@salsita-ai/sdk 0.50.0-develop.70dc8d05b6 → 0.50.0-develop.780177b115

package/dist/react-sdk/handlers/FinalizeActionRunner.d.ts

@@ -0,0 +1,13 @@
+import type { FinalizeActionsStore } from './finalize-actions-store.js';
+interface FinalizeActionRunnerProps {
+    /** The component key of the `finalizeAction` the runner runs */
+    readonly actionKey: string;
+    readonly handler: string;
+    readonly store: FinalizeActionsStore;
+}
+/**
+ * The hidden runner of one `finalizeAction`. `PhoenixHandlerBoundary` remounts it, its error boundary included,
+ * when the handler's source changes, so an edited or fixed handler takes effect without a reload.
+ */
+export declare const FinalizeActionRunner: (props: FinalizeActionRunnerProps) => import("react/jsx-runtime").JSX.Element;
+export {};

package/dist/react-sdk/handlers/FinalizeActionRunner.js

@@ -0,0 +1 @@
+import{jsx as r}from"react/jsx-runtime";import{useLayoutEffect as e}from"react";import{ErrorBoundary as n}from"react-error-boundary";import{useLogger as i}from"../application-runtime/index.js";import{PhoenixHandlerBoundary as o}from"./PhoenixHandlerBoundary.js";import{useFinalizeAction as a}from"./use-finalize-action.js";let t=({actionKey:r,handler:n,store:i})=>{let o=a(n);return e(()=>{i.publish(r,{status:"ready",action:o})}),e(()=>()=>i.remove(r),[r,i]),null},l=({actionKey:r,handler:n,store:o,error:a})=>{let t=i();return e(()=>{let e=a instanceof Error?a:Error(String(a??"The finalize handler failed."),{cause:a});return t.error(`The finalize handler "${n}" failed to load, so its finalize action cannot run.`,{error:e.message}),o.publish(r,{status:"failed",error:e}),()=>o.remove(r)},[r,a,n,t,o]),null};export const FinalizeActionRunner=e=>r(o,{name:e.handler,children:r(n,{fallbackRender:({error:n})=>r(l,{...e,error:n}),children:r(t,{...e})})});

package/dist/react-sdk/handlers/FinalizeActionsHost.d.ts

@@ -0,0 +1,10 @@
+/**
+ * Runs the spec's finalize actions for `useFinalizeActions()`. For every active `finalizeAction` component it
+ * mounts a hidden runner, which calls `useFinalizeAction` with the component's handler and publishes its state into
+ * the enclosing `FinalizeActionsProvider`. It renders nothing.
+ *
+ * The configurator mounts it once beside the configurator layout, inside its `ModalProvider`, so a handler can use
+ * `useModal`; a project does not mount it. The handlers' hooks run here, outside the layout, so a handler uses only
+ * what the configurator provides above its layout.
+ */
+export declare const FinalizeActionsHost: () => import("react/jsx-runtime").JSX.Element | null;

package/dist/react-sdk/handlers/FinalizeActionsHost.js

@@ -0,0 +1 @@
+import{jsx as n,Fragment as i}from"react/jsx-runtime";import{useContext as t,useEffect as o}from"react";import{finalizeActionComponent as e,getComponentSnapshotKey as r}from"#package/domain";import{useLogger as a}from"../application-runtime/index.js";import{useComponents as s}from"../domain-context/index.js";import{FinalizeActionRunner as m}from"./FinalizeActionRunner.js";import{FinalizeActionsContext as l}from"./finalize-actions-context.js";export const FinalizeActionsHost=()=>{let c=t(l),p=s({componentTypes:[e]}),u=a(),d=null!==c;return(o(()=>{d||u.warn("FinalizeActionsHost is mounted outside a FinalizeActionsProvider, so it runs no finalize actions.")},[d,u]),null===c)?null:n(i,{children:p.map(i=>{let t=r(i);return n(m,{actionKey:t,handler:i.state.handler,store:c},t)})})};

