@callimacus/thamyr-core 4.5.0 → 4.6.0

package/dist/types/index.d.ts

@@ -380,6 +380,10 @@ type SlInputEvent = {
         payload?: {
             [key: string]: unknown;
         };
+        /**
+         * Minted by the site for a delivered interaction (a form): a repeated emit gets the stored result back, and the chapter carrying it resolves the site's `run()`.
+         */
+        submissionId?: string;
         nodeKey?: string;
         interactionId: string;
         value?: string | Array<string>;
@@ -817,6 +821,10 @@ type CreateRoundContextOutput = {
     };
     userAgent?: string;
     acceptLanguageLocale?: string;
+    /**
+     * The page title, carried in a delivered interaction's envelope.
+     */
+    title?: string;
     [key: string]: unknown;
 };
 type CustomBlockOutput = {
@@ -1100,6 +1108,10 @@ type SlInputEventOutput = {
         payload?: {
             [key: string]: unknown;
         };
+        /**
+         * Minted by the site for a delivered interaction (a form): a repeated emit gets the stored result back, and the chapter carrying it resolves the site's `run()`.
+         */
+        submissionId?: string;
         nodeKey?: string;
         interactionId: string;
         value?: string | Array<string>;
@@ -1385,6 +1397,12 @@ type SkesisSimilarResponse = {
         score: number;
         item: SkesisItem;
     }>;
+    /**
+     * Present only when the request set `explain: true`: what each stage of the pipeline decided, keyed by stage (search runs plan, route, retrieve, assess, relax and rank; the other pipelines a subset), plus `timings` in milliseconds. Decisions only — never what the engine was told.
+     */
+    trace?: {
+        [key: string]: unknown;
+    };
 };
 type SkesisRelatedResponse = {
     related: Array<{
@@ -1396,6 +1414,12 @@ type SkesisRelatedResponse = {
         item: SkesisItem;
     }>;
     usedFallback: boolean;
+    /**
+     * Present only when the request set `explain: true`: what each stage of the pipeline decided, keyed by stage (search runs plan, route, retrieve, assess, relax and rank; the other pipelines a subset), plus `timings` in milliseconds. Decisions only — never what the engine was told.
+     */
+    trace?: {
+        [key: string]: unknown;
+    };
 };
 /**
  * Document representing an order address.
@@ -3335,6 +3359,10 @@ type UiSnapshot = {
 };
 type InteractionContext = {
     uiSnapshot?: UiSnapshot;
+    /**
+    The page title, carried in a delivered interaction's envelope.
+    */
+    title?: string;
 };
 type UiObserverConfig = {
     enabled?: boolean;
@@ -3456,6 +3484,10 @@ type InteractionOptions<I extends InteractionId = InteractionId> = RoundOptions
     block?: string;
     payload?: InteractionPayload<I>;
     /**
+    Minted by the site for a delivered interaction (a form): a repeated emit gets the stored result back, and the chapter carrying it resolves the site's `run()`.
+    */
+    submissionId?: string;
+    /**
     A value the interaction carries (a chosen option, a list of them).
     */
     value?: string | string[];
@@ -3805,6 +3837,95 @@ declare function shouldRetryHandshake(code: number, attemptsSoFar: number): bool
  */
 declare function classifyConnectError(error: Error, isActive: boolean): ConnectRejection | undefined;
 
+type Action = 
+/**
+Opens a URL in the browser; `#section` scrolls the page.
+*/
+{
+    type: 'link';
+    url: string;
+    newTab?: boolean;
+}
+/**
+A question round, as if the visitor typed it.
+*/
+ | {
+    type: 'ask';
+    value: string;
+}
+/**
+A declared interaction round: open a category, a page, a profile; refresh a block.
+*/
+ | {
+    type: 'interact';
+    id: string;
+    value?: string | string[];
+    payload?: Record<string, unknown>;
+    block?: string;
+}
+/**
+Adds a product to the cart.
+*/
+ | {
+    type: 'cart';
+    productId: string;
+}
+/**
+Sends the component's inputs as a round of the project's `input` interaction of that name — a form — and waits for its delivery result.
+*/
+ | {
+    type: 'submit';
+    form: string;
+};
+type ActionType = Action['type'];
+declare const ACTION_TYPES: readonly ActionType[];
+/**
+ The action in a value the composer produced — or `undefined` when it is not
+ one: unknown type, missing or mistyped fields, a link that is not http(s), mailto, tel or relative. Read block
+ data through this, never trust it as typed.
+*/
+declare function actionOf(value: unknown): Action | undefined;
+/**
+ The fields of a form, as a `submit` sends them: every input by name, a string
+ when the name has one value and a list when it has several (`getAll`). A name
+ ending in `[]` is always a list, the `[]` taken off (`topics[]` → `topics`), so
+ a checkbox group or a multiple select keeps its shape with one box checked.
+ A file is left out — an interaction carries no binary. A checkbox arrives as its
+ `value` (`on` by default), not as a boolean.
+*/
+declare function fieldsOf(form: HTMLFormElement | FormData): Record<string, string | string[]>;
+/**
+The block a delivered interaction (a form) opens its round with: what the submission came to.
+*/
+declare const DELIVER_RESULT_BLOCK = "custom:deliverResult";
+/**
+How a submission resolved. `accepted`: it is in, outages included. `refused`: the primary destination
+rejected it and nothing fanned out. `results` holds one entry per destination, keyed by its position.
+*/
+type DeliverResult = {
+    status: 'accepted' | 'refused';
+    submissionId: string;
+    message?: string;
+    redirect?: string;
+    errors?: Array<{
+        field?: string;
+        message: string;
+    }>;
+    results: Record<string, {
+        status: 'done' | 'pending' | 'ambiguous' | 'skipped';
+        ref?: string;
+    }>;
+};
+/**
+The delivery result a block carries — it is the round's `custom:deliverResult` block — or `undefined`
+for any other block, or a result with a field missing or mistyped. A redirect the site could not hand to
+`location.assign` (not http(s), mailto, tel or a path) is dropped, the rest of the result kept.
+*/
+declare function deliverResultOf(block: {
+    type: string;
+    data?: unknown;
+}): DeliverResult | undefined;
+
 /**
  Logger utility for Thamyr SDK
  Provides configurable logging that can be enabled/disabled to avoid console spam
@@ -3929,5 +4050,5 @@ declare function createContractClient(config: {
     withCredentials?: boolean;
 }): ContractClient;
 
-export { ADD_TO_CART_RESULT_BLOCK, CallimacusApi, CallimacusEvent, CallimacusService, ChapterStatus, ClientEvents, GalleryMode, LANDING_VALUE_MAX_LENGTH, MAX_HANDSHAKE_RETRIES, SLInputEventType, ServerEvents, ThamyrHttpError, ThamyrResponseType, UserInteractionType, addToCartResultOf, applyBlockPatch, blockKeyOf, callimacusService, classifyConnectError, createContractClient, extractTtsAudio, interactionRound, isCustomBlock, isMasterProduct, isSetProduct, landingRound, logger, parseConnectRejection, randomUuid, receptorsOf, shouldRetryHandshake, transformImageUrl };
-export type { AddToCartResult, BCProduct, Basket, Block, BlockPatch, BoundingBox, CallimacusErrorMessage, Chapter, ClientInfo, ConnectRejection, ConnectionStatusCallback, ContractClient, CustomBlock, ErrorCallback, ErrorMessage, Gallery, GenericProduct, HomePage, Image, ImageEdits, ImageFormatEdit, ImageResizeEdit, InteractionContext, InteractionId, InteractionOptions, InteractionPayload, InteractionPayloadMap, LegacyBlock, LocalizedEPArtwork, LocalizedEPChapter, LogLevel, LoggerConfig, MasterProduct, MasterProductWithVariationGroup, OptionItem, ProductItem, ProductMatch, RecommendationsResponse, RiveManifest, RoundOptions, SLDocument, SLDocumentSection, SLInputEvent, ServerResponseCallback, SetProduct, SkesisItem, SkesisRelatedResponse, SkesisSimilarResponse, Story, SuggestPayload, Suggestions, ThamyrInteractionMap, ThamyrResponse, Topic, TopicContentsPage, TopicSummary, TtsAudio, UiElement, UiObserverConfig, UiSnapshot, UserInteraction, Variant, VariationAttribute, VariationGroup, Video, WhisperPayload };
+export { ACTION_TYPES, ADD_TO_CART_RESULT_BLOCK, CallimacusApi, CallimacusEvent, CallimacusService, ChapterStatus, ClientEvents, DELIVER_RESULT_BLOCK, GalleryMode, LANDING_VALUE_MAX_LENGTH, MAX_HANDSHAKE_RETRIES, SLInputEventType, ServerEvents, ThamyrHttpError, ThamyrResponseType, UserInteractionType, actionOf, addToCartResultOf, applyBlockPatch, blockKeyOf, callimacusService, classifyConnectError, createContractClient, deliverResultOf, extractTtsAudio, fieldsOf, interactionRound, isCustomBlock, isMasterProduct, isSetProduct, landingRound, logger, parseConnectRejection, randomUuid, receptorsOf, shouldRetryHandshake, transformImageUrl };
+export type { Action, ActionType, AddToCartResult, BCProduct, Basket, Block, BlockPatch, BoundingBox, CallimacusErrorMessage, Chapter, ClientInfo, ConnectRejection, ConnectionStatusCallback, ContractClient, CustomBlock, DeliverResult, ErrorCallback, ErrorMessage, Gallery, GenericProduct, HomePage, Image, ImageEdits, ImageFormatEdit, ImageResizeEdit, InteractionContext, InteractionId, InteractionOptions, InteractionPayload, InteractionPayloadMap, LegacyBlock, LocalizedEPArtwork, LocalizedEPChapter, LogLevel, LoggerConfig, MasterProduct, MasterProductWithVariationGroup, OptionItem, ProductItem, ProductMatch, RecommendationsResponse, RiveManifest, RoundOptions, SLDocument, SLDocumentSection, SLInputEvent, ServerResponseCallback, SetProduct, SkesisItem, SkesisRelatedResponse, SkesisSimilarResponse, Story, SuggestPayload, Suggestions, ThamyrInteractionMap, ThamyrResponse, Topic, TopicContentsPage, TopicSummary, TtsAudio, UiElement, UiObserverConfig, UiSnapshot, UserInteraction, Variant, VariationAttribute, VariationGroup, Video, WhisperPayload };

package/dist/types/index.native.d.ts

@@ -378,6 +378,10 @@ type SlInputEvent = {
         payload?: {
             [key: string]: unknown;
         };
+        /**
+         * Minted by the site for a delivered interaction (a form): a repeated emit gets the stored result back, and the chapter carrying it resolves the site's `run()`.
+         */
+        submissionId?: string;
         nodeKey?: string;
         interactionId: string;
         value?: string | Array<string>;
@@ -815,6 +819,10 @@ type CreateRoundContextOutput = {
     };
     userAgent?: string;
     acceptLanguageLocale?: string;
+    /**
+     * The page title, carried in a delivered interaction's envelope.
+     */
+    title?: string;
     [key: string]: unknown;
 };
 type CustomBlockOutput = {
@@ -1098,6 +1106,10 @@ type SlInputEventOutput = {
         payload?: {
             [key: string]: unknown;
         };
+        /**
+         * Minted by the site for a delivered interaction (a form): a repeated emit gets the stored result back, and the chapter carrying it resolves the site's `run()`.
+         */
+        submissionId?: string;
         nodeKey?: string;
         interactionId: string;
         value?: string | Array<string>;
@@ -1383,6 +1395,12 @@ type SkesisSimilarResponse = {
         score: number;
         item: SkesisItem;
     }>;
+    /**
+     * Present only when the request set `explain: true`: what each stage of the pipeline decided, keyed by stage (search runs plan, route, retrieve, assess, relax and rank; the other pipelines a subset), plus `timings` in milliseconds. Decisions only — never what the engine was told.
+     */
+    trace?: {
+        [key: string]: unknown;
+    };
 };
 type SkesisRelatedResponse = {
     related: Array<{
@@ -1394,6 +1412,12 @@ type SkesisRelatedResponse = {
         item: SkesisItem;
     }>;
     usedFallback: boolean;
+    /**
+     * Present only when the request set `explain: true`: what each stage of the pipeline decided, keyed by stage (search runs plan, route, retrieve, assess, relax and rank; the other pipelines a subset), plus `timings` in milliseconds. Decisions only — never what the engine was told.
+     */
+    trace?: {
+        [key: string]: unknown;
+    };
 };
 /**
  * Document representing an order address.
@@ -3333,6 +3357,10 @@ type UiSnapshot = {
 };
 type InteractionContext = {
     uiSnapshot?: UiSnapshot;
+    /**
+    The page title, carried in a delivered interaction's envelope.
+    */
+    title?: string;
 };
 type UiObserverConfig = {
     enabled?: boolean;
@@ -3454,6 +3482,10 @@ type InteractionOptions<I extends InteractionId = InteractionId> = RoundOptions
     block?: string;
     payload?: InteractionPayload<I>;
     /**
+    Minted by the site for a delivered interaction (a form): a repeated emit gets the stored result back, and the chapter carrying it resolves the site's `run()`.
+    */
+    submissionId?: string;
+    /**
     A value the interaction carries (a chosen option, a list of them).
     */
     value?: string | string[];
@@ -3803,6 +3835,95 @@ declare function shouldRetryHandshake(code: number, attemptsSoFar: number): bool
  */
 declare function classifyConnectError(error: Error, isActive: boolean): ConnectRejection | undefined;
 
+type Action = 
+/**
+Opens a URL in the browser; `#section` scrolls the page.
+*/
+{
+    type: 'link';
+    url: string;
+    newTab?: boolean;
+}
+/**
+A question round, as if the visitor typed it.
+*/
+ | {
+    type: 'ask';
+    value: string;
+}
+/**
+A declared interaction round: open a category, a page, a profile; refresh a block.
+*/
+ | {
+    type: 'interact';
+    id: string;
+    value?: string | string[];
+    payload?: Record<string, unknown>;
+    block?: string;
+}
+/**
+Adds a product to the cart.
+*/
+ | {
+    type: 'cart';
+    productId: string;
+}
+/**
+Sends the component's inputs as a round of the project's `input` interaction of that name — a form — and waits for its delivery result.
+*/
+ | {
+    type: 'submit';
+    form: string;
+};
+type ActionType = Action['type'];
+declare const ACTION_TYPES: readonly ActionType[];
+/**
+ The action in a value the composer produced — or `undefined` when it is not
+ one: unknown type, missing or mistyped fields, a link that is not http(s), mailto, tel or relative. Read block
+ data through this, never trust it as typed.
+*/
+declare function actionOf(value: unknown): Action | undefined;
+/**
+ The fields of a form, as a `submit` sends them: every input by name, a string
+ when the name has one value and a list when it has several (`getAll`). A name
+ ending in `[]` is always a list, the `[]` taken off (`topics[]` → `topics`), so
+ a checkbox group or a multiple select keeps its shape with one box checked.
+ A file is left out — an interaction carries no binary. A checkbox arrives as its
+ `value` (`on` by default), not as a boolean.
+*/
+declare function fieldsOf(form: HTMLFormElement | FormData): Record<string, string | string[]>;
+/**
+The block a delivered interaction (a form) opens its round with: what the submission came to.
+*/
+declare const DELIVER_RESULT_BLOCK = "custom:deliverResult";
+/**
+How a submission resolved. `accepted`: it is in, outages included. `refused`: the primary destination
+rejected it and nothing fanned out. `results` holds one entry per destination, keyed by its position.
+*/
+type DeliverResult = {
+    status: 'accepted' | 'refused';
+    submissionId: string;
+    message?: string;
+    redirect?: string;
+    errors?: Array<{
+        field?: string;
+        message: string;
+    }>;
+    results: Record<string, {
+        status: 'done' | 'pending' | 'ambiguous' | 'skipped';
+        ref?: string;
+    }>;
+};
+/**
+The delivery result a block carries — it is the round's `custom:deliverResult` block — or `undefined`
+for any other block, or a result with a field missing or mistyped. A redirect the site could not hand to
+`location.assign` (not http(s), mailto, tel or a path) is dropped, the rest of the result kept.
+*/
+declare function deliverResultOf(block: {
+    type: string;
+    data?: unknown;
+}): DeliverResult | undefined;
+
 /**
  Logger utility for Thamyr SDK
  Provides configurable logging that can be enabled/disabled to avoid console spam
@@ -3988,5 +4109,5 @@ declare function createContractClient(config: {
     withCredentials?: boolean;
 }): ContractClient;
 
-export { ADD_TO_CART_RESULT_BLOCK, CallimacusApi, CallimacusEvent, CallimacusService, ChapterStatus, ClientEvents, GalleryMode, LANDING_VALUE_MAX_LENGTH, MAX_HANDSHAKE_RETRIES, SLInputEventType, ServerEvents, ThamyrHttpError, ThamyrResponseType, UserInteractionType, addToCartResultOf, applyBlockPatch, blockKeyOf, callimacusService, classifyConnectError, clearIntentSessionId, createContractClient, ensureIntentSessionId, extractTtsAudio, getIntentSessionId, initIntent, interactionRound, isCustomBlock, isMasterProduct, isSetProduct, landingRound, logger, parseConnectRejection, randomUuid, receptorsOf, setConsent, setDebug, setDebugPanel, setGeo, setIntentSessionMaxAge, shouldRetryHandshake, transformImageUrl };
-export type { AddToCartResult, BCProduct, Basket, Block, BlockPatch, BoundingBox, CallimacusErrorMessage, Chapter, ClientInfo, ConnectRejection, ConnectionStatusCallback, ContractClient, CustomBlock, ErrorCallback, ErrorMessage, Gallery, GenericProduct, HomePage, Image, ImageEdits, ImageFormatEdit, ImageResizeEdit, InitOptions, InteractionContext, InteractionId, InteractionOptions, InteractionPayload, InteractionPayloadMap, LegacyBlock, LocalizedEPArtwork, LocalizedEPChapter, LogLevel, LoggerConfig, MasterProduct, MasterProductWithVariationGroup, OptionItem, ProductItem, ProductMatch, RecommendationsResponse, RiveManifest, RoundOptions, SLDocument, SLDocumentSection, SLInputEvent, ServerResponseCallback, SetProduct, SkesisItem, SkesisRelatedResponse, SkesisSimilarResponse, Story, SuggestPayload, Suggestions, ThamyrInteractionMap, ThamyrResponse, Topic, TopicContentsPage, TopicSummary, TtsAudio, UiElement, UiObserverConfig, UiSnapshot, UserInteraction, Variant, VariationAttribute, VariationGroup, Video, WhisperPayload };
+export { ACTION_TYPES, ADD_TO_CART_RESULT_BLOCK, CallimacusApi, CallimacusEvent, CallimacusService, ChapterStatus, ClientEvents, DELIVER_RESULT_BLOCK, GalleryMode, LANDING_VALUE_MAX_LENGTH, MAX_HANDSHAKE_RETRIES, SLInputEventType, ServerEvents, ThamyrHttpError, ThamyrResponseType, UserInteractionType, actionOf, addToCartResultOf, applyBlockPatch, blockKeyOf, callimacusService, classifyConnectError, clearIntentSessionId, createContractClient, deliverResultOf, ensureIntentSessionId, extractTtsAudio, fieldsOf, getIntentSessionId, initIntent, interactionRound, isCustomBlock, isMasterProduct, isSetProduct, landingRound, logger, parseConnectRejection, randomUuid, receptorsOf, setConsent, setDebug, setDebugPanel, setGeo, setIntentSessionMaxAge, shouldRetryHandshake, transformImageUrl };
+export type { Action, ActionType, AddToCartResult, BCProduct, Basket, Block, BlockPatch, BoundingBox, CallimacusErrorMessage, Chapter, ClientInfo, ConnectRejection, ConnectionStatusCallback, ContractClient, CustomBlock, DeliverResult, ErrorCallback, ErrorMessage, Gallery, GenericProduct, HomePage, Image, ImageEdits, ImageFormatEdit, ImageResizeEdit, InitOptions, InteractionContext, InteractionId, InteractionOptions, InteractionPayload, InteractionPayloadMap, LegacyBlock, LocalizedEPArtwork, LocalizedEPChapter, LogLevel, LoggerConfig, MasterProduct, MasterProductWithVariationGroup, OptionItem, ProductItem, ProductMatch, RecommendationsResponse, RiveManifest, RoundOptions, SLDocument, SLDocumentSection, SLInputEvent, ServerResponseCallback, SetProduct, SkesisItem, SkesisRelatedResponse, SkesisSimilarResponse, Story, SuggestPayload, Suggestions, ThamyrInteractionMap, ThamyrResponse, Topic, TopicContentsPage, TopicSummary, TtsAudio, UiElement, UiObserverConfig, UiSnapshot, UserInteraction, Variant, VariationAttribute, VariationGroup, Video, WhisperPayload };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@callimacus/thamyr-core",
-  "version": "4.5.0",
+  "version": "4.6.0",
   "private": false,
   "description": "Core package for Thamyr",
   "license": "SEE LICENSE IN LICENSE.md",