oneentry 1.0.140 → 1.0.141

package/dist/admins/adminsApi.d.ts

@@ -0,0 +1,50 @@
+import AsyncModules from '../base/asyncModules';
+import type StateModule from '../base/stateModule';
+import type { AttributeType, IError } from '../base/utils';
+import type { IAdminEntity, IAdmins } from './adminsInterfaces';
+/**
+ * Controllers for working with users - admins.
+ * @class AdminsApi
+ * @augments AsyncModules
+ * @implements {IAdmins}
+ * @description This module provides methods for working with users - admins, including retrieving information about all admins.
+ */
+export default class AdminsApi extends AsyncModules implements IAdmins {
+    protected state: StateModule;
+    protected _url: string;
+    /**
+     * Initializes the AdminsApi with the provided state module.
+     * @class
+     * @class AdminsApi
+     * @param {StateModule} state - The state module containing configuration data.
+     * @description Constructor initializes the AdminsApi with a given state.
+     */
+    constructor(state: StateModule);
+    /**
+     * Get all admins objects with filters.
+     * @handleName getAdminsInfo
+     * @param {AttributeType[]} [body] - Array of filter objects with search conditions. Default: [].
+     * @example
+        [
+          {
+            "attributeMarker": "num",
+            "conditionMarker": "mth",
+            "conditionValue": 1
+          },
+          {
+            "attributeMarker": "num",
+            "conditionMarker": "lth",
+            "conditionValue": 3
+          }
+        ]
+     * @param {string} [body.attributeMarker] - Text identifier (marker) of the attribute in the set. Example: "num".
+     * @param {string} [body.conditionMarker] - Text identifier (marker) of the condition in the set. Example: "mth".
+     * @param {string} [body.conditionValue] - Value of the condition. Example: 1.
+     * @param {string} [langCode] - Language code. Default: "en_US".
+     * @param {number} [offset] - Parameter for pagination. Default: 0.
+     * @param {number} [limit] - Parameter for pagination. Default: 30.
+     * @returns {Promise<IAdminEntity[] | IError>} Returns an array of admin objects.
+     * @throws {IError} When isShell=false and an error occurs during the fetch
+     */
+    getAdminsInfo(body?: AttributeType[], langCode?: string, offset?: number, limit?: number): Promise<IAdminEntity[] | IError>;
+}

package/dist/admins/adminsApi.js

@@ -0,0 +1,65 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const asyncModules_1 = __importDefault(require("../base/asyncModules"));
+const adminsSchemas_1 = require("./adminsSchemas");
+/**
+ * Controllers for working with users - admins.
+ * @class AdminsApi
+ * @augments AsyncModules
+ * @implements {IAdmins}
+ * @description This module provides methods for working with users - admins, including retrieving information about all admins.
+ */
+class AdminsApi extends asyncModules_1.default {
+    /**
+     * Initializes the AdminsApi with the provided state module.
+     * @class
+     * @class AdminsApi
+     * @param {StateModule} state - The state module containing configuration data.
+     * @description Constructor initializes the AdminsApi with a given state.
+     */
+    constructor(state) {
+        super(state);
+        this._url = state.url + '/api/content/admins/all';
+    }
+    /**
+     * Get all admins objects with filters.
+     * @handleName getAdminsInfo
+     * @param {AttributeType[]} [body] - Array of filter objects with search conditions. Default: [].
+     * @example
+        [
+          {
+            "attributeMarker": "num",
+            "conditionMarker": "mth",
+            "conditionValue": 1
+          },
+          {
+            "attributeMarker": "num",
+            "conditionMarker": "lth",
+            "conditionValue": 3
+          }
+        ]
+     * @param {string} [body.attributeMarker] - Text identifier (marker) of the attribute in the set. Example: "num".
+     * @param {string} [body.conditionMarker] - Text identifier (marker) of the condition in the set. Example: "mth".
+     * @param {string} [body.conditionValue] - Value of the condition. Example: 1.
+     * @param {string} [langCode] - Language code. Default: "en_US".
+     * @param {number} [offset] - Parameter for pagination. Default: 0.
+     * @param {number} [limit] - Parameter for pagination. Default: 30.
+     * @returns {Promise<IAdminEntity[] | IError>} Returns an array of admin objects.
+     * @throws {IError} When isShell=false and an error occurs during the fetch
+     */
+    async getAdminsInfo(body = [], langCode = this.state.lang, offset = 0, limit = 30) {
+        const query = {
+            langCode,
+            offset,
+            limit,
+        };
+        const response = await this._fetchPost(`?` + this._queryParamsToString(query), body);
+        // Validate response if validation is enabled
+        const validated = this._validateResponse(response, adminsSchemas_1.AdminsResponseSchema);
+        return this._normalizeData(validated, langCode);
+    }
+}
+exports.default = AdminsApi;

