@getauthui/core 0.1.0 → 0.1.1

package/dist/types.d.ts

@@ -0,0 +1,233 @@
+import { Models } from 'appwrite';
+/** Every OAuth2 provider slug Appwrite understands. */
+export 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";
+/** Screens the widget can show. */
+export type AuthUIView = "sign-in" | "sign-up" | "forgot-password" | "reset-password" | "magic-url" | "email-otp" | "phone" | "mfa" | "account";
+export type AuthUITheme = "light" | "dark" | "auto";
+export type AuthUIRadius = "none" | "sm" | "md" | "lg" | "xl" | "full";
+export 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 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 interface AuthUILegal {
+    termsUrl?: string;
+    privacyUrl?: string;
+}
+export 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>;
+    /**
+     * Preview mode: no requests are made. Any email, password or code is accepted and a
+     * sample user with sessions, identities, MFA and logs is used, so every screen can be
+     * explored in a playground, design review or Storybook. Never enable in production.
+     */
+    preview?: boolean;
+}
+export type AuthUIStatus = "loading" | "signed-out" | "signed-in" | "mfa-required";
+/** Something the widget must finish after a redirect, e.g. password reset. */
+export 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";
+};
+export 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;
+}
+export type AuthUIEventMap = {
+    change: AuthUIState;
+    "signed-in": Models.User<Models.Preferences>;
+    "signed-out": undefined;
+    error: {
+        message: string;
+        type: string;
+        code: number;
+    };
+};
+export type AuthUIEventName = keyof AuthUIEventMap;
+export 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;
+    preview: string;
+}
+//# sourceMappingURL=types.d.ts.map

