deck-plugin-sdk 1.11.0 → 1.12.0

package/build-plugin.mjs

@@ -1,172 +1,172 @@
-// Build a Deck plugin: TSX sources -> one plugin.js Deck can import.
-//
-// The same build Deck's own plugins get, with one difference: the shim is shipped with this
-// package rather than generated, because generating it needs Deck's TypeScript sources and the
-// point of this package is that you do not have them.
-//
-// Why a plugin wants a build step at all: JSX, and ordinary imports across as many files as you
-// like. It is not rebuilding Deck — it is what a VS Code extension does.
-//
-// The shim is the whole trick. Deck hands React, its bridge, `listen`, its icons and its
-// animation library over on `window.__deck`, and esbuild resolves those module names to files
-// that read from there. So your sources import "react" as normal code does, and at run time get
-// DECK'S React — which is not an optimisation but a requirement, since two Reacts in one tree
-// break hooks.
-import { build } from "esbuild";
-import { cpSync, existsSync, mkdirSync, readdirSync, readFileSync, rmSync, writeFileSync } from "node:fs";
-import { createRequire } from "node:module";
-import { dirname, join } from "node:path";
-import { fileURLToPath, pathToFileURL } from "node:url";
-import { assetLoaders, fromPackage, packageCss, rawImports } from "./packages.mjs";
-
-const sdk = dirname(fileURLToPath(import.meta.url));
-const require = createRequire(import.meta.url);
-
-/**
- * The module names a plugin may import, and the file each resolves to: shipped ones in `shimDir`,
- * the two generated per plugin in `genDir`.
- */
-function shimMap(shimDir, genDir) {
-  return {
-    react: join(shimDir, "react.js"),
-    "deckreact/jsx-runtime": join(shimDir, "jsx-runtime.js"),
-    // A library compiled with the automatic runtime imports it under its real name.
-    "react/jsx-runtime": join(shimDir, "jsx-runtime.js"),
-    // Deck's react-dom (needs Deck 1.1); only bundled when a plugin or its library imports it.
-    "react-dom": join(shimDir, "react-dom.js"),
-    "@tauri-apps/api/event": join(shimDir, "event.js"),
-    "lucide-react": join(genDir, "icons.js"),
-    "framer-motion": join(genDir, "motion.js"),
-  };
-}
-
-/**
- * Build the plugin in `dir`.
- *
- * A plugin imports the shim from this package (`deck-plugin-sdk/bridge`), so its project holds
- * only its own code: the editor and esbuild both find the shim and its types in node_modules.
- * The two files generated per plugin go to node_modules/.cache, for the length of a build.
- *
- * A project made before that imports `../shim/bridge.js`, a path that has to exist on disk, so
- * for one of those the shim and its types are still copied in beside `src/`, on every build so
- * updating the SDK updates them.
- */
-export async function buildPlugin(dir, { entry = "plugin.tsx" } = {}) {
-  const manifestPath = join(dir, "plugin.json");
-  if (!existsSync(manifestPath)) {
-    throw new Error(`no plugin.json in ${dir}`);
-  }
-  const manifest = JSON.parse(readFileSync(manifestPath, "utf8"));
-
-  // A plugin that needs more from esbuild than this build gives (a worker bundled into it, a
-  // dependency's locales left out) exports `esbuildPlugins` from deck-plugin.config.mjs beside
-  // plugin.json. They run after Deck's own, so they never take over react or the shim.
-  const configPath = join(dir, "deck-plugin.config.mjs");
-  const config = existsSync(configPath) ? await import(pathToFileURL(configPath).href) : {};
-
-  const sources = readdirSync(join(dir, "src"), { recursive: true })
-    .filter((f) => typeof f === "string" && /\.tsx?$/.test(f))
-    .map((f) => readFileSync(join(dir, "src", f), "utf8"));
-
-  const legacy = sources.some((src) => /from\s*["'](\.\.\/)+shim\//.test(src));
-  let shimDir = join(sdk, "shim");
-  let genDir = join(dir, "node_modules", ".cache", "deck-plugin");
-  if (legacy) {
-    shimDir = genDir = join(dir, "shim");
-    rmSync(shimDir, { recursive: true, force: true });
-    cpSync(join(sdk, "shim"), shimDir, { recursive: true });
-    // The declarations the shim's .d.ts files point at, as ../types/. Copied beside it for the
-    // same reason: a relative reference has to find something.
-    const typesDir = join(dir, "types");
-    rmSync(typesDir, { recursive: true, force: true });
-    cpSync(join(sdk, "types"), typesDir, { recursive: true });
-  } else {
-    mkdirSync(genDir, { recursive: true });
-  }
-
-  // ---- icons and animation, generated per plugin ----
-  //
-  // These two cannot be shipped pre-generated like the rest of the shim. They name only the
-  // exports THIS plugin imports, on purpose: re-exporting the whole package goes through a
-  // module esbuild cannot see into, which defeats tree-shaking — doing that with lucide took a
-  // bundle from 403kb to 640kb, larger than just bundling it.
-  //
-  // Nothing about this needs Deck's source, only the plugin's own and the real package, so it
-  // runs here the same way it runs inside the Deck repository.
-  for (const [pkg, file, global] of [
-    ["lucide-react", "icons.js", "icons"],
-    ["framer-motion", "motion.js", "motion"],
-  ]) {
-    const re = new RegExp(String.raw`import\s*\{([^}]*)\}\s*from\s*"${pkg}"`, "g");
-    const names = [...new Set(sources.flatMap((src) => [...src.matchAll(re)]
-      .flatMap((m) => m[1].split(",").map((n) => n.trim().split(/\s+as\s+/)[0]).filter(Boolean))))].sort();
-
-    // Checked against the real package, so a typo fails here rather than as a blank icon at run
-    // time. Only loaded when something is actually imported from it, since framer-motion is an
-    // optional peer dependency.
-    if (names.length) {
-      let real;
-      try { real = require(pkg); }
-      catch { throw new Error(`this plugin imports from "${pkg}" — run: npm i ${pkg}`); }
-      for (const n of names) if (!(n in real)) throw new Error(`${pkg} has no export "${n}"`);
-    }
-
-    writeFileSync(join(genDir, file), `// GENERATED by the Deck plugin build — do not edit.
-//
-// Deck's ${pkg}, so this plugin does not bundle its own copy. Only the names this plugin
-// imports: naming every export would defeat tree-shaking and make the bundle larger.
-const __src = window.__deck.${global};
-${names.map((n) => `export const ${n} = __src.${n};`).join("\n")}
-`);
-  }
-
-  const shims = shimMap(shimDir, genDir);
-
-  await build({
-    entryPoints: [join(dir, "src", entry)],
-    outfile: join(dir, "plugin.js"),
-    bundle: true,
-    format: "esm",
-    target: "es2022",
-    // Nobody reads a plugin bundle; it is loaded by one import() at startup.
-    minify: true,
-    // A package that ships separate builds picks the production one.
-    conditions: ["production"],
-    jsx: "automatic",
-    // React comes from Deck, so the automatic runtime must import from the shim rather than a
-    // "react/jsx-runtime" that does not exist here.
-    jsxImportSource: "deckreact",
-    // A .wasm import becomes a Uint8Array inlined in the bundle rather than a sidecar file. A
-    // plugin is installed as plugin.json + plugin.js, so a file beside them would never arrive.
-    // A .css import becomes its text, for the plugin to inject as a <style>, for the same reason.
-    // Images and fonts become data: URLs, for the same reason (packages.mjs).
-    loader: { ".wasm": "binary", ".css": "text", ...assetLoaders },
-    // A resolve plugin rather than esbuild's `alias`, which maps package to package while these
-    // point at single files.
-    plugins: [{
-      name: "deck-runtime",
-      setup(b) {
-        const filter = new RegExp(`^(${Object.keys(shims)
-          .map((k) => k.replace(/[/\\^$*+?.()|[\]{}]/g, "\\$&")).join("|")})$`);
-        b.onResolve({ filter }, (a) => (fromPackage(a, dir) ? undefined : { path: shims[a.path] }));
-      },
-    }, rawImports, packageCss(manifest.id, dir), ...(config.esbuildPlugins ?? [])],
-    logLevel: "info",
-  });
-
-  // Optional: only a plugin that brings agent-facing tools has one. Built for node, because the
-  // MCP server runs outside the webview.
-  if (existsSync(join(dir, "src", "mcp.ts"))) {
-    await build({
-      entryPoints: [join(dir, "src", "mcp.ts")],
-      outfile: join(dir, "mcp.js"),
-      platform: "node",
-      format: "esm",
-      target: "node18",
-      bundle: true,
-      logLevel: "info",
-    });
-  }
-
-  return manifest;
-}
+// Build a Deck plugin: TSX sources -> one plugin.js Deck can import.
+//
+// The same build Deck's own plugins get, with one difference: the shim is shipped with this
+// package rather than generated, because generating it needs Deck's TypeScript sources and the
+// point of this package is that you do not have them.
+//
+// Why a plugin wants a build step at all: JSX, and ordinary imports across as many files as you
+// like. It is not rebuilding Deck — it is what a VS Code extension does.
+//
+// The shim is the whole trick. Deck hands React, its bridge, `listen`, its icons and its
+// animation library over on `window.__deck`, and esbuild resolves those module names to files
+// that read from there. So your sources import "react" as normal code does, and at run time get
+// DECK'S React — which is not an optimisation but a requirement, since two Reacts in one tree
+// break hooks.
+import { build } from "esbuild";
+import { cpSync, existsSync, mkdirSync, readdirSync, readFileSync, rmSync, writeFileSync } from "node:fs";
+import { createRequire } from "node:module";
+import { dirname, join } from "node:path";
+import { fileURLToPath, pathToFileURL } from "node:url";
+import { assetLoaders, fromPackage, packageCss, rawImports } from "./packages.mjs";
+
+const sdk = dirname(fileURLToPath(import.meta.url));
+const require = createRequire(import.meta.url);
+
+/**
+ * The module names a plugin may import, and the file each resolves to: shipped ones in `shimDir`,
+ * the two generated per plugin in `genDir`.
+ */
+function shimMap(shimDir, genDir) {
+  return {
+    react: join(shimDir, "react.js"),
+    "deckreact/jsx-runtime": join(shimDir, "jsx-runtime.js"),
+    // A library compiled with the automatic runtime imports it under its real name.
+    "react/jsx-runtime": join(shimDir, "jsx-runtime.js"),
+    // Deck's react-dom (needs Deck 1.1); only bundled when a plugin or its library imports it.
+    "react-dom": join(shimDir, "react-dom.js"),
+    "@tauri-apps/api/event": join(shimDir, "event.js"),
+    "lucide-react": join(genDir, "icons.js"),
+    "framer-motion": join(genDir, "motion.js"),
+  };
+}
+
+/**
+ * Build the plugin in `dir`.
+ *
+ * A plugin imports the shim from this package (`deck-plugin-sdk/bridge`), so its project holds
+ * only its own code: the editor and esbuild both find the shim and its types in node_modules.
+ * The two files generated per plugin go to node_modules/.cache, for the length of a build.
+ *
+ * A project made before that imports `../shim/bridge.js`, a path that has to exist on disk, so
+ * for one of those the shim and its types are still copied in beside `src/`, on every build so
+ * updating the SDK updates them.
+ */
+export async function buildPlugin(dir, { entry = "plugin.tsx" } = {}) {
+  const manifestPath = join(dir, "plugin.json");
+  if (!existsSync(manifestPath)) {
+    throw new Error(`no plugin.json in ${dir}`);
+  }
+  const manifest = JSON.parse(readFileSync(manifestPath, "utf8"));
+
+  // A plugin that needs more from esbuild than this build gives (a worker bundled into it, a
+  // dependency's locales left out) exports `esbuildPlugins` from deck-plugin.config.mjs beside
+  // plugin.json. They run after Deck's own, so they never take over react or the shim.
+  const configPath = join(dir, "deck-plugin.config.mjs");
+  const config = existsSync(configPath) ? await import(pathToFileURL(configPath).href) : {};
+
+  const sources = readdirSync(join(dir, "src"), { recursive: true })
+    .filter((f) => typeof f === "string" && /\.tsx?$/.test(f))
+    .map((f) => readFileSync(join(dir, "src", f), "utf8"));
+
+  const legacy = sources.some((src) => /from\s*["'](\.\.\/)+shim\//.test(src));
+  let shimDir = join(sdk, "shim");
+  let genDir = join(dir, "node_modules", ".cache", "deck-plugin");
+  if (legacy) {
+    shimDir = genDir = join(dir, "shim");
+    rmSync(shimDir, { recursive: true, force: true });
+    cpSync(join(sdk, "shim"), shimDir, { recursive: true });
+    // The declarations the shim's .d.ts files point at, as ../types/. Copied beside it for the
+    // same reason: a relative reference has to find something.
+    const typesDir = join(dir, "types");
+    rmSync(typesDir, { recursive: true, force: true });
+    cpSync(join(sdk, "types"), typesDir, { recursive: true });
+  } else {
+    mkdirSync(genDir, { recursive: true });
+  }
+
+  // ---- icons and animation, generated per plugin ----
+  //
+  // These two cannot be shipped pre-generated like the rest of the shim. They name only the
+  // exports THIS plugin imports, on purpose: re-exporting the whole package goes through a
+  // module esbuild cannot see into, which defeats tree-shaking — doing that with lucide took a
+  // bundle from 403kb to 640kb, larger than just bundling it.
+  //
+  // Nothing about this needs Deck's source, only the plugin's own and the real package, so it
+  // runs here the same way it runs inside the Deck repository.
+  for (const [pkg, file, global] of [
+    ["lucide-react", "icons.js", "icons"],
+    ["framer-motion", "motion.js", "motion"],
+  ]) {
+    const re = new RegExp(String.raw`import\s*\{([^}]*)\}\s*from\s*"${pkg}"`, "g");
+    const names = [...new Set(sources.flatMap((src) => [...src.matchAll(re)]
+      .flatMap((m) => m[1].split(",").map((n) => n.trim().split(/\s+as\s+/)[0]).filter(Boolean))))].sort();
+
+    // Checked against the real package, so a typo fails here rather than as a blank icon at run
+    // time. Only loaded when something is actually imported from it, since framer-motion is an
+    // optional peer dependency.
+    if (names.length) {
+      let real;
+      try { real = require(pkg); }
+      catch { throw new Error(`this plugin imports from "${pkg}" — run: npm i ${pkg}`); }
+      for (const n of names) if (!(n in real)) throw new Error(`${pkg} has no export "${n}"`);
+    }
+
+    writeFileSync(join(genDir, file), `// GENERATED by the Deck plugin build — do not edit.
+//
+// Deck's ${pkg}, so this plugin does not bundle its own copy. Only the names this plugin
+// imports: naming every export would defeat tree-shaking and make the bundle larger.
+const __src = window.__deck.${global};
+${names.map((n) => `export const ${n} = __src.${n};`).join("\n")}
+`);
+  }
+
+  const shims = shimMap(shimDir, genDir);
+
+  await build({
+    entryPoints: [join(dir, "src", entry)],
+    outfile: join(dir, "plugin.js"),
+    bundle: true,
+    format: "esm",
+    target: "es2022",
+    // Nobody reads a plugin bundle; it is loaded by one import() at startup.
+    minify: true,
+    // A package that ships separate builds picks the production one.
+    conditions: ["production"],
+    jsx: "automatic",
+    // React comes from Deck, so the automatic runtime must import from the shim rather than a
+    // "react/jsx-runtime" that does not exist here.
+    jsxImportSource: "deckreact",
+    // A .wasm import becomes a Uint8Array inlined in the bundle rather than a sidecar file. A
+    // plugin is installed as plugin.json + plugin.js, so a file beside them would never arrive.
+    // A .css import becomes its text, for the plugin to inject as a <style>, for the same reason.
+    // Images and fonts become data: URLs, for the same reason (packages.mjs).
+    loader: { ".wasm": "binary", ".css": "text", ...assetLoaders },
+    // A resolve plugin rather than esbuild's `alias`, which maps package to package while these
+    // point at single files.
+    plugins: [{
+      name: "deck-runtime",
+      setup(b) {
+        const filter = new RegExp(`^(${Object.keys(shims)
+          .map((k) => k.replace(/[/\\^$*+?.()|[\]{}]/g, "\\$&")).join("|")})$`);
+        b.onResolve({ filter }, (a) => (fromPackage(a, dir) ? undefined : { path: shims[a.path] }));
+      },
+    }, rawImports, packageCss(manifest.id, dir), ...(config.esbuildPlugins ?? [])],
+    logLevel: "info",
+  });
+
+  // Optional: only a plugin that brings agent-facing tools has one. Built for node, because the
+  // MCP server runs outside the webview.
+  if (existsSync(join(dir, "src", "mcp.ts"))) {
+    await build({
+      entryPoints: [join(dir, "src", "mcp.ts")],
+      outfile: join(dir, "mcp.js"),
+      platform: "node",
+      format: "esm",
+      target: "node18",
+      bundle: true,
+      logLevel: "info",
+    });
+  }
+
+  return manifest;
+}

package/package.json

@@ -1,60 +1,60 @@
-{
-  "name": "deck-plugin-sdk",
-  "version": "1.11.0",
-  "description": "Build a plugin for Deck, outside the Deck repository.",
-  "type": "module",
-  "license": "MIT",
-  "bin": {
-    "deck-plugin": "bin/deck-plugin.mjs"
-  },
-  "exports": {
-    "./build": "./build-plugin.mjs",
-    "./*": {
-      "types": "./shim/*.d.ts",
-      "default": "./shim/*.js"
-    },
-    "./package.json": "./package.json"
-  },
-  "files": [
-    "bin",
-    "shim",
-    "types",
-    "template",
-    "build-plugin.mjs",
-    "packages.mjs",
-    "README.md",
-    "permissions.json",
-    "publish.mjs",
-    "validate.mjs"
-  ],
-  "dependencies": {
-    "esbuild": "^0.28.0"
-  },
-  "peerDependencies": {
-    "@types/react": "^19.0.0",
-    "framer-motion": "^13.0.0",
-    "lucide-react": "^1.0.0",
-    "monaco-editor": "^0.56.0",
-    "react": "^19.0.0",
-    "typescript": "^5.0.0"
-  },
-  "peerDependenciesMeta": {
-    "framer-motion": {
-      "optional": true
-    },
-    "monaco-editor": {
-      "optional": true
-    },
-    "typescript": {
-      "optional": true
-    }
-  },
-  "engines": {
-    "node": ">=20"
-  },
-  "keywords": [
-    "deck",
-    "plugin",
-    "sdk"
-  ]
-}
+{
+  "name": "deck-plugin-sdk",
+  "version": "1.12.0",
+  "description": "Build a plugin for Deck, outside the Deck repository.",
+  "type": "module",
+  "license": "MIT",
+  "bin": {
+    "deck-plugin": "bin/deck-plugin.mjs"
+  },
+  "exports": {
+    "./build": "./build-plugin.mjs",
+    "./*": {
+      "types": "./shim/*.d.ts",
+      "default": "./shim/*.js"
+    },
+    "./package.json": "./package.json"
+  },
+  "files": [
+    "bin",
+    "shim",
+    "types",
+    "template",
+    "build-plugin.mjs",
+    "packages.mjs",
+    "README.md",
+    "permissions.json",
+    "publish.mjs",
+    "validate.mjs"
+  ],
+  "dependencies": {
+    "esbuild": "^0.28.0"
+  },
+  "peerDependencies": {
+    "@types/react": "^19.0.0",
+    "framer-motion": "^13.0.0",
+    "lucide-react": "^1.0.0",
+    "monaco-editor": "^0.56.0",
+    "react": "^19.0.0",
+    "typescript": "^5.0.0"
+  },
+  "peerDependenciesMeta": {
+    "framer-motion": {
+      "optional": true
+    },
+    "monaco-editor": {
+      "optional": true
+    },
+    "typescript": {
+      "optional": true
+    }
+  },
+  "engines": {
+    "node": ">=20"
+  },
+  "keywords": [
+    "deck",
+    "plugin",
+    "sdk"
+  ]
+}