package/dist/react-sdk/handlers/FinalizeActionsProvider.d.ts

@@ -0,0 +1,11 @@
+import { type ReactNode } from 'react';
+/**
+ * Holds the state of the spec's finalize actions for `useFinalizeActions()` in its children; the runners of
+ * `FinalizeActionsHost`, mounted somewhere inside it, publish into it.
+ *
+ * The configurator mounts it once above its `ModalProvider`, so a dialog a layout opens with `useModal` sees the
+ * actions too; a project does not mount it.
+ */
+export declare const FinalizeActionsProvider: ({ children }: {
+    readonly children: ReactNode;
+}) => import("react/jsx-runtime").JSX.Element;

package/dist/react-sdk/handlers/FinalizeActionsProvider.js

@@ -0,0 +1 @@
+import{jsx as r}from"react/jsx-runtime";import{useState as i}from"react";import{FinalizeActionsContext as o}from"./finalize-actions-context.js";import{createFinalizeActionsStore as t}from"./finalize-actions-store.js";export const FinalizeActionsProvider=({children:e})=>{let[n]=i(t);return r(o.Provider,{value:n,children:e})};

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

@@ -0,0 +1,6 @@
+import type { FinalizeActionsStore } from './finalize-actions-store.js';
+/**
+ * The store of the enclosing `FinalizeActionsProvider`, or `null` outside one. The built-in finalize buttons read
+ * the outcome of a run from it, which outlives the button; a layout uses `useFinalizeActions()` instead.
+ */
+export declare const FinalizeActionsContext: import("react").Context<FinalizeActionsStore | null>;

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

@@ -0,0 +1 @@
+import{createContext as t}from"react";export const FinalizeActionsContext=t(null);

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

@@ -0,0 +1,23 @@
+import type { UseFinalizeActionResult } from './use-finalize-action.js';
+/**
+ * What the hidden runner of one `finalizeAction` publishes: the state of its `useFinalizeAction` call, or the error
+ * its handler threw while it was resolved, in which case the action cannot run.
+ */
+export type FinalizeActionRunnerState = {
+    readonly status: 'ready';
+    readonly action: UseFinalizeActionResult;
+} | {
+    readonly status: 'failed';
+    readonly error: Error;
+};
+/**
+ * The runner states of the active `finalizeAction` components, by component key. `FinalizeActionsProvider` owns
+ * one; the runners of `FinalizeActionsHost` publish into it and `useFinalizeActions()` reads it.
+ */
+export interface FinalizeActionsStore {
+    readonly subscribe: (listener: () => void) => () => void;
+    readonly getSnapshot: () => ReadonlyMap<string, FinalizeActionRunnerState>;
+    readonly publish: (key: string, state: FinalizeActionRunnerState) => void;
+    readonly remove: (key: string) => void;
+}
+export declare const createFinalizeActionsStore: () => FinalizeActionsStore;

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

@@ -0,0 +1 @@
+export const createFinalizeActionsStore=()=>{let t=new Map,e=new Set,a=a=>{t=a,e.forEach(t=>t())};return{subscribe:t=>(e.add(t),()=>{e.delete(t)}),getSnapshot:()=>t,publish:(e,i)=>{var n;n=t.get(e),(void 0===n||n.status!==i.status||("failed"===n.status||"failed"===i.status?"failed"!==n.status||"failed"!==i.status||n.error!==i.error:n.action.run!==i.action.run||n.action.isPending!==i.action.isPending||n.action.error!==i.action.error||n.action.disabled!==i.action.disabled||n.action.hints!==i.action.hints))&&a(new Map(t).set(e,i))},remove:e=>{if(!t.has(e))return;let i=new Map(t);i.delete(e),a(i)}}};

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

