oneentry 1.0.160 → 1.0.162

package/dist/pages/pagesApi.d.ts

@@ -1,7 +1,7 @@
 import AsyncModules from '../base/asyncModules';
 import type StateModule from '../base/stateModule';
 import type { IError } from '../base/utils';
-import type { IPageConfig, IPagesApi, IPageSearchResult, IPagesEntity, IPositionBlock } from './pagesInterfaces';
+import type { IPagesApi, IPageSearchResult, IPagesEntity, IPagesResponse, IPagesVectorSearch, IPositionBlock } from './pagesInterfaces';
 /**
  * Controllers for working with page objects, including catalog pages
  * @handle /api/content/pages
@@ -80,16 +80,6 @@ export default class PagesApi extends AsyncModules implements IPagesApi {
      * @see {@link https://js-sdk.oneentry.cloud/docs/pages/getBlocksByPageUrl getBlocksByPageUrl} documentation.
      */
     getBlocksByPageUrl(url: string, langCode?: string): Promise<IPositionBlock[] | IError>;
-    /**
-     * Get settings for the page.
-     * @handleName getConfigPageByUrl
-     * @param {string} url - Page URL. Example: "about".
-     * @returns {Promise<IPageConfig | IError>} Returns a ConfigPage object with page display settings
-     * @throws {IError} When isShell=false and an error occurs during the fetch
-     * @description Get settings for the page.
-     * @see {@link https://js-sdk.oneentry.cloud/docs/pages/getConfigPageByUrl getConfigPageByUrl} documentation.
-     */
-    getConfigPageByUrl(url: string): Promise<IPageConfig | IError>;
     /**
      * Quick search for page objects with limited output.
      * @handleName searchPage
@@ -102,6 +92,19 @@ export default class PagesApi extends AsyncModules implements IPagesApi {
      * @see {@link https://js-sdk.oneentry.cloud/docs/pages/searchPage searchPage} documentation.
      */
     searchPage(name: string, url?: string, langCode?: string): Promise<IPagesEntity[] | IPageSearchResult[] | IError>;
