@turinhub/tale-js-sdk 2.3.0 → 2.4.1

package/dist/app-client.d.ts

@@ -22,8 +22,9 @@ export declare function createTaleAppClient(options: TaleAppClientOptions): {
     auth: {
         login: (credentials: Parameters<typeof Auth.login>[0], request?: OptionalRequest<typeof Auth.login, 1>) => Promise<Auth.LoginResponse>;
         validateToken: (token: Parameters<typeof Auth.validateToken>[0], request?: OptionalRequest<typeof Auth.validateToken, 1>) => Promise<boolean>;
-        loginWithSms: (phone: Parameters<typeof Auth.loginWithSms>[0]) => Promise<Auth.SendSmsResponse>;
+        loginWithSms: (phone: Parameters<typeof Auth.loginWithSms>[0], request?: OptionalRequest<typeof Auth.loginWithSms, 1>) => Promise<Auth.SendSmsResponse>;
         verifySmsCode: (request: Parameters<typeof Auth.verifySmsCode>[0], optionsOverride?: OptionalRequest<typeof Auth.verifySmsCode, 1>) => Promise<Auth.SmsLoginResponse>;
+        verifyPasswordChangeSmsAndUpdatePassword: (request: Parameters<typeof Auth.verifyPasswordChangeSmsAndUpdatePassword>[0], optionsOverride?: OptionalRequest<typeof Auth.verifyPasswordChangeSmsAndUpdatePassword, 1>) => Promise<Auth.PasswordChangeSmsResponse>;
         registerWithSms: (request: Parameters<typeof Auth.registerWithSms>[0], optionsOverride?: OptionalRequest<typeof Auth.registerWithSms, 1>) => Promise<Auth.SmsLoginResponse>;
     };
     users: {

package/dist/app-client.js

@@ -24,8 +24,9 @@ export function createTaleAppClient(options) {
                 ...(request ?? {}),
                 baseUrl: options.baseUrl,
             }),
-            loginWithSms: (phone) => Auth.loginWithSms(phone, { appToken: options.appToken }),
+            loginWithSms: (phone, request) => Auth.loginWithSms(phone, mergeRequest(request)),
             verifySmsCode: (request, optionsOverride) => Auth.verifySmsCode(request, mergeRequest(optionsOverride)),
+            verifyPasswordChangeSmsAndUpdatePassword: (request, optionsOverride) => Auth.verifyPasswordChangeSmsAndUpdatePassword(request, mergeRequest(optionsOverride)),
             registerWithSms: (request, optionsOverride) => Auth.registerWithSms(request, mergeRequest(optionsOverride)),
         },
         users: {

package/dist/auth/index.d.ts

@@ -1,5 +1,5 @@
-import type { LoginRequest, LoginOptions, LoginWithSmsOptions, VerifySmsOptions, AppInfo, AuthUser, UserToken, AuthRole, AuthPrivilege, UserGroup, AuthUserLoginMethod, LoginResponse, LoginJson, SendSmsResponse, SendSmsJson, VerifySmsRequest, SmsLoginResponse, SmsLoginJson } from "./types.js";
-export type { LoginRequest, LoginOptions, LoginWithSmsOptions, VerifySmsOptions, AppInfo, AuthUser, UserToken, AuthRole, AuthPrivilege, UserGroup, AuthUserLoginMethod, LoginResponse, LoginJson, SendSmsResponse, SendSmsJson, VerifySmsRequest, SmsLoginResponse, SmsLoginJson, };
+import type { LoginRequest, LoginOptions, LoginWithSmsOptions, VerifySmsOptions, AppInfo, AuthUser, UserToken, AuthRole, AuthPrivilege, UserGroup, AuthUserLoginMethod, LoginResponse, LoginJson, LoginOrRegisterSmsType, PasswordChangeSmsType, PasswordChangeSmsSendType, SmsType, SendSmsResponse, SendSmsJson, VerifySmsRequest, PasswordChangeSmsRequest, PasswordChangeSmsResponse, PasswordChangeSmsJson, SmsLoginResponse, SmsLoginJson } from "./types.js";
+export type { LoginRequest, LoginOptions, LoginWithSmsOptions, VerifySmsOptions, AppInfo, AuthUser, UserToken, AuthRole, AuthPrivilege, UserGroup, AuthUserLoginMethod, LoginResponse, LoginJson, LoginOrRegisterSmsType, PasswordChangeSmsType, PasswordChangeSmsSendType, SmsType, SendSmsResponse, SendSmsJson, VerifySmsRequest, PasswordChangeSmsRequest, PasswordChangeSmsResponse, PasswordChangeSmsJson, SmsLoginResponse, SmsLoginJson, };
 /**
  * Authenticates a user with username and password.
  *
@@ -99,7 +99,7 @@ export declare function validateToken(token: string, options?: {
  * try {
  *   const result = await loginWithSms('+8613800138000');
  *   console.log('SMS sent:', result.smsId);
- *   console.log('Type:', result.type); // 'login' or 'register'
+ *   console.log('Type:', result.type); // 'login', 'register', or 'changePassword'
  * } catch (error) {
  *   console.error('SMS sending failed:', error.message);
  * }
@@ -134,6 +134,17 @@ export declare function loginWithSms(phone: string, options?: LoginWithSmsOption
  * ```
  */
 export declare function verifySmsCode(request: VerifySmsRequest, options?: VerifySmsOptions): Promise<SmsLoginResponse>;
+/**
+ * Verifies password-change SMS code and updates user password.
+ *
+ * @param request - Password change SMS verification request
+ * @param options - Optional configuration for the request
+ * @returns Promise resolving to password update result
+ * @throws {ConfigurationError} When required environment variables are missing
+ * @throws {ApiError} When verification or password update fails
+ * @throws {NetworkError} When network request fails
+ */
+export declare function verifyPasswordChangeSmsAndUpdatePassword(request: PasswordChangeSmsRequest, options?: VerifySmsOptions): Promise<PasswordChangeSmsResponse>;
 /**
  * Registers a new user with SMS verification and optional additional information.
  *

package/dist/auth/index.js

@@ -1,5 +1,16 @@
 import { getAppToken } from "../token.js";
 import { ApiError, ConfigurationError, NetworkError } from "../errors.js";
+const LOGIN_OR_REGISTER_SMS_TYPES = [
+    "login",
+    "register",
+];
+const PASSWORD_CHANGE_SMS_TYPES = [
+    "changePassword",
+    "reset_password",
+];
+const PASSWORD_CHANGE_SMS_SEND_TYPES = [
+    "changePassword",
+];
 /**
  * Authenticates a user with username and password.
  *
@@ -151,6 +162,7 @@ export async function login(credentials, options) {
         userPrivileges: responseData.userPrivileges || [],
         userGroups: responseData.userGroups || [],
         userLoginMethods: responseData.userLoginMethods || [],
+        userAttributes: responseData.userAttributes || [],
     };
     return loginResponse;
 }
@@ -224,7 +236,7 @@ export async function validateToken(token, options) {
  * try {
  *   const result = await loginWithSms('+8613800138000');
  *   console.log('SMS sent:', result.smsId);
- *   console.log('Type:', result.type); // 'login' or 'register'
+ *   console.log('Type:', result.type); // 'login', 'register', or 'changePassword'
  * } catch (error) {
  *   console.error('SMS sending failed:', error.message);
  * }
@@ -237,14 +249,21 @@ export async function loginWithSms(phone, options) {
     }
     // Determine base URL from environment variables
     const env = globalThis?.process?.env ?? import.meta?.env ?? undefined;
-    const base = env?.TALE_BASE_URL;
+    const base = options?.baseUrl ?? env?.TALE_BASE_URL;
     if (!base) {
         throw new ConfigurationError("Missing required environment variable: TALE_BASE_URL");
     }
+    if (options?.smsType &&
+        !PASSWORD_CHANGE_SMS_SEND_TYPES.includes(options.smsType)) {
+        throw new ApiError('smsType must be "changePassword"', 400, "9400");
+    }
     // Use provided app token or get one from token service
-    const authToken = options?.appToken ?? (await getAppToken());
+    const authToken = options?.appToken ?? (await getAppToken(options));
     const url = new URL(String(base).replace(/\/+$/, "") + "/auth/v2/sms/login-or-register");
     url.searchParams.append("phone", phone.trim());
+    if (options?.smsType) {
+        url.searchParams.append("smsType", options.smsType);
+    }
     let response;
     try {
         response = await globalThis.fetch(url.toString(), {
@@ -332,8 +351,9 @@ export async function verifySmsCode(request, options) {
     if (!request.smsId || request.smsId.trim() === "") {
         throw new ApiError("smsId is required", 400, "9400");
     }
-    if (!request.smsType || !["login", "register"].includes(request.smsType)) {
-        throw new ApiError('smsType must be "login" or "register"', 400, "9400");
+    if (!request.smsType ||
+        !LOGIN_OR_REGISTER_SMS_TYPES.includes(request.smsType)) {
+        throw new ApiError('smsType must be "login" or "register". Use verifyPasswordChangeSmsAndUpdatePassword for password changes', 400, "9400");
     }
     if (!request.verificationCode || request.verificationCode.trim() === "") {
         throw new ApiError("verificationCode is required", 400, "9400");
@@ -409,6 +429,91 @@ export async function verifySmsCode(request, options) {
     };
     return smsLoginResponse;
 }
+/**
+ * Verifies password-change SMS code and updates user password.
+ *
+ * @param request - Password change SMS verification request
+ * @param options - Optional configuration for the request
+ * @returns Promise resolving to password update result
+ * @throws {ConfigurationError} When required environment variables are missing
+ * @throws {ApiError} When verification or password update fails
+ * @throws {NetworkError} When network request fails
+ */
+export async function verifyPasswordChangeSmsAndUpdatePassword(request, options) {
+    if (!request.smsId || request.smsId.trim() === "") {
+        throw new ApiError("smsId is required", 400, "9400");
+    }
+    if (!request.smsType ||
+        !PASSWORD_CHANGE_SMS_TYPES.includes(request.smsType)) {
+        throw new ApiError('smsType must be "changePassword" or "reset_password"', 400, "9400");
+    }
+    if (!request.verificationCode || request.verificationCode.trim() === "") {
+        throw new ApiError("verificationCode is required", 400, "9400");
+    }
+    if (!request.passwordEncrypted ||
+        request.passwordEncrypted.trim() === "") {
+        throw new ApiError("passwordEncrypted is required", 400, "9400");
+    }
+    const env = globalThis?.process?.env ?? import.meta?.env ?? undefined;
+    const base = options?.baseUrl ?? env?.TALE_BASE_URL ?? undefined;
+    if (!base) {
+        throw new ConfigurationError("Missing required environment variable: TALE_BASE_URL");
+    }
+    const authToken = options?.appToken ?? (await getAppToken(options));
+    const url = String(base).replace(/\/+$/, "") + "/auth/v2/sms/password/verify";
+    const requestBody = {
+        smsId: request.smsId.trim(),
+        smsType: request.smsType,
+        verificationCode: request.verificationCode.trim(),
+        passwordEncrypted: request.passwordEncrypted,
+    };
+    let response;
+    try {
+        response = await globalThis.fetch(url, {
+            method: "POST",
+            headers: {
+                "x-t-token": authToken,
+                "Content-Type": "application/json",
+            },
+            body: JSON.stringify(requestBody),
+        });
+    }
+    catch (error) {
+        throw new NetworkError(`Failed to verify password change SMS: ${error instanceof Error ? error.message : "Unknown error"}`);
+    }
+    let json;
+    try {
+        const responseJson = await response.json();
+        json = responseJson;
+    }
+    catch (error) {
+        throw new ApiError(`Failed to parse password change SMS response: ${error instanceof Error ? error.message : "Invalid JSON"}`, response.status);
+    }
+    if (response.status === 400) {
+        const errorMsg = typeof json === "object" &&
+            json !== null &&
+            ("message" in json || "msg" in json)
+            ? String(json.message || json.msg)
+            : "Password change SMS verification failed";
+        throw new ApiError(errorMsg, response.status, "9400");
+    }
+    if (response.status === 403) {
+        throw new ApiError("Account is frozen or access forbidden", response.status, "9403");
+    }
+    if (!response.ok) {
+        const errorMsg = typeof json === "object" &&
+            json !== null &&
+            ("message" in json || "msg" in json)
+            ? String(json.message || json.msg)
+            : "Password change SMS verification failed";
+        throw new ApiError(errorMsg, response.status);
+    }
+    const responseData = json.data || json;
+    return {
+        success: true,
+        message: typeof responseData === "string" ? responseData : undefined,
+    };
+}
 /**
  * Registers a new user with SMS verification and optional additional information.
  *

package/dist/auth/types.d.ts

@@ -1,4 +1,5 @@
 import type { AppInfo, User, UserGroup, Role, Privilege, CommonOptions } from "../common/types.js";
+import type { UserAttributeItemDTO } from "../user-attribute/types.js";
 export type { AppInfo, UserGroup };
 /**
  * Auth user information (extends User with non-null remark)
@@ -68,6 +69,7 @@ export interface LoginResponse {
     userPrivileges: AuthPrivilege[];
     userGroups: UserGroup[];
     userLoginMethods: AuthUserLoginMethod[];
+    userAttributes?: UserAttributeItemDTO[];
 }
 export interface LoginJson {
     app: AppInfo;
@@ -77,9 +79,14 @@ export interface LoginJson {
     userPrivileges: AuthPrivilege[];
     userGroups: UserGroup[];
     userLoginMethods: AuthUserLoginMethod[];
+    userAttributes?: UserAttributeItemDTO[];
 }
-export interface LoginWithSmsOptions {
-    appToken?: string;
+export type SmsType = "login" | "register" | "changePassword";
+export type LoginOrRegisterSmsType = "login" | "register";
+export type PasswordChangeSmsType = "changePassword" | "reset_password";
+export type PasswordChangeSmsSendType = "changePassword";
+export interface LoginWithSmsOptions extends CommonOptions {
+    smsType?: PasswordChangeSmsSendType;
 }
 export interface VerifySmsOptions extends CommonOptions {
     deviceName?: string;
@@ -89,24 +96,40 @@ export interface VerifySmsOptions extends CommonOptions {
 export interface SendSmsResponse {
     appKey: string;
     phone: string;
-    type: "login" | "register";
+    type: SmsType;
     smsId: string;
     expiredAt: string;
 }
 export interface SendSmsJson {
     appKey: string;
     phone: string;
-    type: "login" | "register";
+    type: SmsType;
     smsId: string;
     expiredAt: string;
 }
 export interface VerifySmsRequest {
     smsId: string;
-    smsType: "login" | "register";
+    smsType: LoginOrRegisterSmsType;
     verificationCode: string;
     username?: string;
     passwordEncrypted?: string;
 }
+export interface PasswordChangeSmsRequest {
+    smsId: string;
+    smsType: PasswordChangeSmsType;
+    verificationCode: string;
+    passwordEncrypted: string;
+}
+export interface PasswordChangeSmsResponse {
+    success: boolean;
+    message?: string;
+}
+export interface PasswordChangeSmsJson {
+    data?: string;
+    code?: number;
+    msg?: string;
+    message?: string;
+}
 export interface SmsLoginResponse {
     app: AppInfo;
     user: AuthUser;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@turinhub/tale-js-sdk",
-  "version": "2.3.0",
+  "version": "2.4.1",
   "description": "Official TypeScript SDK for Tale backend services",
   "keywords": [
     "tale",