@@ -1,2 +1,8 @@
 export { usePhoenixHandler, useSystemPhoenixHandler, useSystemPhoenixAsyncHandler } from './PhoenixHandler.js';
 export { PhoenixHandlerBoundary } from './PhoenixHandlerBoundary.js';
+export { type UseFinalizeAction, type UseFinalizeActionResult, useFinalizeAction } from './use-finalize-action.js';
+export { FinalizeActionsHost } from './FinalizeActionsHost.js';
+export { FinalizeActionsProvider } from './FinalizeActionsProvider.js';
+export { FinalizeActionsContext } from './finalize-actions-context.js';
+export { type FinalizeActionRunnerState, type FinalizeActionsStore } from './finalize-actions-store.js';
+export { type FinalizeActionEntry, type UseFinalizeActions, type UseFinalizeActionsResult, useFinalizeActions, } from './use-finalize-actions.js';

package/dist/react-sdk/handlers/index.js

@@ -1 +1 @@
-export{usePhoenixHandler,useSystemPhoenixHandler,useSystemPhoenixAsyncHandler}from"./PhoenixHandler.js";export{PhoenixHandlerBoundary}from"./PhoenixHandlerBoundary.js";
+export{usePhoenixHandler,useSystemPhoenixHandler,useSystemPhoenixAsyncHandler}from"./PhoenixHandler.js";export{PhoenixHandlerBoundary}from"./PhoenixHandlerBoundary.js";export{useFinalizeAction}from"./use-finalize-action.js";export{FinalizeActionsHost}from"./FinalizeActionsHost.js";export{FinalizeActionsProvider}from"./FinalizeActionsProvider.js";export{FinalizeActionsContext}from"./finalize-actions-context.js";export{useFinalizeActions}from"./use-finalize-actions.js";

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

@@ -0,0 +1,32 @@
+/**
+ * What a project layout needs to show and run one `finalizeAction` of the spec.
+ * - `run`: pushes the finalize-button analytics event, then runs the action's handler. Does nothing while
+ *   `disabled` or `isPending`. The promise it returns never rejects: it resolves after the handler has settled and
+ *   React has had the chance to render the outcome, or at once when the run does nothing; a failure is `error`.
+ * - `isPending`: the handler is running.
+ * - `error`: what the handler's last run rejected with, `null` after a run that resolved and while a new run is
+ *   pending. A rejection that is not an `Error` is wrapped in one, with the rejected value as its `cause`. No snackbar
+ *   is raised; the layout shows it its own way.
+ * - `disabled` and `hints`: from `useFinalizeViolations()`; the configuration cannot be finalized while it has
+ *   a `warning` or worse, or while it is out of sync with the server, and `hints` says why.
+ *
+ * `isPending` and `error` belong to the mounted component: when it unmounts during a run, the handler keeps
+ * running, and a component mounted afterwards starts with `isPending` false and no `error`.
+ */
+export interface UseFinalizeActionResult {
+    readonly run: () => Promise<void>;
+    readonly isPending: boolean;
+    readonly error: Error | null;
+    readonly disabled: boolean;
+    readonly hints: string | undefined;
+}
+export type UseFinalizeAction = (handler: string) => UseFinalizeActionResult;
+/**
+ * Runs the project handler a `finalizeAction` component names, with the state a finalize button shows.
+ *
+ * It calls `usePhoenixHandler(handler)`, which calls the project's handler factory and the hooks inside it, so:
+ * call it once per component, never in a loop or conditionally, render one component per action, and wrap that
+ * component in `<PhoenixHandlerBoundary name={handler}>` from `@salsita-ai/sdk/react`, so an edited handler takes
+ * effect without a reload. It does not check read mode; a layout hides finalization for a viewer.
+ */
+export declare const useFinalizeAction: UseFinalizeAction;

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

@@ -8,6 +8,8 @@ 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 './responsive-state/index.js';
 export * from './elements/index.js';
