oneentry 1.0.142 → 1.0.144

package/dist/payments/paymentsSchemas.js

@@ -0,0 +1,65 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.CreateSessionResponseSchema = exports.PaymentAccountsResponseSchema = exports.PaymentAccountSchema = exports.SinglePaymentSessionSchema = exports.PaymentSessionsResponseSchema = exports.PaymentSessionSchema = void 0;
+const zod_1 = require("zod");
+/**
+ * Payment session schema
+ * @description Zod schema for validating payment session responses
+ */
+exports.PaymentSessionSchema = zod_1.z.object({
+    id: zod_1.z.number(),
+    orderId: zod_1.z.number(),
+    amount: zod_1.z.number().nullable(),
+    status: zod_1.z.string(),
+    createdDate: zod_1.z.string(),
+    updatedDate: zod_1.z.string(),
+    type: zod_1.z.string(),
+    paymentAccountId: zod_1.z.number(),
+    paymentUrl: zod_1.z.string().nullable(),
+});
+/**
+ * Payment sessions response schema
+ * @description Paginated response schema for payment sessions
+ */
+exports.PaymentSessionsResponseSchema = zod_1.z.object({
+    items: zod_1.z.array(exports.PaymentSessionSchema),
+    total: zod_1.z.number(),
+});
+/**
+ * Single payment session response schema
+ * @description Schema for a single payment session or array of sessions by order
+ */
+exports.SinglePaymentSessionSchema = zod_1.z.union([
+    exports.PaymentSessionSchema,
+    zod_1.z.array(exports.PaymentSessionSchema),
+]);
+/**
+ * Payment account schema
+ * @description Schema for a payment account
+ */
+exports.PaymentAccountSchema = zod_1.z.object({
+    id: zod_1.z.number(),
+    identifier: zod_1.z.string(),
+    isVisible: zod_1.z.boolean(),
+    isUsed: zod_1.z.boolean(),
+    testMode: zod_1.z.boolean(),
+    type: zod_1.z.string(),
+    settings: zod_1.z.record(zod_1.z.string(), zod_1.z.any()),
+    testSettings: zod_1.z.record(zod_1.z.string(), zod_1.z.any()).optional(),
+    localizeInfos: zod_1.z.record(zod_1.z.string(), zod_1.z.any()),
+    updatedDate: zod_1.z.string(),
+});
+/**
+ * Payment accounts response schema
+ */
+exports.PaymentAccountsResponseSchema = zod_1.z.array(exports.PaymentAccountSchema);
+/**
+ * Create session response schema
+ */
+exports.CreateSessionResponseSchema = zod_1.z.object({
+    id: zod_1.z.number(),
+    updatedDate: zod_1.z.string(),
+    version: zod_1.z.number(),
+    identifier: zod_1.z.string(),
+    paymentUrl: zod_1.z.string(),
+});

package/dist/product-statuses/productStatusesApi.d.ts

@@ -0,0 +1,47 @@
+import AsyncModules from '../base/asyncModules';
+import type StateModule from '../base/stateModule';
+import type { IError } from '../base/utils';
+import type { IProductStatusEntity, IProductStatusesApi } from './productStatusesInterfaces';
+/**
+ * Controllers for working with product statuses
+ * @handle /api/content/product-statuses
+ * @description Controllers for working with product statuses
+ */
+export default class ProductStatusesApi extends AsyncModules implements IProductStatusesApi {
+    protected state: StateModule;
+    protected _url: string;
+    /**
+     * Constructor
+     * @param {StateModule} state - State module instance
+     * @description Constructor initializes the ProductStatusesApi with a given state.
+     */
+    constructor(state: StateModule);
+    /**
+     * Search for all product status objects.
+     * @handleName getProductStatuses
+     * @param {string} [langCode] - Language code. Default: "en_US".
+     * @returns {Promise<IProductStatusEntity[] | IError>} Returns an array of product status objects.
+     * @throws {IError} When isShell=false and an error occurs during the fetch
+     * @description Search for all product status objects.
+     */
+    getProductStatuses(langCode?: string): Promise<IProductStatusEntity[] | IError>;
+    /**
+     * Search for a product status object by its textual identifier (marker).
+     * @handleName getProductsByStatusMarker
+     * @param {string} marker - Product marker. Example: "in_stock".
+     * @param {string} [langCode] - Language code. Default: "en_US".
+     * @returns {Promise<IProductStatusEntity | IError>} Returns a product status object.
+     * @throws {IError} When isShell=false and an error occurs during the fetch
+     * @description Search for a product status object by its textual identifier (marker).
+     */
+    getProductsByStatusMarker(marker: string, langCode?: string): Promise<IProductStatusEntity | IError>;
+    /**
+     * Check the existence of a textual identifier.
+     * @handleName validateMarker
+     * @param {string} marker - Product marker. Example: "in_stock".
+     * @returns {Promise<boolean | IError>} Returns true if the textual identifier (marker) exists or false if it doesn't.
+     * @throws {IError} When isShell=false and an error occurs during the fetch
+     * @description Check the existence of a textual identifier.
+     */
+    validateMarker(marker: string): Promise<boolean | IError>;
+}

