@danxbot/plugin-sdk 0.0.0-stage → 0.1.2

package/dist/cli.js

@@ -0,0 +1,12 @@
+#!/usr/bin/env node
+
+// src/cli.ts
+var USAGE = "usage: danx-plugin publish";
+var [command] = process.argv.slice(2);
+if (command === "publish") {
+  process.stderr.write("danx-plugin publish is not available yet: the plugin upload route ships with the next release of this SDK.\n");
+  process.exit(1);
+}
+process.stderr.write(`${USAGE}
+`);
+process.exit(command === void 0 ? 0 : 2);

package/dist/vite.d.ts

@@ -0,0 +1,22 @@
+import { Plugin } from 'vite';
+
+/** The entry module every plugin build produces; the manifest names it and the app `import()`s it. */
+declare const PLUGIN_ENTRY_FILE = "index.js";
+interface DanxPluginOptions {
+    /** The module exporting `CardView` and/or `CardListView`, relative to the project root. */
+    readonly entry?: string;
+}
+/**
+ * The Vite preset for a 50 Arms card-type plugin: an ES-module library build whose output the app loads with `import()`.
+ *
+ * - The specifiers in `src/plugins/runtime-contract.ts` (`react`, `react/jsx-runtime`, `react-dom`, `@danxbot/ui`, the card kit) stay
+ *   EXTERNAL: the page's import map answers them with the app's own modules, so the plugin shares its single React and design system.
+ * - Anything else is bundled. Bundling a copy of a shared package (`react-dom/client` or `react-router` are not in the contract) would run a second copy
+ *   beside the app's, so that fails the build instead of shipping.
+ * - Code-split chunks load by relative import from the entry's folder; CSS is emitted as one `index.css`.
+ * - `danx-plugin.json` is written beside the output: every file's size and sha256, the entry, the stylesheets and the runtime majors.
+ */
+declare function danxPlugin(options?: DanxPluginOptions): Plugin;
+
+export { PLUGIN_ENTRY_FILE, danxPlugin };
+export type { DanxPluginOptions };

package/dist/vite.js

@@ -0,0 +1,119 @@
+// ../../src/plugins/runtime-contract.ts
+var CARD_KIT_MAJOR = 1;
+var CARD_KIT_LIBRARY = "@danxbot/card-kit";
+var PLUGIN_RUNTIME_LIBRARIES = [
+  { name: "react", major: 19 },
+  { name: "react-dom", major: 19 },
+  { name: "@danxbot/ui", major: 26 },
+  { name: CARD_KIT_LIBRARY, major: CARD_KIT_MAJOR }
+];
+var PLUGIN_RUNTIME_SPECIFIERS = [
+  { specifier: "react", library: "react" },
+  { specifier: "react/jsx-runtime", library: "react" },
+  { specifier: "react-dom", library: "react-dom" },
+  { specifier: "@danxbot/ui", library: "@danxbot/ui" },
+  { specifier: `${CARD_KIT_LIBRARY}@${CARD_KIT_MAJOR}`, library: CARD_KIT_LIBRARY }
+];
+var PLUGIN_NEVER_BUNDLED_PACKAGES = [
+  ...PLUGIN_RUNTIME_LIBRARIES.map((library) => library.name).filter((name) => name !== CARD_KIT_LIBRARY),
+  "scheduler",
+  "react-router"
+];
+function pluginRuntimeContract() {
+  return {
+    specifiers: PLUGIN_RUNTIME_SPECIFIERS.map((entry) => entry.specifier),
+    majors: Object.fromEntries(PLUGIN_RUNTIME_LIBRARIES.map((library) => [library.name, library.major]))
+  };
+}
+
+// src/manifest.ts
+import { createHash } from "node:crypto";
+import { readdirSync, readFileSync, writeFileSync } from "node:fs";
+import { join, relative, sep } from "node:path";
+
+// ../../src/plugins/plugin-manifest.ts
+var PLUGIN_MANIFEST_FILE = "danx-plugin.json";
+
+// src/manifest.ts
+function filesUnder(root, dir = root) {
+  return readdirSync(dir, { withFileTypes: true }).flatMap((entry) => entry.isDirectory() ? filesUnder(root, join(dir, entry.name)) : [join(dir, entry.name)]).sort();
+}
+function describeFile(root, file) {
+  const bytes = readFileSync(file);
+  return {
+    path: relative(root, file).split(sep).join("/"),
+    size: bytes.length,
+    sha256: createHash("sha256").update(bytes).digest("hex")
+  };
+}
+function buildManifest(outDir, entry) {
+  const files = filesUnder(outDir).map((file) => describeFile(outDir, file)).filter((file) => file.path !== PLUGIN_MANIFEST_FILE);
+  if (!files.some((file) => file.path === entry)) throw new Error(`danx-plugin: the build produced no entry module ${entry} in ${outDir}`);
+  return {
+    entry,
+    styles: files.filter((file) => file.path.endsWith(".css")).map((file) => file.path),
+    runtime: pluginRuntimeContract().majors,
+    files
+  };
+}
+function writeManifest(outDir, entry) {
+  const manifest = buildManifest(outDir, entry);
+  writeFileSync(join(outDir, PLUGIN_MANIFEST_FILE), `${JSON.stringify(manifest, null, 2)}
+`);
+  return manifest;
+}
+
+// src/vite.ts
+var PLUGIN_ENTRY_FILE = "index.js";
+var STYLESHEET_FILE = "index.css";
+function bundledNeverPackage(moduleId) {
+  const normalised = moduleId.replaceAll("\\", "/");
+  return PLUGIN_NEVER_BUNDLED_PACKAGES.find((name) => normalised.includes(`/node_modules/${name}/`));
+}
+function danxPlugin(options = {}) {
+  const entry = options.entry ?? "src/index.tsx";
+  return {
+    name: "danx-plugin",
+    config() {
+      return {
+        // The runtime-contract specifiers include `react/jsx-runtime`, never `react/jsx-dev-runtime`.
+        esbuild: { jsx: "automatic", jsxDev: false },
+        // Library mode leaves `process.env.NODE_ENV` for the consumer; a browser has no `process`.
+        define: { "process.env.NODE_ENV": JSON.stringify("production") },
+        build: {
+          target: "es2022",
+          sourcemap: true,
+          cssCodeSplit: false,
+          lib: { entry, formats: ["es"], fileName: () => PLUGIN_ENTRY_FILE },
+          rollupOptions: {
+            external: PLUGIN_RUNTIME_SPECIFIERS.map((shared) => shared.specifier),
+            output: {
+              chunkFileNames: "chunks/[name]-[hash].js",
+              assetFileNames: (asset) => asset.names.some((name) => name.endsWith(".css")) ? STYLESHEET_FILE : "assets/[name]-[hash][extname]"
+            }
+          }
+        }
+      };
+    },
+    generateBundle(_options, bundle) {
+      for (const output of Object.values(bundle)) {
+        if (output.type !== "chunk") continue;
+        for (const id of output.moduleIds) {
+          const duplicate = bundledNeverPackage(id);
+          if (duplicate === void 0) continue;
+          throw new Error(
+            `danx-plugin: ${output.fileName} would bundle a copy of ${duplicate}, which the app already serves (${id}). Import only the specifiers the runtime contract lists (${PLUGIN_RUNTIME_SPECIFIERS.map((shared) => shared.specifier).join(", ")}); the card kit also re-exports Link and useNavigate in place of react-router.`
+          );
+        }
+      }
+    },
+    writeBundle(options2) {
+      if (options2.dir === void 0) throw new Error("danx-plugin: the build has no output directory to write the manifest into");
+      writeManifest(options2.dir, PLUGIN_ENTRY_FILE);
+    }
+  };
+}
+export {
+  PLUGIN_ENTRY_FILE,
+  danxPlugin
+};

