feat: local native logger and better OOBE

.github/workflows/deployment.yaml

@@ -30,12 +30,12 @@ jobs:
             [ -n "${{ steps.semver.outputs.prerelease }}" ] && exit 14
             exit 0
           fi
-      - run: npm install
+      - run: npm ci
       - run: npm run lint:js
       - run: npm run lint:css
-      - run: npm run build:${{ matrix.platform }}-beta
+      - run: BETA=1 npm run build:${{ matrix.platform }}-safari-15
         if: ${{ github.event.release.prerelease }}
-      - run: npm run build:${{ matrix.platform }}
+      - run: npm run build:${{ matrix.platform }}-safari-15
         if: ${{ ! github.event.release.prerelease }}
       - name: Set xcode version
         run: sudo xcode-select -s "/Applications/Xcode_15.4.app" # https://github.com/actions/runner-images/blob/main/images/macos/macos-14-arm64-Readme.md#xcode

package.json

@@ -5,36 +5,32 @@
 	"sideEffects": false,
 	"scripts": {
 		"dev": "vite",
-		"dev:ext-safari-mac": "SAFARI_PLATFORM=mac node scripts/dev-ext-safari.js",
-		"dev:ext-safari-ios": "SAFARI_PLATFORM=ios node scripts/dev-ext-safari.js",
-		"build:mac": "npm run build:app && npm run build:ext-safari-mac",
-		"build:ios": "npm run build:app && npm run build:ext-safari-ios",
-		"build:mac-beta": "npm run build:app && BETA=1 npm run build:ext-safari-mac",
-		"build:ios-beta": "npm run build:app && BETA=1 npm run build:ext-safari-ios",
-		"build:app": "node scripts/build-app.js",
-		"build:ext-safari-mac": "SAFARI_PLATFORM=mac node scripts/build-ext-safari-15.js",
-		"build:ext-safari-ios": "SAFARI_PLATFORM=ios node scripts/build-ext-safari-15.js",
-		"build:ext-safari-mac-16.4": "SAFARI_PLATFORM=mac node scripts/build-ext-safari-16.4.js",
-		"build:ext-safari-ios-16.4": "SAFARI_PLATFORM=ios node scripts/build-ext-safari-16.4.js",
+		"dev:mac-safari": "SAFARI_PLATFORM=mac node scripts/dev-safari.js",
+		"dev:ios-safari": "SAFARI_PLATFORM=ios node scripts/dev-safari.js",
+		"build:mac-safari-15": "SAFARI_PLATFORM=mac node scripts/build-safari-15.js",
+		"build:ios-safari-15": "SAFARI_PLATFORM=ios node scripts/build-safari-15.js",
+		"build:mac-safari-16.4": "SAFARI_PLATFORM=mac node scripts/build-safari-16.4.js",
+		"build:ios-safari-16.4": "SAFARI_PLATFORM=ios node scripts/build-safari-16.4.js",
 		"lint:js": "eslint . && prettier --check . --plugin prettier-plugin-svelte",
 		"lint:css": "stylelint '**/*.{css,html,svelte}'",
 		"prettier": "prettier --write . --plugin prettier-plugin-svelte"
 	},
 	"devDependencies": {
-		"@sveltejs/vite-plugin-svelte": "^5.0.2",
+		"@sveltejs/vite-plugin-svelte": "^5.0.3",
 		"@types/webextension-polyfill": "^0.12.1",
 		"autoprefixer": "^10.4.20",
 		"cm-show-invisibles": "^3.1.0",
 		"codemirror": "^5.65.18",
 		"eslint": "^9.17.0",
 		"eslint-config-prettier": "^9.1.0",
 		"eslint-plugin-svelte": "^2.46.1",
+		"marked": "^15.0.4",
 		"prettier": "3.3.3",
 		"prettier-plugin-svelte": "3.3.2",
 		"stylelint": "^16.12.0",
 		"stylelint-config-html": "^1.1.0",
 		"stylelint-config-standard": "^36.0.0",
-		"svelte": "^5.14.0",
-		"vite": "^6.0.3"
+		"svelte": "^5.16.0",
+		"vite": "^6.0.6"
 	}
 }

scripts/build-ext-safari-15.js → scripts/build-safari-15.js

@@ -1,11 +1,11 @@
 /**
- * @file Build Safari extension resources using the Vite JavaScript API
+ * @file Build App-WebView and Safari-Extension resources using the Vite JavaScript API
  * @see {@link https://vitejs.dev/guide/api-javascript.html JavaScript API}
  *
  * Safari supports for modules in background since 16.4
  * @see {@link https://developer.apple.com/documentation/safari-release-notes/safari-16_4-release-notes#Safari-Extensions}
  * @see {@link https://developer.mozilla.org/en-US/docs/Mozilla/Add-ons/WebExtensions/manifest.json/background#browser_compatibility}
- * To ensure forward compatibility, background script use independent builds in v4
+ * To ensure forward compatibility, background script use independent builds for safari 15
  *
  * Content scripts not support import modules, and due to their privileges and the
  * speed of injecting user scripts, use a independent build currently
@@ -25,16 +25,35 @@ const sharedConfig = {
 		...Utils.baseConfig.define,
 		"import.meta.env.SAFARI_VERSION": JSON.stringify(15),
 	},
+	build: {
+		sourcemap: process.env.BETA ? true : false,
+		target: "safari15",
+	},
 };
-const sourcemap = process.env.BETA ? true : false;
+
+/**
+ * Build App-Shared WebView resources to xcode dist
+ */
+build({
+	...Utils.baseConfig,
+	plugins: [svelte()],
+	build: {
+		...sharedConfig.build,
+		outDir: `${Utils.APP_SHARED_RESOURCES}/dist/`,
+		copyPublicDir: false,
+		rollupOptions: {
+			input: "entry-app-webview.html",
+		},
+	},
+});
 
 /**
  * Empty resources directory
  * Copy public static assets
  */