+    /**
+     * Semantic (vector) search for pages.
+     * @handleName getPagesByVectorSearch
+     * @param {IPagesVectorSearch} body - Vector search body. Example: `{ queryText: "winter sale" }`.
+     * @param {string} [langCode] - Language code. Default: "en_US".
+     * @param {number} [offset] - Parameter for pagination. Default: 0.
+     * @param {number} [limit] - Parameter for pagination. Default: 30.
+     * @returns {Promise<IPagesResponse | IError>} Returns an object with an array of found pages and total count.
+     * @throws {IError} When isShell=false and an error occurs during the fetch
+     * @description This method performs a semantic (vector) search for pages.
+     * @see {@link https://js-sdk.oneentry.cloud/docs/pages/getPagesByVectorSearch getPagesByVectorSearch} documentation.
+     */
+    getPagesByVectorSearch(body: IPagesVectorSearch, langCode?: string, offset?: number, limit?: number): Promise<IPagesResponse | IError>;
     /**
      * Add template data to pages
      * @handleName addTemplateToPages

package/dist/pages/pagesApi.js

@@ -212,23 +212,6 @@ class PagesApi extends asyncModules_1.default {
         }));
         return normalizeResponse;
     }
-    /**
-     * Get settings for the page.
-     * @handleName getConfigPageByUrl
-     * @param {string} url - Page URL. Example: "about".
-     * @returns {Promise<IPageConfig | IError>} Returns a ConfigPage object with page display settings
-     * @throws {IError} When isShell=false and an error occurs during the fetch
-     * @description Get settings for the page.
-     * @see {@link https://js-sdk.oneentry.cloud/docs/pages/getConfigPageByUrl getConfigPageByUrl} documentation.
-     */
-    async getConfigPageByUrl(url) {
-        // Fetch data from the server using a GET request to retrieve forms for the specified page URL and language code
-        const result = await this._fetchGet(`/${url}/config`);
-        // Validate response if validation is enabled
-        const validated = await this._validateResponse(result, schema('PageConfigSchema'));
-        // return fetched data
-        return validated;
-    }
     /**
      * Quick search for page objects with limited output.
      * @handleName searchPage
@@ -267,6 +250,27 @@ class PagesApi extends asyncModules_1.default {
         // short cards carry no templateIdentifier, so there is nothing to attach a template to
         return this._normalizeData(data, langCode);
     }
+    /**
+     * Semantic (vector) search for pages.
+     * @handleName getPagesByVectorSearch
+     * @param {IPagesVectorSearch} body - Vector search body. Example: `{ queryText: "winter sale" }`.
+     * @param {string} [langCode] - Language code. Default: "en_US".
+     * @param {number} [offset] - Parameter for pagination. Default: 0.
+     * @param {number} [limit] - Parameter for pagination. Default: 30.
+     * @returns {Promise<IPagesResponse | IError>} Returns an object with an array of found pages and total count.
+     * @throws {IError} When isShell=false and an error occurs during the fetch
+     * @description This method performs a semantic (vector) search for pages.
+     * @see {@link https://js-sdk.oneentry.cloud/docs/pages/getPagesByVectorSearch getPagesByVectorSearch} documentation.
+     */
+    async getPagesByVectorSearch(body, langCode = this.state.lang, offset = 0, limit = 30) {
+        const query = {
+            langCode,
+            offset,
+            limit,
+        };
+        const result = await this._fetchPost(`/vector/search?` + this._queryParamsToString(query), body);
+        return this._normalizeData(result, langCode);
+    }
     /**
      * Add template data to pages
      * @handleName addTemplateToPages

package/dist/pages/pagesInterfaces.d.ts

@@ -66,15 +66,6 @@ interface IPagesApi {
      * @description This method gets all blocks by page url.
      */
     getBlocksByPageUrl(url: string, langCode?: LangType): Promise<IPositionBlock[] | IError>;
-    /**
-     * Get settings for the page.
-     * @handleName getConfigPageByUrl
-     * @param {string} url - Page URL. Example: "about".
-     * @returns {IPageConfig} Returns a ConfigPage object with page display settings
-     * @throws {IError} - If there is an error during the fetch operation, it will return an error object.
-     * @description This method gets settings for the page.
-     */
-    getConfigPageByUrl(url: string): Promise<IPageConfig | IError>;
     /**
      * Quick search for page objects with limited output.
      * @handleName searchPage
@@ -86,16 +77,43 @@ interface IPagesApi {
      * @description This method performs a quick search for page objects with limited output. With traficLimit enabled the raw quick search response is returned as short cards; otherwise full page entities are fetched for the found ids.
      */
     searchPage(name: string, url?: string, langCode?: LangType): Promise<IPagesEntity[] | IPageSearchResult[] | IError>;
