@chat-js/cli 0.4.0 → 0.6.0

package/templates/electron/README.md

@@ -0,0 +1,54 @@
+# Electron Desktop App
+
+This directory contains the Electron wrapper for your ChatJS app.
+
+## Development
+
+Make sure the Next.js web app is running first (`bun run dev` in the parent directory), then:
+
+```bash
+bun install
+bun run dev
+```
+
+`bun run dev` points Electron at `http://localhost:3000` by default. You can override
+that during development with `ELECTRON_APP_URL=... bun run dev`.
+
+## Customization
+
+### App Icon
+
+Replace `icon.png` with your own 512×512 PNG. Then regenerate the platform icons:
+
+```bash
+bun run generate-icons
+```
+
+This produces the generated assets in `build/` used by Electron Forge.
+
+### App Name & ID
+
+The app name, protocol prefix, and production URL are generated from your ChatJS config before each build. Use `forge.config.ts` only for packaging-specific overrides:
+
+- `appName` controls the display name shown in the OS
+- `appPrefix` controls the bundle identifier prefix and protocol scheme
+
+### Protocol Scheme (Deep Links)
+
+The `APP_SCHEME` in `src/config.ts` controls the custom URL scheme used for OAuth deep links (e.g. `yourapp://`). It must match the `protocols` entries in `forge.config.ts`.
+
+### Production URL
+
+Update `appUrl` in `apps/chat/chat.config.ts` for your deployed site. Packaged Electron
+builds use that URL by default, while development uses `http://localhost:3000` unless
+`ELECTRON_APP_URL` is set.
+
+## Building for Distribution
+
+```bash
+bun run make:mac   # macOS .dmg and .zip
+bun run make:win   # Windows installer
+bun run make:linux # Linux .deb and .rpm
+```
+
+Forge outputs are written to `out/`.

package/templates/electron/entitlements.mac.plist

@@ -0,0 +1,10 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!DOCTYPE plist PUBLIC "-//Apple//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd">
+<plist version="1.0">
+  <dict>
+    <key>com.apple.security.cs.allow-jit</key>
+    <true/>
+    <key>com.apple.security.network.client</key>
+    <true/>
+  </dict>
+</plist>

package/templates/electron/forge.config.ts

