@unidy.io/sdk 1.1.8 → 1.1.10

package/dist/types/auth/auth-helpers.d.ts

@@ -0,0 +1,376 @@
+import type { UnidyClient } from "../api";
+export declare class AuthHelpers {
+    private client;
+    private logger;
+    constructor(client: UnidyClient);
+    createSignIn(email: string, password?: string, sendMagicCode?: boolean): Promise<readonly ["missing_required_fields" | "connection_failed" | "schema_validation_error" | "account_not_found" | "invalid_password" | "sign_in_not_found" | "sign_in_expired" | "account_locked" | "magic_code_recently_created", {
+        error_identifier: string;
+    } | {
+        sid: string;
+        status: "pending_verification" | "authenticated" | "completed";
+        email: string;
+        expired: boolean;
+        login_options: {
+            magic_link: boolean;
+            password: boolean;
+            social_logins: string[];
+            passkey: boolean;
+        };
+    } | {
+        jwt: string;
+        sid?: string;
+    } | {
+        enable_resend_after: number;
+        sid?: string;
+    } | {
+        error_identifier: "missing_required_fields";
+        fields: {
+            email?: {
+                required: boolean;
+                label: string;
+                attr_name: string;
+                type: "text" | "textarea";
+                locked?: boolean;
+                locked_text?: string;
+                value?: string;
+            };
+            salutation?: {
+                required: boolean;
+                label: string;
+                attr_name: string;
+                type: "radio";
+                radio_options: {
+                    label: string;
+                    checked: boolean;
+                    value?: string | boolean;
+                }[];
+                locked?: boolean;
+                locked_text?: string;
+                value?: string | boolean;
+            };
+            first_name?: {
+                required: boolean;
+                label: string;
+                attr_name: string;
+                type: "text" | "textarea";
+                locked?: boolean;
+                locked_text?: string;
+                value?: string;
+            };
+            last_name?: {
+                required: boolean;
+                label: string;
+                attr_name: string;
+                type: "text" | "textarea";
+                locked?: boolean;
+                locked_text?: string;
+                value?: string;
+            };
+            phone_number?: {
+                required: boolean;
+                label: string;
+                attr_name: string;
+                type: "tel";
+                locked?: boolean;
+                locked_text?: string;
+                value?: string;
+            };
+            company_name?: {
+                required: boolean;
+                label: string;
+                attr_name: string;
+                type: "text" | "textarea";
+                locked?: boolean;
+                locked_text?: string;
+                value?: string;
+            };
+            address_line_1?: {
+                required: boolean;
+                label: string;
+                attr_name: string;
+                type: "text" | "textarea";
+                locked?: boolean;
+                locked_text?: string;
+                value?: string;
+            };
+            address_line_2?: {
+                required: boolean;
+                label: string;
+                attr_name: string;
+                type: "text" | "textarea";
+                locked?: boolean;
+                locked_text?: string;
+                value?: string;
+            };
+            city?: {
+                required: boolean;
+                label: string;
+                attr_name: string;
+                type: "text" | "textarea";
+                locked?: boolean;
+                locked_text?: string;
+                value?: string;
+            };
+            postal_code?: {
+                required: boolean;
+                label: string;
+                attr_name: string;
+                type: "text" | "textarea";
+                locked?: boolean;
+                locked_text?: string;
+                value?: string;
+            };
+            country_code?: {
+                required: boolean;
+                label: string;
+                attr_name: string;
+                type: "select";
+                options: {
+                    value: string;
+                    label: string;
+                }[];
+                locked?: boolean;
+                locked_text?: string;
+                value?: string;
+            };
+            date_of_birth?: {
+                required: boolean;
+                label: string;
+                attr_name: string;
+                type: "date" | "datetime-local";
+                locked?: boolean;
+                locked_text?: string;
+                value?: string;
+            };
+            preferred_language?: {
+                required: boolean;
+                label: string;
+                attr_name: string;
+                type: "text" | "textarea";
+                locked?: boolean;
+                locked_text?: string;
+                value?: string;
+            };
+            custom_attributes?: Record<string, {
+                required: boolean;
+                label: string;
+                attr_name: string;
+                type: "number" | "boolean" | "date" | "radio" | "text" | "textarea" | "tel" | "select" | "datetime-local" | "checkbox";
+                readonly: boolean;
+                locked?: boolean;
+                locked_text?: string;
+                value?: string | number | boolean | string[];
+                radio_options?: {
+                    label: string;
+                    checked: boolean;
+                    value?: string | boolean;
+                }[];
+                options?: {
+                    value: string;
+                    label: string;
+                }[];
+            }>;
+        };
+        sid?: string;
+    } | {
+        error_identifier: string;
+        enable_resend_after: number;
+    } | {
+        error_identifier: string;
+        errors: string[];
+    }]>;
+    authenticateWithPassword(password: string): Promise<void>;
+    authenticateWithMagicCode(code: string): Promise<void>;
+    authenticateWithPasskey(): Promise<void>;
+    logout(): Promise<readonly ["connection_failed" | "schema_validation_error" | "sign_in_not_found" | "missing_id_token" | "invalid_id_token", {
+        error_identifier: string;
+    } | {
+        error_identifier: string;
+        errors: string[];
+    }]>;
+    refreshToken(): Promise<void>;
+    checkSignedIn(): Promise<void>;
+    sendMagicCode(): Promise<readonly ["missing_required_fields" | "connection_failed" | "schema_validation_error" | "account_not_found" | "invalid_password" | "sign_in_not_found" | "sign_in_expired" | "account_locked" | "magic_code_recently_created", {
+        error_identifier: string;
+    } | {
+        sid: string;
+        status: "pending_verification" | "authenticated" | "completed";
+        email: string;
+        expired: boolean;
+        login_options: {
+            magic_link: boolean;
+            password: boolean;
+            social_logins: string[];
+            passkey: boolean;
+        };
+    } | {
+        jwt: string;
+        sid?: string;
+    } | {
+        enable_resend_after: number;
+        sid?: string;
+    } | {
+        error_identifier: "missing_required_fields";
+        fields: {
+            email?: {
+                required: boolean;
+                label: string;
+                attr_name: string;
+                type: "text" | "textarea";
+                locked?: boolean;
+                locked_text?: string;
+                value?: string;
+            };
+            salutation?: {
+                required: boolean;
+                label: string;
+                attr_name: string;
+                type: "radio";
+                radio_options: {
+                    label: string;
+                    checked: boolean;
+                    value?: string | boolean;
+                }[];
+                locked?: boolean;
+                locked_text?: string;
+                value?: string | boolean;
+            };
+            first_name?: {
+                required: boolean;
+                label: string;
+                attr_name: string;
+                type: "text" | "textarea";
+                locked?: boolean;
+                locked_text?: string;
+                value?: string;
+            };
+            last_name?: {
+                required: boolean;
+                label: string;
+                attr_name: string;
+                type: "text" | "textarea";
+                locked?: boolean;
+                locked_text?: string;
+                value?: string;
+            };
+            phone_number?: {
+                required: boolean;
+                label: string;
+                attr_name: string;
+                type: "tel";
+                locked?: boolean;
+                locked_text?: string;
+                value?: string;
+            };
+            company_name?: {
+                required: boolean;
+                label: string;
+                attr_name: string;
+                type: "text" | "textarea";
+                locked?: boolean;
+                locked_text?: string;
+                value?: string;
+            };
+            address_line_1?: {
+                required: boolean;
+                label: string;
+                attr_name: string;
+                type: "text" | "textarea";
+                locked?: boolean;
+                locked_text?: string;
+                value?: string;
+            };
+            address_line_2?: {
+                required: boolean;
+                label: string;
+                attr_name: string;
+                type: "text" | "textarea";
+                locked?: boolean;
+                locked_text?: string;
+                value?: string;
+            };
+            city?: {
+                required: boolean;
+                label: string;
+                attr_name: string;
+                type: "text" | "textarea";
+                locked?: boolean;
+                locked_text?: string;
+                value?: string;
+            };
+            postal_code?: {
+                required: boolean;
+                label: string;
+                attr_name: string;
+                type: "text" | "textarea";
+                locked?: boolean;
+                locked_text?: string;
+                value?: string;
+            };
+            country_code?: {
+                required: boolean;
+                label: string;
+                attr_name: string;
+                type: "select";
+                options: {
+                    value: string;
+                    label: string;
+                }[];
+                locked?: boolean;
+                locked_text?: string;
+                value?: string;
+            };
+            date_of_birth?: {
+                required: boolean;
+                label: string;
+                attr_name: string;
+                type: "date" | "datetime-local";
+                locked?: boolean;
+                locked_text?: string;
+                value?: string;
+            };
+            preferred_language?: {
+                required: boolean;
+                label: string;
+                attr_name: string;
+                type: "text" | "textarea";
+                locked?: boolean;
+                locked_text?: string;
+                value?: string;
+            };
+            custom_attributes?: Record<string, {
+                required: boolean;
+                label: string;
+                attr_name: string;
+                type: "number" | "boolean" | "date" | "radio" | "text" | "textarea" | "tel" | "select" | "datetime-local" | "checkbox";
+                readonly: boolean;
+                locked?: boolean;
+                locked_text?: string;
+                value?: string | number | boolean | string[];
+                radio_options?: {
+                    label: string;
+                    checked: boolean;
+                    value?: string | boolean;
+                }[];
+                options?: {
+                    value: string;
+                    label: string;
+                }[];
+            }>;
+        };
+        sid?: string;
+    } | {
+        error_identifier: string;
+        enable_resend_after: number;
+    } | {
+        error_identifier: string;
+        errors: string[];
+    }]>;
+    sendResetPasswordEmail(): Promise<void>;
+    resetPassword(): Promise<void>;
+    handleResetPasswordRedirect(): Promise<void>;
+    handleSocialAuthRedirect(): void;
+    private handleAuthError;
+    private handleMissingFields;
+    private handleAuthSuccess;
+}

