oneentry 1.0.159 → 1.0.161

package/esm/auth-provider/authProviderSchemas.d.ts

@@ -0,0 +1,124 @@
+/**
+ * Validation schemas for Auth Provider module
+ * @description Zod schemas for validating auth-related API responses
+ */
+import { z } from 'zod';
+/**
+ * Sign up response schema
+ * @description Schema for validating sign up response
+ */
+export declare const SignUpResponseSchema: z.ZodObject<{
+    id: z.ZodNumber;
+    updatedDate: z.ZodString;
+    version: z.ZodNumber;
+    identifier: z.ZodString;
+    isActive: z.ZodBoolean;
+    formData: z.ZodUnion<readonly [z.ZodArray<z.ZodAny>, z.ZodRecord<z.ZodString, z.ZodAny>]>;
+    notificationData: z.ZodObject<{
+        email: z.ZodString;
+        phonePush: z.ZodArray<z.ZodString>;
+        phoneSMS: z.ZodOptional<z.ZodString>;
+    }, z.core.$strip>;
+    locale: z.ZodOptional<z.ZodString>;
+    createdDate: z.ZodOptional<z.ZodString>;
+    importId: z.ZodNullable<z.ZodOptional<z.ZodAny>>;
+    deletedAt: z.ZodNullable<z.ZodOptional<z.ZodString>>;
+    isDeleted: z.ZodOptional<z.ZodBoolean>;
+    state: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodAny>>;
+    rating: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
+    attributeSetId: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
+    attributesSets: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
+}, z.core.$strip>;
+/**
+ * Auth response schema (login/refresh)
+ * @description Schema for validating auth response
+ */
+export declare const AuthResponseSchema: z.ZodObject<{
+    userIdentifier: z.ZodString;
+    authProviderIdentifier: z.ZodString;
+    accessToken: z.ZodString;
+    refreshToken: z.ZodString;
+}, z.core.$strip>;
+/**
+ * User response schema
+ * @description Schema for validating user response
+ */
+export declare const UserResponseSchema: z.ZodObject<{
+    id: z.ZodNumber;
+    identifier: z.ZodString;
+    authProviderIdentifier: z.ZodString;
+    formData: z.ZodUnion<readonly [z.ZodArray<z.ZodAny>, z.ZodRecord<z.ZodString, z.ZodAny>]>;
+    formIdentifier: z.ZodString;
+    total: z.ZodString;
+    groups: z.ZodArray<z.ZodUnion<readonly [z.ZodString, z.ZodNumber]>>;
+    state: z.ZodRecord<z.ZodString, z.ZodAny>;
+    moduleFormConfigs: z.ZodOptional<z.ZodArray<z.ZodAny>>;
+    rating: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
+}, z.core.$strip>;
+/**
+ * Auth provider entity schema
+ * @description Schema for validating auth provider entity
+ * Includes all fields returned by the API
+ */
+export declare const AuthProviderEntitySchema: z.ZodObject<{
+    id: z.ZodNumber;
+    identifier: z.ZodString;
+    type: z.ZodString;
+    formIdentifier: z.ZodNullable<z.ZodString>;
+    userGroupIdentifier: z.ZodString;
+    isActive: z.ZodBoolean;
+    isCheckCode: z.ZodBoolean;
+    version: z.ZodNumber;
+    localizeInfos: z.ZodRecord<z.ZodString, z.ZodAny>;
+    config: z.ZodRecord<z.ZodString, z.ZodAny>;
+}, z.core.$strip>;
+/**
+ * Auth providers list response schema
+ * @description Schema for validating auth providers list response
+ */
+export declare const AuthProvidersResponseSchema: z.ZodArray<z.ZodObject<{
+    id: z.ZodNumber;
+    identifier: z.ZodString;
+    type: z.ZodString;
+    formIdentifier: z.ZodNullable<z.ZodString>;
+    userGroupIdentifier: z.ZodString;
+    isActive: z.ZodBoolean;
+    isCheckCode: z.ZodBoolean;
+    version: z.ZodNumber;
+    localizeInfos: z.ZodRecord<z.ZodString, z.ZodAny>;
+    config: z.ZodRecord<z.ZodString, z.ZodAny>;
+}, z.core.$strip>>;
+/**
+ * Generate code response schema
+ * @description Schema for validating generate code response
+ */
+export declare const GenerateCodeResponseSchema: z.ZodObject<{
+    success: z.ZodBoolean;
+    message: z.ZodOptional<z.ZodString>;
+}, z.core.$strip>;
+/**
+ * Logout response schema
+ * @description Schema for validating logout response
+ */
+export declare const LogoutResponseSchema: z.ZodObject<{
+    success: z.ZodBoolean;
+    message: z.ZodOptional<z.ZodString>;
+}, z.core.$strip>;
+/**
+ * Active sessions response schema
+ * @description Schema for validating active sessions response
+ */
+export declare const ActiveSessionSchema: z.ZodObject<{
+    deviceInfo: z.ZodObject<{
+        os: z.ZodString;
+        browser: z.ZodString;
+        location: z.ZodString;
+    }, z.core.$strip>;
+}, z.core.$strip>;
+export declare const ActiveSessionsResponseSchema: z.ZodArray<z.ZodObject<{
+    deviceInfo: z.ZodObject<{
+        os: z.ZodString;
+        browser: z.ZodString;
+        location: z.ZodString;
+    }, z.core.$strip>;
+}, z.core.$strip>>;

