oneentry 1.0.159 → 1.0.161

package/esm/products/productsInterfaces.js

@@ -0,0 +1 @@
+export {};

package/esm/products/productsSchemas.d.ts

@@ -0,0 +1,234 @@
+/**
+ * Validation schemas for Products module
+ * @description Zod schemas for validating products-related API responses
+ */
+import { z } from 'zod';
+/**
+ * Product price schema
+ */
+export declare const ProductPriceSchema: z.ZodObject<{
+    value: z.ZodNumber;
+    currency: z.ZodString;
+    compareValue: z.ZodOptional<z.ZodNumber>;
+}, z.core.$strip>;
+/**
+ * Product image schema
+ */
+export declare const ProductImageSchema: z.ZodObject<{
+    id: z.ZodNumber;
+    filename: z.ZodString;
+    url: z.ZodString;
+    size: z.ZodOptional<z.ZodNumber>;
+    type: z.ZodOptional<z.ZodString>;
+}, z.core.$strip>;
+/**
+ * Product entity schema
+ * Includes all fields returned by the API
+ */
+export declare const ProductEntitySchema: z.ZodObject<{
+    id: z.ZodNumber;
+    localizeInfos: z.ZodRecord<z.ZodString, z.ZodAny>;
+    statusIdentifier: z.ZodNullable<z.ZodString>;
+    statusLocalizeInfos: z.ZodRecord<z.ZodString, z.ZodUnknown>;
+    attributeSetIdentifier: z.ZodNullable<z.ZodString>;
+    position: z.ZodNumber;
+    price: z.ZodNullable<z.ZodNumber>;
+    additional: z.ZodObject<{
+        prices: z.ZodObject<{
+            min: z.ZodNumber;
+            max: z.ZodNumber;
+        }, z.core.$strip>;
+    }, z.core.$strip>;
+    sku: z.ZodNullable<z.ZodString>;
+    isSync: z.ZodBoolean;
+    attributeValues: z.ZodRecord<z.ZodString, z.ZodAny>;
+    categories: z.ZodArray<z.ZodString>;
+    isVisible: z.ZodBoolean;
+    moduleFormConfigs: z.ZodOptional<z.ZodArray<z.ZodAny>>;
+    rating: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
+    templateIdentifier: z.ZodNullable<z.ZodOptional<z.ZodString>>;
+    shortDescTemplateIdentifier: z.ZodNullable<z.ZodOptional<z.ZodString>>;
+    signedPrice: z.ZodOptional<z.ZodString>;
+    productPages: z.ZodOptional<z.ZodArray<z.ZodObject<{
+        id: z.ZodNumber;
+        pageId: z.ZodNumber;
+        productId: z.ZodNumber;
+        positionId: z.ZodNumber;
+        categoryPath: z.ZodString;
+    }, z.core.$strip>>>;
+    blocks: z.ZodOptional<z.ZodArray<z.ZodString>>;
+    isPositionLocked: z.ZodOptional<z.ZodBoolean>;
+    relatedIds: z.ZodOptional<z.ZodArray<z.ZodNumber>>;
+    paymentStages: z.ZodNullable<z.ZodOptional<z.ZodAny>>;
+    distance: z.ZodOptional<z.ZodNumber>;
+    discountConfig: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodAny>>;
+}, z.core.$strip>;
+/**
+ * Products response schema
+ */
+export declare const ProductsResponseSchema: z.ZodObject<{
+    items: z.ZodArray<z.ZodObject<{
+        id: z.ZodNumber;
+        localizeInfos: z.ZodRecord<z.ZodString, z.ZodAny>;
+        statusIdentifier: z.ZodNullable<z.ZodString>;
+        statusLocalizeInfos: z.ZodRecord<z.ZodString, z.ZodUnknown>;
+        attributeSetIdentifier: z.ZodNullable<z.ZodString>;
+        position: z.ZodNumber;
+        price: z.ZodNullable<z.ZodNumber>;
+        additional: z.ZodObject<{
+            prices: z.ZodObject<{
+                min: z.ZodNumber;
+                max: z.ZodNumber;
+            }, z.core.$strip>;
+        }, z.core.$strip>;
+        sku: z.ZodNullable<z.ZodString>;
+        isSync: z.ZodBoolean;
+        attributeValues: z.ZodRecord<z.ZodString, z.ZodAny>;
+        categories: z.ZodArray<z.ZodString>;
+        isVisible: z.ZodBoolean;
+        moduleFormConfigs: z.ZodOptional<z.ZodArray<z.ZodAny>>;
+        rating: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
+        templateIdentifier: z.ZodNullable<z.ZodOptional<z.ZodString>>;
+        shortDescTemplateIdentifier: z.ZodNullable<z.ZodOptional<z.ZodString>>;
+        signedPrice: z.ZodOptional<z.ZodString>;
+        productPages: z.ZodOptional<z.ZodArray<z.ZodObject<{
+            id: z.ZodNumber;
+            pageId: z.ZodNumber;
+            productId: z.ZodNumber;
+            positionId: z.ZodNumber;
+            categoryPath: z.ZodString;
+        }, z.core.$strip>>>;
+        blocks: z.ZodOptional<z.ZodArray<z.ZodString>>;
+        isPositionLocked: z.ZodOptional<z.ZodBoolean>;
+        relatedIds: z.ZodOptional<z.ZodArray<z.ZodNumber>>;
+        paymentStages: z.ZodNullable<z.ZodOptional<z.ZodAny>>;
+        distance: z.ZodOptional<z.ZodNumber>;
+        discountConfig: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodAny>>;
+    }, z.core.$strip>>;
+    total: z.ZodNumber;
+    totalFound: z.ZodOptional<z.ZodNumber>;
+}, z.core.$strip>;
+/**
+ * Single product response schema
+ */
+export declare const SingleProductSchema: z.ZodObject<{
+    id: z.ZodNumber;
+    localizeInfos: z.ZodRecord<z.ZodString, z.ZodAny>;
+    statusIdentifier: z.ZodNullable<z.ZodString>;
+    statusLocalizeInfos: z.ZodRecord<z.ZodString, z.ZodUnknown>;
+    attributeSetIdentifier: z.ZodNullable<z.ZodString>;
+    position: z.ZodNumber;
+    price: z.ZodNullable<z.ZodNumber>;
+    additional: z.ZodObject<{
+        prices: z.ZodObject<{
+            min: z.ZodNumber;
+            max: z.ZodNumber;
+        }, z.core.$strip>;
+    }, z.core.$strip>;
+    sku: z.ZodNullable<z.ZodString>;
+    isSync: z.ZodBoolean;
+    attributeValues: z.ZodRecord<z.ZodString, z.ZodAny>;
+    categories: z.ZodArray<z.ZodString>;
+    isVisible: z.ZodBoolean;
+    moduleFormConfigs: z.ZodOptional<z.ZodArray<z.ZodAny>>;
+    rating: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
+    templateIdentifier: z.ZodNullable<z.ZodOptional<z.ZodString>>;
+    shortDescTemplateIdentifier: z.ZodNullable<z.ZodOptional<z.ZodString>>;
+    signedPrice: z.ZodOptional<z.ZodString>;
+    productPages: z.ZodOptional<z.ZodArray<z.ZodObject<{
+        id: z.ZodNumber;
+        pageId: z.ZodNumber;
+        productId: z.ZodNumber;
+        positionId: z.ZodNumber;
+        categoryPath: z.ZodString;
+    }, z.core.$strip>>>;
+    blocks: z.ZodOptional<z.ZodArray<z.ZodString>>;
+    isPositionLocked: z.ZodOptional<z.ZodBoolean>;
+    relatedIds: z.ZodOptional<z.ZodArray<z.ZodNumber>>;
+    paymentStages: z.ZodNullable<z.ZodOptional<z.ZodAny>>;
+    distance: z.ZodOptional<z.ZodNumber>;
+    discountConfig: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodAny>>;
+}, z.core.$strip>;
+/**
+ * Product search result schema
+ * Short card returned by the quick search endpoint
+ */
+export declare const ProductSearchResultSchema: z.ZodObject<{
+    id: z.ZodNumber;
+    title: z.ZodString;
+    pageId: z.ZodNumber;
+}, z.core.$strip>;
+/**
+ * Product search response schema (array of short cards)
+ */
+export declare const ProductSearchResponseSchema: z.ZodArray<z.ZodObject<{
+    id: z.ZodNumber;
+    title: z.ZodString;
+    pageId: z.ZodNumber;
+}, z.core.$strip>>;
+/**
+ * Products count schema
+ */
+export declare const ProductsCountSchema: z.ZodObject<{
+    totalAll: z.ZodNumber;
+    totalInCategory: z.ZodNumber;
+    totalInCategoryWithNested: z.ZodNumber;
+}, z.core.$strip>;
+/**
+ * Product block schema
+ */
+export declare const ProductBlockSchema: z.ZodObject<{
+    id: z.ZodNumber;
+    attributeSetIdentifier: z.ZodNullable<z.ZodString>;
+    localizeInfos: z.ZodRecord<z.ZodString, z.ZodAny>;
+    version: z.ZodNumber;
+    position: z.ZodNumber;
+    identifier: z.ZodString;
+    type: z.ZodString;
+    customSettings: z.ZodRecord<z.ZodString, z.ZodAny>;
+    templateIdentifier: z.ZodNullable<z.ZodString>;
+    isVisible: z.ZodBoolean;
+    isSync: z.ZodBoolean;
+    attributeValues: z.ZodRecord<z.ZodString, z.ZodAny>;
+}, z.core.$strip>;
+/**
+ * Related products schema
+ */
+export declare const RelatedProductsSchema: z.ZodArray<z.ZodObject<{
+    id: z.ZodNumber;
+    localizeInfos: z.ZodRecord<z.ZodString, z.ZodAny>;
+    statusIdentifier: z.ZodNullable<z.ZodString>;
+    statusLocalizeInfos: z.ZodRecord<z.ZodString, z.ZodUnknown>;
+    attributeSetIdentifier: z.ZodNullable<z.ZodString>;
+    position: z.ZodNumber;
+    price: z.ZodNullable<z.ZodNumber>;
+    additional: z.ZodObject<{
+        prices: z.ZodObject<{
+            min: z.ZodNumber;
+            max: z.ZodNumber;
+        }, z.core.$strip>;
+    }, z.core.$strip>;
+    sku: z.ZodNullable<z.ZodString>;
+    isSync: z.ZodBoolean;
+    attributeValues: z.ZodRecord<z.ZodString, z.ZodAny>;
+    categories: z.ZodArray<z.ZodString>;
+    isVisible: z.ZodBoolean;
+    moduleFormConfigs: z.ZodOptional<z.ZodArray<z.ZodAny>>;
+    rating: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
+    templateIdentifier: z.ZodNullable<z.ZodOptional<z.ZodString>>;
+    shortDescTemplateIdentifier: z.ZodNullable<z.ZodOptional<z.ZodString>>;
+    signedPrice: z.ZodOptional<z.ZodString>;
+    productPages: z.ZodOptional<z.ZodArray<z.ZodObject<{
+        id: z.ZodNumber;
+        pageId: z.ZodNumber;
+        productId: z.ZodNumber;
+        positionId: z.ZodNumber;
+        categoryPath: z.ZodString;
+    }, z.core.$strip>>>;
+    blocks: z.ZodOptional<z.ZodArray<z.ZodString>>;
+    isPositionLocked: z.ZodOptional<z.ZodBoolean>;
+    relatedIds: z.ZodOptional<z.ZodArray<z.ZodNumber>>;
+    paymentStages: z.ZodNullable<z.ZodOptional<z.ZodAny>>;
+    distance: z.ZodOptional<z.ZodNumber>;
+    discountConfig: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodAny>>;
+}, z.core.$strip>>;

