@salsita-ai/sdk 0.50.0-develop.85e8f9df39 → 0.50.0-develop.8876e19a19

package/dist/react-sdk/application-runtime/provider/ApplicationType.d.ts

@@ -6,4 +6,11 @@ interface ApplicationTypeProviderProps {
 }
 export declare const ApplicationTypeProvider: (props: ApplicationTypeProviderProps) => import("react/jsx-runtime").JSX.Element;
 export declare const useApplicationType: () => ApplicationType;
+/**
+ * The application type of the nearest `ApplicationTypeProvider`, or `null` outside one, for the
+ * hooks that some application-agnostic providers call and that have nothing to do there.
+ *
+ * @internal Runtime plumbing for the SDK's own UI.
+ */
+export declare const useOptionalApplicationType: () => ApplicationType | null;
 export {};

package/dist/react-sdk/application-runtime/provider/ApplicationType.js

@@ -1 +1 @@
-import{jsx as e}from"react/jsx-runtime";import{createContext as t,useContext as r}from"react";let o=t(null);export const ApplicationTypeProvider=t=>{let{children:r,type:p}=t;return e(o.Provider,{value:p,children:r})};export const useApplicationType=()=>{let e=r(o);if(!e)throw Error("ApplicationType context not found! useApplicationType() must be used within an ApplicationTypeProvider. Use the hook appropriately.");return e};
+import{jsx as e}from"react/jsx-runtime";import{createContext as t,useContext as o}from"react";let p=t(null);export const ApplicationTypeProvider=t=>{let{children:o,type:r}=t;return e(p.Provider,{value:r,children:o})};export const useApplicationType=()=>{let e=o(p);if(!e)throw Error("ApplicationType context not found! useApplicationType() must be used within an ApplicationTypeProvider. Use the hook appropriately.");return e};export const useOptionalApplicationType=()=>o(p);

package/dist/react-sdk/application-runtime/responsive/actions.d.ts

@@ -0,0 +1,47 @@
+import type { DomainApplicationType } from '#package/domain';
+import type { CanvasPadding, ResponsiveBreakpoints, ResponsiveRuntimeState, ResponsiveViewport } from './types.js';
+interface Context {
+    readonly setResponsive: (fn: (state: ResponsiveRuntimeState) => ResponsiveRuntimeState) => void;
+}
+/**
+ * Every action returns the slice unchanged when the value is already set, so the runtime publishes
+ * nothing and no subscriber recomputes.
+ */
+declare const createApplicationActions: (context: Context, applicationType: DomainApplicationType) => {
+    setViewport: (viewport: ResponsiveViewport) => void;
+    setBreakpoints: (breakpoints: ResponsiveBreakpoints) => void;
+    setCanvasPadding: (canvasPadding: CanvasPadding) => void;
+    expand: () => void;
+    collapse: () => void;
+    hide: () => void;
+    show: () => void;
+    setAnimating: (isAnimating: boolean) => void;
+    reset: () => void;
+};
+/** One set of actions per application, as the domain context keys its own. */
+export declare const createResponsiveActions: (context: Context) => {
+    configurator: {
+        setViewport: (viewport: ResponsiveViewport) => void;
+        setBreakpoints: (breakpoints: ResponsiveBreakpoints) => void;
+        setCanvasPadding: (canvasPadding: CanvasPadding) => void;
+        expand: () => void;
+        collapse: () => void;
+        hide: () => void;
+        show: () => void;
+        setAnimating: (isAnimating: boolean) => void;
+        reset: () => void;
+    };
+    admin: {
+        setViewport: (viewport: ResponsiveViewport) => void;
+        setBreakpoints: (breakpoints: ResponsiveBreakpoints) => void;
+        setCanvasPadding: (canvasPadding: CanvasPadding) => void;
+        expand: () => void;
+        collapse: () => void;
+        hide: () => void;
+        show: () => void;
+        setAnimating: (isAnimating: boolean) => void;
+        reset: () => void;
+    };
+};
+export type ResponsiveActions = ReturnType<typeof createApplicationActions>;
+export {};

package/dist/react-sdk/application-runtime/responsive/actions.js

