chatwoot-router 0.1.0

package/lib/shared/chatwoot/signature.d.ts

@@ -0,0 +1,3 @@
+export declare function isFreshTimestamp(timestamp: string | undefined, nowSeconds: number): boolean;
+/** Constant-time check (WebCrypto HMAC verify) of a Chatwoot webhook signature. */
+export declare function verifyChatwootSignature(secret: string, timestamp: string, body: Uint8Array, signatureHeader: string | undefined): Promise<boolean>;

package/lib/shared/config.d.ts

@@ -0,0 +1,10 @@
+import { z } from "zod";
+export declare const jsonRecord: z.ZodPipe<z.ZodPipe<z.ZodString, z.ZodTransform<unknown, string>>, z.ZodRecord<z.ZodString, z.ZodString>>;
+export declare class ConfigError extends Error {
+    constructor(message: string);
+}
+export declare function describe(error: z.ZodError): string;
+export declare const reconcileSchema: z.ZodPrefault<z.ZodObject<{
+    lookbackSeconds: z.ZodDefault<z.ZodNumber>;
+    maxCatchUpSeconds: z.ZodDefault<z.ZodNumber>;
+}, z.core.$strict>>;

package/lib/shared/json.d.ts

@@ -0,0 +1,4 @@
+/** A JSON object (not an array). */
+export declare function isRecord(value: unknown): value is Record<string, unknown>;
+/** The parsed value, or undefined when `text` is missing or not JSON. */
+export declare function parseJson(text: string | undefined): unknown;

package/lib/shared/log.d.ts

@@ -0,0 +1,9 @@
+type Fields = Record<string, string | number | boolean | null | undefined>;
+export declare const log: {
+    info: (message: string, fields?: Fields) => void;
+    warn: (message: string, fields?: Fields) => void;
+    error: (message: string, fields?: Fields) => void;
+};
+/** The error's class and message, safe to log: errors in this service never carry bodies. */
+export declare function errorFields(error: unknown): Fields;
+export {};

package/lib/shared/settings.d.ts

@@ -0,0 +1,6 @@
+export interface ConfigEnv {
+    CONFIG?: unknown;
+    CONFIG_KEY?: string;
+    CONFIG_STORE?: KVNamespace;
+}
+export declare function settingsLoader<Env extends ConfigEnv, Settings>(parse: (config: unknown, env: Env) => Settings): (env: Env) => Promise<Settings>;

package/lib/shared/store.d.ts

@@ -0,0 +1,37 @@
+export declare function retryDelay(attempts: number): number;
+export interface Job {
+    key: string;
+    payload: string;
+    version: number;
+    attempts: number;
+    /** When the job was first queued (ms since the epoch). */
+    createdAt: number;
+}
+export declare class QueueStore {
+    protected readonly sql: SqlStorage;
+    protected readonly now: () => number;
+    constructor(sql: SqlStorage, now?: () => number);
+    migrate(): void;
+    get(key: string): string | undefined;
+    set(key: string, value: string, ttlMs?: number): void;
+    delete(key: string): void;
+    list(start: string, end: string): string[];
+    /**
+     * Adds a job, or marks an existing one as needing another run (its version changes). A job
+     * that is backing off after failures keeps its schedule.
+     */
+    enqueue(key: string, priority: number, payload: string, notBefore?: number): void;
+    nextDueJob(): Job | undefined;
+    /** Earliest due time. */
+    nextWakeup(): number | undefined;
+    /** Removes a finished job unless it was enqueued again while running. */
+    completeJob(job: Job): void;
+    deleteJob(key: string): void;
+    retryJob(job: Job, delayMs: number): void;
+    /**
+     * Makes a job due after `delayMs` without counting an attempt: when an invocation runs out of
+     * budget, or Discord rate limits it.
+     */
+    deferJob(job: Job, delayMs?: number): void;
+    prune(): void;
+}

package/lib/shared/stored-config.d.ts

@@ -0,0 +1,6 @@
+import type { z } from "zod";
+/** The configuration in `file` (JSON with comments), validated; throws when it is invalid. */
+export declare function readStoredConfig(file: string | URL, configSchema: z.ZodType): {
+    key: string;
+    value: string;
+};

package/lib/shared/sweep.d.ts

@@ -0,0 +1,11 @@
+import { z } from "zod";
+import type { reconcileSchema } from "./config.ts";
+import type { QueueStore } from "./store.ts";
+declare const passSchema: z.ZodObject<{
+    cutoff: z.ZodNumber;
+    page: z.ZodNumber;
+    startedAt: z.ZodNumber;
+}, z.core.$strip>;
+export declare function readSweepPass(store: QueueStore, accountId: number, reconcile: z.infer<typeof reconcileSchema>): z.infer<typeof passSchema>;
+export declare function saveSweepPass(store: QueueStore, accountId: number, pass: z.infer<typeof passSchema>, nextPage?: number): void;
+export {};

package/lib/shared/types.d.ts

