cloudfire-auth 0.1.0 → 0.3.0

package/dist/rest-api/generate-verify-and-change-email-link.d.ts

@@ -0,0 +1,20 @@
+import type { ActionCodeSettings } from "../types.js";
+/**
+ * Generates an out-of-band email action link to verify and change a user's email.
+ *
+ * This link allows users to verify ownership of a new email address before updating
+ * their account email. The optional ActionCodeSettings object defines mobile app
+ * handling and additional state.
+ *
+ * @param email - The current email account
+ * @param newEmail - The email address the account is being updated to
+ * @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 generateVerifyAndChangeEmailLinkHandler(email: string, newEmail: string, actionCodeSettings: ActionCodeSettings | undefined, oauth2AccessToken: string): Promise<string>;

package/dist/rest-api/generate-verify-and-change-email-link.js

@@ -0,0 +1,21 @@
+/**
+ * Generates an out-of-band email action link to verify and change a user's email.
+ *
+ * This link allows users to verify ownership of a new email address before updating
+ * their account email. The optional ActionCodeSettings object defines mobile app
+ * handling and additional state.
+ *
+ * @param email - The current email account
+ * @param newEmail - The email address the account is being updated to
+ * @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 generateVerifyAndChangeEmailLinkHandler(email, newEmail, actionCodeSettings, oauth2AccessToken) {
+    throw new Error("Not implemented");
+}

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

@@ -0,0 +1,17 @@
+import type { AuthProviderConfig } from "../types.js";
+/**
+ * Retrieves an Auth provider configuration by provider ID.
+ *
+ * Returns the provider configuration for the specified ID. Throws an error if
+ * the configuration does not exist.
+ *
+ * @param providerId - The provider ID corresponding to the provider config
+ * @param oauth2AccessToken - OAuth2 access token for Firebase Admin API
+ * @returns Promise that resolves to the provider configuration
+ *
+ * @throws {Error} Not yet implemented
+ *
+ * @package
+ * @internal
+ */
+export declare function getProviderConfigHandler(providerId: string, oauth2AccessToken: string): Promise<AuthProviderConfig>;

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

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

package/dist/rest-api/import-users.d.ts

@@ -0,0 +1,18 @@
+import type { UserImportRecord, UserImportOptions, UserImportResult } from "../types.js";
+/**
+ * Imports a list of users into Firebase Auth.
+ *
+ * A maximum of 1000 users can be imported at once. When importing users with passwords,
+ * UserImportOptions are required to specify the hash algorithm.
+ *
+ * @param users - The list of user records to import
+ * @param options - Optional import options, required when importing password hashes
+ * @param oauth2AccessToken - OAuth2 access token for Firebase Admin API
+ * @returns Promise that resolves to the import result
+ *
+ * @throws {Error} Not yet implemented
+ *
+ * @package
+ * @internal
+ */
+export declare function importUsersHandler(users: UserImportRecord[], options: UserImportOptions | undefined, oauth2AccessToken: string): Promise<UserImportResult>;

package/dist/rest-api/import-users.js

@@ -0,0 +1,19 @@
+/**
+ * Imports a list of users into Firebase Auth.
+ *
+ * A maximum of 1000 users can be imported at once. When importing users with passwords,
+ * UserImportOptions are required to specify the hash algorithm.
+ *
+ * @param users - The list of user records to import
+ * @param options - Optional import options, required when importing password hashes
+ * @param oauth2AccessToken - OAuth2 access token for Firebase Admin API
+ * @returns Promise that resolves to the import result
+ *
+ * @throws {Error} Not yet implemented
+ *
+ * @package
+ * @internal
+ */
+export async function importUsersHandler(users, options, oauth2AccessToken) {
+    throw new Error("Not implemented");
+}

package/dist/rest-api/list-provider-configs.d.ts