package/esm/products/productsSchemas.js

@@ -0,0 +1,121 @@
+/**
+ * Validation schemas for Products module
+ * @description Zod schemas for validating products-related API responses
+ */
+import { z } from 'zod';
+/**
+ * Product price schema
+ */
+export const ProductPriceSchema = z.object({
+    value: z.number(),
+    currency: z.string(),
+    compareValue: z.number().optional(),
+});
+/**
+ * Product image schema
+ */
+export const ProductImageSchema = z.object({
+    id: z.number(),
+    filename: z.string(),
+    url: z.string(),
+    size: z.number().optional(),
+    type: z.string().optional(),
+});
+/**
+ * Product entity schema
+ * Includes all fields returned by the API
+ */
+export const ProductEntitySchema = z.object({
+    id: z.number(),
+    localizeInfos: z.record(z.string(), z.any()),
+    statusIdentifier: z.string().nullable(),
+    statusLocalizeInfos: z.record(z.string(), z.unknown()),
+    attributeSetIdentifier: z.string().nullable(),
+    position: z.number(),
+    price: z.number().nullable(),
+    additional: z.object({
+        prices: z.object({
+            min: z.number(),
+            max: z.number(),
+        }),
+    }),
+    sku: z.string().nullable(),
+    isSync: z.boolean(),
+    attributeValues: z.record(z.string(), z.any()),
+    categories: z.array(z.string()),
+    isVisible: z.boolean(),
+    moduleFormConfigs: z.array(z.any()).optional(),
+    rating: z.record(z.string(), z.unknown()).optional(),
+    templateIdentifier: z.string().optional().nullable(),
+    shortDescTemplateIdentifier: z.string().optional().nullable(),
+    signedPrice: z.string().optional(),
+    productPages: z
+        .array(z.object({
+        id: z.number(),
+        pageId: z.number(),
+        productId: z.number(),
+        positionId: z.number(),
+        categoryPath: z.string(),
+    }))
+        .optional(),
+    blocks: z.array(z.string()).optional(),
+    isPositionLocked: z.boolean().optional(),
+    relatedIds: z.array(z.number()).optional(),
+    paymentStages: z.any().optional().nullable(),
+    distance: z.number().optional(),
+    discountConfig: z.record(z.string(), z.any()).optional(),
+});
+/**
+ * Products response schema
+ */
+export const ProductsResponseSchema = z.object({
+    items: z.array(ProductEntitySchema),
+    total: z.number(),
+    totalFound: z.number().optional(),
+});
+/**
+ * Single product response schema
+ */
+export const SingleProductSchema = ProductEntitySchema;
+/**
+ * Product search result schema
+ * Short card returned by the quick search endpoint
+ */
+export const ProductSearchResultSchema = z.object({
+    id: z.number(),
+    title: z.string(),
+    pageId: z.number(),
+});
+/**
+ * Product search response schema (array of short cards)
+ */
+export const ProductSearchResponseSchema = z.array(ProductSearchResultSchema);
+/**
+ * Products count schema
+ */
+export const ProductsCountSchema = z.object({
+    totalAll: z.number(),
+    totalInCategory: z.number(),
+    totalInCategoryWithNested: z.number(),
+});
+/**
+ * Product block schema
+ */
+export const ProductBlockSchema = z.object({
+    id: z.number(),
+    attributeSetIdentifier: z.string().nullable(),
+    localizeInfos: z.record(z.string(), z.any()),
+    version: z.number(),
+    position: z.number(),
+    identifier: z.string(),
+    type: z.string(),
+    customSettings: z.record(z.string(), z.any()),
+    templateIdentifier: z.string().nullable(),
+    isVisible: z.boolean(),
+    isSync: z.boolean(),
+    attributeValues: z.record(z.string(), z.any()),
+});
+/**
+ * Related products schema
+ */
+export const RelatedProductsSchema = z.array(ProductEntitySchema);

