@salsita-ai/sdk 0.50.0-develop.ca72986c39 → 0.50.0-develop.d08a6c0e83

package/dist/react-sdk/handlers/use-finalize-action.js

@@ -0,0 +1 @@
+import{useMutation as r}from"@tanstack/react-query";import{useCallback as t,useRef as e}from"react";import{FrontendAnalyticsFactory as n,useAnalyticsService as i,useLogger as a}from"../application-runtime/index.js";import{useFinalizeViolations as o}from"../domain-context/index.js";import{usePhoenixHandler as c}from"./PhoenixHandler.js";export const useFinalizeAction=s=>{let{handler:l}=c(s),m=i(),u=a(),{disabled:f,hints:d}=o(),h=e(!1),{mutateAsync:p,isPending:w,error:y}=r({mutationFn:async()=>{try{await l()}catch(r){throw r instanceof Error?r:Error(null==r?"The finalize handler failed without a reason.":String(r),{cause:r})}finally{h.current=!1}},onError:r=>{u.error("Failed to finalize",{error:r.message})}});return{run:t(async()=>{if(!f&&!h.current){h.current=!0,m.push(n.FinalizeButtonClicked());try{await p()}catch{}await new Promise(r=>setTimeout(r,0))}},[m,f,p]),isPending:w,error:y,disabled:f,hints:d}};

package/dist/react-sdk/handlers/use-finalize-actions.d.ts

@@ -0,0 +1,53 @@
+import { type FinalizeActionComponentState } from '#package/domain';
+/**
+ * One active `finalizeAction` of the spec, ready to render and run.
+ * - `key`: the stable key of the component instance, for React's `key`.
+ * - `handler`: the name of the project handler the action runs.
+ * - `variant`, `label`, `title` and `icon`: the component's fields, `label` and `title` resolved to the current
+ *   language; `icon` is a `PhxIcon` name.
+ * - `run`: pushes the finalize-button analytics event and runs the handler, as `useFinalizeAction(handler).run`
+ *   does. It does nothing while `disabled` or `isPending`. The promise it returns never rejects: it resolves once
+ *   the entry shows the outcome of the run, or at once when the run does nothing.
+ * - `isPending`: the handler is running.
+ * - `error`: what the handler's last run rejected with, as an `Error`, or `null`; cleared when the action runs
+ *   again. It is also the error the handler threw while it was loaded, when it could not be loaded at all.
+ * - `disabled`: finalizing is blocked, as in `useFinalizeViolations()`, or the handler could not be loaded.
+ */
+export interface FinalizeActionEntry {
+    readonly key: string;
+    readonly handler: string;
+    readonly variant: FinalizeActionComponentState['variant'];
+    readonly label: string;
+    readonly title: string;
+    readonly icon: string;
+    readonly run: () => Promise<void>;
+    readonly isPending: boolean;
+    readonly error: Error | null;
+    readonly disabled: boolean;
+}
+/**
+ * The spec's finalize actions for a layout.
+ * - `actions`: every active `finalizeAction` component, in spec order.
+ * - `primary`: the first `'primary'` action, else the first action, else `null`; the built-in footer's button.
+ * - `secondary`: the other actions, in spec order; the built-in footer's menu.
+ * - `disabled` and `hints`: those of `useFinalizeViolations()`.
+ */
+export interface UseFinalizeActionsResult {
+    readonly actions: readonly FinalizeActionEntry[];
+    readonly primary: FinalizeActionEntry | null;
+    readonly secondary: readonly FinalizeActionEntry[];
+    readonly disabled: boolean;
+    readonly hints: string | undefined;
+}
+export type UseFinalizeActions = () => UseFinalizeActionsResult;
+/**
+ * The spec's finalize actions, each with its own `run`, for a layout that renders its own finalize buttons. The
+ * configurator runs the handlers itself, so a layout calls this hook anywhere, as often as it likes, and renders
+ * the entries in a loop. To run a single action the layout already knows, `useFinalizeAction(handler)` works too.
+ *
+ * It needs the configurator's `FinalizeActionsProvider` and `FinalizeActionsHost`, which are mounted around and
+ * beside every configurator layout, and also reach the dialogs a layout opens with `useModal`. Outside them it
+ * returns no actions and logs a warning. It does not check read mode; a layout hides finalization for a
+ * viewer.
+ */
+export declare const useFinalizeActions: UseFinalizeActions;

package/dist/react-sdk/handlers/use-finalize-actions.js

@@ -0,0 +1 @@
+import{useContext as e,useEffect as i,useMemo as t,useSyncExternalStore as r}from"react";import{finalizeActionComponent as n,getComponentSnapshotKey as o}from"#package/domain";import{useLogger as a}from"../application-runtime/index.js";import{useComponents as s,useFinalizeViolations as l}from"../domain-context/index.js";import{useResolveLocalizable as u}from"../localizable/index.js";import{FinalizeActionsContext as d}from"./finalize-actions-context.js";let m=()=>Promise.resolve(),p=new Map,c=()=>()=>{},f=()=>p;export const useFinalizeActions=()=>{let p=e(d),g=r(p?.subscribe??c,p?.getSnapshot??f),b=s({componentTypes:[n]}),{disabled:y,hints:x}=l(),z=u(),j=a(),h=null!==p;return i(()=>{h||j.warn("useFinalizeActions() is used outside the configurator layout and its dialogs, so it returns no finalize actions. Call it inside a ConfiguratorLayout element or a dialog it opens.")},[h,j]),t(()=>{if(!h)return{actions:[],primary:null,secondary:[],disabled:y,hints:x};let e=b.map(e=>{let i=o(e),{variant:t,label:r,title:n,icon:a,handler:s}=e.state,l=g.get(i),u={key:i,handler:s,variant:t,label:z(r),title:z(n),icon:a};if(l?.status==="ready"){let{run:e,isPending:i,error:t,disabled:r}=l.action;return{...u,run:e,isPending:i,error:t,disabled:r}}return{...u,run:m,isPending:!1,error:l?.status==="failed"?l.error:null,disabled:!0}}),i=e.find(e=>"primary"===e.variant)??e[0]??null,t=e.filter(e=>e!==i);return{actions:e,primary:i,secondary:t,disabled:y,hints:x}},[b,y,h,x,z,g])};