package/dist/product-statuses/productStatusesApi.js

@@ -0,0 +1,70 @@
+"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 productStatusesSchemas_1 = require("./productStatusesSchemas");
+/**
+ * Controllers for working with product statuses
+ * @handle /api/content/product-statuses
+ * @description Controllers for working with product statuses
+ */
+class ProductStatusesApi extends asyncModules_1.default {
+    /**
+     * Constructor
+     * @param {StateModule} state - State module instance
+     * @description Constructor initializes the ProductStatusesApi with a given state.
+     */
+    constructor(state) {
+        super(state);
+        this._url = state.url + '/api/content/product-statuses';
+    }
+    /**
+     * Search for all product status objects.
+     * @handleName getProductStatuses
+     * @param {string} [langCode] - Language code. Default: "en_US".
+     * @returns {Promise<IProductStatusEntity[] | IError>} Returns an array of product status objects.
+     * @throws {IError} When isShell=false and an error occurs during the fetch
+     * @description Search for all product status objects.
+     */
+    async getProductStatuses(langCode = this.state.lang) {
+        const result = await this._fetchGet('');
+        // Validate response if validation is enabled
+        const validated = this._validateResponse(result, productStatusesSchemas_1.ProductStatusesResponseSchema);
+        return this._normalizeData(validated, langCode);
+    }
+    /**
+     * Search for a product status object by its textual identifier (marker).
+     * @handleName getProductsByStatusMarker
+     * @param {string} marker - Product marker. Example: "in_stock".
+     * @param {string} [langCode] - Language code. Default: "en_US".
+     * @returns {Promise<IProductStatusEntity | IError>} Returns a product status object.
+     * @throws {IError} When isShell=false and an error occurs during the fetch
+     * @description Search for a product status object by its textual identifier (marker).
+     */
+    async getProductsByStatusMarker(marker, langCode = this.state.lang) {
+        const result = await this._fetchGet(`/marker/${marker}`);
+        // Validate response if validation is enabled
+        const validated = this._validateResponse(result, productStatusesSchemas_1.ProductStatusEntitySchema);
+        return this._normalizeData(validated, langCode);
+    }
+    /**
+     * Check the existence of a textual identifier.
+     * @handleName validateMarker
+     * @param {string} marker - Product marker. Example: "in_stock".
+     * @returns {Promise<boolean | IError>} Returns true if the textual identifier (marker) exists or false if it doesn't.
+     * @throws {IError} When isShell=false and an error occurs during the fetch
+     * @description Check the existence of a textual identifier.
+     */
+    async validateMarker(marker) {
+        const result = await this._fetchGet(`/marker-validation/${marker}`);
+        // Validate response if validation is enabled
+        const validated = this._validateResponse(result, productStatusesSchemas_1.ValidateMarkerResponseSchema);
+        // Extract the 'valid' boolean value from the response object
+        return typeof validated === 'object' && 'valid' in validated
+            ? validated.valid
+            : validated;
+    }
+}
+exports.default = ProductStatusesApi;

package/dist/product-statuses/productStatusesInterfaces.d.ts

