@getauthui/core 0.1.0 → 0.1.1

package/dist/react.d.ts

@@ -1,395 +0,0 @@
-import { Client } from 'appwrite';
-import { Models } from 'appwrite';
-import { ReactElement } from 'react';
-import { ReactNode } from 'react';
-
-/**
- * Single source of truth for the widget. Wraps the Appwrite Account service,
- * tracks the signed-in user and broadcasts changes on `window` as `authui:change`.
- */
-declare class AuthStore {
-    private client;
-    private account;
-    private config;
-    private state;
-    private listeners;
-    private refreshPromise;
-    /** Configure the Appwrite client. Safe to call more than once; the last call wins. */
-    configure(config: AuthUIConfig): void;
-    get isConfigured(): boolean;
-    getConfig(): AuthUIConfig | null;
-    /** The configured Appwrite client, for apps that want to reuse it. */
-    getClient(): Client | null;
-    getStrings(): AuthUIStrings;
-    getState(): AuthUIState;
-    get user(): Models.User<Models.Preferences> | null;
-    on<K extends AuthUIEventName>(event: K, listener: Listener<K>): () => void;
-    private emit;
-    private setState;
-    private fail;
-    private acct;
-    /** Re-fetch the current user and derive status. */
-    refresh(): Promise<void>;
-    private afterSignIn;
-    signInWithEmailPassword(email: string, password: string): Promise<void>;
-    signUp(email: string, password: string, name?: string): Promise<void>;
-    signInAnonymously(): Promise<void>;
-    /** Redirects the browser to the provider. Never resolves in a browser. */
-    signInWithOAuth(provider: OAuthProviderName): void;
-    sendMagicUrl(email: string): Promise<Models.Token>;
-    sendEmailOtp(email: string): Promise<Models.Token>;
-    sendPhoneOtp(phone: string): Promise<Models.Token>;
-    /** Redeem any token secret (email OTP, SMS OTP, magic URL, OAuth token). */
-    signInWithToken(userId: string, secret: string): Promise<void>;
-    createMfaChallenge(factor: MfaFactor): Promise<Models.MfaChallenge>;
-    /** Verify a challenge. Completes a pending sign in, or acts as a step-up for protected actions. */
-    completeMfaChallenge(challengeId: string, otp: string, opts?: {
-        signIn?: boolean;
-    }): Promise<void>;
-    listMfaFactors(): Promise<Models.MfaFactors>;
-    setMfaEnabled(enabled: boolean): Promise<void>;
-    addAuthenticator(): Promise<Models.MfaType>;
-    verifyAuthenticator(otp: string): Promise<void>;
-    /** Requires a recent MFA challenge (server rejects with user_challenge_required otherwise). */
-    removeAuthenticator(): Promise<void>;
-    createRecoveryCodes(): Promise<string[]>;
-    /** Requires a recent MFA challenge. */
-    regenerateRecoveryCodes(): Promise<string[]>;
-    /** Requires a recent MFA challenge. */
-    getRecoveryCodes(): Promise<string[]>;
-    sendPasswordRecovery(email: string): Promise<void>;
-    completePasswordRecovery(userId: string, secret: string, password: string): Promise<void>;
-    signOut(sessionId?: string): Promise<void>;
-    signOutEverywhere(): Promise<void>;
-    listSessions(): Promise<Models.Session[]>;
-    listIdentities(): Promise<Models.Identity[]>;
-    deleteIdentity(identityId: string): Promise<void>;
-    listLogs(): Promise<Models.Log[]>;
-    updateName(name: string): Promise<void>;
-    updateEmail(email: string, password: string): Promise<void>;
-    updatePhone(phone: string, password: string): Promise<void>;
-    updatePassword(password: string, oldPassword?: string): Promise<void>;
-    /** Turn an anonymous session into a full account. */
-    convertGuest(email: string, password: string, name?: string): Promise<void>;
-    sendEmailVerification(): Promise<void>;
-    sendPhoneVerification(): Promise<void>;
-    confirmPhoneVerification(otp: string): Promise<void>;
-    /** Blocks the account and ends the session. Appwrite keeps the record so an admin can restore it. */
-    deleteAccount(): Promise<void>;
-    /** Build the URL Appwrite should send the user back to for a given flow. */
-    redirectUrl(action: string): string;
-    setPending(pending: AuthUIPendingAction | null): void;
-    /**
-     * Finish a flow that arrived through the URL. Called automatically by `configure()`.
-     * Returns true when a redirect was handled.
-     */
-    handleRedirect(): Promise<boolean>;
-    private cleanUrl;
-    /** Test helper. */
-    reset(): void;
-}
-
-export declare function AuthUIAccount(props: {
-    tab?: "profile" | "security" | "sessions" | "connections" | "activity";
-}): ReactElement;
-
-declare interface AuthUIBranding {
-    /** Product name shown in headings. */
-    name?: string;
-    /** Logo URL rendered above the form. */
-    logo?: string;
-    /** Color scheme. "auto" follows prefers-color-scheme and an `html.dark` class. Default: "auto". */
-    theme?: AuthUITheme;
-    /** Corner radius scale. Default: "md". */
-    radius?: AuthUIRadius;
-    /** Any CSS color for primary buttons. Default: near-black / near-white. */
-    primary?: string;
-    /** Text color on primary buttons. */
-    primaryForeground?: string;
-}
-
-export declare function AuthUIButton(props: {
-    view?: AuthUIView;
-    variant?: "primary" | "brand" | "outline" | "secondary" | "ghost" | "link";
-    size?: "sm" | "md" | "lg";
-    children?: ReactNode;
-}): ReactElement;
-
-declare interface AuthUIConfig {
-    /** Appwrite API endpoint, e.g. https://cloud.appwrite.io/v1 */
-    endpoint: string;
-    /** Appwrite project ID. */
-    project: string;
-    /**
-     * Absolute URL the user returns to after OAuth, magic URL, recovery and verification emails.
-     * Must be on a hostname registered as a web platform in your Appwrite project.
-     * Default: the current page without query string or hash.
-     */
-    redirectUrl?: string;
-    /** Where to navigate after a successful sign in. If omitted the page is not changed. */
-    successUrl?: string;
-    methods?: AuthUIMethods;
-    /** Show the "Sign up" option. Default: true. */
-    signUp?: boolean;
-    /** Ask for a display name during sign up. Default: true. */
-    requireName?: boolean;
-    /** Let users enroll and manage MFA from the account screen. Default: true. */
-    mfa?: boolean;
-    /** Request a security phrase for email OTP and magic URL. Default: true. */
-    securityPhrase?: boolean;
-    /** Extra OAuth scopes per provider. */
-    oauthScopes?: Partial<Record<OAuthProviderName, string[]>>;
-    branding?: AuthUIBranding;
-    legal?: AuthUILegal;
-    /** Override any UI string. */
-    strings?: Partial<AuthUIStrings>;
-}
-
-declare type AuthUIEventMap = {
-    change: AuthUIState;
-    "signed-in": Models.User<Models.Preferences>;
-    "signed-out": undefined;
-    error: {
-        message: string;
-        type: string;
-        code: number;
-    };
-};
-
-declare type AuthUIEventName = keyof AuthUIEventMap;
-
-declare interface AuthUILegal {
-    termsUrl?: string;
-    privacyUrl?: string;
-}
-
-declare interface AuthUIMethods {
-    /** Email + password sign in and sign up. Default: true. */
-    emailPassword?: boolean;
-    /** Passwordless link sent by email. Default: false. */
-    magicUrl?: boolean;
-    /** Passwordless 6-digit code sent by email. Default: false. */
-    emailOtp?: boolean;
-    /** SMS one-time code. Default: false. */
-    phone?: boolean;
-    /** "Continue as guest" anonymous session. Default: false. */
-    anonymous?: boolean;
-    /** OAuth2 providers to show, in order. Default: []. */
-    oauth?: OAuthProviderName[];
-}
-
-export declare function AuthUIModal(props: {
-    view?: AuthUIView;
-    open?: boolean;
-    closeOnSuccess?: boolean;
-}): ReactElement;
-
-/** Something the widget must finish after a redirect, e.g. password reset. */
-declare type AuthUIPendingAction = {
-    type: "reset-password";
-    userId: string;
-    secret: string;
-} | {
-    type: "verify-email";
-    userId: string;
-    secret: string;
-} | {
-    type: "oauth-failed";
-} | {
-    type: "notice";
-    message: string;
-    tone: "success" | "error" | "info";
-};
-
-/** Configures Auth UI once and renders children. Put it near the root of your app. */
-export declare function AuthUIProvider({ config, children, }: {
-    config: AuthUIConfig;
-    children?: ReactNode;
-}): ReactElement;
-
-declare type AuthUIRadius = "none" | "sm" | "md" | "lg" | "xl" | "full";
-
-export declare function AuthUISignIn(props: {
-    view?: Exclude<AuthUIView, "account">;
-    onSuccess?: () => void;
-}): ReactElement;
-
-declare interface AuthUIState {
-    status: AuthUIStatus;
-    user: Models.User<Models.Preferences> | null;
-    /** Factors available to complete MFA when status is "mfa-required". */
-    mfaFactors: Models.MfaFactors | null;
-    pending: AuthUIPendingAction | null;
-    configured: boolean;
-}
-
-declare type AuthUIStatus = "loading" | "signed-out" | "signed-in" | "mfa-required";
-
-declare interface AuthUIStrings {
-    signIn: string;
-    signUp: string;
-    signOut: string;
-    continueAsGuest: string;
-    email: string;
-    password: string;
-    newPassword: string;
-    confirmPassword: string;
-    name: string;
-    phone: string;
-    code: string;
-    forgotPassword: string;
-    noAccount: string;
-    haveAccount: string;
-    or: string;
-    continueWith: string;
-    continueWithEmail: string;
-    sendEmailCode: string;
-    continueWithPhone: string;
-    sendMagicLink: string;
-    sendCode: string;
-    verifyCode: string;
-    magicLinkSent: string;
-    codeSent: string;
-    securityPhrase: string;
-    securityPhraseHint: string;
-    back: string;
-    cancel: string;
-    save: string;
-    update: string;
-    remove: string;
-    close: string;
-    resetPassword: string;
-    resetLinkSent: string;
-    passwordUpdated: string;
-    sendResetLink: string;
-    agreeTo: string;
-    terms: string;
-    privacy: string;
-    and: string;
-    welcomeBack: string;
-    createAccount: string;
-    signInTitle: string;
-    signUpTitle: string;
-    mfaTitle: string;
-    mfaDescription: string;
-    mfaUseAuthenticator: string;
-    mfaUseEmail: string;
-    mfaUsePhone: string;
-    mfaUseRecoveryCode: string;
-    recoveryCode: string;
-    account: string;
-    profile: string;
-    security: string;
-    sessions: string;
-    connections: string;
-    activity: string;
-    dangerZone: string;
-    verified: string;
-    unverified: string;
-    verifyEmail: string;
-    verificationSent: string;
-    emailVerified: string;
-    changePassword: string;
-    currentPassword: string;
-    twoFactor: string;
-    twoFactorDescription: string;
-    enable: string;
-    disable: string;
-    authenticatorApp: string;
-    authenticatorAdd: string;
-    authenticatorScan: string;
-    authenticatorManual: string;
-    authenticatorVerify: string;
-    recoveryCodes: string;
-    recoveryCodesDescription: string;
-    generateRecoveryCodes: string;
-    regenerateRecoveryCodes: string;
-    recoveryCodesWarning: string;
-    currentSession: string;
-    signOutSession: string;
-    signOutAllSessions: string;
-    signOutAllSessionsDescription: string;
-    noConnections: string;
-    disconnect: string;
-    noActivity: string;
-    deleteAccount: string;
-    deleteAccountDescription: string;
-    deleteAccountConfirm: string;
-    loading: string;
-    copied: string;
-    copy: string;
-    done: string;
-    errorGeneric: string;
-    errorInvalidCredentials: string;
-    errorUserExists: string;
-    errorUserBlocked: string;
-    errorRateLimit: string;
-    errorInvalidToken: string;
-    errorInvalidCode: string;
-    errorPasswordMismatch: string;
-    errorPasswordRecentlyUsed: string;
-    errorPasswordPersonalData: string;
-    errorPasswordWeak: string;
-    errorPasswordPwned: string;
-    errorChallengeRequired: string;
-    errorSessionExists: string;
-    errorOAuth: string;
-    errorNetwork: string;
-    errorMethodDisabled: string;
-    errorNotConfigured: string;
-    passwordHint: string;
-    signedInAs: string;
-    manageAccount: string;
-    continue: string;
-    provider: string;
-    lastActive: string;
-    guestAccount: string;
-    guestAccountDescription: string;
-}
-
-declare type AuthUITheme = "light" | "dark" | "auto";
-
-export declare function AuthUIUserButton(props: {
-    src?: string;
-    children?: ReactNode;
-}): ReactElement;
-
-/** Screens the widget can show. */
-declare type AuthUIView = "sign-in" | "sign-up" | "forgot-password" | "reset-password" | "magic-url" | "email-otp" | "phone" | "mfa" | "account";
-
-declare function closeModal(): void;
-
-declare type Listener<K extends AuthUIEventName> = (detail: AuthUIEventMap[K]) => void;
-
-declare type MfaFactor = "totp" | "email" | "phone" | "recoverycode";
-
-/** Every OAuth2 provider slug Appwrite understands. */
-declare type OAuthProviderName = "amazon" | "apple" | "appwrite" | "auth0" | "authentik" | "autodesk" | "bitbucket" | "bitly" | "box" | "cloudflare" | "dailymotion" | "discord" | "disqus" | "dropbox" | "etsy" | "facebook" | "figma" | "fusionauth" | "github" | "gitlab" | "google" | "huggingface" | "kakao" | "keycloak" | "kick" | "linkedin" | "microsoft" | "notion" | "oidc" | "okta" | "paypal" | "paypalSandbox" | "podio" | "resend" | "salesforce" | "slack" | "spotify" | "stripe" | "tiktok" | "tradeshift" | "tradeshiftBox" | "twitch" | "wordpress" | "x" | "yahoo" | "yammer" | "yandex" | "zoho" | "zoom";
-
-/**
- * Open the modal from anywhere. If no <authui-modal> exists yet, one is appended to <body>.
- */
-declare function openModal(view?: AuthUIView): void;
-
-export declare function SignedIn({ children }: {
-    children?: ReactNode;
-}): ReactElement;
-
-export declare function SignedOut({ children }: {
-    children?: ReactNode;
-}): ReactElement;
-
-/** Subscribe to Auth UI state and get the imperative helpers. */
-export declare function useAuthUI(): {
-    open: typeof openModal;
-    close: typeof closeModal;
-    signOut: () => Promise<void>;
-    store: AuthStore;
-    status: AuthUIStatus;
-    user: Models.User<Models.Preferences> | null;
-    mfaFactors: Models.MfaFactors | null;
-    pending: AuthUIPendingAction | null;
-    configured: boolean;
-};
-
-export { }