oneentry 1.0.159 → 1.0.161

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

@@ -0,0 +1,317 @@
+import type { IError, ILocalizeInfo } from '../base/utils.js';
+/**
+ * @interface ICollectionsApi
+ * @description This interface defines methods for managing collections and their records in the system.
+ */
+interface ICollectionsApi {
+    /**
+     * Get all collections.
+     * @handleName getICollections
+     * @param {string} [langCode] - Language code. Default: "en_US".
+     * @param {ICollectionQuery} [userQuery] - Query parameters.
+     * @example
+        {
+          "limit": 30,
+          "offset": 0,
+          "entityType": "orders",
+          "entityId": 1
+        }
+     * @param {number} [userQuery.limit] - Parameter for pagination. Default: 0.
+     * @param {number} [userQuery.offset] - Parameter for pagination. Default: 30.
+     * @param {string} [userQuery.entityType] - Entity type. Example: "orders".
+     * @param {number} [userQuery.entityId] - Entity identifier. Example: 1.
+     * @returns {ICollectionEntity[]} Returns an array of ICollection objects or an error object if there was an issue.
+     * @throws {IError} - If there is an error during the fetch operation, it will return an error object.
+     * @description This method gets all collections.
+     */
+    getICollections(langCode: string, userQuery?: ICollectionQuery): Promise<ICollectionEntity[] | IError>;
+    /**
+     * Get a single collection object by id.
+     * @handleName getICollectionById
+     * @param {number} id - Collection id. Example: 1.
+     * @param {string} [langCode] - Language code. Default: "en_US".
+     * @returns {ICollectionEntity} Returns an ICollection object or an error object if there was an issue.
+     * @throws {IError} - If there is an error during the fetch operation, it will return an error object.
+     * @description This method gets a single collection object by id.
+     */
+    getICollectionById(id: number, langCode: string): Promise<ICollectionEntity | IError>;
+    /**
+     * Get all records belonging to the collection by collection id.
+     * @handleName getICollectionRowsById
+     * @param {number} id - Collection id.
+     * @param {string} [langCode] - Language code. Default: "en_US".
+     * @param {ICollectionQuery} [userQuery] - Optional set query parameters.
+     * @example
+        {
+          "limit": 30,
+          "offset": 0,
+          "entityType": "orders",
+          "entityId": 1
+        }
+     * @param {number} [userQuery.limit] - Optional parameter for pagination. Default: 30.
+     * @param {number} [userQuery.offset] - Optional parameter for pagination. Default: 0.
+     * @param {string} [userQuery.entityType] - Entity type. Example: "orders".
+     * @param {number} [userQuery.entityId] - Entity identifier. Example: 1.
+     * @returns {ICollectionRowsResponce} Returns object ItemsWithTotal, where items is an array of requested objects.
+     * @throws {IError} - If there is an error during the fetch operation, it will return an error object.
+     * @description This method gets all records belonging to the collection by collection id.
+     */
+    getICollectionRowsById(id: number, langCode: string, userQuery?: ICollectionQuery): Promise<ICollectionRowsResponce | IError>;
+    /**
+     * Check for the existence of a text identifier (marker).
+     * @handleName validateICollectionMarker
+     * @param {string} marker - Collection marker. Example: "collection1".
+     * @returns {ICollectionIsValid} Returns an object with a boolean property `valid` indicating whether the marker is valid or not.
+     * @example
+        {
+          "valid": true
+        }
+     * @throws {IError} - If there is an error during the fetch operation, it will return an error object.
+     * @description This method checks for the existence of a text identifier (marker).
+     */
+    validateICollectionMarker(marker: string): Promise<ICollectionIsValid | IError>;
+    /**
+     * Getting all records from the collection.
+     * @handleName getICollectionRowsByMarker
+     * @param {string} marker - Collection text identifier. Example: "collection1".
+     * @param {string} [langCode] - Language code. Default: "en_US".
+     * @returns {ICollectionRowsResponce} Returns collection row entity object.
+     * @throws {IError} - If there is an error during the fetch operation, it will return an error object.
+     * @description This method gets all records from the collection.
+     */
+    getICollectionRowsByMarker(marker: string, langCode?: string): Promise<ICollectionRowsResponce | IError>;
+    /**
+     * Getting one record from the collection.
+     * @handleName getICollectionRowByMarkerAndId
+     * @param {string} marker - Collection text identifier. Example: "collection1".
+     * @param {number} id - Collection record identifier. Example: 1.
+     * @param {string} [langCode] - Language code. Default: "en_US".
+     * @returns {ICollectionRow} Returns collection row entity object.
+     * @throws {IError} - If there is an error during the fetch operation, it will return an error object.
+     * @description This method gets one record from the collection.
+     */
+    getICollectionRowByMarkerAndId(marker: string, id: number, langCode: string): Promise<ICollectionRow | IError>;
+    /**
+     * Create a record in the collection.
+     * @handleName createICollectionRow
+     * @param {string} marker - Collection text identifier. Example: "collection1".
+     * @param {ICollectionFormObject} body - Object for creating a record.
+     * @example
+        {
+          "formIdentifier": "collection-form",
+          "formData": [
+            {
+              "marker": "collection_marker",
+              "type": "string",
+              "value": "Collection marker"
+            }
+          ]
+        }
+     * @param {string} [langCode] - Language code. Default: "en_US".
+     * @returns {ICollectionRow} Returns object of type ICollectionRow.
+     * @throws {IError} - If there is an error during the fetch operation, it will return an error object.
+     * @description This method creates a record in the collection.
+     */
+    createICollectionRow(marker: string, body: ICollectionFormObject, langCode: string): Promise<ICollectionRow | IError>;
+    /**
+     * Edit a record in the collection.
+     * @handleName updateICollectionRow
+     * @param {string} marker - Text identifier of the collection. Example: "collection1".
+     * @param {number} id - Row id. Example: 12.
+     * @param {ICollectionFormObject} body - Object for updating a record in the collection.
+     * @example
+        {
+          "formIdentifier": "collection-form",
+          "formData": [
+            {
+              "marker": "collection_marker",
+              "type": "string",
+              "value": "Collection marker"
+            }
+          ]
+        }
+     * @param {string} [langCode] - Language code. Default: "en_US".
+     * @returns {ICollectionRow} Returns object of type ICollectionRow.
+     * @throws {IError} - If there is an error during the fetch operation, it will return an error object.
+     * @description This method edits a record in the collection.
+     */
+    updateICollectionRow(marker: string, id: number, body: ICollectionFormObject, langCode: string): Promise<ICollectionRow | IError>;
+    /**
+     * Deletion of collection record object
+     * @handleName deleteICollectionRowByMarkerAndId
+     * @param {string} marker - text identifier of the collection Example: "collection1".
+     * @param {number} id - record identifier in the collection Example: 12.
+     * @returns {boolean} Returns true (in case of successful deletion) or false (in case of unsuccessful deletion) (permission "collections.row.delete" required for access)
+     * @throws {IError} - If there is an error during the fetch operation, it will return an error object.
+     * @description This method deletes a collection record object.
+     */
+    deleteICollectionRowByMarkerAndId(marker: string, id: number): Promise<boolean | IError>;
+}
+/**
+ * Collection object
+ * @interface ICollectionEntity
+ * @property {number} id - Object identifier. Example: 1.
+ * @property {string | null} identifier - Text identifier for record field. Example: "collection1".
+ * @property {number | null} formId - Identifier for the form used by the order storage. Example: 1234.
+ * @property {ILocalizeInfo} localizeInfos - Localized information about the collection.
+ * @example
+    {
+      "title": "Admins text"
+    }
+ * @property {number | null} attributeSetId - Identifier of the set of attributes used by the form attached to the collection. Example: 1234 or null if not applicable.
+ * @property {string | null} selectedAttributeMarkers - Text identifiers of form object attributes for display in the data table. Example: "collection_marker".
+ * @description Represents a collection object with various properties, including identifiers, form information, and localized data.
+ */
+interface ICollectionEntity {
+    id: number;
+    identifier: string | null;
+    formId: number | null;
+    localizeInfos: ILocalizeInfo;
+    attributeSetId: number | null;
+    selectedAttributeMarkers: string | null;
+}
+/**
+ * Collection response object
+ * @interface ICollectionResponce
+ * @property {ICollectionEntity[]} items - Array of collection objects.
+ * @example
+    [
+      {
+        "id": 1,
+        "identifier": "collection1"
+      }
+    ]
+ * @property {number} total - Total number of found records. Example: 10.
+ * @description Represents a response from the collections API containing a total count and an array of collection objects.
+ */
+interface ICollectionResponce {
+    items: ICollectionEntity[];
+    total: number;
+}
+/**
+ * Collection form data object
+ * @interface ICollectionFormData
+ * @property {string} marker - Text identifier (marker) of the form field. Example: "collection_marker".
+ * @property {string} type - Type of the form field, such as "text", "number", "date", "etc". Example: "number".
+ * @property {string} value - Value of the form field, which can be a "string", "number", "date", "etc". Example: "Collection marker".
+ * @description Represents a form data object within a collection, containing a marker, type, and value.
+ */
+interface ICollectionFormData {
+    marker: string;
+    type: string;
+    value: string;
+}
+/**
+ * Collection form object
+ * @interface ICollectionFormObject
+ * @property {string} formIdentifier - Text identifier (marker) of the form. Example: "collection-form".
+ * @property {Record<string, ICollectionFormData>} formData - An object where keys are form field markers and values are arrays of ICollectionFormData objects.
+ * @example
+    [
+      {
+        "marker": "name_1",
+        "type": "string",
+        "value": "Value"
+      }
+    ]
+ * @property {string} formData[].marker - Text identifier (marker) of the form field. Example: "name_1".
+ * @property {string} formData[].type - Type of the form field. Example: "string".
+ * @property {string} formData[].value - Value of the form field. Example: "Value".
+ * @description Represents a collection form object that contains a form identifier and associated form data. This interface defines the structure of a collection form object, which includes a form identifier and a set of form data organized by markers.
+ */
+interface ICollectionFormObject {
+    formIdentifier: string;
+    formData: {
+        [key: string]: ICollectionFormData[];
+    };
+}
+/**
+ * Collection row object
+ * @interface ICollectionRow
+ * @property {number} id - Object identifier. Example: 1.
+ * @property {string} createdDate - Date of creation of the record. Example: "2023-01-01T00:00:00Z".
+ * @property {string} updatedDate - Date of last update of the record. Example: "2023-01-02T00:00:00Z".
+ * @property {number | null} [collectionId] - collectionId associated with the collection row. Example: "product", "order", "etc".
+ * @property {ICollectionFormData[]} formData - Array of form data objects associated with the collection row.
+ * @example
+    [
+      {
+        "marker": "name_1",
+        "type": "string",
+        "value": "Value"
+      }
+    ]
+ * @property {string | null} entityType - Type of the entity associated with the collection row. Example: "product", "order", "etc".
+ * @property {number | null} entityId - Identifier of the entity associated with the collection row. Example: 12345.
+ * @property {string | null} [attributeSetIdentifier] - Identifier of the attribute set used by the form attached to the collection row, or null if not applicable. Example: "attributeSet1" or null.
+ * @property {string | null} [langCode] - Language code the row was stored under. Example: "en_US".
+ * @property {string | null} [formIdentifier] - Text identifier of the form the row was created from; returned by the create/update row endpoints. Example: "collection_form".
+ * @property {string} total - Total count. Example: "1".
+ * @description Represents a row in a collection, containing various properties such as identifiers, dates, form data, and an optional total value.
+ */
+interface ICollectionRow {
+    id: number;
+    createdDate: string;
+    updatedDate: string;
+    collectionId?: number | null;
+    formData: ICollectionFormData[];
+    entityType: string | null;
+    entityId: number | null;
+    attributeSetIdentifier?: string | null;
+    langCode?: string | null;
+    formIdentifier?: string | null;
+    total?: string;
+}
+/**
+ * Collection rows response object
+ * @interface ICollectionRowsResponce
+ * @property {ICollectionRow[]} items - Array of collection row objects.
+ * @example
+    [
+      {
+        "id": 1,
+        "createdDate": "2025-06-06T19:08:54.616Z",
+        "updatedDate": "2025-06-06T19:08:54.616Z",
+        "entityId": null,
+        "entityType": null,
+        "formData": [
+          {
+          "marker": "name_1",
+          "type": "string",
+          "value": "Value"
+          }
+        ],
+        "attributeSetIdentifier": null
+      }
+    ]
+ * @property {number} total - Total number of found records. Example: 10.
+ * @description Represents a response from the collections API containing a total count and an array of collection row objects.
+ */
+interface ICollectionRowsResponce {
+    items: ICollectionRow[];
+    total: number;
+}
+/**
+ * Collection is valid object
+ * @interface ICollectionIsValid
+ * @property {boolean} valid - Valid marker object. Example: true.
+ * @description Represents a response from the validateICollectionMarker.
+ */
+interface ICollectionIsValid {
+    valid: boolean;
+}
+/**
+ * Query parameters for collection requests.
+ * @interface ICollectionQuery
+ * @property {number} limit - Parameter for pagination. Default: 30.
+ * @property {number} offset - Parameter for pagination. Default: 0.
+ * @property {string} entityType - Entity type. Example: "orders".
+ * @property {number} entityId - Entity identifier. Example: 1.
+ */
+interface ICollectionQuery {
+    limit: number;
+    offset: number;
+    entityType: string;
+    entityId: number;
+}
+export type { ICollectionEntity, ICollectionFormObject, ICollectionIsValid, ICollectionQuery, ICollectionResponce, ICollectionRow, ICollectionRowsResponce, ICollectionsApi, };

