@botonic/shared 2.25.0 → 2.27.0

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

@@ -1 +1 @@
-{"version":3,"file":"botonic-context-input.js","sourceRoot":"","sources":["../../../../../../../../../libs/botonic/shared/src/lib/domain/server/botonic-context/botonic-context-input.ts"],"names":[],"mappings":"AAEA,OAAO,EACL,mBAAmB,EACnB,eAAe,EACf,WAAW,GACZ,MAAM,qBAAqB,CAAA;AAE5B,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;AAsCD;;;;GAIG;AACH,MAAM,OAAO,mBAAmB;IAC9B,yIAAyI;IACzI,YAAoB,QAAwB;QAAxB,aAAQ,GAAR,QAAQ,CAAgB;IAAG,CAAC;IAEhD,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,IAAgC,CAAC,GAAG,CAAC,CAAA;QAClE,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,IAAgC,CAAC,IAAI,GAAG,KAAK,CAAA;IAC/D,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,IAAgC,CAAC,OAAO,GAAG,KAAK,CAAA;IAClE,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"}
+{"version":3,"file":"botonic-context-input.js","sourceRoot":"","sources":["../../../../../../../../../libs/botonic/shared/src/lib/domain/server/botonic-context/botonic-context-input.ts"],"names":[],"mappings":"AACA,OAAO,EACL,mBAAmB,EACnB,eAAe,EACf,WAAW,GACZ,MAAM,qBAAqB,CAAA;AAE5B,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/domain/server/botonic-context/botonic-context-session.d.ts

@@ -1,96 +1,105 @@
 import { MessagingChannel } from '../../../shared-types';
-export interface ContactInfo {
+import type { BotonicSession, BotonicSessionBot, BotonicSessionHubtypeCase, BotonicSessionUser, BotonicSessionUserContactInfoItem, UserExtraData } from '../../botonic/session';
+import { WebchatClientSettings } from '../../botonic/webchat-client-settings';
+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 BotonicRequestSessionBot {
-    id: string;
-    name?: string;
+export interface BotonicRequestSessionChannel {
+    provider: MessagingChannel;
+    imp_id?: string;
+    unformatted_phone_number?: string;
 }
-/** Extra data attached to session user. API and runtime treat it as a string-keyed object. */
-export type UserExtraData = Record<string, any>;
 export interface BotonicRequestSessionUser<TExtraData extends UserExtraData = UserExtraData> {
     id: string;
-    username?: string;
+    provider_id: string;
     name?: string;
-    provider: MessagingChannel;
-    imp_id?: string;
-    provider_id?: string;
-    chat_id?: string;
+    override_name?: string;
     extra_data?: TExtraData;
+    contact_info?: BotonicRequestSessionUserContactInfoItem[];
     locale: string;
     country: string;
     system_locale: string;
-    contact_info?: ContactInfo[];
-}
-export interface CaptureUserInput {
-    node_id: string;
 }
-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 interface BotonicRequestSession<TExtraData extends UserExtraData = UserExtraData> {
+    organization: BotonicRequestSessionOrganization;
     bot: BotonicRequestSessionBot;
+    channel: BotonicRequestSessionChannel;
     user: BotonicRequestSessionUser<TExtraData>;
-    organization: string;
-    organization_id: string;
-    __retries: number;
-    is_first_interaction: boolean;
     is_test_integration: boolean;
-    flow_thread_id: string;
-    _access_token: string;
-    _botonic_action?: BotonicActionType;
-    _hubtype_api: string;
-    _shadowing?: boolean;
-    _hubtype_case_id?: string;
-    capture_user_input?: CaptureUserInput;
+    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;
 }
 /**
- * Developer-friendly subset of session attributes that can be updated.
- * Pass only the fields you want to change; they are converted to API shape internally.
+ * 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;
-    botonicAction?: BotonicActionType | null;
-    flowThreadId?: string;
-    captureUserInput?: CaptureUserInput;
     user?: {
+        overrideName?: string | null;
         extraData?: TExtraData;
-        systemLocale?: string;
         locale?: string;
         country?: string;
+        systemLocale?: string;
     };
 }
 /**
- * Converts a developer-facing session update (camelCase) to the raw PATCH body shape (snake_case).
+ * 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 sessionUpdateToPatchBody<TExtraData extends UserExtraData = UserExtraData>(update: BotonicSessionUpdate<TExtraData>): Partial<BotonicRequestSession<TExtraData>>;
+export declare function applyNonPatchSessionUpdateFields<TExtraData extends UserExtraData = UserExtraData>(session: BotonicSession<TExtraData>, updates: BotonicSessionUpdate<TExtraData>): void;
 /**
- * Runtime class that wraps SessionUser and exposes accessor methods for common attributes.
- * Use this as request.session.user so consumers can call request.session.user.locale,
- * request.session.user.extraData, etc.
+ * 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: BotonicRequestSessionUser<TExtraData>, onUserUpdate?: ((updates: {
+    constructor(rawUser: BotonicSessionUser<TExtraData>, onUserUpdate?: ((updates: {
         extraData?: TExtraData;
     }) => void) | undefined);
-    /** Raw user for API calls and serialization. */
-    get raw(): BotonicRequestSessionUser<TExtraData>;
+    get raw(): BotonicSessionUser<TExtraData>;
     get id(): string;
     get username(): string | undefined;
     get name(): string | undefined;
-    get provider(): string;
-    get impId(): string | undefined;
-    get chatId(): string | undefined;
+    get overrideName(): string | undefined;
+    get providerId(): string;
     get locale(): string;
     set locale(v: string);
     get country(): string;
@@ -99,38 +108,46 @@ export declare class BotonicContextSessionUser<TExtraData extends UserExtraData
     set systemLocale(v: string);
     get extraData(): TExtraData | undefined;
     set extraData(v: TExtraData | undefined);
-    get contactInfo(): ContactInfo[] | undefined;
+    get contactInfo(): BotonicSessionUserContactInfoItem[] | undefined;
 }
-/**
- * Runtime class that wraps Session and exposes accessor methods for common attributes.
- * Use this as BotRequest.session so consumers can call request.session.user.id,
- * request.session.bot.id, etc.
- */
 export declare class BotonicContextSession<TExtraData extends UserExtraData = UserExtraData> {
-    private rawSession;
+    private sessionData;
     private onUpdate?;
-    constructor(rawSession: BotonicRequestSession<TExtraData>);
-    /** Register a callback to run when session is mutated (e.g. user.extraData set). Calls updateBotSession internally. */
+    constructor(sessionData: BotonicSession<TExtraData>);
     setOnUpdate(cb: (updates: BotonicSessionUpdate<TExtraData>) => void): void;
-    /** Raw session for API calls and serialization (e.g. lambda context). */
-    get raw(): BotonicRequestSession<TExtraData>;
-    get bot(): BotonicRequestSessionBot;
+    /** 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 organization(): string;
     get organizationId(): string;
-    get retries(): number;
+    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;
-    get accessToken(): string;
-    get botonicAction(): BotonicActionType | undefined;
-    set botonicAction(v: BotonicActionType | undefined);
-    get hubtypeApi(): string;
+    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 captureUserInput(): {
-        node_id: 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;
@@ -138,9 +155,5 @@ export declare class BotonicContextSession<TExtraData extends UserExtraData = Us
     isInstagram(): boolean;
     isTwitter(): boolean;
     isWhatsapp(): boolean;
-    isBotonicActionRedirect(): boolean;
-    getBotonicActionPayload(action: BotonicAction): string | undefined;
-    /** True when the session has a flow thread id. */
     hasFlowThreadId(): boolean;
 }
-export {};

package/src/lib/domain/server/botonic-context/botonic-context-session.js

@@ -1,61 +1,98 @@
 import { MessagingChannel } from '../../../shared-types';
-export var BotonicAction;
-(function (BotonicAction) {
-    BotonicAction["Redirect"] = "redirect_action";
-    BotonicAction["CreateCase"] = "create_case";
-    BotonicAction["DeleteUser"] = "delete_user";
-    BotonicAction["DiscardCase"] = "discard_case";
-})(BotonicAction || (BotonicAction = {}));
+import { DEFAULT_WEBCHAT_CLIENT_SETTINGS, } from '../../botonic/webchat-client-settings';
+import { BotonicAction } from './botonic-action';
 /**
- * Converts a developer-facing session update (camelCase) to the raw PATCH body shape (snake_case).
+ * Maps camelCase session updates to snake_case PATCH body (v2 only).
  */
 export function sessionUpdateToPatchBody(update) {
-    var _a;
-    const raw = {};
+    const body = {};
     if (update.isFirstInteraction !== undefined) {
-        raw.is_first_interaction = update.isFirstInteraction;
-    }
-    if ('botonicAction' in update) {
-        raw._botonic_action =
-            (_a = update.botonicAction) !== null && _a !== void 0 ? _a : null;
+        body.is_first_interaction = update.isFirstInteraction;
     }
+    if (update.shadowing !== undefined)
+        body.shadowing = update.shadowing;
     if (update.flowThreadId !== undefined) {
-        raw.flow_thread_id = update.flowThreadId;
-    }
-    if (update.captureUserInput !== undefined) {
-        raw.capture_user_input = update.captureUserInput;
-    }
-    if (update.user !== undefined) {
-        const u = update.user;
-        const userPatch = {};
-        if (u.extraData !== undefined)
-            userPatch.extra_data = u.extraData;
-        if (u.systemLocale !== undefined)
-            userPatch.system_locale = u.systemLocale;
-        if (u.locale !== undefined)
-            userPatch.locale = u.locale;
-        if (u.country !== undefined)
-            userPatch.country = u.country;
-        if (Object.keys(userPatch).length > 0) {
-            ;
-            raw.user = userPatch;
+        body.flow_thread_id = update.flowThreadId;
+    }
+    if (update.custom !== undefined)
+        body.custom = update.custom;
+    if (update.webviewsCustom !== undefined) {
+        body.webviews_custom = update.webviewsCustom;
+    }
+    if (update.webchatClientSettings !== undefined) {
+        body.webchat_client_settings = update.webchatClientSettings;
+    }
+    if (update.captureUserInputNodeId !== undefined) {
+        const id = update.captureUserInputNodeId;
+        if (id === null || id === '') {
+            body.capture_user_input_node_id = null;
+        }
+        else {
+            body.capture_user_input_node_id = id;
         }
     }
-    return raw;
+    return body;
 }
 /**
- * Runtime class that wraps SessionUser and exposes accessor methods for common attributes.
- * Use this as request.session.user so consumers can call request.session.user.locale,
- * request.session.user.extraData, etc.
+ * 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/`.
  */
-// TODO: Should we do call updateSession against API each time a setter is called?
-// feedback TODO: Actually, all sets of this class should use an API call to update the value in the database through the backend. And perhaps the gets should read the data in the same way (I'm not sure about this last point).
+export function applyNonPatchSessionUpdateFields(session, updates) {
+    if (updates.captureUserInputNodeId !== undefined) {
+        const id = updates.captureUserInputNodeId;
+        if (id === null || id === '') {
+            delete session.capture_user_input_node_id;
+        }
+        else {
+            session.capture_user_input_node_id = id;
+        }
+    }
+    if (updates.isFirstInteraction !== undefined) {
+        session.is_first_interaction = updates.isFirstInteraction;
+    }
+    if (updates.botonicAction !== undefined) {
+        const w = session;
+        if (updates.botonicAction === null || updates.botonicAction === '') {
+            delete w._botonic_action;
+        }
+        else {
+            w._botonic_action = updates.botonicAction;
+        }
+    }
+}
+/**
+ * Maps `BotonicSessionUpdate.user` to `PATCH …/users/<user_id>/` body (ChatUserPatchSerializer keys, snake_case).
+ * Unknown keys are omitted — only serializer fields are sent.
+ */
+export function userUpdateToChatUserPatchBody(user) {
+    if (user === undefined)
+        return {};
+    const body = {};
+    if (user.overrideName !== undefined) {
+        body.override_name = user.overrideName;
+    }
+    if (user.locale !== undefined) {
+        body.locale = user.locale;
+    }
+    if (user.country !== undefined) {
+        body.country = user.country;
+    }
+    if (user.systemLocale !== undefined) {
+        body.system_locale = user.systemLocale;
+    }
+    if (user.extraData !== undefined) {
+        body.extra_data = user.extraData;
+    }
+    return body;
+}
 export class BotonicContextSessionUser {
     constructor(rawUser, onUserUpdate) {
         this.rawUser = rawUser;
         this.onUserUpdate = onUserUpdate;
     }
-    /** Raw user for API calls and serialization. */
     get raw() {
         return this.rawUser;
     }
@@ -63,19 +100,19 @@ export class BotonicContextSessionUser {
         return this.rawUser.id;
     }
     get username() {
-        return this.rawUser.username;
+        var _a;
+        return (_a = this.rawUser.username) !== null && _a !== void 0 ? _a : undefined;
     }
     get name() {
-        return this.rawUser.name;
-    }
-    get provider() {
-        return this.rawUser.provider;
+        var _a;
+        return (_a = this.rawUser.name) !== null && _a !== void 0 ? _a : undefined;
     }
-    get impId() {
-        return this.rawUser.imp_id;
+    get overrideName() {
+        var _a;
+        return (_a = this.rawUser.override_name) !== null && _a !== void 0 ? _a : undefined;
     }
-    get chatId() {
-        return this.rawUser.chat_id;
+    get providerId() {
+        return this.rawUser.provider_id;
     }
     get locale() {
         return this.rawUser.locale;
@@ -107,103 +144,154 @@ export class BotonicContextSessionUser {
         return this.rawUser.contact_info;
     }
 }
-/**
- * Runtime class that wraps Session and exposes accessor methods for common attributes.
- * Use this as BotRequest.session so consumers can call request.session.user.id,
- * request.session.bot.id, etc.
- */
 export class BotonicContextSession {
-    constructor(rawSession) {
-        this.rawSession = rawSession;
+    constructor(sessionData) {
+        this.sessionData = sessionData;
     }
-    /** Register a callback to run when session is mutated (e.g. user.extraData set). Calls updateBotSession internally. */
     setOnUpdate(cb) {
         this.onUpdate = cb;
     }
-    /** Raw session for API calls and serialization (e.g. lambda context). */
+    /** Replace underlying session object (e.g. after GET session from Hubtype). */
+    replaceSession(next) {
+        this.sessionData = next;
+    }
     get raw() {
-        return this.rawSession;
+        return this.sessionData;
     }
     get bot() {
-        return this.rawSession.bot;
+        return this.sessionData.bot;
     }
     get user() {
-        return new BotonicContextSessionUser(this.rawSession.user, 
-        // Automatically updates the session when the user is updated (e.g. when the user.extraData is set)
-        this.onUpdate ? updates => this.onUpdate({ user: updates }) : undefined);
-    }
-    get organization() {
-        return this.rawSession.organization;
+        const notify = this.onUpdate;
+        return new BotonicContextSessionUser(this.sessionData.user, notify !== undefined
+            ? updates => {
+                notify({ user: updates });
+            }
+            : undefined);
     }
     get organizationId() {
-        return this.rawSession.organization_id;
+        return this.sessionData.organization.id;
     }
-    get retries() {
-        return this.rawSession.__retries;
+    get organizationName() {
+        return this.sessionData.organization.name;
     }
     get isFirstInteraction() {
-        return this.rawSession.is_first_interaction;
-    }
-    get isTestIntegration() {
-        return this.rawSession.is_test_integration;
+        return this.sessionData.is_first_interaction;
     }
-    get flowThreadId() {
-        return this.rawSession.flow_thread_id;
-    }
-    get accessToken() {
-        return this.rawSession._access_token;
+    set isFirstInteraction(v) {
+        this.sessionData.is_first_interaction = v;
     }
     get botonicAction() {
-        return this.rawSession._botonic_action;
+        const w = this.sessionData;
+        const v = w._botonic_action;
+        return typeof v === 'string' ? v : undefined;
     }
     set botonicAction(v) {
-        this.rawSession._botonic_action = v;
+        const w = this.sessionData;
+        if (v === undefined || v === '') {
+            delete w._botonic_action;
+        }
+        else {
+            w._botonic_action = v;
+        }
     }
-    get hubtypeApi() {
-        return this.rawSession._hubtype_api;
+    isBotonicActionRedirect() {
+        const a = this.botonicAction;
+        const prefix = `${BotonicAction.Redirect}:`;
+        return typeof a === 'string' && a.startsWith(prefix);
+    }
+    getBotonicActionPayload(action) {
+        const prefix = `${action}:`;
+        const a = this.botonicAction;
+        if (typeof a !== 'string' || !a.startsWith(prefix))
+            return undefined;
+        return a.slice(prefix.length);
+    }
+    get isTestIntegration() {
+        return this.sessionData.is_test_integration;
+    }
+    get flowThreadId() {
+        return this.sessionData.flow_thread_id;
     }
     get shadowing() {
-        return this.rawSession._shadowing;
+        return this.sessionData.shadowing;
+    }
+    set shadowing(v) {
+        this.sessionData.shadowing = v;
+    }
+    get hadHubtypeHandoff() {
+        return this.sessionData.had_hubtype_handoff;
+    }
+    get hubtypeCase() {
+        return this.sessionData.hubtype_case;
     }
+    /** Convenience for legacy code paths; prefer {@link hubtypeCase}. */
     get hubtypeCaseId() {
-        return this.rawSession._hubtype_case_id;
+        var _a;
+        return (_a = this.sessionData.hubtype_case) === null || _a === void 0 ? void 0 : _a.id;
+    }
+    get custom() {
+        return this.sessionData.custom;
+    }
+    get external() {
+        return this.sessionData.external;
+    }
+    get webviewsCustom() {
+        return this.sessionData.webviews_custom;
     }
-    get captureUserInput() {
-        return this.rawSession.capture_user_input;
+    set webviewsCustom(v) {
+        this.sessionData.webviews_custom = v;
+    }
+    get webchatClientSettings() {
+        var _a;
+        return ((_a = this.sessionData.webchat_client_settings) !== null && _a !== void 0 ? _a : DEFAULT_WEBCHAT_CLIENT_SETTINGS);
+    }
+    set webchatClientSettings(v) {
+        this.sessionData.webchat_client_settings = v;
+    }
+    /** Flow Builder: node id capturing user input (`capture_user_input_node_id` in JSON). */
+    get captureUserInputNodeId() {
+        const id = this.sessionData.capture_user_input_node_id;
+        if (id == null || id === '') {
+            return undefined;
+        }
+        return id;
+    }
+    /** Channel provider (e.g. webchat, whatsapp). */
+    get provider() {
+        return this.sessionData.channel.provider;
+    }
+    get impId() {
+        return this.sessionData.channel.imp_id;
+    }
+    get unformattedPhoneNumber() {
+        var _a;
+        return (_a = this.sessionData.channel.unformatted_phone_number) !== null && _a !== void 0 ? _a : undefined;
     }
-    // TODO: Still needed?
     isDev() {
-        return this.user.provider === MessagingChannel.Webchat;
+        return this.provider === MessagingChannel.Webchat;
     }
     isWebchat() {
-        return this.user.provider === MessagingChannel.Webchat;
+        return this.provider === MessagingChannel.Webchat;
     }
     isTelegram() {
-        return this.user.provider === MessagingChannel.Telegram;
+        return this.provider === MessagingChannel.Telegram;
     }
     isFacebook() {
-        return this.user.provider === MessagingChannel.Facebook;
+        return this.provider === MessagingChannel.Facebook;
     }
     isInstagram() {
-        return this.user.provider === MessagingChannel.Instagram;
+        return this.provider === MessagingChannel.Instagram;
     }
     isTwitter() {
-        return this.user.provider === MessagingChannel.Twitter;
+        return this.provider === MessagingChannel.Twitter;
     }
     isWhatsapp() {
-        return this.user.provider === MessagingChannel.Whatsapp;
-    }
-    isBotonicActionRedirect() {
-        var _a, _b;
-        return (_b = (_a = this.botonicAction) === null || _a === void 0 ? void 0 : _a.startsWith(BotonicAction.Redirect)) !== null && _b !== void 0 ? _b : false;
-    }
-    getBotonicActionPayload(action) {
-        var _a;
-        return (_a = this.botonicAction) === null || _a === void 0 ? void 0 : _a.split(action + ':')[1];
+        return this.provider === MessagingChannel.Whatsapp;
     }
-    /** True when the session has a flow thread id. */
     hasFlowThreadId() {
-        return this.flowThreadId !== undefined && this.flowThreadId !== '';
+        const ft = this.flowThreadId;
+        return ft != null && ft !== '';
     }
 }
 //# sourceMappingURL=botonic-context-session.js.map