package/package.json

@@ -1,6 +1,57 @@
 {
   "name": "@danxbot/plugin-sdk",
-  "version": "0.0.0-stage",
-  "stub": true,
-  "description": "Temporary package placeholder for staged publishing"
-}
+  "version": "0.1.2",
+  "description": "SDK for building 50 Arms card-type plugins (DX-5170): the card kit's type declarations, a Vite preset that builds a plugin against the app's shared runtime and writes its manifest, and the danx-plugin CLI.",
+  "license": "MIT",
+  "type": "module",
+  "bin": {
+    "danx-plugin": "dist/cli.js"
+  },
+  "exports": {
+    "./vite": {
+      "types": "./dist/vite.d.ts",
+      "default": "./dist/vite.js"
+    },
+    "./card-kit": {
+      "types": "./dist/card-kit.d.ts"
+    }
+  },
+  "files": [
+    "dist",
+    "README.md"
+  ],
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/newms87/danxbot.git",
+    "directory": "packages/danx-plugin-sdk"
+  },
+  "engines": {
+    "node": ">=20"
+  },
+  "peerDependencies": {
+    "@danxbot/ui": "^26.0.0",
+    "@types/react": "^19.0.0",
+    "react": "^19.0.0",
+    "react-router": "^7.0.0",
+    "vite": "^7.1.9"
+  },
+  "scripts": {
+    "prepublishOnly": "bash ../../scripts/assert-tree-contains-origin-main.sh @danxbot/plugin-sdk",
+    "build": "node scripts/build.mjs",
+    "typecheck": "tsc -p tsconfig.test.json --noEmit",
+    "test": "vitest run"
+  },
+  "devDependencies": {
+    "@danxbot/ui": "26.7.1",
+    "@types/node": "^22.0.0",
+    "@types/react": "^19.2.2",
+    "esbuild": "^0.25.0",
+    "react": "^19.2.0",
+    "react-router": "^7.18.2",
+    "rollup": "^4.52.0",
+    "rollup-plugin-dts": "^6.2.0",
+    "typescript": "^5.9.3",
+    "vite": "^7.1.9",
+    "vitest": "^4.1.11"
+  }
+}