oneentry 1.0.159 → 1.0.161

package/esm/forms-data/formsDataSchemas.d.ts

@@ -0,0 +1,107 @@
+/**
+ * Validation schemas for FormsData module
+ * @description Zod schemas for validating forms data-related API responses
+ */
+import { z } from 'zod';
+/**
+ * Form data type schema (flexible structure)
+ */
+export declare const FormDataTypeSchema: z.ZodUnion<readonly [z.ZodObject<{
+    marker: z.ZodString;
+    type: z.ZodString;
+    value: z.ZodAny;
+}, z.core.$strip>, z.ZodRecord<z.ZodString, z.ZodAny>]>;
+/**
+ * Form by marker data entity schema
+ */
+export declare const FormByMarkerDataEntitySchema: z.ZodObject<{
+    id: z.ZodNumber;
+    parentId: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
+    formIdentifier: z.ZodString;
+    depth: z.ZodOptional<z.ZodNumber>;
+    ip: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+    fingerprint: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+    status: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+    userIdentifier: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+    formData: z.ZodUnion<readonly [z.ZodArray<z.ZodUnion<readonly [z.ZodObject<{
+        marker: z.ZodString;
+        type: z.ZodString;
+        value: z.ZodAny;
+    }, z.core.$strip>, z.ZodRecord<z.ZodString, z.ZodAny>]>>, z.ZodRecord<z.ZodString, z.ZodAny>]>;
+    attributeSetIdentifier: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+    time: z.ZodUnion<readonly [z.ZodDate, z.ZodString]>;
+    entityIdentifier: z.ZodOptional<z.ZodString>;
+    isUserAdmin: z.ZodOptional<z.ZodBoolean>;
+    formModuleConfigId: z.ZodOptional<z.ZodNumber>;
+    moduleIdentifier: z.ZodOptional<z.ZodString>;
+    entityId: z.ZodOptional<z.ZodNumber>;
+}, z.core.$strip>;
+/**
+ * Forms by marker data response schema
+ */
+export declare const FormsByMarkerDataResponseSchema: z.ZodObject<{
+    items: z.ZodArray<z.ZodObject<{
+        id: z.ZodNumber;
+        parentId: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
+        formIdentifier: z.ZodString;
+        depth: z.ZodOptional<z.ZodNumber>;
+        ip: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+        fingerprint: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+        status: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+        userIdentifier: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+        formData: z.ZodUnion<readonly [z.ZodArray<z.ZodUnion<readonly [z.ZodObject<{
+            marker: z.ZodString;
+            type: z.ZodString;
+            value: z.ZodAny;
+        }, z.core.$strip>, z.ZodRecord<z.ZodString, z.ZodAny>]>>, z.ZodRecord<z.ZodString, z.ZodAny>]>;
+        attributeSetIdentifier: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+        time: z.ZodUnion<readonly [z.ZodDate, z.ZodString]>;
+        entityIdentifier: z.ZodOptional<z.ZodString>;
+        isUserAdmin: z.ZodOptional<z.ZodBoolean>;
+        formModuleConfigId: z.ZodOptional<z.ZodNumber>;
+        moduleIdentifier: z.ZodOptional<z.ZodString>;
+        entityId: z.ZodOptional<z.ZodNumber>;
+    }, z.core.$strip>>;
+    total: z.ZodNumber;
+}, z.core.$strip>;
+/**
+ * Post form response schema
+ */
+export declare const PostFormResponseSchema: z.ZodObject<{
+    actionMessage: z.ZodUnion<readonly [z.ZodString, z.ZodRecord<z.ZodString, z.ZodAny>]>;
+    formData: z.ZodObject<{
+        id: z.ZodNumber;
+        formIdentifier: z.ZodString;
+        time: z.ZodString;
+        entityIdentifier: z.ZodString;
+        fingerprint: z.ZodNullable<z.ZodString>;
+        isUserAdmin: z.ZodBoolean;
+        formModuleId: z.ZodNumber;
+        userIdentifier: z.ZodNullable<z.ZodString>;
+        parentId: z.ZodNullable<z.ZodNumber>;
+        formData: z.ZodUnion<readonly [z.ZodArray<z.ZodUnion<readonly [z.ZodObject<{
+            marker: z.ZodString;
+            type: z.ZodString;
+            value: z.ZodAny;
+        }, z.core.$strip>, z.ZodRecord<z.ZodString, z.ZodAny>]>>, z.ZodRecord<z.ZodString, z.ZodAny>]>;
+    }, z.core.$strip>;
+}, z.core.$strip>;
+/**
+ * Update forms data response schema
+ */
+export declare const UpdateFormsDataSchema: z.ZodObject<{
+    id: z.ZodNumber;
+    formIdentifier: z.ZodString;
+    time: z.ZodString;
+    formData: z.ZodArray<z.ZodUnion<readonly [z.ZodObject<{
+        marker: z.ZodString;
+        type: z.ZodString;
+        value: z.ZodAny;
+    }, z.core.$strip>, z.ZodRecord<z.ZodString, z.ZodAny>]>>;
+    userIdentifier: z.ZodString;
+    entityIdentifier: z.ZodString;
+    parentId: z.ZodNullable<z.ZodNumber>;
+    fingerprint: z.ZodNullable<z.ZodString>;
+    isUserAdmin: z.ZodBoolean;
+    formModuleId: z.ZodNumber;
+}, z.core.$strip>;

