oneentry 1.0.16 → 1.0.18

package/dist/forms/formsApi.d.ts

@@ -10,13 +10,7 @@ export default class FormsApi extends OneEntry implements IForms {
      *
      * @returns Returns array for all objects of type FormEntity
      */
-    getAllForms(): Promise<IFormsEntity[]>;
-    /**
-     * Get one form by form id.
-     *
-     * @returns Returns object of type FormEntity
-     */
-    getFormById(id: number): Promise<IFormsEntity>;
+    getAllForms(): Promise<Array<IFormsEntity>>;
     /**
      * Get one form by form marker.
      *

package/dist/forms/formsApi.js

@@ -29,17 +29,6 @@ class FormsApi extends oneEntry_1.default {
             return result;
         });
     }
-    /**
-     * Get one form by form id.
-     *
-     * @returns Returns object of type FormEntity
-     */
-    getFormById(id) {
-        return __awaiter(this, void 0, void 0, function* () {
-            const result = yield this._fetchGet(`/${id}`);
-            return result;
-        });
-    }
     /**
      * Get one form by form marker.
      *

package/dist/forms/formsApi.js.map

@@ -1 +1 @@
-{"version":3,"file":"formsApi.js","sourceRoot":"","sources":["../../src/forms/formsApi.ts"],"names":[],"mappings":";;;;;;;;;;;AAAA,+CAAwC;AAGxC;;GAEG;AACH,MAAqB,QAAS,SAAQ,kBAAQ;IAC1C,YAAY,GAAW;QACnB,KAAK,CAAC,GAAG,CAAC,CAAA;QACV,IAAI,CAAC,IAAI,IAAI,oBAAoB,CAAA;IACrC,CAAC;IAED;;;;OAIG;IACU,WAAW;;YACpB,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,SAAS,CAAC,EAAE,CAAC,CAAA;YACvC,OAAO,MAAM,CAAA;QACjB,CAAC;KAAA;IAED;;;;OAIG;IACU,WAAW,CAAC,EAAS;;YAC9B,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,SAAS,CAAC,IAAI,EAAE,EAAE,CAAC,CAAA;YAC7C,OAAO,MAAM,CAAA;QACjB,CAAC;KAAA;IAED;;;;OAIG;IACU,eAAe,CAAC,MAAa;;YACtC,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,SAAS,CAAC,WAAW,MAAM,EAAE,CAAC,CAAA;YACxD,OAAO,MAAM,CAAA;QACjB,CAAC;KAAA;CACJ;AAnCD,2BAmCC"}
+{"version":3,"file":"formsApi.js","sourceRoot":"","sources":["../../src/forms/formsApi.ts"],"names":[],"mappings":";;;;;;;;;;;AAAA,+CAAwC;AAGxC;;GAEG;AACH,MAAqB,QAAS,SAAQ,kBAAQ;IAC1C,YAAY,GAAW;QACnB,KAAK,CAAC,GAAG,CAAC,CAAA;QACV,IAAI,CAAC,IAAI,IAAI,oBAAoB,CAAA;IACrC,CAAC;IAED;;;;OAIG;IACU,WAAW;;YACpB,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,SAAS,CAAC,EAAE,CAAC,CAAA;YACvC,OAAO,MAAM,CAAA;QACjB,CAAC;KAAA;IAGD;;;;OAIG;IACU,eAAe,CAAC,MAAa;;YACtC,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,SAAS,CAAC,WAAW,MAAM,EAAE,CAAC,CAAA;YACxD,OAAO,MAAM,CAAA;QACjB,CAAC;KAAA;CACJ;AA1BD,2BA0BC"}

package/dist/forms/formsInterfaces.d.ts

@@ -1,28 +1,39 @@
 import { ILocalizeInfos } from "../base/utils";
+import { IAttributeSet } from "../attribute-set/attributeSetInterfaces";
+/**
+ * Represents an interface object of Forms Api.
+ *
+ * @property {function} getAllForms - Get all forms in array.
+ *
+ * @property {function} getFormByMarker - Get one form by form marker.
+ */
 interface IForms {
-    getAllForms(): Promise<IFormsEntity[]>;
-    getFormById(id: number): Promise<IFormsEntity>;
+    getAllForms(): Promise<Array<IFormsEntity>>;
     getFormByMarker(marker: string): Promise<IFormsEntity>;
 }
-interface IFromPages {
-    id: number;
-    pageId: number;
-    formId: number;
-    positionId: number;
-    position: object;
-}
+/**
+ * Represents an object with various properties.
+ *
+ * @interface
+ * @property {number} id - The identifier of the object.
+ * @property {number} attributeSetId - The identifier of the attribute set being used.
+ * @property {string} processingType - Type of form processing.
+ * @property {ILocalizeInfos} localizeInfos - The name of the form, taking into account localization.
+ * @property {object} processingData - Form data.
+ * @property {IAttributesSets} attributesSets - The attributes with values used by the object.
+ * @property {number} version - The version number of the object.
+ * @property {string} identifier - The textual identifier for the record field.
+ * @property {number} position - The position of the object.
+ */
 interface IFormsEntity {
     id: number;
-    updatedDate: string;
-    version: number;
-    identifier: string;
-    attributesSets: {
-        [key: string]: string;
-    };
     attributeSetId: number;
     processingType: string;
     localizeInfos: ILocalizeInfos;
-    processingData: object;
-    formPages: Array<IFromPages>;
+    processingData: object | string;
+    attributesValues: IAttributeSet;
+    version: number;
+    identifier: string;
+    position: number;
 }
 export { IForms, IFormsEntity };

package/dist/formsData/formsDataApi.d.ts

@@ -1,5 +1,5 @@
 import OneEntry from '../base/oneEntry';
-import { IFormsPost, IFormsData, IFormsDataPost, IFormsDataEntity } from './formsDataInterfaces';
+import { IFormsPost, IFormsData, IFormsDataEntity } from './formsDataInterfaces';
 /**
  * Controllers for working with form data
  */
@@ -21,7 +21,7 @@ export default class FormsDataApi extends OneEntry implements IFormsData {
      *   "formData": [
      *     {
      *       "marker": "naimenovanie_1",
-     *       "value": "Наименование",
+     *       "value": "Name",
      *       "langCode": "ru_RU"
      *     }
      *   ]
@@ -29,7 +29,7 @@ export default class FormsDataApi extends OneEntry implements IFormsData {
      *
      * @returns - Returns created CreateFormDataDto objects.
      */
-    postFormsData(data: Array<IFormsPost>): Promise<IFormsDataPost>;
+    postFormsData(data: Array<IFormsPost>): Promise<IFormsDataEntity>;
     /**
      * Get one object of form data by marker.
      *

package/dist/formsData/formsDataApi.js

@@ -39,7 +39,7 @@ class FormsDataApi extends oneEntry_1.default {
      *   "formData": [
      *     {
      *       "marker": "naimenovanie_1",
-     *       "value": "Наименование",
+     *       "value": "Name",
      *       "langCode": "ru_RU"
      *     }
      *   ]

package/dist/formsData/formsDataInterfaces.d.ts

@@ -1,25 +1,58 @@
+/**
+ * Represents a interface object of Forms Api.
+ *
+ * @property {function} getFormsData - Get all forms data.
+ *
+ * @property {function} postFormsData - Find all product page objects with pagination and multiple filtering.
+ *
+ * @property {function} getFormsDataByMarker - Get one object of form data by marker.
+ */
 interface IFormsData {
     getFormsData(): Promise<Array<IFormsDataEntity>>;
-    postFormsData(data: Array<IFormsPost>): Promise<IFormsDataPost>;
+    postFormsData(data: Array<IFormsPost>): Promise<IFormsDataEntity>;
     getFormsDataByMarker(marker: string): Promise<Array<IFormsDataEntity>>;
 }
+/**
+ * Represents a form data.
+ *
+ * @interface
+ * @property {number} id - The unique identifier of the form page.
+ * @property {string} formIdentifier - The identifier of the page.
+ * @property {Date | string} time - The identifier of the form.
+ * @property {IFormData} formData - The identifier of the position.
+ */
 interface IFormsDataEntity {
     id: number;
     formIdentifier: string;
     time: Date | string;
-    formData: Array<IFormData>;
-}
-interface IFormsDataPost {
-    formIdentifier: string;
-    formData: Array<IFormData>;
+    formData: IFormData;
 }
+/**
+ * Form data get by langcode identifier
+ * @example formData['en_US']
+ *
+ * @property {langCode.<object>}
+ *
+ * Contains an array of data form objects with the following values
+ *
+ * @property {string} marker Form data marker.
+ *
+ * @property {string} value Form data value.
+ */
 interface IFormData {
-    marker?: string;
-    value?: string;
-    langCode?: string;
+    [langcode: string]: Array<{
+        marker?: string;
+        value?: string;
+    }>;
 }
+/**
+ * interface to create an object of information about saving data using the form
+ *
+ * @property {string} formIdentifier - The identifier of the page.
+ * @property {IFormData} formData - The identifier of the page.
+ */
 interface IFormsPost {
     formIdentifier: string;
     formData: IFormData;
 }
-export { IFormsPost, IFormsData, IFormsDataPost, IFormsDataEntity };
+export { IFormsPost, IFormsData, IFormsDataEntity };

package/dist/general-types/GeneralTypesApi.js

@@ -31,4 +31,4 @@ class GeneralTypesApi extends oneEntry_1.default {
     }
 }
 exports.default = GeneralTypesApi;
-//# sourceMappingURL=generalTypesApi.js.map
+//# sourceMappingURL=GeneralTypesApi.js.map

package/dist/general-types/GeneralTypesApi.js.map

@@ -1 +1 @@
-{"version":3,"file":"generalTypesApi.js","sourceRoot":"","sources":["../../src/general-types/generalTypesApi.ts"],"names":[],"mappings":";;;;;;;;;;;AAAA,+CAAwC;AAGxC;;GAEG;AACH,MAAqB,eAAgB,SAAQ,kBAAQ;IACjD,YAAY,GAAW;QACnB,KAAK,CAAC,GAAG,CAAC,CAAA;QACV,IAAI,CAAC,IAAI,IAAI,4BAA4B,CAAA;IAC7C,CAAC;IAED;;;;OAIG;IACU,WAAW;;YACpB,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,SAAS,CAAC,EAAE,CAAC,CAAA;YACvC,OAAO,MAAM,CAAA;QACjB,CAAC;KAAA;CAEJ;AAhBD,kCAgBC"}
+{"version":3,"file":"GeneralTypesApi.js","sourceRoot":"","sources":["../../src/general-types/GeneralTypesApi.ts"],"names":[],"mappings":";;;;;;;;;;;AAAA,+CAAwC;AAGxC;;GAEG;AACH,MAAqB,eAAgB,SAAQ,kBAAQ;IACjD,YAAY,GAAW;QACnB,KAAK,CAAC,GAAG,CAAC,CAAA;QACV,IAAI,CAAC,IAAI,IAAI,4BAA4B,CAAA;IAC7C,CAAC;IAED;;;;OAIG;IACU,WAAW;;YACpB,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,SAAS,CAAC,EAAE,CAAC,CAAA;YACvC,OAAO,MAAM,CAAA;QACjB,CAAC;KAAA;CAEJ;AAhBD,kCAgBC"}

package/dist/general-types/generalTypesInterfaces.d.ts

@@ -1,7 +1,19 @@
 import { Types } from "../base/utils";
+/**
+ * Represents an interface object of General Type Api.
+ *
+ * @property {function} getAllTypes - Get all types.
+ */
 interface IGeneralTypes {
     getAllTypes(): Promise<Array<IGeneralTypesEntity>>;
 }
+/**
+ * Represents a general types object.
+ *
+ * @interface
+ * @property {number} id - Type id.
+ * @property {Types} type - Types enum.
+ */
 interface IGeneralTypesEntity {
     id: number;
     type: Types;

package/dist/index.d.ts

@@ -4,7 +4,7 @@ import ProductStatusesApi from "./product-statuses/productStatusesApi";
 import TemplatesApi from "./templates/templatesApi";
 import TemplatesPreviewApi from "./templates-preview/templatesPreviewApi";
 import AdminsApi from "./admins/adminsApi";
-import GeneralTypesApi from "./general-types/generalTypesApi";
+import GeneralTypesApi from "./general-types/GeneralTypesApi";
 import LocalesApi from "./locales/localesApi";
 import MenusApi from "./menus/menusApi";
 import FormsApi from "./forms/formsApi";

package/dist/index.js

@@ -7,7 +7,7 @@ const productStatusesApi_1 = require("./product-statuses/productStatusesApi");
 const templatesApi_1 = require("./templates/templatesApi");
 const templatesPreviewApi_1 = require("./templates-preview/templatesPreviewApi");
 const adminsApi_1 = require("./admins/adminsApi");
-const generalTypesApi_1 = require("./general-types/generalTypesApi");
+const GeneralTypesApi_1 = require("./general-types/GeneralTypesApi");
 const localesApi_1 = require("./locales/localesApi");
 const menusApi_1 = require("./menus/menusApi");
 const formsApi_1 = require("./forms/formsApi");
@@ -24,7 +24,7 @@ function defineOneEntry(url) {
     const Templates = new templatesApi_1.default(url);
     const TemplatesPreview = new templatesPreviewApi_1.default(url);
     const Admins = new adminsApi_1.default(url);
-    const GeneralTypes = new generalTypesApi_1.default(url);
+    const GeneralTypes = new GeneralTypesApi_1.default(url);
     const Locales = new localesApi_1.default(url);
     const Menus = new menusApi_1.default(url);
     const Forms = new formsApi_1.default(url);

package/dist/locales/localesInterfaces.d.ts

@@ -1,7 +1,25 @@
 import { LanguageCode } from "../base/utils";
+/**
+ * Represents an interface object of Locales Api.
+ *
+ * @property {function} getLocales - Find all active language localization objects.
+ */
 interface ILocales {
     getLocales(): Promise<Array<ILocalEntity>>;
 }
+/**
+ * Represents a locales object.
+ *
+ * @interface
+ * @property {number} id - The unique identifier of the locales.
+ * @property {string} shortCode - The shortCode of locales.
+ * @property {LanguageCode} code - The full language code.
+ * @property {string} name - The language name.
+ * @property {string} nativeName - The native language name.
+ * @property {boolean} isActive - Active language flag.
+ * @property {string} image - The language image.
+ * @property {number} position - The language position.
+ */
 interface ILocalEntity {
     id: number;
     shortCode: string;
@@ -10,6 +28,6 @@ interface ILocalEntity {
     nativeName: string;
     isActive: boolean;
     image: string;
-    position: number | string;
+    position: number;
 }
 export { ILocales, ILocalEntity };

package/dist/menus/menusInterfaces.d.ts

@@ -1,7 +1,22 @@
 import { ILocalizeInfos } from "../base/utils";
+/**
+ * Represents an interface object of Menus Api.
+ *
+ * @property {function} getAdminsInfo - Get pages includes in menu by marker.
+ */
 interface IMenus {
     getMenusByMarker(marker: string): Promise<IMenusEntity>;
 }
+/**
+ * Represents a position object.
+ *
+ * @interface
+ * @property {number} id - The unique identifier of the menu.
+ * @property {string} pageUrl - The page url string.
+ * @property {ILocalizeInfos} localizeInfos - The menu data, taking into account localization.
+ * @property {number} position - The menu position.
+ * @property {number | null} parentId - The menu parent id.
+ */
 interface IMenusPages {
     id: number;
     pageUrl: string;
@@ -9,6 +24,15 @@ interface IMenusPages {
     position: number;
     parentId: number | null;
 }
+/**
+ * Represents a position object.
+ *
+ * @interface
+ * @property {number} id - The unique identifier of the menu.
+ * @property {string} identifier - The menu identifier.
+ * @property {ILocalizeInfos} localizeInfos - The menu data, taking into account localization.
+ * @property {Array<IMenusPages>} pages - Array of menu pages.
+ */
 interface IMenusEntity {
     id: number;
     identifier: string;

package/dist/modules/modulesInterfaces.d.ts

@@ -13,7 +13,7 @@ interface IModulesEntity {
         type: string;
     }[];
     attributeSetTypes: [];
-    position: number | string;
+    position: number;
     positionId: number;
 }
 export { IModules, IModulesEntity };

package/dist/pages/pagesApi.d.ts

@@ -1,5 +1,5 @@
 import OneEntry from "../base/oneEntry";
-import { IPageApi, IPageConfig, IPagesEntity } from "./pagesInterfaces";
+import { IPageApi, IPageConfig, IPagesEntity, IPositionForm } from "./pagesInterfaces";
 /**
  * Controllers for working with page objects, including catalog pages
  */
@@ -53,6 +53,26 @@ export default class PageApi extends OneEntry implements IPageApi {
      * @returns Returns page object (DTO depends on the type of page being returned)
      */
     getPageByUrl(url: string, langCode: string): Promise<IPagesEntity>;
+    /**
+     * Get child pages object with information as an array.
+     *
+     * @param {string} [langCode] Required parameter lang code
+     *
+     * @param {string} [url] - Page URL
+     *
+     * @returns Returns all created pages as an array of ContentIndexedPageDto objects or an empty array [] (if there is no data) for the selected parent
+     */
+    getChildPagesByParentUrl(url: string, langCode: string): Promise<IPagesEntity>;
+    /**
+     * Get all forms by page url.
+     *
+     * @param {string} [langCode] Required parameter lang code
+     *
+     * @param {string} [url] - Page URL
+     *
+     * @returns Returns all forms as an array of PositionFormDto objects or an empty array [] (if there is no data) for the selected parent
+     */
+    getFormsByPageUrl(url: string, langCode: string): Promise<Array<IPositionForm>>;
     /**
      * Get settings for the page.
      *
@@ -70,5 +90,5 @@ export default class PageApi extends OneEntry implements IPageApi {
      *
      * @returns Returns all created pages as an array of ContentIndexedPageDto objects or an empty array [] (if there is no data)
      */
-    searchPage(name: string, langCode: string): Promise<IPagesEntity>;
+    searchPage(name: string, langCode: string): Promise<Array<IPagesEntity>>;
 }

package/dist/pages/pagesApi.js

@@ -91,19 +91,36 @@ class PageApi extends oneEntry_1.default {
             return result;
         });
     }
-    // /**
-    //  * Get child pages object with information as an array.
-    //  *
-    //  * @param {string} [langCode] Required parameter lang code
-    //  *
-    //  * @param {string} [url] - Page URL
-    //  *
-    //  * @returns Returns all created pages as an array of ContentIndexedPageDto objects or an empty array [] (if there is no data) for the selected parent
-    //  */
-    // public async getChildPagesByParentUrl(url:string, langCode:string):Promise<IPagesEntity> {
-    //     const result = await this._fetchGet(`/${url}/children?langCode=${langCode}`)
-    //     return result
-    // }
+    /**
+     * Get child pages object with information as an array.
+     *
+     * @param {string} [langCode] Required parameter lang code
+     *
+     * @param {string} [url] - Page URL
+     *
+     * @returns Returns all created pages as an array of ContentIndexedPageDto objects or an empty array [] (if there is no data) for the selected parent
+     */
+    getChildPagesByParentUrl(url, langCode) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const result = yield this._fetchGet(`/${url}/children?langCode=${langCode}`);
+            return result;
+        });
+    }
+    /**
+     * Get all forms by page url.
+     *
+     * @param {string} [langCode] Required parameter lang code
+     *
+     * @param {string} [url] - Page URL
+     *
+     * @returns Returns all forms as an array of PositionFormDto objects or an empty array [] (if there is no data) for the selected parent
+     */
+    getFormsByPageUrl(url, langCode) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const result = yield this._fetchGet(`/${url}/forms?langCode=${langCode}`);
+            return result;
+        });
+    }
     /**
      * Get settings for the page.
      *

package/dist/pages/pagesApi.js.map

@@ -1 +1 @@
-{"version":3,"file":"pagesApi.js","sourceRoot":"","sources":["../../src/pages/pagesApi.ts"],"names":[],"mappings":";;;;;;;;;;;AAAA,+CAAwC;AAGxC;;GAEG;AACH,MAAqB,OAAQ,SAAQ,kBAAQ;IACzC,YAAY,GAAW;QACnB,KAAK,CAAC,GAAG,CAAC,CAAA;QACV,IAAI,CAAC,IAAI,IAAI,oBAAoB,CAAA;IACrC,CAAC;IAED;;;;;;OAMG;IACU,YAAY,CAAC,QAAe;;YACrC,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,SAAS,CAAC,kBAAkB,QAAQ,EAAE,CAAC,CAAA;YACjE,OAAO,MAAM,CAAA;QACjB,CAAC;KAAA;IAED;;;;;;;;;;OAUG;IACU,eAAe,CAAC,QAAe,EAAE,QAAe,EAAE,EAAE,SAAgB,CAAC;;YAC9E,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,SAAS,CAAC,qBAAqB,QAAQ,UAAU,KAAK,WAAW,MAAM,EAAE,CAAC,CAAA;YACpG,OAAO,MAAM,CAAA;QACjB,CAAC;KAAA;IAED;;;;;;OAMG;IACU,QAAQ,CAAC,QAAe;;YACjC,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,SAAS,CAAC,aAAa,QAAQ,EAAE,CAAC,CAAA;YAC5D,OAAO,MAAM,CAAA;QACjB,CAAC;KAAA;IAED;;;;;;;;OAQG;IACU,WAAW,CAAC,EAAS,EAAE,QAAe;;YAC/C,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,SAAS,CAAC,IAAI,EAAE,aAAa,QAAQ,EAAE,CAAC,CAAA;YAClE,OAAO,MAAM,CAAA;QACjB,CAAC;KAAA;IAED;;;;;;;;OAQG;IACU,YAAY,CAAC,GAAU,EAAE,QAAe;;YACjD,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,SAAS,CAAC,QAAQ,GAAG,aAAa,QAAQ,EAAE,CAAC,CAAA;YACvE,OAAO,MAAM,CAAA;QACjB,CAAC;KAAA;IAED,MAAM;IACN,0DAA0D;IAC1D,KAAK;IACL,6DAA6D;IAC7D,KAAK;IACL,sCAAsC;IACtC,KAAK;IACL,wJAAwJ;IACxJ,MAAM;IACN,6FAA6F;IAC7F,mFAAmF;IACnF,oBAAoB;IACpB,IAAI;IAEJ;;;;;;OAMG;IACU,kBAAkB,CAAC,GAAU;;YACtC,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,SAAS,CAAC,IAAI,GAAG,SAAS,CAAC,CAAA;YACrD,OAAO,MAAM,CAAA;QACjB,CAAC;KAAA;IAED;;;;;;;;OAQG;IACU,UAAU,CAAC,IAAW,EAAE,QAAe;;YAChD,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,SAAS,CAAC,sBAAsB,QAAQ,SAAS,IAAI,EAAE,CAAC,CAAA;YAClF,OAAO,MAAM,CAAA;QACjB,CAAC;KAAA;CAEJ;AAlHD,0BAkHC"}
+{"version":3,"file":"pagesApi.js","sourceRoot":"","sources":["../../src/pages/pagesApi.ts"],"names":[],"mappings":";;;;;;;;;;;AAAA,+CAAwC;AAGxC;;GAEG;AACH,MAAqB,OAAQ,SAAQ,kBAAQ;IACzC,YAAY,GAAW;QACnB,KAAK,CAAC,GAAG,CAAC,CAAA;QACV,IAAI,CAAC,IAAI,IAAI,oBAAoB,CAAA;IACrC,CAAC;IAED;;;;;;OAMG;IACU,YAAY,CAAC,QAAe;;YACrC,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,SAAS,CAAC,kBAAkB,QAAQ,EAAE,CAAC,CAAA;YACjE,OAAO,MAAM,CAAA;QACjB,CAAC;KAAA;IAED;;;;;;;;;;OAUG;IACU,eAAe,CAAC,QAAe,EAAE,QAAe,EAAE,EAAE,SAAgB,CAAC;;YAC9E,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,SAAS,CAAC,qBAAqB,QAAQ,UAAU,KAAK,WAAW,MAAM,EAAE,CAAC,CAAA;YACpG,OAAO,MAAM,CAAA;QACjB,CAAC;KAAA;IAED;;;;;;OAMG;IACU,QAAQ,CAAC,QAAe;;YACjC,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,SAAS,CAAC,aAAa,QAAQ,EAAE,CAAC,CAAA;YAC5D,OAAO,MAAM,CAAA;QACjB,CAAC;KAAA;IAED;;;;;;;;OAQG;IACU,WAAW,CAAC,EAAS,EAAE,QAAe;;YAC/C,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,SAAS,CAAC,IAAI,EAAE,aAAa,QAAQ,EAAE,CAAC,CAAA;YAClE,OAAO,MAAM,CAAA;QACjB,CAAC;KAAA;IAED;;;;;;;;OAQG;IACU,YAAY,CAAC,GAAU,EAAE,QAAe;;YACjD,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,SAAS,CAAC,QAAQ,GAAG,aAAa,QAAQ,EAAE,CAAC,CAAA;YACvE,OAAO,MAAM,CAAA;QACjB,CAAC;KAAA;IAED;;;;;;;;OAQG;IACU,wBAAwB,CAAC,GAAU,EAAE,QAAe;;YAC7D,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,SAAS,CAAC,IAAI,GAAG,sBAAsB,QAAQ,EAAE,CAAC,CAAA;YAC5E,OAAO,MAAM,CAAA;QACjB,CAAC;KAAA;IAED;;;;;;;;OAQG;IACU,iBAAiB,CAAC,GAAU,EAAE,QAAe;;YACtD,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,SAAS,CAAC,IAAI,GAAG,mBAAmB,QAAQ,EAAE,CAAC,CAAA;YACzE,OAAO,MAAM,CAAA;QACjB,CAAC;KAAA;IAED;;;;;;OAMG;IACU,kBAAkB,CAAC,GAAU;;YACtC,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,SAAS,CAAC,IAAI,GAAG,SAAS,CAAC,CAAA;YACrD,OAAO,MAAM,CAAA;QACjB,CAAC;KAAA;IAED;;;;;;;;OAQG;IACU,UAAU,CAAC,IAAW,EAAE,QAAe;;YAChD,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,SAAS,CAAC,sBAAsB,QAAQ,SAAS,IAAI,EAAE,CAAC,CAAA;YAClF,OAAO,MAAM,CAAA;QACjB,CAAC;KAAA;CAEJ;AAhID,0BAgIC"}

package/dist/pages/pagesInterfaces.d.ts

@@ -1,17 +1,100 @@
 import { ILocalizeInfos, Types } from "../base/utils";
+import { IAttributeSet } from "../attribute-set/attributeSetInterfaces";
+import { IFormsEntity } from "../forms/formsInterfaces";
+/**
+ * Represents an interface object of Pages Api.
+ *
+ * @property {function} getRootPages - Get all top-level page objects.
+ *
+ * @property {function} getCatalogPages - Get all page objects with product information as an array.
+ *
+ * @property {function} getPages - Get all page objects with product information as an array.
+ *
+ * @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.
+ */
 interface IPageApi {
     getRootPages(langCode: string): Promise<Array<IPagesEntity>>;
     getCatalogPages(langCode: string, limit: number, offset: number): Promise<Array<IPagesEntity>>;
     getPages(langCode: string): Promise<Array<IPagesEntity>>;
     getPageById(id: number, langCode: string): Promise<IPagesEntity>;
     getPageByUrl(url: string, langCode: string): Promise<IPagesEntity>;
+    getChildPagesByParentUrl(url: string, langCode: string): Promise<IPagesEntity>;
+    getFormsByPageUrl(url: string, langCode: string): Promise<Array<IPositionForm>>;
     getConfigPageByUrl(url: string): Promise<IPageConfig>;
-    searchPage(name: string, langCode: string): Promise<IPagesEntity>;
+    searchPage(name: string, langCode: string): Promise<Array<IPagesEntity>>;
 }
