@firebase/auth 1.8.0 → 1.8.1

package/dist/node/src/core/providers/oauth.d.ts

@@ -1,151 +1,151 @@
-/**
- * @license
- * Copyright 2019 Google LLC
- *
- * 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 { AuthProvider, UserCredential } from '../../model/public_types';
-import { OAuthCredential } from '../credentials/oauth';
-import { FirebaseError } from '@firebase/util';
-import { FederatedAuthProvider } from './federated';
-/**
- * Defines the options for initializing an {@link OAuthCredential}.
- *
- * @remarks
- * For ID tokens with nonce claim, the raw nonce has to also be provided.
- *
- * @public
- */
-export interface OAuthCredentialOptions {
-    /**
-     * The OAuth ID token used to initialize the {@link OAuthCredential}.
-     */
-    idToken?: string;
-    /**
-     * The OAuth access token used to initialize the {@link OAuthCredential}.
-     */
-    accessToken?: string;
-    /**
-     * The raw nonce associated with the ID token.
-     *
-     * @remarks
-     * It is required when an ID token with a nonce field is provided. The SHA-256 hash of the
-     * raw nonce must match the nonce field in the ID token.
-     */
-    rawNonce?: string;
-}
-/**
- * Common code to all OAuth providers. This is separate from the
- * {@link OAuthProvider} so that child providers (like
- * {@link GoogleAuthProvider}) don't inherit the `credential` instance method.
- * Instead, they rely on a static `credential` method.
- */
-export declare abstract class BaseOAuthProvider extends FederatedAuthProvider implements AuthProvider {
-    /** @internal */
-    private scopes;
-    /**
-     * Add an OAuth scope to the credential.
-     *
-     * @param scope - Provider OAuth scope to add.
-     */
-    addScope(scope: string): AuthProvider;
-    /**
-     * Retrieve the current list of OAuth scopes.
-     */
-    getScopes(): string[];
-}
-/**
- * Provider for generating generic {@link OAuthCredential}.
- *
- * @example
- * ```javascript
- * // Sign in using a redirect.
- * const provider = new OAuthProvider('google.com');
- * // Start a sign in process for an unauthenticated user.
- * provider.addScope('profile');
- * provider.addScope('email');
- * await signInWithRedirect(auth, provider);
- * // This will trigger a full page redirect away from your app
- *
- * // After returning from the redirect when your app initializes you can obtain the result
- * const result = await getRedirectResult(auth);
- * if (result) {
- *   // This is the signed-in user
- *   const user = result.user;
- *   // This gives you a OAuth Access Token for the provider.
- *   const credential = provider.credentialFromResult(auth, result);
- *   const token = credential.accessToken;
- * }
- * ```
- *
- * @example
- * ```javascript
- * // Sign in using a popup.
- * const provider = new OAuthProvider('google.com');
- * provider.addScope('profile');
- * provider.addScope('email');
- * const result = await signInWithPopup(auth, provider);
- *
- * // The signed-in user info.
- * const user = result.user;
- * // This gives you a OAuth Access Token for the provider.
- * const credential = provider.credentialFromResult(auth, result);
- * const token = credential.accessToken;
- * ```
- * @public
- */
-export declare class OAuthProvider extends BaseOAuthProvider {
-    /**
-     * Creates an {@link OAuthCredential} from a JSON string or a plain object.
-     * @param json - A plain object or a JSON string
-     */
-    static credentialFromJSON(json: object | string): OAuthCredential;
-    /**
-     * Creates a {@link OAuthCredential} from a generic OAuth provider's access token or ID token.
-     *
-     * @remarks
-     * The raw nonce is required when an ID token with a nonce field is provided. The SHA-256 hash of
-     * the raw nonce must match the nonce field in the ID token.
-     *
-     * @example
-     * ```javascript
-     * // `googleUser` from the onsuccess Google Sign In callback.
-     * // Initialize a generate OAuth provider with a `google.com` providerId.
-     * const provider = new OAuthProvider('google.com');
-     * const credential = provider.credential({
-     *   idToken: googleUser.getAuthResponse().id_token,
-     * });
-     * const result = await signInWithCredential(credential);
-     * ```
-     *
-     * @param params - Either the options object containing the ID token, access token and raw nonce
-     * or the ID token string.
-     */
-    credential(params: OAuthCredentialOptions): OAuthCredential;
-    /** An internal credential method that accepts more permissive options */
-    private _credential;
-    /**
-     * Used to extract the underlying {@link OAuthCredential} from a {@link UserCredential}.
-     *
-     * @param userCredential - The user credential.
-     */
-    static credentialFromResult(userCredential: UserCredential): OAuthCredential | null;
-    /**
-     * Used to extract the underlying {@link OAuthCredential} from a {@link AuthError} which was
-     * thrown during a sign-in, link, or reauthenticate operation.
-     *
-     * @param userCredential - The user credential.
-     */
-    static credentialFromError(error: FirebaseError): OAuthCredential | null;
-    private static oauthCredentialFromTaggedObject;
-}
+/**
+ * @license
+ * Copyright 2019 Google LLC
+ *
+ * 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 { AuthProvider, UserCredential } from '../../model/public_types';
+import { OAuthCredential } from '../credentials/oauth';
+import { FirebaseError } from '@firebase/util';
+import { FederatedAuthProvider } from './federated';
+/**
+ * Defines the options for initializing an {@link OAuthCredential}.
+ *
+ * @remarks
+ * For ID tokens with nonce claim, the raw nonce has to also be provided.
+ *
+ * @public
+ */
+export interface OAuthCredentialOptions {
+    /**
+     * The OAuth ID token used to initialize the {@link OAuthCredential}.
+     */
+    idToken?: string;
+    /**
+     * The OAuth access token used to initialize the {@link OAuthCredential}.
+     */
+    accessToken?: string;
+    /**
+     * The raw nonce associated with the ID token.
+     *
+     * @remarks
+     * It is required when an ID token with a nonce field is provided. The SHA-256 hash of the
+     * raw nonce must match the nonce field in the ID token.
+     */
+    rawNonce?: string;
+}
+/**
+ * Common code to all OAuth providers. This is separate from the
+ * {@link OAuthProvider} so that child providers (like
+ * {@link GoogleAuthProvider}) don't inherit the `credential` instance method.
+ * Instead, they rely on a static `credential` method.
+ */
+export declare abstract class BaseOAuthProvider extends FederatedAuthProvider implements AuthProvider {
+    /** @internal */
+    private scopes;
+    /**
+     * Add an OAuth scope to the credential.
+     *
+     * @param scope - Provider OAuth scope to add.
+     */
+    addScope(scope: string): AuthProvider;
+    /**
+     * Retrieve the current list of OAuth scopes.
+     */
+    getScopes(): string[];
+}
+/**
+ * Provider for generating generic {@link OAuthCredential}.
+ *
+ * @example
+ * ```javascript
+ * // Sign in using a redirect.
+ * const provider = new OAuthProvider('google.com');
+ * // Start a sign in process for an unauthenticated user.
+ * provider.addScope('profile');
+ * provider.addScope('email');
+ * await signInWithRedirect(auth, provider);
+ * // This will trigger a full page redirect away from your app
+ *
+ * // After returning from the redirect when your app initializes you can obtain the result
+ * const result = await getRedirectResult(auth);
+ * if (result) {
+ *   // This is the signed-in user
+ *   const user = result.user;
+ *   // This gives you a OAuth Access Token for the provider.
+ *   const credential = provider.credentialFromResult(auth, result);
+ *   const token = credential.accessToken;
+ * }
+ * ```
+ *
+ * @example
+ * ```javascript
+ * // Sign in using a popup.
+ * const provider = new OAuthProvider('google.com');
+ * provider.addScope('profile');
+ * provider.addScope('email');
+ * const result = await signInWithPopup(auth, provider);
+ *
+ * // The signed-in user info.
+ * const user = result.user;
+ * // This gives you a OAuth Access Token for the provider.
+ * const credential = provider.credentialFromResult(auth, result);
+ * const token = credential.accessToken;
+ * ```
+ * @public
+ */
+export declare class OAuthProvider extends BaseOAuthProvider {
+    /**
+     * Creates an {@link OAuthCredential} from a JSON string or a plain object.
+     * @param json - A plain object or a JSON string
+     */
+    static credentialFromJSON(json: object | string): OAuthCredential;
+    /**
+     * Creates a {@link OAuthCredential} from a generic OAuth provider's access token or ID token.
+     *
+     * @remarks
+     * The raw nonce is required when an ID token with a nonce field is provided. The SHA-256 hash of
+     * the raw nonce must match the nonce field in the ID token.
+     *
+     * @example
+     * ```javascript
+     * // `googleUser` from the onsuccess Google Sign In callback.
+     * // Initialize a generate OAuth provider with a `google.com` providerId.
+     * const provider = new OAuthProvider('google.com');
+     * const credential = provider.credential({
+     *   idToken: googleUser.getAuthResponse().id_token,
+     * });
+     * const result = await signInWithCredential(credential);
+     * ```
+     *
+     * @param params - Either the options object containing the ID token, access token and raw nonce
+     * or the ID token string.
+     */
+    credential(params: OAuthCredentialOptions): OAuthCredential;
+    /** An internal credential method that accepts more permissive options */
+    private _credential;
+    /**
+     * Used to extract the underlying {@link OAuthCredential} from a {@link UserCredential}.
+     *
+     * @param userCredential - The user credential.
+     */
+    static credentialFromResult(userCredential: UserCredential): OAuthCredential | null;
+    /**
+     * Used to extract the underlying {@link OAuthCredential} from a {@link AuthError} which was
+     * thrown during a sign-in, link, or reauthenticate operation.
+     *
+     * @param userCredential - The user credential.
+     */
+    static credentialFromError(error: FirebaseError): OAuthCredential | null;
+    private static oauthCredentialFromTaggedObject;
+}