@@ -0,0 +1,157 @@
+import { existsSync, readFileSync, rmSync } from "node:fs";
+import { join } from "node:path";
+import { spawnSync } from "node:child_process";
+import type { ForgeConfig } from "@electron-forge/shared-types";
+import { MakerDeb } from "@electron-forge/maker-deb";
+import { MakerDMG } from "@electron-forge/maker-dmg";
+import { MakerRpm } from "@electron-forge/maker-rpm";
+import { MakerSquirrel } from "@electron-forge/maker-squirrel";
+import { MakerZIP } from "@electron-forge/maker-zip";
+
+type Branding = {
+  appName: string;
+  appPrefix: string;
+  appUrl: string;
+  orgName?: string;
+  orgEmail?: string;
+};
+
+const appRoot = __dirname;
+const brandingPath = join(appRoot, "branding.json");
+let prebuildComplete = false;
+
+function loadBranding(): Branding {
+  ensurePrebuild();
+
+  if (!existsSync(brandingPath)) {
+    throw new Error(
+      `Electron packaging requires ${brandingPath}, but it was not generated by prebuild. ` +
+        `Run \`bun run prebuild\` in ${appRoot} and try again.`
+    );
+  }
+
+  const branding = JSON.parse(readFileSync(brandingPath, "utf8")) as Partial<Branding>;
+
+  if (!branding.appName || !branding.appPrefix || !branding.appUrl) {
+    throw new Error(
+      `Electron branding file ${brandingPath} is invalid. Expected appName, appPrefix, and appUrl.`
+    );
+  }
+
+  return branding as Branding;
+}
+
+function runBunScript(script: string, env: NodeJS.ProcessEnv = {}): void {
+  const result = spawnSync("bun", ["run", script], {
+    stdio: "inherit",
+    env: { ...process.env, ...env },
+  });
+
+  if (result.status !== 0) {
+    throw new Error(`bun run ${script} failed with exit code ${result.status ?? "unknown"}`);
+  }
+}
+
+function ensurePrebuild(): void {
+  if (prebuildComplete) {
+    return;
+  }
+
+  runBunScript("prebuild");
+  prebuildComplete = true;
+}
+
+function removeLocalNodeModules(): void {
+  rmSync(join(appRoot, "node_modules"), { recursive: true, force: true });
+}
+
+function createForgeConfig(): ForgeConfig {
+  const branding = loadBranding();
+  const { appName, appPrefix, orgName, orgEmail } = branding;
+
+  return {
+    packagerConfig: {
+      name: appName,
+      executableName: appPrefix,
+      icon: "./build/icon",
+      appBundleId: `dev.${appPrefix}.app`,
+      appCategoryType: "public.app-category.productivity",
+      asar: true,
+      protocols: [
+        {
+          name: `${appName} Auth`,
+          schemes: [appPrefix],
+        },
+      ],
+      ignore: [
+        /^\/out($|\/)/,
+        /^\/release($|\/)/,
+        /^\/src($|\/)/,
+        /^\/node_modules($|\/)/,
+        /^\/scripts($|\/)/,
+        /^\/README\.md$/,
+        /^\/tsconfig\.json$/,
+      ],
+    },
+    makers: [
+      new MakerZIP({}, ["darwin"]),
+      new MakerDMG(
+        {
+          name: `${appName}-mac`,
+        },
+        ["darwin"]
+      ),
+      new MakerSquirrel(
+        {
+          name: appPrefix,
+          authors: orgName ?? appName,
+          description: `${appName} desktop application`,
+          setupExe: `${appName}-windows.exe`,
+        },
+        ["win32"]
+      ),
+      new MakerDeb(
+        {
+          options: {
+            bin: appPrefix,
+            maintainer:
+              orgName && orgEmail
+                ? `${orgName} <${orgEmail}>`
+                : (orgName ?? orgEmail ?? appName),
+            homepage: branding.appUrl,
+            icon: "./build/icon.png",
+            categories: ["Utility"],
+          },
+        },
+        ["linux"]
+      ),
+      new MakerRpm(
+        {
+          options: {
+            bin: appPrefix,
+            homepage: branding.appUrl,
+            icon: "./build/icon.png",
+            license: "Apache-2.0",
+          },
+        },
+        ["linux"]
+      ),
+    ],
+    hooks: {
+      generateAssets: async () => {
+        ensurePrebuild();
+      },
+      preStart: async () => {
+        runBunScript("build", { NODE_ENV: "development" });
+      },
+      prePackage: async () => {
+        runBunScript("build", { NODE_ENV: "production" });
+        removeLocalNodeModules();
+      },
+    },
+  };
+}
+
+const config = createForgeConfig();
+
+export default config;

package/templates/electron/package.json

@@ -0,0 +1,53 @@
+{
+	"name": "__PROJECT_NAME__-electron",
+	"version": "0.3.0",
+	"private": true,
+	"description": "ChatJS desktop application",
+	"repository": {
+		"type": "git",
+		"url": "https://github.com/__GITHUB_OWNER__/__GITHUB_REPO__.git"
+	},
+	"author": {
+		"name": "ChatJS",
+		"email": "support@chatjs.dev"
+	},
+	"homepage": "https://demo.chatjs.dev",
+	"main": "dist/main.js",
+	"scripts": {
+		"forge": "node ./scripts/run-forge.cjs",
+		"generate-icons": "bun scripts/generate-icons.ts",
+		"prebuild": "bun scripts/write-branding.ts && bun run generate-icons",
+		"build": "bun build src/main.ts --target=node --format=cjs --outfile dist/main.js --external electron && bun build src/preload.ts --target=browser --format=cjs --outfile dist/preload.js --external electron",
+		"start": "bun run forge start",
+		"dev": "bun run start",
+		"package": "bun run forge package",
+		"make": "bun run forge make",
+		"make:mac": "bun run forge make --platform=darwin --arch=universal",
+		"make:win": "bun run forge make --platform=win32 --arch=x64",
+		"make:linux": "bun run forge make --platform=linux --arch=x64",
+		"publish": "bun run forge publish",
+		"electron:build": "bun run build",
+		"electron:dev": "bun run dev",
+		"electron:make": "bun run make",
+		"electron:publish": "bun run publish"
+	},
+	"dependencies": {},
+	"devDependencies": {
+		"@better-auth/electron": "^1.5.6",
+		"@electron-forge/cli": "^7.11.1",
+		"@electron-forge/maker-deb": "^7.11.1",
+		"@electron-forge/maker-dmg": "^7.11.1",
+		"@electron-forge/maker-rpm": "^7.11.1",
+		"@electron-forge/maker-squirrel": "^7.11.1",
+		"@electron-forge/maker-zip": "^7.11.1",
+		"@electron-forge/shared-types": "^7.11.1",
+		"@types/node": "^22.8.6",
+		"better-auth": "^1.5.6",
+		"conf": "^15.1.0",
+		"electron": "36.0.0",
+		"png2icons": "^2.0.1",
+		"supports-color": "^7.2.0",
+		"typescript": "5.8.3",
+		"update-electron-app": "^3.1.2"
+	}
+}

