@krischoichoi/channel-web 0.6.0

package/lib/protocol.d.ts

@@ -0,0 +1,152 @@
+/**
+ * @krischoichoi/channel-web — client-safe DTO types shared across the host API and
+ * the Web client ("protocol").
+ *
+ * These are deliberately plain, serialisable wire types. They never carry
+ * secrets or adapter-internal payloads; anything that would leak a credential
+ * is intentionally omitted. The client half does not typecheck against these
+ * via tsc (it is bundled by esbuild), but keeping them here documents the
+ * exact shape the host API promises and gives M1 a stable contract.
+ */
+/** Public view of one channel for the Web dashboard. */
+export interface ChannelView {
+    /** Stable adapter / channel id (e.g. "weixin"). */
+    id: string;
+    /** Whether the channel is enabled in configuration. */
+    enabled: boolean;
+    /** Whether credentials are configured. */
+    configured: boolean;
+    /** Whether the adapter is currently mounted for this process. */
+    mounted: boolean;
+    /** Free-form status string, e.g. "connected" | "disconnected". */
+    status: string;
+    /** Optional health summary when the adapter exposes getHealth. */
+    health?: ChannelHealthView | null;
+    /** Adapter capability flags relevant to the dashboard. */
+    capabilities?: {
+        send?: boolean;
+        receive?: boolean;
+        auth?: boolean;
+        streaming?: boolean;
+        [key: string]: boolean | string | undefined;
+    } | null;
+    /** Sanitised last error message; never a raw secret/credential. */
+    lastError?: string | null;
+}
+/** Client-safe projection of ChannelHealth (never a credential). */
+export interface ChannelHealthView {
+    status: 'ok' | 'degraded' | 'down' | 'unknown';
+    detail?: string | null;
+    connection?: boolean | null;
+    authenticated?: boolean | null;
+}
+/** Public QR auth challenge — never includes the adapter's private payload. */
+export interface PublicAuthChallenge {
+    /** Stable challenge id used to poll/complete this flow. */
+    id: string;
+    /** Human-readable instruction. */
+    instruction: string;
+    /** Optional QR image as a data URL or URL for the dialog. */
+    qrUrl?: string | null;
+    /** Optional expiry epoch ms. */
+    expiresAt?: number | null;
+}
+/** Public auth-flow poll response. */
+export interface PublicAuthPoll {
+    /** Flow state. */
+    state: 'pending' | 'authenticated' | 'expired' | 'failed';
+    /** Human-readable detail when the state is not pending. */
+    detail?: string | null;
+    /** Optional hint the UI should surface (e.g. "enter verification code"). */
+    prompt?: string | null;
+}
+/** Request body for the verification-code (auth/input) endpoint. */
+export interface PublicAuthInput {
+    kind: 'verification-code';
+    value: string;
+}
+/** Standard structured error body returned by the host API. */
+export interface PublicError {
+    error: {
+        code: string;
+        message: string;
+    };
+}
+/** How a channel begins an authorization flow (doc §15). */
+export type AuthMethod = 'qr' | 'device' | 'portal-login' | 'credentials' | 'hybrid';
+/** Fine-grained progress of an auth flow (doc §15/§16). */
+export type AuthPhase = 'preparing' | 'waiting-scan' | 'scanned' | 'waiting-confirm' | 'verification-required' | 'credentials-required' | 'authorized' | 'expired' | 'failed' | 'cancelled';
+/** Coarse public auth state, kept M1-compatible (doc §15). */
+export type AuthState = 'pending' | 'authenticated' | 'expired' | 'failed';
+/** Structured QR payload (doc §17): opaque content, data URL, or external URL. */
+export interface PublicQrPayload {
+    kind: 'content' | 'data-url' | 'external-url';
+    value: string;
+    expiresAt?: number | null;
+}
+/** Structured user-facing prompt associated with a phase (doc §16). */
+export interface PublicAuthPrompt {
+    kind: 'verification-code' | 'confirm-on-phone' | 'credentials-required' | 'open-browser';
+    message?: string | null;
+}
+/** Public auth status returned by polling (doc §16). */
+export interface PublicAuthStatus {
+    state: AuthState;
+    phase: AuthPhase;
+    prompt?: PublicAuthPrompt | null;
+    expiresAt?: number | null;
+    detail?: string | null;
+}
+/** Browser-facing auth session (doc §18). Never contains secret values. */
+export interface PublicAuthSession {
+    id: string;
+    channelId: string;
+    state: AuthState;
+    phase: AuthPhase;
+    qr?: PublicQrPayload | null;
+    expiresAt?: number | null;
+    prompt?: PublicAuthPrompt | null;
+}
+/** Input that begins an auth flow (doc §14/§19). */
+export interface AuthBeginInput {
+    method: AuthMethod;
+    accountId?: string;
+}
+/** Auth input submitted during a flow (e.g. a verification code). */
+export interface AuthInput {
+    kind: 'verification-code';
+    value: string;
+}
+/** One selectable setup field of a channel. Secret refs are never exposed. */
+export interface ChannelSetupField {
+    name: string;
+    kind: 'text' | 'secret';
+    secret: boolean;
+    configured: boolean;
+    writable: boolean;
+}
+/** Static setup descriptor advertising a channel's editable surface (doc §29). */
+export interface ChannelSetupDescriptor {
+    fields: ChannelSetupField[];
+    authMethods: AuthMethod[];
+    setupUrl?: string;
+}
+/** Dynamic configured state: never returns secret values (doc §14/§29). */
+export interface ConfiguredState {
+    configured: boolean;
+    fields: Record<string, {
+        configured: boolean;
+        writable: boolean;
+        source?: string;
+    }>;
+}
+/** Row returned by GET /v2/channels (doc §29). */
+export interface ChannelSummary {
+    id: string;
+    configured: boolean;
+    enabled: boolean;
+    mounted: boolean;
+    runtime: 'running' | 'stopped';
+    connection: 'connected' | 'degraded' | 'disconnected' | 'unknown';
+}
+//# sourceMappingURL=protocol.d.ts.map