package/esm/integration-collections/integrationCollectionsInterfaces.js

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

package/esm/integration-collections/integrationCollectionsSchemas.d.ts

@@ -0,0 +1,84 @@
+/**
+ * Validation schemas for IntegrationCollections module
+ * @description Zod schemas for validating integration collections-related API responses
+ */
+import { z } from 'zod';
+/**
+ * Collection entity schema
+ */
+export declare const CollectionEntitySchema: z.ZodObject<{
+    id: z.ZodNumber;
+    identifier: z.ZodNullable<z.ZodString>;
+    formId: z.ZodNullable<z.ZodNumber>;
+    localizeInfos: z.ZodRecord<z.ZodString, z.ZodAny>;
+    attributeSetId: z.ZodNullable<z.ZodNumber>;
+    selectedAttributeMarkers: z.ZodNullable<z.ZodString>;
+}, z.core.$strip>;
+/**
+ * Collections response schema (array of collections)
+ */
+export declare const CollectionsResponseSchema: z.ZodArray<z.ZodObject<{
+    id: z.ZodNumber;
+    identifier: z.ZodNullable<z.ZodString>;
+    formId: z.ZodNullable<z.ZodNumber>;
+    localizeInfos: z.ZodRecord<z.ZodString, z.ZodAny>;
+    attributeSetId: z.ZodNullable<z.ZodNumber>;
+    selectedAttributeMarkers: z.ZodNullable<z.ZodString>;
+}, z.core.$strip>>;
+/**
+ * Collection form data schema
+ */
+export declare const CollectionFormDataSchema: z.ZodObject<{
+    marker: z.ZodString;
+    type: z.ZodString;
+    value: z.ZodString;
+}, z.core.$strip>;
+/**
+ * Collection row schema
+ */
+export declare const CollectionRowSchema: z.ZodObject<{
+    id: z.ZodNumber;
+    createdDate: z.ZodString;
+    updatedDate: z.ZodString;
+    collectionId: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
+    formData: z.ZodUnion<readonly [z.ZodArray<z.ZodObject<{
+        marker: z.ZodString;
+        type: z.ZodString;
+        value: z.ZodString;
+    }, z.core.$strip>>, z.ZodRecord<z.ZodString, z.ZodAny>]>;
+    entityType: z.ZodNullable<z.ZodString>;
+    entityId: z.ZodNullable<z.ZodNumber>;
+    attributeSetIdentifier: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+    langCode: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+    formIdentifier: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+    total: z.ZodOptional<z.ZodString>;
+}, z.core.$strip>;
+/**
+ * Collection rows response schema
+ */
+export declare const CollectionRowsResponseSchema: z.ZodObject<{
+    items: z.ZodArray<z.ZodObject<{
+        id: z.ZodNumber;
+        createdDate: z.ZodString;
+        updatedDate: z.ZodString;
+        collectionId: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
+        formData: z.ZodUnion<readonly [z.ZodArray<z.ZodObject<{
+            marker: z.ZodString;
+            type: z.ZodString;
+            value: z.ZodString;
+        }, z.core.$strip>>, z.ZodRecord<z.ZodString, z.ZodAny>]>;
+        entityType: z.ZodNullable<z.ZodString>;
+        entityId: z.ZodNullable<z.ZodNumber>;
+        attributeSetIdentifier: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+        langCode: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+        formIdentifier: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+        total: z.ZodOptional<z.ZodString>;
+    }, z.core.$strip>>;
+    total: z.ZodNumber;
+}, z.core.$strip>;
+/**
+ * Collection is valid schema
+ */
+export declare const CollectionIsValidSchema: z.ZodObject<{
+    valid: z.ZodBoolean;
+}, z.core.$strip>;

