oneentry 1.0.159 → 1.0.161

package/esm/sitemap/sitemapApi.d.ts

@@ -0,0 +1,37 @@
+import AsyncModules from '../base/asyncModules.js';
+import type StateModule from '../base/stateModule.js';
+import type { IError } from '../base/utils.js';
+import type { ISitemapApi, ISitemapQuery } from './sitemapInterfaces.js';
+/**
+ * Controllers for working with sitemaps.
+ * @handle /api/content/sitemap
+ * @class SitemapApi
+ * @augments AsyncModules
+ * @implements {ISitemapApi}
+ */
+export default class SitemapApi extends AsyncModules implements ISitemapApi {
+    protected state: StateModule;
+    protected _url: string;
+    /**
+     * Constructor for SitemapApi class.
+     * @param {StateModule} state - The state module.
+     */
+    constructor(state: StateModule);
+    /**
+     * Retrieves the set of sitemaps.
+     * @handleName getSitemap
+     * @returns {Promise<string[] | IError>} Returns an array of sitemap URLs.
+     * @throws {IError} When isShell=false and an error occurs during the fetch
+     * @see {@link https://js-sdk.oneentry.cloud/docs/sitemap/getSitemap getSitemap} documentation.
+     */
+    getSitemap(): Promise<string[] | IError>;
+    /**
+     * Generates a new set of sitemaps.
+     * @handleName updateSitemap
+     * @param {ISitemapQuery} body - Sitemap body params (e.g. `{ baseUrls: { en_US: "https://…" } }`).
+     * @returns {Promise<string[] | IError>} Returns an array of generated sitemap URLs.
+     * @throws {IError} When isShell=false and an error occurs during the fetch
+     * @see {@link https://js-sdk.oneentry.cloud/docs/sitemap/updateSitemap updateSitemap} documentation.
+     */
+    updateSitemap(body: ISitemapQuery): Promise<string[] | IError>;
+}

package/esm/sitemap/sitemapApi.js

@@ -0,0 +1,41 @@
+import AsyncModules from '../base/asyncModules.js';
+/**
+ * Controllers for working with sitemaps.
+ * @handle /api/content/sitemap
+ * @class SitemapApi
+ * @augments AsyncModules
+ * @implements {ISitemapApi}
+ */
+export default class SitemapApi extends AsyncModules {
+    /**
+     * Constructor for SitemapApi class.
+     * @param {StateModule} state - The state module.
+     */
+    constructor(state) {
+        super(state);
+        this._url = state.url + '/api/content/sitemap';
+    }
+    /**
+     * Retrieves the set of sitemaps.
+     * @handleName getSitemap
+     * @returns {Promise<string[] | IError>} Returns an array of sitemap URLs.
+     * @throws {IError} When isShell=false and an error occurs during the fetch
+     * @see {@link https://js-sdk.oneentry.cloud/docs/sitemap/getSitemap getSitemap} documentation.
+     */
+    async getSitemap() {
+        const data = await this._fetchGet(`/`);
+        return this._normalizeData(data);
+    }
+    /**
+     * Generates a new set of sitemaps.
+     * @handleName updateSitemap
+     * @param {ISitemapQuery} body - Sitemap body params (e.g. `{ baseUrls: { en_US: "https://…" } }`).
+     * @returns {Promise<string[] | IError>} Returns an array of generated sitemap URLs.
+     * @throws {IError} When isShell=false and an error occurs during the fetch
+     * @see {@link https://js-sdk.oneentry.cloud/docs/sitemap/updateSitemap updateSitemap} documentation.
+     */
+    async updateSitemap(body) {
+        const data = await this._fetchPost(`/`, body);
+        return this._normalizeData(data);
+    }
+}

package/esm/sitemap/sitemapInterfaces.d.ts