package/dist/react-sdk/index.d.ts

@@ -9,5 +9,7 @@ export * from './web-component/index.js';
 export * from './localizable/index.js';
 export * from './loading-state/index.js';
 export * from './elements/index.js';
+export * from './scene-control-elements/index.js';
+export * from './page-elements/index.js';
 export * from './handlers/index.js';
 export * from './application-runtime/index.js';

package/dist/react-sdk/index.js

@@ -1 +1 @@
-export*from"./theme/index.js";export*from"./utils/index.js";export*from"./session/index.js";export*from"./domain-context/index.js";export*from"./domain-application-context/index.js";export*from"./domain-controls/index.js";export*from"./invalid-deployment/index.js";export*from"./web-component/index.js";export*from"./localizable/index.js";export*from"./loading-state/index.js";export*from"./elements/index.js";export*from"./handlers/index.js";export*from"./application-runtime/index.js";
+export*from"./theme/index.js";export*from"./utils/index.js";export*from"./session/index.js";export*from"./domain-context/index.js";export*from"./domain-application-context/index.js";export*from"./domain-controls/index.js";export*from"./invalid-deployment/index.js";export*from"./web-component/index.js";export*from"./localizable/index.js";export*from"./loading-state/index.js";export*from"./elements/index.js";export*from"./scene-control-elements/index.js";export*from"./page-elements/index.js";export*from"./handlers/index.js";export*from"./application-runtime/index.js";

package/dist/react-sdk/loading-state/LoaderHost.d.ts

@@ -0,0 +1,20 @@
+import type { ReactNode } from 'react';
+/**
+ * Hosts the application's loader: the loading hooks below it report to the runtime's `loading`
+ * slice, and the SDK's own UI below it leaves its inline loaders out (`useIsLoaderHosted()`). The
+ * configurator mounts the one host, inside its `ApplicationTypeProvider`, while it is powered on.
+ *
+ * It resets the slice when it mounts and not again while it stays mounted, so the loading state
+ * starts over at power-on and on remount, and only there.
+ *
+ * Its children mount once the reset is done, so their first render and their first phases already
+ * see the host, and the reset cannot wipe phases they started. The host resets in a layout effect
+ * and then sets local state, which React renders synchronously before the browser paints, whatever
+ * the lane of the first render. StrictMode repeats that layout effect before the children mount, so
+ * the second reset wipes nothing either.
+ *
+ * @internal Runtime plumbing for the SDK's own UI.
+ */
+export declare const LoaderHost: ({ children }: {
+    readonly children: ReactNode;
+}) => import("react/jsx-runtime").JSX.Element | null;

package/dist/react-sdk/loading-state/LoaderHost.js

@@ -0,0 +1 @@
+import{jsx as o}from"react/jsx-runtime";import{useLayoutEffect as r,useState as i}from"react";import{LoaderHostContext as t,useLoadingApplication as e}from"../application-runtime/index.js";export const LoaderHost=({children:n})=>{let a=e(),[p,d]=i(!1);if(null===a)throw Error("LoaderHost has no application whose loader it could host: it is mounted outside an ApplicationRuntimeProvider or an ApplicationTypeProvider. Render LoaderHost inside both an ApplicationRuntimeProvider and an ApplicationTypeProvider, as ConfiguratorApp does.");return(r(()=>{a.actions.resetSlot(),d(!0)},[a]),p)?o(t.Provider,{value:!0,children:n}):null};

package/dist/react-sdk/loading-state/built-in-loading-phase.d.ts

@@ -0,0 +1,9 @@
+/** The ids of the loading phases the SDK reports itself. A project reports its own under other ids. */
+export declare enum BuiltInLoadingPhase {
+    SessionAuth = "session-auth",
+    PublishedData = "published-data",
+    FrontendData = "frontend-data",
+    BackendData = "backend-data",
+    DataFetch = "data-fetch",
+    SceneAssets = "scene-assets"
+}

package/dist/react-sdk/loading-state/built-in-loading-phase.js

@@ -0,0 +1 @@
+var a;export var BuiltInLoadingPhase=((a={}).SessionAuth="session-auth",a.PublishedData="published-data",a.FrontendData="frontend-data",a.BackendData="backend-data",a.DataFetch="data-fetch",a.SceneAssets="scene-assets",a);

package/dist/react-sdk/loading-state/create-app-loader.d.ts

@@ -0,0 +1,18 @@
+import { type PhoenixLayoutElementRegistration } from '#package/domain';
+import type { LoadingPhase } from '../application-runtime/index.js';
+/**
+ * The name a project registers a layout element under to replace what the app loader overlay shows.
+ * Its default, the built-in loader content, is registered in `defaultConfiguratorElements`.
+ */
+export declare const AppLoaderContentName = "AppLoaderContent";
+/** The props of the content a project registers with `createAppLoader`. */
+export interface AppLoaderContentProps {
+    /** The loading phases running now; empty while the loader waits for the scene to start loading. */
+    readonly phases: readonly LoadingPhase[];
+}
+/**
+ * Registers a project's app loader content as the `AppLoaderContent` element. The SDK keeps the
+ * overlay, its place over the scene's safe area and its fade-in; the component is only what it shows.
+ */
+export declare const createAppLoader: (Element: (props: AppLoaderContentProps) => JSX.Element) => readonly PhoenixLayoutElementRegistration[];
+export type CreateAppLoader = (Element: (props: AppLoaderContentProps) => JSX.Element) => readonly PhoenixLayoutElementRegistration[];

package/dist/react-sdk/loading-state/create-app-loader.js

@@ -0,0 +1 @@
+import{jsx as o}from"react/jsx-runtime";import{createCustomPhoenixLayoutElement as t}from"#package/domain";import{useLoadingStateValue as e}from"./loading-state-hooks.js";export const AppLoaderContentName="AppLoaderContent";export const createAppLoader=r=>[t("AppLoaderContent",()=>{let{phases:t}=e();return o(r,{phases:t})})];

