@ihazz/bitrix24 1.1.1 → 1.1.3

package/dist/src/channel.d.ts

@@ -0,0 +1,216 @@
+import type { IncomingMessage, ServerResponse } from 'node:http';
+import { Bitrix24Api } from './api.js';
+import type { BotContext } from './api.js';
+import { SendService } from './send-service.js';
+import { MediaService } from './media-service.js';
+import { InboundHandler } from './inbound-handler.js';
+import type { B24MsgContext, Bitrix24AccountConfig, Bitrix24DmPolicy, B24Keyboard, Logger } from './types.js';
+export declare function canCoalesceDirectMessage(msgCtx: B24MsgContext, config: Bitrix24AccountConfig): boolean;
+export declare function mergeBufferedDirectMessages(messages: B24MsgContext[]): B24MsgContext;
+export declare function mergeForwardedMessageContext(previousMsgCtx: B24MsgContext, forwardedMsgCtx: B24MsgContext): B24MsgContext;
+export declare function resolveDirectMessageCoalesceDelay(params: {
+    startedAt: number;
+    now: number;
+    debounceMs?: number;
+    maxWaitMs?: number;
+}): number;
+export declare function shouldSkipJoinChatWelcome(params: {
+    dialogId?: string;
+    chatType?: string;
+    webhookUrl: string;
+    dmPolicy?: Bitrix24AccountConfig['dmPolicy'];
+}): boolean;
+export interface Bitrix24ConversationRef {
+    dialogId: string;
+    address: string;
+    historyKey: string;
+    peer: {
+        kind: 'direct' | 'group';
+        id: string;
+    };
+}
+export declare function resolveConversationRef(params: {
+    accountId: string;
+    dialogId: string;
+    isDirect: boolean;
+}): Bitrix24ConversationRef;
+export declare function buildConversationSessionKey(routeSessionKey: string, conversation: Pick<Bitrix24ConversationRef, 'address'>): string;
+/** State held per running gateway instance */
+interface GatewayState {
+    accountId: string;
+    api: Bitrix24Api;
+    bot: BotContext;
+    sendService: SendService;
+    mediaService: MediaService;
+    inboundHandler: InboundHandler;
+    eventMode: 'fetch' | 'webhook';
+}
+export declare function __setGatewayStateForTests(state: GatewayState | null): void;
+/** Default keyboard shown with command responses and welcome messages. */
+export declare const DEFAULT_COMMAND_KEYBOARD: B24Keyboard;
+/** Generic button format used by OpenClaw channelData. */
+export interface ChannelButton {
+    text: string;
+    callback_data?: string;
+    style?: string;
+}
+/**
+ * Convert OpenClaw button rows to B24 flat KEYBOARD array.
+ */
+export declare function convertButtonsToKeyboard(input: ChannelButton[][] | ChannelButton[]): B24Keyboard;
+/**
+ * Extract B24 keyboard from a dispatcher payload's channelData.
+ */
+export declare function extractKeyboardFromPayload(payload: {
+    channelData?: Record<string, unknown>;
+}): B24Keyboard | undefined;
+/**
+ * Extract inline button JSON embedded in message text by the agent.
+ *
+ * Agents (especially GPT-4o) sometimes embed button markup directly in text
+ * as `[[{...},{...}]]` instead of using tool call parameters.
+ * This function detects such patterns, extracts the keyboard, and returns
+ * cleaned text without the JSON fragment.
+ */
+export declare function extractInlineButtonsFromText(text: string): {
+    cleanText: string;
+    keyboard: B24Keyboard;
+} | undefined;
+export declare function buildBotCodeCandidates(config: Pick<Bitrix24AccountConfig, 'webhookUrl' | 'botCode'>, maxCandidates?: number): string[];
+/**
+ * Handle an incoming HTTP request on the webhook route (V2 webhook mode).
+ */
+export declare function handleWebhookRequest(req: IncomingMessage, res: ServerResponse): Promise<void>;
+/**
+ * The Bitrix24 channel plugin object.
+ */
+export declare const bitrix24Plugin: {
+    id: string;
+    meta: {
+        id: string;
+        label: string;
+        selectionLabel: string;
+        docsPath: string;
+        docsLabel: string;
+        blurb: string;
+        aliases: string[];
+    };
+    capabilities: {
+        chatTypes: readonly ["direct", "group"];
+        media: boolean;
+        reactions: boolean;
+        threads: boolean;
+        nativeCommands: boolean;
+        inlineButtons: string;
+    };
+    messaging: {
+        normalizeTarget: (raw: string) => string;
+        targetResolver: {
+            hint: string;
+            looksLikeId: (raw: string, _normalized: string) => boolean;
+        };
+    };
+    config: {
+        listAccountIds: (cfg: Record<string, unknown>) => string[];
+        resolveAccount: (cfg: Record<string, unknown>, accountId?: string) => {
+            accountId: string;
+            config: Bitrix24AccountConfig;
+            configured: boolean;
+            enabled: boolean;
+        };
+    };
+    security: {
+        resolveDmPolicy: (params: {
+            cfg?: Record<string, unknown>;
+            accountId?: string;
+            account?: {
+                config?: Record<string, unknown>;
+            };
+        }) => {
+            policy: Bitrix24DmPolicy;
+            allowFrom: string[];
+            policyPath: string;
+            allowFromPath: string;
+            approveHint: string;
+            normalizeEntry: (raw: string) => string;
+        };
+        normalizeAllowFrom: (entry: string) => string;
+    };
+    pairing: {
+        idLabel: string;
+        normalizeAllowEntry: (entry: string) => string;
+        notifyApproval: (params: {
+            cfg: Record<string, unknown>;
+            id: string;
+            runtime?: unknown;
+        }) => Promise<void>;
+    };
+    outbound: {
+        deliveryMode: "direct";
+        textChunkLimit: number;
+        sendText: (ctx: {
+            cfg: Record<string, unknown>;
+            to: string;
+            accountId?: string;
+            text: string;
+            [key: string]: unknown;
+        }) => Promise<{
+            messageId: string;
+        }>;
+        sendMedia: (ctx: {
+            cfg: Record<string, unknown>;
+            to: string;
+            accountId?: string;
+            text: string;
+            mediaUrl?: string;
+            [key: string]: unknown;
+        }) => Promise<{
+            messageId: string;
+        }>;
+        sendPayload: (ctx: {
+            cfg: Record<string, unknown>;
+            to: string;
+            accountId?: string;
+            text: string;
+            mediaUrl?: string;
+            payload?: {
+                channelData?: Record<string, unknown>;
+                [key: string]: unknown;
+            };
+            [key: string]: unknown;
+        }) => Promise<{
+            messageId: string;
+        }>;
+    };
+    actions: {
+        listActions: (_params: {
+            cfg: Record<string, unknown>;
+        }) => string[];
+        supportsAction: (params: {
+            action: string;
+        }) => boolean;
+        handleAction: (ctx: {
+            action: string;
+            channel: string;
+            cfg: Record<string, unknown>;
+            accountId?: string;
+            params: Record<string, unknown>;
+            [key: string]: unknown;
+        }) => Promise<Record<string, unknown> | null>;
+    };
+    gateway: {
+        startAccount: (ctx: {
+            cfg: Record<string, unknown>;
+            accountId: string;
+            account: {
+                config?: Record<string, unknown>;
+            };
+            runtime: unknown;
+            abortSignal: AbortSignal;
+            log?: Logger;
+            setStatus?: (status: Record<string, unknown>) => void;
+        }) => Promise<void>;
+    };
+};
+export {};
+//# sourceMappingURL=channel.d.ts.map

