oneentry 1.0.122 → 1.0.124

package/dist/pages/pagesApi.js

@@ -18,107 +18,167 @@ class PageApi extends asyncModules_1.default {
     /**
      * Get all top-level page objects.
      *
-     * @param {string} [langCode] - lang code
+     * @handleName getRootPages
      *
-     * @returns Returns all created pages without parents as an array of PageEntity objects or an empty array [] (if there is no data)
+     * @param {string} [langCode] - Language code. Default: "en_US".
+     *
+     * @return {IPagesEntity[]} Returns all created pages without parents as an array of PageEntity objects or an empty array [] (if there is no data)
+     * @throws {IError} - If there is an error during the fetch operation, it will return an error object.
+     *
+     * @description
      */
     async getRootPages(langCode = this.state.lang) {
+        // Fetch data from the server using a GET request to retrieve root pages for the specified language code
         const data = await this._fetchGet(`/root?langCode=${langCode}`);
-        const result = await this.addTemplateToPages(data);
-        return this._normalizeData(result, langCode);
+        // Add template information to each page in the fetched root pages data
+        const withTemplate = await this.addTemplateToPages(data);
+        // Normalize the data and return it; ensures consistent structure or handles errors
+        return this._normalizeData(withTemplate, langCode);
     }
     /**
      * Get all page objects with product information as an array.
      *
-     * @param {string} [langCode] - lang code
+     * @handleName getPages
+     *
+     * @param {string} [langCode] - Language code. Default: "en_US".
+     *
+     * @return {IPagesEntity[]} Returns all created pages as an array of PageEntity objects or an empty array [] (if there is no data).
+     * @throws {IError} - If there is an error during the fetch operation, it will return an error object.
      *
-     * @returns Returns all created pages as an array of PageEntity objects or an empty array [] (if there is no data)
+     * @description Get all page objects with product information as an array.
      */
     async getPages(langCode = this.state.lang) {
+        // Fetch data from the server using a GET request to retrieve all pages for the specified language code
         const data = await this._fetchGet(`?langCode=${langCode}`);
-        const result = await this.addTemplateToPages(data);
-        return this._normalizeData(result, langCode);
+        // Add template information to each page in the fetched data
+        const withTemplate = await this.addTemplateToPages(data);
+        // Normalize the data and return it; ensures consistent structure or handles errors
+        return this._normalizeData(withTemplate, langCode);
     }
     /**
      * Get page object with information about forms, blocks, menus, linked to the page.
      *
-     * @param {number} [id] - Page object identifier
-     * @param {string} [langCode] - lang code
+     * @handleName getPageById
      *
-     * @returns Returns PageEntity object
+     * @param {number} id - The unique identifier of the page to be fetched. Example: 1.
+     * @param {string} [langCode] - Language code. Default: "en_US".
+     *
+     * @return {IPagesEntity} Returns PageEntity object
+     * @throws {IError} - If there is an error during the fetch operation, it will return an error object.
+     *
+     * @description Get page object with information about forms, blocks, menus, linked to the page.
      */
     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
         const data = await this._fetchGet(`/${id}?langCode=${langCode}`);
-        const result = await this.addTemplateToPage(data);
-        return this._normalizeData(result, langCode);
+        // Add template information to the fetched page data
+        const withTemplate = await this.addTemplateToPage(data);
+        // Normalize the data and return it; ensures consistent structure or handles errors
+        return this._normalizeData(withTemplate, langCode);
     }
     /**
      * Get page object with information about forms, blocks, menus, linked to the page by URL.
      *
-     * @param {string} [url] - Page URL
-     * @param {string} [langCode] - lang code
+     * @handleName getPageByUrl
+     *
+     * @param {string} url - Page URL. Example: "about".
+     * @param {string} [langCode] - Language code. Default: "en_US".
      *
-     * @returns Returns PageEntity object
+     * @return {IPagesEntity} Returns PageEntity object
+     * @throws {IError} - If there is an error during the fetch operation, it will return an error object.
+     *
+     * @description Get page object with information about forms, blocks, menus, linked to the page by URL.
      */
     async getPageByUrl(url, langCode = this.state.lang) {
+        // Fetch data from the server using a GET request with the specified URL and language code
         const data = await this._fetchGet(`/url/${url}?langCode=${langCode}`);
-        const result = await this.addTemplateToPage(data);
-        return this._normalizeData(result, langCode);
+        // Add template information to the fetched page data
+        const withTemplate = await this.addTemplateToPage(data);
+        // Normalize the result data and return it; ensures consistent structure or handles errors
+        return this._normalizeData(withTemplate, langCode);
     }
     /**
      * Get child pages object with information as an array.
      *
-     * @param {string} [url] - Parent page URL
-     * @param {string} [langCode] - Required parameter lang code
+     * @handleName getChildPagesByParentUrl
+     *
+     * @param {string} url - The URL of the parent page for which child pages are to be fetched. Example: "about/our-team".
+     * @param {string} [langCode] - Language code. Default: "en_US".
      *
-     * @returns Returns all created pages as an array of PageEntity objects or an empty array [] (if there is no data) for the selected parent
+     * @return {IPagesEntity} 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} - If there is an error during the fetch operation, it will return an error object.
+     *
+     * @description Get child pages object with information as an array.
      */
     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
         const data = await this._fetchGet(`/${url}/children?langCode=${langCode}`);
