oneentry 1.0.142 → 1.0.143

package/dist/locales/localesApi.d.ts

@@ -0,0 +1,27 @@
+import AsyncModules from '../base/asyncModules';
+import type StateModule from '../base/stateModule';
+import type { IError } from '../base/utils';
+import type { ILocalEntity, ILocales } from './localesInterfaces';
+/**
+ * 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.
+     */
+    getLocales(): Promise<Array<ILocalEntity> | IError>;
+}

package/dist/locales/localesApi.js

@@ -0,0 +1,37 @@
+"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 localesSchemas_1 = require("./localesSchemas");
+/**
+ * Controllers for working with localizations (content language)
+ * @handle /api/content/locales
+ * @description Controllers for working with localizations (content language)
+ */
+class LocalesApi extends asyncModules_1.default {
+    /**
+     * 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.
+     */
+    async getLocales() {
+        const result = await this._fetchGet('/active/all');
+        // Validate response if validation is enabled
+        const validated = this._validateResponse(result, localesSchemas_1.LocalesResponseSchema);
+        return validated;
+    }
+}
+exports.default = LocalesApi;

package/dist/locales/localesInterfaces.d.ts

@@ -0,0 +1,40 @@
+import type { IError } from '../base/utils';
+/**
+ * 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/dist/locales/localesInterfaces.js

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

package/dist/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/dist/locales/localesSchemas.js

@@ -0,0 +1,26 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.LocalesResponseSchema = exports.LocaleEntitySchema = void 0;
+/**
+ * Validation schemas for Locales module
+ * @description Zod schemas for validating locales-related API responses
+ */
+const zod_1 = require("zod");
+/**
+ * Locale entity schema
+ * Includes all fields returned by the API
+ */
+exports.LocaleEntitySchema = zod_1.z.object({
+    id: zod_1.z.number(),
+    shortCode: zod_1.z.string(),
+    code: zod_1.z.string(),
+    name: zod_1.z.string(),
+    nativeName: zod_1.z.string(),
+    isActive: zod_1.z.boolean(),
+    image: zod_1.z.string().nullable(),
+    position: zod_1.z.number(),
+});
+/**
+ * Locales response schema (array of locales)
+ */
+exports.LocalesResponseSchema = zod_1.z.array(exports.LocaleEntitySchema);

package/dist/menus/menusApi.d.ts

@@ -0,0 +1,29 @@
+import AsyncModules from '../base/asyncModules';
+import type StateModule from '../base/stateModule';
+import type { IError } from '../base/utils';
+import type { IMenus, IMenusEntity } from './menusInterfaces';
+/**
+ * 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.
+     */
+    getMenusByMarker(marker: string, langCode?: string): Promise<IMenusEntity | IError>;
+}

package/dist/menus/menusApi.js

@@ -0,0 +1,39 @@
+"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 menusSchemas_1 = require("./menusSchemas");
+/**
+ * Controllers for working with menu objects
+ * @handle /api/content/menus
+ * @description Controllers for working with menu objects
+ */
+class MenusApi extends asyncModules_1.default {
+    /**
+     * 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) {
+        super(state);
+        this._url = state.url + '/api/content/menus';
+    }
+    /**
+     * 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.
+     */
+    async getMenusByMarker(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, menusSchemas_1.MenuEntitySchema);
+        return this._dataPostProcess(validated, langCode);
+    }
+}
+exports.default = MenusApi;

package/dist/menus/menusInterfaces.d.ts