package/dist/src/channel.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"channel.d.ts","sourceRoot":"","sources":["../../src/channel.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,eAAe,EAAE,cAAc,EAAE,MAAM,WAAW,CAAC;AAEjE,OAAO,EAAE,WAAW,EAAE,MAAM,UAAU,CAAC;AACvC,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,UAAU,CAAC;AAC3C,OAAO,EAAE,WAAW,EAAE,MAAM,mBAAmB,CAAC;AAEhD,OAAO,EAAE,YAAY,EAAE,MAAM,oBAAoB,CAAC;AAElD,OAAO,EAAE,cAAc,EAAE,MAAM,sBAAsB,CAAC;AAiCtD,OAAO,KAAK,EACV,aAAa,EAKb,qBAAqB,EAErB,gBAAgB,EAMhB,WAAW,EAEX,MAAM,EACP,MAAM,YAAY,CAAC;AA0RpB,wBAAgB,wBAAwB,CACtC,MAAM,EAAE,aAAa,EACrB,MAAM,EAAE,qBAAqB,GAC5B,OAAO,CAQT;AAED,wBAAgB,2BAA2B,CAAC,QAAQ,EAAE,aAAa,EAAE,GAAG,aAAa,CAcpF;AAED,wBAAgB,4BAA4B,CAC1C,cAAc,EAAE,aAAa,EAC7B,eAAe,EAAE,aAAa,GAC7B,aAAa,CAkBf;AAED,wBAAgB,iCAAiC,CAAC,MAAM,EAAE;IACxD,SAAS,EAAE,MAAM,CAAC;IAClB,GAAG,EAAE,MAAM,CAAC;IACZ,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,SAAS,CAAC,EAAE,MAAM,CAAC;CACpB,GAAG,MAAM,CAOT;AAED,wBAAgB,yBAAyB,CAAC,MAAM,EAAE;IAChD,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,UAAU,EAAE,MAAM,CAAC;IACnB,QAAQ,CAAC,EAAE,qBAAqB,CAAC,UAAU,CAAC,CAAC;CAC9C,GAAG,OAAO,CAeV;AA+CD,MAAM,WAAW,uBAAuB;IACtC,QAAQ,EAAE,MAAM,CAAC;IACjB,OAAO,EAAE,MAAM,CAAC;IAChB,UAAU,EAAE,MAAM,CAAC;IACnB,IAAI,EAAE;QACJ,IAAI,EAAE,QAAQ,GAAG,OAAO,CAAC;QACzB,EAAE,EAAE,MAAM,CAAC;KACZ,CAAC;CACH;AAED,wBAAgB,sBAAsB,CAAC,MAAM,EAAE;IAC7C,SAAS,EAAE,MAAM,CAAC;IAClB,QAAQ,EAAE,MAAM,CAAC;IACjB,QAAQ,EAAE,OAAO,CAAC;CACnB,GAAG,uBAAuB,CAW1B;AAED,wBAAgB,2BAA2B,CACzC,eAAe,EAAE,MAAM,EACvB,YAAY,EAAE,IAAI,CAAC,uBAAuB,EAAE,SAAS,CAAC,GACrD,MAAM,CAER;AA8YD,8CAA8C;AAC9C,UAAU,YAAY;IACpB,SAAS,EAAE,MAAM,CAAC;IAClB,GAAG,EAAE,WAAW,CAAC;IACjB,GAAG,EAAE,UAAU,CAAC;IAChB,WAAW,EAAE,WAAW,CAAC;IACzB,YAAY,EAAE,YAAY,CAAC;IAC3B,cAAc,EAAE,cAAc,CAAC;IAC/B,SAAS,EAAE,OAAO,GAAG,SAAS,CAAC;CAChC;AAID,wBAAgB,yBAAyB,CAAC,KAAK,EAAE,YAAY,GAAG,IAAI,GAAG,IAAI,CAE1E;AAID,0EAA0E;AAC1E,eAAO,MAAM,wBAAwB,EAAE,WAOtC,CAAC;AAIF,0DAA0D;AAC1D,MAAM,WAAW,aAAa;IAC5B,IAAI,EAAE,MAAM,CAAC;IACb,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,KAAK,CAAC,EAAE,MAAM,CAAC;CAChB;AAqBD;;GAEG;AACH,wBAAgB,wBAAwB,CAAC,KAAK,EAAE,aAAa,EAAE,EAAE,GAAG,aAAa,EAAE,GAAG,WAAW,CA2ChG;AAED;;GAEG;AACH,wBAAgB,0BAA0B,CACxC,OAAO,EAAE;IAAE,WAAW,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;CAAE,GACjD,WAAW,GAAG,SAAS,CAezB;AAED;;;;;;;GAOG;AACH,wBAAgB,4BAA4B,CAC1C,IAAI,EAAE,MAAM,GACX;IAAE,SAAS,EAAE,MAAM,CAAC;IAAC,QAAQ,EAAE,WAAW,CAAA;CAAE,GAAG,SAAS,CAqB1D;AAqCD,wBAAgB,sBAAsB,CACpC,MAAM,EAAE,IAAI,CAAC,qBAAqB,EAAE,YAAY,GAAG,SAAS,CAAC,EAC7D,aAAa,SAA+B,GAC3C,MAAM,EAAE,CAYV;AAyMD;;GAEG;AACH,wBAAsB,oBAAoB,CAAC,GAAG,EAAE,eAAe,EAAE,GAAG,EAAE,cAAc,GAAG,OAAO,CAAC,IAAI,CAAC,CAmDnG;AAwED;;GAEG;AACH,eAAO,MAAM,cAAc;;;;;;;;;;;;;;;;;;;;+BAuBA,MAAM;;;+BAGR,MAAM,eAAe,MAAM;;;;8BAQ1B,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC;8BACvB,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,cAAc,MAAM;;;;;;;;kCAKvC;YAAE,GAAG,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;YAAC,SAAS,CAAC,EAAE,MAAM,CAAC;YAAC,OAAO,CAAC,EAAE;gBAAE,MAAM,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;aAAE,CAAA;SAAE;;;;;;kCAUrG,MAAM;;oCAGJ,MAAM;;;;qCAML,MAAM;iCACJ;YAAE,GAAG,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;YAAC,EAAE,EAAE,MAAM,CAAC;YAAC,OAAO,CAAC,EAAE,OAAO,CAAA;SAAE;;;;;wBAoBxE;YACpB,GAAG,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;YAC7B,EAAE,EAAE,MAAM,CAAC;YACX,SAAS,CAAC,EAAE,MAAM,CAAC;YACnB,IAAI,EAAE,MAAM,CAAC;YACb,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC;SACxB;;;yBAiBsB;YACrB,GAAG,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;YAC7B,EAAE,EAAE,MAAM,CAAC;YACX,SAAS,CAAC,EAAE,MAAM,CAAC;YACnB,IAAI,EAAE,MAAM,CAAC;YACb,QAAQ,CAAC,EAAE,MAAM,CAAC;YAClB,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC;SACxB;;;2BAsBwB;YACvB,GAAG,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;YAC7B,EAAE,EAAE,MAAM,CAAC;YACX,SAAS,CAAC,EAAE,MAAM,CAAC;YACnB,IAAI,EAAE,MAAM,CAAC;YACb,QAAQ,CAAC,EAAE,MAAM,CAAC;YAClB,OAAO,CAAC,EAAE;gBAAE,WAAW,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;gBAAC,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;aAAE,CAAC;YAC5E,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC;SACxB;;;;;+BA8CsB;YAAE,GAAG,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;SAAE,KAAG,MAAM,EAAE;iCAIzC;YAAE,MAAM,EAAE,MAAM,CAAA;SAAE,KAAG,OAAO;4BAI3B;YACxB,MAAM,EAAE,MAAM,CAAC;YACf,OAAO,EAAE,MAAM,CAAC;YAChB,GAAG,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;YAC7B,SAAS,CAAC,EAAE,MAAM,CAAC;YACnB,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;YAChC,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC;SACxB,KAAG,OAAO,CAAC,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,IAAI,CAAC;;;4BA4HjB;YACxB,GAAG,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;YAC7B,SAAS,EAAE,MAAM,CAAC;YAClB,OAAO,EAAE;gBAAE,MAAM,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;aAAE,CAAC;YAC9C,OAAO,EAAE,OAAO,CAAC;YACjB,WAAW,EAAE,WAAW,CAAC;YACzB,GAAG,CAAC,EAAE,MAAM,CAAC;YACb,SAAS,CAAC,EAAE,CAAC,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,KAAK,IAAI,CAAC;SACvD;;CAgrCJ,CAAC"}