@botonic/core 2.26.0 → 2.28.0

package/src/lib/server/bot-server-message.js

@@ -0,0 +1,111 @@
+import { BotonicOutput, } from '@botonic/shared';
+import { MessageType, } from '@botonic/shared';
+// ============================================================================
+// BOT SERVER MESSAGE (extends Output + adds bot-specific metadata)
+// ============================================================================
+export class BotServerMessage extends BotonicOutput {
+    constructor(type, data, metadata = {}) {
+        super(type, data);
+        this.bot_interaction_id = metadata.bot_interaction_id;
+        this.feedback_enabled = metadata.feedback_enabled;
+        this.inference_id = metadata.inference_id;
+        this.typing = metadata.typing;
+        this.delay = metadata.delay;
+    }
+}
+export class BotServerMessageText extends BotServerMessage {
+    constructor(data, metadata = {}) {
+        super(MessageType.Text, data, metadata);
+    }
+}
+export class BotServerMessageAudio extends BotServerMessage {
+    constructor(data, metadata = {}) {
+        super(MessageType.Audio, data, metadata);
+    }
+}
+export class BotServerMessageImage extends BotServerMessage {
+    constructor(data, metadata = {}) {
+        super(MessageType.Image, data, metadata);
+    }
+}
+export class BotServerMessageVideo extends BotServerMessage {
+    constructor(data, metadata = {}) {
+        super(MessageType.Video, data, metadata);
+    }
+}
+export class BotServerMessageDocument extends BotServerMessage {
+    constructor(data, metadata = {}) {
+        super(MessageType.Document, data, metadata);
+    }
+}
+export class BotServerMessageLocation extends BotServerMessage {
+    constructor(data, metadata = {}) {
+        super(MessageType.Location, data, metadata);
+    }
+}
+export class BotServerMessageButtonMessage extends BotServerMessage {
+    constructor(data, metadata = {}) {
+        super(MessageType.ButtonMessage, data, metadata);
+    }
+}
+export class BotServerMessageCarousel extends BotServerMessage {
+    constructor(data, metadata = {}) {
+        super(MessageType.Carousel, data, metadata);
+    }
+}
+export class BotServerMessageCustom extends BotServerMessage {
+    constructor(data, metadata = {}) {
+        super(MessageType.Custom, data, metadata);
+    }
+}
+export class BotServerMessageTypingEvent extends BotServerMessage {
+    constructor(data, metadata = {}) {
+        super(MessageType.TypingEvent, data, metadata);
+    }
+}
+export class BotServerMessageWhatsappButtonList extends BotServerMessage {
+    constructor(data, metadata = {}) {
+        super(MessageType.WhatsappButtonList, data, metadata);
+    }
+}
+export class BotServerMessageWhatsappCTAUrlButton extends BotServerMessage {
+    constructor(data, metadata = {}) {
+        super(MessageType.WhatsappCTAUrlButton, data, metadata);
+    }
+}
+export class BotServerMessageWhatsappCatalog extends BotServerMessage {
+    constructor(data, metadata = {}) {
+        super(MessageType.WhatsappCatalog, data, metadata);
+    }
+}
+export class BotServerMessageWhatsappProduct extends BotServerMessage {
+    constructor(data, metadata = {}) {
+        super(MessageType.WhatsappProduct, data, metadata);
+    }
+}
+export class BotServerMessageWhatsappProductList extends BotServerMessage {
+    constructor(data, metadata = {}) {
+        super(MessageType.WhatsappProductList, data, metadata);
+    }
+}
+export class BotServerMessageWhatsappProductCarousel extends BotServerMessage {
+    constructor(data, metadata = {}) {
+        super(MessageType.WhatsappProductCarousel, data, metadata);
+    }
+}
+export class BotServerMessageWhatsappMediaCarousel extends BotServerMessage {
+    constructor(data, metadata = {}) {
+        super(MessageType.WhatsappMediaCarousel, data, metadata);
+    }
+}
+export class BotServerMessageWhatsappTemplate extends BotServerMessage {
+    constructor(data, metadata = {}) {
+        super(MessageType.WhatsappTemplate, data, metadata);
+    }
+}
+export class BotServerMessageWebchatClientSettings extends BotServerMessage {
+    constructor(data, metadata = {}) {
+        super(MessageType.WebchatClientSettings, data, metadata);
+    }
+}
+//# sourceMappingURL=bot-server-message.js.map