package/esm/forms-data/formsDataSchemas.js

@@ -0,0 +1,83 @@
+/**
+ * Validation schemas for FormsData module
+ * @description Zod schemas for validating forms data-related API responses
+ */
+import { z } from 'zod';
+/**
+ * Form data type schema (flexible structure)
+ */
+export const FormDataTypeSchema = z.union([
+    z.object({
+        marker: z.string(),
+        type: z.string(),
+        value: z.any(),
+    }),
+    z.record(z.string(), z.any()),
+]);
+/**
+ * Form by marker data entity schema
+ */
+export const FormByMarkerDataEntitySchema = z.object({
+    id: z.number(),
+    parentId: z.number().nullish(),
+    formIdentifier: z.string(),
+    depth: z.number().optional(),
+    ip: z.string().nullish(),
+    fingerprint: z.string().nullish(),
+    status: z.string().nullish(),
+    userIdentifier: z.string().nullish(),
+    formData: z.union([
+        z.array(FormDataTypeSchema),
+        z.record(z.string(), z.any()),
+    ]),
+    attributeSetIdentifier: z.string().nullish(),
+    time: z.union([z.date(), z.string()]),
+    entityIdentifier: z.string().optional(),
+    isUserAdmin: z.boolean().optional(),
+    formModuleConfigId: z.number().optional(),
+    moduleIdentifier: z.string().optional(),
+    entityId: z.number().optional(),
+});
+/**
+ * Forms by marker data response schema
+ */
+export const FormsByMarkerDataResponseSchema = z.object({
+    items: z.array(FormByMarkerDataEntitySchema),
+    total: z.number(),
+});
+/**
+ * Post form response schema
+ */
+export const PostFormResponseSchema = z.object({
+    actionMessage: z.union([z.string(), z.record(z.string(), z.any())]),
+    formData: z.object({
+        id: z.number(),
+        formIdentifier: z.string(),
+        time: z.string(),
+        entityIdentifier: z.string(),
+        fingerprint: z.string().nullable(),
+        isUserAdmin: z.boolean(),
+        formModuleId: z.number(),
+        userIdentifier: z.string().nullable(),
+        parentId: z.number().nullable(),
+        formData: z.union([
+            z.array(FormDataTypeSchema),
+            z.record(z.string(), z.any()),
+        ]),
+    }),
+});
+/**
+ * Update forms data response schema
+ */
+export const UpdateFormsDataSchema = z.object({
+    id: z.number(),
+    formIdentifier: z.string(),
+    time: z.string(),
+    formData: z.array(FormDataTypeSchema),
+    userIdentifier: z.string(),
+    entityIdentifier: z.string(),
+    parentId: z.number().nullable(),
+    fingerprint: z.string().nullable(),
+    isUserAdmin: z.boolean(),
+    formModuleId: z.number(),
+});