package/dist/admins/adminsInterfaces.d.ts

@@ -0,0 +1,99 @@
+import type { AttributeType, IAttributeValues, IError } from '../base/utils';
+/**
+ * @interface IAdmins
+ * @property {Function} getAdminsInfo - Method to retrieve all admin user objects.
+ * @description This interface defines the contract for any class that implements it
+ */
+interface IAdmins {
+    /**
+     * Get all admins objects with filters.
+     * @handleName getAdminsInfo
+     * @param {AttributeType[]} [body] - Array of filter objects with search conditions. Default: [].
+     * @example
+        [
+          {
+            "attributeMarker": "num",
+            "conditionMarker": "mth",
+            "conditionValue": 1
+          },
+          {
+            "attributeMarker": "num",
+            "conditionMarker": "lth",
+            "conditionValue": 3
+          }
+        ]
+     * @param {string} [body.attributeMarker] - Text identifier (marker) of the attribute in the set. Example: "num".
+     * @param {string} [body.conditionMarker] - Text identifier (marker) of the condition in the set. Example: "mth".
+     * @param {string} [body.conditionValue] - Value of the condition. Example: 1.
+     * @param {string} [langCode] - Language code. Default: "en_US".
+     * @param {number} [offset] - Parameter for pagination. Default: 0.
+     * @param {number} [limit] - Parameter for pagination. Default: 30.
+     * @returns {IAdminEntity[]} Returns an array of admin objects.
+     * @throws {IError} - If there is an error during the fetch operation, it will return an error object.
+     */
+    getAdminsInfo(body?: AttributeType[], langCode?: string, offset?: number, limit?: number): Promise<IAdminEntity[] | IError>;
+}
+/**
+ * Interface representing a Position entity.
+ * @interface IPosition
+ * @property {number} id - The unique identifier of the position. Example: 1764.
+ * @property {boolean} [isLocked] - Indicates whether the position is locked or not. Example: false.
+ * @property {number} objectId - The unique identifier of the object. Example: 120.
+ * @property {number} [objectCategoryId] - The unique identifier of the object's category. Example: 5.
+ * @property {string} objectType - The type of the object. Example: "admin".
+ * @property {number} position - The position of the object. Example: 192.
+ * @description This interface outlines the properties associated with a position within a system.
+ */
+interface IPosition {
+    id: number;
+    isLocked?: boolean;
+    objectId: number;
+    objectCategoryId?: number;
+    objectType: string;
+    position: number;
+}
+/**
+ * Interface representing an Admin Entity.
+ * @interface IAdminEntity
+ * @property {number} id - The identifier of the object. Example: 1764.
+ * @property {number | null} attributeSetId - The identifier of the attribute set being used. Example: 120.
+ * @property {string} identifier - The textual identifier for the record field. Example: "admin1".
+ * @property {string | null} attributeSetIdentifier - The identifier of the attribute set. Example: "admins".
+ * @property {number | null} position - Position number (for sorting). Example: 1.
+ * @property {boolean} isSync - Page indexing flag (true or false). Example: true.
+ * @property {IAttributeValues} attributeValues - Array of attribute values from the index (presented as a pair of user attribute identifier: attribute value).
+ * @example
+    [
+      {
+        "marker": {
+          "type": "string",
+          "value": "Some value"
+        }
+      }
+    ]
+ * @description This interface captures the essential details and additional attributes of an admin entity.
+ */
+interface IAdminEntity {
+    id: number;
+    attributeSetId: number | null;
+    identifier: string;
+    attributeSetIdentifier: string | null;
+    position: number | null;
+    isSync: boolean;
+    attributeValues: IAttributeValues;
+    [key: string]: any;
+}
+/**
+ * Interface representing a query for fetching admin data.
+ * @interface IAdminQuery
+ * @property {string} langCode - Language code. Default: "en_US".
+ * @property {number} limit - Parameter for pagination. Default: 30.
+ * @property {number} offset - Parameter for pagination. Default: 0.
+ * @description This interface defines the parameters required for querying admin data, including optional defaults.
+ */
+interface IAdminQuery {
+    langCode: string;
+    limit: number;
+    offset: number;
+}
+export type { IAdminEntity, IAdminQuery, IAdmins, IPosition };

package/dist/admins/adminsInterfaces.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/admins/adminsSchemas.d.ts