package/dist/types/auth/auth.d.ts

@@ -0,0 +1,62 @@
+import type { UnidyClient } from "../api";
+import { AuthHelpers } from "./auth-helpers";
+export interface TokenPayload {
+    sub: string;
+    sid: string;
+    exp: number;
+    iat: number;
+    iss: string;
+    aud: string;
+    nonce: string;
+    auth_time: number;
+    email: string;
+    email_verified: boolean;
+    [key: string]: unknown;
+}
+export type AuthError = Error & {
+    code: "TOKEN_EXPIRED" | "REFRESH_FAILED" | "NO_TOKEN" | "INVALID_TOKEN" | "SIGN_IN_NOT_FOUND" | "SIGN_OUT_FAILED";
+    requiresReauth: boolean;
+};
+export declare class Auth {
+    private static instance;
+    readonly helpers: AuthHelpers;
+    private constructor();
+    static Errors: {
+        readonly email: {
+            readonly NOT_FOUND: "account_not_found";
+        };
+        readonly magicCode: {
+            readonly RECENTLY_CREATED: "magic_code_recently_created";
+            readonly NOT_VALID: "magic_code_not_valid";
+            readonly EXPIRED: "magic_code_expired";
+            readonly USED: "magic_code_used";
+        };
+        readonly password: {
+            readonly INVALID: "invalid_password";
+            readonly NOT_SET: "password_not_set";
+            readonly RESET_PASSWORD_ALREADY_SENT: "reset_password_already_sent";
+        };
+        readonly general: {
+            readonly ACCOUNT_LOCKED: "account_locked";
+            readonly SIGN_IN_EXPIRED: "sign_in_expired";
+        };
+    };
+    static getInstance(): Promise<Auth>;
+    static initialize(client: UnidyClient): Promise<Auth>;
+    static isInitialized(): boolean;
+    /**
+     * Checks whether a JWT token is valid and not expired.
+     *
+     * @param token - The JWT token to validate. Can be a raw JWT string, a decoded TokenPayload, or null.
+     * @param expirationBuffer - Number of seconds before actual expiration to consider the token invalid, used to prevent race conditions with preemptive token refresh. Defaults to 10 seconds.
+     * @returns `true` if the token is valid and won't expire within the buffer period, `false` otherwise.
+     * @throws Error if expirationBuffer is not positive number
+     */
+    isTokenValid(token: string | TokenPayload | null, expirationBuffer?: number): boolean;
+    isAuthenticated(): Promise<boolean>;
+    getToken(): Promise<string | AuthError>;
+    userData(): Promise<TokenPayload | null>;
+    logout(): Promise<boolean | AuthError>;
+    getEmail(): string | null;
+    private createAuthError;
+}