package/esm/search/searchApi.d.ts

@@ -0,0 +1,35 @@
+import AsyncModules from '../base/asyncModules.js';
+import type StateModule from '../base/stateModule.js';
+import type { IError } from '../base/utils.js';
+import type { IGlobalSearchResponse, ISearchApi, TGlobalSearchEntityType } from './searchInterfaces.js';
+/**
+ * Controllers for the public cross-entity search.
+ * @handle /api/content/search
+ * @class SearchApi
+ * @augments AsyncModules
+ * @implements {ISearchApi}
+ * @description This class provides a public search over names and attribute values of visible records.
+ */
+export default class SearchApi extends AsyncModules implements ISearchApi {
+    protected state: StateModule;
+    protected _url: string;
+    /**
+     * Constructor for SearchApi class.
+     * @param {StateModule} state - The state module.
+     */
+    constructor(state: StateModule);
+    /**
+     * Public search across titles and attribute values of visible records.
+     * @handleName globalSearch
+     * @param {string} query - Search query. Example: "winter".
+     * @param {TGlobalSearchEntityType[]} [types] - Entity types to search in, sent comma-separated. Searches every type when omitted.
+     * @param {'all' | 'visible' | 'hidden'} [visibility] - Visibility filter of the searched records. Default: "all".
+     * @param {number} [offset] - Drilldown mode offset. Pass it only together with a single accessible type in `types`.
+     * @param {number} [limit] - Drilldown mode page size. Pass it only together with a single accessible type in `types`, otherwise the API answers 400 "Drilldown mode (limit/offset) requires exactly one accessible type in `types`". Without it every group is returned in full.
+     * @returns {Promise<IGlobalSearchResponse | IError>} Returns the query and the found records grouped by entity type.
+     * @throws {IError} When isShell=false and an error occurs during the fetch
+     * @description Searches names and attribute values of visible records across entity types.
+     * @see {@link https://js-sdk.oneentry.cloud/docs/search/globalSearch globalSearch} documentation.
+     */
+    globalSearch(query: string, types?: TGlobalSearchEntityType[], visibility?: 'all' | 'visible' | 'hidden', offset?: number, limit?: number): Promise<IGlobalSearchResponse | IError>;
+}

