oneentry 1.0.156 → 1.0.157

package/dist/products/productsSchemas.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.RelatedProductsSchema = exports.ProductBlockSchema = exports.ProductsCountSchema = exports.SingleProductSchema = exports.ProductsResponseSchema = exports.ProductEntitySchema = exports.ProductImageSchema = exports.ProductPriceSchema = void 0;
+exports.RelatedProductsSchema = exports.ProductBlockSchema = exports.ProductsCountSchema = exports.ProductSearchResponseSchema = exports.ProductSearchResultSchema = exports.SingleProductSchema = exports.ProductsResponseSchema = exports.ProductEntitySchema = exports.ProductImageSchema = exports.ProductPriceSchema = void 0;
 /**
  * Validation schemas for Products module
  * @description Zod schemas for validating products-related API responses
@@ -79,6 +79,19 @@ exports.ProductsResponseSchema = zod_1.z.object({
  * Single product response schema
  */
 exports.SingleProductSchema = exports.ProductEntitySchema;
+/**
+ * Product search result schema
+ * Short card returned by the quick search endpoint
+ */
+exports.ProductSearchResultSchema = zod_1.z.object({
+    id: zod_1.z.number(),
+    title: zod_1.z.string(),
+    pageId: zod_1.z.number(),
+});
+/**
+ * Product search response schema (array of short cards)
+ */
+exports.ProductSearchResponseSchema = zod_1.z.array(exports.ProductSearchResultSchema);
 /**
  * Products count schema
  */

package/dist/subscriptions/subscriptionsApi.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 { ICancelSubscription, ICreatedSubscription, ISubscribe, ISubscriptionsApi } from './subscriptionsInterfaces';
+import type { ICancelSubscription, ICreatedSubscription, ISubscribe, ISubscriptionEntity, ISubscriptionsApi } from './subscriptionsInterfaces';
 /**
  * Controllers for working with paid subscriptions.
  * @handle /api/content/subscriptions
@@ -41,15 +41,15 @@ export default class SubscriptionsApi extends AsyncModules implements ISubscript
      */
     cancelSubscription(body: ICancelSubscription): Promise<boolean | IError>;
     /**
-     * Get all available subscription markers.
+     * Get all available subscriptions.
      * @handleName getAllSubscriptions
-     * @returns {Promise<string[] | IError>} Returns an array of available subscription markers.
+     * @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<string[] | IError>;
+    getAllSubscriptions(): Promise<ISubscriptionEntity[] | IError>;
     /**
      * Get markers of the user's active subscriptions.
      * @handleName getActiveSubscriptions

package/dist/subscriptions/subscriptionsApi.js

@@ -51,9 +51,9 @@ class SubscriptionsApi extends asyncModules_1.default {
         return this._fetchBoolean(() => this._fetchDelete(``, body));
     }
     /**
-     * Get all available subscription markers.
+     * Get all available subscriptions.
      * @handleName getAllSubscriptions
-     * @returns {Promise<string[] | IError>} Returns an array of available subscription markers.
+     * @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}.
@@ -61,7 +61,7 @@ class SubscriptionsApi extends asyncModules_1.default {
      */
     async getAllSubscriptions() {
         const data = await this._fetchGet(``);
-        const validated = this._validateResponse(data, subscriptionsSchemas_1.SubscriptionMarkersSchema);
+        const validated = this._validateResponse(data, subscriptionsSchemas_1.SubscriptionsListSchema);
         return this._normalizeData(validated);
     }
     /**

package/dist/subscriptions/subscriptionsInterfaces.d.ts

@@ -1,4 +1,4 @@
-import type { IError } from '../base/utils';
+import type { IError, ILocalizeInfo } from '../base/utils';
 /**
  * Interface for the Subscriptions API module.
  * @interface ISubscriptionsApi
@@ -26,14 +26,14 @@ interface ISubscriptionsApi {
      */
     cancelSubscription(body: ICancelSubscription): Promise<boolean | IError>;
     /**
-     * Get all available subscription markers.
+     * Get all available subscriptions.
      * @handleName getAllSubscriptions
-     * @returns {Promise<string[] | IError>} Returns an array of available subscription markers.
+     * @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<string[] | IError>;
+    getAllSubscriptions(): Promise<ISubscriptionEntity[] | IError>;
     /**
      * Get markers of the user's active subscriptions.
      * @handleName getActiveSubscriptions
@@ -87,4 +87,25 @@ interface ICreatedSubscription {
     paymentUrl: string;
     status: string;
 }
-export type { ICancelSubscription, ICreatedSubscription, ISubscribe, ISubscriptionsApi, };
+/**
+ * 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/dist/subscriptions/subscriptionsSchemas.d.ts

@@ -13,8 +13,34 @@ export declare const CreatedSubscriptionSchema: z.ZodObject<{
     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 arrays of subscription markers (available and active subscriptions)
+ * @description Schema for the array of active subscription markers returned by getActiveSubscriptions
  */
 export declare const SubscriptionMarkersSchema: z.ZodArray<z.ZodString>;

package/dist/subscriptions/subscriptionsSchemas.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.SubscriptionMarkersSchema = exports.CreatedSubscriptionSchema = void 0;
+exports.SubscriptionMarkersSchema = exports.SubscriptionsListSchema = exports.SubscriptionEntitySchema = exports.CreatedSubscriptionSchema = void 0;
 /**
  * Validation schemas for Subscriptions module
  * @description Zod schemas for validating subscriptions-related API responses
@@ -16,8 +16,26 @@ exports.CreatedSubscriptionSchema = zod_1.z.object({
     paymentUrl: zod_1.z.string(),
     status: zod_1.z.string(),
 });
+/**
+ * Subscription entity schema
+ * @description Schema for an available subscription as returned by the API (localizeInfos kept as a locale map)
+ */
+exports.SubscriptionEntitySchema = zod_1.z.object({
+    id: zod_1.z.number(),
+    identifier: zod_1.z.string(),
+    localizeInfos: zod_1.z.record(zod_1.z.string(), zod_1.z.any()),
+    productIds: zod_1.z.array(zod_1.z.number()),
+    periodInDays: zod_1.z.number(),
+    paymentAccountId: zod_1.z.number(),
+    isUsed: zod_1.z.boolean(),
+});
+/**
+ * Subscriptions list schema
+ * @description Schema for the array of available subscriptions returned by getAllSubscriptions
+ */
+exports.SubscriptionsListSchema = zod_1.z.array(exports.SubscriptionEntitySchema);
 /**
  * Subscription markers schema
- * @description Schema for arrays of subscription markers (available and active subscriptions)
+ * @description Schema for the array of active subscription markers returned by getActiveSubscriptions
  */
 exports.SubscriptionMarkersSchema = zod_1.z.array(zod_1.z.string());

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "oneentry",
-  "version": "1.0.156",
+  "version": "1.0.157",
   "description": "OneEntry NPM package",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",