-        const result = await this.addTemplateToPages(data);
-        return this._normalizeData(result, langCode);
+        // Add template information to each of the fetched child pages
+        const withTemplate = await this.addTemplateToPages(data);
+        // Normalize the result data and return it; ensures consistent structure or handles errors
+        return this._normalizeData(withTemplate, langCode);
     }
     /**
      * Get all blocks by page url.
      *
-     * @param {string} [url] - Page URL
-     * @param {string} [langCode] - lang code
+     * @handleName getBlocksByPageUrl
+     *
+     * @param {string} url - Page URL. Example: "about".
+     * @param {string} [langCode] - Language code. Default: "en_US".
      *
-     * @returns Returns all blocks as an array of PositionBlock objects or an empty array [] (if there is no data) for the selected parent
+     * @return {IPositionBlock[]} Returns all blocks as an array of PositionBlock objects or an empty array [] (if there is no data) for the selected parent
+     * @throws {IError} - If there is an error during the fetch operation, it will return an error object.
+     *
+     * @description Get all blocks by page url.
      */
     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) => {
             const customSettings = item.customSettings;
+            // Check if customSettings contains 'productConfig' property
             // eslint-disable-next-line no-prototype-builtins
             if (customSettings && customSettings.hasOwnProperty('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
             delete item.customSettings;
             delete item.attributesSetIdentifier;
+            // Return the modified item
             return item;
         });
+        // Check if traffic limit is not set
         if (!this.state.traficLimit) {
+            // Define a class 'StaffModule' extending 'AsyncModules'
             class StaffModule extends asyncModules_1.default {
                 constructor(state) {
-                    super(state);
-                    this._url = state.url + '/api/content/blocks';
+                    super(state); // Call parent constructor
+                    this._url = state.url + '/api/content/blocks'; // Set URL for content blocks
                 }
+                // Method to fetch similar products by marker
                 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);
                 }
+                // Method to fetch products by block marker
                 async getProductsByBlockMarker(marker, langCode = this.state.lang, offset = 0, limit = 30) {
+                    // Fetch products from the server
                     const result = await this._fetchGet(`/${marker}/products?langCode=${langCode}&offset=${offset}&limit=${limit}`);
                     return this._normalizeData(result.items);
                 }
             }
+            // 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') {
                 try {
                     await staffModule
@@ -128,8 +188,10 @@ class PageApi extends asyncModules_1.default {
                     });
                 }
                 catch {
+                    // Handle errors by setting an empty array
                     normalizeResponse.similarProducts = [];
                 }
+                // If the block type is 'product_block', fetch products
             }
             else if (normalizeResponse.type === 'product_block') {
                 try {
@@ -140,86 +202,148 @@ class PageApi extends asyncModules_1.default {
                     });
                 }
                 catch {
+                    // Handle errors by setting an empty array
                     normalizeResponse.products = [];
                 }
             }
         }
