@callimacus/thamyr-core 4.3.4

package/dist/types/index.d.ts

@@ -0,0 +1,3577 @@
+/*!
+ * Copyright © 2025–2026 Solomei AI SRL. All rights reserved.
+ *
+ * Proprietary software, licensed for use by Callimacus customers only.
+ * See LICENSE.md for the full terms.
+ *
+ */
+export * from '@callimacus/intent';
+
+type AuthToken = string | undefined;
+interface Auth {
+    /**
+     * Which part of the request do we use to send the auth?
+     *
+     * @default 'header'
+     */
+    in?: 'header' | 'query' | 'cookie';
+    /**
+     * A unique identifier for the security scheme.
+     *
+     * Defined only when there are multiple security schemes whose `Auth`
+     * shape would otherwise be identical.
+     */
+    key?: string;
+    /**
+     * Header or query parameter name.
+     *
+     * @default 'Authorization'
+     */
+    name?: string;
+    scheme?: 'basic' | 'bearer';
+    type: 'apiKey' | 'http';
+}
+
+interface SerializerOptions<T> {
+    /**
+     * @default true
+     */
+    explode: boolean;
+    style: T;
+}
+type ArrayStyle = 'form' | 'spaceDelimited' | 'pipeDelimited';
+type ObjectStyle = 'form' | 'deepObject';
+
+type QuerySerializer = (query: Record<string, unknown>) => string;
+type BodySerializer = (body: unknown) => unknown;
+type QuerySerializerOptionsObject = {
+    allowReserved?: boolean;
+    array?: Partial<SerializerOptions<ArrayStyle>>;
+    object?: Partial<SerializerOptions<ObjectStyle>>;
+};
+type QuerySerializerOptions = QuerySerializerOptionsObject & {
+    /**
+     * Per-parameter serialization overrides. When provided, these settings
+     * override the global array/object settings for specific parameter names.
+     */
+    parameters?: Record<string, QuerySerializerOptionsObject>;
+};
+
+type HttpMethod = 'connect' | 'delete' | 'get' | 'head' | 'options' | 'patch' | 'post' | 'put' | 'trace';
+type Client$1<RequestFn = never, Config = unknown, MethodFn = never, BuildUrlFn = never, SseFn = never> = {
+    /**
+     * Returns the final request URL.
+     */
+    buildUrl: BuildUrlFn;
+    getConfig: () => Config;
+    request: RequestFn;
+    setConfig: (config: Config) => Config;
+} & {
+    [K in HttpMethod]: MethodFn;
+} & ([SseFn] extends [never] ? {
+    sse?: never;
+} : {
+    sse: {
+        [K in HttpMethod]: SseFn;
+    };
+});
+interface Config$1 {
+    /**
+     * Auth token or a function returning auth token. The resolved value will be
+     * added to the request payload as defined by its `security` array.
+     */
+    auth?: ((auth: Auth) => Promise<AuthToken> | AuthToken) | AuthToken;
+    /**
+     * A function for serializing request body parameter. By default,
+     * {@link JSON.stringify()} will be used.
+     */
+    bodySerializer?: BodySerializer | null;
+    /**
+     * An object containing any HTTP headers that you want to pre-populate your
+     * `Headers` object with.
+     *
+     * {@link https://developer.mozilla.org/docs/Web/API/Headers/Headers#init See more}
+     */
+    headers?: RequestInit['headers'] | Record<string, string | number | boolean | (string | number | boolean)[] | null | undefined | unknown>;
+    /**
+     * The request method.
+     *
+     * {@link https://developer.mozilla.org/docs/Web/API/fetch#method See more}
+     */
+    method?: Uppercase<HttpMethod>;
+    /**
+     * A function for serializing request query parameters. By default, arrays
+     * will be exploded in form style, objects will be exploded in deepObject
+     * style, and reserved characters are percent-encoded.
+     *
+     * This method will have no effect if the native `paramsSerializer()` Axios
+     * API function is used.
+     *
+     * {@link https://swagger.io/docs/specification/serialization/#query View examples}
+     */
+    querySerializer?: QuerySerializer | QuerySerializerOptions;
+    /**
+     * A function validating request data. This is useful if you want to ensure
+     * the request conforms to the desired shape, so it can be safely sent to
+     * the server.
+     */
+    requestValidator?: (data: unknown) => Promise<unknown>;
+    /**
+     * A function transforming response data before it's returned. This is useful
+     * for post-processing data, e.g., converting ISO strings into Date objects.
+     */
+    responseTransformer?: (data: unknown) => Promise<unknown>;
+    /**
+     * A function validating response data. This is useful if you want to ensure
+     * the response conforms to the desired shape, so it can be safely passed to
+     * the transformers and returned to the user.
+     */
+    responseValidator?: (data: unknown) => Promise<unknown>;
+}
+/**
+ * Arbitrary metadata passed through the `meta` request option.
+ */
+interface ClientMeta {
+}
+
+type ServerSentEventsOptions<TData = unknown> = Omit<RequestInit, 'method'> & Pick<Config$1, 'method' | 'responseTransformer' | 'responseValidator'> & {
+    /**
+     * Fetch API implementation. You can use this option to provide a custom
+     * fetch instance.
+     *
+     * @default globalThis.fetch
+     */
+    fetch?: typeof fetch;
+    /**
+     * Implementing clients can call request interceptors inside this hook.
+     */
+    onRequest?: (url: string, init: RequestInit) => Promise<Request>;
+    /**
+     * Callback invoked when a network or parsing error occurs during streaming.
+     *
+     * This option applies only if the endpoint returns a stream of events.
+     *
+     * @param error The error that occurred.
+     */
+    onSseError?: (error: unknown) => void;
+    /**
+     * Callback invoked when an event is streamed from the server.
+     *
+     * This option applies only if the endpoint returns a stream of events.
+     *
+     * @param event Event streamed from the server.
+     * @returns Nothing (void).
+     */
+    onSseEvent?: (event: StreamEvent<TData>) => void;
+    serializedBody?: RequestInit['body'];
+    /**
+     * Default retry delay in milliseconds.
+     *
+     * This option applies only if the endpoint returns a stream of events.
+     *
+     * @default 3000
+     */
+    sseDefaultRetryDelay?: number;
+    /**
+     * Maximum number of retry attempts before giving up.
+     */
+    sseMaxRetryAttempts?: number;
+    /**
+     * Maximum retry delay in milliseconds.
+     *
+     * Applies only when exponential backoff is used.
+     *
+     * This option applies only if the endpoint returns a stream of events.
+     *
+     * @default 30000
+     */
+    sseMaxRetryDelay?: number;
+    /**
+     * Optional sleep function for retry backoff.
+     *
+     * Defaults to using `setTimeout`.
+     */
+    sseSleepFn?: (ms: number) => Promise<void>;
+    url: string;
+};
+interface StreamEvent<TData = unknown> {
+    data: TData;
+    event?: string;
+    id?: string;
+    retry?: number;
+}
+type ServerSentEventsResult<TData = unknown, TReturn = void, TNext = unknown> = {
+    stream: AsyncGenerator<TData extends Record<string, unknown> ? TData[keyof TData] : TData, TReturn, TNext>;
+};
+
+type ErrInterceptor<Err, Res, Req, Options> = (error: Err, 
+/** response may be undefined due to a network error where no response object is produced */
+response: Res | undefined, 
+/** request may be undefined, because error may be from building the request object itself */
+request: Req | undefined, options: Options) => Err | Promise<Err>;
+type ReqInterceptor<Req, Options> = (request: Req, options: Options) => Req | Promise<Req>;
+type ResInterceptor<Res, Req, Options> = (response: Res, request: Req, options: Options) => Res | Promise<Res>;
+declare class Interceptors<Interceptor> {
+    fns: Array<Interceptor | null>;
+    clear(): void;
+    eject(id: number | Interceptor): void;
+    exists(id: number | Interceptor): boolean;
+    getInterceptorIndex(id: number | Interceptor): number;
+    update(id: number | Interceptor, fn: Interceptor): number | Interceptor | false;
+    use(fn: Interceptor): number;
+}
+interface Middleware<Req, Res, Err, Options> {
+    error: Interceptors<ErrInterceptor<Err, Res, Req, Options>>;
+    request: Interceptors<ReqInterceptor<Req, Options>>;
+    response: Interceptors<ResInterceptor<Res, Req, Options>>;
+}
+
+type ResponseStyle = 'data' | 'fields';
+interface Config<T extends ClientOptions = ClientOptions> extends Omit<RequestInit, 'body' | 'headers' | 'method'>, Config$1 {
+    /**
+     * Base URL for all requests made by this client.
+     */
+    baseUrl?: T['baseUrl'];
+    /**
+     * Fetch API implementation. You can use this option to provide a custom
+     * fetch instance.
+     *
+     * @default globalThis.fetch
+     */
+    fetch?: typeof fetch;
+    /**
+     * Please don't use the Fetch client for Next.js applications. The `next`
+     * options won't have any effect.
+     *
+     * Install {@link https://www.npmjs.com/package/@hey-api/client-next `@hey-api/client-next`} instead.
+     */
+    next?: never;
+    /**
+     * Return the response data parsed in a specified format. By default, `auto`
+     * will infer the appropriate method from the `Content-Type` response header.
+     * You can override this behavior with any of the {@link Body} methods.
+     * Select `stream` if you don't want to parse response data at all.
+     *
+     * @default 'auto'
+     */
+    parseAs?: 'arrayBuffer' | 'auto' | 'blob' | 'formData' | 'json' | 'stream' | 'text';
+    /**
+     * Should we return only data or multiple fields (data, error, response, etc.)?
+     *
+     * @default 'fields'
+     */
+    responseStyle?: ResponseStyle;
+    /**
+     * Throw an error instead of returning it in the response?
+     *
+     * @default false
+     */
+    throwOnError?: T['throwOnError'];
+}
+interface RequestOptions<TData = unknown, TResponseStyle extends ResponseStyle = 'fields', ThrowOnError extends boolean = boolean, Url extends string = string> extends Config<{
+    responseStyle: TResponseStyle;
+    throwOnError: ThrowOnError;
+}>, Pick<ServerSentEventsOptions<TData>, 'onRequest' | 'onSseError' | 'onSseEvent' | 'sseDefaultRetryDelay' | 'sseMaxRetryAttempts' | 'sseMaxRetryDelay'> {
+    /**
+     * Any body that you want to add to your request.
+     *
+     * {@link https://developer.mozilla.org/docs/Web/API/fetch#body}
+     */
+    body?: unknown;
+    path?: Record<string, unknown>;
+    query?: Record<string, unknown>;
+    /**
+     * Security mechanism(s) to use for the request.
+     */
+    security?: ReadonlyArray<Auth>;
+    url: Url;
+}
+interface ResolvedRequestOptions<TResponseStyle extends ResponseStyle = 'fields', ThrowOnError extends boolean = boolean, Url extends string = string> extends RequestOptions<unknown, TResponseStyle, ThrowOnError, Url> {
+    headers: Headers;
+    serializedBody?: string;
+}
+type RequestResult<TData = unknown, TError = unknown, ThrowOnError extends boolean = boolean, TResponseStyle extends ResponseStyle = 'fields'> = ThrowOnError extends true ? Promise<TResponseStyle extends 'data' ? TData extends Record<string, unknown> ? TData[keyof TData] : TData : {
+    data: TData extends Record<string, unknown> ? TData[keyof TData] : TData;
+    request: Request;
+    response: Response;
+}> : Promise<TResponseStyle extends 'data' ? (TData extends Record<string, unknown> ? TData[keyof TData] : TData) | undefined : ({
+    data: TData extends Record<string, unknown> ? TData[keyof TData] : TData;
+    error: undefined;
+} | {
+    data: undefined;
+    error: TError extends Record<string, unknown> ? TError[keyof TError] : TError;
+}) & {
+    /** request may be undefined, because error may be from building the request object itself */
+    request?: Request;
+    /** response may be undefined, because error may be from building the request object itself or from a network error */
+    response?: Response;
+}>;
+interface ClientOptions {
+    baseUrl?: string;
+    responseStyle?: ResponseStyle;
+    throwOnError?: boolean;
+}
+type MethodFn = <TData = unknown, TError = unknown, ThrowOnError extends boolean = false, TResponseStyle extends ResponseStyle = 'fields'>(options: Omit<RequestOptions<TData, TResponseStyle, ThrowOnError>, 'method'>) => RequestResult<TData, TError, ThrowOnError, TResponseStyle>;
+type SseFn = <TData = unknown, _TError = unknown, ThrowOnError extends boolean = false, TResponseStyle extends ResponseStyle = 'fields'>(options: Omit<RequestOptions<never, TResponseStyle, ThrowOnError>, 'method'>) => Promise<ServerSentEventsResult<TData>>;
+type RequestFn = <TData = unknown, TError = unknown, ThrowOnError extends boolean = false, TResponseStyle extends ResponseStyle = 'fields'>(options: Omit<RequestOptions<TData, TResponseStyle, ThrowOnError>, 'method'> & Pick<Required<RequestOptions<TData, TResponseStyle, ThrowOnError>>, 'method'>) => RequestResult<TData, TError, ThrowOnError, TResponseStyle>;
+type BuildUrlFn = <TData extends {
+    body?: unknown;
+    path?: Record<string, unknown>;
+    query?: Record<string, unknown>;
+    url: string;
+}>(options: TData & Options$1<TData>) => string;
+type Client = Client$1<RequestFn, Config, MethodFn, BuildUrlFn, SseFn> & {
+    interceptors: Middleware<Request, Response, unknown, ResolvedRequestOptions>;
+};
+interface TDataShape {
+    body?: unknown;
+    headers?: unknown;
+    path?: unknown;
+    query?: unknown;
+    url: string;
+}
+type OmitKeys<T, K> = Pick<T, Exclude<keyof T, K>>;
+type Options$1<TData extends TDataShape = TDataShape, ThrowOnError extends boolean = boolean, TResponse = unknown, TResponseStyle extends ResponseStyle = 'fields'> = OmitKeys<RequestOptions<TResponse, TResponseStyle, ThrowOnError>, 'body' | 'path' | 'query' | 'url'> & ([TData] extends [never] ? unknown : Omit<TData, 'url'>);
+
+type ChapterStatus$1 = 1 | 2 | 3 | 4;
+type GalleryMode$1 = 'masonry' | 'carousel';
+type SlInputEvent = {
+    type: 'question';
+    data: {
+        value: string;
+        /**
+         * Optional attachment (a browser File; travels as a socket.io binary payload).
+         */
+        file?: unknown | null;
+    };
+} | {
+    type: 'content';
+    data: {
+        value: string;
+    };
+} | {
+    type: 'topic';
+    data: {
+        value: string;
+    };
+} | {
+    type: 'image';
+    data: {
+        value: string;
+    };
+} | {
+    type: 'gallery';
+    data: {
+        value: string;
+    };
+} | {
+    type: 'page';
+    data: {
+        value: string;
+    };
+} | {
+    type: 'relatedQuestion';
+    data: {
+        value: string;
+    };
+} | {
+    type: 'customInteraction';
+    data: {
+        payload?: {
+            [key: string]: unknown;
+        };
+        nodeKey?: string;
+        interactionId: string;
+        value?: string | Array<string>;
+    };
+} | {
+    type: 'customPage';
+    data: {
+        value?: string;
+    };
+};
+type HomePage = {
+    topics: Array<{
+        topic: TopicSummary;
+        contentList: Array<SlDocumentOutput | LocalizedEpArtworkOutput>;
+    }>;
+    highlight: Array<SlDocumentOutput>;
+    ep: Array<LocalizedEpArtworkOutput>;
+};
+type TopicSummary = {
+    id: number;
+    name: string;
+    slug: string;
+};
+type PublicError = {
+    error: string;
+};
+type TopicContentsPage = {
+    topic: TopicSummary;
+    contentList: Array<SlDocumentOutput>;
+    totalCount: number;
+    offset: number;
+    limit: number;
+};
+type RecommendationsResponse = {
+    directRecommendations: Array<ProductMatch>;
+    inverseRecommendations: Array<ProductMatch>;
+};
+type WhisperPayload = {
+    session_id: string;
+    tenant_id: string;
+    website_context: string;
+    behavioral_intelligence: string;
+    summary: string;
+    behavior_guidance: string;
+    content_guidance: string;
+    content_focus: {
+        categories: Array<string>;
+        themes: Array<string>;
+    };
+    user_guidance: string;
+    block_suggestions: Array<{
+        component: string;
+        confidence: number;
+        rationale: string;
+    }>;
+    anchored_patterns?: Array<{
+        id: string;
+        description: string;
+        score: number;
+    }>;
+    session_digest: string;
+    assembled: string;
+    confidence: number;
+    degraded?: boolean;
+    suppressed?: 'no-behavioral-evidence' | 'no-grounded-guidance';
+    stale?: boolean;
+    generated_at: number;
+    ttl_ms: number;
+};
+type ProductMatch = {
+    match?: {
+        id: string;
+        metadata: {
+            c_macrocategoryacme: string;
+            c_microcategoryacme: string;
+            category: string;
+            description: string;
+            macroColor: string;
+            materials: string;
+            microColor: string;
+            name: string;
+            price: number;
+            sku: string;
+            subCategory: string;
+            taxonomy: string;
+            text: string;
+            type: string;
+        };
+        score: number;
+        values?: Array<number>;
+    };
+    product: BcProductOutput;
+};
+type BcProductOutput = SetProductOutput | MasterProductWithVariationGroupOutput;
+type SetProductOutput = {
+    type: {
+        set: true;
+    };
+    setProducts: Array<{
+        id: string;
+    }>;
+    fullSetProducts?: Array<MasterProductWithVariationGroupOutput>;
+    imageGroups: Array<{
+        images: Array<{
+            alt?: string;
+            disBaseLink?: string;
+            url: string;
+            title?: string;
+        }>;
+    }>;
+    primaryCategoryId: string;
+    assignedCategories?: Array<{
+        categoryId: string;
+    }>;
+    id: string;
+    name: string;
+    online: boolean;
+    c_model: string;
+    c_gender: string;
+    c_season: string;
+    c_macrocategoryacme: string;
+    c_searchkeywords?: string;
+    hasHowToStyle: boolean;
+};
+type MasterProductWithVariationGroupOutput = MasterProductOutput & {
+    selectedVariationGroup: string;
+};
+type MasterProductOutput = {
+    type: {
+        master: true;
+    };
+    variationGroups: Array<VariationGroupOutput>;
+    variants: Array<VariantOutput>;
+    variationAttributes: Array<VariationAttributeOutput>;
+    'c_material-1-percent': number;
+    'c_material-2-percent': number;
+    'c_material-3-percent': number;
+    'c_material-4-percent': number;
+    'c_material-5-percent': number;
+    'c_material-6-percent': number;
+    'c_material-7-percent': number;
+    'c_material-8-percent': number;
+    'c_material-1-desc'?: string;
+    'c_material-2-desc'?: string;
+    'c_material-3-desc'?: string;
+    c_short_description?: string;
+    c_microcategoryacme: string;
+    longDescription: string;
+    shortDescription: string;
+    'c_made-in': string;
+    c_material: string;
+    c_saleline: string;
+    c_avalaraCode: string;
+    'c_id-size-grid': string;
+    c_material_care: string;
+    c_weight: string;
+    currency: string;
+    c_details?: string;
+    productPromotions?: Array<{
+        calloutMsg: string;
+        promotionId: string;
+        c_formattedPrice: string;
+        promotionalPrice: number;
+    }>;
+    c_sku: string;
+    c_hscode: string;
+    orderable: boolean;
+    price: number;
+    priceMax?: number | null;
+    id: string;
+    name: string;
+    online: boolean;
+    c_model: string;
+    c_gender: string;
+    c_season: string;
+    c_macrocategoryacme: string;
+    c_searchkeywords?: string;
+    hasHowToStyle: boolean;
+};
+type VariationGroupOutput = {
+    c_sku: string;
+    c_pfas: string;
+    c_color: string;
+    c_model: string;
+    c_gender: string;
+    c_hscode: string;
+    c_season: string;
+    c_weight: string;
+    c_details?: string;
+    'c_made-in': string;
+    productId: string;
+    c_material: string;
+    c_saleline: string;
+    assignedCategories?: Array<{
+        categoryId: string;
+    }>;
+    c_avalaraCode: string;
+    'c_macro-color': string;
+    'c_micro-color': string;
+    'c_id-size-grid': string;
+    c_material_care: string;
+    'c_material-1-desc'?: string;
+    'c_material-2-desc'?: string;
+    'c_material-3-desc'?: string;
+    primaryCategoryId?: string;
+    c_macrocategoryacme: string;
+    c_microcategoryacme: string;
+    c_short_description?: string;
+    'c_material-1-percent': number;
+    'c_material-2-percent': number;
+    'c_material-3-percent': number;
+    'c_material-4-percent': number;
+    'c_material-5-percent': number;
+    'c_material-6-percent': number;
+    'c_material-7-percent': number;
+    'c_material-8-percent': number;
+    productPromotions?: Array<{
+        calloutMsg: string;
+        promotionId: string;
+        c_formattedPrice: string;
+        promotionalPrice: number;
+    }>;
+    recommendations: Array<{
+        recommendedItemId: string;
+    }>;
+    variationValues: {
+        [key: string]: string;
+    };
+    imageGroups: Array<{
+        images: Array<{
+            alt?: string;
+            disBaseLink?: string;
+            url: string;
+            title?: string;
+        }>;
+    }>;
+    orderable: boolean;
+    online: boolean;
+};
+type VariantOutput = {
+    online: boolean;
+    orderable?: boolean;
+    price?: number;
+    productId: string;
+    c_formattedPrice?: string;
+    variationValues?: {
+        [key: string]: string;
+    };
+    productPromotions?: Array<{
+        calloutMsg: string;
+        promotionId: string;
+        c_formattedPrice: string;
+        promotionalPrice: number;
+    }>;
+    inventory?: {
+        ats: number;
+    };
+};
+type VariationAttributeOutput = {
+    id: string;
+    name?: string;
+    values?: Array<{
+        description?: string;
+        image?: {
+            alt?: string;
+            disBaseLink?: string;
+            url: string;
+            title?: string;
+        };
+        imageSwatch?: {
+            alt?: string;
+            disBaseLink?: string;
+            url: string;
+            title?: string;
+        };
+        name?: string;
+        orderable?: boolean;
+        value: string;
+    }>;
+};
+type BlockOutput = LegacyBlockOutput | CustomBlockOutput;
+type ChapterOutput = {
+    id: string;
+    deleted: boolean;
+    language?: string;
+    receptors?: Array<string>;
+    /**
+     * Deprecated alias of `receptors`.
+     *
+     * @deprecated
+     */
+    intent?: Array<string>;
+    subCondition?: Array<string>;
+    inputEvent?: SlInputEventOutput;
+    related?: {
+        contentList?: Array<SlDocumentOutput>;
+        topicList?: Array<TopicOutput>;
+        relatedQuestions?: Array<string>;
+    };
+    references?: Array<string>;
+    blocks?: Array<BlockOutput>;
+    status: ChapterStatus$1;
+};
+type CreateRoundContextOutput = {
+    uiSnapshot?: {
+        timestamp: number;
+        viewport: {
+            width: number;
+            height: number;
+        };
+        elements?: Array<{
+            id: string;
+            bounds: {
+                x: number;
+                y: number;
+                width: number;
+                height: number;
+                top: number;
+                left: number;
+                right: number;
+                bottom: number;
+            };
+            isVisible?: boolean;
+            visibilityRatio?: number;
+        }>;
+        blockIds?: Array<string>;
+    };
+    userAgent?: string;
+    acceptLanguageLocale?: string;
+    [key: string]: unknown;
+};
+type CustomBlockOutput = {
+    id: string;
+    priority?: number;
+    metaJson?: unknown;
+    /**
+     * Custom block type, always prefixed `custom:`.
+     */
+    type: `custom:${string}`;
+    name?: string;
+    data: unknown;
+};
+type GalleryOutput = {
+    images: Array<ImageOutput>;
+    mode: GalleryMode$1;
+};
+type ImageOutput = {
+    type: 'image';
+    content?: string;
+    url: string;
+    properties: {
+        size: {
+            width: number;
+            height: number;
+        };
+        alt?: string;
+        cloudinary?: {
+            publicId: string;
+            cloudName: string;
+            secureDistribution: string;
+            [key: string]: unknown;
+        };
+    };
+    id?: string;
+    document?: string;
+};
+type LegacyBlockOutput = {
+    id: string;
+    priority?: number;
+    metaJson?: unknown;
+    type: 'image';
+    data: ImageOutput;
+} | {
+    id: string;
+    priority?: number;
+    metaJson?: unknown;
+    type: 'content';
+    data: Array<SlDocumentOutput>;
+} | {
+    id: string;
+    priority?: number;
+    metaJson?: unknown;
+    type: 'gallery';
+    data: GalleryOutput;
+} | {
+    id: string;
+    priority?: number;
+    metaJson?: unknown;
+    type: 'video';
+    data: Array<VideoOutput>;
+} | {
+    id: string;
+    priority?: number;
+    metaJson?: unknown;
+    type: 'topic';
+    data: Array<TopicOutput>;
+} | {
+    id: string;
+    priority?: number;
+    metaJson?: unknown;
+    type: 'product';
+    data: Array<{
+        matches?: {
+            status: 'success';
+            tier?: 'fully' | 'partially' | 'no';
+            explanation?: string;
+        } | {
+            status: 'error';
+        };
+        hit: {
+            match?: {
+                id: string;
+                metadata: {
+                    c_macrocategoryacme: string;
+                    c_microcategoryacme: string;
+                    category: string;
+                    description: string;
+                    macroColor: string;
+                    materials: string;
+                    microColor: string;
+                    name: string;
+                    price: number;
+                    sku: string;
+                    subCategory: string;
+                    taxonomy: string;
+                    text: string;
+                    type: string;
+                };
+                score: number;
+                values?: Array<number>;
+            };
+            product: BcProductOutput;
+        };
+    }>;
+} | {
+    id: string;
+    priority?: number;
+    metaJson?: unknown;
+    type: 'epicPaper';
+    data: Array<LocalizedEpArtworkOutput>;
+} | {
+    id: string;
+    priority?: number;
+    metaJson?: unknown;
+    type: 'demosthenesResponse';
+    data: {
+        text: string;
+        traceId?: string;
+    };
+};
+type LocalizedEpArtworkOutput = {
+    id: string;
+    title?: string;
+    bookmark?: {
+        id: string;
+        text: string;
+        title: string;
+    };
+    chapters?: Array<{
+        id: string;
+        text: string;
+        title: string;
+    }>;
+    language: string;
+    type: 'ep';
+};
+type SlDocumentOutput = {
+    language: string;
+    type: 'content' | 'image' | 'video';
+    name: string;
+    backgroundKnowledge: boolean;
+    topic?: number;
+    meta?: {
+        title?: string;
+        description?: string;
+        url?: string;
+        [key: string]: string | unknown | string | undefined;
+    };
+    status?: 'draft' | 'pending_approval' | 'approved';
+    publishedAt?: string | null;
+    unpublishedAt?: string | null;
+    authors?: Array<string>;
+    source?: 'backoffice' | 'api' | 'salesforce';
+    slug?: string;
+    documentGroupId: string;
+    id: string;
+    lastUpdate: string;
+    sections?: Array<SlDocumentSectionOutput>;
+};
+type SlDocumentSectionOutput = {
+    id: string;
+    document: string;
+    type: 'title' | 'header' | 'text';
+    content: string;
+    properties?: {
+        [key: string]: unknown;
+    };
+} | {
+    id: string;
+    document: string;
+    type: 'image';
+    content?: string;
+    url: string;
+    properties: {
+        size: {
+            width: number;
+            height: number;
+        };
+        alt?: string;
+        cloudinary?: {
+            publicId: string;
+            cloudName: string;
+            secureDistribution: string;
+        } & {
+            [key: string]: unknown;
+        };
+    };
+} | {
+    id: string;
+    document: string;
+    type: 'video';
+    content?: string;
+    url: string;
+    properties?: {
+        size?: {
+            width: number;
+            height: number;
+        };
+        poster?: string;
+        playerConfig?: {
+            autoplay: boolean;
+            muted: boolean;
+            controls: boolean;
+            loop: boolean;
+        };
+        cloudinary?: {
+            publicId: string;
+            cloudName: string;
+            secureDistribution: string;
+        } & {
+            [key: string]: unknown;
+        };
+    };
+} | {
+    id: string;
+    document: string;
+    type: 'custom';
+    content?: string;
+    typeId: string;
+    payload: {
+        [key: string]: unknown;
+    };
+    properties?: {
+        [key: string]: unknown;
+    };
+};
+type SlInputEventOutput = {
+    type: 'question';
+    data: {
+        value: string;
+        /**
+         * Optional attachment (a browser File; travels as a socket.io binary payload).
+         */
+        file?: unknown | null;
+    };
+} | {
+    type: 'content';
+    data: {
+        value: string;
+    };
+} | {
+    type: 'topic';
+    data: {
+        value: string;
+    };
+} | {
+    type: 'image';
+    data: {
+        value: string;
+    };
+} | {
+    type: 'gallery';
+    data: {
+        value: string;
+    };
+} | {
+    type: 'page';
+    data: {
+        value: string;
+    };
+} | {
+    type: 'relatedQuestion';
+    data: {
+        value: string;
+    };
+} | {
+    type: 'customInteraction';
+    data: {
+        payload?: {
+            [key: string]: unknown;
+        };
+        nodeKey?: string;
+        interactionId: string;
+        value?: string | Array<string>;
+    };
+} | {
+    type: 'customPage';
+    data: {
+        value?: string;
+    };
+};
+type StoryOutput = {
+    id: string;
+    language?: string;
+    chapters: Array<ChapterOutput>;
+};
+type TopicOutput = {
+    id: number;
+    slug: string;
+    name: string;
+    description: string;
+    translations: {
+        [key: string]: string;
+    };
+};
+type VideoOutput = {
+    type: 'video';
+    content?: string;
+    url: string;
+    properties?: {
+        size?: {
+            width: number;
+            height: number;
+        };
+        poster?: string;
+        playerConfig?: {
+            autoplay: boolean;
+            muted: boolean;
+            controls: boolean;
+            loop: boolean;
+        };
+        cloudinary?: {
+            publicId: string;
+            cloudName: string;
+            secureDistribution: string;
+            [key: string]: unknown;
+        };
+    };
+    id?: string;
+    document?: string;
+};
+type ErrorMessage = {
+    code: number;
+    message: string;
+    reason?: string;
+};
+type GenericProduct = SetProductOutput | MasterProductOutput;
+type LocalizedEpChapter = {
+    id: string;
+    text: string;
+    title: string;
+};
+type ThamyrResponse$1 = {
+    type: 'chapter-event';
+    chapter: ChapterOutput;
+} | {
+    type: 'story-created';
+    story: StoryOutput;
+} | {
+    type: 'story-shared';
+    data: {
+        storyId: string;
+        shareId: string;
+    };
+} | {
+    type: 'chapter-deleted';
+    data: {
+        storyId: string;
+        chapterId: string;
+        roundId?: string;
+        success: boolean;
+    };
+} | {
+    type: 'story-reset';
+    data: {
+        storyId: string;
+        success: boolean;
+    };
+};
+type UserInteraction$1 = {
+    type: 'get-story';
+    payload: {
+        storyId: string;
+    };
+} | {
+    type: 'create-round';
+    payload: {
+        storyId?: string | null;
+        /**
+         * Language for rounds with no message of their own (a custom page or interaction). A question round detects its language from the visitor's message, and that wins.
+         */
+        language?: string;
+        inputEvent: SlInputEventOutput;
+        context?: CreateRoundContextOutput;
+    };
+} | {
+    type: 'reset-story';
+    payload: {
+        storyId: string;
+    };
+} | {
+    type: 'back-from-round';
+    payload: {
+        storyId: string;
+        chapterId?: string;
+        roundId?: string;
+    };
+} | {
+    type: 'share-story';
+    payload: {
+        storyId: string;
+    };
+} | {
+    type: 'get-shared-story';
+    payload: {
+        shareId: string;
+        language?: string;
+    };
+};
+/**
+ * Document representing a basket.
+ */
+type Basket = {
+    /**
+     * The total tax on products in the shipment, including item-level price adjustments but not
+     * including service charges such as shipping. If the Discount Taxation preference is set to Tax
+     * Products and Shipping Only Based on Adjusted Price, this amount also includes prorated
+     * order-level price adjustments. It is read only.
+     */
+    adjustedMerchandizeTotalTax?: number;
+    /**
+     * The total tax on shipping charges in the shipment, including shipping price adjustments. It is read only.
+     */
+    adjustedShippingTotalTax?: number;
+    /**
+     * Is the basket created by an agent? It is read only.
+     */
+    agentBasket?: boolean;
+    /**
+     * The unique identifier for the basket. It is read only.
+     */
+    basketId: string;
+    /**
+     * The billing address.
+     */
+    billingAddress?: OrderAddress;
+    /**
+     * The bonus discount line items.
+     */
+    bonusDiscountLineItems?: Array<BonusDiscountLineItem>;
+    /**
+     * The sales channel. It is read only.
+     */
+    channelType?: 'storefront' | 'callcenter' | 'marketplace' | 'dss' | 'store' | 'pinterest' | 'twitter' | 'facebookads' | 'subscriptions' | 'onlinereservation' | 'customerservicecenter' | 'instagramcommerce' | 'tiktok' | 'snapchat' | 'google' | 'whatsapp' | 'youtube' | 'chatgpt' | 'gemini';
+    /**
+     * The coupon items.
+     */
+    couponItems?: Array<CouponItem>;
+    /**
+     * The timestamp when the basket was created. It is read only.
+     */
+    creationDate?: string;
+    currency?: CurrencyCode;
+    /**
+     * The customer information, if the customer is logged in.
+     */
+    customerInfo?: CustomerInfo;
+    /**
+     * The gift certificate line items.
+     */
+    giftCertificateItems?: Array<GiftCertificateItem>;
+    /**
+     * Tax values that are grouped and summed based on the tax rate. The tax totals of the line items with the same
+     * tax rate are grouped together and summed up. This does not affect the calculation in any way. It is read only.
+     */
+    groupedTaxItems?: Array<GroupedTaxItem>;
+    /**
+     * The expiration datetime of the inventory reservation. It is read only.
+     */
+    inventoryReservationExpiry?: string;
+    /**
+     * The timestamp when the basket was last modified. It is read only.
+     */
+    lastModified?: string;
+    /**
+     * The total products tax in the purchase currency.
+     * Merchandise total price represents the sum of the product prices before
+     * services (such as shipping) or adjustments from promotions have
+     * been added. It is read only.
+     */
+    merchandizeTotalTax?: number;
+    /**
+     * The order-level price adjustments.
+     */
+    orderPriceAdjustments?: Array<PriceAdjustment>;
+    /**
+     * The total price, including products, shipping and tax. It is read only.
+     */
+    orderTotal?: number;
+    /**
+     * The payment instruments list.
+     */
+    paymentInstruments?: Array<OrderPaymentInstrument>;
+    /**
+     * The product items.
+     */
+    productItems?: Array<BasketProductItem>;
+    /**
+     * The total price of all products including item-level adjustments, but not including order-level adjustments or shipping
+     * charges. If the taxation policy is net, it doesn't include tax. If the taxation policy is gross, it includes tax. It is read only.
+     */
+    productSubTotal?: number;
+    /**
+     * The total price of all products including adjustments, but not including shipping charges. If the taxation policy is net,
+     * it doesn't include tax. If the taxation policy is gross, it includes tax. It is read only.
+     */
+    productTotal?: number;
+    /**
+     * The shipments.
+     */
+    shipments?: Array<Shipment>;
+    /**
+     * The shipping items.
+     */
+    shippingItems?: Array<ShippingItem>;
+    /**
+     * The total price of all shipping charges, including shipping adjustments. If the taxation policy is net, it doesn't
+     * include tax. If the taxation policy is gross, it includes tax. It is read only.
+     */
+    shippingTotal?: number;
+    /**
+     * The total tax on all shipping charges, not including shipping adjustments. It is read only.
+     */
+    shippingTotalTax?: number;
+    /**
+     * The source code assigned to the basket. It is read only.
+     */
+    sourceCode?: string;
+    /**
+     * The total tax amount. It is read only.
+     */
+    taxTotal?: number;
+    /**
+     * The taxation policy (gross or net). It is read only.
+     */
+    taxation?: 'gross' | 'net';
+    /**
+     * If the tax is rounded at the group level, this is set to true. If the tax is rounded at the item or unit level, it is set to false.
+     */
+    taxRoundedAtGroup?: boolean;
+    /**
+     * If the created basket is a temporary basket, this is set to true. Otherwise, it is set to false.
+     */
+    temporaryBasket?: boolean;
+    /**
+     * A list of approaching discount objects for the basket. The list includes both order-level and shipping-level promotions. This field is only included when the expand query parameter contains 'approaching_discounts'.
+     */
+    approachingDiscounts?: Array<ApproachingDiscount>;
+    [key: string]: unknown;
+};
+type SkesisSimilarResponse = {
+    hits: Array<{
+        id: string;
+        score: number;
+        item: SkesisItem;
+    }>;
+};
+type SkesisRelatedResponse = {
+    related: Array<{
+        id: string;
+        item: SkesisItem;
+    }>;
+    siblingColors: Array<{
+        id: string;
+        item: SkesisItem;
+    }>;
+    usedFallback: boolean;
+};
+/**
+ * Document representing an order address.
+ */
+type OrderAddress = {
+    /**
+     * The first address line.
+     */
+    address1?: string;
+    /**
+     * The second address line.
+     */
+    address2?: string;
+    /**
+     * The city.
+     */
+    city?: string;
+    /**
+     * The company name.
+     */
+    companyName?: string;
+    countryCode?: CountryCode;
+    /**
+     * The first name.
+     */
+    firstName?: string;
+    /**
+     * The full name.
+     */
+    fullName?: string;
+    /**
+     * The ID of the address.
+     */
+    id?: string;
+    /**
+     * The job title.
+     */
+    jobTitle?: string;
+    /**
+     * The last name.
+     */
+    lastName?: string;
+    /**
+     * The phone number.
+     */
+    phone?: string;
+    /**
+     * The post office box.
+     */
+    postBox?: string;
+    /**
+     * The postal code.
+     */
+    postalCode?: string;
+    /**
+     * The salutation.
+     */
+    salutation?: string;
+    /**
+     * The second name.
+     */
+    secondName?: string;
+    /**
+     * The state code.
+     */
+    stateCode?: string;
+    /**
+     * The suffix.
+     */
+    suffix?: string;
+    /**
+     * The suite.
+     */
+    suite?: string;
+    /**
+     * The title.
+     */
+    title?: string;
+    [key: string]: unknown;
+};
+/**
+ * Document representing a bonus discount line item.
+ */
+type BonusDiscountLineItem = {
+    /**
+     * The bonus products the customer can choose from.
+     */
+    bonusProducts?: Array<ProductDetailsLink>;
+    /**
+     * The coupon code that triggered the promotion, if applicable.
+     */
+    couponCode?: string;
+    /**
+     * The ID of the line item. It is read only.
+     */
+    id?: string;
+    /**
+     * The maximum number of bonus items the user can select for this promotion.
+     */
+    maxBonusItems?: number;
+    /**
+     * The ID of the promotion that triggered the creation of the line item.
+     */
+    promotionId?: string;
+    [key: string]: unknown;
+};
+/**
+ * Document representing a coupon item.
+ */
+type CouponItem = {
+    /**
+     * The coupon code.
+     */
+    code: string;
+    /**
+     * The coupon item ID. It is read only.
+     */
+    couponItemId?: CouponItemId;
+    /**
+     * The status of the coupon item. It is read only.
+     */
+    statusCode?: 'coupon_code_already_in_basket' | 'coupon_code_already_redeemed' | 'coupon_code_unknown' | 'coupon_disabled' | 'redemption_limit_exceeded' | 'customer_redemption_limit_exceeded' | 'timeframe_redemption_limit_exceeded' | 'no_active_promotion' | 'coupon_already_in_basket' | 'no_applicable_promotion' | 'applied' | 'adhoc';
+    /**
+     * A flag indicating whether the coupon item is valid. A coupon line item is valid if
+     * the status code is "applied" or "no_applicable_promotion". It is read only.
+     */
+    valid?: boolean;
+    [key: string]: unknown;
+};
+/**
+ * A three letter uppercase currency code conforming to the [ISO 4217](https://www.iso.org/iso-4217-currency-codes.html) standard, or the string `N/A` indicating that a currency is not applicable.
+ */
+type CurrencyCode = string;
+/**
+ * The customer information for guest or logged-in customers.
+ */
+type CustomerInfo = {
+    /**
+     * The customer ID. It is read only.
+     */
+    customerId?: string;
+    /**
+     * The customer name.
+     */
+    customerName?: string;
+    /**
+     * The customer number.
+     */
+    customerNo?: string;
+    /**
+     * The customer's email address.
+     */
+    email: string;
+    [key: string]: unknown;
+};
+/**
+ * A gift certificate item.
+ */
+type GiftCertificateItem = {
+    /**
+     * The gift certificate item amount.
+     */
+    amount: number;
+    /**
+     * The item ID. It is read only.
+     */
+    giftCertificateItemId?: GiftCertificateItemId;
+    /**
+     * The gift certificate message.
+     */
+    message?: string;
+    /**
+     * The recipient email.
+     */
+    recipientEmail: string;
+    /**
+     * The recipient's name.
+     */
+    recipientName?: string;
+    /**
+     * The sender's name.
+     */
+    senderName?: string;
+    /**
+     * The ID of the shipment this item belongs to.
+     */
+    shipmentId?: string;
+    [key: string]: unknown;
+};
+/**
+ * Document representing the grouped tax item.
+ */
+type GroupedTaxItem = {
+    /**
+     * The tax rate. It is read only.
+     */
+    taxRate?: number;
+    /**
+     * The summed up tax total for the tax rate. It is read only.
+     */
+    taxValue?: number;
+};
+/**
+ * Document representing a price adjustment within a basket or order. Price adjustments
+ * can be assigned at the order, product, or shipping level.
+ */
+type PriceAdjustment = {
+    /**
+     * Details describing the discount this price adjustment is based on. For adjustments
+     * not based on a discount, this value is null.
+     */
+    appliedDiscount?: Discount;
+    /**
+     * The coupon code of the coupon this price adjustment is based on. For adjustments
+     * not based on a coupon, this value is null. It is read only.
+     */
+    couponCode?: string;
+    /**
+     * The user who created the price adjustment. It is read only.
+     */
+    createdBy?: string;
+    /**
+     * The timestamp when the price adjustment was created. It is read only.
+     */
+    creationDate?: string;
+    /**
+     * A flag indicating whether this price adjustment was created by custom logic. This
+     * flag is set to true unless the price adjustment was created by the promotion
+     * engine.
+     */
+    custom?: boolean;
+    /**
+     * The text describing the item.
+     */
+    itemText?: string;
+    /**
+     * The timestamp when the price adjustment was last modified. It is read only.
+     */
+    lastModified?: string;
+    /**
+     * A flag indicating whether this price adjustment was created by a manual process.
+     * If the price adjustment was created by the promotion engine, this value is always
+     * false.
+     */
+    manual?: boolean;
+    /**
+     * The adjustment price. It is read only.
+     */
+    price?: number;
+    /**
+     * The price adjustment ID. It is read only.
+     */
+    priceAdjustmentId?: PriceAdjustmentId;
+    /**
+     * The ID of the related promotion. Custom price adjustments
+     * can be assigned any promotion ID so long it is not
+     * used by a price adjustment belonging to the same item,
+     * and is not used by a promotion defined in the promotion engine.
+     * If not specified, a promotion ID is generated.
+     */
+    promotionId?: string;
+    /**
+     * The reason for the price adjustment.
+     */
+    reasonCode?: string;
+    [key: string]: unknown;
+};
+/**
+ * Document representing an order payment instrument.
+ */
+type OrderPaymentInstrument = {
+    /**
+     * The payment transaction amount.
+     */
+    amount?: number;
+    /**
+     * The authorization status of the payment transaction. It is read only.
+     */
+    authorizationStatus?: Status;
+    /**
+     * The bank routing number.
+     */
+    bankRoutingNumber?: string;
+    /**
+     * The gift certificate code with the last 4 characters not masked.
+     */
+    maskedGiftCertificateCode?: string;
+    /**
+     * The payment card.
+     */
+    paymentCard?: PaymentCard;
+    /**
+     * The gift card.
+     */
+    giftCard?: GiftCardResponse;
+    /**
+     * The payment instrument ID. It is read only.
+     */
+    paymentInstrumentId?: PaymentInstrumentId;
+    /**
+     * The payment method ID. It is read only.
+     */
+    paymentMethodId?: string;
+    /**
+     * Payment reference information for various payment service providers, only when Salesforce Payments is enabled.
+     */
+    paymentReference?: {
+        /**
+         * Payment reference identifier. Can be payment intent ID for Stripe, PSP reference for Adyen, PayPal order ID for PayPal, or similar identifier for other payment providers.
+         */
+        paymentReferenceId?: string;
+        /**
+         * The payment gateway used to process the payment.
+         */
+        gateway?: 'stripe' | 'paypal' | 'adyen';
+        /**
+         * The payment gateway specific properties.
+         */
+        gatewayProperties?: {
+            /**
+             * # Stripe specific properties.
+             *
+             * - setupFutureUsage: Indicates that you intend to make future payments with this payment method.
+             * - **on_session**: The payment method is intended to be used for a future payment on the same website session.
+             * - **off_session**: The payment method is intended to be used for a future payment on a different website session.
+             * - **null**: The payment method is not intended to be used for a future payment.
+             * - clientSecret: Secret for Stripe client-side payment confirmation. Don't store, log, or expose the client secret to anyone other than the customer, and only use it on pages where TLS is enabled.
+             * - type: string
+             * - maxLength: 256
+             * - example: "pi_1J4K5L2eZvKYlo2CyZ8K5L6M_secret_abc123"
+             *
+             */
+            stripe?: {
+                [key: string]: unknown;
+            };
+            /**
+             * # PayPal specific properties.
+             *
+             */
+            paypal?: {
+                [key: string]: unknown;
+            };
+            /**
+             * # Adyen specific properties.
+             *
+             * - adyenError: Error information returned by Adyen if the payment fails. Null on success.
+             * - adyenPaymentIntent: The Adyen payment intent object containing payment details and required actions.
+             * - resultCode: The result of the payment request (for example, "REDIRECT_SHOPPER", "AUTHORISED", "PENDING", "REFUSED").
+             * - accountID: The Adyen merchant account ID.
+             * - adyenPaymentIntentAction: The action object for payment methods requiring additional shopper interaction.
+             * - url: The URL for completing the payment (redirect or 3DS authentication).
+             * - type: The action type (for example, "redirect", "threeDS2", "voucher").
+             * - method: The HTTP method for the action (for example, "GET", "POST").
+             * - successful: A boolean indicating whether the Adyen operation is successful.
+             *
+             */
+            adyen?: {
+                [key: string]: unknown;
+            };
+        };
+    };
+};
+/**
+ * Document representing a basket product item.
+ */
+type BasketProductItem = ProductItem;
+/**
+ * Document representing a shipment.
+ */
+type Shipment = {
+    /**
+     * The total tax on products in the shipment, including item-level price adjustments but not including
+     * service charges such as shipping. If the Discount Taxation preference is set to Tax Products and
+     * Shipping Only Based on Adjusted Price, this amount also includes prorated order-level price adjustments. It is read only.
+     */
+    adjustedMerchandizeTotalTax?: number;
+    /**
+     * The total tax on shipping charges in the shipment, including shipping price adjustments. It is read only.
+     */
+    adjustedShippingTotalTax?: number;
+    /**
+     * The estimated delivery window for the shipment. The sfcc.app.shipping.calculate hook populates this value from the selected shipping method. The response omits this field if the hook doesn't return a delivery window. This field is reserved for future use and will be supported in an upcoming release.
+     */
+    deliveryWindow?: DeliveryWindow;
+    /**
+     * A flag indicating whether the shipment is a gift. It is read only.
+     */
+    gift?: boolean;
+    /**
+     * The gift message.
+     */
+    giftMessage?: string;
+    /**
+     * The total tax on products in the shipment, not including price adjustments or service charges such as
+     * shipping. It is read only.
+     */
+    merchandizeTotalTax?: number;
+    /**
+     * The timestamp by which an order must be placed for the deliveryWindow to apply, as an RFC 3339 date-time. The sfcc.app.shipping.calculate hook populates this value from the selected shipping method. The response omits this field if the hook doesn't return a cutoff time. This field is reserved for future use and will be supported in an upcoming release.
+     */
+    orderCutoffAt?: string;
+    /**
+     * The total price of all products in the shipment, including item-level adjustments, but not including
+     * order-level adjustments or shipping charges. If the taxation policy is net, it doesn't include tax. If
+     * the taxation policy is gross, it includes tax. It is read only.
+     */
+    productSubTotal?: number;
+    /**
+     * The total price of all products in the shipment including item-level adjustments and prorated
+     * order-level adjustments, but not including shipping charges. If the taxation policy is net, it doesn't
+     * include tax. If the taxation policy is gross, it includes tax. It is read only.
+     */
+    productTotal?: number;
+    /**
+     * The order-specific ID of the shipment. The default value is 'me'.
+     */
+    shipmentId?: ShipmentId;
+    /**
+     * The shipment number of this shipment. This number is automatically generated. It is read only.
+     */
+    shipmentNo?: string;
+    /**
+     * The total price of all products in the shipment including item-level adjustments, shipping charges,
+     * and tax. It is read only.
+     */
+    shipmentTotal?: number;
+    /**
+     * The shipping address.
+     */
+    shippingAddress?: OrderAddress;
+    shippingMethod?: ShippingMethod;
+    /**
+     * The shipping status of the shipment.
+     */
+    shippingStatus?: 'not_shipped' | 'shipped';
+    /**
+     * The total price of all shipping charges in the shipment, including shipping adjustments. If the
+     * taxation policy is net, it doesn't include tax. If the taxation policy is gross, it includes tax. It is read only.
+     */
+    shippingTotal?: number;
+    /**
+     * The total tax on shipping charges in the shipment, not including shipping price adjustments. It is read only.
+     */
+    shippingTotalTax?: number;
+    /**
+     * The total tax on the shipment, including item-level price adjustments and service charges such as
+     * shipping. If the Discount Taxation preference is set to Tax Products and Shipping Only Based on
+     * Adjusted Price, this amount also includes prorated order-level price adjustments. It is read only.
+     */
+    taxTotal?: number;
+    /**
+     * The tracking number of the shipment.
+     */
+    trackingNumber?: string;
+    [key: string]: unknown;
+};
+/**
+ * Document representing a shipping item.
+ */
+type ShippingItem = {
+    /**
+     * The tax for the shipping item, including price adjustments. It is read only.
+     */
+    adjustedTax?: number;
+    /**
+     * The base price of the shipping item, which is the unit price not including adjustments.
+     * If the taxation policy is net, it doesn't include tax. If the taxation policy is gross, it includes tax. It is read only.
+     */
+    basePrice?: number;
+    /**
+     * The shipping item ID. Use it to identify this shipping item when updating its quantity or creating a
+     * custom price adjustment for it. It is read only.
+     */
+    itemId?: string;
+    /**
+     * The text describing the shipping item.
+     */
+    itemText?: string;
+    /**
+     * The price of the line item before applying any adjustments. If the line item is based on net pricing
+     * then the net price is returned. If the line item is based on gross
+     * pricing then the gross price is returned. It is read only.
+     */
+    price?: number;
+    /**
+     * The price adjustments.
+     */
+    priceAdjustments?: Array<PriceAdjustment>;
+    /**
+     * The price of the shipping item including item-level adjustments, but not including order-level
+     * adjustments or shipping charges. If the taxation policy is net, it doesn't include tax.
+     * If the taxation policy is gross, it includes tax. It is read only.
+     */
+    priceAfterItemDiscount?: number;
+    /**
+     * The identifier of the shipment to which this item belongs.
+     */
+    shipmentId?: ShipmentId;
+    /**
+     * The tax on the product item, not including adjustments. It is read only.
+     */
+    tax?: number;
+    /**
+     * The price used to calculate the tax for this shipping item. It is read only.
+     */
+    taxBasis?: number;
+    /**
+     * The tax class ID for the product item, or null
+     * if no tax class ID is associated with the product item. It is read only.
+     */
+    taxClassId?: string;
+    /**
+     * The tax rate applicable to this product line item. For a 10% tax rate, the value is 0.1. It is read only.
+     */
+    taxRate?: number;
+    [key: string]: unknown;
+};
+/**
+ * Document representing an approaching discount for a basket. Contains information about promotions the customer is close to qualifying for.
+ */
+type ApproachingDiscount = {
+    /**
+     * The type of approaching discount (order-level or shipping-level).
+     */
+    type: 'order' | 'shipping';
+    /**
+     * The total amount needed to receive the discount.
+     */
+    conditionThreshold?: number;
+    /**
+     * The amount the customer basket contributes towards the purchase condition.
+     */
+    merchandiseTotal?: number;
+    /**
+     * The applied discount when the order meets the threshold.
+     */
+    discount?: Discount;
+    /**
+     * Document representing a promotion link.
+     */
+    promotionLink?: PromotionLink;
+    /**
+     * The unique id of the shipment the discount relates to. Only applicable when type = shipping.
+     */
+    shipmentId?: string;
+    /**
+     * The shipping methods the promotion relates to. Only applicable when type = shipping.
+     */
+    shippingMethods?: Array<ShippingMethod>;
+    [key: string]: unknown;
+};
+type SkesisItem = {
+    id: string;
+    locale: string;
+    kind: string;
+    fields: {
+        [key: string]: unknown;
+    };
+    [key: string]: unknown;
+};
+/**
+ * A two letter uppercase country code conforming to the [ISO 3166-1](https://www.iso.org/iso-3166-country-codes.html) alpha-2 standard.
+ */
+type CountryCode = string;
+/**
+ * Document representing a link to the resource for product details.
+ */
+type ProductDetailsLink = {
+    /**
+     * The description of the product.
+     */
+    productDescription?: string;
+    productId: ProductId;
+    /**
+     * The name of the product.
+     */
+    productName?: string;
+    /**
+     * The link title.
+     */
+    title?: string;
+};
+/**
+ * The coupon item ID
+ */
+type CouponItemId = string;
+type GiftCertificateItemId = string;
+/**
+ * Document representing a discount.
+ */
+type Discount = {
+    /**
+     * The discount amount for discount types that define specific discount amounts. It is read only.
+     */
+    amount?: number;
+    /**
+     * The discount percent for discount types that define percentage discounts. It is read only.
+     */
+    percentage?: number;
+    /**
+     * The price book ID that is used with some types. It is read only.
+     */
+    priceBookId?: string;
+    /**
+     * The type of discount. It is read only.
+     */
+    type: 'percentage' | 'fixed_price' | 'amount' | 'free' | 'price_book_price' | 'bonus' | 'total_fixed_price' | 'bonus_choice' | 'percentage_off_options';
+    [key: string]: unknown;
+};
+type PriceAdjustmentId = string;
+/**
+ * Document representing an object status.
+ */
+type Status = {
+    /**
+     * The status code.
+     */
+    code?: string;
+    /**
+     * The status message.
+     */
+    message?: string;
+    /**
+     * The status.
+     * For more information on the status values see Status.OK and Status.ERROR.
+     */
+    status?: number;
+};
+/**
+ * Document representing a payment card.
+ */
+type PaymentCard = {
+    /**
+     * The payment card type.
+     */
+    cardType?: string;
+    /**
+     * A flag indicating if the credit card is expired. It is read only.
+     */
+    creditCardExpired?: boolean;
+    /**
+     * A credit card token. If a credit card is tokenized, the token can be used to look up the credit card data
+     * in the token store.
+     */
+    creditCardToken?: string;
+    /**
+     * The month when the payment card expires.
+     */
+    expirationMonth?: number;
+    /**
+     * The year when the payment card expires.
+     */
+    expirationYear?: number;
+    /**
+     * The payment card holder.
+     */
+    holder?: string;
+    /**
+     * The payment card issue number.
+     */
+    issueNumber?: string;
+    /**
+     * The masked payment card number.
+     */
+    maskedNumber?: string;
+    /**
+     * The last digits of the payment card number. It is read only.
+     */
+    numberLastDigits?: string;
+    /**
+     * The month the payment card is valid from.
+     */
+    validFromMonth?: number;
+    /**
+     * The year the payment card is valid from.
+     */
+    validFromYear?: number;
+};
+/**
+ * Document representing a gift card response.
+ */
+type GiftCardResponse = {
+    /**
+     * The gift card brand.
+     */
+    brand?: string;
+    /**
+     * The masked gift card number.
+     */
+    maskedCardNumber?: string;
+    /**
+     * The month when the gift card expires.
+     */
+    expirationMonth?: number;
+    /**
+     * The year when the gift card expires.
+     */
+    expirationYear?: number;
+};
+/**
+ * The payment instrument ID
+ */
+type PaymentInstrumentId = string;
+/**
+ * Document representing a product item.
+ */
+type ProductItem = {
+    /**
+     * The tax on the line item, including any adjustments. It is read only.
+     */
+    adjustedTax?: number;
+    /**
+     * The base price of the line item, which is the unit price not including
+     * adjustments. If the taxation policy is net, it doesn't include tax. If the
+     * taxation policy is gross, it includes tax. It is read only.
+     */
+    basePrice?: number;
+    /**
+     * The ID of the bonus discount line item this bonus product relates to. It is read only.
+     */
+    bonusDiscountLineItemId?: string;
+    /**
+     * A flag indicating whether the product item is a bonus.
+     */
+    bonusProductLineItem?: boolean;
+    /**
+     * The bundled product items.
+     */
+    bundledProductItems?: Array<ProductItem>;
+    /**
+     * Returns true if the item is a gift. It is read only.
+     */
+    gift?: boolean;
+    /**
+     * The gift message.
+     */
+    giftMessage?: string;
+    /**
+     * The inventory list ID associated with this item.
+     */
+    inventoryId?: string;
+    /**
+     * The product item ID. Use it to identify this item when updating its quantity or
+     * creating a custom price adjustment for it. It is read only.
+     */
+    itemId?: ItemId;
+    /**
+     * The text describing the item.
+     */
+    itemText?: string;
+    /**
+     * The option items.
+     */
+    optionItems?: Array<OptionItem>;
+    /**
+     * The price of the line item before applying any adjustments. If the line item is based on net pricing
+     * then the net price is returned. If the line item is based on gross
+     * pricing then the gross price is returned. It is read only.
+     */
+    price?: number;
+    /**
+     * The price adjustments.
+     */
+    priceAdjustments?: Array<PriceAdjustment>;
+    /**
+     * The price of the product line item including item-level adjustments, but not
+     * including order-level adjustments or shipping charges. If the taxation policy is
+     * net, it doesn't include tax. If the taxation policy is gross, it includes tax. It is read only.
+     */
+    priceAfterItemDiscount?: number;
+    /**
+     * The price of the product line item including item-level adjustments and prorated
+     * order-level adjustments, but not including shipping charges. If the taxation
+     * policy is net, it doesn't include tax. If the taxation policy is gross, it
+     * includes tax. It is read only.
+     */
+    priceAfterOrderDiscount?: number;
+    /**
+     * The ID of the product.
+     */
+    productId?: string;
+    /**
+     * If this product line item was added from a product list, this value is a reference
+     * to the corresponding product list item.
+     */
+    productListItem?: ProductListItemReference;
+    /**
+     * The name of the product.
+     */
+    productName?: string;
+    /**
+     * Returns the id of the ProductLineItem that qualified the basket for this bonus product.
+     * This method is only applicable if the product line item is a bonus product line item, and if the promotion is a
+     * product promotion with number of qualifying products granting a bonus-product discount. If these conditions
+     * aren't met, the method returns null. If there are multiple product line items that triggered this bonus product,
+     * this method returns the last one by position within the order.
+     */
+    qualifyingProductItemId?: string;
+    /**
+     * The quantity of the products represented by this item.
+     */
+    quantity?: number;
+    /**
+     * The ID of the shipment this item belongs to.
+     */
+    shipmentId?: string;
+    /**
+     * If the product line item has a related shipping item, this value is its ID. A
+     * related shipping item represents a surcharge applied to individual products using
+     * a particular shipping method. It is read only.
+     */
+    shippingItemId?: string;
+    /**
+     * The tax for the product item, not including price adjustments. It is read only.
+     */
+    tax?: number;
+    /**
+     * The price used to calculate the tax for this product item. It is read only.
+     */
+    taxBasis?: number;
+    /**
+     * The tax class ID for the product item, or null
+     * if no tax class ID is associated with the product item. It is read only.
+     */
+    taxClassId?: string;
+    /**
+     * The tax rate, which is the decimal tax rate to be applied
+     * to the product represented by this item. It is read only.
+     */
+    taxRate?: number;
+    [key: string]: unknown;
+};
+/**
+ * The range describing when an item is expected to be delivered. Both bounds are RFC 3339 date-time timestamps. The API preserves sub-day precision end-to-end.
+ */
+type DeliveryWindow = {
+    /**
+     * The earliest expected delivery time, as an RFC 3339 date-time.
+     */
+    startAt?: string;
+    /**
+     * The latest expected delivery time, as an RFC 3339 date-time.
+     */
+    endAt?: string;
+};
+/**
+ * The identifier of the shipment
+ */
+type ShipmentId = string;
+/**
+ * Document representing a shipping method.
+ */
+type ShippingMethod = {
+    /**
+     * The estimated delivery window for this shipping method. The sfcc.app.shipping.quote hook populates this value. The response omits this field if the hook doesn't return a delivery window.
+     */
+    deliveryWindow?: DeliveryWindow;
+    /**
+     * The localized description of the shipping method.
+     */
+    description?: string;
+    /**
+     * The external shipping method.
+     */
+    externalShippingMethod?: string;
+    /**
+     * The shipping method ID.
+     */
+    id: string;
+    /**
+     * The localized name of the shipping method.
+     */
+    name?: string;
+    /**
+     * The timestamp by which an order must be placed for the deliveryWindow to apply, as an RFC 3339 date-time. The sfcc.app.shipping.quote hook populates this value. The response omits this field if the hook doesn't return a cutoff time.
+     */
+    orderCutoffAt?: string;
+    /**
+     * The shipping cost total, including shipment level costs,
+     * product level fix, and surcharge costs. It is read only.
+     */
+    price?: number;
+    /**
+     * The array of active customer shipping promotions for this shipping
+     * method. This array can be empty.
+     */
+    shippingPromotions?: Array<ShippingPromotion>;
+    [key: string]: unknown;
+};
+/**
+ * Document representing a promotion link.
+ */
+type PromotionLink = {
+    /**
+     * The unique id of the promotion.
+     */
+    promotionId?: string;
+    /**
+     * The localized name of the promotion.
+     */
+    name?: string;
+    /**
+     * The localized call-out message of the promotion.
+     */
+    calloutMsg?: string;
+    /**
+     * The link title.
+     */
+    title?: string;
+    /**
+     * The URL addressing the promotion.
+     */
+    link?: string;
+    [key: string]: unknown;
+};
+/**
+ * The id (SKU) of the product.
+ */
+type ProductId = string;
+/**
+ * The item id.
+ */
+type ItemId = string;
+/**
+ * An option item represents an optional purchase related to a product item, and is always associated with that parent product
+ * item. An option item can have different values from which to select. For example, a refrigerator item can have an option item representing an extended warranty, with a set of option item values representing different warranty lengths. When a shopper purchases the warranty option item together with the parent refrigerator item, they select one of the available warranty option item values.
+ */
+type OptionItem = {
+    /**
+     * The tax on the line item, including any adjustments. It is read only.
+     */
+    adjustedTax?: number;
+    /**
+     * The base price of the line item, which is the unit price not including adjustments.
+     * If the taxation policy is net, it doesn't include tax. If the taxation policy is gross, it includes tax. It is read only.
+     */
+    basePrice?: number;
+    /**
+     * The ID of the bonus discount line item this bonus product relates to. It is read only.
+     */
+    bonusDiscountLineItemId?: string;
+    /**
+     * A flag indicating whether the product item is a bonus. It is read only.
+     */
+    bonusProductLineItem?: boolean;
+    /**
+     * The bundled product items.
+     */
+    bundledProductItems?: Array<ProductItem>;
+    /**
+     * Returns true if the item is a gift. It is read only.
+     */
+    gift?: boolean;
+    /**
+     * The gift message.
+     */
+    giftMessage?: string;
+    /**
+     * The inventory list ID associated with this item. It is read only.
+     */
+    inventoryId?: string;
+    /**
+     * The product item ID. Use it to identify this item when updating its quantity or creating a custom price adjustment for it. It is read only.
+     */
+    itemId?: ItemId;
+    /**
+     * The text describing the item.
+     */
+    itemText?: string;
+    /**
+     * The ID of the option. It is read only.
+     */
+    optionId: string;
+    /**
+     * The option items.
+     */
+    optionItems?: Array<OptionItem>;
+    /**
+     * The ID of the option value. It is read only.
+     */
+    optionValueId: string;
+    /**
+     * The price of the line item before applying any adjustments. If the taxation policy is net, it doesn't include tax.
+     * If the taxation policy is gross, it includes tax. It is read only.
+     */
+    price?: number;
+    /**
+     * The price adjustments.
+     */
+    priceAdjustments?: Array<PriceAdjustment>;
+    /**
+     * The price of the product line item including item-level adjustments, but not including order-level adjustments or
+     * shipping charges. If the taxation policy is net, it doesn't include tax. If the taxation policy is gross, it includes tax. It is read only.
+     */
+    priceAfterItemDiscount?: number;
+    /**
+     * The price of the product line item including item-level adjustments and prorated order-level adjustments, but not
+     * including shipping charges. If the taxation policy is net, it doesn't include tax. If the taxation policy is gross, it
+     * includes tax. It is read only.
+     */
+    priceAfterOrderDiscount?: number;
+    productId?: ProductId;
+    /**
+     * If this product line item was added from a product list, this value is a reference to the corresponding product list item.
+     */
+    productListItem?: ProductListItemReference;
+    /**
+     * The name of the product.
+     */
+    productName?: string;
+    /**
+     * The ordered quantity of the products represented by this item.
+     */
+    quantity?: number;
+    /**
+     * The ID of the shipment this item belongs to.
+     */
+    shipmentId?: string;
+    /**
+     * If the product line item has a related shipping item, this value is its ID. A related shipping item represents a
+     * surcharge applied to individual products using a particular shipping method. It is read only.
+     */
+    shippingItemId?: string;
+    /**
+     * The tax on the line item before applying any adjustments. It is read only.
+     */
+    tax?: number;
+    /**
+     * The amount used to calculate the tax for this item. It is read only.
+     */
+    taxBasis?: number;
+    /**
+     * The tax class ID for the product item, or null
+     * if no tax class ID is associated with the product item. It is read only.
+     */
+    taxClassId?: string;
+    /**
+     * The tax rate, which is the decimal tax rate to be applied
+     * to the product represented by this item. It is read only.
+     */
+    taxRate?: number;
+    [key: string]: unknown;
+};
+/**
+ * Document representing product list item details.
+ */
+type ProductListItemReference = {
+    /**
+     * The ID of the product list item. It is read only.
+     */
+    id: ItemId;
+    /**
+     * The priority of the product list item.
+     */
+    priority?: number;
+    productDetailsLink?: ProductDetailsLink;
+    /**
+     * A reference to the associated product list. It is read only.
+     */
+    productList?: ProductListLink;
+    public?: boolean;
+    /**
+     * The total quantity of this item purchased from the product list.
+     */
+    purchasedQuantity?: number;
+    /**
+     * The number of products or gift certificates that get shipped when purchasing this product list item.
+     */
+    quantity?: number;
+    /**
+     * Specifies whether the item is a product or a gift certificate.
+     */
+    type?: 'product' | 'gift_certificate';
+};
+/**
+ * Document representing a shipping promotion.
+ */
+type ShippingPromotion = {
+    /**
+     * The localized callout message of the promotion.
+     */
+    calloutMsg?: string;
+    /**
+     * The unique ID of the promotion.
+     */
+    promotionId?: string;
+    /**
+     * The localized promotion name.
+     */
+    promotionName?: string;
+    [key: string]: unknown;
+};
+/**
+ * Document representing a link to a product list.
+ */
+type ProductListLink = {
+    /**
+     * The description of this product list.
+     */
+    description?: string;
+    /**
+     * The name of this product list.
+     */
+    name?: string;
+    /**
+     * A flag indicating whether the owner made this product list available for access
+     * by other customers. It is read only.
+     */
+    public?: boolean;
+    /**
+     * The link title.
+     */
+    title?: string;
+    /**
+     * The type of the product list.
+     */
+    type?: 'wish_list' | 'gift_registry' | 'shopping_list' | 'custom_1' | 'custom_2' | 'custom_3';
+};
+type ContentGetPageErrors = {
+    /**
+     * Validation error
+     */
+    400: unknown;
+    /**
+     * Missing or invalid access token
+     */
+    401: unknown;
+    /**
+     * Unknown page id (only `home` exists)
+     */
+    404: PublicError;
+};
+type ContentGetPageResponses = {
+    /**
+     * Success
+     */
+    200: HomePage;
+};
+type ContentListTopicsErrors = {
+    /**
+     * Validation error
+     */
+    400: unknown;
+    /**
+     * Missing or invalid access token
+     */
+    401: unknown;
+};
+type ContentListTopicsResponses = {
+    /**
+     * Success
+     */
+    200: Array<TopicSummary>;
+};
+type ContentGetTopicContentsErrors = {
+    /**
+     * Validation error
+     */
+    400: unknown;
+    /**
+     * Missing or invalid access token
+     */
+    401: unknown;
+    /**
+     * No topic matches idOrSlug
+     */
+    404: PublicError;
+};
+type ContentGetTopicContentsResponses = {
+    /**
+     * Success
+     */
+    200: TopicContentsPage;
+};
+type ContentGetDocumentBySlugErrors = {
+    /**
+     * Validation error
+     */
+    400: unknown;
+    /**
+     * Missing or invalid access token
+     */
+    401: unknown;
+    /**
+     * No published document with this slug
+     */
+    404: PublicError;
+};
+type ContentGetDocumentBySlugResponses = {
+    /**
+     * Success
+     */
+    200: SlDocumentOutput;
+};
+type ContentGetDocumentByGroupErrors = {
+    /**
+     * Validation error
+     */
+    400: unknown;
+    /**
+     * Missing or invalid access token
+     */
+    401: unknown;
+    /**
+     * No published document in this group
+     */
+    404: PublicError;
+};
+type ContentGetDocumentByGroupResponses = {
+    /**
+     * Success
+     */
+    200: SlDocumentOutput;
+};
+type ContentGetDocumentByPathErrors = {
+    /**
+     * Validation error
+     */
+    400: unknown;
+    /**
+     * Missing or invalid access token
+     */
+    401: unknown;
+    /**
+     * Path did not resolve to a published document
+     */
+    404: PublicError;
+};
+type ContentGetDocumentByPathResponses = {
+    /**
+     * Success
+     */
+    200: SlDocumentOutput;
+};
+type StoriesGetSharedErrors = {
+    /**
+     * Validation error
+     */
+    400: unknown;
+    /**
+     * Missing or invalid access token
+     */
+    401: unknown;
+    /**
+     * Share not found
+     */
+    404: PublicError;
+};
+type StoriesGetSharedResponses = {
+    /**
+     * Success
+     */
+    200: StoryOutput;
+};
+type StoriesShareErrors = {
+    /**
+     * Validation error
+     */
+    400: unknown;
+    /**
+     * Missing or invalid access token
+     */
+    401: unknown;
+    /**
+     * Story not found
+     */
+    404: PublicError;
+};
+type StoriesShareResponses = {
+    /**
+     * Success
+     */
+    200: {
+        id: string;
+    };
+};
+type ProductsGetSimilarErrors = {
+    /**
+     * Validation error
+     */
+    400: unknown;
+    /**
+     * Missing or invalid access token
+     */
+    401: unknown;
+    /**
+     * Product not found or similar products unavailable
+     */
+    404: PublicError;
+};
+type ProductsGetSimilarResponses = {
+    /**
+     * Success
+     */
+    200: Array<ProductMatch>;
+};
+type ProductsGetRecommendationsErrors = {
+    /**
+     * Validation error
+     */
+    400: unknown;
+    /**
+     * Missing or invalid access token
+     */
+    401: unknown;
+    /**
+     * Product not found or recommendations unavailable
+     */
+    404: PublicError;
+};
+type ProductsGetRecommendationsResponses = {
+    /**
+     * Success
+     */
+    200: RecommendationsResponse;
+};
+type WhisperGetLastErrors = {
+    /**
+     * Validation error
+     */
+    400: unknown;
+    /**
+     * Missing or invalid access token
+     */
+    401: unknown;
+    /**
+     * Whisper preview is not enabled for this tenant
+     */
+    403: PublicError;
+    /**
+     * No whisper for this session yet
+     */
+    404: PublicError;
+};
+type WhisperGetLastResponses = {
+    /**
+     * Success
+     */
+    200: {
+        whisper: WhisperPayload;
+    };
+};
+type AnalyticsTrackEventErrors = {
+    /**
+     * Validation error
+     */
+    400: unknown;
+    /**
+     * Missing or invalid access token
+     */
+    401: unknown;
+};
+type AnalyticsTrackEventResponses = {
+    /**
+     * No content
+     */
+    204: void;
+};
+type CartGetCartErrors = {
+    /**
+     * Validation error
+     */
+    400: unknown;
+    /**
+     * No Salesforce shopper session could be resolved (typically a tenant without SFCC integration).
+     */
+    401: PublicError;
+};
+type CartGetCartResponses = {
+    /**
+     * Success
+     */
+    200: Basket;
+};
+type CartAddItemToCartErrors = {
+    /**
+     * Validation error
+     */
+    400: unknown;
+    /**
+     * No Salesforce shopper session could be resolved (typically a tenant without SFCC integration).
+     */
+    401: PublicError;
+};
+type CartAddItemToCartResponses = {
+    /**
+     * Success
+     */
+    200: Basket;
+};
+type CartRemoveItemFromCartErrors = {
+    /**
+     * Validation error
+     */
+    400: unknown;
+    /**
+     * No Salesforce shopper session could be resolved (typically a tenant without SFCC integration).
+     */
+    401: PublicError;
+};
+type CartRemoveItemFromCartResponses = {
+    /**
+     * Success
+     */
+    200: Basket;
+};
+type CartUpdateProductQuantityErrors = {
+    /**
+     * Validation error
+     */
+    400: unknown;
+    /**
+     * No Salesforce shopper session could be resolved (typically a tenant without SFCC integration).
+     */
+    401: PublicError;
+};
+type CartUpdateProductQuantityResponses = {
+    /**
+     * Success
+     */
+    200: Basket;
+};
+type SkesisSimilarErrors = {
+    /**
+     * Validation error
+     */
+    400: unknown;
+    /**
+     * Missing or invalid access token
+     */
+    401: unknown;
+    /**
+     * Skesis engine unavailable (rate cap, upstream failure, or not configured); retry later
+     */
+    502: {
+        error: string;
+        errorId: string;
+    };
+};
+type SkesisSimilarResponses = {
+    /**
+     * Success
+     */
+    200: SkesisSimilarResponse;
+};
+type SkesisRelatedErrors = {
+    /**
+     * Validation error
+     */
+    400: unknown;
+    /**
+     * Missing or invalid access token
+     */
+    401: unknown;
+    /**
+     * Skesis engine unavailable (rate cap, upstream failure, or not configured); retry later
+     */
+    502: {
+        error: string;
+        errorId: string;
+    };
+};
+type SkesisRelatedResponses = {
+    /**
+     * Success
+     */
+    200: SkesisRelatedResponse;
+};
+
+type Options<TData extends TDataShape = TDataShape, ThrowOnError extends boolean = boolean, TResponse = unknown> = Options$1<TData, ThrowOnError, TResponse> & {
+    /**
+     * You can provide a client instance returned by `createClient()` instead of
+     * individual options. This might be also useful if you want to implement a
+     * custom client.
+     */
+    client?: Client;
+    /**
+     * You can pass arbitrary values through the `meta` object. This can be
+     * used to access values that aren't defined as part of the SDK function.
+     */
+    meta?: keyof ClientMeta extends never ? Record<string, unknown> : ClientMeta;
+};
+declare class HeyApiClient {
+    protected client: Client;
+    constructor(args: {
+        client: Client;
+    });
+}
+declare class HeyApiRegistry<T> {
+    private readonly defaultKey;
+    private readonly instances;
+    get(key?: string): T;
+    set(value: T, key?: string): void;
+}
+declare class Content extends HeyApiClient {
+    /**
+     * Get a composed page
+     *
+     * The only page id today is `home`; any other id is a 404.
+     */
+    getPage<ThrowOnError extends boolean = false>(parameters: {
+        language: string;
+        id: string;
+    }, options?: Options<never, ThrowOnError>): RequestResult<ContentGetPageResponses, ContentGetPageErrors, ThrowOnError>;
+    /**
+     * List topics
+     *
+     * Every topic of the tenant as a localized summary (name resolved to the requested language). Empty array when none exist.
+     */
+    listTopics<ThrowOnError extends boolean = false>(parameters: {
+        language: string;
+    }, options?: Options<never, ThrowOnError>): RequestResult<ContentListTopicsResponses, ContentListTopicsErrors, ThrowOnError>;
+    /**
+     * Get a topic with its published contents
+     *
+     * Resolves `idOrSlug` as the numeric topic id when it is all digits, as the slug otherwise. Contents are publication-window and approval filtered, ordered by publishedAt DESC; media URLs are public CDN URLs.
+     */
+    getTopicContents<ThrowOnError extends boolean = false>(parameters: {
+        language: string;
+        idOrSlug: string;
+        offset?: number;
+        limit?: number;
+    }, options?: Options<never, ThrowOnError>): RequestResult<ContentGetTopicContentsResponses, ContentGetTopicContentsErrors, ThrowOnError>;
+    /**
+     * Get a published document by slug
+     */
+    getDocumentBySlug<ThrowOnError extends boolean = false>(parameters: {
+        language: string;
+        slug: string;
+    }, options?: Options<never, ThrowOnError>): RequestResult<ContentGetDocumentBySlugResponses, ContentGetDocumentBySlugErrors, ThrowOnError>;
+    /**
+     * Get a published document by its document group
+     */
+    getDocumentByGroup<ThrowOnError extends boolean = false>(parameters: {
+        language: string;
+        groupId: string;
+    }, options?: Options<never, ThrowOnError>): RequestResult<ContentGetDocumentByGroupResponses, ContentGetDocumentByGroupErrors, ThrowOnError>;
+    /**
+     * Get a published document by sitemap path
+     *
+     * Accepts the `/map/{language}/{slug}` paths emitted in the sitemap (leading slash optional; the slug may contain slashes). A path that does not match that shape is a 404, not a 400.
+     */
+    getDocumentByPath<ThrowOnError extends boolean = false>(parameters: {
+        path: string;
+    }, options?: Options<never, ThrowOnError>): RequestResult<ContentGetDocumentByPathResponses, ContentGetDocumentByPathErrors, ThrowOnError>;
+}
+declare class Stories extends HeyApiClient {
+    /**
+     * Open a shared story
+     *
+     * Materializes a FRESH copy of the shared story (new story and chapter ids on every call — this read writes). `language` may be absent; content blocks are rehydrated with full documents where their ids still resolve.
+     */
+    getShared<ThrowOnError extends boolean = false>(parameters: {
+        id: string;
+    }, options?: Options<never, ThrowOnError>): RequestResult<StoriesGetSharedResponses, StoriesGetSharedErrors, ThrowOnError>;
+    /**
+     * Share a story
+     *
+     * Snapshots the story identified by `id` and returns the share id. No request body.
+     */
+    share<ThrowOnError extends boolean = false>(parameters: {
+        id: string;
+    }, options?: Options<never, ThrowOnError>): RequestResult<StoriesShareResponses, StoriesShareErrors, ThrowOnError>;
+}
+declare class Products extends HeyApiClient {
+    /**
+     * Similar products
+     *
+     * Superseded by skesis.similar (/skesis/query/similar). Kept for the whole of thamyr 4.x; removed only after a skesis read that returns product payloads exists, in a major announced ahead of time.
+     *
+     * @deprecated
+     */
+    getSimilar<ThrowOnError extends boolean = false>(parameters: {
+        productId: string;
+        topK?: number;
+        language?: string;
+    }, options?: Options<never, ThrowOnError>): RequestResult<ProductsGetSimilarResponses, ProductsGetSimilarErrors, ThrowOnError>;
+    /**
+     * Product recommendations
+     *
+     * Superseded by skesis.related (/skesis/query/related). Kept for the whole of thamyr 4.x; removed only after a skesis read that returns product payloads exists, in a major announced ahead of time.
+     *
+     * @deprecated
+     */
+    getRecommendations<ThrowOnError extends boolean = false>(parameters: {
+        productId: string;
+        language?: string;
+    }, options?: Options<never, ThrowOnError>): RequestResult<ProductsGetRecommendationsResponses, ProductsGetRecommendationsErrors, ThrowOnError>;
+}
+declare class Whisper extends HeyApiClient {
+    /**
+     * Last whisper for a story
+     */
+    getLast<ThrowOnError extends boolean = false>(parameters: {
+        storyId: string;
+    }, options?: Options<never, ThrowOnError>): RequestResult<WhisperGetLastResponses, WhisperGetLastErrors, ThrowOnError>;
+}
+declare class Analytics extends HeyApiClient {
+    /**
+     * Record a custom analytics event
+     *
+     * Fire-and-forget: always 204 on a valid body (dev-origin requests are dropped without insert).
+     */
+    trackEvent<ThrowOnError extends boolean = false>(parameters: {
+        storyId: string;
+        eventName: string;
+        content?: string;
+        payload?: {
+            [key: string]: string | number | boolean;
+        };
+    }, options?: Options<never, ThrowOnError>): RequestResult<AnalyticsTrackEventResponses, AnalyticsTrackEventErrors, ThrowOnError>;
+}
+declare class Cart extends HeyApiClient {
+    /**
+     * Current cart
+     *
+     * The shopper's current basket, created on first access. The shopper locale is derived from the Referer header.
+     */
+    getCart<ThrowOnError extends boolean = false>(options?: Options<never, ThrowOnError>): RequestResult<CartGetCartResponses, CartGetCartErrors, ThrowOnError>;
+    /**
+     * Add a product to the cart
+     *
+     * Adds one unit of the given product (variant) to the current basket and returns the updated basket.
+     */
+    addItemToCart<ThrowOnError extends boolean = false>(parameters: {
+        productId: string;
+    }, options?: Options<never, ThrowOnError>): RequestResult<CartAddItemToCartResponses, CartAddItemToCartErrors, ThrowOnError>;
+    /**
+     * Remove a product from the cart
+     *
+     * Removes the line item holding the given product (variant) from the current basket and returns the updated basket.
+     */
+    removeItemFromCart<ThrowOnError extends boolean = false>(parameters: {
+        productId: string;
+    }, options?: Options<never, ThrowOnError>): RequestResult<CartRemoveItemFromCartResponses, CartRemoveItemFromCartErrors, ThrowOnError>;
+    /**
+     * Update a product's quantity in the cart
+     *
+     * Sets the quantity of the line item holding the given product (variant) and returns the updated basket.
+     */
+    updateProductQuantity<ThrowOnError extends boolean = false>(parameters: {
+        productId: string;
+        quantity: number;
+    }, options?: Options<never, ThrowOnError>): RequestResult<CartUpdateProductQuantityResponses, CartUpdateProductQuantityErrors, ThrowOnError>;
+}
+declare class Skesis extends HeyApiClient {
+    /**
+     * Similar items
+     *
+     * Vector neighbours of an item ("more like this"). `anchorId` is the full skesis item id, e.g. `sfcc:product:123`. `locale` defaults to the storefront locale derived from the Referer.
+     */
+    similar<ThrowOnError extends boolean = false>(parameters: {
+        anchorId: string;
+        topK?: number;
+        locale?: string;
+    }, options?: Options<never, ThrowOnError>): RequestResult<SkesisSimilarResponses, SkesisSimilarErrors, ThrowOnError>;
+    /**
+     * Related items
+     *
+     * Graph-related items plus the sibling colour variants of an item. When the anchor itself has no edges, the engine falls back to the nearest vector neighbour's edge set (`usedFallback: true`). `locale` defaults to the storefront locale derived from the Referer.
+     */
+    related<ThrowOnError extends boolean = false>(parameters: {
+        anchorId: string;
+        locale?: string;
+    }, options?: Options<never, ThrowOnError>): RequestResult<SkesisRelatedResponses, SkesisRelatedErrors, ThrowOnError>;
+}
+declare class CallimacusApi extends HeyApiClient {
+    static readonly __registry: HeyApiRegistry<CallimacusApi>;
+    constructor(args: {
+        client: Client;
+        key?: string;
+    });
+    private _content?;
+    get content(): Content;
+    private _stories?;
+    get stories(): Stories;
+    private _products?;
+    get products(): Products;
+    private _whisper?;
+    get whisper(): Whisper;
+    private _analytics?;
+    get analytics(): Analytics;
+    private _cart?;
+    get cart(): Cart;
+    private _skesis?;
+    get skesis(): Skesis;
+}
+
+/**
+ The wire types of the public API contract, re-exported from ./generated/
+ under their published names, plus the protocol constants and guards the spec
+ cannot carry. Must stay fully type-erasable (const objects, not TS enums):
+ the node test runner imports this file from source. The alignment checks
+ below stop compilation if the vendored spec drifts from the declarations.
+ */
+
+type BCProduct = BcProductOutput;
+type SetProduct = SetProductOutput;
+type MasterProduct = MasterProductOutput;
+type MasterProductWithVariationGroup = MasterProductWithVariationGroupOutput;
+type VariationGroup = VariationGroupOutput;
+/**
+ A variant PRODUCT (`productId`, `orderable`, `variationValues`, `productPromotions`):
+ the items of `MasterProduct.variants`, as in v3. Anchored to the parent's field
+ rather than to a component id: for a while the document called the variation
+ ATTRIBUTE `Variant` (fixed in `@callimacus/db` 5.5.1), and this alias — like
+ {@link VariationAttribute} — stays correct whatever the components are named.
+ */
+type Variant = MasterProductOutput['variants'][number];
+/**
+ A variation attribute (`id`, `name`, `values`): the items of `MasterProduct.variationAttributes`.
+ */
+type VariationAttribute = MasterProductOutput['variationAttributes'][number];
+type LocalizedEPChapter = LocalizedEpChapter;
+type ContractUserInteraction = UserInteraction$1;
+type SLDocumentSection = SlDocumentSectionOutput;
+type SLInputEvent = SlInputEvent;
+type SLDocument = SlDocumentOutput;
+type Image = ImageOutput;
+type Video = VideoOutput;
+type Gallery = GalleryOutput;
+type Topic = TopicOutput;
+type LocalizedEPArtwork = LocalizedEpArtworkOutput;
+type LegacyBlock = LegacyBlockOutput;
+/**
+ Custom (tenant-defined) block. The `custom:` template-literal narrowing comes
+ straight from the generated types (the spec's `pattern: "^custom:"` via the
+ typeTransformer in openapi-ts.config.ts) — it is what lets
+ `block.type === 'image'` style switches keep narrowing `Block`. The alias
+ only adds the `data` type parameter for tenant payloads.
+ */
+type CustomBlock<T = unknown> = Omit<CustomBlockOutput, 'data'> & {
+    data: T;
+};
+type Block = BlockOutput;
+type Chapter = ChapterOutput;
+type Story = StoryOutput;
+/**
+Every `server-response` payload, exactly as the wire carries it.
+*/
+type ThamyrResponse = ThamyrResponse$1;
+type Values<E> = E[keyof E];
+declare const ThamyrResponseType: {
+    readonly ERROR: "error";
+    readonly CHAPTER_EVENT: "chapter-event";
+    readonly CHAPTER_DELETED: "chapter-deleted";
+    readonly STORY_RESET: "story-reset";
+    readonly STORY_CREATED: "story-created";
+    readonly STORY_SHARED: "story-shared";
+};
+type ThamyrResponseType = Values<typeof ThamyrResponseType>;
+/**
+Events received from the server.
+*/
+declare const ServerEvents: {
+    readonly ERROR: "error";
+    readonly SYSTEM_MESSAGE: "system-message";
+    readonly SERVER_STATUS: "server-status";
+    readonly SERVER_RESPONSE: "server-response";
+};
+type ServerEvents = Values<typeof ServerEvents>;
+/**
+Events sent to the server.
+*/
+declare const ClientEvents: {
+    readonly CLIENT_READY: "client-ready";
+    readonly USER_INTERACTION: "user-interaction";
+};
+type ClientEvents = Values<typeof ClientEvents>;
+declare const SLInputEventType: {
+    readonly question: "question";
+    readonly content: "content";
+    readonly topic: "topic";
+    readonly tag: "tag";
+    readonly image: "image";
+    readonly video: "video";
+    readonly gallery: "gallery";
+    readonly relatedQuestion: "relatedQuestion";
+    readonly page: "page";
+    readonly customInteraction: "customInteraction";
+    readonly customPage: "customPage";
+};
+type SLInputEventType = Values<typeof SLInputEventType>;
+declare const GalleryMode: {
+    readonly masonry: "masonry";
+    readonly carousel: "carousel";
+};
+type GalleryMode = Values<typeof GalleryMode>;
+declare const ChapterStatus: {
+    readonly understandingQuery: 1;
+    readonly craftingAnswer: 2;
+    readonly curatingContent: 3;
+    readonly done: 4;
+};
+type ChapterStatus = Values<typeof ChapterStatus>;
+/**
+ Narrow a block to a tenant-defined custom block. `type.startsWith('custom:')`
+ alone does not narrow the union — this is the guard form of the `custom:`
+ template-literal refinement above.
+ */
+declare function isCustomBlock(block: Block): block is CustomBlock;
+declare function isSetProduct(product: GenericProduct): product is SetProductOutput;
+declare function isMasterProduct(product: GenericProduct): product is MasterProductOutput;
+
+/**
+ Contains information about the client's environment and system
+ */
+type ClientInfo = {
+    /**
+    The browser's user agent string. Empty on platforms that do not expose one (React Native).
+    */
+    userAgent: string;
+    /**
+    The client's preferred language. Empty on platforms that do not expose one (React Native).
+    */
+    language: string;
+    /**
+    The client's timezone identifier
+    */
+    timezone: string;
+    /**
+    The client's screen dimensions (width x height). Empty where there is no `window.screen` (React Native).
+    */
+    screenResolution: string;
+    /**
+    The client's local time as a formatted string
+    */
+    localTime: string;
+    /**
+    Optional geographic coordinates of the client
+    */
+    location?: GeolocationPosition;
+};
+
+type BoundingBox = {
+    x: number;
+    y: number;
+    width: number;
+    height: number;
+    top: number;
+    left: number;
+    right: number;
+    bottom: number;
+};
+type UiElement = {
+    id: string;
+    bounds: BoundingBox;
+    isVisible: boolean;
+    visibilityRatio: number;
+};
+type UiSnapshot = {
+    timestamp: number;
+    viewport: {
+        width: number;
+        height: number;
+    };
+    blockIds: string[];
+    elements: UiElement[];
+};
+type InteractionContext = {
+    uiSnapshot?: UiSnapshot;
+};
+type UiObserverConfig = {
+    enabled?: boolean;
+    productSelector?: string;
+    blockSelector?: string;
+    maxTrackedElements?: number;
+    minVisibilityRatio?: number;
+};
+
+/**
+ Enum representing the different types of user interactions with the Callimacus service.
+ */
+declare enum UserInteractionType {
+    /**
+    Request to retrieve an existing story
+    */
+    GET_STORY = "get-story",
+    /**
+    Request to create a new round in a story
+    */
+    CREATE_ROUND = "create-round",
+    /**
+    Request to reset a story to its initial state
+    */
+    RESET_STORY = "reset-story",
+    /**
+    Request to navigate back from a round to the story
+    */
+    BACK_FROM_ROUND = "back-from-round",
+    /**
+    Request to share a story with others
+    */
+    SHARE_STORY = "share-story",
+    /**
+    Request to retrieve a story that has been shared
+    */
+    GET_SHARED_STORY = "get-shared-story"
+}
+/**
+The contract payload for one interaction type.
+*/
+type PayloadOf<K extends UserInteractionType> = Extract<ContractUserInteraction, {
+    type: `${K}`;
+}>['payload'];
+/**
+Payload for retrieving an existing story.
+*/
+type GetStoryPayload = PayloadOf<UserInteractionType.GET_STORY>;
+/**
+ Payload for creating a new round. `context` is stripped and re-added by
+ {@link InteractionPayloadMap}, which enriches every interaction with it.
+ */
+type CreateRoundPayload = Omit<PayloadOf<UserInteractionType.CREATE_ROUND>, 'context'>;
+/**
+Payload for resetting a story to its initial state.
+*/
+type ResetStoryPayload = PayloadOf<UserInteractionType.RESET_STORY>;
+/**
+Payload for navigating back from a round (the deprecated `roundId` wire alias is neither exposed nor sent).
+*/
+type BackFromRoundPayload = Omit<PayloadOf<UserInteractionType.BACK_FROM_ROUND>, 'roundId'>;
+/**
+Payload for sharing a story with others.
+*/
+type ShareStoryPayload = PayloadOf<UserInteractionType.SHARE_STORY>;
+/**
+Payload for retrieving a shared story.
+*/
+type GetSharedStoryPayload = PayloadOf<UserInteractionType.GET_SHARED_STORY>;
+type WithInteractionContext<T> = T & {
+    context?: InteractionContext;
+};
+/**
+ Map of interaction types to their corresponding payload types.
+ This ensures type safety when working with different interaction types.
+ */
+type InteractionPayloadMap = {
+    [UserInteractionType.GET_STORY]: WithInteractionContext<GetStoryPayload>;
+    [UserInteractionType.CREATE_ROUND]: WithInteractionContext<CreateRoundPayload>;
+    [UserInteractionType.RESET_STORY]: WithInteractionContext<ResetStoryPayload>;
+    [UserInteractionType.BACK_FROM_ROUND]: WithInteractionContext<BackFromRoundPayload>;
+    [UserInteractionType.SHARE_STORY]: WithInteractionContext<ShareStoryPayload>;
+    [UserInteractionType.GET_SHARED_STORY]: WithInteractionContext<GetSharedStoryPayload>;
+};
+/**
+ Discriminated union type representing all possible user interactions.
+ Each interaction has a type and a corresponding payload based on the interaction type.
+ */
+type UserInteraction = {
+    [E in UserInteractionType]: {
+        type: E;
+        payload: InteractionPayloadMap[E];
+    };
+}[UserInteractionType];
+
+/**
+ Enum representing the different types of events emitted by the Callimacus service.
+ */
+declare enum CallimacusEvent {
+    /**
+    Event emitted when a new processing round is created
+    */
+    ROUND_CREATED = "round-created",
+    /**
+    Event emitted during a processing round with intermediate results
+    */
+    ROUND_EVENT = "round-event",
+    /**
+    Event emitted when a processing round is completed
+    */
+    ROUND_COMPLETED = "round-completed",
+    /**
+    Event emitted when an error occurs during processing
+    */
+    ERROR = "error"
+}
+
+/**
+ Audio descriptor that a `tts` content item injects into a block's `data`.
+ Mirrors the shape produced by callimacus-core's tts runner.
+
+ `audioUrl` points at a streaming proxy: the clip is synthesized, streamed, and
+ cached lazily on the first GET, so fetching it (i.e. playing) is what triggers
+ synthesis — creating an element with `preload="none"` costs nothing.
+ */
+type TtsAudio = {
+    /**
+    Playable URL (mp3). Stream-on-first-play; safe to use as an <audio> src.
+    */
+    audioUrl: string;
+    /**
+    MIME type of the audio, e.g. `audio/mpeg`.
+    */
+    mimeType: string;
+    /**
+    ElevenLabs voice the clip was rendered with.
+    */
+    voiceId: string;
+    /**
+    The spoken text.
+    */
+    text: string;
+};
+/**
+ Find the audio descriptor a `tts` content item dropped into a block's `data`.
+ The block author chooses the key (the content item's id), so we scan the
+ top-level data values and return the first audio descriptor, or `undefined`
+ when the block carries none.
+ */
+declare function extractTtsAudio(data: unknown): TtsAudio | undefined;
+
+/**
+ The error surface hosts subscribe to via `onError`: server `error`-channel
+ messages plus terminal connection refusals. `reason` is present only on
+ refusals that carried the server's machine-readable slug (see
+ {@link ConnectRejection}), plus the SDK's own `retries_exhausted`.
+
+ An alias since the contract's ErrorMessage grew `reason?` itself; kept as
+ the name the callback types below always exposed.
+ */
+type CallimacusErrorMessage = ErrorMessage;
+/**
+ Callbacks for different socket events
+ */
+type ServerResponseCallback<T = ThamyrResponse> = (response: T) => void;
+type ConnectionStatusCallback = (isConnected: boolean) => void;
+type ErrorCallback = (error: CallimacusErrorMessage) => void;
+declare class CallimacusService {
+    private socket?;
+    private readonly serverResponseListeners;
+    private readonly connectionStatusListeners;
+    private readonly errorListeners;
+    private uiObserver?;
+    private uiObserverConfig;
+    private handshakeRetryAttempts;
+    private handshakeRetryTimer?;
+    private setupEventListeners;
+    /**
+     Notifies all server response listeners about a new response.
+
+     @param response - The response to notify listeners about
+     */
+    private notifyServerResponseListeners;
+    /**
+     Updates all connection status listeners about a connection status change.
+
+     @param isConnected - The new connection status
+     */
+    private updateConnectionStatus;
+    private notifyRejection;
+    /**
+     Schedules a manual reconnection attempt after a retryable handshake
+     refusal (see {@link shouldRetryHandshake}), with exponential backoff.
+     On exhaustion it emits a final, distinguishable error — "retrying" and
+     "gave up" must never look the same to the host, and the logger is
+     disabled by default so listeners are the only reliable channel.
+     */
+    private scheduleHandshakeRetry;
+    private clearHandshakeRetry;
+    /**
+     Notifies all error listeners about an error message.
+
+     @param error - The error to notify listeners about
+     */
+    private notifyErrorListeners;
+    /**
+     Retrieves the user's current geolocation coordinates.
+
+     Uses the browser's Geolocation API to get the current position. React Native
+     has no `navigator.geolocation` unless the app installs one, so the API is
+     feature-detected rather than assumed — the caller already treats a missing
+     position as normal (permission may simply be denied).
+
+     @returns A promise that resolves to the current position, or `undefined` when geolocation access is denied or unavailable
+     */
+    private getLocation;
+    private enrichPayloadWithUiContext;
+    private ensureUiObserver;
+    socketEndpoint(endpoint: string): {
+        origin: string;
+        path: string;
+    };
+    /**
+     Initializes the Callimacus connection to the server.
+
+     WebSocket is preferred, with a genuine fallback to HTTP long-polling;
+     reconnection behavior and timeouts use socket.io defaults.
+
+     @param url - The URL of the Callimacus server
+     @param headers - Optional headers to pass with the connection
+     @param auth - Optional auth payload sent with the socket handshake, merged with the page referrer
+     */
+    connect(url?: string, headers?: Record<string, string>, auth?: Record<string, string>): void;
+    /**
+     Disconnects from the Callimacus server.
+
+     Closes the socket, and updates the connection status.
+     */
+    disconnect(): void;
+    configureUiObserver(config?: UiObserverConfig): void;
+    /**
+     Sends a typed user interaction to the server with full type assistance.
+
+     @template T - The specific interaction type
+     @param type - Which interaction to send; selects the payload shape
+     @param payload - The properly typed payload for this interaction type
+     */
+    sendUserInteraction<T extends UserInteractionType>(type: T, payload: InteractionPayloadMap[T]): void;
+    /**
+     Collects information about the client's environment.
+
+     Gathers browser details, system information, and geolocation data
+     to provide context about the client's environment.
+
+     Every field is feature-detected. React Native defines `navigator` but not
+     `navigator.userAgent` / `.language`, and has no `window.screen` at all
+     (dimensions come from `Dimensions`, which core cannot reach without importing
+     `react-native`). Rather than throw a `ReferenceError` mid-call, the fields it
+     cannot determine come back as empty strings — an unambiguous "this platform
+     did not report it", as opposed to a plausible-looking wrong value. `timezone`
+     and `localTime` come from `Intl`/`Date` and are available on Hermes.
+
+     @returns A promise that resolves to a ClientInfo object containing user agent, language, timezone, local time, screen resolution, and geolocation data. Fields the platform does not expose are empty strings.
+     */
+    gatherClientInfo(): Promise<ClientInfo>;
+    onServerResponse(callback: ServerResponseCallback): () => void;
+    /**
+     Registers a callback for connection status changes. The callback fires on
+     future changes only — it is NOT invoked with the current status at
+     registration time (the react store relies on this to preserve its
+     'connecting' state).
+
+     @param callback - Function to call when connection status changes
+     @returns Unsubscribe function to remove the listener
+     */
+    onConnectionStatus(callback: ConnectionStatusCallback): () => void;
+    /**
+     Registers a callback for error messages.
+
+     @param callback - Function to call when an error is received
+     @returns Unsubscribe function to remove the listener
+     */
+    onError(callback: ErrorCallback): () => void;
+}
+declare const callimacusService: CallimacusService;
+
+/**
+ Structured payload the server attaches to a refused handshake (SOL-1100):
+ `code` is an HTTP-style status — 4xx is a deliberate refusal, 5xx means the
+ server could not evaluate the handshake — and `reason` is a machine-readable
+ slug such as `invalid_token`, `origin_not_allowed`, `auth_unavailable`.
+ */
+type ConnectRejection = {
+    code: number;
+    reason?: string;
+};
+/**
+ Extracts the server's structured rejection from a `connect_error`. Returns
+ undefined for errors that carry no such payload (engine-level failures, or
+ servers older than connect-time auth).
+ */
+declare function parseConnectRejection(error: Error): ConnectRejection | undefined;
+declare const MAX_HANDSHAKE_RETRIES = 3;
+/**
+ Whether a refused handshake deserves another attempt. 4xx refusals (bad key,
+ blocked origin) are deliberate and permanent — retrying them is exactly the
+ reconnect storm connect-time auth is designed to avoid. Only 5xx (the server
+ could not evaluate the handshake at all) earns a few spaced retries.
+ */
+declare function shouldRetryHandshake(code: number, attemptsSoFar: number): boolean;
+/**
+ Classifies a `connect_error` event. Returns undefined while the socket is
+ still `active` — an engine-level/network failure that socket.io-client
+ retries on its own and hosts must not be alarmed about. Otherwise the
+ connection was refused terminally: the result carries the server's code and
+ reason when present, or `code: 0` for refusals with no structured payload
+ (e.g. socket.io's own "Invalid namespace") so a locally-assigned code can
+ never be mistaken for a server-sent one.
+ */
+declare function classifyConnectError(error: Error, isActive: boolean): ConnectRejection | undefined;
+
+/**
+ Logger utility for Thamyr SDK
+ Provides configurable logging that can be enabled/disabled to avoid console spam
+ Browser-compatible implementation using native console API
+ */
+type LogLevel = 'debug' | 'info' | 'warn' | 'error' | 'silent';
+type LoggerConfig = {
+    enabled: boolean;
+    level: LogLevel;
+    prefix?: string;
+};
+declare class Logger {
+    private config;
+    debug: (...args: unknown[]) => void;
+    info: (...args: unknown[]) => void;
+    warn: (...args: unknown[]) => void;
+    error: (...args: unknown[]) => void;
+    private log;
+    /**
+     Merge the given options into the current logger configuration.
+
+     @param config - Options to override; omitted fields keep their current values
+     */
+    configure(config: Partial<LoggerConfig>): void;
+    /**
+     Get current logger configuration
+     */
+    getConfig(): LoggerConfig;
+}
+declare const logger: Logger;
+
+/**
+ Published image/video block `url`s resolve through cdn.callimacus.ai. This
+ builds a second URL requesting a transformed variant (resize, format
+ conversion, rotate, grayscale, ...) instead of the original file.
+ */
+type ImageResizeEdit = {
+    width?: number;
+    height?: number;
+    /**
+    `cover` (default, crops to fill), `contain` (letterboxes), `fill` (stretches), `inside`/`outside` (bounds only, no crop).
+    */
+    fit?: 'cover' | 'contain' | 'fill' | 'inside' | 'outside';
+};
+type ImageFormatEdit = {
+    /**
+    1-100.
+    */
+    quality?: number;
+};
+type ImageEdits = {
+    resize?: ImageResizeEdit;
+    /**
+    Forces a specific output format; omit entirely to auto-negotiate WebP/AVIF from the browser's `Accept` header.
+    */
+    webp?: ImageFormatEdit;
+    avif?: ImageFormatEdit;
+    jpeg?: ImageFormatEdit;
+    png?: ImageFormatEdit;
+    /**
+    Degrees.
+    */
+    rotate?: number;
+    grayscale?: true;
+    [edit: string]: unknown;
+};
+/**
+ Build a CDN URL requesting a transformed variant of a published
+ image/video block's `url`, instead of the original file. Omitting `edits`
+ entirely (or an empty object) is pointless: just render `cdnUrl` directly
+ in that case.
+ */
+declare function transformImageUrl(cdnUrl: string, edits: ImageEdits): string;
+
+/**
+ Generates an RFC 4122 version 4 UUID.
+
+ Prefers the native `crypto.randomUUID()` when available (browsers, Node, and
+ React Native runtimes that polyfill it). Falls back to `crypto.getRandomValues()`
+ — which React Native apps commonly provide via `react-native-get-random-values`
+ — and finally to `Math.random()` so the SDK never throws on a runtime that lacks
+ the Web Crypto API. Hermes ships with no global `crypto` whatsoever, hence the
+ `typeof` probe: a bare `crypto` reference would throw a `ReferenceError` there,
+ while `typeof` on an undeclared identifier is always safe.
+
+ The id correlates interactions for the lifetime of a session; it is not a
+ security token, so the non-crypto fallback is acceptable.
+ */
+declare function randomUuid(): string;
+
+type ContractClient = Client;
+/**
+What a contract call rejects with under `{throwOnError: true}`.
+
+- `status` is the HTTP status of the failed response, `undefined` when no response arrived (network or
+  CORS failure). It can be 2xx when the response arrived but its body could not be parsed or validated.
+- `body` is the parsed error body the server sent — `{error, errorId}` on the public API, a string for
+  non-JSON bodies, `{}` for an empty body — or, when no response arrived, the underlying `TypeError`
+  (also exposed as `cause`).
+
+Aborting a call through its `signal` is not a failure of the call: the abort reason is rethrown as is. The
+request signal decides, and it does so whether the abort landed before or after the response headers arrived.
+*/
+declare class ThamyrHttpError extends Error {
+    readonly status: number | undefined;
+    readonly body: unknown;
+    readonly response: Response | undefined;
+    readonly request: Request | undefined;
+    constructor(body: unknown, response?: Response, request?: Request);
+}
+/**
+Client for the generated {@link CallimacusApi}: the client id doubles as bearer token and x-sl-access-token.
+Calls made with `{throwOnError: true}` (per call, or through `setConfig`) reject with a
+{@link ThamyrHttpError}; the envelope's `error` stays the parsed body, as documented.
+*/
+declare function createContractClient(config: {
+    endpoint: string;
+    accessToken: string;
+    /**
+    Send cookies cross-origin (the old axios `withCredentials`).
+    */
+    withCredentials?: boolean;
+}): ContractClient;
+
+export { CallimacusApi, CallimacusEvent, CallimacusService, ChapterStatus, ClientEvents, GalleryMode, MAX_HANDSHAKE_RETRIES, SLInputEventType, ServerEvents, ThamyrHttpError, ThamyrResponseType, UserInteractionType, callimacusService, classifyConnectError, createContractClient, extractTtsAudio, isCustomBlock, isMasterProduct, isSetProduct, logger, parseConnectRejection, randomUuid, shouldRetryHandshake, transformImageUrl };
+export type { BCProduct, Basket, Block, BoundingBox, CallimacusErrorMessage, Chapter, ClientInfo, ConnectRejection, ConnectionStatusCallback, ContractClient, CustomBlock, ErrorCallback, ErrorMessage, Gallery, GenericProduct, HomePage, Image, ImageEdits, ImageFormatEdit, ImageResizeEdit, InteractionContext, InteractionPayloadMap, LegacyBlock, LocalizedEPArtwork, LocalizedEPChapter, LogLevel, LoggerConfig, MasterProduct, MasterProductWithVariationGroup, OptionItem, ProductItem, ProductMatch, RecommendationsResponse, SLDocument, SLDocumentSection, SLInputEvent, ServerResponseCallback, SetProduct, SkesisItem, SkesisRelatedResponse, SkesisSimilarResponse, Story, ThamyrResponse, Topic, TopicContentsPage, TopicSummary, TtsAudio, UiElement, UiObserverConfig, UiSnapshot, UserInteraction, Variant, VariationAttribute, VariationGroup, Video, WhisperPayload };