package/src/lib/server/bot-server-message.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"bot-server-message.js","sourceRoot":"","sources":["../../../../../../../libs/botonic/core/src/lib/server/bot-server-message.ts"],"names":[],"mappings":"AACA,OAAO,EACL,aAAa,GAOd,MAAM,iBAAiB,CAAA;AACxB,OAAO,EAOL,WAAW,GACZ,MAAM,iBAAiB,CAAA;AAaxB,+EAA+E;AAC/E,mEAAmE;AACnE,+EAA+E;AAE/E,MAAM,OAAgB,gBAGpB,SAAQ,aAAgB;IASxB,YACE,IAAO,EACP,IAA6B,EAC7B,WAA+B,EAAE;QAEjC,KAAK,CAAC,IAAI,EAAE,IAAI,CAAC,CAAA;QACjB,IAAI,CAAC,kBAAkB,GAAG,QAAQ,CAAC,kBAAkB,CAAA;QACrD,IAAI,CAAC,gBAAgB,GAAG,QAAQ,CAAC,gBAAgB,CAAA;QACjD,IAAI,CAAC,YAAY,GAAG,QAAQ,CAAC,YAAY,CAAA;QACzC,IAAI,CAAC,MAAM,GAAG,QAAQ,CAAC,MAAM,CAAA;QAC7B,IAAI,CAAC,KAAK,GAAG,QAAQ,CAAC,KAAK,CAAA;IAC7B,CAAC;CACF;AAED,MAAM,OAAO,oBAAqB,SAAQ,gBAAkC;IAC1E,YAAY,IAAqB,EAAE,WAA+B,EAAE;QAClE,KAAK,CAAC,WAAW,CAAC,IAAI,EAAE,IAAI,EAAE,QAAQ,CAAC,CAAA;IACzC,CAAC;CACF;AAED,MAAM,OAAO,qBAAsB,SAAQ,gBAAmC;IAC5E,YAAY,IAA4B,EAAE,WAA+B,EAAE;QACzE,KAAK,CAAC,WAAW,CAAC,KAAK,EAAE,IAAI,EAAE,QAAQ,CAAC,CAAA;IAC1C,CAAC;CACF;AAED,MAAM,OAAO,qBAAsB,SAAQ,gBAAmC;IAC5E,YAAY,IAA4B,EAAE,WAA+B,EAAE;QACzE,KAAK,CAAC,WAAW,CAAC,KAAK,EAAE,IAAI,EAAE,QAAQ,CAAC,CAAA;IAC1C,CAAC;CACF;AAED,MAAM,OAAO,qBAAsB,SAAQ,gBAAmC;IAC5E,YAAY,IAA4B,EAAE,WAA+B,EAAE;QACzE,KAAK,CAAC,WAAW,CAAC,KAAK,EAAE,IAAI,EAAE,QAAQ,CAAC,CAAA;IAC1C,CAAC;CACF;AAED,MAAM,OAAO,wBAAyB,SAAQ,gBAAsC;IAClF,YACE,IAA+B,EAC/B,WAA+B,EAAE;QAEjC,KAAK,CAAC,WAAW,CAAC,QAAQ,EAAE,IAAI,EAAE,QAAQ,CAAC,CAAA;IAC7C,CAAC;CACF;AAED,MAAM,OAAO,wBAAyB,SAAQ,gBAAsC;IAClF,YAAY,IAAyB,EAAE,WAA+B,EAAE;QACtE,KAAK,CAAC,WAAW,CAAC,QAAQ,EAAE,IAAI,EAAE,QAAQ,CAAC,CAAA;IAC7C,CAAC;CACF;AAED,MAAM,OAAO,6BAA8B,SAAQ,gBAA2C;IAC5F,YACE,IAA8B,EAC9B,WAA+B,EAAE;QAEjC,KAAK,CAAC,WAAW,CAAC,aAAa,EAAE,IAAI,EAAE,QAAQ,CAAC,CAAA;IAClD,CAAC;CACF;AAED,MAAM,OAAO,wBAAyB,SAAQ,gBAAsC;IAClF,YAAY,IAAyB,EAAE,WAA+B,EAAE;QACtE,KAAK,CAAC,WAAW,CAAC,QAAQ,EAAE,IAAI,EAAE,QAAQ,CAAC,CAAA;IAC7C,CAAC;CACF;AAED,MAAM,OAAO,sBAAuB,SAAQ,gBAAoC;IAC9E,YAAY,IAAuB,EAAE,WAA+B,EAAE;QACpE,KAAK,CAAC,WAAW,CAAC,MAAM,EAAE,IAAI,EAAE,QAAQ,CAAC,CAAA;IAC3C,CAAC;CACF;AAED,MAAM,OAAO,2BAA4B,SAAQ,gBAAyC;IACxF,YAAY,IAA4B,EAAE,WAA+B,EAAE;QACzE,KAAK,CAAC,WAAW,CAAC,WAAW,EAAE,IAAI,EAAE,QAAQ,CAAC,CAAA;IAChD,CAAC;CACF;AAED,MAAM,OAAO,kCAAmC,SAAQ,gBAAgD;IACtG,YACE,IAAmC,EACnC,WAA+B,EAAE;QAEjC,KAAK,CAAC,WAAW,CAAC,kBAAkB,EAAE,IAAI,EAAE,QAAQ,CAAC,CAAA;IACvD,CAAC;CACF;AAED,MAAM,OAAO,oCAAqC,SAAQ,gBAAkD;IAC1G,YACE,IAAqC,EACrC,WAA+B,EAAE;QAEjC,KAAK,CAAC,WAAW,CAAC,oBAAoB,EAAE,IAAI,EAAE,QAAQ,CAAC,CAAA;IACzD,CAAC;CACF;AAED,MAAM,OAAO,+BAAgC,SAAQ,gBAA6C;IAChG,YACE,IAAgC,EAChC,WAA+B,EAAE;QAEjC,KAAK,CAAC,WAAW,CAAC,eAAe,EAAE,IAAI,EAAE,QAAQ,CAAC,CAAA;IACpD,CAAC;CACF;AAED,MAAM,OAAO,+BAAgC,SAAQ,gBAA6C;IAChG,YACE,IAAgC,EAChC,WAA+B,EAAE;QAEjC,KAAK,CAAC,WAAW,CAAC,eAAe,EAAE,IAAI,EAAE,QAAQ,CAAC,CAAA;IACpD,CAAC;CACF;AAED,MAAM,OAAO,mCAAoC,SAAQ,gBAAiD;IACxG,YACE,IAAoC,EACpC,WAA+B,EAAE;QAEjC,KAAK,CAAC,WAAW,CAAC,mBAAmB,EAAE,IAAI,EAAE,QAAQ,CAAC,CAAA;IACxD,CAAC;CACF;AAED,MAAM,OAAO,uCAAwC,SAAQ,gBAAqD;IAChH,YACE,IAAwC,EACxC,WAA+B,EAAE;QAEjC,KAAK,CAAC,WAAW,CAAC,uBAAuB,EAAE,IAAI,EAAE,QAAQ,CAAC,CAAA;IAC5D,CAAC;CACF;AAED,MAAM,OAAO,qCAAsC,SAAQ,gBAAmD;IAC5G,YACE,IAAsC,EACtC,WAA+B,EAAE;QAEjC,KAAK,CAAC,WAAW,CAAC,qBAAqB,EAAE,IAAI,EAAE,QAAQ,CAAC,CAAA;IAC1D,CAAC;CACF;AAED,MAAM,OAAO,gCAAiC,SAAQ,gBAA8C;IAClG,YACE,IAAiC,EACjC,WAA+B,EAAE;QAEjC,KAAK,CAAC,WAAW,CAAC,gBAAgB,EAAE,IAAI,EAAE,QAAQ,CAAC,CAAA;IACrD,CAAC;CACF;AAED,MAAM,OAAO,qCAAsC,SAAQ,gBAAmD;IAC5G,YAAY,IAA2B,EAAE,WAA+B,EAAE;QACxE,KAAK,CAAC,WAAW,CAAC,qBAAqB,EAAE,IAAI,EAAE,QAAQ,CAAC,CAAA;IAC1D,CAAC;CACF"}