package/dist/types/auth/components/helpers.d.ts

@@ -0,0 +1 @@
+export declare function getParentSigninStep(element: HTMLElement): HTMLUSigninStepElement | null;

package/dist/types/auth/components/logout-button/logout-button.d.ts

@@ -0,0 +1,11 @@
+import { type EventEmitter } from "../../../stencil-public-runtime";
+export declare class LogoutButton {
+    el: HTMLElement;
+    componentClassName: string;
+    reloadOnSuccess: boolean;
+    logout: EventEmitter<void>;
+    private hasSlot;
+    componentWillLoad(): Promise<void>;
+    private handleLogout;
+    render(): any;
+}

package/dist/types/auth/components/magic-code-field/magic-code-field.d.ts

@@ -0,0 +1,10 @@
+export declare class MagicCodeField {
+    componentClassName: string;
+    codeDigits: string[];
+    private inputRefs;
+    private handleInput;
+    private handleKeyDown;
+    private handlePaste;
+    private authenticateWithCode;
+    render(): any;
+}

package/dist/types/auth/components/missing-field/missing-field.d.ts

@@ -0,0 +1,4 @@
+export declare class MissingField {
+    el: HTMLElement;
+    render(): any;
+}

package/dist/types/auth/components/missing-fields-submit-button/missing-fields-submit-button.d.ts