package/esm/search/searchApi.js

@@ -0,0 +1,47 @@
+import AsyncModules from '../base/asyncModules.js';
+import createSchemaLoader from '../base/lazySchema.js';
+const schema = createSchemaLoader(() => import('./searchSchemas.js'));
+/**
+ * Controllers for the public cross-entity search.
+ * @handle /api/content/search
+ * @class SearchApi
+ * @augments AsyncModules
+ * @implements {ISearchApi}
+ * @description This class provides a public search over names and attribute values of visible records.
+ */
+export default class SearchApi extends AsyncModules {
+    /**
+     * Constructor for SearchApi class.
+     * @param {StateModule} state - The state module.
+     */
+    constructor(state) {
+        super(state);
+        this._url = state.url + '/api/content/search';
+    }
+    /**
+     * Public search across titles and attribute values of visible records.
+     * @handleName globalSearch
+     * @param {string} query - Search query. Example: "winter".
+     * @param {TGlobalSearchEntityType[]} [types] - Entity types to search in, sent comma-separated. Searches every type when omitted.
+     * @param {'all' | 'visible' | 'hidden'} [visibility] - Visibility filter of the searched records. Default: "all".
+     * @param {number} [offset] - Drilldown mode offset. Pass it only together with a single accessible type in `types`.
+     * @param {number} [limit] - Drilldown mode page size. Pass it only together with a single accessible type in `types`, otherwise the API answers 400 "Drilldown mode (limit/offset) requires exactly one accessible type in `types`". Without it every group is returned in full.
+     * @returns {Promise<IGlobalSearchResponse | IError>} Returns the query and the found records grouped by entity type.
+     * @throws {IError} When isShell=false and an error occurs during the fetch
+     * @description Searches names and attribute values of visible records across entity types.
+     * @see {@link https://js-sdk.oneentry.cloud/docs/search/globalSearch globalSearch} documentation.
+     */
+    async globalSearch(query, types, visibility, offset, limit) {
+        // `types` is sent comma-separated — the array stringifies to exactly that.
+        const params = {
+            q: query,
+            types,
+            visibility,
+            offset,
+            limit,
+        };
+        const data = await this._fetchGet(`?` + this._queryParamsToString(params));
+        const validated = await this._validateResponse(data, schema('GlobalSearchResponseSchema'));
+        return this._normalizeData(validated);
+    }
+}

