@salsita-ai/sdk 0.50.0-develop.b7caacb493 → 0.50.0-develop.b929a82a82

package/dist/configurator/application-runtime/extensions/systems/assistant-system/assistant-system.d.ts

@@ -1,9 +1,11 @@
 import type { AnyClientTool } from '@tanstack/ai';
 import { type UIMessage } from '@tanstack/ai-client';
 import { type ObservableWithLastValue } from '@salsita-ai/common/utils';
+import { type AssistantMessageAnnotation } from '@salsita-ai/contracts/assistant';
 import { type AuthorizedPhoenixApiClient } from '#package/client';
-import type { AssistantManifest, DomainContextSelectors, DomainServicesSelectors, InitializableSystem, SessionAssistantSetup, SpecSelectors } from '#package/domain';
+import type { AssistantManifest, DomainContextSelectors, DomainServicesSelectors, InitializableSystem, SessionAssistantSetup } from '#package/domain';
 import type { ConfiguratorExtensionSelectors } from '../../selectors.js';
+import type { AssistantAnnotation, AssistantAnnotationOverlay } from './assistant-annotation.js';
 /** A tool of the assistant that the model calls and the browser runs, as the chat client accepts it. */
 export type AssistantClientTool = AnyClientTool;
 /**
@@ -15,12 +17,19 @@ export interface AssistantSystemContext {
     readonly configuratorExtensionSelectors: ConfiguratorExtensionSelectors;
     readonly domainContextSelectors: DomainContextSelectors;
     readonly domainServicesSelectors: DomainServicesSelectors;
-    readonly specSelectors: SpecSelectors;
     readonly getConfigurationId: () => string;
     readonly getAuthorizedClient: () => AuthorizedPhoenixApiClient<any, any, any>;
     /** The assistant the initialized session runs: its tools, its exposed fields and whether chat runs at all. */
     readonly getAssistantSetup: () => SessionAssistantSetup;
+    /**
+     * Copies the configurator view as the next frame draws it, for the user to annotate; see
+     * {@link AssistantSystem.annotate}. The only browser-bound step of an annotation the system takes,
+     * so a test can provide one that takes none.
+     */
+    readonly freezeView: () => Promise<HTMLCanvasElement>;
 }
+/** What the user attaches to a message: an image, or an annotation of their configurator view. */
+export type AssistantAttachment = Blob | AssistantAnnotation;
 /**
  * The conversation with the assistant as the panel paints it. One value is published per change, so
  * it changes with every chunk of a streaming reply.
@@ -37,6 +46,12 @@ export interface AssistantChatSnapshot {
      * the server was never reached.
      */
     readonly failedStatus: number | undefined;
+    /**
+     * The seconds the server asked to wait before sending again, from the `Retry-After` header of the
+     * latest chat request it answered with a failure: a message refused for the assistant's hourly
+     * limits. Nothing when that request carried none.
+     */
+    readonly retryAfterSeconds: number | undefined;
     /** False when the server said this session may read the thread but not add to it. */
     readonly isContinuable: boolean;
     /** False until the first request of the chat, the thread read, was answered or failed. */