@@ -0,0 +1,30 @@
+/**
+ * Validation schemas for Admins module
+ * @description Zod schemas for validating admins-related API responses
+ */
+import { z } from 'zod';
+/**
+ * Admin entity schema
+ * Includes all fields returned by the API
+ */
+export declare const AdminEntitySchema: z.ZodObject<{
+    id: z.ZodNumber;
+    attributeSetId: z.ZodNullable<z.ZodNumber>;
+    identifier: z.ZodString;
+    attributeSetIdentifier: z.ZodNullable<z.ZodString>;
+    position: z.ZodNullable<z.ZodNumber>;
+    isSync: z.ZodBoolean;
+    attributeValues: z.ZodRecord<z.ZodString, z.ZodAny>;
+}, z.core.$catchall<z.ZodAny>>;
+/**
+ * Admins response schema (array of admin entities)
+ */
+export declare const AdminsResponseSchema: z.ZodArray<z.ZodObject<{
+    id: z.ZodNumber;
+    attributeSetId: z.ZodNullable<z.ZodNumber>;
+    identifier: z.ZodString;
+    attributeSetIdentifier: z.ZodNullable<z.ZodString>;
+    position: z.ZodNullable<z.ZodNumber>;
+    isSync: z.ZodBoolean;
+    attributeValues: z.ZodRecord<z.ZodString, z.ZodAny>;
+}, z.core.$catchall<z.ZodAny>>>;

package/dist/admins/adminsSchemas.js

@@ -0,0 +1,27 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.AdminsResponseSchema = exports.AdminEntitySchema = void 0;
+/**
+ * Validation schemas for Admins module
+ * @description Zod schemas for validating admins-related API responses
+ */
+const zod_1 = require("zod");
+/**
+ * Admin entity schema
+ * Includes all fields returned by the API
+ */
+exports.AdminEntitySchema = zod_1.z
+    .object({
+    id: zod_1.z.number(),
+    attributeSetId: zod_1.z.number().nullable(),
+    identifier: zod_1.z.string(),
+    attributeSetIdentifier: zod_1.z.string().nullable(),
+    position: zod_1.z.number().nullable(),
+    isSync: zod_1.z.boolean(),
+    attributeValues: zod_1.z.record(zod_1.z.string(), zod_1.z.any()),
+})
+    .catchall(zod_1.z.any()); // Allow additional dynamic properties
+/**
+ * Admins response schema (array of admin entities)
+ */
+exports.AdminsResponseSchema = zod_1.z.array(exports.AdminEntitySchema);

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

@@ -0,0 +1,63 @@
+import AsyncModules from '../base/asyncModules';
+import type StateModule from '../base/stateModule';
+import type { IError } from '../base/utils';
+import type { IAttributeSetsEntity, IAttributesSets, IAttributesSetsEntity, IAttributesSetsResponse } from './attributeSetsInterfaces';
+/**
+ * Controllers for working with attributes - AttributesSetsApi.
+ * @class AttributesSetsApi
+ * @augments AsyncModules
+ * @implements {IAttributesSets}
+ * @description This class provides methods to interact with attribute sets, including fetching attributes, getting attributes by marker, and retrieving single attributes by marker and set.
+ */
+export default class AttributesSetsApi extends AsyncModules implements IAttributesSets {
+    protected state: StateModule;
+    protected _url: string;
+    /**
+     * Initializes the AttributesSetsApi with the provided state module.
+     * @class
+     * @class AttributesSetsApi
+     * @param {StateModule} state - The state module containing configuration data.
+     * @description Constructor initializes the AttributesSetsApi with a given state.
+     */
+    constructor(state: StateModule);
+    /**
+     * Getting all attribute sets objects.
+     * @handleName getAttributes
+     * @param {string} [langCode] - Language code. Default: "en_US".
+     * @param {number} [offset] - parameter offset of record selection. Default: 0.
+     * @param {number} [limit] - parameter limiting the selection of records. Default: 30.
+     * @param {number} [typeId] - identifier of the attribute set type. Default: null.
+     * @param {string} [sortBy] - identifier of the attribute set type. Default: "id".
+     * @returns {Promise<IAttributesSetsResponse | IError>} Returns object with array of IAttributeSetsEntity and total items count.
+     * @throws {IError} When isShell=false and an error occurs during the fetch
+     */
+    getAttributes(langCode?: string, offset?: number, limit?: number, typeId?: any, sortBy?: string): Promise<IAttributesSetsResponse | IError>;
+    /**
+     * Getting all attributes with data from the attribute set.
+     * @handleName getAttributesByMarker
+     * @param {string} marker - Attribute marker. Example: "productAttributes".
+     * @param {string} [langCode] - Language code. Default: "en_US".
+     * @returns {Promise<IAttributeSetsEntity[] | IError>} Returns an array of Attributes objects.
+     * @throws {IError} When isShell=false and an error occurs during the fetch
+     */
+    getAttributesByMarker(marker: string, langCode?: string): Promise<IAttributeSetsEntity[] | IError>;
+    /**
+     * Get a single attribute with data from the attribute sets.
+     * @handleName getSingleAttributeByMarkerSet
+     * @param {string} setMarker - Text identifier (marker) of the attribute set. Example: "productAttributes".
+     * @param {string} attributeMarker - Text identifier (marker) of the attribute in the set. Example: "color".
+     * @param {string} [langCode] - Language code. Default: "en_US".
+     * @returns {Promise<IAttributesSetsEntity | IError>} Returns a single attribute object from the attribute set.
+     * @throws {IError} When isShell=false and an error occurs during the fetch
+     */
+    getSingleAttributeByMarkerSet(setMarker: string, attributeMarker: string, langCode?: string): Promise<IAttributesSetsEntity | IError>;
+    /**
+     * Getting a single object from a set of attributes by marker.
+     * @handleName getAttributeSetByMarker
+     * @param {string} marker - marker of the attribute set object. Example: "productAttributes".
+     * @param {string} [langCode] - Language code. Default: "en_US".
+     * @returns {Promise<IAttributeSetsEntity | IError>} Returns one object of the attribute set.
+     * @throws {IError} When isShell=false and an error occurs during the fetch
+     */
+    getAttributeSetByMarker(marker: string, langCode?: string): Promise<IAttributeSetsEntity | IError>;
+}