package/esm/auth-provider/authProviderSchemas.js

@@ -0,0 +1,92 @@
+/**
+ * Validation schemas for Auth Provider module
+ * @description Zod schemas for validating auth-related API responses
+ */
+import { z } from 'zod';
+import { AuthEntitySchema, UserEntitySchema } from '../base/validation.js';
+/**
+ * Sign up response schema
+ * @description Schema for validating sign up response
+ */
+export const SignUpResponseSchema = z.object({
+    id: z.number(),
+    updatedDate: z.string(),
+    version: z.number(),
+    identifier: z.string(),
+    isActive: z.boolean(),
+    formData: z.union([z.array(z.any()), z.record(z.string(), z.any())]),
+    notificationData: z.object({
+        email: z.string(),
+        phonePush: z.array(z.string()),
+        phoneSMS: z.string().optional(),
+    }),
+    locale: z.string().optional(),
+    createdDate: z.string().optional(),
+    importId: z.any().optional().nullable(),
+    deletedAt: z.string().optional().nullable(),
+    isDeleted: z.boolean().optional(),
+    state: z.record(z.string(), z.any()).optional(),
+    rating: z.record(z.string(), z.unknown()).optional(),
+    attributeSetId: z.number().nullable().optional(),
+    attributesSets: z.record(z.string(), z.unknown()).optional(),
+});
+/**
+ * Auth response schema (login/refresh)
+ * @description Schema for validating auth response
+ */
+export const AuthResponseSchema = AuthEntitySchema;
+/**
+ * User response schema
+ * @description Schema for validating user response
+ */
+export const UserResponseSchema = UserEntitySchema;
+/**
+ * Auth provider entity schema
+ * @description Schema for validating auth provider entity
+ * Includes all fields returned by the API
+ */
+export const AuthProviderEntitySchema = z.object({
+    id: z.number(),
+    identifier: z.string(),
+    type: z.string(),
+    formIdentifier: z.string().nullable(),
+    userGroupIdentifier: z.string(),
+    isActive: z.boolean(),
+    isCheckCode: z.boolean(),
+    version: z.number(),
+    localizeInfos: z.record(z.string(), z.any()),
+    config: z.record(z.string(), z.any()),
+});
+/**
+ * Auth providers list response schema
+ * @description Schema for validating auth providers list response
+ */
+export const AuthProvidersResponseSchema = z.array(AuthProviderEntitySchema);
+/**
+ * Generate code response schema
+ * @description Schema for validating generate code response
+ */
+export const GenerateCodeResponseSchema = z.object({
+    success: z.boolean(),
+    message: z.string().optional(),
+});
+/**
+ * Logout response schema
+ * @description Schema for validating logout response
+ */
+export const LogoutResponseSchema = z.object({
+    success: z.boolean(),
+    message: z.string().optional(),
+});
+/**
+ * Active sessions response schema
+ * @description Schema for validating active sessions response
+ */
+export const ActiveSessionSchema = z.object({
+    deviceInfo: z.object({
+        os: z.string(),
+        browser: z.string(),
+        location: z.string(),
+    }),
+});
+export const ActiveSessionsResponseSchema = z.array(ActiveSessionSchema);

