Skip to content

Privacy-first password manager with built-in email aliasing. Fully encrypted and self-hostable.

Include required dependencies for browser extension sources build and move safari-xcode project (#2159)

Leendert de Borst8c546dfdde58
diff --git a/.gitignore b/.gitignore
index 9b00db29b..4b6132fd5 100644
--- a/.gitignore
+++ b/.gitignore
@@ -441,7 +441,7 @@ temp
*.keystore
# Safari extension build files
-apps/browser-extension/safari-xcode/build
+apps/browser-extension/build-assets/safari-xcode/build
# Rust core binaries (built by ./build.sh in core/rust)
# These are platform-specific and must be built locally or by CI
diff --git a/apps/browser-extension/README.md b/apps/browser-extension/README.md
index ba5ac768e..963388bf9 100644
--- a/apps/browser-extension/README.md
+++ b/apps/browser-extension/README.md
@@ -4,6 +4,11 @@ The browser extension is built using WXT and React:
- [WXT](https://wxt.dev/) is a build tool for browser extensions.
- [React](https://reactjs.org/) is a JavaScript library for building user interfaces.
+The extension links the shared core packages (`core/client`, `core/models`, `core/vault`) as `file:`
+dependencies, so this folder expects to sit in the repository next to the `core` folder. `npm install`
+also installs the dependencies of those linked packages (see `scripts/install-core-deps.mjs`), so one
+install in this directory is all that is needed.
+
To build the browser extension, run the following command in this directory:
### Build the browser extension
@@ -19,7 +24,16 @@ npm run zip:firefox
# Build the Edge extension (saves in dist/edge-mv3)
npm run zip:edge
-# Build the Safari extension (saves in dist/safari-mv2 which is referenced by the safari-xcode/AliasVault.xcodeproj project)
+# Build the Safari extension (saves in dist/safari-mv2 which is referenced by the build-assets/safari-xcode/AliasVault.xcodeproj project)
npm run build:safari
-# Open the safari-xcode/AliasVault.xcodeproj project in MacOS Xcode and run the project. This will install the extension to your Safari browser locally.
+# Open the build-assets/safari-xcode/AliasVault.xcodeproj project in MacOS Xcode and run the project. This will install the extension to your Safari browser locally.
+```
+
+### Rebuild the Rust WASM module (optional)
+`core/client/wasm` holds the prebuilt WASM module that the extension bundles, and the builds above use it
+as is. To rebuild it from the Rust sources in `core/rust`, install the [Rust toolchain](https://rustup.rs)
+and run:
+
+```bash
+npm run build:rust
```
diff --git a/apps/browser-extension/build-assets/README.md b/apps/browser-extension/build-assets/README.md
new file mode 100644
index 000000000..001f3b786
--- /dev/null
+++ b/apps/browser-extension/build-assets/README.md
@@ -0,0 +1,8 @@
+# Build assets
+
+Store specific packaging wrappers that are used to build the browser extension.
+
+| Folder | Description |
+| --- | --- |
+| `firefox-sources` | `README.md` that `wxt.config.ts` injects into the root of the sources archive that accompanies every addons.mozilla.org submission. |
+| `safari-xcode` | Xcode project that wraps the built extension (`../../dist/safari-mv2`) in the macOS app that Apple requires for Safari extensions. |
diff --git a/apps/browser-extension/build-assets/firefox-sources/README.md b/apps/browser-extension/build-assets/firefox-sources/README.md
new file mode 100644
index 000000000..bac7f6420
--- /dev/null
+++ b/apps/browser-extension/build-assets/firefox-sources/README.md
@@ -0,0 +1,37 @@
+# AliasVault browser extension: source archive
+
+This archive contains the source code of the AliasVault browser extension together with the shared packages
+that the extension is built from. It mirrors the layout of the public repository at https://github.com/aliasvault/aliasvault,
+which also holds the server and mobile app sources that are not needed to build the extension.
+
+## Contents
+
+| Path | Description |
+| --- | --- |
+| `apps/browser-extension` | The browser extension itself (WXT, React, TypeScript) |
+| `core/client` | Shared client logic, linked as a `file:` dependency |
+| `core/models` | Shared data models, linked as a `file:` dependency |
+| `core/vault` | Shared vault schema definitions, linked as a `file:` dependency |
+| `core/rust` | Rust sources of the WebAssembly module that the extension bundles |
+
+## How to build
+
+```bash
+cd apps/browser-extension
+npm install
+npm run zip:firefox
+```
+
+This writes the unpacked extension to `apps/browser-extension/dist/firefox-mv2` and the packaged
+extension to `apps/browser-extension/dist/aliasvault-browser-extension-<version>-firefox.zip`.
+
+Node.js and npm are the only requirements; release builds are made with Node.js 24. The `npm install`
+step also installs the dependencies of the linked `core/*` packages, so no other install is needed.
+
+Full instructions are in `apps/browser-extension/README.md`.
+
+## WebAssembly module
+
+`core/client/wasm` holds the prebuilt WebAssembly module that the extension bundles, and the build above
+uses it as is. To rebuild it from the Rust sources in `core/rust`, install the Rust toolchain
+(https://rustup.rs) and run `npm run build:rust` from `apps/browser-extension`.
diff --git a/apps/browser-extension/safari-xcode/.gitignore b/apps/browser-extension/build-assets/safari-xcode/.gitignore
similarity index 100%
rename from apps/browser-extension/safari-xcode/.gitignore
rename to apps/browser-extension/build-assets/safari-xcode/.gitignore
diff --git a/apps/browser-extension/safari-xcode/AliasVault Extension/AliasVault_Extension.entitlements b/apps/browser-extension/build-assets/safari-xcode/AliasVault Extension/AliasVault_Extension.entitlements
similarity index 100%
rename from apps/browser-extension/safari-xcode/AliasVault Extension/AliasVault_Extension.entitlements
rename to apps/browser-extension/build-assets/safari-xcode/AliasVault Extension/AliasVault_Extension.entitlements
diff --git a/apps/browser-extension/safari-xcode/AliasVault Extension/Info.plist b/apps/browser-extension/build-assets/safari-xcode/AliasVault Extension/Info.plist
similarity index 100%
rename from apps/browser-extension/safari-xcode/AliasVault Extension/Info.plist
rename to apps/browser-extension/build-assets/safari-xcode/AliasVault Extension/Info.plist
diff --git a/apps/browser-extension/safari-xcode/AliasVault Extension/SafariWebExtensionHandler.swift b/apps/browser-extension/build-assets/safari-xcode/AliasVault Extension/SafariWebExtensionHandler.swift
similarity index 100%
rename from apps/browser-extension/safari-xcode/AliasVault Extension/SafariWebExtensionHandler.swift
rename to apps/browser-extension/build-assets/safari-xcode/AliasVault Extension/SafariWebExtensionHandler.swift
diff --git a/apps/browser-extension/safari-xcode/AliasVault.xcodeproj/project.pbxproj b/apps/browser-extension/build-assets/safari-xcode/AliasVault.xcodeproj/project.pbxproj
similarity index 96%
rename from apps/browser-extension/safari-xcode/AliasVault.xcodeproj/project.pbxproj
rename to apps/browser-extension/build-assets/safari-xcode/AliasVault.xcodeproj/project.pbxproj
index 385aa59fb..d2c70a2f8 100644
--- a/apps/browser-extension/safari-xcode/AliasVault.xcodeproj/project.pbxproj
+++ b/apps/browser-extension/build-assets/safari-xcode/AliasVault.xcodeproj/project.pbxproj
@@ -72,18 +72,18 @@
CE0CAFC52D81A9F8006174AB /* SafariWebExtensionHandler.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = SafariWebExtensionHandler.swift; sourceTree = "<group>"; };
CE0CAFC72D81A9F8006174AB /* Info.plist */ = {isa = PBXFileReference; lastKnownFileType = text.plist.xml; path = Info.plist; sourceTree = "<group>"; };
CE0CAFC82D81A9F8006174AB /* AliasVault_Extension.entitlements */ = {isa = PBXFileReference; lastKnownFileType = text.plist.entitlements; path = AliasVault_Extension.entitlements; sourceTree = "<group>"; };
- CE0CAFD32D81A9F8006174AB /* background.js */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.javascript; name = background.js; path = "../../dist/safari-mv2/background.js"; sourceTree = "<group>"; };
- CE0CAFD42D81A9F8006174AB /* popup.html */ = {isa = PBXFileReference; lastKnownFileType = text.html; name = popup.html; path = "../../dist/safari-mv2/popup.html"; sourceTree = "<group>"; };
- CE0CAFD52D81A9F8006174AB /* chunks */ = {isa = PBXFileReference; lastKnownFileType = folder; name = chunks; path = "../../dist/safari-mv2/chunks"; sourceTree = "<group>"; };
- CE0CAFD62D81A9F8006174AB /* content-scripts */ = {isa = PBXFileReference; lastKnownFileType = folder; name = "content-scripts"; path = "../../dist/safari-mv2/content-scripts"; sourceTree = "<group>"; };
- CE0CAFD72D81A9F8006174AB /* manifest.json */ = {isa = PBXFileReference; lastKnownFileType = text.json; name = manifest.json; path = "../../dist/safari-mv2/manifest.json"; sourceTree = "<group>"; };
- CE0CAFD82D81A9F8006174AB /* icon */ = {isa = PBXFileReference; lastKnownFileType = folder; name = icon; path = "../../dist/safari-mv2/icon"; sourceTree = "<group>"; };
- CE0CAFD92D81A9F8006174AB /* assets */ = {isa = PBXFileReference; lastKnownFileType = folder; name = assets; path = "../../dist/safari-mv2/assets"; sourceTree = "<group>"; };
- CE0CAFDA2D81A9F8006174AB /* src */ = {isa = PBXFileReference; lastKnownFileType = folder; name = src; path = "../../dist/safari-mv2/src"; sourceTree = "<group>"; };
+ CE0CAFD32D81A9F8006174AB /* background.js */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.javascript; name = background.js; path = "../../../dist/safari-mv2/background.js"; sourceTree = "<group>"; };
+ CE0CAFD42D81A9F8006174AB /* popup.html */ = {isa = PBXFileReference; lastKnownFileType = text.html; name = popup.html; path = "../../../dist/safari-mv2/popup.html"; sourceTree = "<group>"; };
+ CE0CAFD52D81A9F8006174AB /* chunks */ = {isa = PBXFileReference; lastKnownFileType = folder; name = chunks; path = "../../../dist/safari-mv2/chunks"; sourceTree = "<group>"; };
+ CE0CAFD62D81A9F8006174AB /* content-scripts */ = {isa = PBXFileReference; lastKnownFileType = folder; name = "content-scripts"; path = "../../../dist/safari-mv2/content-scripts"; sourceTree = "<group>"; };
+ CE0CAFD72D81A9F8006174AB /* manifest.json */ = {isa = PBXFileReference; lastKnownFileType = text.json; name = manifest.json; path = "../../../dist/safari-mv2/manifest.json"; sourceTree = "<group>"; };
+ CE0CAFD82D81A9F8006174AB /* icon */ = {isa = PBXFileReference; lastKnownFileType = folder; name = icon; path = "../../../dist/safari-mv2/icon"; sourceTree = "<group>"; };
+ CE0CAFD92D81A9F8006174AB /* assets */ = {isa = PBXFileReference; lastKnownFileType = folder; name = assets; path = "../../../dist/safari-mv2/assets"; sourceTree = "<group>"; };
+ CE0CAFDA2D81A9F8006174AB /* src */ = {isa = PBXFileReference; lastKnownFileType = folder; name = src; path = "../../../dist/safari-mv2/src"; sourceTree = "<group>"; };
CE0E5BAF2E7D8BA600515C80 /* AliasVault.icon */ = {isa = PBXFileReference; lastKnownFileType = folder.iconcomposer.icon; path = AliasVault.icon; sourceTree = "<group>"; };
- CEA194E32EB6221B00EAB23B /* webauthn.js */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.javascript; name = webauthn.js; path = "../../dist/safari-mv2/webauthn.js"; sourceTree = "<group>"; };
- CEA194E52EB6248D00EAB23B /* offscreen.html */ = {isa = PBXFileReference; lastKnownFileType = text.html; name = offscreen.html; path = "../../dist/safari-mv2/offscreen.html"; sourceTree = "<group>"; };
- CEA194E62EB6248D00EAB23B /* offscreen.js */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.javascript; name = offscreen.js; path = "../../dist/safari-mv2/offscreen.js"; sourceTree = "<group>"; };
+ CEA194E32EB6221B00EAB23B /* webauthn.js */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.javascript; name = webauthn.js; path = "../../../dist/safari-mv2/webauthn.js"; sourceTree = "<group>"; };
+ CEA194E52EB6248D00EAB23B /* offscreen.html */ = {isa = PBXFileReference; lastKnownFileType = text.html; name = offscreen.html; path = "../../../dist/safari-mv2/offscreen.html"; sourceTree = "<group>"; };
+ CEA194E62EB6248D00EAB23B /* offscreen.js */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.javascript; name = offscreen.js; path = "../../../dist/safari-mv2/offscreen.js"; sourceTree = "<group>"; };
/* End PBXFileReference section */
/* Begin PBXFrameworksBuildPhase section */
diff --git a/apps/browser-extension/safari-xcode/AliasVault.xcodeproj/project.xcworkspace/contents.xcworkspacedata b/apps/browser-extension/build-assets/safari-xcode/AliasVault.xcodeproj/project.xcworkspace/contents.xcworkspacedata
similarity index 100%
rename from apps/browser-extension/safari-xcode/AliasVault.xcodeproj/project.xcworkspace/contents.xcworkspacedata
rename to apps/browser-extension/build-assets/safari-xcode/AliasVault.xcodeproj/project.xcworkspace/contents.xcworkspacedata
diff --git a/apps/browser-extension/safari-xcode/AliasVault.xcodeproj/project.xcworkspace/xcshareddata/IDEWorkspaceChecks.plist b/apps/browser-extension/build-assets/safari-xcode/AliasVault.xcodeproj/project.xcworkspace/xcshareddata/IDEWorkspaceChecks.plist
similarity index 100%
rename from apps/browser-extension/safari-xcode/AliasVault.xcodeproj/project.xcworkspace/xcshareddata/IDEWorkspaceChecks.plist
rename to apps/browser-extension/build-assets/safari-xcode/AliasVault.xcodeproj/project.xcworkspace/xcshareddata/IDEWorkspaceChecks.plist
diff --git a/apps/browser-extension/safari-xcode/AliasVault/AliasVault.entitlements b/apps/browser-extension/build-assets/safari-xcode/AliasVault/AliasVault.entitlements
similarity index 100%
rename from apps/browser-extension/safari-xcode/AliasVault/AliasVault.entitlements
rename to apps/browser-extension/build-assets/safari-xcode/AliasVault/AliasVault.entitlements
diff --git a/apps/browser-extension/safari-xcode/AliasVault/AliasVault.icon/Assets/icon-1024.png b/apps/browser-extension/build-assets/safari-xcode/AliasVault/AliasVault.icon/Assets/icon-1024.png
similarity index 100%
rename from apps/browser-extension/safari-xcode/AliasVault/AliasVault.icon/Assets/icon-1024.png
rename to apps/browser-extension/build-assets/safari-xcode/AliasVault/AliasVault.icon/Assets/icon-1024.png
diff --git a/apps/browser-extension/safari-xcode/AliasVault/AliasVault.icon/icon.json b/apps/browser-extension/build-assets/safari-xcode/AliasVault/AliasVault.icon/icon.json
similarity index 100%
rename from apps/browser-extension/safari-xcode/AliasVault/AliasVault.icon/icon.json
rename to apps/browser-extension/build-assets/safari-xcode/AliasVault/AliasVault.icon/icon.json
diff --git a/apps/browser-extension/safari-xcode/AliasVault/AppDelegate.swift b/apps/browser-extension/build-assets/safari-xcode/AliasVault/AppDelegate.swift
similarity index 100%
rename from apps/browser-extension/safari-xcode/AliasVault/AppDelegate.swift
rename to apps/browser-extension/build-assets/safari-xcode/AliasVault/AppDelegate.swift
diff --git a/apps/browser-extension/safari-xcode/AliasVault/Assets.xcassets/AccentColor.colorset/Contents.json b/apps/browser-extension/build-assets/safari-xcode/AliasVault/Assets.xcassets/AccentColor.colorset/Contents.json
similarity index 100%
rename from apps/browser-extension/safari-xcode/AliasVault/Assets.xcassets/AccentColor.colorset/Contents.json
rename to apps/browser-extension/build-assets/safari-xcode/AliasVault/Assets.xcassets/AccentColor.colorset/Contents.json
diff --git a/apps/browser-extension/safari-xcode/AliasVault/Assets.xcassets/Contents.json b/apps/browser-extension/build-assets/safari-xcode/AliasVault/Assets.xcassets/Contents.json
similarity index 100%
rename from apps/browser-extension/safari-xcode/AliasVault/Assets.xcassets/Contents.json
rename to apps/browser-extension/build-assets/safari-xcode/AliasVault/Assets.xcassets/Contents.json
diff --git a/apps/browser-extension/safari-xcode/AliasVault/Assets.xcassets/LargeIcon.imageset/Contents.json b/apps/browser-extension/build-assets/safari-xcode/AliasVault/Assets.xcassets/LargeIcon.imageset/Contents.json
similarity index 100%
rename from apps/browser-extension/safari-xcode/AliasVault/Assets.xcassets/LargeIcon.imageset/Contents.json
rename to apps/browser-extension/build-assets/safari-xcode/AliasVault/Assets.xcassets/LargeIcon.imageset/Contents.json
diff --git a/apps/browser-extension/safari-xcode/AliasVault/Base.lproj/Main.html b/apps/browser-extension/build-assets/safari-xcode/AliasVault/Base.lproj/Main.html
similarity index 100%
rename from apps/browser-extension/safari-xcode/AliasVault/Base.lproj/Main.html
rename to apps/browser-extension/build-assets/safari-xcode/AliasVault/Base.lproj/Main.html
diff --git a/apps/browser-extension/safari-xcode/AliasVault/Base.lproj/Main.storyboard b/apps/browser-extension/build-assets/safari-xcode/AliasVault/Base.lproj/Main.storyboard
similarity index 100%
rename from apps/browser-extension/safari-xcode/AliasVault/Base.lproj/Main.storyboard
rename to apps/browser-extension/build-assets/safari-xcode/AliasVault/Base.lproj/Main.storyboard
diff --git a/apps/browser-extension/safari-xcode/AliasVault/Info.plist b/apps/browser-extension/build-assets/safari-xcode/AliasVault/Info.plist
similarity index 100%
rename from apps/browser-extension/safari-xcode/AliasVault/Info.plist
rename to apps/browser-extension/build-assets/safari-xcode/AliasVault/Info.plist
diff --git a/apps/browser-extension/safari-xcode/AliasVault/Resources/Icon.png b/apps/browser-extension/build-assets/safari-xcode/AliasVault/Resources/Icon.png
similarity index 100%
rename from apps/browser-extension/safari-xcode/AliasVault/Resources/Icon.png
rename to apps/browser-extension/build-assets/safari-xcode/AliasVault/Resources/Icon.png
diff --git a/apps/browser-extension/safari-xcode/AliasVault/Resources/Script.js b/apps/browser-extension/build-assets/safari-xcode/AliasVault/Resources/Script.js
similarity index 100%
rename from apps/browser-extension/safari-xcode/AliasVault/Resources/Script.js
rename to apps/browser-extension/build-assets/safari-xcode/AliasVault/Resources/Script.js
diff --git a/apps/browser-extension/safari-xcode/AliasVault/Resources/Style.css b/apps/browser-extension/build-assets/safari-xcode/AliasVault/Resources/Style.css
similarity index 100%
rename from apps/browser-extension/safari-xcode/AliasVault/Resources/Style.css
rename to apps/browser-extension/build-assets/safari-xcode/AliasVault/Resources/Style.css
diff --git a/apps/browser-extension/safari-xcode/AliasVault/ViewController.swift b/apps/browser-extension/build-assets/safari-xcode/AliasVault/ViewController.swift
similarity index 100%
rename from apps/browser-extension/safari-xcode/AliasVault/ViewController.swift
rename to apps/browser-extension/build-assets/safari-xcode/AliasVault/ViewController.swift
diff --git a/apps/browser-extension/safari-xcode/README.md b/apps/browser-extension/build-assets/safari-xcode/README.md
similarity index 94%
rename from apps/browser-extension/safari-xcode/README.md
rename to apps/browser-extension/build-assets/safari-xcode/README.md
index cae9c63e8..1835a2909 100644
--- a/apps/browser-extension/safari-xcode/README.md
+++ b/apps/browser-extension/build-assets/safari-xcode/README.md
@@ -14,7 +14,7 @@ To recreate this project, run the following command in the browser-extension roo
npm run build:safari
# Convert the safari extension to an Xcode project (requires MacOS/XCode command line interface)
-xcrun safari-web-extension-converter --bundle-identifier net.aliasvault.safari --macos-only dist/safari-mv2 --project-location safari-xcode --force
+xcrun safari-web-extension-converter --bundle-identifier net.aliasvault.safari --macos-only dist/safari-mv2 --project-location build-assets/safari-xcode --force
# After the Xcode project is opened, you can run the extension by clicking the "Run" button in the top left corner of the Xcode window.
# This will install the extension to your Safari browser and allow you to run it.
diff --git a/apps/browser-extension/safari-xcode/build-and-submit.sh b/apps/browser-extension/build-assets/safari-xcode/build-and-submit.sh
similarity index 98%
rename from apps/browser-extension/safari-xcode/build-and-submit.sh
rename to apps/browser-extension/build-assets/safari-xcode/build-and-submit.sh
index c429efe61..759298755 100755
--- a/apps/browser-extension/safari-xcode/build-and-submit.sh
+++ b/apps/browser-extension/build-assets/safari-xcode/build-and-submit.sh
@@ -90,7 +90,7 @@ echo ""
if [[ $CHOICE == "1" || $CHOICE == "2" ]]; then
echo "Building browser extension..."
- pushd "$SCRIPT_DIR/.." > /dev/null
+ pushd "$SCRIPT_DIR/../.." > /dev/null
npm run build:safari
popd > /dev/null
@@ -191,7 +191,7 @@ fi
echo "✅ Proceeding with upload..."
# Calculate path to repository root and metadata
-REPO_ROOT="$SCRIPT_DIR/../../.."
+REPO_ROOT="$SCRIPT_DIR/../../../.."
METADATA_PATH="$REPO_ROOT/fastlane/metadata/browser-extension"
# ------------------------------------------
diff --git a/apps/browser-extension/safari-xcode/exportOptions.plist b/apps/browser-extension/build-assets/safari-xcode/exportOptions.plist
similarity index 100%
rename from apps/browser-extension/safari-xcode/exportOptions.plist
rename to apps/browser-extension/build-assets/safari-xcode/exportOptions.plist
diff --git a/apps/browser-extension/package.json b/apps/browser-extension/package.json
index c4cae59e1..ff65e54db 100644
--- a/apps/browser-extension/package.json
+++ b/apps/browser-extension/package.json
@@ -5,7 +5,7 @@
"version": "0.31.0",
"type": "module",
"scripts": {
- "build:rust": "cd ../../core/rust && ./build.sh --browser",
+ "build:rust": "cd ../../core/rust && bash ./build.sh --browser",
"dev:chrome": "wxt -b chrome",
"dev:firefox": "wxt -b firefox",
"dev:edge": "wxt -b edge",
@@ -26,6 +26,7 @@
"zip:firefox": "wxt zip -b firefox",
"zip:edge": "wxt zip -b edge",
"compile": "tsc --noEmit",
+ "preinstall": "node scripts/install-core-deps.mjs",
"postinstall": "wxt prepare"
},
"dependencies": {
diff --git a/apps/browser-extension/scripts/install-core-deps.mjs b/apps/browser-extension/scripts/install-core-deps.mjs
new file mode 100755
index 000000000..1c5bfd21c
--- /dev/null
+++ b/apps/browser-extension/scripts/install-core-deps.mjs
@@ -0,0 +1,127 @@
+#!/usr/bin/env node
+// Installs the dependencies of the core packages this extension links with `file:`
+// references (core/client, core/models, core/vault).
+//
+// npm symlinks a `file:` dependency but never installs that package's own
+// dependencies, so core/client is left without `sql.js` and `otpauth`. Both are
+// resolved from core/client's own node_modules when the extension is built (the
+// linked package lives outside this project's node_modules tree), and
+// wxt.config.ts copies the sql.js wasm file out of it, so the build fails without
+// this step. Running it from `preinstall` also makes the Firefox sources archive,
+// which ships core/* next to the extension, build with a plain `npm install`.
+//
+// Usage:
+// node scripts/install-core-deps.mjs
+
+import { spawnSync } from "node:child_process";
+import { existsSync, readFileSync } from "node:fs";
+import { fileURLToPath } from "node:url";
+import path from "node:path";
+import { env, exit, platform } from "node:process";
+
+const scriptDir = path.dirname(fileURLToPath(import.meta.url));
+const extensionDir = path.resolve(scriptDir, "..");
+
+/*
+ * npm exports its own project root to lifecycle scripts, and a nested npm picks that
+ * up over the cwd we hand it, which would install into the extension instead of the
+ * core package. Drop the path-scoped config so the child install stays in its own
+ * directory, and keep the rest (registry, cache, proxy) intact.
+ */
+const childEnv = { ...env };
+delete childEnv.npm_config_local_prefix;
+delete childEnv.npm_config_workspace;
+delete childEnv.npm_config_workspaces;
+
+/**
+ * Read a package.json, returning null when it is missing or unreadable.
+ * @param {string} packageDir
+ * @returns {Record<string, any> | null}
+ */
+function readManifest(packageDir) {
+ try {
+ return JSON.parse(readFileSync(path.join(packageDir, "package.json"), "utf8"));
+ } catch {
+ return null;
+ }
+}
+
+/**
+ * Resolve the directories of a package's `file:` dependencies.
+ * @param {string} packageDir
+ * @param {Record<string, any>} manifest
+ * @returns {string[]}
+ */
+function linkedDirs(packageDir, manifest) {
+ return Object.values(manifest.dependencies ?? {})
+ .filter((spec) => typeof spec === "string" && spec.startsWith("file:"))
+ .map((spec) => path.resolve(packageDir, spec.slice("file:".length)));
+}
+
+/**
+ * Collect every `file:` linked package reachable from the extension.
+ * @returns {string[]}
+ */
+function collectLinkedPackages() {
+ const extensionManifest = readManifest(extensionDir);
+ if (!extensionManifest) {
+ return [];
+ }
+
+ const collected = [];
+ const seen = new Set([extensionDir]);
+ const queue = linkedDirs(extensionDir, extensionManifest);
+
+ while (queue.length > 0) {
+ const packageDir = queue.shift();
+ if (seen.has(packageDir)) {
+ continue;
+ }
+ seen.add(packageDir);
+
+ const manifest = readManifest(packageDir);
+ if (!manifest) {
+ continue;
+ }
+
+ collected.push(packageDir);
+ queue.push(...linkedDirs(packageDir, manifest));
+ }
+
+ return collected;
+}
+
+/**
+ * List the registry dependencies of a package that are not installed in it yet.
+ * @param {string} packageDir
+ * @returns {string[]}
+ */
+function missingDependencies(packageDir) {
+ const manifest = readManifest(packageDir);
+ return Object.entries(manifest?.dependencies ?? {})
+ .filter(([, spec]) => !(typeof spec === "string" && spec.startsWith("file:")))
+ .map(([name]) => name)
+ .filter((name) => !existsSync(path.join(packageDir, "node_modules", name)));
+}
+
+for (const packageDir of collectLinkedPackages()) {
+ const missing = missingDependencies(packageDir);
+ if (missing.length === 0) {
+ continue;
+ }
+
+ const relativeDir = path.relative(extensionDir, packageDir);
+ console.log(`[core-deps] Installing dependencies for ${relativeDir} (missing: ${missing.join(", ")})`);
+
+ const result = spawnSync("npm", ["install", "--omit=dev", "--no-audit", "--no-fund"], {
+ cwd: packageDir,
+ env: childEnv,
+ stdio: "inherit",
+ shell: platform === "win32",
+ });
+
+ if (result.status !== 0) {
+ console.error(`[core-deps] Failed to install dependencies for ${relativeDir}`);
+ exit(result.status ?? 1);
+ }
+}
diff --git a/apps/browser-extension/tailwind.config.js b/apps/browser-extension/tailwind.config.js
index 1cbf5014f..7bdbe9820 100644
--- a/apps/browser-extension/tailwind.config.js
+++ b/apps/browser-extension/tailwind.config.js
@@ -1,7 +1,9 @@
/** @type {import('tailwindcss').Config} */
export default {
content: [
- "./src/**/*.{js,jsx,ts,tsx,html}"
+ "./src/**/*.{js,jsx,ts,tsx,html}",
+ // Test fixtures are not shipped, so strip out of CSS.
+ "!./src/**/__tests__/**"
],
darkMode: 'class',
theme: {
diff --git a/apps/browser-extension/wxt.config.ts b/apps/browser-extension/wxt.config.ts
index 87c189bc0..5b8647679 100644
--- a/apps/browser-extension/wxt.config.ts
+++ b/apps/browser-extension/wxt.config.ts
@@ -1,3 +1,4 @@
+import { execFileSync } from 'node:child_process';
import path from 'node:path';
import { defineConfig } from 'wxt';
@@ -33,6 +34,13 @@ function asciiOnlyJsPlugin(): Plugin {
const CORE_DIR = path.resolve(import.meta.dirname, '../../core');
+/*
+ * README that is placed in the root of the Firefox sources archive. It is added after zipping because
+ * wxt keeps the path of every included file, and the archive root maps to the repository root which
+ * already has its own README.md.
+ */
+const SOURCES_README = path.resolve(import.meta.dirname, 'build-assets/firefox-sources/README.md');
+
// See https://wxt.dev/api/config.html
export default defineConfig({
manifest: ({ browser, manifestVersion, mode, command }) => {
@@ -126,6 +134,15 @@ export default defineConfig({
})
],
}),
+ hooks: {
+ 'zip:sources:done': (_wxt, zipPath): void => {
+ try {
+ execFileSync('zip', ['-jq', zipPath, SOURCES_README]);
+ } catch (error) {
+ throw new Error(`Could not add README.md to ${path.basename(zipPath)}, is the 'zip' command available? ${error}`);
+ }
+ },
+ },
zip: {
// Firefox source archive (zip) requires all the files the build needs locally inside the archive.
sourcesRoot: path.resolve(CORE_DIR, '..'),
@@ -134,16 +151,21 @@ export default defineConfig({
'core/client/**/*',
'core/models/**/*',
'core/vault/**/*',
+ 'core/rust/**/*',
+ 'core/rust/.cargo/**/*',
+ 'LICENSE.md',
],
excludeSources: [
'**/node_modules/**',
'**/dist/**',
'**/.wxt/**',
- 'apps/browser-extension/safari-xcode/build/**',
+ 'core/rust/target/**',
+ 'apps/browser-extension/build-assets/safari-xcode/build/**',
'**/xcuserdata/**',
'apps/browser-extension/playwright-report/**',
'apps/browser-extension/test-results/**',
'apps/browser-extension/tests/**',
+ 'apps/browser-extension/build-assets/firefox-sources/**',
'apps/browser-extension/stats.html',
'apps/browser-extension/stats-*.json',
'**/*.log',
diff --git a/docs/docs/contributing/development/browser-extensions.md b/docs/docs/contributing/development/browser-extensions.md
index 2b239493e..d2bf0591c 100644
--- a/docs/docs/contributing/development/browser-extensions.md
+++ b/docs/docs/contributing/development/browser-extensions.md
@@ -79,7 +79,7 @@ npm run build:edge
npm run build:safari
```
-2. Open the Xcode project in the `safari-xcode/AliasVault.xcodeproj` folder and build / run the app.
+2. Open the Xcode project in the `build-assets/safari-xcode/AliasVault.xcodeproj` folder and build / run the app.
3. The extension will be installed automatically in Safari. Follow the on-screen MacOS app instructions to complete the installation.
diff --git a/docs/docs/installation/browser-extensions/safari/build-from-source.md b/docs/docs/installation/browser-extensions/safari/build-from-source.md
index 0845820c4..6c5013bd4 100644
--- a/docs/docs/installation/browser-extensions/safari/build-from-source.md
+++ b/docs/docs/installation/browser-extensions/safari/build-from-source.md
@@ -34,7 +34,7 @@ npm install
npm run build:safari
```
-5. Open Xcode and open the `apps/browser-extension/safari-xcode/AliasVault.xcodeproj` file
+5. Open Xcode and open the `apps/browser-extension/build-assets/safari-xcode/AliasVault.xcodeproj` file
6. Run the project. This will open up the AliasVault MacOS wrapper app and automatically install the extension to your Safari Extensions list.
diff --git a/scripts/bump-versions.sh b/scripts/bump-versions.sh
index 4984bc186..72219ffb8 100755
--- a/scripts/bump-versions.sh
+++ b/scripts/bump-versions.sh
@@ -293,7 +293,7 @@ get_android_version() {
# Function to extract version from Safari extension
get_safari_version() {
- grep "MARKETING_VERSION = " "$REPO_ROOT/apps/browser-extension/safari-xcode/AliasVault.xcodeproj/project.pbxproj" | head -n1 | tr -d '"' | tr -d ';' | tr -d ' ' | cut -d'=' -f2
+ grep "MARKETING_VERSION = " "$REPO_ROOT/apps/browser-extension/build-assets/safari-xcode/AliasVault.xcodeproj/project.pbxproj" | head -n1 | tr -d '"' | tr -d ';' | tr -d ' ' | cut -d'=' -f2
}
# Function to extract version from Rust core Cargo.toml
@@ -507,7 +507,7 @@ elif [[ "$MARKETING_UPDATE" == true ]]; then
exit 1
fi
- current_safari_build=$(grep -A1 "CURRENT_PROJECT_VERSION" "$REPO_ROOT/apps/browser-extension/safari-xcode/AliasVault.xcodeproj/project.pbxproj" | grep "CURRENT_PROJECT_VERSION = [0-9]\+;" | head -n1 | tr -d ';' | tr -d ' ' | cut -d'=' -f2 | grep -E '^[0-9]+$')
+ current_safari_build=$(grep -A1 "CURRENT_PROJECT_VERSION" "$REPO_ROOT/apps/browser-extension/build-assets/safari-xcode/AliasVault.xcodeproj/project.pbxproj" | grep "CURRENT_PROJECT_VERSION = [0-9]\+;" | head -n1 | tr -d ';' | tr -d ' ' | cut -d'=' -f2 | grep -E '^[0-9]+$')
if [ -z "$current_safari_build" ]; then
echo -e "${RED}Error: Could not read Safari build number or invalid format${RESET}"
exit 1
@@ -656,7 +656,7 @@ elif [[ "$MARKETING_UPDATE" == true ]]; then
# Update Safari extension version (Apple doesn't accept stage suffixes in MARKETING_VERSION)
echo -e "${BLUE}Updating Safari extension version...${RESET}"
- update_version "$REPO_ROOT/apps/browser-extension/safari-xcode/AliasVault.xcodeproj/project.pbxproj" \
+ update_version "$REPO_ROOT/apps/browser-extension/build-assets/safari-xcode/AliasVault.xcodeproj/project.pbxproj" \
"MARKETING_VERSION = [0-9][0-9]*\.[0-9][0-9]*\.[0-9][0-9]*[^;]*;" \
"MARKETING_VERSION = $version;"
@@ -733,7 +733,7 @@ if [[ "$MARKETING_UPDATE" != true ]]; then
exit 1
fi
- current_safari_build=$(grep -A1 "CURRENT_PROJECT_VERSION" "$REPO_ROOT/apps/browser-extension/safari-xcode/AliasVault.xcodeproj/project.pbxproj" | grep "CURRENT_PROJECT_VERSION = [0-9]\+;" | head -n1 | tr -d ';' | tr -d ' ' | cut -d'=' -f2 | grep -E '^[0-9]+$')
+ current_safari_build=$(grep -A1 "CURRENT_PROJECT_VERSION" "$REPO_ROOT/apps/browser-extension/build-assets/safari-xcode/AliasVault.xcodeproj/project.pbxproj" | grep "CURRENT_PROJECT_VERSION = [0-9]\+;" | head -n1 | tr -d ';' | tr -d ' ' | cut -d'=' -f2 | grep -E '^[0-9]+$')
if [ -z "$current_safari_build" ]; then
echo -e "${RED}Error: Could not read Safari build number or invalid format${RESET}"
exit 1
@@ -759,7 +759,7 @@ update_version "$REPO_ROOT/apps/mobile-app/android/app/build.gradle" \
"versionCode $new_android_build" \
"Android App"
-update_version "$REPO_ROOT/apps/browser-extension/safari-xcode/AliasVault.xcodeproj/project.pbxproj" \
+update_version "$REPO_ROOT/apps/browser-extension/build-assets/safari-xcode/AliasVault.xcodeproj/project.pbxproj" \
"CURRENT_PROJECT_VERSION = [0-9]\+;" \
"CURRENT_PROJECT_VERSION = $new_safari_build;" \
"Safari Extension"
diff --git a/scripts/review-versions.sh b/scripts/review-versions.sh
index f0ea6c87b..ef3b7b820 100755
--- a/scripts/review-versions.sh
+++ b/scripts/review-versions.sh
@@ -62,12 +62,12 @@ get_android_build() {
# Function to extract version from Safari extension
get_safari_version() {
- grep "MARKETING_VERSION = " ../apps/browser-extension/safari-xcode/AliasVault.xcodeproj/project.pbxproj | head -n1 | tr -d '"' | tr -d ';' | tr -d ' ' | cut -d'=' -f2
+ grep "MARKETING_VERSION = " ../apps/browser-extension/build-assets/safari-xcode/AliasVault.xcodeproj/project.pbxproj | head -n1 | tr -d '"' | tr -d ';' | tr -d ' ' | cut -d'=' -f2
}
# Function to extract Safari build number
get_safari_build() {
- grep -A1 "CURRENT_PROJECT_VERSION" ../apps/browser-extension/safari-xcode/AliasVault.xcodeproj/project.pbxproj | grep "CURRENT_PROJECT_VERSION = [0-9]\+;" | head -n1 | tr -d ';' | tr -d ' ' | cut -d'=' -f2
+ grep -A1 "CURRENT_PROJECT_VERSION" ../apps/browser-extension/build-assets/safari-xcode/AliasVault.xcodeproj/project.pbxproj | grep "CURRENT_PROJECT_VERSION = [0-9]\+;" | head -n1 | tr -d ';' | tr -d ' ' | cut -d'=' -f2
}
# Collect all versions