oneentry 1.0.142 → 1.0.144

package/dist/attribute-sets/attributeSetsSchemas.d.ts

@@ -0,0 +1,90 @@
+/**
+ * Validation schemas for AttributeSets module
+ * @description Zod schemas for validating attribute sets-related API responses
+ */
+import { z } from 'zod';
+/**
+ * List title schema for list and radioButton attributes
+ */
+export declare const ListTitleSchema: z.ZodObject<{
+    title: z.ZodString;
+    value: z.ZodUnion<readonly [z.ZodNumber, z.ZodString]>;
+    position: z.ZodUnion<readonly [z.ZodString, z.ZodNumber, z.ZodNull]>;
+    extended: z.ZodObject<{
+        value: z.ZodNullable<z.ZodString>;
+        type: z.ZodNullable<z.ZodString>;
+    }, z.core.$strip>;
+}, z.core.$strip>;
+/**
+ * Attribute entity schema (single attribute from a set)
+ */
+export declare const AttributeEntitySchema: z.ZodObject<{
+    type: z.ZodString;
+    value: z.ZodOptional<z.ZodAny>;
+    initialValue: z.ZodAny;
+    marker: z.ZodString;
+    position: z.ZodNumber;
+    listTitles: z.ZodOptional<z.ZodUnion<readonly [z.ZodArray<z.ZodAny>, z.ZodRecord<z.ZodString, z.ZodAny>]>>;
+    validators: z.ZodOptional<z.ZodUnion<readonly [z.ZodRecord<z.ZodString, z.ZodAny>, z.ZodArray<z.ZodAny>]>>;
+    localizeInfos: z.ZodUnion<readonly [z.ZodRecord<z.ZodString, z.ZodAny>, z.ZodArray<z.ZodAny>]>;
+    additionalFields: z.ZodOptional<z.ZodUnion<readonly [z.ZodRecord<z.ZodString, z.ZodAny>, z.ZodArray<z.ZodAny>]>>;
+    settings: z.ZodOptional<z.ZodUnion<readonly [z.ZodRecord<z.ZodString, z.ZodAny>, z.ZodArray<z.ZodAny>]>>;
+}, z.core.$strip>;
+/**
+ * Attribute set entity schema (attribute set object)
+ */
+export declare const AttributeSetEntitySchema: z.ZodObject<{
+    id: z.ZodNumber;
+    createdDate: z.ZodString;
+    updatedDate: z.ZodString;
+    version: z.ZodNumber;
+    identifier: z.ZodString;
+    typeId: z.ZodNumber;
+    title: z.ZodString;
+    schema: z.ZodObject<{}, z.core.$loose>;
+    isVisible: z.ZodBoolean;
+    properties: z.ZodObject<{}, z.core.$loose>;
+    type: z.ZodObject<{
+        id: z.ZodNumber;
+        type: z.ZodString;
+    }, z.core.$strip>;
+    position: z.ZodNumber;
+}, z.core.$strip>;
+/**
+ * Attributes response schema (for getAttributes method)
+ */
+export declare const AttributeSetsResponseSchema: z.ZodObject<{
+    total: z.ZodNumber;
+    items: z.ZodArray<z.ZodObject<{
+        id: z.ZodNumber;
+        createdDate: z.ZodString;
+        updatedDate: z.ZodString;
+        version: z.ZodNumber;
+        identifier: z.ZodString;
+        typeId: z.ZodNumber;
+        title: z.ZodString;
+        schema: z.ZodObject<{}, z.core.$loose>;
+        isVisible: z.ZodBoolean;
+        properties: z.ZodObject<{}, z.core.$loose>;
+        type: z.ZodObject<{
+            id: z.ZodNumber;
+            type: z.ZodString;
+        }, z.core.$strip>;
+        position: z.ZodNumber;
+    }, z.core.$strip>>;
+}, z.core.$strip>;
+/**
+ * Attributes array response schema (for getAttributesByMarker method)
+ */
+export declare const AttributesArrayResponseSchema: z.ZodArray<z.ZodObject<{
+    type: z.ZodString;
+    value: z.ZodOptional<z.ZodAny>;
+    initialValue: z.ZodAny;
+    marker: z.ZodString;
+    position: z.ZodNumber;
+    listTitles: z.ZodOptional<z.ZodUnion<readonly [z.ZodArray<z.ZodAny>, z.ZodRecord<z.ZodString, z.ZodAny>]>>;
+    validators: z.ZodOptional<z.ZodUnion<readonly [z.ZodRecord<z.ZodString, z.ZodAny>, z.ZodArray<z.ZodAny>]>>;
+    localizeInfos: z.ZodUnion<readonly [z.ZodRecord<z.ZodString, z.ZodAny>, z.ZodArray<z.ZodAny>]>;
+    additionalFields: z.ZodOptional<z.ZodUnion<readonly [z.ZodRecord<z.ZodString, z.ZodAny>, z.ZodArray<z.ZodAny>]>>;
+    settings: z.ZodOptional<z.ZodUnion<readonly [z.ZodRecord<z.ZodString, z.ZodAny>, z.ZodArray<z.ZodAny>]>>;
+}, z.core.$strip>>;

