oneentry 1.0.159 → 1.0.161

package/esm/menus/menusApi.js

@@ -0,0 +1,35 @@
+import AsyncModules from '../base/asyncModules.js';
+import createSchemaLoader from '../base/lazySchema.js';
+const schema = createSchemaLoader(() => import('./menusSchemas.js'));
+/**
+ * Controllers for working with menu objects
+ * @handle /api/content/menus
+ * @description Controllers for working with menu objects
+ */
+export default class MenusApi extends AsyncModules {
+    /**
+     * 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.
+     * @see {@link https://js-sdk.oneentry.cloud/docs/menus/getMenusByMarker getMenusByMarker} documentation.
+     */
+    async getMenusByMarker(marker, langCode = this.state.lang) {
+        const result = await this._fetchGet(`/marker/${marker}?langCode=${langCode}`);
+        // Validate response if validation is enabled
+        const validated = await this._validateResponse(result, schema('MenuEntitySchema'));
+        return this._normalizeData(validated, langCode);
+    }
+}

package/esm/menus/menusInterfaces.d.ts

@@ -0,0 +1,87 @@
+import type { IAttributeValues, IError, ILocalizeInfo } from '../base/utils.js';
+/**
+ * @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[];
+}
+export type { IMenus, IMenusEntity, IMenusPages };

package/esm/menus/menusInterfaces.js

@@ -0,0 +1,2 @@
+// import type { IAttributesSets } from 'attribute-sets/attributeSetsInterfaces';
+export {};

package/esm/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/esm/menus/menusSchemas.js

@@ -0,0 +1,25 @@
+import { z } from 'zod';
+/**
+ * Menu pages schema (recursive)
+ * Can have children that are also menu pages
+ */
+// eslint-disable-next-line @typescript-eslint/no-explicit-any
+export const MenusPagesSchema = z.lazy(() => z.object({
+    children: z.union([z.array(MenusPagesSchema), MenusPagesSchema]).optional(),
+    id: z.number().nullable(),
+    pageUrl: z.string().nullable(),
+    localizeInfos: z.record(z.string(), z.any()),
+    attributeValues: z.record(z.string(), z.any()),
+    position: z.number(),
+    parentId: z.number().nullable(),
+}));
+/**
+ * Menu entity schema
+ * Includes all fields returned by the API
+ */
+export const MenuEntitySchema = z.object({
+    id: z.number(),
+    identifier: z.string(),
+    localizeInfos: z.record(z.string(), z.any()),
+    pages: z.union([z.array(MenusPagesSchema), MenusPagesSchema]),
+});

package/esm/orders/ordersApi.d.ts

