oneentry 1.0.15 → 1.0.17

package/README.md

@@ -79,15 +79,15 @@ Example return:
     },
     "attributeSetId": 0,
     "login": "meteor",
-    "email": "meteor@mydomen.ru",
+    "email": "meteor@mydomen.com",
     "restorePasswordCode": "",
     "position": {
       "id": 12,
       "objectId": 1,
       "objectType": "module",
-      "position": "0|hzzzzz:"
+      "position": 1
     },
-    "positionId": "0|hzzzzz:",
+    "positionId": 1,
     "permissions": {
       "menu.create": true
     },
@@ -145,7 +145,7 @@ Example return:
         "id": 12,
         "objectId": 1,
         "objectType": "page",
-        "position": "0|hzzzzz:"
+        "position": 1
       }
     }
   ]
@@ -195,7 +195,7 @@ Example return:
         "id": 12,
         "objectId": 1,
         "objectType": "page",
-        "position": "0|hzzzzz:"
+        "position": 1
       }
     }
   ]
@@ -246,7 +246,7 @@ Example return:
         "id": 12,
         "objectId": 1,
         "objectType": "page",
-        "position": "0|hzzzzz:"
+        "position": 1
       }
     }
   ]
@@ -382,7 +382,7 @@ Example return:
     "nativeName": "বাংলা",
     "isActive": false,
     "image": "🇦🇨",
-    "position": "0|hzzzzz:"
+    "position": 1
   }
 ]
 ```
@@ -1345,9 +1345,9 @@ Example return:
     "id": 12,
     "objectId": 1,
     "objectType": "module",
-    "position": "0|hzzzzz:"
+    "position": 1
   },
-  "positionId": "0|hzzzzz:"
+  "positionId": 1
 }
 ```
 ### getTemplateByMarker
@@ -1385,9 +1385,9 @@ Example return:
     "id": 12,
     "objectId": 1,
     "objectType": "module",
-    "position": "0|hzzzzz:"
+    "position": 1
   },
-  "positionId": "0|hzzzzz:"
+  "positionId": 1
 }
 ```
 ## TemplatesPreviewApi
@@ -1426,9 +1426,9 @@ Example return:
       "id": 12,
       "objectId": 1,
       "objectType": "module",
-      "position": "0|hzzzzz:"
+      "position": 1
     },
-    "positionId": "0|hzzzzz:"
+    "positionId": 1
   }
 ]
 ```
@@ -1462,9 +1462,9 @@ Example return:
     "id": 12,
     "objectId": 1,
     "objectType": "module",
-    "position": "0|hzzzzz:"
+    "position": 1
   },
-  "positionId": "0|hzzzzz:"
+  "positionId": 1
 }
 ```
 ### getTemplatesPreviewByMarker
@@ -1497,8 +1497,8 @@ Example return:
     "id": 12,
     "objectId": 1,
     "objectType": "module",
-    "position": "0|hzzzzz:"
+    "position": 1
   },
-  "positionId": "0|hzzzzz:"
+  "positionId": 1
 }
 ```

package/dist/admins/adminsInterfaces.d.ts

@@ -1,17 +1,59 @@
+/**
+ * Represents a interface object of Admins Api.
+ *
+ * @property {function} getAdminsInfo - Get all user objects - admins.
+ */
 interface IAdmins {
     getAdminsInfo(): Promise<IAdminEntity>;
 }
+/**
+ * Represents a position object.
+ *
+ * @interface
+ * @property {number} id - The unique identifier of the position.
+ * @property {number} position - The position of the object.
+ * @property {number} objectId - The unique identifier of the object.
+ * @property {string} objectType - The type of the object.
+ * @property {boolean} isLocked - Indicates whether the position is locked or not.
+ * @property {number} objectCategoryId - The unique identifier of the object's category.
+ */
 interface IPosition {
     id: number;
-    position: string;
+    position: number;
     objectId: number;
     objectType: string;
-    isLocked: boolean;
-    objectCategoryId: number;
+    isLocked?: boolean;
+    objectCategoryId?: number;
 }
+/**
+ * Represents a position object.
+ *
+ * @interface
+ * @property {string} attr_name - Attributes with values used by the object.
+ */
 interface IAttributesSets {
     [key: string]: string;
 }
+/**
+ * Represents an object with various properties.
+ *
+ * @interface
+ * @property {number} id - The identifier of the object.
+ * @property {string} updatedDate - The date of when the object was 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} login - The login username.
+ * @property {string} email - The email address.
+ * @property {number} restorePasswordCode - The code for password restoration.
+ * @property {IPosition} position - The position of the object.
+ * @property {number} positionId - The identifier of the position object.
+ * @property {Record<string, boolean>} permissions - The user's available permissions.
+ * @property {string} selectedLanguage - The selected language for the interface.
+ * @property {string} selectedContentLanguage - The selected language for content.
+ * @property {string} selectedUITheme - The selected theme for the interface.
+ */
 interface IAdminEntity {
     id: number;
     updatedDate: string;
@@ -29,4 +71,4 @@ interface IAdminEntity {
     selectedContentLanguage: string;
     selectedUITheme: string;
 }
-export { IAdmins, IAdminEntity };
+export { IAdmins, IAdminEntity, IPosition };

package/dist/forms/formsApi.d.ts

@@ -11,12 +11,6 @@ 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>;
     /**
      * 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>;
     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>;
+    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
  */
@@ -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/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.
      *

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>;
 }
