cloudfire-auth 0.3.2 → 0.4.0

package/LICENSE

@@ -1,21 +1,21 @@
-MIT License
-
-Copyright (c) 2025-Present Connor Skelland
-
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in all
-copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-SOFTWARE.
+MIT License
+
+Copyright (c) 2025-Present Connor Skelland
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/NOTICE

@@ -1,13 +1,13 @@
-This software incorporates code from the following third-party components:
-
--------------------------------------------------------------------------
-
-1.  Component: firebase-admin
-    Copyright 2021 Google Inc.
-
-    This component is licensed under the Apache License, Version 2.0.
-    The full text of the license can be found in the LICENSE file
-    distributed with this software.
-
-    The original source code can be found at:
+This software incorporates code from the following third-party components:
+
+-------------------------------------------------------------------------
+
+1.  Component: firebase-admin
+    Copyright 2021 Google Inc.
+
+    This component is licensed under the Apache License, Version 2.0.
+    The full text of the license can be found in the LICENSE file
+    distributed with this software.
+
+    The original source code can be found at:
     https://github.com/firebase/firebase-admin-node

package/README.md

@@ -1,129 +1,129 @@
-# Cloudfire Auth
-
-A library to make Firebase Auth work in Cloudflare Workers, using native Cloudflare APIs for caching and persistence. The library handles OAuth2 token generation and interactions with the Firebase Auth REST API.
-
-## Features
-
-- 🔥 Firebase Auth compatibility for Cloudflare Workers
-- ⚡ Native Cloudflare KV integration for token caching
-- 🛡️ Full TypeScript support
-- 📦 One dependency, jose for JWT handling
-- 🌐 ESM-only for modern JavaScript environments
-
-## Installation
-
-```bash
-npm install cloudfire-auth
-```
-
-## Quick Start
-
-```typescript
-import { CloudFireAuth } from "cloudfire-auth";
-
-// It is best practice to store your service account key separately and
-// load it from a secure source.
-const serviceAccountKey = {
-  // Your Firebase service account key
-  private_key: "-----BEGIN PRIVATE KEY-----\n...",
-  client_email: "firebase-adminsdk-...@your-project.iam.gserviceaccount.com",
-  // ... other service account fields
-};
-
-// Initialize with your Firebase project credentials
-const auth = new CloudFireAuth(
-  serviceAccountKey,
-  env.YOUR_KV_NAMESPACE // Optional: KV namespace for token caching
-);
-
-// Verify an ID token
-try {
-  const decodedToken = await auth.verifyIdToken(idToken);
-  console.log("User ID:", decodedToken.uid);
-} catch (error) {
-  console.error("Token verification failed:", error);
-}
-
-// Get user data
-const user = await auth.getUser("user-uid");
-console.log("User email:", user.email);
-```
-
-## API Reference
-
-### Constructor
-
-```typescript
-new CloudFireAuth(serviceAccountKey: ServiceAccountKey, kvNamespace?: KVNamespace)
-```
-
-- `serviceAccountKey`: Firebase service account credentials
-- `kvNamespace`: Optional KV namespace for OAuth2 token caching
-
-### Methods
-
-#### Authentication
-
-| Method                                                                             | Status | Description                         |
-| ---------------------------------------------------------------------------------- | ------ | ----------------------------------- |
-| `verifyIdToken(idToken: string, checkRevoked?: boolean)`                           | ✅     | Verify Firebase ID tokens           |
-| `verifySessionCookie(sessionCookie: string, checkRevoked?: boolean)`               | ✅     | Verify session cookies              |
-| `createSessionCookie(idToken: string, sessionCookieOptions: SessionCookieOptions)` | ❌     | Create session cookie from ID token |
-| `createCustomToken(uid: string, developerClaims?: object)`                         | ❌     | Create custom token for client SDK  |
-
-#### User Management
-
-| Method                                                                | Status | Description                            |
-| --------------------------------------------------------------------- | ------ | -------------------------------------- |
-| `getUser(uid: string)`                                                | ✅     | Get user by UID                        |
-| `getUserByEmail(email: string)`                                       | ❌     | Get user by email                      |
-| `getUserByPhoneNumber(phoneNumber: string)`                           | ❌     | Get user by phone number               |
-| `getUserByProviderUid(providerId: string, uid: string)`               | ❌     | Get user by provider UID               |
-| `getUsers(identifiers: UserIdentifier[])`                             | ❌     | Get users by identifiers               |
-| `createUser(properties: CreateRequest)`                               | ❌     | Create a new user                      |
-| `updateUser(uid: string, properties: UpdateRequest)`                  | ✅     | Update existing user                   |
-| `deleteUser(uid: string)`                                             | ✅     | Delete a user                          |
-| `deleteUsers(uids: string[])`                                         | ❌     | Delete multiple users                  |
-| `listUsers(maxResults?: number, pageToken?: string)`                  | ❌     | List users with pagination             |
-| `importUsers(users: UserImportRecord[], options?: UserImportOptions)` | ❌     | Bulk import users with password hashes |
-
-#### Token Management
-
-| Method                                                               | Status | Description                          |
-| -------------------------------------------------------------------- | ------ | ------------------------------------ |
-| `revokeRefreshTokens(uid: string)`                                   | ✅     | Revoke all refresh tokens for a user |
-| `setCustomUserClaims(uid: string, customUserClaims: object \| null)` | ✅     | Set custom claims                    |
-
-#### Email Actions
-
-| Method                                                                                                       | Status | Description                             |
-| ------------------------------------------------------------------------------------------------------------ | ------ | --------------------------------------- |
-| `generatePasswordResetLink(email: string, actionCodeSettings?: ActionCodeSettings)`                          | ❌     | Generate password reset link            |
-| `generateEmailVerificationLink(email: string, actionCodeSettings?: ActionCodeSettings)`                      | ❌     | Generate email verification link        |
-| `generateVerifyAndChangeEmailLink(email: string, newEmail: string, actionCodeSettings?: ActionCodeSettings)` | ❌     | Generate email change verification link |
-| `generateSignInWithEmailLink(email: string, actionCodeSettings: ActionCodeSettings)`                         | ❌     | Generate sign-in with email link        |
-
-#### Provider Configuration
-
-| Method                                                                               | Status | Description                            |
-| ------------------------------------------------------------------------------------ | ------ | -------------------------------------- |
-| `listProviderConfigs(options: AuthProviderConfigFilter)`                             | ❌     | List SAML/OIDC provider configurations |
-| `getProviderConfig(providerId: string)`                                              | ❌     | Get provider configuration by ID       |
-| `createProviderConfig(config: AuthProviderConfig)`                                   | ❌     | Create new provider configuration      |
-| `updateProviderConfig(providerId: string, updatedConfig: UpdateAuthProviderRequest)` | ❌     | Update provider configuration          |
-| `deleteProviderConfig(providerId: string)`                                           | ❌     | Delete provider configuration          |
-
-## Environment Setup
-
-Your Cloudflare Worker needs these environment variables:
-
-- `FIREBASE_SERVICE_ACCOUNT_KEY`: JSON string of your service account key
-- `AUTH_KV_NAMESPACE`: (Optional) KV namespace for token caching
-
-## License
-
-MIT © Connor Skelland
-
-## Contributing
-
-Issues and pull requests are welcome!
+# Cloudfire Auth
+
+A library to make Firebase Auth work in Cloudflare Workers, using native Cloudflare APIs for caching and persistence. The library handles OAuth2 token generation and interactions with the Firebase Auth REST API.
+
+## Features
+
+- 🔥 Firebase Auth compatibility for Cloudflare Workers
+- ⚡ Native Cloudflare KV integration for token caching
+- 🛡️ Full TypeScript support
+- 📦 One dependency, `jose` for JWT handling
+- 🌐 ESM-only for modern JavaScript environments
+
+## Installation
+
+```bash
+npm install cloudfire-auth
+```
+
+## Quick Start
+
+```typescript
+import { CloudFireAuth } from "cloudfire-auth";
+
+// It is best practice to store your service account key separately and
+// load it from a secure source.
+const serviceAccountKey = {
+  // Your Firebase service account key
+  private_key: "-----BEGIN PRIVATE KEY-----\n...",
+  client_email: "firebase-adminsdk-...@your-project.iam.gserviceaccount.com",
+  // ... other service account fields
+};
+
+// Initialize with your Firebase project credentials
+const auth = new CloudFireAuth(
+  serviceAccountKey,
+  env.YOUR_KV_NAMESPACE // Optional: KV namespace for token caching
+);
+
+// Verify an ID token
+try {
+  const decodedToken = await auth.verifyIdToken(idToken);
+  console.log("User ID:", decodedToken.uid);
+} catch (error) {
+  console.error("Token verification failed:", error);
+}
+
+// Get user data
+const user = await auth.getUser("user-uid");
+console.log("User email:", user.email);
+```
+
+## API Reference
+
+### Constructor
+
+```typescript
+new CloudFireAuth(serviceAccountKey: ServiceAccountKey, kvNamespace?: KVNamespace)
+```
+
+- `serviceAccountKey`: Firebase service account credentials
+- `kvNamespace`: Optional KV namespace for OAuth2 token caching
+
+### Methods
+
+#### Authentication
+
+| Method                                                                             | Status | Description                         |
+| ---------------------------------------------------------------------------------- | ------ | ----------------------------------- |
+| `verifyIdToken(idToken: string, checkRevoked?: boolean)`                           | ✅     | Verify Firebase ID tokens           |
+| `verifySessionCookie(sessionCookie: string, checkRevoked?: boolean)`               | ❌     | Verify session cookies              |
+| `createSessionCookie(idToken: string, sessionCookieOptions: SessionCookieOptions)` | ❌     | Create session cookie from ID token |
+| `createCustomToken(uid: string, developerClaims?: object)`                         | ❌     | Create custom token for client SDK  |
+
+#### User Management
+
+| Method                                                                | Status | Description                            |
+| --------------------------------------------------------------------- | ------ | -------------------------------------- |
+| `getUser(uid: string)`                                                | ✅     | Get user by UID                        |
+| `getUserByEmail(email: string)`                                       | ❌     | Get user by email                      |
+| `getUserByPhoneNumber(phoneNumber: string)`                           | ❌     | Get user by phone number               |
+| `getUserByProviderUid(providerId: string, uid: string)`               | ❌     | Get user by provider UID               |
+| `getUsers(identifiers: UserIdentifier[])`                             | ❌     | Get users by identifiers               |
+| `createUser(properties: CreateRequest)`                               | ❌     | Create a new user                      |
+| `updateUser(uid: string, properties: UpdateRequest)`                  | ✅     | Update existing user                   |
+| `deleteUser(uid: string)`                                             | ✅     | Delete a user                          |
+| `deleteUsers(uids: string[])`                                         | ❌     | Delete multiple users                  |
+| `listUsers(maxResults?: number, pageToken?: string)`                  | ❌     | List users with pagination             |
+| `importUsers(users: UserImportRecord[], options?: UserImportOptions)` | ❌     | Bulk import users with password hashes |
+
+#### Token Management
+
+| Method                                                               | Status | Description                          |
+| -------------------------------------------------------------------- | ------ | ------------------------------------ |
+| `revokeRefreshTokens(uid: string)`                                   | ✅     | Revoke all refresh tokens for a user |
+| `setCustomUserClaims(uid: string, customUserClaims: object \| null)` | ✅     | Set custom claims                    |
+
+#### Email Actions
+
+| Method                                                                                                       | Status | Description                             |
+| ------------------------------------------------------------------------------------------------------------ | ------ | --------------------------------------- |
+| `generatePasswordResetLink(email: string, actionCodeSettings?: ActionCodeSettings)`                          | ❌     | Generate password reset link            |
+| `generateEmailVerificationLink(email: string, actionCodeSettings?: ActionCodeSettings)`                      | ❌     | Generate email verification link        |
+| `generateVerifyAndChangeEmailLink(email: string, newEmail: string, actionCodeSettings?: ActionCodeSettings)` | ❌     | Generate email change verification link |
+| `generateSignInWithEmailLink(email: string, actionCodeSettings: ActionCodeSettings)`                         | ❌     | Generate sign-in with email link        |
+
+#### Provider Configuration
+
+| Method                                                                               | Status | Description                            |
+| ------------------------------------------------------------------------------------ | ------ | -------------------------------------- |
+| `listProviderConfigs(options: AuthProviderConfigFilter)`                             | ❌     | List SAML/OIDC provider configurations |
+| `getProviderConfig(providerId: string)`                                              | ❌     | Get provider configuration by ID       |
+| `createProviderConfig(config: AuthProviderConfig)`                                   | ❌     | Create new provider configuration      |
+| `updateProviderConfig(providerId: string, updatedConfig: UpdateAuthProviderRequest)` | ❌     | Update provider configuration          |
+| `deleteProviderConfig(providerId: string)`                                           | ❌     | Delete provider configuration          |
+
+## Environment Setup
+
+Your Cloudflare Worker needs these environment variables:
+
+- `FIREBASE_SERVICE_ACCOUNT_KEY`: JSON string of your service account key
+- `AUTH_KV_NAMESPACE`: (Optional) KV namespace for token caching
+
+## License
+
+MIT © Connor Skelland
+
+## Contributing
+
+Issues and pull requests are welcome!

