oneentry 1.0.126 → 1.0.127

package/dist/pages/pagesApi.d.ts

@@ -5,156 +5,143 @@ import type { IPageApi, IPageConfig, IPagesEntity, IPositionBlock } from './page
 /**
  * Controllers for working with page objects, including catalog pages
  * @handle /api/content/pages
+ * @description Controllers for working with page objects, including catalog pages
  */
 export default class PageApi extends AsyncModules implements IPageApi {
     protected state: StateModule;
     protected _url: string;
+    /**
+     * Constructor
+     * @param {StateModule} state - The state module.
+     * @description Constructor initializes the PageApi with a given state.
+     */
     constructor(state: StateModule);
     /**
      * Get all top-level page objects.
-     *
      * @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)
+     * @param   {string}         [langCode] - Language code. Default: "en_US".
+     * @returns {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 Get all top-level page objects.
      */
     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).
+     * @param   {string}         [langCode] - Language code. Default: "en_US".
+     * @returns {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<IPagesEntity[] | IError>;
     /**
      * Get page object with information about forms, blocks, menus, linked to the page.
-     *
      * @handleName getPageById
-     *
-     * @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
+     * @param   {number}       id         - The unique identifier of the page to be fetched. Example: 1.
+     * @param   {string}       [langCode] - Language code. Default: "en_US".
+     * @returns {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>;
     /**
      * Get page object with information about forms, blocks, menus, linked to the page by URL.
-     *
      * @handleName getPageByUrl
-     *
-     * @param {string} url - Page URL. Example: "about".
-     * @param {string} [langCode] - Language code. Default: "en_US".
-     * @return {IPagesEntity} Returns PageEntity object
+     * @param   {string}       url        - Page URL. Example: "about".
+     * @param   {string}       [langCode] - Language code. Default: "en_US".
+     * @returns {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>;
     /**
      * Get child pages object with information as an array.
-     *
      * @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".
-     * @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
+     * @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 {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<IPagesEntity[] | IError>;
     /**
      * Get all blocks by page url.
-     *
      * @handleName getBlocksByPageUrl
-     *
-     * @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
+     * @param   {string}           url        - Page URL. Example: "about".
+     * @param   {string}           [langCode] - Language code. Default: "en_US".
+     * @returns {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<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
+     * @param   {string}      url - Page URL. Example: "about".
+     * @returns {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>;
     /**
      * Quick search for page objects with limited output.
-     *
      * @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)
+     * @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}         [url]      - Page URL. Example: "catalog".
+     * @param   {string}         [langCode] - Language code. Default: "en_US".
+     * @returns {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<IPagesEntity[] | IError>;
+    searchPage(name: string, url?: string, langCode?: string): Promise<IPagesEntity[] | IError>;
     /**
      * Add template data to pages
-     *
      * @handleName addTemplateToPages
-     *
-     * @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
+     * @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,
+                                      },
+                                      }
+                                      ]
+     * @returns {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<any | IError>;
     /**
      * Add template data to page by page templateIdentifier
-     *
      * @handleName addTemplateToPage
-     *
-     * @param {IPagesEntity} data - Page object (IPagesEntity) to which template data will be added.
-     * @return {any} An array of page objects with template data added
+     * @param   {IPagesEntity} data - Page object (IPagesEntity) to which template data will be added.
+     * @returns {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 page by page templateIdentifier
      */

package/dist/pages/pagesApi.js

@@ -3,25 +3,30 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
+/* eslint-disable jsdoc/reject-any-type */
 /* eslint-disable @typescript-eslint/no-explicit-any */
 const asyncModules_1 = __importDefault(require("../base/asyncModules"));
 const templatesApi_1 = __importDefault(require("../templates/templatesApi"));
 /**
  * Controllers for working with page objects, including catalog pages
  * @handle /api/content/pages
+ * @description Controllers for working with page objects, including catalog pages
  */
 class PageApi extends asyncModules_1.default {
+    /**
+     * Constructor
+     * @param {StateModule} state - The state module.
+     * @description Constructor initializes the PageApi with a given state.
+     */
     constructor(state) {
         super(state);
         this._url = state.url + '/api/content/pages';
     }
     /**
      * Get all top-level page objects.
-     *
      * @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)
+     * @param   {string}         [langCode] - Language code. Default: "en_US".
+     * @returns {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 Get all top-level page objects.
      */
@@ -35,11 +40,9 @@ class PageApi extends asyncModules_1.default {
     }
     /**
      * 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).
+     * @param   {string}         [langCode] - Language code. Default: "en_US".
+     * @returns {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.
      */
@@ -53,12 +56,10 @@ class PageApi extends asyncModules_1.default {
     }
     /**
      * Get page object with information about forms, blocks, menus, linked to the page.
-     *
      * @handleName getPageById
-     *
-     * @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
+     * @param   {number}       id         - The unique identifier of the page to be fetched. Example: 1.
+     * @param   {string}       [langCode] - Language code. Default: "en_US".
+     * @returns {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.
      */
@@ -72,12 +73,10 @@ class PageApi extends asyncModules_1.default {
     }
     /**
      * Get page object with information about forms, blocks, menus, linked to the page by URL.
-     *
      * @handleName getPageByUrl
-     *
-     * @param {string} url - Page URL. Example: "about".
-     * @param {string} [langCode] - Language code. Default: "en_US".
-     * @return {IPagesEntity} Returns PageEntity object
+     * @param   {string}       url        - Page URL. Example: "about".
+     * @param   {string}       [langCode] - Language code. Default: "en_US".
+     * @returns {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.
      */
@@ -91,12 +90,10 @@ class PageApi extends asyncModules_1.default {
     }
     /**
      * Get child pages object with information as an array.
-     *
      * @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".
-     * @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
+     * @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 {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.
      */
@@ -110,12 +107,10 @@ class PageApi extends asyncModules_1.default {
     }
     /**
      * Get all blocks by page url.
-     *
      * @handleName getBlocksByPageUrl
-     *
-     * @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
+     * @param   {string}           url        - Page URL. Example: "about".
+     * @param   {string}           [langCode] - Language code. Default: "en_US".
+     * @returns {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.
      */
@@ -200,11 +195,9 @@ class PageApi extends asyncModules_1.default {
     }
     /**
      * Get settings for the page.
-     *
      * @handleName getConfigPageByUrl
-     *
-     * @param {string} url - Page URL. Example: "about".
-     * @return {IPageConfig} Returns a ConfigPage object with page display settings
+     * @param   {string}      url - Page URL. Example: "about".
+     * @returns {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.
      */
@@ -216,18 +209,18 @@ class PageApi extends asyncModules_1.default {
     }
     /**
      * Quick search for page objects with limited output.
-     *
      * @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)
+     * @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}         [url]      - Page URL. Example: "catalog".
+     * @param   {string}         [langCode] - Language code. Default: "en_US".
+     * @returns {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) {
+    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?lang=${langCode}&name=${name}`);
+        const data = await this._fetchGet(`/quick/search?${url && 'url=' + url}&lang=${langCode}&name=${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) {
             // Initialize an empty array to store detailed page information
@@ -251,45 +244,43 @@ class PageApi extends asyncModules_1.default {
     }
     /**
      * Add template data to pages
-     *
      * @handleName addTemplateToPages
-     *
-     * @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
+     * @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,
+                                      },
+                                      }
+                                      ]
+     * @returns {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
      */
@@ -304,11 +295,9 @@ class PageApi extends asyncModules_1.default {
     }
     /**
      * Add template data to page by page templateIdentifier
-     *
      * @handleName addTemplateToPage
-     *
-     * @param {IPagesEntity} data - Page object (IPagesEntity) to which template data will be added.
-     * @return {any} An array of page objects with template data added
+     * @param   {IPagesEntity} data - Page object (IPagesEntity) to which template data will be added.
+     * @returns {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 page by page templateIdentifier
      */
@@ -332,6 +321,7 @@ class PageApi 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;