@danxbot/plugin-sdk 0.2.33 → 0.2.35

package/README.md

@@ -25,6 +25,8 @@ import { danxPlugin } from "@danxbot/plugin-sdk/vite";
 export default defineConfig({ plugins: [danxPlugin()] });
 ```
 
+A plugin whose `CardView` is made for particular card types names them: `danxPlugin({ cardTypes: ["Bug"] })`. Each becomes that type's default view once the plugin's revision is approved and active (a team admin's card-view board shows it as "Default" and reverts a type to it); where two plugins name one type, the one activated first wins. The names go into `danx-plugin.json` as `cardTypes`, and the upload refuses a key that is not a card type key or a plugin that exports no `CardView`.
+
 `tsconfig.json`: add `"types": ["@danxbot/plugin-sdk/card-kit"]`: the kit's declarations. They are self-contained (they import only `react`, `@danxbot/ui` and `react-router`) and the specifier is not a package, so TypeScript reads them as ambient types.
 
 `src/index.tsx` exports `CardView` and/or `CardListView`:

package/dist/publish.d.ts

@@ -27,6 +27,12 @@ interface PluginManifest {
     readonly screenshot?: string;
     /** Each shared library's major the plugin was built against (`PLUGIN_RUNTIME_LIBRARIES`), compared with what the app serves. */
     readonly runtime: Readonly<Record<string, number>>;
+    /**
+     * DX-6178: the card types the plugin's `CardView` is made for (card type keys, e.g. `["Bug"]`); absent when it is made for none. Each is that type's DEFAULT view
+     * while the plugin's active revision is approved and exports `CardView`: the admin's card-view board shows it as the type's "Default" and reverts to it.
+     * Where two plugins declare one type, the one activated first wins (`plugins.activated_at`).
+     */
+    readonly cardTypes?: readonly string[];
     /** DX-5282: which view modules the entry exports (`PLUGIN_VIEW_EXPORTS`), recorded at build from the entry chunk's real exports; never empty. */
     readonly exports: readonly PluginViewExport[];
     readonly files: readonly PluginManifestFile[];

package/dist/vite.d.ts

@@ -5,6 +5,11 @@ declare const PLUGIN_ENTRY_FILE = "index.js";
 interface DanxPluginOptions {
     /** The module exporting `CardView` and/or `CardListView`, relative to the project root. */
     readonly entry?: string;
+    /**
+     * DX-6178: the card types the plugin's `CardView` is made for (card type keys, e.g. `["Bug"]`). Each becomes that type's DEFAULT view once the plugin's revision is approved
+     * and active, and the team can always set the type back to it. Leave it out for a plugin made for no particular type.
+     */
+    readonly cardTypes?: readonly string[];
 }
 /**
  * The Vite preset for a 50 Arms card-type plugin: an ES-module library build whose output the app loads with `import()`.

package/dist/vite.js

@@ -49,7 +49,7 @@ function describeFile(root, file) {
     sha256: createHash("sha256").update(bytes).digest("hex")
   };
 }
-function buildManifest(outDir, entry, exports) {
+function buildManifest(outDir, entry, exports, cardTypes = []) {
   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 {
@@ -57,11 +57,13 @@ function buildManifest(outDir, entry, exports) {
     styles: files.filter((file) => file.path.endsWith(".css")).map((file) => file.path),
     runtime: pluginRuntimeContract().majors,
     exports: [...exports],
+    // DX-6178: the card types the plugin's card view is made for, written only when the author named some.
+    ...cardTypes.length === 0 ? {} : { cardTypes: [...cardTypes] },
     files
   };
 }
-function writeManifest(outDir, entry, exports) {
-  const manifest = buildManifest(outDir, entry, exports);
+function writeManifest(outDir, entry, exports, cardTypes = []) {
+  const manifest = buildManifest(outDir, entry, exports, cardTypes);
   writeFileSync(join(outDir, PLUGIN_MANIFEST_FILE), `${JSON.stringify(manifest, null, 2)}
 `);
   return manifest;
@@ -120,9 +122,9 @@ function danxPlugin(options = {}) {
         }
       }
     },
-    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, viewExports);
+    writeBundle(output) {
+      if (output.dir === void 0) throw new Error("danx-plugin: the build has no output directory to write the manifest into");
+      writeManifest(output.dir, PLUGIN_ENTRY_FILE, viewExports, options.cardTypes ?? []);
     }
   };
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@danxbot/plugin-sdk",
-  "version": "0.2.33",
+  "version": "0.2.35",
   "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",