package/dist/types.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,UAAU,CAAC;AAEvC,uDAAuD;AACvD,MAAM,MAAM,iBAAiB,GACzB,QAAQ,GACR,OAAO,GACP,UAAU,GACV,OAAO,GACP,WAAW,GACX,UAAU,GACV,WAAW,GACX,OAAO,GACP,KAAK,GACL,YAAY,GACZ,aAAa,GACb,SAAS,GACT,QAAQ,GACR,SAAS,GACT,MAAM,GACN,UAAU,GACV,OAAO,GACP,YAAY,GACZ,QAAQ,GACR,QAAQ,GACR,QAAQ,GACR,aAAa,GACb,OAAO,GACP,UAAU,GACV,MAAM,GACN,UAAU,GACV,WAAW,GACX,QAAQ,GACR,MAAM,GACN,MAAM,GACN,QAAQ,GACR,eAAe,GACf,OAAO,GACP,QAAQ,GACR,YAAY,GACZ,OAAO,GACP,SAAS,GACT,QAAQ,GACR,QAAQ,GACR,YAAY,GACZ,eAAe,GACf,QAAQ,GACR,WAAW,GACX,GAAG,GACH,OAAO,GACP,QAAQ,GACR,QAAQ,GACR,MAAM,GACN,MAAM,CAAC;AAEX,mCAAmC;AACnC,MAAM,MAAM,UAAU,GAClB,SAAS,GACT,SAAS,GACT,iBAAiB,GACjB,gBAAgB,GAChB,WAAW,GACX,WAAW,GACX,OAAO,GACP,KAAK,GACL,SAAS,CAAC;AAEd,MAAM,MAAM,WAAW,GAAG,OAAO,GAAG,MAAM,GAAG,MAAM,CAAC;AACpD,MAAM,MAAM,YAAY,GAAG,MAAM,GAAG,IAAI,GAAG,IAAI,GAAG,IAAI,GAAG,IAAI,GAAG,MAAM,CAAC;AAEvE,MAAM,WAAW,aAAa;IAC5B,2DAA2D;IAC3D,aAAa,CAAC,EAAE,OAAO,CAAC;IACxB,uDAAuD;IACvD,QAAQ,CAAC,EAAE,OAAO,CAAC;IACnB,+DAA+D;IAC/D,QAAQ,CAAC,EAAE,OAAO,CAAC;IACnB,yCAAyC;IACzC,KAAK,CAAC,EAAE,OAAO,CAAC;IAChB,6DAA6D;IAC7D,SAAS,CAAC,EAAE,OAAO,CAAC;IACpB,uDAAuD;IACvD,KAAK,CAAC,EAAE,iBAAiB,EAAE,CAAC;CAC7B;AAED,MAAM,WAAW,cAAc;IAC7B,sCAAsC;IACtC,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,wCAAwC;IACxC,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,mGAAmG;IACnG,KAAK,CAAC,EAAE,WAAW,CAAC;IACpB,0CAA0C;IAC1C,MAAM,CAAC,EAAE,YAAY,CAAC;IACtB,2EAA2E;IAC3E,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,qCAAqC;IACrC,iBAAiB,CAAC,EAAE,MAAM,CAAC;CAC5B;AAED,MAAM,WAAW,WAAW;IAC1B,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,UAAU,CAAC,EAAE,MAAM,CAAC;CACrB;AAED,MAAM,WAAW,YAAY;IAC3B,+DAA+D;IAC/D,QAAQ,EAAE,MAAM,CAAC;IACjB,2BAA2B;IAC3B,OAAO,EAAE,MAAM,CAAC;IAChB;;;;OAIG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,wFAAwF;IACxF,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,OAAO,CAAC,EAAE,aAAa,CAAC;IACxB,gDAAgD;IAChD,MAAM,CAAC,EAAE,OAAO,CAAC;IACjB,4DAA4D;IAC5D,WAAW,CAAC,EAAE,OAAO,CAAC;IACtB,8EAA8E;IAC9E,GAAG,CAAC,EAAE,OAAO,CAAC;IACd,4EAA4E;IAC5E,cAAc,CAAC,EAAE,OAAO,CAAC;IACzB,uCAAuC;IACvC,WAAW,CAAC,EAAE,OAAO,CAAC,MAAM,CAAC,iBAAiB,EAAE,MAAM,EAAE,CAAC,CAAC,CAAC;IAC3D,QAAQ,CAAC,EAAE,cAAc,CAAC;IAC1B,KAAK,CAAC,EAAE,WAAW,CAAC;IACpB,8BAA8B;IAC9B,OAAO,CAAC,EAAE,OAAO,CAAC,aAAa,CAAC,CAAC;IACjC;;;;OAIG;IACH,OAAO,CAAC,EAAE,OAAO,CAAC;CACnB;AAED,MAAM,MAAM,YAAY,GAAG,SAAS,GAAG,YAAY,GAAG,WAAW,GAAG,cAAc,CAAC;AAEnF,8EAA8E;AAC9E,MAAM,MAAM,mBAAmB,GAC3B;IAAE,IAAI,EAAE,gBAAgB,CAAC;IAAC,MAAM,EAAE,MAAM,CAAC;IAAC,MAAM,EAAE,MAAM,CAAA;CAAE,GAC1D;IAAE,IAAI,EAAE,cAAc,CAAC;IAAC,MAAM,EAAE,MAAM,CAAC;IAAC,MAAM,EAAE,MAAM,CAAA;CAAE,GACxD;IAAE,IAAI,EAAE,cAAc,CAAA;CAAE,GACxB;IAAE,IAAI,EAAE,QAAQ,CAAC;IAAC,OAAO,EAAE,MAAM,CAAC;IAAC,IAAI,EAAE,SAAS,GAAG,OAAO,GAAG,MAAM,CAAA;CAAE,CAAC;AAE5E,MAAM,WAAW,WAAW;IAC1B,MAAM,EAAE,YAAY,CAAC;IACrB,IAAI,EAAE,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,WAAW,CAAC,GAAG,IAAI,CAAC;IAC7C,uEAAuE;IACvE,UAAU,EAAE,MAAM,CAAC,UAAU,GAAG,IAAI,CAAC;IACrC,OAAO,EAAE,mBAAmB,GAAG,IAAI,CAAC;IACpC,UAAU,EAAE,OAAO,CAAC;CACrB;AAED,MAAM,MAAM,cAAc,GAAG;IAC3B,MAAM,EAAE,WAAW,CAAC;IACpB,WAAW,EAAE,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,WAAW,CAAC,CAAC;IAC7C,YAAY,EAAE,SAAS,CAAC;IACxB,KAAK,EAAE;QAAE,OAAO,EAAE,MAAM,CAAC;QAAC,IAAI,EAAE,MAAM,CAAC;QAAC,IAAI,EAAE,MAAM,CAAA;KAAE,CAAC;CACxD,CAAC;AAEF,MAAM,MAAM,eAAe,GAAG,MAAM,cAAc,CAAC;AAEnD,MAAM,WAAW,aAAa;IAC5B,MAAM,EAAE,MAAM,CAAC;IACf,MAAM,EAAE,MAAM,CAAC;IACf,OAAO,EAAE,MAAM,CAAC;IAChB,eAAe,EAAE,MAAM,CAAC;IACxB,KAAK,EAAE,MAAM,CAAC;IACd,QAAQ,EAAE,MAAM,CAAC;IACjB,WAAW,EAAE,MAAM,CAAC;IACpB,eAAe,EAAE,MAAM,CAAC;IACxB,IAAI,EAAE,MAAM,CAAC;IACb,KAAK,EAAE,MAAM,CAAC;IACd,IAAI,EAAE,MAAM,CAAC;IACb,cAAc,EAAE,MAAM,CAAC;IACvB,SAAS,EAAE,MAAM,CAAC;IAClB,WAAW,EAAE,MAAM,CAAC;IACpB,EAAE,EAAE,MAAM,CAAC;IACX,YAAY,EAAE,MAAM,CAAC;IACrB,iBAAiB,EAAE,MAAM,CAAC;IAC1B,aAAa,EAAE,MAAM,CAAC;IACtB,iBAAiB,EAAE,MAAM,CAAC;IAC1B,aAAa,EAAE,MAAM,CAAC;IACtB,QAAQ,EAAE,MAAM,CAAC;IACjB,UAAU,EAAE,MAAM,CAAC;IACnB,aAAa,EAAE,MAAM,CAAC;IACtB,QAAQ,EAAE,MAAM,CAAC;IACjB,cAAc,EAAE,MAAM,CAAC;IACvB,kBAAkB,EAAE,MAAM,CAAC;IAC3B,IAAI,EAAE,MAAM,CAAC;IACb,MAAM,EAAE,MAAM,CAAC;IACf,IAAI,EAAE,MAAM,CAAC;IACb,MAAM,EAAE,MAAM,CAAC;IACf,MAAM,EAAE,MAAM,CAAC;IACf,KAAK,EAAE,MAAM,CAAC;IACd,aAAa,EAAE,MAAM,CAAC;IACtB,aAAa,EAAE,MAAM,CAAC;IACtB,eAAe,EAAE,MAAM,CAAC;IACxB,aAAa,EAAE,MAAM,CAAC;IACtB,OAAO,EAAE,MAAM,CAAC;IAChB,KAAK,EAAE,MAAM,CAAC;IACd,OAAO,EAAE,MAAM,CAAC;IAChB,GAAG,EAAE,MAAM,CAAC;IACZ,WAAW,EAAE,MAAM,CAAC;IACpB,aAAa,EAAE,MAAM,CAAC;IACtB,WAAW,EAAE,MAAM,CAAC;IACpB,WAAW,EAAE,MAAM,CAAC;IACpB,QAAQ,EAAE,MAAM,CAAC;IACjB,cAAc,EAAE,MAAM,CAAC;IACvB,mBAAmB,EAAE,MAAM,CAAC;IAC5B,WAAW,EAAE,MAAM,CAAC;IACpB,WAAW,EAAE,MAAM,CAAC;IACpB,kBAAkB,EAAE,MAAM,CAAC;IAC3B,YAAY,EAAE,MAAM,CAAC;IACrB,OAAO,EAAE,MAAM,CAAC;IAChB,OAAO,EAAE,MAAM,CAAC;IAChB,QAAQ,EAAE,MAAM,CAAC;IACjB,QAAQ,EAAE,MAAM,CAAC;IACjB,WAAW,EAAE,MAAM,CAAC;IACpB,QAAQ,EAAE,MAAM,CAAC;IACjB,UAAU,EAAE,MAAM,CAAC;IACnB,QAAQ,EAAE,MAAM,CAAC;IACjB,UAAU,EAAE,MAAM,CAAC;IACnB,WAAW,EAAE,MAAM,CAAC;IACpB,gBAAgB,EAAE,MAAM,CAAC;IACzB,aAAa,EAAE,MAAM,CAAC;IACtB,cAAc,EAAE,MAAM,CAAC;IACvB,eAAe,EAAE,MAAM,CAAC;IACxB,SAAS,EAAE,MAAM,CAAC;IAClB,oBAAoB,EAAE,MAAM,CAAC;IAC7B,MAAM,EAAE,MAAM,CAAC;IACf,OAAO,EAAE,MAAM,CAAC;IAChB,gBAAgB,EAAE,MAAM,CAAC;IACzB,gBAAgB,EAAE,MAAM,CAAC;IACzB,iBAAiB,EAAE,MAAM,CAAC;IAC1B,mBAAmB,EAAE,MAAM,CAAC;IAC5B,mBAAmB,EAAE,MAAM,CAAC;IAC5B,aAAa,EAAE,MAAM,CAAC;IACtB,wBAAwB,EAAE,MAAM,CAAC;IACjC,qBAAqB,EAAE,MAAM,CAAC;IAC9B,uBAAuB,EAAE,MAAM,CAAC;IAChC,oBAAoB,EAAE,MAAM,CAAC;IAC7B,cAAc,EAAE,MAAM,CAAC;IACvB,cAAc,EAAE,MAAM,CAAC;IACvB,kBAAkB,EAAE,MAAM,CAAC;IAC3B,6BAA6B,EAAE,MAAM,CAAC;IACtC,aAAa,EAAE,MAAM,CAAC;IACtB,UAAU,EAAE,MAAM,CAAC;IACnB,UAAU,EAAE,MAAM,CAAC;IACnB,aAAa,EAAE,MAAM,CAAC;IACtB,wBAAwB,EAAE,MAAM,CAAC;IACjC,oBAAoB,EAAE,MAAM,CAAC;IAC7B,OAAO,EAAE,MAAM,CAAC;IAChB,MAAM,EAAE,MAAM,CAAC;IACf,IAAI,EAAE,MAAM,CAAC;IACb,IAAI,EAAE,MAAM,CAAC;IACb,YAAY,EAAE,MAAM,CAAC;IACrB,uBAAuB,EAAE,MAAM,CAAC;IAChC,eAAe,EAAE,MAAM,CAAC;IACxB,gBAAgB,EAAE,MAAM,CAAC;IACzB,cAAc,EAAE,MAAM,CAAC;IACvB,iBAAiB,EAAE,MAAM,CAAC;IAC1B,gBAAgB,EAAE,MAAM,CAAC;IACzB,qBAAqB,EAAE,MAAM,CAAC;IAC9B,yBAAyB,EAAE,MAAM,CAAC;IAClC,yBAAyB,EAAE,MAAM,CAAC;IAClC,iBAAiB,EAAE,MAAM,CAAC;IAC1B,kBAAkB,EAAE,MAAM,CAAC;IAC3B,sBAAsB,EAAE,MAAM,CAAC;IAC/B,kBAAkB,EAAE,MAAM,CAAC;IAC3B,UAAU,EAAE,MAAM,CAAC;IACnB,YAAY,EAAE,MAAM,CAAC;IACrB,mBAAmB,EAAE,MAAM,CAAC;IAC5B,kBAAkB,EAAE,MAAM,CAAC;IAC3B,YAAY,EAAE,MAAM,CAAC;IACrB,UAAU,EAAE,MAAM,CAAC;IACnB,aAAa,EAAE,MAAM,CAAC;IACtB,QAAQ,EAAE,MAAM,CAAC;IACjB,QAAQ,EAAE,MAAM,CAAC;IACjB,UAAU,EAAE,MAAM,CAAC;IACnB,YAAY,EAAE,MAAM,CAAC;IACrB,uBAAuB,EAAE,MAAM,CAAC;IAChC,OAAO,EAAE,MAAM,CAAC;CACjB"}

package/package.json

@@ -1,18 +1,18 @@
 {
   "name": "@getauthui/core",
-  "version": "0.1.0",
+  "version": "0.1.1",
   "description": "Drop-in authentication UI for Appwrite. One script tag, every sign-in method, MFA, sessions and account management as web components.",
   "type": "module",
   "main": "./dist/authui.js",
   "module": "./dist/authui.js",
-  "types": "./dist/authui.d.ts",
+  "types": "./dist/index.d.ts",
   "exports": {
     ".": {
-      "types": "./dist/authui.d.ts",
+      "types": "./dist/index.d.ts",
       "import": "./dist/authui.js"
     },
     "./react": {
-      "types": "./dist/react.d.ts",
+      "types": "./dist/react/index.d.ts",
       "import": "./dist/react.js"
     },
     "./cdn": "./dist/authui.cdn.mjs",