@@ -0,0 +1,87 @@
+import type { IAttributeValues, IError, ILocalizeInfo } from '../base/utils';
+/**
+ * @interface IMenus
+ * @description This interface defines a method for retrieving menu pages by a specific marker and language code.
+ */
+interface IMenus {
+    /**
+     * 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 {IMenusEntity} Returns a single menu object as a ContentMenu object with included pages.
+     * @throws {IError} - If there is an error during the fetch operation, it will return an error object.
+     * @description This method gets pages includes in menu by marker.
+     */
+    getMenusByMarker(marker: string, langCode: string): Promise<IMenusEntity | IError>;
+}
+/**
+ * @interface IMenusPages
+ * @property {IMenusPages[]} children - Contains array with child page objects.
+ * @example
+    [
+      {
+        "id": null,
+        "pageUrl": null,
+        "localizeInfos": {},
+        "attributeValues": {},
+        "parentId": null,
+        "position": 1
+      }
+    ]
+ * @property {number | null} id - The unique identifier of the menu. Example: 1.
+ * @property {string | null} pageUrl - The page url string. Example: "about".
+ * @property {ILocalizeInfo} localizeInfos - The menu data, taking into account localization.
+ * @example
+    {
+      "title": "menu"
+    }
+ * @property {IAttributeValues} attributeValues - Attributes sets.
+ * @example
+    {
+      "color": "red",
+      "size": "large"
+    }
+ * @property {number} position - The menu position. Example: 1.
+ * @property {number | null} parentId - The menu parent id. Example: null.
+ * @description This interface defines the structure of a menu page entity, including its identifiers, localization information, attributes, and hierarchical relationships.
+ */
+interface IMenusPages {
+    children?: IMenusPages[] | IMenusPages;
+    id: number | null;
+    pageUrl: string | null;
+    localizeInfos: ILocalizeInfo;
+    attributeValues: IAttributeValues;
+    position: number;
+    parentId: number | null;
+}
+/**
+ * @interface IMenusEntity
+ * @property {number} id - The unique identifier of the menu. Example: 1.
+ * @property {string} identifier - The menu identifier. Example: "main_menu".
+ * @property {ILocalizeInfo} localizeInfos - Contains localization information.
+ * @example
+    {
+      "title": "menu"
+    }
+ * @property {IMenusPages[]} pages - Array of menu pages.
+ * @example
+    [
+      {
+        "id": null,
+        "pageUrl": null,
+        "localizeInfos": {},
+        "attributeValues": {},
+        "parentId": null,
+        "position": 1
+      }
+    ]
+ * @description This interface defines the structure of a menu entity, including its identifiers, localization information, and associated pages.
+ */
+interface IMenusEntity {
+    id: number;
+    identifier: string;
+    localizeInfos: ILocalizeInfo;
+    pages: IMenusPages[] | IMenusPages;
+}
+export type { IMenus, IMenusEntity, IMenusPages };

package/dist/menus/menusInterfaces.js

@@ -0,0 +1,3 @@
+"use strict";
+// import type { IAttributesSets } from 'attribute-sets/attributeSetsInterfaces';
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/menus/menusSchemas.d.ts

@@ -0,0 +1,16 @@
+import { z } from 'zod';
+/**
+ * Menu pages schema (recursive)
+ * Can have children that are also menu pages
+ */
+export declare const MenusPagesSchema: z.ZodType<any>;
+/**
+ * Menu entity schema
+ * Includes all fields returned by the API
+ */
+export declare const MenuEntitySchema: z.ZodObject<{
+    id: z.ZodNumber;
+    identifier: z.ZodString;
+    localizeInfos: z.ZodRecord<z.ZodString, z.ZodAny>;
+    pages: z.ZodUnion<readonly [z.ZodArray<z.ZodType<any, unknown, z.core.$ZodTypeInternals<any, unknown>>>, z.ZodType<any, unknown, z.core.$ZodTypeInternals<any, unknown>>]>;
+}, z.core.$strip>;

package/dist/menus/menusSchemas.js

