oneentry 1.0.126 → 1.0.127

package/dist/system/systemApi.d.ts

@@ -5,46 +5,46 @@ import type { ISystem } from './systemInterfaces';
 /**
  * Controllers for working with system - system
  * @handle /api/content/system
+ * @description Controllers for working with system - system
  */
 export default class SystemApi extends AsyncModules implements ISystem {
     protected state: StateModule;
     protected _url: string;
+    /**
+     * Constructor
+     * @param {StateModule} state - The state module.
+     * @description Constructor initializes the SystemApi with a given state.
+     */
     constructor(state: StateModule);
     /**
      * Sends a GET request to the '/test404' endpoint and returns the result.
-     *
      * @handleName test404
-     *
-     * @return {any} The response from the server after fetching data from the '/test404' endpoint.
+     * @returns {any} The response from the server after fetching data from the '/test404' endpoint.
      * @throws {IError} If there is an error during the fetch operation, it will return an error object.
      * @description This method is used to test the 404 error handling by sending a GET request to a specific endpoint.
      */
     test404(): Promise<any | IError>;
     /**
      * Sends a GET request to the '/test500' endpoint and returns the result.
-     *
      * @handleName test500
-     *
-     * @return {any} The response from the server after fetching data from the '/test500' endpoint.
+     * @returns {any} The response from the server after fetching data from the '/test500' endpoint.
      * @throws {IError} If there is an error during the fetch operation, it will return an error object.
      * @description This method is used to test the 500 error handling by sending a GET request to a specific endpoint.
      */
     test500(): Promise<any | IError>;
     /**
      * Validates a CAPTCHA token by sending it to the server for verification.
-     *
      * @handleName validateCapcha
-     *
-     * @param {Object} event - The event object containing CAPTCHA data. Example:
-        {
-          "token": "03AGdBq24...",
-          "expectedAction": "login",
-          "siteKey": "6Lc_aCMTAAAAAB..."
-        }
-     * @param {string} event.token - The CAPTCHA token to be validated. Example: "03AGdBq24...".
-     * @param {string} event.expectedAction - The expected action associated with the CAPTCHA. Example: "login".
-     * @param {string} event.siteKey - The site key used for the CAPTCHA. Example: "6Lc_aCMTAAAAAB...".
-     * @return {any} The response from the server after validating the CAPTCHA, or an error object if validation fails.
+     * @param   {object} event                - The event object containing CAPTCHA data. Example:
+                                              {
+                                              "token": "03AGdBq24...",
+                                              "expectedAction": "login",
+                                              "siteKey": "6Lc_aCMTAAAAAB..."
+                                              }
+     * @param   {string} event.token          - The CAPTCHA token to be validated. Example: "03AGdBq24...".
+     * @param   {string} event.expectedAction - The expected action associated with the CAPTCHA. Example: "login".
+     * @param   {string} event.siteKey        - The site key used for the CAPTCHA. Example: "6Lc_aCMTAAAAAB...".
+     * @returns {any}                         The response from the server after validating the CAPTCHA, or an error object if validation fails.
      * @throws {IError} If there is an error during the fetch operation, it will return an error object.
      * @description This method sends the CAPTCHA token and related information to the server endpoint '/captcha/validate' to verify its validity.
      */
@@ -55,10 +55,8 @@ export default class SystemApi extends AsyncModules implements ISystem {
     }): Promise<any | IError>;
     /**
      * Getting the number of requests to API.
-     *
      * @handleName getApiStat
-     *
-     * @return {any} Return object with date and count.
+     * @returns {any} Return object with date and count.
      * @throws {IError} If there is an error during the fetch operation, it will return an error object.
      * @description Getting the number of requests to API.
      */

package/dist/system/systemApi.js

