oneentry 1.0.126 → 1.0.127

package/dist/attribute-sets/attributeSetsInterfaces.d.ts

@@ -1,41 +1,41 @@
 import type { IError, ILocalizeInfo } from '../base/utils';
 /**
+ * Interface for retrieving attributes based on markers and language codes.
  * @interface IAttributesSets
- *
- * @property {function} getAttributesByMarker - Get all attributes with data from the attribute sets.
- * @property {function} getSingleAttributeByMarkerSet - Get a single attribute with data from the attribute sets.
- *
+ * @property {Function} getAttributesByMarker         - Get all attributes with data from the attribute sets.
+ * @property {Function} getSingleAttributeByMarkerSet - Get a single attribute with data from the attribute sets.
  * @description This interface defines methods for retrieving attributes based on markers and language codes.
  */
 interface IAttributesSets {
     /**
      * Fetches attributes by a specific marker.
-     *
-     * @param {string} marker - The marker used to identify the attribute set. Example: "productAttributes".
-     * @param {string} [langCode] - The language code for localization purposes. Default: 'en_US'.
-     * @returns {IAttributeSetsEntity[]} A promise that resolves to an array of attribute set entities or an error.
+     * @handleName getAttributesByMarker
+     * @param   {string}                 marker     - The marker used to identify the attribute set. Example: "productAttributes".
+     * @param   {string}                 [langCode] - The language code for localization purposes. Default: 'en_US'.
+     * @returns {IAttributeSetsEntity[]}            A promise that resolves to an array of attribute set entities or an error.
      * @throws {IError} - If there is an error during the fetch operation, it will return an error object.
+     * @description This method fetches attributes by a specific marker.
      */
     getAttributesByMarker(marker: string, langCode: string): Promise<IAttributeSetsEntity[] | IError>;
     /**
      * Fetches a single attribute by its marker and the set marker.
-     *
-     * @param {string} attributeMarker - The marker identifying the attribute. Example: "color".
-     * @param {string} setMarker - The marker identifying the attribute set. Example: "productAttributes".
-     * @param {string} [langCode] - The language code for localization purposes. Default: "en_US".
-     * @returns {IAttributesSetsEntity} A promise that resolves to an attribute set entity or an error.
+     * @handleName getSingleAttributeByMarkerSet
+     * @param   {string}                attributeMarker - The marker identifying the attribute. Example: "color".
+     * @param   {string}                setMarker       - The marker identifying the attribute set. Example: "productAttributes".
+     * @param   {string}                [langCode]      - The language code for localization purposes. Default: "en_US".
+     * @returns {IAttributesSetsEntity}                 A promise that resolves to an attribute set entity or an error.
+     * @throws {IError} - If there is an error during the fetch operation, it will return an error object.
+     * @description This method fetches a single attribute by its marker and the set marker.
      */
     getSingleAttributeByMarkerSet(attributeMarker: string, setMarker: string, langCode: string): Promise<IAttributesSetsEntity | IError>;
 }
 /**
- * Interface representing the structure of a list item.
- *
+ * Represents the structure of a list item.
  * @interface IListTitle
- *
- * @property {string} title - The title or name associated with the list item. Example: "Item Name".
- * @property {number | string} value - The value of the list item, which can be either a number or a string depending on the context. Example: 42
- * @property {string | number | null} position - The position of the list item, which can be represented as a string, number, or null if not applicable. Example: 1
- * @property {object} extended - An object containing additional properties or metadata related to the list item. This could include any extra details that extend the basic information.
+ * @property {string}                 title    - The title or name associated with the list item. Example: "Item Name".
+ * @property {number | string}        value    - The value of the list item, which can be either a number or a string depending on the context. Example: 42.
+ * @property {string | number | null} position - The position of the list item, which can be represented as a string, number, or null if not applicable. Example: 1.
+ * @property {object}                 extended - An object containing additional properties or metadata related to the list item. This could include any extra details that extend the basic information.
  * @description This interface defines the structure of a list item, which includes properties for the title, value, position, and extended information.
  */
 interface IListTitle {
@@ -48,54 +48,50 @@ interface IListTitle {
     };
 }
 /**
- * AttributeType
- *
- * @type IAdminQuery
+ * Defines the possible values for attribute types used in the system.
  * @type {AttributeType}
  * @description This type defines the possible values for attribute types used in the system.
  */
 type AttributeType = 'string' | 'text' | 'textWithHeader' | 'integer' | 'real' | 'float' | 'dateTime' | 'date' | 'time' | 'file' | 'image' | 'groupOfImages' | 'radioButton' | 'list' | 'button';
 /**
- * Interface representing an attribute set entity.
- *
+ * Represents an attribute set entity.
  * @interface IAttributesSetsEntity
- *
- * @property {AttributeType} type - Attribute type. Example: "string", "text", "integer", "etc".
- * @property {any} [value] - Value of the attribute, which can be of any type.
- * @property {string} marker - Textual identifier of the attribute (marker). Example: "color", "size", "etc".
- * @property {number} position - Position number for sorting. Example: 1
- * @property {IListTitle[] | Record<string, any>} [listTitles] - Array of values (with extended data) for list and radioButton attributes. Example:
-    [
-      {
-        "title": "red",
-        "value": 1,
-        "position": 1,
-        "extendedValue": null,
-        "extendedValueType": null
-      },
-      {
-        "title": "yellow",
-        "value": 2,
-        "position": 2,
-        "extendedValue": null,
-        "extendedValueType": null
-      }
-    ]
- * @property {Record<string, any>} [validators] - Set of validators for validation. Example:
-    {
-      "requiredValidator": {
-        "strict": true
-      },
-      "defaultValueValidator": {
-        "fieldDefaultValue": 11
-      }
-    }
- * @property {ILocalizeInfo} localizeInfos - The name of the template, taking into account localization. Example:
-    {
-      "title": "My attribute"
-    }
- * @property {Record<string, any>} [additionalFields] - Additional fields for the attribute (optional).
- * @property {Record<string, any>} [settings] -  Additional attribute settings (optional).
+ * @property {AttributeType}                      type               - Attribute type. Example: "string", "text", "integer", "etc".
+ * @property {any}                                [value]            - Value of the attribute, which can be of any type.
+ * @property {string}                             marker             - Textual identifier of the attribute (marker). Example: "color", "size", "etc".
+ * @property {number}                             position           - Position number for sorting. Example: 1.
+ * @property {IListTitle[] | Record<string, any>} [listTitles]       - Array of values (with extended data) for list and radioButton attributes. Example:
+                                                                     [
+                                                                     {
+                                                                     "title": "red",
+                                                                     "value": 1,
+                                                                     "position": 1,
+                                                                     "extendedValue": null,
+                                                                     "extendedValueType": null
+                                                                     },
+                                                                     {
+                                                                     "title": "yellow",
+                                                                     "value": 2,
+                                                                     "position": 2,
+                                                                     "extendedValue": null,
+                                                                     "extendedValueType": null
+                                                                     }
+                                                                     ]
+ * @property {Record<string, any>}                [validators]       - Set of validators for validation. Example:
+                                                                     {
+                                                                     "requiredValidator": {
+                                                                     "strict": true
+                                                                     },
+                                                                     "defaultValueValidator": {
+                                                                     "fieldDefaultValue": 11
+                                                                     }
+                                                                     }
+ * @property {ILocalizeInfo}                      localizeInfos      - The name of the template, taking into account localization. Example:
+                                                                     {
+                                                                     "title": "My attribute"
+                                                                     }
+ * @property {Record<string, any>}                [additionalFields] - Additional fields for the attribute (optional).
+ * @property {Record<string, any>}                [settings]         - Additional attribute settings (optional).
  * @description This interface defines the structure of an attribute set entity, including its type, marker, position, validators, localization information, list titles, additional fields, and settings.
  */
 interface IAttributesSetsEntity {
@@ -110,37 +106,35 @@ interface IAttributesSetsEntity {
     settings?: Record<string, any>;
 }
 /**
- * Interface representing an attribute set entity.
- *
+ * Represents an attribute set entity.
  * @interface IAttributeSetsEntity
- *
- * @property {number} id - The unique identifier of the attribute set entity. Example: 123.
- * @property {string} updatedDate - The date when the attribute set was last updated, represented as a string. Example: "2023-10-01T12:00:00Z".
- * @property {number} version - The version number of the attribute set, used for tracking changes or updates. Example: 1.
- * @property {string} identifier - A string that uniquely identifies the attribute set. Example: "attributeSet1".
- * @property {number} typeId - The numerical identifier representing the type of the attribute set. Example: 1.
- * @property {string} title - The title or name of the attribute set. Example: "Product Attributes".
- * @property {any} schema - The schema definition associated with the attribute set. This could represent the structure or rules for the data. Example:
-    {
-      "attribute1": {
-        "id": 1,
-        "type": "string",
-        "isPrice": false,
-        "original": true,
-        "identifier": "string",
-        "localizeInfos": {
-          "en_US": { "title": "String" }
-        }
-      }
-    }
- * @property {boolean} isVisible - Indicates whether the attribute set is visible or not. Example: true.
- * @property {any} properties - Additional properties associated with the attribute set, which can be of any type. Example:
-    {
-      "color": "red",
-      "size": "M"
-    }
- * @property {any} type - The type of the attribute set, which could be a specific classification or category. Example: "product", "user", "etc".
- * @property {number} position - The position number for sorting the attribute set. Example: 1.
+ * @property {number}  id          - The unique identifier of the attribute set entity. Example: 123.
+ * @property {string}  updatedDate - The date when the attribute set was last updated, represented as a string. Example: "2023-10-01T12:00:00Z".
+ * @property {number}  version     - The version number of the attribute set, used for tracking changes or updates. Example: 1.
+ * @property {string}  identifier  - A string that uniquely identifies the attribute set. Example: "attributeSet1".
+ * @property {number}  typeId      - The numerical identifier representing the type of the attribute set. Example: 1.
+ * @property {string}  title       - The title or name of the attribute set. Example: "Product Attributes".
+ * @property {object}  schema      - The schema definition associated with the attribute set. This could represent the structure or rules for the data. Example:
+                                   {
+                                   "attribute1": {
+                                   "id": 1,
+                                   "type": "string",
+                                   "isPrice": false,
+                                   "original": true,
+                                   "identifier": "string",
+                                   "localizeInfos": {
+                                   "en_US": { "title": "String" }
+                                   }
+                                   }
+                                   }
+ * @property {boolean} isVisible   - Indicates whether the attribute set is visible or not. Example: true.
+ * @property {object}  properties  - Additional properties associated with the attribute set, which can be of any type. Example:
+                                   {
+                                   "color": "red",
+                                   "size": "M"
+                                   }
+ * @property {string}  type        - The type of the attribute set, which could be a specific classification or category. Example: "product", "user", "etc".
+ * @property {number}  position    - The position number for sorting the attribute set. Example: 1.
  * @description This interface defines the structure of an attribute set entity.
  */
 interface IAttributeSetsEntity {
@@ -150,29 +144,27 @@ interface IAttributeSetsEntity {
     identifier: string;
     typeId: number;
     title: string;
-    schema: any;
+    schema: object;
     isVisible: boolean;
-    properties: any;
-    type: any;
+    properties: object;
+    type: string;
     position: number;
 }
 /**
- * Interface defining the structure of a response object for attribute sets.
- *
+ * Represents the response structure for attribute sets.
  * @interface IAttributesSetsResponse
- *
- * @property {number} total - Total items. Example: 100.
+ * @property {number}                 total - Total items. Example: 100.
  * @property {IAttributeSetsEntity[]} items - IAttributeSetsEntity array containing attribute set entities. Example:
-  [
-    {
-      "id": 1,
-      "identifier": "set1"
-    },
-    {
-      "id": 2,
-      "identifier": "set2"
-    }
-  ]
+                                            [
+                                            {
+                                            "id": 1,
+                                            "identifier": "set1"
+                                            },
+                                            {
+                                            "id": 2,
+                                            "identifier": "set2"
+                                            }
+                                            ]
  * @description This interface defines the structure of a response object for attribute sets.
  */
 interface IAttributesSetsResponse {