@@ -0,0 +1,62 @@
+import type { IError, ILocalizeInfo } from '../base/utils';
+/**
+ * @interface IProductStatuses
+ * @description This interface defines methods for retrieving and managing product statuses in the system.
+ */
+interface IProductStatusesApi {
+    /**
+     * Search for all product status objects.
+     * @handleName getProductStatuses
+     * @param {string} [langCode] - Language code. Default: "en_US".
+     * @returns {IProductStatusEntity[]} Returns an array of product status objects.
+     * @throws {IError} - If there is an error during the fetch operation, it will return an error object.
+     * @description This method searches for all product status objects.
+     */
+    getProductStatuses(langCode: string): Promise<IProductStatusEntity[] | IError>;
+    /**
+     * Search for a product status object by its textual identifier (marker).
+     * @handleName getProductsByStatusMarker
+     * @param {string} marker - Product marker. Example: "in_stock".
+     * @param {string} [langCode] - Language code. Default: "en_US".
+     * @returns {IProductStatusEntity} Returns a product status object.
+     * @throws {IError} If there is an error during the fetch operation, it will return an error object.
+     * @description This method searches for a product status object by its textual identifier (marker).
+     */
+    getProductsByStatusMarker(marker: string, langCode: string): Promise<IProductStatusEntity | IError>;
+    /**
+     * Check the existence of a textual identifier.
+     * @handleName validateMarker
+     * @param {string} marker - Product marker. Example: "in_stock".
+     * @returns {boolean} Returns true if the textual identifier (marker) exists or false if it doesn't.
+     * @throws {IError} If there is an error during the fetch operation, it will return an error object.
+     * @description This method checks the existence of a textual identifier.
+     */
+    validateMarker(marker: string): Promise<boolean | IError>;
+}
+/**
+ * Product status entity structure
+ * @interface IProductStatusEntity
+ * @property {number} id - The unique identifier of the position. Example: 12345.
+ * @property {string} identifier - The textual identifier for the record field. Example: "in_stock".
+ * @property {ILocalizeInfo} localizeInfos - The name of the products statuses, taking into account localization.
+ * @example
+    {
+      "title": "Catalog",
+      "plainContent": "Content for catalog",
+      "htmlContent": "<b>Content for catalog</b>",
+      "menuTitle": "Catalog"
+    }
+ * @property {boolean} isDefault - Default status flag. Example: true.
+ * @property {number} version - The version number of the object. Example: 1.
+ * @property {number} position - Position number. Example: 1.
+ * @description This interface defines the structure of a product status entity, including its identifiers, localization information, position, and default status flag.
+ */
+interface IProductStatusEntity {
+    id: number;
+    identifier: string;
+    localizeInfos: ILocalizeInfo;
+    isDefault: boolean;
+    version: number;
+    position: number;
+}
+export type { IProductStatusEntity, IProductStatusesApi };

package/dist/product-statuses/productStatusesInterfaces.js

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

package/dist/product-statuses/productStatusesSchemas.d.ts

@@ -0,0 +1,34 @@
+/**
+ * Validation schemas for ProductStatuses module
+ * @description Zod schemas for validating product statuses-related API responses
+ */
+import { z } from 'zod';
+/**
+ * Product status entity schema
+ * Includes all fields returned by the API
+ */
+export declare const ProductStatusEntitySchema: z.ZodObject<{
+    id: z.ZodNumber;
+    identifier: z.ZodString;
+    localizeInfos: z.ZodRecord<z.ZodString, z.ZodAny>;
+    isDefault: z.ZodBoolean;
+    version: z.ZodNumber;
+    position: z.ZodNumber;
+}, z.core.$strip>;
+/**
+ * Product statuses response schema (array of product statuses)
+ */
+export declare const ProductStatusesResponseSchema: z.ZodArray<z.ZodObject<{
+    id: z.ZodNumber;
+    identifier: z.ZodString;
+    localizeInfos: z.ZodRecord<z.ZodString, z.ZodAny>;
+    isDefault: z.ZodBoolean;
+    version: z.ZodNumber;
+    position: z.ZodNumber;
+}, z.core.$strip>>;
+/**
+ * Validate marker response schema (object with valid property)
+ */
+export declare const ValidateMarkerResponseSchema: z.ZodObject<{
+    valid: z.ZodBoolean;
+}, z.core.$strip>;

package/dist/product-statuses/productStatusesSchemas.js

@@ -0,0 +1,30 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ValidateMarkerResponseSchema = exports.ProductStatusesResponseSchema = exports.ProductStatusEntitySchema = void 0;
+/**
+ * Validation schemas for ProductStatuses module
+ * @description Zod schemas for validating product statuses-related API responses
+ */
+const zod_1 = require("zod");
+/**
+ * Product status entity schema
+ * Includes all fields returned by the API
+ */
+exports.ProductStatusEntitySchema = 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()),
+    isDefault: zod_1.z.boolean(),
+    version: zod_1.z.number(),
+    position: zod_1.z.number(),
+});
+/**
+ * Product statuses response schema (array of product statuses)
+ */
+exports.ProductStatusesResponseSchema = zod_1.z.array(exports.ProductStatusEntitySchema);
+/**
+ * Validate marker response schema (object with valid property)
+ */
+exports.ValidateMarkerResponseSchema = zod_1.z.object({
+    valid: zod_1.z.boolean(),
+});