@@ -0,0 +1,17 @@
+import type { AuthProviderConfigFilter, ListProviderConfigResults } from "../types.js";
+/**
+ * Lists provider configurations matching the specified filter.
+ *
+ * Returns a list of SAML or OIDC provider configurations. At most 100 provider
+ * configs can be listed at a time.
+ *
+ * @param options - The provider config filter to apply
+ * @param oauth2AccessToken - OAuth2 access token for Firebase Admin API
+ * @returns Promise that resolves to the list of provider configs
+ *
+ * @throws {Error} Not yet implemented
+ *
+ * @package
+ * @internal
+ */
+export declare function listProviderConfigsHandler(options: AuthProviderConfigFilter, oauth2AccessToken: string): Promise<ListProviderConfigResults>;

package/dist/rest-api/list-provider-configs.js

@@ -0,0 +1,18 @@
+/**
+ * Lists provider configurations matching the specified filter.
+ *
+ * Returns a list of SAML or OIDC provider configurations. At most 100 provider
+ * configs can be listed at a time.
+ *
+ * @param options - The provider config filter to apply
+ * @param oauth2AccessToken - OAuth2 access token for Firebase Admin API
+ * @returns Promise that resolves to the list of provider configs
+ *
+ * @throws {Error} Not yet implemented
+ *
+ * @package
+ * @internal
+ */
+export async function listProviderConfigsHandler(options, oauth2AccessToken) {
+    throw new Error("Not implemented");
+}

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

@@ -0,0 +1,18 @@
+import type { UpdateAuthProviderRequest, AuthProviderConfig } from "../types.js";
+/**
+ * Updates an existing Auth provider configuration.
+ *
+ * Updates the provider configuration for the specified provider ID with the
+ * new settings. Throws an error if the configuration does not exist.
+ *
+ * @param providerId - The provider ID corresponding to the provider config to update
+ * @param updatedConfig - The updated configuration
+ * @param oauth2AccessToken - OAuth2 access token for Firebase Admin API
+ * @returns Promise that resolves to the updated provider configuration
+ *
+ * @throws {Error} Not yet implemented
+ *
+ * @package
+ * @internal
+ */
+export declare function updateProviderConfigHandler(providerId: string, updatedConfig: UpdateAuthProviderRequest, oauth2AccessToken: string): Promise<AuthProviderConfig>;

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

@@ -0,0 +1,19 @@
+/**
+ * Updates an existing Auth provider configuration.
+ *
+ * Updates the provider configuration for the specified provider ID with the
+ * new settings. Throws an error if the configuration does not exist.
+ *
+ * @param providerId - The provider ID corresponding to the provider config to update
+ * @param updatedConfig - The updated configuration
+ * @param oauth2AccessToken - OAuth2 access token for Firebase Admin API
+ * @returns Promise that resolves to the updated provider configuration
+ *
+ * @throws {Error} Not yet implemented
+ *
+ * @package
+ * @internal
+ */
+export async function updateProviderConfigHandler(providerId, updatedConfig, oauth2AccessToken) {
+    throw new Error("Not implemented");
+}

package/dist/types/firebase-admin/action-code-settings.d.ts