+    /**
+     * Semantic (vector) search for pages.
+     * @handleName getPagesByVectorSearch
+     * @param {IPagesVectorSearch} body - Vector search body. Example: `{ queryText: "winter sale" }`.
+     * @param {string} [langCode] - Language code. Default: "en_US".
+     * @param {number} [offset] - Parameter for pagination. Default: 0.
+     * @param {number} [limit] - Parameter for pagination. Default: 30.
+     * @returns {IPagesResponse} A promise that resolves to a pages response (items + total) or an error.
+     * @throws {IError} - If there is an error during the fetch operation, it will return an error object.
+     * @description This method performs a semantic (vector) search for pages.
+     */
+    getPagesByVectorSearch(body: IPagesVectorSearch, langCode?: string, offset?: number, limit?: number): Promise<IPagesResponse | IError>;
+}
+/**
+ * Body for semantic (vector) page search.
+ * @interface IPagesVectorSearch
+ * @property {string} queryText - Natural-language search query. Example: "winter sale".
+ * @property {number} [vectorDistanceThreshold] - Override of the cosine distance threshold (0..2). Example: 0.3.
+ * @property {number} [maxHits] - Top-K candidates fetched before pagination. Default: 100. Max: 500. Example: 10.
+ * @property {boolean} [debug] - When true, each returned item gets a `distance` field. Example: false.
+ * @description Body for the pages vector/search endpoint.
+ */
+interface IPagesVectorSearch {
+    queryText: string;
+    vectorDistanceThreshold?: number;
+    maxHits?: number;
+    debug?: boolean;
 }
 /**
- * @interface IPageConfig
- * @property {number | null} rowsPerPage - Number of lines per page. Example: 1.
- * @property {number | null} productsPerRow - Number of products per page. Example: 1.
- * @description This interface defines the configuration for pagination in pages, including the number of rows and products displayed per page.
+ * @interface IPagesResponse
+ * @property {IPagesEntity[]} items - Array of found page objects.
+ * @property {number} total - Total number of found records. Example: 100.
+ * @description This interface defines the structure of a response containing multiple page entities, including the total count and an array of page items.
  */
