oneentry 1.0.138 → 1.0.140

package/dist/attribute-sets/attributeSetsApi.js

@@ -1,98 +0,0 @@
-"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

@@ -1,187 +0,0 @@
-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

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

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

@@ -1,90 +0,0 @@
-/**
- * Validation schemas for AttributeSets module
- * @description Zod schemas for validating attribute sets-related API responses
- */
-import { z } from 'zod';
-/**
- * List title schema for list and radioButton attributes
- */
-export declare const ListTitleSchema: z.ZodObject<{
-    title: z.ZodString;
-    value: z.ZodUnion<readonly [z.ZodNumber, z.ZodString]>;
-    position: z.ZodUnion<readonly [z.ZodString, z.ZodNumber, z.ZodNull]>;
-    extended: z.ZodObject<{
-        value: z.ZodNullable<z.ZodString>;
-        type: z.ZodNullable<z.ZodString>;
-    }, z.core.$strip>;
-}, z.core.$strip>;
-/**
- * Attribute entity schema (single attribute from a set)
- */
-export declare const AttributeEntitySchema: z.ZodObject<{
-    type: z.ZodString;
-    value: z.ZodOptional<z.ZodAny>;
-    initialValue: z.ZodAny;
-    marker: z.ZodString;
-    position: z.ZodNumber;
-    listTitles: z.ZodOptional<z.ZodUnion<readonly [z.ZodArray<z.ZodAny>, z.ZodRecord<z.ZodString, z.ZodAny>]>>;
-    validators: z.ZodOptional<z.ZodUnion<readonly [z.ZodRecord<z.ZodString, z.ZodAny>, z.ZodArray<z.ZodAny>]>>;
-    localizeInfos: z.ZodUnion<readonly [z.ZodRecord<z.ZodString, z.ZodAny>, z.ZodArray<z.ZodAny>]>;
-    additionalFields: z.ZodOptional<z.ZodUnion<readonly [z.ZodRecord<z.ZodString, z.ZodAny>, z.ZodArray<z.ZodAny>]>>;
-    settings: z.ZodOptional<z.ZodUnion<readonly [z.ZodRecord<z.ZodString, z.ZodAny>, z.ZodArray<z.ZodAny>]>>;
-}, z.core.$strip>;
-/**
- * Attribute set entity schema (attribute set object)
- */
-export declare const AttributeSetEntitySchema: z.ZodObject<{
-    id: z.ZodNumber;
-    createdDate: z.ZodString;
-    updatedDate: z.ZodString;
-    version: z.ZodNumber;
-    identifier: z.ZodString;
-    typeId: z.ZodNumber;
-    title: z.ZodString;
-    schema: z.ZodObject<{}, z.core.$loose>;
-    isVisible: z.ZodBoolean;
-    properties: z.ZodObject<{}, z.core.$loose>;
-    type: z.ZodObject<{
-        id: z.ZodNumber;
-        type: z.ZodString;
-    }, z.core.$strip>;
-    position: z.ZodNumber;
-}, z.core.$strip>;
-/**
- * Attributes response schema (for getAttributes method)
- */
-export declare const AttributeSetsResponseSchema: z.ZodObject<{
-    total: z.ZodNumber;
-    items: z.ZodArray<z.ZodObject<{
-        id: z.ZodNumber;
-        createdDate: z.ZodString;
-        updatedDate: z.ZodString;
-        version: z.ZodNumber;
-        identifier: z.ZodString;
-        typeId: z.ZodNumber;
-        title: z.ZodString;
-        schema: z.ZodObject<{}, z.core.$loose>;
-        isVisible: z.ZodBoolean;
-        properties: z.ZodObject<{}, z.core.$loose>;
-        type: z.ZodObject<{
-            id: z.ZodNumber;
-            type: z.ZodString;
-        }, z.core.$strip>;
-        position: z.ZodNumber;
-    }, z.core.$strip>>;
-}, z.core.$strip>;
-/**
- * Attributes array response schema (for getAttributesByMarker method)
- */
-export declare const AttributesArrayResponseSchema: z.ZodArray<z.ZodObject<{
-    type: z.ZodString;
-    value: z.ZodOptional<z.ZodAny>;
-    initialValue: z.ZodAny;
-    marker: z.ZodString;
-    position: z.ZodNumber;
-    listTitles: z.ZodOptional<z.ZodUnion<readonly [z.ZodArray<z.ZodAny>, z.ZodRecord<z.ZodString, z.ZodAny>]>>;
-    validators: z.ZodOptional<z.ZodUnion<readonly [z.ZodRecord<z.ZodString, z.ZodAny>, z.ZodArray<z.ZodAny>]>>;
-    localizeInfos: z.ZodUnion<readonly [z.ZodRecord<z.ZodString, z.ZodAny>, z.ZodArray<z.ZodAny>]>;
-    additionalFields: z.ZodOptional<z.ZodUnion<readonly [z.ZodRecord<z.ZodString, z.ZodAny>, z.ZodArray<z.ZodAny>]>>;
-    settings: z.ZodOptional<z.ZodUnion<readonly [z.ZodRecord<z.ZodString, z.ZodAny>, z.ZodArray<z.ZodAny>]>>;
-}, z.core.$strip>>;

