oneentry 1.0.123 → 1.0.125

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

@@ -1,60 +1,203 @@
-import type { IError } from '../base/utils';
+import type { IError, ILocalizeInfo } from '../base/utils';
 /**
- * Represents an interface object of ICollections Api.
+ * @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} [getICollectionRowByMarkerAndId] - Getting one record (row) 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 {
-    getICollections(marker: string, langCode: string, userQuery?: any): Promise<Array<any> | IError>;
-    getICollectionById(id: number, langCode: string): Promise<any | IError>;
-    getICollectionRowsById(id: number, langCode: string, userQuery?: any): Promise<any | IError>;
+    /**
+     * 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.
+     * @throws {IError} - If there is an error during the fetch operation, it will return an error object.
+     */
+    getICollections(langCode: string, userQuery?: {
+        limit: number;
+        offset: number;
+        entityType: string;
+        entityId: number;
+    }): 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.
+     * @throws {IError} - If there is an error during the fetch operation, it will return an error object.
+     */
+    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.
+     * @throws {IError} - If there is an error during the fetch operation, it will return an error object.
+     */
+    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
+        }
+     * @throws {IError} - If there is an error during the fetch operation, it will return an error object.
+     */
     validateICollectionMarker(marker: string): Promise<any | IError>;
-    getICollectionRowByMarkerAndId(marker: string, id: number, langCode: string): Promise<any | IError>;
-    createICollectionRow(marker: string, body: any, langCode: string): Promise<Array<any> | IError>;
-    updateICollectionRow(marker: string, id: number, body: any, langCode: string): Promise<any | 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.
+     * @throws {IError} - If there is an error during the fetch operation, it will return an error object.
+     */
+    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.
+     * @throws {IError} - If there is an error during the fetch operation, it will return an error object.
+     */
+    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.
+     * @throws {IError} - If there is an error during the fetch operation, it will return an error object.
+     */
+    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.
+     * @throws {IError} - If there is an error during the fetch operation, it will return an error object.
+     */
+    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)
+     * @throws {IError} - If there is an error during the fetch operation, it will return an error object.
+     */
     deleteICollectionRowByMarkerAndId(marker: string, id: number): Promise<any | IError>;
 }
 /**
- * ICollection
+ * @interface ICollectionEntity
  *
- * @property {number} [id] - Object identifier
- * @property {object} [localizeInfos] - Name considering localization
- * @property {string | null} [identifier] - Text identifier for record field
- * @property {number | null} [formId] - Identifier for the form used by the order storage
- * @property {string | null} [attributeSetId] - Identifier of the set of attributes used by the form attached to the collection
- * @property {string | null} [selectedAttributeMarkers] - Text identifiers of form object attributes for display in the data table
+ * @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.
  */