@@ -0,0 +1,5 @@
+export declare class MissingFieldsSubmitButton {
+    el: HTMLElement;
+    private onSubmit;
+    render(): any;
+}

package/dist/types/auth/components/passkey/passkey.d.ts

@@ -0,0 +1,9 @@
+export declare class Passkey {
+    disabled: boolean;
+    componentClassName: string;
+    ariaDescribedBy?: string;
+    isSupported: boolean;
+    componentWillLoad(): void;
+    private handleClick;
+    render(): any;
+}

package/dist/types/auth/components/password-field/password-field.d.ts

@@ -0,0 +1,15 @@
+export type PasswordFieldFor = "login" | "new-password" | "password-confirmation";
+export declare class PasswordField {
+    el: HTMLElement;
+    for: PasswordFieldFor;
+    componentClassName: string;
+    ariaLabel: string;
+    private getAriaLabel;
+    private getValue;
+    private getAutocomplete;
+    private getInputName;
+    private handleInput;
+    private handleSubmit;
+    private shouldRender;
+    render(): any;
+}

package/dist/types/auth/components/registration/registration-button.d.ts

@@ -0,0 +1,11 @@
+export declare class RegistrationButton {
+    el: HTMLElement;
+    for: "email";
+    componentClassName: string;
+    redirectUri: string;
+    private getButtonText;
+    private shouldRender;
+    private getAuthUrl;
+    private handleClick;
+    render(): any;
+}

package/dist/types/auth/components/reset-pass-button/reset-pass-button.d.ts

@@ -0,0 +1,7 @@
+export declare class ResetPasswordButton {
+    componentClassName: string;
+    private handleClick;
+    private shouldRender;
+    private getButtonText;
+    render(): any;
+}

package/dist/types/auth/components/send-magic-code-button/send-magic-code-button.d.ts

@@ -0,0 +1,11 @@
+export declare class SendMagicCodeButton {
+    disabled: boolean;
+    componentClassName: string;
+    countdown: number;
+    private countdownInterval;
+    private handleClick;
+    private startCountdown;
+    private clearCountdown;
+    disconnectedCallback(): void;
+    render(): any;
+}

package/dist/types/auth/components/signed-in/signed-in.d.ts

@@ -0,0 +1,5 @@
+export declare class SignedIn {
+    componentClassName: string;
+    not: boolean;
+    render(): any;
+}

package/dist/types/auth/components/signin-root/signin-root.d.ts

@@ -0,0 +1,14 @@
+import { type EventEmitter } from "../../../stencil-public-runtime";
+import type { TokenResponse } from "../../api/auth";
+export declare class SigninRoot {
+    el: HTMLElement;
+    componentClassName: string;
+    authEvent: EventEmitter<TokenResponse>;
+    errorEvent: EventEmitter<{
+        error: string;
+    }>;
+    componentDidLoad(): void;
+    onAuth(response: TokenResponse): void;
+    onError(error: string): void;
+    render(): any;
+}

package/dist/types/auth/components/signin-step/signin-step.d.ts

@@ -0,0 +1,8 @@
+export declare class SigninStep {
+    el: HTMLElement;
+    name: "email" | "verification" | "reset-password" | "single-login" | "missing-fields" | "registration";
+    alwaysRender: boolean;
+    isActive(): Promise<boolean>;
+    submit(): Promise<void>;
+    render(): any;
+}

package/dist/types/auth/components/signin-strategy/signin-strategy.d.ts

@@ -0,0 +1,5 @@
+export declare class SigninStrategy {
+    type: "password" | "magic-code";
+    componentClassName: string;
+    render(): any;
+}

