oneentry 1.0.159 → 1.0.161

package/dist/users/usersApi.js

@@ -325,5 +325,27 @@ class UsersApi extends asyncModules_1.default {
         const validated = await this._validateResponse(result, schema('WishlistResponseSchema'));
         return this._normalizeData(validated);
     }
+    /**
+     * Semantic (vector) search for users.
+     * @handleName getUsersByVectorSearch
+     * @param {IUsersVectorSearch} body - Vector search body. Example: `{ queryText: "john" }`.
+     * @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<IUsersResponse | IError>} Returns an object with an array of found users and total count.
+     * @throws {IError} When isShell=false and an error occurs during the fetch
+     * @description This method performs a semantic (vector) search for users. It requires user authorization.
+     * @see For more information about configuring the {@link https://js-sdk.oneentry.cloud/docs/category/authprovider authorization module}, see the documentation in the  {@link https://js-sdk.oneentry.cloud/docs/category/authprovider configuration settings section of the SDK}.
+     * @see {@link https://js-sdk.oneentry.cloud/docs/users/getUsersByVectorSearch getUsersByVectorSearch} documentation.
+     */
+    async getUsersByVectorSearch(body, langCode = this.state.lang, offset = 0, limit = 30) {
+        const query = {
+            langCode,
+            offset,
+            limit,
+        };
+        const result = await this._fetchPost(`/vector/search?` + this._queryParamsToString(query), body);
+        return this._normalizeData(result, langCode);
+    }
 }
 exports.default = UsersApi;

package/dist/users/usersInterfaces.d.ts

