@krischoichoi/channel-web 0.6.0

package/lib/host/routes-v2.d.ts

@@ -0,0 +1,149 @@
+/**
+ * dsh-channels host API v2 control-plane routes (M4-M5 host side).
+ *
+ * Lives on `/dsh-channels/api/v2` and delegates every operation to the
+ * ChannelControlService (doc §28–§33). This is deliberately a THIN layer:
+ *
+ * ```text
+ * HTTP → validate (strict schema) → ChannelControlLike → serialize public DTO
+ * ```
+ *
+ * The web layer never knows credential ref names: setup descriptors carry
+ * credential fields, and `saveCredential` maps a field name to its ref
+ * server-side (doc §31). Secret values are never echoed — the credential PUT
+ * returns only `{ configured, writable }`.
+ *
+ * The service is injected as a structural seam ([ChannelControlLike]) so this
+ * package ships no hard dependency on the concrete control-plane plugin; when
+ * the seam is absent (standalone web profile) the caller registers a 503 stub
+ * instead.
+ */
+import type { AuthBeginInput, AuthInput, BundleUpdateStatus, ChannelAccessState, ChannelSetupDescriptor, ChannelSetupInput, ChannelSetupResult, ChannelSummary, ConfiguredState, PublicAuthSession, PublicAuthStatus, PublicConversationIdentity, PublicOwnerClaimSession } from '@krischoichoi/channel-control';
+import type { ChannelAccessPolicy } from '@krischoichoi/channel-core';
+import { z } from 'zod';
+/** Minimal structural view of the ChannelControlService surface we consume. */
+export interface ChannelControlLike {
+    listChannels(): Promise<ChannelSummary[]>;
+    getSetup(channelId: string): Promise<ChannelSetupDescriptor>;
+    getConfiguredState(channelId: string): Promise<ConfiguredState>;
+    setEnabled(channelId: string, enabled: boolean): Promise<ChannelSummary>;
+    saveConfig(channelId: string, patch: Record<string, unknown>): Promise<void>;
+    describeCredential(channelId: string, field: string): Promise<{
+        configured: boolean;
+        writable: boolean;
+        source?: string;
+    }>;
+    saveCredential(channelId: string, field: string, value: string): Promise<{
+        configured: boolean;
+        writable: boolean;
+    }>;
+    applySetup(channelId: string, input: ChannelSetupInput): Promise<ChannelSetupResult>;
+    beginAuth(channelId: string, input: AuthBeginInput): Promise<PublicAuthSession>;
+    pollAuth(sessionId: string): Promise<PublicAuthStatus>;
+    submitAuthInput(sessionId: string, input: AuthInput): Promise<PublicAuthStatus>;
+    cancelAuth(sessionId: string): Promise<void>;
+    getAccess(channelId: string, accountId?: string): Promise<ChannelAccessState>;
+    saveAccess(channelId: string, policy: ChannelAccessPolicy, accountId?: string): Promise<ChannelAccessState>;
+    beginOwnerClaim(channelId: string, accountId?: string): Promise<PublicOwnerClaimSession>;
+    getOwnerClaim(channelId: string, claimId: string): Promise<PublicOwnerClaimSession>;
+    confirmOwnerClaim(channelId: string, claimId: string): Promise<ChannelAccessState>;
+    cancelOwnerClaim(channelId: string, claimId: string): Promise<void>;
+    listConversations(channelId: string, accountId?: string): Promise<PublicConversationIdentity[]>;
+    findConversation(channelId: string, externalId: string, accountId?: string): Promise<PublicConversationIdentity | undefined>;
+    getUpdateStatus(): Promise<BundleUpdateStatus>;
+}
+export interface ApiResultV2 {
+    status: number;
+    body: unknown;
+}
+export declare class ChannelApiV2 {
+    private readonly control;
+    constructor(control: ChannelControlLike);
+    /**
+     * Resolve whether a channel id exists (via the setup descriptor). Returns a
+     * 404 result for unknown channels so every channel-scoped endpoint reports a
+     * stable code.
+     */
+    private channelOr404;
+    /** GET /channels → { channels: ChannelSummary[] } (doc §29). */
+    listChannels(): Promise<ApiResultV2>;
+    /**
+     * GET /update-check → BundleUpdateStatus. Panel-level read-only DTO (no
+     * secrets); the host performs the registry check so the browser never
+     * contacts npm itself.
+     */
+    getUpdateCheck(): Promise<ApiResultV2>;
+    /** GET /channels/:channelId/setup → ChannelSetupDescriptor (doc §29). */
+    getSetup(channelId: string): Promise<ApiResultV2>;
+    /**
+     * PUT /channels/:channelId/enabled → ChannelSummary (doc §23).
+     * Body: `{ enabled: boolean }`. The control plane persists the intent and
+     * starts/stops the runtime accordingly.
+     */
+    setEnabled(channelId: string, body: unknown): Promise<ApiResultV2>;
+    /** PUT /channels/:channelId/setup → save the whole form and reconcile. */
+    applySetup(channelId: string, body: unknown): Promise<ApiResultV2>;
+    /** PATCH /channels/:channelId/config → { configured, fields } (doc §30). */
+    saveConfig(channelId: string, body: unknown): Promise<ApiResultV2>;
+    /** PUT /channels/:channelId/credentials/:field → { configured, writable } (doc §31). */
+    saveCredential(channelId: string, field: string, body: unknown): Promise<ApiResultV2>;
+    /** POST /channels/:channelId/auth/sessions → 201 PublicAuthSession (doc §32). */
+    beginAuth(channelId: string, body: unknown): Promise<ApiResultV2>;
+    /** GET /channels/:channelId/auth/sessions/:sessionId → PublicAuthStatus (doc §32). */
+    pollAuth(channelId: string, sessionId: unknown): Promise<ApiResultV2>;
+    /** POST /channels/:channelId/auth/sessions/:sessionId/input → PublicAuthStatus (doc §32). */
+    submitInput(channelId: string, sessionId: unknown, body: unknown): Promise<ApiResultV2>;
+    /** DELETE /channels/:channelId/auth/sessions/:sessionId → 204 (doc §32). */
+    cancelAuth(channelId: string, sessionId: unknown): Promise<ApiResultV2>;
+    /** GET /channels/:channelId/access → ChannelAccessState. */
+    getAccess(channelId: string): Promise<ApiResultV2>;
+    /**
+     * PUT /channels/:channelId/access → ChannelAccessState.
+     * Body is a strict ChannelAccessPolicy; malformed input is a 400 INVALID_INPUT
+     * before it reaches the control plane.
+     */
+    saveAccess(channelId: string, body: unknown): Promise<ApiResultV2>;
+    /** POST /channels/:channelId/access/owner-claims → 201 PublicOwnerClaimSession. */
+    beginOwnerClaim(channelId: string): Promise<ApiResultV2>;
+    /** GET /channels/:channelId/access/owner-claims/:claimId → PublicOwnerClaimSession. */
+    getOwnerClaim(channelId: string, claimId: unknown): Promise<ApiResultV2>;
+    /** POST /channels/:channelId/access/owner-claims/:claimId/confirm → ChannelAccessState. */
+    confirmOwnerClaim(channelId: string, claimId: unknown): Promise<ApiResultV2>;
+    /** DELETE /channels/:channelId/access/owner-claims/:claimId → 204. */
+    cancelOwnerClaim(channelId: string, claimId: unknown): Promise<ApiResultV2>;
+    /**
+     * GET /channels/:channelId/conversations → { conversations } — observed
+     * conversation identities (plan §35). Display/mapping metadata only.
+     */
+    listConversations(channelId: string): Promise<ApiResultV2>;
+    /**
+     * GET /channels/:channelId/conversations/by-external/:externalId → the one
+     * observed identity matching an optional human-facing id, or 404 when
+     * the bot has never seen it. Callers must not guess a canonical id.
+     */
+    findConversation(channelId: string, externalId: unknown): Promise<ApiResultV2>;
+    /**
+     * Match a path under `/dsh-channels/api/v2` (the prefix is stripped by the
+     * caller) and dispatch. Returns 404 for unknown routes.
+     */
+    handle(method: string, pathname: string, body: unknown): Promise<ApiResultV2>;
+    /** PATCH config body: a flat JSON object (never nested). */
+    private configPatch;
+    /** PUT credentials body: `{ value: string }` (empty string clears). */
+    private credentialValue;
+    /** PUT setup body: `{ config: object, credentials: Record<string,string> }`. */
+    private setupInput;
+    /** POST auth/sessions body: `{ method: AuthMethod, accountId?: string }`. */
+    private authBeginInput;
+    /** POST session/input body: `{ kind: 'verification-code', value: string }`. */
+    private authInput;
+}
+/**
+ * POST session/input body: `{ kind: 'verification-code', value: string }`.
+ * Shared with the v1 routes so both API generations check the same shape.
+ */
+export declare const authInputSchema: z.ZodObject<{
+    kind: z.ZodLiteral<"verification-code">;
+    value: z.ZodString;
+}, z.core.$loose>;
+//# sourceMappingURL=routes-v2.d.ts.map