package/dist/attribute-sets/attributeSetsApi.js

@@ -0,0 +1,98 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const asyncModules_1 = __importDefault(require("../base/asyncModules"));
+const attributeSetsSchemas_1 = require("./attributeSetsSchemas");
+/**
+ * Controllers for working with attributes - AttributesSetsApi.
+ * @class AttributesSetsApi
+ * @augments AsyncModules
+ * @implements {IAttributesSets}
+ * @description This class provides methods to interact with attribute sets, including fetching attributes, getting attributes by marker, and retrieving single attributes by marker and set.
+ */
+class AttributesSetsApi extends asyncModules_1.default {
+    /**
+     * Initializes the AttributesSetsApi with the provided state module.
+     * @class
+     * @class AttributesSetsApi
+     * @param {StateModule} state - The state module containing configuration data.
+     * @description Constructor initializes the AttributesSetsApi with a given state.
+     */
+    constructor(state) {
+        super(state);
+        this._url = state.url + '/api/content/attributes-sets';
+    }
+    /**
+     * Getting all attribute sets objects.
+     * @handleName getAttributes
+     * @param {string} [langCode] - Language code. Default: "en_US".
+     * @param {number} [offset] - parameter offset of record selection. Default: 0.
+     * @param {number} [limit] - parameter limiting the selection of records. Default: 30.
+     * @param {number} [typeId] - identifier of the attribute set type. Default: null.
+     * @param {string} [sortBy] - identifier of the attribute set type. Default: "id".
+     * @returns {Promise<IAttributesSetsResponse | IError>} Returns object with array of IAttributeSetsEntity and total items count.
+     * @throws {IError} When isShell=false and an error occurs during the fetch
+     */
+    async getAttributes(langCode = this.state.lang, offset = 0, limit = 30, 
+    // eslint-disable-next-line @typescript-eslint/no-explicit-any
+    typeId = null, sortBy = 'id') {
+        // eslint-disable-next-line @typescript-eslint/no-explicit-any
+        const query = {
+            langCode,
+            offset,
+            limit,
+            typeId,
+            sortBy,
+        };
+        const result = await this._fetchGet(`?` + this._queryParamsToString(query));
+        // Validate response if validation is enabled
+        const validated = this._validateResponse(result, attributeSetsSchemas_1.AttributeSetsResponseSchema);
+        return this._dataPostProcess(validated, langCode);
+    }
+    /**
+     * Getting all attributes with data from the attribute set.
+     * @handleName getAttributesByMarker
+     * @param {string} marker - Attribute marker. Example: "productAttributes".
+     * @param {string} [langCode] - Language code. Default: "en_US".
+     * @returns {Promise<IAttributeSetsEntity[] | IError>} Returns an array of Attributes objects.
+     * @throws {IError} When isShell=false and an error occurs during the fetch
+     */
+    async getAttributesByMarker(marker, langCode = this.state.lang) {
+        const result = await this._fetchGet(`/${marker}/attributes?langCode=${langCode}`);
+        // Validate response if validation is enabled
+        const validated = this._validateResponse(result, attributeSetsSchemas_1.AttributesArrayResponseSchema);
+        return this._dataPostProcess(validated, langCode);
+    }
+    /**
+     * Get a single attribute with data from the attribute sets.
+     * @handleName getSingleAttributeByMarkerSet
+     * @param {string} setMarker - Text identifier (marker) of the attribute set. Example: "productAttributes".
+     * @param {string} attributeMarker - Text identifier (marker) of the attribute in the set. Example: "color".
+     * @param {string} [langCode] - Language code. Default: "en_US".
+     * @returns {Promise<IAttributesSetsEntity | IError>} Returns a single attribute object from the attribute set.
+     * @throws {IError} When isShell=false and an error occurs during the fetch
+     */
+    async getSingleAttributeByMarkerSet(setMarker, attributeMarker, langCode = this.state.lang) {
+        const result = await this._fetchGet(`/${setMarker}/attributes/${attributeMarker}?langCode=${langCode}`);
+        // Validate response if validation is enabled
+        const validated = this._validateResponse(result, attributeSetsSchemas_1.AttributeEntitySchema);
+        return this._dataPostProcess(validated, langCode);
+    }
+    /**
+     * Getting a single object from a set of attributes by marker.
+     * @handleName getAttributeSetByMarker
+     * @param {string} marker - marker of the attribute set object. Example: "productAttributes".
+     * @param {string} [langCode] - Language code. Default: "en_US".
+     * @returns {Promise<IAttributeSetsEntity | IError>} Returns one object of the attribute set.
+     * @throws {IError} When isShell=false and an error occurs during the fetch
+     */
+    async getAttributeSetByMarker(marker, langCode = this.state.lang) {
+        const result = await this._fetchGet(`/marker/${marker}?langCode=${langCode}`);
+        // Validate response if validation is enabled
+        const validated = this._validateResponse(result, attributeSetsSchemas_1.AttributeSetEntitySchema);
+        return this._dataPostProcess(validated, langCode);
+    }
+}
+exports.default = AttributesSetsApi;

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