package/esm/general-types/generalTypesApi.d.ts

@@ -0,0 +1,29 @@
+import AsyncModules from '../base/asyncModules.js';
+import type StateModule from '../base/stateModule.js';
+import type { IError } from '../base/utils.js';
+import type { IGeneralTypes, IGeneralTypesEntity } from './generalTypesInterfaces.js';
+/**
+ * Controllers for working with types
+ * @handle /api/content/general-types
+ * @class GeneralTypesApi
+ * @augments AsyncModules
+ * @implements {IGeneralTypes}
+ * @description This class provides methods to interact with general types, including retrieving all types.
+ */
+export default class GeneralTypesApi extends AsyncModules implements IGeneralTypes {
+    protected state: StateModule;
+    protected _url: string;
+    /**
+     * Constructor for the GeneralTypesApi class.
+     */
+    constructor(state: StateModule);
+    /**
+     * Get all types.
+     * @handleName getAllTypes
+     * @returns {Promise<IGeneralTypesEntity[] | IError>} Returns an array of general types or an error object if there was an issue.
+     * @throws {IError} When isShell=false and an error occurs during the fetch
+     * @description This method retrieves all general types available in the system.
+     * @see {@link https://js-sdk.oneentry.cloud/docs/general-types/getAllTypes getAllTypes} documentation.
+     */
+    getAllTypes(): Promise<IGeneralTypesEntity[] | IError>;
+}

package/esm/general-types/generalTypesApi.js

@@ -0,0 +1,34 @@
+import AsyncModules from '../base/asyncModules.js';
+import createSchemaLoader from '../base/lazySchema.js';
+const schema = createSchemaLoader(() => import('./generalTypesSchemas.js'));
+/**
+ * Controllers for working with types
+ * @handle /api/content/general-types
+ * @class GeneralTypesApi
+ * @augments AsyncModules
+ * @implements {IGeneralTypes}
+ * @description This class provides methods to interact with general types, including retrieving all types.
+ */
+export default class GeneralTypesApi extends AsyncModules {
+    /**
+     * Constructor for the GeneralTypesApi class.
+     */
+    constructor(state) {
+        super(state);
+        this._url = state.url + '/api/content/general-types';
+    }
+    /**
+     * Get all types.
+     * @handleName getAllTypes
+     * @returns {Promise<IGeneralTypesEntity[] | IError>} Returns an array of general types or an error object if there was an issue.
+     * @throws {IError} When isShell=false and an error occurs during the fetch
+     * @description This method retrieves all general types available in the system.
+     * @see {@link https://js-sdk.oneentry.cloud/docs/general-types/getAllTypes getAllTypes} documentation.
+     */
+    async getAllTypes() {
+        const result = await this._fetchGet('');
+        // Validate response if validation is enabled
+        const validated = await this._validateResponse(result, schema('GeneralTypesResponseSchema'));
+        return validated;
+    }
+}

package/esm/general-types/generalTypesInterfaces.d.ts

@@ -0,0 +1,29 @@
+import type { IError } from '../base/utils.js';
+import type { BlockType } from '../blocks/blocksInterfaces.js';
+/**
+ * Interface for retrieving all general types in the system.
+ * @interface IGeneralTypes
+ * @description This interface defines a method for retrieving all general types in the system.
+ */
+interface IGeneralTypes {
+    /**
+     * Get all types.
+     * @handleName getAllTypes
+     * @returns {IGeneralTypesEntity[]} Returns an array of general types 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 types.
+     */
+    getAllTypes(): Promise<IGeneralTypesEntity[] | IError>;
+}
+/**
+ * Represents a general type entity.
+ * @interface IGeneralTypesEntity
+ * @property {number} id - Type id. Example: 1.
+ * @property {BlockType} type - Types enum. Example: "product", "category", "etc".
+ * @description Represents a general type entity with an identifier and a type.
+ */
+interface IGeneralTypesEntity {
+    id: number;
+    type: BlockType;
+}
+export type { IGeneralTypes, IGeneralTypesEntity };

