oneentry 1.0.123 → 1.0.125

package/dist/system/systemApi.d.ts

@@ -11,26 +11,56 @@ export default class SystemApi extends AsyncModules implements ISystem {
     protected _url: string;
     constructor(state: StateModule);
     /**
-     * test404
-     * @returns
+     * 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.
+     * @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>;
+    test404(): Promise<any | IError>;
     /**
-     * test500
-     * @returns
+     * 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.
+     * @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>;
+    test500(): Promise<any | IError>;
     /**
-     * validateCapcha
-     * @param event
-     * @param event.token -
-     * @param event.expectedAction -
-     * @param event.siteKey -
-     * @returns
+     * 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.
+     * @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.
      */
     validateCapcha(event: {
         token: string;
         expectedAction: string;
         siteKey: string;
     }): Promise<any | IError>;
+    /**
+     * Getting the number of requests to API.
+     *
+     * @handleName getApiStat
+     *
+     * @return {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.
+     */
+    getApiStat(): Promise<any | IError>;
 }

package/dist/system/systemApi.js

@@ -15,28 +15,48 @@ class SystemApi extends asyncModules_1.default {
         this._url = state.url + '/api/content/system';
     }
     /**
-     * test404
-     * @returns
+     * 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.
+     * @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.
      */
     async test404() {
         const result = await this._fetchGet('/test404');
         return result;
     }
     /**
-     * test500
-     * @returns
+     * 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.
+     * @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.
      */
     async test500() {
         const result = await this._fetchGet('/test500');
         return result;
     }
     /**
-     * validateCapcha
-     * @param event
-     * @param event.token -
-     * @param event.expectedAction -
-     * @param event.siteKey -
-     * @returns
+     * 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.
+     * @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.
      */
     async validateCapcha(event) {
         const data = {
@@ -45,5 +65,18 @@ class SystemApi extends asyncModules_1.default {
         const result = await this._fetchPost('/captcha/validate', data);
         return result;
     }
+    /**
+     * Getting the number of requests to API.
+     *
+     * @handleName getApiStat
+     *
+     * @return {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.
+     */
+    async getApiStat() {
+        const result = await this._fetchGet('/api-stat');
+        return result;
+    }
 }
 exports.default = SystemApi;

package/dist/system/systemInterfaces.d.ts

@@ -1,3 +1,10 @@
+/**
+ * @interface ISystem
+ *
+ * @property {function} test404 - Test 404 error.
+ * @property {function} test500 - Test 500 error.
+ * @description Represents a interface object of System Api.
+ */
 interface ISystem {
     test404(): Promise<any>;
     test500(): Promise<any>;

package/dist/templates/templatesApi.d.ts

@@ -4,7 +4,11 @@ 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;
@@ -13,36 +17,36 @@ export default class TemplatesPreviewApi extends AsyncModules implements ITempla
     /**
      * Get all template objects grouped by types.
      *
-     * @param {string} [langCode] - Optional parameter language code
+     * @handleName getAllTemplates
      *
-     * @returns Returns an object GroupedTemplatesObject, which contains an array of template objects TemplateEntity
+     * @param {string} [langCode] - Language code. Default: "en_US".
+     * @return {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>;
+    getAllTemplates(langCode?: string): Promise<Record<Types, ITemplateEntity[]> | IError>;
     /**
      * Get template objects by type.
      *
-     * @param {Types} [type] - type
-     * @param {string} [langCode] - Optional parameter language code
+     * @handleName getTemplateByType
      *
-     * @returns 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".
+     * @return {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<Array<ITemplateEntity> | IError>;
+    getTemplateByType(type: Types, langCode?: string): Promise<ITemplateEntity[] | IError>;
     /**
-     * Get one template object by id.
+     * Get one template object by marker.
      *
-     * @param {number} [id] - Template id
-     * @param {string} [langCode] - Optional parameter language code
+     * @handleName getTemplateByMarker
      *
-     * @returns Returns a TemplateEntity object
-     */
-    getTemplateById(id: number, langCode?: string): Promise<ITemplateEntity | IError>;
-    /**
-     * Get one template object by id.
-     *
-     * @param {number} [marker] - Template marker
-     * @param {string} [langCode] - Optional parameter language code
-     *
-     * @returns 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".
+     * @return {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.
      */
     getTemplateByMarker(marker: string, langCode?: string): Promise<ITemplateEntity | IError>;
 }

package/dist/templates/templatesApi.js

@@ -7,7 +7,11 @@ 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(state) {
@@ -17,9 +21,12 @@ class TemplatesPreviewApi extends asyncModules_1.default {
     /**
      * Get all template objects grouped by types.
      *
-     * @param {string} [langCode] - Optional parameter language code
+     * @handleName getAllTemplates
      *
-     * @returns Returns an object GroupedTemplatesObject, which contains an array of template objects TemplateEntity
+     * @param {string} [langCode] - Language code. Default: "en_US".
+     * @return {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.
      */
     async getAllTemplates(langCode = this.state.lang) {
         const response = await this._fetchGet(`/all?langCode=${langCode}`);
@@ -33,34 +40,28 @@ class TemplatesPreviewApi extends asyncModules_1.default {
     /**
      * Get template objects by type.
      *
-     * @param {Types} [type] - type
-     * @param {string} [langCode] - Optional parameter language code
+     * @handleName getTemplateByType
      *
-     * @returns 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".
+     * @return {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.
      */
     async getTemplateByType(type, langCode = this.state.lang) {
         const result = await this._fetchGet(`?type=${type}&langCode=${langCode}`);
         return this._normalizeData(result);
     }
     /**
-     * Get one template object by id.
+     * Get one template object by marker.
      *
-     * @param {number} [id] - Template id
-     * @param {string} [langCode] - Optional parameter language code
+     * @handleName getTemplateByMarker
      *
-     * @returns Returns a TemplateEntity object
-     */
-    async getTemplateById(id, langCode = this.state.lang) {
-        const result = await this._fetchGet(`/${id}?langCode=${langCode}`);
-        return this._normalizeData(result);
-    }
-    /**
-     * Get one template object by id.
-     *
-     * @param {number} [marker] - Template marker
-     * @param {string} [langCode] - Optional parameter language code
-     *
-     * @returns 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".
+     * @return {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.
      */
     async getTemplateByMarker(marker, langCode = this.state.lang) {
         const result = await this._fetchGet(`/marker/${marker}?langCode=${langCode}`);

package/dist/templates/templatesInterfaces.d.ts

@@ -1,42 +1,68 @@
 import type { AttributeType, IError, Types } from '../base/utils';
 /**
- * Represents an interface object of Templates Api.
+ * @interface ITemplatesApi
  *
  * @property {function} getAllTemplates - Get all template objects grouped by types.
  * @property {function} getTemplateByType - Get template objects by type.
- * @property {function} getTemplateById - Get one template object by id.
  * @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 {
-    getAllTemplates(langCode?: string): Promise<Record<Types, ITemplateEntity> | IError>;
-    getTemplateByType(type: Types, langCode: string): Promise<Array<ITemplateEntity> | IError>;
-    getTemplateById(id: number): Promise<ITemplateEntity | IError>;
+    /**
+     * 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
+     * @throws {IError} - If there is an error during the fetch operation, it will return an error object.
+     */
+    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.
+     * @throws {IError} - If there is an error during the fetch operation, it will return an error object.
+     */
+    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
+     * @throws {IError} - If there is an error during the fetch operation, it will return an error object.
+     */
     getTemplateByMarker(marker: string, langCode?: string): Promise<ITemplateEntity | IError>;
 }
 /**
- * Represents a template entity object.
- *
- * @interface
- * @property {number} id - The unique identifier of the position.
- * @property {number} version - The version number of the object.
- * @property {string} identifier - The textual identifier for the record field.
- * @property {number} generalTypeId - General type Entity id.
- * @property {string} title - The name of the template.
- * @property {number} position - The position of the object.
- * @property {Types} generalTypeName - General type name.
- * @property {string} attributeSetIdentifier - Set of attributes id.
- * @property {AttributeType} attributeValues - Attribute values from the index (represented as a pair of user attribute id: attribute value).
+ * @interface ITemplateEntity
  *
+ * @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"
+    }
+ * @description This interface defines the structure of a template entity, including its identifiers, attributes, and general type information.
  */
 interface ITemplateEntity {
     id: number;
-    version: number;
-    identifier: string;
-    generalTypeId: number;
+    attributeSetIdentifier: string | null;
     title: string;
-    position: number;
+    generalTypeId: number;
+    identifier: string;
+    version: number;
     generalTypeName: Types;
     attributeValues: AttributeType;
-    attributeSetIdentifier: string | null;
+    position: number;
 }
 export type { ITemplateEntity, ITemplatesApi };

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

@@ -3,8 +3,11 @@ import type StateModule from '../base/stateModule';
 import type { IError } from '../base/utils';
 import type { ITemplatesPreview, ITemplatesPreviewEntity } from './templatesPreviewInterfaces';
 /**
- * Controllers for working with template objects for preview
+ * 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;
@@ -13,27 +16,24 @@ export default class TemplatePreviewsApi extends AsyncModules implements ITempla
     /**
      * Get all template objects.
      *
-     * @param {string} [langCode] - Optional parameter language code
+     * @handleName getTemplatePreviews
      *
-     * @returns Returns all TemplatePreviewsEntity template objects
+     * @param {string} [langCode] - Language code. Default: "en_US".
+     * @return {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<Array<ITemplatesPreviewEntity> | IError>;
+    getTemplatePreviews(langCode?: string): Promise<ITemplatesPreviewEntity[] | IError>;
     /**
-     * Get one template object by id.
+     * Retrieves a template object by its marker.
      *
-     * @param {number} [id] - Product marker
-     * @param {string} [langCode] - Optional parameter language code
+     * @handleName getTemplatePreviewByMarker
      *
-     * @returns Returns a TemplatePreviewsEntity object
-     */
-    getTemplatePreviewById(id: number, langCode?: string): Promise<ITemplatesPreviewEntity | IError>;
-    /**
-     * Get one template object by marker.
-     *
-     * @param {string} [marker] - Product marker
-     * @param {string} [langCode] - Optional parameter language code
-     *
-     * @returns Returns a TemplatePreviewsEntity object
+     * @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.
+     * @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.
      */
     getTemplatePreviewByMarker(marker: string, langCode?: string): Promise<ITemplatesPreviewEntity | IError>;
 }

package/dist/templates-preview/templatesPreviewApi.js

@@ -5,8 +5,11 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 Object.defineProperty(exports, "__esModule", { value: true });
 const asyncModules_1 = __importDefault(require("../base/asyncModules"));
 /**
- * Controllers for working with template objects for preview
+ * 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(state) {
@@ -16,33 +19,27 @@ class TemplatePreviewsApi extends asyncModules_1.default {
     /**
      * Get all template objects.
      *
-     * @param {string} [langCode] - Optional parameter language code
+     * @handleName getTemplatePreviews
      *
-     * @returns Returns all TemplatePreviewsEntity template objects
+     * @param {string} [langCode] - Language code. Default: "en_US".
+     * @return {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.
      */
     async getTemplatePreviews(langCode = this.state.lang) {
         const result = await this._fetchGet(`?langCode=${langCode}`);
         return this._normalizeData(result, langCode);
     }
     /**
-     * Get one template object by id.
+     * Retrieves a template object by its marker.
      *
-     * @param {number} [id] - Product marker
-     * @param {string} [langCode] - Optional parameter language code
+     * @handleName getTemplatePreviewByMarker
      *
-     * @returns Returns a TemplatePreviewsEntity object
-     */
-    async getTemplatePreviewById(id, langCode = this.state.lang) {
-        const result = await this._fetchGet(`/${id}?langCode=${langCode}`);
-        return this._normalizeData(result, langCode);
-    }
-    /**
-     * Get one template object by marker.
-     *
-     * @param {string} [marker] - Product marker
-     * @param {string} [langCode] - Optional parameter language code
-     *
-     * @returns Returns a TemplatePreviewsEntity object
+     * @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.
+     * @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.
      */
     async getTemplatePreviewByMarker(marker, langCode = this.state.lang) {
         const result = await this._fetchGet(`/marker/${marker}?langCode=${langCode}`);