+export * from './scene-control-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"./responsive-state/index.js";export*from"./elements/index.js";export*from"./scene-control-elements/index.js";export*from"./handlers/index.js";export*from"./application-runtime/index.js";

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

@@ -22,10 +22,15 @@ export declare class LoadingStateManager {
     private readonly _phases$;
     private readonly _hasError$;
     private readonly _expectedPhases$;
+    private readonly _expectationCounts;
     readonly startPhase: (phase: LoadingPhase) => void;
     readonly endPhase: (id: string) => void;
     readonly reportError: () => void;
     readonly clearError: () => void;
+    /**
+     * Marks a phase as expected before it starts. Expectations are counted: the phase stays expected
+     * until every `expectPhase` call for it has been matched by a `dropExpectation`.
+     */
     readonly expectPhase: (id: string) => void;
     readonly dropExpectation: (id: string) => void;
     readonly state$: Observable<LoadingState>;

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

@@ -1 +1 @@
-var e;import{BehaviorSubject as s,combineLatest as a,distinctUntilChanged as t,map as h}from"rxjs";export var BuiltInLoadingPhase=((e={}).SessionAuth="session-auth",e.PublishedData="published-data",e.FrontendData="frontend-data",e.BackendData="backend-data",e.DataFetch="data-fetch",e.SceneAssets="scene-assets",e);export class LoadingStateManager{_phases$=new s(new Map);_hasError$=new s(!1);_expectedPhases$=new s(new Set);startPhase=e=>{let s=new Map(this._phases$.value);s.set(e.id,e),this._phases$.next(s)};endPhase=e=>{let s=this._phases$.value;if(!s.has(e))return;let a=new Map(s);a.delete(e),this._phases$.next(a)};reportError=()=>{this._hasError$.next(!0)};clearError=()=>{this._hasError$.next(!1)};expectPhase=e=>{let s=new Set(this._expectedPhases$.value);s.add(e),this._expectedPhases$.next(s)};dropExpectation=e=>{let s=this._expectedPhases$.value;if(!s.has(e))return;let a=new Set(s);a.delete(e),this._expectedPhases$.next(a)};state$=a([this._phases$,this._hasError$,this._expectedPhases$]).pipe(h(([e,s,a])=>{let t;return{isLoading:(t=Array.from(e.values())).length>0,hasError:s,phases:t,expectedPhaseIds:a}}),t((e,s)=>e.isLoading===s.isLoading&&e.hasError===s.hasError&&e.expectedPhaseIds===s.expectedPhaseIds&&e.phases.length===s.phases.length&&e.phases.every((e,a)=>e.id===s.phases[a]?.id&&e.progress===s.phases[a]?.progress&&e.label===s.phases[a]?.label)))}
+var e;import{BehaviorSubject as s,combineLatest as t,distinctUntilChanged as a,map as h}from"rxjs";export var BuiltInLoadingPhase=((e={}).SessionAuth="session-auth",e.PublishedData="published-data",e.FrontendData="frontend-data",e.BackendData="backend-data",e.DataFetch="data-fetch",e.SceneAssets="scene-assets",e);export class LoadingStateManager{_phases$=new s(new Map);_hasError$=new s(!1);_expectedPhases$=new s(new Set);_expectationCounts=new Map;startPhase=e=>{let s=new Map(this._phases$.value);s.set(e.id,e),this._phases$.next(s)};endPhase=e=>{let s=this._phases$.value;if(!s.has(e))return;let t=new Map(s);t.delete(e),this._phases$.next(t)};reportError=()=>{this._hasError$.next(!0)};clearError=()=>{this._hasError$.next(!1)};expectPhase=e=>{let s=this._expectationCounts.get(e)??0;if(this._expectationCounts.set(e,s+1),s>0)return;let t=new Set(this._expectedPhases$.value);t.add(e),this._expectedPhases$.next(t)};dropExpectation=e=>{let s=this._expectationCounts.get(e);if(void 0===s)return;if(s>1)return void this._expectationCounts.set(e,s-1);this._expectationCounts.delete(e);let t=new Set(this._expectedPhases$.value);t.delete(e),this._expectedPhases$.next(t)};state$=t([this._phases$,this._hasError$,this._expectedPhases$]).pipe(h(([e,s,t])=>{let a;return{isLoading:(a=Array.from(e.values())).length>0,hasError:s,phases:a,expectedPhaseIds:t}}),a((e,s)=>e.isLoading===s.isLoading&&e.hasError===s.hasError&&e.expectedPhaseIds===s.expectedPhaseIds&&e.phases.length===s.phases.length&&e.phases.every((e,t)=>e.id===s.phases[t]?.id&&e.progress===s.phases[t]?.progress&&e.label===s.phases[t]?.label)))}

package/dist/react-sdk/responsive-state/ResponsiveStateProvider.d.ts

@@ -0,0 +1,25 @@
+import { type ReactNode } from 'react';
+import type { ResponsiveStateManager } from './responsive-state-manager.js';
+export declare const ResponsiveStateContext: import("react").Context<ResponsiveStateManager | null>;
+/**
+ * The props of `ResponsiveStateProvider`.
+ *
+ * @internal Runtime plumbing behind `useResponsiveState`, 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 ResponsiveStateProviderProps {
+    readonly children: ReactNode;
+    /** The responsive state of the application mounted inside. One per mounted application. */
+    readonly manager: ResponsiveStateManager;
+}
+/**
+ * Provides the responsive state of one mounted application to the lifecycle and UI inside it.
+ * Each mounted application has its own, because each has its own root container: an admin that
+ * embeds a configurator runs both in one application runtime.
+ *
+ * @internal Exists for the SDK's own UI, which reaches the runtime's responsive state through it.
+ * A project layout does not use it: it uses `useActiveViewports()` from `@salsita-ai/sdk/react`
+ * and `useSceneSafeArea()` from `@salsita-ai/sdk/configurator`.
+ */
+export declare const ResponsiveStateProvider: (props: ResponsiveStateProviderProps) => import("react/jsx-runtime").JSX.Element;

