oneentry 1.0.159 → 1.0.161

package/esm/types.js

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

package/esm/user-activity/userActivityApi.d.ts

@@ -0,0 +1,31 @@
+import AsyncModules from '../base/asyncModules.js';
+import type StateModule from '../base/stateModule.js';
+import type { IError } from '../base/utils.js';
+import type { ITrackActivity, IUserActivityApi } from './userActivityInterfaces.js';
+/**
+ * Controllers for working with user activity.
+ * @handle /api/content/user-activity
+ * @class UserActivityApi
+ * @augments AsyncModules
+ * @implements {IUserActivityApi}
+ * @description This class provides methods to track user/guest activity events.
+ */
+export default class UserActivityApi extends AsyncModules implements IUserActivityApi {
+    protected state: StateModule;
+    protected _url: string;
+    /**
+     * Constructor for UserActivityApi class.
+     * @param {StateModule} state - The state module.
+     */
+    constructor(state: StateModule);
+    /**
+     * Track a user or guest activity event.
+     * @handleName trackUserActivity
+     * @param {ITrackActivity} body - Activity event body. Example: `{ type: "product_view", productId: 12345 }`.
+     * @returns {Promise<boolean | IError>} Returns true if the event was recorded, or an error object if there was an issue.
+     * @throws {IError} When isShell=false and an error occurs during the fetch
+     * @description Records an activity event for the current authorized user or guest.
+     * @see {@link https://js-sdk.oneentry.cloud/docs/user-activity/trackUserActivity trackUserActivity} documentation.
+     */
+    trackUserActivity(body: ITrackActivity): Promise<boolean | IError>;
+}

package/esm/user-activity/userActivityApi.js

@@ -0,0 +1,37 @@
+import AsyncModules from '../base/asyncModules.js';
+/**
+ * Controllers for working with user activity.
+ * @handle /api/content/user-activity
+ * @class UserActivityApi
+ * @augments AsyncModules
+ * @implements {IUserActivityApi}
+ * @description This class provides methods to track user/guest activity events.
+ */
+export default class UserActivityApi extends AsyncModules {
+    /**
+     * Constructor for UserActivityApi class.
+     * @param {StateModule} state - The state module.
+     */
+    constructor(state) {
+        super(state);
+        this._url = state.url + '/api/content/user-activity';
+    }
+    /**
+     * Track a user or guest activity event.
+     * @handleName trackUserActivity
+     * @param {ITrackActivity} body - Activity event body. Example: `{ type: "product_view", productId: 12345 }`.
+     * @returns {Promise<boolean | IError>} Returns true if the event was recorded, or an error object if there was an issue.
+     * @throws {IError} When isShell=false and an error occurs during the fetch
+     * @description Records an activity event for the current authorized user or guest.
+     * @see {@link https://js-sdk.oneentry.cloud/docs/user-activity/trackUserActivity trackUserActivity} documentation.
+     */
+    async trackUserActivity(body) {
+        try {
+            await this._fetchPost(`/track`, body);
+            return true;
+        }
+        catch (e) {
+            return e;
+        }
+    }
+}

package/esm/user-activity/userActivityInterfaces.d.ts

@@ -0,0 +1,42 @@
+import type { IError } from '../base/utils.js';
+/**
+ * Interface for the UserActivity API module.
+ * @interface IUserActivityApi
+ * @description This interface defines methods for tracking user/guest activity events.
+ */
+interface IUserActivityApi {
+    /**
+     * Track a user or guest activity event.
+     * @handleName trackUserActivity
+     * @param {ITrackActivity} body - Activity event body. Example: `{ type: "product_view", productId: 12345 }`.
+     * @returns {Promise<boolean | IError>} Returns true if the event was recorded, or an error object if there was an issue.
+     * @throws {IError} When isShell=false and an error occurs during the fetch
+     * @description Records an activity event for the current authorized user or guest.
+     */
+    trackUserActivity(body: ITrackActivity): Promise<boolean | IError>;
+}
+/**
+ * User activity event type.
+ * @description Type of the tracked user activity event.
+ */
+type TUserActivityType = 'product_view' | 'page_view' | 'category_view' | 'search' | 'product_add_to_cart' | 'product_remove_from_cart' | 'product_add_to_wishlist' | 'product_remove_from_wishlist' | 'product_purchase' | 'product_rating';
+/**
+ * Body for tracking a user activity event.
+ * @interface ITrackActivity
+ * @property {TUserActivityType} type - Activity event type. Example: "product_view".
+ * @property {number} [productId] - Product identifier. Example: 12345.
+ * @property {number} [pageId] - Page identifier (for page_view, category_view). Example: 7.
+ * @property {number} [categoryId] - Legacy category identifier. Example: 67.
+ * @property {string} [query] - Search query (for type=search). Example: "iphone case".
+ * @property {Record<string, unknown>} [meta] - Arbitrary meta information (source block, A/B variant, scroll-depth).
+ * @description Body for tracking a user activity event.
+ */
+interface ITrackActivity {
+    type: TUserActivityType;
+    productId?: number;
+    pageId?: number;
+    categoryId?: number;
+    query?: string;
+    meta?: Record<string, unknown>;
+}
+export type { ITrackActivity, IUserActivityApi, TUserActivityType };