@@ -0,0 +1 @@
+import{initializeResponsiveApplication as t}from"./initialize.js";let e=(e,i)=>{let n=t=>{e.setResponsive(e=>{let n=e[i],s=t(n);return s===n?e:{...e,[i]:s}})},s=t=>{n(e=>e.isExpanded===t?e:{...e,isExpanded:t})},r=t=>{n(e=>e.isHidden===t?e:{...e,isHidden:t})};return{setViewport:t=>{n(e=>{let i;return(i=e.viewport,null!==i&&i.width===t.width&&i.height===t.height&&i.isLandscape===t.isLandscape&&i.isPortrait===t.isPortrait)?e:{...e,viewport:t}})},setBreakpoints:t=>{n(e=>{let i;return(i=e.breakpoints,i.sm===t.sm&&i.md===t.md&&i.lg===t.lg)?e:{...e,breakpoints:t}})},setCanvasPadding:t=>{n(e=>{let i;return(i=e.canvasPadding,i.top===t.top&&i.right===t.right&&i.bottom===t.bottom&&i.left===t.left)?e:{...e,canvasPadding:t}})},expand:()=>{s(!0)},collapse:()=>{s(!1)},hide:()=>{r(!0)},show:()=>{r(!1)},setAnimating:t=>{n(e=>e.isAnimating===t?e:{...e,isAnimating:t})},reset:()=>{n(()=>t())}}};export const createResponsiveActions=t=>({configurator:e(t,"configurator"),admin:e(t,"admin")});

package/dist/react-sdk/application-runtime/responsive/index.d.ts

@@ -0,0 +1,4 @@
+export * from './actions.js';
+export * from './initialize.js';
+export * from './selectors.js';
+export type * from './types.js';

package/dist/react-sdk/application-runtime/responsive/index.js

@@ -0,0 +1 @@
+export*from"./actions.js";export*from"./initialize.js";export*from"./selectors.js";

package/dist/react-sdk/application-runtime/responsive/initialize.d.ts

@@ -0,0 +1,3 @@
+import type { ResponsiveApplicationState, ResponsiveRuntimeState } from './types.js';
+export declare const initializeResponsiveApplication: () => ResponsiveApplicationState;
+export declare const initializeResponsive: () => ResponsiveRuntimeState;

package/dist/react-sdk/application-runtime/responsive/initialize.js

@@ -0,0 +1 @@
+export const initializeResponsiveApplication=()=>({viewport:null,breakpoints:{sm:480,md:768,lg:1024},canvasPadding:{top:0,right:0,bottom:0,left:0},isExpanded:!1,isHidden:!1,isAnimating:!1});export const initializeResponsive=()=>({configurator:initializeResponsiveApplication(),admin:initializeResponsiveApplication()});

package/dist/react-sdk/application-runtime/responsive/selectors.d.ts

@@ -0,0 +1,20 @@
+import type { DomainApplicationType } from '#package/domain';
+import type { ResponsiveRuntimeState, ResponsiveState, ResponsiveViewportSize } from './types.js';
+export interface ResponsiveSelectorState {
+    readonly responsive: ResponsiveRuntimeState;
+}
+interface Context {
+    readonly getState: () => ResponsiveSelectorState;
+    readonly applicationType: DomainApplicationType;
+}
+/** The selectors of one application's responsive state; the runtime creates one set per application. */
+export declare const createResponsiveSelectors: (context: Context) => {
+    selectResponsiveState: import("@salsita-ai/common/utils").Selector<ResponsiveSelectorState, ResponsiveState>;
+    selectViewportSize: import("@salsita-ai/common/utils").Selector<ResponsiveSelectorState, ResponsiveViewportSize>;
+    selectCanvasPadding: import("@salsita-ai/common/utils").Selector<ResponsiveSelectorState, import("./types.js").CanvasPadding>;
+    getResponsiveState: () => ResponsiveState;
+    getViewportSize: () => ResponsiveViewportSize;
+    getCanvasPadding: () => import("./types.js").CanvasPadding;
+};
+export type ResponsiveSelectors = ReturnType<typeof createResponsiveSelectors>;
+export {};

package/dist/react-sdk/application-runtime/responsive/selectors.js