-interface ICollection {
+interface ICollectionEntity {
     id: number;
     identifier: string | null;
     formId: number | null;
-    localizeInfos: object;
+    localizeInfos: ILocalizeInfo;
     attributeSetId: string | null;
     selectedAttributeMarkers: string | null;
 }
 /**
- * ICollectionResponce
+ * @interface ICollectionResponce
  *
- * @property {ICollection[]} items -
- * @property {number} total -
+ * @property {ICollectionEntity[]} items - Array of collection objects. Example:
+    [
+      {
+        "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 {
-    items: ICollection[];
+    items: ICollectionEntity[];
     total: number;
 }
 /**
- * ICollectionFormData
+ * @interface ICollectionFormData
  *
- * @property {string} marker -
- * @property {string} type -
- * @property {string} value -
+ * @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".
+ * @description Represents a form data object within a collection, containing a marker, type, and value.
  */
 interface ICollectionFormData {
     marker: string;
@@ -62,10 +205,21 @@ interface ICollectionFormData {
     value: string;
 }
 /**
- * ICollectionFormObject
+ * @interface ICollectionFormObject
  *
- * @property {string} formIdentifier -
- * @property {object} formData -
+ * @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 {
     formIdentifier: string;
@@ -74,23 +228,72 @@ interface ICollectionFormObject {
     };
 }
 /**
- * ICollectionRow
+ * @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".
+ * @description Represents a row in a collection, containing various properties such as identifiers, dates, form data, and an optional total value.
  */
 interface ICollectionRow {
     id: number;
     createdDate: string;
     updatedDate: string;
-    entityId: any;
-    entityType: any;
+    collectionId?: number | null;
     formData: ICollectionFormData[];
-    attributeSetIdentifier: string | null;
-    total?: string;
+    entityType: string | null;
+    entityId: number | null;
+    attributeSetIdentifier?: string | null;
+    total: string;
 }
 /**
- * ICollectionRows
+ * @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.
+ * @description Represents a response from the collections API containing a total count and an array of collection row objects.
  */
 interface ICollectionRowsResponce {
     items: ICollectionRow[];
     total: number;
 }
-export type { ICollection, ICollectionFormObject, ICollectionResponce, ICollectionRow, ICollectionRowsResponce, ICollectionsApi, };
+/**
+ * @interface ICollectionIsValid
+ *
+ * @property {boolean} valid - Valid marker object. Example: true.
+ * @description Represents a response from the validateICollectionMarker.
+ */
+interface ICollectionIsValid {
+    valid: boolean;
+}
+export type { ICollectionEntity, ICollectionFormObject, ICollectionIsValid, ICollectionResponce, ICollectionRow, ICollectionRowsResponce, ICollectionsApi, };

package/dist/locales/localesApi.d.ts

@@ -13,7 +13,11 @@ export default class LocalesApi extends AsyncModules implements ILocales {
     /**
      * Find all active language localization objects.
      *
-     * @returns Returns an array of LocaleEntity objects
+     * @handleName getLocales
+     *
+     * @return {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.
      */
     getLocales(): Promise<Array<ILocalEntity> | IError>;
 }

package/dist/locales/localesApi.js

@@ -16,7 +16,11 @@ class LocalesApi extends asyncModules_1.default {
     /**
      * Find all active language localization objects.
      *
-     * @returns Returns an array of LocaleEntity objects
+     * @handleName getLocales
+     *
+     * @return {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.
      */
     async getLocales() {
         const result = await this._fetchGet('/active/all');

package/dist/locales/localesInterfaces.d.ts

@@ -1,24 +1,31 @@
 import type { IError } from '../base/utils';
 /**
- * Represents an interface object of Locales Api.
+ * @interface ILocales
  *
  * @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 {
-    getLocales(): Promise<Array<ILocalEntity> | IError>;
+    /**
+     * Find all active language localization objects.
+     *
+     * @return {ILocalEntity[]} Returns an array of LocaleEntity objects.
+     * @throws {IError} - If there is an error during the fetch operation, it will return an error object.
+     */
+    getLocales(): Promise<ILocalEntity[] | IError>;
 }
 /**
- * Represents a locales object.
+ * @interface ILocalEntity
  *
- * @interface
- * @property {number} id - The unique identifier of the locales.
- * @property {string} shortCode - The shortCode of locales.
- * @property {string} 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.
+ * @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 {
     id: number;

package/dist/menus/menusApi.d.ts

@@ -13,10 +13,13 @@ export default class MenusApi extends AsyncModules implements IMenus {
     /**
      * Get pages includes in menu by marker.
      *
-     * @param {string} [marker] - Menu marker
-     * @param {string} [langCode] - Language code
+     * @handleName getMenusByMarker
      *
-     * @returns 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".
+     * @return {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.
      */
     getMenusByMarker(marker: string, langCode?: string): Promise<IMenusEntity | IError>;
 }

package/dist/menus/menusApi.js

@@ -16,10 +16,13 @@ class MenusApi extends asyncModules_1.default {
     /**
      * Get pages includes in menu by marker.
      *
-     * @param {string} [marker] - Menu marker
-     * @param {string} [langCode] - Language code
+     * @handleName getMenusByMarker
      *
-     * @returns 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".
+     * @return {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.
      */
     async getMenusByMarker(marker, langCode = this.state.lang) {
         const result = await this._fetchGet(`/marker/${marker}?langCode=${langCode}`);

package/dist/menus/menusInterfaces.d.ts

@@ -1,46 +1,85 @@
-import type { IError, ILocalizeInfo } from '../base/utils';
+import type { IAttributeValues, IError, ILocalizeInfo } from '../base/utils';
 /**
- * Represents an interface object of Menus Api.
+ * @interface IMenus
  *
- * @property {function} getAdminsInfo - Get pages includes in menu by marker.
+ * @property {function} getMenusByMarker - Get pages includes in menu by marker.
+ * @description This interface defines a method for retrieving menu pages by a specific marker and language code.
  */
 interface IMenus {
+    /**
+     * Get pages includes in menu by marker.
+     *
+     * @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.
+     * @throws {IError} - If there is an error during the fetch operation, it will return an error object.
+     */
     getMenusByMarker(marker: string, langCode: string): Promise<IMenusEntity | IError>;
 }
 /**
- * Represents a position object.
+ * @interface IMenusPages
  *
- * @interface
- * @property {Array<IMenusPages>} children - The optional parameter. Contains array with child page objects.
- * @property {number} id - The unique identifier of the menu.
- * @property {string} pageUrl - The page url string.
- * @property {ILocalizeInfo} localizeInfos - The menu data, taking into account localization.
- * @property {IAttributesSets} attributeValues - Attributes sets
- * @property {number} position - The menu position.
- * @property {number | null} parentId - The menu parent id.
+ * @property {IMenusPages[]} children - Contains array with child page objects. Example:
+    [
+      {
+        "id": null,
+        "pageUrl": null,
+        "localizeInfos": {},
+        "attributeValues": {},
+        "parentId": null,
+        "position": 1
+      }
+    ]
+ * @property {number} id - The unique identifier of the menu. Example: 1.
+ * @property {string} pageUrl - The page url string. Example: "about".
+ * @property {ILocalizeInfo} localizeInfos - The menu data, taking into account localization. Example:
+    {
+      "title": "menu"
+    }
+ * @property {IAttributeValues} attributeValues - Attributes sets. Example:
+    {
+      "color": "red",
+      "size": "large"
+    }
+ * @property {number} position - The menu position. Example: 1.
+ * @property {number | null} parentId - The menu parent id. Example: null.
+ * @description This interface defines the structure of a menu page entity, including its identifiers, localization information, attributes, and hierarchical relationships.
  */
 interface IMenusPages {
-    children?: Array<IMenusPages> | IMenusPages;
+    children?: IMenusPages[] | IMenusPages;
     id: number | null;
     pageUrl: string | null;
     localizeInfos: ILocalizeInfo;
-    attributeValues: any;
+    attributeValues: IAttributeValues;
     position: number;
     parentId: number | null;
 }
 /**
- * Represents a position object.
+ * @interface IMenusEntity
  *
- * @interface
- * @property {number} id - The unique identifier of the menu.
- * @property {string} identifier - The menu identifier.
- * @property {Record<string, any>} localizeInfos - The menu data, taking into account localization.
- * @property {Array<IMenusPages>} pages - Array of menu pages.
+ * @property {number} id - The unique identifier of the menu. Example: 1.
+ * @property {string} identifier - The menu identifier. Example: "main_menu".
+ * @property {ILocalizeInfo} localizeInfos - The menu data, taking into account localization. Example:
+    {
+      "title": "menu"
+    }
+ * @property {IMenusPages[]} pages - Array of menu pages. Example:
+    [
+      {
+        "id": null,
+        "pageUrl": null,
+        "localizeInfos": {},
+        "attributeValues": {},
+        "parentId": null,
+        "position": 1
+      }
+    ]
+ * @description This interface defines the structure of a menu entity, including its identifiers, localization information, and associated pages.
  */
 interface IMenusEntity {
     id: number;
     identifier: string;
     localizeInfos: ILocalizeInfo;
-    pages: Array<IMenusPages> | IMenusPages;
+    pages: IMenusPages[] | IMenusPages;
 }
 export type { IMenus, IMenusEntity, IMenusPages };