package/dist/attribute-sets/attributeSetsSchemas.js

@@ -0,0 +1,74 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.AttributesArrayResponseSchema = exports.AttributeSetsResponseSchema = exports.AttributeSetEntitySchema = exports.AttributeEntitySchema = exports.ListTitleSchema = void 0;
+/**
+ * Validation schemas for AttributeSets module
+ * @description Zod schemas for validating attribute sets-related API responses
+ */
+const zod_1 = require("zod");
+/**
+ * List title schema for list and radioButton attributes
+ */
+exports.ListTitleSchema = zod_1.z.object({
+    title: zod_1.z.string(),
+    value: zod_1.z.union([zod_1.z.number(), zod_1.z.string()]),
+    position: zod_1.z.union([zod_1.z.string(), zod_1.z.number(), zod_1.z.null()]),
+    extended: zod_1.z.object({
+        value: zod_1.z.string().nullable(),
+        type: zod_1.z.string().nullable(),
+    }),
+});
+/**
+ * Attribute entity schema (single attribute from a set)
+ */
+exports.AttributeEntitySchema = zod_1.z.object({
+    type: zod_1.z.string(),
+    value: zod_1.z.any().optional(),
+    initialValue: zod_1.z.any(),
+    marker: zod_1.z.string(),
+    position: zod_1.z.number(),
+    listTitles: zod_1.z
+        .union([zod_1.z.array(zod_1.z.any()), zod_1.z.record(zod_1.z.string(), zod_1.z.any())])
+        .optional(),
+    validators: zod_1.z
+        .union([zod_1.z.record(zod_1.z.string(), zod_1.z.any()), zod_1.z.array(zod_1.z.any())])
+        .optional(),
+    localizeInfos: zod_1.z.union([zod_1.z.record(zod_1.z.string(), zod_1.z.any()), zod_1.z.array(zod_1.z.any())]),
+    additionalFields: zod_1.z
+        .union([zod_1.z.record(zod_1.z.string(), zod_1.z.any()), zod_1.z.array(zod_1.z.any())])
+        .optional(),
+    settings: zod_1.z
+        .union([zod_1.z.record(zod_1.z.string(), zod_1.z.any()), zod_1.z.array(zod_1.z.any())])
+        .optional(),
+});
+/**
+ * Attribute set entity schema (attribute set object)
+ */
+exports.AttributeSetEntitySchema = zod_1.z.object({
+    id: zod_1.z.number(),
+    createdDate: zod_1.z.string(),
+    updatedDate: zod_1.z.string(),
+    version: zod_1.z.number(),
+    identifier: zod_1.z.string(),
+    typeId: zod_1.z.number(),
+    title: zod_1.z.string(),
+    schema: zod_1.z.object({}).passthrough(),
+    isVisible: zod_1.z.boolean(),
+    properties: zod_1.z.object({}).passthrough(),
+    type: zod_1.z.object({
+        id: zod_1.z.number(),
+        type: zod_1.z.string(),
+    }),
+    position: zod_1.z.number(),
+});
+/**
+ * Attributes response schema (for getAttributes method)
+ */
+exports.AttributeSetsResponseSchema = zod_1.z.object({
+    total: zod_1.z.number(),
+    items: zod_1.z.array(exports.AttributeSetEntitySchema),
+});
+/**
+ * Attributes array response schema (for getAttributesByMarker method)
+ */
+exports.AttributesArrayResponseSchema = zod_1.z.array(exports.AttributeEntitySchema);