@@ -210,6 +210,44 @@ interface IUsersApi {
      * @see For more information about configuring the {@link https://js-sdk.oneentry.cloud/docs/category/authprovider authorization module}, see the documentation in the  {@link https://js-sdk.oneentry.cloud/docs/category/authprovider configuration settings section of the SDK}.
      */
     removeWishlistItem(productId: number): Promise<IWishlistResponse | IError>;
+    /**
+     * Semantic (vector) search for users.
+     * @handleName getUsersByVectorSearch
+     * @param {IUsersVectorSearch} body - Vector search body. Example: `{ queryText: "john" }`.
+     * @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<IUsersResponse | IError>} A promise resolving to a users response (items + total), or an error.
+     * @throws {IError} - If there is an error during the fetch operation, it will return an error object.
+     * @description This method performs a semantic (vector) search for users. It requires user authorization.
+     * @see For more information about configuring the {@link https://js-sdk.oneentry.cloud/docs/category/authprovider authorization module}, see the documentation in the  {@link https://js-sdk.oneentry.cloud/docs/category/authprovider configuration settings section of the SDK}.
+     */
+    getUsersByVectorSearch(body: IUsersVectorSearch, langCode?: string, offset?: number, limit?: number): Promise<IUsersResponse | IError>;
+}
+/**
+ * Body for semantic (vector) user search.
+ * @interface IUsersVectorSearch
+ * @property {string} queryText - Natural-language search query. Example: "john".
+ * @property {number} [vectorDistanceThreshold] - Override of the cosine distance threshold (0..2). Example: 0.3.
+ * @property {number} [maxHits] - Top-K candidates fetched before pagination. Default: 100. Max: 500. Example: 10.
+ * @property {boolean} [debug] - When true, each returned item gets a `distance` field. Example: false.
+ * @description Body for the users vector/search endpoint.
+ */
+interface IUsersVectorSearch {
+    queryText: string;
+    vectorDistanceThreshold?: number;
+    maxHits?: number;
+    debug?: boolean;
+}
+/**
+ * @interface IUsersResponse
+ * @property {IUserEntity[]} items - Array of found user objects.
+ * @property {number} total - Total number of found records. Example: 100.
+ * @description This interface defines the structure of a response containing multiple user entities, including the total count and an array of user items.
+ */
+interface IUsersResponse {
+    items: IUserEntity[];
+    total: number;
 }
 /**
  * @interface IUserEntity
@@ -378,4 +416,4 @@ interface IWishlistSet {
 interface IWishlistAddItem {
     productId: number;
 }
-export type { ICartAddItem, ICartItem, ICartResponse, ICartSet, IUserBody, IUserEntity, IUsersApi, IWishlistAddItem, IWishlistItem, IWishlistResponse, IWishlistSet, };
+export type { ICartAddItem, ICartItem, ICartResponse, ICartSet, IUserBody, IUserEntity, IUsersApi, IUsersResponse, IUsersVectorSearch, IWishlistAddItem, IWishlistItem, IWishlistResponse, IWishlistSet, };

package/dist/web-socket/lazySocket.d.ts

@@ -0,0 +1,18 @@
+import type { Socket } from 'socket.io-client';
+/**
+ * Wraps a not-yet-loaded Socket.io socket in a synchronous stand-in.
+ *
+ * `WS.connect()` is synchronous and returns a `Socket`, so `socket.io-client` would have to
+ * be imported statically — putting ~41 kB into every bundle, including those that never open
+ * a socket. This keeps the signature by returning a proxy immediately: calls made on it are
+ * queued and replayed onto the real socket as soon as the chunk resolves, and every later
+ * call passes straight through.
+ * @param {() => Promise<Socket>} createSocket - Loads Socket.io and creates the socket.
+ * @returns {Socket} Stand-in usable exactly like the socket it will become.
+ * @description Listener registration is what matters for ordering, and it is safe: the queue is
+ * replayed in the same tick the socket is created, before the connection can deliver anything.
+ * The one visible difference is that methods returning a value (e.g. `listeners()`) cannot answer
+ * before the chunk arrives — they return the proxy instead. Reading state (`id`, `connected`, …)
+ * is accurate, and awaiting `socket.io` or other nested objects is only possible once loaded.
+ */
+export default function createLazySocket(createSocket: () => Promise<Socket>): Socket;

package/dist/web-socket/lazySocket.js

@@ -0,0 +1,70 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.default = createLazySocket;
+/**
+ * Properties readable before the real socket exists.
+ * @description Their values match what Socket.io itself reports for a socket that
+ * has been created but has not connected yet, so reading them early is not a lie.
+ */
+const PENDING_STATE = {
+    id: undefined,
+    connected: false,
+    disconnected: true,
+    active: false,
+    recovered: false,
+};
+/**
+ * Wraps a not-yet-loaded Socket.io socket in a synchronous stand-in.
+ *
+ * `WS.connect()` is synchronous and returns a `Socket`, so `socket.io-client` would have to
+ * be imported statically — putting ~41 kB into every bundle, including those that never open
+ * a socket. This keeps the signature by returning a proxy immediately: calls made on it are
+ * queued and replayed onto the real socket as soon as the chunk resolves, and every later
+ * call passes straight through.
+ * @param {() => Promise<Socket>} createSocket - Loads Socket.io and creates the socket.
+ * @returns {Socket} Stand-in usable exactly like the socket it will become.
+ * @description Listener registration is what matters for ordering, and it is safe: the queue is
+ * replayed in the same tick the socket is created, before the connection can deliver anything.
+ * The one visible difference is that methods returning a value (e.g. `listeners()`) cannot answer
+ * before the chunk arrives — they return the proxy instead. Reading state (`id`, `connected`, …)
+ * is accurate, and awaiting `socket.io` or other nested objects is only possible once loaded.
+ */
+function createLazySocket(createSocket) {
+    let socket;
+    const queued = [];
+    const loading = createSocket().then((created) => {
+        // Replay before returning: the connection cannot emit anything until this tick ends,
+        // so no event registered through the proxy can be missed.
+        for (const { method, args } of queued) {
+            created[method](...args);
+        }
+        queued.length = 0;
+        socket = created;
+        return created;
+    });
+    // A failed chunk load must not surface as an unhandled rejection
+    loading.catch((error) => {
+        // eslint-disable-next-line no-undef, no-console
+        console.error('OneEntry SDK: failed to load socket.io-client', error);
+    });
+    const proxy = new Proxy({}, {
+        get(_target, property) {
+            if (socket) {
+                const value = socket[property];
+                return typeof value === 'function' ? value.bind(socket) : value;
+            }
+            // Never look thenable: returning a function for `then` would make `await socket` hang
+            if (property === 'then' || typeof property === 'symbol') {
+                return undefined;
+            }
+            if (property in PENDING_STATE) {
+                return PENDING_STATE[property];
+            }
+            return (...args) => {
+                queued.push({ method: property, args });
+                return proxy;
+            };
+        },
+    });
+    return proxy;
+}

package/esm/admins/adminsApi.d.ts

@@ -0,0 +1,66 @@
+import AsyncModules from '../base/asyncModules.js';
+import type StateModule from '../base/stateModule.js';
+import type { IError } from '../base/utils.js';
+import type { IFilterParams } from '../products/productsInterfaces.js';
+import type { IAdminEntity, IAdmins, IAdminsResponse, IAdminsVectorSearch } from './adminsInterfaces.js';
+/**
+ * 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;
+    private _adminsUrl;
+    /**
+     * 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 {IFilterParams[]} [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 {number | string | null} [body.conditionValue] - Value of the condition. Example: "new".
+     * @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
+     * @see {@link https://js-sdk.oneentry.cloud/docs/admins/getAdminsInfo getAdminsInfo} documentation.
+     */
+    getAdminsInfo(body?: IFilterParams[], langCode?: string, offset?: number, limit?: number): Promise<IAdminEntity[] | IError>;
+    /**
+     * Semantic (vector) search for admins.
+     * @handleName getAdminsByVectorSearch
+     * @param {IAdminsVectorSearch} body - Vector search body. Example: `{ queryText: "content manager" }`.
+     * @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<IAdminsResponse | IError>} Returns an object with an array of found admins and total count.
+     * @throws {IError} When isShell=false and an error occurs during the fetch
+     * @description This method performs a semantic (vector) search for admins.
+     * @see {@link https://js-sdk.oneentry.cloud/docs/admins/getAdminsByVectorSearch getAdminsByVectorSearch} documentation.
+     */
+    getAdminsByVectorSearch(body: IAdminsVectorSearch, langCode?: string, offset?: number, limit?: number): Promise<IAdminsResponse | IError>;
+}

