@linxin666/dsh-client-ui-task-board 0.4.4 → 0.4.6

package/lib/types/core/extension.d.ts

@@ -0,0 +1,283 @@
+/**
+ * The task board's external provider extension contract.
+ *
+ * This module is the single source of truth for how another plugin adds a
+ * provider surface to the task board: the cordis service name both halves
+ * publish, the API version they negotiate, the child seats a provider renders
+ * into, the host capability face a provider implements against, and the client
+ * capability face the board's browser half provides. It is framework-free and
+ * shared by the host and browser programs; the only imported SDK type is
+ * type-only, so the browser bundle never pulls a value out of an SDK package.
+ *
+ * @module dsh-task-board/core/extension
+ */
+import type { ToolDefinition } from '@deepseek-ai/dsh-tools';
+import type { ExecutionOutcome, TaskRecord, TaskStatus } from './tasks.ts';
+/** Cordis service name the host and browser halves each publish. */
+export declare const TASK_BOARD_SERVICE_NAME = "taskBoard";
+/**
+ * Contract version of {@link TASK_BOARD_SERVICE_NAME}. A provider declares the
+ * version it was built against; the board refuses (visibly) any other version
+ * instead of guessing at a stale shape.
+ */
+export declare const TASK_BOARD_API_VERSION = 1;
+/** Child seat a provider registers its task-detail section into. */
+export declare const TASK_BOARD_DETAIL_SECTION = "task-board.detail.section";
+/** Child seat a provider registers its settings section into. */
+export declare const TASK_BOARD_SETTINGS_SECTION = "task-board.settings.section";
+/** Child seat a provider registers its card decoration into. */
+export declare const TASK_BOARD_CARD_DECORATION = "task-board.card.decoration";
+/** Every child seat the board declares for extensions, in render order. */
+export declare const TASK_BOARD_EXTENSION_SEATS: readonly string[];
+/**
+ * Largest accepted extension payload, in bytes of its JSON serialization. One
+ * integration entry — and one action payload — may carry schema the board does
+ * not interpret, but never enough of it to bloat the ledger or the action
+ * channel.
+ */
+export declare const TASK_BOARD_PAYLOAD_LIMIT_BYTES: number;
+/** One opaque provider payload the board stores and forwards without interpreting. */
+export type TaskBoardExtensionPayload = Record<string, unknown>;
+/**
+ * Validate one extension payload: a pure JSON object whose serialization fits
+ * {@link TASK_BOARD_PAYLOAD_LIMIT_BYTES}. Arrays, primitives and non-plain
+ * objects are refused; the board never interprets the keys.
+ * @param value - candidate payload.
+ * @returns whether the value is an acceptable opaque payload.
+ */
+export declare function isTaskBoardExtensionPayload(value: unknown): value is TaskBoardExtensionPayload;
+/** Byte length of a value's JSON serialization, or undefined when it does not serialize. */
+export declare function taskBoardPayloadBytes(value: unknown): number | undefined;
+/**
+ * Normalize a task's whole integrations container: a plain JSON object whose
+ * values are each an opaque provider payload within the size limit. A malformed
+ * container normalizes to undefined (the field is dropped), and one malformed
+ * entry is dropped alone so a single bad provider can never take a card — or
+ * another provider's data — with it.
+ * @param value - candidate container from the wire, the ledger, or a create input.
+ * @returns the cleaned container, or undefined when nothing usable remains.
+ */
+export declare function normalizeTaskIntegrations(value: unknown): Record<string, TaskBoardExtensionPayload> | undefined;
+/** One action a provider dispatches over the board's same-origin channel. */
+export interface TaskBoardExtensionActionRequest {
+    /** Id of the extension the action belongs to. */
+    extensionId: string;
+    /** Provider-owned action name, routed back to that extension's handleAction. */
+    action: string;
+    /** Task the action targets, when it targets one. */
+    taskId?: string;
+    /** Opaque provider payload, bounded like every other extension payload. */
+    payload?: TaskBoardExtensionPayload;
+}
+/**
+ * Deliver one extension action through the board's same-origin action channel.
+ * The extension never opens an HTTP surface of its own.
+ */
+export type TaskBoardExtensionDispatch = (request: TaskBoardExtensionActionRequest) => Promise<boolean>;
+/** Draft one provider creates a task from. */
+export interface TaskBoardTaskDraft {
+    title: string;
+    description: string;
+    prompt: string;
+    /** Column the created card opens in; absent means the board default (todo). */
+    status?: TaskStatus;
+    /** Parent card id, when the provider materializes a subtask. */
+    parentId?: string;
+    /**
+     * Workspace the execution must run in. Absent leaves the board's own
+     * inheritance rules in charge (the creating session's workspace for a root
+     * card, else the recent workspace at execution time), so a provider that has
+     * no reason to know better pins nothing.
+     */
+    workspaceId?: string;
+}
+/** Options of {@link TaskBoardTasksFace.create}. */
+export interface TaskBoardCreateOptions {
+    /** Opaque payload stored under the creating extension's id. */
+    payload?: TaskBoardExtensionPayload;
+    /** Create the card off-board: it exists in the ledger but is never shown on the board. */
+    hidden?: boolean;
+}
+/** One task linked to an extension, with that extension's own payload. */
+export interface TaskBoardLinkedTask {
+    task: TaskRecord;
+    payload: TaskBoardExtensionPayload;
+}
+/** Task reads and writes the board grants an extension. */
+export interface TaskBoardTasksFace {
+    /** Every task in the ledger, most recent mutation last. */
+    list(): readonly TaskRecord[];
+    /** One task by id, or undefined. */
+    get(taskId: string): TaskRecord | undefined;
+    /**
+     * Create a task through the board's own creation gate; the payload lands
+     * under the creating extension's id. Throws on a refused draft.
+     */
+    create(draft: TaskBoardTaskDraft, options?: TaskBoardCreateOptions): TaskRecord;
+    /**
+     * Patch a task's content. Reuses the board's own content gate: a task that
+     * has started executing keeps its recorded title/description/prompt.
+     * Throws when the card is frozen.
+     */
+    patchContent(taskId: string, patch: {
+        title?: string;
+        description?: string;
+        prompt?: string;
+    }): void;
+    /**
+     * Move a task through the board's existing status gates (running lock,
+     * permission confirmation gate). Throws on refusal.
+     */
+    setStatus(taskId: string, status: TaskStatus, initiator?: string): void;
+    /** Every task carrying this extension's payload. */
+    linked(): readonly TaskBoardLinkedTask[];
+}
+/** Storage face for one extension's own payload on a task. */
+export interface TaskBoardIntegrationFace {
+    /** Read this extension's payload, or undefined when the task carries none. */
+    read(taskId: string): TaskBoardExtensionPayload | undefined;
+    /**
+     * Shallow-merge this extension's payload into the task: the given keys
+     * replace the stored ones, and a key explicitly set to undefined clears it.
+     * The board stores the result opaquely; a non-JSON or oversized payload is
+     * refused.
+     */
+    write(taskId: string, payload: TaskBoardExtensionPayload): void;
+}
+/** Status-change notification. */
+export interface TaskBoardStatusChangedEvent {
+    taskId: string;
+    status: TaskStatus;
+    previous: TaskStatus;
+    initiator?: string;
+}
+/** Execution-settlement notification. */
+export interface TaskBoardExecutionSettledEvent {
+    taskId: string;
+    executionId: string;
+    outcome: ExecutionOutcome;
+    error?: string;
+}
+/** Task-deletion notification. */
+export interface TaskBoardTaskDeletedEvent {
+    taskId: string;
+}
+/**
+ * Event subscriptions an extension registers for. Every callback runs isolated:
+ * a throw is logged and never interrupts the board's own execution path.
+ */
+export interface TaskBoardEventFace {
+    onStatusChanged(callback: (event: TaskBoardStatusChangedEvent) => void): () => void;
+    onExecutionSettled(callback: (event: TaskBoardExecutionSettledEvent) => void): () => void;
+    onTaskDeleted(callback: (event: TaskBoardTaskDeletedEvent) => void): () => void;
+}
+/**
+ * Host capability face handed to one extension while it is started. The face
+ * lives for the extension's enabled lifetime; the board revokes it by calling
+ * the extension's stop().
+ */
+export interface TaskBoardExtensionHost {
+    tasks: TaskBoardTasksFace;
+    integration: TaskBoardIntegrationFace;
+    events: TaskBoardEventFace;
+    /**
+     * Publish this extension's read-only summary; it lands in the snapshot's
+     * extensions[id] for the extension's browser half to render.
+     */
+    publish(summary: TaskBoardExtensionPayload): void;
+    /** Register one model-visible tool; the returned disposer unregisters it. */
+    registerTool(definition: ToolDefinition): () => void;
+}
+/** One external provider contributed to the task board. */
+export interface TaskBoardExtension {
+    /** Stable extension id; also the key of this extension's integration payload. */
+    readonly id: string;
+    /** Contract version this extension was built against. */
+    readonly apiVersion: number;
+    /** Volatile per-extension switch; absent means enabled. Read at use time. */
+    enabled?(): boolean;
+    /** Acquire the capability face and start any provider-side work. */
+    start?(host: TaskBoardExtensionHost): void;
+    /** Release provider-side work. Never clears stored data. */
+    stop?(): void;
+    /** Route one dispatched action; the returned value goes back to the dispatcher. */
+    handleAction?(request: TaskBoardExtensionActionRequest): unknown | Promise<unknown>;
+}
+/** Board mirror an extension's browser half observes. */
+export interface TaskBoardClientMirror {
+    /** Whether the board's master switch currently runs the extension faces. */
+    enabled: boolean;
+    /** Tasks the board currently holds. */
+    tasks: readonly TaskRecord[];
+    /** Published extension summaries, keyed by extension id (opaque to the board). */
+    extensions: Readonly<Record<string, unknown>>;
+}
+/** Whether a task should be shown on the board; false hides it. */
+export type TaskBoardVisibilityPredicate = (task: TaskRecord) => boolean;
+/**
+ * Client capability face the board's browser half provides. A provider's
+ * browser half resolves it from the shared cordis service name; it never
+ * value-imports the board package.
+ */
+export interface TaskBoardClientFace {
+    /** Deliver one action through the board's same-origin action channel. */
+    dispatch(request: TaskBoardExtensionActionRequest): Promise<boolean>;
+    /** Register one card visibility predicate; the returned disposer removes it. */
+    registerVisibility(predicate: TaskBoardVisibilityPredicate): () => void;
+    /** Subscribe to the board mirror. */
+    subscribe(callback: (mirror: TaskBoardClientMirror) => void): () => void;
+    /** Read the current board mirror. */
+    snapshot(): TaskBoardClientMirror;
+}
+/** Owner props of the task-detail seat. */
+export interface TaskBoardDetailSectionProps {
+    task: TaskRecord;
+    dispatch: TaskBoardExtensionDispatch;
+}
+/** Owner props of the settings seat. */
+export interface TaskBoardSettingsSectionProps {
+    dispatch: TaskBoardExtensionDispatch;
+}
+/** Owner props of the card-decoration seat. */
+export interface TaskBoardCardDecorationProps {
+    task: TaskRecord;
+}
+/**
+ * Host-half service face published under {@link TASK_BOARD_SERVICE_NAME}. A
+ * provider package's host half resolves this from the shared cordis service
+ * and registers its extension; the board's ledger never crosses this boundary.
+ */
+export interface TaskBoardHostFace {
+    /**
+     * Admit one provider extension. Idempotent by extension id; the returned
+     * disposer releases it without clearing stored data.
+     */
+    registerExtension(extension: TaskBoardExtension): () => void;
+    /** Whether the board currently runs a given extension (board x extension). */
+    isExtensionEnabled(extensionId: string): boolean;
+}
+declare module '@deepseek-ai/cordis' {
+    interface Context {
+        /**
+         * The board's extension service. The host half publishes
+         * {@link TaskBoardHostFace}; the browser half publishes
+         * {@link TaskBoardClientFace} under the same name. The two halves never run
+         * in one process, so the browser half resolves its face through
+         * {@link resolveTaskBoardClientFace} and this shared declaration names the
+         * host face that registration-side consumers type against.
+         */
+        taskBoard: TaskBoardHostFace;
+    }
+}
+/** The narrow context seat {@link resolveTaskBoardClientFace} needs. */
+export interface TaskBoardClientContextSeat {
+    get(name: string): unknown;
+}
+/**
+ * Resolve the browser half's client capability face by service name. Returns
+ * undefined when the board is not loaded or the service is not served, so a
+ * provider's browser half can degrade instead of throwing.
+ * @param ctx - client context.
+ * @returns the client face, or undefined.
+ */
+export declare function resolveTaskBoardClientFace(ctx: TaskBoardClientContextSeat): TaskBoardClientFace | undefined;

