@botonic/webviews 2.26.0 → 2.28.0

package/lib/context/botonic-context-webviews.d.ts

@@ -0,0 +1,70 @@
+import { MessagingChannel, BotonicWebviewsSessionChannel, BotonicWebviewsSessionUser } from '../../../../shared/src/index.ts';
+export declare class BotonicContextWebviewsChannel {
+    private readonly channel;
+    constructor(channel: BotonicWebviewsSessionChannel);
+    get provider(): MessagingChannel;
+    get impId(): string;
+    get unformattedPhoneNumber(): string;
+}
+export declare class BotonicContextWebviewsUser {
+    private readonly user;
+    constructor(user: {
+        id: string;
+        locale: string;
+        country: string;
+        system_locale: string;
+    });
+    get id(): string;
+    get locale(): string;
+    get country(): string;
+    get systemLocale(): string;
+}
+export declare class BotonicContextWebviewsSettings {
+    private readonly settings;
+    constructor(settings: {
+        HUBTYPE_API_URL: string;
+    });
+    get hubtypeApiUrl(): string;
+}
+export declare class BotonicContextWebviewsBot {
+    private readonly bot;
+    constructor(bot: {
+        id: string;
+        name: string;
+    });
+    get id(): string;
+    get name(): string;
+}
+/**
+ * Nested session slice with channel/user wrappers (same idea as {@link BotonicContextSession} on the server).
+ */
+export declare class BotonicContextWebviewsSession {
+    private readonly sessionPayload;
+    constructor(sessionPayload: {
+        channel: BotonicWebviewsSessionChannel;
+        user: BotonicWebviewsSessionUser;
+    });
+    get channel(): BotonicContextWebviewsChannel;
+    get user(): BotonicContextWebviewsUser;
+}
+/**
+ * Normalized webviews context: `session` groups API `channel` + `user` (set by the factory).
+ * Optional `settings` is not returned by GET webviews — pass when building from app config / URL (e.g. hubtype API URL).
+ */
+export interface BotonicContextWebviewsType {
+    custom: Record<string, any>;
+    bot: BotonicContextWebviewsBot;
+    session: BotonicContextWebviewsSession;
+    settings?: BotonicContextWebviewsSettings;
+}
+/**
+ * Hydrated webviews context (like {@link BotonicContext}): factory output plus optional injected settings.
+ */
+export declare class BotonicContextWebviews implements BotonicContextWebviewsType {
+    readonly custom: Record<string, any>;
+    readonly bot: BotonicContextWebviewsBot;
+    readonly session: BotonicContextWebviewsSession;
+    readonly settings?: BotonicContextWebviewsSettings;
+    constructor(base: BotonicContextWebviewsType);
+    get hubtypeApiUrl(): string;
+}

package/lib/context/factory.d.ts

@@ -0,0 +1,17 @@
+import { BotonicWebviewsSessionBot, BotonicWebviewsSessionChannel, BotonicWebviewsSessionUser } from '../../../../shared/src/index.ts';
+import { BotonicContextWebviews } from './botonic-context-webviews';
+interface BotonicContextWebviewsFactoryParams {
+    custom: Record<string, unknown>;
+    channel: BotonicWebviewsSessionChannel;
+    user: BotonicWebviewsSessionUser;
+    bot: BotonicWebviewsSessionBot;
+    hubtypeApiUrl: string;
+}
+export declare class BotonicContextWebviewsFactory {
+    /**
+     * Maps flat GET webviews JSON (`custom`, `channel`, `user`) into a context shape where
+     * `channel` and `user` are grouped under `session` (see {@link BotonicContextFactory.from}).
+     */
+    static from(params: BotonicContextWebviewsFactoryParams): BotonicContextWebviews;
+}
+export {};

package/lib/context/index.d.ts

@@ -0,0 +1,2 @@
+export * from './botonic-context-webviews';
+export * from './factory';

package/lib/hooks/use-botonic-context-webviews.d.ts

@@ -0,0 +1,4 @@
+import { BotonicContextWebviews } from '../context';
+export declare const useBotonicContextWebviews: () => {
+    botonicContextWebviews: BotonicContextWebviews | undefined;
+};

package/lib/hooks/use-webview-close.d.ts

@@ -1,6 +1,7 @@
+import { BotonicContextWebviews } from '../context';
 export interface CloseWebviewOptions {
     payload?: any;
     path?: string;
     params?: Record<string, string>;
 }
-export declare function useWebviewClose(session: any): (options?: CloseWebviewOptions) => Promise<void>;
+export declare function useWebviewClose(botonicContextWebviews?: BotonicContextWebviews): (options?: CloseWebviewOptions) => Promise<void>;

package/lib/hooks/use-webview-contents/hook.d.ts

@@ -1,8 +1,10 @@
+import { BotonicContextWebviews } from '../../context';
 import { MapContentsType, UseWebviewContents } from './types';
 export interface UseWebviewContentsProps<T extends MapContentsType> {
-    botSession: Record<string, any>;
+    /** Undefined until `useBotonicContextWebviews` finishes loading the GET webviews session. */
+    botonicContextWebviews?: BotonicContextWebviews;
     params: Record<string, string>;
     version?: 'draft' | 'latest' | string;
     mapContents: Record<keyof T, string>;
 }
-export declare function useWebviewContents<T extends MapContentsType>({ botSession, params, version, mapContents, }: UseWebviewContentsProps<T>): UseWebviewContents<T>;
+export declare function useWebviewContents<T extends MapContentsType>({ botonicContextWebviews, params, version, mapContents, }: UseWebviewContentsProps<T>): UseWebviewContents<T>;

package/lib/index.d.ts

@@ -1,5 +1,6 @@
+export * from './context';
 export * from './components';
-export * from './hooks/use-bot-session';
+export * from './hooks/use-botonic-context-webviews';
 export * from './hooks/use-webview-close';
 export * from './hooks/use-webview-contents';
 export * from './webview-context';

package/lib/webview-context.d.ts

@@ -1,8 +1,9 @@
+import { BotonicContextWebviews } from './context';
 import { ConfirmCloseOption } from '../../../webchat-core/src/index.ts';
 import { CloseWebviewOptions } from './hooks/use-webview-close';
 import { WebviewDefinition } from './webviews';
 export interface WebviewContextType {
-    botSession: Record<string, any>;
+    botonicContextWebviews?: BotonicContextWebviews;
     params: Record<string, string>;
     closeWebview: (options?: CloseWebviewOptions) => Promise<void>;
     setWebviewTitle: (title: string) => void;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@botonic/webviews",
-  "version": "2.26.0",
+  "version": "2.28.0",
   "type": "module",
   "types": "./index.d.ts",
   "module": "./index.js",
@@ -12,9 +12,10 @@
     }
   },
   "dependencies": {
-    "@botonic/core": "2.26.0",
-    "@botonic/webchat-core": "2.26.0",
-    "@lilara/foundations": ">=0.5.0",
+    "@botonic/core": "2.28.0",
+    "@botonic/shared": "2.28.0",
+    "@botonic/webchat-core": "2.28.0",
+    "@lilara/foundations": ">=0.7.0",
     "class-variance-authority": "^0.7.0",
     "react": "18.3.1"
   },

package/lib/hooks/use-bot-session.d.ts

@@ -1,3 +0,0 @@
-export declare const useBotSession: () => {
-    botSession: any;
-};