oneentry 1.0.124 → 1.0.125

package/dist/pages/pagesApi.js

@@ -21,11 +21,9 @@ class PageApi extends asyncModules_1.default {
      * @handleName getRootPages
      *
      * @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
+     * @description Get all top-level page objects.
      */
     async getRootPages(langCode = this.state.lang) {
         // Fetch data from the server using a GET request to retrieve root pages for the specified language code
@@ -41,10 +39,8 @@ class PageApi extends asyncModules_1.default {
      * @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.
-     *
      * @description Get all page objects with product information as an array.
      */
     async getPages(langCode = this.state.lang) {
@@ -62,10 +58,8 @@ class PageApi extends asyncModules_1.default {
      *
      * @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) {
@@ -83,10 +77,8 @@ class PageApi extends asyncModules_1.default {
      *
      * @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.
-     *
      * @description Get page object with information about forms, blocks, menus, linked to the page by URL.
      */
     async getPageByUrl(url, langCode = this.state.lang) {
@@ -104,10 +96,8 @@ class PageApi extends asyncModules_1.default {
      *
      * @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".
-     *
      * @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) {
@@ -125,10 +115,8 @@ class PageApi extends asyncModules_1.default {
      *
      * @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.
-     *
      * @description Get all blocks by page url.
      */
     async getBlocksByPageUrl(url, langCode = this.state.lang) {
@@ -210,35 +198,14 @@ class PageApi extends asyncModules_1.default {
         // Return the final normalized response
         return this._normalizeData(normalizeResponse);
     }
-    /**
-     * 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.
-     */
-    async getFormsByPageUrl(url, langCode = this.state.lang) {
-        // 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.
      *
      * @handleName getConfigPageByUrl
      *
      * @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) {
@@ -254,10 +221,8 @@ class PageApi extends asyncModules_1.default {
      *
      * @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.
-     *
      * @description Quick search for page objects with limited output.
      */
     async searchPage(name, langCode = this.state.lang) {
@@ -289,11 +254,43 @@ class PageApi extends asyncModules_1.default {
      *
      * @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
+     * @param {IPagesEntity[]} data - An array of page objects (IPagesEntity[]) to which template data will be added. Example:
+        [
+          {
+            id: 8,
+            parentId: null,
+            moduleFormConfigs: [],
+            pageUrl: 'blog',
+            depth: 0,
+            localizeInfos: {
+              title: 'Blog',
+              menuTitle: 'Blog',
+              htmlContent: '',
+              plainContent: '',
+            },
+            isVisible: true,
+            forms: [],
+            blocks: [],
+            type: 'common_page',
+            templateIdentifier: 'template',
+            attributeSetIdentifier: 'page',
+            attributeValues: {},
+            isSync: true,
+            template: {
+              id: 4,
+              attributeSetIdentifier: null,
+              title: 'Template',
+              generalTypeId: 4,
+              identifier: 'template',
+              version: 0,
+              generalTypeName: 'catalog_page',
+              attributeValues: {},
+              position: 1,
+            },
+          }
+        ]
+     * @return {any} 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) {
@@ -310,12 +307,10 @@ class PageApi extends asyncModules_1.default {
      *
      * @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
+     * @param {IPagesEntity} data - Page object (IPagesEntity) to which template data will be added.
+     * @return {any} 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
+     * @description Add template data to page by page templateIdentifier
      */
     async addTemplateToPage(data) {
         // Check if 'templateIdentifier' exists in 'data' and is not null or an empty string

package/dist/pages/pagesInterfaces.d.ts

@@ -1,4 +1,5 @@
-import type { AttributeType, IAttributes, IError, LangType, Types } from '../base/utils';
+import type { IFormConfig } from 'forms/formsInterfaces';
+import type { AttributeType, IAttributes, IError, ILocalizeInfo, LangType, Types } from '../base/utils';
 /**
  * @interface IPageApi
  *
@@ -8,10 +9,8 @@ import type { AttributeType, IAttributes, IError, LangType, Types } from '../bas
  * @property {function} getPageById - Get page object with information about forms, blocks, menus, linked to the page.
  * @property {function} getPageByUrl - Get page object with information about forms, blocks, menus, linked to the page by URL.
  * @property {function} getChildPagesByParentUrl - Get child pages object with information as an array.
- * @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 {
@@ -19,26 +18,23 @@ 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>;
+    getRootPages(langCode?: LangType): Promise<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>;
+    getPages(langCode?: LangType): Promise<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.
      */
@@ -48,7 +44,6 @@ interface IPageApi {
      *
      * @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.
      */
@@ -58,40 +53,23 @@ interface IPageApi {
      *
      * @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>;
+    getChildPagesByParentUrl(url: string, langCode?: LangType): Promise<IPagesEntity[] | 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>;
+    getBlocksByPageUrl(url: string, langCode?: LangType): Promise<IPositionBlock[] | 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.
      */
@@ -101,18 +79,16 @@ interface IPageApi {
      *
      * @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>;
+    searchPage(name: string, langCode?: LangType): Promise<IPagesEntity[] | IError>;
 }
 /**
  * @interface IPageConfig
  *
- * @property {number} rowsPerPage - Number of lines per page.
- * @property {number} rowsPerPage - Number of products per page.
- *
+ * @property {number | null} rowsPerPage - Number of lines per page. Example: 1.
+ * @property {number | null} productsPerRow - Number of products per page. Example: 1.
  * @description This interface defines the configuration for pagination in pages, including the number of rows and products displayed per page.
  */
 interface IPageConfig {
@@ -122,105 +98,178 @@ interface IPageConfig {
 /**
  * @interface IPositionForm
  *
- * @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.
- * @property {Array<IAttributes>} attributes - Array of attribute values from the used attribute set for displaying the form (taking into account the specified language).
- * @property {number} attributeSetId - The identifier of the attribute set being used.
- * @property {string} processingType - Type of form processing.
- * @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.
- *
+ * @property {number} id - The identifier of the object. Example: 1764.
+ * @property {number} version - The version number of the object. Example: 10.
+ * @property {string} identifier - The textual identifier for the record field. Example: "catalog".
+ * @property {number} attributeSetId - The identifier of the attribute set being used. Example: 0.
+ * @property {string} processingType - Type of form processing. Example: "email".
+ * @property {ILocalizeInfo} localizeInfos - The name of the page, taking into account localization. Example:
+ * @property {object} processingData - Form data. Example: {}.
+ * @property {number} position - The position of the object. Example: 0.
+ * @property {IAttributes[]} attributes - Array of attribute values from the used attribute set for displaying the form (taking into account the specified language). Example:
+    [
+      {
+        "type": "list",
+        "marker": "list_marker",
+        "position": 2,
+        "listTitles": [
+          {
+            "title": "red",
+            "value": 1,
+            "position": 1,
+            "extendedValue": null,
+            "extendedValueType": null
+          },
+          {
+            "title": "yellow",
+            "value": 2,
+            "position": 2,
+            "extendedValue": null,
+            "extendedValueType": null
+          }
+        ],
+        "validators": {},
+        "localizeInfos": {
+          "title": "l1"
+        }
+      }
+    ]
+    {
+      "title": "My form",
+      "titleForSite": "",
+      "successMessage": "",
+      "unsuccessMessage": "",
+      "urlAddress": "",
+      "database": "0",
+      "script": "0"
+    }
  * @description This interface defines the structure of a position form entity, including its identifiers, attributes, and processing data.
  */
 interface IPositionForm {
     id: number;
     version: number;
     identifier: string;
-    attributes: Array<IAttributes> | IAttributes;
     attributeSetId: number;
     processingType: string;
-    localizeInfos: Record<string, any>;
+    localizeInfos: ILocalizeInfo;
     processingData: Record<string, any>;
     position: number;
+    attributes: IAttributes[] | IAttributes;
 }
 /**
  * @interface IPositionBlock
  *
- * @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 {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 - 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.
- *
+ * @property {number} id - The identifier of the object. Example: 1.
+ * @property {string | null} attributeSetIdentifier - Set of attributes id. Example: "block".
+ * @property {ILocalizeInfo} localizeInfos - The name of the page, taking into account localization. Example:
+ * @property {number} version - The version number of the object. Example: 0.
+ * @property {number} position - The position of the object. Example: 1.
+ * @property {string} identifier - The textual identifier for the record field. Example: "product_block".
+ * @property {Types} type - Page type. Example: "product".
+ * @property {string | null} templateIdentifier - User id of the linked template. Example: null.
+ * @property {boolean} isVisible - A sign of page visibility. Example: true.
+ * @property {boolean} isSync - Indication of page indexing. Example: false.
+ * @property {AttributeType} attributeValues - Array of attribute values from the index (represented as a pair of user attribute id: attribute value). Example:
+    {
+      "block-text": {
+        "type": "string",
+        "value": "some text",
+        "position": 0,
+        "additionalFields": []
+      }
+    }
+ * @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.
+    {
+      "title": "Product Block"
+    }
  * @description This interface defines the structure of a position block entity, including its identifiers, attributes, and visibility.
  */
 interface IPositionBlock {
     id: number;
-    quantity?: number;
+    attributeSetIdentifier: string | null;
+    localizeInfos: ILocalizeInfo;
     version: number;
-    identifier: string;
-    localizeInfos: Record<string, any>;
     position: number;
-    isSync: boolean;
-    isVisible: boolean;
-    attributeValues: AttributeType;
-    attributeSetIdentifier: string | null;
+    identifier: string;
     type: string;
     templateIdentifier: string | null;
+    isVisible: boolean;
+    isSync: boolean;
+    attributeValues: AttributeType;
     countElementsPerRow?: number;
+    quantity?: number;
 }
 /**
  * @interface IPagesEntity
  *
- * @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 {Types} type - Page type.
- * @property {any} [template] - Template object.
- *
+ * @property {number} id - The identifier of the object. Example: 8.
+ * @property {number | null} parentId - The id of the parent page, if it contains null, then it is the top-level page. Example: 10.
+ * @property {string} pageUrl - Unique page Url. Example: "blog".
+ * @property {number} depth - Page nesting depth relative to parentId. Example: 10.
+ * @property {ILocalizeInfo} localizeInfos - The name of the page, taking into account localization. Example:
+    {
+      "title": "Blog",
+      "menuTitle": "Blog",
+      "htmlContent": "",
+      "plainContent": ""
+    }
+ * @property {boolean} isVisible - A sign of page visibility. Example: true.
+ * @property {Types} type - Page type. Example: "common_page".
+ * @property {string | null} templateIdentifier - User id of the linked template. Example: "template".
+ * @property {string | null} attributeSetIdentifier - Set of attributes id. Example: "page".
+ * @property {AttributeType} attributeValues - Array of attribute values from the index (represented as a pair of user attribute id: attribute value). Example:
+    {
+      "text": {
+        "type": "string",
+        "value": "some text",
+        "position": 0,
+        "additionalFields": []
+      }
+    }
+ * @property {boolean} isSync - Indication of page indexing. Example: true.
+ * @property {any} [template] - Template object. Example:
+ * @property {number} [position] - Item number (for sorting). Example: 2.
+ * @property {any} [config] - Output settings for catalog pages. Example:
+    {
+      "rowsPerPage": 1,
+      "productsPerRow": 1
+    }
+ * @property {number} [products] - The number of products linked to the page. Example: 0.
+ * @property {number} [childrenCount] - Children count. Example: 1.
+ * @property {any} [forms]
+ * @property {any} [blocks]
+    {
+      "id": 4,
+      "attributeSetIdentifier": null,
+      "title": "Template",
+      "generalTypeId": 4,
+      "identifier": "template",
+      "version": 0,
+      "generalTypeName": "catalog_page",
+      "attributeValues": {},
+      "position": 1
+    }
  * @description This interface defines the structure of a page entity, including its identifiers, attributes, and hierarchical relationships.
  */
 interface IPagesEntity {
+    id: number;
+    parentId: number | null;
+    pageUrl: string;
+    depth: number;
+    localizeInfos: ILocalizeInfo;
+    isVisible: boolean;
+    type: Types;
+    templateIdentifier: string | null;
     attributeSetIdentifier: string | null;
     attributeValues: AttributeType;
-    childrenCount?: number;
-    config?: Record<string, number>;
-    depth: number;
-    id: number;
     isSync: boolean;
-    isVisible: boolean;
-    forms?: Record<string, any>;
-    blocks?: Record<string, any>;
-    localizeInfos: Record<string, any>;
-    pageUrl: string;
-    parentId: number | null;
+    template?: any;
     position?: number;
+    config?: Record<string, number>;
     products?: number;
-    templateIdentifier: string | null;
-    type: Types;
-    template?: any;
+    childrenCount?: number;
+    blocks?: Record<string, any>;
+    moduleFormConfigs?: Array<IFormConfig>;
 }
 export type { IPageApi, IPageConfig, IPagesEntity, IPositionBlock, IPositionForm, };