package/dist/CloudFireAuth.d.ts

@@ -32,6 +32,8 @@
  *
  * - getOauth2AccessToken
  *
+ * All of the method documentation beneath the @returns tag is under the MIT
+ * License for this project also.
  */
 import type { DecodedIdToken, UserRecord, UserIdentifier, GetUsersResult, ListUsersResult, CreateRequest, UpdateRequest, DeleteUsersResult, ServiceAccountKey, SessionCookieOptions, ActionCodeSettings, AuthProviderConfig, UpdateAuthProviderRequest, AuthProviderConfigFilter, ListProviderConfigResults, UserImportRecord, UserImportOptions, UserImportResult } from "./types.js";
 export declare class CloudFireAuth {
@@ -55,6 +57,8 @@ export declare class CloudFireAuth {
      *
      * @returns A promise fulfilled with a custom token for the
      *   provided `uid` and payload.
+     *
+     * @category Authentication
      */
     createCustomToken(uid: string, developerClaims?: object): Promise<string>;
     /**
@@ -80,6 +84,8 @@ export declare class CloudFireAuth {
      * @returns A promise fulfilled with the
      *   token's decoded claims if the ID token is valid; otherwise, a rejected
      *   promise.
+     *
+     * @category Authentication
      */
     verifyIdToken(idToken: string, checkRevoked?: boolean): Promise<DecodedIdToken>;
     /**
@@ -92,6 +98,8 @@ export declare class CloudFireAuth {
      *
      * @returns A promise fulfilled with the user
      *   data corresponding to the provided `uid`.
+     *
+     * @category User Management
      */
     getUser(uid: string): Promise<UserRecord>;
     /**
@@ -105,6 +113,8 @@ export declare class CloudFireAuth {
      *
      * @returns A promise fulfilled with the user
      *   data corresponding to the provided email.
+     *
+     * @category User Management
      */
     getUserByEmail(email: string): Promise<UserRecord>;
     /**
@@ -119,6 +129,8 @@ export declare class CloudFireAuth {
      *
      * @returns A promise fulfilled with the user
      *   data corresponding to the provided phone number.
+     *
+     * @category User Management
      */
     getUserByPhoneNumber(phoneNumber: string): Promise<UserRecord>;
     /**
@@ -133,6 +145,8 @@ export declare class CloudFireAuth {
      *
      * @returns A promise fulfilled with the user data corresponding to the
      *   given provider id.
+     *
+     * @category User Management
      */
     getUserByProviderUid(providerId: string, uid: string): Promise<UserRecord>;
     /**
@@ -149,6 +163,8 @@ export declare class CloudFireAuth {
      * @returns A promise that resolves to the corresponding user records.
      * @throws FirebaseAuthError If any of the identifiers are invalid or if more than 100
      *     identifiers are specified.
+     *
+     * @category User Management
      */
     getUsers(identifiers: UserIdentifier[]): Promise<GetUsersResult>;
     /**
@@ -165,6 +181,8 @@ export declare class CloudFireAuth {
      *   users starting without any offset.
      * @returns A promise that resolves with
      *   the current batch of downloaded users and the next page token.
+     *
+     * @category User Management
      */
     listUsers(maxResults?: number, pageToken?: string): Promise<ListUsersResult>;
     /**
@@ -178,6 +196,8 @@ export declare class CloudFireAuth {
      *
      * @returns A promise fulfilled with the user
      *   data corresponding to the newly created user.
+     *
+     * @category User Management
      */
     createUser(properties: CreateRequest): Promise<UserRecord>;
     /**
@@ -190,6 +210,8 @@ export declare class CloudFireAuth {
      *
      * @returns An empty promise fulfilled once the user has been
      *   deleted.
+     *
+     * @category User Management
      */
     deleteUser(uid: string): Promise<void>;
     /**
@@ -213,6 +235,8 @@ export declare class CloudFireAuth {
      * @returns A Promise that resolves to the total number of successful/failed
      *     deletions, as well as the array of errors that corresponds to the
      *     failed deletions.
+     *
+     * @category User Management
      */
     deleteUsers(uids: string[]): Promise<DeleteUsersResult>;
     /**
@@ -227,6 +251,8 @@ export declare class CloudFireAuth {
      *
      * @returns A promise fulfilled with the
      *   updated user data.
+     *
+     * @category User Management
      */
     updateUser(uid: string, properties: UpdateRequest): Promise<UserRecord>;
     /**
@@ -251,6 +277,8 @@ export declare class CloudFireAuth {
      *   separate storage systems.
      * @returns A promise that resolves when the operation completes
      *   successfully.
+     *
+     * @category Token Management
      */
     setCustomUserClaims(uid: string, customUserClaims: object | null): Promise<void>;
     /**
@@ -263,7 +291,7 @@ export declare class CloudFireAuth {
      * While this will revoke all sessions for a specified user and disable any
      * new ID tokens for existing sessions from getting minted, existing ID tokens
      * may remain active until their natural expiration (one hour). To verify that
-     * ID tokens are revoked, use {@link BaseAuth.verifyIdToken}
+     * ID tokens are revoked, use {@link CloudFireAuth.verifyIdToken}
      * where `checkRevoked` is set to true.
      *
      * @param uid - The `uid` corresponding to the user whose refresh tokens
@@ -271,6 +299,8 @@ export declare class CloudFireAuth {
      *
      * @returns An empty promise fulfilled once the user's refresh
      *   tokens have been revoked.
+     *
+     * @category Token Management
      */
     revokeRefreshTokens(uid: string): Promise<void>;
     /**
@@ -289,6 +319,8 @@ export declare class CloudFireAuth {
      *   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.
+     *
+     * @category User Management
      */
     importUsers(users: UserImportRecord[], options?: UserImportOptions): Promise<UserImportResult>;
     /**
@@ -307,6 +339,8 @@ export declare class CloudFireAuth {
      *
      * @returns A promise that resolves on success with the
      *   created session cookie.
+     *
+     * @category Authentication
      */
     createSessionCookie(idToken: string, sessionCookieOptions: SessionCookieOptions): Promise<string>;
     /**
@@ -325,7 +359,7 @@ export declare class CloudFireAuth {
      * for code samples and detailed documentation
      *
      * @param sessionCookie - The session cookie to verify.
-     * @param checkForRevocation -  Whether to check if the session cookie was
+     * @param checkRevoked -  Whether to check if the session cookie was
      *   revoked. This requires an extra request to the Firebase Auth backend to
      *   check the `tokensValidAfterTime` time for the corresponding user.
      *   When not specified, this additional check is not performed.
@@ -333,6 +367,8 @@ export declare class CloudFireAuth {
      * @returns A promise fulfilled with the
      *   session cookie's decoded claims if the session cookie is valid; otherwise,
      *   a rejected promise.
+     *
+     * @category Authentication
      */
     verifySessionCookie(sessionCookie: string, checkRevoked?: boolean): Promise<DecodedIdToken>;
     /**
@@ -383,6 +419,8 @@ export declare class CloudFireAuth {
      *     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.
+     *
+     * @category Email Actions
      */
     generatePasswordResetLink(email: string, actionCodeSettings?: ActionCodeSettings): Promise<string>;
     /**
@@ -432,6 +470,8 @@ export declare class CloudFireAuth {
      *     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.
+     *
+     * @category Email Actions
      */
     generateEmailVerificationLink(email: string, actionCodeSettings?: ActionCodeSettings): Promise<string>;
     /**
@@ -457,6 +497,8 @@ export declare class CloudFireAuth {
      *     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.
+     *
+     * @category Email Actions
      */
     generateVerifyAndChangeEmailLink(email: string, newEmail: string, actionCodeSettings?: ActionCodeSettings): Promise<string>;
     /**
@@ -506,6 +548,8 @@ export declare class CloudFireAuth {
      *     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.
+     *
+     * @category Email Actions
      */
     generateSignInWithEmailLink(email: string, actionCodeSettings: ActionCodeSettings): Promise<string>;
     /**
@@ -519,6 +563,8 @@ export declare class CloudFireAuth {
      * @param options - The provider config filter to apply.
      * @returns A promise that resolves with the list of provider configs meeting the
      *   filter requirements.
+     *
+     * @category Provider Configuration
      */
     listProviderConfigs(options: AuthProviderConfigFilter): Promise<ListProviderConfigResults>;
     /**
@@ -535,6 +581,8 @@ export declare class CloudFireAuth {
      *     config to return.
      * @returns A promise that resolves
      *     with the configuration corresponding to the provided ID.
+     *
+     * @category Provider Configuration
      */
     getProviderConfig(providerId: string): Promise<AuthProviderConfig>;
     /**
@@ -549,6 +597,8 @@ export declare class CloudFireAuth {
      * @param providerId - The provider ID corresponding to the provider
      *     config to delete.
      * @returns A promise that resolves on completion.
+     *
+     * @category Provider Configuration
      */
     deleteProviderConfig(providerId: string): Promise<void>;
     /**
@@ -565,6 +615,8 @@ export declare class CloudFireAuth {
      *     config to update.
      * @param updatedConfig - The updated configuration.
      * @returns A promise that resolves with the updated provider configuration.
+     *
+     * @category Provider Configuration
      */
     updateProviderConfig(providerId: string, updatedConfig: UpdateAuthProviderRequest): Promise<AuthProviderConfig>;
     /**
@@ -577,6 +629,8 @@ export declare class CloudFireAuth {
      *
      * @param config - The provider configuration to create.
      * @returns A promise that resolves with the created provider configuration.
+     *
+     * @category Provider Configuration
      */
     createProviderConfig(config: AuthProviderConfig): Promise<AuthProviderConfig>;
     /**