package/esm/user-activity/userActivityInterfaces.js

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

package/esm/users/usersApi.d.ts

@@ -0,0 +1,249 @@
+import AsyncModules from '../base/asyncModules.js';
+import type StateModule from '../base/stateModule.js';
+import type { IError } from '../base/utils.js';
+import type { ICartAddItem, ICartResponse, ICartSet, IUserBody, IUserEntity, IUsersApi, IUsersResponse, IUsersVectorSearch, IWishlistAddItem, IWishlistResponse, IWishlistSet } from './usersInterfaces.js';
+/**
+ * Controllers for working with users
+ * @handle /api/content/users
+ * @description This module provides various methods to manage users, including creating, retrieving, updating, and deleting user data. It requires proper authorization to access these endpoints.
+ */
+export default class UsersApi extends AsyncModules implements IUsersApi {
+    protected state: StateModule;
+    protected _url: string;
+    /**
+     * Constructor for UsersApi class.
+     * @param {StateModule} state - The state module containing necessary information for API calls.
+     * @description Initializes the UsersApi class with the provided state module.
+     */
+    constructor(state: StateModule);
+    /**
+     * Getting the data of an authorized user.
+     * @handleName getUser
+     * @param {string} [langCode] - Language code. Default: "en_US".
+     * @returns {Promise<IUserEntity | IError>} Returns a promise that resolves to the user entity object if successful; otherwise, returns an error object.
+     * @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/users/getUser getUser} documentation.
+     */
+    getUser(langCode?: string): Promise<IUserEntity | IError>;
+    /**
+     * Updating a single user object.
+     * @handleName updateUser
+     * @param {IUserBody} body - Request body.
+     * @example
+        {
+          "formIdentifier": "reg",
+          "authData": [
+            {
+              "marker": "email_reg",
+              "value": "your-email@oneentery.cloud"
+            },
+            {
+              "marker": "password_reg",
+              "value": "12345"
+            }
+          ],
+          "formData": [
+            {
+              "marker": "last_name",
+              "type": "string",
+              "value": "Username"
+            }
+          ],
+          "notificationData": {
+            "email": "example@oneentry.cloud",
+            "phonePush": ["+99999999999"],
+            "phoneSMS": "+99999999999"
+          },
+          "state": {}
+        }
+     * @param {string} body.formIdentifier - Identifies the registration form being used. Example: "reg_form".
+     * @param {string} body.authData - Contains authentication credentials for the user. Example:
+     * @example
+        [
+          {
+            "marker": "email_reg",
+            "value": "example@oneentry.cloud"
+          },
+          {
+            "marker": "password_reg",
+            "value": "password"
+          }
+        ]
+     * @param {string} body.authData[].marker - Identifies the field being used. Example: "email_reg".
+     * @param {string} body.authData[].value - Contains the value of the field. Example: "example@oneentry.cloud".
+     * @param {string} body.formData - Contains additional data for the user.
+     * @example
+        [
+          {
+            "marker": "last_name",
+            "type": "string",
+            "value": "Username"
+          }
+        ]
+     * @param {string} body.formData[].marker - The marker of the field. Example: "last_name".
+     * @param {string} body.formData[].type - The type of the field. Example: "string".
+     * @param {string} body.formData[].value - The value of the field. Example: "Username".
+     * @param {string} body.notificationData - The notification data.
+     * @example
+        {
+          "email": "example@oneentry.cloud",
+          "phonePush": ["+99999999999"],
+          "phoneSMS": "+99999999999"
+        }
+     * @param {string} body.notificationData.email - The email address of the user. Example: "example@oneentry.cloud".
+     * @param {string} body.notificationData.phonePush - An array of phone numbers for push notifications. Example: ["+99999999999"].
+     * @param {string} body.notificationData.phoneSMS - The phone number for SMS notifications. Example: "+99999999999".
+     * @param {string} [langCode] - Language code. Default: "en_US".
+     * @returns {Promise<boolean | IError>} Returns `true` if the user object was successfully updated; otherwise, returns an error object.
+     * @throws {IError} When isShell=false and an error occurs during the fetch
+     * @description This method updates the user's data. 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 For more information about {@link https://doc.oneentry.cloud/docs/forms/create-form registration forms}, see the documentation in the  {@link https://doc.oneentry.cloud/docs/forms/create-form forms configuration section}.
+     * @see {@link https://js-sdk.oneentry.cloud/docs/users/updateUser updateUser} documentation.
+     */
+    updateUser(body: IUserBody, langCode?: string): Promise<boolean | IError>;
+    /**
+     * Archiving one user object (marked for deletion).
+     * @handleName archiveUser
+     * @returns {Promise<boolean | IError>} Returns `true` if the user was successfully deleted; otherwise, returns an error object.
+     * @throws {IError} When isShell=false and an error occurs during the fetch
+     * @description This method archives a user object (marks it for deletion). This method requires user authorization.
+     * @see For more information about configuring the {@link https://js-sdk.oneentry.cloud/docs/auth-provider/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/users/archiveUser archiveUser} documentation.
+     */
+    archiveUser(): Promise<boolean | IError>;
+    /**
+     * Delete a single user.
+     * @handleName deleteUser
+     * @returns {Promise<boolean | IError>} Returns `true` if the user was successfully deleted; otherwise, returns an error object.
+     * @throws {IError} When isShell=false and an error occurs during the fetch
+     * @description This method deletes the user from the system. 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/users/deleteUser deleteUser} documentation.
+     */
+    deleteUser(): Promise<boolean | IError>;
+    /**
+     * Adds an FCM (Firebase Cloud Messaging) token for sending push notifications.
+     * @handleName addFCMToken
+     * @param {string} token - The cloud messaging token to be added. This token is used to identify the user's device for push notifications. Example: "fcm_token_1234567890abcdefg".
+     * @returns {Promise<boolean | IError>} Returns `true` if the token was successfully added; otherwise, returns an error object.
+     * @throws {IError} When isShell=false and an error occurs during the fetch
+     * @description This method adds an FCM token for sending push notifications. 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/users/addFCMToken addFCMToken} documentation.
+     */
+    addFCMToken(token: string): Promise<boolean | IError>;
+    /**
+     * Deletes an FCM (Firebase Cloud Messaging) token.
+     * @handleName deleteFCMToken
+     * @param {string} token - The cloud messaging token to be deleted. This token is used to identify the user's device for push notifications and will be removed. Example: "fcm_token_1234567890abcdefg".
+     * @returns {Promise<boolean | IError>} Returns `true` if the token was successfully deleted; otherwise, returns an error object.
+     * @throws {IError} When isShell=false and an error occurs during the fetch
+     * @description This method deletes an existing FCM token. 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/users/deleteFCMToken deleteFCMToken} documentation.
+     */
+    deleteFCMToken(token: string): Promise<boolean | IError>;
+    /**
+     * Get the current user's or guest's cart.
+     * @handleName getCart
+     * @returns {Promise<ICartResponse | IError>} Returns the cart with its items and total.
+     * @throws {IError} When isShell=false and an error occurs during the fetch
+     * @description This method requires user authorization (or a guest context).
+     * @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/users/getCart getCart} documentation.
+     */
+    getCart(): Promise<ICartResponse | IError>;
+    /**
+     * Replace the current user's or guest's cart.
+     * @handleName setCart
+     * @param {ICartSet} body - New cart contents. Example: `{ items: [{ productId: 1, qty: 2 }] }`.
+     * @returns {Promise<ICartResponse | IError>} Returns the updated cart.
+     * @throws {IError} When isShell=false and an error occurs during the fetch
+     * @description This method requires user authorization (or a guest context).
+     * @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/users/setCart setCart} documentation.
+     */
+    setCart(body: ICartSet): Promise<ICartResponse | IError>;
+    /**
+     * Add an item to the cart (or update qty of an existing one).
+     * @handleName addCartItem
+     * @param {ICartAddItem} body - Item to add. Example: `{ productId: 1, qty: 2 }`.
+     * @returns {Promise<ICartResponse | IError>} Returns the updated cart.
+     * @throws {IError} When isShell=false and an error occurs during the fetch
+     * @description This method requires user authorization (or a guest context).
+     * @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/users/addCartItem addCartItem} documentation.
+     */
+    addCartItem(body: ICartAddItem): Promise<ICartResponse | IError>;
+    /**
+     * Remove an item from the cart.
+     * @handleName removeCartItem
+     * @param {number} productId - Product identifier. Example: 12345.
+     * @returns {Promise<ICartResponse | IError>} Returns the updated cart.
+     * @throws {IError} When isShell=false and an error occurs during the fetch
+     * @description This method requires user authorization (or a guest context).
+     * @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/users/removeCartItem removeCartItem} documentation.
+     */
+    removeCartItem(productId: number): Promise<ICartResponse | IError>;
+    /**
+     * Get the current user's or guest's wishlist.
+     * @handleName getWishlist
+     * @returns {Promise<IWishlistResponse | IError>} Returns the wishlist with its items and total.
+     * @throws {IError} When isShell=false and an error occurs during the fetch
+     * @description This method requires user authorization (or a guest context).
+     * @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/users/getWishlist getWishlist} documentation.
+     */
+    getWishlist(): Promise<IWishlistResponse | IError>;
+    /**
+     * Replace the current user's or guest's wishlist.
+     * @handleName setWishlist
+     * @param {IWishlistSet} body - New wishlist contents. Example: `{ items: [{ productId: 1 }] }`.
+     * @returns {Promise<IWishlistResponse | IError>} Returns the updated wishlist.
+     * @throws {IError} When isShell=false and an error occurs during the fetch
+     * @description This method requires user authorization (or a guest context).
+     * @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/users/setWishlist setWishlist} documentation.
+     */
+    setWishlist(body: IWishlistSet): Promise<IWishlistResponse | IError>;
+    /**
+     * Add an item to the wishlist.
+     * @handleName addWishlistItem
+     * @param {IWishlistAddItem} body - Item to add. Example: `{ productId: 1 }`.
+     * @returns {Promise<IWishlistResponse | IError>} Returns the updated wishlist.
+     * @throws {IError} When isShell=false and an error occurs during the fetch
+     * @description This method requires user authorization (or a guest context).
+     * @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/users/addWishlistItem addWishlistItem} documentation.
+     */
+    addWishlistItem(body: IWishlistAddItem): Promise<IWishlistResponse | IError>;
+    /**
+     * Remove an item from the wishlist.
+     * @handleName removeWishlistItem
+     * @param {number} productId - Product identifier. Example: 12345.
+     * @returns {Promise<IWishlistResponse | IError>} Returns the updated wishlist.
+     * @throws {IError} When isShell=false and an error occurs during the fetch
+     * @description This method requires user authorization (or a guest context).
+     * @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/users/removeWishlistItem removeWishlistItem} documentation.
+     */
+    removeWishlistItem(productId: number): Promise<IWishlistResponse | IError>;
+    /**
+     * Semantic (vector) search for users.
+     * @handleName getUsersByVectorSearch
+     * @param {IUsersVectorSearch} body - Vector search body. Example: `{ queryText: "john" }`.
+     * @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<IUsersResponse | IError>} Returns an object with an array of found users and total count.
+     * @throws {IError} When isShell=false and an error occurs during the fetch
+     * @description This method performs a semantic (vector) search for users. It 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/users/getUsersByVectorSearch getUsersByVectorSearch} documentation.
+     */
+    getUsersByVectorSearch(body: IUsersVectorSearch, langCode?: string, offset?: number, limit?: number): Promise<IUsersResponse | IError>;
+}