+        // Return the final normalized response
         return this._normalizeData(normalizeResponse);
     }
     /**
      * Get all forms by page url.
      *
-     * @param {string} [url] - Page URL
-     * @param {string} [langCode] - lang code
+     * @handleName getFormsByPageUrl
+     *
+     * @param {string} url - The URL of the page for which forms are to be fetched. Example: "about".
+     * @param {string} [langCode] - Language code. Default: "en_US".
+     *
+     * @return {IPositionForm[]} Returns all forms as an array of PositionForm objects or an empty array [] (if there is no data) for the selected parent
+     * @throws {IError} - If there is an error during the fetch operation, it will return an error object.
      *
-     * @returns Returns all forms as an array of PositionForm objects or an empty array [] (if there is no data) for the selected parent
+     * @description Get all forms by page url.
      */
     async getFormsByPageUrl(url, langCode = this.state.lang) {
-        const result = await this._fetchGet(`/${url}/forms?langCode=${langCode}`);
-        return this._normalizeData(result, langCode);
+        // Fetch data from the server using a GET request to retrieve forms for the specified page URL and language code
+        const withTemplate = await this._fetchGet(`/${url}/forms?langCode=${langCode}`);
+        // Normalize the fetched result data and return it; ensures consistent structure or handles errors
+        return this._normalizeData(withTemplate, langCode);
     }
     /**
      * Get settings for the page.
      *
-     * @param {string} [url] - Page URL
+     * @handleName getConfigPageByUrl
      *
-     * @returns Returns a ConfigPage object with page display settings
+     * @param {string} url - Page URL. Example: "about".
+     *
+     * @return {IPageConfig} Returns a ConfigPage object with page display settings
+     * @throws {IError} - If there is an error during the fetch operation, it will return an error object.
+     *
+     * @description Get settings for the page.
      */
     async getConfigPageByUrl(url) {
+        // Fetch data from the server using a GET request to retrieve forms for the specified page URL and language code
         const result = await this._fetchGet(`/${url}/config`);
+        // return fetched data
         return result;
     }
     /**
      * Quick search for page objects with limited output.
      *
-     * @param {string} [name] - Text for searching page objects (search is performed on the title field of the localizeInfos object with the language taken into account)
-     * @param {string} [langCode] - lang code
+     * @handleName searchPage
+     *
+     * @param {string} name - Text for searching page objects (search is performed on the title field of the localizeInfos object with the language taken into account). Example: "About Us".
+     * @param {string} [langCode] - Language code. Default: "en_US".
+     *
+     * @return {IPagesEntity[]} Returns all created pages as an array of PageEntity objects or an empty array [] (if there is no data)
+     * @throws {IError} - If there is an error during the fetch operation, it will return an error object.
      *
-     * @returns Returns all created pages as an array of PageEntity objects or an empty array [] (if there is no data)
+     * @description Quick search for page objects with limited output.
      */
     async searchPage(name, 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?lang=${langCode}&name=${name}`);
+        // Check if there is no traffic limit set in the state
         if (!this.state.traficLimit) {
+            // Initialize an empty array to store detailed page information
             const pageList = [];
+            // Use Promise.all to fetch detailed information for each page concurrently
             await Promise.all(data.map(async (page) => {
+                // Fetch detailed page information by page ID and push it to pageList
                 await this.getPageById(page.id, langCode).then((result) => {
                     pageList.push(result);
                 });
             }));
-            const result = await this.addTemplateToPages(pageList);
-            return this._dataPostProcess(result, langCode);
+            // Add templates to the fetched pages
+            const withTemplate = await this.addTemplateToPages(pageList);
+            // Post-process the data and return it; ensures consistent structure or handles errors
+            return this._dataPostProcess(withTemplate, langCode);
         }
-        const result = await this.addTemplateToPages(data);
-        return this._normalizeData(result, langCode);
+        // If there is a traffic limit, add templates to the initially fetched data without fetching detailed information
+        const withTemplate = await this.addTemplateToPages(data);
+        // Normalize the data and return it; ensures consistent structure or handles errors
+        return this._normalizeData(withTemplate, langCode);
     }
     /**
-     * addTemplateToPages
-     * @param data
-     * @returns
+     * Add template data to pages
+     *
+     * @handleName addTemplateToPages
+     *
+     * @param data - An array of page objects (IPagesEntity[]) to which template data will be added. Example: .
+     *
+     * @return - An array of page objects with template data added
+     * @throws {IError} - If there is an error during the fetch operation, it will return an error object.
+     *
+     * @description Add template data to pages
      */
     async addTemplateToPages(data) {
+        // Use Promise.all to handle an array of promises returned by mapping over 'data'
         return Promise.all(data.map(async (d) => {
+            // For each element 'd' in the 'data' array, call 'addTemplateToPage'
             const result = await this.addTemplateToPage(d);
+            // Return the result of 'addTemplateToPage' for the current element
             return result;
         }));
     }
     /**
-     * addTemplateToPage by page templateIdentifier
-     * @param data - page object
-     * @returns
+     * Add template data to page by page templateIdentifier
+     *
+     * @handleName addTemplateToPage
+     *
+     * @param data - An array of page objects (IPagesEntity[]) to which template data will be added. Example: .
+     *
+     * @return - An array of page objects with template data added
+     * @throws {IError} If there is an error during the fetch operation, it will return an error object.
+     *
+     * @description
      */
     async addTemplateToPage(data) {
-        if ('templateIdentifier' in data && data.templateIdentifier) {
-            // Create an instance of templatesApi with the current state
-            const Templates = new templatesApi_1.default(this.state);
-            // get template by marker
-            const result = await Templates.getTemplateByMarker('template');
-            return {
-                ...data,
-                template: result,
-            };
+        // Check if 'templateIdentifier' exists in 'data' and is not null or an empty string
+        if ('templateIdentifier' in data &&
+            data.templateIdentifier !== null &&
+            data.templateIdentifier !== '') {
+            // Destructure 'templateIdentifier' from 'data'
+            const { templateIdentifier } = data;
+            try {
+                // Create a new instance of templatesApi with the current state
+                const Templates = new templatesApi_1.default(this.state);
+                // Fetch the template using the 'templateIdentifier'
+                const result = await Templates.getTemplateByMarker(templateIdentifier);
+                // Return the original data object with the fetched template added
+                return {
+                    ...data,
+                    template: result,
+                };
+            }
+            catch (error) {
+                // Log any errors that occur during the template fetching process
+                console.error('Template fetch error: ', error);
+                // Return the original data object unchanged if an error occurs
+                return data;
+            }
         }
         else {
+            // If 'templateIdentifier' doesn't exist or is invalid, return the original data
             return data;
         }
     }

package/dist/pages/pagesInterfaces.d.ts

@@ -1,6 +1,6 @@
 import type { AttributeType, IAttributes, IError, LangType, Types } from '../base/utils';
 /**
- * Represents an interface object of Pages Api.
+ * @interface IPageApi
  *
  * @property {function} getRootPages - Get all top-level page objects.
  * @property {function} getCatalogPages - Get all page objects with product information as an array.
@@ -11,33 +11,117 @@ import type { AttributeType, IAttributes, IError, LangType, Types } from '../bas
  * @property {function} getFormsByPageUrl - Get all forms by page url.
  * @property {function} getConfigPageByUrl - Get settings for the page.
  * @property {function} searchPage - Quick search for page objects with limited output.
+ *
+ * @description This interface defines methods for retrieving and managing pages in the system.
  */
 interface IPageApi {
+    /**
+     * Get all top-level page objects.
+     *
+     * @param {string} [langCode] - Language code. Default: "en_US".
+     *
+     * @return {IPagesEntity[]} Returns all created pages without parents as an array of PageEntity objects or an empty array [] (if there is no data)
+     * @throws {IError} - If there is an error during the fetch operation, it will return an error object.
+     */
     getRootPages(langCode?: LangType): Promise<Array<IPagesEntity> | IError>;
+    /**
+     * Get all page objects with product information as an array.
+     *
+     * @param {string} [langCode] - Language code. Default: "en_US".
+     *
+     * @return {IPagesEntity[]} Returns all created pages as an array of PageEntity objects or an empty array [] (if there is no data).
+     * @throws {IError} - If there is an error during the fetch operation, it will return an error object.
+     */
     getPages(langCode?: LangType): Promise<Array<IPagesEntity> | IError>;
+    /**
+     * Get page object with information about forms, blocks, menus, linked to the page.
+     *
+     * @param {number} id - The unique identifier of the page to be fetched. Example: 123.
+     * @param {string} [langCode] - Language code. Default: "en_US".
+     *
+     * @return {IPagesEntity} Returns PageEntity object
+     * @throws {IError} - If there is an error during the fetch operation, it will return an error object.
+     */
     getPageById(id: number, langCode?: LangType): Promise<IPagesEntity | IError>;
+    /**
+     * Get page object with information about forms, blocks, menus, linked to the page by URL.
+     *
+     * @param {string} url - Page URL. Example: "about".
+     * @param {string} [langCode] - Language code. Default: "en_US".
+     *
+     * @return {IPagesEntity} Returns PageEntity object
+     * @throws {IError} - If there is an error during the fetch operation, it will return an error object.
+     */
     getPageByUrl(url: string, langCode?: LangType): Promise<IPagesEntity | IError>;
+    /**
+     * Get child pages object with information as an array.
+     *
+     * @param {string} url - The URL of the parent page for which child pages are to be fetched. Example: "about".
+     * @param {string} [langCode] - Language code. Default: "en_US".
+     *
+     * @return {IPagesEntity} 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} - If there is an error during the fetch operation, it will return an error object.
+     */
     getChildPagesByParentUrl(url: string, langCode?: LangType): Promise<Array<IPagesEntity> | IError>;
-    getFormsByPageUrl(url: string, langCode?: LangType): Promise<Array<IPositionForm> | IError>;
+    /**
+     * Get all blocks by page url.
+     *
+     * @param {string} url - Page URL. Example: "about".
+     * @param {string} [langCode] - Language code. Default: "en_US".
+     *
+     * @return {IPositionBlock[]} Returns all blocks as an array of PositionBlock objects or an empty array [] (if there is no data) for the selected parent
+     * @throws {IError} - If there is an error during the fetch operation, it will return an error object.
+     */
     getBlocksByPageUrl(url: string, langCode?: LangType): Promise<Array<IPositionBlock> | IError>;
+    /**
+     * Get all forms by page url.
+     *
+     * @handleName getFormsByPageUrl
+     *
+     * @param {string} url - The URL of the page for which forms are to be fetched. Example: "about".
+     * @param {string} [langCode] - Language code. Default: "en_US".
+     *
+     * @return {IPositionForm[]} Returns all forms as an array of PositionForm objects or an empty array [] (if there is no data) for the selected parent
+     * @throws {IError} - If there is an error during the fetch operation, it will return an error object.
+     *
+     * @description Get all forms by page url.
+     */
+    getFormsByPageUrl(url: string, langCode?: LangType): Promise<Array<IPositionForm> | IError>;
+    /**
+     * Get settings for the page.
+     *
+     * @param {string} url - Page URL. Example: "about".
+     *
+     * @return {IPageConfig} Returns a ConfigPage object with page display settings
+     * @throws {IError} - If there is an error during the fetch operation, it will return an error object.
+     */
     getConfigPageByUrl(url: string): Promise<IPageConfig | IError>;
+    /**
+     * Quick search for page objects with limited output.
+     *
+     * @param {string} name - Text for searching page objects (search is performed on the title field of the localizeInfos object with the language taken into account). Example: "About Us".
+     * @param {string} [langCode] - Language code. Default: "en_US".
+     *
+     * @return {IPagesEntity[]} Returns all created pages as an array of PageEntity objects or an empty array [] (if there is no data)
+     * @throws {IError} - If there is an error during the fetch operation, it will return an error object.
+     */
     searchPage(name: string, langCode?: LangType): Promise<Array<IPagesEntity> | IError>;
 }
 /**
- * Represents a config object.
+ * @interface IPageConfig
  *
- * @interface
  * @property {number} rowsPerPage - Number of lines per page.
  * @property {number} rowsPerPage - Number of products per page.
+ *
+ * @description This interface defines the configuration for pagination in pages, including the number of rows and products displayed per page.
  */
 interface IPageConfig {
     rowsPerPage: number | null;
     productsPerRow: number | null;
 }
 /**
- * Represents an object with various properties.
+ * @interface IPositionForm
  *
- * @interface
  * @property {number} id - The identifier of the object.
  * @property {number} version - The version number of the object.
  * @property {string} identifier - The textual identifier for the record field.
@@ -47,6 +131,8 @@ interface IPageConfig {
  * @property {Record<string, any>} localizeInfos - The name of the page, taking into account localization.
  * @property {object} processingData - Form data.
  * @property {number} position - The position of the object.
+ *
+ * @description This interface defines the structure of a position form entity, including its identifiers, attributes, and processing data.
  */
 interface IPositionForm {
     id: number;
@@ -60,19 +146,23 @@ interface IPositionForm {
     position: number;
 }
 /**
- * Represents an object with various properties.
+ * @interface IPositionBlock
  *
- * @interface
  * @property {number} id - The identifier of the object.
+ * @property {number} [quantity] - Quantity pages in block.
  * @property {number} version - The version number of the object.
- * @property {number} quantity - Quantity pages in block.
  * @property {string} identifier - The textual identifier for the record field.
  * @property {Record<string, any>} localizeInfos - The name of the page, taking into account localization.
  * @property {number} position - The position of the object.
  * @property {boolean} isSync - Indication of page indexing.
  * @property {AttributeType} attributeValues - Array of attribute values from the index (represented as a pair of user attribute id: attribute value).
- * @property {string} attributeSetIdentifier
+ * @property {string} attributeSetIdentifier - Set of attributes id.
+ * @property {boolean} isVisible - A sign of page visibility.
  * @property {Types} type - Page type.
+ * @property {string | null} templateIdentifier - User id of the linked template.
+ * @property {number} [countElementsPerRow] - Number of elements displayed per row in the block, if applicable.
+ *
+ * @description This interface defines the structure of a position block entity, including its identifiers, attributes, and visibility.
  */
 interface IPositionBlock {
     id: number;
@@ -90,24 +180,28 @@ interface IPositionBlock {
     countElementsPerRow?: number;
 }
 /**
- * Represents an object with various properties.
+ * @interface IPagesEntity
  *
- * @interface
- * @property {number} id - The identifier of the object.
- * @property {number} parentId - The id of the parent page, if it contains null, then it is the top-level page.
- * @property {Record<string, number>} config - Output settings for catalog pages.
- * @property {string} pageUrl - Unique page Url.
- * @property {number} depth - Page nesting depth relative to parentId.
- * @property {Record<string, any>} localizeInfos - The name of the page, taking into account localization.
- * @property {boolean} isVisible - A sign of page visibility.
- * @property {number} products - The number of products linked to the page.
  * @property {string} attributeSetIdentifier - Set of attributes id.
+ * @property {AttributeType} attributeValues - Array of attribute values from the index (represented as a pair of user attribute id: attribute value).
+ * @property {number} [childrenCount] - Children count.
+ * @property {Record<string, number>} [config] - Output settings for catalog pages.
+ * @property {number} depth - Page nesting depth relative to parentId.
+ * @property {number} id - The identifier of the object.
  * @property {boolean} isSync - Indication of page indexing.
+ * @property {boolean} isVisible - A sign of page visibility.
+ * @property {Record<string, any>} [forms] -
+ * @property {Record<string, any>} [blocks] -
+ * @property {Record<string, any>} localizeInfos - The name of the page, taking into account localization.
+ * @property {string} pageUrl - Unique page Url.
+ * @property {number} parentId - The id of the parent page, if it contains null, then it is the top-level page.
+ * @property {number} [position] - Item number (for sorting).
+ * @property {number} [products] - The number of products linked to the page.
  * @property {string} templateIdentifier - User id of the linked template.
- * @property {AttributeType} attributeValues - Array of attribute values from the index (represented as a pair of user attribute id: attribute value).
- * @property {number} position - Item number (for sorting).
  * @property {Types} type - Page type.
- * @property {number} childrenCount - Children count.
+ * @property {any} [template] - Template object.
+ *
+ * @description This interface defines the structure of a page entity, including its identifiers, attributes, and hierarchical relationships.
  */
 interface IPagesEntity {
     attributeSetIdentifier: string | null;