+/**
+ * Represents a config object.
+ *
+ * @interface
+ * @property {number} rowsPerPage - Number of lines per page.
+ *
+ * @property {number} rowsPerPage - Number of products per page.
+ */
 interface IPageConfig {
     rowsPerPage: number;
     productsPerRow: number;
 }
+/**
+ * Represents an object with various properties.
+ *
+ * @interface
+ * @property {number} id - The identifier of the object.
+ * @property {Date | string} updatedDate - The date of last updated.
+ * @property {number} version - The version number of the object.
+ * @property {string} identifier - The textual identifier for the record field.
+ * @property {IAttributesSets} attributesSets - The attributes with values used by the object.
+ * @property {number} attributeSetId - The identifier of the attribute set being used.
+ * @property {string} processingType - Type of form processing.
+ * @property {ILocalizeInfos} 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} positionId - The position id.
+ */
+interface IPositionForm {
+    id: number;
+    updatedDate: Date | string;
+    version: number;
+    identifier: string;
+    attributesSets: IAttributeSet;
+    attributeSetId: number;
+    processingType: string;
+    localizeInfos: ILocalizeInfos;
+    processingData: object;
+    position: number;
+    positionId: number;
+}
+/**
+ * Represents an object with various properties.
+ *
+ * @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 {ILocalizeInfos} 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 {number} attributeSetId - Set of attributes id.
+ * @property {Array<IFormsEntity>} forms - Array of identifier values of the Form Entity objects to which the page is linked (optional).
+ * @property {Array<IFormsEntity>} blocks - array of identifier values of BlockEntity objects to which the page is linked (optional).
+ * @property {boolean} isSync - Indication of page indexing.
+ * @property {string} templateIdentifier - User id of the linked template.
+ * @property {Array<[langCode:string]:object>} 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.
+ */
 interface IPagesEntity {
     id: number;
     parentId: number;
@@ -20,9 +103,11 @@ interface IPagesEntity {
     depth: number;
     localizeInfos: ILocalizeInfos;
     isVisible: boolean;
-    isEditorDisabled: boolean;
     products: number;
     attributeSetId: number;
+    forms?: Array<IFormsEntity>;
+    blocks?: Array<object>;
+    isSync: boolean;
     templateIdentifier: string;
     /**
      * Language-specific attribute values.
@@ -33,7 +118,7 @@ interface IPagesEntity {
     attributeValues: {
         [langCode: string]: object;
     };
-    position: string;
+    position: number;
     type: Types;
 }
-export { IPageApi, IPageConfig, IPagesEntity };
+export { IPageApi, IPageConfig, IPagesEntity, IPositionForm };

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

@@ -1,10 +1,32 @@
 import { ILocalizeInfos } from "../base/utils";
+/**
+ * Represents an interface object of Product Statuses Api.
+ *
+ * @property {function} getProductStatuses - Search for all product status objects.
+ *
+ * @property {function} getProductStatusesById - Search for a product status object by identifier.
+ *
+ * @property {function} getProductsByStatusMarker - Search for a product status object by its textual identifier (marker).
+ *
+ * @property {function} validateMarker - Check the existence of a textual identifier.
+ */
 interface IProductStatuses {
     getProductStatuses(): Promise<Array<IProductStatusEntity>>;
     getProductStatusesById(id: number): Promise<IProductStatusEntity>;
     getProductsByStatusMarker(marker: string): Promise<IProductStatusEntity>;
     validateMarker(marker: string): Promise<boolean>;
 }
+/**
+ * Represents a position object.
+ *
+ * @interface
+ * @property {number} id - The unique identifier of the position.
+ * @property {Date | string} updatedDate - The date of last updated.
+ * @property {number} version - The version number of the object.
+ * @property {string} identifier - The textual identifier for the record field.
+ * @property {boolean} isLocked - Indicates whether the position is locked or not.
+ * @property {ILocalizeInfos} localizeInfos - The name of the products statuses, taking into account localization.
+ */
 interface IProductStatusEntity {
     id: number;
     updatedDate: string;