Navigate

API reference

@pyric/cli/register/client/auth

88 published symbols from @pyric/cli

Generated from the TypeScript declarations shipped at this import path.

Variables

applyActionCode

const applyActionCode: typeof applyActionCode;

beforeAuthStateChanged

const beforeAuthStateChanged: typeof beforeAuthStateChanged;

Worker mode: the gate can’t run before a worker-committed transition (see worker/client.ts’s beforeAuthStateChanged doc) — registering throws immediately rather than silently accepting a no-op callback. In-page mode: full block-and-abort semantics via pyric/auth.


browserLocalPersistence

const browserLocalPersistence: Persistence;

browserSessionPersistence

const browserSessionPersistence: Persistence;

checkActionCode

const checkActionCode: typeof checkActionCode;

confirmPasswordReset

const confirmPasswordReset: typeof confirmPasswordReset;

connectAuthEmulator

const connectAuthEmulator: typeof connectAuthEmulator;

createUserWithEmailAndPassword

const createUserWithEmailAndPassword: typeof createUserWithEmailAndPassword;

deleteUser

const deleteUser: typeof deleteUser;

EmailAuthProvider

const EmailAuthProvider: typeof EmailAuthProvider;

FacebookAuthProvider

const FacebookAuthProvider: typeof FacebookAuthProvider;

fetchSignInMethodsForEmail

const fetchSignInMethodsForEmail: UnsupportedServedApi;

getAdditionalUserInfo

const getAdditionalUserInfo: typeof getAdditionalUserInfo;

getAuth

const getAuth: typeof getAuth;

getAuthLens

const getAuthLens: typeof getAuthLens;

getIdToken

const getIdToken: typeof getIdToken;

getIdTokenResult

const getIdTokenResult: typeof getIdTokenResult;

getMultiFactorResolver

const getMultiFactorResolver: UnsupportedServedApi;

getRedirectResult

const getRedirectResult: typeof getRedirectResult;

GithubAuthProvider

const GithubAuthProvider: typeof GithubAuthProvider;

GoogleAuthProvider

const GoogleAuthProvider: typeof GoogleAuthProvider;

initializeAuth

const initializeAuth: typeof initializeAuth;

initializeAuth(app, deps?) — aliases the picked getAuth (worker- or in-page-backed). Path-independent: deps is accepted for parity, ignored.


initializeRecaptchaConfig

const initializeRecaptchaConfig: UnsupportedServedApi;

inMemoryPersistence

const inMemoryPersistence: Persistence;

linkWithCredential

const linkWithCredential: typeof linkWithCredential;

linkWithPhoneNumber

const linkWithPhoneNumber: UnsupportedServedApi;

linkWithPopup

const linkWithPopup: typeof linkWithPopup;

linkWithRedirect

const linkWithRedirect: typeof linkWithRedirect;

multiFactor

const multiFactor: UnsupportedServedApi;

OAuthProvider

const OAuthProvider: typeof OAuthProvider;

onAuthLensChanged

const onAuthLensChanged: typeof onAuthLensChanged;

onAuthStateChanged

const onAuthStateChanged: typeof onAuthStateChanged;

onIdTokenChanged

const onIdTokenChanged: typeof onIdTokenChanged;

PhoneAuthCredential

const PhoneAuthCredential: UnsupportedServedApi;

PhoneAuthProvider

const PhoneAuthProvider: UnsupportedServedApi;

PhoneMultiFactorGenerator

const PhoneMultiFactorGenerator: UnsupportedServedApi;

reauthenticateWithCredential

const reauthenticateWithCredential: typeof reauthenticateWithCredential;

reauthenticateWithPhoneNumber

const reauthenticateWithPhoneNumber: UnsupportedServedApi;

reauthenticateWithPopup

const reauthenticateWithPopup: typeof reauthenticateWithPopup;

reauthenticateWithRedirect

const reauthenticateWithRedirect: typeof reauthenticateWithRedirect;

RecaptchaVerifier

const RecaptchaVerifier: UnsupportedServedApi;

reload

const reload: typeof reload;

revokeAccessToken

const revokeAccessToken: UnsupportedServedApi;

sendEmailVerification

const sendEmailVerification: typeof sendEmailVerification;

