oneentry 1.0.149 → 1.0.150

package/dist/general-types/generalTypesSchemas.js

@@ -12,6 +12,7 @@ const zod_1 = require("zod");
  */
 exports.GeneralTypeEntitySchema = zod_1.z.object({
     id: zod_1.z.number(),
+    // Must stay in sync with BlockType in src/blocks/blocksInterfaces.ts
     type: zod_1.z.enum([
         'product',
         'error_page',
@@ -19,6 +20,15 @@ exports.GeneralTypeEntitySchema = zod_1.z.object({
         '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',
@@ -26,7 +36,6 @@ exports.GeneralTypeEntitySchema = zod_1.z.object({
         'service',
         'external_page',
         'discount',
-        'frequently_ordered_block',
         'none',
     ]),
 });

package/dist/index.d.ts

@@ -9,6 +9,7 @@ import BlocksApi from './blocks/blocksApi';
 import DiscountsApi from './discounts/discountsApi';
 import EventsApi from './events/eventsApi';
 import FileUploadingApi from './file-uploading/fileUploadingApi';
+import FiltersApi from './filters/filtersApi';
 import FormsApi from './forms/formsApi';
 import FormsDataApi from './forms-data/formsDataApi';
 import GeneralTypesApi from './general-types/generalTypesApi';
@@ -21,9 +22,11 @@ import PaymentsApi from './payments/paymentsApi';
 import ProductStatusesApi from './product-statuses/productStatusesApi';
 import ProductsApi from './products/productsApi';
 import SitemapApi from './sitemap/sitemapApi';
+import SubscriptionsApi from './subscriptions/subscriptionsApi';
 import SystemApi from './system/systemApi';
 import TemplatesApi from './templates/templatesApi';
 import TemplatePreviewsApi from './templates-preview/templatesPreviewApi';
+import UserActivityApi from './user-activity/userActivityApi';
 import UsersApi from './users/usersApi';
 import WsApi from './web-socket/wsApi';
 /**
@@ -36,6 +39,7 @@ import WsApi from './web-socket/wsApi';
  * @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.
@@ -48,9 +52,11 @@ import WsApi from './web-socket/wsApi';
  * @property {ProductsApi} Products - Products API module.
  * @property {ProductStatusesApi} ProductStatuses - Product statuses 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.
  */
@@ -69,6 +75,8 @@ interface IDefineApi {
     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 */
@@ -93,12 +101,16 @@ interface IDefineApi {
     ProductStatuses: ProductStatusesApi;
     /** 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 */
@@ -110,6 +122,7 @@ interface IDefineApi {
  * @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.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.

package/dist/index.js

@@ -15,6 +15,7 @@ const blocksApi_1 = __importDefault(require("./blocks/blocksApi"));
 const discountsApi_1 = __importDefault(require("./discounts/discountsApi"));
 const eventsApi_1 = __importDefault(require("./events/eventsApi"));
 const fileUploadingApi_1 = __importDefault(require("./file-uploading/fileUploadingApi"));
+const filtersApi_1 = __importDefault(require("./filters/filtersApi"));
 const formsApi_1 = __importDefault(require("./forms/formsApi"));
 const formsDataApi_1 = __importDefault(require("./forms-data/formsDataApi"));
 const generalTypesApi_1 = __importDefault(require("./general-types/generalTypesApi"));
@@ -27,9 +28,11 @@ const paymentsApi_1 = __importDefault(require("./payments/paymentsApi"));
 const productStatusesApi_1 = __importDefault(require("./product-statuses/productStatusesApi"));
 const productsApi_1 = __importDefault(require("./products/productsApi"));
 const sitemapApi_1 = __importDefault(require("./sitemap/sitemapApi"));
+const subscriptionsApi_1 = __importDefault(require("./subscriptions/subscriptionsApi"));
 const systemApi_1 = __importDefault(require("./system/systemApi"));
 const templatesApi_1 = __importDefault(require("./templates/templatesApi"));
 const templatesPreviewApi_1 = __importDefault(require("./templates-preview/templatesPreviewApi"));
+const userActivityApi_1 = __importDefault(require("./user-activity/userActivityApi"));
 const usersApi_1 = __importDefault(require("./users/usersApi"));
 const wsApi_1 = __importDefault(require("./web-socket/wsApi"));
 /**
@@ -38,6 +41,7 @@ const wsApi_1 = __importDefault(require("./web-socket/wsApi"));
  * @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.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.
@@ -57,6 +61,7 @@ function defineOneEntry(url, config) {
     const Discounts = new discountsApi_1.default(stateModule);
     const Events = new eventsApi_1.default(stateModule);
     const FileUploading = new fileUploadingApi_1.default(stateModule);
+    const Filters = new filtersApi_1.default(stateModule);
     const Forms = new formsApi_1.default(stateModule);
     const FormData = new formsDataApi_1.default(stateModule);
     const GeneralTypes = new generalTypesApi_1.default(stateModule);
@@ -69,9 +74,11 @@ function defineOneEntry(url, config) {
     const Products = new productsApi_1.default(stateModule);
     const ProductStatuses = new productStatusesApi_1.default(stateModule);
     const Sitemap = new sitemapApi_1.default(stateModule);
+    const Subscriptions = new subscriptionsApi_1.default(stateModule);
     const System = new systemApi_1.default(stateModule);
     const Templates = new templatesApi_1.default(stateModule);
     const TemplatePreviews = new templatesPreviewApi_1.default(stateModule);
+    const UserActivity = new userActivityApi_1.default(stateModule);
     const Users = new usersApi_1.default(stateModule);
     const WS = new wsApi_1.default(stateModule);
     return {
@@ -82,6 +89,7 @@ function defineOneEntry(url, config) {
         Discounts,
         Events,
         FileUploading,
+        Filters,
         Forms,
         FormData,
         GeneralTypes,
@@ -94,9 +102,11 @@ function defineOneEntry(url, config) {
         Products,
         ProductStatuses,
         Sitemap,
+        Subscriptions,
         System,
         Templates,
         TemplatePreviews,
+        UserActivity,
         Users,
         WS,
     };

package/dist/pages/pagesInterfaces.d.ts

@@ -240,7 +240,7 @@ interface IPositionBlock {
       "productsPerRow": 1
     }
  * @property {number} [products] - The number of products linked to the page. Example: 0.
- * @property {string} [childrenCount] - Children count. Example: 1.
+ * @property {number} [childrenCount] - Children count. Example: 1.
  * @property {IBlockEntity[] | string[]} [blocks] - blocks.
  * @example
     {
@@ -279,7 +279,7 @@ interface IPagesEntity {
     position?: number;
     config?: Record<string, number>;
     products?: number;
-    childrenCount?: string;
+    childrenCount?: number;
     total?: string;
     categoryPath?: string;
 }

package/dist/pages/pagesSchemas.d.ts

@@ -26,7 +26,7 @@ export declare const PageEntitySchema: z.ZodObject<{
     position: z.ZodOptional<z.ZodNumber>;
     config: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodNumber>>;
     products: z.ZodOptional<z.ZodNumber>;
-    childrenCount: z.ZodOptional<z.ZodString>;
+    childrenCount: z.ZodOptional<z.ZodNumber>;
     total: z.ZodOptional<z.ZodString>;
     categoryPath: z.ZodOptional<z.ZodString>;
 }, z.core.$strip>;
@@ -52,7 +52,7 @@ export declare const PagesResponseSchema: z.ZodArray<z.ZodObject<{
     position: z.ZodOptional<z.ZodNumber>;
     config: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodNumber>>;
     products: z.ZodOptional<z.ZodNumber>;
-    childrenCount: z.ZodOptional<z.ZodString>;
+    childrenCount: z.ZodOptional<z.ZodNumber>;
     total: z.ZodOptional<z.ZodString>;
     categoryPath: z.ZodOptional<z.ZodString>;
 }, z.core.$strip>>;
@@ -78,7 +78,7 @@ export declare const SinglePageSchema: z.ZodObject<{
     position: z.ZodOptional<z.ZodNumber>;
     config: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodNumber>>;
     products: z.ZodOptional<z.ZodNumber>;
-    childrenCount: z.ZodOptional<z.ZodString>;
+    childrenCount: z.ZodOptional<z.ZodNumber>;
     total: z.ZodOptional<z.ZodString>;
     categoryPath: z.ZodOptional<z.ZodString>;
 }, z.core.$strip>;

package/dist/pages/pagesSchemas.js

@@ -29,7 +29,7 @@ exports.PageEntitySchema = zod_1.z.object({
     position: zod_1.z.number().optional(),
     config: zod_1.z.record(zod_1.z.string(), zod_1.z.number()).optional(),
     products: zod_1.z.number().optional(),
-    childrenCount: zod_1.z.string().optional(),
+    childrenCount: zod_1.z.number().optional(),
     total: zod_1.z.string().optional(),
     categoryPath: zod_1.z.string().optional(),
 });

package/dist/products/productsApi.d.ts

@@ -1,7 +1,7 @@
 import AsyncModules from '../base/asyncModules';
 import type StateModule from '../base/stateModule';
 import type { IError } from '../base/utils';
-import type { IAggregatedProductGroup, IFilterParams, IProductBlock, IProductsApi, IProductsCount, IProductsEntity, IProductsInfo, IProductsQuery, IProductsResponse } from './productsInterfaces';
+import type { IAggregatedProductGroup, IFilterParams, IProductBlock, IProductsApi, IProductsCount, IProductsEntity, IProductsInfo, IProductsQuery, IProductsResponse, IVectorSearchProducts } from './productsInterfaces';
 /**
  * Controllers for working with product pages
  * @handle /api/content/products
@@ -369,5 +369,23 @@ export default class ProductsApi extends AsyncModules implements IProductsApi {
      * @throws {IError} When isShell=false and an error occurs during the fetch
      * @description This method calculates and returns the number of products available on a given catalog page, identified by its URL, with optional filtering.
      */
+    /**
+     * Semantic (vector) search for products.
+     * @handleName getProductsByVectorSearch
+     * @param {IVectorSearchProducts} body - Vector search body. Example: `{ queryText: "red running shoes" }`.
+     * @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<IProductsEntity[] | IError>} Array with ProductEntity objects.
+     * @throws {IError} When isShell=false and an error occurs during the fetch
+     * @description This method performs a semantic (vector) search for products.
+     */
+    getProductsByVectorSearch(body: IVectorSearchProducts, langCode?: string, offset?: number, limit?: number): Promise<IProductsEntity[] | IError>;
+    /**
+     * Get products by page url.
+     * @param {string} url - Page url.
+     * @param {any[]} body - Request body.
+     * @returns {IProductsEntity[] | IError} Returns an array of products or an error object.
+     */
     getProductsCountByPageUrl(url: string, body?: any[]): Promise<IProductsCount | IError>;
 }

package/dist/products/productsApi.js

@@ -367,13 +367,9 @@ class ProductsApi extends asyncModules_1.default {
     async searchProduct(name, langCode = this.state.lang) {
         const searchProducts = await this._fetchGet(`/quick/search?langCode=${langCode}&name=${name}`);
         if (!this.state.traficLimit && Array.isArray(searchProducts)) {
-            // eslint-disable-next-line @typescript-eslint/no-explicit-any
-            const productsList = [];
-            await Promise.all(searchProducts.map(async (product) => {
-                await this.getProductById(product.id, langCode).then((result) => {
-                    productsList.push(result);
-                });
-            }));
+            // Promise.all preserves the input order, keeping the search relevance
+            // order from the API (manual push would reorder by completion time).
+            const productsList = await Promise.all(searchProducts.map((product) => this.getProductById(product.id, langCode)));
             return this._dataPostProcess(productsList, langCode);
         }
         return searchProducts;
@@ -455,6 +451,32 @@ class ProductsApi extends asyncModules_1.default {
      * @throws {IError} When isShell=false and an error occurs during the fetch
      * @description This method calculates and returns the number of products available on a given catalog page, identified by its URL, with optional filtering.
      */
+    /**
+     * Semantic (vector) search for products.
+     * @handleName getProductsByVectorSearch
+     * @param {IVectorSearchProducts} body - Vector search body. Example: `{ queryText: "red running shoes" }`.
+     * @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<IProductsEntity[] | IError>} Array with ProductEntity objects.
+     * @throws {IError} When isShell=false and an error occurs during the fetch
+     * @description This method performs a semantic (vector) search for products.
+     */
+    async getProductsByVectorSearch(body, langCode = this.state.lang, offset = 0, limit = 30) {
+        const query = {
+            langCode,
+            offset,
+            limit,
+        };
+        const result = await this._fetchPost(`/vector/search?` + this._queryParamsToString(query), body);
+        return this._dataPostProcess(result, langCode);
+    }
+    /**
+     * Get products by page url.
+     * @param {string} url - Page url.
+     * @param {any[]} body - Request body.
+     * @returns {IProductsEntity[] | IError} Returns an array of products or an error object.
+     */
     async getProductsCountByPageUrl(url, 
     // eslint-disable-next-line @typescript-eslint/no-explicit-any
     body = []) {

package/dist/products/productsInterfaces.d.ts

@@ -320,6 +320,18 @@ interface IProductsApi {
      * @description This method calculates and returns the number of products available on a given catalog page, identified by its URL, with optional filtering.
      */
     getProductsCountByPageUrl(url: string, body?: object[]): Promise<IProductsCount | IError>;
+    /**
+     * Semantic (vector) search for products.
+     * @handleName getProductsByVectorSearch
+     * @param {IVectorSearchProducts} body - Vector search body. Example: `{ queryText: "red running shoes" }`.
+     * @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 {IProductsEntity[]} Array with ProductEntity objects.
+     * @throws {IError} - If there is an error during the fetch operation, it will return an error object.
+     * @description This method performs a semantic (vector) search for products.
+     */
+    getProductsByVectorSearch(body: IVectorSearchProducts, langCode?: string, offset?: number, limit?: number): Promise<IProductsEntity[] | IError>;
 }
 /**
  * @interface IProductsQuery
@@ -454,6 +466,7 @@ interface IProductPageRef {
       67890
     ]
  * @property {unknown} [paymentStages] - Payment stages data (may be null). Example: null.
+ * @property {number} [distance] - Vector (semantic) search relevance distance. Present only in results of vector search. Example: 0.42.
  * @property {Record<string, unknown>} [discountConfig] - Discount configuration object. Example: {}.
  * @property {string | null} [templateIdentifier] - User id of the linked template. Example: "template_12345".
  * @property {string | null} [shortDescTemplateIdentifier] - User id of the linked template for a short description. Example: "short_desc_template_12345".
@@ -501,6 +514,7 @@ interface IProductsEntity {
     isPositionLocked?: boolean;
     relatedIds?: number[];
     paymentStages?: unknown;
+    distance?: number;
     discountConfig?: Record<string, unknown>;
 }
 /**
@@ -667,4 +681,19 @@ interface IAggregatedProductGroup {
     productIds: string[];
     total: number;
 }
-export type { IAggregatedProductGroup, IFilterParams, IProductBlock, IProductInfo, IProductsApi, IProductsCount, IProductsEntity, IProductsInfo, IProductsQuery, IProductsResponse, };
+/**
+ * Body for semantic (vector) product search.
+ * @interface IVectorSearchProducts
+ * @property {string} queryText - Natural-language search query. Example: "red running shoes".
+ * @property {number} [vectorDistanceThreshold] - Max vector distance for a hit. Example: 0.5.
+ * @property {number} [maxHits] - Max number of hits to return. Example: 50.
+ * @property {boolean} [debug] - Include debug info in the response. Example: false.
+ * @description Body for the products vector/search endpoint.
+ */
+interface IVectorSearchProducts {
+    queryText: string;
+    vectorDistanceThreshold?: number;
+    maxHits?: number;
+    debug?: boolean;
+}
+export type { IAggregatedProductGroup, IFilterParams, IProductBlock, IProductInfo, IProductsApi, IProductsCount, IProductsEntity, IProductsInfo, IProductsQuery, IProductsResponse, IVectorSearchProducts, };

package/dist/products/productsSchemas.d.ts

@@ -60,6 +60,7 @@ export declare const ProductEntitySchema: z.ZodObject<{
     isPositionLocked: z.ZodOptional<z.ZodBoolean>;
     relatedIds: z.ZodOptional<z.ZodArray<z.ZodNumber>>;
     paymentStages: z.ZodNullable<z.ZodOptional<z.ZodAny>>;
+    distance: z.ZodOptional<z.ZodNumber>;
     discountConfig: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodAny>>;
 }, z.core.$strip>;
 /**
@@ -101,6 +102,7 @@ export declare const ProductsResponseSchema: z.ZodObject<{
         isPositionLocked: z.ZodOptional<z.ZodBoolean>;
         relatedIds: z.ZodOptional<z.ZodArray<z.ZodNumber>>;
         paymentStages: z.ZodNullable<z.ZodOptional<z.ZodAny>>;
+        distance: z.ZodOptional<z.ZodNumber>;
         discountConfig: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodAny>>;
     }, z.core.$strip>>;
     total: z.ZodNumber;
@@ -143,6 +145,7 @@ export declare const SingleProductSchema: z.ZodObject<{
     isPositionLocked: z.ZodOptional<z.ZodBoolean>;
     relatedIds: z.ZodOptional<z.ZodArray<z.ZodNumber>>;
     paymentStages: z.ZodNullable<z.ZodOptional<z.ZodAny>>;
+    distance: z.ZodOptional<z.ZodNumber>;
     discountConfig: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodAny>>;
 }, z.core.$strip>;
 /**
@@ -208,5 +211,6 @@ export declare const RelatedProductsSchema: z.ZodArray<z.ZodObject<{
     isPositionLocked: z.ZodOptional<z.ZodBoolean>;
     relatedIds: z.ZodOptional<z.ZodArray<z.ZodNumber>>;
     paymentStages: z.ZodNullable<z.ZodOptional<z.ZodAny>>;
+    distance: z.ZodOptional<z.ZodNumber>;
     discountConfig: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodAny>>;
 }, z.core.$strip>>;

package/dist/products/productsSchemas.js

@@ -65,6 +65,7 @@ exports.ProductEntitySchema = zod_1.z.object({
     isPositionLocked: zod_1.z.boolean().optional(),
     relatedIds: zod_1.z.array(zod_1.z.number()).optional(),
     paymentStages: zod_1.z.any().optional().nullable(),
+    distance: zod_1.z.number().optional(),
     discountConfig: zod_1.z.record(zod_1.z.string(), zod_1.z.any()).optional(),
 });
 /**

package/dist/subscriptions/subscriptionsApi.d.ts

@@ -0,0 +1,69 @@
+import AsyncModules from '../base/asyncModules';
+import type StateModule from '../base/stateModule';
+import type { IError } from '../base/utils';
+import type { ICancelSubscription, ICreatedSubscription, ISubscribe, ISubscriptionsApi } from './subscriptionsInterfaces';
+/**
+ * Controllers for working with paid subscriptions.
+ * @handle /api/content/subscriptions
+ * @class SubscriptionsApi
+ * @augments AsyncModules
+ * @implements {ISubscriptionsApi}
+ * @description This class provides methods to interact with paid subscriptions: creating, cancelling, recovering, and listing available/active subscriptions.
+ */
+export default class SubscriptionsApi extends AsyncModules implements ISubscriptionsApi {
+    protected state: StateModule;
+    protected _url: string;
+    /**
+     * Constructor for SubscriptionsApi class.
+     * @param {StateModule} state - The state module.
+     */
+    constructor(state: StateModule);
+    /**
+     * Create a new subscription and get a payment session for it.
+     * @handleName subscribe
+     * @param {ISubscribe} body - Subscription body. Example: `{ marker: "premium" }`.
+     * @returns {Promise<ICreatedSubscription | IError>} Returns the created payment session for the subscription.
+     * @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}.
+     */
+    subscribe(body: ISubscribe): Promise<ICreatedSubscription | IError>;
+    /**
+     * Cancel a subscription.
+     * @handleName cancelSubscription
+     * @param {ICancelSubscription} body - Subscription body. Example: `{ marker: "premium" }`.
+     * @returns {Promise<boolean | IError>} Returns true if the subscription was cancelled, or an error object if there was an issue.
+     * @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}.
+     */
+    cancelSubscription(body: ICancelSubscription): Promise<boolean | IError>;
+    /**
+     * Get all available subscription markers.
+     * @handleName getAllSubscriptions
+     * @returns {Promise<string[] | IError>} Returns an array of available subscription markers.
+     * @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}.
+     */
+    getAllSubscriptions(): Promise<string[] | IError>;
+    /**
+     * Get markers of the user's active subscriptions.
+     * @handleName getActiveSubscriptions
+     * @returns {Promise<string[] | IError>} Returns an array of active subscription markers.
+     * @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}.
+     */
+    getActiveSubscriptions(): Promise<string[] | IError>;
+    /**
+     * Recover a subscription through the Stripe Billing Portal.
+     * @handleName recoverSubscriptions
+     * @param {ICancelSubscription} body - Subscription body. Example: `{ marker: "premium" }`.
+     * @returns {Promise<boolean | IError>} Returns true if the recovery request was accepted, or an error object if there was an issue.
+     * @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}.
+     */
+    recoverSubscriptions(body: ICancelSubscription): Promise<boolean | IError>;
+}

package/dist/subscriptions/subscriptionsApi.js

@@ -0,0 +1,102 @@
+"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 subscriptionsSchemas_1 = require("./subscriptionsSchemas");
+/**
+ * Controllers for working with paid subscriptions.
+ * @handle /api/content/subscriptions
+ * @class SubscriptionsApi
+ * @augments AsyncModules
+ * @implements {ISubscriptionsApi}
+ * @description This class provides methods to interact with paid subscriptions: creating, cancelling, recovering, and listing available/active subscriptions.
+ */
+class SubscriptionsApi extends asyncModules_1.default {
+    /**
+     * Constructor for SubscriptionsApi class.
+     * @param {StateModule} state - The state module.
+     */
+    constructor(state) {
+        super(state);
+        this._url = state.url + '/api/content/subscriptions';
+    }
+    /**
+     * Create a new subscription and get a payment session for it.
+     * @handleName subscribe
+     * @param {ISubscribe} body - Subscription body. Example: `{ marker: "premium" }`.
+     * @returns {Promise<ICreatedSubscription | IError>} Returns the created payment session for the subscription.
+     * @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}.
+     */
+    async subscribe(body) {
+        const data = await this._fetchPost(``, body);
+        const validated = this._validateResponse(data, subscriptionsSchemas_1.CreatedSubscriptionSchema);
+        return this._normalizeData(validated);
+    }
+    /**
+     * Cancel a subscription.
+     * @handleName cancelSubscription
+     * @param {ICancelSubscription} body - Subscription body. Example: `{ marker: "premium" }`.
+     * @returns {Promise<boolean | IError>} Returns true if the subscription was cancelled, or an error object if there was an issue.
+     * @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}.
+     */
+    async cancelSubscription(body) {
+        try {
+            await this._fetchDelete(``, body);
+            return true;
+        }
+        catch (e) {
+            return e;
+        }
+    }
+    /**
+     * Get all available subscription markers.
+     * @handleName getAllSubscriptions
+     * @returns {Promise<string[] | IError>} Returns an array of available subscription markers.
+     * @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}.
+     */
+    async getAllSubscriptions() {
+        const data = await this._fetchGet(``);
+        const validated = this._validateResponse(data, subscriptionsSchemas_1.SubscriptionMarkersSchema);
+        return this._normalizeData(validated);
+    }
+    /**
+     * Get markers of the user's active subscriptions.
+     * @handleName getActiveSubscriptions
+     * @returns {Promise<string[] | IError>} Returns an array of active subscription markers.
+     * @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}.
+     */
+    async getActiveSubscriptions() {
+        const data = await this._fetchGet(`/active`);
+        const validated = this._validateResponse(data, subscriptionsSchemas_1.SubscriptionMarkersSchema);
+        return this._normalizeData(validated);
+    }
+    /**
+     * Recover a subscription through the Stripe Billing Portal.
+     * @handleName recoverSubscriptions
+     * @param {ICancelSubscription} body - Subscription body. Example: `{ marker: "premium" }`.
+     * @returns {Promise<boolean | IError>} Returns true if the recovery request was accepted, or an error object if there was an issue.
+     * @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}.
+     */
+    async recoverSubscriptions(body) {
+        try {
+            await this._fetchPost(`/recover`, body);
+            return true;
+        }
+        catch (e) {
+            return e;
+        }
+    }
+}
+exports.default = SubscriptionsApi;