@callimacus/thamyr-core 4.9.0 → 4.10.0

package/dist/types/index.d.ts

@@ -478,6 +478,44 @@ type WhisperPayload = {
     generated_at: number;
     ttl_ms: number;
 };
+type SkesisItemPage = {
+    /**
+     * The canonical page path, `/map/{locale}/{slug}/{id}`, as the sitemap lists it
+     */
+    path: string;
+    /**
+     * The catalogue locale the item is read in, as the engine spells it (e.g. `en-IT`)
+     */
+    locale: string;
+    kind: string;
+    /**
+     * The URL segment the site publishes the item's kind under
+     */
+    slug: string;
+    /**
+     * The item's title, or its id when it has none
+     */
+    title: string;
+    /**
+     * The item's description, as plain text
+     */
+    description?: string;
+    /**
+     * The URL of the item's first image
+     */
+    image?: string;
+    /**
+     * The item as stored, for a page that shows more than the crawler is served
+     */
+    item: {
+        id: string;
+        kind: string;
+        locale: string;
+        fields: {
+            [key: string]: unknown;
+        };
+    };
+};
 type ProductMatch = {
     match?: {
         id: string;
@@ -3009,6 +3047,37 @@ type SkesisRelatedResponses = {
      */
     200: SkesisRelatedResponse;
 };
+type SkesisGetItemByPathErrors = {
+    /**
+     * Validation error
+     */
+    400: unknown;
+    /**
+     * Missing or invalid access token
+     */
+    401: unknown;
+    /**
+     * The caller is not permitted to perform this operation
+     */
+    403: PinaxForbidden;
+    /**
+     * Path did not resolve to a published item
+     */
+    404: PublicError;
+    /**
+     * Skesis engine unavailable (rate cap, upstream failure, or not configured); retry later
+     */
+    502: {
+        error: string;
+        errorId: string;
+    };
+};
+type SkesisGetItemByPathResponses = {
+    /**
+     * Success
+     */
+    200: SkesisItemPage;
+};
 
 type Options<TData extends TDataShape = TDataShape, ThrowOnError extends boolean = boolean, TResponse = unknown> = Options$1<TData, ThrowOnError, TResponse> & {
     /**
@@ -3214,6 +3283,14 @@ declare class Skesis extends HeyApiClient {
         anchorId: string;
         locale?: string;
     }, options?: Options<never, ThrowOnError>): RequestResult<SkesisRelatedResponses, SkesisRelatedErrors, ThrowOnError>;
+    /**
+     * Get a catalogue item page by its path
+     *
+     * Resolves a `/map/{locale}/{slug}/{id}` path from the sitemap to what the crawler is served there: a visible item of a kind the site publishes as pages, in that locale. Pass the path as the browser shows it (`location.pathname`). A document wins a path both could name, so resolve a `/map/` path with `content.getDocumentByPath` first and with this read on its 404. A path that names no such item is a 404, not a 400.
+     */
+    getItemByPath<ThrowOnError extends boolean = false>(parameters: {
+        path: string;
+    }, options?: Options<never, ThrowOnError>): RequestResult<SkesisGetItemByPathResponses, SkesisGetItemByPathErrors, ThrowOnError>;
 }
 declare class CallimacusApi extends HeyApiClient {
     static readonly __registry: HeyApiRegistry<CallimacusApi>;
@@ -3913,7 +3990,9 @@ type MapPath = {
  */
 declare function parseMapPath(pathname: string): MapPath | undefined;
 /**
- What a `/map/…` pathname shows: one document, or the per-language index.
+ What a `/map/…` pathname shows: one document, the per-language index, or one
+ catalogue item (`language` is then the catalogue locale, `slug` the kind's
+ slug and the item id).
  */
 type MapPage = {
     kind: 'document';
@@ -3924,11 +4003,18 @@ type MapPage = {
     kind: 'index';
     language: string;
     entries: DocumentIndexEntry[];
+} | {
+    kind: 'item';
+    language: string;
+    slug: string;
+    itemPage: SkesisItemPage;
 };
 /**
  Resolves what to show at a `/map/…` pathname: the document at
- `/map/{language}/{slug}`, or the entries of the per-language index at
- `/map/{language}` — the same list the crawler is served, newest first.
+ `/map/{language}/{slug}`, the entries of the per-language index at
+ `/map/{language}` — the same list the crawler is served, newest first — or the
+ catalogue item at `/map/{locale}/{kind-slug}/{id}`. A document wins a path both
+ could name, as it does in the server render.
  @param api - A `Thamyr` instance, or the React package's `thamyrApi`.
  @param pathname - `location.pathname`.
  @returns `undefined` when the pathname is not a `/map/` path or names no
@@ -3936,7 +4022,7 @@ type MapPage = {
  failure (network, a 5xx, an SDK not initialized) rejects — with a
  `ThamyrHttpError` when a response arrived.
  */
-declare function resolveMapPage(api: Pick<CallimacusApi, 'content'>, pathname: string): Promise<MapPage | undefined>;
+declare function resolveMapPage(api: Pick<CallimacusApi, 'content' | 'skesis'>, pathname: string): Promise<MapPage | undefined>;
 
 /**
  Structured payload the server attaches to a refused handshake (SOL-1100):
@@ -4153,4 +4239,4 @@ declare function transformImageUrl(cdnUrl: string, edits: ImageEdits): string;
 declare function randomUuid(): string;
 
 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, parseMapPath, randomUuid, receptorsOf, resolveMapPage, shouldRetryHandshake, transformImageUrl };
-export type { Action, ActionType, AddToCartResult, BCProduct, Basket, Block, BlockPatch, BoundingBox, CallimacusErrorMessage, Chapter, ClientInfo, ConnectRejection, ConnectionStatusCallback, ContractClient, CustomBlock, DeliverResult, DocumentIndexEntry, ErrorCallback, ErrorMessage, Gallery, GenericProduct, HomePage, Image, ImageEdits, ImageFormatEdit, ImageResizeEdit, InteractionContext, InteractionId, InteractionOptions, InteractionPayload, InteractionPayloadMap, LegacyBlock, LocalizedEPArtwork, LocalizedEPChapter, LogLevel, LoggerConfig, MapPage, MapPath, 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 type { Action, ActionType, AddToCartResult, BCProduct, Basket, Block, BlockPatch, BoundingBox, CallimacusErrorMessage, Chapter, ClientInfo, ConnectRejection, ConnectionStatusCallback, ContractClient, CustomBlock, DeliverResult, DocumentIndexEntry, ErrorCallback, ErrorMessage, Gallery, GenericProduct, HomePage, Image, ImageEdits, ImageFormatEdit, ImageResizeEdit, InteractionContext, InteractionId, InteractionOptions, InteractionPayload, InteractionPayloadMap, LegacyBlock, LocalizedEPArtwork, LocalizedEPChapter, LogLevel, LoggerConfig, MapPage, MapPath, MasterProduct, MasterProductWithVariationGroup, OptionItem, ProductItem, ProductMatch, RecommendationsResponse, RiveManifest, RoundOptions, SLDocument, SLDocumentSection, SLInputEvent, ServerResponseCallback, SetProduct, SkesisItem, SkesisItemPage, 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

@@ -476,6 +476,44 @@ type WhisperPayload = {
     generated_at: number;
     ttl_ms: number;
 };
+type SkesisItemPage = {
+    /**
+     * The canonical page path, `/map/{locale}/{slug}/{id}`, as the sitemap lists it
+     */
+    path: string;
+    /**
+     * The catalogue locale the item is read in, as the engine spells it (e.g. `en-IT`)
+     */
+    locale: string;
+    kind: string;
+    /**
+     * The URL segment the site publishes the item's kind under
+     */
+    slug: string;
+    /**
+     * The item's title, or its id when it has none
+     */
+    title: string;
+    /**
+     * The item's description, as plain text
+     */
+    description?: string;
+    /**
+     * The URL of the item's first image
+     */
+    image?: string;
+    /**
+     * The item as stored, for a page that shows more than the crawler is served
+     */
+    item: {
+        id: string;
+        kind: string;
+        locale: string;
+        fields: {
+            [key: string]: unknown;
+        };
+    };
+};
 type ProductMatch = {
     match?: {
         id: string;
@@ -3007,6 +3045,37 @@ type SkesisRelatedResponses = {
      */
     200: SkesisRelatedResponse;
 };
+type SkesisGetItemByPathErrors = {
+    /**
+     * Validation error
+     */
+    400: unknown;
+    /**
+     * Missing or invalid access token
+     */
+    401: unknown;
+    /**
+     * The caller is not permitted to perform this operation
+     */
+    403: PinaxForbidden;
+    /**
+     * Path did not resolve to a published item
+     */
+    404: PublicError;
+    /**
+     * Skesis engine unavailable (rate cap, upstream failure, or not configured); retry later
+     */
+    502: {
+        error: string;
+        errorId: string;
+    };
+};
+type SkesisGetItemByPathResponses = {
+    /**
+     * Success
+     */
+    200: SkesisItemPage;
+};
 
 type Options<TData extends TDataShape = TDataShape, ThrowOnError extends boolean = boolean, TResponse = unknown> = Options$1<TData, ThrowOnError, TResponse> & {
     /**
@@ -3212,6 +3281,14 @@ declare class Skesis extends HeyApiClient {
         anchorId: string;
         locale?: string;
     }, options?: Options<never, ThrowOnError>): RequestResult<SkesisRelatedResponses, SkesisRelatedErrors, ThrowOnError>;
+    /**
+     * Get a catalogue item page by its path
+     *
+     * Resolves a `/map/{locale}/{slug}/{id}` path from the sitemap to what the crawler is served there: a visible item of a kind the site publishes as pages, in that locale. Pass the path as the browser shows it (`location.pathname`). A document wins a path both could name, so resolve a `/map/` path with `content.getDocumentByPath` first and with this read on its 404. A path that names no such item is a 404, not a 400.
+     */
+    getItemByPath<ThrowOnError extends boolean = false>(parameters: {
+        path: string;
+    }, options?: Options<never, ThrowOnError>): RequestResult<SkesisGetItemByPathResponses, SkesisGetItemByPathErrors, ThrowOnError>;
 }
 declare class CallimacusApi extends HeyApiClient {
     static readonly __registry: HeyApiRegistry<CallimacusApi>;
@@ -3911,7 +3988,9 @@ type MapPath = {
  */
 declare function parseMapPath(pathname: string): MapPath | undefined;
 /**
- What a `/map/…` pathname shows: one document, or the per-language index.
+ What a `/map/…` pathname shows: one document, the per-language index, or one
+ catalogue item (`language` is then the catalogue locale, `slug` the kind's
+ slug and the item id).
  */
 type MapPage = {
     kind: 'document';
@@ -3922,11 +4001,18 @@ type MapPage = {
     kind: 'index';
     language: string;
     entries: DocumentIndexEntry[];
+} | {
+    kind: 'item';
+    language: string;
+    slug: string;
+    itemPage: SkesisItemPage;
 };
 /**
  Resolves what to show at a `/map/…` pathname: the document at
- `/map/{language}/{slug}`, or the entries of the per-language index at
- `/map/{language}` — the same list the crawler is served, newest first.
+ `/map/{language}/{slug}`, the entries of the per-language index at
+ `/map/{language}` — the same list the crawler is served, newest first — or the
+ catalogue item at `/map/{locale}/{kind-slug}/{id}`. A document wins a path both
+ could name, as it does in the server render.
  @param api - A `Thamyr` instance, or the React package's `thamyrApi`.
  @param pathname - `location.pathname`.
  @returns `undefined` when the pathname is not a `/map/` path or names no
@@ -3934,7 +4020,7 @@ type MapPage = {
  failure (network, a 5xx, an SDK not initialized) rejects — with a
  `ThamyrHttpError` when a response arrived.
  */
-declare function resolveMapPage(api: Pick<CallimacusApi, 'content'>, pathname: string): Promise<MapPage | undefined>;
+declare function resolveMapPage(api: Pick<CallimacusApi, 'content' | 'skesis'>, pathname: string): Promise<MapPage | undefined>;
 
 /**
  Structured payload the server attaches to a refused handshake (SOL-1100):
@@ -4212,4 +4298,4 @@ declare function clearIntentSessionId(): void;
 declare function setIntentSessionMaxAge(_seconds: number): void;
 
 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, parseMapPath, randomUuid, receptorsOf, resolveMapPage, 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, DocumentIndexEntry, ErrorCallback, ErrorMessage, Gallery, GenericProduct, HomePage, Image, ImageEdits, ImageFormatEdit, ImageResizeEdit, InitOptions, InteractionContext, InteractionId, InteractionOptions, InteractionPayload, InteractionPayloadMap, LegacyBlock, LocalizedEPArtwork, LocalizedEPChapter, LogLevel, LoggerConfig, MapPage, MapPath, 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 type { Action, ActionType, AddToCartResult, BCProduct, Basket, Block, BlockPatch, BoundingBox, CallimacusErrorMessage, Chapter, ClientInfo, ConnectRejection, ConnectionStatusCallback, ContractClient, CustomBlock, DeliverResult, DocumentIndexEntry, ErrorCallback, ErrorMessage, Gallery, GenericProduct, HomePage, Image, ImageEdits, ImageFormatEdit, ImageResizeEdit, InitOptions, InteractionContext, InteractionId, InteractionOptions, InteractionPayload, InteractionPayloadMap, LegacyBlock, LocalizedEPArtwork, LocalizedEPChapter, LogLevel, LoggerConfig, MapPage, MapPath, MasterProduct, MasterProductWithVariationGroup, OptionItem, ProductItem, ProductMatch, RecommendationsResponse, RiveManifest, RoundOptions, SLDocument, SLDocumentSection, SLInputEvent, ServerResponseCallback, SetProduct, SkesisItem, SkesisItemPage, 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.9.0",
+  "version": "4.10.0",
   "private": false,
   "description": "Core package for Thamyr",
   "license": "SEE LICENSE IN LICENSE.md",