package/templates/electron/scripts/generate-icons.test.js

@@ -0,0 +1,37 @@
+const { existsSync, rmSync } = require("node:fs");
+const { join, resolve } = require("node:path");
+const { spawnSync } = require("node:child_process");
+const { describe, expect, test } = require("bun:test");
+const forgeConfig = require("../forge.config").default;
+
+const appRoot = resolve(__dirname, "..");
+const buildDir = join(appRoot, "build");
+const outputFiles = ["icon.png", "icon.icns", "icon.ico"];
+
+function cleanupGeneratedIcons() {
+  for (const file of outputFiles) {
+    rmSync(join(buildDir, file), { force: true });
+  }
+}
+
+describe("generate-icons", () => {
+  test("writes Forge-compatible icon assets", () => {
+    cleanupGeneratedIcons();
+
+    const result = spawnSync("bun", ["scripts/generate-icons.ts"], {
+      cwd: appRoot,
+      stdio: "pipe",
+      encoding: "utf8",
+    });
+
+    expect(result.status).toBe(0);
+
+    for (const file of outputFiles) {
+      expect(existsSync(join(buildDir, file))).toBe(true);
+    }
+  });
+
+  test("forge config points packager at generated icons", () => {
+    expect(forgeConfig.packagerConfig?.icon).toBe("./build/icon");
+  });
+});

package/templates/electron/scripts/generate-icons.ts

@@ -0,0 +1,29 @@
+import { copyFileSync, mkdirSync, readFileSync, writeFileSync } from "node:fs";
+import { join, resolve } from "node:path";
+import * as png2icons from "png2icons";
+
+const root = resolve(__dirname, "..");
+const src = join(root, "icon.png");
+const buildDir = join(root, "build");
+const outputBase = join(buildDir, "icon");
+
+mkdirSync(buildDir, { recursive: true });
+
+const sourcePng = readFileSync(src);
+const icns = png2icons.createICNS(sourcePng, png2icons.BICUBIC2, 0);
+const ico = png2icons.createICO(sourcePng, png2icons.BICUBIC2, 0, false, true);
+
+if (!icns) {
+  throw new Error("Failed to generate build/icon.icns");
+}
+
+if (!ico) {
+  throw new Error("Failed to generate build/icon.ico");
+}
+
+copyFileSync(src, `${outputBase}.png`);
+writeFileSync(`${outputBase}.icns`, icns);
+writeFileSync(`${outputBase}.ico`, ico);
+png2icons.clearCache();
+
+console.log("Generated build/icon.{png,icns,ico}");

package/templates/electron/scripts/run-forge.cjs

@@ -0,0 +1,28 @@
+const { spawnSync } = require("node:child_process");
+const path = require("node:path");
+
+const candidates = [
+  path.resolve(__dirname, "..", "..", "..", "node_modules", "@electron-forge", "cli", "dist", "electron-forge.js"),
+  path.resolve(__dirname, "..", "node_modules", "@electron-forge", "cli", "dist", "electron-forge.js"),
+];
+
+const forgeEntrypoint = candidates.find((candidate) => {
+  try {
+    require("node:fs").accessSync(candidate);
+    return true;
+  } catch {
+    return false;
+  }
+});
+
+if (!forgeEntrypoint) {
+  console.error("Could not locate @electron-forge/cli.");
+  process.exit(1);
+}
+
+const result = spawnSync(process.execPath, [forgeEntrypoint, ...process.argv.slice(2)], {
+  stdio: "inherit",
+  env: process.env,
+});
+
+process.exit(result.status ?? 1);