-interface IPageConfig {
-    rowsPerPage: number | null;
-    productsPerRow: number | null;
+interface IPagesResponse {
+    items: IPagesEntity[];
+    total: number;
 }
 /**
  * @interface IPositionForm
@@ -269,6 +287,7 @@ type PageType = 'catalog_page' | 'common_page' | 'error_page' | 'external_page';
  * @property {IRating} [rating] - Rating data.
  * @property {string} [total] - Total number of products linked to the page. Example: "10".
  * @property {string | null} [categoryPath] - Category path string; null for nested pages that have no own category path. Example: "catalog".
+ * @property {number} [distance] - Cosine distance to the query. Returned only by the semantic (vector) search endpoint when `debug: true` is passed in the search body. Example: 0.12.
  * @description This interface defines the structure of a page entity, including its identifiers, attributes, and hierarchical relationships.
  */
 interface IPagesEntity {
@@ -293,6 +312,7 @@ interface IPagesEntity {
     childrenCount?: number;
     total?: string;
     categoryPath?: string | null;
+    distance?: number;
 }
 /**
  * @interface IPageSearchResult
@@ -304,4 +324,4 @@ interface IPageSearchResult {
     id: number;
     title: string;
 }
-export type { IPageConfig, IPagesApi, IPageSearchResult, IPagesEntity, IPositionBlock, IPositionForm, PageType, };
+export type { IPagesApi, IPageSearchResult, IPagesEntity, IPagesResponse, IPagesVectorSearch, IPositionBlock, IPositionForm, PageType, };

package/dist/pages/pagesSchemas.d.ts

@@ -34,6 +34,7 @@ export declare const PageEntitySchema: z.ZodObject<{
     childrenCount: z.ZodOptional<z.ZodNumber>;
     total: z.ZodOptional<z.ZodString>;
     categoryPath: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+    distance: z.ZodOptional<z.ZodNumber>;
 }, z.core.$strip>;
 /**
  * Pages response schema (array of pages)
@@ -65,6 +66,7 @@ export declare const PagesResponseSchema: z.ZodArray<z.ZodObject<{
     childrenCount: z.ZodOptional<z.ZodNumber>;
     total: z.ZodOptional<z.ZodString>;
     categoryPath: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+    distance: z.ZodOptional<z.ZodNumber>;
 }, z.core.$strip>>;
 /**
  * Page search result schema
@@ -111,11 +113,5 @@ export declare const SinglePageSchema: z.ZodObject<{
     childrenCount: z.ZodOptional<z.ZodNumber>;
     total: z.ZodOptional<z.ZodString>;
     categoryPath: z.ZodOptional<z.ZodNullable<z.ZodString>>;
-}, z.core.$strip>;
-/**
- * Page config schema
- */
-export declare const PageConfigSchema: z.ZodObject<{
-    rowsPerPage: z.ZodNullable<z.ZodNumber>;
-    productsPerRow: z.ZodNullable<z.ZodNumber>;
+    distance: z.ZodOptional<z.ZodNumber>;
 }, z.core.$strip>;

package/dist/pages/pagesSchemas.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.PageConfigSchema = exports.SinglePageSchema = exports.PageSearchResponseSchema = exports.PageSearchResultSchema = exports.PagesResponseSchema = exports.PageEntitySchema = void 0;
+exports.SinglePageSchema = exports.PageSearchResponseSchema = exports.PageSearchResultSchema = exports.PagesResponseSchema = exports.PageEntitySchema = void 0;
 /**
  * Validation schemas for Pages module
  * @description Zod schemas for validating pages-related API responses
@@ -33,6 +33,7 @@ exports.PageEntitySchema = zod_1.z.object({
     childrenCount: zod_1.z.number().optional(),
     total: zod_1.z.string().optional(),
     categoryPath: zod_1.z.string().nullable().optional(),
+    distance: zod_1.z.number().optional(),
 });
 /**
  * Pages response schema (array of pages)
@@ -54,10 +55,3 @@ exports.PageSearchResponseSchema = zod_1.z.array(exports.PageSearchResultSchema)
  * Single page response schema
  */
 exports.SinglePageSchema = exports.PageEntitySchema;
-/**
- * Page config schema
- */
-exports.PageConfigSchema = zod_1.z.object({
-    rowsPerPage: zod_1.z.number().nullable(),
-    productsPerRow: zod_1.z.number().nullable(),
-});

package/dist/payments/paymentsInterfaces.d.ts

@@ -131,7 +131,7 @@ interface IIntent {
  * @property {number} id - Object identifier. Example: 12345.
  * @property {ILocalizeInfo} localizeInfos - Json description of the payment account object.
  * @property {string} identifier - Text identifier for the recording field. Example: "payment_12345".
- * @property {'stripe' | 'custom'} type - Type may be 'stripe' or 'custom'. Example: 'stripe'.
+ * @property {'stripe' | 'yookassa' | 'midtrans' | 'xendit' | 'custom'} type - Payment provider type. Example: 'stripe'.
  * @property {boolean} isVisible - Visibility indicator of the payment account. Example: true.
  * @property {boolean} isUsed - Usage indicator of the payment account. Example: false.
  * @property {boolean} testMode - Indicates whether the payment account is in test mode. Example: true.
@@ -144,7 +144,7 @@ interface IAccountsEntity {
     id: number;
     localizeInfos: ILocalizeInfo;
     identifier: string;
-    type: 'stripe' | 'custom';
+    type: 'stripe' | 'yookassa' | 'midtrans' | 'xendit' | 'custom';
     isVisible: boolean;
     isUsed: boolean;
     testMode: boolean;

package/dist/products/productsInterfaces.d.ts

@@ -377,7 +377,7 @@ type IProductsQuery = IProductsQueryBase;
  */
 interface IFilterParams {
     attributeMarker: string;
-    conditionMarker?: 'in' /** 'in' - Contains */ | 'nin' /** 'nin' - Does not contain */ | 'eq' /** 'eq' - Equal */ | 'neq' /** 'neq' - Not equal */ | 'mth' /** 'mth' - Greater than */ | 'lth' /** 'lth' - Less than */ | 'exs' /** 'exs' - Exists */ | 'nexs' /** 'nexs' - Does not exist */ | null;
+    conditionMarker?: 'in' /** 'in' - Contains */ | 'nin' /** 'nin' - Does not contain */ | 'eq' /** 'eq' - Equal */ | 'neq' /** 'neq' - Not equal */ | 'mth' /** 'mth' - Greater than */ | 'lth' /** 'lth' - Less than */ | 'exs' /** 'exs' - Exists */ | 'nexs' /** 'nexs' - Does not exist */ | 'pat' /** 'pat' - Matches pattern */ | 'same' /** 'same' - Matches the value exactly */ | 'same_part' /** 'same_part' - Matches a part of the value exactly */ | null;
     conditionValue: number | string | null;
     pageUrl?: string | null;
     pageUrls?: string[] | null;

package/dist/search/searchApi.d.ts

@@ -0,0 +1,35 @@
+import AsyncModules from '../base/asyncModules';
+import type StateModule from '../base/stateModule';
+import type { IError } from '../base/utils';
+import type { IGlobalSearchResponse, ISearchApi, TGlobalSearchEntityType } from './searchInterfaces';
+/**
+ * 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/dist/search/searchApi.js

@@ -0,0 +1,86 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || (function () {
+    var ownKeys = function(o) {
+        ownKeys = Object.getOwnPropertyNames || function (o) {
+            var ar = [];
+            for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
+            return ar;
+        };
+        return ownKeys(o);
+    };
+    return function (mod) {
+        if (mod && mod.__esModule) return mod;
+        var result = {};
+        if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
+        __setModuleDefault(result, mod);
+        return result;
+    };
+})();
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const asyncModules_1 = __importDefault(require("../base/asyncModules"));
+const lazySchema_1 = __importDefault(require("../base/lazySchema"));
+const schema = (0, lazySchema_1.default)(() => Promise.resolve().then(() => __importStar(require('./searchSchemas'))));
+/**
+ * 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.
+ */
+class SearchApi extends asyncModules_1.default {
+    /**
+     * 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);
+    }
+}
+exports.default = SearchApi;

package/dist/search/searchInterfaces.d.ts

@@ -0,0 +1,94 @@
+import type { IError } from '../base/utils';
+/**
+ * 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/dist/search/searchInterfaces.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/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/dist/search/searchSchemas.js

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

package/dist/templates-preview/templatesPreviewInterfaces.d.ts

@@ -71,7 +71,6 @@ interface ITemplatesPreviewApi {
  * @property {number} version - The version number of the object. Example: 1.
  * @property {number} position - The position of the object. Example: 1.
  * @property {boolean} isUsed - Indicates whether the template preview is used. Example: true.
- * @property {string | null} [attributeSetIdentifier] - Text identifier used for a set of attributes. Example: "attribute_set_1".
  * @description This interface defines the structure of a template preview entity, including its identifiers, attributes, proportions, and title.
  */
 interface ITemplatesPreviewEntity {
@@ -82,7 +81,6 @@ interface ITemplatesPreviewEntity {
     version: number;
     position: number;
     isUsed: boolean;
-    attributeSetIdentifier?: string | null;
 }
 /**
  * @interface ITemplatesPreviewProportions

package/dist/templates-preview/templatesPreviewSchemas.d.ts

@@ -47,7 +47,6 @@ export declare const TemplatePreviewEntitySchema: z.ZodObject<{
     version: z.ZodNumber;
     position: z.ZodNumber;
     isUsed: z.ZodBoolean;
-    attributeSetIdentifier: z.ZodOptional<z.ZodNullable<z.ZodString>>;
 }, z.core.$strip>;
 /**
  * Template previews response schema (array of template previews)
@@ -77,5 +76,4 @@ export declare const TemplatePreviewsResponseSchema: z.ZodArray<z.ZodObject<{
     version: z.ZodNumber;
     position: z.ZodNumber;
     isUsed: z.ZodBoolean;
-    attributeSetIdentifier: z.ZodOptional<z.ZodNullable<z.ZodString>>;
 }, z.core.$strip>>;

package/dist/templates-preview/templatesPreviewSchemas.js

@@ -39,7 +39,6 @@ exports.TemplatePreviewEntitySchema = zod_1.z.object({
     version: zod_1.z.number(),
     position: zod_1.z.number(),
     isUsed: zod_1.z.boolean(),
-    attributeSetIdentifier: zod_1.z.string().nullable().optional(),
 });
 /**
  * Template previews response schema (array of template previews)