package/lib/protocol.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"protocol.d.ts","sourceRoot":"","sources":["../src/protocol.ts"],"names":[],"mappings":"AAAA;;;;;;;;;GASG;AAEH,wDAAwD;AACxD,MAAM,WAAW,WAAW;IAC1B,mDAAmD;IACnD,EAAE,EAAE,MAAM,CAAC;IACX,uDAAuD;IACvD,OAAO,EAAE,OAAO,CAAC;IACjB,0CAA0C;IAC1C,UAAU,EAAE,OAAO,CAAC;IACpB,iEAAiE;IACjE,OAAO,EAAE,OAAO,CAAC;IACjB,kEAAkE;IAClE,MAAM,EAAE,MAAM,CAAC;IACf,kEAAkE;IAClE,MAAM,CAAC,EAAE,iBAAiB,GAAG,IAAI,CAAC;IAClC,0DAA0D;IAC1D,YAAY,CAAC,EAAE;QACb,IAAI,CAAC,EAAE,OAAO,CAAC;QACf,OAAO,CAAC,EAAE,OAAO,CAAC;QAClB,IAAI,CAAC,EAAE,OAAO,CAAC;QACf,SAAS,CAAC,EAAE,OAAO,CAAC;QACpB,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,GAAG,MAAM,GAAG,SAAS,CAAC;KAC7C,GAAG,IAAI,CAAC;IACT,mEAAmE;IACnE,SAAS,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CAC3B;AAED,oEAAoE;AACpE,MAAM,WAAW,iBAAiB;IAChC,MAAM,EAAE,IAAI,GAAG,UAAU,GAAG,MAAM,GAAG,SAAS,CAAC;IAC/C,MAAM,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IACvB,UAAU,CAAC,EAAE,OAAO,GAAG,IAAI,CAAC;IAC5B,aAAa,CAAC,EAAE,OAAO,GAAG,IAAI,CAAC;CAChC;AAED,+EAA+E;AAC/E,MAAM,WAAW,mBAAmB;IAClC,2DAA2D;IAC3D,EAAE,EAAE,MAAM,CAAC;IACX,kCAAkC;IAClC,WAAW,EAAE,MAAM,CAAC;IACpB,6DAA6D;IAC7D,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IACtB,gCAAgC;IAChC,SAAS,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CAC3B;AAED,sCAAsC;AACtC,MAAM,WAAW,cAAc;IAC7B,kBAAkB;IAClB,KAAK,EAAE,SAAS,GAAG,eAAe,GAAG,SAAS,GAAG,QAAQ,CAAC;IAC1D,2DAA2D;IAC3D,MAAM,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IACvB,4EAA4E;IAC5E,MAAM,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CACxB;AAED,oEAAoE;AACpE,MAAM,WAAW,eAAe;IAC9B,IAAI,EAAE,mBAAmB,CAAC;IAC1B,KAAK,EAAE,MAAM,CAAC;CACf;AAED,+DAA+D;AAC/D,MAAM,WAAW,WAAW;IAC1B,KAAK,EAAE;QACL,IAAI,EAAE,MAAM,CAAC;QACb,OAAO,EAAE,MAAM,CAAC;KACjB,CAAC;CACH;AASD,4DAA4D;AAC5D,MAAM,MAAM,UAAU,GAAG,IAAI,GAAG,QAAQ,GAAG,cAAc,GAAG,aAAa,GAAG,QAAQ,CAAC;AAErF,2DAA2D;AAC3D,MAAM,MAAM,SAAS,GACjB,WAAW,GACX,cAAc,GACd,SAAS,GACT,iBAAiB,GACjB,uBAAuB,GACvB,sBAAsB,GACtB,YAAY,GACZ,SAAS,GACT,QAAQ,GACR,WAAW,CAAC;AAEhB,8DAA8D;AAC9D,MAAM,MAAM,SAAS,GAAG,SAAS,GAAG,eAAe,GAAG,SAAS,GAAG,QAAQ,CAAC;AAE3E,kFAAkF;AAClF,MAAM,WAAW,eAAe;IAC9B,IAAI,EAAE,SAAS,GAAG,UAAU,GAAG,cAAc,CAAC;IAC9C,KAAK,EAAE,MAAM,CAAC;IACd,SAAS,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CAC3B;AAED,uEAAuE;AACvE,MAAM,WAAW,gBAAgB;IAC/B,IAAI,EAAE,mBAAmB,GAAG,kBAAkB,GAAG,sBAAsB,GAAG,cAAc,CAAC;IACzF,OAAO,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CACzB;AAED,wDAAwD;AACxD,MAAM,WAAW,gBAAgB;IAC/B,KAAK,EAAE,SAAS,CAAC;IACjB,KAAK,EAAE,SAAS,CAAC;IACjB,MAAM,CAAC,EAAE,gBAAgB,GAAG,IAAI,CAAC;IACjC,SAAS,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAC1B,MAAM,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CACxB;AAED,2EAA2E;AAC3E,MAAM,WAAW,iBAAiB;IAChC,EAAE,EAAE,MAAM,CAAC;IACX,SAAS,EAAE,MAAM,CAAC;IAClB,KAAK,EAAE,SAAS,CAAC;IACjB,KAAK,EAAE,SAAS,CAAC;IACjB,EAAE,CAAC,EAAE,eAAe,GAAG,IAAI,CAAC;IAC5B,SAAS,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAC1B,MAAM,CAAC,EAAE,gBAAgB,GAAG,IAAI,CAAC;CAClC;AAED,oDAAoD;AACpD,MAAM,WAAW,cAAc;IAC7B,MAAM,EAAE,UAAU,CAAC;IACnB,SAAS,CAAC,EAAE,MAAM,CAAC;CACpB;AAED,qEAAqE;AACrE,MAAM,WAAW,SAAS;IACxB,IAAI,EAAE,mBAAmB,CAAC;IAC1B,KAAK,EAAE,MAAM,CAAC;CACf;AAED,8EAA8E;AAC9E,MAAM,WAAW,iBAAiB;IAChC,IAAI,EAAE,MAAM,CAAC;IACb,IAAI,EAAE,MAAM,GAAG,QAAQ,CAAC;IACxB,MAAM,EAAE,OAAO,CAAC;IAChB,UAAU,EAAE,OAAO,CAAC;IACpB,QAAQ,EAAE,OAAO,CAAC;CACnB;AAED,kFAAkF;AAClF,MAAM,WAAW,sBAAsB;IACrC,MAAM,EAAE,iBAAiB,EAAE,CAAC;IAC5B,WAAW,EAAE,UAAU,EAAE,CAAC;IAC1B,QAAQ,CAAC,EAAE,MAAM,CAAC;CACnB;AAED,2EAA2E;AAC3E,MAAM,WAAW,eAAe;IAC9B,UAAU,EAAE,OAAO,CAAC;IACpB,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE;QAAE,UAAU,EAAE,OAAO,CAAC;QAAC,QAAQ,EAAE,OAAO,CAAC;QAAC,MAAM,CAAC,EAAE,MAAM,CAAA;KAAE,CAAC,CAAC;CACrF;AAED,kDAAkD;AAClD,MAAM,WAAW,cAAc;IAC7B,EAAE,EAAE,MAAM,CAAC;IACX,UAAU,EAAE,OAAO,CAAC;IACpB,OAAO,EAAE,OAAO,CAAC;IACjB,OAAO,EAAE,OAAO,CAAC;IACjB,OAAO,EAAE,SAAS,GAAG,SAAS,CAAC;IAC/B,UAAU,EAAE,WAAW,GAAG,UAAU,GAAG,cAAc,GAAG,SAAS,CAAC;CACnE"}