-await Utils.emptyBuildDir(Utils.SAFARI_EXT_RESOURCES);
-Utils.cp("public/ext/shared", Utils.SAFARI_EXT_RESOURCES);
-Utils.cp("public/ext/safari-15", Utils.SAFARI_EXT_RESOURCES);
+await Utils.emptyBuildDir(Utils.EXT_SAFARI_RESOURCES);
+Utils.cp("public/ext/shared", Utils.EXT_SAFARI_RESOURCES);
+Utils.cp("public/ext/safari-15", Utils.EXT_SAFARI_RESOURCES);
 
 /** Build content scripts */
 [
@@ -45,10 +64,10 @@ Utils.cp("public/ext/safari-15", Utils.SAFARI_EXT_RESOURCES);
 	build({
 		...sharedConfig,
 		build: {
-			outDir: `${Utils.SAFARI_EXT_RESOURCES}/dist/content-scripts/`,
+			...sharedConfig.build,
+			outDir: `${Utils.EXT_SAFARI_RESOURCES}/dist/content-scripts/`,
 			emptyOutDir: false,
 			copyPublicDir: false,
-			sourcemap,
 			rollupOptions: {
 				input,
 				output: { entryFileNames: "[name].js" },
@@ -61,10 +80,10 @@ Utils.cp("public/ext/safari-15", Utils.SAFARI_EXT_RESOURCES);
 build({
 	...sharedConfig,
 	build: {
-		outDir: `${Utils.SAFARI_EXT_RESOURCES}/dist/`,
+		...sharedConfig.build,
+		outDir: `${Utils.EXT_SAFARI_RESOURCES}/dist/`,
 		emptyOutDir: false,
 		copyPublicDir: false,
-		sourcemap,
 		rollupOptions: {
 			input: { background: "src/ext/background/main.js" },
 			output: { entryFileNames: "[name].js" },
@@ -78,9 +97,9 @@ build({
 	plugins: [svelte()],
 	publicDir: "public/ext/vendor/",
 	build: {
-		outDir: `${Utils.SAFARI_EXT_RESOURCES}/dist/`,
+		...sharedConfig.build,
+		outDir: `${Utils.EXT_SAFARI_RESOURCES}/dist/`,
 		emptyOutDir: false,
-		sourcemap,
 		rollupOptions: {
 			input: ["entry-ext-action-popup.html", "entry-ext-extension-page.html"],
 		},

scripts/build-ext-safari-16.4.js → scripts/build-safari-16.4.js

@@ -1,5 +1,5 @@
 /**
- * @file Build Safari extension resources using the Vite JavaScript API
+ * @file Build App-WebView and Safari-Extension resources using the Vite JavaScript API
  * @see {@link https://vitejs.dev/guide/api-javascript.html JavaScript API}
  *
  * Safari supports for modules in background since 16.4
@@ -24,16 +24,35 @@ const sharedConfig = {
 		...Utils.baseConfig.define,
 		"import.meta.env.SAFARI_VERSION": JSON.stringify(16.4),
 	},
+	build: {
+		sourcemap: process.env.BETA ? true : false,
+		target: "safari16.4",
+	},
 };
-const sourcemap = process.env.BETA ? true : false;
+
+/**
+ * Build App-Shared WebView resources to xcode dist
+ */
+build({
+	...Utils.baseConfig,
+	plugins: [svelte()],
+	build: {
+		...sharedConfig.build,
+		outDir: `${Utils.APP_SHARED_RESOURCES}/dist/`,
+		copyPublicDir: false,
+		rollupOptions: {
+			input: "entry-app-webview.html",
+		},
+	},
+});
 
 /**
  * Empty resources directory
  * Copy public static assets
  */
-await Utils.emptyBuildDir(Utils.SAFARI_EXT_RESOURCES);
-Utils.cp("public/ext/shared", Utils.SAFARI_EXT_RESOURCES);
-Utils.cp("public/ext/safari-16.4", Utils.SAFARI_EXT_RESOURCES);
+await Utils.emptyBuildDir(Utils.EXT_SAFARI_RESOURCES);
+Utils.cp("public/ext/shared", Utils.EXT_SAFARI_RESOURCES);
+Utils.cp("public/ext/safari-16.4", Utils.EXT_SAFARI_RESOURCES);
 
 /** Build content scripts */
 [
@@ -44,10 +63,10 @@ Utils.cp("public/ext/safari-16.4", Utils.SAFARI_EXT_RESOURCES);
 	build({
 		...sharedConfig,
 		build: {
-			outDir: `${Utils.SAFARI_EXT_RESOURCES}/dist/content-scripts/`,
+			...sharedConfig.build,
+			outDir: `${Utils.EXT_SAFARI_RESOURCES}/dist/content-scripts/`,
 			emptyOutDir: false,
 			copyPublicDir: false,
-			sourcemap,
 			rollupOptions: {
 				input,
 				output: { entryFileNames: "[name].js" },
@@ -64,10 +83,10 @@ Utils.cp("public/ext/safari-16.4", Utils.SAFARI_EXT_RESOURCES);
 build({
 	...sharedConfig,
 	build: {
-		outDir: `${Utils.SAFARI_EXT_RESOURCES}/dist/`,
+		...sharedConfig.build,
+		outDir: `${Utils.EXT_SAFARI_RESOURCES}/dist/`,
 		emptyOutDir: false,
 		copyPublicDir: false,
-		sourcemap,
 		rollupOptions: {
 			input: { background: "src/ext/background/main.js" },
 			output: { entryFileNames: "[name].js" },
@@ -81,9 +100,9 @@ build({
 	plugins: [svelte()],
 	publicDir: "public/ext/vendor/",
 	build: {
-		outDir: `${Utils.SAFARI_EXT_RESOURCES}/dist/`,
+		...sharedConfig.build,
+		outDir: `${Utils.EXT_SAFARI_RESOURCES}/dist/`,
 		emptyOutDir: false,
-		sourcemap,
 		rollupOptions: {
 			input: {
 				// background: "src/ext/background/main.js",

scripts/dev-ext-safari.js → scripts/dev-safari.js

@@ -33,18 +33,18 @@ async function buildResources(server, origin) {
 	 * copy public static assets
 	 */
 	await Utils.emptyBuildDir("dist");
-	await Utils.emptyBuildDir(Utils.SAFARI_EXT_RESOURCES);
-	Utils.cp("public/ext/shared", Utils.SAFARI_EXT_RESOURCES);
-	Utils.cp("public/ext/shared-dev", Utils.SAFARI_EXT_RESOURCES);
+	await Utils.emptyBuildDir(Utils.EXT_SAFARI_RESOURCES);
+	Utils.cp("public/ext/shared", Utils.EXT_SAFARI_RESOURCES);
+	Utils.cp("public/ext/shared-dev", Utils.EXT_SAFARI_RESOURCES);
 	if (process.env.SAFARI_PLATFORM === "ios") {
 		Utils.cp(
 			"public/ext/safari-dev/manifest-ios.json",
-			`${Utils.SAFARI_EXT_RESOURCES}/manifest.json`,
+			`${Utils.EXT_SAFARI_RESOURCES}/manifest.json`,
 		);
 	} else {
 		Utils.cp(
 			"public/ext/safari-dev/manifest-mac.json",
-			`${Utils.SAFARI_EXT_RESOURCES}/manifest.json`,
+			`${Utils.EXT_SAFARI_RESOURCES}/manifest.json`,
 		);
 	}
 
@@ -81,7 +81,7 @@ async function buildResources(server, origin) {
 				},
 			],
 			build: {
-				outDir: `${Utils.SAFARI_EXT_RESOURCES}/dist/content-scripts/`,
+				outDir: `${Utils.EXT_SAFARI_RESOURCES}/dist/content-scripts/`,
 				emptyOutDir: false,
 				copyPublicDir: false,
 				rollupOptions: {
@@ -128,7 +128,7 @@ async function buildResources(server, origin) {
 			},
 		],
 		build: {
-			outDir: `${Utils.SAFARI_EXT_RESOURCES}/dist/`,
+			outDir: `${Utils.EXT_SAFARI_RESOURCES}/dist/`,
 			emptyOutDir: false,
 			rollupOptions: {
 				input: {

scripts/utils.js

@@ -35,8 +35,8 @@ import {
 const execFileAsync = promisify(execFile);
 
 /** Define shared constants */
-export const SAFARI_APP_RESOURCES = "xcode/App-Shared/Resources";
-export const SAFARI_EXT_RESOURCES = "xcode/Ext-Safari/Resources";
+export const APP_SHARED_RESOURCES = "xcode/App-Shared/Resources";
+export const EXT_SAFARI_RESOURCES = "xcode/Ext-Safari/Resources";
 
 /**
  * If not then cd to root dir and returns the path
@@ -59,7 +59,7 @@ export async function rootDir() {
  * @returns {Promise<boolean>}
  */
 export async function emptyBuildDir(dir) {
-	const buildPaths = ["dist", SAFARI_APP_RESOURCES, SAFARI_EXT_RESOURCES];
+	const buildPaths = ["dist", EXT_SAFARI_RESOURCES];
 	if (!buildPaths.includes(dir)) {
 		console.error("Non-build path, cannot be empty.");
 		return false;