package/esm/admins/adminsApi.js

@@ -0,0 +1,90 @@
+import AsyncModules from '../base/asyncModules.js';
+import createSchemaLoader from '../base/lazySchema.js';
+const schema = createSchemaLoader(() => import('./adminsSchemas.js'));
+/**
+ * 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 {
+    /**
+     * 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';
+        this._adminsUrl = state.url + '/api/content/admins';
+    }
+    /**
+     * Get all admins objects with filters.
+     * @handleName getAdminsInfo
+     * @param {IFilterParams[]} [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 {number | string | null} [body.conditionValue] - Value of the condition. Example: "new".
+     * @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
+     * @see {@link https://js-sdk.oneentry.cloud/docs/admins/getAdminsInfo getAdminsInfo} documentation.
+     */
+    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 = await this._validateResponse(response, schema('AdminsResponseSchema'));
+        return this._normalizeData(validated, langCode);
+    }
+    /**
+     * Semantic (vector) search for admins.
+     * @handleName getAdminsByVectorSearch
+     * @param {IAdminsVectorSearch} body - Vector search body. Example: `{ queryText: "content manager" }`.
+     * @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<IAdminsResponse | IError>} Returns an object with an array of found admins and total count.
+     * @throws {IError} When isShell=false and an error occurs during the fetch
+     * @description This method performs a semantic (vector) search for admins.
+     * @see {@link https://js-sdk.oneentry.cloud/docs/admins/getAdminsByVectorSearch getAdminsByVectorSearch} documentation.
+     */
+    async getAdminsByVectorSearch(body, langCode = this.state.lang, offset = 0, limit = 30) {
+        const query = {
+            langCode,
+            offset,
+            limit,
+        };
+        const savedUrl = this._url;
+        this._url = this._adminsUrl;
+        try {
+            const response = await this._fetchPost(`/vector/search?` + this._queryParamsToString(query), body);
+            return this._normalizeData(response, langCode);
+        }
+        finally {
+            this._url = savedUrl;
+        }
+    }
+}

package/esm/admins/adminsInterfaces.d.ts