package/dist/node/src/core/providers/oauth.test.d.ts

@@ -1,17 +1,17 @@
-/**
- * @license
- * Copyright 2020 Google LLC
- *
- * 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 {};
+/**
+ * @license
+ * Copyright 2020 Google LLC
+ *
+ * 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/node/src/core/providers/saml.d.ts

@@ -1,62 +1,62 @@
-/**
- * @license
- * Copyright 2020 Google LLC
- *
- * 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 { FirebaseError } from '@firebase/util';
-import { UserCredential } from '../../model/public_types';
-import { AuthCredential } from '../credentials';
-import { FederatedAuthProvider } from './federated';
-/**
- * An {@link AuthProvider} for SAML.
- *
- * @public
- */
-export declare class SAMLAuthProvider extends FederatedAuthProvider {
-    /**
-     * Constructor. The providerId must start with "saml."
-     * @param providerId - SAML provider ID.
-     */
-    constructor(providerId: string);
-    /**
-     * Generates an {@link AuthCredential} from a {@link UserCredential} after a
-     * successful SAML flow completes.
-     *
-     * @remarks
-     *
-     * For example, to get an {@link AuthCredential}, you could write the
-     * following code:
-     *
-     * ```js
-     * const userCredential = await signInWithPopup(auth, samlProvider);
-     * const credential = SAMLAuthProvider.credentialFromResult(userCredential);
-     * ```
-     *
-     * @param userCredential - The user credential.
-     */
-    static credentialFromResult(userCredential: UserCredential): AuthCredential | null;
-    /**
-     * Used to extract the underlying {@link OAuthCredential} from a {@link AuthError} which was
-     * thrown during a sign-in, link, or reauthenticate operation.
-     *
-     * @param userCredential - The user credential.
-     */
-    static credentialFromError(error: FirebaseError): AuthCredential | null;
-    /**
-     * Creates an {@link AuthCredential} from a JSON string or a plain object.
-     * @param json - A plain object or a JSON string
-     */
-    static credentialFromJSON(json: string | object): AuthCredential;
-    private static samlCredentialFromTaggedObject;
-}
+/**
+ * @license
+ * Copyright 2020 Google LLC
+ *
+ * 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 { FirebaseError } from '@firebase/util';
+import { UserCredential } from '../../model/public_types';
+import { AuthCredential } from '../credentials';
+import { FederatedAuthProvider } from './federated';
+/**
+ * An {@link AuthProvider} for SAML.
+ *
+ * @public
+ */
+export declare class SAMLAuthProvider extends FederatedAuthProvider {
+    /**
+     * Constructor. The providerId must start with "saml."
+     * @param providerId - SAML provider ID.
+     */
+    constructor(providerId: string);
+    /**
+     * Generates an {@link AuthCredential} from a {@link UserCredential} after a
+     * successful SAML flow completes.
+     *
+     * @remarks
+     *
+     * For example, to get an {@link AuthCredential}, you could write the
+     * following code:
+     *
+     * ```js
+     * const userCredential = await signInWithPopup(auth, samlProvider);
+     * const credential = SAMLAuthProvider.credentialFromResult(userCredential);
+     * ```
+     *
+     * @param userCredential - The user credential.
+     */
+    static credentialFromResult(userCredential: UserCredential): AuthCredential | null;
+    /**
+     * Used to extract the underlying {@link OAuthCredential} from a {@link AuthError} which was
+     * thrown during a sign-in, link, or reauthenticate operation.
+     *
+     * @param userCredential - The user credential.
+     */
+    static credentialFromError(error: FirebaseError): AuthCredential | null;
+    /**
+     * Creates an {@link AuthCredential} from a JSON string or a plain object.
+     * @param json - A plain object or a JSON string
+     */
+    static credentialFromJSON(json: string | object): AuthCredential;
+    private static samlCredentialFromTaggedObject;
+}

package/dist/node/src/core/providers/saml.test.d.ts

@@ -1,17 +1,17 @@
-/**
- * @license
- * Copyright 2020 Google LLC
- *
- * 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 {};
+/**
+ * @license
+ * Copyright 2020 Google LLC
+ *
+ * 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 {};