package/esm/general-types/generalTypesInterfaces.js

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

package/esm/general-types/generalTypesSchemas.d.ts

@@ -0,0 +1,68 @@
+/**
+ * Validation schemas for GeneralTypes module
+ * @description Zod schemas for validating general types-related API responses
+ */
+import { z } from 'zod';
+/**
+ * General type entity schema
+ * Includes all fields returned by the API
+ */
+export declare const GeneralTypeEntitySchema: z.ZodObject<{
+    id: z.ZodNumber;
+    type: z.ZodEnum<{
+        none: "none";
+        product: "product";
+        order: "order";
+        form: "form";
+        error_page: "error_page";
+        catalog_page: "catalog_page";
+        product_preview: "product_preview";
+        similar_products_block: "similar_products_block";
+        product_block: "product_block";
+        frequently_ordered_block: "frequently_ordered_block";
+        trending_block: "trending_block";
+        recently_viewed_block: "recently_viewed_block";
+        repeat_purchase_block: "repeat_purchase_block";
+        slider_block: "slider_block";
+        personal_recommendations_block: "personal_recommendations_block";
+        cart_complement_block: "cart_complement_block";
+        cart_similar_block: "cart_similar_block";
+        wishlist_similar_block: "wishlist_similar_block";
+        common_page: "common_page";
+        common_block: "common_block";
+        service: "service";
+        external_page: "external_page";
+        discount: "discount";
+    }>;
+}, z.core.$strip>;
+/**
+ * General types response schema (array of general types)
+ */
+export declare const GeneralTypesResponseSchema: z.ZodArray<z.ZodObject<{
+    id: z.ZodNumber;
+    type: z.ZodEnum<{
+        none: "none";
+        product: "product";
+        order: "order";
+        form: "form";
+        error_page: "error_page";
+        catalog_page: "catalog_page";
+        product_preview: "product_preview";
+        similar_products_block: "similar_products_block";
+        product_block: "product_block";
+        frequently_ordered_block: "frequently_ordered_block";
+        trending_block: "trending_block";
+        recently_viewed_block: "recently_viewed_block";
+        repeat_purchase_block: "repeat_purchase_block";
+        slider_block: "slider_block";
+        personal_recommendations_block: "personal_recommendations_block";
+        cart_complement_block: "cart_complement_block";
+        cart_similar_block: "cart_similar_block";
+        wishlist_similar_block: "wishlist_similar_block";
+        common_page: "common_page";
+        common_block: "common_block";
+        service: "service";
+        external_page: "external_page";
+        discount: "discount";
+    }>;
+}, z.core.$strip>>;

package/esm/general-types/generalTypesSchemas.js

@@ -0,0 +1,42 @@
+/**
+ * Validation schemas for GeneralTypes module
+ * @description Zod schemas for validating general types-related API responses
+ */
+import { z } from 'zod';
+/**
+ * General type entity schema
+ * Includes all fields returned by the API
+ */
+export const GeneralTypeEntitySchema = z.object({
+    id: z.number(),
+    // Must stay in sync with BlockType in src/blocks/blocksInterfaces.ts
+    type: z.enum([
+        'product',
+        'error_page',
+        'catalog_page',
+        'product_preview',
+        'similar_products_block',
+        'product_block',
+        'frequently_ordered_block',
+        'trending_block',
+        'recently_viewed_block',
+        'repeat_purchase_block',
+        'slider_block',
+        'personal_recommendations_block',
+        'cart_complement_block',
+        'cart_similar_block',
+        'wishlist_similar_block',
+        'form',
+        'common_page',
+        'common_block',
+        'order',
+        'service',
+        'external_page',
+        'discount',
+        'none',
+    ]),
+});
+/**
+ * General types response schema (array of general types)
+ */
+export const GeneralTypesResponseSchema = z.array(GeneralTypeEntitySchema);

