cloudfire-auth 0.3.3 → 0.4.0

package/README.md

@@ -7,7 +7,7 @@ A library to make Firebase Auth work in Cloudflare Workers, using native Cloudfl
 - 🔥 Firebase Auth compatibility for Cloudflare Workers
 - ⚡ Native Cloudflare KV integration for token caching
 - 🛡️ Full TypeScript support
-- 📦 One dependency, jose for JWT handling
+- 📦 One dependency, `jose` for JWT handling
 - 🌐 ESM-only for modern JavaScript environments
 
 ## Installation

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>;
     /**

package/dist/CloudFireAuth.js

@@ -68,6 +68,8 @@ export class CloudFireAuth {
      *
      * @returns A promise fulfilled with a custom token for the
      *   provided `uid` and payload.
+     *
+     * @category Authentication
      */
     async createCustomToken(uid, developerClaims) {
         const oauth2Token = await this.getOauth2AccessToken();
@@ -96,6 +98,8 @@ export class CloudFireAuth {
      * @returns A promise fulfilled with the
      *   token's decoded claims if the ID token is valid; otherwise, a rejected
      *   promise.
+     *
+     * @category Authentication
      */
     async verifyIdToken(idToken, checkRevoked) {
         const oauth2Token = await this.getOauth2AccessToken();
@@ -111,6 +115,8 @@ export class CloudFireAuth {
      *
      * @returns A promise fulfilled with the user
      *   data corresponding to the provided `uid`.
+     *
+     * @category User Management
      */
     async getUser(uid) {
         const oauth2Token = await this.getOauth2AccessToken();
@@ -127,6 +133,8 @@ export class CloudFireAuth {
      *
      * @returns A promise fulfilled with the user
      *   data corresponding to the provided email.
+     *
+     * @category User Management
      */
     async getUserByEmail(email) {
         return await getUserByEmailHandler(email);
@@ -143,6 +151,8 @@ export class CloudFireAuth {
      *
      * @returns A promise fulfilled with the user
      *   data corresponding to the provided phone number.
+     *
+     * @category User Management
      */
     async getUserByPhoneNumber(phoneNumber) {
         return await getUserByPhoneNumberHandler(phoneNumber);
@@ -159,6 +169,8 @@ export class CloudFireAuth {
      *
      * @returns A promise fulfilled with the user data corresponding to the
      *   given provider id.
+     *
+     * @category User Management
      */
     async getUserByProviderUid(providerId, uid) {
         return await getUserByProviderUidHandler(providerId, uid);
@@ -177,6 +189,8 @@ export 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
      */
     async getUsers(identifiers) {
         return await getUsersHandler(identifiers);
@@ -195,6 +209,8 @@ export 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
      */
     async listUsers(maxResults, pageToken) {
         return await listUsersHandler(maxResults, pageToken);
@@ -210,6 +226,8 @@ export class CloudFireAuth {
      *
      * @returns A promise fulfilled with the user
      *   data corresponding to the newly created user.
+     *
+     * @category User Management
      */
     async createUser(properties) {
         return await createUserHandler(properties);
@@ -224,6 +242,8 @@ export class CloudFireAuth {
      *
      * @returns An empty promise fulfilled once the user has been
      *   deleted.
+     *
+     * @category User Management
      */
     async deleteUser(uid) {
         const oauth2Token = await this.getOauth2AccessToken();
@@ -250,6 +270,8 @@ export 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
      */
     async deleteUsers(uids) {
         return await deleteUsersHandler(uids);
@@ -266,6 +288,8 @@ export class CloudFireAuth {
      *
      * @returns A promise fulfilled with the
      *   updated user data.
+     *
+     * @category User Management
      */
     async updateUser(uid, properties) {
         const oauth2Token = await this.getOauth2AccessToken();
@@ -293,6 +317,8 @@ export class CloudFireAuth {
      *   separate storage systems.
      * @returns A promise that resolves when the operation completes
      *   successfully.
+     *
+     * @category Token Management
      */
     async setCustomUserClaims(uid, customUserClaims) {
         const oauth2Token = await this.getOauth2AccessToken();
@@ -308,7 +334,7 @@ export 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
@@ -316,6 +342,8 @@ export class CloudFireAuth {
      *
      * @returns An empty promise fulfilled once the user's refresh
      *   tokens have been revoked.
+     *
+     * @category Token Management
      */
     async revokeRefreshTokens(uid) {
         const oauth2Token = await this.getOauth2AccessToken();
@@ -337,6 +365,8 @@ export 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
      */
     async importUsers(users, options) {
         const oauth2Token = await this.getOauth2AccessToken();
@@ -358,6 +388,8 @@ export class CloudFireAuth {
      *
      * @returns A promise that resolves on success with the
      *   created session cookie.
+     *
+     * @category Authentication
      */
     async createSessionCookie(idToken, sessionCookieOptions) {
         const oauth2Token = await this.getOauth2AccessToken();
@@ -379,7 +411,7 @@ export 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.
@@ -387,6 +419,8 @@ export 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
      */
     async verifySessionCookie(sessionCookie, checkRevoked) {
         return await verifySessionCookieHandler(sessionCookie, checkRevoked);
@@ -439,6 +473,8 @@ export 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
      */
     async generatePasswordResetLink(email, actionCodeSettings) {
         const oauth2Token = await this.getOauth2AccessToken();
@@ -491,6 +527,8 @@ export 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
      */
     async generateEmailVerificationLink(email, actionCodeSettings) {
         const oauth2Token = await this.getOauth2AccessToken();
@@ -519,6 +557,8 @@ export 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
      */
     async generateVerifyAndChangeEmailLink(email, newEmail, actionCodeSettings) {
         const oauth2Token = await this.getOauth2AccessToken();
@@ -571,6 +611,8 @@ export 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
      */
     async generateSignInWithEmailLink(email, actionCodeSettings) {
         const oauth2Token = await this.getOauth2AccessToken();
@@ -587,6 +629,8 @@ export 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
      */
     async listProviderConfigs(options) {
         const oauth2Token = await this.getOauth2AccessToken();
@@ -606,6 +650,8 @@ export class CloudFireAuth {
      *     config to return.
      * @returns A promise that resolves
      *     with the configuration corresponding to the provided ID.
+     *
+     * @category Provider Configuration
      */
     async getProviderConfig(providerId) {
         const oauth2Token = await this.getOauth2AccessToken();
@@ -623,6 +669,8 @@ export class CloudFireAuth {
      * @param providerId - The provider ID corresponding to the provider
      *     config to delete.
      * @returns A promise that resolves on completion.
+     *
+     * @category Provider Configuration
      */
     async deleteProviderConfig(providerId) {
         const oauth2Token = await this.getOauth2AccessToken();
@@ -642,6 +690,8 @@ export class CloudFireAuth {
      *     config to update.
      * @param updatedConfig - The updated configuration.
      * @returns A promise that resolves with the updated provider configuration.
+     *
+     * @category Provider Configuration
      */
     async updateProviderConfig(providerId, updatedConfig) {
         const oauth2Token = await this.getOauth2AccessToken();
@@ -657,6 +707,8 @@ export class CloudFireAuth {
      *
      * @param config - The provider configuration to create.
      * @returns A promise that resolves with the created provider configuration.
+     *
+     * @category Provider Configuration
      */
     async createProviderConfig(config) {
         const oauth2Token = await this.getOauth2AccessToken();

package/dist/types/firebase-admin/auth-config.d.ts

@@ -209,7 +209,7 @@ export interface CreateRequest extends UpdateRequest {
 /**
  * The response interface for listing provider configs. This is only available
  * when listing all identity providers' configurations via
- * {@link BaseAuth.listProviderConfigs}.
+ * {@link CloudFireAuth.listProviderConfigs}.
  */
 export interface ListProviderConfigResults {
     /**
@@ -224,7 +224,7 @@ export interface ListProviderConfigResults {
 /**
  * The filter interface used for listing provider configurations. This is used
  * when specifying how to list configured identity providers via
- * {@link BaseAuth.listProviderConfigs}.
+ * {@link CloudFireAuth.listProviderConfigs}.
  */
 export interface AuthProviderConfigFilter {
     /**
@@ -247,7 +247,7 @@ export interface AuthProviderConfigFilter {
 /**
  * The request interface for updating a SAML Auth provider. This is used
  * when updating a SAML provider's configuration via
- * {@link BaseAuth.updateProviderConfig}.
+ * {@link CloudFireAuth.updateProviderConfig}.
  */
 export interface SAMLUpdateAuthProviderRequest {
     /**
@@ -289,7 +289,7 @@ export interface SAMLUpdateAuthProviderRequest {
 /**
  * The request interface for updating an OIDC Auth provider. This is used
  * when updating an OIDC provider's configuration via
- * {@link BaseAuth.updateProviderConfig}.
+ * {@link CloudFireAuth.updateProviderConfig}.
  */
 export interface OIDCUpdateAuthProviderRequest {
     /**
@@ -489,7 +489,7 @@ export interface BaseAuthProviderConfig {
  * The
  * [SAML](http://docs.oasis-open.org/security/saml/Post2.0/sstc-saml-tech-overview-2.0.html)
  * Auth provider configuration interface. A SAML provider can be created via
- * {@link BaseAuth.createProviderConfig}.
+ * {@link CloudFireAuth.createProviderConfig}.
  */
 export interface SAMLAuthProviderConfig extends BaseAuthProviderConfig {
     /**
@@ -547,7 +547,7 @@ export interface OAuthResponseType {
 /**
  * The [OIDC](https://openid.net/specs/openid-connect-core-1_0-final.html) Auth
  * provider configuration interface. An OIDC provider can be created via
- * {@link BaseAuth.createProviderConfig}.
+ * {@link CloudFireAuth.createProviderConfig}.
  */
 export interface OIDCAuthProviderConfig extends BaseAuthProviderConfig {
     /**
@@ -585,7 +585,7 @@ export interface OIDCAuthProviderConfig extends BaseAuthProviderConfig {
 }
 /**
  * The Auth provider configuration type.
- * {@link BaseAuth.createProviderConfig}.
+ * {@link CloudFireAuth.createProviderConfig}.
  */
 export type AuthProviderConfig = SAMLAuthProviderConfig | OIDCAuthProviderConfig;
 /**

package/dist/types/firebase-admin/identifier.d.ts

@@ -23,7 +23,7 @@
 /**
  * Used for looking up an account by uid.
  *
- * See {@link BaseAuth.getUsers}.
+ * See {@link CloudFireAuth.getUsers}.
  */
 export interface UidIdentifier {
     uid: string;
@@ -31,7 +31,7 @@ export interface UidIdentifier {
 /**
  * Used for looking up an account by email.
  *
- * See {@link BaseAuth.getUsers}.
+ * See {@link CloudFireAuth.getUsers}.
  */
 export interface EmailIdentifier {
     email: string;
@@ -39,7 +39,7 @@ export interface EmailIdentifier {
 /**
  * Used for looking up an account by phone number.
  *
- * See {@link BaseAuth.getUsers}.
+ * See {@link CloudFireAuth.getUsers}.
  */
 export interface PhoneIdentifier {
     phoneNumber: string;
@@ -47,7 +47,7 @@ export interface PhoneIdentifier {
 /**
  * Used for looking up an account by federated provider.
  *
- * See {@link BaseAuth.getUsers}.
+ * See {@link CloudFireAuth.getUsers}.
  */
 export interface ProviderIdentifier {
     providerId: string;

package/dist/types/firebase-admin/index.d.ts

@@ -23,11 +23,13 @@
  */
 import type { DecodedIdToken } from "./token-verifier.js";
 import type { UserRecord } from "./user-record.js";
-import type { CreateRequest, UpdateRequest, AuthProviderConfig, UpdateAuthProviderRequest, AuthProviderConfigFilter, ListProviderConfigResults } from "./auth-config.js";
-import type { UserIdentifier } from "./identifier.js";
+import type { UserMetadata, MultiFactorSettings, UserInfo, MultiFactorInfo } from "./user-record.js";
+import type { CreateRequest, UpdateRequest, AuthProviderConfig, UpdateAuthProviderRequest, AuthProviderConfigFilter, ListProviderConfigResults, SAMLAuthProviderConfig, OIDCAuthProviderConfig, SAMLUpdateAuthProviderRequest, OIDCUpdateAuthProviderRequest, MultiFactorCreateSettings, MultiFactorUpdateSettings, UserProvider, CreatePhoneMultiFactorInfoRequest, UpdatePhoneMultiFactorInfoRequest, OAuthResponseType } from "./auth-config.js";
+import type { UserIdentifier, UidIdentifier, EmailIdentifier, PhoneIdentifier, ProviderIdentifier } from "./identifier.js";
 import type { ActionCodeSettings } from "./action-code-settings.js";
 import type { UserImportRecord, UserImportOptions, UserImportResult, HashAlgorithmType, UserMetadataRequest, UserProviderRequest } from "./user-import.js";
-export type { DecodedIdToken, UserRecord, CreateRequest, UpdateRequest, UserIdentifier, AuthProviderConfig, UpdateAuthProviderRequest, AuthProviderConfigFilter, ListProviderConfigResults, ActionCodeSettings, UserImportRecord, UserImportOptions, UserImportResult, HashAlgorithmType, UserMetadataRequest, UserProviderRequest, };
+export type { DecodedIdToken, UserRecord, CreateRequest, UpdateRequest, UserIdentifier, UidIdentifier, EmailIdentifier, PhoneIdentifier, ProviderIdentifier, AuthProviderConfig, SAMLAuthProviderConfig, OIDCAuthProviderConfig, UpdateAuthProviderRequest, SAMLUpdateAuthProviderRequest, OIDCUpdateAuthProviderRequest, AuthProviderConfigFilter, ListProviderConfigResults, ActionCodeSettings, UserImportRecord, UserImportOptions, UserImportResult, HashAlgorithmType, UserMetadataRequest, UserProviderRequest, MultiFactorCreateSettings, MultiFactorUpdateSettings, UserProvider, CreatePhoneMultiFactorInfoRequest, UpdatePhoneMultiFactorInfoRequest, OAuthResponseType, };
+export type { UserMetadata, MultiFactorSettings, UserInfo, MultiFactorInfo };
 /**
  * `FirebaseError` is a subclass of the standard JavaScript `Error` object. In
  * addition to a message string and stack trace, it contains a string code.
@@ -100,7 +102,7 @@ export interface FirebaseArrayIndexError {
      */
     error: FirebaseError;
 }
-/** Represents the result of the {@link BaseAuth.getUsers} API. */
+/** Represents the result of the {@link CloudFireAuth.getUsers} API. */
 export interface GetUsersResult {
     /**
      * Set of user records, corresponding to the set of users that were
@@ -113,7 +115,7 @@ export interface GetUsersResult {
 }
 /**
  * Interface representing the object returned from a
- * {@link BaseAuth.listUsers} operation. Contains the list
+ * {@link CloudFireAuth.listUsers} operation. Contains the list
  * of users for the current batch and the next page token if available.
  */
 export interface ListUsersResult {
@@ -128,7 +130,7 @@ export interface ListUsersResult {
     pageToken?: string;
 }
 /**
- * Represents the result of the {@link BaseAuth.deleteUsers}.
+ * Represents the result of the {@link CloudFireAuth.deleteUsers}.
  * API.
  */
 export interface DeleteUsersResult {
@@ -151,7 +153,7 @@ export interface DeleteUsersResult {
 }
 /**
  * Interface representing the session cookie options needed for the
- * {@link BaseAuth.createSessionCookie} method.
+ * {@link CloudFireAuth.createSessionCookie} method.
  */
 export interface SessionCookieOptions {
     /**

package/dist/types/firebase-admin/token-verifier.d.ts

@@ -22,7 +22,7 @@
  */
 /**
  * Interface representing a decoded Firebase ID token, returned from the
- * {@link BaseAuth.verifyIdToken} method.
+ * {@link CloudFireAuth.verifyIdToken} method.
  *
  * Firebase ID tokens are OpenID Connect spec-compliant JSON Web Tokens (JWTs).
  * See the

package/dist/types/firebase-admin/user-import.d.ts

@@ -36,7 +36,7 @@ import type { MultiFactorUpdateSettings } from "./auth-config.js";
 export type HashAlgorithmType = "SCRYPT" | "STANDARD_SCRYPT" | "HMAC_SHA512" | "HMAC_SHA256" | "HMAC_SHA1" | "HMAC_MD5" | "MD5" | "PBKDF_SHA1" | "BCRYPT" | "PBKDF2_SHA256" | "SHA512" | "SHA256" | "SHA1";
 /**
  * Interface representing the user import options needed for
- * {@link BaseAuth.importUsers} method. This is used to
+ * {@link CloudFireAuth.importUsers} method. This is used to
  * provide the password hashing algorithm information.
  */
 export interface UserImportOptions {
@@ -135,7 +135,7 @@ export interface UserProviderRequest {
 }
 /**
  * Interface representing a user to import to Firebase Auth via the
- * {@link BaseAuth.importUsers} method.
+ * {@link CloudFireAuth.importUsers} method.
  */
 export interface UserImportRecord {
     /**
@@ -207,7 +207,7 @@ export interface UserImportRecord {
     multiFactor?: MultiFactorUpdateSettings;
 }
 /**
- * Interface representing the result of the {@link BaseAuth.importUsers} API.
+ * Interface representing the result of the {@link CloudFireAuth.importUsers} API.
  */
 export interface UserImportResult {
     /**

package/dist/types/firebase-admin/user-record.d.ts

@@ -251,7 +251,7 @@ export declare class UserRecord {
      * when uploading this user, as is typical when migrating from another Auth
      * system, this will be an empty string. If no password is set, this is
      * null. This is only available when the user is obtained from
-     * {@link BaseAuth.listUsers}.
+     * {@link CloudFireAuth.listUsers}.
      */
     readonly passwordHash?: string;
     /**
@@ -259,13 +259,13 @@ export declare class UserRecord {
      * algorithm (SCRYPT) is used. If a different hashing algorithm had been used to
      * upload this user, typical when migrating from another Auth system, this will
      * be an empty string. If no password is set, this is null. This is only
-     * available when the user is obtained from {@link BaseAuth.listUsers}.
+     * available when the user is obtained from {@link CloudFireAuth.listUsers}.
      */
     readonly passwordSalt?: string;
     /**
      * The user's custom claims object if available, typically used to define
      * user roles and propagated to an authenticated user's ID token.
-     * This is set via {@link BaseAuth.setCustomUserClaims}
+     * This is set via {@link CloudFireAuth.setCustomUserClaims}
      */
     readonly customClaims?: {
         [key: string]: any;
@@ -277,7 +277,7 @@ export declare class UserRecord {
     /**
      * The date the user's tokens are valid after, formatted as a UTC string.
      * This is updated every time the user's refresh token are revoked either
-     * from the {@link BaseAuth.revokeRefreshTokens}
+     * from the {@link CloudFireAuth.revokeRefreshTokens}
      * API or from the Firebase Auth backend on big account changes (password
      * resets, password or email updates, etc).
      */

package/dist/types/google-auth.d.ts

@@ -1,4 +1,4 @@
-interface ProviderUserInfo {
+export interface ProviderUserInfo {
     providerId: string;
     displayName?: string;
     photoUrl?: string;
@@ -22,4 +22,3 @@ export interface SetAccountInfoResponse {
     passwordHash: string;
     emailVerified: boolean;
 }
-export {};

package/dist/types.d.ts

@@ -1,6 +1,3 @@
-import type { DecodedIdToken, UserRecord, UserIdentifier, GetUsersResult, ListUsersResult, CreateRequest, UpdateRequest, DeleteUsersResult, SessionCookieOptions, AuthProviderConfig, UpdateAuthProviderRequest, AuthProviderConfigFilter, ListProviderConfigResults, ActionCodeSettings, UserImportRecord, UserImportOptions, UserImportResult, HashAlgorithmType, UserMetadataRequest, UserProviderRequest } from "./types/firebase-admin/index.js";
-import type { ServiceAccountKey } from "./types/service-account-key.js";
-import type { SetAccountInfoResponse } from "./types/google-auth.js";
-export type { DecodedIdToken, UserRecord, UserIdentifier, GetUsersResult, ListUsersResult, CreateRequest, UpdateRequest, DeleteUsersResult, SessionCookieOptions, AuthProviderConfig, UpdateAuthProviderRequest, AuthProviderConfigFilter, ListProviderConfigResults, ActionCodeSettings, UserImportRecord, UserImportOptions, UserImportResult, HashAlgorithmType, UserMetadataRequest, UserProviderRequest, };
-export type { ServiceAccountKey };
-export type { SetAccountInfoResponse };
+export type { DecodedIdToken, UserRecord, UserIdentifier, GetUsersResult, ListUsersResult, CreateRequest, UpdateRequest, DeleteUsersResult, SessionCookieOptions, AuthProviderConfig, UpdateAuthProviderRequest, AuthProviderConfigFilter, ListProviderConfigResults, ActionCodeSettings, UserImportRecord, UserImportOptions, UserImportResult, HashAlgorithmType, UserMetadataRequest, UserProviderRequest, SAMLAuthProviderConfig, OIDCAuthProviderConfig, SAMLUpdateAuthProviderRequest, OIDCUpdateAuthProviderRequest, MultiFactorCreateSettings, MultiFactorUpdateSettings, MultiFactorSettings, UserMetadata, UserInfo, UserProvider, FirebaseArrayIndexError, FirebaseError, UidIdentifier, EmailIdentifier, PhoneIdentifier, ProviderIdentifier, CreatePhoneMultiFactorInfoRequest, UpdatePhoneMultiFactorInfoRequest, OAuthResponseType, MultiFactorInfo, } from "./types/firebase-admin/index.js";
+export type { ServiceAccountKey } from "./types/service-account-key.js";
+export type { SetAccountInfoResponse, ProviderUserInfo } from "./types/google-auth.js";

package/package.json

@@ -1,13 +1,20 @@
 {
   "name": "cloudfire-auth",
-  "version": "0.3.3",
+  "version": "0.4.0",
   "author": "Connor Skelland",
   "license": "MIT",
   "engines": {
     "node": ">=18.0.0"
   },
   "description": "Firebase Auth in Cloudflare Workers.",
-  "homepage": "https://github.com/connor56/cloudfire-auth",
+  "homepage": "https://connor56.github.io/cloudfire-auth/",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/Connor56/cloudfire-auth.git"
+  },
+  "bugs": {
+    "url": "https://github.com/Connor56/cloudfire-auth/issues"
+  },
   "keywords": [
     "firebase",
     "auth",
@@ -27,10 +34,11 @@
   },
   "scripts": {
     "test": "vitest run",
-    "test:integration": "RUN_INTEGRATION_TESTS=true vitest run",
+    "test:integration": "npx tsx scripts/test-integration.ts",
     "build": "tsc",
     "clean": "tsx scripts/publishing/remove-dist.ts",
     "build:watch": "tsc --watch",
+    "docs:build": "npx tsx scripts/docs/build-docs.ts",
     "prepublishOnly": "npm run test && npm run clean && npm run build"
   },
   "devDependencies": {

package/dist/rest-api/index.d.ts

@@ -1,6 +0,0 @@
-export { deleteUserHandler } from "./delete-user.js";
-export { getUserHandler } from "./get-user.js";
-export { updateUserHandler } from "./update-user.js";
-export { setCustomUserClaimsHandler, checkClaimsAreValid } from "./set-custom-user-claims.js";
-export { revokeRefreshTokensHandler } from "./revoke-refresh-tokens.js";
-export { verifyIdTokenHandler, validateJwtHeader } from "./verify-id-token.js";

package/dist/rest-api/index.js

@@ -1,6 +0,0 @@
-export { deleteUserHandler } from "./delete-user.js";
-export { getUserHandler } from "./get-user.js";
-export { updateUserHandler } from "./update-user.js";
-export { setCustomUserClaimsHandler, checkClaimsAreValid } from "./set-custom-user-claims.js";
-export { revokeRefreshTokensHandler } from "./revoke-refresh-tokens.js";
-export { verifyIdTokenHandler, validateJwtHeader } from "./verify-id-token.js";