chatwoot-router 0.3.0 → 0.5.0

package/lib/packages/chatwoot-router/src/reply.d.ts

@@ -2,4 +2,4 @@ import { type ChatwootClient, type ChatwootMessage } from "../../../shared/chatw
 /** A Chatwoot creation receipt, not a channel delivery receipt. */
 export declare function confirmedReply(message: ChatwootMessage | undefined, botId: number | undefined): boolean;
 /** Read past turn boundaries, including replies made by the former relay's brand bot. */
-export declare function replyHistory(chatwoot: ChatwootClient, accountId: number, conversationId: number, botId: number | undefined, freshPages?: readonly ChatwootMessage[][]): Promise<"found" | "complete-none" | "unknown">;
+export declare function replyHistory(chatwoot: ChatwootClient, accountId: number, conversationId: number, botId: number | undefined): Promise<"found" | "complete-none" | "unknown">;

package/lib/packages/chatwoot-router/src/router.d.ts

@@ -1,11 +1,15 @@
 import { DurableObject } from "cloudflare:workers";
 import type { Env } from "./env.ts";
 import type { Transition } from "./webhook.ts";
-export declare function conversationName(accountId: number, conversationId: number): string;
+export declare function sweeper(env: Env): DurableObjectStub<Router>;
+export declare function conversationRouter(env: Env, accountId: number, conversationId: number): DurableObjectStub<Router>;
 export declare class Router extends DurableObject<Env> {
     private readonly store;
     constructor(context: DurableObjectState, env: Env);
     enqueueConversation(accountId: number, conversationId: number, transition?: Transition): Promise<void>;
+    requestSweep(): Promise<void>;
     alarm(): Promise<void>;
+    private sweep;
     private enqueue;
+    private schedule;
 }

package/lib/packages/chatwoot-router/src/turn.d.ts

