@fnd-platform/cognito-auth 1.0.0-alpha.1 → 1.0.0-alpha.3

package/lib/client/auth-client.d.ts

@@ -6,7 +6,7 @@
  *
  * @packageDocumentation
  */
-import type { AuthClientConfig, AuthTokens, SignUpResult } from '../types.js';
+import type { AuthClientConfig, AuthTokens, SignUpResult, ForgotPasswordResult } from '../types.js';
 /**
  * Clears the client cache. Useful for testing.
  */
@@ -35,97 +35,154 @@ export declare function clearClientCache(): void;
  * ```
  */
 export declare class FndAuthClient {
-  private readonly client;
-  private readonly clientId;
-  /**
-   * Creates a new FndAuthClient.
-   *
-   * @param config - Configuration for the auth client
-   */
-  constructor(config: AuthClientConfig);
-  /**
-   * Signs in a user with email and password.
-   *
-   * @param email - User's email address
-   * @param password - User's password
-   * @returns Authentication tokens
-   * @throws {AuthError} If authentication fails
-   *
-   * @example
-   * ```typescript
-   * try {
-   *   const tokens = await authClient.signIn('user@example.com', 'password');
-   *   console.log('Logged in!', tokens.accessToken);
-   * } catch (error) {
-   *   if (error instanceof AuthError && error.code === 'USER_NOT_CONFIRMED') {
-   *     // Redirect to confirmation page
-   *   }
-   * }
-   * ```
-   */
-  signIn(email: string, password: string): Promise<AuthTokens>;
-  /**
-   * Signs up a new user.
-   *
-   * @param email - User's email address
-   * @param password - User's password
-   * @param name - Optional user's name
-   * @returns Sign-up result with confirmation status
-   * @throws {AuthError} If sign-up fails
-   *
-   * @example
-   * ```typescript
-   * const result = await authClient.signUp('user@example.com', 'password', 'John Doe');
-   * if (!result.userConfirmed) {
-   *   // Show confirmation code input
-   *   console.log(`Code sent to ${result.codeDeliveryDetails?.destination}`);
-   * }
-   * ```
-   */
-  signUp(email: string, password: string, name?: string): Promise<SignUpResult>;
-  /**
-   * Confirms a user's sign-up with the verification code.
-   *
-   * @param email - User's email address
-   * @param code - Verification code from email/SMS
-   * @throws {AuthError} If confirmation fails
-   *
-   * @example
-   * ```typescript
-   * await authClient.confirmSignUp('user@example.com', '123456');
-   * // User is now confirmed, can sign in
-   * ```
-   */
-  confirmSignUp(email: string, code: string): Promise<void>;
-  /**
-   * Refreshes authentication tokens using a refresh token.
-   *
-   * @param refreshToken - The refresh token from a previous authentication
-   * @returns New authentication tokens
-   * @throws {AuthError} If refresh fails
-   *
-   * @example
-   * ```typescript
-   * // When access token is about to expire
-   * const newTokens = await authClient.refreshTokens(tokens.refreshToken);
-   * ```
-   */
-  refreshTokens(refreshToken: string): Promise<AuthTokens>;
-  /**
-   * Signs out the user from all devices.
-   *
-   * This invalidates all refresh tokens for the user, effectively
-   * signing them out from all devices.
-   *
-   * @param accessToken - The user's current access token
-   * @throws {AuthError} If sign-out fails
-   *
-   * @example
-   * ```typescript
-   * await authClient.signOut(tokens.accessToken);
-   * // User is now signed out from all devices
-   * ```
-   */
-  signOut(accessToken: string): Promise<void>;
+    private readonly client;
+    private readonly clientId;
+    /**
+     * Creates a new FndAuthClient.
+     *
+     * @param config - Configuration for the auth client
+     */
+    constructor(config: AuthClientConfig);
+    /**
+     * Signs in a user with email and password.
+     *
+     * @param email - User's email address
+     * @param password - User's password
+     * @returns Authentication tokens
+     * @throws {AuthError} If authentication fails
+     * @throws {NewPasswordRequiredError} If user must change password first
+     *
+     * @example
+     * ```typescript
+     * try {
+     *   const tokens = await authClient.signIn('user@example.com', 'password');
+     *   console.log('Logged in!', tokens.accessToken);
+     * } catch (error) {
+     *   if (error instanceof NewPasswordRequiredError) {
+     *     // Redirect to change password page
+     *     redirect(`/change-password?session=${error.session}&email=${email}`);
+     *   } else if (error instanceof AuthError && error.code === 'USER_NOT_CONFIRMED') {
+     *     // Redirect to confirmation page
+     *   }
+     * }
+     * ```
+     */
+    signIn(email: string, password: string): Promise<AuthTokens>;
+    /**
+     * Completes password change for users with FORCE_CHANGE_PASSWORD status.
+     *
+     * Use this after catching NewPasswordRequiredError from signIn().
+     *
+     * @param email - User's email address
+     * @param newPassword - New password to set
+     * @param session - Session token from NewPasswordRequiredError
+     * @returns Authentication tokens
+     * @throws {AuthError} If password change fails
+     *
+     * @example
+     * ```typescript
+     * // After catching NewPasswordRequiredError
+     * const tokens = await authClient.completeNewPassword(
+     *   email,
+     *   newPassword,
+     *   error.session
+     * );
+     * ```
+     */
+    completeNewPassword(email: string, newPassword: string, session: string): Promise<AuthTokens>;
+    /**
+     * Initiates forgot password flow.
+     *
+     * Sends a verification code to the user's email for password reset.
+     *
+     * @param email - User's email address
+     * @returns Delivery details for the reset code
+     * @throws {AuthError} If request fails
+     *
+     * @example
+     * ```typescript
+     * const result = await authClient.forgotPassword('user@example.com');
+     * console.log(`Code sent to ${result.codeDeliveryDetails?.destination}`);
+     * ```
+     */
+    forgotPassword(email: string): Promise<ForgotPasswordResult>;
+    /**
+     * Completes forgot password flow with verification code.
+     *
+     * @param email - User's email address
+     * @param code - Verification code from email
+     * @param newPassword - New password to set
+     * @throws {AuthError} If password reset fails
+     *
+     * @example
+     * ```typescript
+     * await authClient.confirmForgotPassword('user@example.com', '123456', 'NewP@ssw0rd');
+     * // User can now sign in with new password
+     * ```
+     */
+    confirmForgotPassword(email: string, code: string, newPassword: string): Promise<void>;
+    /**
+     * Signs up a new user.
+     *
+     * @param email - User's email address
+     * @param password - User's password
+     * @param name - Optional user's name
+     * @returns Sign-up result with confirmation status
+     * @throws {AuthError} If sign-up fails
+     *
+     * @example
+     * ```typescript
+     * const result = await authClient.signUp('user@example.com', 'password', 'John Doe');
+     * if (!result.userConfirmed) {
+     *   // Show confirmation code input
+     *   console.log(`Code sent to ${result.codeDeliveryDetails?.destination}`);
+     * }
+     * ```
+     */
+    signUp(email: string, password: string, name?: string): Promise<SignUpResult>;
+    /**
+     * Confirms a user's sign-up with the verification code.
+     *
+     * @param email - User's email address
+     * @param code - Verification code from email/SMS
+     * @throws {AuthError} If confirmation fails
+     *
+     * @example
+     * ```typescript
+     * await authClient.confirmSignUp('user@example.com', '123456');
+     * // User is now confirmed, can sign in
+     * ```
+     */
+    confirmSignUp(email: string, code: string): Promise<void>;
+    /**
+     * Refreshes authentication tokens using a refresh token.
+     *
+     * @param refreshToken - The refresh token from a previous authentication
+     * @returns New authentication tokens
+     * @throws {AuthError} If refresh fails
+     *
+     * @example
+     * ```typescript
+     * // When access token is about to expire
+     * const newTokens = await authClient.refreshTokens(tokens.refreshToken);
+     * ```
+     */
+    refreshTokens(refreshToken: string): Promise<AuthTokens>;
+    /**
+     * Signs out the user from all devices.
+     *
+     * This invalidates all refresh tokens for the user, effectively
+     * signing them out from all devices.
+     *
+     * @param accessToken - The user's current access token
+     * @throws {AuthError} If sign-out fails
+     *
+     * @example
+     * ```typescript
+     * await authClient.signOut(tokens.accessToken);
+     * // User is now signed out from all devices
+     * ```
+     */
+    signOut(accessToken: string): Promise<void>;
 }
-//# sourceMappingURL=auth-client.d.ts.map
+//# sourceMappingURL=auth-client.d.ts.map

package/lib/client/auth-client.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"auth-client.d.ts","sourceRoot":"","sources":["../../src/client/auth-client.ts"],"names":[],"mappings":"AAAA;;;;;;;GAOG;AAUH,OAAO,KAAK,EAAE,gBAAgB,EAAE,UAAU,EAAE,YAAY,EAAE,MAAM,aAAa,CAAC;AA8B9E;;GAEG;AACH,wBAAgB,gBAAgB,IAAI,IAAI,CAEvC;AAED;;;;;;;;;;;;;;;;;;;;;;GAsBG;AACH,qBAAa,aAAa;IACxB,OAAO,CAAC,QAAQ,CAAC,MAAM,CAAgC;IACvD,OAAO,CAAC,QAAQ,CAAC,QAAQ,CAAS;IAElC;;;;OAIG;gBACS,MAAM,EAAE,gBAAgB;IAKpC;;;;;;;;;;;;;;;;;;;OAmBG;IACG,MAAM,CAAC,KAAK,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,GAAG,OAAO,CAAC,UAAU,CAAC;IAkClE;;;;;;;;;;;;;;;;;OAiBG;IACG,MAAM,CAAC,KAAK,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,EAAE,IAAI,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,YAAY,CAAC;IA+BnF;;;;;;;;;;;;OAYG;IACG,aAAa,CAAC,KAAK,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAc/D;;;;;;;;;;;;OAYG;IACG,aAAa,CAAC,YAAY,EAAE,MAAM,GAAG,OAAO,CAAC,UAAU,CAAC;IAkC9D;;;;;;;;;;;;;;OAcG;IACG,OAAO,CAAC,WAAW,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;CAWlD"}
+{"version":3,"file":"auth-client.d.ts","sourceRoot":"","sources":["../../src/client/auth-client.ts"],"names":[],"mappings":"AAAA;;;;;;;GAOG;AAcH,OAAO,KAAK,EAAE,gBAAgB,EAAE,UAAU,EAAE,YAAY,EAAE,oBAAoB,EAAE,MAAM,aAAa,CAAC;AA8BpG;;GAEG;AACH,wBAAgB,gBAAgB,IAAI,IAAI,CAEvC;AAED;;;;;;;;;;;;;;;;;;;;;;GAsBG;AACH,qBAAa,aAAa;IACxB,OAAO,CAAC,QAAQ,CAAC,MAAM,CAAgC;IACvD,OAAO,CAAC,QAAQ,CAAC,QAAQ,CAAS;IAElC;;;;OAIG;gBACS,MAAM,EAAE,gBAAgB;IAKpC;;;;;;;;;;;;;;;;;;;;;;;OAuBG;IACG,MAAM,CAAC,KAAK,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,GAAG,OAAO,CAAC,UAAU,CAAC;IA8ClE;;;;;;;;;;;;;;;;;;;;OAoBG;IACG,mBAAmB,CACvB,KAAK,EAAE,MAAM,EACb,WAAW,EAAE,MAAM,EACnB,OAAO,EAAE,MAAM,GACd,OAAO,CAAC,UAAU,CAAC;IAmCtB;;;;;;;;;;;;;;OAcG;IACG,cAAc,CAAC,KAAK,EAAE,MAAM,GAAG,OAAO,CAAC,oBAAoB,CAAC;IAsBlE;;;;;;;;;;;;;OAaG;IACG,qBAAqB,CACzB,KAAK,EAAE,MAAM,EACb,IAAI,EAAE,MAAM,EACZ,WAAW,EAAE,MAAM,GAClB,OAAO,CAAC,IAAI,CAAC;IAehB;;;;;;;;;;;;;;;;;OAiBG;IACG,MAAM,CAAC,KAAK,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,EAAE,IAAI,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,YAAY,CAAC;IA+BnF;;;;;;;;;;;;OAYG;IACG,aAAa,CAAC,KAAK,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAc/D;;;;;;;;;;;;OAYG;IACG,aAAa,CAAC,YAAY,EAAE,MAAM,GAAG,OAAO,CAAC,UAAU,CAAC;IAkC9D;;;;;;;;;;;;;;OAcG;IACG,OAAO,CAAC,WAAW,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;CAWlD"}