oneentry 1.0.126 → 1.0.127

package/dist/integration-collections/integrationCollectionsInterfaces.d.ts

@@ -1,36 +1,36 @@
 import type { IError, ILocalizeInfo } from '../base/utils';
 /**
  * @interface ICollectionsApi
- *
- * @property {function} getICollections - Get all collections.
- * @property {function} getICollectionById - Get a single collection object.
- * @property {function} getICollectionRowsById - Get all records belonging to the collection by collection id.
- * @property {function} validateICollectionMarker - Check for the existence of a text identifier (marker).
- * @property {function} getICollectionRowsByMarker - Getting all records (row) from the collection.
- * @property {function} getICollectionRowByMarkerAndId - Getting one record (rows) from the collection.
- * @property {function} createICollectionRow - Create a record (row) in the collection.
- * @property {function} updateICollectionRow - Edit a record (row) in the collection.
- * @property {function} deleteICollectionRowByMarkerAndId - Deletion of collection record object (row).
+ * @property {Function} getICollections                   - Get all collections.
+ * @property {Function} getICollectionById                - Get a single collection object.
+ * @property {Function} getICollectionRowsById            - Get all records belonging to the collection by collection id.
+ * @property {Function} validateICollectionMarker         - Check for the existence of a text identifier (marker).
+ * @property {Function} getICollectionRowsByMarker        - Getting all records (row) from the collection.
+ * @property {Function} getICollectionRowByMarkerAndId    - Getting one record (rows) from the collection.
+ * @property {Function} createICollectionRow              - Create a record (row) in the collection.
+ * @property {Function} updateICollectionRow              - Edit a record (row) in the collection.
+ * @property {Function} deleteICollectionRowByMarkerAndId - Deletion of collection record object (row).
  * @description This interface defines methods for managing collections and their records in the system.
  */
 interface ICollectionsApi {
     /**
      * Get all collections.
-     *
-     * @param {string} [langCode] - Language code. Default: "en_US".
-     * @param {any} [userQuery] - Query parameters. Example:
-        {
-          "limit": 30,
-          "offset": 0,
-          "entityType": "orders",
-          "entityId": 1
-        }
-     * @param {number} [userQuery.limit] - Parameter for pagination. Default: 0.
-     * @param {number} [userQuery.offset] - Parameter for pagination. Default: 30.
-     * @param {string} [userQuery.entityType] - Entity type. Example: "orders".
-     * @param {number} [userQuery.entityId] - Entity identifier. Example: 1.
-     * @return {ICollectionEntity[]} Returns an array of ICollection objects or an error object if there was an issue.
+     * @handleName getICollections
+     * @param   {string}              [langCode]             - Language code. Default: "en_US".
+     * @param   {any}                 [userQuery]            - Query parameters. Example:
+                                                             {
+                                                             "limit": 30,
+                                                             "offset": 0,
+                                                             "entityType": "orders",
+                                                             "entityId": 1
+                                                             }
+     * @param   {number}              [userQuery.limit]      - Parameter for pagination. Default: 0.
+     * @param   {number}              [userQuery.offset]     - Parameter for pagination. Default: 30.
+     * @param   {string}              [userQuery.entityType] - Entity type. Example: "orders".
+     * @param   {number}              [userQuery.entityId]   - Entity identifier. Example: 1.
+     * @returns {ICollectionEntity[]}                        Returns an array of ICollection objects or an error object if there was an issue.
      * @throws {IError} - If there is an error during the fetch operation, it will return an error object.
+     * @description This method gets all collections.
      */
     getICollections(langCode: string, userQuery?: {
         limit: number;
@@ -40,129 +40,137 @@ interface ICollectionsApi {
     }): Promise<ICollectionEntity[] | IError>;
     /**
      * Get a single collection object by id.
-     *
-     * @param {number} id - Collection id. Example: 1.
-     * @param {string} [langCode] - Language code. Default: "en_US".
-     * @return {ICollectionEntity} Returns an ICollection object or an error object if there was an issue.
+     * @handleName getICollectionById
+     * @param   {number}            id         - Collection id. Example: 1.
+     * @param   {string}            [langCode] - Language code. Default: "en_US".
+     * @returns {ICollectionEntity}            Returns an ICollection object or an error object if there was an issue.
      * @throws {IError} - If there is an error during the fetch operation, it will return an error object.
+     * @description This method gets a single collection object by id.
      */
     getICollectionById(id: number, langCode: string): Promise<ICollectionEntity | IError>;
     /**
      * Get all records belonging to the collection by collection id.
-     *
-     * @param {number} id - Collection id.
-     * @param {string} [langCode] - Language code. Default: "en_US".
-     * @param {any} [userQuery] - Optional set query parameters. Example:
-        {
-          "limit": 30,
-          "offset": 0,
-          "entityType": "orders",
-          "entityId": 1
-        }
-     * @param {number} [userQuery.limit] - Optional parameter for pagination. Default: 30.
-     * @param {number} [userQuery.offset] - Optional parameter for pagination. Default: 0.
-     * @param {number} [userQuery.entityType] - Entity type. Example: "orders".
-     * @param {number} [userQuery.entityId] - Entity identifier. Example: 1.
-     * @return {ICollectionRowsResponce} Returns object ItemsWithTotal, where items is an array of requested objects.
+     * @handleName getICollectionRowsById
+     * @param   {number}                  id                     - Collection id.
+     * @param   {string}                  [langCode]             - Language code. Default: "en_US".
+     * @param   {any}                     [userQuery]            - Optional set query parameters. Example:
+                                                                 {
+                                                                 "limit": 30,
+                                                                 "offset": 0,
+                                                                 "entityType": "orders",
+                                                                 "entityId": 1
+                                                                 }
+     * @param   {number}                  [userQuery.limit]      - Optional parameter for pagination. Default: 30.
+     * @param   {number}                  [userQuery.offset]     - Optional parameter for pagination. Default: 0.
+     * @param   {number}                  [userQuery.entityType] - Entity type. Example: "orders".
+     * @param   {number}                  [userQuery.entityId]   - Entity identifier. Example: 1.
+     * @returns {ICollectionRowsResponce}                        Returns object ItemsWithTotal, where items is an array of requested objects.
      * @throws {IError} - If there is an error during the fetch operation, it will return an error object.
+     * @description This method gets all records belonging to the collection by collection id.
      */
     getICollectionRowsById(id: number, langCode: string, userQuery?: any): Promise<ICollectionRowsResponce | IError>;
     /**
      * Check for the existence of a text identifier (marker).
-     *
-     * @param {string} marker - Collection marker. Example: "collection1".
-     * @return {ICollectionIsValid} Returns an object with a boolean property `valid` indicating whether the marker is valid or not. Example:
-        {
-          "valid": true
-        }
+     * @handleName validateICollectionMarker
+     * @param   {string}             marker - Collection marker. Example: "collection1".
+     * @returns {ICollectionIsValid}        Returns an object with a boolean property `valid` indicating whether the marker is valid or not. Example:
+                                            {
+                                            "valid": true
+                                            }
      * @throws {IError} - If there is an error during the fetch operation, it will return an error object.
+     * @description This method checks for the existence of a text identifier (marker).
      */
-    validateICollectionMarker(marker: string): Promise<any | IError>;
+    validateICollectionMarker(marker: string): Promise<ICollectionIsValid | IError>;
     /**
      * Getting all records from the collection.
-     *
-     * @param {string} marker - Collection text identifier. Example: "collection1".
-     * @param {string} [langCode] - Language code. Default: "en_US".
-     * @return {ICollectionRowsResponce} Returns collection row entity object.
+     * @handleName getICollectionRowsByMarker
+     * @param   {string}                  marker     - Collection text identifier. Example: "collection1".
+     * @param   {string}                  [langCode] - Language code. Default: "en_US".
+     * @returns {ICollectionRowsResponce}            Returns collection row entity object.
      * @throws {IError} - If there is an error during the fetch operation, it will return an error object.
+     * @description This method gets all records from the collection.
      */
     getICollectionRowsByMarker(marker: string, langCode?: string): Promise<ICollectionRowsResponce | IError>;
     /**
      * Getting one record from the collection.
-     *
-     * @param {string} marker - Collection text identifier. Example: "collection1".
-     * @param {number} id - Collection record identifier. Example: 1.
-     * @param {string} [langCode] - Language code. Default: "en_US".
-     * @return {ICollectionRow} Returns collection row entity object.
+     * @handleName getICollectionRowByMarkerAndId
+     * @param   {string}         marker     - Collection text identifier. Example: "collection1".
+     * @param   {number}         id         - Collection record identifier. Example: 1.
+     * @param   {string}         [langCode] - Language code. Default: "en_US".
+     * @returns {ICollectionRow}            Returns collection row entity object.
      * @throws {IError} - If there is an error during the fetch operation, it will return an error object.
+     * @description This method gets one record from the collection.
      */
     getICollectionRowByMarkerAndId(marker: string, id: number, langCode: string): Promise<ICollectionRow | IError>;
     /**
      * Create a record in the collection.
-     *
-     * @param {string} marker - Collection text identifier. Example: "collection1".
-     * @param {ICollectionFormObject} body - Object for creating a record. Example:
-        {
-          "formIdentifier": "collection-form",
-          "formData": {
-            "en_US": [
-              {
-                "marker": "collection_marker",
-                "type": "string",
-                "value": "Collection marker"
-              }
-            ]
-          }
-        }
-     * @param {string} [langCode] - Language code. Default: "en_US".
-     * @return {any} Returns object of type ICollectionRow.
+     * @handleName createICollectionRow
+     * @param   {string}                marker     - Collection text identifier. Example: "collection1".
+     * @param   {ICollectionFormObject} body       - Object for creating a record. Example:
+                                                   {
+                                                   "formIdentifier": "collection-form",
+                                                   "formData": {
+                                                   "en_US": [
+                                                   {
+                                                   "marker": "collection_marker",
+                                                   "type": "string",
+                                                   "value": "Collection marker"
+                                                   }
+                                                   ]
+                                                   }
+                                                   }
+     * @param   {string}                [langCode] - Language code. Default: "en_US".
+     * @returns {any}                              Returns object of type ICollectionRow.
      * @throws {IError} - If there is an error during the fetch operation, it will return an error object.
+     * @description This method creates a record in the collection.
      */
     createICollectionRow(marker: string, body: ICollectionFormObject, langCode: string): Promise<any | IError>;
     /**
      * Edit a record in the collection.
-     *
-     * @param {string} marker - Text identifier of the collection. Example: "collection1".
-     * @param {number} id - Row id. Example: 12.
-     * @param {ICollectionFormObject} body - Object for updating a record in the collection. Example:
-        {
-          "formIdentifier": "collection-form",
-          "formData": {
-            "en_US": [
-              {
-                "marker": "collection_marker",
-                "type": "string",
-                "value": "Collection marker"
-              }
-            ]
-          }
-        }
-     * @param {string} [langCode] - Language code. Default: "en_US".
-     * @return {ICollectionRow} Returns object of type ICollectionRow.
+     * @handleName updateICollectionRow
+     * @param   {string}                marker     - Text identifier of the collection. Example: "collection1".
+     * @param   {number}                id         - Row id. Example: 12.
+     * @param   {ICollectionFormObject} body       - Object for updating a record in the collection. Example:
+                                                   {
+                                                   "formIdentifier": "collection-form",
+                                                   "formData": {
+                                                   "en_US": [
+                                                   {
+                                                   "marker": "collection_marker",
+                                                   "type": "string",
+                                                   "value": "Collection marker"
+                                                   }
+                                                   ]
+                                                   }
+                                                   }
+     * @param   {string}                [langCode] - Language code. Default: "en_US".
+     * @returns {ICollectionRow}                   Returns object of type ICollectionRow.
      * @throws {IError} - If there is an error during the fetch operation, it will return an error object.
+     * @description This method edits a record in the collection.
      */
     updateICollectionRow(marker: string, id: number, body: ICollectionFormObject, langCode: string): Promise<any | IError>;
     /**
      * Deletion of collection record object
-     *
-     * @param {string} marker - text identifier of the collection Example: "collection1".
-     * @param {number} id - record identifier in the collection Example: 12.
-     * @return {boolean} Returns true (in case of successful deletion) or false (in case of unsuccessful deletion) (permission "collections.row.delete" required for access)
+     * @handleName deleteICollectionRowByMarkerAndId
+     * @param   {string}  marker - text identifier of the collection Example: "collection1".
+     * @param   {number}  id     - record identifier in the collection Example: 12.
+     * @returns {boolean}        Returns true (in case of successful deletion) or false (in case of unsuccessful deletion) (permission "collections.row.delete" required for access)
      * @throws {IError} - If there is an error during the fetch operation, it will return an error object.
+     * @description This method deletes a collection record object.
      */
     deleteICollectionRowByMarkerAndId(marker: string, id: number): Promise<any | IError>;
 }
 /**
+ * Collection object
  * @interface ICollectionEntity
- *
- * @property {number} id - Object identifier. Example: 1.
- * @property {string | null} identifier - Text identifier for record field. Example: "collection1".
- * @property {number | null} formId - Identifier for the form used by the order storage. Example: 1234.
- * @property {ILocalizeInfo} localizeInfos - Localized information about the collection. Example:
-    {
-      "title": "Admins text"
-    }
- * @property {string | null} attributeSetId - Identifier of the set of attributes used by the form attached to the collection. Example: "attributeSet1" or null if not applicable.
+ * @property {number}        id                       - Object identifier. Example: 1.
+ * @property {string | null} identifier               - Text identifier for record field. Example: "collection1".
+ * @property {number | null} formId                   - Identifier for the form used by the order storage. Example: 1234.
+ * @property {ILocalizeInfo} localizeInfos            - Localized information about the collection. Example:
+                                                      {
+                                                      "title": "Admins text"
+                                                      }
+ * @property {string | null} attributeSetId           - Identifier of the set of attributes used by the form attached to the collection. Example: "attributeSet1" or null if not applicable.
  * @property {string | null} selectedAttributeMarkers - Text identifiers of form object attributes for display in the data table. Example: "collection_marker".
  * @description Represents a collection object with various properties, including identifiers, form information, and localized data.
  */
@@ -175,16 +183,16 @@ interface ICollectionEntity {
     selectedAttributeMarkers: string | null;
 }
 /**
+ * Collection response object
  * @interface ICollectionResponce
- *
  * @property {ICollectionEntity[]} items - Array of collection objects. Example:
-    [
-      {
-        "id": 1,
-        "identifier": "collection1"
-      }
-    ]
- * @property {number} total - Total number of found records. Example: 10.
+                                         [
+                                         {
+                                         "id": 1,
+                                         "identifier": "collection1"
+                                         }
+                                         ]
+ * @property {number}              total - Total number of found records. Example: 10.
  * @description Represents a response from the collections API containing a total count and an array of collection objects.
  */
 interface ICollectionResponce {
@@ -192,11 +200,11 @@ interface ICollectionResponce {
     total: number;
 }
 /**
+ * Collection form data object
  * @interface ICollectionFormData
- *
  * @property {string} marker - Text identifier (marker) of the form field. Example: "collection_marker".
- * @property {string} type - Type of the form field, such as "text", "number", "date", "etc". Example: "number".
- * @property {string} value - Value of the form field, which can be a "string", "number", "date", "etc". Example: "Collection marker".
+ * @property {string} type   - Type of the form field, such as "text", "number", "date", "etc". Example: "number".
+ * @property {string} value  - Value of the form field, which can be a "string", "number", "date", "etc". Example: "Collection marker".
  * @description Represents a form data object within a collection, containing a marker, type, and value.
  */
 interface ICollectionFormData {
@@ -205,20 +213,20 @@ interface ICollectionFormData {
     value: string;
 }
 /**
+ * Collection form object
  * @interface ICollectionFormObject
- *
- * @property {string} formIdentifier - Text identifier (marker) of the form. Example: "collection-form".
- * @property {Record<string, ICollectionFormData>} formData - An object where keys are form field markers and values are arrays of ICollectionFormData objects. Example:
-    [
-      {
-        "marker": "name_1",
-        "type": "string",
-        "value": "Value"
-      }
-    ]
- * @property {string} formData[index].marker - Text identifier (marker) of the form field. Example: "name_1".
- * @property {string} formData[index].type - Type of the form field. Example: "string".
- * @property {string} formData[index].value - Value of the form field. Example: "Value".
+ * @property {string}                              formIdentifier         - Text identifier (marker) of the form. Example: "collection-form".
+ * @property {Record<string, ICollectionFormData>} formData               - An object where keys are form field markers and values are arrays of ICollectionFormData objects. Example:
+                                                                          [
+                                                                          {
+                                                                          "marker": "name_1",
+                                                                          "type": "string",
+                                                                          "value": "Value"
+                                                                          }
+                                                                          ]
+ * @property {string}                              formData[index].marker - Text identifier (marker) of the form field. Example: "name_1".
+ * @property {string}                              formData[index].type   - Type of the form field. Example: "string".
+ * @property {string}                              formData[index].value  - Value of the form field. Example: "Value".
  * @description Represents a collection form object that contains a form identifier and associated form data. This interface defines the structure of a collection form object, which includes a form identifier and a set of form data organized by markers.
  */
 interface ICollectionFormObject {
@@ -228,24 +236,24 @@ interface ICollectionFormObject {
     };
 }
 /**
+ * Collection row object
  * @interface ICollectionRow
- *
- * @property {number} id - Object identifier. Example: 1.
- * @property {string} createdDate - Date of creation of the record. Example: "2023-01-01T00:00:00Z".
- * @property {string} updatedDate - Date of last update of the record. Example: "2023-01-02T00:00:00Z".
- * @property {number | null} [collectionId] - collectionId associated with the collection row. Example: "product", "order", "etc".
- * @property {ICollectionFormData[]} formData - Array of form data objects associated with the collection row. Example:
-    [
-      {
-        "marker": "name_1",
-        "type": "string",
-        "value": "Value"
-      }
-    ]
- * @property {string | null} entityType - Type of the entity associated with the collection row. Example: "product", "order", "etc".
- * @property {number | null} entityId - Identifier of the entity associated with the collection row. Example: 12345.
- * @property {string | null} [attributeSetIdentifier] - Identifier of the attribute set used by the form attached to the collection row, or null if not applicable. Example: "attributeSet1" or null.
- * @property {string} total - Total count. Example: "1".
+ * @property {number}                id                       - Object identifier. Example: 1.
+ * @property {string}                createdDate              - Date of creation of the record. Example: "2023-01-01T00:00:00Z".
+ * @property {string}                updatedDate              - Date of last update of the record. Example: "2023-01-02T00:00:00Z".
+ * @property {number | null}         [collectionId]           - collectionId associated with the collection row. Example: "product", "order", "etc".
+ * @property {ICollectionFormData[]} formData                 - Array of form data objects associated with the collection row. Example:
+                                                              [
+                                                              {
+                                                              "marker": "name_1",
+                                                              "type": "string",
+                                                              "value": "Value"
+                                                              }
+                                                              ]
+ * @property {string | null}         entityType               - Type of the entity associated with the collection row. Example: "product", "order", "etc".
+ * @property {number | null}         entityId                 - Identifier of the entity associated with the collection row. Example: 12345.
+ * @property {string | null}         [attributeSetIdentifier] - Identifier of the attribute set used by the form attached to the collection row, or null if not applicable. Example: "attributeSet1" or null.
+ * @property {string}                total                    - Total count. Example: "1".
  * @description Represents a row in a collection, containing various properties such as identifiers, dates, form data, and an optional total value.
  */
 interface ICollectionRow {
@@ -257,30 +265,30 @@ interface ICollectionRow {
     entityType: string | null;
     entityId: number | null;
     attributeSetIdentifier?: string | null;
-    total: string;
+    total?: string;
 }
 /**
+ * Collection rows response object
  * @interface ICollectionRowsResponce
- *
  * @property {ICollectionRow[]} items - Array of collection row objects. Example:
-    [
-      {
-        "id": 1,
-        "createdDate": "2025-06-06T19:08:54.616Z",
-        "updatedDate": "2025-06-06T19:08:54.616Z",
-        "entityId": null,
-        "entityType": null,
-        "formData": [
-          {
-            "marker": "name_1",
-            "type": "string",
-            "value": "Value"
-          }
-        ],
-        "attributeSetIdentifier": null
-      }
-    ]
- * @property {number} total - Total number of found records. Example: 10.
+                                      [
+                                      {
+                                      "id": 1,
+                                      "createdDate": "2025-06-06T19:08:54.616Z",
+                                      "updatedDate": "2025-06-06T19:08:54.616Z",
+                                      "entityId": null,
+                                      "entityType": null,
+                                      "formData": [
+                                      {
+                                      "marker": "name_1",
+                                      "type": "string",
+                                      "value": "Value"
+                                      }
+                                      ],
+                                      "attributeSetIdentifier": null
+                                      }
+                                      ]
+ * @property {number}           total - Total number of found records. Example: 10.
  * @description Represents a response from the collections API containing a total count and an array of collection row objects.
  */
 interface ICollectionRowsResponce {
@@ -288,8 +296,8 @@ interface ICollectionRowsResponce {
     total: number;
 }
 /**
+ * Collection is valid object
  * @interface ICollectionIsValid
- *
  * @property {boolean} valid - Valid marker object. Example: true.
  * @description Represents a response from the validateICollectionMarker.
  */

package/dist/locales/localesApi.d.ts

@@ -5,17 +5,21 @@ import type { ILocalEntity, ILocales } from './localesInterfaces';
 /**
  * Controllers for working with localizations (content language)
  * @handle /api/content/locales
+ * @description Controllers for working with localizations (content language)
  */
 export default class LocalesApi extends AsyncModules implements ILocales {
     protected state: StateModule;
     protected _url: string;
+    /**
+     * Constructor
+     * @param {StateModule} state - StateModule instance
+     * @description Constructor initializes the LocalesApi with a given state.
+     */
     constructor(state: StateModule);
     /**
      * Find all active language localization objects.
-     *
      * @handleName getLocales
-     *
-     * @return {ILocalEntity[]} Returns an array of LocaleEntity objects.
+     * @returns {ILocalEntity[]} Returns an array of LocaleEntity objects.
      * @throws {IError} - If there is an error during the fetch operation, it will return an error object.
      * @description Find all active language localization objects.
      */

package/dist/locales/localesApi.js

@@ -7,18 +7,22 @@ const asyncModules_1 = __importDefault(require("../base/asyncModules"));
 /**
  * Controllers for working with localizations (content language)
  * @handle /api/content/locales
+ * @description Controllers for working with localizations (content language)
  */
 class LocalesApi extends asyncModules_1.default {
+    /**
+     * Constructor
+     * @param {StateModule} state - StateModule instance
+     * @description Constructor initializes the LocalesApi with a given state.
+     */
     constructor(state) {
         super(state);
         this._url = state.url + '/api/content/locales';
     }
     /**
      * Find all active language localization objects.
-     *
      * @handleName getLocales
-     *
-     * @return {ILocalEntity[]} Returns an array of LocaleEntity objects.
+     * @returns {ILocalEntity[]} Returns an array of LocaleEntity objects.
      * @throws {IError} - If there is an error during the fetch operation, it will return an error object.
      * @description Find all active language localization objects.
      */

package/dist/locales/localesInterfaces.d.ts

@@ -1,30 +1,31 @@
 import type { IError } from '../base/utils';
 /**
+ * The `ILocales` interface defines methods for working with language localization objects in the system.
  * @interface ILocales
- *
- * @property {function} getLocales - Find all active language localization objects.
+ * @property {Function} getLocales - Find all active language localization objects.
  * @description This interface defines a method for retrieving all active language localization objects in the system.
  */
 interface ILocales {
     /**
      * Find all active language localization objects.
-     *
-     * @return {ILocalEntity[]} Returns an array of LocaleEntity objects.
+     * @handleName getLocales
+     * @returns {ILocalEntity[]} Returns an array of LocaleEntity objects.
      * @throws {IError} - If there is an error during the fetch operation, it will return an error object.
+     * @description This method finds all active language localization objects.
      */
     getLocales(): Promise<ILocalEntity[] | IError>;
 }
 /**
+ * The `ILocalEntity` interface defines the structure of a locales entity, including its identifiers, name, and other properties.
  * @interface ILocalEntity
- *
- * @property {number} id - The unique identifier of the locales. Example: 1.
- * @property {string} shortCode - The shortCode of locales. Example: "en".
- * @property {string} code - The full language code. Example: "en_US".
- * @property {string} name - The language name. Example: "English".
- * @property {string} nativeName - The native language name. Example: "English".
- * @property {boolean} isActive - Active language flag. Example: true.
- * @property {string | null} image - The language image. Example: "https://example.com/images/en.png".
- * @property {number} position - The language position. Example: 1.
+ * @property {number}        id         - The unique identifier of the locales. Example: 1.
+ * @property {string}        shortCode  - The shortCode of locales. Example: "en".
+ * @property {string}        code       - The full language code. Example: "en_US".
+ * @property {string}        name       - The language name. Example: "English".
+ * @property {string}        nativeName - The native language name. Example: "English".
+ * @property {boolean}       isActive   - Active language flag. Example: true.
+ * @property {string | null} image      - The language image. Example: "https://example.com/images/en.png".
+ * @property {number}        position   - The language position. Example: 1.
  * @description This interface defines the structure of a locales entity, including its identifiers, name, and other properties.
  */
 interface ILocalEntity {

package/dist/menus/menusApi.d.ts

@@ -5,19 +5,23 @@ import type { IMenus, IMenusEntity } from './menusInterfaces';
 /**
  * Controllers for working with menu objects
  * @handle /api/content/menus
+ * @description Controllers for working with menu objects
  */
 export default class MenusApi extends AsyncModules implements IMenus {
     protected state: StateModule;
     protected _url: string;
+    /**
+     * Constructor initializes the MenusApi with a given state.
+     * @param {StateModule} state - The state module.
+     * @description Constructor initializes the MenusApi with a given state.
+     */
     constructor(state: StateModule);
     /**
      * Get pages includes in menu by marker.
-     *
      * @handleName getMenusByMarker
-     *
-     * @param {string} marker - Menu marker. Example: "main_menu".
-     * @param {string} [langCode] - Language code. Default: "en_US".
-     * @return {IMenusEntity} Returns a single menu object as a ContentMenu object with included pages.
+     * @param   {string}       marker     - Menu marker. Example: "main_menu".
+     * @param   {string}       [langCode] - Language code. Default: "en_US".
+     * @returns {IMenusEntity}            Returns a single menu object as a ContentMenu object with included pages.
      * @throws {IError} - If there is an error during the fetch operation, it will return an error object.
      * @description Get pages includes in menu by marker.
      */

package/dist/menus/menusApi.js

@@ -7,20 +7,24 @@ const asyncModules_1 = __importDefault(require("../base/asyncModules"));
 /**
  * Controllers for working with menu objects
  * @handle /api/content/menus
+ * @description Controllers for working with menu objects
  */
 class MenusApi extends asyncModules_1.default {
+    /**
+     * Constructor initializes the MenusApi with a given state.
+     * @param {StateModule} state - The state module.
+     * @description Constructor initializes the MenusApi with a given state.
+     */
     constructor(state) {
         super(state);
         this._url = state.url + '/api/content/menus';
     }
     /**
      * Get pages includes in menu by marker.
-     *
      * @handleName getMenusByMarker
-     *
-     * @param {string} marker - Menu marker. Example: "main_menu".
-     * @param {string} [langCode] - Language code. Default: "en_US".
-     * @return {IMenusEntity} Returns a single menu object as a ContentMenu object with included pages.
+     * @param   {string}       marker     - Menu marker. Example: "main_menu".
+     * @param   {string}       [langCode] - Language code. Default: "en_US".
+     * @returns {IMenusEntity}            Returns a single menu object as a ContentMenu object with included pages.
      * @throws {IError} - If there is an error during the fetch operation, it will return an error object.
      * @description Get pages includes in menu by marker.
      */