@jchat/addon-sdk 0.0.1 → 1.0.0-alpha.10

package/dist/vite.mjs

@@ -1,10 +1,341 @@
-import e from"node:fs";import t from"node:path";import{execFileSync as n}from"node:child_process";import r from"node:crypto";function i(n){return{name:`jchat-embed-css`,apply:`build`,writeBundle(){let r=t.resolve(process.cwd(),`build`);if(!e.existsSync(r))return;let i=e.readdirSync(r),a=i.find(e=>e.endsWith(`.css`)),o=i.find(e=>e.includes(`ui`)&&e.endsWith(`.js`));if(!a||!o)return;let s=t.join(r,a),c=t.join(r,o),l=e.readFileSync(s,`utf-8`),u=e.readFileSync(c,`utf-8`);l.length<10?l=``:n?.id&&(l=l.replace(/:root\s*\{[^}]+\}/g,``),l=l.replace(/\.dark\s*\{[^}]+\}/g,``),l=l.replace(/\[data-theme=[^\]]+\]\s*\{[^}]+\}/g,``),l=l.replace(/\.dark\s*\[data-theme=[^\]]+\]\s*\{[^}]+\}/g,``),l=`@scope (#addon-${n.id}) {\n*, ::before, ::after { border-color: var(--border); }\n${l}\n}`),u=`
+import fs from "node:fs";
+import path from "node:path";
+import crypto from "node:crypto";
+//#region src/vite.ts
+/**
+* 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;
+	let shouldZip = options.zip;
+	let developmentBuild = false;
+	return {
+		name: "jchat-addon",
+		apply: "build",
+		config(_, env) {
+			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 = 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() {
+			const rootDir = process.cwd();
+			const pkgPath = path.resolve(rootDir, "package.json");
+			if (!fs.existsSync(pkgPath)) return;
+			const pkg = JSON.parse(fs.readFileSync(pkgPath, "utf-8"));
+			const buildDir = path.resolve(rootDir, "build");
+			if (!fs.existsSync(buildDir)) return;
+			const bundleFile = fs.readdirSync(buildDir).find((f) => f.includes("ui") && f.endsWith(".js"));
+			if (!bundleFile) return;
+			if (options.css !== false) embedCssIntoBundle(buildDir, manifestData.id);
+			let manifest = {
+				...manifestData,
+				version: pkg.version,
+				frontend: {
+					...manifestData.frontend,
+					bundle: `./${bundleFile}`,
+					mountPoints: manifestData.frontend?.mountPoints ?? []
+				}
+			};
+			const serverSrcPath = path.resolve(rootDir, "src/api.ts");
+			const hasServer = await Bun.file(serverSrcPath).exists();
+			if (hasServer) {
+				Bun.spawnSync(["bun", ...createAddonServerBuildArguments(serverSrcPath, path.resolve(buildDir, "api.js"), developmentBuild)], { stdio: [
+					"inherit",
+					"inherit",
+					"inherit"
+				] });
+				manifest = {
+					...manifest,
+					server: {
+						...manifest.server,
+						bundle: "./api.js"
+					}
+				};
+			}
+			const databaseFiles = [...manifest.server?.migrations ?? [], ...manifest.server?.seeds ?? []];
+			for (const directory of ["migrations", "seeds"]) fs.rmSync(path.resolve(buildDir, directory), {
+				recursive: true,
+				force: true
+			});
+			for (const relativePath of databaseFiles) {
+				if (path.isAbsolute(relativePath) || relativePath.includes("\\") || relativePath.split("/").includes("..")) throw new Error(`Unsafe addon database file path: ${relativePath}`);
+				const destination = path.resolve(buildDir, relativePath);
+				fs.mkdirSync(path.dirname(destination), { recursive: true });
+			}
+			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) {
+					const archivePaths = [
+						"manifest.json",
+						bundleFile,
+						...manifest.server?.migrations ?? [],
+						...manifest.server?.seeds ?? []
+					];
+					if (hasServer) archivePaths.push("api.js");
+					const resolvedFiles = await Promise.all(archivePaths.map(async (file) => ({
+						path: file,
+						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);
+			await Bun.write(path.resolve(buildDir, "manifest.json"), manifestJson);
+			if (shouldZip) {
+				const zipName = `${manifest.id}-${pkg.version}.zip`;
+				const filesToZip = ["manifest.json", bundleFile];
+				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");
+				Bun.spawnSync([
+					"tar",
+					"-a",
+					"-cf",
+					zipName,
+					...filesToZip
+				], {
+					cwd: buildDir,
+					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",
+		entryPath,
+		"--target=bun",
+		"--format=esm",
+		`--outfile=${outputPath}`,
+		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 = {
+		...manifest,
+		signature: {
+			algorithm: "rsa-sha256",
+			digest: "",
+			value: ""
+		}
+	};
+	const hash = crypto.createHash("sha256");
+	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);
+		hash.update("\0");
+	}
+	const digest = hash.digest("hex");
+	return {
+		...unsigned,
+		signature: {
+			algorithm: "rsa-sha256",
+			digest,
+			value: crypto.sign("sha256", Buffer.from(digest), privateKey).toString("base64url")
+		}
+	};
+}
+/**
+* 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;
+	throw new Error("Database-bearing addon builds require JCHAT_ADDON_SIGNING_PRIVATE_KEY");
+}
+function embedCssIntoBundle(buildDir, addonId) {
+	const files = fs.readdirSync(buildDir);
+	const cssFile = files.find((f) => f.endsWith(".css"));
+	const jsFile = files.find((f) => f.includes("ui") && f.endsWith(".js"));
+	if (!cssFile || !jsFile) return;
+	const cssPath = path.join(buildDir, cssFile);
+	const jsPath = path.join(buildDir, jsFile);
+	let css = fs.readFileSync(cssPath, "utf-8");
+	const js = fs.readFileSync(jsPath, "utf-8");
+	if (css.length < 10) css = "";
+	else {
+		css = css.replace(/:root\s*\{[^}]+\}/g, "");
+		css = css.replace(/\.dark\s*\{[^}]+\}/g, "");
+		css = css.replace(/\[data-theme=[^\]]+\]\s*\{[^}]+\}/g, "");
+		css = css.replace(/\.dark\s*\[data-theme=[^\]]+\]\s*\{[^}]+\}/g, "");
+		css = `@scope (#addon-${addonId}) {\n*, ::before, ::after { border-color: var(--border); }\n${css}\n}`;
+	}
+	const injection = `
 (function() {
-  if (typeof document !== 'undefined' && ${JSON.stringify(l)}.length > 0) {
+  if (typeof document !== 'undefined' && ${JSON.stringify(css)}.length > 0) {
     const style = document.createElement('style');
     style.type = 'text/css';
-    style.textContent = ${JSON.stringify(l)};
+    style.textContent = ${JSON.stringify(css)};
     document.head.appendChild(style);
   }
 })();
-`+u,e.writeFileSync(c,u);try{e.unlinkSync(s)}catch{}}}}function a(e,t,n){return[`build`,e,`--target=bun`,`--format=esm`,`--outfile=${t}`,n?`--sourcemap=external`:`--minify`]}function o(e){let t=e=>Array.isArray(e)?e.map(t):e&&typeof e==`object`?Object.fromEntries(Object.entries(e).sort(([e],[t])=>e.localeCompare(t)).map(([e,n])=>[e,t(n)])):e;return JSON.stringify(t(e))}function s(e,t,n){if(!e.publisher?.id)throw Error(`Signed addons require manifest.publisher.id`);let i={...e,signature:{algorithm:`rsa-sha256`,digest:``,value:``}},a=r.createHash(`sha256`);for(let e of[...t].sort((e,t)=>e.path.localeCompare(t.path)))a.update(e.path),a.update(`\0`),a.update(e.path===`manifest.json`?o(i):e.contents),a.update(`\0`);let s=a.digest(`hex`);return{...i,signature:{algorithm:`rsa-sha256`,digest:s,value:r.sign(`sha256`,Buffer.from(s),n).toString(`base64url`)}}}function c(e,t){if(e)return e;if(!t)throw Error(`Database-bearing addon builds require JCHAT_ADDON_SIGNING_PRIVATE_KEY`)}function l(r){let{manifest:i}=r,o=r.zip,l=!1;return{name:`jchat-addon`,apply:`build`,config(e,t){return{define:{"process.env.NODE_ENV":JSON.stringify(t.mode||`production`)}}},configResolved(e){l=e.mode===`development`,o===void 0&&(o=e.mode===`production`)},async writeBundle(){let u=process.cwd(),d=t.resolve(u,`package.json`);if(!e.existsSync(d))return;let f=JSON.parse(e.readFileSync(d,`utf-8`)),p=t.resolve(u,`build`);if(!e.existsSync(p))return;let m=e.readdirSync(p).find(e=>e.includes(`ui`)&&e.endsWith(`.js`));if(!m)return;let h={...i,version:f.version,frontend:{...i.frontend,bundle:`./${m}`,mountPoints:i.frontend?.mountPoints??[]}},g=t.resolve(u,`src/api.ts`),_=e.existsSync(g);_&&(n(`bun`,a(g,t.resolve(p,`api.js`),l),{stdio:`inherit`}),h={...h,server:{...h.server,bundle:`./api.js`}});let v=[...h.server?.migrations??[],...h.server?.seeds??[]];for(let n of[`migrations`,`seeds`])e.rmSync(t.resolve(p,n),{recursive:!0,force:!0});for(let n of v){if(t.isAbsolute(n)||n.includes(`\\`)||n.split(`/`).includes(`..`))throw Error(`Unsafe addon database file path: ${n}`);let r=t.resolve(u,n);if(!e.existsSync(r)||!e.statSync(r).isFile())throw Error(`Missing addon database file: ${n}`);let i=t.resolve(p,n);e.mkdirSync(t.dirname(i),{recursive:!0}),e.copyFileSync(r,i)}if(h.server?.migrations?.length||h.server?.seeds?.length){let n=c(r.signingPrivateKey??process.env.JCHAT_ADDON_SIGNING_PRIVATE_KEY,l);if(n){let r=[`manifest.json`,m,...h.server?.migrations??[],...h.server?.seeds??[]];_&&r.push(`api.js`),h=s(h,r.map(n=>({path:n,contents:n===`manifest.json`?Buffer.from(``):e.readFileSync(t.resolve(p,n))})),n)}}let y=JSON.stringify(h,null,2);if(e.writeFileSync(t.resolve(p,`manifest.json`),y),o){let r=`${h.id}-${f.version}.zip`,i=[`manifest.json`,m];e.existsSync(t.resolve(p,`api.js`))&&i.push(`api.js`);let a=t.resolve(p,`migrations`);e.existsSync(a)&&i.push(`migrations`);let o=t.resolve(p,`seeds`);e.existsSync(o)&&i.push(`seeds`),n(`tar`,[`-a`,`-cf`,r,...i],{cwd:p,stdio:`inherit`}),console.log(`Build Complete: ${h.id} v${f.version} → ${r}`)}}}}export{a as createAddonServerBuildArguments,l as jchatAddon,i as jchatEmbedCss,c as requireAddonSigningKey,s as signAddonManifest};
+`;
+	fs.writeFileSync(jsPath, injection + js);
+	try {
+		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) {
+	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": "0.0.1",
+  "version": "1.0.0-alpha.10",
   "private": false,
+  "description": "JChat Addon SDK for building JChat addons.",
   "keywords": [
     "addon",
     "chat",
@@ -11,10 +12,20 @@
     "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",
-    "README.md"
+    "tsconfig.addon.json",
+    "README.md",
+    "CHANGELOG.md"
   ],
   "type": "module",
   "main": "./dist/index.mjs",
@@ -24,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"
@@ -31,30 +46,48 @@
     "./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": "1.0.0-alpha.1",
-    "@types/react": "^19.2.17",
-    "elysia": "^1.4.29",
+    "@jchat/icon": "workspace:*",
+    "@jchat/ui": "workspace:*",
+    "@tailwindcss/vite": "catalog:",
+    "@tanstack/react-query": "catalog:",
+    "@types/bun": "catalog:",
+    "@types/react": "catalog:",
+    "elysia": "catalog:",
     "kysely": "^catalog:",
     "tsdown": "^0.22.14",
-    "vite": "^8.1.5"
+    "vite": "catalog:"
   },
   "peerDependencies": {
-    "elysia": "^1.4.29",
+    "@tailwindcss/vite": "catalog:",
+    "@tanstack/react-query": "catalog:",
+    "elysia": "catalog:",
     "kysely": "^catalog:",
-    "react": "^19.2.8",
-    "vite": "^8.1.5"
+    "react": "catalog:",
+    "vite": "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"]
+}