package/esm/auth-provider/authProvidersInterfaces.d.ts

@@ -0,0 +1,430 @@
+import type { IError, ILocalizeInfo, IRating } from '../base/utils.js';
+/**
+ * @interface IAuthProvider
+ * @description This interface defines methods for user authentication and registration through various auth providers.
+ */
+interface IAuthProvider {
+    /**
+     * Registers a new user.
+     * @handleName signUp
+     * @param {string} marker - The marker identifying the auth provider. Example: "email".
+     * @param {ISignUpData} data - The data required for user registration.
+     * @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} [langCode] - Optional language code for localization. Default: "en_US".
+     * @returns {ISignUpEntity} A promise that resolves to a sign-up entity or an error.
+     * @throws {IError} - If there is an error during the fetch operation, it will return an error object.
+     * @description This method registers a new user.
+     */
+    signUp(marker: string, data: ISignUpData, langCode?: string): Promise<ISignUpEntity | IError>;
+    /**
+     * Generates an activation code for a user.
+     * @handleName generateCode
+     * @param {string} marker - The marker identifying the auth provider. Example: "email".
+     * @param {string} userIdentifier - The user's identifier. Example: "example@oneentry.cloud".
+     * @param {string} eventIdentifier - The event identifier related to the code generation. Example: "user_registration".
+     * @returns {void} A promise that resolves to void or an error.
+     * @throws {IError} - If there is an error during the fetch operation, it will return an error object.
+     * @description This method generates an activation code for a user.
+     */
+    generateCode(marker: string, userIdentifier: string, eventIdentifier: string): Promise<void | IError>;
+    /**
+     * Verifies a user activation code.
+     * @handleName checkCode
+     * @param {string} marker - The marker identifying the auth provider. Example: "email".
+     * @param {string} userIdentifier - The user's identifier. Example: "example@oneentry.cloud".
+     * @param {string} eventIdentifier - The event identifier related to the code verification. Example: "user_registration".
+     * @param {string} code - The activation code to verify. Example: "123456".
+     * @returns {boolean} A promise that resolves to a boolean indicating success or failure, or an error.
+     * @throws {IError} - If there is an error during the fetch operation, it will return an error object.
+     * @description This method verifies a user activation code.
+     */
+    checkCode(marker: string, userIdentifier: string, eventIdentifier: string, code: string): Promise<boolean | IError>;
+    /**
+     * Activates a user account.
+     * @handleName activateUser
+     * @param {string} marker - The marker identifying the auth provider. Example: "email".
+     * @param {string} userIdentifier - The user's identifier. Example: "example@oneentry.cloud".
+     * @param {string} code - The activation code. Example: "123456".
+     * @returns {boolean} A promise that resolves to a boolean indicating success or failure, or an error.
+     * @throws {IError} - If there is an error during the fetch operation, it will return an error object.
+     * @description This method activates a user account.
+     */
+    activateUser(marker: string, userIdentifier: string, code: string): Promise<boolean | IError>;
+    /**
+     * Authorizes a user.
+     * @handleName auth
+     * @param {string} marker - The marker identifying the auth provider. Example: "email".
+     * @param {IAuthPostBody} data - The data required for user authorization. Example: .
+     * @returns {IAuthEntity} A promise that resolves to an auth entity or an error.
+     * @throws {IError} - If there is an error during the fetch operation, it will return an error object.
+     * @description This method authorizes a user.
+     */
+    auth(marker: string, data: IAuthPostBody): Promise<IAuthEntity | IError>;
+    /**
+     * Refreshes a user's access token.
+     * @handleName refresh
+     * @param {string} marker - The marker identifying the auth provider. Example: "email".
+     * @param {string} token - The refresh token. Example: "abcdef123456".
+     * @returns {IAuthEntity} A promise that resolves to an auth entity or an error.
+     * @throws {IError} - If there is an error during the fetch operation, it will return an error object.
+     * @description This method refreshes a user's access token.
+     */
+    refresh(marker: string, token: string): Promise<IAuthEntity | IError>;
+    /**
+     * Logs out a user.
+     * @handleName logout
+     * @param {string} marker - The marker identifying the auth provider. Example: "email".
+     * @param {string} token - The access token. Example: "abcdef123456".
+     * @returns {boolean} A promise that resolves to a boolean indicating success or failure, or an error.
+     * @throws {IError} - If there is an error during the fetch operation, it will return an error object.
+     * @description This method logs out a user.
+     */
+    logout(marker: string, token: string): Promise<boolean | IError>;
+    /**
+     * Logout of user account on all devices.
+     * @handleName logoutAll
+     * @param {string} marker - The marker identifying the auth provider. Example: "email".
+     * @returns {boolean} A promise that resolves to a boolean indicating success or failure, or an error.
+     * @throws {IError} - If there is an error during the fetch operation, it will return an error object.
+     * @description This method logs out a user account on all devices.
+     */
+    logoutAll(marker: string): Promise<boolean | IError>;
+    /**
+     * Changes a user's password.
+     * @handleName changePassword
+     * @param {string} marker - The marker identifying the auth provider. Example: "email".
+     * @param {string} userIdentifier - The user's identifier. Example: "example@oneentry.cloud".
+     * @param {string} eventIdentifier - The event identifier. Example: "reg".
+     * @param {number} type - The type of password change. 1 for changing password, 2 for recovery. Example: 1.
+     * @param {string} code - The code for password change verification. Example: "123456".
+     * @param {string} newPassword - The new password. Example: "newPassword123".
+     * @param {string} [repeatPassword] - Optional repeat of the new password for confirmation. Example: "newPassword123".
+     * @returns {boolean} A promise that resolves to a boolean indicating success or failure, or an error.
+     * @throws {IError} - If there is an error during the fetch operation, it will return an error object.
+     * @description This method changes a user's password.
+     */
+    changePassword(marker: string, userIdentifier: string, eventIdentifier: string, type: number, code: string, newPassword: string, repeatPassword?: string): Promise<boolean | IError>;
+    /**
+     * Retrieves all authentication providers.
+     * @handleName getAuthProviders
+     * @param {string} [langCode] - Optional language code for localization. Default: "en_US".
+     * @param {number} [offset] - Optional offset for pagination. Default: 0.
+     * @param {number} [limit] - Optional limit for pagination. Default: 30.
+     * @returns {IAuthProvidersEntity[]} A promise that resolves to an array of auth provider entities or an error.
+     * @throws {IError} - If there is an error during the fetch operation, it will return an error object.
+     * @description This method retrieves all authentication providers.
+     */
+    getAuthProviders(langCode?: string, offset?: number, limit?: number): Promise<IAuthProvidersEntity[] | IError>;
+    /**
+     * Retrieves a specific auth provider by its marker.
+     * @handleName getAuthProviderByMarker
+     * @param {string} marker - The marker identifying the auth provider. Example: "email".
+     * @param {string} [langCode] - Optional language code for localization. Default: "en_US".
+     * @returns {IAuthProvidersEntity} A promise that resolves to an auth provider entity or an error.
+     * @throws {IError} - If there is an error during the fetch operation, it will return an error object.
+     * @description This method retrieves a specific auth provider by its marker.
+     */
+    getAuthProviderByMarker(marker: string, langCode?: string): Promise<IAuthProvidersEntity | IError>;
+    /**
+     * Retrieves active user sessions data object.
+     * @handleName getActiveSessionsByMarker
+     * @param {string} marker - The marker identifying the auth provider. Example: "email".
+     * @returns {Promise<IActiveSession[] | IError>} A promise that resolves to active user sessions data object.
+     * @throws {IError} - If there is an error during the fetch operation, it will return an error object.
+     * @description This method retrieves active user sessions data object.
+     */
+    getActiveSessionsByMarker(marker: string): Promise<IActiveSession[] | IError>;
+    /**
+     * User registration (authorization) via OAUTH.
+     * @handleName oauthSignUp
+     * @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 {ISignUpEntity} Returns a user object.
+     * @throws {IError} - If there is an error during the fetch operation, it will return an error object.
+     * @description User registration (authorization) via OAUTH.
+     */
+    oauth(marker: string, body: IOauthData, langCode?: string): Promise<IAuthEntity | IError>;
+}
+/**
+ * Interface representing the structure of authentication form data.
+ * @interface IAuthFormData
+ * @property {string} marker - A unique identifier for the form field. Example: "email".
+ * @property {string} type - The type of the form field, such as 'string', 'email', etc. Example: "string".
+ * @property {string} value - The value entered in the form field. Example: "example@oneentry.cloud".
+ * @description This interface defines the structure of authentication form data used in user registration and authentication processes.
+ */
+interface IAuthFormData {
+    marker: string;
+    type: string;
+    value: string;
+}
+/**
+ * Interface representing the data required for user registration.
+ * @interface ISignUpData
+ * @property {string} formIdentifier - The identifier for the registration form. Example: "reg".
+ * @property {string} [langCode] - Language code. Default: "en_US".
+ * @property {Array} authData - An array of authentication data objects, each containing a marker and its corresponding value.
+ * @property {IAuthFormData | IAuthFormData[]} formData - The form data for the registration.
+ * @property {INotificationData} notificationData - An object containing notification data, including email, phonePush, and phoneSMS.
+ * @description User registration (❗️For a provider with user activation, the activation code is sent through the corresponding user notification method).
+ */
+interface ISignUpData {
+    formIdentifier: string;
+    langCode?: string;
+    authData: IAuthData[];
+    formData: IAuthFormData | IAuthFormData[];
+    notificationData: INotificationData;
+}
+/**
+ * @interface INotificationData
+ * @property {string} email - User's email used for notifications. Example: "example@oneentry.cloud".
+ * @property {string[]} phonePush - Phone numbers used for push notifications. Example: ["+19999999999"].
+ * @property {string} [phoneSMS] - Phone number used for SMS notifications. Example: "+19999999999".
+ * @description Notification channels configured for a user.
+ */
+interface INotificationData {
+    email: string;
+    phonePush: string[];
+    phoneSMS?: string;
+}
+/**
+ * Interface representing the data required for user registration via OAUTH.
+ * @interface IOauthData
+ * @property {string} client_id - The client ID for the OAuth application. Example: "34346983-luuct343473qdkqidjopdfp3eb3k4thp.apps.googleusercontent.com".
+ * @property {string} client_secret - The client secret for the OAuth application. Example: "43434343434".
+ * @property {string} code - The authorization code received from the OAuth provider. Example: "4/0AVMBsJgwewewewewewei4D7T6E_fbswxnL3g".
+ * @property {string} grant_type - The grant type for the OAuth request. Example: "authorization_code".
+ * @property {string} redirect_uri - The redirect URI for the OAuth application. Example: "http://localhost:3000".
+ * @description User registration (❗️For a provider with user activation, the activation code is sent through the corresponding user notification method).
+ */
+interface IOauthData {
+    client_id: string;
+    client_secret: string;
+    code: string;
+    grant_type: string;
+    redirect_uri: string;
+}
+/**
+ * Interface representing a sign-up entity.
+ * @interface ISignUpEntity
+ * @property {number} id - The unique identifier of the sign-up entity. Example: 12345.
+ * @property {string} updatedDate - The date when the sign-up entity was last updated. Example: "2023-10-01T12:00:00Z".
+ * @property {number} version - The version number of the sign-up entity. Example: 1.
+ * @property {string} identifier - A unique string that identifies the sign-up entity. Example: "signup_12345".
+ * @property {boolean} isActive - Indicates whether the sign-up entity is active. Example: true.
+ * @property {IAuthFormData[]} formData - Form data array.
+ * @example
+    [
+      {
+        "marker": "first_name",
+        "value": "John"
+      }
+    ]
+ * @property {INotificationData} notificationData - An object containing notification data, including email, phonePush, and phoneSMS.
+ * @example
+    {
+      "email": "example@oneentry.cloud",
+      "phonePush": ["+99999999999"],
+      "phoneSMS": "+99999999999"
+    }
+ * @property {string} [locale] - The locale or language code associated with the sign-up entity. Example: "en_US".
+ * @property {string} [createdDate] - The date when the sign-up entity was created. Example: "2023-10-01T12:00:00Z".
+ * @property {unknown} [importId] - Import identifier. Example: null.
+ * @property {string | null} [deletedAt] - Deletion date or null. Example: null.
+ * @property {boolean} [isDeleted] - Whether the entity is deleted. Example: false.
+ * @property {Record<string, unknown>} [state] - Additional state information. Example: {}.
+ * @property {IRating} [rating] - Rating data.
+ * @property {number | null} [attributeSetId] - Identifier of the attribute set attached to the user, or null when none is attached. Example: null.
+ * @property {Record<string, unknown>} [attributesSets] - Attribute sets attached to the user, keyed by marker; empty object when none. Example: {}.
+ * @description This interface defines the structure of a sign-up entity.
+ */
+interface ISignUpEntity {
+    id: number;
+    updatedDate: string;
+    version: number;
+    identifier: string;
+    isActive: boolean;
+    formData: IAuthFormData[];
+    notificationData: INotificationData;
+    locale?: string;
+    createdDate?: string;
+    importId?: unknown;
+    deletedAt?: string | null;
+    isDeleted?: boolean;
+    state?: Record<string, unknown>;
+    rating?: IRating;
+    attributeSetId?: number | null;
+    attributesSets?: Record<string, unknown>;
+}
+/**
+ * Interface representing a code entity used for user registration or verification processes.
+ * @interface ICodeEntity
+ * @property {string} code - The activation code for user registration or verification. Example: "123456".
+ * @property {string} expiredDate - The date when the activation code expires. Example: "2023-10-01T12:00:00Z".
+ * @description This interface defines the structure of a code entity used for user registration or verification processes.
+ */
+interface ICodeEntity {
+    code: string;
+    expiredDate: string;
+}
+/**
+ * Interface representing an authentication entity.
+ * @interface IAuthEntity
+ * @property {string} userIdentifier - The unique identifier for the user. Example: "user12345".
+ * @property {string} authProviderIdentifier - The identifier for the authentication provider. Example: "email".
+ * @property {string} accessToken - The access token for the user session. Example: "abcdef123456".
+ * @property {string} refreshToken - The refresh token for renewing the access token. Example: "ghijkl789012".
+ * @description This interface defines the structure of an authentication entity.
+ */
+interface IAuthEntity {
+    userIdentifier: string;
+    authProviderIdentifier: string;
+    accessToken: string;
+    refreshToken: string;
+}
+/**
+ * Interface representing an authentication provider entity.
+ * @interface IAuthProvidersEntity
+ * @property {number} id - The unique identifier of the auth provider entity. Example: 194.
+ * @property {ILocalizeInfo} localizeInfos - Localized information for the auth provider.
+ * @example
+    {
+      "key": "value"
+    }
+ * @property {IAuthProvidersEntityConfig} config - Configuration settings for the auth provider, stored as a key-value pair object.
+ * @example
+    {
+      "key": "value"
+    }
+ * @property {number} version - The version number of the auth provider entity. Example: 1.
+ * @property {string} identifier - A unique string that identifies the auth provider. Example: "email".
+ * @property {string} type - The type of the auth provider (e.g., 'email', 'google', etc.). Example: "email".
+ * @property {string | null} formIdentifier - The identifier for the form associated with the auth provider, or null if not applicable. Example: "reg_form".
+ * @property {string} userGroupIdentifier - The identifier for the userGroup associated with the auth provider. Example: "guest".
+ * @property {boolean} isActive - Indicates whether the auth provider is active. Example: true.
+ * @property {boolean} isCheckCode - Indicates whether the auth provider requires code verification. Example: false.
+ * @description This interface defines the structure of an authentication provider entity.
+ */
+interface IAuthProvidersEntity {
+    id: number;
+    localizeInfos: ILocalizeInfo;
+    config: IAuthProvidersEntityConfig;
+    version: number;
+    identifier: string;
+    type: string;
+    formIdentifier: string | null;
+    userGroupIdentifier: string;
+    isActive: boolean;
+    isCheckCode: boolean;
+}
+/**
+ * Interface representing an authentication provider config.
+ * @interface IAuthProvidersEntityConfig
+ * @property {string} accessTokenTtlSec - Access token time to live in seconds. Example: "3600".
+ * @property {string} refreshTokenTtlMc - Refresh token time to live in milliseconds. Example: "86400000".
+ * @property {string} deleteNoneActiveUsersAfterDays - Delete none active users after days. Example: "30".
+ * @property {string} systemCodeTlsSec - System code time to live in seconds. Example: "86400".
+ * @property {string} systemCodeLength - System code length. Example: "6".
+ * @property {string | null} oauthAuthUrl - OAuth authorization URL. Example: null.
+ * @property {string | null} systemCodeOnlyNumbers - System code only numbers flag. Example: null.
+ */
+interface IAuthProvidersEntityConfig {
+    accessTokenTtlSec: string;
+    refreshTokenTtlMc: string;
+    deleteNoneActiveUsersAfterDays: string;
+    systemCodeTlsSec: string;
+    systemCodeLength: string;
+    oauthAuthUrl: string | null;
+    systemCodeOnlyNumbers: string | null;
+}
+/**
+ * Authentication data object.
+ * @interface IAuthData
+ * @property {string} marker - The marker identifying the auth field. Example: "login".
+ * @property {string} value - The value of the auth field. Example: "user@example.com".
+ */
+interface IAuthData {
+    marker: string;
+    value: string;
+}
+/**
+ * Interface representing the body used in authentication requests.
+ * @interface IAuthPostBody
+ * @property {IAuthData[]} authData - An array of authentication data objects, each containing a marker and its corresponding value.
+ * @example
+    [
+      {
+        "marker": "login",
+        "value": "user@example.com"
+      }
+    ]
+ * @description This interface defines the structure of the body used in authentication requests, containing an array of authentication data.
+ */
+interface IAuthPostBody {
+    authData: IAuthData[];
+}
+/**
+ * Interface representing the active session data.
+ * @interface IActiveSession
+ * @property {object} deviceInfo - Information about the device used in the active session.
+ * @example
+    {
+      "os": "Win32",
+      "browser": "Node.js/22",
+      "location": "ru-RU"
+    }
+ * @property {string} deviceInfo.os - The operating system of the active session. Example: "Win32".
+ * @property {string} deviceInfo.browser - The browser used in the active session. Example: "Node.js/22".
+ * @property {string} deviceInfo.location - The location of the active session. Example: "ru-RU".
+ * @description This interface defines the structure of the body used in authentication requests, containing an array of authentication data.
+ */
+interface IActiveSession {
+    deviceInfo: IDeviceInfo;
+}
+/**
+ * @interface IDeviceInfo
+ * @property {string} os - The operating system of the active session. Example: "Win32".
+ * @property {string} browser - The browser used in the active session. Example: "Node.js/22".
+ * @property {string} location - The locale of the active session. Example: "ru-RU".
+ * @description Information about the device tied to an active authentication session.
+ */
+interface IDeviceInfo {
+    os: string;
+    browser: string;
+    location: string;
+}
+export type { IActiveSession, IAuthData, IAuthEntity, IAuthFormData, IAuthPostBody, IAuthProvider, IAuthProvidersEntity, ICodeEntity, IDeviceInfo, INotificationData, IOauthData, ISignUpData, ISignUpEntity, };

package/esm/auth-provider/authProvidersInterfaces.js

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