package/esm/search/searchInterfaces.d.ts

@@ -0,0 +1,94 @@
+import type { IError } from '../base/utils.js';
+/**
+ * Interface for the Search API module.
+ * @interface ISearchApi
+ * @description This interface defines methods for the public cross-entity search.
+ */
+interface ISearchApi {
+    /**
+     * Public search across titles and attribute values of visible records.
+     * @handleName globalSearch
+     * @param {string} query - Search query. Example: "winter".
+     * @param {TGlobalSearchEntityType[]} [types] - Entity types to search in, sent comma-separated. Searches every type when omitted.
+     * @param {'all' | 'visible' | 'hidden'} [visibility] - Visibility filter of the searched records. Default: "all".
+     * @param {number} [offset] - Drilldown mode offset. Pass it only together with a single accessible type in `types`.
+     * @param {number} [limit] - Drilldown mode page size. Pass it only together with a single accessible type in `types`, otherwise the API answers 400 "Drilldown mode (limit/offset) requires exactly one accessible type in `types`". Without it every group is returned in full.
+     * @returns {Promise<IGlobalSearchResponse | IError>} Returns the query and the found records grouped by entity type.
+     * @throws {IError} When isShell=false and an error occurs during the fetch
+     * @description Searches names and attribute values of visible records across entity types.
+     */
+    globalSearch(query: string, types?: TGlobalSearchEntityType[], visibility?: 'all' | 'visible' | 'hidden', offset?: number, limit?: number): Promise<IGlobalSearchResponse | IError>;
+}
+/**
+ * Entity type a global search group or item belongs to.
+ * @description Entity type a global search group or item belongs to.
+ */
+type TGlobalSearchEntityType = 'products' | 'pages' | 'blocks' | 'slides' | 'templates' | 'discounts' | 'user_groups' | 'users' | 'admins' | 'menus' | 'forms' | 'attributes_sets' | 'attributes' | 'orders' | 'workflows' | 'events' | 'subscriptions' | 'collections';
+/**
+ * How a global search item matched the query.
+ * @description Ranking kind of the match: exact value, title, attribute name or attribute value.
+ */
+type TGlobalSearchMatchKind = 'exact' | 'title' | 'attributeName' | 'attributeValue';
+/**
+ * Concrete field a global search item matched on.
+ * @description Field that produced the match; independent from the matchKind ranking.
+ */
+type TGlobalSearchMatchedField = 'id' | 'title' | 'identifier' | 'url' | 'attributeName' | 'attributeValue' | 'importId' | 'nodeName';
+/**
+ * A single record found by the global search.
+ * @interface IGlobalSearchItem
+ * @property {TGlobalSearchEntityType} type - Entity type of the found record. Example: "products".
+ * @property {number | string} id - Entity id; a string for workflows and attributes. Example: 12345.
+ * @property {string} [title] - Display title; absent when the record has no own name (orders, users without login). Example: "Winter jacket".
+ * @property {string} [identifier] - Machine identifier (marker) of the record. Example: "winter_jacket".
+ * @property {string} [subtitle] - Secondary line (url, storage, node). Example: "catalog/winter".
+ * @property {TGlobalSearchMatchKind} matchKind - How the record matched the query. Example: "title".
+ * @property {TGlobalSearchMatchedField} matchedField - Concrete field that matched the query. Example: "title".
+ * @property {Record<string, unknown>} [matchedAttribute] - Attribute the match occurred in.
+ * @property {string} [fragment] - Plain-text context around the match, no markup. Example: "warm winter jacket".
+ * @property {string} [langCode] - Language code of the matched value. Example: "en_US".
+ * @property {boolean} [isVisible] - Visibility of the found record. Example: true.
+ * @property {Record<string, unknown>} [parent] - Owning record for entities without their own page (slides to block, orders to storage).
+ * @property {number} [attributeSetId] - Owning attribute set id; only for type=attributes. Example: 12.
+ * @description A single record found by the global search, with the context of how it matched.
+ */
+interface IGlobalSearchItem {
+    type: TGlobalSearchEntityType;
+    id: number | string;
+    title?: string;
+    identifier?: string;
+    subtitle?: string;
+    matchKind: TGlobalSearchMatchKind;
+    matchedField: TGlobalSearchMatchedField;
+    matchedAttribute?: Record<string, unknown>;
+    fragment?: string;
+    langCode?: string;
+    isVisible?: boolean;
+    parent?: Record<string, unknown>;
+    attributeSetId?: number;
+}
+/**
+ * Global search results of a single entity type.
+ * @interface IGlobalSearchGroup
+ * @property {TGlobalSearchEntityType} type - Entity type of the group. Example: "products".
+ * @property {IGlobalSearchItem[]} items - Records found within this entity type.
+ * @property {boolean} hasMore - Whether more records of this type are available beyond the requested page. Example: false.
+ * @description Global search results of a single entity type.
+ */
+interface IGlobalSearchGroup {
+    type: TGlobalSearchEntityType;
+    items: IGlobalSearchItem[];
+    hasMore: boolean;
+}
+/**
+ * Response of the global search endpoint.
+ * @interface IGlobalSearchResponse
+ * @property {string} query - The query the results were produced for. Example: "winter".
+ * @property {IGlobalSearchGroup[]} groups - Found records grouped by entity type.
+ * @description Response of the global search endpoint: the query and the found records grouped by entity type.
+ */
+interface IGlobalSearchResponse {
+    query: string;
+    groups: IGlobalSearchGroup[];
+}
+export type { IGlobalSearchGroup, IGlobalSearchItem, IGlobalSearchResponse, ISearchApi, TGlobalSearchEntityType, TGlobalSearchMatchedField, TGlobalSearchMatchKind, };