@@ -0,0 +1,102 @@
+/*! firebase-admin v13.4.0 */
+/*!
+ * Copyright 2018 Google Inc.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *   http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+/**
+ * You can find the code taken from the Firebase Admin SDK in this location of
+ * the firebase-admin 13.4.0 npm package:
+ *
+ * firebase-admin/lib/auth/action-code-settings-builder.d.ts
+ */
+/**
+ * This is the interface that defines the required continue/state URL with
+ * optional Android and iOS bundle identifiers.
+ */
+export interface ActionCodeSettings {
+    /**
+     * Defines the link continue/state URL, which has different meanings in
+     * different contexts:
+     * <ul>
+     * <li>When the link is handled in the web action widgets, this is the deep
+     *     link in the `continueUrl` query parameter.</li>
+     * <li>When the link is handled in the app directly, this is the `continueUrl`
+     *     query parameter in the deep link of the Dynamic Link.</li>
+     * </ul>
+     */
+    url: string;
+    /**
+     * Whether to open the link via a mobile app or a browser.
+     * The default is false. When set to true, the action code link is sent
+     * as a Universal Link or Android App Link and is opened by the app if
+     * installed. In the false case, the code is sent to the web widget first
+     * and then redirects to the app if installed.
+     */
+    handleCodeInApp?: boolean;
+    /**
+     * Defines the iOS bundle ID. This will try to open the link in an iOS app if it
+     * is installed.
+     */
+    iOS?: {
+        /**
+         * Defines the required iOS bundle ID of the app where the link should be
+         * handled if the application is already installed on the device.
+         */
+        bundleId: string;
+    };
+    /**
+     * Defines the Android package name. This will try to open the link in an
+     * android app if it is installed. If `installApp` is passed, it specifies
+     * whether to install the Android app if the device supports it and the app is
+     * not already installed. If this field is provided without a `packageName`, an
+     * error is thrown explaining that the `packageName` must be provided in
+     * conjunction with this field. If `minimumVersion` is specified, and an older
+     * version of the app is installed, the user is taken to the Play Store to
+     * upgrade the app.
+     */
+    android?: {
+        /**
+         * Defines the required Android package name of the app where the link should be
+         * handled if the Android app is installed.
+         */
+        packageName: string;
+        /**
+         * Whether to install the Android app if the device supports it and the app is
+         * not already installed.
+         */
+        installApp?: boolean;
+        /**
+         * The Android minimum version if available. If the installed app is an older
+         * version, the user is taken to the GOogle Play Store to upgrade the app.
+         */
+        minimumVersion?: string;
+    };
+    /**
+     * Defines the dynamic link domain to use for the current link if it is to be
+     * opened using Firebase Dynamic Links, as multiple dynamic link domains can be
+     * configured per project. This field provides the ability to explicitly choose
+     * configured per project. This fields provides the ability explicitly choose
+     * one. If none is provided, the oldest domain is used by default.
+     * @deprecated use `linkDomain` instead
+     */
+    dynamicLinkDomain?: string;
+    /**
+     * Defines the custom Firebase Hosting domain to use when the link is to be opened
+     * via a specified mobile app,
+     * This is a replacement of Firebase Dynamic Link.
+     * If none is provided,
+     * a default hosting domain will be used (for example, `example.firebaseapp.com`)
+     */
+    linkDomain?: string;
+}

package/dist/types/firebase-admin/action-code-settings.js

@@ -0,0 +1,17 @@
+/*! firebase-admin v13.4.0 */
+/*!
+ * Copyright 2018 Google Inc.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *   http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+export {};

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

@@ -14,6 +14,12 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
+/**
+ * You can find the code taken from the Firebase Admin SDK in this location of
+ * the firebase-admin 13.4.0 npm package:
+ *
+ * firebase-admin/lib/auth/auth-config.d.ts
+ */
 /**
  * Interface representing base properties of a user-enrolled second factor for a
  * `CreateRequest`.
@@ -226,7 +232,7 @@ export interface AuthProviderConfigFilter {
      * The former is used to look up SAML providers only, while the latter is used
      * for OIDC providers.
      */
-    type: 'saml' | 'oidc';
+    type: "saml" | "oidc";
     /**
      * The maximum number of results to return per page. The default and maximum is
      * 100.
@@ -381,7 +387,7 @@ export interface EmailSignInConfigServerRequest {
     enableEmailLinkSignin?: boolean;
 }
 /** Identifies the server side second factor type. */
