@danxbot/plugin-sdk 0.2.32 → 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/card-kit.d.ts

@@ -240,6 +240,11 @@ declare module "@danxbot/card-kit@1" {
       recommended: boolean;
   }
 
+  interface DocsProposalPromotionV2 {
+      plan_id: number;
+      attempt: number;
+  }
+
   interface V2CopyComment {
       author: string;
       text: string;
@@ -307,6 +312,7 @@ declare module "@danxbot/card-kit@1" {
       title: string;
       created_by: string;
       created_at: string;
+      archived_at: string | null;
       revisions: V2CopyDesignRevision[];
       decisions: V2CopyDesignDecision[];
   }
@@ -323,6 +329,16 @@ declare module "@danxbot/card-kit@1" {
       created_at: string;
       updated_at: string;
   }
+  interface V2CopyDocsProposal {
+      repo: string;
+      page_id: string;
+      new_page_title: string | null;
+      change: string;
+      author: string;
+      team_agent: string | null;
+      created_at: string;
+      updated_at: string;
+  }
   interface V2CopyAc {
       title: string;
       checked: boolean;
@@ -430,6 +446,7 @@ declare module "@danxbot/card-kit@1" {
       checklists: V2CopyChecklist[];
       comments: V2CopyComment[];
       agent_notes: V2CopyAgentNote[];
+      docs_proposals: V2CopyDocsProposal[];
       dependencies: V2CopyDependency[];
       retro: V2CopyRetro | null;
       mirrors: V2CopyMirror[];
@@ -870,6 +887,19 @@ declare module "@danxbot/card-kit@1" {
     updated_at: string;
     text: string;
     metadata: unknown;
+  }>);
+    docs_proposals?: undefined | (Array<{
+    id: number;
+    repo: string;
+    page_id: string;
+    new_page_title: null | string;
+    change: string;
+    author: string;
+    by: AuthorV2;
+    via_key: null | ViaKey;
+    promotion: null | DocsProposalPromotionV2;
+    created_at: string;
+    updated_at: string;
   }>);
     designs?: undefined | (Array<{
     id: number;
@@ -877,6 +907,7 @@ declare module "@danxbot/card-kit@1" {
     title: string;
     created_by: string;
     created_at: string;
+    archived_at: null | string;
     review_state: "rejected" | "awaiting_review" | "changes_requested" | "approved";
     revision_count: number;
     latest_revision_no: number;
@@ -930,6 +961,7 @@ declare module "@danxbot/card-kit@1" {
     id: string;
     name: string;
     status: "Cancelled" | "Review" | "ToDo" | "In Progress" | "Backlog" | "Done";
+    board_id: string;
     type?: undefined | string;
     priority?: undefined | number;
     summary?: undefined | null | string;
@@ -1076,6 +1108,7 @@ declare module "@danxbot/card-kit@1" {
     title: string;
     created_by: string;
     created_at: string;
+    archived_at: null | string;
     review_state: "rejected" | "awaiting_review" | "changes_requested" | "approved";
     revision_count: number;
     latest_revision_no: number;
@@ -1243,14 +1276,12 @@ declare module "@danxbot/card-kit@1" {
       mutation: CardMutation;
   }): react.JSX.Element;
 
-  type CardTone = "success" | "warning" | "danger" | "info" | "neutral" | "accent" | "brand" | "muted";
   interface ChildProgress {
       done: number;
       total: number;
   }
   interface CardStatusPresentation {
       label: string;
-      tone: CardTone;
       icon: string;
       reason: string | null;
       live: boolean;

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.32",
+  "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",
@@ -46,7 +46,7 @@
     "test": "vitest run"
   },
   "devDependencies": {
-    "@danxbot/ui": "28.3.0",
+    "@danxbot/ui": "28.4.0",
     "@types/node": "^22.0.0",
     "@types/react": "^19.2.2",
     "esbuild": "^0.25.0",