oneentry 1.0.172 → 1.0.173

package/changelog.md

@@ -1,5 +1,30 @@
 # SDK Change Log
 
+## v.1.0.173
+
+### What's Changed
+
+- **⚠️ Breaking (types): `FileUploading.upload` and `FileUploading.delete` require `fileQuery`, and `IUploadingQuery` requires `type`, `entity` and `id`.** The signature and the JSDoc declared all of them optional, and the SDK filled the gaps with `null` — which the endpoint refuses: without any of the three both methods answer `400 type should not be empty; entity should not be empty; id should not be empty`, and a `delete` without `type` leaves the file in place. A call that compiled could never succeed. It is now a compile error instead of a `400` at run time; code that already passed a full `fileQuery` is unaffected. `width`, `height`, `compress` and `template` stay optional. The per-field `fileQuery` of `postFormsData` is unchanged — there the SDK still picks a folder when none is given (CMS-1085).
+
+- **`IntegrationCollections` types accept the calls the API accepts.** `ICollectionFormObject.formData` was declared as a map keyed by language only, so the flat array `[{ marker, type, value }]` shown in the JSDoc example of `createICollectionRow` — and stored by the platform — did not compile; it is now `ICollectionFormData[] | Record<string, ICollectionFormData[]>`. All four fields of `ICollectionQuery` were required, so `{ limit, offset }` did not compile either; they are optional now. `getICollections` takes the new `ICollectionsListQuery` (`limit`, `offset`): the collection list has no entity filter. The JSDoc of both list methods gave the pagination defaults swapped (`limit` 0, `offset` 30); the code has always used `limit` 30, `offset` 0, and so does the JSDoc now (CMS-1078, CMS-1086).
+
+- **`IFilterParams.attributeMarker` and `conditionValue` are optional.** A filter entry may select by `statusMarker` (or `pageUrls`, `title`) alone — `getProducts([{ statusMarker: 'sale' }])` is answered and filtered by the endpoint (an unknown status gives `total: 0`), but the type refused it without a cast (CMS-1086).
+
+- **`System.getApiStat` is typed.** It returned `Promise<unknown>` and its JSDoc promised "object with date and count"; the endpoint answers an array of one-key day objects, `[{ "2026-10-25": 17280 }, { "2026-10-26": 13671 }]`. The return type is now `IApiStatEntry[] | IError`, with `IApiStatEntry = Record<string, number>` exported (CMS-1077).
+
+### What's Fixed
+
+- **JSDoc that the documentation site is generated from.**
+  - `IConfig.traficLimit` and the `config.traficLimit` parameter of `defineOneEntry` said "set it to `false` to save traffic" — the opposite of the code: `true` makes the SDK skip its follow-up requests (one request instead of six for a quick page search) and shortens some results to `{ id, title }` cards (CMS-1084).
+  - `Templates.getAllTemplates`, `getTemplateByType` and `getTemplateByMarker` named `GroupedTemplatesObject` and `TemplateEntity`, which do not exist; they name `BlockType` and `ITemplateEntity` now, and `getTemplateByType` is described as the array it returns (CMS-1077).
+  - `AuthProvider.getActiveSessionsByMarker` carried the description of `getAuthProviderByMarker`; it describes the user's active sessions now (CMS-1086).
+  - `ProductStatuses.getProductsByStatusMarker` and `validateMarker` called their argument a product marker; it is a product status marker (CMS-1086).
+  - Examples carried Russian data into English documentation: `"Ivan"` in the order examples and `"ru-RU"` in `IActiveSession` are `"John"` and `"en-US"` (CMS-1086).
+
+### Tests
+
+- **`callercontracts.spec.ts` checks the types against the API.** ts-jest type-checks the file, so a type that drifts back fails the run: a flat collection `formData`, `{ limit, offset }` as a collection query, a status-only product filter and the `getApiStat` array must compile, and `upload` / `delete` without `fileQuery` must not (`@ts-expect-error`). The test client is typed now — it was `any`, which would have let such checks pass silently. Against 1.0.172 the file does not compile, with six errors naming exactly these types.
+
 ## v.1.0.172
 
 ### What's Fixed

package/dist/auth-provider/authProviderApi.d.ts

@@ -233,9 +233,9 @@ export default class AuthProviderApi extends AsyncModules implements IAuthProvid
      * Getting active user sessions data.
      * @handleName getActiveSessionsByMarker
      * @param {string} marker - The text identifier of the authorization provider. Example: "email".