sendPasswordResetEmail

const sendPasswordResetEmail: typeof sendPasswordResetEmail;

sendSignInLinkToEmail

const sendSignInLinkToEmail: typeof sendSignInLinkToEmail;

setPersistence

const setPersistence: typeof setPersistence;

setPersistence: selects which web storage holds THIS TAB’s session (and migrates the current one). On the worker path the record is still client- side (#754 — per-port sessions restore via auth.restorePortSession); the RPC just keeps the worker’s surface-parity mode in sync.


signInAnonymously

const signInAnonymously: typeof signInAnonymously;

signInWithCredential

const signInWithCredential: typeof signInWithCredential;

Direct credential sign-in: unsupported over the worker in v1 (the worker-client rejects with a clear error); in-page passes through.


signInWithCustomToken

const signInWithCustomToken: typeof signInWithCustomToken;

signInWithEmailAndPassword

const signInWithEmailAndPassword: typeof signInWithEmailAndPassword;

const signInWithEmailLink: typeof signInWithEmailLink;

signInWithPhoneNumber

const signInWithPhoneNumber: UnsupportedServedApi;

signInWithPopup

const signInWithPopup: typeof signInWithPopup;

signInWithRedirect

const signInWithRedirect: typeof signInWithRedirect;

signInWithRedirect over the worker resolves like popup — the pyric emulator helper does not actually navigate, so the identity is picked + the worker signs in immediately. The result is delivered through the sign-in + onAuthStateChanged; getRedirectResult returns null on the worker path (there is no deferred post-navigation result to replay). v1 behavior.


signOut

const signOut: typeof signOut;

switchAuthLens

const switchAuthLens: typeof switchAuthLens;

TotpMultiFactorGenerator

const TotpMultiFactorGenerator: UnsupportedServedApi;

TotpSecret

const TotpSecret: UnsupportedServedApi;

const unlink: typeof unlink;

updateCurrentUser

const updateCurrentUser: typeof updateCurrentUser;

updateEmail

const updateEmail: typeof updateEmail;

updatePassword

const updatePassword: typeof updatePassword;

updatePhoneNumber

const updatePhoneNumber: UnsupportedServedApi;

updateProfile

const updateProfile: typeof updateProfile;

updateProfile(user, { displayName?, photoURL? }) — updates the signed-in user’s profile on the picked path (worker or in-page). Both wc and ipAuth export a top-level updateProfile; cast to the canonical pyric/auth shape. (Fixes #746: the served firebase/auth entry didn’t re-export this at all.)


useDeviceLanguage

const useDeviceLanguage: typeof useDeviceLanguage;

useDeviceLanguage(auth) — accepted no-op (no device locale in the served sandbox). Path-independent.


validatePassword

const validatePassword: UnsupportedServedApi;

verifyBeforeUpdateEmail

const verifyBeforeUpdateEmail: typeof verifyBeforeUpdateEmail;

verifyPasswordResetCode

const verifyPasswordResetCode: typeof verifyPasswordResetCode;

Functions

function isSignInWithEmailLink(auth: Auth, link: string): boolean;

Parameters

ParameterType
authAuth
linkstring

Returns

boolean

References

ActionCodeOperation

Re-exports ActionCodeOperation


ActionCodeURL

Re-exports ActionCodeURL


AuthCredential

Re-exports AuthCredential


AuthErrorCodes

Re-exports AuthErrorCodes


browserCookiePersistence

Re-exports browserCookiePersistence


browserPopupRedirectResolver

Re-exports browserPopupRedirectResolver


debugErrorMap

Re-exports debugErrorMap


EmailAuthCredential

Re-exports EmailAuthCredential


FactorId

Re-exports FactorId


indexedDBLocalPersistence

Re-exports indexedDBLocalPersistence


OAuthCredential

Re-exports OAuthCredential


OperationType

Re-exports OperationType


parseActionCodeURL

Re-exports parseActionCodeURL


prodErrorMap

Re-exports prodErrorMap


ProviderId

Re-exports ProviderId


SAMLAuthProvider

Re-exports SAMLAuthProvider


SignInMethod

Re-exports SignInMethod


TwitterAuthProvider

Re-exports TwitterAuthProvider