package/src/lib/server/botonic-context/botonic-action.d.ts

@@ -0,0 +1,10 @@
+/** Flow / handoff action prefixes stored in session (legacy plugins may still set these via `custom` until migrated). */
+export declare enum BotonicAction {
+    Redirect = "redirect_action",
+    CreateCase = "create_case",
+    DeleteUser = "delete_user",
+    DiscardCase = "discard_case"
+}
+type BotonicActionSeparator = ':';
+export type BotonicActionType = `${BotonicAction.CreateCase}${BotonicActionSeparator}${string}` | `${BotonicAction.Redirect}${BotonicActionSeparator}${string}` | `${BotonicAction.DiscardCase}${BotonicActionSeparator}${string}` | `${BotonicAction.DiscardCase}` | `${BotonicAction.DeleteUser}`;
+export {};

package/src/lib/server/botonic-context/botonic-action.js

@@ -0,0 +1,9 @@
+/** Flow / handoff action prefixes stored in session (legacy plugins may still set these via `custom` until migrated). */
+export var BotonicAction;
+(function (BotonicAction) {
+    BotonicAction["Redirect"] = "redirect_action";
+    BotonicAction["CreateCase"] = "create_case";
+    BotonicAction["DeleteUser"] = "delete_user";
+    BotonicAction["DiscardCase"] = "discard_case";
+})(BotonicAction || (BotonicAction = {}));
+//# sourceMappingURL=botonic-action.js.map

