cloudfire-auth 0.1.0

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

@@ -0,0 +1 @@
+export {};

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

@@ -0,0 +1,57 @@
+/*! 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.
+ */
+/**
+ * Used for looking up an account by uid.
+ *
+ * See {@link BaseAuth.getUsers}.
+ */
+export interface UidIdentifier {
+    uid: string;
+}
+/**
+ * Used for looking up an account by email.
+ *
+ * See {@link BaseAuth.getUsers}.
+ */
+export interface EmailIdentifier {
+    email: string;
+}
+/**
+ * Used for looking up an account by phone number.
+ *
+ * See {@link BaseAuth.getUsers}.
+ */
+export interface PhoneIdentifier {
+    phoneNumber: string;
+}
+/**
+ * Used for looking up an account by federated provider.
+ *
+ * See {@link BaseAuth.getUsers}.
+ */
+export interface ProviderIdentifier {
+    providerId: string;
+    providerUid: string;
+}
+/**
+ * Identifies a user to be looked up.
+ */
+export type UserIdentifier = UidIdentifier | EmailIdentifier | PhoneIdentifier | ProviderIdentifier;
+export declare function isUidIdentifier(id: UserIdentifier): id is UidIdentifier;
+export declare function isEmailIdentifier(id: UserIdentifier): id is EmailIdentifier;
+export declare function isPhoneIdentifier(id: UserIdentifier): id is PhoneIdentifier;
+export declare function isProviderIdentifier(id: ProviderIdentifier): id is ProviderIdentifier;

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

@@ -0,0 +1 @@
+export {};

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

@@ -0,0 +1,153 @@
+/*! 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.
+ */
+import type { DecodedIdToken } from "./token-verifier.js";
+import type { UserRecord } from "./user-record.js";
+import type { CreateRequest, UpdateRequest } from "./auth-config.js";
+import type { UserIdentifier } from "./identifier.js";
+export type { DecodedIdToken, UserRecord, CreateRequest, UpdateRequest, UserIdentifier };
+/**
+ * `FirebaseError` is a subclass of the standard JavaScript `Error` object. In
+ * addition to a message string and stack trace, it contains a string code.
+ */
+export interface FirebaseError {
+    /**
+     * Error codes are strings using the following format: `"service/string-code"`.
+     * Some examples include `"auth/invalid-uid"` and
+     * `"messaging/invalid-recipient"`.
+     *
+     * While the message for a given error can change, the code will remain the same
+     * between backward-compatible versions of the Firebase SDK.
+     */
+    code: string;
+    /**
+     * An explanatory message for the error that just occurred.
+     *
+     * This message is designed to be helpful to you, the developer. Because
+     * it generally does not convey meaningful information to end users,
+     * this message should not be displayed in your application.
+     */
+    message: string;
+    /**
+     * A string value containing the execution backtrace when the error originally
+     * occurred.
+     *
+     * This information can be useful for troubleshooting the cause of the error with
+     * {@link https://firebase.google.com/support | Firebase Support}.
+     */
+    stack?: string;
+    /**
+     * Returns a JSON-serializable object representation of this error.
+     *
+     * @returns A JSON-serializable representation of this object.
+     */
+    toJSON(): object;
+}
+/**
+ * Composite type which includes both a `FirebaseError` object and an index
+ * which can be used to get the errored item.
+ *
+ * @example
+ * ```javascript
+ * var registrationTokens = [token1, token2, token3];
+ * admin.messaging().subscribeToTopic(registrationTokens, 'topic-name')
+ *   .then(function(response) {
+ *     if (response.failureCount > 0) {
+ *       console.log("Following devices unsucessfully subscribed to topic:");
+ *       response.errors.forEach(function(error) {
+ *         var invalidToken = registrationTokens[error.index];
+ *         console.log(invalidToken, error.error);
+ *       });
+ *     } else {
+ *       console.log("All devices successfully subscribed to topic:", response);
+ *     }
+ *   })
+ *   .catch(function(error) {
+ *     console.log("Error subscribing to topic:", error);
+ *   });
+ *```
+ */
+export interface FirebaseArrayIndexError {
+    /**
+     * The index of the errored item within the original array passed as part of the
+     * called API method.
+     */
+    index: number;
+    /**
+     * The error object.
+     */
+    error: FirebaseError;
+}
+/** Represents the result of the {@link BaseAuth.getUsers} API. */
+export interface GetUsersResult {
+    /**
+     * Set of user records, corresponding to the set of users that were
+     * requested. Only users that were found are listed here. The result set is
+     * unordered.
+     */
+    users: UserRecord[];
+    /** Set of identifiers that were requested, but not found. */
+    notFound: UserIdentifier[];
+}
+/**
+ * Interface representing the object returned from a
+ * {@link BaseAuth.listUsers} operation. Contains the list
+ * of users for the current batch and the next page token if available.
+ */
+export interface ListUsersResult {
+    /**
+     * The list of {@link UserRecord} objects for the
+     * current downloaded batch.
+     */
+    users: UserRecord[];
+    /**
+     * The next page token if available. This is needed for the next batch download.
+     */
+    pageToken?: string;
+}
+/**
+ * Represents the result of the {@link BaseAuth.deleteUsers}.
+ * API.
+ */
+export interface DeleteUsersResult {
+    /**
+     * The number of user records that failed to be deleted (possibly zero).
+     */
+    failureCount: number;
+    /**
+     * The number of users that were deleted successfully (possibly zero).
+     * Users that did not exist prior to calling `deleteUsers()` are
+     * considered to be successfully deleted.
+     */
+    successCount: number;
+    /**
+     * A list of `FirebaseArrayIndexError` instances describing the errors that
+     * were encountered during the deletion. Length of this list is equal to
+     * the return value of {@link DeleteUsersResult.failureCount}.
+     */
+    errors: FirebaseArrayIndexError[];
+}
+/**
+ * Interface representing the session cookie options needed for the
+ * {@link BaseAuth.createSessionCookie} method.
+ */
+export interface SessionCookieOptions {
+    /**
+     * The session cookie custom expiration in milliseconds. The minimum allowed is
+     * 5 minutes and the maxium allowed is 2 weeks.
+     */
+    expiresIn: number;
+}

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

