@jchat/addon-sdk 1.0.0-alpha.1 → 1.0.0-alpha.11

package/dist/vite.mjs

@@ -1,11 +1,28 @@
 import fs from "node:fs";
 import path from "node:path";
-import { execFileSync } from "node:child_process";
 import crypto from "node:crypto";
 //#region src/vite.ts
 /**
-* Vite plugin to configure Jchat addon manifest generation, bundle backend scripts, copy
-* migrations, declarative seed data, and zip production build artifacts.
+* Vite plugin for building JChat sandboxed addon extensions.
+*
+* Configures automatic manifest generation (`manifest.json`), bundles server-side API scripts
+* (`src/api.ts`), embeds scoped Tailwind CSS into the frontend bundle, packages database migrations
+* and seed files, copies documentation (`README.md`), signs database-bearing addon manifests, and
+* zips production build artifacts.
+*
+* @example
+*   ;```ts
+*   import { jchatAddon } from "@jchat/addon-sdk/vite"
+*   import manifest from "./src/manifest"
+*   import { defineConfig } from "vite"
+*
+*   export default defineConfig({
+*     plugins: [jchatAddon({ manifest })]
+*   })
+*   ```
+*
+* @param options - Configuration options for the JChat addon Vite plugin.
+* @returns A Vite {@link Plugin} instance configured for addon compilation.
 */
 function jchatAddon(options) {
 	const { manifest: manifestData } = options;
@@ -15,10 +32,45 @@ function jchatAddon(options) {
 		name: "jchat-addon",
 		apply: "build",
 		config(_, env) {
-			return { define: { "process.env.NODE_ENV": JSON.stringify(env.mode || "production") } };
+			const rootDir = process.cwd();
+			const uiEntry = path.resolve(rootDir, "src/ui.tsx");
+			const hasUi = fs.existsSync(uiEntry);
+			return {
+				define: {
+					global: "window",
+					"process.env.NODE_ENV": JSON.stringify(env.mode || "production")
+				},
+				build: {
+					outDir: "build",
+					emptyOutDir: true,
+					minify: env.mode === "production",
+					...hasUi ? {
+						lib: {
+							entry: uiEntry,
+							name: manifestData.id,
+							formats: ["es"],
+							fileName: () => "ui.[hash].js"
+						},
+						rolldownOptions: {
+							external: [
+								"react",
+								"react-dom",
+								"react/jsx-runtime",
+								"react/jsx-dev-runtime",
+								"jotai",
+								"react-hot-toast",
+								"@tanstack/react-query",
+								"@jchat/addon-sdk",
+								"@jchat/addon-sdk/ui"
+							],
+							output: { format: "esm" }
+						}
+					} : {}
+				}
+			};
 		},
 		configResolved(config) {
-			developmentBuild = config.mode === "development";
+			developmentBuild = options.development ?? (config.mode === "development" || process.env.JCHAT_ADDON_DEV === "true" || process.env.NODE_ENV === "development");
 			if (shouldZip === void 0) shouldZip = config.mode === "production";
 		},
 		async writeBundle() {
@@ -41,9 +93,13 @@ function jchatAddon(options) {
 				}
 			};
 			const serverSrcPath = path.resolve(rootDir, "src/api.ts");
-			const hasServer = fs.existsSync(serverSrcPath);
+			const hasServer = await Bun.file(serverSrcPath).exists();
 			if (hasServer) {
-				execFileSync("bun", createAddonServerBuildArguments(serverSrcPath, path.resolve(buildDir, "api.js"), developmentBuild), { stdio: "inherit" });
+				Bun.spawnSync(["bun", ...createAddonServerBuildArguments(serverSrcPath, path.resolve(buildDir, "api.js"), developmentBuild)], { stdio: [
+					"inherit",
+					"inherit",
+					"inherit"
+				] });
 				manifest = {
 					...manifest,
 					server: {
@@ -59,12 +115,15 @@ function jchatAddon(options) {
 			});
 			for (const relativePath of databaseFiles) {
 				if (path.isAbsolute(relativePath) || relativePath.includes("\\") || relativePath.split("/").includes("..")) throw new Error(`Unsafe addon database file path: ${relativePath}`);
-				const source = path.resolve(rootDir, relativePath);
-				if (!fs.existsSync(source) || !fs.statSync(source).isFile()) throw new Error(`Missing addon database file: ${relativePath}`);
 				const destination = path.resolve(buildDir, relativePath);
 				fs.mkdirSync(path.dirname(destination), { recursive: true });
-				fs.copyFileSync(source, destination);
 			}
+			await Promise.all(databaseFiles.map(async (relativePath) => {
+				const source = path.resolve(rootDir, relativePath);
+				if (!await Bun.file(source).exists() || !fs.statSync(source).isFile()) throw new Error(`Missing addon database file: ${relativePath}`);
+				const destination = path.resolve(buildDir, relativePath);
+				return Bun.write(destination, Bun.file(source));
+			}));
 			if (manifest.server?.migrations?.length || manifest.server?.seeds?.length) {
 				const signingPrivateKey = requireAddonSigningKey(options.signingPrivateKey ?? process.env.JCHAT_ADDON_SIGNING_PRIVATE_KEY, developmentBuild);
 				if (signingPrivateKey) {
@@ -75,36 +134,57 @@ function jchatAddon(options) {
 						...manifest.server?.seeds ?? []
 					];
 					if (hasServer) archivePaths.push("api.js");
-					manifest = signAddonManifest(manifest, archivePaths.map((file) => ({
+					const resolvedFiles = await Promise.all(archivePaths.map(async (file) => ({
 						path: file,
-						contents: file === "manifest.json" ? Buffer.from("") : fs.readFileSync(path.resolve(buildDir, file))
-					})), signingPrivateKey);
+						contents: file === "manifest.json" ? Buffer.from("") : Buffer.from(await Bun.file(path.resolve(buildDir, file)).arrayBuffer())
+					})));
+					manifest = signAddonManifest(manifest, resolvedFiles, signingPrivateKey);
 				}
 			}
+			const readmeSource = path.resolve(rootDir, "README.md");
+			if (await Bun.file(readmeSource).exists()) await Bun.write(path.resolve(buildDir, "README.md"), Bun.file(readmeSource));
+			const vendorLicensesContent = await generateAddonVendorLicenses(rootDir, manifest.name);
+			await Bun.write(path.resolve(buildDir, "vendor-licenses.txt"), vendorLicensesContent);
 			const manifestJson = JSON.stringify(manifest, null, 2);
-			fs.writeFileSync(path.resolve(buildDir, "manifest.json"), manifestJson);
+			await Bun.write(path.resolve(buildDir, "manifest.json"), manifestJson);
 			if (shouldZip) {
 				const zipName = `${manifest.id}-${pkg.version}.zip`;
 				const filesToZip = ["manifest.json", bundleFile];
-				if (fs.existsSync(path.resolve(buildDir, "api.js"))) filesToZip.push("api.js");
+				if (await Bun.file(path.resolve(buildDir, "api.js")).exists()) filesToZip.push("api.js");
+				if (await Bun.file(path.resolve(buildDir, "README.md")).exists()) filesToZip.push("README.md");
+				if (await Bun.file(path.resolve(buildDir, "vendor-licenses.txt")).exists()) filesToZip.push("vendor-licenses.txt");
 				const migrationsDest = path.resolve(buildDir, "migrations");
 				if (fs.existsSync(migrationsDest)) filesToZip.push("migrations");
 				const seedsDest = path.resolve(buildDir, "seeds");
 				if (fs.existsSync(seedsDest)) filesToZip.push("seeds");
-				execFileSync("tar", [
+				Bun.spawnSync([
+					"tar",
 					"-a",
 					"-cf",
 					zipName,
 					...filesToZip
 				], {
 					cwd: buildDir,
-					stdio: "inherit"
+					stdio: [
+						"inherit",
+						"inherit",
+						"inherit"
+					]
 				});
 				console.log(`Build Complete: ${manifest.id} v${pkg.version} → ${zipName}`);
 			}
 		}
 	};
 }
+/**
+* Generates CLI argument parameters for bundling server-side Elysia API scripts (`src/api.ts`) via
+* Bun.
+*
+* @param entryPath - Absolute file path to the server entry script (`src/api.ts`).
+* @param outputPath - Absolute destination file path for the bundled output (`build/api.js`).
+* @param developmentBuild - Indicates whether to enable external sourcemaps or minification.
+* @returns Array of command line arguments for running `bun build`.
+*/
 function createAddonServerBuildArguments(entryPath, outputPath, developmentBuild) {
 	return [
 		"build",
@@ -112,9 +192,17 @@ function createAddonServerBuildArguments(entryPath, outputPath, developmentBuild
 		"--target=bun",
 		"--format=esm",
 		`--outfile=${outputPath}`,
-		developmentBuild ? "--sourcemap=external" : "--minify"
+		developmentBuild ? "--sourcemap=inline" : "--minify"
 	];
 }
+/**
+* Cryptographically signs an addon manifest using RSA-SHA256 over all archive file contents.
+*
+* @param manifest - Unsigned or base addon manifest.
+* @param files - List of archive file paths and raw contents to digest.
+* @param privateKey - RSA private key in PEM format.
+* @returns Updated {@link AddonManifest} containing an RSA signature block.
+*/
 function signAddonManifest(manifest, files, privateKey) {
 	if (!manifest.publisher?.id) throw new Error("Signed addons require manifest.publisher.id");
 	const unsigned = {
@@ -126,7 +214,7 @@ function signAddonManifest(manifest, files, privateKey) {
 		}
 	};
 	const hash = crypto.createHash("sha256");
-	for (const file of [...files].sort((a, b) => a.path.localeCompare(b.path))) {
+	for (const file of [...files].toSorted((a, b) => a.path.localeCompare(b.path))) {
 		hash.update(file.path);
 		hash.update("\0");
 		hash.update(file.path === "manifest.json" ? stableStringify(unsigned) : file.contents);
@@ -142,6 +230,14 @@ function signAddonManifest(manifest, files, privateKey) {
 		}
 	};
 }
+/**
+* Resolves the required RSA signing key for database-bearing addons.
+*
+* @param signingPrivateKey - Provided signing key or undefined.
+* @param developmentBuild - Whether the current build is targeting development mode.
+* @returns Resolved signing key string or undefined (in dev builds).
+* @throws {@link Error} If building a database-bearing addon in production without a signing key.
+*/
 function requireAddonSigningKey(signingPrivateKey, developmentBuild) {
 	if (signingPrivateKey) return signingPrivateKey;
 	if (developmentBuild) return void 0;
@@ -179,13 +275,67 @@ function embedCssIntoBundle(buildDir, addonId) {
 		fs.unlinkSync(cssPath);
 	} catch {}
 }
+function sortValue(child) {
+	if (Array.isArray(child)) return child.map(sortValue);
+	if (child && typeof child === "object") return Object.fromEntries(Object.entries(child).toSorted(([left], [right]) => left.localeCompare(right)).map(([key, nested]) => [key, sortValue(nested)]));
+	return child;
+}
 function stableStringify(value) {
-	const sortValue = (child) => {
-		if (Array.isArray(child)) return child.map(sortValue);
-		if (child && typeof child === "object") return Object.fromEntries(Object.entries(child).sort(([left], [right]) => left.localeCompare(right)).map(([key, nested]) => [key, sortValue(nested)]));
-		return child;
-	};
 	return JSON.stringify(sortValue(value));
 }
+async function generateAddonVendorLicenses(addonDir, addonName) {
+	const title = addonName ? `${addonName} Addon` : "JChat Addon";
+	try {
+		const proc = Bun.spawn([
+			"bun",
+			"pm",
+			"licenses",
+			"--json",
+			"--prod"
+		], {
+			cwd: addonDir,
+			stdout: "pipe",
+			stderr: "pipe"
+		});
+		const output = await new Response(proc.stdout).text();
+		await proc.exited;
+		const data = JSON.parse(output);
+		const lines = [
+			"================================================================================",
+			`${title} - Third-Party Vendor Licenses & Open Source Attribution`,
+			"================================================================================",
+			"This distribution incorporates open-source libraries and software components.",
+			"Their licenses and attributions are listed below.",
+			"================================================================================",
+			""
+		];
+		let totalPackages = 0;
+		const sortedCategories = Object.keys(data).toSorted((a, b) => a.localeCompare(b));
+		for (const licenseCategory of sortedCategories) {
+			const packages = data[licenseCategory];
+			if (!packages || packages.length === 0) continue;
+			lines.push(`\n## License: ${licenseCategory} (${packages.length} packages)\n`);
+			for (const pkg of packages) {
+				totalPackages++;
+				lines.push(`- Package:     ${pkg.name}@${pkg.versions.join(", ")}`);
+				if (pkg.description) lines.push(`  Description: ${pkg.description}`);
+				if (pkg.author) lines.push(`  Author:      ${pkg.author}`);
+				if (pkg.homepage) lines.push(`  Homepage:    ${pkg.homepage}`);
+			}
+		}
+		lines.splice(5, 0, `Total Open-Source Dependencies: ${totalPackages}\n`);
+		return lines.join("\n") + "\n";
+	} catch {
+		return [
+			"================================================================================",
+			`${title} - Third-Party Vendor Licenses & Open Source Attribution`,
+			"================================================================================",
+			"This distribution incorporates open-source libraries and software components.",
+			"See individual package.json files and dependencies for specific license details.",
+			"================================================================================",
+			""
+		].join("\n");
+	}
+}
 //#endregion
 export { createAddonServerBuildArguments, jchatAddon, requireAddonSigningKey, signAddonManifest };

package/package.json

@@ -1,7 +1,8 @@
 {
   "name": "@jchat/addon-sdk",
-  "version": "1.0.0-alpha.1",
+  "version": "1.0.0-alpha.11",
   "private": false,
+  "description": "JChat Addon SDK for building JChat addons.",
   "keywords": [
     "addon",
     "chat",
@@ -11,15 +12,18 @@
     "sdk",
     "vite"
   ],
-  "license": "Apache-2.0",
+  "license": "SEE LICENSE IN LICENSE",
   "repository": {
     "type": "git",
     "url": "git+https://github.com/mjjabarullah/jchat.git",
     "directory": "packages/addon-sdk"
   },
+  "bin": {
+    "jchat-addon": "./dist/cli.mjs"
+  },
   "files": [
     "dist",
-    "src",
+    "tsconfig.addon.json",
     "README.md",
     "CHANGELOG.md"
   ],
@@ -31,6 +35,10 @@
       "types": "./dist/index.d.mts",
       "import": "./dist/index.mjs"
     },
+    "./cli": {
+      "types": "./dist/cli.d.mts",
+      "import": "./dist/cli.mjs"
+    },
     "./diagnostics": {
       "types": "./dist/diagnostics.d.mts",
       "import": "./dist/diagnostics.mjs"
@@ -38,20 +46,36 @@
     "./vite": {
       "types": "./dist/vite.d.mts",
       "import": "./dist/vite.mjs"
-    }
+    },
+    "./ui": {
+      "types": "./dist/ui.d.mts",
+      "import": "./dist/ui.mjs"
+    },
+    "./ui/tailwind.css": {
+      "style": "./src/tailwind.css",
+      "import": "./src/tailwind.css",
+      "default": "./src/tailwind.css"
+    },
+    "./tsconfig.json": "./tsconfig.addon.json"
   },
   "publishConfig": {
     "access": "public"
   },
   "scripts": {
     "build": "tsdown",
-    "lint": "oxlint . --config=../../oxlint.json",
+    "lint": "oxlint .",
     "format": "oxfmt . --write",
+    "test": "bun test",
     "typecheck": "tsc --noEmit",
     "prepack": "bun run build"
   },
+  "dependencies": {},
   "devDependencies": {
     "@jchat/icon": "workspace:*",
+    "@jchat/ui": "workspace:*",
+    "@tailwindcss/vite": "catalog:",
+    "@tanstack/react-query": "catalog:",
+    "@types/bun": "catalog:",
     "@types/react": "catalog:",
     "elysia": "catalog:",
     "kysely": "^catalog:",
@@ -59,6 +83,8 @@
     "vite": "catalog:"
   },
   "peerDependencies": {
+    "@tailwindcss/vite": "catalog:",
+    "@tanstack/react-query": "catalog:",
     "elysia": "catalog:",
     "kysely": "^catalog:",
     "react": "catalog:",

package/tsconfig.addon.json

@@ -0,0 +1,20 @@
+{
+  "$schema": "https://json.schemastore.org/tsconfig",
+  "display": "JChat Addon Base",
+  "compilerOptions": {
+    "target": "ESNext",
+    "module": "ESNext",
+    "moduleResolution": "bundler",
+    "lib": ["ESNext", "DOM", "DOM.Iterable"],
+    "jsx": "react-jsx",
+    "strict": true,
+    "esModuleInterop": true,
+    "verbatimModuleSyntax": true,
+    "resolveJsonModule": true,
+    "skipLibCheck": true,
+    "isolatedModules": true,
+    "noEmit": true,
+    "types": ["bun", "vite/client"]
+  },
+  "exclude": ["build", "dist", "node_modules"]
+}

package/src/contracts.d.ts

@@ -1,127 +0,0 @@
-export type AddonPermission = string;
-/**
- * Defines a single configuration field for an addon's settings panel. These are shown to site
- * admins in the Jchat dashboard.
- */
-export interface ConfigSchemaField {
-    /** Unique key used to store and retrieve the value in `getConfig` */
-    key: string;
-    /** Data type for validation and UI rendering */
-    type: "string" | "number" | "boolean";
-    /** Human-readable label shown in the settings UI */
-    label: string;
-    /** If true, the admin must provide a value before saving */
-    required?: boolean;
-    /** Whether the value is sensitive (encrypted at rest and masked in the UI) */
-    secret?: boolean;
-    /** Default value pre-filled in the settings form for new installations */
-    default?: string | number | boolean;
-}
-/** Definition of a custom permission introduced by an addon. */
-export interface AddonPermissionDefinition {
-    /** Permission identifier (recommended: `addon.<id>.<action>`) */
-    name: string;
-    /** Short, human-readable name for the permission */
-    label: string;
-    /** Detailed description of what the permission grants (shown in Rank editor) */
-    description: string;
-}
-/** Valid locations where an addon can be rendered within the Jchat layout. */
-export declare const MOUNT_POINTS: {
-    /** Top of the main chat column */
-    readonly CHAT_HEADER: "chat-header";
-    /** Below the main chat header, above messages */
-    readonly CHAT_TOOLBAR: "chat-toolbar";
-    /** The persistent right-side sidebar */
-    readonly CHAT_SIDEBAR: "chat-sidebar";
-    /** Top of the left sidebar (room list) */
-    readonly SIDEBAR_TOP: "sidebar-top";
-    /** Bottom of the left sidebar */
-    readonly SIDEBAR_BOTTOM: "sidebar-bottom";
-    /** Action list shown when clicking a user's avatar */
-    readonly USER_POPOVER_ACTIONS: "user-popover-actions";
-    /** Menu shown when right-clicking a message */
-    readonly MESSAGE_CONTEXT_MENU: "message-context-menu";
-    /** Floating overlay rendered on top of the message stream */
-    readonly MESSAGE_FEED_OVERLAY: "message-feed-overlay";
-    /** Main admin dashboard area */
-    readonly ADMIN_PANEL: "admin-panel";
-    /** User or site settings dashboard area */
-    readonly SETTINGS_PANEL: "settings-panel";
-    /** The 'plus' (+) menu in the message composer */
-    readonly CHAT_PLUS_MENU: "chat-plus-menu";
-    /** Custom tab in the emoji/gif selection panel */
-    readonly EMOJI_PICKER_GIF_TAB: "emoji-picker-gif-tab";
-    /** Full-screen or modal dialog specifically for TubeScan */
-    readonly TUBESCAN_DIALOG: "tubescan-dialog";
-};
-/** Union type of all valid addon mount points. */
-export type MountPoint = (typeof MOUNT_POINTS)[keyof typeof MOUNT_POINTS];
-/**
- * The `manifest.json` schema required for every Jchat addon. This file describes how the addon is
- * identified and mounted.
- */
-export interface AddonManifest {
-    /** Unique kebab-case addon identifier (must match the folder name) */
-    id: string;
-    /** Human-readable addon name */
-    name: string;
-    /** Semver version string (e.g. `1.2.0`) */
-    version: string;
-    /** Brief summary of what the addon does */
-    description?: string;
-    /** Author name, organization, or GitHub handle */
-    author?: string;
-    /** Support or documentation URL */
-    homepage?: string;
-    /** SPDX license identifier (e.g. `MIT`) */
-    license?: string;
-    /** Host and SDK versions this directly executed plugin was built and tested against */
-    compatibility: {
-        /** Supported JChat versions as a semantic-version range, for example `^1.0.0` */
-        jchat: string;
-        /** Supported `@jchat/addon-sdk` versions as a semantic-version range */
-        addonSdk: string;
-    };
-    /** Identity of the trusted publisher that signed this package. Required when migrations exist */
-    publisher?: {
-        id: string;
-    };
-    /** Signature over the canonical archive digest. Required when migrations exist */
-    signature?: {
-        algorithm: "rsa-sha256";
-        digest: string;
-        value: string;
-    };
-    /** Configuration for the React-based frontend bundle */
-    frontend?: {
-        /** Relative path to the pre-compiled ESM bundle (created by Vite) */
-        bundle: string;
-        /** List of UI locations where this addon should be active */
-        mountPoints: MountPoint[];
-        /** Optional path to a specific UI for the settings panel */
-        settings?: string;
-        /** Additional shared packages this addon imports from the host */
-        externals?: string[];
-    };
-    /** Configuration for the server-side API bundle */
-    server?: {
-        /** Relative path to the pre-compiled server bundle */
-        bundle?: string;
-        /** List of SQL files to run (in order) to set up the addon's database tables */
-        migrations?: string[];
-        /** List of declarative JSON master-data files to apply once, in order */
-        seeds?: string[];
-    };
-    /**
-     * The minimum permission required to see or use this addon. If provided, the host gates
-     * visibility in the UI and access to all server routes.
-     */
-    accessPermission?: AddonPermission;
-    /** Full list of all permissions used by this addon for informational purposes */
-    permissions?: AddonPermission[];
-    /** Custom permissions that should be registered with the host application on installation */
-    permissionDefinitions?: AddonPermissionDefinition[];
-    /** Settings form structure shown to site admins. Values are stored encrypted per site */
-    configSchema?: ConfigSchemaField[];
-}

package/src/contracts.ts

@@ -1,132 +0,0 @@
-export type AddonPermission = string
-
-/**
- * Defines a single configuration field for an addon's settings panel. These are shown to site
- * admins in the Jchat dashboard.
- */
-export interface ConfigSchemaField {
-  /** Unique key used to store and retrieve the value in `getConfig` */
-  key: string
-  /** Data type for validation and UI rendering */
-  type: "string" | "number" | "boolean"
-  /** Human-readable label shown in the settings UI */
-  label: string
-  /** If true, the admin must provide a value before saving */
-  required?: boolean
-  /** Whether the value is sensitive (encrypted at rest and masked in the UI) */
-  secret?: boolean
-  /** Default value pre-filled in the settings form for new installations */
-  default?: string | number | boolean
-}
-
-/** Definition of a custom permission introduced by an addon. */
-export interface AddonPermissionDefinition {
-  /** Permission identifier (recommended: `addon.<id>.<action>`) */
-  name: string
-  /** Short, human-readable name for the permission */
-  label: string
-  /** Detailed description of what the permission grants (shown in Rank editor) */
-  description: string
-}
-
-/** Valid locations where an addon can be rendered within the Jchat layout. */
-export const MOUNT_POINTS = {
-  /** Top of the main chat column */
-  CHAT_HEADER: "chat-header",
-  /** Below the main chat header, above messages */
-  CHAT_TOOLBAR: "chat-toolbar",
-  /** The persistent right-side sidebar */
-  CHAT_SIDEBAR: "chat-sidebar",
-  /** Top of the left sidebar (room list) */
-  SIDEBAR_TOP: "sidebar-top",
-  /** Bottom of the left sidebar */
-  SIDEBAR_BOTTOM: "sidebar-bottom",
-  /** Action list shown when clicking a user's avatar */
-  USER_POPOVER_ACTIONS: "user-popover-actions",
-  /** Menu shown when right-clicking a message */
-  MESSAGE_CONTEXT_MENU: "message-context-menu",
-  /** Floating overlay rendered on top of the message stream */
-  MESSAGE_FEED_OVERLAY: "message-feed-overlay",
-  /** Main admin dashboard area */
-  ADMIN_PANEL: "admin-panel",
-  /** User or site settings dashboard area */
-  SETTINGS_PANEL: "settings-panel",
-  /** The 'plus' (+) menu in the message composer */
-  CHAT_PLUS_MENU: "chat-plus-menu",
-  /** Custom tab in the emoji/gif selection panel */
-  EMOJI_PICKER_GIF_TAB: "emoji-picker-gif-tab",
-  /** Full-screen or modal dialog specifically for TubeScan */
-  TUBESCAN_DIALOG: "tubescan-dialog"
-} as const
-
-/** Union type of all valid addon mount points. */
-export type MountPoint = (typeof MOUNT_POINTS)[keyof typeof MOUNT_POINTS]
-
-/**
- * The `manifest.json` schema required for every Jchat addon. This file describes how the addon is
- * identified and mounted.
- */
-export interface AddonManifest {
-  /** Unique kebab-case addon identifier (must match the folder name) */
-  id: string
-  /** Human-readable addon name */
-  name: string
-  /** Semver version string (e.g. `1.2.0`) */
-  version: string
-  /** Brief summary of what the addon does */
-  description?: string
-  /** Author name, organization, or GitHub handle */
-  author?: string
-  /** Support or documentation URL */
-  homepage?: string
-  /** SPDX license identifier (e.g. `MIT`) */
-  license?: string
-  /** Host and SDK versions this directly executed plugin was built and tested against */
-  compatibility: {
-    /** Supported JChat versions as a semantic-version range, for example `^1.0.0` */
-    jchat: string
-    /** Supported `@jchat/addon-sdk` versions as a semantic-version range */
-    addonSdk: string
-  }
-  /** Identity of the trusted publisher that signed this package. Required when migrations exist */
-  publisher?: {
-    id: string
-  }
-  /** Signature over the canonical archive digest. Required when migrations exist */
-  signature?: {
-    algorithm: "rsa-sha256"
-    digest: string
-    value: string
-  }
-  /** Configuration for the React-based frontend bundle */
-  frontend?: {
-    /** Relative path to the pre-compiled ESM bundle (created by Vite) */
-    bundle: string
-    /** List of UI locations where this addon should be active */
-    mountPoints: MountPoint[]
-    /** Optional path to a specific UI for the settings panel */
-    settings?: string
-    /** Additional shared packages this addon imports from the host */
-    externals?: string[]
-  }
-  /** Configuration for the server-side API bundle */
-  server?: {
-    /** Relative path to the pre-compiled server bundle */
-    bundle?: string
-    /** List of SQL files to run (in order) to set up the addon's database tables */
-    migrations?: string[]
-    /** List of declarative JSON master-data files to apply once, in order */
-    seeds?: string[]
-  }
-  /**
-   * The minimum permission required to see or use this addon. If provided, the host gates
-   * visibility in the UI and access to all server routes.
-   */
-  accessPermission?: AddonPermission
-  /** Full list of all permissions used by this addon for informational purposes */
-  permissions?: AddonPermission[]
-  /** Custom permissions that should be registered with the host application on installation */
-  permissionDefinitions?: AddonPermissionDefinition[]
-  /** Settings form structure shown to site admins. Values are stored encrypted per site */
-  configSchema?: ConfigSchemaField[]
-}

package/src/diagnostics.d.ts

@@ -1,19 +0,0 @@
-import type { AddonManifest } from "./contracts";
-export type AddonDiagnosticStatus = "pass" | "warning" | "error";
-export interface AddonPackageDiagnostic {
-    id: string;
-    label: string;
-    status: AddonDiagnosticStatus;
-    message: string;
-}
-export interface AddonPackageDiagnosticOptions {
-    buildDir: string;
-    manifest: AddonManifest;
-    jchatVersion: string;
-    addonSdkVersion: string;
-    productionPackage?: boolean;
-    maxBytes?: number;
-}
-export declare function createCompatibleMajorRange(version: string): string;
-export declare function diagnoseAddonPackage(options: AddonPackageDiagnosticOptions): AddonPackageDiagnostic[];
-export declare function hasAddonDiagnosticErrors(diagnostics: readonly AddonPackageDiagnostic[]): boolean;