package/lib/types/core/handover.d.ts

@@ -35,7 +35,11 @@ export declare const HANDOVER_MAX_REFERENCE_BYTES = 512;
 export declare const HANDOVER_MAX_TOTAL_BYTES: number;
 /** Per target-id (workspace/preset) byte cap. */
 export declare const HANDOVER_MAX_TARGET_BYTES = 256;
-/** The board's notion of the deployment session-default permission (fail-safe default). */
+/**
+ * Fail-safe baseline for the confirmation gate: what it falls back to when the
+ * deployment pins no baseline of its own and the Host's default permission
+ * preset cannot be read. Every elevation above it stays gated.
+ */
 export declare const DEFAULT_SESSION_PERMISSION: TaskPermission;
 /** Permission elevation rank (higher = more authority). */
 export declare const PERMISSION_RANK: ReadonlyMap<TaskPermission, number>;
@@ -51,6 +55,14 @@ export declare function handoverOf(input: TaskHandoverInput, now: number): TaskH
 export declare function effectivePermission(task: Pick<TaskRecord, 'permission' | 'handover'>): TaskPermission | undefined;
 /** Whether a binding's permission is elevated above the session default. */
 export declare function exceedsSessionDefault(permission: TaskPermission | undefined, sessionDefault: TaskPermission): boolean;
