oneentry 1.0.101 → 1.0.104

package/dist/products/productsApi.d.ts

@@ -1,7 +1,7 @@
-import { IProductsQuery, IFilterParams, IProductApi, IProductsEntity, IProductBlock, IProductEntity, IProductsResponse, IProductsInfo } from './productsInterfaces';
 import AsyncModules from '../base/asyncModules';
-import StateModule from "../base/stateModule";
-import { IError } from "../base/utils";
+import type StateModule from '../base/stateModule';
+import type { IError } from '../base/utils';
+import type { IFilterParams, IProductApi, IProductBlock, IProductEntity, IProductsEntity, IProductsInfo, IProductsQuery, IProductsResponse } from './productsInterfaces';
 /**
  * Controllers for working with product pages
  */
@@ -12,27 +12,23 @@ export default class ProductApi extends AsyncModules implements IProductApi {
     private _defaultQuery;
     /**
      * Search for all products with pagination and filter.
+     *
      * @param {Array<IFilterParams>} body - Request body. Default [].
      * @param {string} [langCode] - Language code parameter. Default "en_US"
      * @param {IProductsQuery} [userQuery] - Optional set query parameters.
-     * @param {number} [userQuery.limit] - Optional parameter for pagination, default is 0
      *
      * @param {number} [userQuery.offset] - Optional parameter for pagination, default is 30
-     *
+     * @param {number} [userQuery.limit] - Optional parameter for pagination, default is 0
+     * @param {string} [userQuery.sortOrder] - Optional sorting order DESC | ASC
+     * @param {string} [userQuery.sortKey] - Optional field to sort by (id, title, date, price, position, status)
+     * @param {number} [userQuery.statusId] - Optional parameter - search by status id
      * @param {string} [userQuery.statusMarker] - Optional identifier of the product page status
-     *
      * @param {string} [userQuery.conditionValue] - Optional value that is being searched
-     *
      * @param {string} [userQuery.conditionMarker] - Optional identifier of the filter condition by which values are filtered
-     *
      * @param {string} [userQuery.attributeMarker] - Optional text identifier of the indexed attribute by which values are filtered
      *
-     * @param {string} [userQuery.sortOrder] - Optional sorting order DESC | ASC
-     *
-     * @param {string} [userQuery.sortKey] - Optional field to sort by
-     *
      * @example
-     * const body = [
+     * const body: IFilterParams[] = [
      *   {
      *     "attributeMarker": "price",
      *     "conditionMarker": "mth",
@@ -64,46 +60,35 @@ export default class ProductApi extends AsyncModules implements IProductApi {
      *
      * @param {string} [langCode] - Language code parameter. Default "en_US"
      * @param {IProductsQuery} [userQuery] - Optional set query parameters.
-     * @param {number} [userQuery.limit] - Optional parameter for pagination, default is 0
      *
      * @param {number} [userQuery.offset] - Optional parameter for pagination, default is 30
-     *
+     * @param {number} [userQuery.limit] - Optional parameter for pagination, default is 0
      * @param {string} [userQuery.statusMarker] - Optional identifier of the product page status
-     *
      * @param {string} [userQuery.conditionValue] - Optional value that is being searched
-     *
      * @param {string} [userQuery.conditionMarker] - Optional identifier of the filter condition by which values are filtered
-     *
      * @param {string} [userQuery.attributeMarker] - Optional text identifier of the indexed attribute by which values are filtered
-     *
      * @param {string} [userQuery.sortOrder] - Optional sorting order DESC | ASC
-     *
-     * @param {string} [userQuery.sortKey] - Optional field to sort by
+     * @param {string} [userQuery.sortKey] - Optional field to sort by (id, title, date, price, position, status)
      *
      * @returns  Array with ProductEntity objects
      */
     getProductsEmptyPage(langCode?: string, userQuery?: IProductsQuery): Promise<IProductsResponse | IError>;
     /**
      * Search for all products with pagination for the selected category.
+     *
      * @param {Array<IFilterParams>} body - Request body.
      * @param {number} id - Page id.
      * @param {string} [langCode] - Language code parameter. Default "en_US"
      * @param {IProductsQuery} [userQuery] - Optional set query parameters.
-     * @param {number} [userQuery.limit] - Optional parameter for pagination, default is 0
      *
      * @param {number} [userQuery.offset] - Optional parameter for pagination, default is 30
-     *
+     * @param {number} [userQuery.limit] - Optional parameter for pagination, default is 0
      * @param {string} [userQuery.statusMarker] - Optional identifier of the product page status
-     *
      * @param {string} [userQuery.conditionValue] - Optional value that is being searched
-     *
      * @param {string} [userQuery.conditionMarker] - Optional identifier of the filter condition by which values are filtered
-     *
      * @param {string} [userQuery.attributeMarker] - Optional text identifier of the indexed attribute by which values are filtered
-     *
      * @param {string} [userQuery.sortOrder] - Optional sorting order DESC | ASC
-     *
-     * @param {string} [userQuery.sortKey] - Optional field to sort by
+     * @param {string} [userQuery.sortKey] - Optional field to sort by (id, title, date, price, position, status)
      *
      * @example
      * const body = [
@@ -135,49 +120,39 @@ export default class ProductApi extends AsyncModules implements IProductApi {
     getProductsByPageId(id: number, body?: Array<IFilterParams>, langCode?: string, userQuery?: IProductsQuery): Promise<IProductsResponse | IError>;
     /**
      * Search for information about products and prices for the selected category.
+     *
      * @param {string} url - Page url.
      * @param {string} langCode - Language code.
      * @param {IProductsQuery} [userQuery] - Optional set query parameters.
-     * @param {number} [userQuery.limit] - Optional parameter for pagination, default is 0
      *
      * @param {number} [userQuery.offset] - Optional parameter for pagination, default is 30
-     *
+     * @param {number} [userQuery.limit] - Optional parameter for pagination, default is 0
      * @param {string} [userQuery.statusMarker] - Optional identifier of the product page status
-     *
      * @param {string} [userQuery.conditionValue] - Optional value that is being searched
-     *
      * @param {string} [userQuery.conditionMarker] - Optional identifier of the filter condition by which values are filtered
-     *
      * @param {string} [userQuery.attributeMarker] - Optional text identifier of the indexed attribute by which values are filtered
-     *
      * @param {string} [userQuery.sortOrder] - Optional sorting order DESC | ASC
-     *
-     * @param {string} [userQuery.sortKey] - Optional field to sort by
+     * @param {string} [userQuery.sortKey] - Optional field to sort by (id, title, date, price, position, status)
      *
      * @returns  Array with ProductInformation objects
      */
     getProductsPriceByPageUrl(url: string, langCode?: string, userQuery?: IProductsQuery): Promise<IProductsInfo | IError>;
     /**
      * Search for all products with pagination for the selected category.
+     *
      * @param {Array<IFilterParams>} body - Request body.
      * @param {string} url - Page url.
      * @param {string} [langCode] - Language code parameter. Default "en_US"
      * @param {IProductsQuery} [userQuery] - Optional set query parameters.
-     * @param {number} [userQuery.limit] - Optional parameter for pagination, default is 0
      *
      * @param {number} [userQuery.offset] - Optional parameter for pagination, default is 30
-     *
+     * @param {number} [userQuery.limit] - Optional parameter for pagination, default is 0
      * @param {string} [userQuery.statusMarker] - Optional identifier of the product page status
-     *
      * @param {string} [userQuery.conditionValue] - Optional value that is being searched
-     *
      * @param {string} [userQuery.conditionMarker] - Optional identifier of the filter condition by which values are filtered
-     *
      * @param {string} [userQuery.attributeMarker] - Optional text identifier of the indexed attribute by which values are filtered
-     *
      * @param {string} [userQuery.sortOrder] - Optional sorting order DESC | ASC
-     *
-     * @param {string} [userQuery.sortKey] - Optional field to sort by
+     * @param {string} [userQuery.sortKey] - Optional field to sort by (id, title, date, price, position, status)
      *
      * @example
      * const body = [
@@ -211,26 +186,36 @@ export default class ProductApi extends AsyncModules implements IProductApi {
      * Find all related product page objects.
      *
      * @param {number} [id] - Product page identifier for which to find relationship.
-     *
      * @param {string} [langCode] - Language code parameter. Default "en_US"
-     *
      * @param {IProductsQuery} [userQuery] - Optional set query parameters.
-     * @param {number} [userQuery.limit] - Optional parameter for pagination, default is 0
      *
      * @param {number} [userQuery.offset] - Optional parameter for pagination, default is 30
-     *
+     * @param {number} [userQuery.limit] - Optional parameter for pagination, default is 0
      * @param {string} [userQuery.sortOrder] - Optional sorting order DESC | ASC
-     *
-     * @param {string} [userQuery.sortKey] - Optional field to sort by
+     * @param {string} [userQuery.sortKey] - Optional field to sort by (id, title, date, price, position, status)
      *
      * @returns  Array with ProductEntity objects
      */
     getRelatedProductsById(id: number, langCode?: string, userQuery?: IProductsQuery): Promise<IProductsResponse | IError>;
+    /**
+     * Find products by its ids.
+     *
+     * @param {string} [ids] - Product page identifiers for which to find relationships.
+     * @param {string} [langCode] - Language code parameter. Default "en_US"
+     * @param {IProductsQuery} [userQuery] - Optional set query parameters.
+     *
+     * @param {number} [userQuery.offset] - Optional parameter for pagination, default is 30
+     * @param {number} [userQuery.limit] - Optional parameter for pagination, default is 0
+     * @param {string} [userQuery.sortOrder] - Optional sorting order DESC | ASC
+     * @param {string} [userQuery.sortKey] - Optional field to sort by (id, title, date, price, position, status)
+     *
+     * @returns  Array with ProductEntity objects
+     */
+    getProductsByIds(ids: string, langCode?: string, userQuery?: IProductsQuery): Promise<Array<IProductsEntity> | IError>;
     /**
      * Retrieve one product object.
      *
      * @param {number} [id] - Product id.
-     *
      * @param {string} [langCode] Language code parameter. Default "en_US".
      *
      * @returns  ProductEntity object.
@@ -238,15 +223,14 @@ export default class ProductApi extends AsyncModules implements IProductApi {
     getProductById(id: number, langCode?: string): Promise<IProductEntity | IError>;
     /**
      * Getting a product block object by product id.
-     * @param {number} id - Product id
      *
+     * @param {number} id - Product id
      */
     getProductBlockById(id: number): Promise<Array<IProductBlock> | IError>;
     /**
      * Quick search for product page objects with limited output.
      *
      * @param {string} [name] - Text to search product page objects (search is based on the title field of the localizeInfos object with language consideration)
-     *
      * @param {string} [langCode] - Language code
      *
      * @returns  Array with ProductEntity objects

package/dist/products/productsApi.js

@@ -1,6 +1,10 @@
 "use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
 Object.defineProperty(exports, "__esModule", { value: true });
-const asyncModules_1 = require("../base/asyncModules");
+const asyncModules_1 = __importDefault(require("../base/asyncModules"));
+// import { IProductInfo } from './productsInterfaces';
 /**
  * Controllers for working with product pages
  */
@@ -10,39 +14,30 @@ class ProductApi extends asyncModules_1.default {
         this._defaultQuery = {
             offset: 0,
             limit: 30,
-            templateMarker: null,
-            statusMarker: null,
-            conditionValue: null,
-            conditionMarker: null,
-            attributeMarker: null,
             sortOrder: null,
-            sortKey: null
+            sortKey: null,
         };
         this._url = state.url + '/api/content/products';
     }
     /**
      * Search for all products with pagination and filter.
+     *
      * @param {Array<IFilterParams>} body - Request body. Default [].
      * @param {string} [langCode] - Language code parameter. Default "en_US"
      * @param {IProductsQuery} [userQuery] - Optional set query parameters.
-     * @param {number} [userQuery.limit] - Optional parameter for pagination, default is 0
      *
      * @param {number} [userQuery.offset] - Optional parameter for pagination, default is 30
-     *
+     * @param {number} [userQuery.limit] - Optional parameter for pagination, default is 0
+     * @param {string} [userQuery.sortOrder] - Optional sorting order DESC | ASC
+     * @param {string} [userQuery.sortKey] - Optional field to sort by (id, title, date, price, position, status)
+     * @param {number} [userQuery.statusId] - Optional parameter - search by status id
      * @param {string} [userQuery.statusMarker] - Optional identifier of the product page status
-     *
      * @param {string} [userQuery.conditionValue] - Optional value that is being searched
-     *
      * @param {string} [userQuery.conditionMarker] - Optional identifier of the filter condition by which values are filtered
-     *
      * @param {string} [userQuery.attributeMarker] - Optional text identifier of the indexed attribute by which values are filtered
      *
-     * @param {string} [userQuery.sortOrder] - Optional sorting order DESC | ASC
-     *
-     * @param {string} [userQuery.sortKey] - Optional field to sort by
-     *
      * @example
-     * const body = [
+     * const body: IFilterParams[] = [
      *   {
      *     "attributeMarker": "price",
      *     "conditionMarker": "mth",
@@ -69,7 +64,11 @@ class ProductApi extends asyncModules_1.default {
      * @returns  Array with ProductEntity objects
      */
     async getProducts(body = [], langCode = this.state.lang, userQuery) {
-        const query = { ...this._defaultQuery, ...userQuery, langCode };
+        const query = {
+            ...this._defaultQuery,
+            ...userQuery,
+            langCode,
+        };
         const result = await this._fetchPost(`/all?` + this._queryParamsToString(query), body);
         return this._dataPostProcess(result, langCode);
     }
@@ -78,21 +77,15 @@ class ProductApi extends asyncModules_1.default {
      *
      * @param {string} [langCode] - Language code parameter. Default "en_US"
      * @param {IProductsQuery} [userQuery] - Optional set query parameters.
-     * @param {number} [userQuery.limit] - Optional parameter for pagination, default is 0
      *
      * @param {number} [userQuery.offset] - Optional parameter for pagination, default is 30
-     *
+     * @param {number} [userQuery.limit] - Optional parameter for pagination, default is 0
      * @param {string} [userQuery.statusMarker] - Optional identifier of the product page status
-     *
      * @param {string} [userQuery.conditionValue] - Optional value that is being searched
-     *
      * @param {string} [userQuery.conditionMarker] - Optional identifier of the filter condition by which values are filtered
-     *
      * @param {string} [userQuery.attributeMarker] - Optional text identifier of the indexed attribute by which values are filtered
-     *
      * @param {string} [userQuery.sortOrder] - Optional sorting order DESC | ASC
-     *
-     * @param {string} [userQuery.sortKey] - Optional field to sort by
+     * @param {string} [userQuery.sortKey] - Optional field to sort by (id, title, date, price, position, status)
      *
      * @returns  Array with ProductEntity objects
      */
@@ -103,25 +96,20 @@ class ProductApi extends asyncModules_1.default {
     }
     /**
      * Search for all products with pagination for the selected category.
+     *
      * @param {Array<IFilterParams>} body - Request body.
      * @param {number} id - Page id.
      * @param {string} [langCode] - Language code parameter. Default "en_US"
      * @param {IProductsQuery} [userQuery] - Optional set query parameters.
-     * @param {number} [userQuery.limit] - Optional parameter for pagination, default is 0
      *
      * @param {number} [userQuery.offset] - Optional parameter for pagination, default is 30
-     *
+     * @param {number} [userQuery.limit] - Optional parameter for pagination, default is 0
      * @param {string} [userQuery.statusMarker] - Optional identifier of the product page status
-     *
      * @param {string} [userQuery.conditionValue] - Optional value that is being searched
-     *
      * @param {string} [userQuery.conditionMarker] - Optional identifier of the filter condition by which values are filtered
-     *
      * @param {string} [userQuery.attributeMarker] - Optional text identifier of the indexed attribute by which values are filtered
-     *
      * @param {string} [userQuery.sortOrder] - Optional sorting order DESC | ASC
-     *
-     * @param {string} [userQuery.sortKey] - Optional field to sort by
+     * @param {string} [userQuery.sortKey] - Optional field to sort by (id, title, date, price, position, status)
      *
      * @example
      * const body = [
@@ -157,53 +145,47 @@ class ProductApi extends asyncModules_1.default {
     }
     /**
      * Search for information about products and prices for the selected category.
+     *
      * @param {string} url - Page url.
      * @param {string} langCode - Language code.
      * @param {IProductsQuery} [userQuery] - Optional set query parameters.
-     * @param {number} [userQuery.limit] - Optional parameter for pagination, default is 0
      *
      * @param {number} [userQuery.offset] - Optional parameter for pagination, default is 30
-     *
+     * @param {number} [userQuery.limit] - Optional parameter for pagination, default is 0
      * @param {string} [userQuery.statusMarker] - Optional identifier of the product page status
-     *
      * @param {string} [userQuery.conditionValue] - Optional value that is being searched
-     *
      * @param {string} [userQuery.conditionMarker] - Optional identifier of the filter condition by which values are filtered
-     *
      * @param {string} [userQuery.attributeMarker] - Optional text identifier of the indexed attribute by which values are filtered
-     *
      * @param {string} [userQuery.sortOrder] - Optional sorting order DESC | ASC
-     *
-     * @param {string} [userQuery.sortKey] - Optional field to sort by
+     * @param {string} [userQuery.sortKey] - Optional field to sort by (id, title, date, price, position, status)
      *
      * @returns  Array with ProductInformation objects
      */
     async getProductsPriceByPageUrl(url, langCode = this.state.lang, userQuery) {
-        const query = { ...this._defaultQuery, ...userQuery, langCode };
+        const query = {
+            ...this._defaultQuery,
+            ...userQuery,
+            langCode,
+        };
         const result = await this._fetchGet(`/page/${url}/prices?` + this._queryParamsToString(query));
         return result;
     }
     /**
      * Search for all products with pagination for the selected category.
+     *
      * @param {Array<IFilterParams>} body - Request body.
      * @param {string} url - Page url.
      * @param {string} [langCode] - Language code parameter. Default "en_US"
      * @param {IProductsQuery} [userQuery] - Optional set query parameters.
-     * @param {number} [userQuery.limit] - Optional parameter for pagination, default is 0
      *
      * @param {number} [userQuery.offset] - Optional parameter for pagination, default is 30
-     *
+     * @param {number} [userQuery.limit] - Optional parameter for pagination, default is 0
      * @param {string} [userQuery.statusMarker] - Optional identifier of the product page status
-     *
      * @param {string} [userQuery.conditionValue] - Optional value that is being searched
-     *
      * @param {string} [userQuery.conditionMarker] - Optional identifier of the filter condition by which values are filtered
-     *
      * @param {string} [userQuery.attributeMarker] - Optional text identifier of the indexed attribute by which values are filtered
-     *
      * @param {string} [userQuery.sortOrder] - Optional sorting order DESC | ASC
-     *
-     * @param {string} [userQuery.sortKey] - Optional field to sort by
+     * @param {string} [userQuery.sortKey] - Optional field to sort by (id, title, date, price, position, status)
      *
      * @example
      * const body = [
@@ -234,24 +216,21 @@ class ProductApi extends asyncModules_1.default {
      */
     async getProductsByPageUrl(url, body = [], langCode = this.state.lang, userQuery) {
         const query = { ...this._defaultQuery, ...userQuery };
-        const result = await this._fetchPost(`/page/url/${url}?langCode=${langCode}&` + this._queryParamsToString(query), body);
+        const result = await this._fetchPost(`/page/url/${url}?langCode=${langCode}&` +
+            this._queryParamsToString(query), body);
         return this._dataPostProcess(result, langCode);
     }
     /**
      * Find all related product page objects.
      *
      * @param {number} [id] - Product page identifier for which to find relationship.
-     *
      * @param {string} [langCode] - Language code parameter. Default "en_US"
-     *
      * @param {IProductsQuery} [userQuery] - Optional set query parameters.
-     * @param {number} [userQuery.limit] - Optional parameter for pagination, default is 0
      *
      * @param {number} [userQuery.offset] - Optional parameter for pagination, default is 30
-     *
+     * @param {number} [userQuery.limit] - Optional parameter for pagination, default is 0
      * @param {string} [userQuery.sortOrder] - Optional sorting order DESC | ASC
-     *
-     * @param {string} [userQuery.sortKey] - Optional field to sort by
+     * @param {string} [userQuery.sortKey] - Optional field to sort by (id, title, date, price, position, status)
      *
      * @returns  Array with ProductEntity objects
      */
@@ -260,11 +239,34 @@ class ProductApi extends asyncModules_1.default {
         const result = await this._fetchGet(`/${id}/related?langCode=${langCode}&` + this._queryParamsToString(query));
         return this._dataPostProcess(result, langCode);
     }
+    /**
+     * Find products by its ids.
+     *
+     * @param {string} [ids] - Product page identifiers for which to find relationships.
+     * @param {string} [langCode] - Language code parameter. Default "en_US"
+     * @param {IProductsQuery} [userQuery] - Optional set query parameters.
+     *
+     * @param {number} [userQuery.offset] - Optional parameter for pagination, default is 30
+     * @param {number} [userQuery.limit] - Optional parameter for pagination, default is 0
+     * @param {string} [userQuery.sortOrder] - Optional sorting order DESC | ASC
+     * @param {string} [userQuery.sortKey] - Optional field to sort by (id, title, date, price, position, status)
+     *
+     * @returns  Array with ProductEntity objects
+     */
+    async getProductsByIds(ids, langCode = this.state.lang, userQuery) {
+        const query = {
+            ids,
+            langCode,
+            ...this._defaultQuery,
+            ...userQuery,
+        };
+        const result = await this._fetchGet(`/ids?` + this._queryParamsToString(query));
+        return this._dataPostProcess(result, langCode);
+    }
     /**
      * Retrieve one product object.
      *
      * @param {number} [id] - Product id.
-     *
      * @param {string} [langCode] Language code parameter. Default "en_US".
      *
      * @returns  ProductEntity object.
@@ -275,8 +277,8 @@ class ProductApi extends asyncModules_1.default {
     }
     /**
      * Getting a product block object by product id.
-     * @param {number} id - Product id
      *
+     * @param {number} id - Product id
      */
     async getProductBlockById(id) {
         const response = await this._fetchGet(`/${id}/blocks`);
@@ -286,7 +288,6 @@ class ProductApi extends asyncModules_1.default {
      * Quick search for product page objects with limited output.
      *
      * @param {string} [name] - Text to search product page objects (search is based on the title field of the localizeInfos object with language consideration)
-     *
      * @param {string} [langCode] - Language code
      *
      * @returns  Array with ProductEntity objects
@@ -294,6 +295,7 @@ class ProductApi extends asyncModules_1.default {
     async searchProduct(name, langCode = this.state.lang) {
         const searchProducts = await this._fetchGet(`/quick/search?langCode=${langCode}&name=${name}`);
         if (this.state.multipleResponse) {
+            // eslint-disable-next-line @typescript-eslint/no-explicit-any
             const productsList = [];
             await Promise.all(searchProducts.map(async (product) => {
                 await this.getProductById(product.id, langCode).then((result) => {

package/dist/products/productsInterfaces.d.ts

@@ -1,4 +1,4 @@
-import { AttributeType, IError, LangType, Types } from "../base/utils";
+import type { AttributeType, IError, LangType, Types } from '../base/utils';
 /**
  * Represents an interface object of Products Api.
  *
@@ -38,25 +38,16 @@ interface IProductApi {
  * @property {string} sortKey - Field for sorting (default - null)
  */
 interface IProductsQuery {
-    offset?: number;
-    limit?: number;
+    offset: number;
+    limit: number;
+    sortOrder: 'DESC' | 'ASC' | null;
+    sortKey: 'id' | 'position' | 'title' | 'date' | 'price' | null;
+    templateMarker?: string | null;
     statusMarker?: string | null;
     conditionValue?: string | null;
-    /**
-     * 'in' - Contains,
-     * 'nin' - Does not contain,
-     * 'eq' - Equal,
-     * 'neq' - Not equal,
-     * 'mth' - Greater than,
-     * 'lth' - Less than,
-     * 'exs' - Exists,
-     * 'nexs' - Does not exist
-     */
-    conditionMarker?: 'in' | 'nin' | 'eq' | 'neq' | 'mth' | 'lth' | 'exs' | 'nexs' | null;
     attributeMarker?: string | null;
-    sortOrder?: 'DESC' | 'ASC' | null;
-    sortKey?: "id" | "position" | "title" | "date" | "price" | null;
-    [key: string]: string | number | 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 */ | null;
+    [key: string]: any;
 }
 /**
  * Represents a product POST data object.
@@ -71,22 +62,12 @@ interface IProductsQuery {
  */
 interface IFilterParams {
     attributeMarker: string;
-    /**
-     * 'in' - Contains,
-     * 'nin' - Does not contain,
-     * 'eq' - Equal,
-     * 'neq' - Not equal,
-     * 'mth' - Greater than,
-     * 'lth' - Less than,
-     * 'exs' - Exists,
-     * 'nexs' - Does not exist
-     */
-    conditionMarker?: 'in' | 'nin' | 'eq' | 'neq' | 'mth' | 'lth' | 'exs' | 'nexs' | 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 */ | null;
     conditionValue: number | string | null;
     pageUrl?: Array<string> | null;
     statusMarker?: string;
-    title: string;
-    isNested: boolean;
+    title?: string;
+    isNested?: boolean;
 }
 /**
  * Represents a product entity object.
@@ -115,7 +96,7 @@ interface IProductsEntity {
             max: number;
         };
     };
-    isPositionLocked?: Boolean;
+    isPositionLocked?: boolean;
     localizeInfos: Record<string, any>;
     isVisible: boolean;
     statusIdentifier: string | null;
@@ -123,28 +104,59 @@ interface IProductsEntity {
     isSync: number | boolean;
     price: number;
     templateIdentifier: string | null;
-    shortDescTemplateIdentifier: string;
+    shortDescTemplateIdentifier: string | null;
     statusLocalizeInfos: Record<string, any>;
     attributeValues: AttributeType;
     position: number;
     sku: string | null;
 }
+/**
+ * IProductEntity
+ *
+ * @interface
+ * @property {Array<string>} blocks
+ * @property {Array<Record<string, any>> | Record<string, any>} productPages
+ */
 interface IProductEntity extends IProductsEntity {
     blocks?: Array<string>;
     productPages?: Array<Record<string, any>> | Record<string, any>;
 }
+/**
+ * IProductsResponse
+ *
+ * @interface
+ * @property {number} total
+ * @property {Array<IProductsEntity>} items
+ */
 interface IProductsResponse {
     total: number;
     items: Array<IProductsEntity>;
 }
+/**
+ * IProductsInfo
+ *
+ * @interface
+ * @property {number} total
+ * @property {Array<IProductInfo>} items
+ */
 interface IProductsInfo {
     total: number;
-    items: Array<IProductsInfo>;
+    items: Array<IProductInfo>;
 }
+/**
+ * IProductInfo
+ *
+ * @interface
+ * @property {number} id
+ * @property {number} price
+ */
 interface IProductInfo {
     id: number;
     price: number;
 }
+/**
+ * IProductBlock
+ */
 interface IProductBlock {
     id: number;
     attributeSetIdentifier: number | null;
@@ -154,13 +166,13 @@ interface IProductBlock {
     identifier: string;
     type: Types;
     customSettings: {
-        sliderDelay: number;
-        sliderDelayType: string;
+        sliderDelay: number | null;
+        sliderDelayType: string | null;
         productConfig: {
-            quantity: number;
-            sortType: string;
-            sortOrder: string;
-            countElementsPerRow: number;
+            quantity: string | number;
+            countElementsPerRow: string | number;
+            sortType?: string;
+            sortOrder?: string;
         };
         similarProductRules: Array<{
             property: string;
@@ -175,4 +187,4 @@ interface IProductBlock {
     isSync: boolean;
     attributeValues: AttributeType;
 }
-export { IFilterParams, IProductsQuery, IProductApi, IProductsEntity, IProductsInfo, IProductInfo, IProductBlock, IProductEntity, IProductsResponse };
+export type { IFilterParams, IProductApi, IProductBlock, IProductEntity, IProductInfo, IProductsEntity, IProductsInfo, IProductsQuery, IProductsResponse, };

package/dist/system/systemApi.d.ts

@@ -1,6 +1,6 @@
-import AsyncModules from "../base/asyncModules";
-import { ISystem } from "./systemInterfaces";
-import StateModule from "../base/stateModule";
+import AsyncModules from '../base/asyncModules';
+import type StateModule from '../base/stateModule';
+import type { ISystem } from './systemInterfaces';
 /**
  * Controllers for working with system - system
  */

package/dist/system/systemApi.js

@@ -1,6 +1,10 @@
 "use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
 Object.defineProperty(exports, "__esModule", { value: true });
-const asyncModules_1 = require("../base/asyncModules");
+/* eslint-disable @typescript-eslint/no-explicit-any */
+const asyncModules_1 = __importDefault(require("../base/asyncModules"));
 /**
  * Controllers for working with system - system
  */