package/esm/index.d.ts

@@ -0,0 +1,143 @@
+/**
+ * OneEntry SDK
+ */
+import AdminsApi from './admins/adminsApi.js';
+import AttributesSetsApi from './attribute-sets/attributeSetsApi.js';
+import AuthProviderApi from './auth-provider/authProviderApi.js';
+import type { IConfig } from './base/utils.js';
+import BlocksApi from './blocks/blocksApi.js';
+import DiscountsApi from './discounts/discountsApi.js';
+import EventsApi from './events/eventsApi.js';
+import FileUploadingApi from './file-uploading/fileUploadingApi.js';
+import FiltersApi from './filters/filtersApi.js';
+import FormsApi from './forms/formsApi.js';
+import FormsDataApi from './forms-data/formsDataApi.js';
+import GeneralTypesApi from './general-types/generalTypesApi.js';
+import IntegrationCollectionsApi from './integration-collections/integrationCollectionsApi.js';
+import LocalesApi from './locales/localesApi.js';
+import MenusApi from './menus/menusApi.js';
+import OrdersApi from './orders/ordersApi.js';
+import PagesApi from './pages/pagesApi.js';
+import PaymentsApi from './payments/paymentsApi.js';
+import ProductStatusesApi from './product-statuses/productStatusesApi.js';
+import ProductsApi from './products/productsApi.js';
+import SearchApi from './search/searchApi.js';
+import SitemapApi from './sitemap/sitemapApi.js';
+import SubscriptionsApi from './subscriptions/subscriptionsApi.js';
+import SystemApi from './system/systemApi.js';
+import TemplatesApi from './templates/templatesApi.js';
+import TemplatePreviewsApi from './templates-preview/templatesPreviewApi.js';
+import UserActivityApi from './user-activity/userActivityApi.js';
+import UsersApi from './users/usersApi.js';
+import WsApi from './web-socket/wsApi.js';
+export { expandAttributeTimeIntervals, expandTimeIntervals, isTimeIntervalAttribute, } from './base/timeIntervals.js';
+export type * from './types.js';
+/**
+ * IDefineApi interface
+ * @interface IDefineApi
+ * @property {AdminsApi} Admins - Admins API module.
+ * @property {AttributesSetsApi} AttributesSets - Attribute sets API module.
+ * @property {AuthProviderApi} AuthProvider - Auth provider API module.
+ * @property {BlocksApi} Blocks - Blocks API module.
+ * @property {EventsApi} Events - Events API module.
+ * @property {DiscountsApi} Discounts - Discounts API module.
+ * @property {FileUploadingApi} FileUploading - File uploading API module.
+ * @property {FiltersApi} Filters - Filters API module.
+ * @property {FormsApi} Forms - Forms API module.
+ * @property {FormsDataApi} FormData - Form data API module.
+ * @property {GeneralTypesApi} GeneralTypes - General types API module.
+ * @property {IntegrationCollectionsApi} IntegrationCollections - Integration collections API module.
+ * @property {LocalesApi} Locales - Locales API module.
+ * @property {MenusApi} Menus - Menus API module.
+ * @property {OrdersApi} Orders - Orders API module.
+ * @property {PagesApi} Pages - Pages API module.
+ * @property {PaymentsApi} Payments - Payments API module.
+ * @property {ProductsApi} Products - Products API module.
+ * @property {ProductStatusesApi} ProductStatuses - Product statuses API module.
+ * @property {SearchApi} Search - Search API module.
+ * @property {SitemapApi} Sitemap - Sitemap API module.
+ * @property {SubscriptionsApi} Subscriptions - Subscriptions API module.
+ * @property {SystemApi} System - System API module.
+ * @property {TemplatesApi} Templates - Templates API module.
+ * @property {TemplatePreviewsApi} TemplatePreviews - Template previews API module.
+ * @property {UserActivityApi} UserActivity - User activity API module.
+ * @property {UsersApi} Users - Users API module.
+ * @property {WsApi} WS - WebSocket API module.
+ */
+interface IDefineApi {
+    /** Admin panel users management */
+    Admins: AdminsApi;
+    /** Attribute set schemas: getAttributesByMarker, getAttributeSetByMarker, getSingleAttributeByMarkerSet */
+    AttributesSets: AttributesSetsApi;
+    /** User registration, login, logout, OAuth, token refresh */
+    AuthProvider: AuthProviderApi;
+    /** Page blocks: getBlocksByPageUrl, getBlockByMarker */
+    Blocks: BlocksApi;
+    /** Subscription events: subscribe to real-time entity changes */
+    Events: EventsApi;
+    /** Discounts and promo codes */
+    Discounts: DiscountsApi;
+    /** File upload helpers: createFileFromUrl */
+    FileUploading: FileUploadingApi;
+    /** Content filters: getFilterByMarker */
+    Filters: FiltersApi;
+    /** Form schemas: getFormByMarker — use for rendering dynamic forms */
+    Forms: FormsApi;
+    /** Submit form data: postFormsData */
+    FormData: FormsDataApi;
+    /** General types / custom types defined in admin panel */
+    GeneralTypes: GeneralTypesApi;
+    /** Integration collections */
+    IntegrationCollections: IntegrationCollectionsApi;
+    /** Project locales: getLocales */
+    Locales: LocalesApi;
+    /** Navigation menus: getMenusByMarker */
+    Menus: MenusApi;
+    /** Orders: createOrder, getAllOrdersByMarker, getAllOrdersStorage */
+    Orders: OrdersApi;
+    /** Pages: getPageByUrl, getPageById, getChildPages, getRootPages */
+    Pages: PagesApi;
+    /** Payments: createSession, getSessionByOrderId */
+    Payments: PaymentsApi;
+    /** Products: getProducts, getProductById, filterProducts, searchProducts */
+    Products: ProductsApi;
+    /** Product statuses: getProductStatuses */
+    ProductStatuses: ProductStatusesApi;
+    /** Public cross-entity search: globalSearch */
+    Search: SearchApi;
+    /** Sitemap generation */
+    Sitemap: SitemapApi;
+    /** Paid subscriptions: subscribe, cancelSubscription, recoverSubscriptions, getAllSubscriptions, getActiveSubscriptions */
+    Subscriptions: SubscriptionsApi;
+    /** System info */
+    System: SystemApi;
+    /** Page templates */
+    Templates: TemplatesApi;
+    /** Template previews */
+    TemplatePreviews: TemplatePreviewsApi;
+    /** User/guest activity tracking: trackUserActivity */
+    UserActivity: UserActivityApi;
+    /** Current authenticated user: getUser, updateUser */
+    Users: UsersApi;
+    /** WebSocket real-time updates */
+    WS: WsApi;
+}
+/**
+ * Define API.
+ * @function defineOneEntry
+ * @param {string} url - URl of your project.
+ * @param {IConfig} config - Custom configuration settings
+ * @param {string} [config.token] - Optional token parameter
+ * @param {string} [config.guestId] - Optional guest identifier sent as the `x-guest-id` header for guest cart/wishlist/activity flows (only while unauthenticated). In the browser, if omitted, a stable per-device id is generated and persisted in localStorage. On the server you MUST pass a per-visitor `guestId` (or call `setGuestId`): the SDK never auto-generates a server id, to avoid sharing one guest across visitors.
+ * @param {string} [config.deviceMetadata] - Optional device-metadata string sent as the `x-device-metadata` header instead of the environment-derived fingerprint. Refresh tokens are bound to this header, so a server issuing tokens for a browser (OAuth code exchange) must pass the browser's string (from `getDeviceMetadata()`), or the token will not be refreshable from that browser.
+ * @param {string} [config.langCode] - Optional langCode parameter
+ * @param {boolean} [config.traficLimit] - Some methods use multiple queries to make it easier to work with the API. Set this parameter to "false" to save traffic and decide for yourself what data you need.
+ * @param {string} [config.auth] - An object with authorization settings.
+ * @param {boolean} [config.auth.customAuth] - Set this flag to true if you want to configure the authorization process yourself. Set the flag to false, or do not pass it at all to have automatic authorization and token renewal.
+ * @param {string} [config.auth.refreshToken] - Transfer the refresh token here, for example from the local storage, to resume the user's session. Otherwise, the user will need to log in every time a new session is created.
+ * @param {string} [config.auth.providerMarker] - The marker of the authorization provider.
+ * @param {string} [config.auth.saveFunction] - If you want to store the token between sessions, for example in local storage, create a custom function that takes refreshToken as a parameter and executes the necessary instructions. This function will be called every time the tokens are updated.
+ * @returns {IDefineApi} List of methods set.
+ * @description Define API.
+ */
+export declare function defineOneEntry(url: string, config: IConfig): IDefineApi;