package/src/lib/server/botonic-context/botonic-action.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"botonic-action.js","sourceRoot":"","sources":["../../../../../../../../libs/botonic/core/src/lib/server/botonic-context/botonic-action.ts"],"names":[],"mappings":"AAAA,yHAAyH;AACzH,MAAM,CAAN,IAAY,aAKX;AALD,WAAY,aAAa;IACvB,6CAA4B,CAAA;IAC5B,2CAA0B,CAAA;IAC1B,2CAA0B,CAAA;IAC1B,6CAA4B,CAAA;AAC9B,CAAC,EALW,aAAa,KAAb,aAAa,QAKxB"}

package/src/lib/server/botonic-context/botonic-context-input.d.ts

@@ -0,0 +1,96 @@
+import type { BotonicData } from '@botonic/shared';
+import { MessageType } from '@botonic/shared';
+export declare enum HelpdeskEvent {
+    StatusChanged = "status_changed",
+    AgentMessageCreated = "agent_message_created",
+    QueuePositionChanged = "queue_position_changed"
+}
+export declare enum InputType {
+    Text = "text",
+    Image = "image",
+    Video = "video",
+    Audio = "audio",
+    Document = "document",
+    Location = "location",
+    Contact = "contact",
+    Custom = "custom",
+    Raw = "raw",
+    CaseEventQueuePosition = "case_event_queue_position",
+    Postback = "postback",
+    Event = "event",
+    /** Legacy typing: maps to v2 typing event_name "typing_on". */
+    StartTyping = "start_typing",
+    /** Legacy typing: maps to v2 typing event_name "typing_off". */
+    SendPaused = "send_paused"
+}
+export declare enum NluType {
+    Keyword = "keyword",
+    SmartIntent = "smart-intent",
+    Intent = "intent"
+}
+export interface NluResolution {
+    type: NluType;
+    matchedValue: string;
+    payload?: string;
+}
+export interface CampaignV2 {
+    id: string;
+    name: string;
+    agent_context?: string;
+    end_date?: string;
+}
+export interface InputContext {
+    campaigns_v2?: CampaignV2[];
+}
+export type SentBy = 'enduser' | 'agent' | 'bot';
+export interface BotonicRequestInput {
+    type: MessageType;
+    data: BotonicData;
+    provider_id?: string;
+    sent_by?: string;
+    message_id?: string;
+    bot_interaction_id: string;
+    conversation_id?: string;
+    context?: InputContext;
+    /** Bot-side: NLU resolution set by plugins. */
+    nluResolution?: NluResolution;
+}
+/**
+ * Facade over {@link BotonicRequestInput}: wraps the wire payload and exposes
+ * camelCase accessors (`text`, `botInteractionId`, …). It does not implement
+ * `BotonicRequestInput` (naming and shape differ on purpose).
+ */
+export declare class BotonicContextInput {
+    private rawInput;
+    constructor(rawInput: BotonicRequestInput);
+    get type(): MessageType;
+    set type(v: MessageType);
+    get data(): BotonicData;
+    get providerId(): string | undefined;
+    get sentBy(): string | undefined;
+    get messageId(): string | undefined;
+    get botInteractionId(): string;
+    get conversationId(): string | undefined;
+    get context(): InputContext | undefined;
+    get nluResolution(): NluResolution | undefined;
+    set nluResolution(v: NluResolution | undefined);
+    private getKeyDataStringValue;
+    get text(): string | undefined;
+    set text(value: string);
+    get payload(): string | undefined;
+    set payload(value: string | undefined);
+    get referral(): string | undefined;
+    get attachmentUrl(): string | undefined;
+    /** True when the input is text with string data present. */
+    hasInputText(): boolean;
+    /**
+     * Replace the current input with a synthetic postback so type and data stay in sync.
+     * Use for redirect flow instead of mutating payload/type/text individually.
+     */
+    setAsPostback(payload: string): void;
+    /**
+     * Replace the current input with synthetic text so type and data stay in sync.
+     * Use when converting e.g. WhatsApp referral to text input.
+     */
+    setAsText(text: string): void;
+}

package/src/lib/server/botonic-context/botonic-context-input.js