package/esm/search/searchInterfaces.js

@@ -0,0 +1 @@
+export {};

package/esm/search/searchSchemas.d.ts

@@ -0,0 +1,73 @@
+/**
+ * Validation schemas for Search module
+ * @description Zod schemas for validating search-related API responses (raw API data, before normalization)
+ */
+import { z } from 'zod';
+/**
+ * Global search item schema
+ * @description Schema for a single record found by the global search
+ */
+export declare const GlobalSearchItemSchema: z.ZodObject<{
+    type: z.ZodString;
+    id: z.ZodUnion<readonly [z.ZodNumber, z.ZodString]>;
+    title: z.ZodOptional<z.ZodString>;
+    identifier: z.ZodOptional<z.ZodString>;
+    subtitle: z.ZodOptional<z.ZodString>;
+    matchKind: z.ZodString;
+    matchedField: z.ZodString;
+    matchedAttribute: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
+    fragment: z.ZodOptional<z.ZodString>;
+    langCode: z.ZodOptional<z.ZodString>;
+    isVisible: z.ZodOptional<z.ZodBoolean>;
+    parent: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
+    attributeSetId: z.ZodOptional<z.ZodNumber>;
+}, z.core.$strip>;
+/**
+ * Global search group schema
+ * @description Schema for the results of a single entity type
+ */
+export declare const GlobalSearchGroupSchema: z.ZodObject<{
+    type: z.ZodString;
+    items: z.ZodArray<z.ZodObject<{
+        type: z.ZodString;
+        id: z.ZodUnion<readonly [z.ZodNumber, z.ZodString]>;
+        title: z.ZodOptional<z.ZodString>;
+        identifier: z.ZodOptional<z.ZodString>;
+        subtitle: z.ZodOptional<z.ZodString>;
+        matchKind: z.ZodString;
+        matchedField: z.ZodString;
+        matchedAttribute: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
+        fragment: z.ZodOptional<z.ZodString>;
+        langCode: z.ZodOptional<z.ZodString>;
+        isVisible: z.ZodOptional<z.ZodBoolean>;
+        parent: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
+        attributeSetId: z.ZodOptional<z.ZodNumber>;
+    }, z.core.$strip>>;
+    hasMore: z.ZodBoolean;
+}, z.core.$strip>;
+/**
+ * Global search response schema
+ * @description Schema for the response returned by globalSearch
+ */
+export declare const GlobalSearchResponseSchema: z.ZodObject<{
+    query: z.ZodString;
+    groups: z.ZodArray<z.ZodObject<{
+        type: z.ZodString;
+        items: z.ZodArray<z.ZodObject<{
+            type: z.ZodString;
+            id: z.ZodUnion<readonly [z.ZodNumber, z.ZodString]>;
+            title: z.ZodOptional<z.ZodString>;
+            identifier: z.ZodOptional<z.ZodString>;
+            subtitle: z.ZodOptional<z.ZodString>;
+            matchKind: z.ZodString;
+            matchedField: z.ZodString;
+            matchedAttribute: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
+            fragment: z.ZodOptional<z.ZodString>;
+            langCode: z.ZodOptional<z.ZodString>;
+            isVisible: z.ZodOptional<z.ZodBoolean>;
+            parent: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
+            attributeSetId: z.ZodOptional<z.ZodNumber>;
+        }, z.core.$strip>>;
+        hasMore: z.ZodBoolean;
+    }, z.core.$strip>>;
+}, z.core.$strip>;