@@ -51,10 +66,34 @@ export interface AssistantChatSnapshot {
      * the chat was open, and the ones loaded with {@link AssistantSystem.loadEarlierThread}.
      */
     readonly earlierThreads: ReadonlyArray<AssistantEarlierThreadSnapshot>;
-    /** True when the server holds a thread older than the oldest painted one. */
-    readonly hasEarlierThread: boolean;
-    /** True while that older thread is being loaded. */
+    /**
+     * The closed thread that {@link AssistantSystem.loadEarlierThread} loads next; `null` when the
+     * painted threads start the conversation. Usually the thread before the oldest painted one, but
+     * the oldest painted one itself when it was closed while only its newest messages were painted:
+     * loading it then paints it whole.
+     */
+    readonly earlierThreadId: string | null;
+    /** True while that thread is being loaded. */
     readonly isLoadingEarlierThread: boolean;
+    /** True when the thread of the chat has older messages than the painted ones on the server; see {@link AssistantSystem.loadOlderMessages}. */
+    readonly hasOlderMessages: boolean;
+    /** True while those older messages are being loaded. */
+    readonly isLoadingOlderMessages: boolean;
+}
+/** What else the caller of {@link AssistantSystem.send} learns about the message. */
+export interface AssistantSendOptions {
+    /**
+     * Called once the message is handed to the chat, which paints it: after its images were uploaded,
+     * and not at all when it is not sent because the thread could not be resumed or an upload failed.
+     * The composer keeps the message until then, so a message that is not sent can be sent again.
+     */
+    readonly onSent?: () => void;
+    /**
+     * Called when a message that was handed to the chat is gone from it after all: the server refused
+     * it because the thread could not continue, the thread was resumed without it, and its images
+     * could not be uploaded into the new thread. The caller gets it back, so it can be sent again.
+     */
+    readonly onUnsent?: () => void;
 }
 /** A closed thread of the conversation as the panel paints it above the thread that continues it. */
 export interface AssistantEarlierThreadSnapshot {
@@ -73,9 +112,9 @@ export interface AssistantPanelSnapshot {
     readonly isInputFocused: boolean;
 }
 /**
- * Owns the conversational assistant of a configurator: its client tools (`getBrowserDetails`,
- * `query` and `apply`), the chat with the server, the state of the built-in panel, and the record
- * of what changed in the configuration since the agent last acted, which every user message carries.
+ * Owns the conversational assistant of a configurator: its client tools (`query` and `apply`), the
+ * chat with the server, the state of the built-in panel, and the record of what changed in the
+ * configuration since the agent last acted, which every user message carries.
  *
  * The server owns the thread, so the chat keeps nothing in browser storage: its client hydrates
  * from the server and rejoins a reply that is still streaming.
@@ -89,6 +128,9 @@ export declare class AssistantSystem implements InitializableSystem {
     private readonly _tools;
     private readonly _chat;
     private readonly _panel;
+    private readonly _annotationOverlay;
+    /** Identity of the `annotate()` call that runs; a new configuration load forgets it, which cancels it. */
+    private _annotationRun;
     /** Identity of the current `activate()` call; nothing while the chat is not active. */
     private _activation;
     /** The chat of the current activation; nothing while no chat is active. */
@@ -98,11 +140,6 @@ export declare class AssistantSystem implements InitializableSystem {
      * background. Each leaves the set when its reply ends or when a new chat takes its thread over.
      */
     private readonly _finishing;
-    /**
-     * The thread before the oldest painted one, as the server named it; nothing when the painted
-     * threads start the conversation. `hasEarlierThread` of the chat says whether it is set.
-     */
-    private _olderThreadId;
     /** The resume that is running, so two sends that find the thread locked share one. */
     private _resuming;
     /**
@@ -122,8 +159,6 @@ export declare class AssistantSystem implements InitializableSystem {
      * thread continues the same chain; any other new chat starts another one.
      */
     private _chain;
-    /** The earlier thread that is being loaded, so a second press loads nothing twice. */
-    private _loadingThreadId;
     private readonly _recorder;
     /** The recorder's subscription to the committed emissions of the store; made by the first `initialize()`. */
     private _recording;
@@ -136,11 +171,21 @@ export declare class AssistantSystem implements InitializableSystem {
      */
     private readonly _applyToolCallIds;
     private readonly _undoTipToolCallId;
+    /**
+     * Object URLs of the screenshots read so far, by image id. An uploaded image never changes, so
+     * each is read once and kept while the configuration stays loaded.
+     */
+    private _screenshotUrls;
     constructor(_context: AssistantSystemContext);
     /** The conversation. It never completes, and holds the empty chat whenever no chat is active. */
     readonly chat$: ObservableWithLastValue<AssistantChatSnapshot>;
     /** The state of the built-in panel. It never completes. */
     readonly panel$: ObservableWithLastValue<AssistantPanelSnapshot>;
+    /**
+     * What covers the configurator for an annotation, as the layout renders it; nothing while no
+     * annotation is made or shown. See {@link AssistantSystem.annotate}. It never completes.
+     */
+    readonly annotationOverlay$: ObservableWithLastValue<AssistantAnnotationOverlay | null>;
     /**
      * The `apply` tool call whose committed state is the step of the undo history the configuration is
      * at; nothing when that step is not a change of the assistant. It never completes.
@@ -194,6 +239,14 @@ export declare class AssistantSystem implements InitializableSystem {
      * acted, which the server puts in front of the message for the model. The record is taken only
      * when there is a chat to send it on, because taking it moves its baseline.
      *
+     * The images the user attached go with the message: they are uploaded into the chat's thread
+     * first, and the message references them, one image part after its text each. The text part is
+     * left out of a message with images only. An annotation is attached like an image: its image is
+     * uploaded and referenced in its place among the images, and its pins go into the metadata of the
+     * message, by the id of its image, for the server to tell the model. Each attempt to send uploads them again, into the
+     * thread it sends on. An upload that fails leaves the message unsent, with the failure as the
+     * error of the chat; `onSent` is not called then.
+     *
      * A thread can end in a tool call that nothing will answer: its reply parked while no page was
      * open, or the page that ran the tool was left before the result was sent. The client refuses to
      * send while it waits on such a call, so the wait is given up first, and the server records for
@@ -204,20 +257,44 @@ export declare class AssistantSystem implements InitializableSystem {
      *
      * The chat can be out of date about that: the thread reached its size limit with the reply before
      * this message, or the assistant's setup changed while the configurator stayed open. The server
-     * then refuses the message and says that the thread cannot be continued. The message stays
-     * painted while the thread is resumed, and is then sent again on the new thread, with the change
-     * record it was first sent with. This happens once: a refusal of the second attempt is the
-     * failure it is. When resuming fails, the message is left as any message that failed to send:
-     * painted, with the failure as the error of the chat.
+     * then refuses the message, or the upload of one of its images, and says that the thread cannot
+     * be continued. The thread is resumed, and the message is then sent again on the new thread, its
+     * images uploaded again, with the change record it was first sent with. This happens once: a
+     * refusal of the second attempt is the failure it is. When resuming fails, a refused message is
+     * left as any message that failed to send: painted, with the failure as the error of the chat; a
+     * refused upload leaves the message unsent. When the images of a refused message cannot be
+     * uploaded into the new thread, the message is given back through `onUnsent`.
+     *
+     * A chat that ends while the images upload, because another configuration was loaded or the
+     * thread is read again, sends nothing.
      *
      * Accepted: when the server refuses the compaction itself with a conflict, because another tab
      * compacted the thread or a run is still running, the thread is read again (see `resume`) and
      * the refused message is gone without a notice. It takes two tabs or a run racing the send, and
      * the user writes the message again, as after any reload of a thread that failed.
      *
+     * Accepted: images uploaded by an attempt that is not sent stay stored in that thread, which no
+     * message references.
+     *
      * It never rejects: a message the client could not send is reported as the error of the chat.
      */
-    send: (content: string) => Promise<void>;
+    send: (content: string, attachments?: ReadonlyArray<AssistantAttachment>, { onSent, onUnsent }?: AssistantSendOptions) => Promise<void>;
+    /**
+     * Lets the user annotate their current view of the configurator, and resolves with what they made,
+     * or with `null` when they cancel, the view cannot be frozen or another configuration is loaded
+     * meanwhile. Nothing happens while another annotation is made or shown: it resolves with `null` at once.
+     *
+     * The layout is inert from the start, and `annotationOverlay$` says what covers it. Once the camera
+     * is still, the view glides from the canvas padding to none, so the product is centred on the whole
+     * configurator area, and the next frame is frozen for the editor. When the editor finishes, the
+     * view glides back to the padding and the layout is released.
+     */
+    annotate: () => Promise<AssistantAnnotation | null>;
+    /**
+     * Shows an annotation of a sent message over the configurator, read-only, until its overlay is
+     * closed. Nothing happens while another annotation is made or shown.
+     */
+    viewAnnotation: (annotation: AssistantMessageAnnotation) => void;
     /**
      * Makes the chat ready for the next message. A thread the server no longer lets this session
      * continue, because the assistant's setup changed since it was started or the thread reached
@@ -232,10 +309,25 @@ export declare class AssistantSystem implements InitializableSystem {
      */
     resume: () => Promise<boolean>;
     /**
-     * Loads the thread before the oldest painted one and paints it above. Does nothing when there is
-     * none or one is being loaded. A load that fails is logged and can be asked for again.
+     * An object URL of a screenshot of the conversation, by the id its tool result references it by.
+     * It is read from the server through the client of the current chat, once per image; a read that
+     * failed is forgotten, so it can be asked for again. Rejects without a chat or when the read fails.
+     */
+    loadScreenshotUrl: (imageId: string) => Promise<string>;
+    /**
+     * Loads the closed thread named by `earlierThreadId` of the chat, whole, and paints it above the
+     * painted ones; when it is the oldest painted thread itself, closed while only its newest messages
+     * were painted, it replaces that partial copy. Does nothing when there is none, one is being
+     * loaded, or the chat's own thread still has older messages: the earlier threads come above them.
+     * A load that fails is logged and can be asked for again.
      */
     loadEarlierThread: () => Promise<void>;
+    /**
+     * Loads the page of messages before the oldest painted one of the chat's thread and paints it
+     * above. Does nothing when the thread has no older messages or a page is being loaded. A load that
+     * fails is logged and can be asked for again; one that ends after its chat did is dropped.
+     */
+    loadOlderMessages: () => Promise<void>;
     /**
      * Stops the reply on both sides. Closing the stream alone keeps the server run going, because a
      * closed connection is also how a reload looks and a reload must be able to rejoin the run.
@@ -259,14 +351,32 @@ export declare class AssistantSystem implements InitializableSystem {
     undoToolCalls: (toolCallIds: ReadonlySet<string>) => void;
     setOpen: (open: boolean) => void;
     setInputFocused: (isInputFocused: boolean) => void;
+    /** A new configuration load cancels an annotation that is made, and closes one that is shown. */
+    private _closeAnnotationOverlay;
     /**
      * Where the message starts that is being sent on the chat for the first time and that the server
      * refused because its thread cannot be continued, so it never reached the thread; `-1` when there
      * is no such message. A refused continuation of a reply is not one: its message is stored.
      */
     private _findRefusedMessageIndex;
+    /** The content of a user message: its text, when it has any, and a reference to each of its images. */
+    private _messageContent;
+    /**
+     * Uploads the images of a message into the chat's thread, in their order, and resolves with their
+     * ids. Resolves with `'refused'` when the server refused an upload because the thread cannot be
+     * continued, and marks the chat so; then with `null` for any other failure, which is reported as
+     * the error of the chat. It never rejects.
+     */
+    private _uploadImages;
+    /**
+     * Uploads the images of a message into the thread that was resumed for it. A message the chat
+     * refused shows nowhere meanwhile, so the chat stays resuming until the upload is over: nothing
+     * else is sent ahead of it.
+     */
+    private _uploadSuccessorImages;
+    private _reportUploadFailure;
     private _sendOn;
-    private _resume;
+    private _compact;
     /**
      * The `apply` call whose committed state is the step the configuration is at. Nothing at the bottom
      * of the history, where nothing can be undone: that step was not made by a change it could take back.
@@ -300,6 +410,8 @@ export declare class AssistantSystem implements InitializableSystem {
      * it is: whether it finishes its reply or is cut off is the caller's decision.
      */
     private _retireChat;
+    /** Revokes the object URLs of the screenshots read for the configuration that was loaded, also those still being read. */
+    private _releaseScreenshotUrls;
     /** Ends the current chat without cutting its reply off. */
     private _endChat;
 }

package/dist/configurator/application-runtime/extensions/systems/assistant-system/assistant-system.js

@@ -1 +1 @@
-import{ChatClient as e,fetchServerSentEvents as t}from"@tanstack/ai-client";import{BehaviorSubject as i}from"rxjs";import{skip as s}from"rxjs/operators";import{isShallowEqual as a}from"@salsita-ai/common/utils";import{AssistantRequestError as r}from"#package/client";import{createBrowserDetailsClientTool as n}from"./browser-details.js";import{ChangeRecorder as o}from"./change-recorder.js";import{createApplyClientTool as l,createQueryClientTool as h,toToolResult as d}from"./graphql-tools.js";let c=Object.freeze({messages:Object.freeze([]),isLoading:!1,error:void 0,failedStatus:void 0,isContinuable:!0,isLoaded:!1,isResuming:!1,earlierThreads:Object.freeze([]),hasEarlierThread:!1,isLoadingEarlierThread:!1}),u=Object.freeze({open:!1,hasUnreadReply:!1,isInputFocused:!1}),_=Object.freeze({}),g=d({results:[],committed:!1,sideEffects:[],screenshots:new Map,message:"Nothing was run, because the user closed the configurator while this reply was being written. Do not call any more tools in this reply and end it now. The tools work again as soon as the user writes the next message."}),m=e=>{if(e.getError())return!0;let t=e.getMessages().at(-1)?.parts.at(-1);return t?.type!=="tool-call"&&t?.type!=="tool-result"};export class AssistantSystem{_context;_tools;_chat=new i(c);_panel=new i(u);_activation=null;_current=null;_finishing=new Set;_olderThreadId=null;_resuming=null;_refused=null;_firstAttempt=null;_chain={};_loadingThreadId=null;_recorder;_recording=null;_applyToolCallIds=new WeakMap;_undoTipToolCallId=new i(void 0);constructor(e){this._context=e;let{configuratorExtensionSelectors:t,domainContextSelectors:i,domainServicesSelectors:s,getAssistantSetup:a}=e;this._recorder=new o({maxEntities:30},{readers:{selectedEntityId:e=>i.getNavigationSystem().getActiveSelectionState(e),navigationState:e=>i.getNavigationSystem().getActiveNavigationState(e),viewState:e=>i.getNavigationSystem().getActiveViewState(e),toolState:e=>i.getNavigationSystem().getActiveToolState(e)},getExposedFields:()=>a().manifest?.fields??_,resolveLocalizable:e=>s.getResolveLocalizable()(e)});let r={getGraphQLSystem:()=>t.getGraphQLSystem(),getStoreSystem:()=>i.getStoreSystem(),getActiveMode:()=>i.getActiveMode(),getIsViewMode:()=>i.getIsViewMode(),clearChanges:()=>this._recorder.clear(this._committedState()),rememberCommit:(e,t)=>{this._applyToolCallIds.set(t,e),this._refreshUndoTip()}};this._tools=[n(),h(r),l(r)],i.getUndoSystem().tip$.subscribe(this._refreshUndoTip)}chat$=this._chat;panel$=this._panel;undoTipToolCallId$=this._undoTipToolCallId;getSessionManifest=()=>this._context.getAssistantSetup().manifest;initialize=()=>{let{committed:e}=this._context.domainContextSelectors.getStoreSystem().stateSlices;this._recording??=e.pipe(s(1)).subscribe(this._recorder.record),this._recorder.reset(e.value.state),this._endChat(),this._patchPanel(u),this._activation&&this._startClient()};activate=()=>{this._endChat();let e={};return this._activation=e,this._startClient(),()=>{this._activation===e&&(this._activation=null,this._endChat())}};send=async e=>{if(!this._chat.value.isContinuable&&!await this.resume())return;let t=this._current;if(!t)return;let i={changes:this._recorder.take(this._committedState())};this._firstAttempt=t;try{await this._sendOn(t,e,i);let s=this._findRefusedMessageIndex(t);if(-1===s)return;this._refused={chat:t,index:s}}finally{this._firstAttempt===t&&(this._firstAttempt=null)}if(!await this.resume())return;let s=this._current;s&&await this._sendOn(s,e,i)};resume=async()=>{let e=this._current;if(!e)return!1;if(this._chat.value.isContinuable)return!0;if(this._resuming)return this._resuming;let t=this._resume(e).finally(()=>{this._resuming===t&&(this._resuming=null)});return this._resuming=t,t};loadEarlierThread=async()=>{let e=this._current,t=this._olderThreadId;if(!e||null===t||this._loadingThreadId===t)return;let i=this._chain;this._loadingThreadId=t,this._chat.next({...this._chat.value,isLoadingEarlierThread:!0});try{let s=await e.authorizedClient.getAssistantEarlierThread(e.configurationId,t,50);if(this._chain!==i||this._olderThreadId!==t)return;this._olderThreadId=s.previousThreadId,this._chat.next({...this._chat.value,earlierThreads:[{threadId:t,messages:s.messages},...this._chat.value.earlierThreads],hasEarlierThread:null!==s.previousThreadId})}catch(e){this._context.domainServicesSelectors.getLogger().warn("Could not load the earlier assistant conversation",{error:e})}finally{this._chain===i&&this._loadingThreadId===t&&(this._loadingThreadId=null,this._chat.next({...this._chat.value,isLoadingEarlierThread:!1}))}};stop=async()=>{let e=this._current;if(!e)return;let t=e.client.getCurrentRunId();if(e.client.stop(),null!=t)try{let i=e.getConnection();await fetch(`${i.url}/runs/${encodeURIComponent(t)}/cancel`,{method:"POST",headers:await i.headers()})}catch(e){this._context.domainServicesSelectors.getLogger().warn("Could not cancel the assistant run on the server",{error:e})}};reloadThread=()=>{if(!this._activation)return;let e=this._retireChat();e?.client.stop(),e?.dispose(),this._recorder.reset(this._committedState()),this._startClient()};undoToolCalls=e=>{let t=this._context.domainContextSelectors.getUndoSystem(),i=()=>{let t=this._findTipToolCallId();return void 0!==t&&e.has(t)};for(;i();)t.undo()};setOpen=e=>{this._patchPanel(e?{open:e,hasUnreadReply:!1}:{open:e,isInputFocused:!1})};setInputFocused=e=>{this._patchPanel({isInputFocused:e})};_findRefusedMessageIndex=e=>{var t;let i,{failedStatus:s,isContinuable:a}=this._chat.value;return this._firstAttempt===e&&e.generation.active&&409===s&&!a?(i=(t=e.client.getMessages()).map(e=>e.role).lastIndexOf("user"),t.slice(i+1).every(e=>0===e.parts.length)?i:-1):-1};_sendOn=async(e,t,i)=>{let{client:s}=e;s.getIsLoading()||null===s.getResumeState()||s.stop();try{await s.sendMessage({content:t,metadata:i})}catch(i){let t=i instanceof Error?i:Error(String(i));e.generation.active&&this._chat.next({...this._chat.value,error:t}),this._context.domainServicesSelectors.getLogger().error("The assistant message could not be sent",{},t)}};_resume=async e=>{this._chat.next({...this._chat.value,isResuming:!0,error:void 0,failedStatus:void 0});try{let{previousThreadId:t}=await e.authorizedClient.compactAssistantThread(e.configurationId);if(!e.generation.active)return!1;let{messages:i,earlierThreads:s,hasEarlierThread:a}=this._chat.value,r=this._refused?.chat===e?i.slice(0,this._refused.index):i;return e.generation.active=!1,this._current=null,e.client.stop(),e.dispose(),this._chat.next({...c,earlierThreads:[...s,{threadId:t,messages:r}],hasEarlierThread:a,isLoadingEarlierThread:null!==this._loadingThreadId}),this._startClient(),!0}catch(i){let t=i instanceof Error?i:Error(String(i));if(t instanceof r&&409===t.status)return e.generation.active&&this.reloadThread(),!1;return e.generation.active&&this._chat.next({...this._chat.value,isResuming:!1,error:t,failedStatus:t instanceof r?t.status:void 0}),this._context.domainServicesSelectors.getLogger().error("The assistant thread could not be resumed",{},t),!1}};_findTipToolCallId=()=>{let e=this._context.domainContextSelectors.getUndoSystem(),t=e.tip$.value?.committedState;return void 0!==t&&e.canUndo()?this._applyToolCallIds.get(t):void 0};_refreshUndoTip=()=>{let e=this._findTipToolCallId();e!==this._undoTipToolCallId.value&&this._undoTipToolCallId.next(e)};_committedState=()=>this._context.domainContextSelectors.getStoreSystem().stateSlices.committed.value.state;_patchPanel=e=>{let t={...this._panel.value,...e};a(t,this._panel.value)||this._panel.next(t)};_takeOverThread=e=>{for(let t of this._finishing)t.configurationId===e&&(t.client.stop(),t.dispose())};_startClient=()=>{let i={active:!0},s=this._context.getConfigurationId();this._takeOverThread(s);let r=this._context.getAuthorizedClient(),n=()=>{if(i.active){let{manifest:e,error:t}=this._context.getAssistantSetup();if(t)throw t;if(!e)throw Error("The assistant is disabled for this session.")}return r.getAssistantChatConnection(s)},o=e=>{if(!i.active)return;let t={...this._chat.value,...e};a(t,this._chat.value)||this._chat.next(t)},l=async(e,t)=>{let s=await fetch(e,t).finally(()=>o({isLoaded:!0})),a=s.headers.get("x-assistant-thread-continuable");return null!=a&&s.ok&&i.active&&0===this._chat.value.earlierThreads.length&&(this._olderThreadId=s.headers.get("x-assistant-previous-thread")),o({failedStatus:s.ok?void 0:s.status,...null!=a&&{isContinuable:"false"!==a,hasEarlierThread:null!==this._olderThreadId}}),s},h=async()=>({headers:await n().headers(),fetchClient:l}),d=t(()=>n().url,h),c=t(()=>`${n().url}/runs`,h),u=this._tools.map(e=>({...e,execute:(t,s)=>{if(!i.active)return g;let{manifest:a,error:r}=this._context.getAssistantSetup();return r||!a?{error:r?.message??"The assistant is disabled for this session."}:e.execute?.(t,s)}})),_=new e({threadId:`assistant:${s}`,connection:{...d,joinRun:c.joinRun},persistence:!0,history:{pageSize:50},tools:u,onMessagesChange:e=>o({messages:e}),onLoadingChange:e=>{let t=i.active&&this._chat.value.isLoading;o({isLoading:e}),!e&&m(_)&&(i.active?t&&!this._panel.value.open&&this._patchPanel({hasUnreadReply:!0}):p())},onErrorChange:e=>{i.active&&e!==this._chat.value.error&&(!e||-1===this._findRefusedMessageIndex(v))&&(o({error:e}),e&&this._context.domainServicesSelectors.getLogger().error("The assistant request failed",{status:this._chat.value.failedStatus},e))}}),f=!1,p=()=>{f||(f=!0,this._finishing.delete(v),_.dispose())},v={client:_,configurationId:s,generation:i,authorizedClient:r,getConnection:n,dispose:p};this._current=v,_.attach()};_retireChat=()=>{let e=this._current;return this._current=null,e&&(e.generation.active=!1),this._chain={},this._olderThreadId=null,this._resuming=null,this._refused=null,this._loadingThreadId=null,this._chat.value!==c&&this._chat.next(c),e};_endChat=()=>{let e=this._retireChat();if(e){if(!e.client.getIsLoading()&&m(e.client))return void e.dispose();this._finishing.add(e)}}}
+import{ChatClient as t,fetchServerSentEvents as e}from"@tanstack/ai-client";import{BehaviorSubject as a,firstValueFrom as i,race as s,timer as n}from"rxjs";import{filter as r,skip as o}from"rxjs/operators";import{isShallowEqual as l}from"@salsita-ai/common/utils";import{assistantImageReference as h}from"@salsita-ai/contracts/assistant";import{AssistantRequestError as c}from"#package/client";import{ChangeRecorder as d}from"./change-recorder.js";import{createApplyClientTool as u,createQueryClientTool as _,toToolResult as g}from"./graphql-tools.js";let f=Object.freeze({messages:Object.freeze([]),isLoading:!1,error:void 0,failedStatus:void 0,retryAfterSeconds:void 0,isContinuable:!0,isLoaded:!1,isResuming:!1,earlierThreads:Object.freeze([]),earlierThreadId:null,isLoadingEarlierThread:!1,hasOlderMessages:!1,isLoadingOlderMessages:!1}),v=Object.freeze({top:0,right:0,bottom:0,left:0}),m=Object.freeze({kind:"transition"}),p=Object.freeze({open:!1,hasUnreadReply:!1,isInputFocused:!1}),S=Object.freeze({}),y=g({results:[],committed:!1,sideEffects:[],warnings:[],screenshots:new Map,message:"Nothing was run, because the user closed the configurator while this reply was being written. Do not call any more tools in this reply and end it now. The tools work again as soon as the user writes the next message."}),x=t=>{if(t.getError())return!0;let e=t.getMessages().at(-1)?.parts.at(-1);return e?.type!=="tool-call"&&e?.type!=="tool-result"},w=async t=>{try{let e=await t.clone().json(),a=e?.page;return a?.truncated===!0&&"string"==typeof a.cursor&&""!==a.cursor}catch{return!1}};export class AssistantSystem{_context;_tools;_chat=new a(f);_panel=new a(p);_annotationOverlay=new a(null);_annotationRun=null;_activation=null;_current=null;_finishing=new Set;_resuming=null;_refused=null;_firstAttempt=null;_chain={};_recorder;_recording=null;_applyToolCallIds=new WeakMap;_undoTipToolCallId=new a(void 0);_screenshotUrls=new Map;constructor(t){this._context=t;let{configuratorExtensionSelectors:e,domainContextSelectors:a,domainServicesSelectors:i,getAssistantSetup:s}=t;this._recorder=new d({maxEntities:30},{readers:{selectedEntityId:t=>a.getNavigationSystem().getActiveSelectionState(t),navigationState:t=>a.getNavigationSystem().getActiveNavigationState(t),viewState:t=>a.getNavigationSystem().getActiveViewState(t),toolState:t=>a.getNavigationSystem().getActiveToolState(t)},getExposedFields:()=>s().manifest?.fields??S,resolveLocalizable:t=>i.getResolveLocalizable()(t)});let n={getGraphQLSystem:()=>e.getGraphQLSystem(),getStoreSystem:()=>a.getStoreSystem(),getActiveMode:()=>a.getActiveMode(),getIsViewMode:()=>a.getIsViewMode(),clearChanges:()=>this._recorder.clear(this._committedState()),rememberCommit:(t,e)=>{this._applyToolCallIds.set(e,t),this._refreshUndoTip()}};this._tools=[_(n),u(n)],a.getUndoSystem().tip$.subscribe(this._refreshUndoTip)}chat$=this._chat;panel$=this._panel;annotationOverlay$=this._annotationOverlay;undoTipToolCallId$=this._undoTipToolCallId;getSessionManifest=()=>this._context.getAssistantSetup().manifest;initialize=()=>{let{committed:t}=this._context.domainContextSelectors.getStoreSystem().stateSlices;this._recording??=t.pipe(o(1)).subscribe(this._recorder.record),this._recorder.reset(t.value.state),this._endChat(),this._patchPanel(p),this._releaseScreenshotUrls(),this._closeAnnotationOverlay(),this._activation&&this._startClient()};activate=()=>{this._endChat();let t={};return this._activation=t,this._startClient(),()=>{this._activation===t&&(this._activation=null,this._endChat())}};send=async(t,e=[],{onSent:a,onUnsent:i}={})=>{if(!this._chat.value.isContinuable&&!await this.resume())return;let s=this._current;if(!s)return;let n={changes:this._recorder.take(this._committedState()),locale:this._context.domainServicesSelectors.getI18n().locale},r=()=>this._recorder.reset(this._committedState()),o=e.map(t=>t instanceof Blob?t:t.blob),l=!1,h=(i,s)=>{l||(l=!0,a?.());let r=e.flatMap((t,e)=>{let a=s[e];return t instanceof Blob||void 0===a?[]:[{imageId:a,pins:t.pins}]});return this._sendOn(i,this._messageContent(t,s),0===r.length?n:{...n,annotations:r})};this._firstAttempt=s;try{let t=0===o.length?[]:await this._uploadImages(s,o);if(null===t||!s.generation.active)return void r();if("refused"!==t){await h(s,t);let e=this._findRefusedMessageIndex(s);if(-1===e)return;this._refused={chat:s,index:e}}}finally{this._firstAttempt===s&&(this._firstAttempt=null)}if(!await this.resume()){l||r();return}let c=this._current,d=c?await this._uploadSuccessorImages(c,o):null;if(!c||null===d||"refused"===d||!c.generation.active){c&&"refused"===d&&this._reportUploadFailure(c,this._chat.value.error),l&&i?.(),r();return}await h(c,d)};annotate=async()=>{if(null!==this._annotationOverlay.value)return null;let{getCameraControlSystem:t,getCanvasSystem:e}=this._context.configuratorExtensionSelectors,a=t(),o=e().r3fHandle$.value?.get().frameloop==="demand",l={},h=()=>this._annotationRun===l;if(this._annotationRun=l,this._annotationOverlay.next(m),await i(s(a.transitionState$.pipe(r(t=>"still"===t||"sleep"===t&&!o)),n(2e3))),!h())return this._annotationOverlay.next(null),null;let c=a.holdCameraOffset(),d=null;try{await a.glideCameraOffset(v);let t=await this._context.freezeView();h()&&(d=await new Promise(e=>{this._annotationOverlay.next({kind:"editor",view:t,finish:e})}))}catch(e){let t=e instanceof Error?e:Error(String(e));this._context.domainServicesSelectors.getLogger().error("The configurator view could not be frozen for an annotation",{},t)}this._annotationOverlay.next(m);try{await a.glideCameraOffset(a.canvasPadding$.value)}finally{c(),this._annotationOverlay.next(null),h()&&(this._annotationRun=null)}return d};viewAnnotation=t=>{if(null!==this._annotationOverlay.value)return;let e={kind:"viewer",annotation:t,close:()=>{this._annotationOverlay.value===e&&this._annotationOverlay.next(null)}};this._annotationOverlay.next(e)};resume=async()=>{let t=this._current;if(!t)return!1;if(this._chat.value.isContinuable)return!0;if(this._resuming)return this._resuming;let e=this._compact(t).finally(()=>{this._resuming===e&&(this._resuming=null)});return this._resuming=e,e};loadScreenshotUrl=t=>{let e=this._screenshotUrls.get(t);if(e)return e;let a=this._current;if(!a)return Promise.reject(Error(`The screenshot ${t} cannot be read, because the assistant chat is not active. Open the assistant panel of the configuration first.`));let i=this._screenshotUrls,s=a.authorizedClient.getAssistantImage(a.configurationId,t).then(t=>URL.createObjectURL(t));return i.set(t,s),s.catch(()=>{i.get(t)===s&&i.delete(t)}),s};loadEarlierThread=async()=>{let t=this._current,{earlierThreadId:e,isLoadingEarlierThread:a,hasOlderMessages:i}=this._chat.value;if(!t||null===e||a||i)return;let s=this._chain;this._chat.next({...this._chat.value,isLoadingEarlierThread:!0});try{let a=await t.authorizedClient.getAssistantEarlierThread(t.configurationId,e);if(this._chain!==s||this._chat.value.earlierThreadId!==e)return;let[i,...n]=this._chat.value.earlierThreads,r={threadId:e,messages:a.messages};this._chat.next({...this._chat.value,earlierThreads:i?.threadId===e?[r,...n]:[r,...this._chat.value.earlierThreads],earlierThreadId:a.previousThreadId})}catch(t){this._context.domainServicesSelectors.getLogger().warn("Could not load the earlier assistant conversation",{error:t})}finally{this._chain===s&&this._chat.next({...this._chat.value,isLoadingEarlierThread:!1})}};loadOlderMessages=async()=>{let t=this._current,{hasOlderMessages:e,isLoadingOlderMessages:a}=this._chat.value;if(t&&e&&!a){this._chat.next({...this._chat.value,isLoadingOlderMessages:!0});try{await t.client.loadOlderMessages()}catch(t){this._context.domainServicesSelectors.getLogger().warn("Could not load older assistant messages",{error:t})}finally{t===this._current&&this._chat.next({...this._chat.value,hasOlderMessages:t.client.getHasOlderMessages(),isLoadingOlderMessages:!1})}}};stop=async()=>{let t=this._current;if(!t)return;let e=t.client.getCurrentRunId();if(t.client.stop(),null!=e)try{let a=t.getConnection();await fetch(`${a.url}/runs/${encodeURIComponent(e)}/cancel`,{method:"POST",headers:await a.headers()})}catch(t){this._context.domainServicesSelectors.getLogger().warn("Could not cancel the assistant run on the server",{error:t})}};reloadThread=()=>{if(!this._activation)return;let t=this._retireChat();t?.client.stop(),t?.dispose(),this._recorder.reset(this._committedState()),this._startClient()};undoToolCalls=t=>{let e=this._context.domainContextSelectors.getUndoSystem(),a=()=>{let e=this._findTipToolCallId();return void 0!==e&&t.has(e)};for(;a();)e.undo()};setOpen=t=>{this._patchPanel(t?{open:t,hasUnreadReply:!1}:{open:t,isInputFocused:!1})};setInputFocused=t=>{this._patchPanel({isInputFocused:t})};_closeAnnotationOverlay=()=>{let t=this._annotationOverlay.value;this._annotationRun=null,t?.kind==="editor"&&t.finish(null),t?.kind==="viewer"&&t.close()};_findRefusedMessageIndex=t=>{var e;let a,{failedStatus:i,isContinuable:s}=this._chat.value;return this._firstAttempt===t&&t.generation.active&&409===i&&!s?(a=(e=t.client.getMessages()).map(t=>t.role).lastIndexOf("user"),e.slice(a+1).every(t=>0===t.parts.length)?a:-1):-1};_messageContent=(t,e)=>0===e.length?t:[...t?[{type:"text",content:t}]:[],...e.map(t=>({type:"image",source:{type:"url",value:h(t)}}))];_uploadImages=async(t,e)=>{if(0===e.length)return[];t.generation.active&&this._chat.next({...this._chat.value,error:void 0,failedStatus:void 0});try{return(await Promise.all(e.map(e=>t.authorizedClient.uploadAssistantImage(t.configurationId,e)))).map(({imageId:t})=>t)}catch(a){let e=a instanceof Error?a:Error(String(a));if(e instanceof c&&e.threadNotContinuable)return t.generation.active&&this._chat.next({...this._chat.value,isContinuable:!1,error:e,failedStatus:e.status}),"refused";return this._reportUploadFailure(t,e),null}};_uploadSuccessorImages=async(t,e)=>{if(0===e.length)return[];this._chat.next({...this._chat.value,isResuming:!0});try{return await this._uploadImages(t,e)}finally{t.generation.active&&this._chat.next({...this._chat.value,isResuming:!1})}};_reportUploadFailure=(t,e)=>{t.generation.active&&this._chat.next({...this._chat.value,error:e,failedStatus:e instanceof c?e.status:void 0}),this._context.domainServicesSelectors.getLogger().error("The images of the assistant message could not be uploaded",{},e)};_sendOn=async(t,e,a)=>{let{client:i}=t;i.getIsLoading()||null===i.getResumeState()||i.stop();try{await i.sendMessage({content:e,metadata:a})}catch(a){let e=a instanceof Error?a:Error(String(a));t.generation.active&&this._chat.next({...this._chat.value,error:e}),this._context.domainServicesSelectors.getLogger().error("The assistant message could not be sent",{},e)}};_compact=async t=>{this._chat.next({...this._chat.value,isResuming:!0,error:void 0,failedStatus:void 0});try{let{previousThreadId:e}=await t.authorizedClient.compactAssistantThread(t.configurationId);if(!t.generation.active)return!1;let{messages:a,earlierThreads:i,earlierThreadId:s,isLoadingEarlierThread:n}=this._chat.value,r=this._refused?.chat===t?a.slice(0,this._refused.index):a,o=t.client.getHasOlderMessages()?e:s;return t.generation.active=!1,this._current=null,t.client.stop(),t.dispose(),this._chat.next({...f,earlierThreads:[...i,{threadId:e,messages:r}],earlierThreadId:o,isLoadingEarlierThread:n}),this._startClient(),!0}catch(a){let e=a instanceof Error?a:Error(String(a));if(e instanceof c&&409===e.status)return t.generation.active&&this.reloadThread(),!1;return t.generation.active&&this._chat.next({...this._chat.value,isResuming:!1,error:e,failedStatus:e instanceof c?e.status:void 0}),this._context.domainServicesSelectors.getLogger().error("The assistant thread could not be resumed",{},e),!1}};_findTipToolCallId=()=>{let t=this._context.domainContextSelectors.getUndoSystem(),e=t.tip$.value?.committedState;return void 0!==e&&t.canUndo()?this._applyToolCallIds.get(e):void 0};_refreshUndoTip=()=>{let t=this._findTipToolCallId();t!==this._undoTipToolCallId.value&&this._undoTipToolCallId.next(t)};_committedState=()=>this._context.domainContextSelectors.getStoreSystem().stateSlices.committed.value.state;_patchPanel=t=>{let e={...this._panel.value,...t};l(e,this._panel.value)||this._panel.next(e)};_takeOverThread=t=>{for(let e of this._finishing)e.configurationId===t&&(e.client.stop(),e.dispose())};_startClient=()=>{let a={active:!0},i=this._context.getConfigurationId();this._takeOverThread(i);let s=this._context.getAuthorizedClient(),n=()=>{if(a.active){let{manifest:t,error:e}=this._context.getAssistantSetup();if(e)throw e;if(!t)throw Error("The assistant is disabled for this session.")}return s.getAssistantChatConnection(i)},r=t=>{if(!a.active)return;let e={...this._chat.value,...t};l(e,this._chat.value)||this._chat.next(e)},o=async(t,e)=>{let a,i=await fetch(t,e).finally(()=>r({isLoaded:!0})),s=i.headers.get("x-assistant-thread-continuable"),n=null!=s&&i.ok&&0===this._chat.value.earlierThreads.length,o=n?i.headers.get("x-assistant-previous-thread"):null;return r({failedStatus:i.ok?void 0:i.status,retryAfterSeconds:i.ok?void 0:null!==(a=i.headers.get("retry-after"))&&/^\d+$/.test(a.trim())?Number(a):void 0,...null!=s&&{isContinuable:"false"!==s},...n&&{earlierThreadId:o,...null!==o&&{hasOlderMessages:await w(i)}}}),i},h=async()=>({headers:await n().headers(),fetchClient:o}),c=e(()=>n().url,h),d=e(()=>`${n().url}/runs`,h),u=this._tools.map(t=>({...t,execute:(e,i)=>{if(!a.active)return y;let{manifest:s,error:n}=this._context.getAssistantSetup();return n||!s?{error:n?.message??"The assistant is disabled for this session."}:t.execute?.(e,i)}})),_=new t({threadId:`assistant:${i}`,connection:{...c,joinRun:d.joinRun},persistence:!0,history:{pageSize:50},tools:u,onMessagesChange:t=>r({messages:t,hasOlderMessages:_.getHasOlderMessages()}),onLoadingChange:t=>{let e=a.active&&this._chat.value.isLoading;r({isLoading:t}),!t&&x(_)&&(a.active?e&&!this._panel.value.open&&this._patchPanel({hasUnreadReply:!0}):f())},onErrorChange:t=>{a.active&&t!==this._chat.value.error&&(!t||-1===this._findRefusedMessageIndex(v))&&(r({error:t}),t&&this._context.domainServicesSelectors.getLogger().error("The assistant request failed",{status:this._chat.value.failedStatus},t))}}),g=!1,f=()=>{g||(g=!0,this._finishing.delete(v),_.dispose())},v={client:_,configurationId:i,generation:a,authorizedClient:s,getConnection:n,dispose:f};this._current=v,_.attach()};_retireChat=()=>{let t=this._current;return this._current=null,t&&(t.generation.active=!1),this._chain={},this._resuming=null,this._refused=null,this._chat.value!==f&&this._chat.next(f),t};_releaseScreenshotUrls=()=>{for(let t of this._screenshotUrls.values())t.then(URL.revokeObjectURL,()=>void 0);this._screenshotUrls=new Map};_endChat=()=>{let t=this._retireChat();if(t){if(!t.client.getIsLoading()&&x(t.client))return void t.dispose();this._finishing.add(t)}}}

package/dist/configurator/application-runtime/extensions/systems/assistant-system/graphql-tools.d.ts

@@ -7,7 +7,7 @@ import type { GraphQLExecution, GraphQLSystem } from '../graphql-system/graphql-
  * mode current at that moment, never against ones captured when its reply began streaming.
  */
 export interface AssistantToolDependencies {
-    readonly getGraphQLSystem: () => Pick<GraphQLSystem, 'prepare' | 'execute' | 'readSideEffects' | 'readScreenshots'>;
+    readonly getGraphQLSystem: () => Pick<GraphQLSystem, 'prepare' | 'execute' | 'readSideEffects' | 'readWarnings' | 'readScreenshots'>;
     readonly getStoreSystem: () => {
         readonly isInitialized: boolean;
         readonly stateSlices: {
@@ -35,7 +35,8 @@ export interface AssistantToolDependencies {
 /**
  * A tool result as the chat client accepts it: content parts, the execution's JSON as a text part
  * followed, per screenshot, by its label as a text part and its picture as an image part, so the
- * model reads each picture under the label its `image` field returned. The client deep-clones a
+ * model reads each picture under the label its `image` field returned; the image part references the picture the browser uploaded, which the server
+ * inlines only for the model. The client deep-clones a
  * result and rejects anything that is not plain JSON, so the `GraphQLError` instances of a result
  * are formatted through their `toJSON` and `undefined` members are dropped. The prepared state stays
  * in the browser.
@@ -44,12 +45,16 @@ export declare const toToolResult: ({ preparedState, screenshots, ...execution }
 /**
  * Browser implementation of the assistant's `query` tool: prepares the operations from the
  * committed state and drops their emissions, so mutations in the list show a hypothetical state and
- * the configuration, the undo stack and the saved revision stay as they were. The side effects of
- * the dropped emissions are still reported, as what the changes would do.
+ * the configuration, the undo stack and the saved revision stay as they were. The side effects and
+ * the new warnings of the dropped emissions are still reported, as what the changes would do.
  */
 export declare const createQueryClientTool: (dependencies: AssistantToolDependencies) => import("@tanstack/ai").ClientTool<{
     type: string;
     properties: {
+        title: {
+            type: string;
+            description: string;
+        };
         operations: {
             type: string;
             minItems: number;
@@ -79,6 +84,10 @@ export declare const createQueryClientTool: (dependencies: AssistantToolDependen
     inputSchema: {
         type: string;
         properties: {
+            title: {
+                type: string;
+                description: string;
+            };
             operations: {
                 type: string;
                 minItems: number;
@@ -132,6 +141,10 @@ export declare const createQueryClientTool: (dependencies: AssistantToolDependen
 export declare const createApplyClientTool: (dependencies: AssistantToolDependencies) => import("@tanstack/ai").ClientTool<{
     type: string;
     properties: {
+        title: {
+            type: string;
+            description: string;
+        };
         operations: {
             type: string;
             minItems: number;
@@ -161,6 +174,10 @@ export declare const createApplyClientTool: (dependencies: AssistantToolDependen
     inputSchema: {
         type: string;
         properties: {
+            title: {
+                type: string;
+                description: string;
+            };
             operations: {
                 type: string;
                 minItems: number;

package/dist/configurator/application-runtime/extensions/systems/assistant-system/graphql-tools.js

@@ -1 +1 @@
-import{AssistantGraphQLToolInput as e,applyTool as t,queryTool as o}from"@salsita-ai/contracts/assistant";let a=e=>({results:[],committed:!1,message:e,sideEffects:[],screenshots:new Map});export const toToolResult=({preparedState:e,screenshots:t,...o})=>[{type:"text",content:JSON.stringify(o)},...[...t].flatMap(([e,{data:t,mimeType:o}])=>[{type:"text",content:e},{type:"image",source:{type:"data",value:t,mimeType:o}}])];let i=t=>{let o=e.safeParse(t);if(!o.success){let e=o.error.issues.map(e=>`${e.path.join(".")}: ${e.message}`).join("; ");return{ok:!1,refusal:a(`Nothing was run, because the tool input is not a list of operations (${e}). Send { "operations": [{ "query": "<one GraphQL operation>" }] } with at least one item.`)}}return{ok:!0,operations:o.data.operations.map(({query:e,variables:t,operationName:o})=>({document:e,variables:t??void 0,operationName:o??void 0}))}};export const createQueryClientTool=e=>o.client(async t=>{let o=i(t);if(!o.ok)return toToolResult(o.refusal);let s=e.getStoreSystem();if(!s.isInitialized)return toToolResult(a("Nothing was run, because the configuration is not loaded yet, so there is no state to query. Call the tool again once the configurator has finished loading."));let n=e.getGraphQLSystem(),r=await n.prepare(s.stateSlices.committed.value.state,o.operations);return toToolResult({results:r.map(({result:e})=>e),committed:!1,sideEffects:n.readSideEffects(r),screenshots:n.readScreenshots(r)})});export const createApplyClientTool=e=>t.client(async(t,o)=>{if("finalize"===e.getActiveMode())return toToolResult(a("Nothing was run, because changes cannot be applied in this session: the user may view this configuration but not change it. The query tool still works here, including mutations, to show what a change would do without keeping it."));if(e.getIsViewMode())return toToolResult(a("Nothing was run, because the configuration is read-only right now: the user may view it but not change it. The query tool still works here, including mutations, to show what a change would do without keeping it. Call apply again only once the configuration is editable."));let s=i(t);if(!s.ok)return toToolResult(s.refusal);let n=await e.getGraphQLSystem().execute(s.operations),r=o?.toolCallId;return void 0!==r&&void 0!==n.preparedState&&e.rememberCommit(r,n.preparedState),n.committed&&e.clearChanges(),toToolResult(n)});
+import{AssistantGraphQLToolInput as e,applyTool as t,assistantImageReference as o,queryTool as a}from"@salsita-ai/contracts/assistant";let i=e=>({results:[],committed:!1,message:e,sideEffects:[],screenshots:new Map,warnings:[]});export const toToolResult=({preparedState:e,screenshots:t,...a})=>[{type:"text",content:JSON.stringify(a)},...[...t].flatMap(([e,{imageId:t}])=>[{type:"text",content:e},{type:"image",source:{type:"url",value:o(t)}}])];let s=t=>{let o=e.safeParse(t);if(!o.success){let e=o.error.issues.map(e=>`${e.path.join(".")}: ${e.message}`).join("; ");return{ok:!1,refusal:i(`Nothing was run, because the tool input is not a list of operations (${e}). Send { "operations": [{ "query": "<one GraphQL operation>" }] } with at least one item.`)}}return{ok:!0,operations:o.data.operations.map(({query:e,variables:t,operationName:o})=>({document:e,variables:t??void 0,operationName:o??void 0}))}};export const createQueryClientTool=e=>a.client(async t=>{let o=s(t);if(!o.ok)return toToolResult(o.refusal);let a=e.getStoreSystem();if(!a.isInitialized)return toToolResult(i("Nothing was run, because the configuration is not loaded yet, so there is no state to query. Call the tool again once the configurator has finished loading."));let n=e.getGraphQLSystem(),r=a.stateSlices.committed.value.state,l=await n.prepare(r,o.operations);return toToolResult({results:l.map(({result:e})=>e),committed:!1,sideEffects:n.readSideEffects(l),screenshots:n.readScreenshots(l),warnings:n.readWarnings(r,l)})});export const createApplyClientTool=e=>t.client(async(t,o)=>{if("finalize"===e.getActiveMode())return toToolResult(i("Nothing was run, because changes cannot be applied in this session: the user may view this configuration but not change it. The query tool still works here, including mutations, to show what a change would do without keeping it."));if(e.getIsViewMode())return toToolResult(i("Nothing was run, because the configuration is read-only right now: the user may view it but not change it. The query tool still works here, including mutations, to show what a change would do without keeping it. Call apply again only once the configuration is editable."));let a=s(t);if(!a.ok)return toToolResult(a.refusal);let n=await e.getGraphQLSystem().execute(a.operations),r=o?.toolCallId;return void 0!==r&&void 0!==n.preparedState&&e.rememberCommit(r,n.preparedState),n.committed&&e.clearChanges(),toToolResult(n)});

package/dist/configurator/application-runtime/extensions/systems/camera-control-system/camera-control-system.d.ts

@@ -65,6 +65,10 @@ export declare class CameraControlSystem {
      */
     private readonly _canvasPadding$;
     readonly canvasPadding$: ObservableWithLastValue<CanvasPadding>;
+    /** The padding the interactive cameras were last offset by, through `applyCameraOffset`. */
+    private _appliedCameraOffset;
+    /** How many holders keep CameraPadding from writing the offset; see `holdCameraOffset`. */
+    private _cameraOffsetHolds;
     private _generation;
     private _pendingAbortController;
     private _lastTransition;
@@ -118,6 +122,45 @@ export declare class CameraControlSystem {
     readonly fitRootCamera: () => void;
     readonly fitEntity: (id: DomainEntityId<string>) => void;
     readonly setCameraOffset: (props: CameraOffsetProps) => void;
+    /**
+     * The padding the interactive cameras were last offset by; a glide starts from it.
+     *
+     * @internal
+     */
+    get appliedCameraOffset(): CanvasPadding;
+    /**
+     * True while someone else than CameraPadding owns the offset of the interactive cameras.
+     *
+     * @internal
+     */
+    get isCameraOffsetHeld(): boolean;
+    /**
+     * Takes the offset of the interactive cameras over from CameraPadding, which stops writing it until
+     * every hold is released, so the holder can move the view without a refit (see
+     * `glideCameraOffset`). Releasing wakes the frameloop, so CameraPadding glides on from wherever the
+     * holder left the offset. The returned release does nothing when called again.
+     *
+     * @internal
+     */
+    readonly holdCameraOffset: () => (() => void);
+    /**
+     * Offsets both interactive cameras by `padding` against the measured canvas viewport. Nothing
+     * happens while no canvas has been measured: there is no viewport to offset against.
+     *
+     * @internal
+     */
+    readonly applyCameraOffset: (padding: CanvasPadding) => void;
+    /**
+     * Moves the offset of the interactive cameras from the applied padding to `to` in a fixed time, a
+     * frame at a time, and resolves once it is there. The offset is a function of the elapsed time, so
+     * a slow device shows fewer frames but takes no longer. With reduced motion it is set at once.
+     * Meant for the holder of `holdCameraOffset`; CameraPadding would otherwise overwrite every step.
+     *
+     * @internal
+     */
+    readonly glideCameraOffset: (to: CanvasPadding) => Promise<void>;
+    /** Wakes the demand frameloop of the mounted canvas, so an offset written outside a frame is drawn. */
+    private readonly _invalidate;
     initialize: () => void;
 }
 export {};

package/dist/configurator/application-runtime/extensions/systems/camera-control-system/camera-control-system.js

@@ -1 +1 @@
-import t from"promise-queue";import{BehaviorSubject as e,Subject as r,debounceTime as a,map as i,of as o,shareReplay as s,startWith as n,switchMap as h}from"rxjs";import{OrthographicCamera as l,PerspectiveCamera as p}from"three";import{match as c}from"ts-pattern";import{DEFAULT_DIMENSION_UNIT as C,distanceUnitToDefault as m}from"#package/domain";import{createCameraControls as g}from"./create-camera-controls.js";export const CameraControlType={Perspective:"perspective",Orthographic:"orthographic"};let d=t=>Number.isFinite(t.width)&&Number.isFinite(t.height)&&t.width>0&&t.height>0;export class CameraControlSystem{_context;perspectiveCamera=Object.assign(new p,{manual:!0});orthographicCamera=Object.assign(new l,{manual:!0});perspectiveCameraControls=g(this.perspectiveCamera);orthographicCameraControls=g(this.orthographicCamera);_transitionState$=new e("still");_rendered$=new r;_transitionQueue=new t(1,1/0);_activeCameraControls$=new e(void 0);activeCameraControls$=this._activeCameraControls$;_canvasPadding$=new e({top:0,right:0,bottom:0,left:0});canvasPadding$=this._canvasPadding$;_generation=null;_pendingAbortController=void 0;_lastTransition=void 0;_cameraControlState$=new e("idle");cameraControlState$=this._cameraControlState$;transitionState$=this._transitionState$.pipe(h(t=>"sleep"===t?this._rendered$.pipe(a(200),i(()=>"still"),n("sleep")):o(t)),s(1));constructor(t){this._context=t,this.perspectiveCamera.fov=50,this.perspectiveCamera.near=m(500,C),this.perspectiveCamera.far=m(4e4,C),this.perspectiveCamera.position.set(0,1,0),this.orthographicCamera.left=m(-500,C),this.orthographicCamera.bottom=m(-500,C),this.orthographicCamera.right=m(500,C),this.orthographicCamera.top=m(500,C),this.orthographicCamera.far=m(4e4,C),this.orthographicCamera.near=m(500,C),this.orthographicCamera.position.set(0,1,0),this._context.configuratorExtensionSelectors.getCanvasSystem().interactiveViewport$.subscribe(t=>{null!==t&&this.handleCanvasResize(t)})}_seedCameraControls=()=>{this.perspectiveCameraControls.enabled=!0,this.orthographicCameraControls.enabled=!0,this.perspectiveCameraControls.rotateTo(0,1.2,!1),this.orthographicCameraControls.rotateTo(0,1.2,!1),this.orthographicCameraControls.dollyTo(m(1e4,C),!1)};resetCamera=()=>{this._lastTransition&&this.scheduleCameraTransition(this._lastTransition,{bypassViewLocks:!0})};setTransitionState=t=>{this._transitionState$.next(t)};reportRender=()=>{this._rendered$.next()};scheduleCameraTransition(t,e={}){this._pendingAbortController?.abort();let r=new AbortController;this._pendingAbortController=r;let a=this._generation;return{finished:this._transitionQueue.add(async()=>{let i=r.signal;if(i.aborted||!a?.active)return;let o=c(t.cameraType).with(CameraControlType.Perspective,()=>this.perspectiveCameraControls).with(CameraControlType.Orthographic,()=>this.orthographicCameraControls).exhaustive(),s=null==this._activeCameraControls$.value,n=this._activeCameraControls$.value!==o;n&&this._activeCameraControls$.next(o),this._lastTransition=t,await t.run({controls:o,camera:o.camera,abortSignal:i,firstLoad:s,typeChanged:n,bypassViewLocks:!0===e.bypassViewLocks})}),abort:()=>{r.abort()}}}setCameraControlState=t=>{this._cameraControlState$.next(t)};handleCanvasResize=t=>{if(!d(t))return;let e=t.width/t.height;this.perspectiveCamera.aspect=e,this.perspectiveCamera.updateProjectionMatrix();let r=this.orthographicCamera,a=(r.left+r.right)/2,i=(r.top-r.bottom)/2*e;r.left=a-i,r.right=a+i,r.updateProjectionMatrix()};setCanvasPadding=t=>{let e=this._canvasPadding$.value;(e.top!==t.top||e.right!==t.right||e.bottom!==t.bottom||e.left!==t.left)&&this._canvasPadding$.next(t)};enable=()=>{this.perspectiveCameraControls.enabled=!0,this.orthographicCameraControls.enabled=!0};disable=()=>{this.perspectiveCameraControls.enabled=!1,this.orthographicCameraControls.enabled=!1};fitRootCamera=()=>{let t=this._context.configuratorExtensionSelectors.getCanvasSystem().ready$.value?.scene;t&&this.perspectiveCameraControls.fitToSphere(t,!1)};fitEntity=t=>{let e=this._context.configuratorExtensionSelectors.getCanvasSystem().ready$.value?.scene;if(!e)return;let r=e.getObjectByName(t.toString());null!=r&&this.perspectiveCameraControls.fitToBox(r,!1)};setCameraOffset=t=>{let{padding:e,viewPort:r,camera:a}=t;if(!d(r))return;if(![e.top,e.right,e.bottom,e.left].every(Number.isFinite)||e.left+e.right>=r.width||e.top+e.bottom>=r.height)return void a.clearViewOffset();let i=(e.right-e.left)/2,o=(e.bottom-e.top)/2;a.setViewOffset(r.width,r.height,i,o,r.width,r.height)};initialize=()=>{null!==this._generation&&(this._generation.active=!1),this._pendingAbortController?.abort(),this._pendingAbortController=void 0,this._lastTransition=void 0,this._transitionState$.next("still"),this._cameraControlState$.next("idle"),this._activeCameraControls$.next(void 0),this._generation={active:!0},this._seedCameraControls()}}
+import t from"promise-queue";import{BehaviorSubject as e,Subject as a,debounceTime as r,map as i,of as o,shareReplay as s,startWith as n,switchMap as h}from"rxjs";import{OrthographicCamera as l,PerspectiveCamera as m}from"three";import{match as p}from"ts-pattern";import{DEFAULT_DIMENSION_UNIT as c,distanceUnitToDefault as C}from"#package/domain";import{createCameraControls as d}from"./create-camera-controls.js";export const CameraControlType={Perspective:"perspective",Orthographic:"orthographic"};let f=Object.freeze({top:0,right:0,bottom:0,left:0}),g=t=>Number.isFinite(t.width)&&Number.isFinite(t.height)&&t.width>0&&t.height>0;export class CameraControlSystem{_context;perspectiveCamera=Object.assign(new m,{manual:!0});orthographicCamera=Object.assign(new l,{manual:!0});perspectiveCameraControls=d(this.perspectiveCamera);orthographicCameraControls=d(this.orthographicCamera);_transitionState$=new e("still");_rendered$=new a;_transitionQueue=new t(1,1/0);_activeCameraControls$=new e(void 0);activeCameraControls$=this._activeCameraControls$;_canvasPadding$=new e({top:0,right:0,bottom:0,left:0});canvasPadding$=this._canvasPadding$;_appliedCameraOffset=f;_cameraOffsetHolds=0;_generation=null;_pendingAbortController=void 0;_lastTransition=void 0;_cameraControlState$=new e("idle");cameraControlState$=this._cameraControlState$;transitionState$=this._transitionState$.pipe(h(t=>"sleep"===t?this._rendered$.pipe(r(200),i(()=>"still"),n("sleep")):o(t)),s(1));constructor(t){this._context=t,this.perspectiveCamera.fov=50,this.perspectiveCamera.near=C(500,c),this.perspectiveCamera.far=C(4e4,c),this.perspectiveCamera.position.set(0,1,0),this.orthographicCamera.left=C(-500,c),this.orthographicCamera.bottom=C(-500,c),this.orthographicCamera.right=C(500,c),this.orthographicCamera.top=C(500,c),this.orthographicCamera.far=C(4e4,c),this.orthographicCamera.near=C(500,c),this.orthographicCamera.position.set(0,1,0),this._context.configuratorExtensionSelectors.getCanvasSystem().interactiveViewport$.subscribe(t=>{null!==t&&this.handleCanvasResize(t)})}_seedCameraControls=()=>{this.perspectiveCameraControls.enabled=!0,this.orthographicCameraControls.enabled=!0,this.perspectiveCameraControls.rotateTo(0,1.2,!1),this.orthographicCameraControls.rotateTo(0,1.2,!1),this.orthographicCameraControls.dollyTo(C(1e4,c),!1)};resetCamera=()=>{this._lastTransition&&this.scheduleCameraTransition(this._lastTransition,{bypassViewLocks:!0})};setTransitionState=t=>{this._transitionState$.next(t)};reportRender=()=>{this._rendered$.next()};scheduleCameraTransition(t,e={}){this._pendingAbortController?.abort();let a=new AbortController;this._pendingAbortController=a;let r=this._generation;return{finished:this._transitionQueue.add(async()=>{let i=a.signal;if(i.aborted||!r?.active)return;let o=p(t.cameraType).with(CameraControlType.Perspective,()=>this.perspectiveCameraControls).with(CameraControlType.Orthographic,()=>this.orthographicCameraControls).exhaustive(),s=null==this._activeCameraControls$.value,n=this._activeCameraControls$.value!==o;n&&this._activeCameraControls$.next(o),this._lastTransition=t,await t.run({controls:o,camera:o.camera,abortSignal:i,firstLoad:s,typeChanged:n,bypassViewLocks:!0===e.bypassViewLocks})}),abort:()=>{a.abort()}}}setCameraControlState=t=>{this._cameraControlState$.next(t)};handleCanvasResize=t=>{if(!g(t))return;let e=t.width/t.height;this.perspectiveCamera.aspect=e,this.perspectiveCamera.updateProjectionMatrix();let a=this.orthographicCamera,r=(a.left+a.right)/2,i=(a.top-a.bottom)/2*e;a.left=r-i,a.right=r+i,a.updateProjectionMatrix()};setCanvasPadding=t=>{let e=this._canvasPadding$.value;(e.top!==t.top||e.right!==t.right||e.bottom!==t.bottom||e.left!==t.left)&&this._canvasPadding$.next(t)};enable=()=>{this.perspectiveCameraControls.enabled=!0,this.orthographicCameraControls.enabled=!0};disable=()=>{this.perspectiveCameraControls.enabled=!1,this.orthographicCameraControls.enabled=!1};fitRootCamera=()=>{let t=this._context.configuratorExtensionSelectors.getCanvasSystem().ready$.value?.scene;t&&this.perspectiveCameraControls.fitToSphere(t,!1)};fitEntity=t=>{let e=this._context.configuratorExtensionSelectors.getCanvasSystem().ready$.value?.scene;if(!e)return;let a=e.getObjectByName(t.toString());null!=a&&this.perspectiveCameraControls.fitToBox(a,!1)};setCameraOffset=t=>{let{padding:e,viewPort:a,camera:r}=t;if(!g(a))return;if(![e.top,e.right,e.bottom,e.left].every(Number.isFinite)||e.left+e.right>=a.width||e.top+e.bottom>=a.height)return void r.clearViewOffset();let i=(e.right-e.left)/2,o=(e.bottom-e.top)/2;r.setViewOffset(a.width,a.height,i,o,a.width,a.height)};get appliedCameraOffset(){return this._appliedCameraOffset}get isCameraOffsetHeld(){return this._cameraOffsetHolds>0}holdCameraOffset=()=>{this._cameraOffsetHolds+=1;let t=!1;return()=>{t||(t=!0,this._cameraOffsetHolds-=1,this._invalidate())}};applyCameraOffset=t=>{let e=this._context.configuratorExtensionSelectors.getCanvasSystem().interactiveViewport$.value;null!==e&&(this.setCameraOffset({padding:t,viewPort:e,camera:this.perspectiveCamera}),this.setCameraOffset({padding:t,viewPort:e,camera:this.orthographicCamera}),this._appliedCameraOffset=t)};glideCameraOffset=async t=>{let e=this._appliedCameraOffset;if(globalThis.matchMedia?.("(prefers-reduced-motion: reduce)").matches===!0){this.applyCameraOffset(t),this._invalidate();return}let a=performance.now();await new Promise(r=>{let i=o=>{let s,n=Math.min(1,Math.max(0,(o-a)/300));this.applyCameraOffset((s=n<.5?4*n*n*n:1-(-2*n+2)**3/2,{top:e.top+(t.top-e.top)*s,right:e.right+(t.right-e.right)*s,bottom:e.bottom+(t.bottom-e.bottom)*s,left:e.left+(t.left-e.left)*s})),this._invalidate(),n<1?requestAnimationFrame(i):r()};requestAnimationFrame(i)})};_invalidate=()=>{this._context.configuratorExtensionSelectors.getCanvasSystem().r3fHandle$.value?.get().invalidate()};initialize=()=>{null!==this._generation&&(this._generation.active=!1),this._pendingAbortController?.abort(),this._pendingAbortController=void 0,this._lastTransition=void 0,this._transitionState$.next("still"),this._cameraControlState$.next("idle"),this._activeCameraControls$.next(void 0),this._generation={active:!0},this._seedCameraControls()}}