@@ -0,0 +1,124 @@
+import { BotonicPostbackData, BotonicTextData, MessageType, } from '@botonic/shared';
+export var HelpdeskEvent;
+(function (HelpdeskEvent) {
+    HelpdeskEvent["StatusChanged"] = "status_changed";
+    HelpdeskEvent["AgentMessageCreated"] = "agent_message_created";
+    HelpdeskEvent["QueuePositionChanged"] = "queue_position_changed";
+})(HelpdeskEvent || (HelpdeskEvent = {}));
+export var InputType;
+(function (InputType) {
+    InputType["Text"] = "text";
+    InputType["Image"] = "image";
+    InputType["Video"] = "video";
+    InputType["Audio"] = "audio";
+    InputType["Document"] = "document";
+    InputType["Location"] = "location";
+    InputType["Contact"] = "contact";
+    InputType["Custom"] = "custom";
+    InputType["Raw"] = "raw";
+    InputType["CaseEventQueuePosition"] = "case_event_queue_position";
+    InputType["Postback"] = "postback";
+    InputType["Event"] = "event";
+    /** Legacy typing: maps to v2 typing event_name "typing_on". */
+    InputType["StartTyping"] = "start_typing";
+    /** Legacy typing: maps to v2 typing event_name "typing_off". */
+    InputType["SendPaused"] = "send_paused";
+})(InputType || (InputType = {}));
+export var NluType;
+(function (NluType) {
+    NluType["Keyword"] = "keyword";
+    NluType["SmartIntent"] = "smart-intent";
+    NluType["Intent"] = "intent";
+})(NluType || (NluType = {}));
+/**
+ * Facade over {@link BotonicRequestInput}: wraps the wire payload and exposes
+ * camelCase accessors (`text`, `botInteractionId`, …). It does not implement
+ * `BotonicRequestInput` (naming and shape differ on purpose).
+ */
+export class BotonicContextInput {
+    // TODO: if message_id becomes required on BotonicRequestInput, throw when BotonicContextInput exposes messageId not message_id
+    constructor(rawInput) {
+        this.rawInput = rawInput;
+    }
+    // Delegate Input properties
+    get type() {
+        return this.rawInput.type;
+    }
+    // TODO: Remove this setter when we adapt logic using it
+    set type(v) {
+        this.rawInput.type = v;
+    }
+    get data() {
+        return this.rawInput.data;
+    }
+    get providerId() {
+        return this.rawInput.provider_id;
+    }
+    get sentBy() {
+        return this.rawInput.sent_by;
+    }
+    get messageId() {
+        return this.rawInput.message_id;
+    }
+    get botInteractionId() {
+        return this.rawInput.bot_interaction_id;
+    }
+    get conversationId() {
+        return this.rawInput.conversation_id;
+    }
+    get context() {
+        return this.rawInput.context;
+    }
+    get nluResolution() {
+        return this.rawInput.nluResolution;
+    }
+    set nluResolution(v) {
+        this.rawInput.nluResolution = v;
+    }
+    getKeyDataStringValue(key) {
+        const value = this.rawInput.data[key];
+        return typeof value === 'string' ? value : undefined;
+    }
+    get text() {
+        return this.getKeyDataStringValue('text');
+    }
+    set text(value) {
+        ;
+        this.rawInput.data.text = value;
+    }
+    get payload() {
+        return this.getKeyDataStringValue('payload');
+    }
+    set payload(value) {
+        ;
+        this.rawInput.data.payload = value;
+    }
+    get referral() {
+        return this.getKeyDataStringValue('referral');
+    }
+    get attachmentUrl() {
+        var _a;
+        return ((_a = this.getKeyDataStringValue('attachment_url')) !== null && _a !== void 0 ? _a : this.getKeyDataStringValue('attachment_content'));
+    }
+    /** True when the input is text with string data present. */
+    hasInputText() {
+        return (this.type === MessageType.Text &&
+            this.text !== undefined &&
+            this.text !== '');
+    }
+    /**
+     * Replace the current input with a synthetic postback so type and data stay in sync.
+     * Use for redirect flow instead of mutating payload/type/text individually.
+     */
+    setAsPostback(payload) {
+        this.rawInput = Object.assign(Object.assign({}, this.rawInput), { type: MessageType.Postback, data: new BotonicPostbackData(payload) });
+    }
+    /**
+     * Replace the current input with synthetic text so type and data stay in sync.
+     * Use when converting e.g. WhatsApp referral to text input.
+     */
+    setAsText(text) {
+        this.rawInput = Object.assign(Object.assign({}, this.rawInput), { type: MessageType.Text, data: new BotonicTextData(text) });
+    }
+}
+//# sourceMappingURL=botonic-context-input.js.map