@@ -0,0 +1 @@
+import{createSelector as e}from"@salsita-ai/common/utils";export const createResponsiveSelectors=i=>{let{getState:s,applicationType:t}=i,a=e.withTypes(),o=a.leaf(e=>null!==e.responsive[t].viewport),n=a.leaf(e=>e.responsive[t].viewport?.width??0),r=a.leaf(e=>e.responsive[t].viewport?.height??0),p=a.leaf(e=>e.responsive[t].viewport?.isLandscape??!1),l=a.leaf(e=>e.responsive[t].viewport?.isPortrait??!1),v=a.leaf(e=>e.responsive[t].breakpoints),d=a.leaf(e=>e.responsive[t].canvasPadding),f=a.leaf(e=>e.responsive[t].isExpanded),g=a.leaf(e=>e.responsive[t].isHidden),h=a.leaf(e=>e.responsive[t].isAnimating),m=a([o,n,v],(e,i,s)=>e&&i<s.sm),w=a([o,n,v],(e,i,s)=>e&&i<=s.md),c=a([o,n,v],(e,i,s)=>e&&i<s.lg&&i>s.sm),u=a([o,n,v],(e,i,s)=>e&&i>s.md),P=a([m,w,c,u,p,l,d,f,g,h],(e,i,s,t,a,o,n,r,p,l)=>({isPhone:e,isMobile:i,isTablet:s,isDesktop:t,isLandscape:a,isPortrait:o,canvasPadding:n,isExpanded:r,isHidden:p,isAnimating:l})),S=a([n,r],(e,i)=>({width:Math.ceil(e),height:Math.ceil(i)}));return{selectResponsiveState:P,selectViewportSize:S,selectCanvasPadding:d,getResponsiveState:()=>P(s()),getViewportSize:()=>S(s()),getCanvasPadding:()=>d(s())}};

package/dist/react-sdk/application-runtime/responsive/types.d.ts

@@ -0,0 +1,104 @@
+/**
+ * The part of the canvas, in pixels from each edge, that overlay UI covers. The camera frames the
+ * scene inside what is left, so the scene stays visible beside a sidebar or under a preview body.
+ *
+ * @internal Runtime plumbing for the SDK's own UI. A project layout uses `useActiveViewports()`
+ * from `@salsita-ai/sdk/react` and `useSceneSafeArea()` from `@salsita-ai/sdk/configurator`.
+ */
+export interface CanvasPadding {
+    readonly top: number;
+    readonly right: number;
+    readonly bottom: number;
+    readonly left: number;
+}
+/**
+ * The widths, in pixels, that split the application's root container into phone, tablet and
+ * desktop. The theme decides them; the UI library pushes its theme's values in with
+ * `setBreakpoints`.
+ *
+ * @internal Runtime plumbing for the SDK's own UI. A project layout uses `useActiveViewports()`
+ * from `@salsita-ai/sdk/react` and `useSceneSafeArea()` from `@salsita-ai/sdk/configurator`.
+ */
+export interface ResponsiveBreakpoints {
+    readonly sm: number;
+    readonly md: number;
+    readonly lg: number;
+}
+/**
+ * One measurement of the application's root container. The orientation comes from the window,
+ * not from the container's aspect ratio.
+ *
+ * @internal Runtime plumbing for the SDK's own UI. A project layout uses `useActiveViewports()`
+ * from `@salsita-ai/sdk/react` and `useSceneSafeArea()` from `@salsita-ai/sdk/configurator`.
+ */
+export interface ResponsiveViewport {
+    readonly width: number;
+    readonly height: number;
+    readonly isLandscape: boolean;
+    readonly isPortrait: boolean;
+}
+/**
+ * The size of the application's root container, rounded up to whole pixels.
+ *
+ * @internal Runtime plumbing for the SDK's own UI. A project layout uses `useActiveViewports()`
+ * from `@salsita-ai/sdk/react` and `useSceneSafeArea()` from `@salsita-ai/sdk/configurator`.
+ */
+export interface ResponsiveViewportSize {
+    readonly width: number;
+    readonly height: number;
+}
+/**
+ * The responsive state of one mounted application: what it measured of its root container, the
+ * breakpoints that classify it, the canvas padding the scene is framed with, and whether the
+ * container is expanded over the host page, hidden, or in a layout animation.
+ *
+ * The configurator's root container writes it while it is mounted and resets it when it unmounts.
+ *
+ * @internal Runtime plumbing for the SDK's own UI. A project layout uses `useActiveViewports()`
+ * from `@salsita-ai/sdk/react` and `useSceneSafeArea()` from `@salsita-ai/sdk/configurator`.
+ */
+export interface ResponsiveApplicationState {
+    /** `null` until the root container is measured for the first time. */
+    readonly viewport: ResponsiveViewport | null;
+    readonly breakpoints: ResponsiveBreakpoints;
+    readonly canvasPadding: CanvasPadding;
+    readonly isExpanded: boolean;
+    readonly isHidden: boolean;
+    readonly isAnimating: boolean;
+}
+/**
+ * The `responsive` slice, one entry per application: an admin that embeds a configurator runs both
+ * in one runtime, and each has its own root container.
+ *
+ * @internal Runtime plumbing for the SDK's own UI. A project layout uses `useActiveViewports()`
+ * from `@salsita-ai/sdk/react` and `useSceneSafeArea()` from `@salsita-ai/sdk/configurator`.
+ */
+export interface ResponsiveRuntimeState {
+    readonly configurator: ResponsiveApplicationState;
+    readonly admin: ResponsiveApplicationState;
+}
+/**
+ * The responsive state the UI and the lifecycle read: the size classes of the root container, the
+ * canvas padding, and whether the container is expanded, hidden or animating.
+ *
+ * Every size class is `false` until the container is measured for the first time.
+ *
+ * @internal Runtime plumbing for the SDK's own UI. A project layout uses `useActiveViewports()`
+ * from `@salsita-ai/sdk/react` and `useSceneSafeArea()` from `@salsita-ai/sdk/configurator`.
+ */
+export interface ResponsiveState {
+    /** `width < sm` */
+    readonly isPhone: boolean;
+    /** `width <= md` */
+    readonly isMobile: boolean;
+    /** `sm < width < lg` */
+    readonly isTablet: boolean;
+    /** `width > md` */
+    readonly isDesktop: boolean;
+    readonly isLandscape: boolean;
+    readonly isPortrait: boolean;
+    readonly canvasPadding: CanvasPadding;
+    readonly isExpanded: boolean;
+    readonly isHidden: boolean;
+    readonly isAnimating: boolean;
+}