package/esm/search/searchSchemas.js

@@ -0,0 +1,41 @@
+/**
+ * Validation schemas for Search module
+ * @description Zod schemas for validating search-related API responses (raw API data, before normalization)
+ */
+import { z } from 'zod';
+/**
+ * Global search item schema
+ * @description Schema for a single record found by the global search
+ */
+export const GlobalSearchItemSchema = z.object({
+    type: z.string(),
+    id: z.union([z.number(), z.string()]),
+    title: z.string().optional(),
+    identifier: z.string().optional(),
+    subtitle: z.string().optional(),
+    matchKind: z.string(),
+    matchedField: z.string(),
+    matchedAttribute: z.record(z.string(), z.unknown()).optional(),
+    fragment: z.string().optional(),
+    langCode: z.string().optional(),
+    isVisible: z.boolean().optional(),
+    parent: z.record(z.string(), z.unknown()).optional(),
+    attributeSetId: z.number().optional(),
+});
+/**
+ * Global search group schema
+ * @description Schema for the results of a single entity type
+ */
+export const GlobalSearchGroupSchema = z.object({
+    type: z.string(),
+    items: z.array(GlobalSearchItemSchema),
+    hasMore: z.boolean(),
+});
+/**
+ * Global search response schema
+ * @description Schema for the response returned by globalSearch
+ */
+export const GlobalSearchResponseSchema = z.object({
+    query: z.string(),
+    groups: z.array(GlobalSearchGroupSchema),
+});