@@ -0,0 +1,213 @@
+import AsyncModules from '../base/asyncModules.js';
+import type StateModule from '../base/stateModule.js';
+import type { IError } from '../base/utils.js';
+import type { IBaseOrdersEntity, ICreateOrderPreview, ICreateRefundRequest, IOrderByMarkerEntity, IOrderData, IOrderPreviewResponse, IOrdersApi, IOrdersByMarkerEntity, IOrdersEntity, IOrderStatus, IOrdersVectorSearch, IRefundRequest } from './ordersInterfaces.js';
+/**
+ * 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;
+    private _ordersUrl;
+    /**
+     * 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}.
+     * @see {@link https://js-sdk.oneentry.cloud/docs/orders/getAllOrdersStorage getAllOrdersStorage} documentation.
+     */
+    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}.
+     * @see {@link https://js-sdk.oneentry.cloud/docs/orders/getAllOrdersByMarker getAllOrdersByMarker} documentation.
+     */
+    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}.
+     * @see {@link https://js-sdk.oneentry.cloud/docs/orders/getOrdersStorageByMarker getOrdersStorageByMarker} documentation.
+     */
+    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}.
+     * @see {@link https://js-sdk.oneentry.cloud/docs/orders/getOrderByMarkerAndId getOrderByMarkerAndId} documentation.
+     */
+    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}.
+     * @see {@link https://js-sdk.oneentry.cloud/docs/orders/previewOrder previewOrder} documentation.
+     */
+    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}.
+     * @see {@link https://js-sdk.oneentry.cloud/docs/orders/createOrder createOrder} documentation.
+     */
+    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}.
+     * @see {@link https://js-sdk.oneentry.cloud/docs/orders/updateOrderByMarkerAndId updateOrderByMarkerAndId} documentation.
+     */
+    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}.
+     * @see {@link https://js-sdk.oneentry.cloud/docs/orders/getAllStatusesByStorageMarker getAllStatusesByStorageMarker} documentation.
+     */
+    getAllStatusesByStorageMarker(marker: string, langCode?: string, offset?: number, limit?: number): Promise<IOrderStatus[] | IError>;
+    /**
+     * Get all refund requests for an order.
+     * @handleName getRefunds
+     * @param {number} id - Order id. Example: 1.
+     * @returns {Promise<IRefundRequest[] | IError>} Returns array of refund requests.
+     * @throws {IError} When isShell=false and an error occurs during the fetch
+     * @see {@link https://js-sdk.oneentry.cloud/docs/orders/getRefunds getRefunds} documentation.
+     */
+    getRefunds(id: number): Promise<IRefundRequest[] | IError>;
+    /**
+     * Create a refund request for an order.
+     * @handleName createRefundRequest
+     * @param {number} id - Order id. Example: 1.
+     * @param {ICreateRefundRequest} body - Refund request body.
+     * @returns {Promise<boolean | IError>} Returns true if the refund request was created successfully.
+     * @throws {IError} When isShell=false and an error occurs during the fetch
+     * @see {@link https://js-sdk.oneentry.cloud/docs/orders/createRefundRequest createRefundRequest} documentation.
+     */
+    createRefundRequest(id: number, body: ICreateRefundRequest): Promise<boolean | IError>;
+    /**
+     * Cancel a refund request for an order.
+     * @handleName cancelRefundRequest
+     * @param {number} id - Order id. Example: 1.
+     * @returns {Promise<boolean | IError>} Returns true if the refund request was cancelled successfully.
+     * @throws {IError} When isShell=false and an error occurs during the fetch
+     * @see {@link https://js-sdk.oneentry.cloud/docs/orders/cancelRefundRequest cancelRefundRequest} documentation.
+     */
+    cancelRefundRequest(id: number): Promise<boolean | IError>;
+    /**
+     * Semantic (vector) search for the current user's orders.
+     * @handleName getOrdersByVectorSearch
+     * @param {IOrdersVectorSearch} body - Vector search body. Example: `{ queryText: "winter jacket" }`.
+     * @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<IOrdersByMarkerEntity | IError>} Returns an object with an array of found orders and total count.
+     * @throws {IError} When isShell=false and an error occurs during the fetch
+     * @description This method performs a semantic (vector) search over the orders of the authorized user. 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/orders/getOrdersByVectorSearch getOrdersByVectorSearch} documentation.
+     */
+    getOrdersByVectorSearch(body: IOrdersVectorSearch, langCode?: string, offset?: number, limit?: number): Promise<IOrdersByMarkerEntity | IError>;
+    /**
+     * Runs a fetch against the `/orders` base URL instead of the default
+     * `/orders-storage`, then restores the original URL.
+     *
+     * Refund endpoints live under `/api/content/orders`, while this class is based
+     * on `/api/content/orders-storage`. The helper swaps `_url` for the duration of
+     * the call and restores it in `finally`, so the base URL is restored even if
+     * the request throws.
+     * @param {() => Promise<T>} fetcher - Thunk performing the fetch call.
+     * @returns {Promise<T>} The fetcher result.
+     * @template T
+     */
+    private _withOrdersUrl;
+}