package/dist/react-sdk/application-runtime/responsive/types.js

@@ -0,0 +1 @@
+export{};

package/dist/react-sdk/application-runtime/routing/routing-service.d.ts

@@ -17,11 +17,43 @@ interface RoutingServiceContext {
 }
 export declare class RoutingService {
     private readonly context;
-    private onGoToIndex;
-    private onNavigated;
+    private readonly onGoToIndexRegistrations;
+    private readonly onNavigatedRegistrations;
+    private unregisterSetOnGoToIndex;
+    private unregisterSetOnNavigated;
     constructor(context: RoutingServiceContext);
+    /**
+     * Registers the handler `goToIndex` calls instead of navigating; the handler navigates by calling
+     * `next`. The most recent registration is the active one. The returned function removes only this
+     * registration, so the one registered before it becomes active again.
+     * @internal Plumbing for `ConfiguratorRoutingProvider`; projects intercept `goToIndex` with
+     * `createOnGoToIndexHandler`.
+     */
+    registerOnGoToIndex: (handler: OnGoToIndexHandler) => (() => void);
+    /**
+     * Registers the callback told about each navigation `goToIndex` and `goToConfigurationDetail`
+     * make. The most recent registration is the active one, and it replaces the SDK's own reporting
+     * to the host (the `route` property, the configuration id in the URL and the `navigated` event)
+     * rather than listening beside it. The returned function removes only this registration, so the
+     * one registered before it becomes active again.
+     * @internal Plumbing for `ConfiguratorRoutingProvider`, which does that reporting.
+     */
+    registerOnNavigated: (handler: OnNavigatedHandler) => (() => void);
+    /**
+     * Replaces the handler this method registered before, on top of the other registrations; `null`
+     * removes it. Registrations made with `registerOnGoToIndex` stay.
+     * @deprecated Intercept `goToIndex` with a handler made by `createOnGoToIndexHandler` instead. This
+     * API will be removed in a future version.
+     */
     setOnGoToIndex: (handler: OnGoToIndexHandler | null) => void;
+    /**
+     * Replaces the callback this method registered before, on top of the other registrations; `null`
+     * removes it. Registrations made with `registerOnNavigated` stay.
+     * @deprecated Listen to the `navigated` event of the web component instead; a callback set here
+     * replaces the SDK's own reporting to the host. This API will be removed in a future version.
+     */
     setOnNavigated: (handler: OnNavigatedHandler | null) => void;
+    private notifyNavigated;
     routeTo: (routingState: RoutingState) => void;
     goToIndex: () => void;
     goToConfigurationDetail: (configurationId: string, accessToken?: string) => void;

package/dist/react-sdk/application-runtime/routing/routing-service.js

@@ -1 +1 @@
-import{InvalidAccessKeyError as t}from"#package/client";import{AnalyticsEventFactory as o,decodeAccessInfo as e}from"#package/domain";import{getAccessInfo as n,getAccessTokenFromLocalStorage as i,putAccessTokenToLocalStorage as s,removeAccessTokenFromLocalStorage as a}from"./access-service.js";import{ApplicationRoutes as c}from"./types.js";export class RoutingService{context;onGoToIndex=null;onNavigated=null;constructor(t){this.context=t}setOnGoToIndex=t=>{this.onGoToIndex=t};setOnNavigated=t=>{this.onNavigated=t};routeTo=t=>{var o;if(o=this.context.getRoutingState(),o.route===c.Index||t.route===c.Index?o.route===t.route:o.configurationId===t.configurationId&&o.accessToken===t.accessToken)return;if(this.context.loadedDataActions.resetConfiguratorLoad(),t.route===c.Index){this.context.accessActions.setConfiguratorAccessInfo(null),this.context.actions.setRoutingState(t);return}let e=n(t.configurationId,t.accessToken);this.context.accessActions.setConfiguratorAccessInfo(e),this.context.actions.setRoutingState(t),t.accessToken&&s(t.configurationId,t.accessToken)};goToIndex=()=>{let t=()=>{this.context.getAnalytics().push(o.NavigationEvent({navigationState:"productPage"})),this.context.getLogger().appendToGlobalContext({navigationState:"productPage"});let t={route:c.Index};this.routeTo(t),this.onNavigated?.(t)};null==this.onGoToIndex?t():this.onGoToIndex({next:t})};goToConfigurationDetail=(t,o)=>{let e={route:c.Configuration,configurationId:t,accessToken:o};this.routeTo(e),this.onNavigated?.(e)};rejectAccessToken=(t,o)=>{i(t)===o&&a(t)};requestAccessToken=(o,n)=>{if(null!==e(n,o))return n;let i=new t;throw this.rejectAccessToken(o,n),this.context.loadedDataActions.failConfiguratorLoad(i),i}}
+import{InvalidAccessKeyError as t}from"#package/client";import{AnalyticsEventFactory as e,decodeAccessInfo as o}from"#package/domain";import{getAccessInfo as n,getAccessTokenFromLocalStorage as i,putAccessTokenToLocalStorage as s,removeAccessTokenFromLocalStorage as a}from"./access-service.js";import{ApplicationRoutes as r}from"./types.js";let c=(t,e)=>{let o={handler:e};return t.push(o),()=>{let e=t.indexOf(o);-1!==e&&t.splice(e,1)}},g=t=>t.at(-1)?.handler??null;export class RoutingService{context;onGoToIndexRegistrations=[];onNavigatedRegistrations=[];unregisterSetOnGoToIndex=null;unregisterSetOnNavigated=null;constructor(t){this.context=t}registerOnGoToIndex=t=>c(this.onGoToIndexRegistrations,t);registerOnNavigated=t=>c(this.onNavigatedRegistrations,t);setOnGoToIndex=t=>{this.unregisterSetOnGoToIndex?.(),this.unregisterSetOnGoToIndex=null===t?null:this.registerOnGoToIndex(t)};setOnNavigated=t=>{this.unregisterSetOnNavigated?.(),this.unregisterSetOnNavigated=null===t?null:this.registerOnNavigated(t)};notifyNavigated=t=>{g(this.onNavigatedRegistrations)?.(t)};routeTo=t=>{var e;if(e=this.context.getRoutingState(),e.route===r.Index||t.route===r.Index?e.route===t.route:e.configurationId===t.configurationId&&e.accessToken===t.accessToken)return;if(this.context.loadedDataActions.resetConfiguratorLoad(),t.route===r.Index){this.context.accessActions.setConfiguratorAccessInfo(null),this.context.actions.setRoutingState(t);return}let o=n(t.configurationId,t.accessToken);this.context.accessActions.setConfiguratorAccessInfo(o),this.context.actions.setRoutingState(t),t.accessToken&&s(t.configurationId,t.accessToken)};goToIndex=()=>{let t=()=>{this.context.getAnalytics().push(e.NavigationEvent({navigationState:"productPage"})),this.context.getLogger().appendToGlobalContext({navigationState:"productPage"});let t={route:r.Index};this.routeTo(t),this.notifyNavigated(t)},o=g(this.onGoToIndexRegistrations);null==o?t():o({next:t})};goToConfigurationDetail=(t,e)=>{let o={route:r.Configuration,configurationId:t,accessToken:e};this.routeTo(o),this.notifyNavigated(o)};rejectAccessToken=(t,e)=>{i(t)===e&&a(t)};requestAccessToken=(e,n)=>{if(null!==o(n,e))return n;let i=new t;throw this.rejectAccessToken(e,n),this.context.loadedDataActions.failConfiguratorLoad(i),i}}