package/templates/electron/scripts/write-branding.ts

@@ -0,0 +1,18 @@
+import { writeFileSync } from "node:fs";
+import { resolve } from "node:path";
+import { config } from "@/lib/config";
+
+const { appName, appPrefix, appUrl, organization } = config;
+const orgEmail =
+  organization.contact?.privacyEmail || organization.contact?.legalEmail;
+
+writeFileSync(
+  resolve(__dirname, "..", "branding.json"),
+  JSON.stringify(
+    { appName, appPrefix, appUrl, orgName: organization.name, orgEmail },
+    null,
+    2
+  )
+);
+
+console.log("branding.json written:", { appName, appPrefix, appUrl });

package/templates/electron/src/config.ts

@@ -0,0 +1,16 @@
+import { config } from "@/lib/config";
+
+export const APP_NAME = config.appName;
+export const APP_SCHEME = config.appPrefix;
+const DEFAULT_DEV_APP_URL = "http://localhost:3000";
+
+export const APP_URL =
+  process.env.ELECTRON_APP_URL ||
+  (process.env.NODE_ENV === "production" ? config.appUrl : DEFAULT_DEV_APP_URL);
+
+export const WINDOW_DEFAULTS = {
+  width: 1280,
+  height: 800,
+  minWidth: 800,
+  minHeight: 600,
+} as const;

package/templates/electron/src/lib/auth-client.ts

@@ -0,0 +1,64 @@
+import { safeStorage } from "electron";
+import { electronClient } from "@better-auth/electron/client";
+import { storage } from "@better-auth/electron/storage";
+import { createAuthClient } from "better-auth/client";
+import {
+  ELECTRON_AUTH_CALLBACK_PATH,
+  ELECTRON_AUTH_CLIENT_ID,
+  ELECTRON_AUTH_COOKIE_PREFIX,
+} from "@/lib/electron-auth";
+import { APP_SCHEME, APP_URL } from "../config";
+
+if (process.env.NODE_ENV !== "production") {
+  Object.defineProperty(safeStorage, "isEncryptionAvailable", {
+    configurable: true,
+    value: () => false,
+  });
+}
+
+const memoryStorage = () => {
+  const store = new Map<string, string>();
+
+  return {
+    getItem: (key: string) => store.get(key) ?? null,
+    setItem: (key: string, value: string) => {
+      store.set(key, value);
+    },
+  };
+};
+
+const electronAuthStorage =
+  process.env.NODE_ENV === "production" ? storage() : memoryStorage();
+
+export const authClient = createAuthClient({
+  baseURL: APP_URL,
+  plugins: [
+    electronClient({
+      callbackPath: ELECTRON_AUTH_CALLBACK_PATH,
+      clientID: ELECTRON_AUTH_CLIENT_ID,
+      cookiePrefix: ELECTRON_AUTH_COOKIE_PREFIX,
+      signInURL: `${APP_URL}/device-login`,
+      protocol: {
+        scheme: APP_SCHEME,
+      },
+      storage: electronAuthStorage,
+      // `as any`: @better-auth/electron does not export a typed Storage union
+      // compatible with both `storage()` and our in-memory shim, and the
+      // plugin's inferred return type leaks through to createAuthClient.
+    }) as any,
+  ],
+});
+
+export type ElectronAuthClient = typeof authClient & {
+  authenticate: (data: { token: string }) => Promise<unknown>;
+  getCookie: () => string;
+  getSession: () => Promise<{ data?: { user?: unknown | null } | null }>;
+  requestAuth: (options?: { provider?: string }) => Promise<void>;
+  signOut: () => Promise<unknown>;
+  setupMain: (cfg?: {
+    getWindow?: () => Electron.BrowserWindow | null;
+    scheme?: boolean;
+  }) => void;
+};
+
+export const electronAuthClient = authClient as ElectronAuthClient;