package/dist/react-sdk/responsive-state/ResponsiveStateProvider.js

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

package/dist/react-sdk/responsive-state/canvas-padding.d.ts

@@ -0,0 +1,14 @@
+/**
+ * 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 behind `useResponsiveState`, 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;
+}

package/dist/react-sdk/responsive-state/canvas-padding.js

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

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

@@ -0,0 +1,5 @@
+export { type CanvasPadding } from './canvas-padding.js';
+export { type ResponsiveBreakpoints, type ResponsiveState, ResponsiveStateManager, type ResponsiveStateManagerOptions, type ResponsiveViewport, } from './responsive-state-manager.js';
+export { ResponsiveStateProvider, type ResponsiveStateProviderProps } from './ResponsiveStateProvider.js';
+export { useResponsiveState } from './use-responsive-state.js';
+export { useResponsiveStateManager } from './use-responsive-state-manager.js';

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

@@ -0,0 +1 @@
+export{ResponsiveStateManager}from"./responsive-state-manager.js";export{ResponsiveStateProvider}from"./ResponsiveStateProvider.js";export{useResponsiveState}from"./use-responsive-state.js";export{useResponsiveStateManager}from"./use-responsive-state-manager.js";

package/dist/react-sdk/responsive-state/responsive-state-manager.d.ts

@@ -0,0 +1,111 @@
+import { BehaviorSubject, type Observable } from 'rxjs';
+import type { CanvasPadding } from './canvas-padding.js';
+/**
+ * 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 behind `useResponsiveState`, 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 behind `useResponsiveState`, 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 responsive state of one mounted application: the size classes of its root container, the
+ * canvas padding the scene is framed with, and whether the container is expanded over the host
+ * page, hidden, or in a layout animation.
+ *
+ * Every size class is `false` until the container is measured for the first time.
+ *
+ * @internal Runtime plumbing behind `useResponsiveState`, 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;
+}
+/**
+ * How a `ResponsiveStateManager` starts.
+ *
+ * @internal Runtime plumbing behind `useResponsiveState`, 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 ResponsiveStateManagerOptions {
+    /** A measurement to start from, for a test or a host that knows its size up front. */
+    readonly viewport?: ResponsiveViewport;
+    /** Defaults to the Phoenix theme's breakpoints: 480, 768 and 1024. */
+    readonly breakpoints?: ResponsiveBreakpoints;
+}
+/**
+ * Holds the responsive state of one mounted application, without any UI: the UI measures its root
+ * container into it and reads it back, and the lifecycle (preview, viewport sync, the loader) reads
+ * and sets it through `useResponsiveState` and `useResponsiveStateManager`. A test sets a fixed
+ * viewport with `setViewport` and renders no UI at all.
+ *
+ * `state$` emits only when a value in `ResponsiveState` changes; a resize within one size class
+ * reaches `viewport$` alone.
+ *
+ * @internal Exists for the SDK's own UI, which reaches the runtime's responsive state through it.
+ * A project layout does not use it: it uses `useActiveViewports()` from `@salsita-ai/sdk/react`
+ * and `useSceneSafeArea()` from `@salsita-ai/sdk/configurator`.
+ */
+export declare class ResponsiveStateManager {
+    private _viewport;
+    private _breakpoints;
+    private readonly _state$;
+    /** The measured size of the root container, rounded up to whole pixels. */
+    readonly viewport$: BehaviorSubject<{
+        width: number;
+        height: number;
+    }>;
+    readonly state$: Observable<ResponsiveState>;
+    constructor(options?: ResponsiveStateManagerOptions);
+    private readonly update;
+    readonly getState: () => ResponsiveState;
+    readonly setViewport: (viewport: ResponsiveViewport) => void;
+    readonly setBreakpoints: (breakpoints: ResponsiveBreakpoints) => void;
+    readonly getCanvasPadding: () => CanvasPadding;
+    readonly setCanvasPadding: (canvasPadding: CanvasPadding) => void;
+    /** Lays the root container over the host page. */
+    readonly expand: () => void;
+    readonly collapse: () => void;
+    readonly hide: () => void;
+    readonly show: () => void;
+    /**
+     * Whether a layout animation is in flight, so the root container clips the transient overflow
+     * of motion FLIP transforms instead of flashing scrollbars on the host page.
+     */
+    readonly setAnimating: (isAnimating: boolean) => void;
+}

