@danxbot/plugin-sdk 0.2.33 → 0.2.36

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`:
@@ -39,6 +41,8 @@ export function CardView({ card, mutation }: CardViewProps) {
 
 `vite build` writes the plugin to `dist/`: `index.js` (the entry), `chunks/` for code splitting, `index.css`, source maps, and `danx-plugin.json`, the manifest listing every file with its size and sha256 and the runtime majors the plugin was built against.
 
+A plugin styles itself with its own CSS (import a `.css` file; the build emits it as `index.css`) over the design system's runtime tokens such as `var(--surface)` and `var(--accent)`: the app's stylesheet holds only the utility classes the app's own source uses, so a utility class in a plugin may be missing at run time. A plugin changes cards with the kit's writes (`createCard`, `editCard`, `transitionCard`). A list view about one card type reads its cards with `useCardsOfType(scope, type)`, never by filtering `useBoardLaneState`'s lanes: those hold a window of each status, so cards would go missing.
+
 The build refuses to bundle a copy of React, React DOM, `@danxbot/ui` or `react-router`: import only the specifiers above. For routing, use the kit's `Link` and `useNavigate`; `StandardCardPage` reads the plan the page was opened from out of the URL, so a view that wraps it passes only `{card, mutation}`.
 
 ## The card kit is a contract

package/dist/card-kit.d.ts

@@ -583,6 +583,7 @@ declare module "@danxbot/card-kit@1" {
   interface LiveQueryResult<T> {
       data: T | null;
       loading: boolean;
+      refreshing?: boolean;
       error: Error | null;
       connection: ConnectionState;
       refetch: () => void;
@@ -1177,6 +1178,18 @@ declare module "@danxbot/card-kit@1" {
 
   type LifecycleAction = Extract<TransitionAction, "ready" | "unready" | "complete" | "cancel" | "reopen">;
 
+  interface CardEditPatch {
+      title?: string;
+      description?: string;
+      summary?: string | null;
+      pull_request_url?: string | null;
+      priority?: number;
+      type?: CardTypeKey;
+      parent_id?: string | null;
+      effort_level?: EffortLevelName;
+      content_hash?: string;
+  }
+  function editCard(id: string, patch: CardEditPatch): Promise<void>;
   function transitionCard(id: string, action: LifecycleAction | "unblock" | "archive"): Promise<void>;
   type PriorityPlacement = {
       side: "after" | "before";
@@ -1213,6 +1226,47 @@ declare module "@danxbot/card-kit@1" {
       run: (key: string, failureTitle: string, op: () => Promise<void>) => Promise<boolean>;
   }
   function useCardMutation(): CardMutation;
+
+  type PlanWire = number | {
+      name: string;
+  } | null;
+
+  interface NewCardInput {
+      board: string;
+      type: CardTypeKey;
+      title: string;
+      priority: number;
+      plan: PlanWire;
+      description: string;
+  }
+  function createCard(input: NewCardInput): Promise<string>;
+
+  interface ChildProgress {
+      done: number;
+      total: number;
+  }
+  interface CardStatusPresentation {
+      label: string;
+      icon: string;
+      reason: string | null;
+      live: boolean;
+      isContainer: boolean;
+      childProgress: ChildProgress | null;
+  }
+  type SnoozePresentation = {
+      active: false;
+  } | {
+      active: true;
+      wakeAt: string;
+      wakeAction: "ready" | "review";
+  };
+  interface GateBreakdownEntry {
+      gate: string;
+      label: string;
+      status: GateVerdict;
+  }
+  const defaultNewCardPriority: () => number;
+  type GateVerdict = QualityGateViewV2["status"];
   type HideableLane = "Cancelled" | "Backlog";
   interface LaneVisibility {
       isShown: (lane: IssueStatus$1) => boolean;
@@ -1249,6 +1303,8 @@ declare module "@danxbot/card-kit@1" {
   }
   function useBoardLaneState(scope: BoardScope): BoardLaneState;
 
+  function useCardsOfType(scope: BoardScope, type: string): LiveQueryResult<readonly IssueViewV2[]>;
+
   function boardCardPath(cardId: string): string;
   function planCardPath(planId: number, cardId: string, planSearch?: string): string;
   function planPathFromCard(planId: number, cardSearch?: string): string;
@@ -1276,32 +1332,6 @@ declare module "@danxbot/card-kit@1" {
       mutation: CardMutation;
   }): react.JSX.Element;
 
-  interface ChildProgress {
-      done: number;
-      total: number;
-  }
-  interface CardStatusPresentation {
-      label: string;
-      icon: string;
-      reason: string | null;
-      live: boolean;
-      isContainer: boolean;
-      childProgress: ChildProgress | null;
-  }
-  type SnoozePresentation = {
-      active: false;
-  } | {
-      active: true;
-      wakeAt: string;
-      wakeAction: "ready" | "review";
-  };
-  interface GateBreakdownEntry {
-      gate: string;
-      label: string;
-      status: GateVerdict;
-  }
-  type GateVerdict = QualityGateViewV2["status"];
-
   interface ProblemAttention {
       problem: ProblemViewV2;
       solutions: SolutionViewV2[];
@@ -1527,6 +1557,6 @@ declare module "@danxbot/card-kit@1" {
       readonly cardPath: (cardId: string) => string;
   }
 
-  export { ActivityTab, AttachmentsTab, AttentionZone, CardActionsMenu, CardBoard, CardFace, CardLink, ChecklistsSection, ChildrenSection, DependenciesSection, EditableContext, EditableSummary, EditableTitle, EffortControl, GatesSection, ParentField, PlansField, PriorityControl, ProblemsSection, RetroTab, StandardCardPage, StatusControl, TypeControl, WorkStateControl, boardCardPath, planCardPath, planPathFromCard, requestBoardMove, transitionCard, useAttachmentActions, useBoardLaneState, useIssueDetail as useCard, useCardMutation };
-  export type { AttachmentActions, BoardLaneState, BoardMoveResult, BoardScope, CardFaceProps, CardListViewProps, CardMutation, CardViewProps, IssueViewV2, LaneMoveRequest, LiveQueryResult, StandardCardPageProps };
+  export { ActivityTab, AttachmentsTab, AttentionZone, CardActionsMenu, CardBoard, CardFace, CardLink, ChecklistsSection, ChildrenSection, DependenciesSection, EditableContext, EditableSummary, EditableTitle, EffortControl, GatesSection, ParentField, PlansField, PriorityControl, ProblemsSection, RetroTab, StandardCardPage, StatusControl, TypeControl, WorkStateControl, boardCardPath, createCard, defaultNewCardPriority, editCard, planCardPath, planPathFromCard, requestBoardMove, transitionCard, useAttachmentActions, useBoardLaneState, useIssueDetail as useCard, useCardMutation, useCardsOfType };
+  export type { AttachmentActions, BoardLaneState, BoardMoveResult, BoardScope, CardEditPatch, CardFaceProps, CardListViewProps, CardMutation, CardViewProps, IssueViewV2, LaneMoveRequest, LiveQueryResult, NewCardInput, StandardCardPageProps };
 }

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.36",
   "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.4.0",
+    "@danxbot/ui": "28.5.1",
     "@types/node": "^22.0.0",
     "@types/react": "^19.2.2",
     "esbuild": "^0.25.0",