@cavi-ai/api-client 0.1.0

package/dist/extensions/cavi/contracts/mobile.d.ts

@@ -0,0 +1,441 @@
+import type { GatewayMode } from "./surfaces.js";
+export type MobileGatewaySurfaceClass = "gateway-native" | "compatibility-shim" | "blocked";
+export type MobileGatewayEndpointContract = {
+    surface: string;
+    classification: MobileGatewaySurfaceClass;
+    method?: "GET" | "POST" | "PATCH" | "PUT" | "DELETE";
+    currentPath?: string;
+    hermesPath?: string;
+    owner: string;
+    note: string;
+};
+export type OperatorTaskDispatchMode = "operator-task-shim" | "kanban-native" | "blocked";
+export type MobileGatewayContractGap = {
+    area: string;
+    expectedContract: string;
+    note: string;
+    reason: "backend-not-configured" | "unknown";
+};
+export type GatewayTargets = {
+    rawBase: string;
+    httpBase: string;
+    wsBase: string;
+    authToken: string | null;
+    wsPath: string;
+};
+export type HermesGatewayTargets = GatewayTargets;
+export declare const GATEWAY_WS_PATH: string;
+export declare const GATEWAY_KANBAN_TASKS_PATH: string;
+export declare const GATEWAY_KANBAN_BOARD_PATH: string;
+export declare const HERMES_WS_PATH: string;
+export declare const HERMES_KANBAN_TASKS_PATH: string;
+export declare const HERMES_KANBAN_BOARD_PATH: string;
+export declare const MOBILE_GATEWAY_ENDPOINT_CONTRACTS: {
+    readonly providerConfig: {
+        readonly surface: "provider-config";
+        readonly classification: "gateway-native";
+        readonly hermesPath: "http-base + /v1/*, /health*; ws-base + /api/ws";
+        readonly owner: "method-man";
+        readonly note: "Resolve explicit HTTP and WS targets from the saved gateway URL; preserve bearer auth.";
+    };
+    readonly preflightHealth: {
+        readonly surface: "preflight-health";
+        readonly classification: "gateway-native";
+        readonly method: "GET";
+        readonly hermesPath: string;
+        readonly owner: "method-man";
+        readonly note: "Primary reachability check for the selected gateway API server.";
+    };
+    readonly preflightHealthDetailed: {
+        readonly surface: "preflight-health-detailed";
+        readonly classification: "gateway-native";
+        readonly method: "GET";
+        readonly hermesPath: string;
+        readonly owner: "method-man";
+        readonly note: "Detailed health check; failures should be reported without hiding the basic health result.";
+    };
+    readonly preflightCapabilities: {
+        readonly surface: "preflight-capabilities";
+        readonly classification: "gateway-native";
+        readonly method: "GET";
+        readonly hermesPath: string;
+        readonly owner: "method-man";
+        readonly note: "Authenticated API-server capability proof for saved bearer tokens.";
+    };
+    readonly websocketSession: {
+        readonly surface: "websocket-session";
+        readonly classification: "gateway-native";
+        readonly hermesPath: string;
+        readonly owner: "method-man";
+        readonly note: "Dashboard/TUI JSON-RPC for chat, sessions, logs, and health.snapshot.";
+    };
+    readonly gatewayMediaProviders: {
+        readonly surface: "gateway-media-providers";
+        readonly classification: "gateway-native";
+        readonly method: "GET";
+        readonly hermesPath: string;
+        readonly owner: "gateway/media contract";
+        readonly note: "Shared media provider inventory for audio, image, video, and music generation across Hermes and OpenClaw.";
+    };
+    readonly gatewayMediaAudio: {
+        readonly surface: "gateway-media-audio";
+        readonly classification: "gateway-native";
+        readonly method: "POST";
+        readonly hermesPath: string;
+        readonly owner: "gateway/media contract";
+        readonly note: "Core audio generation route; Machine TTS remains only a compatibility shim.";
+    };
+    readonly gatewayMediaImage: {
+        readonly surface: "gateway-media-image";
+        readonly classification: "gateway-native";
+        readonly method: "POST";
+        readonly hermesPath: string;
+        readonly owner: "gateway/media contract";
+        readonly note: "Core image generation route exposed through the provider-neutral media client.";
+    };
+    readonly gatewayMediaVideo: {
+        readonly surface: "gateway-media-video";
+        readonly classification: "gateway-native";
+        readonly method: "POST";
+        readonly hermesPath: string;
+        readonly owner: "gateway/media contract";
+        readonly note: "Core video generation route exposed through the provider-neutral media client.";
+    };
+    readonly gatewayMediaMusic: {
+        readonly surface: "gateway-media-music";
+        readonly classification: "gateway-native";
+        readonly method: "POST";
+        readonly hermesPath: string;
+        readonly owner: "gateway/media contract";
+        readonly note: "Core music generation route exposed through the provider-neutral media client.";
+    };
+    readonly gatewayMediaJob: {
+        readonly surface: "gateway-media-job";
+        readonly classification: "gateway-native";
+        readonly method: "GET";
+        readonly hermesPath: string;
+        readonly owner: "gateway/media contract";
+        readonly note: "Core media job status route used by audio, image, video, and music generation.";
+    };
+    readonly gatewayMediaAssets: {
+        readonly surface: "gateway-media-assets";
+        readonly classification: "gateway-native";
+        readonly method: "GET";
+        readonly hermesPath: string;
+        readonly owner: "gateway/media contract";
+        readonly note: "Core media asset inventory route.";
+    };
+    readonly gatewayMediaAsset: {
+        readonly surface: "gateway-media-asset";
+        readonly classification: "gateway-native";
+        readonly method: "GET";
+        readonly hermesPath: string;
+        readonly owner: "gateway/media contract";
+        readonly note: "Core media asset bytes and metadata route.";
+    };
+    readonly gatewayWikiVaults: {
+        readonly surface: "gateway-wiki-vaults";
+        readonly classification: "gateway-native";
+        readonly method: "GET";
+        readonly hermesPath: string;
+        readonly owner: "gateway/wiki contract";
+        readonly note: "Core wiki vault inventory for external Obsidian/QMD plugin vaults.";
+    };
+    readonly gatewayWikiTree: {
+        readonly surface: "gateway-wiki-tree";
+        readonly classification: "gateway-native";
+        readonly method: "GET";
+        readonly hermesPath: string;
+        readonly owner: "gateway/wiki contract";
+        readonly note: "Core wiki tree route; legacy vault tree remains a compatibility shim.";
+    };
+    readonly gatewayWikiRead: {
+        readonly surface: "gateway-wiki-read";
+        readonly classification: "gateway-native";
+        readonly method: "GET";
+        readonly hermesPath: string;
+        readonly owner: "gateway/wiki contract";
+        readonly note: "Core wiki read route for QMD/Markdown pages.";
+    };
+    readonly gatewayWikiIngest: {
+        readonly surface: "gateway-wiki-ingest";
+        readonly classification: "gateway-native";
+        readonly method: "POST";
+        readonly hermesPath: string;
+        readonly owner: "gateway/wiki contract";
+        readonly note: "Core wiki ingest route used by Hermes and OpenClaw external wiki plugins.";
+    };
+    readonly gatewayWikiCompile: {
+        readonly surface: "gateway-wiki-compile";
+        readonly classification: "gateway-native";
+        readonly method: "POST";
+        readonly hermesPath: string;
+        readonly owner: "gateway/wiki contract";
+        readonly note: "Core QMD compile route for wiki pages and collections.";
+    };
+    readonly gatewayWikiPromote: {
+        readonly surface: "gateway-wiki-promote";
+        readonly classification: "gateway-native";
+        readonly method: "POST";
+        readonly hermesPath: string;
+        readonly owner: "gateway/wiki contract";
+        readonly note: "Core wiki promotion route for durable vault publishing.";
+    };
+    readonly costHistory: {
+        readonly surface: "cost-history";
+        readonly classification: "compatibility-shim";
+        readonly method: "GET";
+        readonly currentPath: string;
+        readonly owner: "gateway/cavi owner";
+        readonly note: "No native gateway cost history endpoint identified; keep gateway-side CAVI shim.";
+    };
+    readonly operatorStatus: {
+        readonly surface: "operator-status";
+        readonly classification: "compatibility-shim";
+        readonly method: "GET";
+        readonly currentPath: string;
+        readonly owner: "gateway/cavi owner";
+        readonly note: "Legacy operator-status shim used only as an HTTP preflight fallback.";
+    };
+    readonly operatorSnapshot: {
+        readonly surface: "operator-snapshot";
+        readonly classification: "compatibility-shim";
+        readonly method: "GET";
+        readonly currentPath: string;
+        readonly hermesPath: string;
+        readonly owner: "gateway/cavi owner";
+        readonly note: "Operator aggregate shim mirrors Hermes Kanban-backed task visibility for mobile while preserving the existing CAVI path.";
+    };
+    readonly operatorTaskDispatch: {
+        readonly surface: "operator-task-dispatch";
+        readonly classification: "compatibility-shim";
+        readonly method: "POST";
+        readonly currentPath: string;
+        readonly hermesPath: string;
+        readonly owner: "ODB + gateway owner";
+        readonly note: "Existing OperatorTaskCreateRequest envelope is accepted by the operator shim and mapped to Kanban task creation server-side.";
+    };
+    readonly kanbanTasks: {
+        readonly surface: "kanban-tasks";
+        readonly classification: "gateway-native";
+        readonly method: "POST";
+        readonly hermesPath: string;
+        readonly owner: "gateway/kanban owner";
+        readonly note: "Hermes API Server exposes Kanban task creation through bearer-authenticated /api/plugins/kanban/tasks for mobile and operator surfaces.";
+    };
+    readonly kanbanBoard: {
+        readonly surface: "kanban-board";
+        readonly classification: "gateway-native";
+        readonly method: "GET";
+        readonly hermesPath: string;
+        readonly owner: "gateway/kanban owner";
+        readonly note: "Hermes API Server exposes the unified Kanban board through bearer-authenticated /api/plugins/kanban/board for Project Board and Operator visibility.";
+    };
+    readonly teamWorkspace: {
+        readonly surface: "team-workspace";
+        readonly classification: "gateway-native";
+        readonly method: "GET";
+        readonly hermesPath: string;
+        readonly owner: "gateway/team contract";
+        readonly note: "Preferred agnostic replacement for team-owned folder shims; resolve the concrete path through the team manifest whitelist.";
+    };
+    readonly teamAgentWorkspace: {
+        readonly surface: "team-agent-workspace";
+        readonly classification: "gateway-native";
+        readonly method: "GET";
+        readonly hermesPath: string;
+        readonly owner: "gateway/team contract";
+        readonly note: "Preferred agnostic replacement for agent-owned media/research folder shims; resolve concrete paths through the team manifest whitelist.";
+    };
+    readonly frontDoorDashboard: {
+        readonly surface: "front-door-dashboard";
+        readonly classification: "compatibility-shim";
+        readonly method: "GET";
+        readonly currentPath: string;
+        readonly owner: "front-door gateway owner";
+        readonly note: "No native gateway dashboard endpoint identified; keep Front Door shim.";
+    };
+    readonly frontDoorIdeas: {
+        readonly surface: "front-door-ideas";
+        readonly classification: "compatibility-shim";
+        readonly method: "POST";
+        readonly currentPath: string;
+        readonly owner: "front-door gateway owner";
+        readonly note: "No native gateway mutation endpoint identified; keep Front Door shim.";
+    };
+    readonly frontDoorMemory: {
+        readonly surface: "front-door-memory";
+        readonly classification: "compatibility-shim";
+        readonly method: "POST";
+        readonly currentPath: string;
+        readonly owner: "front-door gateway owner";
+        readonly note: "No native gateway memory endpoint identified; keep Front Door shim.";
+    };
+    readonly frontDoorArticles: {
+        readonly surface: "front-door-articles";
+        readonly classification: "compatibility-shim";
+        readonly method: "POST";
+        readonly currentPath: string;
+        readonly owner: "front-door gateway owner";
+        readonly note: "No native gateway article endpoint identified; keep Front Door shim.";
+    };
+    readonly frontDoorInbox: {
+        readonly surface: "front-door-inbox";
+        readonly classification: "compatibility-shim";
+        readonly method: "POST";
+        readonly currentPath: string;
+        readonly owner: "front-door gateway owner";
+        readonly note: "No native gateway inbox upload endpoint identified; keep Front Door shim.";
+    };
+    readonly tradingDashboard: {
+        readonly surface: "trading-dashboard";
+        readonly classification: "compatibility-shim";
+        readonly method: "GET";
+        readonly currentPath: string;
+        readonly owner: "trading gateway owner";
+        readonly note: "Trading portal snapshot: research packet cards, source folders, market-data recommendations, and source registry status. Mobile falls back to the checked packet-derived baseline until gateway exposes the workspace folder API.";
+    };
+    readonly tradingResearchPackets: {
+        readonly surface: "trading-research-packets";
+        readonly classification: "compatibility-shim";
+        readonly method: "GET";
+        readonly currentPath: string;
+        readonly owner: "trading gateway owner";
+        readonly note: "Thin packet-list endpoint for saved research packet folders under the trading workspace. Must preserve bearer auth and return structured packet metadata, not raw secret-bearing filesystem state.";
+    };
+    readonly fleetLibrary: {
+        readonly surface: "fleet-library";
+        readonly classification: "compatibility-shim";
+        readonly method: "GET";
+        readonly currentPath: string;
+        readonly owner: "library gateway owner";
+        readonly note: "Base Sigmund fleet snapshot; mobile enriches it with library status, inbox, promotable, and review-request paths when available.";
+    };
+    readonly libraryPipelineStatus: {
+        readonly surface: "library-pipeline-status";
+        readonly classification: "compatibility-shim";
+        readonly method: "GET";
+        readonly currentPath: string;
+        readonly owner: "library gateway owner";
+        readonly note: "Scholar's Lounge ingest pipeline counters used by the mobile forge and fleet summaries.";
+    };
+    readonly libraryPipelineInbox: {
+        readonly surface: "library-pipeline-inbox";
+        readonly classification: "compatibility-shim";
+        readonly method: "GET";
+        readonly currentPath: string;
+        readonly owner: "library gateway owner";
+        readonly note: "Optional inbox item detail for assigning arrival pressure to library lanes.";
+    };
+    readonly libraryPromotable: {
+        readonly surface: "library-promotable";
+        readonly classification: "compatibility-shim";
+        readonly method: "GET";
+        readonly currentPath: string;
+        readonly owner: "library gateway owner";
+        readonly note: "Promotable note rows used to hydrate Sigmund's mobile board, promotions, and graph surfaces.";
+    };
+    readonly libraryReviewRequests: {
+        readonly surface: "library-review-requests";
+        readonly classification: "compatibility-shim";
+        readonly method: "GET";
+        readonly currentPath: string;
+        readonly owner: "library gateway owner";
+        readonly note: "Review-request state joined onto promotable notes before mobile renders library operation rows.";
+    };
+    readonly machineDashboard: {
+        readonly surface: "machine-dashboard";
+        readonly classification: "compatibility-shim";
+        readonly method: "GET";
+        readonly currentPath: string;
+        readonly owner: "machine gateway owner";
+        readonly note: "Machine portal aggregate snapshot: voice agents, media rows, sample counters, and Chris/comedy dashboard context. Missing legacy route must use dashboard fallback payload instead of hard-failing the mobile surface.";
+    };
+    readonly machineComedyRun: {
+        readonly surface: "machine-comedy-run";
+        readonly classification: "gateway-native";
+        readonly method: "POST";
+        readonly currentPath: string;
+        readonly hermesPath: string;
+        readonly owner: "machine/chris agent owner";
+        readonly note: "Chris joke/comedy actions prefer Hermes REST/SSE /v1/runs using action machine.chris.comedy.run when the legacy /machine/api/comedy/run shim is missing.";
+    };
+    readonly machineTtsProviders: {
+        readonly surface: "machine-tts-providers";
+        readonly classification: "compatibility-shim";
+        readonly method: "GET";
+        readonly currentPath: string;
+        readonly owner: "machine gateway owner";
+        readonly note: "Voice Lab provider inventory for Chris/audio comedy features; 404 is a compatibility gap, not a mobile crash.";
+    };
+    readonly machineTts: {
+        readonly surface: "machine-tts";
+        readonly classification: "compatibility-shim";
+        readonly method: "POST";
+        readonly currentPath: string;
+        readonly owner: "machine gateway owner";
+        readonly note: "Text-to-speech render path for Machine/Chris audio output; remains gateway-owned media generation shim.";
+    };
+    readonly machineMedia: {
+        readonly surface: "machine-media";
+        readonly classification: "compatibility-shim";
+        readonly method: "GET";
+        readonly currentPath: string;
+        readonly owner: "machine gateway owner";
+        readonly note: "Authenticated Machine media fetch/thumbnail endpoint used by comedy, meme, caption, and voice surfaces.";
+    };
+    readonly machineMemeJobs: {
+        readonly surface: "machine-meme-jobs";
+        readonly classification: "compatibility-shim";
+        readonly method: "GET";
+        readonly currentPath: string;
+        readonly owner: "machine gateway owner";
+        readonly note: "Meme job listing/mutation surface used by the Machine meme workshop; endpoint may be absent on Hermes-only gateways and should degrade gracefully.";
+    };
+    readonly machineChrisComedyMemory: {
+        readonly surface: "machine-chris-comedy-memory";
+        readonly classification: "compatibility-shim";
+        readonly method: "GET";
+        readonly currentPath: string;
+        readonly owner: "machine gateway owner";
+        readonly note: "Portable portal-memory envelope for Chris joke-room themes/callbacks; local device persistence remains the offline fallback.";
+    };
+    readonly machineInbox: {
+        readonly surface: "machine-inbox";
+        readonly classification: "compatibility-shim";
+        readonly method: "POST";
+        readonly currentPath: string;
+        readonly owner: "machine gateway owner";
+        readonly note: "Media/action routes remain machine-owned gateway shims.";
+    };
+    readonly vaultTree: {
+        readonly surface: "vault-tree";
+        readonly classification: "compatibility-shim";
+        readonly method: "GET";
+        readonly currentPath: string;
+        readonly owner: "vault/gateway owner";
+        readonly note: "No native gateway Obsidian route identified in this slice.";
+    };
+    readonly vaultRead: {
+        readonly surface: "vault-read";
+        readonly classification: "compatibility-shim";
+        readonly method: "GET";
+        readonly currentPath: string;
+        readonly owner: "vault/gateway owner";
+        readonly note: "No native gateway Obsidian route identified in this slice.";
+    };
+    readonly wuTangGithub: {
+        readonly surface: "wu-tang-github-proxy";
+        readonly classification: "compatibility-shim";
+        readonly currentPath: string;
+        readonly owner: "wu-tang gateway owner";
+        readonly note: "Keep GitHub PAT custody server-side; never move PAT or GitHub auth to device.";
+    };
+};
+export type MobileGatewaySurfaceKey = keyof typeof MOBILE_GATEWAY_ENDPOINT_CONTRACTS;
+export declare function getMobileGatewayEndpointContract(key: MobileGatewaySurfaceKey): MobileGatewayEndpointContract;
+export declare function getMobileGatewayEndpointPath(key: MobileGatewaySurfaceKey, mode?: GatewayMode): string;
+export declare function createContractGap(key: MobileGatewaySurfaceKey, note?: string): MobileGatewayContractGap;
+export declare function resolveOperatorTaskDispatchContract(mode: OperatorTaskDispatchMode): MobileGatewayEndpointContract;
+export declare function resolveOperatorTaskDispatchPath(mode?: OperatorTaskDispatchMode): string;
+//# sourceMappingURL=mobile.d.ts.map

