oneentry 1.0.152 → 1.0.154

package/dist/pages/pagesApi.js

@@ -30,6 +30,7 @@ class PagesApi extends asyncModules_1.default {
      * @returns {Promise<IPagesEntity[] | IError>} Returns all created pages without parents as an array of PageEntity objects or an empty array [] (if there is no data)
      * @throws {IError} When isShell=false and an error occurs during the fetch
      * @description Get all top-level page objects.
+     * @see {@link https://js-sdk.oneentry.cloud/docs/pages/getRootPages getRootPages} documentation.
      */
     async getRootPages(langCode = this.state.lang) {
         // Fetch data from the server using a GET request to retrieve root pages for the specified language code
@@ -48,6 +49,7 @@ class PagesApi extends asyncModules_1.default {
      * @returns {Promise<IPagesEntity[] | IError>} Returns all created pages as an array of PageEntity objects or an empty array [] (if there is no data).
      * @throws {IError} When isShell=false and an error occurs during the fetch
      * @description Get all page objects with product information as an array.
+     * @see {@link https://js-sdk.oneentry.cloud/docs/pages/getPages getPages} documentation.
      */
     async getPages(langCode = this.state.lang) {
         // Fetch data from the server using a GET request to retrieve all pages for the specified language code
@@ -67,6 +69,7 @@ class PagesApi extends asyncModules_1.default {
      * @returns {Promise<IPagesEntity | IError>} Returns PageEntity object
      * @throws {IError} When isShell=false and an error occurs during the fetch
      * @description Get page object with information about forms, blocks, menus, linked to the page.
+     * @see {@link https://js-sdk.oneentry.cloud/docs/pages/getPageById getPageById} documentation.
      */
     async getPageById(id, langCode = this.state.lang) {
         // Fetch data from the server using a GET request to retrieve page details by ID and language code
@@ -86,6 +89,7 @@ class PagesApi extends asyncModules_1.default {
      * @returns {Promise<IPagesEntity | IError>} Returns PageEntity object
      * @throws {IError} When isShell=false and an error occurs during the fetch
      * @description Get page object with information about forms, blocks, menus, linked to the page by URL.
+     * @see {@link https://js-sdk.oneentry.cloud/docs/pages/getPageByUrl getPageByUrl} documentation.
      */
     async getPageByUrl(url, langCode = this.state.lang) {
         // Fetch data from the server using a GET request with the specified URL and language code
@@ -105,6 +109,7 @@ class PagesApi extends asyncModules_1.default {
      * @returns {Promise<IPagesEntity | IError>} Returns all created pages as an array of PageEntity objects or an empty array [] (if there is no data) for the selected parent
      * @throws {IError} When isShell=false and an error occurs during the fetch
      * @description Get child pages object with information as an array.
+     * @see {@link https://js-sdk.oneentry.cloud/docs/pages/getChildPagesByParentUrl getChildPagesByParentUrl} documentation.
      */
     async getChildPagesByParentUrl(url, langCode = this.state.lang) {
         // Fetch data from the server using a GET request to retrieve child pages for the specified parent URL and language code
@@ -124,66 +129,54 @@ class PagesApi extends asyncModules_1.default {
      * @returns {Promise<IPositionBlock[] | IError>} Returns all blocks as an array of PositionBlock objects or an empty array [] (if there is no data) for the selected parent
      * @throws {IError} When isShell=false and an error occurs during the fetch
      * @description Get all blocks by page url.
+     * @see {@link https://js-sdk.oneentry.cloud/docs/pages/getBlocksByPageUrl getBlocksByPageUrl} documentation.
      */
     async getBlocksByPageUrl(url, langCode = this.state.lang) {
         const response = await this._fetchGet(`/${url}/blocks?langCode=${langCode}`);
         // Normalize the fetched response data
         const normalizeResponse = this._normalizeData(response);
-        // Iterate over each item in the normalized response
-        normalizeResponse.map((item) => {
+        if (!Array.isArray(normalizeResponse)) {
+            return normalizeResponse;
+        }
+        // Helper module wrapping the block product endpoints (similar / products).
+        const staffModule = new StaffModule(this.state);
+        // Enrich every block in parallel: product / similar blocks
+        await Promise.all(normalizeResponse.map(async (item) => {
             const customSettings = item.customSettings;
-            // Check if customSettings contains 'productConfig' property
+            // Lift product display settings (stored as strings) to numeric top-level fields.
             if (customSettings &&
                 Object.prototype.hasOwnProperty.call(customSettings, 'productConfig')) {
-                // If 'countElementsPerRow' exists, set it on the item
                 if (customSettings.productConfig.countElementsPerRow)
                     item.countElementsPerRow =
                         +customSettings.productConfig.countElementsPerRow;
-                // If 'quantity' exists, set it on the item
                 if (customSettings.productConfig.quantity)
                     item.quantity = +customSettings.productConfig.quantity;
             }
-            // Remove unnecessary properties from the item
+            // Remove internal-only properties from the result.
             delete item.customSettings;
             delete item.attributesSetIdentifier;
-            // Return the modified item
-            return item;
-        });
-        // Check if traffic limit is not set
-        if (!this.state.traficLimit) {
-            // Create an instance of 'StaffModule' with the current state
-            const staffModule = new StaffModule(this.state);
-            // If the block type is 'similar_products_block', fetch similar products
-            if (normalizeResponse.type === 'similar_products_block') {
+            // In traffic-saving mode skip the extra product requests.
+            if (this.state.traficLimit)
+                return;
+            // Attach related products by block type. StaffModule already normalizes its results.
+            if (item.type === 'similar_products_block') {
                 try {
-                    await staffModule
-                        .getSimilarProducts(normalizeResponse.identifier, langCode)
-                        .then((result) => {
-                        normalizeResponse.similarProducts = this._normalizeData(result);
-                    });
+                    item.similarProducts = await staffModule.getSimilarProducts(item.identifier, langCode);
                 }
                 catch {
-                    // Handle errors by setting an empty array
-                    normalizeResponse.similarProducts = [];
+                    item.similarProducts = [];
                 }
-                // If the block type is 'product_block', fetch products
             }
-            else if (normalizeResponse.type === 'product_block') {
+            else if (item.type === 'product_block') {
                 try {
-                    await staffModule
-                        .getProductsByBlockMarker(normalizeResponse.identifier, langCode)
-                        .then((result) => {
-                        normalizeResponse.products = this._normalizeData(result);
-                    });
+                    item.products = await staffModule.getProductsByBlockMarker(item.identifier, langCode);
                 }
                 catch {
-                    // Handle errors by setting an empty array
-                    normalizeResponse.products = [];
+                    item.products = [];
                 }
             }
-        }
-        // Return the final normalized response
-        return this._normalizeData(normalizeResponse);
+        }));
+        return normalizeResponse;
     }
     /**
      * Get settings for the page.
@@ -192,6 +185,7 @@ class PagesApi extends asyncModules_1.default {
      * @returns {Promise<IPageConfig | IError>} Returns a ConfigPage object with page display settings
      * @throws {IError} When isShell=false and an error occurs during the fetch
      * @description Get settings for the page.
+     * @see {@link https://js-sdk.oneentry.cloud/docs/pages/getConfigPageByUrl getConfigPageByUrl} documentation.
      */
     async getConfigPageByUrl(url) {
         // Fetch data from the server using a GET request to retrieve forms for the specified page URL and language code
@@ -210,10 +204,12 @@ class PagesApi extends asyncModules_1.default {
      * @returns {Promise<IPagesEntity[] | IError>} Returns all created pages as an array of PageEntity objects or an empty array [] (if there is no data)
      * @throws {IError} When isShell=false and an error occurs during the fetch
      * @description Quick search for page objects with limited output.
+     * @see {@link https://js-sdk.oneentry.cloud/docs/pages/searchPage searchPage} documentation.
      */
     async searchPage(name, url, langCode = this.state.lang) {
         // Fetch data from the server using a GET request to perform a quick search by page name and language code
-        const data = await this._fetchGet(`/quick/search?${url && 'url=' + url}&lang=${langCode}&name=${name}`);
+        const urlPart = url ? `url=${encodeURIComponent(url)}&` : '';
+        const data = await this._fetchGet(`/quick/search?${urlPart}lang=${encodeURIComponent(langCode)}&name=${encodeURIComponent(name)}`);
         // /quick/search?url=catalog&langCode=en_US&name=cat
         // Check if there is no traffic limit set in the state
         if (!this.state.traficLimit && Array.isArray(data)) {
@@ -332,6 +328,7 @@ class PagesApi extends asyncModules_1.default {
      * @returns {Promise<any | IError>} An array of page objects with template data added
      * @throws {IError} When isShell=false and an error occurs during the fetch
      * @description Add template data to page by page templateIdentifier
+     * @see {@link https://js-sdk.oneentry.cloud/docs/pages/addTemplateToPage addTemplateToPage} documentation.
      */
     async addTemplateToPage(data) {
         // Check if 'templateIdentifier' exists in 'data' and is not null or an empty string
@@ -352,10 +349,8 @@ class PagesApi extends asyncModules_1.default {
                 };
             }
             catch (error) {
-                // Log any errors that occur during the template fetching process
                 // eslint-disable-next-line no-undef, no-console
                 console.error('Template fetch error: ', error);
-                // Return the original data object unchanged if an error occurs
                 return data;
             }
         }
@@ -375,11 +370,12 @@ class StaffModule extends asyncModules_1.default {
         super(state); // Call parent constructor
         this._url = state.url + '/api/content/blocks'; // Set URL for content blocks
     }
-    // Method to fetch similar products by marker
+    // Method to fetch similar products by marker. Returns the full response
+    // ({ total, items }) to match BlocksApi's similarProducts contract.
     async getSimilarProducts(marker, langCode = this.state.lang, offset = 0, limit = 30) {
         // Fetch similar products from the server
         const result = await this._fetchGet(`/${marker}/similar-products?langCode=${langCode}&offset=${offset}&limit=${limit}`);
-        return this._normalizeData(result.items);
+        return this._normalizeData(result);
     }
     // Method to fetch products by block marker
     async getProductsByBlockMarker(marker, langCode = this.state.lang, offset = 0, limit = 30) {

package/dist/pages/pagesInterfaces.d.ts

@@ -1,6 +1,7 @@
 import type { IAttributes, IAttributeValues, IError, ILocalizeInfo, IRating, LangType } from '../base/utils';
 import type { BlockType, IBlockEntity } from '../blocks/blocksInterfaces';
 import type { IFormConfig } from '../forms/formsInterfaces';
+import type { IProductsEntity, IProductsResponse } from '../products/productsInterfaces';
 import type { ITemplateEntity } from '../templates/templatesInterfaces';
 /**
  * @interface IPagesApi
@@ -185,6 +186,8 @@ interface IPositionForm {
     }
  * @property {number} [countElementsPerRow] - Number of elements displayed per row in the block, if applicable. Example: 3.
  * @property {number} [quantity] - Quantity pages in block. Example: 1.
+ * @property {IProductsResponse} [similarProducts] - Similar products response (total + items). Present only for "similar_products_block" blocks and only when traffic-saving mode is off.
+ * @property {IProductsEntity[]} [products] - Array of products associated with the block. Present only for "product_block" blocks and only when traffic-saving mode is off.
  * @description This interface defines the structure of a position block entity, including its identifiers, attributes, and visibility.
  */
 interface IPositionBlock {
@@ -201,6 +204,8 @@ interface IPositionBlock {
     attributeValues: IAttributeValues;
     countElementsPerRow?: number;
     quantity?: number;
+    similarProducts?: IProductsResponse;
+    products?: IProductsEntity[];
 }
 /**
  * PageType

package/dist/payments/paymentsApi.d.ts

@@ -25,6 +25,7 @@ export default class PaymentsApi extends AsyncModules implements IPaymentsApi {
      * @throws {IError} When isShell=false and an error occurs during the fetch
      * @description This method gets list of payment sessions. 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}.
+     * @see {@link https://js-sdk.oneentry.cloud/docs/payments/getSessions getSessions} documentation.
      */
     getSessions(offset?: number, limit?: number): Promise<ISessionsEntity | IError>;
     /**
@@ -35,6 +36,7 @@ export default class PaymentsApi extends AsyncModules implements IPaymentsApi {
      * @throws {IError} When isShell=false and an error occurs during the fetch
      * @description This method gets a single payment session object by its identifier. 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}.
+     * @see {@link https://js-sdk.oneentry.cloud/docs/payments/getSessionById getSessionById} documentation.
      */
     getSessionById(id: number): Promise<ISessionEntity | IError>;
     /**
@@ -45,6 +47,7 @@ export default class PaymentsApi extends AsyncModules implements IPaymentsApi {
      * @throws {IError} When isShell=false and an error occurs during the fetch
      * @description This method gets one payment session object by order identifier. 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}.
+     * @see {@link https://js-sdk.oneentry.cloud/docs/payments/getSessionByOrderId getSessionByOrderId} documentation.
      */
     getSessionByOrderId(id: number): Promise<ISessionEntity | ISessionEntity[] | IError>;
     /**
@@ -57,6 +60,7 @@ export default class PaymentsApi extends AsyncModules implements IPaymentsApi {
      * @throws {IError} When isShell=false and an error occurs during the fetch
      * @description This method creates a payment session. 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}.
+     * @see {@link https://js-sdk.oneentry.cloud/docs/payments/createSession createSession} documentation.
      */
     createSession(orderId: number, type: 'session' | 'intent', automaticTaxEnabled?: boolean): Promise<ISessionEntity | IError>;
     /**
@@ -66,6 +70,7 @@ export default class PaymentsApi extends AsyncModules implements IPaymentsApi {
      * @throws {IError} When isShell=false and an error occurs during the fetch
      * @description This method gets all payment accounts as an array. 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}.
+     * @see {@link https://js-sdk.oneentry.cloud/docs/payments/getAccounts getAccounts} documentation.
      */
     getAccounts(): Promise<IAccountsEntity[] | IError>;
     /**
@@ -77,6 +82,7 @@ export default class PaymentsApi extends AsyncModules implements IPaymentsApi {
      * @description Get a single payment account object by its identifier.
      * @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}.
+     * @see {@link https://js-sdk.oneentry.cloud/docs/payments/getAccountById getAccountById} documentation.
      */
     getAccountById(id: number): Promise<IAccountsEntity | IError>;
 }

package/dist/payments/paymentsApi.js

@@ -29,6 +29,7 @@ class PaymentsApi extends asyncModules_1.default {
      * @throws {IError} When isShell=false and an error occurs during the fetch
      * @description This method gets list of payment sessions. 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}.
+     * @see {@link https://js-sdk.oneentry.cloud/docs/payments/getSessions getSessions} documentation.
      */
     async getSessions(offset = 0, limit = 30) {
         const query = {
@@ -48,6 +49,7 @@ class PaymentsApi extends asyncModules_1.default {
      * @throws {IError} When isShell=false and an error occurs during the fetch
      * @description This method gets a single payment session object by its identifier. 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}.
+     * @see {@link https://js-sdk.oneentry.cloud/docs/payments/getSessionById getSessionById} documentation.
      */
     async getSessionById(id) {
         const result = await this._fetchGet(`/sessions/${id}`);
@@ -61,6 +63,7 @@ class PaymentsApi extends asyncModules_1.default {
      * @throws {IError} When isShell=false and an error occurs during the fetch
      * @description This method gets one payment session object by order identifier. 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}.
+     * @see {@link https://js-sdk.oneentry.cloud/docs/payments/getSessionByOrderId getSessionByOrderId} documentation.
      */
     async getSessionByOrderId(id) {
         const result = await this._fetchGet(`/sessions/order/${id}`);
@@ -78,6 +81,7 @@ class PaymentsApi extends asyncModules_1.default {
      * @throws {IError} When isShell=false and an error occurs during the fetch
      * @description This method creates a payment session. 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}.
+     * @see {@link https://js-sdk.oneentry.cloud/docs/payments/createSession createSession} documentation.
      */
     async createSession(orderId, type, automaticTaxEnabled = false) {
         const result = await this._fetchPost('/sessions', {
@@ -96,6 +100,7 @@ class PaymentsApi extends asyncModules_1.default {
      * @throws {IError} When isShell=false and an error occurs during the fetch
      * @description This method gets all payment accounts as an array. 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}.
+     * @see {@link https://js-sdk.oneentry.cloud/docs/payments/getAccounts getAccounts} documentation.
      */
     async getAccounts() {
         const result = await this._fetchGet('/accounts');
@@ -112,6 +117,7 @@ class PaymentsApi extends asyncModules_1.default {
      * @description Get a single payment account object by its identifier.
      * @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}.
+     * @see {@link https://js-sdk.oneentry.cloud/docs/payments/getAccountById getAccountById} documentation.
      */
     async getAccountById(id) {
         const result = await this._fetchGet(`/accounts/${id}`);

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

@@ -23,6 +23,7 @@ export default class ProductStatusesApi extends AsyncModules implements IProduct
      * @returns {Promise<IProductStatusEntity[] | IError>} Returns an array of product status objects.
      * @throws {IError} When isShell=false and an error occurs during the fetch
      * @description Search for all product status objects.
+     * @see {@link https://js-sdk.oneentry.cloud/docs/product-statuses/getProductStatuses getProductStatuses} documentation.
      */
     getProductStatuses(langCode?: string): Promise<IProductStatusEntity[] | IError>;
     /**
@@ -33,6 +34,7 @@ export default class ProductStatusesApi extends AsyncModules implements IProduct
      * @returns {Promise<IProductStatusEntity | IError>} Returns a product status object.
      * @throws {IError} When isShell=false and an error occurs during the fetch
      * @description Search for a product status object by its textual identifier (marker).
+     * @see {@link https://js-sdk.oneentry.cloud/docs/product-statuses/getProductsByStatusMarker getProductsByStatusMarker} documentation.
      */
     getProductsByStatusMarker(marker: string, langCode?: string): Promise<IProductStatusEntity | IError>;
     /**
@@ -42,6 +44,7 @@ export default class ProductStatusesApi extends AsyncModules implements IProduct
      * @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.
+     * @see {@link https://js-sdk.oneentry.cloud/docs/product-statuses/validateMarker validateMarker} documentation.
      */
     validateMarker(marker: string): Promise<boolean | IError>;
 }

package/dist/product-statuses/productStatusesApi.js

@@ -27,6 +27,7 @@ class ProductStatusesApi extends asyncModules_1.default {
      * @returns {Promise<IProductStatusEntity[] | IError>} Returns an array of product status objects.
      * @throws {IError} When isShell=false and an error occurs during the fetch
      * @description Search for all product status objects.
+     * @see {@link https://js-sdk.oneentry.cloud/docs/product-statuses/getProductStatuses getProductStatuses} documentation.
      */
     async getProductStatuses(langCode = this.state.lang) {
         const result = await this._fetchGet('');
@@ -42,6 +43,7 @@ class ProductStatusesApi extends asyncModules_1.default {
      * @returns {Promise<IProductStatusEntity | IError>} Returns a product status object.
      * @throws {IError} When isShell=false and an error occurs during the fetch
      * @description Search for a product status object by its textual identifier (marker).
+     * @see {@link https://js-sdk.oneentry.cloud/docs/product-statuses/getProductsByStatusMarker getProductsByStatusMarker} documentation.
      */
     async getProductsByStatusMarker(marker, langCode = this.state.lang) {
         const result = await this._fetchGet(`/marker/${marker}`);
@@ -56,6 +58,7 @@ class ProductStatusesApi extends asyncModules_1.default {
      * @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.
+     * @see {@link https://js-sdk.oneentry.cloud/docs/product-statuses/validateMarker validateMarker} documentation.
      */
     async validateMarker(marker) {
         const result = await this._fetchGet(`/marker-validation/${marker}`);