@@ -0,0 +1 @@
+export {};

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

@@ -0,0 +1,219 @@
+/*! 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.
+ */
+/**
+ * Interface representing a decoded Firebase ID token, returned from the
+ * {@link BaseAuth.verifyIdToken} method.
+ *
+ * Firebase ID tokens are OpenID Connect spec-compliant JSON Web Tokens (JWTs).
+ * See the
+ * [ID Token section of the OpenID Connect spec](http://openid.net/specs/openid-connect-core-1_0.html#IDToken)
+ * for more information about the specific properties below.
+ */
+export interface DecodedIdToken {
+    /**
+     * The audience for which this token is intended.
+     *
+     * This value is a string equal to your Firebase project ID, the unique
+     * identifier for your Firebase project, which can be found in [your project's
+     * settings](https://console.firebase.google.com/project/_/settings/general/android:com.random.android).
+     */
+    aud: string;
+    /**
+     * Time, in seconds since the Unix epoch, when the end-user authentication
+     * occurred.
+     *
+     * This value is not set when this particular ID token was created, but when the
+     * user initially logged in to this session. In a single session, the Firebase
+     * SDKs will refresh a user's ID tokens every hour. Each ID token will have a
+     * different [`iat`](#iat) value, but the same `auth_time` value.
+     */
+    auth_time: number;
+    /**
+     * The email of the user to whom the ID token belongs, if available.
+     */
+    email?: string;
+    /**
+     * Whether or not the email of the user to whom the ID token belongs is
+     * verified, provided the user has an email.
+     */
+    email_verified?: boolean;
+    /**
+     * The ID token's expiration time, in seconds since the Unix epoch. That is, the
+     * time at which this ID token expires and should no longer be considered valid.
+     *
+     * The Firebase SDKs transparently refresh ID tokens every hour, issuing a new
+     * ID token with up to a one hour expiration.
+     */
+    exp: number;
+    /**
+     * Information about the sign in event, including which sign in provider was
+     * used and provider-specific identity details.
+     *
+     * This data is provided by the Firebase Authentication service and is a
+     * reserved claim in the ID token.
+     */
+    firebase: {
+        /**
+         * Provider-specific identity details corresponding
+         * to the provider used to sign in the user.
+         */
+        identities: {
+            [key: string]: any;
+        };
+        /**
+         * The ID of the provider used to sign in the user.
+         * One of `"anonymous"`, `"password"`, `"facebook.com"`, `"github.com"`,
+         * `"google.com"`, `"twitter.com"`, `"apple.com"`, `"microsoft.com"`,
+         * `"yahoo.com"`, `"phone"`, `"playgames.google.com"`, `"gc.apple.com"`,
+         * or `"custom"`.
+         *
+         * Additional Identity Platform provider IDs include `"linkedin.com"`,
+         * OIDC and SAML identity providers prefixed with `"saml."` and `"oidc."`
+         * respectively.
+         */
+        sign_in_provider: string;
+        /**
+         * The type identifier or `factorId` of the second factor, provided the
+         * ID token was obtained from a multi-factor authenticated user.
+         * For phone, this is `"phone"`.
+         */
+        sign_in_second_factor?: string;
+        /**
+         * The `uid` of the second factor used to sign in, provided the
+         * ID token was obtained from a multi-factor authenticated user.
+         */
+        second_factor_identifier?: string;
+        /**
+         * The ID of the tenant the user belongs to, if available.
+         */
+        tenant?: string;
+        [key: string]: any;
+    };
+    /**
+     * The ID token's issued-at time, in seconds since the Unix epoch. That is, the
+     * time at which this ID token was issued and should start to be considered
+     * valid.
+     *
+     * The Firebase SDKs transparently refresh ID tokens every hour, issuing a new
+     * ID token with a new issued-at time. If you want to get the time at which the
+     * user session corresponding to the ID token initially occurred, see the
+     * [`auth_time`](#auth_time) property.
+     */
+    iat: number;
+    /**
+     * The issuer identifier for the issuer of the response.
+     *
+     * This value is a URL with the format
+     * `https://securetoken.google.com/<PROJECT_ID>`, where `<PROJECT_ID>` is the
+     * same project ID specified in the [`aud`](#aud) property.
+     */
+    iss: string;
+    /**
+     * The phone number of the user to whom the ID token belongs, if available.
+     */
+    phone_number?: string;
+    /**
+     * The photo URL for the user to whom the ID token belongs, if available.
+     */
+    picture?: string;
+    /**
+     * The `uid` corresponding to the user who the ID token belonged to.
+     *
+     * As a convenience, this value is copied over to the [`uid`](#uid) property.
+     */
+    sub: string;
+    /**
+     * The `uid` corresponding to the user who the ID token belonged to.
+     *
+     * This value is not actually in the JWT token claims itself. It is added as a
+     * convenience, and is set as the value of the [`sub`](#sub) property.
+     */
+    uid: string;
+    /**
+     * Other arbitrary claims included in the ID token.
+     */
+    [key: string]: any;
+}
+/** @alpha */
+export interface DecodedAuthBlockingSharedUserInfo {
+    uid: string;
+    display_name?: string;
+    email?: string;
+    photo_url?: string;
+    phone_number?: string;
+}
+/** @alpha */
+export interface DecodedAuthBlockingMetadata {
+    creation_time?: number;
+    last_sign_in_time?: number;
+}
+/** @alpha */
+export interface DecodedAuthBlockingUserInfo extends DecodedAuthBlockingSharedUserInfo {
+    provider_id: string;
+}
+/** @alpha */
+export interface DecodedAuthBlockingMfaInfo {
+    uid: string;
+    display_name?: string;
+    phone_number?: string;
+    enrollment_time?: string;
+    factor_id?: string;
+}
+/** @alpha */
+export interface DecodedAuthBlockingEnrolledFactors {
+    enrolled_factors?: DecodedAuthBlockingMfaInfo[];
+}
+/** @alpha */
+export interface DecodedAuthBlockingUserRecord extends DecodedAuthBlockingSharedUserInfo {
+    email_verified?: boolean;
+    disabled?: boolean;
+    metadata?: DecodedAuthBlockingMetadata;
+    password_hash?: string;
+    password_salt?: string;
+    provider_data?: DecodedAuthBlockingUserInfo[];
+    multi_factor?: DecodedAuthBlockingEnrolledFactors;
+    custom_claims?: any;
+    tokens_valid_after_time?: number;
+    tenant_id?: string;
+    [key: string]: any;
+}
+/** @alpha */
+export interface DecodedAuthBlockingToken {
+    aud: string;
+    exp: number;
+    iat: number;
+    iss: string;
+    sub: string;
+    event_id: string;
+    event_type: string;
+    ip_address: string;
+    user_agent?: string;
+    locale?: string;
+    sign_in_method?: string;
+    user_record?: DecodedAuthBlockingUserRecord;
+    tenant_id?: string;
+    raw_user_info?: string;
+    sign_in_attributes?: {
+        [key: string]: any;
+    };
+    oauth_id_token?: string;
+    oauth_access_token?: string;
+    oauth_refresh_token?: string;
+    oauth_token_secret?: string;
+    oauth_expires_in?: number;
+    [key: string]: any;
+}

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

@@ -0,0 +1 @@
+export {};