oneentry 1.0.172 → 1.0.173

package/esm/orders/ordersInterfaces.d.ts

@@ -211,7 +211,7 @@ interface IOrdersVectorSearch {
         "formData": [
           {
           "marker": "order_name",
-          "value": "Ivan",
+          "value": "John",
           "type": "string"
           }
         ],
@@ -578,7 +578,7 @@ interface IOrderSplit {
     [
       {
         "marker": "order_name",
-        "value": "Ivan",
+        "value": "John",
         "type": "string"
       }
     ]

package/esm/product-statuses/productStatusesApi.d.ts

@@ -29,7 +29,7 @@ export default class ProductStatusesApi extends AsyncModules implements IProduct
     /**
      * Search for a product status object by its textual identifier (marker).
      * @handleName getProductsByStatusMarker
-     * @param {string} marker - Product marker. Example: "in_stock".
+     * @param {string} marker - Product status marker. Example: "in_stock".
      * @param {string} [langCode] - Language code. Default: "en_US".
      * @returns {Promise<IProductStatusEntity | IError>} Returns a product status object.
      * @throws {IError} When isShell=false and an error occurs during the fetch
@@ -40,7 +40,7 @@ export default class ProductStatusesApi extends AsyncModules implements IProduct
     /**
      * Check the existence of a textual identifier.
      * @handleName validateMarker
-     * @param {string} marker - Product marker. Example: "in_stock".
+     * @param {string} marker - Product status marker. Example: "in_stock".
      * @returns {Promise<boolean | IError>} Returns true if the textual identifier (marker) exists or false if it doesn't.
      * @throws {IError} When isShell=false and an error occurs during the fetch
      * @description Check the existence of a textual identifier.

package/esm/product-statuses/productStatusesApi.js

@@ -34,7 +34,7 @@ export default class ProductStatusesApi extends AsyncModules {
     /**
      * Search for a product status object by its textual identifier (marker).
      * @handleName getProductsByStatusMarker
-     * @param {string} marker - Product marker. Example: "in_stock".
+     * @param {string} marker - Product status marker. Example: "in_stock".
      * @param {string} [langCode] - Language code. Default: "en_US".
      * @returns {Promise<IProductStatusEntity | IError>} Returns a product status object.
      * @throws {IError} When isShell=false and an error occurs during the fetch
@@ -50,7 +50,7 @@ export default class ProductStatusesApi extends AsyncModules {
     /**
      * Check the existence of a textual identifier.
      * @handleName validateMarker
-     * @param {string} marker - Product marker. Example: "in_stock".
+     * @param {string} marker - Product status marker. Example: "in_stock".
      * @returns {Promise<boolean | IError>} Returns true if the textual identifier (marker) exists or false if it doesn't.
      * @throws {IError} When isShell=false and an error occurs during the fetch
      * @description Check the existence of a textual identifier.

package/esm/product-statuses/productStatusesInterfaces.d.ts

@@ -16,7 +16,7 @@ interface IProductStatusesApi {
     /**
      * Search for a product status object by its textual identifier (marker).
      * @handleName getProductsByStatusMarker
-     * @param {string} marker - Product marker. Example: "in_stock".
+     * @param {string} marker - Product status marker. Example: "in_stock".
      * @param {string} [langCode] - Language code. Default: "en_US".
      * @returns {IProductStatusEntity} Returns a product status object.
      * @throws {IError} If there is an error during the fetch operation, it will return an error object.
@@ -26,7 +26,7 @@ interface IProductStatusesApi {
     /**
      * Check the existence of a textual identifier.
      * @handleName validateMarker
-     * @param {string} marker - Product marker. Example: "in_stock".
+     * @param {string} marker - Product status marker. Example: "in_stock".
      * @returns {boolean} Returns true if the textual identifier (marker) exists or false if it doesn't.
      * @throws {IError} If there is an error during the fetch operation, it will return an error object.
      * @description This method checks the existence of a textual identifier.

package/esm/products/productsInterfaces.d.ts

@@ -367,9 +367,9 @@ type IProductsByIdsQuery = Pick<IProductsQueryBase, 'signPrice'>;
 type IProductsQuery = IProductsQueryBase;
 /**
  * @interface IFilterParams
- * @property {string | null} attributeMarker - The text identifier of the indexed attribute by which values are filtered. Default: null. Example: "color".
+ * @property {string} [attributeMarker] - The text identifier of the indexed attribute by which values are filtered. Example: "color". Optional: a filter entry may select by `statusMarker` (or `pageUrls`, `title`) alone, e.g. `{ statusMarker: "in_stock" }`.
  * @property {string | null} [conditionMarker] - Id of the filter condition by which the values are filtered. Default: null. Example: "eq".
- * @property {number | string | null} conditionValue - The value that is being searched for, default null. Example: "new".
+ * @property {number | string | null} [conditionValue] - The value that is being searched for, default null. Example: "new". Needed together with `attributeMarker`.
  * @property {string | null} [pageUrl] - Url of the category page object. Example: ["23-laminat-floorwood-maxima"].
  * @property {string[] | null} [pageUrls] - Url of the category page object. Example: ["23-laminat-floorwood-maxima"].
  * @property {string | null} [statusMarker] - Text identifier of the product page status (default not set). Example: "in_stock".
@@ -378,9 +378,9 @@ type IProductsQuery = IProductsQueryBase;
  * @description This interface defines the structure of filter parameters used for querying products, including conditions, attributes, and pagination.
  */
 interface IFilterParams {
-    attributeMarker: string;
+    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 */ | '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;
+    conditionValue?: number | string | null;
     pageUrl?: string | null;
     pageUrls?: string[] | null;
     statusMarker?: string;

package/esm/system/systemApi.d.ts

@@ -1,7 +1,7 @@
 import AsyncModules from '../base/asyncModules.js';
 import type StateModule from '../base/stateModule.js';
 import type { IError } from '../base/utils.js';
-import type { ISystemApi } from './systemInterfaces.js';
+import type { IApiStatEntry, ISystemApi } from './systemInterfaces.js';
 /**
  * Controllers for working with system components
  * @handle /api/content/system
@@ -37,10 +37,10 @@ export default class SystemApi extends AsyncModules implements ISystemApi {
     /**
      * Getting the number of requests to API.
      * @handleName getApiStat
-     * @returns {Promise<unknown | IError>} Return object with date and count.
+     * @returns {Promise<IApiStatEntry[] | IError>} Array of one-key objects `{ [YYYY-MM-DD]: count }`, one per day. Example: `[{ "2026-10-25": 17280 }, { "2026-10-26": 13671 }]`.
      * @throws {IError} When isShell=false and an error occurs during the fetch
-     * @description Getting the number of requests to API.
+     * @description Getting the number of requests to API, per day.
      * @see {@link https://js-sdk.oneentry.cloud/docs/system/getApiStat getApiStat} documentation.
      */
-    getApiStat(): Promise<unknown>;
+    getApiStat(): Promise<IApiStatEntry[] | IError>;
 }

package/esm/system/systemApi.js

@@ -41,9 +41,9 @@ export default class SystemApi extends AsyncModules {
     /**
      * Getting the number of requests to API.
      * @handleName getApiStat
-     * @returns {Promise<unknown | IError>} Return object with date and count.
+     * @returns {Promise<IApiStatEntry[] | IError>} Array of one-key objects `{ [YYYY-MM-DD]: count }`, one per day. Example: `[{ "2026-10-25": 17280 }, { "2026-10-26": 13671 }]`.
      * @throws {IError} When isShell=false and an error occurs during the fetch
-     * @description Getting the number of requests to API.
+     * @description Getting the number of requests to API, per day.
      * @see {@link https://js-sdk.oneentry.cloud/docs/system/getApiStat getApiStat} documentation.
      */
     async getApiStat() {

package/esm/system/systemInterfaces.d.ts

@@ -19,11 +19,17 @@ interface ISystemApi {
      */
     test500(): Promise<unknown | IError>;
     /**
-     * getApiStat
+     * Getting the number of requests to API.
      * @handleName getApiStat
-     * @returns {unknown} Returns a Promise that resolves with any data.
-     * @description This method getApiStat.
+     * @returns {Promise<IApiStatEntry[] | IError>} Array of one-key objects `{ [YYYY-MM-DD]: count }`, one per day. Example: `[{ "2026-10-25": 17280 }, { "2026-10-26": 13671 }]`.
+     * @description Getting the number of requests to API, per day.
      */
-    getApiStat(): Promise<unknown>;
+    getApiStat(): Promise<IApiStatEntry[] | IError>;
 }
-export type { ISystemApi };
+/**
+ * One day of API request statistics: a single key — the date `YYYY-MM-DD` — holding the number of requests.
+ * @typedef {Record<string, number>} IApiStatEntry
+ * @description Element of the array returned by getApiStat. Example: `{ "2026-10-26": 13671 }`.
+ */
+type IApiStatEntry = Record<string, number>;
+export type { IApiStatEntry, ISystemApi };

package/esm/templates/templatesApi.d.ts

@@ -22,7 +22,7 @@ export default class TemplatesPreviewApi extends AsyncModules implements ITempla
      * Get all template objects grouped by types.
      * @handleName getAllTemplates
      * @param {string} [langCode] - Language code. Default: "en_US".
-     * @returns {Promise<Record<BlockType, ITemplateEntity[]> | IError>} Returns an object GroupedTemplatesObject, which contains an array of template objects TemplateEntity
+     * @returns {Promise<Record<BlockType, ITemplateEntity[]> | IError>} Object keyed by `BlockType`; each value is an array of `ITemplateEntity` of that type.
      * @throws {IError} When isShell=false and an error occurs during the fetch
      * @description This function is designed to fetch organized template objects in groups based on their types.
      * @see {@link https://js-sdk.oneentry.cloud/docs/templates/getAllTemplates getAllTemplates} documentation.
@@ -33,7 +33,7 @@ export default class TemplatesPreviewApi extends AsyncModules implements ITempla
      * @handleName getTemplateByType
      * @param {BlockType} type - The type of templates to retrieve. This parameter specifies the category or classification of templates being requested. Example: "product".
      * @param {string} [langCode] - Language code. Default: "en_US".
-     * @returns {Promise<ITemplateEntity[] | IError>} Returns a TemplateEntity object.
+     * @returns {Promise<ITemplateEntity[] | IError>} Array of `ITemplateEntity` objects of the given type.
      * @throws {IError} When isShell=false and an error occurs during the fetch
      * @description Fetch template objects that belong to a specific type, with an optional filter by language.
      * @see {@link https://js-sdk.oneentry.cloud/docs/templates/getTemplateByType getTemplateByType} documentation.
@@ -44,7 +44,7 @@ export default class TemplatesPreviewApi extends AsyncModules implements ITempla
      * @handleName getTemplateByMarker
      * @param {string} marker - The unique marker of the template to retrieve. Example: "template_12345".
      * @param {string} [langCode] - Language code. Default: "en_US".
-     * @returns {Promise<ITemplateEntity | IError>} Returns a TemplateEntity object
+     * @returns {Promise<ITemplateEntity | IError>} Returns an `ITemplateEntity` object
      * @throws {IError} When isShell=false and an error occurs during the fetch
      * @description Fetch a specific template object based on its unique marker.
      * @see {@link https://js-sdk.oneentry.cloud/docs/templates/getTemplateByMarker getTemplateByMarker} documentation.

package/esm/templates/templatesApi.js

@@ -22,7 +22,7 @@ export default class TemplatesPreviewApi extends AsyncModules {
      * Get all template objects grouped by types.
      * @handleName getAllTemplates
      * @param {string} [langCode] - Language code. Default: "en_US".
-     * @returns {Promise<Record<BlockType, ITemplateEntity[]> | IError>} Returns an object GroupedTemplatesObject, which contains an array of template objects TemplateEntity
+     * @returns {Promise<Record<BlockType, ITemplateEntity[]> | IError>} Object keyed by `BlockType`; each value is an array of `ITemplateEntity` of that type.
      * @throws {IError} When isShell=false and an error occurs during the fetch
      * @description This function is designed to fetch organized template objects in groups based on their types.
      * @see {@link https://js-sdk.oneentry.cloud/docs/templates/getAllTemplates getAllTemplates} documentation.
@@ -48,7 +48,7 @@ export default class TemplatesPreviewApi extends AsyncModules {
      * @handleName getTemplateByType
      * @param {BlockType} type - The type of templates to retrieve. This parameter specifies the category or classification of templates being requested. Example: "product".
      * @param {string} [langCode] - Language code. Default: "en_US".
-     * @returns {Promise<ITemplateEntity[] | IError>} Returns a TemplateEntity object.
+     * @returns {Promise<ITemplateEntity[] | IError>} Array of `ITemplateEntity` objects of the given type.
      * @throws {IError} When isShell=false and an error occurs during the fetch
      * @description Fetch template objects that belong to a specific type, with an optional filter by language.
      * @see {@link https://js-sdk.oneentry.cloud/docs/templates/getTemplateByType getTemplateByType} documentation.
@@ -64,7 +64,7 @@ export default class TemplatesPreviewApi extends AsyncModules {
      * @handleName getTemplateByMarker
      * @param {string} marker - The unique marker of the template to retrieve. Example: "template_12345".
      * @param {string} [langCode] - Language code. Default: "en_US".
-     * @returns {Promise<ITemplateEntity | IError>} Returns a TemplateEntity object
+     * @returns {Promise<ITemplateEntity | IError>} Returns an `ITemplateEntity` object
      * @throws {IError} When isShell=false and an error occurs during the fetch
      * @description Fetch a specific template object based on its unique marker.
      * @see {@link https://js-sdk.oneentry.cloud/docs/templates/getTemplateByMarker getTemplateByMarker} documentation.

package/esm/templates/templatesInterfaces.d.ts

@@ -9,7 +9,7 @@ interface ITemplatesApi {
      * Get all template objects grouped by types.
      * @handleName getAllTemplates
      * @param {string} [langCode] - Language code. Default: "en_US".
-     * @returns {Record<BlockType, ITemplateEntity[]>} Returns an object GroupedTemplatesObject, which contains an array of template objects TemplateEntity
+     * @returns {Record<BlockType, ITemplateEntity[]>} Object keyed by `BlockType`; each value is an array of `ITemplateEntity` of that type.
      * @throws {IError} - If there is an error during the fetch operation, it will return an error object.
      * @description This method gets all template objects grouped by types.
      */
@@ -19,7 +19,7 @@ interface ITemplatesApi {
      * @handleName getTemplateByType
      * @param {BlockType} type - The type of templates to retrieve. This parameter specifies the category or classification of templates being requested. Example: "product".
      * @param {string} [langCode] - Language code. Default: "en_US".
-     * @returns {ITemplateEntity[]} Returns a TemplateEntity object.
+     * @returns {ITemplateEntity[]} Array of `ITemplateEntity` objects of the given type.
      * @throws {IError} - If there is an error during the fetch operation, it will return an error object.
      * @description This method gets template objects by type.
      */
@@ -29,7 +29,7 @@ interface ITemplatesApi {
      * @handleName getTemplateByMarker
      * @param {string} marker - The unique marker of the template to retrieve. Example: "template_12345".
      * @param {string} [langCode] - Language code. Default: "en_US".
-     * @returns {ITemplateEntity} Returns a TemplateEntity object
+     * @returns {ITemplateEntity} Returns an `ITemplateEntity` object
      * @throws {IError} - If there is an error during the fetch operation, it will return an error object.
      * @description This method gets one template object by id.
      */

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "oneentry",
-  "version": "1.0.172",
+  "version": "1.0.173",
   "description": "OneEntry NPM package",
   "main": "dist/index.js",
   "module": "esm/index.js",
@@ -48,7 +48,7 @@
   },
   "scripts": {
     "prepublishOnly": "node ../scripts/smoke-pack.js --files-only",
-    "postpublish": "node ../scripts/verify-published.js --named defineOneEntry --expect 1.0.172"
+    "postpublish": "node ../scripts/verify-published.js --named defineOneEntry --expect 1.0.173"
   },
   "sideEffects": false,
   "files": [