package/esm/integration-collections/integrationCollectionsSchemas.js

@@ -0,0 +1,60 @@
+/**
+ * Validation schemas for IntegrationCollections module
+ * @description Zod schemas for validating integration collections-related API responses
+ */
+import { z } from 'zod';
+/**
+ * Collection entity schema
+ */
+export const CollectionEntitySchema = z.object({
+    id: z.number(),
+    identifier: z.string().nullable(),
+    formId: z.number().nullable(),
+    localizeInfos: z.record(z.string(), z.any()),
+    attributeSetId: z.number().nullable(),
+    selectedAttributeMarkers: z.string().nullable(),
+});
+/**
+ * Collections response schema (array of collections)
+ */
+export const CollectionsResponseSchema = z.array(CollectionEntitySchema);
+/**
+ * Collection form data schema
+ */
+export const CollectionFormDataSchema = z.object({
+    marker: z.string(),
+    type: z.string(),
+    value: z.string(),
+});
+/**
+ * Collection row schema
+ */
+export const CollectionRowSchema = z.object({
+    id: z.number(),
+    createdDate: z.string(),
+    updatedDate: z.string(),
+    collectionId: z.number().nullable().optional(),
+    formData: z.union([
+        z.array(CollectionFormDataSchema),
+        z.record(z.string(), z.any()),
+    ]),
+    entityType: z.string().nullable(),
+    entityId: z.number().nullable(),
+    attributeSetIdentifier: z.string().nullable().optional(),
+    langCode: z.string().nullable().optional(),
+    formIdentifier: z.string().nullable().optional(),
+    total: z.string().optional(),
+});
+/**
+ * Collection rows response schema
+ */
+export const CollectionRowsResponseSchema = z.object({
+    items: z.array(CollectionRowSchema),
+    total: z.number(),
+});
+/**
+ * Collection is valid schema
+ */
+export const CollectionIsValidSchema = z.object({
+    valid: z.boolean(),
+});