package/dist/react-sdk/responsive-state/responsive-state-manager.js

@@ -0,0 +1 @@
+import{BehaviorSubject as t}from"rxjs";let i={sm:480,md:768,lg:1024},s={top:0,right:0,bottom:0,left:0},e={isPhone:!1,isMobile:!1,isTablet:!1,isDesktop:!1,isLandscape:!1,isPortrait:!1},a=(t,i)=>{if(!t)return e;let{width:s}=t;return{isPhone:s<i.sm,isMobile:s<=i.md,isTablet:s<i.lg&&s>i.sm,isDesktop:s>i.md,isLandscape:t.isLandscape,isPortrait:t.isPortrait}};export class ResponsiveStateManager{_viewport;_breakpoints;_state$;viewport$;state$;constructor(e={}){this._viewport=e.viewport??null,this._breakpoints=e.breakpoints??i,this.viewport$=new t({width:Math.ceil(this._viewport?.width??0),height:Math.ceil(this._viewport?.height??0)}),this._state$=new t({...a(this._viewport,this._breakpoints),canvasPadding:s,isExpanded:!1,isHidden:!1,isAnimating:!1}),this.state$=this._state$.asObservable()}update=t=>{let i=this._state$.value,s={...i,...a(this._viewport,this._breakpoints),...t};(i.isPhone!==s.isPhone||i.isMobile!==s.isMobile||i.isTablet!==s.isTablet||i.isDesktop!==s.isDesktop||i.isLandscape!==s.isLandscape||i.isPortrait!==s.isPortrait||i.isExpanded!==s.isExpanded||i.isHidden!==s.isHidden||i.isAnimating!==s.isAnimating||i.canvasPadding.top!==s.canvasPadding.top||i.canvasPadding.right!==s.canvasPadding.right||i.canvasPadding.bottom!==s.canvasPadding.bottom||i.canvasPadding.left!==s.canvasPadding.left)&&this._state$.next(s)};getState=()=>this._state$.value;setViewport=t=>{this._viewport=t,this.update({}),this.viewport$.next({width:Math.ceil(t.width),height:Math.ceil(t.height)})};setBreakpoints=t=>{this._breakpoints=t,this.update({})};getCanvasPadding=()=>this._state$.value.canvasPadding;setCanvasPadding=t=>{this.update({canvasPadding:t})};expand=()=>{this.update({isExpanded:!0})};collapse=()=>{this.update({isExpanded:!1})};hide=()=>{this.update({isHidden:!0})};show=()=>{this.update({isHidden:!1})};setAnimating=t=>{this.update({isAnimating:t})}}