package/dist/attribute-sets/attributeSetsSchemas.js

@@ -1,74 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.AttributesArrayResponseSchema = exports.AttributeSetsResponseSchema = exports.AttributeSetEntitySchema = exports.AttributeEntitySchema = exports.ListTitleSchema = void 0;
-/**
- * Validation schemas for AttributeSets module
- * @description Zod schemas for validating attribute sets-related API responses
- */
-const zod_1 = require("zod");
-/**
- * List title schema for list and radioButton attributes
- */
-exports.ListTitleSchema = zod_1.z.object({
-    title: zod_1.z.string(),
-    value: zod_1.z.union([zod_1.z.number(), zod_1.z.string()]),
-    position: zod_1.z.union([zod_1.z.string(), zod_1.z.number(), zod_1.z.null()]),
-    extended: zod_1.z.object({
-        value: zod_1.z.string().nullable(),
-        type: zod_1.z.string().nullable(),
-    }),
-});
-/**
- * Attribute entity schema (single attribute from a set)
- */
-exports.AttributeEntitySchema = zod_1.z.object({
-    type: zod_1.z.string(),
-    value: zod_1.z.any().optional(),
-    initialValue: zod_1.z.any(),
-    marker: zod_1.z.string(),
-    position: zod_1.z.number(),
-    listTitles: zod_1.z
-        .union([zod_1.z.array(zod_1.z.any()), zod_1.z.record(zod_1.z.string(), zod_1.z.any())])
-        .optional(),
-    validators: zod_1.z
-        .union([zod_1.z.record(zod_1.z.string(), zod_1.z.any()), zod_1.z.array(zod_1.z.any())])
-        .optional(),
-    localizeInfos: zod_1.z.union([zod_1.z.record(zod_1.z.string(), zod_1.z.any()), zod_1.z.array(zod_1.z.any())]),
-    additionalFields: zod_1.z
-        .union([zod_1.z.record(zod_1.z.string(), zod_1.z.any()), zod_1.z.array(zod_1.z.any())])
-        .optional(),
-    settings: zod_1.z
-        .union([zod_1.z.record(zod_1.z.string(), zod_1.z.any()), zod_1.z.array(zod_1.z.any())])
-        .optional(),
-});
-/**
- * Attribute set entity schema (attribute set object)
- */
-exports.AttributeSetEntitySchema = zod_1.z.object({
-    id: zod_1.z.number(),
-    createdDate: zod_1.z.string(),
-    updatedDate: zod_1.z.string(),
-    version: zod_1.z.number(),
-    identifier: zod_1.z.string(),
-    typeId: zod_1.z.number(),
-    title: zod_1.z.string(),
-    schema: zod_1.z.object({}).passthrough(),
-    isVisible: zod_1.z.boolean(),
-    properties: zod_1.z.object({}).passthrough(),
-    type: zod_1.z.object({
-        id: zod_1.z.number(),
-        type: zod_1.z.string(),
-    }),
-    position: zod_1.z.number(),
-});
-/**
- * Attributes response schema (for getAttributes method)
- */
-exports.AttributeSetsResponseSchema = zod_1.z.object({
-    total: zod_1.z.number(),
-    items: zod_1.z.array(exports.AttributeSetEntitySchema),
-});
-/**
- * Attributes array response schema (for getAttributesByMarker method)
- */
-exports.AttributesArrayResponseSchema = zod_1.z.array(exports.AttributeEntitySchema);