@@ -3,23 +3,28 @@ 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"));
 /**
  * Controllers for working with system - system
  * @handle /api/content/system
+ * @description Controllers for working with system - system
  */
 class SystemApi extends asyncModules_1.default {
+    /**
+     * Constructor
+     * @param {StateModule} state - The state module.
+     * @description Constructor initializes the SystemApi with a given state.
+     */
     constructor(state) {
         super(state);
         this._url = state.url + '/api/content/system';
     }
     /**
      * Sends a GET request to the '/test404' endpoint and returns the result.
-     *
      * @handleName test404
-     *
-     * @return {any} The response from the server after fetching data from the '/test404' endpoint.
+     * @returns {any} The response from the server after fetching data from the '/test404' endpoint.
      * @throws {IError} If there is an error during the fetch operation, it will return an error object.
      * @description This method is used to test the 404 error handling by sending a GET request to a specific endpoint.
      */
@@ -29,10 +34,8 @@ class SystemApi extends asyncModules_1.default {
     }
     /**
      * Sends a GET request to the '/test500' endpoint and returns the result.
-     *
      * @handleName test500
-     *
-     * @return {any} The response from the server after fetching data from the '/test500' endpoint.
+     * @returns {any} The response from the server after fetching data from the '/test500' endpoint.
      * @throws {IError} If there is an error during the fetch operation, it will return an error object.
      * @description This method is used to test the 500 error handling by sending a GET request to a specific endpoint.
      */
@@ -42,19 +45,17 @@ class SystemApi extends asyncModules_1.default {
     }
     /**
      * Validates a CAPTCHA token by sending it to the server for verification.
-     *
      * @handleName validateCapcha
-     *
-     * @param {Object} event - The event object containing CAPTCHA data. Example:
-        {
-          "token": "03AGdBq24...",
-          "expectedAction": "login",
-          "siteKey": "6Lc_aCMTAAAAAB..."
-        }
-     * @param {string} event.token - The CAPTCHA token to be validated. Example: "03AGdBq24...".
-     * @param {string} event.expectedAction - The expected action associated with the CAPTCHA. Example: "login".
-     * @param {string} event.siteKey - The site key used for the CAPTCHA. Example: "6Lc_aCMTAAAAAB...".
-     * @return {any} The response from the server after validating the CAPTCHA, or an error object if validation fails.
+     * @param   {object} event                - The event object containing CAPTCHA data. Example:
+                                              {
+                                              "token": "03AGdBq24...",
+                                              "expectedAction": "login",
+                                              "siteKey": "6Lc_aCMTAAAAAB..."
+                                              }
+     * @param   {string} event.token          - The CAPTCHA token to be validated. Example: "03AGdBq24...".
+     * @param   {string} event.expectedAction - The expected action associated with the CAPTCHA. Example: "login".
+     * @param   {string} event.siteKey        - The site key used for the CAPTCHA. Example: "6Lc_aCMTAAAAAB...".
+     * @returns {any}                         The response from the server after validating the CAPTCHA, or an error object if validation fails.
      * @throws {IError} If there is an error during the fetch operation, it will return an error object.
      * @description This method sends the CAPTCHA token and related information to the server endpoint '/captcha/validate' to verify its validity.
      */
@@ -67,10 +68,8 @@ class SystemApi extends asyncModules_1.default {
     }
     /**
      * Getting the number of requests to API.
-     *
      * @handleName getApiStat
-     *
-     * @return {any} Return object with date and count.
+     * @returns {any} Return object with date and count.
      * @throws {IError} If there is an error during the fetch operation, it will return an error object.
      * @description Getting the number of requests to API.
      */

package/dist/system/systemInterfaces.d.ts

@@ -1,12 +1,23 @@
 /**
  * @interface ISystem
- *
- * @property {function} test404 - Test 404 error.
- * @property {function} test500 - Test 500 error.
+ * @property {Function} test404 - Test 404 error.
+ * @property {Function} test500 - Test 500 error.
  * @description Represents a interface object of System Api.
  */
 interface ISystem {
+    /**
+     * Test 404 error.
+     * @handleName test404
+     * @returns {any} Returns a Promise that resolves with any data.
+     * @description This method tests 404 error.
+     */
     test404(): Promise<any>;
+    /**
+     * Test 500 error.
+     * @handleName test500
+     * @returns {any} Returns a Promise that resolves with any data.
+     * @description This method tests 500 error.
+     */
     test500(): Promise<any>;
 }
 export type { ISystem };

package/dist/templates/templatesApi.d.ts

@@ -4,47 +4,44 @@ import type { IError, Types } from '../base/utils';
 import type { ITemplateEntity, ITemplatesApi } from './templatesInterfaces';
 /**
  * Controllers for working with template objects
- *
  * @module TemplateController
  * @handle /api/content/templates
- *
  * @description This module provides a set of controllers for handling operations related to template objects.
  */
 export default class TemplatesPreviewApi extends AsyncModules implements ITemplatesApi {
     protected state: StateModule;
     protected _url: string;
+    /**
+     * Constructor for TemplatesApi class.
+     * @param {StateModule} state - The state module instance.
+     * @description Initializes the TemplatesApi class with the provided state module instance.
+     */
     constructor(state: StateModule);
     /**
      * Get all template objects grouped by types.
-     *
      * @handleName getAllTemplates
-     *
-     * @param {string} [langCode] - Language code. Default: "en_US".
-     * @return {Record<Types, ITemplateEntity[]>} Returns an object GroupedTemplatesObject, which contains an array of template objects TemplateEntity
+     * @param   {string}                           [langCode] - Language code. Default: "en_US".
+     * @returns {Record<Types, ITemplateEntity[]>}            Returns an object GroupedTemplatesObject, which contains an array of template objects TemplateEntity
      * @throws {IError} - If there is an error during the fetch operation, it will return an error object.
      * @description This function is designed to fetch organized template objects in groups based on their types.
      */
     getAllTemplates(langCode?: string): Promise<Record<Types, ITemplateEntity[]> | IError>;
     /**
      * Get template objects by type.
-     *
      * @handleName getTemplateByType
-     *
-     * @param {Types} type - The type of templates to retrieve. This parameter specifies the category or classification of templates being requested. Example: "product".
-     * @param {string} [langCode] - Language code. Default: "en_US".
-     * @return {ITemplateEntity[]} Returns a TemplateEntity object.
+     * @param   {Types}             type       - The type of templates to retrieve. This parameter specifies the category or classification of templates being requested. Example: "product".
+     * @param   {string}            [langCode] - Language code. Default: "en_US".
+     * @returns {ITemplateEntity[]}            Returns a TemplateEntity object.
      * @throws {IError} - If there is an error during the fetch operation, it will return an error object.
      * @description Fetch template objects that belong to a specific type, with an optional filter by language.
      */
     getTemplateByType(type: Types, langCode?: string): Promise<ITemplateEntity[] | IError>;
     /**
      * Get one template object by marker.
-     *
      * @handleName getTemplateByMarker
-     *
-     * @param {string} marker - The unique marker of the template to retrieve. Example: "template_12345".
-     * @param {string} [langCode] - Language code. Default: "en_US".
-     * @return {ITemplateEntity} Returns a TemplateEntity object
+     * @param   {string}          marker     - The unique marker of the template to retrieve. Example: "template_12345".
+     * @param   {string}          [langCode] - Language code. Default: "en_US".
+     * @returns {ITemplateEntity}            Returns a TemplateEntity object
      * @throws {IError} - If there is an error during the fetch operation, it will return an error object.
      * @description Fetch a specific template object based on its unique marker.
      */

package/dist/templates/templatesApi.js

@@ -7,24 +7,25 @@ Object.defineProperty(exports, "__esModule", { value: true });
 const asyncModules_1 = __importDefault(require("../base/asyncModules"));
 /**
  * Controllers for working with template objects
- *
  * @module TemplateController
  * @handle /api/content/templates
- *
  * @description This module provides a set of controllers for handling operations related to template objects.
  */
 class TemplatesPreviewApi extends asyncModules_1.default {
+    /**
+     * Constructor for TemplatesApi class.
+     * @param {StateModule} state - The state module instance.
+     * @description Initializes the TemplatesApi class with the provided state module instance.
+     */
     constructor(state) {
         super(state);
         this._url = state.url + '/api/content/templates';
     }
     /**
      * Get all template objects grouped by types.
-     *
      * @handleName getAllTemplates
-     *
-     * @param {string} [langCode] - Language code. Default: "en_US".
-     * @return {Record<Types, ITemplateEntity[]>} Returns an object GroupedTemplatesObject, which contains an array of template objects TemplateEntity
+     * @param   {string}                           [langCode] - Language code. Default: "en_US".
+     * @returns {Record<Types, ITemplateEntity[]>}            Returns an object GroupedTemplatesObject, which contains an array of template objects TemplateEntity
      * @throws {IError} - If there is an error during the fetch operation, it will return an error object.
      * @description This function is designed to fetch organized template objects in groups based on their types.
      */
@@ -39,12 +40,10 @@ class TemplatesPreviewApi extends asyncModules_1.default {
     }
     /**
      * Get template objects by type.
-     *
      * @handleName getTemplateByType
-     *
-     * @param {Types} type - The type of templates to retrieve. This parameter specifies the category or classification of templates being requested. Example: "product".
-     * @param {string} [langCode] - Language code. Default: "en_US".
-     * @return {ITemplateEntity[]} Returns a TemplateEntity object.
+     * @param   {Types}             type       - The type of templates to retrieve. This parameter specifies the category or classification of templates being requested. Example: "product".
+     * @param   {string}            [langCode] - Language code. Default: "en_US".
+     * @returns {ITemplateEntity[]}            Returns a TemplateEntity object.
      * @throws {IError} - If there is an error during the fetch operation, it will return an error object.
      * @description Fetch template objects that belong to a specific type, with an optional filter by language.
      */
@@ -54,12 +53,10 @@ class TemplatesPreviewApi extends asyncModules_1.default {
     }
     /**
      * Get one template object by marker.
-     *
      * @handleName getTemplateByMarker
-     *
-     * @param {string} marker - The unique marker of the template to retrieve. Example: "template_12345".
-     * @param {string} [langCode] - Language code. Default: "en_US".
-     * @return {ITemplateEntity} Returns a TemplateEntity object
+     * @param   {string}          marker     - The unique marker of the template to retrieve. Example: "template_12345".
+     * @param   {string}          [langCode] - Language code. Default: "en_US".
+     * @returns {ITemplateEntity}            Returns a TemplateEntity object
      * @throws {IError} - If there is an error during the fetch operation, it will return an error object.
      * @description Fetch a specific template object based on its unique marker.
      */

package/dist/templates/templatesInterfaces.d.ts

@@ -1,57 +1,58 @@
 import type { AttributeType, IError, Types } from '../base/utils';
 /**
  * @interface ITemplatesApi
- *
- * @property {function} getAllTemplates - Get all template objects grouped by types.
- * @property {function} getTemplateByType - Get template objects by type.
- * @property {function} getTemplateByMarker - Getting a single template object.
- *
+ * @property {Function} getAllTemplates     - Get all template objects grouped by types.
+ * @property {Function} getTemplateByType   - Get template objects by type.
+ * @property {Function} getTemplateByMarker - Getting a single template object.
  * @description This interface defines methods for retrieving templates in the system, including fetching all templates, specific templates by type or ID, and by marker.
  */
 interface ITemplatesApi {
     /**
      * Get all template objects grouped by types.
-     *
-     * @param {string} [langCode] - Language code. Default: "en_US".
-     * @return {Record<Types, ITemplateEntity[]>} Returns an object GroupedTemplatesObject, which contains an array of template objects TemplateEntity
+     * @handleName getAllTemplates
+     * @param   {string}                           [langCode] - Language code. Default: "en_US".
+     * @returns {Record<Types, ITemplateEntity[]>}            Returns an object GroupedTemplatesObject, which contains an array of template objects TemplateEntity
      * @throws {IError} - If there is an error during the fetch operation, it will return an error object.
+     * @description This method gets all template objects grouped by types.
      */
     getAllTemplates(langCode?: string): Promise<Record<Types, ITemplateEntity[]> | IError>;
     /**
      * Get template objects by type.
-     *
-     * @param {Types} type - The type of templates to retrieve. This parameter specifies the category or classification of templates being requested. Example: "product".
-     * @param {string} [langCode] - Language code. Default: "en_US".
-     * @return {TemplateEntity[]} Returns a TemplateEntity object.
+     * @handleName getTemplateByType
+     * @param   {Types}             type       - The type of templates to retrieve. This parameter specifies the category or classification of templates being requested. Example: "product".
+     * @param   {string}            [langCode] - Language code. Default: "en_US".
+     * @returns {ITemplateEntity[]}            Returns a TemplateEntity object.
      * @throws {IError} - If there is an error during the fetch operation, it will return an error object.
+     * @description This method gets template objects by type.
      */
     getTemplateByType(type: Types, langCode: string): Promise<ITemplateEntity[] | IError>;
     /**
      * Get one template object by id.
-     *
-     * @param {string} marker - The unique marker of the template to retrieve. Example: "template_12345".
-     * @param {string} [langCode] - Language code. Default: "en_US".
-     * @return {ITemplateEntity} Returns a TemplateEntity object
+     * @handleName getTemplateByMarker
+     * @param   {string}          marker     - The unique marker of the template to retrieve. Example: "template_12345".
+     * @param   {string}          [langCode] - Language code. Default: "en_US".
+     * @returns {ITemplateEntity}            Returns a TemplateEntity object
      * @throws {IError} - If there is an error during the fetch operation, it will return an error object.
+     * @description This method gets one template object by id.
      */
     getTemplateByMarker(marker: string, langCode?: string): Promise<ITemplateEntity | IError>;
 }
 /**
+ * The template entity interface
  * @interface ITemplateEntity
- *
- * @property {number} id - The unique identifier of the position. Example: 12345.
+ * @property {number}        id                     - The unique identifier of the position. Example: 12345.
  * @property {string | null} attributeSetIdentifier - Set of attributes id. Example: "attribute_set_1".
- * @property {string} title - The name of the template. Example: "Product Template".
- * @property {number} generalTypeId - General type Entity id. Example: 67890.
- * @property {string} identifier - The textual identifier for the record field. Example: "template_12345".
- * @property {number} version - The version number of the object. Example: 1.
- * @property {Types} generalTypeName - General type name. Example: "product".
- * @property {AttributeType} attributeValues - Attribute values from the index (represented as a pair of user attribute id: attribute value). Example:
- * @property {number} position - The position of the object. Example: 1.
-    {
-      "id": 1,
-      "value": "some"
-    }
+ * @property {string}        title                  - The name of the template. Example: "Product Template".
+ * @property {number}        generalTypeId          - General type Entity id. Example: 67890.
+ * @property {string}        identifier             - The textual identifier for the record field. Example: "template_12345".
+ * @property {number}        version                - The version number of the object. Example: 1.
+ * @property {Types}         generalTypeName        - General type name. Example: "product".
+ * @property {AttributeType} attributeValues        - Attribute values from the index (represented as a pair of user attribute id: attribute value). Example:
+ * @property {number}        position               - The position of the object. Example: 1.
+                                                    {
+                                                    "id": 1,
+                                                    "value": "some"
+                                                    }
  * @description This interface defines the structure of a template entity, including its identifiers, attributes, and general type information.
  */
 interface ITemplateEntity {

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

@@ -4,34 +4,33 @@ import type { IError } from '../base/utils';
 import type { ITemplatesPreview, ITemplatesPreviewEntity } from './templatesPreviewInterfaces';
 /**
  * Controllers for working with template objects for preview.
- *
  * @handle /api/content/template-previews
- *
  * @description This module provides a set of controllers for managing and retrieving template objects designed for preview purposes.
  */
 export default class TemplatePreviewsApi extends AsyncModules implements ITemplatesPreview {
     protected state: StateModule;
     protected _url: string;
+    /**
+     * Constructor for the TemplatePreviewsApi class.
+     * @param {StateModule} state - The state module instance.
+     * @description Initializes the TemplatePreviewsApi class with the provided state module instance.
+     */
     constructor(state: StateModule);
     /**
      * Get all template objects.
-     *
      * @handleName getTemplatePreviews
-     *
-     * @param {string} [langCode] - Language code. Default: "en_US".
-     * @return {ITemplatesPreviewEntity[]} - Returns all TemplatePreviewsEntity template objects.
+     * @param   {string}                    [langCode] - Language code. Default: "en_US".
+     * @returns {ITemplatesPreviewEntity[]}            - Returns all TemplatePreviewsEntity template objects.
      * @throws {IError} - If there is an error during the fetch operation, it will return an error object.
      * @description This method is used to fetch all available template objects.
      */
     getTemplatePreviews(langCode?: string): Promise<ITemplatesPreviewEntity[] | IError>;
     /**
      * Retrieves a template object by its marker.
-     *
      * @handleName getTemplatePreviewByMarker
-     *
-     * @param {string} marker - The unique product marker used to identify the template. If not provided, a default behavior or error may occur. Example: "template_12345".
-     * @param {string} [langCode] - Language code. Default: "en_US".
-     * @return {TemplatePreviewsEntity} - A promise that resolves to a TemplatePreviewsEntity object representing the template.
+     * @param   {string}                                    marker     - The unique product marker used to identify the template. If not provided, a default behavior or error may occur. Example: "template_12345".
+     * @param   {string}                                    [langCode] - Language code. Default: "en_US".
+     * @returns {Promise<ITemplatesPreviewEntity | IError>}            - A promise that resolves to a TemplatePreviewsEntity object representing the template.
      * @throws {IError} - Throws an error object if there is an issue during the fetch operation.
      * @description This method is used to fetch a specific template object based on the provided marker.
      */

package/dist/templates-preview/templatesPreviewApi.js

@@ -6,23 +6,24 @@ Object.defineProperty(exports, "__esModule", { value: true });
 const asyncModules_1 = __importDefault(require("../base/asyncModules"));
 /**
  * Controllers for working with template objects for preview.
- *
  * @handle /api/content/template-previews
- *
  * @description This module provides a set of controllers for managing and retrieving template objects designed for preview purposes.
  */
 class TemplatePreviewsApi extends asyncModules_1.default {
+    /**
+     * Constructor for the TemplatePreviewsApi class.
+     * @param {StateModule} state - The state module instance.
+     * @description Initializes the TemplatePreviewsApi class with the provided state module instance.
+     */
     constructor(state) {
         super(state);
         this._url = state.url + '/api/content/template-previews';
     }
     /**
      * Get all template objects.
-     *
      * @handleName getTemplatePreviews
-     *
-     * @param {string} [langCode] - Language code. Default: "en_US".
-     * @return {ITemplatesPreviewEntity[]} - Returns all TemplatePreviewsEntity template objects.
+     * @param   {string}                    [langCode] - Language code. Default: "en_US".
+     * @returns {ITemplatesPreviewEntity[]}            - Returns all TemplatePreviewsEntity template objects.
      * @throws {IError} - If there is an error during the fetch operation, it will return an error object.
      * @description This method is used to fetch all available template objects.
      */
@@ -32,12 +33,10 @@ class TemplatePreviewsApi extends asyncModules_1.default {
     }
     /**
      * Retrieves a template object by its marker.
-     *
      * @handleName getTemplatePreviewByMarker
-     *
-     * @param {string} marker - The unique product marker used to identify the template. If not provided, a default behavior or error may occur. Example: "template_12345".
-     * @param {string} [langCode] - Language code. Default: "en_US".
-     * @return {TemplatePreviewsEntity} - A promise that resolves to a TemplatePreviewsEntity object representing the template.
+     * @param   {string}                                    marker     - The unique product marker used to identify the template. If not provided, a default behavior or error may occur. Example: "template_12345".
+     * @param   {string}                                    [langCode] - Language code. Default: "en_US".
+     * @returns {Promise<ITemplatesPreviewEntity | IError>}            - A promise that resolves to a TemplatePreviewsEntity object representing the template.
      * @throws {IError} - Throws an error object if there is an issue during the fetch operation.
      * @description This method is used to fetch a specific template object based on the provided marker.
      */