Topaz

Bluetooth Enabled Web Browser for iOS

Development Tooling

Required tooling:

• Xcode
• Xcode Command Line Tools
• Npm

Optional tooling:

• swiftlint (soon to be replaced by swift format)
• xcbeautify (highly recommended when running tests from the command line)

Building Javascript

Any changes to the lib/Javascript sources requires manually building and committing the final artifacts. To compile the Typescript sources:

$ make js

This will output the compiled artifacts to lib/Sources/WebView/Resources/Generated. Submit these changes as part of the PR.

To compile the Javascript in a non-minified form for debugging:

$ make js-debug

To switch between the debug and production artifacts, use the js-clean target to force a re-build e.g.:

# Force re-build for testing:
$ make js-clean js-debug
# Force re-build for production:
$ make js-clean js

CLI Build and Test

Installing onto a phone or simulator requires using Xcode. But for CI and local testing convenience there are makefiles for doing most tasks.

To build the entire project:

$ make build

The default build flavor is Debug. To use a different build configuration set XCODE_CONFIG e.g.:

$ make XCODE_CONFIG=Release build

To run tests for the entire project:

$ make test

To run tests for a specific SPM library module specify a target with the syntax <module-name>Tests e.g.:

$ make BluetoothEngineTests

To build all the modules in the SPM library using the bare swift tooling instead of xcodebuild:

$ make -C lib

To build a specific SPM library module set TARGET to the module name e.g.:

$ make -C lib TARGET=BluetoothEngine

To clean up and delete all build artifacts:

$ make clean

Publishing To App Store

Please see the detailed instructions here.

License

Copyright 2025 JUUL Labs, Inc.

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

    http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.