cloudfire-auth 0.2.0 → 0.3.1

package/dist/CloudFireAuth.js

@@ -15,6 +15,7 @@
  * limitations under the License.
  */
 // Rest API
+import { createCustomTokenHandler } from "./rest-api/create-custom-token.js";
 import { verifyIdTokenHandler } from "./rest-api/verify-id-token.js";
 import { getUserHandler } from "./rest-api/get-user.js";
 import { getUserByEmailHandler } from "./rest-api/get-user-by-email.js";
@@ -29,6 +30,17 @@ import { updateUserHandler } from "./rest-api/update-user.js";
 import { setCustomUserClaimsHandler } from "./rest-api/set-custom-user-claims.js";
 import { revokeRefreshTokensHandler } from "./rest-api/revoke-refresh-tokens.js";
 import { verifySessionCookieHandler } from "./rest-api/verify-session-cookie.js";
+import { importUsersHandler } from "./rest-api/import-users.js";
+import { createSessionCookieHandler } from "./rest-api/create-session-cookie.js";
+import { generatePasswordResetLinkHandler } from "./rest-api/generate-password-reset-link.js";
+import { generateEmailVerificationLinkHandler } from "./rest-api/generate-email-verification-link.js";
+import { generateVerifyAndChangeEmailLinkHandler } from "./rest-api/generate-verify-and-change-email-link.js";
+import { generateSignInWithEmailLinkHandler } from "./rest-api/generate-sign-in-with-email-link.js";
+import { listProviderConfigsHandler } from "./rest-api/list-provider-configs.js";
+import { getProviderConfigHandler } from "./rest-api/get-provider-config.js";
+import { deleteProviderConfigHandler } from "./rest-api/delete-provider-config.js";
+import { updateProviderConfigHandler } from "./rest-api/update-provider-config.js";
+import { createProviderConfigHandler } from "./rest-api/create-provider-config.js";
 // Google Auth
 import { getOauth2AccessTokenHandler } from "./google-auth/get-oauth-2-token.js";
 export class CloudFireAuth {
@@ -41,6 +53,26 @@ export class CloudFireAuth {
         this.serviceAccountKey = serviceAccountKey;
         this.kvNamespace = kvNamespace;
     }
+    /**
+     * Creates a new Firebase custom token (JWT) that can be sent back to a client
+     * device to use to sign in with the client SDKs' `signInWithCustomToken()`
+     * methods. (Tenant-aware instances will also embed the tenant ID in the
+     * token.)
+     *
+     * See {@link https://firebase.google.com/docs/auth/admin/create-custom-tokens | Create Custom Tokens}
+     * for code samples and detailed documentation.
+     *
+     * @param uid - The `uid` to use as the custom token's subject.
+     * @param developerClaims - Optional additional claims to include
+     *   in the custom token's payload.
+     *
+     * @returns A promise fulfilled with a custom token for the
+     *   provided `uid` and payload.
+     */
+    async createCustomToken(uid, developerClaims) {
+        const oauth2Token = await this.getOauth2AccessToken();
+        return await createCustomTokenHandler(uid, developerClaims, oauth2Token);
+    }
     /**
      * Verifies a Firebase ID token (JWT). If the token is valid, the promise is
      * fulfilled with the token's decoded claims; otherwise, the promise is
@@ -289,6 +321,48 @@ export class CloudFireAuth {
         const oauth2Token = await this.getOauth2AccessToken();
         return await revokeRefreshTokensHandler(uid, oauth2Token);
     }
+    /**
+     * Imports the provided list of users into Firebase Auth.
+     * A maximum of 1000 users are allowed to be imported one at a time.
+     * When importing users with passwords,
+     * {@link UserImportOptions} are required to be
+     * specified.
+     * This operation is optimized for bulk imports and will ignore checks on `uid`,
+     * `email` and other identifier uniqueness which could result in duplications.
+     *
+     * @param users - The list of user records to import to Firebase Auth.
+     * @param options - The user import options, required when the users provided include
+     *   password credentials.
+     * @returns A promise that resolves when
+     *   the operation completes with the result of the import. This includes the
+     *   number of successful imports, the number of failed imports and their
+     *   corresponding errors.
+     */
+    async importUsers(users, options) {
+        const oauth2Token = await this.getOauth2AccessToken();
+        return await importUsersHandler(users, options, oauth2Token);
+    }
+    /**
+     * Creates a new Firebase session cookie with the specified options. The created
+     * JWT string can be set as a server-side session cookie with a custom cookie
+     * policy, and be used for session management. The session cookie JWT will have
+     * the same payload claims as the provided ID token.
+     *
+     * See {@link https://firebase.google.com/docs/auth/admin/manage-cookies | Manage Session Cookies}
+     * for code samples and detailed documentation.
+     *
+     * @param idToken - The Firebase ID token to exchange for a session
+     *   cookie.
+     * @param sessionCookieOptions - The session
+     *   cookie options which includes custom session duration.
+     *
+     * @returns A promise that resolves on success with the
+     *   created session cookie.
+     */
+    async createSessionCookie(idToken, sessionCookieOptions) {
+        const oauth2Token = await this.getOauth2AccessToken();
+        return await createSessionCookieHandler(idToken, sessionCookieOptions, oauth2Token);
+    }
     /**
      * Verifies a Firebase session cookie. Returns a Promise with the cookie claims.
      * Rejects the promise if the cookie could not be verified.
@@ -317,6 +391,277 @@ export class CloudFireAuth {
     async verifySessionCookie(sessionCookie, checkRevoked) {
         return await verifySessionCookieHandler(sessionCookie, checkRevoked);
     }
+    /**
+     * Generates the out of band email action link to reset a user's password.
+     * The link is generated for the user with the specified email address. The
+     * optional  {@link ActionCodeSettings} object
+     * defines whether the link is to be handled by a mobile app or browser and the
+     * additional state information to be passed in the deep link, etc.
+     *
+     * @example
+     * ```javascript
+     * var actionCodeSettings = {
+     *   url: 'https://www.example.com/?email=user@example.com',
+     *   iOS: {
+     *     bundleId: 'com.example.ios'
+     *   },
+     *   android: {
+     *     packageName: 'com.example.android',
+     *     installApp: true,
+     *     minimumVersion: '12'
+     *   },
+     *   handleCodeInApp: true,
+     *   linkDomain: 'project-id.firebaseapp.com'
+     * };
+     * admin.auth()
+     *     .generatePasswordResetLink('user@example.com', actionCodeSettings)
+     *     .then(function(link) {
+     *       // The link was successfully generated.
+     *     })
+     *     .catch(function(error) {
+     *       // Some error occurred, you can inspect the code: error.code
+     *     });
+     * ```
+     *
+     * @param email - The email address of the user whose password is to be
+     *   reset.
+     * @param actionCodeSettings - The action
+     *     code settings. If specified, the state/continue URL is set as the
+     *     "continueUrl" parameter in the password reset link. The default password
+     *     reset landing page will use this to display a link to go back to the app
+     *     if it is installed.
+     *     If the actionCodeSettings is not specified, no URL is appended to the
+     *     action URL.
+     *     The state URL provided must belong to a domain that is whitelisted by the
+     *     developer in the console. Otherwise an error is thrown.
+     *     Mobile app redirects are only applicable if the developer configures
+     *     and accepts the Firebase Dynamic Links terms of service.
+     *     The Android package name and iOS bundle ID are respected only if they
+     *     are configured in the same Firebase Auth project.
+     * @returns A promise that resolves with the generated link.
+     */
+    async generatePasswordResetLink(email, actionCodeSettings) {
+        const oauth2Token = await this.getOauth2AccessToken();
+        return await generatePasswordResetLinkHandler(email, actionCodeSettings, oauth2Token);
+    }
+    /**
+     * Generates the out of band email action link to verify the user's ownership
+     * of the specified email. The {@link ActionCodeSettings} object provided
+     * as an argument to this method defines whether the link is to be handled by a
+     * mobile app or browser along with additional state information to be passed in
+     * the deep link, etc.
+     *
+     * @example
+     * ```javascript
+     * var actionCodeSettings = {
+     *   url: 'https://www.example.com/cart?email=user@example.com&cartId=123',
+     *   iOS: {
+     *     bundleId: 'com.example.ios'
+     *   },
+     *   android: {
+     *     packageName: 'com.example.android',
+     *     installApp: true,
+     *     minimumVersion: '12'
+     *   },
+     *   handleCodeInApp: true,
+     *   linkDomain: 'project-id.firebaseapp.com'
+     * };
+     * admin.auth()
+     *     .generateEmailVerificationLink('user@example.com', actionCodeSettings)
+     *     .then(function(link) {
+     *       // The link was successfully generated.
+     *     })
+     *     .catch(function(error) {
+     *       // Some error occurred, you can inspect the code: error.code
+     *     });
+     * ```
+     *
+     * @param email - The email account to verify.
+     * @param actionCodeSettings - The action
+     *     code settings. If specified, the state/continue URL is set as the
+     *     "continueUrl" parameter in the email verification link. The default email
+     *     verification landing page will use this to display a link to go back to
+     *     the app if it is installed.
+     *     If the actionCodeSettings is not specified, no URL is appended to the
+     *     action URL.
+     *     The state URL provided must belong to a domain that is whitelisted by the
+     *     developer in the console. Otherwise an error is thrown.
+     *     Mobile app redirects are only applicable if the developer configures
+     *     and accepts the Firebase Dynamic Links terms of service.
+     *     The Android package name and iOS bundle ID are respected only if they
+     *     are configured in the same Firebase Auth project.
+     * @returns A promise that resolves with the generated link.
+     */
+    async generateEmailVerificationLink(email, actionCodeSettings) {
+        const oauth2Token = await this.getOauth2AccessToken();
+        return await generateEmailVerificationLinkHandler(email, actionCodeSettings, oauth2Token);
+    }
+    /**
+     * Generates an out-of-band email action link to verify the user's ownership
+     * of the specified email. The {@link ActionCodeSettings} object provided
+     * as an argument to this method defines whether the link is to be handled by a
+     * mobile app or browser along with additional state information to be passed in
+     * the deep link, etc.
+     *
+     * @param email - The current email account.
+     * @param newEmail - The email address the account is being updated to.
+     * @param actionCodeSettings - The action
+     *     code settings. If specified, the state/continue URL is set as the
+     *     "continueUrl" parameter in the email verification link. The default email
+     *     verification landing page will use this to display a link to go back to
+     *     the app if it is installed.
+     *     If the actionCodeSettings is not specified, no URL is appended to the
+     *     action URL.
+     *     The state URL provided must belong to a domain that is authorized
+     *     in the console, or an error will be thrown.
+     *     Mobile app redirects are only applicable if the developer configures
+     *     and accepts the Firebase Dynamic Links terms of service.
+     *     The Android package name and iOS bundle ID are respected only if they
+     *     are configured in the same Firebase Auth project.
+     * @returns A promise that resolves with the generated link.
+     */
+    async generateVerifyAndChangeEmailLink(email, newEmail, actionCodeSettings) {
+        const oauth2Token = await this.getOauth2AccessToken();
+        return await generateVerifyAndChangeEmailLinkHandler(email, newEmail, actionCodeSettings, oauth2Token);
+    }
+    /**
+     * Generates the out of band email action link to verify the user's ownership
+     * of the specified email. The {@link ActionCodeSettings} object provided
+     * as an argument to this method defines whether the link is to be handled by a
+     * mobile app or browser along with additional state information to be passed in
+     * the deep link, etc.
+     *
+     * @example
+     * ```javascript
+     * var actionCodeSettings = {
+     *   url: 'https://www.example.com/cart?email=user@example.com&cartId=123',
+     *   iOS: {
+     *     bundleId: 'com.example.ios'
+     *   },
+     *   android: {
+     *     packageName: 'com.example.android',
+     *     installApp: true,
+     *     minimumVersion: '12'
+     *   },
+     *   handleCodeInApp: true,
+     *   linkDomain: 'project-id.firebaseapp.com'
+     * };
+     * admin.auth()
+     *     .generateEmailVerificationLink('user@example.com', actionCodeSettings)
+     *     .then(function(link) {
+     *       // The link was successfully generated.
+     *     })
+     *     .catch(function(error) {
+     *       // Some error occurred, you can inspect the code: error.code
+     *     });
+     * ```
+     *
+     * @param email - The email account to verify.
+     * @param actionCodeSettings - The action
+     *     code settings. If specified, the state/continue URL is set as the
+     *     "continueUrl" parameter in the email verification link. The default email
+     *     verification landing page will use this to display a link to go back to
+     *     the app if it is installed.
+     *     If the actionCodeSettings is not specified, no URL is appended to the
+     *     action URL.
+     *     The state URL provided must belong to a domain that is whitelisted by the
+     *     developer in the console. Otherwise an error is thrown.
+     *     Mobile app redirects are only applicable if the developer configures
+     *     and accepts the Firebase Dynamic Links terms of service.
+     *     The Android package name and iOS bundle ID are respected only if they
+     *     are configured in the same Firebase Auth project.
+     * @returns A promise that resolves with the generated link.
+     */
+    async generateSignInWithEmailLink(email, actionCodeSettings) {
+        const oauth2Token = await this.getOauth2AccessToken();
+        return await generateSignInWithEmailLinkHandler(email, actionCodeSettings, oauth2Token);
+    }
+    /**
+     * Returns the list of existing provider configurations matching the filter
+     * provided. At most, 100 provider configs can be listed at a time.
+     *
+     * SAML and OIDC provider support requires Google Cloud's Identity Platform
+     * (GCIP). To learn more about GCIP, including pricing and features,
+     * see the {@link https://cloud.google.com/identity-platform | GCIP documentation}.
+     *
+     * @param options - The provider config filter to apply.
+     * @returns A promise that resolves with the list of provider configs meeting the
+     *   filter requirements.
+     */
+    async listProviderConfigs(options) {
+        const oauth2Token = await this.getOauth2AccessToken();
+        return await listProviderConfigsHandler(options, oauth2Token);
+    }
+    /**
+     * Looks up an Auth provider configuration by the provided ID.
+     * Returns a promise that resolves with the provider configuration
+     * corresponding to the provider ID specified. If the specified ID does not
+     * exist, an `auth/configuration-not-found` error is thrown.
+     *
+     * SAML and OIDC provider support requires Google Cloud's Identity Platform
+     * (GCIP). To learn more about GCIP, including pricing and features,
+     * see the {@link https://cloud.google.com/identity-platform | GCIP documentation}.
+     *
+     * @param providerId - The provider ID corresponding to the provider
+     *     config to return.
+     * @returns A promise that resolves
+     *     with the configuration corresponding to the provided ID.
+     */
+    async getProviderConfig(providerId) {
+        const oauth2Token = await this.getOauth2AccessToken();
+        return await getProviderConfigHandler(providerId, oauth2Token);
+    }
+    /**
+     * Deletes the provider configuration corresponding to the provider ID passed.
+     * If the specified ID does not exist, an `auth/configuration-not-found` error
+     * is thrown.
+     *
+     * SAML and OIDC provider support requires Google Cloud's Identity Platform
+     * (GCIP). To learn more about GCIP, including pricing and features,
+     * see the {@link https://cloud.google.com/identity-platform | GCIP documentation}.
+     *
+     * @param providerId - The provider ID corresponding to the provider
+     *     config to delete.
+     * @returns A promise that resolves on completion.
+     */
+    async deleteProviderConfig(providerId) {
+        const oauth2Token = await this.getOauth2AccessToken();
+        await deleteProviderConfigHandler(providerId, oauth2Token);
+    }
+    /**
+     * Returns a promise that resolves with the updated `AuthProviderConfig`
+     * corresponding to the provider ID specified.
+     * If the specified ID does not exist, an `auth/configuration-not-found` error
+     * is thrown.
+     *
+     * SAML and OIDC provider support requires Google Cloud's Identity Platform
+     * (GCIP). To learn more about GCIP, including pricing and features,
+     * see the {@link https://cloud.google.com/identity-platform | GCIP documentation}.
+     *
+     * @param providerId - The provider ID corresponding to the provider
+     *     config to update.
+     * @param updatedConfig - The updated configuration.
+     * @returns A promise that resolves with the updated provider configuration.
+     */
+    async updateProviderConfig(providerId, updatedConfig) {
+        const oauth2Token = await this.getOauth2AccessToken();
+        return await updateProviderConfigHandler(providerId, updatedConfig, oauth2Token);
+    }
+    /**
+     * Returns a promise that resolves with the newly created `AuthProviderConfig`
+     * when the new provider configuration is created.
+     *
+     * SAML and OIDC provider support requires Google Cloud's Identity Platform
+     * (GCIP). To learn more about GCIP, including pricing and features,
+     * see the {@link https://cloud.google.com/identity-platform | GCIP documentation}.
+     *
+     * @param config - The provider configuration to create.
+     * @returns A promise that resolves with the created provider configuration.
+     */
+    async createProviderConfig(config) {
+        const oauth2Token = await this.getOauth2AccessToken();
+        return await createProviderConfigHandler(config, oauth2Token);
+    }
     /**
      * Gets an OAuth2 access token from Google's OAuth2 server. This token is
      * required for accessing the Firebase Auth REST API via fetch requests.

package/dist/rest-api/create-custom-token.d.ts

@@ -0,0 +1,18 @@
+/**
+ * Creates a new Firebase custom token (JWT) for the specified user ID.
+ *
+ * This function creates a custom JWT that can be used with Firebase client SDKs
+ * to sign in users via the signInWithCustomToken() method. The token is signed
+ * with the service account's private key and includes optional developer claims.
+ *
+ * @param uid - The user ID to create the token for
+ * @param developerClaims - Optional additional claims to include in the token
+ * @param oauth2AccessToken - OAuth2 access token for Firebase Admin API
+ * @returns Promise that resolves to the custom token string
+ *
+ * @throws {Error} Not yet implemented
+ *
+ * @package
+ * @internal
+ */
+export declare function createCustomTokenHandler(uid: string, developerClaims: object | undefined, oauth2AccessToken: string): Promise<string>;

package/dist/rest-api/create-custom-token.js

@@ -0,0 +1,20 @@
+/**
+ * Creates a new Firebase custom token (JWT) for the specified user ID.
+ *
+ * This function creates a custom JWT that can be used with Firebase client SDKs
+ * to sign in users via the signInWithCustomToken() method. The token is signed
+ * with the service account's private key and includes optional developer claims.
+ *
+ * @param uid - The user ID to create the token for
+ * @param developerClaims - Optional additional claims to include in the token
+ * @param oauth2AccessToken - OAuth2 access token for Firebase Admin API
+ * @returns Promise that resolves to the custom token string
+ *
+ * @throws {Error} Not yet implemented
+ *
+ * @package
+ * @internal
+ */
+export async function createCustomTokenHandler(uid, developerClaims, oauth2AccessToken) {
+    throw new Error("Not implemented");
+}

package/dist/rest-api/create-provider-config.d.ts

@@ -0,0 +1,16 @@
+import type { AuthProviderConfig } from "../types.js";
+/**
+ * Creates a new Auth provider configuration.
+ *
+ * Creates a new SAML or OIDC provider configuration with the specified settings.
+ *
+ * @param config - The provider configuration to create
+ * @param oauth2AccessToken - OAuth2 access token for Firebase Admin API
+ * @returns Promise that resolves to the created provider configuration
+ *
+ * @throws {Error} Not yet implemented
+ *
+ * @package
+ * @internal
+ */
+export declare function createProviderConfigHandler(config: AuthProviderConfig, oauth2AccessToken: string): Promise<AuthProviderConfig>;

package/dist/rest-api/create-provider-config.js

@@ -0,0 +1,17 @@
+/**
+ * Creates a new Auth provider configuration.
+ *
+ * Creates a new SAML or OIDC provider configuration with the specified settings.
+ *
+ * @param config - The provider configuration to create
+ * @param oauth2AccessToken - OAuth2 access token for Firebase Admin API
+ * @returns Promise that resolves to the created provider configuration
+ *
+ * @throws {Error} Not yet implemented
+ *
+ * @package
+ * @internal
+ */
+export async function createProviderConfigHandler(config, oauth2AccessToken) {
+    throw new Error("Not implemented");
+}

package/dist/rest-api/create-session-cookie.d.ts

@@ -0,0 +1,18 @@
+import type { SessionCookieOptions } from "../types.js";
+/**
+ * Creates a new Firebase session cookie from an ID token.
+ *
+ * The session cookie can be used for server-side session management. It has the same
+ * payload claims as the provided ID token.
+ *
+ * @param idToken - The Firebase ID token to exchange for a session cookie
+ * @param sessionCookieOptions - Options including custom session duration
+ * @param oauth2AccessToken - OAuth2 access token for Firebase Admin API
+ * @returns Promise that resolves to the session cookie string
+ *
+ * @throws {Error} Not yet implemented
+ *
+ * @package
+ * @internal
+ */
+export declare function createSessionCookieHandler(idToken: string, sessionCookieOptions: SessionCookieOptions, oauth2AccessToken: string): Promise<string>;

package/dist/rest-api/create-session-cookie.js

@@ -0,0 +1,19 @@
+/**
+ * Creates a new Firebase session cookie from an ID token.
+ *
+ * The session cookie can be used for server-side session management. It has the same
+ * payload claims as the provided ID token.
+ *
+ * @param idToken - The Firebase ID token to exchange for a session cookie
+ * @param sessionCookieOptions - Options including custom session duration
+ * @param oauth2AccessToken - OAuth2 access token for Firebase Admin API
+ * @returns Promise that resolves to the session cookie string
+ *
+ * @throws {Error} Not yet implemented
+ *
+ * @package
+ * @internal
+ */
+export async function createSessionCookieHandler(idToken, sessionCookieOptions, oauth2AccessToken) {
+    throw new Error("Not implemented");
+}

package/dist/rest-api/delete-provider-config.d.ts

@@ -0,0 +1,16 @@
+/**
+ * Deletes the provider configuration for the specified provider ID.
+ *
+ * Removes the provider configuration from Firebase Auth. Throws an error if
+ * the configuration does not exist.
+ *
+ * @param providerId - The provider ID corresponding to the provider config to delete
+ * @param oauth2AccessToken - OAuth2 access token for Firebase Admin API
+ * @returns Promise that resolves when the operation completes
+ *
+ * @throws {Error} Not yet implemented
+ *
+ * @package
+ * @internal
+ */
+export declare function deleteProviderConfigHandler(providerId: string, oauth2AccessToken: string): Promise<void>;

package/dist/rest-api/delete-provider-config.js

@@ -0,0 +1,18 @@
+/**
+ * Deletes the provider configuration for the specified provider ID.
+ *
+ * Removes the provider configuration from Firebase Auth. Throws an error if
+ * the configuration does not exist.
+ *
+ * @param providerId - The provider ID corresponding to the provider config to delete
+ * @param oauth2AccessToken - OAuth2 access token for Firebase Admin API
+ * @returns Promise that resolves when the operation completes
+ *
+ * @throws {Error} Not yet implemented
+ *
+ * @package
+ * @internal
+ */
+export async function deleteProviderConfigHandler(providerId, oauth2AccessToken) {
+    throw new Error("Not implemented");
+}

package/dist/rest-api/generate-email-verification-link.d.ts

@@ -0,0 +1,18 @@
+import type { ActionCodeSettings } from "../types.js";
+/**
+ * Generates an out-of-band email action link to verify a user's email ownership.
+ *
+ * The link can be sent to users to verify their email address. The optional
+ * ActionCodeSettings object defines mobile app handling and additional state.
+ *
+ * @param email - The email account to verify
+ * @param actionCodeSettings - Optional action code settings
+ * @param oauth2AccessToken - OAuth2 access token for Firebase Admin API
+ * @returns Promise that resolves to the generated link
+ *
+ * @throws {Error} Not yet implemented
+ *
+ * @package
+ * @internal
+ */
+export declare function generateEmailVerificationLinkHandler(email: string, actionCodeSettings: ActionCodeSettings | undefined, oauth2AccessToken: string): Promise<string>;

package/dist/rest-api/generate-email-verification-link.js

@@ -0,0 +1,19 @@
+/**
+ * Generates an out-of-band email action link to verify a user's email ownership.
+ *
+ * The link can be sent to users to verify their email address. The optional
+ * ActionCodeSettings object defines mobile app handling and additional state.
+ *
+ * @param email - The email account to verify
+ * @param actionCodeSettings - Optional action code settings
+ * @param oauth2AccessToken - OAuth2 access token for Firebase Admin API
+ * @returns Promise that resolves to the generated link
+ *
+ * @throws {Error} Not yet implemented
+ *
+ * @package
+ * @internal
+ */
+export async function generateEmailVerificationLinkHandler(email, actionCodeSettings, oauth2AccessToken) {
+    throw new Error("Not implemented");
+}

package/dist/rest-api/generate-password-reset-link.d.ts

@@ -0,0 +1,18 @@
+import type { ActionCodeSettings } from "../types.js";
+/**
+ * Generates an out-of-band email action link to reset a user's password.
+ *
+ * The link can be sent to users to allow them to reset their password. The optional
+ * ActionCodeSettings object defines mobile app handling and additional state.
+ *
+ * @param email - The email address of the user whose password is to be reset
+ * @param actionCodeSettings - Optional action code settings
+ * @param oauth2AccessToken - OAuth2 access token for Firebase Admin API
+ * @returns Promise that resolves to the generated link
+ *
+ * @throws {Error} Not yet implemented
+ *
+ * @package
+ * @internal
+ */
+export declare function generatePasswordResetLinkHandler(email: string, actionCodeSettings: ActionCodeSettings | undefined, oauth2AccessToken: string): Promise<string>;

package/dist/rest-api/generate-password-reset-link.js

@@ -0,0 +1,19 @@
+/**
+ * Generates an out-of-band email action link to reset a user's password.
+ *
+ * The link can be sent to users to allow them to reset their password. The optional
+ * ActionCodeSettings object defines mobile app handling and additional state.
+ *
+ * @param email - The email address of the user whose password is to be reset
+ * @param actionCodeSettings - Optional action code settings
+ * @param oauth2AccessToken - OAuth2 access token for Firebase Admin API
+ * @returns Promise that resolves to the generated link
+ *
+ * @throws {Error} Not yet implemented
+ *
+ * @package
+ * @internal
+ */
+export async function generatePasswordResetLinkHandler(email, actionCodeSettings, oauth2AccessToken) {
+    throw new Error("Not implemented");
+}

package/dist/rest-api/generate-sign-in-with-email-link.d.ts

@@ -0,0 +1,18 @@
+import type { ActionCodeSettings } from "../types.js";
+/**
+ * Generates a sign-in with email link for the specified email address.
+ *
+ * This link allows users to sign in via email link without a password. The
+ * ActionCodeSettings object is required to specify where the link should redirect.
+ *
+ * @param email - The email account to generate the sign-in link for
+ * @param actionCodeSettings - Action code settings (required)
+ * @param oauth2AccessToken - OAuth2 access token for Firebase Admin API
+ * @returns Promise that resolves to the generated link
+ *
+ * @throws {Error} Not yet implemented
+ *
+ * @package
+ * @internal
+ */
+export declare function generateSignInWithEmailLinkHandler(email: string, actionCodeSettings: ActionCodeSettings, oauth2AccessToken: string): Promise<string>;

package/dist/rest-api/generate-sign-in-with-email-link.js

@@ -0,0 +1,19 @@
+/**
+ * Generates a sign-in with email link for the specified email address.
+ *
+ * This link allows users to sign in via email link without a password. The
+ * ActionCodeSettings object is required to specify where the link should redirect.
+ *
+ * @param email - The email account to generate the sign-in link for
+ * @param actionCodeSettings - Action code settings (required)
+ * @param oauth2AccessToken - OAuth2 access token for Firebase Admin API
+ * @returns Promise that resolves to the generated link
+ *
+ * @throws {Error} Not yet implemented
+ *
+ * @package
+ * @internal
+ */
+export async function generateSignInWithEmailLinkHandler(email, actionCodeSettings, oauth2AccessToken) {
+    throw new Error("Not implemented");
+}