-type AuthFactorServerType = 'PHONE_SMS';
+type AuthFactorServerType = "PHONE_SMS";
 /** Server side multi-factor configuration. */
 export interface MultiFactorAuthServerConfig {
     state?: MultiFactorConfigState;
@@ -391,11 +397,11 @@ export interface MultiFactorAuthServerConfig {
 /**
  * Identifies a second factor type.
  */
-export type AuthFactorType = 'phone';
+export type AuthFactorType = "phone";
 /**
  * Identifies a multi-factor configuration state.
  */
-export type MultiFactorConfigState = 'ENABLED' | 'DISABLED';
+export type MultiFactorConfigState = "ENABLED" | "DISABLED";
 /**
  * Interface representing a multi-factor configuration.
  * This can be used to define whether multi-factor authentication is enabled
@@ -433,8 +439,8 @@ export interface MultiFactorConfig {
  */
 export interface TotpMultiFactorProviderConfig {
     /**
-      *  The allowed number of adjacent intervals that will be used for verification
-      *  to compensate for clock skew.   */
+     *  The allowed number of adjacent intervals that will be used for verification
+     *  to compensate for clock skew.   */
     adjacentIntervals?: number;
 }
 /**
@@ -630,25 +636,25 @@ export interface AllowByDefault {
  */
 export interface AllowlistOnly {
     /**
-   * Two letter unicode region codes to allow as defined by
-   * https://cldr.unicode.org/
-   * The full list of these region codes is here:
-   * https://github.com/unicode-cldr/cldr-localenames-full/blob/master/main/en/territories.json
-   */
+     * Two letter unicode region codes to allow as defined by
+     * https://cldr.unicode.org/
+     * The full list of these region codes is here:
+     * https://github.com/unicode-cldr/cldr-localenames-full/blob/master/main/en/territories.json
+     */
     allowedRegions: string[];
 }
 /**
-* Enforcement state of reCAPTCHA protection.
-*   - 'OFF': Unenforced.
-*   - 'AUDIT': Create assessment but don't enforce the result.
-*   - 'ENFORCE': Create assessment and enforce the result.
-*/
-export type RecaptchaProviderEnforcementState = 'OFF' | 'AUDIT' | 'ENFORCE';
+ * Enforcement state of reCAPTCHA protection.
+ *   - 'OFF': Unenforced.
+ *   - 'AUDIT': Create assessment but don't enforce the result.
+ *   - 'ENFORCE': Create assessment and enforce the result.
+ */
+export type RecaptchaProviderEnforcementState = "OFF" | "AUDIT" | "ENFORCE";
 /**
-* The actions to take for reCAPTCHA-protected requests.
-*   - 'BLOCK': The reCAPTCHA-protected request will be blocked.
-*/
-export type RecaptchaAction = 'BLOCK';
+ * The actions to take for reCAPTCHA-protected requests.
+ *   - 'BLOCK': The reCAPTCHA-protected request will be blocked.
+ */
+export type RecaptchaAction = "BLOCK";
 /**
  * The config for a reCAPTCHA action rule.
  */
@@ -658,8 +664,8 @@ export interface RecaptchaManagedRule {
      */
     endScore: number;
     /**
-    * The action for reCAPTCHA-protected requests.
-    */
+     * The action for reCAPTCHA-protected requests.
+     */
     action?: RecaptchaAction;
 }
 /**
@@ -668,8 +674,8 @@ export interface RecaptchaManagedRule {
  */
 export interface RecaptchaTollFraudManagedRule {
     /**
-    * The action will be enforced if the reCAPTCHA score of a request is larger than startScore.
-    */
+     * The action will be enforced if the reCAPTCHA score of a request is larger than startScore.
+     */
     startScore: number;
     /**
      * The action for reCAPTCHA-protected requests.
@@ -679,7 +685,7 @@ export interface RecaptchaTollFraudManagedRule {
 /**
  * The key's platform type.
  */
-export type RecaptchaKeyClientType = 'WEB' | 'IOS' | 'ANDROID';
+export type RecaptchaKeyClientType = "WEB" | "IOS" | "ANDROID";
 /**
  * The reCAPTCHA key config.
  */
@@ -701,12 +707,12 @@ export interface RecaptchaKey {
  */
 export interface RecaptchaConfig {
     /**
-    * The enforcement state of the email password provider.
-    */
+     * The enforcement state of the email password provider.
+     */
     emailPasswordEnforcementState?: RecaptchaProviderEnforcementState;
     /**
-    * The enforcement state of the phone provider.
-    */
+     * The enforcement state of the phone provider.
+     */
     phoneEnforcementState?: RecaptchaProviderEnforcementState;
     /**
      *  The reCAPTCHA managed rules.
@@ -752,7 +758,7 @@ export interface RecaptchaAuthServerConfig {
 }
 /**
  * A password policy configuration for a project or tenant
-*/
+ */
 export interface PasswordPolicyConfig {
     /**
      * Enforcement state of the password policy
@@ -780,11 +786,11 @@ export interface MobileLinksConfig {
 /**
  * Open code in app domain to use for app links and universal links.
  */
-export type MobileLinksDomain = 'HOSTING_DOMAIN' | 'FIREBASE_DYNAMIC_LINK_DOMAIN';
+export type MobileLinksDomain = "HOSTING_DOMAIN" | "FIREBASE_DYNAMIC_LINK_DOMAIN";
 /**
  * A password policy's enforcement state.
  */
-export type PasswordPolicyEnforcementState = 'ENFORCE' | 'OFF';
+export type PasswordPolicyEnforcementState = "ENFORCE" | "OFF";
 /**
  * Constraints to be enforced on the password policy
  */

package/dist/types/firebase-admin/auth-config.js

@@ -1 +1,17 @@
+/*! firebase-admin v13.4.0 */
+/*!
+ * Copyright 2018 Google Inc.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *   http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
 export {};

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

@@ -14,6 +14,12 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
+/**
+ * You can find the code taken from the Firebase Admin SDK in this location of
+ * the firebase-admin 13.4.0 npm package:
+ *
+ * firebase-admin/lib/auth/identifier.d.ts
+ */
 /**
  * Used for looking up an account by uid.
  *

package/dist/types/firebase-admin/identifier.js

@@ -1 +1,17 @@
+/*! firebase-admin v13.4.0 */
+/*!
+ * Copyright 2020 Google Inc.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *   http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
 export {};

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

@@ -14,11 +14,20 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
+/**
+ * You can find the code taken from the Firebase Admin SDK in this location of
+ * the firebase-admin 13.4.0 npm package:
+ *
+ * firebase-admin/lib/auth/base-auth.d.ts
+ * firebase-admin/lib/app/index.d.ts
+ */
 import type { DecodedIdToken } from "./token-verifier.js";
 import type { UserRecord } from "./user-record.js";
-import type { CreateRequest, UpdateRequest } from "./auth-config.js";
+import type { CreateRequest, UpdateRequest, AuthProviderConfig, UpdateAuthProviderRequest, AuthProviderConfigFilter, ListProviderConfigResults } from "./auth-config.js";
 import type { UserIdentifier } from "./identifier.js";
-export type { DecodedIdToken, UserRecord, CreateRequest, UpdateRequest, UserIdentifier };
+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, };
 /**
  * `FirebaseError` is a subclass of the standard JavaScript `Error` object. In
  * addition to a message string and stack trace, it contains a string code.

package/dist/types/firebase-admin/index.js

@@ -1 +1,17 @@
+/*! firebase-admin v13.4.0 */
+/*!
+ * Copyright 2021 Google Inc.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *   http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
 export {};

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

@@ -14,6 +14,12 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
+/**
+ * You can find the code taken from the Firebase Admin SDK in this location of
+ * the firebase-admin 13.4.0 npm package:
+ *
+ * firebase-admin/lib/auth/token-verifier.d.ts
+ */
 /**
  * Interface representing a decoded Firebase ID token, returned from the
  * {@link BaseAuth.verifyIdToken} method.

package/dist/types/firebase-admin/token-verifier.js

@@ -1 +1,17 @@
+/*! firebase-admin v13.4.0 */
+/*!
+ * Copyright 2018 Google Inc.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *   http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
 export {};