@@ -0,0 +1,137 @@
+import type { IAttributeValues, IError } from '../base/utils.js';
+import type { IFormConfig } from '../forms/formsInterfaces.js';
+import type { IFilterParams } from '../products/productsInterfaces.js';
+/**
+ * @interface IAdmins
+ * @description This interface defines the contract for any class that implements it
+ */
+interface IAdmins {
+    /**
+     * Get all admins objects with filters.
+     * @handleName getAdminsInfo
+     * @param {IFilterParams[]} [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 {number | string | null} [body.conditionValue] - Value of the condition. Example: "new".
+     * @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?: IFilterParams[], langCode?: string, offset?: number, limit?: number): Promise<IAdminEntity[] | IError>;
+    /**
+     * Semantic (vector) search for admins.
+     * @handleName getAdminsByVectorSearch
+     * @param {IAdminsVectorSearch} body - Vector search body. Example: `{ queryText: "content manager" }`.
+     * @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 {IAdminsResponse} Returns an object with an array of found admins and total count.
+     * @throws {IError} - If there is an error during the fetch operation, it will return an error object.
+     */
+    getAdminsByVectorSearch(body: IAdminsVectorSearch, langCode?: string, offset?: number, limit?: number): Promise<IAdminsResponse | IError>;
+}
+/**
+ * Body for semantic (vector) admin search.
+ * @interface IAdminsVectorSearch
+ * @property {string} queryText - Natural-language search query. Example: "content manager".
+ * @property {number} [vectorDistanceThreshold] - Override of the cosine distance threshold (0..2). Example: 0.3.
+ * @property {number} [maxHits] - Top-K candidates fetched before pagination. Default: 100. Max: 500. Example: 10.
+ * @property {boolean} [debug] - When true, each returned item gets a `distance` field. Example: false.
+ * @description Body for the admins vector/search endpoint.
+ */
+interface IAdminsVectorSearch {
+    queryText: string;
+    vectorDistanceThreshold?: number;
+    maxHits?: number;
+    debug?: boolean;
+}
+/**
+ * @interface IAdminsResponse
+ * @property {IAdminEntity[]} items - Array of found admin objects.
+ * @property {number} total - Total number of found records. Example: 100.
+ * @description This interface defines the structure of a response containing multiple admin entities, including the total count and an array of admin items.
+ */
+interface IAdminsResponse {
+    items: IAdminEntity[];
+    total: number;
+}
+/**
+ * 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"
+        }
+      }
+    ]
+ * @property {IFormConfig[]} [moduleFormConfigs] - Array of module form configurations associated with the admin.
+ * @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;
+    moduleFormConfigs?: IFormConfig[];
+}
+/**
+ * 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, IAdminsResponse, IAdminsVectorSearch, IPosition, };

package/esm/admins/adminsInterfaces.js

@@ -0,0 +1 @@
+export {};

package/esm/admins/adminsSchemas.d.ts

@@ -0,0 +1,48 @@
+/**
+ * Validation schemas for Admins module
+ * @description Zod schemas for validating admins-related API responses
+ */
+import { z } from 'zod';
+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.ZodRecord<z.ZodString, z.ZodType<{
+        type: string;
+        value: unknown;
+        position?: number;
+        additionalFields?: Record<string, unknown> | unknown[];
+    }, unknown, z.core.$ZodTypeInternals<{
+        type: string;
+        value: unknown;
+        position?: number;
+        additionalFields?: Record<string, unknown> | unknown[];
+    }, unknown>>>>;
+    moduleFormConfigs: z.ZodOptional<z.ZodArray<z.ZodAny>>;
+}, z.core.$strip>;
+/**
+ * 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.ZodRecord<z.ZodString, z.ZodType<{
+        type: string;
+        value: unknown;
+        position?: number;
+        additionalFields?: Record<string, unknown> | unknown[];
+    }, unknown, z.core.$ZodTypeInternals<{
+        type: string;
+        value: unknown;
+        position?: number;
+        additionalFields?: Record<string, unknown> | unknown[];
+    }, unknown>>>>;
+    moduleFormConfigs: z.ZodOptional<z.ZodArray<z.ZodAny>>;
+}, z.core.$strip>>;

package/esm/admins/adminsSchemas.js

@@ -0,0 +1,31 @@
+/**
+ * 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
+ */
+const AttributeValueSchema = z.object({
+    type: z.string(),
+    value: z.unknown(),
+    position: z.number().optional(),
+    additionalFields: z
+        .union([z.record(z.string(), z.unknown()), z.array(z.unknown())])
+        .optional(),
+});
+export const AdminEntitySchema = z.object({
+    id: z.number(),
+    attributeSetId: z.number().nullable(),
+    identifier: z.string(),
+    attributeSetIdentifier: z.string().nullable(),
+    position: z.number().nullable(),
+    isSync: z.boolean(),
+    attributeValues: z.record(z.string(), z.record(z.string(), AttributeValueSchema)),
+    moduleFormConfigs: z.array(z.any()).optional(),
+});
+/**
+ * Admins response schema (array of admin entities)
+ */
+export const AdminsResponseSchema = z.array(AdminEntitySchema);

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

@@ -0,0 +1,67 @@
+import AsyncModules from '../base/asyncModules.js';
+import type StateModule from '../base/stateModule.js';
+import type { IError } from '../base/utils.js';
+import type { IAttributeSetsEntity, IAttributesSets, IAttributesSetsEntity, IAttributesSetsResponse } from './attributeSetsInterfaces.js';
+/**
+ * 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
+     * @see {@link https://js-sdk.oneentry.cloud/docs/attribute-sets/getAttributes getAttributes} documentation.
+     */
+    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<IAttributesSetsEntity[] | IError>} Returns an array of Attributes objects.
+     * @throws {IError} When isShell=false and an error occurs during the fetch
+     * @see {@link https://js-sdk.oneentry.cloud/docs/attribute-sets/getAttributesByMarker getAttributesByMarker} documentation.
+     */
+    getAttributesByMarker(marker: string, langCode?: string): Promise<IAttributesSetsEntity[] | 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
+     * @see {@link https://js-sdk.oneentry.cloud/docs/attribute-sets/getSingleAttributeByMarkerSet getSingleAttributeByMarkerSet} documentation.
+     */
+    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
+     * @see {@link https://js-sdk.oneentry.cloud/docs/attribute-sets/getAttributeSetByMarker getAttributeSetByMarker} documentation.
+     */
+    getAttributeSetByMarker(marker: string, langCode?: string): Promise<IAttributeSetsEntity | IError>;
+}