-     * @returns {Promise<IActiveSession[] | IError>} Returns an auth provider object.
+     * @returns {Promise<IActiveSession[] | IError>} Array of the authenticated user's active sessions for this provider, one per device (`deviceInfo`).
      * @throws {IError} When isShell=false and an error occurs during the fetch
-     * @description Getting a single authorization provider object by marker.
+     * @description Getting the authenticated user's active sessions for the authorization provider. This method requires user authorization.
      * @see {@link https://js-sdk.oneentry.cloud/docs/auth-provider/getActiveSessionsByMarker getActiveSessionsByMarker} documentation.
      */
     getActiveSessionsByMarker(marker: string): Promise<IActiveSession[] | IError>;

package/dist/auth-provider/authProviderApi.js

@@ -366,9 +366,9 @@ class AuthProviderApi extends asyncModules_1.default {
      * Getting active user sessions data.
      * @handleName getActiveSessionsByMarker
      * @param {string} marker - The text identifier of the authorization provider. Example: "email".
-     * @returns {Promise<IActiveSession[] | IError>} Returns an auth provider object.
+     * @returns {Promise<IActiveSession[] | IError>} Array of the authenticated user's active sessions for this provider, one per device (`deviceInfo`).
      * @throws {IError} When isShell=false and an error occurs during the fetch
-     * @description Getting a single authorization provider object by marker.
+     * @description Getting the authenticated user's active sessions for the authorization provider. This method requires user authorization.
      * @see {@link https://js-sdk.oneentry.cloud/docs/auth-provider/getActiveSessionsByMarker getActiveSessionsByMarker} documentation.
      */
     async getActiveSessionsByMarker(marker) {

package/dist/auth-provider/authProvidersInterfaces.d.ts

@@ -405,11 +405,11 @@ interface IAuthPostBody {
     {
       "os": "Win32",
       "browser": "Node.js/22",
-      "location": "ru-RU"
+      "location": "en-US"
     }
  * @property {string} deviceInfo.os - The operating system of the active session. Example: "Win32".
  * @property {string} deviceInfo.browser - The browser used in the active session. Example: "Node.js/22".
- * @property {string} deviceInfo.location - The location of the active session. Example: "ru-RU".
+ * @property {string} deviceInfo.location - The location of the active session. Example: "en-US".
  * @description This interface defines the structure of the body used in authentication requests, containing an array of authentication data.
  */
 interface IActiveSession {
@@ -419,7 +419,7 @@ interface IActiveSession {
  * @interface IDeviceInfo
  * @property {string} os - The operating system of the active session. Example: "Win32".
  * @property {string} browser - The browser used in the active session. Example: "Node.js/22".
- * @property {string} location - The locale of the active session. Example: "ru-RU".
+ * @property {string} location - The locale of the active session. Example: "en-US".
  * @description Information about the device tied to an active authentication session.
  */
 interface IDeviceInfo {

package/dist/base/utils.d.ts

@@ -4,7 +4,7 @@
  * @property {string} [guestId] - Guest identifier sent as the `x-guest-id` header on unauthenticated requests. Lets cart/wishlist/activity endpoints work for a guest. In the browser a stable id is auto-generated (localStorage) when omitted; on the server pass a per-visitor id. Can also be set later via `setGuestId`.
  * @property {string} [deviceMetadata] - Device-metadata string sent as the `x-device-metadata` header on POST requests and token refresh, overriding the environment-derived fingerprint. The API binds refresh tokens to this header, so server-side flows that issue tokens on behalf of a browser (e.g. an OAuth code exchange) must pass the browser's string here — otherwise the token is bound to the server's fingerprint and cannot be refreshed from the browser. Obtain the string in the browser via `getDeviceMetadata()`. Can also be set later via `setDeviceMetadata`.
  * @property {string} [langCode] - specify the default language to avoid specifying it in every request.
- * @property {boolean} [traficLimit] - Some methods use multiple queries to make it easier to work with the API. Set this parameter to "false" to save traffic and decide for yourself what data you need.
+ * @property {boolean} [traficLimit] - Some methods use multiple queries to make it easier to work with the API. Set it to `true` to save traffic and decide for yourself what data you need: the SDK then skips its follow-up requests (full pages behind quick search results, products of page blocks), and some results change shape — e.g. `searchPage` returns short `{ id, title }` cards. Default: false.
  * @property {boolean} [rawData] - Set to true to keep an attribute's nested `additionalFields` as the
  * array the API sends, instead of the marker-keyed map the SDK builds by default. It turns off only that
  * transformation — locale unwrapping, sorting by `position`, single-file unwrapping and number casting

package/dist/file-uploading/fileUploadingApi.d.ts

@@ -23,7 +23,7 @@ export default class FileUploadingApi extends AsyncModules implements IFileUploa
      * Upload file function.
      * @handleName upload
      * @param {File | Blob} file - File to upload. Example: `new File(["content"], "file.png", {"type": "image/png"})`
-     * @param {IUploadingQuery} [fileQuery] - Optional set query parameters.
+     * @param {IUploadingQuery} fileQuery - Where the file lives in the storage. Required: without `type`, `entity` and `id` the endpoint answers `400 … should not be empty`.
      * @example
         {
           "type": "page",
@@ -34,9 +34,9 @@ export default class FileUploadingApi extends AsyncModules implements IFileUploa
           "compress": true,
           "template": 1
         }
-     * @param {string} [fileQuery.type] - Type, determines the folder name in the storage. Example: "page".
-     * @param {string} [fileQuery.entity] - Entity name from which the file is uploaded, determines the folder name in the storage. Example: "editor".
-     * @param {number} [fileQuery.id] - Identifier of the object from which the file is uploaded, determines the folder name in the storage. Example: 3787.
+     * @param {string} fileQuery.type - Type, determines the folder name in the storage. Example: "page".
+     * @param {string} fileQuery.entity - Entity name from which the file is uploaded, determines the folder name in the storage. Example: "editor".
+     * @param {number} fileQuery.id - Identifier of the object from which the file is uploaded, determines the folder name in the storage. Example: 3787.
      * @param {number} [fileQuery.width] - Optional width parameter. Example: 0.
      * @param {number} [fileQuery.height] - Optional height parameter. Example: 0.
      * @param {boolean} [fileQuery.compress] - Optional flag of optimization (compression) for images. Example: true.
@@ -45,12 +45,12 @@ export default class FileUploadingApi extends AsyncModules implements IFileUploa
      * @throws {IError} When isShell=false and an error occurs during the fetch
      * @see {@link https://js-sdk.oneentry.cloud/docs/file-uploading/upload upload} documentation.
      */
-    upload(file: File | Blob, fileQuery?: IUploadingQuery): Promise<IUploadingReturn[] | IError>;
+    upload(file: File | Blob, fileQuery: IUploadingQuery): Promise<IUploadingReturn[] | IError>;
     /**
      * Deletes a file from the cloud file storage.
      * @handleName delete
      * @param {string} filename - File name. Example: "file.png".
-     * @param {IUploadingQuery} [fileQuery] - Optional set query parameters.
+     * @param {IUploadingQuery} fileQuery - Where the file lives in the storage. Required: without `type`, `entity` and `id` the endpoint answers `400 … should not be empty`.
      * @example
         {
           "type": "page",
@@ -58,15 +58,15 @@ export default class FileUploadingApi extends AsyncModules implements IFileUploa
           "id": 3787,
           "template": 1
         }
-     * @param {string} [fileQuery.type] - Type, determines the folder name in the storage. Example: "page".
-     * @param {string} [fileQuery.entity] - Entity name from which the file is uploaded, determines the folder name in the storage. Example: "editor".
-     * @param {number} [fileQuery.id] - Identifier of the object from which the file is uploaded, determines the folder name in the storage. Example: 3787.
+     * @param {string} fileQuery.type - Type, determines the folder name in the storage. Example: "page".
+     * @param {string} fileQuery.entity - Entity name from which the file is uploaded, determines the folder name in the storage. Example: "editor".
+     * @param {number} fileQuery.id - Identifier of the object from which the file is uploaded, determines the folder name in the storage. Example: 3787.
      * @param {number} [fileQuery.template] - preview template identifier. Example: 1.
      * @returns {Promise<boolean | IError>} Returns a promise that resolves to true when the file was deleted or an error object if there was an issue.
      * @throws {IError} When isShell=false and an error occurs during the fetch
      * @see {@link https://js-sdk.oneentry.cloud/docs/file-uploading/delete delete} documentation.
      */
-    delete(filename: string, fileQuery?: IUploadingQuery): Promise<boolean | IError>;
+    delete(filename: string, fileQuery: IUploadingQuery): Promise<boolean | IError>;
     /**
      * Public search across the content of files attached to records.
      * @handleName searchFileContent

package/dist/file-uploading/fileUploadingApi.js

@@ -56,9 +56,6 @@ class FileUploadingApi extends asyncModules_1.default {
         super(state);
         /** FileUploadingApi class */
         this._defaultQuery = {
-            type: null,
-            entity: null,
-            id: null,
             width: null,
             height: null,
             compress: null,
@@ -69,7 +66,7 @@ class FileUploadingApi extends asyncModules_1.default {
      * Upload file function.
      * @handleName upload
      * @param {File | Blob} file - File to upload. Example: `new File(["content"], "file.png", {"type": "image/png"})`
-     * @param {IUploadingQuery} [fileQuery] - Optional set query parameters.
+     * @param {IUploadingQuery} fileQuery - Where the file lives in the storage. Required: without `type`, `entity` and `id` the endpoint answers `400 … should not be empty`.
      * @example
         {
           "type": "page",
@@ -80,9 +77,9 @@ class FileUploadingApi extends asyncModules_1.default {
           "compress": true,
           "template": 1
         }
-     * @param {string} [fileQuery.type] - Type, determines the folder name in the storage. Example: "page".
-     * @param {string} [fileQuery.entity] - Entity name from which the file is uploaded, determines the folder name in the storage. Example: "editor".
-     * @param {number} [fileQuery.id] - Identifier of the object from which the file is uploaded, determines the folder name in the storage. Example: 3787.
+     * @param {string} fileQuery.type - Type, determines the folder name in the storage. Example: "page".
+     * @param {string} fileQuery.entity - Entity name from which the file is uploaded, determines the folder name in the storage. Example: "editor".
+     * @param {number} fileQuery.id - Identifier of the object from which the file is uploaded, determines the folder name in the storage. Example: 3787.
      * @param {number} [fileQuery.width] - Optional width parameter. Example: 0.
      * @param {number} [fileQuery.height] - Optional height parameter. Example: 0.
      * @param {boolean} [fileQuery.compress] - Optional flag of optimization (compression) for images. Example: true.
@@ -104,7 +101,7 @@ class FileUploadingApi extends asyncModules_1.default {
      * Deletes a file from the cloud file storage.
      * @handleName delete
      * @param {string} filename - File name. Example: "file.png".
-     * @param {IUploadingQuery} [fileQuery] - Optional set query parameters.
+     * @param {IUploadingQuery} fileQuery - Where the file lives in the storage. Required: without `type`, `entity` and `id` the endpoint answers `400 … should not be empty`.
      * @example
         {
           "type": "page",
@@ -112,9 +109,9 @@ class FileUploadingApi extends asyncModules_1.default {
           "id": 3787,
           "template": 1
         }
-     * @param {string} [fileQuery.type] - Type, determines the folder name in the storage. Example: "page".
-     * @param {string} [fileQuery.entity] - Entity name from which the file is uploaded, determines the folder name in the storage. Example: "editor".
-     * @param {number} [fileQuery.id] - Identifier of the object from which the file is uploaded, determines the folder name in the storage. Example: 3787.
+     * @param {string} fileQuery.type - Type, determines the folder name in the storage. Example: "page".
+     * @param {string} fileQuery.entity - Entity name from which the file is uploaded, determines the folder name in the storage. Example: "editor".
+     * @param {number} fileQuery.id - Identifier of the object from which the file is uploaded, determines the folder name in the storage. Example: 3787.
      * @param {number} [fileQuery.template] - preview template identifier. Example: 1.
      * @returns {Promise<boolean | IError>} Returns a promise that resolves to true when the file was deleted or an error object if there was an issue.
      * @throws {IError} When isShell=false and an error occurs during the fetch

package/dist/file-uploading/fileUploadingInterfaces.d.ts

@@ -17,7 +17,7 @@ interface IFileUploading {
      * Upload file function.
      * @handleName upload
      * @param {File | Blob} file - File to upload. Example: `new File(["content"], "file.png", {"type": "image/png"})`
-     * @param {IUploadingQuery} [fileQuery] - Optional set query parameters.
+     * @param {IUploadingQuery} fileQuery - Where the file lives in the storage. Required: without `type`, `entity` and `id` the endpoint answers `400 … should not be empty`.
      * @example
         {
           "type": "page",
@@ -28,9 +28,9 @@ interface IFileUploading {
           "compress": true,
           "template": 1
         }
-     * @param {string} [fileQuery.type] - Type, determines the folder name in the storage. Example: "page".
-     * @param {string} [fileQuery.entity] - Entity name from which the file is uploaded, determines the folder name in the storage. Example: "editor".
-     * @param {number} [fileQuery.id] - Identifier of the object from which the file is uploaded, determines the folder name in the storage. Example: 3787.
+     * @param {string} fileQuery.type - Type, determines the folder name in the storage. Example: "page".
+     * @param {string} fileQuery.entity - Entity name from which the file is uploaded, determines the folder name in the storage. Example: "editor".
+     * @param {number} fileQuery.id - Identifier of the object from which the file is uploaded, determines the folder name in the storage. Example: 3787.
      * @param {number} [fileQuery.width] - Optional width parameter. Example: 0.
      * @param {number} [fileQuery.height] - Optional height parameter. Example: 0.
      * @param {boolean} [fileQuery.compress] - Optional flag of optimization (compression) for images. Example: true.
@@ -38,12 +38,12 @@ interface IFileUploading {
      * @returns {IUploadingReturn[]} Uploads a file to an Amazon S3-compatible cloud file storage.
      * @throws {IError} - If there is an error during the fetch operation, it will return an error object.
      */
-    upload(file: File | Blob, fileQuery?: IUploadingQuery): Promise<IUploadingReturn[] | IError>;
+    upload(file: File | Blob, fileQuery: IUploadingQuery): Promise<IUploadingReturn[] | IError>;
     /**
      * Deletes a file from the cloud file storage.
      * @handleName delete
      * @param {string} [filename] - File name. Example: "file.png".
-     * @param {IUploadingQuery} [fileQuery] - Optional set query parameters.
+     * @param {IUploadingQuery} fileQuery - Where the file lives in the storage. Required: without `type`, `entity` and `id` the endpoint answers `400 … should not be empty`.
      * @example
         {
           "type": "page",
@@ -51,14 +51,14 @@ interface IFileUploading {
           "id": 3787,
           "template": 1
         }
-     * @param {string} [fileQuery.type] - Type, determines the folder name in the storage. Example: "page".
-     * @param {string} [fileQuery.entity] - Entity name from which the file is uploaded, determines the folder name in the storage. Example: "editor".
-     * @param {number} [fileQuery.id] - Identifier of the object from which the file is uploaded, determines the folder name in the storage. Example: 3787.
+     * @param {string} fileQuery.type - Type, determines the folder name in the storage. Example: "page".
+     * @param {string} fileQuery.entity - Entity name from which the file is uploaded, determines the folder name in the storage. Example: "editor".
+     * @param {number} fileQuery.id - Identifier of the object from which the file is uploaded, determines the folder name in the storage. Example: 3787.
      * @param {number} [fileQuery.template] - preview template identifier. Example: 1.
      * @returns {boolean | IError} Returns a promise that resolves to true when the file was deleted or an error object if there was an issue.
      * @throws {IError} - If there is an error during the fetch operation, it will return an error object.
      */
-    delete(filename: string, fileQuery?: IUploadingQuery): Promise<boolean | IError>;
+    delete(filename: string, fileQuery: IUploadingQuery): Promise<boolean | IError>;
     /**
      * Get file by parameters.
      * @handleName getFile
@@ -106,12 +106,12 @@ interface IFileEntity {
  * @property {number} [width] - Width parameter. Example: 0.
  * @property {number} [height] - Height parameter. Example: 0.
  * @property {boolean} [compress] - Flag of optimization (compression) for images. Example: true.
- * @description Represents a query for uploading files, including type, entity, and optional parameters like width, height, and compression.
+ * @description Represents a query for uploading files, including type, entity, and optional parameters like width, height, and compression. `type`, `entity` and `id` are required by the endpoint: it answers `400 … should not be empty` without any of them (CMS-1085).
  */
 interface IUploadingQuery {
-    type: string | null;
-    entity: string | null;
-    id: number | null;
+    type: string;
+    entity: string;
+    id: number;
     [key: string]: string | number | boolean | null;
 }
 /**

package/dist/index.d.ts

@@ -136,7 +136,7 @@ interface IDefineApi {
  * @param {string} [config.guestId] - Optional guest identifier sent as the `x-guest-id` header for guest cart/wishlist/activity flows (only while unauthenticated). In the browser, if omitted, a stable per-device id is generated and persisted in localStorage. On the server you MUST pass a per-visitor `guestId` (or call `setGuestId`): the SDK never auto-generates a server id, to avoid sharing one guest across visitors.
  * @param {string} [config.deviceMetadata] - Optional device-metadata string sent as the `x-device-metadata` header instead of the environment-derived fingerprint. Refresh tokens are bound to this header, so a server issuing tokens for a browser (OAuth code exchange) must pass the browser's string (from `getDeviceMetadata()`), or the token will not be refreshable from that browser.
  * @param {string} [config.langCode] - Optional langCode parameter
- * @param {boolean} [config.traficLimit] - Some methods use multiple queries to make it easier to work with the API. Set this parameter to "false" to save traffic and decide for yourself what data you need.
+ * @param {boolean} [config.traficLimit] - Some methods use multiple queries to make it easier to work with the API. Set it to `true` to save traffic and decide for yourself what data you need: the SDK then skips its follow-up requests, and some results change shape (e.g. `searchPage` returns short `{ id, title }` cards). Default: false.
  * @param {string} [config.auth] - An object with authorization settings.
  * @param {boolean} [config.auth.customAuth] - Set this flag to true if you want to configure the authorization process yourself. Set the flag to false, or do not pass it at all to have automatic authorization and token renewal.
  * @param {string} [config.auth.refreshToken] - Transfer the refresh token here, for example from the local storage, to resume the user's session. Otherwise, the user will need to log in every time a new session is created.

package/dist/index.js

@@ -59,7 +59,7 @@ Object.defineProperty(exports, "isTimeIntervalAttribute", { enumerable: true, ge
  * @param {string} [config.guestId] - Optional guest identifier sent as the `x-guest-id` header for guest cart/wishlist/activity flows (only while unauthenticated). In the browser, if omitted, a stable per-device id is generated and persisted in localStorage. On the server you MUST pass a per-visitor `guestId` (or call `setGuestId`): the SDK never auto-generates a server id, to avoid sharing one guest across visitors.
  * @param {string} [config.deviceMetadata] - Optional device-metadata string sent as the `x-device-metadata` header instead of the environment-derived fingerprint. Refresh tokens are bound to this header, so a server issuing tokens for a browser (OAuth code exchange) must pass the browser's string (from `getDeviceMetadata()`), or the token will not be refreshable from that browser.
  * @param {string} [config.langCode] - Optional langCode parameter
- * @param {boolean} [config.traficLimit] - Some methods use multiple queries to make it easier to work with the API. Set this parameter to "false" to save traffic and decide for yourself what data you need.
+ * @param {boolean} [config.traficLimit] - Some methods use multiple queries to make it easier to work with the API. Set it to `true` to save traffic and decide for yourself what data you need: the SDK then skips its follow-up requests, and some results change shape (e.g. `searchPage` returns short `{ id, title }` cards). Default: false.
  * @param {string} [config.auth] - An object with authorization settings.
  * @param {boolean} [config.auth.customAuth] - Set this flag to true if you want to configure the authorization process yourself. Set the flag to false, or do not pass it at all to have automatic authorization and token renewal.
  * @param {string} [config.auth.refreshToken] - Transfer the refresh token here, for example from the local storage, to resume the user's session. Otherwise, the user will need to log in every time a new session is created.

package/dist/integration-collections/integrationCollectionsApi.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 { ICollectionEntity, ICollectionFormObject, ICollectionIsValid, ICollectionQuery, ICollectionRow, ICollectionRowsResponce, ICollectionsApi } from './integrationCollectionsInterfaces';
+import type { ICollectionEntity, ICollectionFormObject, ICollectionIsValid, ICollectionQuery, ICollectionRow, ICollectionRowsResponce, ICollectionsApi, ICollectionsListQuery } from './integrationCollectionsInterfaces';
 /**
  * Controllers for working with attributes.
  * @handle /api/content/integration-collections
@@ -22,22 +22,18 @@ export default class IntegrationCollectionsApi extends AsyncModules implements I
      * Get all collections.
      * @handleName getICollections
      * @param {string} [langCode] - Language code. Default: "en_US".
-     * @param {object} [userQuery] - Optional set query parameters.
+     * @param {ICollectionsListQuery} [userQuery] - Optional set query parameters.
      * @example
         {
-          "limit": 0,
-          "offset": 30,
-          "entityType": "orders",
-          "entityId": 1
+          "limit": 30,
+          "offset": 0
         }
-     * @param {number} [userQuery.limit] - Optional parameter for pagination. Default: 0.
-     * @param {number} [userQuery.offset] - Optional parameter for pagination. Default: 30.
-     * @param {string} [userQuery.entityType] - Entity type. Example: "orders".
-     * @param {number} [userQuery.entityId] - Entity identifier. Example: 1.
+     * @param {number} [userQuery.limit] - Optional parameter for pagination. Default: 30.
+     * @param {number} [userQuery.offset] - Optional parameter for pagination. Default: 0.
      * @returns {Promise<ICollectionEntity[] | IError>} Returns an array of ICollection objects or an error object if there was an issue.
      * @see {@link https://js-sdk.oneentry.cloud/docs/integration-collections/getICollections getICollections} documentation.
      */
-    getICollections(langCode?: string, userQuery?: ICollectionQuery): Promise<ICollectionEntity[] | IError>;
+    getICollections(langCode?: string, userQuery?: ICollectionsListQuery): Promise<ICollectionEntity[] | IError>;
     /**
      * Get a single collection object by id.
      * @handleName getICollectionById
@@ -53,16 +49,16 @@ export default class IntegrationCollectionsApi extends AsyncModules implements I
      * @handleName getICollectionRowsById
      * @param {number} id - Collection id. Example: 1.
      * @param {string} [langCode] - Language code. Default: "en_US".
-     * @param {any} [userQuery] - Optional set query parameters.
+     * @param {ICollectionQuery} [userQuery] - Optional set query parameters.
      * @example
         {
-          "limit": 0,
-          "offset": 30,
+          "limit": 30,
+          "offset": 0,
           "entityType": "orders",
           "entityId": 1
         }
-     * @param {number} [userQuery.limit] - Optional parameter for pagination. Default: 0.
-     * @param {number} [userQuery.offset] - Optional parameter for pagination. Default: 30.
+     * @param {number} [userQuery.limit] - Optional parameter for pagination. Default: 30.
+     * @param {number} [userQuery.offset] - Optional parameter for pagination. Default: 0.
      * @param {string} [userQuery.entityType] - Entity type. Example: "orders".
      * @param {number} [userQuery.entityId] - Entity identifier. Example: 1.
      * @returns {Promise<ICollectionRowsResponce | IError>} Returns object ItemsWithTotal, where items is an array of requested objects.

package/dist/integration-collections/integrationCollectionsApi.js

@@ -65,18 +65,14 @@ class IntegrationCollectionsApi extends asyncModules_1.default {
      * Get all collections.
      * @handleName getICollections
      * @param {string} [langCode] - Language code. Default: "en_US".
-     * @param {object} [userQuery] - Optional set query parameters.
+     * @param {ICollectionsListQuery} [userQuery] - Optional set query parameters.
      * @example
         {
-          "limit": 0,
-          "offset": 30,
-          "entityType": "orders",
-          "entityId": 1
+          "limit": 30,
+          "offset": 0
         }
-     * @param {number} [userQuery.limit] - Optional parameter for pagination. Default: 0.
-     * @param {number} [userQuery.offset] - Optional parameter for pagination. Default: 30.
-     * @param {string} [userQuery.entityType] - Entity type. Example: "orders".
-     * @param {number} [userQuery.entityId] - Entity identifier. Example: 1.
+     * @param {number} [userQuery.limit] - Optional parameter for pagination. Default: 30.
+     * @param {number} [userQuery.offset] - Optional parameter for pagination. Default: 0.
      * @returns {Promise<ICollectionEntity[] | IError>} Returns an array of ICollection objects or an error object if there was an issue.
      * @see {@link https://js-sdk.oneentry.cloud/docs/integration-collections/getICollections getICollections} documentation.
      */
@@ -108,16 +104,16 @@ class IntegrationCollectionsApi extends asyncModules_1.default {
      * @handleName getICollectionRowsById
      * @param {number} id - Collection id. Example: 1.
      * @param {string} [langCode] - Language code. Default: "en_US".
-     * @param {any} [userQuery] - Optional set query parameters.
+     * @param {ICollectionQuery} [userQuery] - Optional set query parameters.
      * @example
         {
-          "limit": 0,
-          "offset": 30,
+          "limit": 30,
+          "offset": 0,
           "entityType": "orders",
           "entityId": 1
         }
-     * @param {number} [userQuery.limit] - Optional parameter for pagination. Default: 0.
-     * @param {number} [userQuery.offset] - Optional parameter for pagination. Default: 30.
+     * @param {number} [userQuery.limit] - Optional parameter for pagination. Default: 30.
+     * @param {number} [userQuery.offset] - Optional parameter for pagination. Default: 0.
      * @param {string} [userQuery.entityType] - Entity type. Example: "orders".
      * @param {number} [userQuery.entityId] - Entity identifier. Example: 1.
      * @returns {Promise<ICollectionRowsResponce | IError>} Returns object ItemsWithTotal, where items is an array of requested objects.

package/dist/integration-collections/integrationCollectionsInterfaces.d.ts

@@ -8,23 +8,19 @@ interface ICollectionsApi {
      * Get all collections.
      * @handleName getICollections
      * @param {string} [langCode] - Language code. Default: "en_US".
-     * @param {ICollectionQuery} [userQuery] - Query parameters.
+     * @param {ICollectionsListQuery} [userQuery] - Query parameters.
      * @example
         {
           "limit": 30,
-          "offset": 0,
-          "entityType": "orders",
-          "entityId": 1
+          "offset": 0
         }
-     * @param {number} [userQuery.limit] - Parameter for pagination. Default: 0.
-     * @param {number} [userQuery.offset] - Parameter for pagination. Default: 30.
-     * @param {string} [userQuery.entityType] - Entity type. Example: "orders".
-     * @param {number} [userQuery.entityId] - Entity identifier. Example: 1.
+     * @param {number} [userQuery.limit] - Parameter for pagination. Default: 30.
+     * @param {number} [userQuery.offset] - Parameter for pagination. Default: 0.
      * @returns {ICollectionEntity[]} Returns an array of ICollection objects or an error object if there was an issue.
      * @throws {IError} - If there is an error during the fetch operation, it will return an error object.
      * @description This method gets all collections.
      */
-    getICollections(langCode?: string, userQuery?: ICollectionQuery): Promise<ICollectionEntity[] | IError>;
+    getICollections(langCode?: string, userQuery?: ICollectionsListQuery): Promise<ICollectionEntity[] | IError>;
     /**
      * Get a single collection object by id.
      * @handleName getICollectionById
@@ -205,7 +201,7 @@ interface ICollectionFormData {
  * Collection form object
  * @interface ICollectionFormObject
  * @property {string} formIdentifier - Text identifier (marker) of the form. Example: "collection-form".
- * @property {Record<string, ICollectionFormData>} formData - An object where keys are form field markers and values are arrays of ICollectionFormData objects.
+ * @property {ICollectionFormData[] | Record<string, ICollectionFormData[]>} formData - Field values: a flat array `[{ marker, type, value }]` (as in the example), or the same array wrapped in a language code — `{ "en_US": [...] }`. The platform stores both; the SDK sends the value as is.
  * @example
     [
       {
@@ -221,9 +217,7 @@ interface ICollectionFormData {
  */
 interface ICollectionFormObject {
     formIdentifier: string;
-    formData: {
-        [key: string]: ICollectionFormData[];
-    };
+    formData: ICollectionFormData[] | Record<string, ICollectionFormData[]>;
 }
 /**
  * Collection row object
@@ -301,17 +295,24 @@ interface ICollectionIsValid {
     valid: boolean;
 }
 /**
- * Query parameters for collection requests.
+ * Query parameters for collection row requests. All of them are optional.
  * @interface ICollectionQuery
- * @property {number} limit - Parameter for pagination. Default: 30.
- * @property {number} offset - Parameter for pagination. Default: 0.
- * @property {string} entityType - Entity type. Example: "orders".
- * @property {number} entityId - Entity identifier. Example: 1.
+ * @property {number} [limit] - Parameter for pagination. Default: 30.
+ * @property {number} [offset] - Parameter for pagination. Default: 0.
+ * @property {string} [entityType] - Entity type. Example: "orders".
+ * @property {number} [entityId] - Entity identifier. Example: 1.
  */
 interface ICollectionQuery {
-    limit: number;
-    offset: number;
-    entityType: string;
-    entityId: number;
+    limit?: number;
+    offset?: number;
+    entityType?: string;
+    entityId?: number;
 }
-export type { ICollectionEntity, ICollectionFormObject, ICollectionIsValid, ICollectionQuery, ICollectionResponce, ICollectionRow, ICollectionRowsResponce, ICollectionsApi, };
+/**
+ * Query parameters for getICollections: pagination only — the collection list takes no entity filter.
+ * @typedef {object} ICollectionsListQuery
+ * @property {number} [limit] - Parameter for pagination. Default: 30.
+ * @property {number} [offset] - Parameter for pagination. Default: 0.
+ */
+type ICollectionsListQuery = Pick<ICollectionQuery, 'limit' | 'offset'>;
+export type { ICollectionEntity, ICollectionFormObject, ICollectionIsValid, ICollectionQuery, ICollectionResponce, ICollectionRow, ICollectionRowsResponce, ICollectionsApi, ICollectionsListQuery, };

package/dist/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/dist/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/dist/product-statuses/productStatusesApi.js

@@ -72,7 +72,7 @@ class ProductStatusesApi extends asyncModules_1.default {
     /**
      * 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
@@ -88,7 +88,7 @@ class ProductStatusesApi extends asyncModules_1.default {
     /**
      * 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/dist/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/dist/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;