package/src/lib/server/botonic-context/botonic-context-input.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"botonic-context-input.js","sourceRoot":"","sources":["../../../../../../../../libs/botonic/core/src/lib/server/botonic-context/botonic-context-input.ts"],"names":[],"mappings":"AACA,OAAO,EACL,mBAAmB,EACnB,eAAe,EACf,WAAW,GACZ,MAAM,iBAAiB,CAAA;AAExB,MAAM,CAAN,IAAY,aAIX;AAJD,WAAY,aAAa;IACvB,iDAAgC,CAAA;IAChC,8DAA6C,CAAA;IAC7C,gEAA+C,CAAA;AACjD,CAAC,EAJW,aAAa,KAAb,aAAa,QAIxB;AAED,MAAM,CAAN,IAAY,SAiBX;AAjBD,WAAY,SAAS;IACnB,0BAAa,CAAA;IACb,4BAAe,CAAA;IACf,4BAAe,CAAA;IACf,4BAAe,CAAA;IACf,kCAAqB,CAAA;IACrB,kCAAqB,CAAA;IACrB,gCAAmB,CAAA;IACnB,8BAAiB,CAAA;IACjB,wBAAW,CAAA;IACX,iEAAoD,CAAA;IACpD,kCAAqB,CAAA;IACrB,4BAAe,CAAA;IACf,+DAA+D;IAC/D,yCAA4B,CAAA;IAC5B,gEAAgE;IAChE,uCAA0B,CAAA;AAC5B,CAAC,EAjBW,SAAS,KAAT,SAAS,QAiBpB;AAED,MAAM,CAAN,IAAY,OAIX;AAJD,WAAY,OAAO;IACjB,8BAAmB,CAAA;IACnB,uCAA4B,CAAA;IAC5B,4BAAiB,CAAA;AACnB,CAAC,EAJW,OAAO,KAAP,OAAO,QAIlB;AAmCD;;;;GAIG;AACH,MAAM,OAAO,mBAAmB;IAC9B,+HAA+H;IAC/H,YAAoB,QAA6B;QAA7B,aAAQ,GAAR,QAAQ,CAAqB;IAAG,CAAC;IAErD,4BAA4B;IAC5B,IAAI,IAAI;QACN,OAAO,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAA;IAC3B,CAAC;IAED,wDAAwD;IACxD,IAAI,IAAI,CAAC,CAAc;QACrB,IAAI,CAAC,QAAQ,CAAC,IAAI,GAAG,CAAC,CAAA;IACxB,CAAC;IAED,IAAI,IAAI;QACN,OAAO,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAA;IAC3B,CAAC;IAED,IAAI,UAAU;QACZ,OAAO,IAAI,CAAC,QAAQ,CAAC,WAAW,CAAA;IAClC,CAAC;IAED,IAAI,MAAM;QACR,OAAO,IAAI,CAAC,QAAQ,CAAC,OAAO,CAAA;IAC9B,CAAC;IAED,IAAI,SAAS;QACX,OAAO,IAAI,CAAC,QAAQ,CAAC,UAAU,CAAA;IACjC,CAAC;IAED,IAAI,gBAAgB;QAClB,OAAO,IAAI,CAAC,QAAQ,CAAC,kBAAkB,CAAA;IACzC,CAAC;IAED,IAAI,cAAc;QAChB,OAAO,IAAI,CAAC,QAAQ,CAAC,eAAe,CAAA;IACtC,CAAC;IAED,IAAI,OAAO;QACT,OAAO,IAAI,CAAC,QAAQ,CAAC,OAAO,CAAA;IAC9B,CAAC;IAED,IAAI,aAAa;QACf,OAAO,IAAI,CAAC,QAAQ,CAAC,aAAa,CAAA;IACpC,CAAC;IAED,IAAI,aAAa,CAAC,CAA4B;QAC5C,IAAI,CAAC,QAAQ,CAAC,aAAa,GAAG,CAAC,CAAA;IACjC,CAAC;IAEO,qBAAqB,CAAC,GAAW;QACvC,MAAM,KAAK,GAAI,IAAI,CAAC,QAAQ,CAAC,IAA2C,CACtE,GAAG,CACJ,CAAA;QACD,OAAO,OAAO,KAAK,KAAK,QAAQ,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,SAAS,CAAA;IACtD,CAAC;IAED,IAAI,IAAI;QACN,OAAO,IAAI,CAAC,qBAAqB,CAAC,MAAM,CAAC,CAAA;IAC3C,CAAC;IAED,IAAI,IAAI,CAAC,KAAa;QACpB,CAAC;QAAC,IAAI,CAAC,QAAQ,CAAC,IAA2C,CAAC,IAAI,GAAG,KAAK,CAAA;IAC1E,CAAC;IAED,IAAI,OAAO;QACT,OAAO,IAAI,CAAC,qBAAqB,CAAC,SAAS,CAAC,CAAA;IAC9C,CAAC;IAED,IAAI,OAAO,CAAC,KAAyB;QACnC,CAAC;QAAC,IAAI,CAAC,QAAQ,CAAC,IAA2C,CAAC,OAAO,GAAG,KAAK,CAAA;IAC7E,CAAC;IAED,IAAI,QAAQ;QACV,OAAO,IAAI,CAAC,qBAAqB,CAAC,UAAU,CAAC,CAAA;IAC/C,CAAC;IAED,IAAI,aAAa;;QACf,OAAO,CACL,MAAA,IAAI,CAAC,qBAAqB,CAAC,gBAAgB,CAAC,mCAC5C,IAAI,CAAC,qBAAqB,CAAC,oBAAoB,CAAC,CACjD,CAAA;IACH,CAAC;IAED,4DAA4D;IAC5D,YAAY;QACV,OAAO,CACL,IAAI,CAAC,IAAI,KAAK,WAAW,CAAC,IAAI;YAC9B,IAAI,CAAC,IAAI,KAAK,SAAS;YACvB,IAAI,CAAC,IAAI,KAAK,EAAE,CACjB,CAAA;IACH,CAAC;IAED;;;OAGG;IACH,aAAa,CAAC,OAAe;QAC3B,IAAI,CAAC,QAAQ,mCACR,IAAI,CAAC,QAAQ,KAChB,IAAI,EAAE,WAAW,CAAC,QAAQ,EAC1B,IAAI,EAAE,IAAI,mBAAmB,CAAC,OAAO,CAAC,GACvC,CAAA;IACH,CAAC;IAED;;;OAGG;IACH,SAAS,CAAC,IAAY;QACpB,IAAI,CAAC,QAAQ,mCACR,IAAI,CAAC,QAAQ,KAChB,IAAI,EAAE,WAAW,CAAC,IAAI,EACtB,IAAI,EAAE,IAAI,eAAe,CAAC,IAAI,CAAC,GAChC,CAAA;IACH,CAAC;CACF"}