package/lib/protocol.js

@@ -0,0 +1,12 @@
+/**
+ * @krischoichoi/channel-web — client-safe DTO types shared across the host API and
+ * the Web client ("protocol").
+ *
+ * These are deliberately plain, serialisable wire types. They never carry
+ * secrets or adapter-internal payloads; anything that would leak a credential
+ * is intentionally omitted. The client half does not typecheck against these
+ * via tsc (it is bundled by esbuild), but keeping them here documents the
+ * exact shape the host API promises and gives M1 a stable contract.
+ */
+export {};
+//# sourceMappingURL=protocol.js.map

package/lib/protocol.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"protocol.js","sourceRoot":"","sources":["../src/protocol.ts"],"names":[],"mappings":"AAAA;;;;;;;;;GASG"}

package/package.json

@@ -0,0 +1,73 @@
+{
+  "name": "@krischoichoi/channel-web",
+  "version": "0.6.0",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/krischoichoi/dsh-channels.git"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "description": "DeepSeek Harness Web client: Settings > Channels (渠道) dashboard",
+  "type": "module",
+  "main": "./lib/index.js",
+  "types": "./lib/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./lib/index.d.ts",
+      "default": "./lib/index.js"
+    },
+    "./client": {
+      "default": "./lib/client.js"
+    },
+    "./protocol": {
+      "types": "./lib/protocol.d.ts",
+      "default": "./lib/protocol.js"
+    },
+    "./package.json": "./package.json"
+  },
+  "dsh": {
+    "client": {
+      "platform": "web",
+      "inject": [
+        "@deepseek-ai/dsh-client-locale",
+        "@deepseek-ai/dsh-client-ui-settings"
+      ]
+    }
+  },
+  "files": [
+    "lib"
+  ],
+  "scripts": {
+    "build": "tsc -p tsconfig.host.json && node build.mjs",
+    "typecheck": "tsc -p tsconfig.json",
+    "test": "vitest run",
+    "clean": "rimraf lib"
+  },
+  "dependencies": {
+    "@krischoichoi/channel-control": "workspace:*",
+    "@krischoichoi/channel-core": "workspace:*",
+    "qrcode": "^1.5.4",
+    "zod": "^4.4.3"
+  },
+  "devDependencies": {
+    "@deepseek-ai/cordis": "^4.0.4",
+    "@deepseek-ai/dsh-client-locale": "0.2.0-rc.2",
+    "@deepseek-ai/dsh-client-ui-settings": "0.2.0-rc.2",
+    "@deepseek-ai/dsh-client-ui-slots": "0.2.0-rc.2",
+    "@deepseek-ai/dsh-client-ui-primitives": "0.2.0-rc.2",
+    "@types/qrcode": "^1.5.6",
+    "@types/react": "^18.3.1",
+    "esbuild": "^0.28.2",
+    "react": "^18.3.1",
+    "rimraf": "^6.0.0",
+    "typescript": "^5.9.0",
+    "vitest": "^3.2.0"
+  },
+  "peerDependencies": {
+    "@deepseek-ai/cordis": "^4.0.4",
+    "@deepseek-ai/dsh-client-locale": "0.2.0-rc.2",
+    "@deepseek-ai/dsh-client-ui-settings": "0.2.0-rc.2"
+  },
+  "license": "MIT"
+}