@opensecret/react 1.0.0-beta.2 → 1.0.0-beta.4

package/dist/index.d.ts

@@ -146,8 +146,45 @@ declare const AWS_ROOT_CERT_DER: Uint8Array;
 
 declare function changePassword(currentPassword: string, newPassword: string): Promise<void>;
 
+/**
+ * Changes password for a platform developer account
+ * @param currentPassword - Current password for verification
+ * @param newPassword - New password to set
+ * @returns A promise that resolves when the password is successfully changed
+ * @throws {Error} If current password is incorrect or the request fails
+ *
+ * @description
+ * This function:
+ * 1. Requires the user to be authenticated
+ * 2. Verifies the current password before allowing the change
+ * 3. Updates to the new password if verification succeeds
+ */
+declare function changePlatformPassword(currentPassword: string, newPassword: string): Promise<{
+    message: string;
+}>;
+
 declare function confirmPasswordReset(email: string, alphanumericCode: string, plaintextSecret: string, newPassword: string, client_id: string): Promise<void>;
 
+/**
+ * Completes the password reset process for a platform developer account
+ * @param email - Developer's email address
+ * @param alphanumericCode - Code received via email
+ * @param plaintextSecret - The plaintext secret that corresponds to the hashed_secret sent in the request
+ * @param newPassword - New password to set
+ * @returns A promise that resolves when the password is successfully reset
+ * @throws {Error} If the verification fails or the request is invalid
+ *
+ * @description
+ * This function:
+ * 1. Completes the password reset process using the code from the email
+ * 2. Requires the plaintext_secret that matches the previously sent hashed_secret
+ * 3. Sets the new password if all verification succeeds
+ * 4. The user can then log in with the new password
+ */
+declare function confirmPlatformPasswordReset(email: string, alphanumericCode: string, plaintextSecret: string, newPassword: string): Promise<{
+    message: string;
+}>;
+
 declare function convertGuestToEmailAccount(email: string, password: string, name?: string | null): Promise<void>;
 
 declare function createOrganization(name: string): Promise<Organization>;
@@ -684,10 +721,54 @@ export declare type OpenSecretDeveloperContextType = {
      * Alias for requestNewVerificationCode - for consistency with OpenSecretContext
      */
     requestNewVerificationEmail: typeof platformApi.requestNewPlatformVerificationCode;
+    /**
+     * Initiates the password reset process for a platform developer account
+     * @param email - Developer's email address
+     * @param hashedSecret - Hashed secret used for additional security verification
+     * @returns A promise that resolves when the reset request is successfully processed
+     * @throws {Error} If the request fails or the email doesn't exist
+     *
+     * @description
+     * - Sends a password reset request for a platform developer
+     * - The server will send an email with an alphanumeric code
+     * - The email and hashed_secret are paired for the reset process
+     * - Use confirmPasswordReset to complete the process
+     */
+    requestPasswordReset: typeof platformApi.requestPlatformPasswordReset;
+    /**
+     * Completes the password reset process for a platform developer account
+     * @param email - Developer's email address
+     * @param alphanumericCode - Code received via email
+     * @param plaintextSecret - The plaintext secret that corresponds to the hashed_secret sent in the request
+     * @param newPassword - New password to set
+     * @returns A promise that resolves when the password is successfully reset
+     * @throws {Error} If the verification fails or the request is invalid
+     *
+     * @description
+     * - Completes the password reset process using the code from the email
+     * - Requires the plaintext_secret that matches the previously sent hashed_secret
+     * - Sets the new password if all verification succeeds
+     * - The user can then log in with the new password
+     */
+    confirmPasswordReset: typeof platformApi.confirmPlatformPasswordReset;
+    /**
+     * Changes password for a platform developer account
+     * @param currentPassword - Current password for verification
+     * @param newPassword - New password to set
+     * @returns A promise that resolves when the password is successfully changed
+     * @throws {Error} If current password is incorrect or the request fails
+     *
+     * @description
+     * - Requires the user to be authenticated
+     * - Verifies the current password before allowing the change
+     * - Updates to the new password if verification succeeds
+     */
+    changePassword: typeof platformApi.changePlatformPassword;
     /**
      * Registers a new developer account
      * @param email - Developer's email address
      * @param password - Developer's password
+     * @param invite_code - Required invitation code in UUID format
      * @param name - Optional developer name
      * @returns A promise that resolves to the login response with access and refresh tokens
      *
@@ -697,7 +778,7 @@ export declare type OpenSecretDeveloperContextType = {
      * - Updates the developer state with new user information
      * - Throws an error if account creation fails
      */
-    signUp: (email: string, password: string, name?: string) => Promise<platformApi.PlatformLoginResponse>;
+    signUp: (email: string, password: string, invite_code: string, name?: string) => Promise<platformApi.PlatformLoginResponse>;
     /**
      * Signs out the current developer by removing authentication tokens
      *
@@ -1045,6 +1126,9 @@ declare namespace platformApi {
         platformMe,
         verifyPlatformEmail,
         requestNewPlatformVerificationCode,
+        requestPlatformPasswordReset,
+        confirmPlatformPasswordReset,
+        changePlatformPassword,
         PlatformLoginResponse,
         PlatformRefreshResponse,
         PlatformOrg,
@@ -1105,7 +1189,15 @@ declare type PlatformRefreshResponse = {
  */
 declare function platformRefreshToken(): Promise<PlatformRefreshResponse>;
 
-declare function platformRegister(email: string, password: string, name?: string): Promise<PlatformLoginResponse>;
+/**
+ * Registers a new platform developer account
+ * @param email Developer's email address
+ * @param password Developer's password
+ * @param invite_code Required invitation code in UUID format
+ * @param name Optional developer name
+ * @returns A promise that resolves to the login response with access and refresh tokens
+ */
+declare function platformRegister(email: string, password: string, invite_code: string, name?: string): Promise<PlatformLoginResponse>;
 
 declare type PlatformUser = {
     id: string;
@@ -1179,6 +1271,22 @@ declare function requestNewVerificationCode(): Promise<void>;
 
 declare function requestPasswordReset(email: string, hashedSecret: string, client_id: string): Promise<void>;
 
+/**
+ * Initiates the password reset process for a platform developer account
+ * @param email - Developer's email address
+ * @param hashedSecret - Hashed secret used for additional security verification
+ * @returns A promise that resolves when the reset request is successfully processed
+ * @throws {Error} If the request fails or the email doesn't exist
+ *
+ * @description
+ * This function:
+ * 1. Sends a password reset request for a platform developer
+ * 2. The server will send an email with an alphanumeric code
+ * 3. The email and hashed_secret are paired for the reset process
+ * 4. Use confirmPlatformPasswordReset to complete the process
+ */
+declare function requestPlatformPasswordReset(email: string, hashedSecret: string): Promise<void>;
+
 declare function setApiUrl(url: string): void;
 
 declare function setPlatformApiUrl(url: string): void;