package/dist/react-sdk/loading-state/index.d.ts

@@ -1,2 +1,4 @@
-export { BuiltInLoadingPhase, type LoadingPhase, type LoadingState, LoadingStateManager, } from './loading-state-manager.js';
-export { LoadingStateProvider, useLoadingState, type UseLoadingState, useLoadingStateManager, useLoadingStateValue, useLoadingPhase, useExpectPhase, useLoadingError, } from './LoadingStateProvider.js';
+export { BuiltInLoadingPhase } from './built-in-loading-phase.js';
+export { LoaderHost } from './LoaderHost.js';
+export { useLoadingState, type UseLoadingState, useLoadingStateValue, useLoadingPhase, useExpectPhase, useLoadingError, } from './loading-state-hooks.js';
+export { AppLoaderContentName, type AppLoaderContentProps, createAppLoader, type CreateAppLoader, } from './create-app-loader.js';

package/dist/react-sdk/loading-state/index.js

@@ -1 +1 @@
-export{BuiltInLoadingPhase,LoadingStateManager}from"./loading-state-manager.js";export{LoadingStateProvider,useLoadingState,useLoadingStateManager,useLoadingStateValue,useLoadingPhase,useExpectPhase,useLoadingError}from"./LoadingStateProvider.js";
+export{BuiltInLoadingPhase}from"./built-in-loading-phase.js";export{LoaderHost}from"./LoaderHost.js";export{useLoadingState,useLoadingStateValue,useLoadingPhase,useExpectPhase,useLoadingError}from"./loading-state-hooks.js";export{AppLoaderContentName,createAppLoader}from"./create-app-loader.js";

package/dist/react-sdk/loading-state/{LoadingStateProvider.d.ts → loading-state-hooks.d.ts}