@@ -0,0 +1,28 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.MenuEntitySchema = exports.MenusPagesSchema = void 0;
+const zod_1 = require("zod");
+/**
+ * Menu pages schema (recursive)
+ * Can have children that are also menu pages
+ */
+// eslint-disable-next-line @typescript-eslint/no-explicit-any
+exports.MenusPagesSchema = zod_1.z.lazy(() => zod_1.z.object({
+    children: zod_1.z.union([zod_1.z.array(exports.MenusPagesSchema), exports.MenusPagesSchema]).optional(),
+    id: zod_1.z.number().nullable(),
+    pageUrl: zod_1.z.string().nullable(),
+    localizeInfos: zod_1.z.record(zod_1.z.string(), zod_1.z.any()),
+    attributeValues: zod_1.z.record(zod_1.z.string(), zod_1.z.any()),
+    position: zod_1.z.number(),
+    parentId: zod_1.z.number().nullable(),
+}));
+/**
+ * Menu entity schema
+ * Includes all fields returned by the API
+ */
+exports.MenuEntitySchema = zod_1.z.object({
+    id: zod_1.z.number(),
+    identifier: zod_1.z.string(),
+    localizeInfos: zod_1.z.record(zod_1.z.string(), zod_1.z.any()),
+    pages: zod_1.z.union([zod_1.z.array(exports.MenusPagesSchema), exports.MenusPagesSchema]),
+});

package/dist/orders/ordersApi.d.ts