@@ -0,0 +1,86 @@
+export type MessageType = "incoming" | "outgoing" | "activity" | "template";
+export interface RelayAssignee {
+    id?: number | undefined;
+    name?: string | null | undefined;
+}
+/** A Chatwoot agent linked to a Discord user (`agents[]`). */
+export interface LinkedAgent {
+    discordUserId: string;
+}
+/** A file (its URL, and what it is when Chatwoot says), or a shared contact or location, which has no file. */
+export type RelayAttachment = {
+    type: "file";
+    url: string;
+    label?: string;
+} | {
+    type: "contact";
+    name: string;
+    phone: string;
+} | {
+    type: "location";
+    title: string;
+    latitude: number;
+    longitude: number;
+    url: string;
+};
+export interface RelayItem {
+    title: string;
+    description: string;
+    url: string;
+    /** A card's link buttons. */
+    links: Array<{
+        text: string;
+        url: string;
+    }>;
+}
+export interface RelayConversation {
+    /** The conversation's display id (the number shown in Chatwoot). */
+    id: number;
+    /** open, pending, snoozed, or resolved. */
+    status?: string | undefined;
+    channel?: string | null;
+    /** urgent, high, medium, low, or null. */
+    priority?: string | null;
+    labels: string[];
+    contact: {
+        name?: string | null;
+        email?: string | null;
+        phone?: string | null;
+        blocked?: boolean;
+        avatarUrl?: string | null;
+    };
+    assignee?: RelayAssignee | null;
+    customAttributes: Record<string, unknown>;
+}
+export interface RelayMessage {
+    id: number;
+    /** Unix seconds. */
+    createdAt?: number | null;
+    messageType: MessageType;
+    private: boolean;
+    /** Deleted in Chatwoot (its content is replaced by a placeholder). */
+    deleted?: boolean;
+    content: string;
+    emailSubject?: string | null;
+    /** An automatic email reply (out of office, for example): relayed without notifications. */
+    autoReply?: boolean;
+    attachments: RelayAttachment[];
+    /** A bot's options to pick, cards, or articles, with a link each when they have one. */
+    items?: RelayItem[];
+    /** Chatwoot user id -> Discord user id of the linked agents a private note mentions. */
+    mentionedAgents?: ReadonlyMap<number, string>;
+    /** The Discord avatar of the linked agent who sent the message, if any. */
+    discordAvatarUrl?: string;
+    sender?: {
+        name?: string | null | undefined;
+        email?: string | null | undefined;
+        type?: string | null | undefined;
+        avatarUrl?: string | null | undefined;
+    } | undefined;
+    account: {
+        id: number;
+        name: string;
+    };
+    inboxName?: string | null;
+    conversation: RelayConversation;
+}

package/package.json

@@ -0,0 +1,73 @@
+{
+  "name": "chatwoot-router",
+  "version": "0.1.0",
+  "description": "Route Chatwoot conversations with TypeSafe Jev on Cloudflare Workers.",
+  "keywords": [
+    "chatwoot",
+    "cloudflare-workers",
+    "durable-objects",
+    "triage"
+  ],
+  "homepage": "https://github.com/Phala-Network/chatwoot-workers/tree/main/packages/chatwoot-router#readme",
+  "bugs": {
+    "url": "https://github.com/Phala-Network/chatwoot-workers/issues"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/Phala-Network/chatwoot-workers.git",
+    "directory": "packages/chatwoot-router"
+  },
+  "license": "MIT",
+  "type": "module",
+  "exports": {
+    ".": {
+      "types": "./lib/packages/chatwoot-router/src/index.d.ts",
+      "default": "./lib/packages/chatwoot-router/src/index.js"
+    },
+    "./stored-config": {
+      "types": "./lib/packages/chatwoot-router/scripts/stored-config.d.ts",
+      "default": "./lib/packages/chatwoot-router/scripts/stored-config.js"
+    }
+  },
+  "bin": {
+    "chatwoot-router-store-config": "lib/packages/chatwoot-router/scripts/store-config.js"
+  },
+  "files": [
+    "lib/packages/chatwoot-router/src",
+    "lib/packages/chatwoot-router/scripts",
+    "lib/shared",
+    "CHANGELOG.md",
+    "LICENSE"
+  ],
+  "packageManager": "npm@12.1.0",
+  "engines": {
+    "node": ">=24.15.0"
+  },
+  "scripts": {
+    "dev": "cf dev",
+    "lint": "biome check .",
+    "format": "biome check --write .",
+    "types": "cf workers types",
+    "typecheck": "cf workers types && tsc --noEmit && tsc --noEmit -p tsconfig.node.json",
+    "test": "vitest run",
+    "build": "cf build",
+    "deploy": "cf deploy",
+    "gen:chatwoot": "npx --yes --package=openapi-typescript@7.13.0 --package=typescript@5.9.3 -- openapi-typescript https://raw.githubusercontent.com/chatwoot/chatwoot/v4.18.0/swagger/swagger.json --empty-objects-unknown -o ../../shared/chatwoot/schema.d.ts",
+    "store-config": "node scripts/store-config.ts",
+    "build:package": "node ../../scripts/build-package.ts",
+    "prepack": "npm run build:package"
+  },
+  "devDependencies": {
+    "@cloudflare/vite-plugin": "2.0.0-beta.sha-805ec1ff3"
+  },
+  "dependencies": {
+    "hono": "^4.13.10",
+    "ip-regex": "^5.0.0",
+    "jsonc-parser": "^3.3.1",
+    "openapi-fetch": "^0.17.0",
+    "zod": "^4.6.5"
+  },
+  "publishConfig": {
+    "access": "public"
+  }
+}