oneentry 1.0.124 → 1.0.126

package/dist/pages/pagesApi.d.ts

@@ -1,7 +1,7 @@
 import AsyncModules from '../base/asyncModules';
 import type StateModule from '../base/stateModule';
 import type { IError } from '../base/utils';
-import type { IPageApi, IPageConfig, IPagesEntity, IPositionBlock, IPositionForm } from './pagesInterfaces';
+import type { IPageApi, IPageConfig, IPagesEntity, IPositionBlock } from './pagesInterfaces';
 /**
  * Controllers for working with page objects, including catalog pages
  * @handle /api/content/pages
@@ -16,26 +16,22 @@ export default class PageApi extends AsyncModules implements IPageApi {
      * @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.
      */
-    getRootPages(langCode?: string): Promise<Array<IPagesEntity> | IError>;
+    getRootPages(langCode?: string): Promise<IPagesEntity[] | IError>;
     /**
      * Get all page objects with product information as an array.
      *
      * @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.
      */
-    getPages(langCode?: string): Promise<Array<IPagesEntity> | IError>;
+    getPages(langCode?: string): Promise<IPagesEntity[] | IError>;
     /**
      * Get page object with information about forms, blocks, menus, linked to the page.
      *
@@ -43,10 +39,8 @@ export default class PageApi extends AsyncModules implements IPageApi {
      *
      * @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.
      */
     getPageById(id: number, langCode?: string): Promise<IPagesEntity | IError>;
@@ -57,10 +51,8 @@ export default class PageApi extends AsyncModules implements 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.
-     *
      * @description Get page object with information about forms, blocks, menus, linked to the page by URL.
      */
     getPageByUrl(url: string, langCode?: string): Promise<IPagesEntity | IError>;
@@ -71,13 +63,11 @@ export default class PageApi extends AsyncModules implements IPageApi {
      *
      * @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.
      */
-    getChildPagesByParentUrl(url: string, langCode?: string): Promise<Array<IPagesEntity> | IError>;
+    getChildPagesByParentUrl(url: string, langCode?: string): Promise<IPagesEntity[] | IError>;
     /**
      * Get all blocks by page url.
      *
@@ -85,37 +75,19 @@ export default class PageApi extends AsyncModules implements IPageApi {
      *
      * @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.
      */
-    getBlocksByPageUrl(url: string, langCode?: string): 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?: string): Promise<Array<IPositionForm> | IError>;
+    getBlocksByPageUrl(url: string, langCode?: string): Promise<IPositionBlock[] | IError>;
     /**
      * 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.
      */
     getConfigPageByUrl(url: string): Promise<IPageConfig | IError>;
@@ -126,37 +98,65 @@ export default class PageApi extends AsyncModules implements 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.
-     *
      * @description Quick search for page objects with limited output.
      */
-    searchPage(name: string, langCode?: string): Promise<Array<IPagesEntity> | IError>;
+    searchPage(name: string, langCode?: string): Promise<IPagesEntity[] | IError>;
     /**
      * 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
+     * @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
      */
-    protected addTemplateToPages(data: IPagesEntity[]): Promise<IPagesEntity[]>;
+    protected addTemplateToPages(data: IPagesEntity[]): Promise<any | IError>;
     /**
      * 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
+     * @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
      */
-    protected addTemplateToPage(data: IPagesEntity): Promise<IPagesEntity>;
+    protected addTemplateToPage(data: IPagesEntity): Promise<any | IError>;
 }

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