@kya-os/contracts 1.7.26 → 1.7.32

package/dist/openclaw/types.js

@@ -0,0 +1,122 @@
+"use strict";
+/**
+ * OpenClaw Configuration & Gateway Protocol Types
+ *
+ * Single source of truth for:
+ * 1. openclaw.json config shape (Zod schemas + inferred types)
+ * 2. Gateway Protocol v3 WebSocket frame types (plain interfaces)
+ *
+ * Based on openclaw 2026.2.x config schema.
+ *
+ * @package @kya-os/contracts/openclaw
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.OpenClawConfigSchema = exports.OpenClawModelProviderSchema = exports.OpenClawModelSchema = exports.OpenClawChannelsSchema = exports.OpenClawGatewaySchema = exports.OpenClawControlUiSchema = void 0;
+const zod_1 = require("zod");
+// ============================================================================
+// OpenClaw Config Schemas (openclaw.json)
+// ============================================================================
+/**
+ * Gateway controlUi configuration.
+ * Controls WebSocket access, device auth, and origin allowlisting.
+ */
+exports.OpenClawControlUiSchema = zod_1.z.object({
+    enabled: zod_1.z.boolean().optional(),
+    allowInsecureAuth: zod_1.z.boolean().optional(),
+    dangerouslyDisableDeviceAuth: zod_1.z.boolean().optional(),
+    /** Exact origin strings — no wildcard support */
+    allowedOrigins: zod_1.z.array(zod_1.z.string()).optional(),
+});
+/**
+ * Gateway configuration.
+ * Key differences from older versions:
+ * - bind is an enum ("lan"|"loopback"|"auto"|"custom"|"tailnet"), not an IP
+ */
+exports.OpenClawGatewaySchema = zod_1.z.object({
+    mode: zod_1.z.enum(["local", "remote"]),
+    port: zod_1.z.number().int().positive(),
+    bind: zod_1.z.enum(["lan", "loopback", "auto", "custom", "tailnet"]),
+    auth: zod_1.z.object({
+        token: zod_1.z.string(),
+    }),
+    remote: zod_1.z
+        .object({
+        token: zod_1.z.string(),
+    })
+        .optional(),
+    trustedProxies: zod_1.z.array(zod_1.z.string()).optional(),
+    controlUi: exports.OpenClawControlUiSchema.optional(),
+});
+/**
+ * Channel configurations.
+ * - Telegram uses "botToken", Discord uses "token" (not "botToken")
+ * - Slack needs both botToken and appToken
+ */
+exports.OpenClawChannelsSchema = zod_1.z.object({
+    telegram: zod_1.z
+        .object({
+        enabled: zod_1.z.boolean(),
+        botToken: zod_1.z.string(),
+        dmPolicy: zod_1.z.string().optional(),
+    })
+        .optional(),
+    discord: zod_1.z
+        .object({
+        enabled: zod_1.z.boolean(),
+        token: zod_1.z.string(),
+        dm: zod_1.z.object({ policy: zod_1.z.string() }).optional(),
+    })
+        .optional(),
+    slack: zod_1.z
+        .object({
+        enabled: zod_1.z.boolean(),
+        botToken: zod_1.z.string(),
+        appToken: zod_1.z.string(),
+    })
+        .optional(),
+    whatsapp: zod_1.z.record(zod_1.z.unknown()).optional(),
+});
+/**
+ * A single model definition within a provider.
+ */
+exports.OpenClawModelSchema = zod_1.z.object({
+    id: zod_1.z.string(),
+    name: zod_1.z.string(),
+    contextWindow: zod_1.z.number().int().positive(),
+    maxTokens: zod_1.z.number().int().positive(),
+});
+/**
+ * AI model provider definition.
+ * Tells OpenClaw how to reach an AI provider (e.g. OpenAI, custom endpoint).
+ */
+exports.OpenClawModelProviderSchema = zod_1.z.object({
+    baseUrl: zod_1.z.string(),
+    apiKey: zod_1.z.string().optional(),
+    api: zod_1.z.string(),
+    models: zod_1.z.array(exports.OpenClawModelSchema),
+});
+/**
+ * Full openclaw.json configuration.
+ *
+ * AI provider keys go in `env` (flat record), not a top-level "ai" key.
+ * The `agents.defaults.model.primary` field sets the default model.
+ */
+exports.OpenClawConfigSchema = zod_1.z.object({
+    gateway: exports.OpenClawGatewaySchema,
+    env: zod_1.z.record(zod_1.z.string()).optional(),
+    channels: exports.OpenClawChannelsSchema.optional(),
+    agents: zod_1.z
+        .object({
+        defaults: zod_1.z
+            .object({
+            model: zod_1.z.object({ primary: zod_1.z.string() }).optional(),
+        })
+            .optional(),
+    })
+        .optional(),
+    models: zod_1.z
+        .object({
+        providers: zod_1.z.record(exports.OpenClawModelProviderSchema).optional(),
+    })
+        .optional(),
+});

package/dist/pairing/index.d.ts

@@ -0,0 +1,44 @@
+/**
+ * Pairing WebSocket event types
+ *
+ * Emitted by compute PairingWatcher via PairingEventBus.
+ * Consumed by Checkpoint UI via WS frames from the control server.
+ *
+ * These types are the canonical contract between compute and dashboard.
+ * Import via @kya-os/contracts or @kya-os/contracts/pairing.
+ */
+/**
+ * WhatsApp login state machine (backend-owned).
+ *
+ * Transitions:
+ *   disabled → enabling → qr_ready → scanned → linked
+ *                                              → failed
+ */
+export type WhatsAppLoginState = "disabled" | "enabling" | "qr_ready" | "scanned" | "linked" | "failed";
+export type PairingRequestedEvent = {
+    event: "channel.pairing.requested";
+    payload: {
+        channel: string;
+        code: string;
+        userId: string;
+        createdAt: string;
+        meta?: Record<string, string>;
+    };
+};
+export type PairingApprovedEvent = {
+    event: "channel.pairing.approved";
+    payload: {
+        channel: string;
+        code: string;
+        userId: string;
+    };
+};
+export type LinkStateChangedEvent = {
+    event: "channel.link.stateChanged";
+    payload: {
+        channel: string;
+        state: WhatsAppLoginState | "waiting_user_start" | "code_issued" | "approved" | "configured";
+        previousState?: string;
+    };
+};
+export type PairingWsEvent = PairingRequestedEvent | PairingApprovedEvent | LinkStateChangedEvent;

package/dist/pairing/index.js

@@ -0,0 +1,11 @@
+"use strict";
+/**
+ * Pairing WebSocket event types
+ *
+ * Emitted by compute PairingWatcher via PairingEventBus.
+ * Consumed by Checkpoint UI via WS frames from the control server.
+ *
+ * These types are the canonical contract between compute and dashboard.
+ * Import via @kya-os/contracts or @kya-os/contracts/pairing.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });