oneentry 1.0.171 → 1.0.173

package/changelog.md

@@ -1,5 +1,58 @@
 # 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
+
+- **`Orders.createOrder`, `Orders.updateOrderByMarkerAndId` and `FormData.postFormsData` no longer modify the body they are given.** All three wrapped `formData` into `{ [langCode]: [...] }` and wrote the result back into the caller's object (`body.formData = formData`) — the same class of defect 1.0.168 fixed in `_normalizePostBody`, in three methods that wrap on their own. A reused body (a retry, a shared template, form state passed by reference) was wrapped a second time: `createOrder` and `postFormsData` answered `400 formData's marker '#0' marker is required`, and `updateOrderByMarkerAndId` answered **`200` and stored the broken `formData` in the order**. The wrapped value now goes into a new body. `postFormsData` also processed file fields in place — it replaced the caller's `File` with the upload result, deleted `fileQuery` and stripped `contentType` from a descriptor passed through — and now works on copies of those fields too (CMS-1063, CMS-1071).
+
+- **`UserActivity.trackUserActivity` returned `true` for a refused event.** With `isShell` on — the default — the API error came back as a value nobody inspected, so a `400 type must be a valid enum value` read as "recorded"; with `isShell` off the thrown error was caught and returned, while the JSDoc promises a throw. The method now goes through `_fetchBoolean`: `true` on the `204`, the `IError` otherwise, thrown when `isShell` is off (CMS-1064).
+
+- **Methods built on `_fetchBoolean` threw nothing when `isShell` was off.** `Events.subscribeByMarker`, `unsubscribeByMarker`, `subscribeToForm`, `unsubscribeFromForm`, `Subscriptions.cancelSubscription` and `recoverSubscriptions` caught the error `browserResponse` throws in that mode and returned it, so a `try/catch` around them never fired and `if (result)` took the error object for success. The helper now rethrows when `isShell` is off, as every other method does. The JSDoc of `unsubscribeByMarker` said `Promise<any | IError>` and now matches the signature (CMS-1067).
+
+- **`Pages.searchPage` searched only the default language.** The method sent `lang=` where the endpoint reads `langCode`, and the endpoint treats an unknown parameter as no language at all. On a bilingual stand `searchPage('Блог', undefined, 'ru_RU')` came back empty, while `searchPage('Blog', undefined, 'ru_RU')` found the English titles and then loaded them in `ru_RU`: the pages missing in that locale answered `404`, and those errors were returned as elements of the `IPagesEntity[]` array. The parameter is `langCode` now, a found page that cannot be loaded is left out of the result, and the result keeps the order of the search instead of the order the requests finished in (CMS-1068).
+
+- **`FileUploading.delete` resolved to `{}` on success, not to the declared `boolean`.** The endpoint answers `200` with an empty body, which the parser reads as `{}`. The method now returns `true`, so `=== true` and `typeof result === 'boolean'` work as the type says (CMS-1072).
+
+### What's Changed
+
+- **`Products.getProductsEmptyPage` returns `IProductsResponse`.** It was declared as `IAggregatedProductGroup[]`, but the endpoint answers `{ items, total }` — the same container as `getProducts` — and the SDK never converted it, so `result.map(...)` compiled and failed at run time. The response is now validated with the same schema as `getProducts` when validation is on. `IAggregatedProductGroup` is kept for existing imports and marked deprecated: no method returns it (CMS-1065).
+
+- **`indexReady` is declared on all seven vector search responses.** The platform answers every `…/vector/search` with `indexReady`: `false` means the index for that entity and language is not built yet and empty `items` do not mean "nothing matched". The SDK passed the field through but no type declared it. The new `IVectorSearchResponse<T>` adds it to the module's own container, and `getUsersByVectorSearch`, `getProductsByVectorSearch`, `getPagesByVectorSearch`, `getOrdersByVectorSearch`, `getDiscountsByVectorSearch`, `getAdminsByVectorSearch` and `getFormsDataByVectorSearch` return it. It is assignable to the container they declared before, so existing code compiles unchanged (CMS-1074).
+
+- **Products query types follow what the endpoint accepts.** `IProductsQueryBase.sortKey` takes `'status'`, which the endpoint sorts by and the type refused; `IProductsRelatedQuery` declares `relationMode: 'global' | 'local'` of `GET /products/{id}/related`; the JSDoc example of `IFilterParams.conditionMarker` was `"equals"`, which answers `400 filter.0.conditionMarker must be a valid enum value`, and is `"eq"` now (CMS-1066).
+
+- **`BlockType` no longer includes `'none'`.** The platform has no such type — `GET /general-types` does not return it — and a filter by it answers `400 type must be a valid enum value`. The `general-types` response schema drops it as well. The JSDoc of `getBlocks` listed 12 of the types and lists all 22 now. `'service'` stays: it is the platform's own name for the type, and the `400` the `type` filter of `getBlocks` and `getTemplateByType` currently gives it is a platform defect, reported as CMS-1073 (CMS-1062).
+
+### Tests
+
+- **`src/base/tests/callercontracts.spec.ts` pins these contracts** with a stubbed `fetch`, no stand required: a reused order and form body sent identically twice and left untouched, a file descriptor passed through without losing `contentType` on the caller's side, `trackUserActivity` on `204` / `400` with `isShell` on and off, `subscribeByMarker` throwing when `isShell` is off, `searchPage` sending `langCode` and dropping a page it could not load, and `FileUploading.delete` returning `true`. Against 1.0.171 ten of its thirteen cases fail.
+
 ## v.1.0.171
 
 ### What's Fixed

package/dist/admins/adminsApi.d.ts

@@ -1,6 +1,6 @@
 import AsyncModules from '../base/asyncModules';
 import type StateModule from '../base/stateModule';
-import type { IError } from '../base/utils';
+import type { IError, IVectorSearchResponse } from '../base/utils';
 import type { IFilterParams } from '../products/productsInterfaces';
 import type { IAdminEntity, IAdmins, IAdminsResponse, IAdminsVectorSearch } from './adminsInterfaces';
 /**
@@ -57,10 +57,10 @@ export default class AdminsApi extends AsyncModules implements IAdmins {
      * @param {string} [langCode] - Language code. Default: "en_US".
      * @param {number} [offset] - Parameter for pagination. Default: 0.
      * @param {number} [limit] - Parameter for pagination. Default: 30.
-     * @returns {Promise<IAdminsResponse | IError>} Returns an object with an array of found admins and total count.
+     * @returns {Promise<IVectorSearchResponse<IAdminsResponse> | IError>} Returns an object with an array of found admins and total count.
      * @throws {IError} When isShell=false and an error occurs during the fetch
      * @description This method performs a semantic (vector) search for admins.
      * @see {@link https://js-sdk.oneentry.cloud/docs/admins/getAdminsByVectorSearch getAdminsByVectorSearch} documentation.
      */
-    getAdminsByVectorSearch(body: IAdminsVectorSearch, langCode?: string, offset?: number, limit?: number): Promise<IAdminsResponse | IError>;
+    getAdminsByVectorSearch(body: IAdminsVectorSearch, langCode?: string, offset?: number, limit?: number): Promise<IVectorSearchResponse<IAdminsResponse> | IError>;
 }

package/dist/admins/adminsApi.js

@@ -104,7 +104,7 @@ class AdminsApi extends asyncModules_1.default {
      * @param {string} [langCode] - Language code. Default: "en_US".
      * @param {number} [offset] - Parameter for pagination. Default: 0.
      * @param {number} [limit] - Parameter for pagination. Default: 30.
-     * @returns {Promise<IAdminsResponse | IError>} Returns an object with an array of found admins and total count.
+     * @returns {Promise<IVectorSearchResponse<IAdminsResponse> | IError>} Returns an object with an array of found admins and total count.
      * @throws {IError} When isShell=false and an error occurs during the fetch
      * @description This method performs a semantic (vector) search for admins.
      * @see {@link https://js-sdk.oneentry.cloud/docs/admins/getAdminsByVectorSearch getAdminsByVectorSearch} documentation.

package/dist/admins/adminsInterfaces.d.ts

@@ -1,4 +1,4 @@
-import type { IAttributeValues, IError } from '../base/utils';
+import type { IAttributeValues, IError, IVectorSearchResponse } from '../base/utils';
 import type { IFormConfig } from '../forms/formsInterfaces';
 import type { IFilterParams } from '../products/productsInterfaces';
 /**
@@ -40,10 +40,10 @@ interface IAdmins {
      * @param {string} [langCode] - Language code. Default: "en_US".
      * @param {number} [offset] - Parameter for pagination. Default: 0.
      * @param {number} [limit] - Parameter for pagination. Default: 30.
-     * @returns {IAdminsResponse} Returns an object with an array of found admins and total count.
+     * @returns {IVectorSearchResponse<IAdminsResponse>} Returns an object with an array of found admins, total count and indexReady.
      * @throws {IError} - If there is an error during the fetch operation, it will return an error object.
      */
-    getAdminsByVectorSearch(body: IAdminsVectorSearch, langCode?: string, offset?: number, limit?: number): Promise<IAdminsResponse | IError>;
+    getAdminsByVectorSearch(body: IAdminsVectorSearch, langCode?: string, offset?: number, limit?: number): Promise<IVectorSearchResponse<IAdminsResponse> | IError>;
 }
 /**
  * Body for semantic (vector) admin search.

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/asyncModules.d.ts

@@ -79,8 +79,13 @@ export default abstract class AsyncModules extends SyncModules {
      * (the default) browserResponse returns the API error instead of throwing
      * it, so relying on the catch alone would report every failed call — a 404
      * from cancelSubscription, a 403 from recoverSubscriptions — as a success.
+     *
+     * With `isShell` disabled browserResponse throws, and the error is thrown on
+     * from here too: returning it would break the `@throws` contract every caller
+     * documents, and a `try/catch` around the call would never fire (CMS-1067).
      * @param {() => Promise<unknown>} request - Thunk performing the fetch call.
-     * @returns {Promise<boolean | IError>} `true` on success, IError on failure.
+     * @returns {Promise<boolean | IError>} `true` on success, IError on failure when isShell=true.
+     * @throws {IError} When isShell=false and the request fails.
      */
     protected _fetchBoolean(request: () => Promise<unknown>): Promise<boolean | IError>;
     /**

package/dist/base/asyncModules.js

@@ -168,8 +168,13 @@ class AsyncModules extends syncModules_1.default {
      * (the default) browserResponse returns the API error instead of throwing
      * it, so relying on the catch alone would report every failed call — a 404
      * from cancelSubscription, a 403 from recoverSubscriptions — as a success.
+     *
+     * With `isShell` disabled browserResponse throws, and the error is thrown on
+     * from here too: returning it would break the `@throws` contract every caller
+     * documents, and a `try/catch` around the call would never fire (CMS-1067).
      * @param {() => Promise<unknown>} request - Thunk performing the fetch call.
-     * @returns {Promise<boolean | IError>} `true` on success, IError on failure.
+     * @returns {Promise<boolean | IError>} `true` on success, IError on failure when isShell=true.
+     * @throws {IError} When isShell=false and the request fails.
      */
     async _fetchBoolean(request) {
         try {
@@ -180,6 +185,9 @@ class AsyncModules extends syncModules_1.default {
             return true;
         }
         catch (e) {
+            if (!this.state.isShell) {
+                throw e;
+            }
             return e;
         }
     }

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
@@ -439,6 +439,16 @@ interface IHttpOptions {
     headers: IHttpHeaders;
     body?: string | FormData | Blob;
 }
+/**
+ * Response of a semantic (vector) search: the module's own list container plus `indexReady`.
+ * @typedef {object} IVectorSearchResponse
+ * @template T
+ * @property {boolean} indexReady - `false` when no vectors are built yet for this entity and language: the query was not embedded, and empty `items` do not mean "nothing matched". `true` — an honest search result.
+ * @description Every `…/vector/search` endpoint answers with `indexReady` next to its list (CMS-1074).
+ */
+type IVectorSearchResponse<T> = T & {
+    indexReady: boolean;
+};
 /**
  * LangType
  */
@@ -447,4 +457,4 @@ type LangType = string | Array<string>;
  * LocalizeType
  */
 type LocalizeType = ILocalizeInfo;
-export type { IAttributeFile, IAttributeLocalizeInfo, IAttributes, IAttributeValue, IAttributeValues, IConfig, IError, IFileAttributeValue, IHttpHeaders, IHttpOptions, IListAttributeValue, ILocalizeInfo, INumberAttributeValue, IRating, IStringAttributeValue, ITimeIntervalAttributeValue, ITimeIntervalEntitySchedule, ITimeIntervalGroup, ITimeIntervalPoint, ITimeIntervalRange, ITimeIntervalSchedule, ITimeIntervalWindow, ITypedAttributeValue, LangType, LocalizeType, TimeIntervalPair, };
+export type { IAttributeFile, IAttributeLocalizeInfo, IAttributes, IAttributeValue, IAttributeValues, IConfig, IError, IFileAttributeValue, IHttpHeaders, IHttpOptions, IListAttributeValue, ILocalizeInfo, INumberAttributeValue, IRating, IStringAttributeValue, ITimeIntervalAttributeValue, ITimeIntervalEntitySchedule, ITimeIntervalGroup, ITimeIntervalPoint, ITimeIntervalRange, ITimeIntervalSchedule, ITimeIntervalWindow, ITypedAttributeValue, IVectorSearchResponse, LangType, LocalizeType, TimeIntervalPair, };

package/dist/blocks/blocksApi.d.ts

@@ -21,7 +21,7 @@ export default class BlocksApi extends AsyncModules implements IBlocks {
     /**
      * Get blocks by parameters.
      * @handleName getBlocks
-     * @param {BlockType} [type] - Optional block type to filter by. Available values: "product" | "error_page" | "catalog_page" | "product_preview" | "similar_products_block" | "product_block" | "form" | "common_page" | "common_block" | "order" | "service" | "none". When omitted, blocks of all types are returned. Example: 'product'.
+     * @param {BlockType} [type] - Optional block type to filter by. Available values: "product" | "error_page" | "catalog_page" | "product_preview" | "similar_products_block" | "product_block" | "frequently_ordered_block" | "trending_block" | "recently_viewed_block" | "repeat_purchase_block" | "slider_block" | "personal_recommendations_block" | "cart_complement_block" | "cart_similar_block" | "wishlist_similar_block" | "form" | "common_page" | "common_block" | "order" | "service" | "external_page" | "discount" (see BlockType). When omitted, blocks of all types are returned. Example: 'product'.
      * @param {string} [langCode] - Language code. Default: "en_US".
      * @param {number} [offset] - Parameter for pagination. Default: 0.
      * @param {number} [limit] - Parameter for pagination. Default: 30.

package/dist/blocks/blocksApi.js

@@ -60,7 +60,7 @@ class BlocksApi extends asyncModules_1.default {
     /**
      * Get blocks by parameters.
      * @handleName getBlocks
-     * @param {BlockType} [type] - Optional block type to filter by. Available values: "product" | "error_page" | "catalog_page" | "product_preview" | "similar_products_block" | "product_block" | "form" | "common_page" | "common_block" | "order" | "service" | "none". When omitted, blocks of all types are returned. Example: 'product'.
+     * @param {BlockType} [type] - Optional block type to filter by. Available values: "product" | "error_page" | "catalog_page" | "product_preview" | "similar_products_block" | "product_block" | "frequently_ordered_block" | "trending_block" | "recently_viewed_block" | "repeat_purchase_block" | "slider_block" | "personal_recommendations_block" | "cart_complement_block" | "cart_similar_block" | "wishlist_similar_block" | "form" | "common_page" | "common_block" | "order" | "service" | "external_page" | "discount" (see BlockType). When omitted, blocks of all types are returned. Example: 'product'.
      * @param {string} [langCode] - Language code. Default: "en_US".
      * @param {number} [offset] - Parameter for pagination. Default: 0.
      * @param {number} [limit] - Parameter for pagination. Default: 30.

package/dist/blocks/blocksInterfaces.d.ts

@@ -309,9 +309,11 @@ interface ISearchBlock {
 /**
  * BlockType
  * @type {BlockType}
- * @description This type defines the possible values for block types used in the system.
+ * @description This type defines the possible values for block types used in the system: the types `GET /api/content/general-types` returns.
+ * `'none'` was dropped — the platform has no such type and a filter by it answers `400 type must be a valid enum value` (CMS-1062).
+ * `'service'` is the platform's own name for the type, but the `type` filter of getBlocks and getTemplateByType currently refuses it with the same `400`; that is a platform defect (CMS-1073).
  */
-type BlockType = 'product' | 'error_page' | 'catalog_page' | 'product_preview' | 'similar_products_block' | 'product_block' | 'frequently_ordered_block' | 'trending_block' | 'recently_viewed_block' | 'repeat_purchase_block' | 'slider_block' | 'personal_recommendations_block' | 'cart_complement_block' | 'cart_similar_block' | 'wishlist_similar_block' | 'form' | 'common_page' | 'common_block' | 'order' | 'service' | 'external_page' | 'discount' | 'none';
+type BlockType = 'product' | 'error_page' | 'catalog_page' | 'product_preview' | 'similar_products_block' | 'product_block' | 'frequently_ordered_block' | 'trending_block' | 'recently_viewed_block' | 'repeat_purchase_block' | 'slider_block' | 'personal_recommendations_block' | 'cart_complement_block' | 'cart_similar_block' | 'wishlist_similar_block' | 'form' | 'common_page' | 'common_block' | 'order' | 'service' | 'external_page' | 'discount';
 /**
  * Lookup body for block product endpoints by explicit productIds.
  * @interface IBlockProductsLookup

package/dist/discounts/discountsApi.d.ts

@@ -1,6 +1,6 @@
 import AsyncModules from '../base/asyncModules';
 import type StateModule from '../base/stateModule';
-import type { IError } from '../base/utils';
+import type { IError, IVectorSearchResponse } from '../base/utils';
 import type { IBonusBalanceEntity, IBonusHistoryResponse, IBonusTransactionType, ICouponValidationResult, IDiscountsApi, IDiscountsEntity, IDiscountsResponse, IDiscountsVectorSearch, IDiscountType } from './discountsInterfaces';
 /**
  * Controllers for working with events
@@ -85,10 +85,10 @@ export default class DiscountsApi extends AsyncModules implements IDiscountsApi
      * @param {string} [langCode] - Language code. Default: "en_US".
      * @param {number} [offset] - Parameter for pagination. Default: 0.
      * @param {number} [limit] - Parameter for pagination. Default: 30.
-     * @returns {Promise<IDiscountsResponse | IError>} Returns an object with an array of found discounts and total count.
+     * @returns {Promise<IVectorSearchResponse<IDiscountsResponse> | IError>} Returns an object with an array of found discounts and total count.
      * @throws {IError} When isShell=false and an error occurs during the fetch
      * @description This method performs a semantic (vector) search for discounts.
      * @see {@link https://js-sdk.oneentry.cloud/docs/discounts/getDiscountsByVectorSearch getDiscountsByVectorSearch} documentation.
      */
-    getDiscountsByVectorSearch(body: IDiscountsVectorSearch, langCode?: string, offset?: number, limit?: number): Promise<IDiscountsResponse | IError>;
+    getDiscountsByVectorSearch(body: IDiscountsVectorSearch, langCode?: string, offset?: number, limit?: number): Promise<IVectorSearchResponse<IDiscountsResponse> | IError>;
 }

package/dist/discounts/discountsApi.js

@@ -124,7 +124,7 @@ class DiscountsApi extends asyncModules_1.default {
      * @param {string} [langCode] - Language code. Default: "en_US".
      * @param {number} [offset] - Parameter for pagination. Default: 0.
      * @param {number} [limit] - Parameter for pagination. Default: 30.
-     * @returns {Promise<IDiscountsResponse | IError>} Returns an object with an array of found discounts and total count.
+     * @returns {Promise<IVectorSearchResponse<IDiscountsResponse> | IError>} Returns an object with an array of found discounts and total count.
      * @throws {IError} When isShell=false and an error occurs during the fetch
      * @description This method performs a semantic (vector) search for discounts.
      * @see {@link https://js-sdk.oneentry.cloud/docs/discounts/getDiscountsByVectorSearch getDiscountsByVectorSearch} documentation.

package/dist/discounts/discountsInterfaces.d.ts

@@ -1,4 +1,4 @@
-import type { IAttributeValues, IError, ILocalizeInfo } from '../base/utils';
+import type { IAttributeValues, IError, ILocalizeInfo, IVectorSearchResponse } from '../base/utils';
 /**
  * Discount type.
  */
@@ -66,10 +66,10 @@ interface IDiscountsApi {
      * @param {string} [langCode] - Language code. Default: "en_US".
      * @param {number} [offset] - Parameter for pagination. Default: 0.
      * @param {number} [limit] - Parameter for pagination. Default: 30.
-     * @returns {Promise<IDiscountsResponse | IError>} Returns an object with an array of found discounts and total count.
+     * @returns {Promise<IVectorSearchResponse<IDiscountsResponse> | IError>} Returns an object with an array of found discounts and total count.
      * @throws {IError} When isShell=false and an error occurs during the fetch
      */
-    getDiscountsByVectorSearch(body: IDiscountsVectorSearch, langCode?: string, offset?: number, limit?: number): Promise<IDiscountsResponse | IError>;
+    getDiscountsByVectorSearch(body: IDiscountsVectorSearch, langCode?: string, offset?: number, limit?: number): Promise<IVectorSearchResponse<IDiscountsResponse> | IError>;
 }
 /**
  * Body for semantic (vector) discount search.

package/dist/events/eventsApi.d.ts

@@ -53,7 +53,7 @@ export default class EventsApi extends AsyncModules implements IEvents {
      * @param {string} marker - The marker of the event to unsubscribe from. Example: "product_price_change".
      * @param {number} productId - The ID of the product to unsubscribe from. Example: 12345.
      * @param {string} [langCode] - Language code. Default: "en_US".
-     * @returns {Promise<any | IError>} - Returns a promise that resolves to the result of the unsubscription operation or an error object if there was an issue.
+     * @returns {Promise<boolean | IError>} - Returns true if the unsubscription succeeded, or an error object if there was an issue.
      * @throws {IError} When isShell=false and an error occurs during the fetch
      * @description This method requires user authorization.
      * @see For more information about configuring the {@link https://js-sdk.oneentry.cloud/docs/category/authprovider authorization module}, see the documentation in the  {@link https://js-sdk.oneentry.cloud/docs/category/authprovider configuration settings section of the SDK}.

package/dist/events/eventsApi.js

@@ -3,7 +3,6 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-/* eslint-disable jsdoc/reject-any-type */
 /* eslint-disable @typescript-eslint/no-explicit-any */
 const asyncModules_1 = __importDefault(require("../base/asyncModules"));
 /**
@@ -71,7 +70,7 @@ class EventsApi extends asyncModules_1.default {
      * @param {string} marker - The marker of the event to unsubscribe from. Example: "product_price_change".
      * @param {number} productId - The ID of the product to unsubscribe from. Example: 12345.
      * @param {string} [langCode] - Language code. Default: "en_US".
-     * @returns {Promise<any | IError>} - Returns a promise that resolves to the result of the unsubscription operation or an error object if there was an issue.
+     * @returns {Promise<boolean | IError>} - Returns true if the unsubscription succeeded, or an error object if there was an issue.
      * @throws {IError} When isShell=false and an error occurs during the fetch
      * @description This method requires user authorization.
      * @see For more information about configuring the {@link https://js-sdk.oneentry.cloud/docs/category/authprovider authorization module}, see the documentation in the  {@link https://js-sdk.oneentry.cloud/docs/category/authprovider configuration settings section of the SDK}.

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 the result of the deletion operation or an error object if there was an issue.
+     * @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,18 +109,19 @@ 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 the result of the deletion operation or an error object if there was an issue.
+     * @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.
      */
     async delete(filename, fileQuery) {
         const query = { ...this._defaultQuery, ...fileQuery };
-        const result = await this._fetchDelete(`?filename=${filename}&` + this._queryParamsToString(query));
-        return result;
+        // The endpoint answers 200 with an empty body, which _parseJson reads as `{}`;
+        // _fetchBoolean turns that into the declared `true` (CMS-1072)
+        return this._fetchBoolean(() => this._fetchDelete(`?filename=${filename}&` + this._queryParamsToString(query)));
     }
     /**
      * Public search across the content of files attached to records.

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 the result of the deletion operation or an error object if there was an issue.
+     * @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/forms-data/formsDataApi.d.ts

@@ -1,6 +1,6 @@
 import AsyncModules from '../base/asyncModules';
 import type StateModule from '../base/stateModule';
-import type { IError } from '../base/utils';
+import type { IError, IVectorSearchResponse } from '../base/utils';
 import type { IBodyPostFormData, IFormsByMarkerDataEntity, IFormsData, IFormsDataFilter, IFormsDataSearchResponse, IFormsDataVectorSearch, IPostFormResponse, IUpdateFormsData } from './formsDataInterfaces';
 /**
  * Controllers for working with form data
@@ -76,7 +76,7 @@ export default class FormsDataApi extends AsyncModules implements IFormsData {
     /**
      * Removes `contentType` from a file value, which the endpoint does not accept.
      * @param {T} value - Value of a `file` / `image` / `groupOfImages` field, after the uploads.
-     * @returns {T} The same value, without `contentType`.
+     * @returns {T} The value without `contentType`; entries that carried it are copies, the caller's objects are not modified.
      * @description `FileUploading.upload` returns `contentType` and form data rejects it,
      * so it is stripped from an array of values and from a lone value object alike. A value
      * of any other shape is returned untouched and the endpoint names the field it cannot
@@ -166,10 +166,10 @@ export default class FormsDataApi extends AsyncModules implements IFormsData {
      * @param {string} [langCode] - Language code. Default: "en_US".
      * @param {number} [offset] - Parameter for pagination. Default: 0.
      * @param {number} [limit] - Parameter for pagination. Default: 30.
-     * @returns {Promise<IFormsDataSearchResponse | IError>} Returns an object with an array of found form data records and total count.
+     * @returns {Promise<IVectorSearchResponse<IFormsDataSearchResponse> | IError>} Returns an object with an array of found form data records and total count.
      * @throws {IError} When isShell=false and an error occurs during the fetch
      * @description This method performs a semantic (vector) search for form data.
      * @see {@link https://js-sdk.oneentry.cloud/docs/forms-data/getFormsDataByVectorSearch getFormsDataByVectorSearch} documentation.
      */
-    getFormsDataByVectorSearch(body: IFormsDataVectorSearch, langCode?: string, offset?: number, limit?: number): Promise<IFormsDataSearchResponse | IError>;
+    getFormsDataByVectorSearch(body: IFormsDataVectorSearch, langCode?: string, offset?: number, limit?: number): Promise<IVectorSearchResponse<IFormsDataSearchResponse> | IError>;
 }