package/esm/locales/localesApi.d.ts

@@ -0,0 +1,28 @@
+import AsyncModules from '../base/asyncModules.js';
+import type StateModule from '../base/stateModule.js';
+import type { IError } from '../base/utils.js';
+import type { ILocalEntity, ILocales } from './localesInterfaces.js';
+/**
+ * Controllers for working with localizations (content language)
+ * @handle /api/content/locales
+ * @description Controllers for working with localizations (content language)
+ */
+export default class LocalesApi extends AsyncModules implements ILocales {
+    protected state: StateModule;
+    protected _url: string;
+    /**
+     * Constructor
+     * @param {StateModule} state - StateModule instance
+     * @description Constructor initializes the LocalesApi with a given state.
+     */
+    constructor(state: StateModule);
+    /**
+     * Find all active language localization objects.
+     * @handleName getLocales
+     * @returns {Promise<ILocalEntity[] | IError>} Returns an array of LocaleEntity objects.
+     * @throws {IError} When isShell=false and an error occurs during the fetch
+     * @description Find all active language localization objects.
+     * @see {@link https://js-sdk.oneentry.cloud/docs/locales/getLocales getLocales} documentation.
+     */
+    getLocales(): Promise<Array<ILocalEntity> | IError>;
+}

package/esm/locales/localesApi.js