@@ -0,0 +1,187 @@
+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.
+ * @description This interface defines methods for retrieving attributes based on markers and language codes.
+ */
+interface IAttributesSets {
+    /**
+     * Fetches attributes by a specific marker.
+     * @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.
+     * @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>;
+}
+/**
+ * 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 | null} extended.value - The extended value, which can be a string or null. Example: "extra_value".
+ * @property {string | null} extended.type - The type of the extended value, which can be a string or null. Example: "color".
+ * @description This interface defines the structure of a list item, which includes properties for the title, value, position, and extended information.
+ */
+interface IListTitle {
+    title: string;
+    value: number | string;
+    position: string | number | null;
+    extended: {
+        value: string | null;
+        type: string | null;
+    };
+}
+/**
+ * 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';
+/**
+ * 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 {any} initialValue - Initial value of the attribute.
+ * @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).
+ * @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 {
+    type: AttributeType;
+    value?: any;
+    initialValue: any;
+    marker: string;
+    position: number;
+    listTitles?: IListTitle[] | Record<string, any>;
+    validators?: Record<string, any>;
+    localizeInfos: ILocalizeInfo;
+    additionalFields?: Record<string, any>;
+}
+/**
+ * Represents an attribute set entity.
+ * @interface IAttributeSetsEntity
+ * @property {number} id - The unique identifier of the attribute set entity. Example: 123.
+ * @property {string} createdDate - The date when the attribute set was created. Example: "2023-10-01T12:00:00Z".
+ * @property {string} updatedDate - The date when the attribute set was last updated. 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 {
+    id: number;
+    createdDate: string;
+    updatedDate: string;
+    version: number;
+    identifier: string;
+    typeId: number;
+    title: string;
+    schema: object;
+    isVisible: boolean;
+    properties: object;
+    type: {
+        id: number;
+        type: string;
+    };
+    position: number;
+}
+/**
+ * Represents the response structure for attribute sets.
+ * @interface IAttributesSetsResponse
+ * @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"
+     }
+   ]
+ * @description This interface defines the structure of a response object for attribute sets.
+ */
+interface IAttributesSetsResponse {
+    total: number;
+    items: IAttributeSetsEntity[];
+}
+export type { AttributeType, IAttributeSetsEntity, IAttributesSets, IAttributesSetsEntity, IAttributesSetsResponse, IListTitle, };

package/dist/attribute-sets/attributeSetsInterfaces.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });