Skip to content

Add documentation for auth@next #3938

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Merged
merged 18 commits into from
Oct 14, 2020
Merged

Add documentation for auth@next #3938

merged 18 commits into from
Oct 14, 2020

Conversation

avolkovi
Copy link
Contributor

This is just the types in auth-types-exp, I will send a followup PR for everything in auth-exp

@avolkovi avolkovi requested review from sam-gc and Feiyang1 October 13, 2020 23:29
@changeset-bot
Copy link

changeset-bot bot commented Oct 13, 2020 •
edited
Loading

⚠️ No Changeset found

Latest commit: 4959195

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

@google-oss-bot
Copy link
Contributor

google-oss-bot commented Oct 13, 2020 •
edited
Loading

Binary Size Report

Affected SDKs

  • @firebase/firestore/exp

    Type Base (916770f) Head (a6d0d78) Diff
    browser 190 kB 190 kB -44 B (-0.0%)
    main 477 kB 479 kB +1.22 kB (+0.3%)
    module 190 kB 190 kB -44 B (-0.0%)
    react-native 190 kB 190 kB -44 B (-0.0%)

  • @firebase/functions

    Type Base (916770f) Head (a6d0d78) Diff
    browser 10.0 kB 10.1 kB +95 B (+0.9%)
    esm2017 7.62 kB 7.69 kB +68 B (+0.9%)
    main 10.2 kB 10.3 kB +95 B (+0.9%)
    module 9.78 kB 9.87 kB +95 B (+1.0%)

  • firebase

    Type Base (916770f) Head (a6d0d78) Diff
    firebase-functions.js 10.1 kB 10.2 kB +77 B (+0.8%)
    firebase.js 831 kB 831 kB +78 B (+0.0%)

Test Logs

@google-oss-bot
Copy link
Contributor

google-oss-bot commented Oct 13, 2020 •
edited
Loading

Size Analysis Report

Affected Products

@firebase/auth-exp

  • ActionCodeURL

    Size

    Type Base (916770f) Head (a6d0d78) Diff
    size 44.9 kB 45.0 kB +169 B (+0.4%)
    size_with_ext_deps 55.5 kB 55.7 kB +170 B (+0.3%)

  • AuthCredential

    Size

    Type Base (916770f) Head (a6d0d78) Diff
    size 44.1 kB 44.3 kB +169 B (+0.4%)
    size_with_ext_deps 54.8 kB 55.0 kB +170 B (+0.3%)

  • EmailAuthCredential

    Size

    Type Base (916770f) Head (a6d0d78) Diff
    size 45.9 kB 46.1 kB +169 B (+0.4%)
    size_with_ext_deps 56.6 kB 56.7 kB +170 B (+0.3%)

  • EmailAuthProvider

    Size

    Type Base (916770f) Head (a6d0d78) Diff
    size 47.2 kB 47.4 kB +169 B (+0.4%)
    size_with_ext_deps 57.9 kB 58.1 kB +170 B (+0.3%)

  • FacebookAuthProvider

    Size

    Type Base (916770f) Head (a6d0d78) Diff
    size 47.3 kB 47.4 kB +169 B (+0.4%)
    size_with_ext_deps 57.9 kB 58.1 kB +170 B (+0.3%)

  • GithubAuthProvider

    Size

    Type Base (916770f) Head (a6d0d78) Diff
    size 47.2 kB 47.4 kB +169 B (+0.4%)
    size_with_ext_deps 57.9 kB 58.1 kB +170 B (+0.3%)

  • GoogleAuthProvider

    Size

    Type Base (916770f) Head (a6d0d78) Diff
    size 47.2 kB 47.4 kB +169 B (+0.4%)
    size_with_ext_deps 57.9 kB 58.1 kB +170 B (+0.3%)

  • OAuthCredential

    Size

    Type Base (916770f) Head (a6d0d78) Diff
    size 45.9 kB 46.1 kB +169 B (+0.4%)
    size_with_ext_deps 56.6 kB 56.8 kB +170 B (+0.3%)

  • OAuthProvider

    Size

    Type Base (916770f) Head (a6d0d78) Diff
    size 46.6 kB 46.8 kB +169 B (+0.4%)
    size_with_ext_deps 57.3 kB 57.5 kB +170 B (+0.3%)

  • PhoneAuthCredential

    Size

    Type Base (916770f) Head (a6d0d78) Diff
    size 45.9 kB 46.0 kB +169 B (+0.4%)
    size_with_ext_deps 56.5 kB 56.7 kB +170 B (+0.3%)

  • PhoneAuthProvider

    Size

    Type Base (916770f) Head (a6d0d78) Diff
    size 47.6 kB 47.7 kB +169 B (+0.4%)
    size_with_ext_deps 58.3 kB 58.4 kB +170 B (+0.3%)

  • PhoneMultiFactorGenerator

    Size

    Type Base (916770f) Head (a6d0d78) Diff
    size 44.8 kB 44.9 kB +169 B (+0.4%)
    size_with_ext_deps 55.4 kB 55.6 kB +170 B (+0.3%)

  • RecaptchaVerifier

    Size

    Type Base (916770f) Head (a6d0d78) Diff
    size 50.4 kB 50.5 kB +169 B (+0.3%)
    size_with_ext_deps 61.0 kB 61.2 kB +170 B (+0.3%)

  • TwitterAuthProvider

    Size

    Type Base (916770f) Head (a6d0d78) Diff
    size 47.3 kB 47.4 kB +169 B (+0.4%)
    size_with_ext_deps 57.9 kB 58.1 kB +170 B (+0.3%)

  • applyActionCode

    Size

    Type Base (916770f) Head (a6d0d78) Diff
    size 44.0 kB 44.1 kB +169 B (+0.4%)
    size_with_ext_deps 54.6 kB 54.8 kB +170 B (+0.3%)

  • browserLocalPersistence

    Size

    Type Base (916770f) Head (a6d0d78) Diff
    size 46.8 kB 47.0 kB +169 B (+0.4%)
    size_with_ext_deps 57.5 kB 57.7 kB +170 B (+0.3%)

  • browserPopupRedirectResolver

    Size

    Type Base (916770f) Head (a6d0d78) Diff
    size 55.8 kB 55.9 kB +169 B (+0.3%)
    size_with_ext_deps 66.5 kB 66.7 kB +170 B (+0.3%)

  • browserSessionPersistence

    Size

    Type Base (916770f) Head (a6d0d78) Diff
    size 44.5 kB 44.7 kB +169 B (+0.4%)
    size_with_ext_deps 55.2 kB 55.3 kB +170 B (+0.3%)

  • checkActionCode

    Size

    Type Base (916770f) Head (a6d0d78) Diff
    size 45.0 kB 45.2 kB +169 B (+0.4%)
    size_with_ext_deps 55.6 kB 55.8 kB +170 B (+0.3%)

  • confirmPasswordReset

    Size

    Type Base (916770f) Head (a6d0d78) Diff
    size 44.0 kB 44.2 kB +169 B (+0.4%)
    size_with_ext_deps 54.7 kB 54.8 kB +170 B (+0.3%)

  • createUserWithEmailAndPassword

    Size

    Type Base (916770f) Head (a6d0d78) Diff
    size 44.9 kB 45.1 kB +169 B (+0.4%)
    size_with_ext_deps 55.5 kB 55.7 kB +170 B (+0.3%)

  • deleteUser

    Size

    Type Base (916770f) Head (a6d0d78) Diff
    size 43.9 kB 44.1 kB +169 B (+0.4%)
    size_with_ext_deps 54.6 kB 54.7 kB +170 B (+0.3%)

  • fetchSignInMethodsForEmail

    Size

    Type Base (916770f) Head (a6d0d78) Diff
    size 44.2 kB 44.4 kB +169 B (+0.4%)
    size_with_ext_deps 54.9 kB 55.0 kB +170 B (+0.3%)

  • getAdditionalUserInfo

    Size

    Type Base (916770f) Head (a6d0d78) Diff
    size 45.1 kB 45.3 kB +169 B (+0.4%)
    size_with_ext_deps 55.8 kB 55.9 kB +170 B (+0.3%)

  • getAuth

    Size

    Type Base (916770f) Head (a6d0d78) Diff
    size 61.6 kB 61.8 kB +169 B (+0.3%)
    size_with_ext_deps 73.1 kB 73.2 kB +170 B (+0.2%)

  • getIdToken

    Size

    Type Base (916770f) Head (a6d0d78) Diff
    size 43.9 kB 44.1 kB +169 B (+0.4%)
    size_with_ext_deps 54.6 kB 54.7 kB +170 B (+0.3%)

  • getIdTokenResult

    Size

    Type Base (916770f) Head (a6d0d78) Diff
    size 43.9 kB 44.0 kB +169 B (+0.4%)
    size_with_ext_deps 54.5 kB 54.7 kB +170 B (+0.3%)

  • getMultiFactorResolver

    Size

    Type Base (916770f) Head (a6d0d78) Diff
    size 46.8 kB 46.9 kB +169 B (+0.4%)
    size_with_ext_deps 57.4 kB 57.6 kB +170 B (+0.3%)

  • getRedirectResult

    Size

    Type Base (916770f) Head (a6d0d78) Diff
    size 49.3 kB 49.5 kB +169 B (+0.3%)
    size_with_ext_deps 60.0 kB 60.2 kB +170 B (+0.3%)

  • inMemoryPersistence

    Size

    Type Base (916770f) Head (a6d0d78) Diff
    size 43.9 kB 44.0 kB +169 B (+0.4%)
    size_with_ext_deps 54.5 kB 54.7 kB +170 B (+0.3%)

  • indexedDBLocalPersistence

    Size

    Type Base (916770f) Head (a6d0d78) Diff
    size 46.9 kB 47.1 kB +169 B (+0.4%)
    size_with_ext_deps 57.6 kB 57.8 kB +170 B (+0.3%)

  • initializeAuth

    Size

    Type Base (916770f) Head (a6d0d78) Diff
    size 44.2 kB 44.3 kB +169 B (+0.4%)
    size_with_ext_deps 55.5 kB 55.6 kB +170 B (+0.3%)

  • isSignInWithEmailLink

    Size

    Type Base (916770f) Head (a6d0d78) Diff
    size 45.0 kB 45.1 kB +169 B (+0.4%)
    size_with_ext_deps 55.6 kB 55.8 kB +170 B (+0.3%)

  • linkWithCredential

    Size

    Type Base (916770f) Head (a6d0d78) Diff
    size 44.9 kB 45.1 kB +169 B (+0.4%)
    size_with_ext_deps 55.6 kB 55.7 kB +170 B (+0.3%)

  • linkWithPhoneNumber

    Size

    Type Base (916770f) Head (a6d0d78) Diff
    size 48.4 kB 48.6 kB +169 B (+0.3%)
    size_with_ext_deps 59.1 kB 59.3 kB +170 B (+0.3%)

  • linkWithPopup

    Size

    Type Base (916770f) Head (a6d0d78) Diff
    size 52.4 kB 52.6 kB +169 B (+0.3%)
    size_with_ext_deps 63.1 kB 63.2 kB +170 B (+0.3%)

  • linkWithRedirect

    Size

    Type Base (916770f) Head (a6d0d78) Diff
    size 47.4 kB 47.6 kB +169 B (+0.4%)
    size_with_ext_deps 58.1 kB 58.3 kB +170 B (+0.3%)

  • multiFactor

    Size

    Type Base (916770f) Head (a6d0d78) Diff
    size 46.0 kB 46.1 kB +169 B (+0.4%)
    size_with_ext_deps 56.6 kB 56.8 kB +170 B (+0.3%)

  • onAuthStateChanged

    Size

    Type Base (916770f) Head (a6d0d78) Diff
    size 43.9 kB 44.1 kB +169 B (+0.4%)
    size_with_ext_deps 54.6 kB 54.7 kB +170 B (+0.3%)

  • onIdTokenChanged

    Size

    Type Base (916770f) Head (a6d0d78) Diff
    size 43.9 kB 44.1 kB +169 B (+0.4%)
    size_with_ext_deps 54.6 kB 54.7 kB +170 B (+0.3%)

  • parseActionCodeURL

    Size

    Type Base (916770f) Head (a6d0d78) Diff
    size 44.9 kB 45.1 kB +169 B (+0.4%)
    size_with_ext_deps 55.5 kB 55.7 kB +170 B (+0.3%)

  • reauthenticateWithCredential

    Size

    Type Base (916770f) Head (a6d0d78) Diff
    size 45.5 kB 45.7 kB +169 B (+0.4%)
    size_with_ext_deps 56.2 kB 56.4 kB +170 B (+0.3%)

  • reauthenticateWithPhoneNumber

    Size

    Type Base (916770f) Head (a6d0d78) Diff
    size 49.0 kB 49.2 kB +169 B (+0.3%)
    size_with_ext_deps 59.7 kB 59.9 kB +170 B (+0.3%)

  • reauthenticateWithPopup

    Size

    Type Base (916770f) Head (a6d0d78) Diff
    size 52.4 kB 52.6 kB +169 B (+0.3%)
    size_with_ext_deps 63.1 kB 63.2 kB +170 B (+0.3%)

  • reauthenticateWithRedirect

    Size

    Type Base (916770f) Head (a6d0d78) Diff
    size 47.2 kB 47.3 kB +169 B (+0.4%)
    size_with_ext_deps 57.8 kB 58.0 kB +170 B (+0.3%)

  • reload

    Size

    Type Base (916770f) Head (a6d0d78) Diff
    size 43.9 kB 44.0 kB +169 B (+0.4%)
    size_with_ext_deps 54.5 kB 54.7 kB +170 B (+0.3%)

  • sendEmailVerification

    Size

    Type Base (916770f) Head (a6d0d78) Diff
    size 44.5 kB 44.6 kB +169 B (+0.4%)
    size_with_ext_deps 55.1 kB 55.3 kB +170 B (+0.3%)

  • sendPasswordResetEmail

    Size

    Type Base (916770f) Head (a6d0d78) Diff
    size 44.4 kB 44.6 kB +169 B (+0.4%)
    size_with_ext_deps 55.0 kB 55.2 kB +170 B (+0.3%)

  • sendSignInLinkToEmail

    Size

    Type Base (916770f) Head (a6d0d78) Diff
    size 44.4 kB 44.6 kB +169 B (+0.4%)
    size_with_ext_deps 55.0 kB 55.2 kB +170 B (+0.3%)

  • setPersistence

    Size

    Type Base (916770f) Head (a6d0d78) Diff
    size 43.9 kB 44.1 kB +169 B (+0.4%)
    size_with_ext_deps 54.6 kB 54.7 kB +170 B (+0.3%)

  • signInAnonymously

    Size

    Type Base (916770f) Head (a6d0d78) Diff
    size 45.0 kB 45.2 kB +169 B (+0.4%)
    size_with_ext_deps 55.7 kB 55.8 kB +170 B (+0.3%)

  • signInWithCredential

    Size

    Type Base (916770f) Head (a6d0d78) Diff
    size 45.2 kB 45.4 kB +169 B (+0.4%)
    size_with_ext_deps 55.9 kB 56.1 kB +170 B (+0.3%)

  • signInWithCustomToken

    Size

    Type Base (916770f) Head (a6d0d78) Diff
    size 44.9 kB 45.0 kB +169 B (+0.4%)
    size_with_ext_deps 55.5 kB 55.7 kB +170 B (+0.3%)

  • signInWithEmailAndPassword

    Size

    Type Base (916770f) Head (a6d0d78) Diff
    size 48.7 kB 48.8 kB +169 B (+0.3%)
    size_with_ext_deps 59.3 kB 59.5 kB +170 B (+0.3%)

  • signInWithEmailLink

    Size

    Type Base (916770f) Head (a6d0d78) Diff
    size 48.9 kB 49.0 kB +169 B (+0.3%)
    size_with_ext_deps 59.5 kB 59.7 kB +170 B (+0.3%)

  • signInWithPhoneNumber

    Size

    Type Base (916770f) Head (a6d0d78) Diff
    size 48.7 kB 48.9 kB +169 B (+0.3%)
    size_with_ext_deps 59.4 kB 59.6 kB +170 B (+0.3%)

  • signInWithPopup

    Size

    Type Base (916770f) Head (a6d0d78) Diff
    size 52.4 kB 52.5 kB +169 B (+0.3%)
    size_with_ext_deps 63.1 kB 63.2 kB +170 B (+0.3%)

  • signInWithRedirect

    Size

    Type Base (916770f) Head (a6d0d78) Diff
    size 46.9 kB 47.1 kB +169 B (+0.4%)
    size_with_ext_deps 57.6 kB 57.7 kB +170 B (+0.3%)

  • signOut

    Size

    Type Base (916770f) Head (a6d0d78) Diff
    size 43.9 kB 44.1 kB +169 B (+0.4%)
    size_with_ext_deps 54.5 kB 54.7 kB +170 B (+0.3%)

  • unlink

    Size

    Type Base (916770f) Head (a6d0d78) Diff
    size 44.5 kB 44.6 kB +169 B (+0.4%)
    size_with_ext_deps 55.1 kB 55.3 kB +170 B (+0.3%)

  • updateCurrentUser

    Size

    Type Base (916770f) Head (a6d0d78) Diff
    size 43.9 kB 44.1 kB +169 B (+0.4%)
    size_with_ext_deps 54.6 kB 54.7 kB +170 B (+0.3%)

  • updateEmail

    Size

    Type Base (916770f) Head (a6d0d78) Diff
    size 44.2 kB 44.3 kB +169 B (+0.4%)
    size_with_ext_deps 54.8 kB 55.0 kB +170 B (+0.3%)

  • updatePassword

    Size

    Type Base (916770f) Head (a6d0d78) Diff
    size 44.2 kB 44.3 kB +169 B (+0.4%)
    size_with_ext_deps 54.8 kB 55.0 kB +170 B (+0.3%)

  • updatePhoneNumber

    Size

    Type Base (916770f) Head (a6d0d78) Diff
    size 44.6 kB 44.8 kB +169 B (+0.4%)
    size_with_ext_deps 55.3 kB 55.4 kB +170 B (+0.3%)

  • updateProfile

    Size

    Type Base (916770f) Head (a6d0d78) Diff
    size 44.4 kB 44.5 kB +169 B (+0.4%)
    size_with_ext_deps 55.0 kB 55.2 kB +170 B (+0.3%)

  • useDeviceLanguage

    Size

    Type Base (916770f) Head (a6d0d78) Diff
    size 43.9 kB 44.1 kB +169 B (+0.4%)
    size_with_ext_deps 54.6 kB 54.7 kB +170 B (+0.3%)

  • verifyBeforeUpdateEmail

    Size

    Type Base (916770f) Head (a6d0d78) Diff
    size 44.5 kB 44.7 kB +169 B (+0.4%)
    size_with_ext_deps 55.1 kB 55.3 kB +170 B (+0.3%)

  • verifyPasswordResetCode

    Size

    Type Base (916770f) Head (a6d0d78) Diff
    size 45.1 kB 45.2 kB +169 B (+0.4%)
    size_with_ext_deps 55.7 kB 55.9 kB +170 B (+0.3%)

@firebase/functions-exp

  • useFunctionsEmulator

    Size

    Type Base (916770f) Head (a6d0d78) Diff
    size 1.96 kB 1.99 kB +23 B (+1.2%)
    size_with_ext_deps 5.82 kB 5.84 kB +23 B (+0.4%)

Test Logs

sam-gc
sam-gc reviewed Oct 14, 2020
View reviewed changes
Copy link
Contributor

@sam-gc sam-gc left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Seems like a lot of the methods don't have @returns, even when something is returned (like a Promise<void>. Is that intentional?

packages-exp/auth-types-exp/index.d.ts Outdated
readonly phoneNumber?: string;
/**
* The tenant ID being used for sign-in/linking. If you use `signInWithRedirect` to sign in,
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

can signInWithRedirect be a link or does that have to wait for the other documentation?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'll try to add it once I make a pass over the auth-exp files

avolkovi and others added 10 commits October 14, 2020 09:35
@avolkovi @sam-gc
Update packages-exp/auth-types-exp/index.d.ts
33057a3 
Co-authored-by: Sam Horlbeck Olsen <[email protected]>
@avolkovi @sam-gc
Update packages-exp/auth-types-exp/index.d.ts
29715fe 
Co-authored-by: Sam Horlbeck Olsen <[email protected]>
@avolkovi @sam-gc
Update packages-exp/auth-types-exp/index.d.ts
4137266 
Co-authored-by: Sam Horlbeck Olsen <[email protected]>
@avolkovi @sam-gc
Update packages-exp/auth-types-exp/index.d.ts
0663d49 
Co-authored-by: Sam Horlbeck Olsen <[email protected]>
@avolkovi @sam-gc
Update packages-exp/auth-types-exp/index.d.ts
e75622c 
Co-authored-by: Sam Horlbeck Olsen <[email protected]>
@avolkovi @sam-gc
Update packages-exp/auth-types-exp/index.d.ts
746888c 
Co-authored-by: Sam Horlbeck Olsen <[email protected]>
@avolkovi @sam-gc
Update packages-exp/auth-types-exp/index.d.ts
e047a54 
Co-authored-by: Sam Horlbeck Olsen <[email protected]>
@avolkovi @sam-gc
Update packages-exp/auth-types-exp/index.d.ts
b0cb6ac 
Co-authored-by: Sam Horlbeck Olsen <[email protected]>
@avolkovi @sam-gc
Update packages-exp/auth-types-exp/index.d.ts
14128e8 
Co-authored-by: Sam Horlbeck Olsen <[email protected]>
@avolkovi @sam-gc
Update packages-exp/auth-types-exp/index.d.ts
0f1fa93 
Co-authored-by: Sam Horlbeck Olsen <[email protected]>
@avolkovi avolkovi requested a review from egilmorez October 14, 2020 16:41
egilmorez
egilmorez reviewed Oct 14, 2020
View reviewed changes
Copy link
Contributor

@egilmorez egilmorez left a comment •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Gave you some nits, and have a question: should the @example blocks have a language declaration?

In the old version of index.d.ts we used ```javascript on the line directly following @example and before the actual sample code.

I think that may get us prettyprint in some contexts, or is potentially useful in other ways. hsubox76 probably knows :)

avolkovi
avolkovi commented Oct 14, 2020
View reviewed changes
egilmorez
egilmorez approved these changes Oct 14, 2020
View reviewed changes
Copy link
Contributor

@egilmorez egilmorez left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LG from a docs perspective, thanks!

sam-gc
sam-gc approved these changes Oct 14, 2020
View reviewed changes
@avolkovi avolkovi merged commit 2c1764d into master Oct 14, 2020
@avolkovi avolkovi deleted the avolkovi/auth-docs branch October 14, 2020 23:28
@firebase firebase locked and limited conversation to collaborators Nov 14, 2020
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Reviewers

@sam-gc sam-gc sam-gc approved these changes

@Feiyang1 Feiyang1 Feiyang1 approved these changes

@egilmorez egilmorez egilmorez approved these changes

@hiranya911 hiranya911 Awaiting requested review from hiranya911

@hsubox76 hsubox76 Awaiting requested review from hsubox76

Assignees

@Feiyang1 Feiyang1

Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
5 participants
@avolkovi @google-oss-bot @sam-gc @Feiyang1 @egilmorez