package/dist/auth-provider/authProviderApi.d.ts

@@ -0,0 +1,249 @@
+import AsyncModules from '../base/asyncModules';
+import type StateModule from '../base/stateModule';
+import type { IError } from '../base/utils';
+import type { IActiveSession, IAuthEntity, IAuthPostBody, IAuthProvider, IAuthProvidersEntity, IOauthData, ISignUpData, ISignUpEntity } from './authProvidersInterfaces';
+/**
+ * Controllers for working with auth services.
+ * @handle /api/content/users-auth-providers
+ * @class AuthProviderApi
+ * @augments AsyncModules
+ * @implements {IAuthProvider}
+ * @description This class provides methods for user registration, authentication, and management of authentication providers.
+ */
+export default class AuthProviderApi extends AsyncModules implements IAuthProvider {
+    protected state: StateModule;
+    protected _url: string;
+    /**
+     * constructor
+     */
+    constructor(state: StateModule);
+    /**
+     * User registration.
+     * @handleName signUp
+     * @param {string} marker - The text identifier of the authorization provider. Example: "email".
+     * @param {ISignUpData} body - Request body.
+     * @example
+        {
+          "formIdentifier": "reg",
+          "authData": [
+            {
+              "marker": "login",
+              "value": "example@oneentry.cloud"
+            },
+            {
+              "marker": "password",
+              "value": "12345"
+            }
+          ],
+          "formData": [
+            {
+              "marker": "last_name",
+              "type": "string",
+              "value": "Name"
+            }
+          ],
+          "notificationData": {
+            "email": "example@oneentry.cloud",
+            "phonePush": ["+99999999999"],
+            "phoneSMS": "+99999999999"
+          }
+        }
+     * @param {string} body.formIdentifier - The identifier for the registration form. Example: "reg".
+     * @param {{ marker: string; value: string }[]} body.authData - An array of authentication data objects, each containing a marker and its corresponding value.
+     * @example
+        [
+          {
+            "marker": "login",
+            "value": "example@oneentry.cloud"
+          },
+          {
+            "marker": "password",
+            "value": "12345"
+          }
+        ]
+     * @param {IAuthFormData} body.formData - The form data for the registration, which can be a single object or an array of objects.
+     * @example
+        {
+          "marker": "last_name",
+          "type": "string",
+          "value": "Name"
+        }
+     * @param {object} body.notificationData - An object containing notification data, including email, phonePush, and phoneSMS.
+     * @example
+        {
+          "email": "example@oneentry.cloud",
+          "phonePush": ["+99999999999"],
+          "phoneSMS": "+99999999999"
+        }
+     * @param {string} body.notificationData.email - The email address to which the notification will be sent.
+     * @param {Array<string>} [body.notificationData.phonePush] - An array of phone numbers for push notifications. Optional.
+     * @param {string} [body.notificationData.phoneSMS] - The phone number for SMS notifications. Optional.
+     * @param {string} [langCode] - Language code. Default: "en_US".
+     * @returns {Promise<ISignUpEntity | IError>} Returns a user object.
+     * @throws {IError} When isShell=false and an error occurs during the fetch
+     * @description User registration (❗️For a provider with user activation, the activation code is sent through the corresponding user notification method).
+     */
+    signUp(marker: string, body: ISignUpData, langCode?: string): Promise<ISignUpEntity | IError>;
+    /**
+     * Getting a user activation code. The code is returned via the appropriate user notification method.
+     * @handleName generateCode
+     * @param {string} marker - The text identifier of the authorization provider. Example: "email".
+     * @param {string} userIdentifier - The text identifier of the user's object (user login). Example: "example@oneentry.cloud".
+     * @param {string} eventIdentifier - Text identifier of the event object for which the code is generated. Example: "user_registration".
+     * @returns {Promise<void | IError>} Returns void if the code is successfully generated, or an error object if there was an issue.
+     * @throws {IError} When isShell=false and an error occurs during the fetch
+     * @description Obtaining a code to activate the user.
+     */
+    generateCode(marker: string, userIdentifier: string, eventIdentifier: string): Promise<void | IError>;
+    /**
+     * User activation code verification. Returns true (if the code is correct) or false (if it is incorrect).
+     * @handleName checkCode
+     * @param {string} marker - The text identifier of the authorization provider. Example: "email".
+     * @param {string} userIdentifier  - The text identifier of the user's object (user login). Example: "example@oneentry.cloud".
+     * @param {string} eventIdentifier - Text identifier of the event object for which the code is generated. Example: "user_registration".
+     * @param {string} code - Service code. Example: "123456".
+     * @returns {Promise<boolean | IError>} Returns true if the code is correct, or an error object if there was an issue.
+     * @throws {IError} When isShell=false and an error occurs during the fetch
+     * @description Checking the user activation code
+     */
+    checkCode(marker: string, userIdentifier: string, eventIdentifier: string, code: string): Promise<boolean | IError>;
+    /**
+     * User activate.
+     * @handleName activateUser
+     * @param {string} marker - The text identifier of the authorization provider. Example: "email".
+     * @param {string} userIdentifier - The text identifier of the user's object (user login). Example: "example@oneentry.cloud".
+     * @param {string} code - Service code. Example: "123456".
+     * @returns {Promise<boolean | IError>} Returns true if the user was successfully activated, or an error object if there was an issue.
+     * @throws {IError} When isShell=false and an error occurs during the fetch
+     * @description User activation.
+     */
+    activateUser(marker: string, userIdentifier: string, code: string): Promise<boolean | IError>;
+    /**
+     * User authorization.
+     * @handleName auth
+     * @param {string} marker - The text identifier of the authorization provider. Example: "email".
+     * @param {IAuthPostBody} body - Objects contains auth information.
+     * @example
+        {
+          "authData": [
+            {
+              "marker": "login",
+              "value": "example@oneentry.cloud"
+            },
+            {
+              "marker": "password",
+              "value": "12345"
+            }
+          ]
+        }
+     * @param {{ marker: string; value: string | number }[]} body.authData - An array of authentication data objects, each containing a marker and its corresponding value.
+     * @example
+        [
+          {
+            "marker": "login",
+            "value": "user@example.com"
+          }
+        ]
+     * @param {string} body.authData[index].marker - The marker for the authentication data. Example: "login".
+     * @param {string} body.authData[index].value  - The value for the authentication data. Example: "user@example.com".
+     * @returns {Promise<IAuthEntity | IError>} Returns an auth entity object.
+     * @throws {IError} When isShell=false and an error occurs during the fetch
+     * @description User authorization.
+     */
+    auth(marker: string, body: IAuthPostBody): Promise<IAuthEntity | IError>;
+    /**
+     * Refresh token.
+     * @handleName refresh
+     * @param {string} marker - The text identifier of the authorization provider. Example: "email".
+     * @param {string} token - Refresh token. Example: "abcdef123456".
+     * @returns {Promise<IAuthEntity | IError>} Returns an auth entity object with the following values: accessToken, refreshToken, user, and other auth-related data.
+     * @throws {IError} When isShell=false and an error occurs during the fetch
+     * @description User token refresh.
+     */
+    refresh(marker: string, token: string): Promise<IAuthEntity | IError>;
+    /**
+     * User account logout.
+     * @handleName logout
+     * @param {string} marker - The text identifier of the authorization provider. Example: "email".
+     * @param {string} token - Refresh token. Example: "abcdef123456".
+     * @returns {Promise<boolean | IError>} Returns true if the logout was successful, 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}.
+     */
+    logout(marker: string, token: string): Promise<boolean | IError>;
+    /**
+     * Logout of user account on all devices.
+     * @handleName logoutAll
+     * @param {string} marker - The text identifier of the authorization provider. Example: "email".
+     * @returns {Promise<boolean | IError>} Returns true if the logout was successful, 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}.
+     */
+    logoutAll(marker: string): Promise<boolean | IError>;
+    /**
+     * Change password.
+     * @handleName changePassword
+     * @param {string} marker - The text identifier of the authorization provider. Example: "email".
+     * @param {string} userIdentifier - The text identifier of the user's object (user login). Example: "example@oneentry.cloud".
+     * @param {string} eventIdentifier - The text identifier of the event. Example: "reg".
+     * @param {string} type - Operation type (1 - for changing password, 2 - for recovery). Example: 1.
+     * @param {string} code - Service code. Example: "123456".
+     * @param {string} newPassword - New password. Example: "newPassword123".
+     * @param {string} [repeatPassword] - Optional variable contains repeat new password for validation. Example: "newPassword123".
+     * @returns {Promise<boolean | IError>} Returns true if the password was successfully changed, or an error object if there was an issue.
+     * @throws {IError} When isShell=false and an error occurs during the fetch
+     * @description User password change (only for tariffs with account activation and the Activation feature enabled).
+     */
+    changePassword(marker: string, userIdentifier: string, eventIdentifier: string, type: number, code: string, newPassword: string, repeatPassword?: string): Promise<boolean | IError>;
+    /**
+     * Get all auth providers objects.
+     * @handleName getAuthProviders
+     * @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<IAuthProvidersEntity[] | IError>} Returns an array of auth provider objects.
+     * @throws {IError} When isShell=false and an error occurs during the fetch
+     * @description Getting all objects of authorization providers.
+     */
+    getAuthProviders(langCode?: string, offset?: number, limit?: number): Promise<IAuthProvidersEntity[] | IError>;
+    /**
+     * Get one auth provider object by marker.
+     * @handleName getAuthProviderByMarker
+     * @param {string} marker - The text identifier of the authorization provider. Example: "email".
+     * @param {string} [langCode] - Language code. Default: "en_US".
+     * @returns {Promise<IAuthProvidersEntity | IError>} Returns an auth provider object.
+     * @throws {IError} When isShell=false and an error occurs during the fetch
+     * @description Getting a single authorization provider object by marker.
+     */
+    getAuthProviderByMarker(marker: string, langCode?: string): Promise<IAuthProvidersEntity | IError>;
+    /**
+     * Getting active user sessions data.
+     * @handleName getActiveSessionsByMarker
+     * @param {string} marker - The text identifier of the authorization provider. Example: "email".
+     * @returns {Promise<IActiveSession[] | IError>} Returns an auth provider object.
+     * @throws {IError} When isShell=false and an error occurs during the fetch
+     * @description Getting a single authorization provider object by marker.
+     */
+    getActiveSessionsByMarker(marker: string): Promise<IActiveSession[] | IError>;
+    /**
+     * User registration (authorization) via OAUTH.
+     * @handleName oauth
+     * @param {string} marker - The text identifier of the authorization provider. Example: "email".
+     * @param {IOauthData} body - Object contains OAuth information for registration.
+     * @example
+        {
+          "client_id": "34346983-luuct343473qdkqidjopdfp3eb3k4thp.apps.googleusercontent.com",
+          "client_secret": "43434343434",
+          "code": "4/0AVMBsJgwewewewewewei4D7T6E_fbswxnL3g",
+          "grant_type": "authorization_code",
+          "redirect_uri": "http://localhost:3000"
+        }
+     * @param {string} [langCode] - Language code. Default: "en_US".
+     * @returns {Promise<ISignUpEntity | IError>} Returns a user object.
+     * @throws {IError} When isShell=false and an error occurs during the fetch
+     * @description User registration (authorization) via OAUTH.
+     */
+    oauth(marker: string, body: IOauthData, langCode?: string): Promise<IAuthEntity | IError>;
+}