@@ -0,0 +1,33 @@
+import AsyncModules from '../base/asyncModules.js';
+import createSchemaLoader from '../base/lazySchema.js';
+const schema = createSchemaLoader(() => import('./localesSchemas.js'));
+/**
+ * Controllers for working with localizations (content language)
+ * @handle /api/content/locales
+ * @description Controllers for working with localizations (content language)
+ */
+export default class LocalesApi extends AsyncModules {
+    /**
+     * Constructor
+     * @param {StateModule} state - StateModule instance
+     * @description Constructor initializes the LocalesApi with a given state.
+     */
+    constructor(state) {
+        super(state);
+        this._url = state.url + '/api/content/locales';
+    }
+    /**
+     * Find all active language localization objects.
+     * @handleName getLocales
+     * @returns {Promise<ILocalEntity[] | IError>} Returns an array of LocaleEntity objects.
+     * @throws {IError} When isShell=false and an error occurs during the fetch
+     * @description Find all active language localization objects.
+     * @see {@link https://js-sdk.oneentry.cloud/docs/locales/getLocales getLocales} documentation.
+     */
+    async getLocales() {
+        const result = await this._fetchGet('/active/all');
+        // Validate response if validation is enabled
+        const validated = await this._validateResponse(result, schema('LocalesResponseSchema'));
+        return validated;
+    }
+}