package/lib/host/routes-v2.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"routes-v2.d.ts","sourceRoot":"","sources":["../../src/host/routes-v2.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;GAmBG;AACH,OAAO,KAAK,EACV,cAAc,EACd,SAAS,EACT,kBAAkB,EAClB,kBAAkB,EAClB,sBAAsB,EACtB,iBAAiB,EACjB,kBAAkB,EAClB,cAAc,EACd,eAAe,EACf,iBAAiB,EACjB,gBAAgB,EAChB,0BAA0B,EAC1B,uBAAuB,EACxB,MAAM,+BAA+B,CAAC;AACvC,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,4BAA4B,CAAC;AAGtE,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AAGxB,+EAA+E;AAC/E,MAAM,WAAW,kBAAkB;IACjC,YAAY,IAAI,OAAO,CAAC,cAAc,EAAE,CAAC,CAAC;IAC1C,QAAQ,CAAC,SAAS,EAAE,MAAM,GAAG,OAAO,CAAC,sBAAsB,CAAC,CAAC;IAC7D,kBAAkB,CAAC,SAAS,EAAE,MAAM,GAAG,OAAO,CAAC,eAAe,CAAC,CAAC;IAChE,UAAU,CAAC,SAAS,EAAE,MAAM,EAAE,OAAO,EAAE,OAAO,GAAG,OAAO,CAAC,cAAc,CAAC,CAAC;IACzE,UAAU,CAAC,SAAS,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAC7E,kBAAkB,CAChB,SAAS,EAAE,MAAM,EACjB,KAAK,EAAE,MAAM,GACZ,OAAO,CAAC;QAAE,UAAU,EAAE,OAAO,CAAC;QAAC,QAAQ,EAAE,OAAO,CAAC;QAAC,MAAM,CAAC,EAAE,MAAM,CAAA;KAAE,CAAC,CAAC;IACxE,cAAc,CACZ,SAAS,EAAE,MAAM,EACjB,KAAK,EAAE,MAAM,EACb,KAAK,EAAE,MAAM,GACZ,OAAO,CAAC;QAAE,UAAU,EAAE,OAAO,CAAC;QAAC,QAAQ,EAAE,OAAO,CAAA;KAAE,CAAC,CAAC;IACvD,UAAU,CAAC,SAAS,EAAE,MAAM,EAAE,KAAK,EAAE,iBAAiB,GAAG,OAAO,CAAC,kBAAkB,CAAC,CAAC;IACrF,SAAS,CAAC,SAAS,EAAE,MAAM,EAAE,KAAK,EAAE,cAAc,GAAG,OAAO,CAAC,iBAAiB,CAAC,CAAC;IAChF,QAAQ,CAAC,SAAS,EAAE,MAAM,GAAG,OAAO,CAAC,gBAAgB,CAAC,CAAC;IACvD,eAAe,CAAC,SAAS,EAAE,MAAM,EAAE,KAAK,EAAE,SAAS,GAAG,OAAO,CAAC,gBAAgB,CAAC,CAAC;IAChF,UAAU,CAAC,SAAS,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAE7C,SAAS,CAAC,SAAS,EAAE,MAAM,EAAE,SAAS,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,kBAAkB,CAAC,CAAC;IAC9E,UAAU,CACR,SAAS,EAAE,MAAM,EACjB,MAAM,EAAE,mBAAmB,EAC3B,SAAS,CAAC,EAAE,MAAM,GACjB,OAAO,CAAC,kBAAkB,CAAC,CAAC;IAC/B,eAAe,CAAC,SAAS,EAAE,MAAM,EAAE,SAAS,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,uBAAuB,CAAC,CAAC;IACzF,aAAa,CAAC,SAAS,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,GAAG,OAAO,CAAC,uBAAuB,CAAC,CAAC;IACpF,iBAAiB,CAAC,SAAS,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,GAAG,OAAO,CAAC,kBAAkB,CAAC,CAAC;IACnF,gBAAgB,CAAC,SAAS,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAEpE,iBAAiB,CAAC,SAAS,EAAE,MAAM,EAAE,SAAS,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,0BAA0B,EAAE,CAAC,CAAC;IAChG,gBAAgB,CACd,SAAS,EAAE,MAAM,EACjB,UAAU,EAAE,MAAM,EAClB,SAAS,CAAC,EAAE,MAAM,GACjB,OAAO,CAAC,0BAA0B,GAAG,SAAS,CAAC,CAAC;IAEnD,eAAe,IAAI,OAAO,CAAC,kBAAkB,CAAC,CAAC;CAChD;AAED,MAAM,WAAW,WAAW;IAC1B,MAAM,EAAE,MAAM,CAAC;IACf,IAAI,EAAE,OAAO,CAAC;CACf;AAgGD,qBAAa,YAAY;IACX,OAAO,CAAC,QAAQ,CAAC,OAAO;gBAAP,OAAO,EAAE,kBAAkB;IAExD;;;;OAIG;YACW,YAAY;IAiB1B,gEAAgE;IAC1D,YAAY,IAAI,OAAO,CAAC,WAAW,CAAC;IAO1C;;;;OAIG;IACG,cAAc,IAAI,OAAO,CAAC,WAAW,CAAC;IAO5C,yEAAyE;IACnE,QAAQ,CAAC,SAAS,EAAE,MAAM,GAAG,OAAO,CAAC,WAAW,CAAC;IAMvD;;;;OAIG;IACG,UAAU,CAAC,SAAS,EAAE,MAAM,EAAE,IAAI,EAAE,OAAO,GAAG,OAAO,CAAC,WAAW,CAAC;IAWxE,0EAA0E;IACpE,UAAU,CAAC,SAAS,EAAE,MAAM,EAAE,IAAI,EAAE,OAAO,GAAG,OAAO,CAAC,WAAW,CAAC;IAWxE,4EAA4E;IACtE,UAAU,CAAC,SAAS,EAAE,MAAM,EAAE,IAAI,EAAE,OAAO,GAAG,OAAO,CAAC,WAAW,CAAC;IAexE,wFAAwF;IAClF,cAAc,CAAC,SAAS,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,EAAE,IAAI,EAAE,OAAO,GAAG,OAAO,CAAC,WAAW,CAAC;IAW3F,iFAAiF;IAC3E,SAAS,CAAC,SAAS,EAAE,MAAM,EAAE,IAAI,EAAE,OAAO,GAAG,OAAO,CAAC,WAAW,CAAC;IAWvE,sFAAsF;IAChF,QAAQ,CAAC,SAAS,EAAE,MAAM,EAAE,SAAS,EAAE,OAAO,GAAG,OAAO,CAAC,WAAW,CAAC;IAQ3E,6FAA6F;IACvF,WAAW,CAAC,SAAS,EAAE,MAAM,EAAE,SAAS,EAAE,OAAO,EAAE,IAAI,EAAE,OAAO,GAAG,OAAO,CAAC,WAAW,CAAC;IAa7F,4EAA4E;IACtE,UAAU,CAAC,SAAS,EAAE,MAAM,EAAE,SAAS,EAAE,OAAO,GAAG,OAAO,CAAC,WAAW,CAAC;IAQ7E,4DAA4D;IACtD,SAAS,CAAC,SAAS,EAAE,MAAM,GAAG,OAAO,CAAC,WAAW,CAAC;IAMxD;;;;OAIG;IACG,UAAU,CAAC,SAAS,EAAE,MAAM,EAAE,IAAI,EAAE,OAAO,GAAG,OAAO,CAAC,WAAW,CAAC;IAWxE,mFAAmF;IAC7E,eAAe,CAAC,SAAS,EAAE,MAAM,GAAG,OAAO,CAAC,WAAW,CAAC;IAS9D,uFAAuF;IACjF,aAAa,CAAC,SAAS,EAAE,MAAM,EAAE,OAAO,EAAE,OAAO,GAAG,OAAO,CAAC,WAAW,CAAC;IAW9E,2FAA2F;IACrF,iBAAiB,CAAC,SAAS,EAAE,MAAM,EAAE,OAAO,EAAE,OAAO,GAAG,OAAO,CAAC,WAAW,CAAC;IAWlF,sEAAsE;IAChE,gBAAgB,CAAC,SAAS,EAAE,MAAM,EAAE,OAAO,EAAE,OAAO,GAAG,OAAO,CAAC,WAAW,CAAC;IAWjF;;;OAGG;IACG,iBAAiB,CAAC,SAAS,EAAE,MAAM,GAAG,OAAO,CAAC,WAAW,CAAC;IAShE;;;;OAIG;IACG,gBAAgB,CAAC,SAAS,EAAE,MAAM,EAAE,UAAU,EAAE,OAAO,GAAG,OAAO,CAAC,WAAW,CAAC;IAYpF;;;OAGG;IACG,MAAM,CAAC,MAAM,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,EAAE,IAAI,EAAE,OAAO,GAAG,OAAO,CAAC,WAAW,CAAC;IA0EnF,4DAA4D;IAC5D,OAAO,CAAC,WAAW;IAMnB,uEAAuE;IACvE,OAAO,CAAC,eAAe;IAMvB,gFAAgF;IAChF,OAAO,CAAC,UAAU;IA2BlB,6EAA6E;IAC7E,OAAO,CAAC,cAAc;IAatB,+EAA+E;IAC/E,OAAO,CAAC,SAAS;CAWlB;AAED;;;GAGG;AACH,eAAO,MAAM,eAAe;;;iBAGkB,CAAC"}