+/**
+ * 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;

package/dist/products/productsApi.d.ts

@@ -28,7 +28,7 @@ export default class ProductApi extends OneEntry implements IProductApi {
      *
      * @param {string} [userQuery.sortKey] - Optional field to sort by
      *
-     * @returns {Promise<IProduct[]>} - List of products.
+     * @returns {Promise<IProductsEntity[]>} - List of products.
      */
     getProducts(userQuery?: IProductsQuery): Promise<Array<IProductsEntity>>;
     /**
@@ -53,7 +53,7 @@ export default class ProductApi extends OneEntry implements IProductApi {
      *
      * @param {string} [userQuery.sortKey] - Optional field to sort by
      *
-     * @returns {Promise<IProduct[]>} - Returns array of items, where item - ContentIndexedProductDto objects.
+     * @returns {Promise<IProductsEntity[]>} - Returns array of items, where item - ContentIndexedProductDto objects.
      */
     getProductsEmptyPage(userQuery?: IProductsQuery): Promise<Array<IProductsEntity>>;
     /**
@@ -80,7 +80,7 @@ export default class ProductApi extends OneEntry implements IProductApi {
      *
      * @param {string} [userQuery.sortKey] - Optional field to sort by
      *
-     * @returns {Promise<IProduct[]>} - Returns array of items, where item - ContentIndexedProductDto objects.
+     * @returns {Promise<IProductsEntity[]>} - Returns array of items, where item - ContentIndexedProductDto objects.
      */
     getProductsPageById(id: number, userQuery?: IProductsQuery): Promise<Array<IProductsEntity>>;
     /**
@@ -107,7 +107,7 @@ export default class ProductApi extends OneEntry implements IProductApi {
      *
      * @param {string} [userQuery.sortKey] - Optional field to sort by
      *
-     * @returns {Promise<IProduct[]>} - Returns array of items, where item - ContentIndexedProductDto objects.
+     * @returns {Promise<IProductsEntity[]>} - Returns array of items, where item - ContentIndexedProductDto objects.
      */
     getProductsPageByUrl(url: string, userQuery?: IProductsQuery): Promise<Array<IProductsEntity>>;
     /**
@@ -126,7 +126,7 @@ export default class ProductApi extends OneEntry implements IProductApi {
      *
      * @param {string} [userQuery.sortKey] - Optional field to sort by
      *
-     * @returns {Promise<IProduct[]>} - Returns array of items, where item - ContentIndexedProductDto objects.
+     * @returns {Promise<IProductsEntity[]>} - Returns array of items, where item - ContentIndexedProductDto objects.
      */
     getRelatedProductsById(id: number, userQuery?: IProductsQuery): Promise<IProductsEntity>;
     /**
@@ -170,7 +170,7 @@ export default class ProductApi extends OneEntry implements IProductApi {
      *
      * @param {string} [userQuery.sortKey] - Optional field to sort by
      *
-     * @returns {Promise<IProduct[]>} - Returns array of items, where item - ContentIndexedProductDto objects.
+     * @returns {Promise<IProductsEntity[]>} - Returns array of items, where item - ContentIndexedProductDto objects.
      */
     filterProduct(data: Array<IFilterParams>, userQuery?: IProductsQuery): Promise<Array<IProductsEntity>>;
     /**
@@ -180,16 +180,8 @@ export default class ProductApi extends OneEntry implements IProductApi {
      *
      * @param {string} [langCode] - Language code
      *
-     * @returns {Promise<IProduct[]>} - Returns array of ContentIndexedProductDto object for the product.
+     * @returns {Promise<IProductsEntity[]>} - Returns array of ContentIndexedProductDto object for the product.
      */
     searchProduct(name: string, langCode?: string): Promise<Array<IProductsEntity>>;
-    /**
-     * Get all attributes of one Product.
-     *
-     * @param {number} [id] - Product id.
-     *
-     * @returns {Promise<IProduct[]>} - Returns array of set attributes.
-     */
-    getAttributesByProductId(id: number): Promise<any>;
     private _normalizeProductData;
 }

package/dist/products/productsApi.js