package/esm/locales/localesInterfaces.d.ts

@@ -0,0 +1,40 @@
+import type { IError } from '../base/utils.js';
+/**
+ * The `ILocales` interface defines methods for working with language localization objects in the system.
+ * @interface ILocales
+ * @description This interface defines a method for retrieving all active language localization objects in the system.
+ */
+interface ILocales {
+    /**
+     * Find all active language localization objects.
+     * @handleName getLocales
+     * @returns {ILocalEntity[]} Returns an array of LocaleEntity objects.
+     * @throws {IError} - If there is an error during the fetch operation, it will return an error object.
+     * @description This method finds all active language localization objects.
+     */
+    getLocales(): Promise<ILocalEntity[] | IError>;
+}
+/**
+ * The `ILocalEntity` interface defines the structure of a locales entity, including its identifiers, name, and other properties.
+ * @interface ILocalEntity
+ * @property {number} id - The unique identifier of the locales. Example: 1.
+ * @property {string} shortCode - The shortCode of locales. Example: "en".
+ * @property {string} code - The full language code. Example: "en_US".
+ * @property {string} name - The language name. Example: "English".
+ * @property {string} nativeName - The native language name. Example: "English".
+ * @property {boolean} isActive - Active language flag. Example: true.
+ * @property {string | null} image - The language image. Example: "https://example.com/images/en.png".
+ * @property {number} position - The language position. Example: 1.
+ * @description This interface defines the structure of a locales entity, including its identifiers, name, and other properties.
+ */
+interface ILocalEntity {
+    id: number;
+    shortCode: string;
+    code: string;
+    name: string;
+    nativeName: string;
+    isActive: boolean;
+    image: string | null;
+    position: number;
+}
+export type { ILocalEntity, ILocales };