@@ -0,0 +1,149 @@
+import AsyncModules from '../base/asyncModules';
+import type StateModule from '../base/stateModule';
+import type { IError } from '../base/utils';
+import type { IBaseOrdersEntity, ICreateOrderPreview, IOrderByMarkerEntity, IOrderData, IOrderPreviewResponse, IOrdersApi, IOrdersByMarkerEntity, IOrdersEntity, IOrderStatus } from './ordersInterfaces';
+/**
+ * Controllers for working with orders.
+ * @handle /api/content/orders-storage
+ * @module OrdersApi
+ * @description This module provides methods for working with orders, including retrieving, creating, and updating orders in the order storage.
+ */
+export default class OrdersApi extends AsyncModules implements IOrdersApi {
+    protected state: StateModule;
+    protected _url: string;
+    /**
+     * Constructs an instance of the OrdersApi class.
+     * @param {StateModule} state - The state module containing the necessary information for making API calls.
+     * @description Constructor initializes the OrdersApi with a given state.
+     */
+    constructor(state: StateModule);
+    /**
+     * Getting all the order storage objects.
+     * @handleName getAllOrdersStorage
+     * @param {string} [langCode] - Language code. Default: "en_US".
+     * @param {number} [offset] - Optional parameter for pagination. Default: 0.
+     * @param {number} [limit] - Optional parameter for pagination. Default: 30.
+     * @returns {Promise<IOrdersEntity[] | IError>} Returns an array of order storage objects.
+     * @throws {IError} When isShell=false and an error occurs during the fetch
+     * @description This method 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}.
+     */
+    getAllOrdersStorage(langCode?: string, offset?: number, limit?: number): Promise<IOrdersEntity[] | IError>;
+    /**
+     * Getting all orders from the orders storage object created by the user.
+     * @handleName getAllOrdersByMarker
+     * @param {string} marker - Textual identifier of the order storage object. Example: "order_storage_1".
+     * @param {string} [langCode] - Language code. Default: "en_US".
+     * @param {number} [offset] - Offset parameter. Default: 0.
+     * @param {number} [limit] - Limit parameter. Default: 30.
+     * @returns {Promise<IOrdersByMarkerEntity | IError>} Returns an object with the orders.
+     * @throws {IError} When isShell=false and an error occurs during the fetch
+     * @description This method 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}.
+     */
+    getAllOrdersByMarker(marker: string, langCode?: string, offset?: number, limit?: number): Promise<IOrdersByMarkerEntity | IError>;
+    /**
+     * Retrieve one order storage object by marker.
+     * @handleName getOrdersStorageByMarker
+     * @param {string} marker - Marker of the order object. Example: "order_storage_1".
+     * @param {string} [langCode] - Language code. Default: "en_US".
+     * @returns {Promise<IOrdersEntity | IError>} Return object of order information.
+     * @throws {IError} When isShell=false and an error occurs during the fetch
+     * @description This method 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}.
+     */
+    getOrdersStorageByMarker(marker: string, langCode?: string): Promise<IOrdersEntity | IError>;
+    /**
+     * Getting a single order from the order storage object created by the user.
+     * @handleName getOrderByMarkerAndId
+     * @param {string} marker - The text identifier of the order storage object. Example: "order_storage_1".
+     * @param {number} id - ID of the order object. Example: 12345.
+     * @param {string} [langCode] - Language code. Default: "en_US".
+     * @returns {Promise<IOrderByMarkerEntity | IError>} Returns an object with the order.
+     * @throws {IError} When isShell=false and an error occurs during the fetch
+     * @description This method 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}.
+     */
+    getOrderByMarkerAndId(marker: string, id: number, langCode?: string): Promise<IOrderByMarkerEntity | IError>;
+    /**
+     * Preview order calculation with discounts and coupons (without saving).
+     * @handleName previewOrder
+     * @param {ICreateOrderPreview} body - Order preview body.
+     * @param {string} [langCode] - Language code. Default: "en_US".
+     * @returns {Promise<IOrderPreviewResponse | IError>} Returns an object with the order preview.
+     * @throws {IError} When isShell=false and an error occurs during the fetch
+     * @description This method 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}.
+     */
+    previewOrder(body: ICreateOrderPreview, langCode?: string): Promise<IOrderPreviewResponse | IError>;
+    /**
+     * Creation of an order in the order storage.
+     * @handleName createOrder
+     * @param {string} marker - Textual identifier of the order storage object. Example: "order_storage_1".
+     * @param {IOrderData} body - Object for creating an order.
+     * @example
+        {
+          "formIdentifier": "bar-orders-form",
+          "paymentAccountIdentifier": "usd-payment",
+          "formData": {
+            "marker": "name_1",
+            "value": "Name",
+            "type": "string"
+          },
+          "products": [
+            {
+            "productId": 1,
+            "quantity": 2
+            }
+          ]
+        }
+     * @param {string} [langCode] - Language code. Default: "en_US".
+     * @returns {Promise<IBaseOrdersEntity | IError>} Returns an object with the created order.
+     * @throws {IError} When isShell=false and an error occurs during the fetch
+     * @description This method 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}.
+     */
+    createOrder(marker: string, body: IOrderData, langCode?: string): Promise<IBaseOrdersEntity | IError>;
+    /**
+     * Changing an order in the orders storage
+     * @handleName updateOrderByMarkerAndId
+     * @param {string} marker - The text identifier of the order storage object. Example: "order_storage_1".
+     * @param {number} id - ID of the order object. Example: 12345.
+     * @param {IOrderData} body - Object for updating an order.
+     * @example
+        {
+          "formIdentifier": "bar-orders-form",
+          "paymentAccountIdentifier": "usd-payment",
+          "formData": {
+            "marker": "name_1",
+            "value": "Name",
+            "type": "string"
+          },
+          "products": [
+            {
+            "productId": 1,
+            "quantity": 2
+            }
+          ],
+          "currency": "USD"
+        }
+     * @param {string} [langCode] - Language code. Default: "en_US".
+     * @returns {Promise<IBaseOrdersEntity | IError>} Returns an object with the updated order.
+     * @throws {IError} When isShell=false and an error occurs during the fetch
+     * @description This method 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}.
+     */
+    updateOrderByMarkerAndId(marker: string, id: number, body: IOrderData, langCode?: string): Promise<IBaseOrdersEntity | IError>;
+    /**
+     * Get all orders statuses by Storage marker
+     * @handleName getAllStatusesByStorageMarker
+     * @param {string} marker - Textual identifier of the order storage object. Example: "order_storage_1".
+     * @param {string} [langCode] - Language code. Default: "en_US".
+     * @param {number} [offset] - Offset parameter. Default: 0.
+     * @param {number} [limit] - Limit parameter. Default: 30.
+     * @returns {Promise<IOrderStatus[] | IError>} Returns an object with the orders statuses.
+     * @throws {IError} When isShell=false and an error occurs during the fetch
+     * @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}.
+     */
+    getAllStatusesByStorageMarker(marker: string, langCode?: string, offset?: number, limit?: number): Promise<IOrderStatus[] | IError>;
+}