package/dist/extensions/cavi/contracts/mobile.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"mobile.d.ts","sourceRoot":"","sources":["../../../../src/extensions/cavi/contracts/mobile.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,eAAe,CAAC;AAEjD,MAAM,MAAM,yBAAyB,GACjC,gBAAgB,GAChB,oBAAoB,GACpB,SAAS,CAAC;AAEd,MAAM,MAAM,6BAA6B,GAAG;IAC1C,OAAO,EAAE,MAAM,CAAC;IAChB,cAAc,EAAE,yBAAyB,CAAC;IAC1C,MAAM,CAAC,EAAE,KAAK,GAAG,MAAM,GAAG,OAAO,GAAG,KAAK,GAAG,QAAQ,CAAC;IACrD,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,KAAK,EAAE,MAAM,CAAC;IACd,IAAI,EAAE,MAAM,CAAC;CACd,CAAC;AAEF,MAAM,MAAM,wBAAwB,GAChC,oBAAoB,GACpB,eAAe,GACf,SAAS,CAAC;AAEd,MAAM,MAAM,wBAAwB,GAAG;IACrC,IAAI,EAAE,MAAM,CAAC;IACb,gBAAgB,EAAE,MAAM,CAAC;IACzB,IAAI,EAAE,MAAM,CAAC;IACb,MAAM,EAAE,wBAAwB,GAAG,SAAS,CAAC;CAC9C,CAAC;AAEF,MAAM,MAAM,cAAc,GAAG;IAC3B,OAAO,EAAE,MAAM,CAAC;IAChB,QAAQ,EAAE,MAAM,CAAC;IACjB,MAAM,EAAE,MAAM,CAAC;IACf,SAAS,EAAE,MAAM,GAAG,IAAI,CAAC;IACzB,MAAM,EAAE,MAAM,CAAC;CAChB,CAAC;AAEF,MAAM,MAAM,oBAAoB,GAAG,cAAc,CAAC;AAOlD,eAAO,MAAM,eAAe,QAAqC,CAAC;AAClE,eAAO,MAAM,yBAAyB,QAAgC,CAAC;AACvE,eAAO,MAAM,yBAAyB,QAAgC,CAAC;AACvE,eAAO,MAAM,cAAc,QAAkB,CAAC;AAC9C,eAAO,MAAM,wBAAwB,QAA4B,CAAC;AAClE,eAAO,MAAM,wBAAwB,QAA4B,CAAC;AAElE,eAAO,MAAM,iCAAiC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CAkaoB,CAAC;AAEnE,MAAM,MAAM,uBAAuB,GAAG,MAAM,OAAO,iCAAiC,CAAC;AAErF,wBAAgB,gCAAgC,CAC9C,GAAG,EAAE,uBAAuB,GAC3B,6BAA6B,CAE/B;AAED,wBAAgB,4BAA4B,CAC1C,GAAG,EAAE,uBAAuB,EAC5B,IAAI,GAAE,WAAsB,GAC3B,MAAM,CAUR;AAED,wBAAgB,iBAAiB,CAC/B,GAAG,EAAE,uBAAuB,EAC5B,IAAI,CAAC,EAAE,MAAM,GACZ,wBAAwB,CAY1B;AAED,wBAAgB,mCAAmC,CAAC,IAAI,EAAE,wBAAwB,iCAIjF;AAED,wBAAgB,+BAA+B,CAC7C,IAAI,GAAE,wBAA+C,GACpD,MAAM,CAOR"}