package/esm/locales/localesInterfaces.js

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

package/esm/locales/localesSchemas.d.ts

@@ -0,0 +1,32 @@
+/**
+ * Validation schemas for Locales module
+ * @description Zod schemas for validating locales-related API responses
+ */
+import { z } from 'zod';
+/**
+ * Locale entity schema
+ * Includes all fields returned by the API
+ */
+export declare const LocaleEntitySchema: z.ZodObject<{
+    id: z.ZodNumber;
+    shortCode: z.ZodString;
+    code: z.ZodString;
+    name: z.ZodString;
+    nativeName: z.ZodString;
+    isActive: z.ZodBoolean;
+    image: z.ZodNullable<z.ZodString>;
+    position: z.ZodNumber;
+}, z.core.$strip>;
+/**
+ * Locales response schema (array of locales)
+ */
+export declare const LocalesResponseSchema: z.ZodArray<z.ZodObject<{
+    id: z.ZodNumber;
+    shortCode: z.ZodString;
+    code: z.ZodString;
+    name: z.ZodString;
+    nativeName: z.ZodString;
+    isActive: z.ZodBoolean;
+    image: z.ZodNullable<z.ZodString>;
+    position: z.ZodNumber;
+}, z.core.$strip>>;

package/esm/locales/localesSchemas.js

@@ -0,0 +1,23 @@
+/**
+ * Validation schemas for Locales module
+ * @description Zod schemas for validating locales-related API responses
+ */
+import { z } from 'zod';
+/**
+ * Locale entity schema
+ * Includes all fields returned by the API
+ */
+export const LocaleEntitySchema = z.object({
+    id: z.number(),
+    shortCode: z.string(),
+    code: z.string(),
+    name: z.string(),
+    nativeName: z.string(),
+    isActive: z.boolean(),
+    image: z.string().nullable(),
+    position: z.number(),
+});
+/**
+ * Locales response schema (array of locales)
+ */
+export const LocalesResponseSchema = z.array(LocaleEntitySchema);

package/esm/menus/menusApi.d.ts

@@ -0,0 +1,30 @@
+import AsyncModules from '../base/asyncModules.js';
+import type StateModule from '../base/stateModule.js';
+import type { IError } from '../base/utils.js';
+import type { IMenus, IMenusEntity } from './menusInterfaces.js';
+/**
+ * Controllers for working with menu objects
+ * @handle /api/content/menus
+ * @description Controllers for working with menu objects
+ */
+export default class MenusApi extends AsyncModules implements IMenus {
+    protected state: StateModule;
+    protected _url: string;
+    /**
+     * Constructor initializes the MenusApi with a given state.
+     * @param {StateModule} state - The state module.
+     * @description Constructor initializes the MenusApi with a given state.
+     */
+    constructor(state: StateModule);
+    /**
+     * Get pages includes in menu by marker.
+     * @handleName getMenusByMarker
+     * @param {string} marker - Menu marker. Example: "main_menu".
+     * @param {string} [langCode] - Language code. Default: "en_US".
+     * @returns {Promise<IMenusEntity | IError>} Returns a single menu object as a ContentMenu object with included pages.
+     * @throws {IError} When isShell=false and an error occurs during the fetch
+     * @description Get pages includes in menu by marker.
+     * @see {@link https://js-sdk.oneentry.cloud/docs/menus/getMenusByMarker getMenusByMarker} documentation.
+     */
+    getMenusByMarker(marker: string, langCode?: string): Promise<IMenusEntity | IError>;
+}