+/**
+ * Whether a session running at `holder` already carries `permission`: the
+ * permission is absent, or its rank does not exceed the holder's. A teammate
+ * inherits the Lead session's permission and cannot be narrowed below it, so a
+ * subtask's own pin is carried by a team run exactly when this holds, and a pin
+ * it does not carry would be silently dropped instead.
+ */
+export declare function permissionCarriedBy(holder: TaskPermission, permission: TaskPermission | undefined): boolean;
 /**
  * The confirmation-gate predicate: an elevated permission without a human
  * confirmation stamp. Manual run/rerun and cron must refuse such a card.

package/lib/types/core/issue-form.d.ts

@@ -0,0 +1,16 @@
+/**
+ * Issue-form vocabulary the card excerpt recognizes.
+ *
+ * Issue forms from an issue tracker (and the zh templates this family's repositories use)
+ * write the same section headings and empty-field placeholders on every issue.
+ * The patterns are data about those forms, not UI copy, so they live in the
+ * shared core rather than in a locale dictionary; the browser half imports them.
+ *
+ * @module @linxin666/dsh-client-ui-task-board/core/issue-form
+ */
+/** Section headings whose body is the issue's own summary (zh and en forms). */
+export declare const SUMMARY_HEADING: RegExp;
+/** Values an issue form writes for an empty field. */
+export declare const EMPTY_FIELD: RegExp;
+/** A trailing colon (ASCII or full-width) after a heading. */
+export declare const HEADING_COLON: RegExp;