@@ -0,0 +1,51 @@
+import type { IError } from '../base/utils.js';
+/**
+ * Interface for the Sitemap API module.
+ * @interface ISitemapApi
+ */
+interface ISitemapApi {
+    /**
+     * Retrieves the set of sitemaps.
+     * @handleName getSitemap
+     * @returns {Promise<Array<string> | IError>}
+     */
+    getSitemap(): Promise<Array<string> | IError>;
+    /**
+     * Generates a new set of sitemaps.
+     * @handleName updateSitemap
+     * @param {ISitemapQuery} body - Sitemap body params.
+     * @returns {Promise<string[] | IError>} Returns an array of generated sitemap URLs.
+     */
+    updateSitemap(body: ISitemapQuery): Promise<string[] | IError>;
+}
+/**
+ * Query parameters for sitemap requests.
+ * @interface ISitemapQuery
+ * @property {Record<string, string>} [baseUrls] - Base URLs per language for sitemap generation. Example: `{ "en_US": "https://example.com/" }`.
+ * @property {string} [url] - URL of a single sitemap entry.
+ * @property {string} [lastmod] - Last modification date of the entry.
+ * @property {string} [changefreq] - Frequency of changes for the entry.
+ * @property {number} [priority] - Priority of the entry.
+ */
+interface ISitemapQuery {
+    baseUrls?: Record<string, string>;
+    url?: string;
+    lastmod?: string;
+    changefreq?: string;
+    priority?: number;
+}
+/**
+ * Entity interface for sitemap.
+ * @interface ISitemapEntity
+ * @property {string} url - URL of the sitemap.
+ * @property {string} lastmod - Last modification date of the sitemap.
+ * @property {string} changefreq - Frequency of changes for the sitemap.
+ * @property {number} priority - Priority of the sitemap.
+ */
+interface ISitemapEntity {
+    url: string;
+    lastmod: string;
+    changefreq: string;
+    priority: number;
+}
+export type { ISitemapApi, ISitemapEntity, ISitemapQuery };

package/esm/sitemap/sitemapInterfaces.js

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

package/esm/subscriptions/subscriptionsApi.d.ts

@@ -0,0 +1,74 @@
+import AsyncModules from '../base/asyncModules.js';
+import type StateModule from '../base/stateModule.js';
+import type { IError } from '../base/utils.js';
+import type { ICancelSubscription, ICreatedSubscription, ISubscribe, ISubscriptionEntity, ISubscriptionsApi } from './subscriptionsInterfaces.js';
+/**
+ * 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}.
+     * @see {@link https://js-sdk.oneentry.cloud/docs/subscriptions/subscribe subscribe} documentation.
+     */
+    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}.
+     * @see {@link https://js-sdk.oneentry.cloud/docs/subscriptions/cancelSubscription cancelSubscription} documentation.
+     */
+    cancelSubscription(body: ICancelSubscription): Promise<boolean | IError>;
+    /**
+     * Get all available subscriptions.
+     * @handleName getAllSubscriptions
+     * @returns {Promise<ISubscriptionEntity[] | IError>} Returns an array of available subscriptions.
+     * @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/subscriptions/getAllSubscriptions getAllSubscriptions} documentation.
+     */
+    getAllSubscriptions(): Promise<ISubscriptionEntity[] | 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}.
+     * @see {@link https://js-sdk.oneentry.cloud/docs/subscriptions/getActiveSubscriptions getActiveSubscriptions} documentation.
+     */
+    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}.
+     * @see {@link https://js-sdk.oneentry.cloud/docs/subscriptions/recoverSubscriptions recoverSubscriptions} documentation.
+     */
+    recoverSubscriptions(body: ICancelSubscription): Promise<boolean | IError>;
+}

package/esm/subscriptions/subscriptionsApi.js