package/src/lib/server/botonic-context/botonic-context-session.d.ts

@@ -0,0 +1,159 @@
+import { MessagingChannel } from '@botonic/shared';
+import type { BotonicSession, BotonicSessionBot, BotonicSessionHubtypeCase, BotonicSessionUser, BotonicSessionUserContactInfoItem, UserExtraData } from '@botonic/shared';
+import { WebchatClientSettings } from '@botonic/shared';
+import { BotonicAction } from './botonic-action';
+export type { UserExtraData };
+export interface BotonicRequestSessionBasicEntity {
+    id: string;
+    name: string;
+}
+export type BotonicRequestSessionOrganization = BotonicRequestSessionBasicEntity;
+export type BotonicRequestSessionBot = BotonicRequestSessionBasicEntity;
+export interface BotonicRequestSessionUserContactInfoItem {
+    name: string;
+    type: string;
+    value: string;
+    description?: string;
+}
+export interface BotonicRequestSessionChannel {
+    provider: MessagingChannel;
+    imp_id?: string;
+    unformatted_phone_number?: string;
+}
+export interface BotonicRequestSessionUser<TExtraData extends UserExtraData = UserExtraData> {
+    id: string;
+    provider_id: string;
+    name?: string;
+    override_name?: string;
+    extra_data?: TExtraData;
+    contact_info?: BotonicRequestSessionUserContactInfoItem[];
+    locale: string;
+    country: string;
+    system_locale: string;
+}
+export interface BotonicRequestSession<TExtraData extends UserExtraData = UserExtraData> {
+    organization: BotonicRequestSessionOrganization;
+    bot: BotonicRequestSessionBot;
+    channel: BotonicRequestSessionChannel;
+    user: BotonicRequestSessionUser<TExtraData>;
+    is_test_integration: boolean;
+    is_first_interaction: boolean;
+    shadowing: boolean;
+    flow_thread_id?: string;
+    had_hubtype_handoff: boolean;
+    hubtype_case?: BotonicSessionHubtypeCase;
+    custom: Record<string, any>;
+    external: Record<string, any>;
+    webviews_custom: Record<string, any>;
+    webchat_client_settings: WebchatClientSettings;
+}
+/**
+ * Hydrated BotonicSession from Lambda `session`.
+ * Field names match backend `model_dump(mode="json")` (snake_case).
+ */
+export interface BotonicSessionUpdate<TExtraData extends UserExtraData = UserExtraData> {
+    shadowing?: boolean | null;
+    flowThreadId?: string | null;
+    custom?: Record<string, unknown>;
+    webviewsCustom?: Record<string, unknown>;
+    webchatClientSettings?: Record<string, unknown>;
+    /** Flow Builder capture node id; maps to `capture_user_input_node_id` on `PATCH …/session/`. */
+    captureUserInputNodeId?: string | null;
+    /** Stored as `_botonic_action` on session; not sent on v2 session PATCH. */
+    botonicAction?: string | null;
+    /** Maps to `is_first_interaction` on session; included in `PATCH …/session/` when set. */
+    isFirstInteraction?: boolean;
+    user?: {
+        overrideName?: string | null;
+        extraData?: TExtraData;
+        locale?: string;
+        country?: string;
+        systemLocale?: string;
+    };
+}
+/**
+ * Maps camelCase session updates to snake_case PATCH body (v2 only).
+ */
+export declare function sessionUpdateToPatchBody<TExtraData extends UserExtraData = UserExtraData>(update: BotonicSessionUpdate<TExtraData>): Record<string, unknown>;
+/**
+ * Mutates `session.raw` immediately so the rest of the turn sees updates.
+ * Handles `capture_user_input_node_id` (mirror of {@link sessionUpdateToPatchBody}) and
+ * `_botonic_action` (not sent on session PATCH).
+ * For `isFirstInteraction`, also updates in-memory `is_first_interaction`; the same
+ * value is emitted by {@link sessionUpdateToPatchBody} for `PATCH …/session/`.
+ */
+export declare function applyNonPatchSessionUpdateFields<TExtraData extends UserExtraData = UserExtraData>(session: BotonicSession<TExtraData>, updates: BotonicSessionUpdate<TExtraData>): void;
+/**
+ * Maps `BotonicSessionUpdate.user` to `PATCH …/users/<user_id>/` body (ChatUserPatchSerializer keys, snake_case).
+ * Unknown keys are omitted — only serializer fields are sent.
+ */
+export declare function userUpdateToChatUserPatchBody<TExtraData extends UserExtraData = UserExtraData>(user: BotonicSessionUpdate<TExtraData>['user'] | undefined): Record<string, unknown>;
+export declare class BotonicContextSessionUser<TExtraData extends UserExtraData = UserExtraData> {
+    private rawUser;
+    private readonly onUserUpdate?;
+    constructor(rawUser: BotonicSessionUser<TExtraData>, onUserUpdate?: ((updates: {
+        extraData?: TExtraData;
+    }) => void) | undefined);
+    get raw(): BotonicSessionUser<TExtraData>;
+    get id(): string;
+    get username(): string | undefined;
+    get name(): string | undefined;
+    get overrideName(): string | undefined;
+    get providerId(): string;
+    get locale(): string;
+    set locale(v: string);
+    get country(): string;
+    set country(v: string);
+    get systemLocale(): string;
+    set systemLocale(v: string);
+    get extraData(): TExtraData | undefined;
+    set extraData(v: TExtraData | undefined);
+    get contactInfo(): BotonicSessionUserContactInfoItem[] | undefined;
+}
+export declare class BotonicContextSession<TExtraData extends UserExtraData = UserExtraData> {
+    private sessionData;
+    private onUpdate?;
+    constructor(sessionData: BotonicSession<TExtraData>);
+    setOnUpdate(cb: (updates: BotonicSessionUpdate<TExtraData>) => void): void;
+    /** Replace underlying session object (e.g. after GET session from Hubtype). */
+    replaceSession(next: BotonicSession<TExtraData>): void;
+    get raw(): BotonicSession<TExtraData>;
+    get bot(): BotonicSessionBot;
+    get user(): BotonicContextSessionUser<TExtraData>;
+    get organizationId(): string;
+    get organizationName(): string;
+    get isFirstInteraction(): boolean;
+    set isFirstInteraction(v: boolean);
+    get botonicAction(): string | undefined;
+    set botonicAction(v: string | undefined);
+    isBotonicActionRedirect(): boolean;
+    getBotonicActionPayload(action: BotonicAction): string | undefined;
+    get isTestIntegration(): boolean;
+    get flowThreadId(): string | null | undefined;
+    get shadowing(): boolean | undefined;
+    set shadowing(v: boolean | undefined);
+    get hadHubtypeHandoff(): boolean | undefined;
+    get hubtypeCase(): BotonicSessionHubtypeCase | undefined;
+    /** Convenience for legacy code paths; prefer {@link hubtypeCase}. */
+    get hubtypeCaseId(): string | undefined;
+    get custom(): Record<string, unknown> | undefined;
+    get external(): Record<string, unknown> | undefined;
+    get webviewsCustom(): Record<string, unknown> | undefined;
+    set webviewsCustom(v: Record<string, unknown> | undefined);
+    get webchatClientSettings(): WebchatClientSettings;
+    set webchatClientSettings(v: WebchatClientSettings);
+    /** Flow Builder: node id capturing user input (`capture_user_input_node_id` in JSON). */
+    get captureUserInputNodeId(): string | undefined;
+    /** Channel provider (e.g. webchat, whatsapp). */
+    get provider(): string;
+    get impId(): string;
+    get unformattedPhoneNumber(): string | undefined;
+    isDev(): boolean;
+    isWebchat(): boolean;
+    isTelegram(): boolean;
+    isFacebook(): boolean;
+    isInstagram(): boolean;
+    isTwitter(): boolean;
+    isWhatsapp(): boolean;
+    hasFlowThreadId(): boolean;
+}