package/lib/types/core/poll-cadence.d.ts

@@ -0,0 +1,31 @@
+/**
+ * Roster-poll cadence: the one recurring Host timer the board holds.
+ *
+ * The cadence is a user setting (seconds), so the bounds and the seconds to
+ * milliseconds conversion live here rather than in either half: the settings
+ * card validates a draft against the same range the Host clamps a hand-edited
+ * configuration to, and a programmatic mount that passes no cadence gets the
+ * default.
+ *
+ * @module dsh-task-board/core/poll-cadence
+ */
+/** Cadence used when neither the settings document nor the mount names one. */
+export declare const DEFAULT_SESSION_POLL_SECONDS = 5;
+/** Shortest accepted cadence: a faster poll only burns CPU on the Host. */
+export declare const SESSION_POLL_MIN_SECONDS = 1;
+/** Longest accepted cadence, five minutes. */
+export declare const SESSION_POLL_MAX_SECONDS = 300;
+/**
+ * Clamp a configured cadence into the supported range. A value the schema
+ * would refuse (non-finite, below the floor, above the ceiling) still leaves
+ * the board polling: an out-of-range setting never disables the timer.
+ * @param seconds - configured cadence in seconds, or undefined for the default.
+ * @returns the effective cadence in seconds.
+ */
+export declare function normalizeSessionPollSeconds(seconds: number | undefined): number;
+/**
+ * The cadence in the milliseconds the Host timer face takes.
+ * @param seconds - configured cadence in seconds, or undefined for the default.
+ * @returns the effective cadence in milliseconds.
+ */
+export declare function sessionPollMs(seconds: number | undefined): number;