package/esm/index.js

@@ -0,0 +1,124 @@
+/**
+ * OneEntry SDK
+ */
+import AdminsApi from './admins/adminsApi.js';
+import AttributesSetsApi from './attribute-sets/attributeSetsApi.js';
+import AuthProviderApi from './auth-provider/authProviderApi.js';
+import StateModule from './base/stateModule.js';
+import BlocksApi from './blocks/blocksApi.js';
+import DiscountsApi from './discounts/discountsApi.js';
+import EventsApi from './events/eventsApi.js';
+import FileUploadingApi from './file-uploading/fileUploadingApi.js';
+import FiltersApi from './filters/filtersApi.js';
+import FormsApi from './forms/formsApi.js';
+import FormsDataApi from './forms-data/formsDataApi.js';
+import GeneralTypesApi from './general-types/generalTypesApi.js';
+import IntegrationCollectionsApi from './integration-collections/integrationCollectionsApi.js';
+import LocalesApi from './locales/localesApi.js';
+import MenusApi from './menus/menusApi.js';
+import OrdersApi from './orders/ordersApi.js';
+import PagesApi from './pages/pagesApi.js';
+import PaymentsApi from './payments/paymentsApi.js';
+import ProductStatusesApi from './product-statuses/productStatusesApi.js';
+import ProductsApi from './products/productsApi.js';
+import SearchApi from './search/searchApi.js';
+import SitemapApi from './sitemap/sitemapApi.js';
+import SubscriptionsApi from './subscriptions/subscriptionsApi.js';
+import SystemApi from './system/systemApi.js';
+import TemplatesApi from './templates/templatesApi.js';
+import TemplatePreviewsApi from './templates-preview/templatesPreviewApi.js';
+import UserActivityApi from './user-activity/userActivityApi.js';
+import UsersApi from './users/usersApi.js';
+import WsApi from './web-socket/wsApi.js';
+export { expandAttributeTimeIntervals, expandTimeIntervals, isTimeIntervalAttribute, } from './base/timeIntervals.js';
+/**
+ * Define API.
+ * @function defineOneEntry
+ * @param {string} url - URl of your project.
+ * @param {IConfig} config - Custom configuration settings
+ * @param {string} [config.token] - Optional token parameter
+ * @param {string} [config.guestId] - Optional guest identifier sent as the `x-guest-id` header for guest cart/wishlist/activity flows (only while unauthenticated). In the browser, if omitted, a stable per-device id is generated and persisted in localStorage. On the server you MUST pass a per-visitor `guestId` (or call `setGuestId`): the SDK never auto-generates a server id, to avoid sharing one guest across visitors.
+ * @param {string} [config.deviceMetadata] - Optional device-metadata string sent as the `x-device-metadata` header instead of the environment-derived fingerprint. Refresh tokens are bound to this header, so a server issuing tokens for a browser (OAuth code exchange) must pass the browser's string (from `getDeviceMetadata()`), or the token will not be refreshable from that browser.
+ * @param {string} [config.langCode] - Optional langCode parameter
+ * @param {boolean} [config.traficLimit] - Some methods use multiple queries to make it easier to work with the API. Set this parameter to "false" to save traffic and decide for yourself what data you need.
+ * @param {string} [config.auth] - An object with authorization settings.
+ * @param {boolean} [config.auth.customAuth] - Set this flag to true if you want to configure the authorization process yourself. Set the flag to false, or do not pass it at all to have automatic authorization and token renewal.
+ * @param {string} [config.auth.refreshToken] - Transfer the refresh token here, for example from the local storage, to resume the user's session. Otherwise, the user will need to log in every time a new session is created.
+ * @param {string} [config.auth.providerMarker] - The marker of the authorization provider.
+ * @param {string} [config.auth.saveFunction] - If you want to store the token between sessions, for example in local storage, create a custom function that takes refreshToken as a parameter and executes the necessary instructions. This function will be called every time the tokens are updated.
+ * @returns {IDefineApi} List of methods set.
+ * @description Define API.
+ */
+export function defineOneEntry(url, config) {
+    if (typeof url !== 'string' || url.trim() === '') {
+        throw new Error('OneEntry SDK: project URL is required to initialize the SDK. ' +
+            'Pass a non-empty URL as the first argument of defineOneEntry, e.g. ' +
+            'defineOneEntry("https://your-project.oneentry.cloud", { token: "your-app-token" }).');
+    }
+    if (!config ||
+        typeof config.token !== 'string' ||
+        config.token.trim() === '') {
+        throw new Error('OneEntry SDK: app token is required to initialize the SDK. ' +
+            'Pass it via config, e.g. ' +
+            'defineOneEntry("https://your-project.oneentry.cloud", { token: "your-app-token" }).');
+    }
+    const stateModule = new StateModule(url.endsWith('/') ? url.slice(0, -1) : url, config);
+    const Admins = new AdminsApi(stateModule);
+    const AttributesSets = new AttributesSetsApi(stateModule);
+    const AuthProvider = new AuthProviderApi(stateModule);
+    const Blocks = new BlocksApi(stateModule);
+    const Discounts = new DiscountsApi(stateModule);
+    const Events = new EventsApi(stateModule);
+    const FileUploading = new FileUploadingApi(stateModule);
+    const Filters = new FiltersApi(stateModule);
+    const Forms = new FormsApi(stateModule);
+    const FormData = new FormsDataApi(stateModule);
+    const GeneralTypes = new GeneralTypesApi(stateModule);
+    const IntegrationCollections = new IntegrationCollectionsApi(stateModule);
+    const Locales = new LocalesApi(stateModule);
+    const Menus = new MenusApi(stateModule);
+    const Orders = new OrdersApi(stateModule);
+    const Pages = new PagesApi(stateModule);
+    const Payments = new PaymentsApi(stateModule);
+    const Products = new ProductsApi(stateModule);
+    const ProductStatuses = new ProductStatusesApi(stateModule);
+    const Search = new SearchApi(stateModule);
+    const Sitemap = new SitemapApi(stateModule);
+    const Subscriptions = new SubscriptionsApi(stateModule);
+    const System = new SystemApi(stateModule);
+    const Templates = new TemplatesApi(stateModule);
+    const TemplatePreviews = new TemplatePreviewsApi(stateModule);
+    const UserActivity = new UserActivityApi(stateModule);
+    const Users = new UsersApi(stateModule);
+    const WS = new WsApi(stateModule);
+    return {
+        Admins,
+        AttributesSets,
+        AuthProvider,
+        Blocks,
+        Discounts,
+        Events,
+        FileUploading,
+        Filters,
+        Forms,
+        FormData,
+        GeneralTypes,
+        IntegrationCollections,
+        Locales,
+        Menus,
+        Orders,
+        Pages,
+        Payments,
+        Products,
+        ProductStatuses,
+        Search,
+        Sitemap,
+        Subscriptions,
+        System,
+        Templates,
+        TemplatePreviews,
+        UserActivity,
+        Users,
+        WS,
+    };
+}