@@ -1,22 +1,13 @@
-import type { ReactNode } from 'react';
-import { type LoadingPhase, type LoadingState, LoadingStateManager } from './loading-state-manager.js';
-export declare const LoadingStateProvider: ({ children }: {
-    readonly children: ReactNode;
-}) => import("react/jsx-runtime").JSX.Element;
-/**
- * Returns the loading state manager if available.
- * Returns `null` when used outside of `LoadingStateProvider` (e.g. in admin app).
- */
-export declare const useLoadingStateManager: () => LoadingStateManager | null;
+import { type LoadingPhase, type LoadingState } from '../application-runtime/index.js';
 /**
  * Subscribe to the current aggregated loading state.
- * Returns the default (not loading) state when used outside of `LoadingStateProvider`.
+ * Returns the default (not loading) state outside the application's loader host.
  */
 export declare const useLoadingStateValue: () => LoadingState;
 export type UseLoadingState = typeof useLoadingState;
 /**
  * Returns loading phase control functions.
- * Returns `null` when used outside of `LoadingStateProvider`.
+ * Returns `null` outside the application's loader host.
  */
 export declare const useLoadingState: () => {
     startPhase: (phase: LoadingPhase) => void;

package/dist/react-sdk/loading-state/loading-state-hooks.js

@@ -0,0 +1 @@
+import{useEffect as e,useMemo as t,useRef as r,useSyncExternalStore as n}from"react";import{useIsLoaderHosted as s,useLoadingActions as a,useLoadingApplication as o,useOptionalApplicationRuntime as u}from"../application-runtime/index.js";let c={isLoading:!1,hasError:!1,phases:[],expectedPhaseIds:new Set},l=()=>c,i=()=>()=>{};export const useLoadingStateValue=()=>{let e=o(),t=s(),r=u(),a=n(r?.subscribe??i,e?.selectors.getLoadingState??l);return t?a:c};export const useLoadingState=()=>{let e=a();return t(()=>e?{startPhase:e.startPhase,endPhase:e.endPhase}:null,[e])};export const useLoadingPhase=(t,n)=>{let s=a(),o=r(t);o.current=t;let u=r(null);e(()=>{if(s)return n?(u.current=o.current.id,s.startPhase(o.current)):null!==u.current&&(s.endPhase(u.current),u.current=null),()=>{null!==u.current&&(s.endPhase(u.current),u.current=null)}},[s,n,t.id])};export const useExpectPhase=t=>{let r=a();e(()=>{if(r)return r.expectPhase(t),()=>{r.dropExpectation(t)}},[r,t])};export const useLoadingError=t=>{let r=a();e(()=>{r&&t&&r.reportError()},[r,t])};

package/dist/react-sdk/page-elements/ConfigurationNotFoundPagePropsProvider.d.ts

@@ -0,0 +1,17 @@
+import { type PropsWithChildren } from 'react';
+import type { ConfigurationNotFoundPageProps } from '../session/index.js';
+interface ConfigurationNotFoundPagePropsProviderProps extends PropsWithChildren {
+    readonly value: ConfigurationNotFoundPageProps;
+}
+/**
+ * @internal Runtime plumbing behind `createConfigurationNotFoundPage`, for the SDK's own UI. The
+ * configurator's renderer of the `ConfigurationNotFoundPage` element provides the page's props through
+ * it, because an element slot is typed as taking only `children`.
+ */
+export declare const ConfigurationNotFoundPagePropsProvider: (props: ConfigurationNotFoundPagePropsProviderProps) => import("react/jsx-runtime").JSX.Element;
+/**
+ * @internal Exists for the SDK's own UI and for `createConfigurationNotFoundPage`, which read the
+ * props of the `ConfigurationNotFoundPage` element through it.
+ */
+export declare const useConfigurationNotFoundPageProps: () => ConfigurationNotFoundPageProps;
+export {};

package/dist/react-sdk/page-elements/ConfigurationNotFoundPagePropsProvider.js

@@ -0,0 +1 @@
+import{jsx as o}from"react/jsx-runtime";import{createContext as r,useContext as t}from"react";let e=r({});export const ConfigurationNotFoundPagePropsProvider=r=>{let{value:t,children:n}=r;return o(e.Provider,{value:t,children:n})};export const useConfigurationNotFoundPageProps=()=>t(e);

package/dist/react-sdk/page-elements/ConfiguratorErrorPagePropsProvider.d.ts

@@ -0,0 +1,17 @@
+import { type PropsWithChildren } from 'react';
+import type { ConfiguratorErrorPageProps } from './configurator-error-page-props.js';
+interface ConfiguratorErrorPagePropsProviderProps extends PropsWithChildren {
+    readonly value: ConfiguratorErrorPageProps;
+}
+/**
+ * @internal Runtime plumbing behind `createConfiguratorErrorPage`, for the SDK's own UI. The
+ * configurator's renderer of the `ConfiguratorErrorPage` element provides the page's props through it,
+ * because an element slot is typed as taking only `children`.
+ */
+export declare const ConfiguratorErrorPagePropsProvider: (props: ConfiguratorErrorPagePropsProviderProps) => import("react/jsx-runtime").JSX.Element;
+/**
+ * @internal Exists for the SDK's own UI and for `createConfiguratorErrorPage`, which read the props
+ * of the `ConfiguratorErrorPage` element through it.
+ */
+export declare const useConfiguratorErrorPageProps: () => ConfiguratorErrorPageProps;
+export {};

package/dist/react-sdk/page-elements/ConfiguratorErrorPagePropsProvider.js

@@ -0,0 +1 @@
+import{jsx as r}from"react/jsx-runtime";import{createContext as e,useContext as o}from"react";let t=e(void 0);export const ConfiguratorErrorPagePropsProvider=e=>{let{value:o,children:i}=e;return r(t.Provider,{value:o,children:i})};export const useConfiguratorErrorPageProps=()=>{let r=o(t);if(void 0===r)throw Error("The ConfiguratorErrorPage element was rendered without its props. Only the configurator renders this element, inside ConfiguratorErrorPagePropsProvider; render the element through the configurator instead of mounting it directly.");return r};

package/dist/react-sdk/page-elements/configurator-error-page-props.d.ts

@@ -0,0 +1,20 @@
+/**
+ * Why the configurator shows its error page:
+ * - `uncaughtError`: rendering the configurator failed with an error nothing else handled;
+ * - `presetCreationFailed`: starting a configuration from a preset failed on a start screen that has
+ *   no preset grid to return to (a single preset).
+ */
+export type ConfiguratorErrorReason = 'uncaughtError' | 'presetCreationFailed';
+/**
+ * The props of the `ConfiguratorErrorPage` element, the page the configurator shows in production
+ * when it cannot go on; a project registers its page with `createConfiguratorErrorPage`. In
+ * development the configurator shows its detailed error pages instead.
+ */
+export interface ConfiguratorErrorPageProps {
+    readonly reason: ConfiguratorErrorReason;
+    /**
+     * Tries again: after an `uncaughtError` it renders the configurator again, after
+     * `presetCreationFailed` it reloads the page.
+     */
+    readonly onRetry: () => void;
+}

package/dist/react-sdk/page-elements/configurator-error-page-props.js

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

package/dist/react-sdk/page-elements/create-configuration-not-found-page.d.ts

@@ -0,0 +1,15 @@
+import { type PhoenixLayoutElementRegistration } from '#package/domain';
+import type { ConfigurationNotFoundPageProps } from '../session/index.js';
+/**
+ * The name a project registers a layout element under to replace the page shown when a configuration
+ * cannot be loaded or opened. Its default, the built-in `ConfigurationNotFoundPage`, is registered in
+ * `defaultConfiguratorElements`.
+ */
+export declare const ConfigurationNotFoundPageName = "ConfigurationNotFoundPage";
+/**
+ * Registers a project's "configuration not accessible" page as the `ConfigurationNotFoundPage`
+ * element, with its props typed. Registering a layout element under that name with
+ * `createCustomPhoenixLayoutElement` works too, but its component is typed as taking only `children`.
+ */
+export declare const createConfigurationNotFoundPage: (Element: (props: ConfigurationNotFoundPageProps) => JSX.Element) => PhoenixLayoutElementRegistration;
+export type CreateConfigurationNotFoundPage = (Element: (props: ConfigurationNotFoundPageProps) => JSX.Element) => PhoenixLayoutElementRegistration;

package/dist/react-sdk/page-elements/create-configuration-not-found-page.js

@@ -0,0 +1 @@
+import{jsx as o}from"react/jsx-runtime";import{createCustomPhoenixLayoutElement as t}from"#package/domain";import{useConfigurationNotFoundPageProps as n}from"./ConfigurationNotFoundPagePropsProvider.js";export const ConfigurationNotFoundPageName="ConfigurationNotFoundPage";export const createConfigurationNotFoundPage=r=>t("ConfigurationNotFoundPage",()=>o(r,{...n()}));

package/dist/react-sdk/page-elements/create-configurator-error-page.d.ts

@@ -0,0 +1,14 @@
+import { type PhoenixLayoutElementRegistration } from '#package/domain';
+import type { ConfiguratorErrorPageProps } from './configurator-error-page-props.js';
+/**
+ * The name a project registers a layout element under to replace the configurator's production error
+ * page. Its default, the built-in error page, is registered in `defaultConfiguratorElements`.
+ */
+export declare const ConfiguratorErrorPageName = "ConfiguratorErrorPage";
+/**
+ * Registers a project's production error page as the `ConfiguratorErrorPage` element, with its props
+ * typed. Registering a layout element under that name with `createCustomPhoenixLayoutElement` works
+ * too, but its component is typed as taking only `children`.
+ */
+export declare const createConfiguratorErrorPage: (Element: (props: ConfiguratorErrorPageProps) => JSX.Element) => PhoenixLayoutElementRegistration;
+export type CreateConfiguratorErrorPage = (Element: (props: ConfiguratorErrorPageProps) => JSX.Element) => PhoenixLayoutElementRegistration;

package/dist/react-sdk/page-elements/create-configurator-error-page.js

@@ -0,0 +1 @@
+import{jsx as r}from"react/jsx-runtime";import{createCustomPhoenixLayoutElement as o}from"#package/domain";import{useConfiguratorErrorPageProps as a}from"./ConfiguratorErrorPagePropsProvider.js";export const ConfiguratorErrorPageName="ConfiguratorErrorPage";export const createConfiguratorErrorPage=t=>o("ConfiguratorErrorPage",()=>r(t,{...a()}));

package/dist/react-sdk/page-elements/create-preset-ui.d.ts

@@ -0,0 +1,9 @@
+import { type PhoenixLayoutElementRegistration } from '#package/domain';
+/**
+ * The name a project registers a layout element under to replace the whole preset screen. Its
+ * default, the built-in preset screen, is registered in `defaultConfiguratorElements`.
+ */
+export declare const PresetUiName = "PresetUi";
+/** Registers a project's preset screen as the `PresetUi` element. */
+export declare const createPresetUi: (Element: () => JSX.Element) => PhoenixLayoutElementRegistration;
+export type CreatePresetUi = (Element: () => JSX.Element) => PhoenixLayoutElementRegistration;

package/dist/react-sdk/page-elements/create-preset-ui.js

@@ -0,0 +1 @@
+import{createCustomPhoenixLayoutElement as e}from"#package/domain";export const PresetUiName="PresetUi";export const createPresetUi=t=>e("PresetUi",t);

package/dist/react-sdk/page-elements/index.d.ts

@@ -0,0 +1,6 @@
+export type { ConfiguratorErrorPageProps, ConfiguratorErrorReason } from './configurator-error-page-props.js';
+export { ConfiguratorErrorPagePropsProvider, useConfiguratorErrorPageProps, } from './ConfiguratorErrorPagePropsProvider.js';
+export { ConfiguratorErrorPageName, createConfiguratorErrorPage, type CreateConfiguratorErrorPage, } from './create-configurator-error-page.js';
+export { ConfigurationNotFoundPagePropsProvider, useConfigurationNotFoundPageProps, } from './ConfigurationNotFoundPagePropsProvider.js';
+export { ConfigurationNotFoundPageName, createConfigurationNotFoundPage, type CreateConfigurationNotFoundPage, } from './create-configuration-not-found-page.js';
+export { PresetUiName, createPresetUi, type CreatePresetUi } from './create-preset-ui.js';

package/dist/react-sdk/page-elements/index.js

@@ -0,0 +1 @@
+export{ConfiguratorErrorPagePropsProvider,useConfiguratorErrorPageProps}from"./ConfiguratorErrorPagePropsProvider.js";export{ConfiguratorErrorPageName,createConfiguratorErrorPage}from"./create-configurator-error-page.js";export{ConfigurationNotFoundPagePropsProvider,useConfigurationNotFoundPageProps}from"./ConfigurationNotFoundPagePropsProvider.js";export{ConfigurationNotFoundPageName,createConfigurationNotFoundPage}from"./create-configuration-not-found-page.js";export{PresetUiName,createPresetUi}from"./create-preset-ui.js";

package/dist/react-sdk/scene-control-elements/AddEntityFabElement.d.ts

@@ -0,0 +1,36 @@
+import type { Localizable } from '@salsita-ai/common/utils';
+import type { DomainEntityId } from '#package/domain';
+import type { SceneControlTooltipVisibility } from './scene-control-tooltip-visibility.js';
+/**
+ * The name of the entity element that renders a `sceneEntityAddFab`. Its default, the built-in
+ * add-entity FAB, is registered in `defaultConfiguratorElements`.
+ */
+export declare const AddEntityFabName = "AddEntityFab";
+/**
+ * Props of the `AddEntityFab` element, rendered for each `sceneEntityAddFab` of an entity, at the
+ * position the component sets. The recipes it can add are not computed up front: the built-in FAB
+ * reads them with `useGroupedRecipeOptions(entityId, instanceNames, fixableViolations)` when it
+ * opens its menu, and a replacement does the same.
+ */
+export interface AddEntityFabElementProps {
+    /** The entity the FAB adds children to. */
+    readonly entityId: DomainEntityId<string>;
+    /** The `childEntityRecipes` instances whose recipes the FAB offers; all of them when not set. */
+    readonly instanceNames?: readonly string[];
+    /** Violations a new entity may cause without disabling its recipe (the component's `hiddenViolations`). */
+    readonly fixableViolations?: readonly string[];
+    /** The name of a Phoenix icon. */
+    readonly icon?: string;
+    /** A visible text label. */
+    readonly label?: Localizable;
+    /** The tooltip text. */
+    readonly title?: Localizable;
+    /** When the tooltip shows: `on-hover` unless the component sets it. */
+    readonly tooltipVisibility: SceneControlTooltipVisibility;
+    /** Add the only recipe directly, without a menu. */
+    readonly skipMenuWhenOnlyOne?: boolean;
+    /** Render nothing when there is no recipe. */
+    readonly hideWhenNone?: boolean;
+}
+/** Renders the `AddEntityFab` element for an entity. */
+export declare const AddEntityFabElement: import("react").MemoExoticComponent<(props: AddEntityFabElementProps) => import("react/jsx-runtime").JSX.Element>;

package/dist/react-sdk/scene-control-elements/AddEntityFabElement.js

@@ -0,0 +1 @@
+import{jsx as t}from"react/jsx-runtime";import{memo as e,useMemo as n}from"react";import{PhoenixEntityElementWithChildren as r}from"../elements/index.js";export const AddEntityFabName="AddEntityFab";export const AddEntityFabElement=e(e=>{let{entityId:d,instanceNames:i,fixableViolations:m,icon:o,label:a,title:s,tooltipVisibility:p,skipMenuWhenOnlyOne:x,hideWhenNone:y}=e,E=n(()=>({instanceNames:i,fixableViolations:m,icon:o,label:a,title:s,tooltipVisibility:p,skipMenuWhenOnlyOne:x,hideWhenNone:y}),[i,m,o,a,s,p,x,y]);return t(r,{kind:"AddEntityFab",entityId:d,elementProps:E})});

package/dist/react-sdk/scene-control-elements/DeleteEntityFabElement.d.ts

@@ -0,0 +1,44 @@
+import { type SyntheticEvent } from 'react';
+import type { Localizable } from '@salsita-ai/common/utils';
+import type { DomainEntityId } from '#package/domain';
+import type { SceneControlTooltipVisibility } from './scene-control-tooltip-visibility.js';
+/**
+ * The name of the entity element that renders a `sceneEntityDeleteFab`. Its default, the built-in
+ * delete-entity FAB, is registered in `defaultConfiguratorElements`.
+ */
+export declare const DeleteEntityFabName = "DeleteEntityFab";
+/**
+ * Props of the `DeleteEntityFab` element, rendered for each `sceneEntityDeleteFab` of an entity, at
+ * the position the component sets.
+ */
+export interface DeleteEntityFabElementProps {
+    /** The entity the FAB deletes. */
+    readonly entityId: DomainEntityId<string>;
+    /** The name of a Phoenix icon. */
+    readonly icon?: string;
+    /** A visible text label. */
+    readonly label?: Localizable;
+    /** The tooltip text. */
+    readonly title?: Localizable;
+    /** When the tooltip shows: `on-hover` unless the component sets it. */
+    readonly tooltipVisibility: SceneControlTooltipVisibility;
+    /**
+     * Deletes the entity and pushes the delete analytics event. Pass it straight to `onClick`: given
+     * an event, it stops the event's propagation so the click does not reach the scene.
+     */
+    readonly onDelete: (event?: SyntheticEvent) => void;
+    /** True when deleting would cause a violation the component does not allow. */
+    readonly disabled: boolean;
+    /** Why deleting is disabled, when it is. */
+    readonly disabledHint: string | undefined;
+    /** Logs the dry run of the deletion to the console, for debugging. */
+    readonly trace: () => void;
+}
+type DeleteEntityFabElementConfig = Omit<DeleteEntityFabElementProps, 'onDelete' | 'disabled' | 'disabledHint' | 'trace'>;
+interface Props extends DeleteEntityFabElementConfig {
+    /** Violations deleting may cause without disabling the FAB (the component's `hiddenViolations`). */
+    readonly fixableViolations?: readonly string[];
+}
+/** Renders the `DeleteEntityFab` element for an entity, with the deletion it performs. */
+export declare const DeleteEntityFabElement: import("react").MemoExoticComponent<(props: Props) => import("react/jsx-runtime").JSX.Element>;
+export {};

package/dist/react-sdk/scene-control-elements/DeleteEntityFabElement.js

@@ -0,0 +1 @@
+import{jsx as t}from"react/jsx-runtime";import{memo as e,useCallback as i,useMemo as o}from"react";import{FrontendAnalyticsFactory as n}from"../application-runtime/index.js";import{useDeletedEntity as r}from"../domain-controls/index.js";import{PhoenixEntityElementWithChildren as m}from"../elements/index.js";export const DeleteEntityFabName="DeleteEntityFab";export const DeleteEntityFabElement=e(e=>{let{entityId:a,fixableViolations:s,icon:l,label:p,title:d,tooltipVisibility:c}=e,x=i(()=>n.EntityDeleteHotspotClicked(a),[a]),{disabled:y,hints:E,remove:b,trace:f}=r(a,s,x),j=i(t=>{t?.stopPropagation(),b()},[b]),D=o(()=>({icon:l,label:p,title:d,tooltipVisibility:c,onDelete:j,disabled:y,disabledHint:E,trace:f}),[l,p,d,c,j,y,E,f]);return t(m,{kind:"DeleteEntityFab",entityId:a,elementProps:D})});

package/dist/react-sdk/scene-control-elements/NavigationHotspotElement.d.ts

@@ -0,0 +1,38 @@
+import { type SyntheticEvent } from 'react';
+import type { Localizable } from '@salsita-ai/common/utils';
+import type { DomainEntityId } from '#package/domain';
+import type { SceneControlTooltipVisibility } from './scene-control-tooltip-visibility.js';
+/**
+ * The name of the entity element that renders a `sceneEntityNavigationHotspot`. Its default, the
+ * built-in navigation hotspot, is registered in `defaultConfiguratorElements`.
+ */
+export declare const NavigationHotspotName = "NavigationHotspot";
+/**
+ * Props of the `NavigationHotspot` element, rendered for each `sceneEntityNavigationHotspot` of an
+ * entity, at the position the component sets.
+ */
+export interface NavigationHotspotElementProps {
+    /** The entity the hotspot is attached to. */
+    readonly entityId: DomainEntityId<string>;
+    /** The navigation state the hotspot goes to. */
+    readonly navigationState: string;
+    /** The tooltip text. */
+    readonly title?: Localizable;
+    /** When the tooltip shows: `on-hover` unless the component sets it. */
+    readonly tooltipVisibility: SceneControlTooltipVisibility;
+    /**
+     * Goes to `navigationState`, pushed onto the navigation stack or replacing the current state as
+     * the component sets. Pass it straight to `onClick`: given an event, it prevents the event's
+     * default and stops its propagation so the click does not reach the scene.
+     */
+    readonly onNavigate: (event?: SyntheticEvent) => void;
+}
+interface Props extends Omit<NavigationHotspotElementProps, 'onNavigate'> {
+    /** Push `navigationState` onto the navigation stack instead of replacing the current state. */
+    readonly pushToStack?: boolean;
+    /** The states `navigationState` can be stacked onto. */
+    readonly canStackOnto?: readonly string[];
+}
+/** Renders the `NavigationHotspot` element for an entity, with the navigation it performs. */
+export declare const NavigationHotspotElement: import("react").MemoExoticComponent<(props: Props) => import("react/jsx-runtime").JSX.Element>;
+export {};

package/dist/react-sdk/scene-control-elements/NavigationHotspotElement.js

@@ -0,0 +1 @@
+import{jsx as t}from"react/jsx-runtime";import{memo as e,useCallback as o,useMemo as a}from"react";import{useDomain as i}from"../domain-context/index.js";import{PhoenixEntityElementWithChildren as n}from"../elements/index.js";export const NavigationHotspotName="NavigationHotspot";export const NavigationHotspotElement=e(e=>{let{entityId:s,navigationState:m,pushToStack:r,canStackOnto:p,title:g,tooltipVisibility:d}=e,{navigationSystem:l,storeSystem:v}=i(),c=o(t=>{t?.preventDefault(),t?.stopPropagation();let e=r?l.getPushNavigationUpdate(m,v.stateSlices.committed.value.state,{canStackOnto:p}):l.getNavigationUpdate(m);v.stageAndCommit([e])},[l,m,r,v,p]);return t(n,{kind:"NavigationHotspot",entityId:s,elementProps:a(()=>({navigationState:m,title:g,tooltipVisibility:d,onNavigate:c}),[m,g,d,c])})});

package/dist/react-sdk/scene-control-elements/SelectionHotspotElement.d.ts

@@ -0,0 +1,30 @@
+import { type SyntheticEvent } from 'react';
+import type { Localizable } from '@salsita-ai/common/utils';
+import type { DomainEntityId } from '#package/domain';
+import type { SceneControlTooltipVisibility } from './scene-control-tooltip-visibility.js';
+/**
+ * The name of the entity element that renders a `sceneEntitySelectHotspot`. Its default, the
+ * built-in selection hotspot, is registered in `defaultConfiguratorElements`.
+ */
+export declare const SelectionHotspotName = "SelectionHotspot";
+/**
+ * Props of the `SelectionHotspot` element, rendered for each `sceneEntitySelectHotspot` of an
+ * entity, at the position the component sets.
+ */
+export interface SelectionHotspotElementProps {
+    /** The entity the hotspot selects. */
+    readonly entityId: DomainEntityId<string>;
+    /** The tooltip text. */
+    readonly title?: Localizable;
+    /** When the tooltip shows: `on-hover` unless the component sets it. */
+    readonly tooltipVisibility: SceneControlTooltipVisibility;
+    /**
+     * Selects the entity and pushes the selection-hotspot analytics event. Pass it straight to
+     * `onClick`: given an event, it stops the event's propagation so the click does not reach the scene.
+     */
+    readonly onSelect: (event?: SyntheticEvent) => void;
+}
+type Props = Omit<SelectionHotspotElementProps, 'onSelect'>;
+/** Renders the `SelectionHotspot` element for an entity, with the selection it performs. */
+export declare const SelectionHotspotElement: import("react").MemoExoticComponent<(props: Props) => import("react/jsx-runtime").JSX.Element>;
+export {};

package/dist/react-sdk/scene-control-elements/SelectionHotspotElement.js

@@ -0,0 +1 @@
+import{jsx as t}from"react/jsx-runtime";import{memo as o,useCallback as e,useMemo as i}from"react";import{FrontendAnalyticsFactory as n}from"../application-runtime/index.js";import{useSelectEntity as r}from"../domain-context/index.js";import{PhoenixEntityElementWithChildren as m}from"../elements/index.js";export const SelectionHotspotName="SelectionHotspot";export const SelectionHotspotElement=o(o=>{let{entityId:p,title:s,tooltipVisibility:c}=o,l=r(n.SelectionHotspotClicked),a=e(t=>{t?.stopPropagation(),l(p)},[p,l]);return t(m,{kind:"SelectionHotspot",entityId:p,elementProps:i(()=>({title:s,tooltipVisibility:c,onSelect:a}),[s,c,a])})});

package/dist/react-sdk/scene-control-elements/ToolMenuFabElement.d.ts

@@ -0,0 +1,30 @@
+import type { Localizable } from '@salsita-ai/common/utils';
+import type { DomainEntityId, ToolMenuFabOption } from '#package/domain';
+import type { SceneControlTooltipVisibility } from './scene-control-tooltip-visibility.js';
+/**
+ * The name of the entity element that renders a `toolMenuFab`. Its default, the built-in tool-menu
+ * FAB, is registered in `defaultConfiguratorElements`.
+ */
+export declare const ToolMenuFabName = "ToolMenuFab";
+/**
+ * Props of the `ToolMenuFab` element, rendered for each `toolMenuFab` of an entity, at the position
+ * the component sets.
+ */
+export interface ToolMenuFabElementProps {
+    /** The entity the FAB is attached to. */
+    readonly entityId: DomainEntityId<string>;
+    /** The tools the menu offers, each with its `label`, optional `icon` and `toolState`. */
+    readonly options: readonly ToolMenuFabOption[];
+    /** The name of a Phoenix icon; the built-in FAB shows `PencilSimpleBold` when it is not set. */
+    readonly icon?: string;
+    /** The tooltip text, which the built-in menu also shows as its heading. */
+    readonly title?: Localizable;
+    /** When the tooltip shows: `on-hover` unless the component sets it. */
+    readonly tooltipVisibility: SceneControlTooltipVisibility;
+    /** Switches to the given tool state, the `toolState` of one of the `options`. */
+    readonly onSelectTool: (toolState: string) => void;
+}
+type Props = Omit<ToolMenuFabElementProps, 'onSelectTool'>;
+/** Renders the `ToolMenuFab` element for an entity, with the tool switch it performs. */
+export declare const ToolMenuFabElement: import("react").MemoExoticComponent<(props: Props) => import("react/jsx-runtime").JSX.Element>;
+export {};

package/dist/react-sdk/scene-control-elements/ToolMenuFabElement.js

@@ -0,0 +1 @@
+import{jsx as e}from"react/jsx-runtime";import{memo as o,useCallback as t,useMemo as n}from"react";import{useDomain as m}from"../domain-context/index.js";import{PhoenixEntityElementWithChildren as r}from"../elements/index.js";export const ToolMenuFabName="ToolMenuFab";export const ToolMenuFabElement=o(o=>{let{entityId:a,options:i,icon:s,title:l,tooltipVisibility:p}=o,{navigationSystem:d,storeSystem:x}=m(),u=t(e=>{x.stageAndCommit([d.getToolUpdate(e)])},[d,x]);return e(r,{kind:"ToolMenuFab",entityId:a,elementProps:n(()=>({options:i,icon:s,title:l,tooltipVisibility:p,onSelectTool:u}),[i,s,l,p,u])})});

package/dist/react-sdk/scene-control-elements/create-add-entity-fab.d.ts

@@ -0,0 +1,9 @@
+import { type PhoenixEntityElementRegistration } from '#package/domain';
+import { type AddEntityFabElementProps } from './AddEntityFabElement.js';
+/**
+ * Registers a project's add-entity FAB as the `AddEntityFab` entity element, with its props typed.
+ * Registering an entity element under that name with `createCustomPhoenixEntityElement` works too,
+ * but its component is then typed as taking only `entityId` and `children`.
+ */
+export declare const createAddEntityFab: (Element: (props: AddEntityFabElementProps) => JSX.Element | null) => PhoenixEntityElementRegistration;
+export type CreateAddEntityFab = (Element: (props: AddEntityFabElementProps) => JSX.Element | null) => PhoenixEntityElementRegistration;

package/dist/react-sdk/scene-control-elements/create-add-entity-fab.js

@@ -0,0 +1 @@
+import{createCustomPhoenixEntityElement as t}from"#package/domain";import{AddEntityFabName as o}from"./AddEntityFabElement.js";export const createAddEntityFab=a=>t(o,a);

package/dist/react-sdk/scene-control-elements/create-delete-entity-fab.d.ts

@@ -0,0 +1,9 @@
+import { type PhoenixEntityElementRegistration } from '#package/domain';
+import { type DeleteEntityFabElementProps } from './DeleteEntityFabElement.js';
+/**
+ * Registers a project's delete-entity FAB as the `DeleteEntityFab` entity element, with its props
+ * typed. Registering an entity element under that name with `createCustomPhoenixEntityElement`
+ * works too, but its component is then typed as taking only `entityId` and `children`.
+ */
+export declare const createDeleteEntityFab: (Element: (props: DeleteEntityFabElementProps) => JSX.Element | null) => PhoenixEntityElementRegistration;
+export type CreateDeleteEntityFab = (Element: (props: DeleteEntityFabElementProps) => JSX.Element | null) => PhoenixEntityElementRegistration;

package/dist/react-sdk/scene-control-elements/create-delete-entity-fab.js

@@ -0,0 +1 @@
+import{createCustomPhoenixEntityElement as e}from"#package/domain";import{DeleteEntityFabName as t}from"./DeleteEntityFabElement.js";export const createDeleteEntityFab=o=>e(t,o);

package/dist/react-sdk/scene-control-elements/create-navigation-hotspot.d.ts

@@ -0,0 +1,10 @@
+import { type PhoenixEntityElementRegistration } from '#package/domain';
+import { type NavigationHotspotElementProps } from './NavigationHotspotElement.js';
+/**
+ * Registers a project's navigation hotspot as the `NavigationHotspot` entity element, with its
+ * props typed. Registering an entity element under that name with
+ * `createCustomPhoenixEntityElement` works too, but its component is then typed as taking only
+ * `entityId` and `children`.
+ */
+export declare const createNavigationHotspot: (Element: (props: NavigationHotspotElementProps) => JSX.Element | null) => PhoenixEntityElementRegistration;
+export type CreateNavigationHotspot = (Element: (props: NavigationHotspotElementProps) => JSX.Element | null) => PhoenixEntityElementRegistration;

package/dist/react-sdk/scene-control-elements/create-navigation-hotspot.js

@@ -0,0 +1 @@
+import{createCustomPhoenixEntityElement as o}from"#package/domain";import{NavigationHotspotName as t}from"./NavigationHotspotElement.js";export const createNavigationHotspot=a=>o(t,a);

package/dist/react-sdk/scene-control-elements/create-selection-hotspot.d.ts

@@ -0,0 +1,9 @@
+import { type PhoenixEntityElementRegistration } from '#package/domain';
+import { type SelectionHotspotElementProps } from './SelectionHotspotElement.js';
+/**
+ * Registers a project's selection hotspot as the `SelectionHotspot` entity element, with its props
+ * typed. Registering an entity element under that name with `createCustomPhoenixEntityElement`
+ * works too, but its component is then typed as taking only `entityId` and `children`.
+ */
+export declare const createSelectionHotspot: (Element: (props: SelectionHotspotElementProps) => JSX.Element | null) => PhoenixEntityElementRegistration;
+export type CreateSelectionHotspot = (Element: (props: SelectionHotspotElementProps) => JSX.Element | null) => PhoenixEntityElementRegistration;

package/dist/react-sdk/scene-control-elements/create-selection-hotspot.js

@@ -0,0 +1 @@
+import{createCustomPhoenixEntityElement as o}from"#package/domain";import{SelectionHotspotName as t}from"./SelectionHotspotElement.js";export const createSelectionHotspot=e=>o(t,e);

package/dist/react-sdk/scene-control-elements/create-tool-menu-fab.d.ts

@@ -0,0 +1,9 @@
+import { type PhoenixEntityElementRegistration } from '#package/domain';
+import { type ToolMenuFabElementProps } from './ToolMenuFabElement.js';
+/**
+ * Registers a project's tool-menu FAB as the `ToolMenuFab` entity element, with its props typed.
+ * Registering an entity element under that name with `createCustomPhoenixEntityElement` works too,
+ * but its component is then typed as taking only `entityId` and `children`.
+ */
+export declare const createToolMenuFab: (Element: (props: ToolMenuFabElementProps) => JSX.Element | null) => PhoenixEntityElementRegistration;
+export type CreateToolMenuFab = (Element: (props: ToolMenuFabElementProps) => JSX.Element | null) => PhoenixEntityElementRegistration;