@@ -9,58 +9,6 @@ export declare function requestHandoff(store: RoutingStore, accountId: number, c
 export declare function recordFailure(store: RoutingStore, accountId: number, conversationId: number): number;
 export declare function clearFailures(store: RoutingStore, accountId: number, conversationId: number): void;
 export declare function readTurn(chatwoot: ChatwootClient, store: RoutingStore, accountId: number, conversationId: number): Promise<{
-    pages: {
-        id: number;
-        conversation_id?: number | undefined;
-        content?: string | null | undefined;
-        message_type: number;
-        content_type?: string | null | undefined;
-        status?: string | null | undefined;
-        created_at?: number | null | undefined;
-        private?: boolean | null | undefined;
-        content_attributes?: {
-            email?: {
-                subject?: string | null | undefined;
-                auto_reply?: boolean | null | undefined;
-                text_content?: {
-                    quoted?: string | null | undefined;
-                } | null | undefined;
-                html_content?: {
-                    quoted?: string | null | undefined;
-                } | null | undefined;
-            } | null | undefined;
-            deleted?: boolean | null | undefined;
-            external_error?: string | null | undefined;
-            activity?: {
-                type?: string | null | undefined;
-                status?: string | null | undefined;
-            } | null | undefined;
-            submitted_values?: unknown;
-            submitted_email?: unknown;
-            items?: unknown;
-        } | null | undefined;
-        sender?: {
-            id?: number | null | undefined;
-            name?: string | null | undefined;
-            email?: string | null | undefined;
-            type?: string | null | undefined;
-            thumbnail?: string | null | undefined;
-            avatar_url?: string | null | undefined;
-        } | null | undefined;
-        attachments?: {
-            file_type?: string | null | undefined;
-            data_url?: string | null | undefined;
-            fallback_title?: string | null | undefined;
-            coordinates_lat?: number | null | undefined;
-            coordinates_long?: number | null | undefined;
-            meta?: {
-                firstName?: string | null | undefined;
-                lastName?: string | null | undefined;
-                first_name?: string | null | undefined;
-                last_name?: string | null | undefined;
-            } | null | undefined;
-        }[] | null | undefined;
-    }[][];
     messages: {
         id: number;
         conversation_id?: number | undefined;

package/lib/shared/budget.d.ts

@@ -2,25 +2,14 @@ import type { Fetch } from "./chatwoot/api.ts";
 export declare class BudgetExhaustedError extends Error {
     constructor();
 }
-export { JobDeadlineError } from "./deadline.ts";
-export declare const METADATA_TIMEOUT_MS = 1500;
-export declare const TRANSFER_TIMEOUT_MS = 8000;
-export declare const JOB_SLICE_MS = 10000;
 export declare class Budget {
     readonly limit: number;
     private readonly fetchImpl;
+    private readonly timeoutMs;
     private used;
-    private slice;
-    private sliceEnds;
-    constructor(limit: number, fetchImpl?: Fetch);
+    constructor(limit: number, fetchImpl?: Fetch, timeoutMs?: number);
     get remaining(): number;
-    startSlice(ms?: number): void;
-    requireTime(ms: number): void;
-    checkpoint(): void;
+    /** Counts a request that is not a fetch, such as a call to another Durable Object. */
     consume(): void;
-    require(requests: number): void;
-    controlSignal(ms: number): AbortSignal;
-    fetchWith(timeoutMs: number): Fetch;
     readonly fetch: Fetch;
-    private request;
 }

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

@@ -1,5 +1,4 @@
 import { z } from "zod";
-import type { RateLimitStore } from "../rate-limit.ts";
 import type { RelayConversation, RelayMessage } from "../types.ts";
 import type { components, operations } from "./schema.ts";
 export type Fetch = (input: Request) => Promise<Response>;
@@ -7,18 +6,20 @@ export type Fetch = (input: Request) => Promise<Response>;
 export declare class ChatwootError extends Error {
     readonly status: number;
     readonly conversationMissing: boolean;
-    readonly retryAfterMs: number | undefined;
-    constructor(status: number, operation: string, conversationMissing?: boolean, retryAfterMs?: number);
+    constructor(status: number, operation: string, conversationMissing?: boolean);
 }
 /**
  * A conversation as returned by GET conversations/{id} and in the conversation list. The spec's
  * `status` enum omits `snoozed`, which the API does return, so the relay treats it as a string.
  */
-export type ChatwootConversation = components["schemas"]["conversation_show"] & {
+export type ChatwootConversation = Omit<components["schemas"]["conversation_show"], "snoozed_until"> & {
     meta?: {
         assignee_type?: string | null;
     };
+    snoozed_until?: string | number | null;
 };
+/** Unix seconds when a snoozed conversation reopens; null unless it is snoozed until a time. */
+export declare function snoozedUntil(conversation: ChatwootConversation): number | null;
 declare const messageSchema: z.ZodObject<{
     id: z.ZodNumber;
     conversation_id: z.ZodOptional<z.ZodNumber>;
@@ -99,7 +100,7 @@ export type ChatwootClient = ReturnType<typeof chatwootClient>;
 type MessageQuery = NonNullable<operations["list-all-messages"]["parameters"]["query"]> & {
     filter_internal_messages?: true;
 };
-export declare function chatwootClient(baseUrl: string, token: string, fetch: Fetch, limits?: RateLimitStore): {
+export declare function chatwootClient(baseUrl: string, token: string, fetch: Fetch): {
     /** The conversation, or undefined when it does not exist (it was deleted). */
     getConversation(accountId: number, conversationId: number): Promise<ChatwootConversation | undefined>;
     /** Messages with an id above `after`, oldest first; without `after`, the latest page. */

package/lib/shared/store.d.ts

@@ -1,18 +1,16 @@
 export declare function retryDelay(attempts: number): number;
-export type Job = {
+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;
-    private readonly atomic;
-    constructor(sql: SqlStorage, now?: () => number, atomic?: <T>(write: () => T) => T);
-    transaction<T>(write: () => T): T;
+    constructor(sql: SqlStorage, now?: () => number);
     migrate(): void;
     get(key: string): string | undefined;
     set(key: string, value: string, ttlMs?: number): void;
@@ -23,8 +21,6 @@ export declare class QueueStore {
      */
     enqueue(key: string, priority: number, payload: string, notBefore?: number): void;
     nextDueJob(): Job | undefined;
-    /** A bounded due batch; independent scan and delivery work can select their own keys. */
-    nextDueJobs(limit: number, prefix?: string): Job[];
     /** Earliest due time. */
     nextWakeup(): number | undefined;
     /** Removes a finished job unless it was enqueued again while running. */
@@ -36,9 +32,10 @@ export declare class QueueStore {
      * budget, or Discord rate limits it.
      */
     deferJob(job: Job, delayMs?: number): void;
-    /** One short re-read for a racing status webhook, then wait for an event or a sweep. */
-    holdJob(job: Job): void;
-    /** Suspended conversation jobs need reconciliation even outside the ordinary activity window. */
-    wakeHeldJobs(): void;
+    /**
+     * Makes a job due again after `delayMs`, unless it was queued again while it ran (it is due
+     * then), clearing its failures.
+     */
+    postponeJob(job: Job, delayMs: number): void;
     prune(): void;
 }

package/lib/shared/types.d.ts

@@ -51,6 +51,10 @@ export interface RelayConversation {
     };
     /** Person only; agent bots are represented as unassigned. */
     assignee?: RelayAssignee | null;
+    /** Unix seconds since the customer has waited for a reply (Chatwoot's `waiting_since`); null when they do not. */
+    waitingSince?: number | null;
+    /** Unix seconds when a snoozed conversation reopens; null when not snoozed or snoozed until the next reply. */
+    snoozedUntil?: number | null;
     assigneeType?: string | null;
     customAttributes: Record<string, unknown>;
 }
@@ -66,8 +70,8 @@ export interface RelayMessage {
     emailSubject?: string | null;
     /** An automatic email reply (out of office, for example): relayed without notifications. */
     autoReply?: boolean;
-    /** A qualifying public reply follows this message in Chatwoot. */
-    answered?: boolean;
+    /** A public reply that answers the customer (see isAnsweringReply). */
+    answers?: boolean;
     attachments: RelayAttachment[];
     /** A bot's options to pick, cards, or articles, with a link each when they have one. */
     items?: RelayItem[];

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "chatwoot-router",
-  "version": "0.3.0",
+  "version": "0.5.0",
   "description": "Route Chatwoot conversations with TypeSafe Jev on Cloudflare Workers.",
   "keywords": [
     "chatwoot",

package/lib/packages/chatwoot-router/src/coordinator.d.ts

@@ -1,10 +0,0 @@
-import { DurableObject } from "cloudflare:workers";
-import type { Env } from "./env.ts";
-export declare const COORDINATOR_NAME = "global";
-/** Lists one page per alarm. Conversation state belongs exclusively to the conversation's Router. */
-export declare class Coordinator extends DurableObject<Env> {
-    private readonly store;
-    constructor(ctx: DurableObjectState, env: Env);
-    requestSweep(): Promise<void>;
-    alarm(): Promise<void>;
-}

package/lib/shared/alarm.d.ts

@@ -1,2 +0,0 @@
-/** Set the one Durable Object alarm for the earliest durable wake-up. */
-export declare function scheduleAlarm(state: DurableObjectState, next: number | undefined): Promise<void>;

package/lib/shared/concurrent.d.ts

@@ -1,4 +0,0 @@
-/** Finish or cancel every independent read before the caller can yield to another job. */
-export declare function parallel<T extends readonly unknown[]>(...reads: {
-    [K in keyof T]: Promise<T[K]>;
-}): Promise<T>;

package/lib/shared/deadline.d.ts

@@ -1,6 +0,0 @@
-/** Bounds non-fetch dependencies too, including an RPC whose enqueue outcome can be unknown. */
-export declare function within<T>(pending: Promise<T>, signal: AbortSignal): Promise<T>;
-export declare class JobDeadlineError extends Error {
-    readonly requestStarted: boolean;
-    constructor(requestStarted?: boolean);
-}

package/lib/shared/rate-limit.d.ts

@@ -1,5 +0,0 @@
-/** Cache-aside state shared by upstream clients' durable cooldown stores. */
-export interface RateLimitStore {
-    get(key: string): string | undefined;
-    set(key: string, value: string, ttlMs?: number): void;
-}