package/dist/types/auth/components/social-logins/logos/apple.d.ts

@@ -0,0 +1,4 @@
+import { type FunctionalComponent } from "../../../../stencil-public-runtime";
+export declare const AppleLogo: FunctionalComponent<{
+    className: string;
+}>;

package/dist/types/auth/components/social-logins/logos/discord.d.ts

@@ -0,0 +1,4 @@
+import { type FunctionalComponent } from "../../../../stencil-public-runtime";
+export declare const DiscordLogo: FunctionalComponent<{
+    className: string;
+}>;

package/dist/types/auth/components/social-logins/logos/facebook.d.ts

@@ -0,0 +1,4 @@
+import { type FunctionalComponent } from "../../../../stencil-public-runtime";
+export declare const FacebookLogo: FunctionalComponent<{
+    className: string;
+}>;

package/dist/types/auth/components/social-logins/logos/google.d.ts

@@ -0,0 +1,4 @@
+import { type FunctionalComponent } from "../../../../stencil-public-runtime";
+export declare const GoogleLogo: FunctionalComponent<{
+    className: string;
+}>;

package/dist/types/auth/components/social-logins/logos/linkedin.d.ts

@@ -0,0 +1,4 @@
+import { type FunctionalComponent } from "../../../../stencil-public-runtime";
+export declare const LinkedInLogo: FunctionalComponent<{
+    className: string;
+}>;

package/dist/types/auth/components/social-logins/social-login-button.d.ts

@@ -0,0 +1,24 @@
+import { UnidyComponent } from "../../../logger";
+declare const ICON_MAP: {
+    readonly google: any;
+    readonly linkedin: any;
+    readonly apple: any;
+    readonly discord: any;
+    readonly facebook: any;
+};
+type SocialLoginProvider = keyof typeof ICON_MAP | "unidy";
+export declare class SocialLoginButton extends UnidyComponent {
+    provider: SocialLoginProvider;
+    redirectUri: string;
+    iconOnly: boolean;
+    theme: "light" | "dark";
+    componentWillLoad(): void;
+    private get isUnsupportedProvider();
+    private get isProviderEnabled();
+    private getAuthUrl;
+    private onClick;
+    private renderIcon;
+    private getButtonClasses;
+    render(): any;
+}
+export {};

package/dist/types/auth/components/submit-button/auth-submit-button.d.ts

@@ -0,0 +1,3 @@
+import type { SubmitButtonContext } from "../../../shared/components/submit-button/context";
+export type AuthButtonFor = "email" | "password" | "resetPassword";
+export declare const authContext: SubmitButtonContext<AuthButtonFor>;

package/dist/types/auth/error-definitions.d.ts

@@ -0,0 +1,23 @@
+export declare const AUTH_ERROR_CODES: {
+    readonly EMAIL: {
+        readonly NOT_FOUND: "account_not_found";
+    };
+    readonly PASSWORD: {
+        readonly INVALID: "invalid_password";
+        readonly NOT_SET: "password_not_set";
+        readonly RESET_PASSWORD_ALREADY_SENT: "reset_password_already_sent";
+    };
+    readonly MAGIC_CODE: {
+        readonly RECENTLY_CREATED: "magic_code_recently_created";
+        readonly EXPIRED: "magic_code_expired";
+        readonly USED: "magic_code_used";
+        readonly NOT_VALID: "magic_code_not_valid";
+    };
+    readonly PASSWORD_RESET: {
+        readonly PASSWORD_TOO_WEAK: "password_too_weak";
+    };
+    readonly GENERAL: {
+        readonly ACCOUNT_LOCKED: "account_locked";
+        readonly SIGN_IN_EXPIRED: "sign_in_expired";
+    };
+};

package/dist/types/auth/index.d.ts

@@ -0,0 +1,15 @@
+/**
+ * @fileoverview entry point for your component library
+ *
+ * This is the entry point for your component library. Use this file to export utilities,
+ * constants or data structure that accompany your components.
+ *
+ * DO NOT use this file to export your components. Instead, use the recommended approaches
+ * to consume components of this package as outlined in the `README.md`.
+ */
+export type { LoginOptions } from "./api/auth";
+export type { AuthError, TokenPayload } from "./auth";
+export * from "./auth";
+export * from "./error-definitions";
+export type { AuthState, AuthStep } from "./store/auth-store";
+export { authState, authStore, missingFieldNames, onChange as onAuthChange } from "./store/auth-store";