package/dist/react-sdk/responsive-state/use-responsive-state-manager.d.ts

@@ -0,0 +1,10 @@
+import type { ResponsiveStateManager } from './responsive-state-manager.js';
+/**
+ * The responsive state manager of the application this component is mounted in, to set canvas
+ * padding, expand or hide the root container, or read the state without subscribing to it.
+ *
+ * @internal Exists for the SDK's own UI, which reaches the runtime's responsive state through it.
+ * A project layout does not use it: it uses `useActiveViewports()` from `@salsita-ai/sdk/react`
+ * and `useSceneSafeArea()` from `@salsita-ai/sdk/configurator`.
+ */
+export declare const useResponsiveStateManager: () => ResponsiveStateManager;

package/dist/react-sdk/responsive-state/use-responsive-state-manager.js

@@ -0,0 +1 @@
+import{useContext as e}from"react";import{ResponsiveStateContext as t}from"./ResponsiveStateProvider.js";export const useResponsiveStateManager=()=>{let o=e(t);if(!o)throw Error("useResponsiveStateManager() found no responsive state: it is used outside a ResponsiveStateProvider. Use it inside a mounted Phoenix application, or wrap a test in <ResponsiveStateProvider manager={new ResponsiveStateManager()}>.");return o};

package/dist/react-sdk/responsive-state/use-responsive-state.d.ts

@@ -0,0 +1,11 @@
+import type { ResponsiveState } from './responsive-state-manager.js';
+/**
+ * The responsive state of the application this component is mounted in: the size classes of its
+ * root container, the canvas padding, and whether the container is expanded, hidden or animating.
+ * Re-renders when any of them changes.
+ *
+ * @internal Exists for the SDK's own UI, which reaches the runtime's responsive state through it.
+ * A project layout does not use it: it uses `useActiveViewports()` from `@salsita-ai/sdk/react`
+ * and `useSceneSafeArea()` from `@salsita-ai/sdk/configurator`.
+ */
+export declare const useResponsiveState: () => ResponsiveState;

package/dist/react-sdk/responsive-state/use-responsive-state.js

@@ -0,0 +1 @@
+import{useCallback as e,useSyncExternalStore as t}from"react";import{useResponsiveStateManager as r}from"./use-responsive-state-manager.js";export const useResponsiveState=()=>{let s=r();return t(e(e=>{let t=s.state$.subscribe(e);return()=>{t.unsubscribe()}},[s]),s.getState)};

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])})});