@@ -0,0 +1,90 @@
+import AsyncModules from '../base/asyncModules.js';
+import createSchemaLoader from '../base/lazySchema.js';
+const schema = createSchemaLoader(() => import('./subscriptionsSchemas.js'));
+/**
+ * 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 {
+    /**
+     * 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}.
+     * @see {@link https://js-sdk.oneentry.cloud/docs/subscriptions/subscribe subscribe} documentation.
+     */
+    async subscribe(body) {
+        const data = await this._fetchPost(``, body);
+        const validated = await this._validateResponse(data, schema('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}.
+     * @see {@link https://js-sdk.oneentry.cloud/docs/subscriptions/cancelSubscription cancelSubscription} documentation.
+     */
+    async cancelSubscription(body) {
+        return this._fetchBoolean(() => this._fetchDelete(``, body));
+    }
+    /**
+     * Get all available subscriptions.
+     * @handleName getAllSubscriptions
+     * @returns {Promise<ISubscriptionEntity[] | IError>} Returns an array of available subscriptions.
+     * @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/subscriptions/getAllSubscriptions getAllSubscriptions} documentation.
+     */
+    async getAllSubscriptions() {
+        const data = await this._fetchGet(``);
+        const validated = await this._validateResponse(data, schema('SubscriptionsListSchema'));
+        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}.
+     * @see {@link https://js-sdk.oneentry.cloud/docs/subscriptions/getActiveSubscriptions getActiveSubscriptions} documentation.
+     */
+    async getActiveSubscriptions() {
+        const data = await this._fetchGet(`/active`);
+        const validated = await this._validateResponse(data, schema('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}.
+     * @see {@link https://js-sdk.oneentry.cloud/docs/subscriptions/recoverSubscriptions recoverSubscriptions} documentation.
+     */
+    async recoverSubscriptions(body) {
+        return this._fetchBoolean(() => this._fetchPost(`/recover`, body));
+    }
+}

package/esm/subscriptions/subscriptionsInterfaces.d.ts

@@ -0,0 +1,111 @@
+import type { IError, ILocalizeInfo } from '../base/utils.js';
+/**
+ * Interface for the Subscriptions API module.
+ * @interface ISubscriptionsApi
+ * @description This interface defines methods for managing paid subscriptions: creating, cancelling, recovering, and listing available/active subscriptions.
+ */
+interface ISubscriptionsApi {
+    /**
+     * 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 subscriptions.
+     * @handleName getAllSubscriptions
+     * @returns {Promise<ISubscriptionEntity[] | IError>} Returns an array of available subscriptions.
+     * @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<ISubscriptionEntity[] | 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>;
+}
+/**
+ * Body for creating a subscription.
+ * @interface ISubscribe
+ * @property {string} marker - Subscription marker. Example: "premium".
+ * @description Body for creating a subscription.
+ */
+interface ISubscribe {
+    marker: string;
+}
+/**
+ * Body for cancelling or recovering a subscription.
+ * @interface ICancelSubscription
+ * @property {string} marker - Subscription marker. Example: "premium".
+ * @description Body for cancelling or recovering a subscription.
+ */
+interface ICancelSubscription {
+    marker: string;
+}
+/**
+ * Created subscription payment session.
+ * @interface ICreatedSubscription
+ * @property {number} id - Payment session identifier. Example: 1.
+ * @property {number} amount - Amount to be paid. Example: 100.
+ * @property {string} paymentUrl - Payment page URL. Example: "https://checkout.stripe.com/c/pay/...".
+ * @property {string} status - Payment session status. Example: "waiting".
+ * @description Created subscription payment session returned after subscribing.
+ */
+interface ICreatedSubscription {
+    id: number;
+    amount: number;
+    paymentUrl: string;
+    status: string;
+}
+/**
+ * Available subscription.
+ * @interface ISubscriptionEntity
+ * @property {number} id - Subscription identifier. Example: 1.
+ * @property {string} identifier - Subscription textual identifier (marker). Example: "test_subscription".
+ * @property {ILocalizeInfo} localizeInfos - Localized subscription info for the current language. Example: `{ title: "Test subscription" }`.
+ * @property {number[]} productIds - Identifiers of the products included in the subscription. Example: [3445].
+ * @property {number} periodInDays - Subscription period in days. Example: 30.
+ * @property {number} paymentAccountId - Identifier of the payment account the subscription is billed through. Example: 1.
+ * @property {boolean} isUsed - Indicates whether the subscription is in use. Example: false.
+ * @description Subscription configured in the project, returned by getAllSubscriptions.
+ */
+interface ISubscriptionEntity {
+    id: number;
+    identifier: string;
+    localizeInfos: ILocalizeInfo;
+    productIds: number[];
+    periodInDays: number;
+    paymentAccountId: number;
+    isUsed: boolean;
+}
+export type { ICancelSubscription, ICreatedSubscription, ISubscribe, ISubscriptionEntity, ISubscriptionsApi, };

package/esm/subscriptions/subscriptionsInterfaces.js

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

package/esm/subscriptions/subscriptionsSchemas.d.ts

@@ -0,0 +1,46 @@
+/**
+ * Validation schemas for Subscriptions module
+ * @description Zod schemas for validating subscriptions-related API responses
+ */
+import { z } from 'zod';
+/**
+ * Created subscription schema
+ * @description Schema for the payment session returned after creating a subscription
+ */
+export declare const CreatedSubscriptionSchema: z.ZodObject<{
+    id: z.ZodNumber;
+    amount: z.ZodNumber;
+    paymentUrl: z.ZodString;
+    status: z.ZodString;
+}, z.core.$strip>;
+/**
+ * Subscription entity schema
+ * @description Schema for an available subscription as returned by the API (localizeInfos kept as a locale map)
+ */
+export declare const SubscriptionEntitySchema: z.ZodObject<{
+    id: z.ZodNumber;
+    identifier: z.ZodString;
+    localizeInfos: z.ZodRecord<z.ZodString, z.ZodAny>;
+    productIds: z.ZodArray<z.ZodNumber>;
+    periodInDays: z.ZodNumber;
+    paymentAccountId: z.ZodNumber;
+    isUsed: z.ZodBoolean;
+}, z.core.$strip>;
+/**
+ * Subscriptions list schema
+ * @description Schema for the array of available subscriptions returned by getAllSubscriptions
+ */
+export declare const SubscriptionsListSchema: z.ZodArray<z.ZodObject<{
+    id: z.ZodNumber;
+    identifier: z.ZodString;
+    localizeInfos: z.ZodRecord<z.ZodString, z.ZodAny>;
+    productIds: z.ZodArray<z.ZodNumber>;
+    periodInDays: z.ZodNumber;
+    paymentAccountId: z.ZodNumber;
+    isUsed: z.ZodBoolean;
+}, z.core.$strip>>;
+/**
+ * Subscription markers schema
+ * @description Schema for the array of active subscription markers returned by getActiveSubscriptions
+ */
+export declare const SubscriptionMarkersSchema: z.ZodArray<z.ZodString>;

package/esm/subscriptions/subscriptionsSchemas.js

@@ -0,0 +1,38 @@
+/**
+ * Validation schemas for Subscriptions module
+ * @description Zod schemas for validating subscriptions-related API responses
+ */
+import { z } from 'zod';
+/**
+ * Created subscription schema
+ * @description Schema for the payment session returned after creating a subscription
+ */
+export const CreatedSubscriptionSchema = z.object({
+    id: z.number(),
+    amount: z.number(),
+    paymentUrl: z.string(),
+    status: z.string(),
+});
+/**
+ * Subscription entity schema
+ * @description Schema for an available subscription as returned by the API (localizeInfos kept as a locale map)
+ */
+export const SubscriptionEntitySchema = z.object({
+    id: z.number(),
+    identifier: z.string(),
+    localizeInfos: z.record(z.string(), z.any()),
+    productIds: z.array(z.number()),
+    periodInDays: z.number(),
+    paymentAccountId: z.number(),
+    isUsed: z.boolean(),
+});
+/**
+ * Subscriptions list schema
+ * @description Schema for the array of available subscriptions returned by getAllSubscriptions
+ */
+export const SubscriptionsListSchema = z.array(SubscriptionEntitySchema);
+/**
+ * Subscription markers schema
+ * @description Schema for the array of active subscription markers returned by getActiveSubscriptions
+ */
+export const SubscriptionMarkersSchema = z.array(z.string());

package/esm/system/systemApi.d.ts

@@ -0,0 +1,46 @@
+import AsyncModules from '../base/asyncModules.js';
+import type StateModule from '../base/stateModule.js';
+import type { IError } from '../base/utils.js';
+import type { ISystemApi } from './systemInterfaces.js';
+/**
+ * Controllers for working with system components
+ * @handle /api/content/system
+ * @description Controllers for working with system components
+ */
+export default class SystemApi extends AsyncModules implements ISystemApi {
+    protected state: StateModule;
+    protected _url: string;
+    /**
+     * Constructor
+     * @param {StateModule} state - The state module.
+     * @description Constructor initializes the SystemApi with a given state.
+     */
+    constructor(state: StateModule);
+    /**
+     * Sends a GET request to the '/test404' endpoint and returns the result.
+     * @handleName test404
+     * @returns {Promise<unknown | IError>} The response from the server after fetching data from the '/test404' endpoint.
+     * @throws {IError} When isShell=false and an error occurs during the fetch
+     * @description This method is used to test the 404 error handling by sending a GET request to a specific endpoint.
+     * @see {@link https://js-sdk.oneentry.cloud/docs/system/test404 test404} documentation.
+     */
+    test404(): Promise<unknown | IError>;
+    /**
+     * Sends a GET request to the '/test500' endpoint and returns the result.
+     * @handleName test500
+     * @returns {Promise<unknown | IError>} The response from the server after fetching data from the '/test500' endpoint.
+     * @throws {IError} When isShell=false and an error occurs during the fetch
+     * @description This method is used to test the 500 error handling by sending a GET request to a specific endpoint.
+     * @see {@link https://js-sdk.oneentry.cloud/docs/system/test500 test500} documentation.
+     */
+    test500(): Promise<unknown | IError>;
+    /**
+     * Getting the number of requests to API.
+     * @handleName getApiStat
+     * @returns {Promise<unknown | IError>} Return object with date and count.
+     * @throws {IError} When isShell=false and an error occurs during the fetch
+     * @description Getting the number of requests to API.
+     * @see {@link https://js-sdk.oneentry.cloud/docs/system/getApiStat getApiStat} documentation.
+     */
+    getApiStat(): Promise<unknown>;
+}

package/esm/system/systemApi.js

@@ -0,0 +1,53 @@
+import AsyncModules from '../base/asyncModules.js';
+/**
+ * Controllers for working with system components
+ * @handle /api/content/system
+ * @description Controllers for working with system components
+ */
+export default class SystemApi extends AsyncModules {
+    /**
+     * Constructor
+     * @param {StateModule} state - The state module.
+     * @description Constructor initializes the SystemApi with a given state.
+     */
+    constructor(state) {
+        super(state);
+        this._url = state.url + '/api/content/system';
+    }
+    /**
+     * Sends a GET request to the '/test404' endpoint and returns the result.
+     * @handleName test404
+     * @returns {Promise<unknown | IError>} The response from the server after fetching data from the '/test404' endpoint.
+     * @throws {IError} When isShell=false and an error occurs during the fetch
+     * @description This method is used to test the 404 error handling by sending a GET request to a specific endpoint.
+     * @see {@link https://js-sdk.oneentry.cloud/docs/system/test404 test404} documentation.
+     */
+    async test404() {
+        const result = await this._fetchGet('/test404');
+        return result;
+    }
+    /**
+     * Sends a GET request to the '/test500' endpoint and returns the result.
+     * @handleName test500
+     * @returns {Promise<unknown | IError>} The response from the server after fetching data from the '/test500' endpoint.
+     * @throws {IError} When isShell=false and an error occurs during the fetch
+     * @description This method is used to test the 500 error handling by sending a GET request to a specific endpoint.
+     * @see {@link https://js-sdk.oneentry.cloud/docs/system/test500 test500} documentation.
+     */
+    async test500() {
+        const result = await this._fetchGet('/test500');
+        return result;
+    }
+    /**
+     * Getting the number of requests to API.
+     * @handleName getApiStat
+     * @returns {Promise<unknown | IError>} Return object with date and count.
+     * @throws {IError} When isShell=false and an error occurs during the fetch
+     * @description Getting the number of requests to API.
+     * @see {@link https://js-sdk.oneentry.cloud/docs/system/getApiStat getApiStat} documentation.
+     */
+    async getApiStat() {
+        const result = await this._fetchGet('/api-stat');
+        return result;
+    }
+}

package/esm/system/systemInterfaces.d.ts

@@ -0,0 +1,29 @@
+import type { IError } from '../base/utils.js';
+/**
+ * @interface ISystemApi
+ * @description Represents a interface object of System Api.
+ */
+interface ISystemApi {
+    /**
+     * Test 404 error.
+     * @handleName test404
+     * @returns {unknown} Returns a Promise that resolves with any data.
+     * @description This method tests 404 error.
+     */
+    test404(): Promise<unknown | IError>;
+    /**
+     * Test 500 error.
+     * @handleName test500
+     * @returns {unknown} Returns a Promise that resolves with any data.
+     * @description This method tests 500 error.
+     */
+    test500(): Promise<unknown | IError>;
+    /**
+     * getApiStat
+     * @handleName getApiStat
+     * @returns {unknown} Returns a Promise that resolves with any data.
+     * @description This method getApiStat.
+     */
+    getApiStat(): Promise<unknown>;
+}
+export type { ISystemApi };

package/esm/system/systemInterfaces.js

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