@callimacus/thamyr 4.3.5 → 4.4.0

package/CHANGELOG.core.md

@@ -3,6 +3,31 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
+## [4.4.0](https://github.com/callimacus/thamyr-sdk/compare/thamyr-core-v4.3.5...thamyr-core-v4.4.0) (2026-09-29)
+
+
+### Features
+
+* **callimacus:** export additional action types from hooks for better type safety ([fe22166](https://github.com/callimacus/thamyr-sdk/commit/fe221665c994723d546f972c9379cdf4b4eecbc8))
+* **ContentAPI:** implement getDocumentByGroupId method to retrieve documents based on language and group ID ([fe22166](https://github.com/callimacus/thamyr-sdk/commit/fe221665c994723d546f972c9379cdf4b4eecbc8))
+* **hooks.ts:** enhance useProducts, useAnalytics, and useSitemap hooks with TypeScript interfaces and detailed documentation ([fe22166](https://github.com/callimacus/thamyr-sdk/commit/fe221665c994723d546f972c9379cdf4b4eecbc8))
+* **react:** add eslint-config-xo-react for better React linting ([fe22166](https://github.com/callimacus/thamyr-sdk/commit/fe221665c994723d546f972c9379cdf4b4eecbc8))
+* **react:** implement Callimacus store and hooks for state management ([fe22166](https://github.com/callimacus/thamyr-sdk/commit/fe221665c994723d546f972c9379cdf4b4eecbc8))
+* **service.ts:** add polling transport option to socket connection for improved connectivity in restricted environments ([fe22166](https://github.com/callimacus/thamyr-sdk/commit/fe221665c994723d546f972c9379cdf4b4eecbc8))
+* **service.ts:** add referrer to auth object for enhanced tracking and analytics ([fe22166](https://github.com/callimacus/thamyr-sdk/commit/fe221665c994723d546f972c9379cdf4b4eecbc8))
+* **thamyr:** parity with the v2 wire, rounds without a message, acknowledged suggestions, receptors and block keys ([#784](https://github.com/callimacus/thamyr-sdk/issues/784)) ([fe22166](https://github.com/callimacus/thamyr-sdk/commit/fe221665c994723d546f972c9379cdf4b4eecbc8))
+
+
+### Bug Fixes
+
+* **AnalyticsAPI.ts, Thamyr.ts:** remove array type from content parameter in trackEvent method for consistency and simplification ([fe22166](https://github.com/callimacus/thamyr-sdk/commit/fe221665c994723d546f972c9379cdf4b4eecbc8))
+* **core/package.json:** update @solomei-ai/intent to version 1.9.2 for latest features and fixes ([fe22166](https://github.com/callimacus/thamyr-sdk/commit/fe221665c994723d546f972c9379cdf4b4eecbc8))
+* **package.json:** remove redundant comma in scripts section to ensure JSON validity ([fe22166](https://github.com/callimacus/thamyr-sdk/commit/fe221665c994723d546f972c9379cdf4b4eecbc8))
+* **package.json:** update @types/react to version 19.2.10 for improved type definitions chore(package.json): bump react and react-dom to version 19.2.4 for latest features and fixes ([fe22166](https://github.com/callimacus/thamyr-sdk/commit/fe221665c994723d546f972c9379cdf4b4eecbc8))
+* **react:** ensure consistent export style across components ([fe22166](https://github.com/callimacus/thamyr-sdk/commit/fe221665c994723d546f972c9379cdf4b4eecbc8))
+* **react:** remove obsolete global type declarations ([fe22166](https://github.com/callimacus/thamyr-sdk/commit/fe221665c994723d546f972c9379cdf4b4eecbc8))
+* remove legacy-peer-deps from .npmrc and update registry configuration for scoped package ([fe22166](https://github.com/callimacus/thamyr-sdk/commit/fe221665c994723d546f972c9379cdf4b4eecbc8))
+
 ## [4.3.5](https://github.com/callimacus/thamyr-sdk/compare/thamyr-core-v4.3.4...thamyr-core-v4.3.5) (2026-09-29)
 
 

package/CHANGELOG.md

@@ -3,6 +3,38 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
+## [4.4.0](https://github.com/callimacus/thamyr-sdk/compare/thamyr-v4.3.5...thamyr-v4.4.0) (2026-09-29)
+
+
+### Features
+
+* **callimacus:** export additional action types from hooks for better type safety ([fe22166](https://github.com/callimacus/thamyr-sdk/commit/fe221665c994723d546f972c9379cdf4b4eecbc8))
+* **ContentAPI:** implement getDocumentByGroupId method to retrieve documents based on language and group ID ([fe22166](https://github.com/callimacus/thamyr-sdk/commit/fe221665c994723d546f972c9379cdf4b4eecbc8))
+* **hooks.ts:** enhance useProducts, useAnalytics, and useSitemap hooks with TypeScript interfaces and detailed documentation ([fe22166](https://github.com/callimacus/thamyr-sdk/commit/fe221665c994723d546f972c9379cdf4b4eecbc8))
+* **react:** add eslint-config-xo-react for better React linting ([fe22166](https://github.com/callimacus/thamyr-sdk/commit/fe221665c994723d546f972c9379cdf4b4eecbc8))
+* **react:** implement Callimacus store and hooks for state management ([fe22166](https://github.com/callimacus/thamyr-sdk/commit/fe221665c994723d546f972c9379cdf4b4eecbc8))
+* **service.ts:** add polling transport option to socket connection for improved connectivity in restricted environments ([fe22166](https://github.com/callimacus/thamyr-sdk/commit/fe221665c994723d546f972c9379cdf4b4eecbc8))
+* **service.ts:** add referrer to auth object for enhanced tracking and analytics ([fe22166](https://github.com/callimacus/thamyr-sdk/commit/fe221665c994723d546f972c9379cdf4b4eecbc8))
+* **thamyr:** parity with the v2 wire, rounds without a message, acknowledged suggestions, receptors and block keys ([#784](https://github.com/callimacus/thamyr-sdk/issues/784)) ([fe22166](https://github.com/callimacus/thamyr-sdk/commit/fe221665c994723d546f972c9379cdf4b4eecbc8))
+
+
+### Bug Fixes
+
+* **AnalyticsAPI.ts, Thamyr.ts:** remove array type from content parameter in trackEvent method for consistency and simplification ([fe22166](https://github.com/callimacus/thamyr-sdk/commit/fe221665c994723d546f972c9379cdf4b4eecbc8))
+* **core/package.json:** update @solomei-ai/intent to version 1.9.2 for latest features and fixes ([fe22166](https://github.com/callimacus/thamyr-sdk/commit/fe221665c994723d546f972c9379cdf4b4eecbc8))
+* **package.json:** remove redundant comma in scripts section to ensure JSON validity ([fe22166](https://github.com/callimacus/thamyr-sdk/commit/fe221665c994723d546f972c9379cdf4b4eecbc8))
+* **package.json:** update @types/react to version 19.2.10 for improved type definitions chore(package.json): bump react and react-dom to version 19.2.4 for latest features and fixes ([fe22166](https://github.com/callimacus/thamyr-sdk/commit/fe221665c994723d546f972c9379cdf4b4eecbc8))
+* **react:** ensure consistent export style across components ([fe22166](https://github.com/callimacus/thamyr-sdk/commit/fe221665c994723d546f972c9379cdf4b4eecbc8))
+* **react:** remove obsolete global type declarations ([fe22166](https://github.com/callimacus/thamyr-sdk/commit/fe221665c994723d546f972c9379cdf4b4eecbc8))
+* remove legacy-peer-deps from .npmrc and update registry configuration for scoped package ([fe22166](https://github.com/callimacus/thamyr-sdk/commit/fe221665c994723d546f972c9379cdf4b4eecbc8))
+
+
+### Dependencies
+
+* The following workspace dependencies were updated
+  * dependencies
+    * @callimacus/thamyr-core bumped from ^4.3.5 to ^4.4.0
+
 ## [4.3.5](https://github.com/callimacus/thamyr-sdk/compare/thamyr-v4.3.4...thamyr-v4.3.5) (2026-09-29)
 
 

package/README.md

@@ -254,6 +254,90 @@ To trigger interactions and send user input, you'll need to handle user events l
    };
    ```
 
+### Rounds Without a Message: Landing, Interactions, Refresh
+
+Not every round starts with a question. The tenant's configuration document declares a landing page and a registry of named **interactions** the storefront may send; the SDK opens those rounds with three helpers, so you never assemble the input event by hand.
+
+```javascript
+// The landing page, composed from the tenant's landing configuration.
+// `value` is the landing value its blocks read ({{input.value}}) — a page slug, a campaign; at most 200 characters.
+thamyr.openLanding('spring-edit', { language: 'it' });
+
+// A declared interaction, with the block it comes from and what it carries.
+thamyr.sendInteraction('pick-size', { block: 'hero', payload: { size: 'M' }, storyId });
+
+// A refresh: the interaction sent with the block's key. The round composes like any other; a block
+// whose `patchOn` names the interaction is updated in place instead (see Block patches).
+thamyr.refresh('hero', 'reshuffle', { storyId });
+```
+
+Every helper takes `storyId` and `language` like `CREATE_ROUND` does; an interaction the tenant declared as `system` is recorded and closed with nothing composed.
+
+Type `sendInteraction` from the tenant's registry by augmenting `ThamyrInteractionMap` once in your project: the id becomes a union of the declared ids and each payload is checked.
+
+```typescript
+declare module '@callimacus/thamyr-core' {
+  interface ThamyrInteractionMap {
+    'pick-size': { size: string };
+    reshuffle: undefined;
+  }
+}
+```
+
+In React the same three helpers come from `useThamyr()` and pass through its connection gate:
+
+```tsx
+const { openLanding, sendInteraction, refresh } = useThamyr();
+```
+
+### Suggestions for the Input Box
+
+`suggest(prefix)` answers through the socket acknowledgment, never as a story response: the tenant's starter questions while the prefix is shorter than three characters, autocomplete from there. It never rejects — a disabled tenant, a lost connection or a timeout (4 s by default) all resolve to no suggestions.
+
+```javascript
+const { suggestions } = await thamyr.suggest(inputText, { storyId, timeoutMs: 2000 });
+```
+
+In React, `useSuggestions(prefix, { storyId })` follows the input as the visitor types — debounced (200 ms by default, the empty prefix asks at once), and a late answer never overwrites a newer prefix:
+
+```tsx
+const [text, setText] = useState('');
+const { suggestions, loading } = useSuggestions(text, { storyId });
+```
+
+### Reading a Round
+
+Three things a round carries are worth reading by name rather than by digging into `data`:
+
+- **Receptors** — the labels the classifier assigned this message (not the session intent). `receptorsOf(chapter)` reads `chapter.receptors`, falling back to the `intent` name older servers used.
+- **Block key** — the identity a block is attributed, pinned and linked by; `block.type` is a render hint two blocks may share. `blockKeyOf(block)` reads it off a custom block (legacy blocks have none).
+- **Add-to-cart result** — when the flow adds to cart, every block of the round carries how it went as `data.addToCart`; `addToCartResultOf(block)` narrows it to `{status: 'resolved' | 'size_selection_needed' | 'error', ...}`. A round that needs a size picked also emits a `custom:addToCartResult` block (`ADD_TO_CART_RESULT_BLOCK`).
+
+```javascript
+thamyr.onResponse((response) => {
+  if (response.type !== ThamyrResponseType.CHAPTER_EVENT) return;
+  const labels = receptorsOf(response.chapter);
+  for (const block of response.chapter.blocks ?? []) {
+    const result = addToCartResultOf(block);
+    if (result?.status === 'size_selection_needed') showSizePicker(result.availableSizes);
+  }
+});
+```
+
+### Block Patches
+
+An interaction a block's rive content declares in `patchOn`, sent with the block's key, does not compose a new round: the server answers with a `block-patch` response that re-sets the animation already on screen. `values`, `inputs` and `textRuns` hold only what changed; `fire` lists the triggers to play once, in order (`input:<name>` or `vm:<name>`).
+
+`applyBlockPatch(chapter, patch)` returns the round with the patch merged into the animation it names (`patch.contentId`, a dotted path into `block.data`), or the same chapter when it holds no such block. The React and React Native stores apply it to the history for you; the patch itself still reaches `onResponse`, which is where to play `fire`, so triggers never replay from state.
+
+```javascript
+thamyr.onResponse((response) => {
+  if (response.type !== ThamyrResponseType.BLOCK_PATCH) return;
+  round = applyBlockPatch(round, response.data);
+  player.fire(response.data.fire);
+});
+```
+
 ### Rendering Blocks
 
 Thamyr responds with different types of content blocks based on the input events. You can render these blocks in your UI using a switch-case structure or dynamic rendering.

package/dist/esm/index.js

@@ -5,5 +5,5 @@
  * See LICENSE.md for the full terms.
  *
  */
-import{callimacusService as n,createContractClient as e,logger as t,CallimacusApi as o,UserInteractionType as s,SLInputEventType as r}from"@callimacus/thamyr-core";export*from"@callimacus/thamyr-core";class a{onConnectionStatusChangeCallback;onResponseCallback;onErrorCallback;onClientInfoCallback;constructor(e={}){const{autoConnect:t=!0,url:o="wss://localhost:4000",token:s,callbacks:r,uiObserver:a}=e;this.onConnectionStatusChangeCallback=r?.onConnectionStatusChange,this.onResponseCallback=r?.onResponse,this.onErrorCallback=r?.onError,this.onClientInfoCallback=r?.onClientInfo,void 0!==a&&n.configureUiObserver(a),this.setupEventListeners(),t&&this.connect(o,s)}setupEventListeners(){n.onConnectionStatus(n=>{this.onConnectionStatusChangeCallback&&this.onConnectionStatusChangeCallback(n)}),n.onServerResponse(n=>{this.onResponseCallback&&this.onResponseCallback(n)}),n.onError(n=>{this.onErrorCallback&&this.onErrorCallback(n)})}connect(e="wss://localhost:4000",t){const o="string"==typeof t&&""!==t,s=o?{Authorization:`Bearer ${t}`}:void 0,r=o?{token:t}:void 0;n.connect(e,s,r)}disconnect(){n.disconnect()}sendUserInteraction(e,t){n.sendUserInteraction(e,t)}gatherClientInfo(){n.gatherClientInfo().then(n=>{this.onClientInfoCallback&&this.onClientInfoCallback(n)})}onConnectionStatusChange(n){return this.onConnectionStatusChangeCallback=n,()=>{this.onConnectionStatusChangeCallback=void 0}}onResponse(n){return this.onResponseCallback=n,()=>{this.onResponseCallback=void 0}}onError(n){return this.onErrorCallback=n,()=>{this.onErrorCallback=void 0}}}class i{config;client;constructor(n){this.config=n,this.client=e(n)}async getSitemap(){const{data:n,error:e,response:o}=await this.client.get({url:"/sitemap.xml",headers:{Accept:"application/xml"},parseAs:"text"});if(void 0===n){const n=o?.status;throw t.error(void 0===n?"sitemap: no response received":`sitemap: API Error ${n}`,e),Object.assign(new Error(void 0===n?"sitemap request failed":`sitemap request failed with status ${n}`),{status:n,error:e})}return n}}const c="https://api.callimacus.ai";function l(n){const e=n??c;if(!function(n){try{return Boolean(new URL(n))}catch{return!1}}(e))throw new Error(`[thamyr] \`endpoint\` must be an absolute URL such as ${c}, got ${JSON.stringify(n)}. Omit it to use the default.`);return e}class h extends o{config;websocketManager;sitemap;constructor(n){const t=l(n.endpoint),{clientId:o}=n;if(!o)throw new Error("[thamyr] `clientId` is required. Pass your Callimacus Client ID (`cal-pk-…`).");super({client:e({accessToken:o,endpoint:t,withCredentials:!0})}),this.config=n,this.sitemap=new i({accessToken:o,endpoint:t}),this.websocketManager=new a({url:t,autoConnect:!0,token:o,uiObserver:n.uiObserver})}sendAudio(n,e){const t=new File([n],"recording.webm",{type:n.type});this.sendUserInteraction(s.CREATE_ROUND,{inputEvent:{type:r.question,data:{value:e??"",file:t}}})}sendUserInteraction(n,e){this.websocketManager.sendUserInteraction(n,e)}onResponse(n){this.websocketManager.onResponse(n)}onError(n){this.websocketManager.onError(n)}}export{i as SitemapAPI,h as Thamyr,a as WebsocketManager};
+import{callimacusService as n,createContractClient as e,logger as t,CallimacusApi as o,UserInteractionType as s,SLInputEventType as r,landingRound as a,interactionRound as i}from"@callimacus/thamyr-core";export*from"@callimacus/thamyr-core";class c{onConnectionStatusChangeCallback;onResponseCallback;onErrorCallback;onClientInfoCallback;constructor(e={}){const{autoConnect:t=!0,url:o="wss://localhost:4000",token:s,callbacks:r,uiObserver:a}=e;this.onConnectionStatusChangeCallback=r?.onConnectionStatusChange,this.onResponseCallback=r?.onResponse,this.onErrorCallback=r?.onError,this.onClientInfoCallback=r?.onClientInfo,void 0!==a&&n.configureUiObserver(a),this.setupEventListeners(),t&&this.connect(o,s)}setupEventListeners(){n.onConnectionStatus(n=>{this.onConnectionStatusChangeCallback&&this.onConnectionStatusChangeCallback(n)}),n.onServerResponse(n=>{this.onResponseCallback&&this.onResponseCallback(n)}),n.onError(n=>{this.onErrorCallback&&this.onErrorCallback(n)})}connect(e="wss://localhost:4000",t){const o="string"==typeof t&&""!==t,s=o?{Authorization:`Bearer ${t}`}:void 0,r=o?{token:t}:void 0;n.connect(e,s,r)}disconnect(){n.disconnect()}sendUserInteraction(e,t){n.sendUserInteraction(e,t)}async suggest(e,t){return n.suggest(e,t)}gatherClientInfo(){n.gatherClientInfo().then(n=>{this.onClientInfoCallback&&this.onClientInfoCallback(n)})}onConnectionStatusChange(n){return this.onConnectionStatusChangeCallback=n,()=>{this.onConnectionStatusChangeCallback=void 0}}onResponse(n){return this.onResponseCallback=n,()=>{this.onResponseCallback=void 0}}onError(n){return this.onErrorCallback=n,()=>{this.onErrorCallback=void 0}}}class l{config;client;constructor(n){this.config=n,this.client=e(n)}async getSitemap(){const{data:n,error:e,response:o}=await this.client.get({url:"/sitemap.xml",headers:{Accept:"application/xml"},parseAs:"text"});if(void 0===n){const n=o?.status;throw t.error(void 0===n?"sitemap: no response received":`sitemap: API Error ${n}`,e),Object.assign(new Error(void 0===n?"sitemap request failed":`sitemap request failed with status ${n}`),{status:n,error:e})}return n}}const u="https://api.callimacus.ai";function h(n){const e=n??u;if(!function(n){try{return Boolean(new URL(n))}catch{return!1}}(e))throw new Error(`[thamyr] \`endpoint\` must be an absolute URL such as ${u}, got ${JSON.stringify(n)}. Omit it to use the default.`);return e}class C extends o{config;websocketManager;sitemap;constructor(n){const t=h(n.endpoint),{clientId:o}=n;if(!o)throw new Error("[thamyr] `clientId` is required. Pass your Callimacus Client ID (`cal-pk-…`).");super({client:e({accessToken:o,endpoint:t,withCredentials:!0})}),this.config=n,this.sitemap=new l({accessToken:o,endpoint:t}),this.websocketManager=new c({url:t,autoConnect:!0,token:o,uiObserver:n.uiObserver})}sendAudio(n,e){const t=new File([n],"recording.webm",{type:n.type});this.sendUserInteraction(s.CREATE_ROUND,{inputEvent:{type:r.question,data:{value:e??"",file:t}}})}sendUserInteraction(n,e){this.websocketManager.sendUserInteraction(n,e)}openLanding(n,e={}){this.sendUserInteraction(s.CREATE_ROUND,a(n,e))}sendInteraction(n,e={}){this.sendUserInteraction(s.CREATE_ROUND,i(n,e))}refresh(n,e,t={}){this.sendInteraction(e,{...t,block:n})}async suggest(n="",e={}){const{timeoutMs:t,storyId:o,language:s}=e;return this.websocketManager.suggest({prefix:n,storyId:o??void 0,language:s},{timeoutMs:t})}onResponse(n){this.websocketManager.onResponse(n)}onError(n){this.websocketManager.onError(n)}}export{l as SitemapAPI,C as Thamyr,c as WebsocketManager};
 //# sourceMappingURL=index.js.map

package/dist/esm/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sources":["../../../src/components/callimacus/manager.ts","../../../src/service/sitemap-api.ts","../../../src/service/thamyr.ts"],"sourcesContent":[null,null,null],"names":["WebsocketManager","onConnectionStatusChangeCallback","onResponseCallback","onErrorCallback","onClientInfoCallback","constructor","options","autoConnect","url","token","callbacks","uiObserver","this","onConnectionStatusChange","onResponse","onError","onClientInfo","undefined","callimacusService","configureUiObserver","setupEventListeners","connect","onConnectionStatus","isConnected","onServerResponse","response","error","hasToken","headers","Authorization","auth","disconnect","sendUserInteraction","type","payload","gatherClientInfo","then","clientInfo","callback","SitemapAPI","config","client","createContractClient","getSitemap","data","get","Accept","parseAs","status","logger","Object","assign","Error","DEFAULT_ENDPOINT","resolveEndpoint","endpoint","resolved","value","Boolean","URL","isAbsoluteUrl","JSON","stringify","Thamyr","CallimacusApi","websocketManager","sitemap","clientId","super","accessToken","withCredentials","sendAudio","audio","query","file","File","UserInteractionType","CREATE_ROUND","inputEvent","SLInputEventType","question"],"mappings":";;;;;;;+MA+FaA,EAEJC,iCACAC,mBACAC,gBACSC,qBAMjB,WAAAC,CAAYC,EAAoC,IAC/C,MAAMC,YACLA,GAAc,EAAIC,IAClBA,EAAM,uBAAsBC,MAC5BA,EAAKC,UACLA,EAASC,WACTA,GACGL,EAGJM,KAAKX,iCAAmCS,GAAWG,yBACnDD,KAAKV,mBAAqBQ,GAAWI,WACrCF,KAAKT,gBAAkBO,GAAWK,QAClCH,KAAKR,qBAAuBM,GAAWM,kBAEpBC,IAAfN,GACHO,EAAkBC,oBAAoBR,GAIvCC,KAAKQ,sBAEDb,GACHK,KAAKS,QAAQb,EAAKC,EAEpB,CAKQ,mBAAAW,GACPF,EAAkBI,mBAAmBC,IAChCX,KAAKX,kCACRW,KAAKX,iCAAiCsB,KAIxCL,EAAkBM,iBAAiBC,IAC9Bb,KAAKV,oBACRU,KAAKV,mBAAmBuB,KAI1BP,EAAkBH,QAASW,IACtBd,KAAKT,iBACRS,KAAKT,gBAAgBuB,IAGxB,CAQO,OAAAL,CAAQb,EAAM,uBAAwBC,GAG5C,MAAMkB,EAA4B,iBAAVlB,GAAgC,KAAVA,EAExCmB,EAAUD,EAAW,CAACE,cAAe,UAAUpB,UAAWQ,EAC1Da,EAAOH,EAAW,CAAClB,cAASQ,EAClCC,EAAkBG,QAAQb,EAAKoB,EAASE,EACzC,CAKO,UAAAC,GACNb,EAAkBa,YACnB,CASO,mBAAAC,CAAmDC,EAASC,GAClEhB,EAAkBc,oBAAoBC,EAAMC,EAC7C,CAKO,gBAAAC,GACDjB,EAAkBiB,mBAAmBC,KAAKC,IAC1CzB,KAAKR,sBACRQ,KAAKR,qBAAqBiC,IAG7B,CAQO,wBAAAxB,CAAyByB,GAE/B,OADA1B,KAAKX,iCAAmCqC,EACjC,KACN1B,KAAKX,sCAAmCgB,EAE1C,CAQO,UAAAH,CAAWwB,GAEjB,OADA1B,KAAKV,mBAAqBoC,EACnB,KACN1B,KAAKV,wBAAqBe,EAE5B,CAQO,OAAAF,CAAQuB,GAEd,OADA1B,KAAKT,gBAAkBmC,EAChB,KACN1B,KAAKT,qBAAkBc,EAEzB,QCtOYsB,EAGgBC,OAFXC,OAEjB,WAAApC,CAA4BmC,GAAA5B,KAAA4B,OAAAA,EAI3B5B,KAAK6B,OAASC,EAAqBF,EACpC,CAOA,gBAAMG,GACL,MAAMC,KAACA,EAAIlB,MAAEA,EAAKD,SAAEA,SAAkBb,KAAK6B,OAAOI,IAAmB,CACpErC,IAAK,eAELoB,QAAS,CAACkB,OAAQ,mBAClBC,QAAS,SAEV,QAAa9B,IAAT2B,EAAoB,CACvB,MAAMI,EAASvB,GAAUuB,OAEzB,MADAC,EAAOvB,WAAiBT,IAAX+B,EAAuB,gCAAkC,sBAAsBA,IAAUtB,GAChGwB,OAAOC,OAAO,IAAIC,WAAiBnC,IAAX+B,EAAuB,yBAA2B,sCAAsCA,KAAW,CAACA,SAAQtB,SAC3I,CAEA,OAAOkB,CACR,ECxBD,MAAMS,EAAmB,4BAWzB,SAASC,EAAgBC,GACxB,MAAMC,EAAWD,GAAYF,EAC7B,IAOD,SAAuBI,GACtB,IACC,OAAOC,QAAQ,IAAIC,IAAIF,GACxB,CAAE,MACD,OAAO,CACR,CACD,CAbMG,CAAcJ,GAClB,MAAM,IAAIJ,MAAM,yDAAyDC,UAAyBQ,KAAKC,UAAUP,mCAGlH,OAAOC,CACR,CAeM,MAAOO,UAAeC,EAOCxB,OANXyB,iBAIDC,QAEhB,WAAA7D,CAA4BmC,GAQ3B,MAAMe,EAAWD,EAAgBd,EAAOe,WAClCY,SAACA,GAAY3B,EAGnB,IAAK2B,EACJ,MAAM,IAAIf,MAAM,iFAOjBgB,MAAM,CAAC3B,OAAQC,EAAqB,CAAC2B,YAAaF,EAAUZ,WAAUe,iBAAiB,MApB5D1D,KAAA4B,OAAAA,EAsB3B5B,KAAKsD,QAAU,IAAI3B,EAAW,CAC7B8B,YAAaF,EACbZ,aAGD3C,KAAKqD,iBAAmB,IAAIjE,EAAiB,CAC5CQ,IAAK+C,EACLhD,aAAa,EACbE,MAAO0D,EACPxD,WAAY6B,EAAO7B,YAErB,CAEA,SAAA4D,CAAUC,EAAaC,GACtB,MAAMC,EAAO,IAAIC,KAAK,CAACH,GAAQ,iBAAkB,CAACvC,KAAMuC,EAAMvC,OAC9DrB,KAAKoB,oBAAoB4C,EAAoBC,aAAc,CAC1DC,WAAY,CACX7C,KAAM8C,EAAiBC,SACvBpC,KAAM,CAACa,MAAOgB,GAAS,GAAIC,UAG9B,CAEA,mBAAA1C,CAAmDC,EAASC,GAC3DtB,KAAKqD,iBAAiBjC,oBAAoBC,EAAMC,EACjD,CAEA,UAAApB,CAAWwB,GACV1B,KAAKqD,iBAAiBnD,WAAWwB,EAClC,CAEA,OAAAvB,CAAQuB,GACP1B,KAAKqD,iBAAiBlD,QAAQuB,EAC/B"}
+{"version":3,"file":"index.js","sources":["../../../src/components/callimacus/manager.ts","../../../src/service/sitemap-api.ts","../../../src/service/thamyr.ts"],"sourcesContent":[null,null,null],"names":["WebsocketManager","onConnectionStatusChangeCallback","onResponseCallback","onErrorCallback","onClientInfoCallback","constructor","options","autoConnect","url","token","callbacks","uiObserver","this","onConnectionStatusChange","onResponse","onError","onClientInfo","undefined","callimacusService","configureUiObserver","setupEventListeners","connect","onConnectionStatus","isConnected","onServerResponse","response","error","hasToken","headers","Authorization","auth","disconnect","sendUserInteraction","type","payload","suggest","gatherClientInfo","then","clientInfo","callback","SitemapAPI","config","client","createContractClient","getSitemap","data","get","Accept","parseAs","status","logger","Object","assign","Error","DEFAULT_ENDPOINT","resolveEndpoint","endpoint","resolved","value","Boolean","URL","isAbsoluteUrl","JSON","stringify","Thamyr","CallimacusApi","websocketManager","sitemap","clientId","super","accessToken","withCredentials","sendAudio","audio","query","file","File","UserInteractionType","CREATE_ROUND","inputEvent","SLInputEventType","question","openLanding","landingRound","sendInteraction","id","interactionRound","refresh","block","interaction","prefix","timeoutMs","storyId","language"],"mappings":";;;;;;;uPAiGaA,EAEJC,iCACAC,mBACAC,gBACSC,qBAMjB,WAAAC,CAAYC,EAAoC,IAC/C,MAAMC,YACLA,GAAc,EAAIC,IAClBA,EAAM,uBAAsBC,MAC5BA,EAAKC,UACLA,EAASC,WACTA,GACGL,EAGJM,KAAKX,iCAAmCS,GAAWG,yBACnDD,KAAKV,mBAAqBQ,GAAWI,WACrCF,KAAKT,gBAAkBO,GAAWK,QAClCH,KAAKR,qBAAuBM,GAAWM,kBAEpBC,IAAfN,GACHO,EAAkBC,oBAAoBR,GAIvCC,KAAKQ,sBAEDb,GACHK,KAAKS,QAAQb,EAAKC,EAEpB,CAKQ,mBAAAW,GACPF,EAAkBI,mBAAmBC,IAChCX,KAAKX,kCACRW,KAAKX,iCAAiCsB,KAIxCL,EAAkBM,iBAAiBC,IAC9Bb,KAAKV,oBACRU,KAAKV,mBAAmBuB,KAI1BP,EAAkBH,QAASW,IACtBd,KAAKT,iBACRS,KAAKT,gBAAgBuB,IAGxB,CAQO,OAAAL,CAAQb,EAAM,uBAAwBC,GAG5C,MAAMkB,EAA4B,iBAAVlB,GAAgC,KAAVA,EAExCmB,EAAUD,EAAW,CAACE,cAAe,UAAUpB,UAAWQ,EAC1Da,EAAOH,EAAW,CAAClB,cAASQ,EAClCC,EAAkBG,QAAQb,EAAKoB,EAASE,EACzC,CAKO,UAAAC,GACNb,EAAkBa,YACnB,CASO,mBAAAC,CAAmDC,EAASC,GAClEhB,EAAkBc,oBAAoBC,EAAMC,EAC7C,CAKO,aAAMC,CAAQD,EAAyB5B,GAC7C,OAAOY,EAAkBiB,QAAQD,EAAS5B,EAC3C,CAKO,gBAAA8B,GACDlB,EAAkBkB,mBAAmBC,KAAKC,IAC1C1B,KAAKR,sBACRQ,KAAKR,qBAAqBkC,IAG7B,CAQO,wBAAAzB,CAAyB0B,GAE/B,OADA3B,KAAKX,iCAAmCsC,EACjC,KACN3B,KAAKX,sCAAmCgB,EAE1C,CAQO,UAAAH,CAAWyB,GAEjB,OADA3B,KAAKV,mBAAqBqC,EACnB,KACN3B,KAAKV,wBAAqBe,EAE5B,CAQO,OAAAF,CAAQwB,GAEd,OADA3B,KAAKT,gBAAkBoC,EAChB,KACN3B,KAAKT,qBAAkBc,EAEzB,QC/OYuB,EAGgBC,OAFXC,OAEjB,WAAArC,CAA4BoC,GAAA7B,KAAA6B,OAAAA,EAI3B7B,KAAK8B,OAASC,EAAqBF,EACpC,CAOA,gBAAMG,GACL,MAAMC,KAACA,EAAInB,MAAEA,EAAKD,SAAEA,SAAkBb,KAAK8B,OAAOI,IAAmB,CACpEtC,IAAK,eAELoB,QAAS,CAACmB,OAAQ,mBAClBC,QAAS,SAEV,QAAa/B,IAAT4B,EAAoB,CACvB,MAAMI,EAASxB,GAAUwB,OAEzB,MADAC,EAAOxB,WAAiBT,IAAXgC,EAAuB,gCAAkC,sBAAsBA,IAAUvB,GAChGyB,OAAOC,OAAO,IAAIC,WAAiBpC,IAAXgC,EAAuB,yBAA2B,sCAAsCA,KAAW,CAACA,SAAQvB,SAC3I,CAEA,OAAOmB,CACR,EClBD,MAAMS,EAAmB,4BAWzB,SAASC,EAAgBC,GACxB,MAAMC,EAAWD,GAAYF,EAC7B,IAOD,SAAuBI,GACtB,IACC,OAAOC,QAAQ,IAAIC,IAAIF,GACxB,CAAE,MACD,OAAO,CACR,CACD,CAbMG,CAAcJ,GAClB,MAAM,IAAIJ,MAAM,yDAAyDC,UAAyBQ,KAAKC,UAAUP,mCAGlH,OAAOC,CACR,CAeM,MAAOO,UAAeC,EAOCxB,OANXyB,iBAIDC,QAEhB,WAAA9D,CAA4BoC,GAQ3B,MAAMe,EAAWD,EAAgBd,EAAOe,WAClCY,SAACA,GAAY3B,EAGnB,IAAK2B,EACJ,MAAM,IAAIf,MAAM,iFAOjBgB,MAAM,CAAC3B,OAAQC,EAAqB,CAAC2B,YAAaF,EAAUZ,WAAUe,iBAAiB,MApB5D3D,KAAA6B,OAAAA,EAsB3B7B,KAAKuD,QAAU,IAAI3B,EAAW,CAC7B8B,YAAaF,EACbZ,aAGD5C,KAAKsD,iBAAmB,IAAIlE,EAAiB,CAC5CQ,IAAKgD,EACLjD,aAAa,EACbE,MAAO2D,EACPzD,WAAY8B,EAAO9B,YAErB,CAEA,SAAA6D,CAAUC,EAAaC,GACtB,MAAMC,EAAO,IAAIC,KAAK,CAACH,GAAQ,iBAAkB,CAACxC,KAAMwC,EAAMxC,OAC9DrB,KAAKoB,oBAAoB6C,EAAoBC,aAAc,CAC1DC,WAAY,CACX9C,KAAM+C,EAAiBC,SACvBpC,KAAM,CAACa,MAAOgB,GAAS,GAAIC,UAG9B,CAEA,mBAAA3C,CAAmDC,EAASC,GAC3DtB,KAAKsD,iBAAiBlC,oBAAoBC,EAAMC,EACjD,CAOA,WAAAgD,CAAYxB,EAAgBpD,EAAwB,IACnDM,KAAKoB,oBAAoB6C,EAAoBC,aAAcK,EAAazB,EAAOpD,GAChF,CAQA,eAAA8E,CAAyCC,EAAO/E,EAAiC,IAChFM,KAAKoB,oBAAoB6C,EAAoBC,aAAcQ,EAAiBD,EAAI/E,GACjF,CASA,OAAAiF,CAAQC,EAAeC,EAA4BnF,EAAwB,CAAA,GAC1EM,KAAKwE,gBAAgBK,EAAa,IAAInF,EAASkF,SAChD,CASA,aAAMrD,CAAQuD,EAAS,GAAIpF,EAA+C,CAAA,GACzE,MAAMqF,UAACA,EAASC,QAAEA,EAAOC,SAAEA,GAAYvF,EACvC,OAAOM,KAAKsD,iBAAiB/B,QAAQ,CAACuD,SAAQE,QAASA,QAAW3E,EAAW4E,YAAW,CAACF,aAC1F,CAEA,UAAA7E,CAAWyB,GACV3B,KAAKsD,iBAAiBpD,WAAWyB,EAClC,CAEA,OAAAxB,CAAQwB,GACP3B,KAAKsD,iBAAiBnD,QAAQwB,EAC/B"}

package/dist/types/index.d.ts

@@ -5,7 +5,7 @@
  * See LICENSE.md for the full terms.
  *
  */
-import { ThamyrResponse, ErrorMessage, ClientInfo, UiObserverConfig, UserInteractionType, InteractionPayloadMap, CallimacusApi } from '@callimacus/thamyr-core';
+import { ThamyrResponse, ErrorMessage, ClientInfo, UiObserverConfig, UserInteractionType, InteractionPayloadMap, SuggestPayload, Suggestions, CallimacusApi, RoundOptions, InteractionId, InteractionOptions } from '@callimacus/thamyr-core';
 export * from '@callimacus/thamyr-core';
 
 /**
@@ -119,6 +119,12 @@ declare class WebsocketManager {
      @param payload - The properly typed payload for this interaction type
      */
     sendUserInteraction<T extends UserInteractionType>(type: T, payload: InteractionPayloadMap[T]): void;
+    /**
+     Prompt suggestions through the socket acknowledgment; resolves to none when disconnected.
+     */
+    suggest(payload: SuggestPayload, options?: {
+        timeoutMs?: number;
+    }): Promise<Suggestions>;
     /**
      Gathers client information
      */
@@ -195,6 +201,37 @@ declare class Thamyr extends CallimacusApi {
     });
     sendAudio(audio: Blob, query?: string): void;
     sendUserInteraction<T extends UserInteractionType>(type: T, payload: InteractionPayloadMap[T]): void;
+    /**
+     Opens the landing page: a round with no message, composed from the tenant's
+     landing configuration. `value` is the landing value its blocks and conditions
+     read (`{{input.value}}`) — a page slug, a campaign; at most 200 characters.
+     */
+    openLanding(value?: string, options?: RoundOptions): void;
+    /**
+     Sends one of the interactions the tenant declared in its configuration
+     document. Augment `ThamyrInteractionMap` (from `@callimacus/thamyr-core`) with
+     the registry and the id and payload are typed; a `system` interaction is
+     recorded and closed with nothing composed.
+     */
+    sendInteraction<I extends InteractionId>(id: I, options?: InteractionOptions<I>): void;
+    /**
+     Sends an interaction on behalf of one block. The round composes like any
+     other; a block whose `patchOn` names the interaction is patched in place.
+     @param block - The block's key
+     @param interaction - The refresh interaction the block declares
+     @param options - The story to continue and the language to compose in
+     */
+    refresh(block: string, interaction: InteractionId, options?: RoundOptions): void;
+    /**
+     Prompt suggestions for the input box: the tenant's starter questions while the
+     prefix is shorter than three characters, autocomplete from there. Called with
+     no prefix — an empty input box — it asks for the starters. Resolves to no
+     suggestions — never rejects — when the tenant disabled them, the socket is
+     down or the server did not answer within `timeoutMs` (default 4 s).
+     */
+    suggest(prefix?: string, options?: RoundOptions & {
+        timeoutMs?: number;
+    }): Promise<Suggestions>;
     onResponse(callback: (response: ThamyrResponse) => void): void;
     onError(callback: (error: ErrorMessage) => void): void;
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@callimacus/thamyr",
-  "version": "4.3.5",
+  "version": "4.4.0",
   "private": false,
   "description": "JavaScript package for Thamyr",
   "license": "SEE LICENSE IN LICENSE.md",
@@ -35,7 +35,7 @@
     "test": "vitest run"
   },
   "dependencies": {
-    "@callimacus/thamyr-core": "^4.3.5"
+    "@callimacus/thamyr-core": "^4.4.0"
   },
   "gitHead": "fafba2c8ca0586f95b1d03c5eede356a53b00886",
   "devDependencies": {