@@ -51,7 +51,7 @@ class ProductApi extends oneEntry_1.default {
      *
      * @param {string} [userQuery.sortKey] - Optional field to sort by
      *
-     * @returns {Promise<IProduct[]>} - List of products.
+     * @returns {Promise<IProductsEntity[]>} - List of products.
      */
     getProducts(userQuery) {
         return __awaiter(this, void 0, void 0, function* () {
@@ -82,7 +82,7 @@ class ProductApi extends oneEntry_1.default {
      *
      * @param {string} [userQuery.sortKey] - Optional field to sort by
      *
-     * @returns {Promise<IProduct[]>} - Returns array of items, where item - ContentIndexedProductDto objects.
+     * @returns {Promise<IProductsEntity[]>} - Returns array of items, where item - ContentIndexedProductDto objects.
      */
     getProductsEmptyPage(userQuery) {
         return __awaiter(this, void 0, void 0, function* () {
@@ -115,7 +115,7 @@ class ProductApi extends oneEntry_1.default {
      *
      * @param {string} [userQuery.sortKey] - Optional field to sort by
      *
-     * @returns {Promise<IProduct[]>} - Returns array of items, where item - ContentIndexedProductDto objects.
+     * @returns {Promise<IProductsEntity[]>} - Returns array of items, where item - ContentIndexedProductDto objects.
      */
     getProductsPageById(id, userQuery) {
         return __awaiter(this, void 0, void 0, function* () {
@@ -148,7 +148,7 @@ class ProductApi extends oneEntry_1.default {
      *
      * @param {string} [userQuery.sortKey] - Optional field to sort by
      *
-     * @returns {Promise<IProduct[]>} - Returns array of items, where item - ContentIndexedProductDto objects.
+     * @returns {Promise<IProductsEntity[]>} - Returns array of items, where item - ContentIndexedProductDto objects.
      */
     getProductsPageByUrl(url, userQuery) {
         return __awaiter(this, void 0, void 0, function* () {
@@ -173,7 +173,7 @@ class ProductApi extends oneEntry_1.default {
      *
      * @param {string} [userQuery.sortKey] - Optional field to sort by
      *
-     * @returns {Promise<IProduct[]>} - Returns array of items, where item - ContentIndexedProductDto objects.
+     * @returns {Promise<IProductsEntity[]>} - Returns array of items, where item - ContentIndexedProductDto objects.
      */
     getRelatedProductsById(id, userQuery) {
         return __awaiter(this, void 0, void 0, function* () {
@@ -235,7 +235,7 @@ class ProductApi extends oneEntry_1.default {
      *
      * @param {string} [userQuery.sortKey] - Optional field to sort by
      *
-     * @returns {Promise<IProduct[]>} - Returns array of items, where item - ContentIndexedProductDto objects.
+     * @returns {Promise<IProductsEntity[]>} - Returns array of items, where item - ContentIndexedProductDto objects.
      */
     filterProduct(data, userQuery) {
         return __awaiter(this, void 0, void 0, function* () {
@@ -251,7 +251,7 @@ class ProductApi extends oneEntry_1.default {
      *
      * @param {string} [langCode] - Language code
      *
-     * @returns {Promise<IProduct[]>} - Returns array of ContentIndexedProductDto object for the product.
+     * @returns {Promise<IProductsEntity[]>} - Returns array of ContentIndexedProductDto object for the product.
      */
     searchProduct(name, langCode = 'en_US') {
         return __awaiter(this, void 0, void 0, function* () {
@@ -265,19 +265,6 @@ class ProductApi extends oneEntry_1.default {
             return productsList;
         });
     }
-    /**
-     * Get all attributes of one Product.
-     *
-     * @param {number} [id] - Product id.
-     *
-     * @returns {Promise<IProduct[]>} - Returns array of set attributes.
-     */
-    getAttributesByProductId(id) {
-        return __awaiter(this, void 0, void 0, function* () {
-            const product = yield this.getProductById(id);
-            return product.attributeValues;
-        });
-    }
     _normalizeProductData(product, langSet) {
         return __awaiter(this, void 0, void 0, function* () {
             const normalizeProduct = Object.assign({}, product);

package/dist/products/productsApi.js.map

@@ -1 +1 @@
-{"version":3,"file":"productsApi.js","sourceRoot":"","sources":["../../src/products/productsApi.ts"],"names":[],"mappings":";;;;;;;;;;;AACA,+CAAuC;AAEvC;;GAEG;AACH,MAAqB,UAAW,SAAQ,kBAAQ;IAC5C,YAAY,GAAU;QAClB,KAAK,CAAC,GAAG,CAAC,CAAA;QAIN,kBAAa,GAAkB;YACnC,MAAM,EAAE,CAAC;YACT,KAAK,EAAE,EAAE;YACT,YAAY,EAAE,IAAI;YAClB,cAAc,EAAE,IAAI;YACpB,eAAe,EAAE,IAAI;YACrB,eAAe,EAAE,IAAI;YACrB,QAAQ,EAAE,OAAO;YACjB,SAAS,EAAE,MAAM;YACjB,OAAO,EAAE,IAAI;SAChB,CAAA;QAbG,IAAI,CAAC,IAAI,IAAI,uBAAuB,CAAA;IACxC,CAAC;IAcD;;;;;;;;;;;;;;;;;;;;;;;OAuBG;IACU,WAAW,CAAC,SAA0B;;YAC/C,MAAM,KAAK,mCAAsB,IAAI,CAAC,aAAa,GAAK,SAAS,CAAC,CAAA;YAElE,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,SAAS,CAAC,GAAG,GAAG,IAAI,CAAC,oBAAoB,CAAC,KAAK,CAAC,CAAC,CAAA;YAC3E,OAAO,MAAM,CAAC,KAAK,CAAA;QACvB,CAAC;KAAA;IAED;;;;;;;;;;;;;;;;;;;;;;;OAuBG;IACU,oBAAoB,CAAC,SAAyB;;YACvD,MAAM,KAAK,mCAAsB,IAAI,CAAC,aAAa,GAAK,SAAS,CAAC,CAAA;YAElE,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,SAAS,CAAC,cAAc,GAAG,IAAI,CAAC,oBAAoB,CAAC,KAAK,CAAC,CAAC,CAAA;YACtF,OAAO,MAAM,CAAA;QACjB,CAAC;KAAA;IAED;;;;;;;;;;;;;;;;;;;;;;;;;OAyBG;IACU,mBAAmB,CAAC,EAAS,EAAE,SAAyB;;YACjE,MAAM,KAAK,mCAAsB,IAAI,CAAC,aAAa,GAAK,SAAS,CAAC,CAAA;YAElE,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,SAAS,CAAC,SAAS,EAAE,GAAG,GAAG,IAAI,CAAC,oBAAoB,CAAC,KAAK,CAAC,CAAC,CAAA;YACtF,OAAO,MAAM,CAAC,KAAK,CAAA;QACvB,CAAC;KAAA;IAED;;;;;;;;;;;;;;;;;;;;;;;;;OAyBG;IACU,oBAAoB,CAAC,GAAU,EAAE,SAAyB;;YACnE,MAAM,KAAK,mCAAsB,IAAI,CAAC,aAAa,GAAK,SAAS,CAAC,CAAA;YAClE,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,SAAS,CAAC,aAAa,GAAG,GAAG,GAAG,IAAI,CAAC,oBAAoB,CAAC,KAAK,CAAC,CAAC,CAAA;YAC3F,OAAO,MAAM,CAAC,KAAK,CAAA;QACvB,CAAC;KAAA;IAED;;;;;;;;;;;;;;;;;OAiBG;IACU,sBAAsB,CAAC,EAAS,EAAE,SAAyB;;YACpE,MAAM,KAAK,mCAAsB,IAAI,CAAC,aAAa,GAAK,SAAS,CAAC,CAAA;YAElE,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,SAAS,CAAC,IAAI,EAAE,WAAW,GAAG,IAAI,CAAC,oBAAoB,CAAC,KAAK,CAAC,CAAC,CAAA;YACzF,OAAO,MAAM,CAAC,KAAK,CAAA;QACvB,CAAC;KAAA;IAED;;;;;;;;OAQG;IACU,cAAc,CAAC,EAAS,EAAE,WAAmC,OAAO;;YAC7E,IAAI,OAAO,QAAQ,KAAK,QAAQ,EAAE;gBAC9B,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,SAAS,CAAC,IAAI,EAAE,aAAa,QAAQ,EAAE,CAAC,CAAA;gBACpE,OAAO,QAAQ,CAAA;aAClB;iBAAM;gBACH,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,SAAS,CAAC,IAAI,EAAE,aAAa,QAAQ,CAAC,CAAC,CAAC,EAAE,CAAC,CAAA;gBACvE,MAAM,OAAO,GAAG,MAAM,IAAI,CAAC,qBAAqB,CAAC,QAAQ,EAAE,QAAQ,CAAC,CAAA;gBACpE,OAAO,OAAO,CAAA;aACjB;QACL,CAAC;KAAA;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAgCG;IACU,aAAa,CAAC,IAAyB,EAAE,SAAyB;;YAC3E,MAAM,KAAK,mCAAsB,IAAI,CAAC,aAAa,GAAK,SAAS,CAAC,CAAA;YAElE,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,UAAU,CAAC,qBAAqB,GAAG,IAAI,CAAC,oBAAoB,CAAC,KAAK,CAAC,EAAC,IAAI,CAAC,CAAA;YACnG,OAAO,MAAM,CAAC,KAAK,CAAA;QACvB,CAAC;KAAA;IAED;;;;;;;;OAQG;IACU,aAAa,CAAC,IAAW,EAAE,WAAkB,OAAO;;YAC7D,MAAM,cAAc,GAAG,MAAM,IAAI,CAAC,SAAS,CAAC,sBAAsB,QAAQ,SAAS,IAAI,EAAE,CAAC,CAAA;YAC1F,MAAM,YAAY,GAA0B,EAAE,CAAA;YAI9C,MAAM,OAAO,CAAC,GAAG,CACb,cAAc,CAAC,GAAG,CAAC,CAAO,OAAsB,EAAE,EAAE;gBAChD,MAAM,IAAI,CAAC,cAAc,CAAC,OAAO,CAAC,EAAE,CAAC,CAAC,IAAI,CAAC,CAAC,MAAM,EAAE,EAAE;oBAClD,YAAY,CAAC,IAAI,CAAC,MAAM,CAAC,CAAA;gBAC7B,CAAC,CAAC,CAAA;YACN,CAAC,CAAA,CAAC,CACL,CAAA;YACD,OAAO,YAAY,CAAA;QACvB,CAAC;KAAA;IAED;;;;;;OAMG;IACU,wBAAwB,CAAC,EAAS;;YAC3C,MAAM,OAAO,GAAG,MAAM,IAAI,CAAC,cAAc,CAAC,EAAE,CAAC,CAAA;YAC7C,OAAO,OAAO,CAAC,eAAe,CAAA;QAClC,CAAC;KAAA;IAEa,qBAAqB,CAAC,OAAwB,EAAE,OAA+B;;YACzF,MAAM,gBAAgB,GAAO,MAAM,CAAC,MAAM,CAAC,EAAE,EAAE,OAAO,CAAC,CAAA;YACvD,IAAI,OAAO,OAAO,KAAK,QAAQ,EAAE;gBAC7B,gBAAgB,CAAC,eAAe,GAAG,OAAO,CAAC,eAAe,CAAC,OAAO,CAAC,CAAA;aACtE;iBAAM;gBACH,MAAM,KAAK,GAAiB,EAAE,CAAA;gBAC9B,MAAM,EAAE,GAAG,OAAO,CAAC,EAAE,CAAA;gBACrB,MAAM,OAAO,CAAC,GAAG,CACb,OAAO,CAAC,GAAG,CAAC,CAAO,IAAW,EAAE,EAAE;oBAC9B,MAAM,IAAI,CAAC,cAAc,CAAC,EAAE,EAAE,IAAI,CAAC,CAAC,IAAI,CAAC,CAAC,MAAM,EAAE,EAAE;wBAChD,KAAK,CAAC,IAAI,CAAC,MAAM,CAAC,eAAe,CAAC,CAAA;oBACtC,CAAC,CAAC,CAAA;gBACN,CAAC,CAAA,CAAC,CACL,CAAA;gBACD,MAAM,CAAC,MAAM,CAAC,gBAAgB,CAAC,eAAe,EAAE,GAAG,KAAK,CAAC,CAAA;aAC5D;YACD,OAAO,gBAAgB,CAAA;QAC3B,CAAC;KAAA;CAEJ;AA9RD,6BA8RC"}
+{"version":3,"file":"productsApi.js","sourceRoot":"","sources":["../../src/products/productsApi.ts"],"names":[],"mappings":";;;;;;;;;;;AACA,+CAAuC;AAEvC;;GAEG;AACH,MAAqB,UAAW,SAAQ,kBAAQ;IAC5C,YAAY,GAAU;QAClB,KAAK,CAAC,GAAG,CAAC,CAAA;QAIN,kBAAa,GAAkB;YACnC,MAAM,EAAE,CAAC;YACT,KAAK,EAAE,EAAE;YACT,YAAY,EAAE,IAAI;YAClB,cAAc,EAAE,IAAI;YACpB,eAAe,EAAE,IAAI;YACrB,eAAe,EAAE,IAAI;YACrB,QAAQ,EAAE,OAAO;YACjB,SAAS,EAAE,MAAM;YACjB,OAAO,EAAE,IAAI;SAChB,CAAA;QAbG,IAAI,CAAC,IAAI,IAAI,uBAAuB,CAAA;IACxC,CAAC;IAcD;;;;;;;;;;;;;;;;;;;;;;;OAuBG;IACU,WAAW,CAAC,SAA0B;;YAC/C,MAAM,KAAK,mCAAsB,IAAI,CAAC,aAAa,GAAK,SAAS,CAAC,CAAA;YAElE,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,SAAS,CAAC,GAAG,GAAG,IAAI,CAAC,oBAAoB,CAAC,KAAK,CAAC,CAAC,CAAA;YAC3E,OAAO,MAAM,CAAC,KAAK,CAAA;QACvB,CAAC;KAAA;IAED;;;;;;;;;;;;;;;;;;;;;;;OAuBG;IACU,oBAAoB,CAAC,SAAyB;;YACvD,MAAM,KAAK,mCAAsB,IAAI,CAAC,aAAa,GAAK,SAAS,CAAC,CAAA;YAElE,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,SAAS,CAAC,cAAc,GAAG,IAAI,CAAC,oBAAoB,CAAC,KAAK,CAAC,CAAC,CAAA;YACtF,OAAO,MAAM,CAAA;QACjB,CAAC;KAAA;IAED;;;;;;;;;;;;;;;;;;;;;;;;;OAyBG;IACU,mBAAmB,CAAC,EAAS,EAAE,SAAyB;;YACjE,MAAM,KAAK,mCAAsB,IAAI,CAAC,aAAa,GAAK,SAAS,CAAC,CAAA;YAElE,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,SAAS,CAAC,SAAS,EAAE,GAAG,GAAG,IAAI,CAAC,oBAAoB,CAAC,KAAK,CAAC,CAAC,CAAA;YACtF,OAAO,MAAM,CAAC,KAAK,CAAA;QACvB,CAAC;KAAA;IAED;;;;;;;;;;;;;;;;;;;;;;;;;OAyBG;IACU,oBAAoB,CAAC,GAAU,EAAE,SAAyB;;YACnE,MAAM,KAAK,mCAAsB,IAAI,CAAC,aAAa,GAAK,SAAS,CAAC,CAAA;YAClE,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,SAAS,CAAC,aAAa,GAAG,GAAG,GAAG,IAAI,CAAC,oBAAoB,CAAC,KAAK,CAAC,CAAC,CAAA;YAC3F,OAAO,MAAM,CAAC,KAAK,CAAA;QACvB,CAAC;KAAA;IAED;;;;;;;;;;;;;;;;;OAiBG;IACU,sBAAsB,CAAC,EAAS,EAAE,SAAyB;;YACpE,MAAM,KAAK,mCAAsB,IAAI,CAAC,aAAa,GAAK,SAAS,CAAC,CAAA;YAElE,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,SAAS,CAAC,IAAI,EAAE,WAAW,GAAG,IAAI,CAAC,oBAAoB,CAAC,KAAK,CAAC,CAAC,CAAA;YACzF,OAAO,MAAM,CAAC,KAAK,CAAA;QACvB,CAAC;KAAA;IAED;;;;;;;;OAQG;IACU,cAAc,CAAC,EAAS,EAAE,WAAmC,OAAO;;YAC7E,IAAI,OAAO,QAAQ,KAAK,QAAQ,EAAE;gBAC9B,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,SAAS,CAAC,IAAI,EAAE,aAAa,QAAQ,EAAE,CAAC,CAAA;gBACpE,OAAO,QAAQ,CAAA;aAClB;iBAAM;gBACH,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,SAAS,CAAC,IAAI,EAAE,aAAa,QAAQ,CAAC,CAAC,CAAC,EAAE,CAAC,CAAA;gBACvE,MAAM,OAAO,GAAG,MAAM,IAAI,CAAC,qBAAqB,CAAC,QAAQ,EAAE,QAAQ,CAAC,CAAA;gBACpE,OAAO,OAAO,CAAA;aACjB;QACL,CAAC;KAAA;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAgCG;IACU,aAAa,CAAC,IAAyB,EAAE,SAAyB;;YAC3E,MAAM,KAAK,mCAAsB,IAAI,CAAC,aAAa,GAAK,SAAS,CAAC,CAAA;YAElE,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,UAAU,CAAC,qBAAqB,GAAG,IAAI,CAAC,oBAAoB,CAAC,KAAK,CAAC,EAAC,IAAI,CAAC,CAAA;YACnG,OAAO,MAAM,CAAC,KAAK,CAAA;QACvB,CAAC;KAAA;IAED;;;;;;;;OAQG;IACU,aAAa,CAAC,IAAW,EAAE,WAAkB,OAAO;;YAC7D,MAAM,cAAc,GAAG,MAAM,IAAI,CAAC,SAAS,CAAC,sBAAsB,QAAQ,SAAS,IAAI,EAAE,CAAC,CAAA;YAC1F,MAAM,YAAY,GAA0B,EAAE,CAAA;YAI9C,MAAM,OAAO,CAAC,GAAG,CACb,cAAc,CAAC,GAAG,CAAC,CAAO,OAAsB,EAAE,EAAE;gBAChD,MAAM,IAAI,CAAC,cAAc,CAAC,OAAO,CAAC,EAAE,CAAC,CAAC,IAAI,CAAC,CAAC,MAAM,EAAE,EAAE;oBAClD,YAAY,CAAC,IAAI,CAAC,MAAM,CAAC,CAAA;gBAC7B,CAAC,CAAC,CAAA;YACN,CAAC,CAAA,CAAC,CACL,CAAA;YACD,OAAO,YAAY,CAAA;QACvB,CAAC;KAAA;IAGa,qBAAqB,CAAC,OAAwB,EAAE,OAA+B;;YACzF,MAAM,gBAAgB,GAAO,MAAM,CAAC,MAAM,CAAC,EAAE,EAAE,OAAO,CAAC,CAAA;YACvD,IAAI,OAAO,OAAO,KAAK,QAAQ,EAAE;gBAC7B,gBAAgB,CAAC,eAAe,GAAG,OAAO,CAAC,eAAe,CAAC,OAAO,CAAC,CAAA;aACtE;iBAAM;gBACH,MAAM,KAAK,GAAiB,EAAE,CAAA;gBAC9B,MAAM,EAAE,GAAG,OAAO,CAAC,EAAE,CAAA;gBACrB,MAAM,OAAO,CAAC,GAAG,CACb,OAAO,CAAC,GAAG,CAAC,CAAO,IAAW,EAAE,EAAE;oBAC9B,MAAM,IAAI,CAAC,cAAc,CAAC,EAAE,EAAE,IAAI,CAAC,CAAC,IAAI,CAAC,CAAC,MAAM,EAAE,EAAE;wBAChD,KAAK,CAAC,IAAI,CAAC,MAAM,CAAC,eAAe,CAAC,CAAA;oBACtC,CAAC,CAAC,CAAA;gBACN,CAAC,CAAA,CAAC,CACL,CAAA;gBACD,MAAM,CAAC,MAAM,CAAC,gBAAgB,CAAC,eAAe,EAAE,GAAG,KAAK,CAAC,CAAA;aAC5D;YACD,OAAO,gBAAgB,CAAA;QAC3B,CAAC;KAAA;CAEJ;AAnRD,6BAmRC"}

package/dist/products/productsInterfaces.d.ts

@@ -1,4 +1,23 @@
 import { ILocalizeInfos } from "../base/utils";
+/**
+ * Represents an interface object of Products Api.
+ *
+ * @property {function} getProducts - Search for all product page objects with pagination and filtering.
+ *
+ * @property {function} getProductsEmptyPage - Search for all product page objects with pagination that do not have a category.
+ *
+ * @property {function} getProductsPageById - Search for all product page objects with pagination for the selected category.
+ *
+ * @property {function} getProductsPageByUrl - Search for all product page objects with pagination for the selected category (by its URL).
+ *
+ * @property {function} getRelatedProductsById - Find all related product page objects.
+ *
+ * @property {function} getProductById - Retrieve one product object.
+ *
+ * @property {function} filterProduct - Find all product page objects with pagination and multiple filtering.
+ *
+ * @property {function} searchProduct - Quick search for product page objects with limited output.
+ */
 interface IProductApi {
     getProducts(userQuery?: IProductsQuery): Promise<Array<IProductsEntity>>;
     getProductsEmptyPage(userQuery?: IProductsQuery): Promise<Array<IProductsEntity>>;
@@ -8,22 +27,21 @@ interface IProductApi {
     getProductById(id: number, langCode: string): Promise<IProductsEntity>;
     filterProduct(data: Array<IFilterParams>, userQuery?: IProductsQuery): Promise<Array<IProductsEntity>>;
     searchProduct(name: string, langCode: string): Promise<Array<IProductsEntity>>;
-    getAttributesByProductId(id: number): Promise<any>;
-}
-interface IProduct {
-    attributeSetId: number | null;
-    attributeValues: object | null;
-    id: number;
-    isSync: number;
-    isVisible: boolean;
-    localizeInfos: object;
-    position: number;
-    price?: number;
-    relatedIds: number[];
-    shortDescTemplateIdentifier: string | number | null;
-    statusId: number | null;
-    templateIdentifier: string | number | null;
 }
+/**
+ * Represents a product query parameters object.
+ *
+ * @interface
+ * @property {number} offset - Parameter for pagination, default 0.
+ * @property {number} limit - Parameter for pagination, default 30.
+ * @property {string | null} statusMarker - Product page status id, default null.
+ * @property {string | null} conditionValue - The value that is being searched for, default null.
+ * @property {string | null} conditionMarker - Id of the filter condition by which the values are filtered, default null.
+ * @property {string | null} attributeMarker - The text identifier of the indexed attribute by which values are filtered, default null.
+ * @property {string} sortOrder - Sort order 'DESC' | 'ASC', default 'DESC'.
+ * @property {string} langCode - localization language code (used only when searching with a filter, default 'en_US'.
+ * @property {string} sortKey - Sorting field, default null.
+ */
 interface IProductsQuery {
     offset?: number;
     limit?: number;
@@ -46,17 +64,54 @@ interface IProductsQuery {
     sortKey?: string;
     [key: string]: string | number | null;
 }
+/**
+ * Represents a product POST data object.
+ *
+ * @interface
+ * @property {number | null} conditionValue - The value that is being searched for, default null.
+ * @property {string | null} conditionMarker - Id of the filter condition by which the values are filtered, default null.
+ * @property {string | null} attributeMarker - The text identifier of the indexed attribute by which values are filtered, default null.
+ * @property {number | null} pageId - Id of the category page object.
+ */
 interface IFilterParams {
     attributeMarker: string;
-    conditionMarker: string;
+    /**
+     * 'in' - Contains,
+     * 'nin' - Does not contain,
+     * 'eq' - Equal,
+     * 'neq' - Not equal,
+     * 'mth' - Greater than,
+     * 'lth' - Less than,
+     * 'exs' - Exists,
+     * 'nexs' - Does not exist
+     */
+    conditionMarker?: 'in' | 'nin' | 'eq' | 'neq' | 'mth' | 'lth' | 'exs' | 'nexs' | null;
     conditionValue: number;
     pageId?: number;
 }
+/**
+ * Represents a product entity object.
+ *
+ * @interface
+ * @property {number} id - The unique identifier.
+ * @property {ILocalizeInfos} localizeInfos - The name of the products, taking into account localization.
+ * @property {boolean} isVisible - A sign of page visibility.
+ * @property {number | null} statusId - Product page status identifiers (may be null).
+ * @property {Array<number>} relatedIds - Ids of related product pages.
+ * @property {object} productPages - ProductPageEntity objects associated with the product page.
+ * @property {number} attributeSetId - Set of attributes id.
+ * @property {number} version - Page modification version number.
+ * @property {boolean} isSync - Indication of page indexing.
+ * @property {number} price - The value of the product page price taken from the index.
+ * @property {string} templateIdentifier - User id of the linked template.
+ * @property {string} shortDescTemplateIdentifier - User id of the linked template for a short description.
+ * @property {number} position - Item number (for sorting).
+ */
 interface IProductsEntity {
     id: number;
     localizeInfos: ILocalizeInfos;
     isVisible: boolean;
-    statusId: number;
+    statusId: number | null;
     relatedIds: number[];
     productPages: {
         id: number;
@@ -80,4 +135,4 @@ interface IProductsEntity {
     };
     position: number;
 }
-export { IFilterParams, IProductsQuery, IProduct, IProductApi, IProductsEntity };
+export { IFilterParams, IProductsQuery, IProductApi, IProductsEntity };

package/dist/templates/templatesApi.d.ts

@@ -8,8 +8,6 @@ export default class TemplatesPreviewApi extends OneEntry implements ITemplatesA
     /**
      * Get all template objects grouped by types.
      *
-     * @param {number} [id] - Status id
-     *
      * @returns Returns an object GroupedTemplatesObject, which contains an array of template objects TemplateEntity
      */
     getAllTemplates(): Promise<Array<ITemplateEntity>>;

package/dist/templates/templatesApi.js

@@ -18,21 +18,9 @@ class TemplatesPreviewApi extends oneEntry_1.default {
         super(url);
         this._url += '/api/content/templates';
     }
-    // /**
-    //  * Get all template objects of a specific type.
-    //  *
-    //  * @returns Returns an array of product status objects
-    //  */
-    // public async getTemplatesByType(type:string):Promise<Array<ITemplateEntity>> {
-    //     //TODO уточнить парметр type
-    //     const result = await this._fetchGet(`?type=${type}`)
-    //     return result
-    // }
     /**
      * Get all template objects grouped by types.
      *
-     * @param {number} [id] - Status id
-     *
      * @returns Returns an object GroupedTemplatesObject, which contains an array of template objects TemplateEntity
      */
     getAllTemplates() {

package/dist/templates/templatesApi.js.map

@@ -1 +1 @@
-{"version":3,"file":"templatesApi.js","sourceRoot":"","sources":["../../src/templates/templatesApi.ts"],"names":[],"mappings":";;;;;;;;;;;AAAA,+CAAuC;AAGvC;;GAEG;AACH,MAAqB,mBAAoB,SAAQ,kBAAQ;IACrD,YAAY,GAAW;QACnB,KAAK,CAAC,GAAG,CAAC,CAAA;QACV,IAAI,CAAC,IAAI,IAAI,wBAAwB,CAAA;IACzC,CAAC;IAED,MAAM;IACN,kDAAkD;IAClD,KAAK;IACL,yDAAyD;IACzD,MAAM;IACN,iFAAiF;IACjF,mCAAmC;IACnC,2DAA2D;IAC3D,oBAAoB;IACpB,IAAI;IAEJ;;;;;;OAMG;IACU,eAAe;;YACxB,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC,CAAA;YAC3C,OAAO,MAAM,CAAA;QACjB,CAAC;KAAA;IAED;;;;;;OAMG;IACU,eAAe,CAAC,EAAS;;YAClC,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,SAAS,CAAC,IAAI,EAAE,EAAE,CAAC,CAAA;YAC7C,OAAO,MAAM,CAAA;QACjB,CAAC;KAAA;IAED;;;;;;OAMG;IACU,mBAAmB,CAAC,MAAa;;YAC1C,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,SAAS,CAAC,WAAW,MAAM,EAAE,CAAC,CAAA;YACxD,OAAO,MAAM,CAAA;QACjB,CAAC;KAAA;CACJ;AApDD,sCAoDC"}
+{"version":3,"file":"templatesApi.js","sourceRoot":"","sources":["../../src/templates/templatesApi.ts"],"names":[],"mappings":";;;;;;;;;;;AAAA,+CAAuC;AAGvC;;GAEG;AACH,MAAqB,mBAAoB,SAAQ,kBAAQ;IACrD,YAAY,GAAW;QACnB,KAAK,CAAC,GAAG,CAAC,CAAA;QACV,IAAI,CAAC,IAAI,IAAI,wBAAwB,CAAA;IACzC,CAAC;IAED;;;;OAIG;IACU,eAAe;;YACxB,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC,CAAA;YAC3C,OAAO,MAAM,CAAA;QACjB,CAAC;KAAA;IAED;;;;;;OAMG;IACU,eAAe,CAAC,EAAS;;YAClC,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,SAAS,CAAC,IAAI,EAAE,EAAE,CAAC,CAAA;YAC7C,OAAO,MAAM,CAAA;QACjB,CAAC;KAAA;IAED;;;;;;OAMG;IACU,mBAAmB,CAAC,MAAa;;YAC1C,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,SAAS,CAAC,WAAW,MAAM,EAAE,CAAC,CAAA;YACxD,OAAO,MAAM,CAAA;QACjB,CAAC;KAAA;CACJ;AAvCD,sCAuCC"}

package/dist/templates/templatesInterfaces.d.ts

@@ -1,30 +1,49 @@
 import { IGeneralTypesEntity } from "../general-types/generalTypesInterfaces";
 import { ILocalizeInfos } from "../base/utils";
+import { IPosition } from "../admins/adminsInterfaces";
+import { IAttributeSet } from "../attribute-set/attributeSetInterfaces";
+/**
+ * Represents an interface object of Templates Api.
+ *
+ * @property {function} getAllTemplates - Get all template objects grouped by types.
+ *
+ * @property {function} getTemplateById - Get one template object by id.
+ *
+ * @property {function} getTemplateByMarker - Get a single template object by marker.
+ */
 interface ITemplatesApi {
     getAllTemplates(): Promise<Array<ITemplateEntity>>;
     getTemplateById(id: number): Promise<ITemplateEntity>;
     getTemplateByMarker(marker: string): Promise<ITemplateEntity>;
 }
+/**
+ * Represents a template entity 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 {IAttributesSets} attributesSets - The attributes with values used by the object.
+ * @property {number} attributeSetId - The identifier of the attribute set being used.
+ * @property {IGeneralTypesEntity} generalType - General type Entity object.
+ * @property {number} generalTypeId - General type Entity id.
+ * @property {ILocalizeInfos} localizeInfos - The name of the template, taking into account localization.
+ * @property {IPosition} position - The position of the object.
+ * @property {number | string} positionId - Id of the item object.
+ *
+ */
 interface ITemplateEntity {
     id: number;
     updatedDate: string;
     version: number;
     identifier: string;
-    attributesSets: {
-        [key: string]: string;
-    };
+    attributesSets: IAttributeSet;
     attributeSetId: number;
     generalType: IGeneralTypesEntity;
     generalTypeId: number;
     localizeInfos: ILocalizeInfos;
-    position: {
-        id: number;
-        position: number | string;
-        objectId: number;
-        objectType: string;
-        isLocked: boolean;
-        objectCategoryId: number;
-    };
+    position: IPosition;
     positionId: number | string;
 }
 export { ITemplatesApi, ITemplateEntity };

package/dist/templates-preview/templatesPreviewInterfaces.d.ts

@@ -1,27 +1,43 @@
 import { ILocalizeInfos } from "../base/utils";
+import { IPosition } from "../admins/adminsInterfaces";
+import { IAttributeSet } from "../attribute-set/attributeSetInterfaces";
+/**
+ * Represents an interface object of Templates Preview Api.
+ *
+ * @property {function} getTemplatesPreview - Get all template objects.
+ *
+ * @property {function} getTemplatesPreviewById - Get one template object by id.
+ *
+ * @property {function} getTemplatesPreviewByMarker - Get one template object by marker.
+ */
 interface ITemplatesPreview {
     getTemplatesPreview(): Promise<Array<ITemplatesPreviewEntity>>;
     getTemplatesPreviewById(id: number): Promise<ITemplatesPreviewEntity>;
     getTemplatesPreviewByMarker(marker: string): Promise<ITemplatesPreviewEntity>;
 }
+/**
+ * Represents a template preview entity object.
+ *
+ * @interface
+ * @property {number} id - The unique identifier of the position.
+ * @property {Date | string} updatedDate - The date of last updated.
+ * @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 {ILocalizeInfos} localizeInfos - The name of the template, taking into account localization.
+ * @property {IPosition} position - The position of the object.
+ * @property {number | string} positionId - Id of the item object.
+ *
+ */
 interface ITemplatesPreviewEntity {
     id: number;
     updatedDate: string;
     version: number;
     identifier: string;
-    attributesSets: {
-        [key: string]: string;
-    };
+    attributesSets: IAttributeSet;
     attributeSetId: number;
     localizeInfos: ILocalizeInfos;
-    position: {
-        id: number;
-        position: number | string;
-        objectId: number;
-        objectType: string;
-        isLocked: boolean;
-        objectCategoryId: number | null;
-    };
+    position: IPosition;
     positionId: number | string;
 }
 export { ITemplatesPreview, ITemplatesPreviewEntity };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "oneentry",
-  "version": "1.0.15",
+  "version": "1.0.17",
   "description": "",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",