@tern-secure/types 1.0.0

package/dist/ternsecure.d.ts

@@ -0,0 +1,123 @@
+import { TernSecureUser } from './all';
+import { Appearance } from './theme';
+export interface TernSecureSession {
+    token: string | null;
+    expiresAt?: number;
+}
+type SignInFormValues = {
+    email: string;
+    password: string;
+    phoneNumber?: string;
+};
+export type SignInInitialValue = Partial<SignInFormValues>;
+type SignUpFormValues = {
+    email: string;
+    password: string;
+    confirmPassword?: string;
+    displayName?: string;
+};
+export type SignUpInitialValue = Partial<SignUpFormValues>;
+export interface SignInResponse {
+    success: boolean;
+    message?: string;
+    error?: any | undefined;
+    user?: any;
+}
+export interface AuthError extends Error {
+    code?: any | string;
+    message: string;
+    response?: SignInResponse;
+}
+export declare function isSignInResponse(value: any): value is SignInResponse;
+export interface AuthActions {
+    signInWithEmail: (email: string, password: string) => Promise<SignInResponse>;
+    signInWithGoogle: () => Promise<void>;
+    signInWithMicrosoft: () => Promise<void>;
+    signOut: () => Promise<void>;
+    getRedirectResult: () => Promise<any>;
+    getIdToken: () => Promise<string | null>;
+    createUserWithEmailAndPassword?: (email: string, password: string) => Promise<SignInResponse>;
+    sendEmailVerification?: (user: TernSecureUser) => Promise<void>;
+}
+export interface RedirectConfig {
+    redirectUrl?: string;
+    isReturn?: boolean;
+    priority?: number;
+}
+export interface SignInProps extends RedirectConfig {
+    initialValue?: SignInInitialValue;
+    logo?: string;
+    appName?: string;
+    appearance?: Appearance;
+    onError?: (error: AuthError) => void;
+    onSuccess?: (user: TernSecureUser | null) => void;
+}
+/**
+ * SignUpProps interface defines the properties for the sign-up component.
+ * It extends RedirectConfig to include redirect-related properties.
+ */
+export interface SignUpProps extends RedirectConfig {
+    initialValue?: SignUpInitialValue;
+    logo?: string;
+    appName?: string;
+    appearance?: Appearance;
+    onError?: (error: AuthError) => void;
+    onSuccess?: (user: TernSecureUser | null) => void;
+}
+/**
+ * Defines the contract for a TernSecure instance.
+ * This instance provides authentication state, user information, and methods
+ * for managing the authentication lifecycle. It is designed to be used by
+ * UI packages like tern-ui, which act as "dumb" renderers.
+ */
+export interface TernSecureInstance {
+    /** Indicates if the user is currently signed in. */
+    isSignedIn: () => boolean;
+    /** The current authenticated user object, or null if not signed in. */
+    user: TernSecureUser | null;
+    /** The current user session information, or null if not signed in. */
+    session: TernSecureSession | null;
+    /** Initiates the sign-out process for the current user. */
+    signOut: () => Promise<void>;
+    /**
+     * Prepares or signals to mount the sign-in interface.
+     * @param options Optional configuration or initial state for the sign-in UI, conforming to SignInProps.
+     */
+    mountSignIn: (options?: SignInProps) => void;
+    /** Cleans up or signals to unmount the sign-in interface. */
+    unmountSignIn: () => void;
+    /**
+     * Prepares or signals to mount the sign-up interface.
+     * @param options Optional configuration or initial state for the sign-up UI, conforming to SignUpProps.
+     */
+    mountSignUp: (options?: SignUpProps) => void;
+    /** Cleans up or signals to unmount the sign-up interface. */
+    unmountSignUp: () => void;
+    /**
+     * Determines if a redirect is necessary based on the current authentication
+     * state and the given path.
+     * @param currentPath The current URL path.
+     * @returns True if a redirect is needed, false otherwise, or a string path to redirect to.
+     */
+    shouldRedirect: (currentPath: string) => boolean | string;
+    /**
+     * Constructs a URL, appending necessary redirect parameters.
+     * Useful for redirecting back to the original page after authentication.
+     * @param baseUrl The base URL to which redirect parameters should be added.
+     * @returns The new URL string with redirect parameters.
+     */
+    constructUrlWithRedirect: (baseUrl: string) => string;
+    /**
+     * Redirects the user to the configured login page.
+     * @param redirectUrl Optional URL to redirect to after successful login.
+     */
+    redirectToLogin: (redirectUrl?: string) => void;
+    /** Indicates if an authentication operation is currently in progress. */
+    isLoading: boolean;
+    /** Holds any error that occurred during an authentication operation, or null otherwise. */
+    error: Error | null;
+    /** Indicates if the user has verified their email address. */
+    sendVerificationEmail: () => Promise<void>;
+}
+export {};
+//# sourceMappingURL=ternsecure.d.ts.map

package/dist/ternsecure.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"ternsecure.d.ts","sourceRoot":"","sources":["../src/ternsecure.ts"],"names":[],"mappings":"AAAA,OAAO,EACH,cAAc,EACjB,MAAM,OAAO,CAAC;AACf,OAAO,EAAE,UAAU,EAAE,MAAM,SAAS,CAAC;AAErC,MAAM,WAAW,iBAAiB;IAChC,KAAK,EAAE,MAAM,GAAG,IAAI,CAAC;IACrB,SAAS,CAAC,EAAE,MAAM,CAAC;CACpB;AAED,KAAK,gBAAgB,GAAG;IACtB,KAAK,EAAE,MAAM,CAAC;IACd,QAAQ,EAAE,MAAM,CAAC;IACjB,WAAW,CAAC,EAAE,MAAM,CAAC;CACtB,CAAA;AAED,MAAM,MAAM,kBAAkB,GAAG,OAAO,CAAC,gBAAgB,CAAC,CAAC;AAG3D,KAAK,gBAAgB,GAAG;IACtB,KAAK,EAAE,MAAM,CAAC;IACd,QAAQ,EAAE,MAAM,CAAC;IACjB,eAAe,CAAC,EAAE,MAAM,CAAC;IACzB,WAAW,CAAC,EAAE,MAAM,CAAC;CACtB,CAAC;AAGF,MAAM,MAAM,kBAAkB,GAAG,OAAO,CAAC,gBAAgB,CAAC,CAAC;AAE3D,MAAM,WAAW,cAAc;IAC7B,OAAO,EAAE,OAAO,CAAC;IACjB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,KAAK,CAAC,EAAE,GAAG,GAAG,SAAS,CAAC;IACxB,IAAI,CAAC,EAAE,GAAG,CAAC;CACZ;AAED,MAAM,WAAW,SAAU,SAAQ,KAAK;IACtC,IAAI,CAAC,EAAE,GAAG,GAAG,MAAM,CAAA;IACnB,OAAO,EAAE,MAAM,CAAA;IACf,QAAQ,CAAC,EAAE,cAAc,CAAA;CAC1B;AAED,wBAAgB,gBAAgB,CAAC,KAAK,EAAE,GAAG,GAAG,KAAK,IAAI,cAAc,CAEpE;AAED,MAAM,WAAW,WAAW;IAC1B,eAAe,EAAE,CAAC,KAAK,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,KAAK,OAAO,CAAC,cAAc,CAAC,CAAC;IAC9E,gBAAgB,EAAE,MAAM,OAAO,CAAC,IAAI,CAAC,CAAC;IACtC,mBAAmB,EAAE,MAAM,OAAO,CAAC,IAAI,CAAC,CAAC;IACzC,OAAO,EAAE,MAAM,OAAO,CAAC,IAAI,CAAC,CAAC;IAC7B,iBAAiB,EAAE,MAAM,OAAO,CAAC,GAAG,CAAC,CAAC;IACtC,UAAU,EAAE,MAAM,OAAO,CAAC,MAAM,GAAG,IAAI,CAAC,CAAC;IACzC,8BAA8B,CAAC,EAAE,CAAC,KAAK,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,KAAK,OAAO,CAAC,cAAc,CAAC,CAAC;IAC9F,qBAAqB,CAAC,EAAE,CAAC,IAAI,EAAE,cAAc,KAAK,OAAO,CAAC,IAAI,CAAC,CAAC;CACjE;AAED,MAAM,WAAW,cAAc;IAE7B,WAAW,CAAC,EAAE,MAAM,CAAA;IAEpB,QAAQ,CAAC,EAAE,OAAO,CAAA;IAElB,QAAQ,CAAC,EAAE,MAAM,CAAA;CAClB;AAGD,MAAM,WAAW,WAAY,SAAQ,cAAc;IACjD,YAAY,CAAC,EAAE,kBAAkB,CAAC;IAClC,IAAI,CAAC,EAAE,MAAM,CAAA;IACb,OAAO,CAAC,EAAE,MAAM,CAAA;IAChB,UAAU,CAAC,EAAE,UAAU,CAAC;IACxB,OAAO,CAAC,EAAE,CAAC,KAAK,EAAE,SAAS,KAAK,IAAI,CAAC;IACrC,SAAS,CAAC,EAAE,CAAC,IAAI,EAAE,cAAc,GAAG,IAAI,KAAK,IAAI,CAAC;CACnD;AAGD;;;GAGG;AACH,MAAM,WAAW,WAAY,SAAQ,cAAc;IACjD,YAAY,CAAC,EAAE,kBAAkB,CAAC;IAClC,IAAI,CAAC,EAAE,MAAM,CAAA;IACb,OAAO,CAAC,EAAE,MAAM,CAAA;IAChB,UAAU,CAAC,EAAE,UAAU,CAAC;IACxB,OAAO,CAAC,EAAE,CAAC,KAAK,EAAE,SAAS,KAAK,IAAI,CAAC;IACrC,SAAS,CAAC,EAAE,CAAC,IAAI,EAAE,cAAc,GAAG,IAAI,KAAK,IAAI,CAAC;CACnD;AAED;;;;;GAKG;AACH,MAAM,WAAW,kBAAkB;IACjC,oDAAoD;IACpD,UAAU,EAAE,MAAM,OAAO,CAAC;IAE1B,uEAAuE;IACvE,IAAI,EAAE,cAAc,GAAG,IAAI,CAAC;IAE5B,sEAAsE;IACtE,OAAO,EAAE,iBAAiB,GAAG,IAAI,CAAC;IAElC,2DAA2D;IAC3D,OAAO,EAAE,MAAM,OAAO,CAAC,IAAI,CAAC,CAAC;IAE7B;;;OAGG;IACH,WAAW,EAAE,CAAC,OAAO,CAAC,EAAE,WAAW,KAAK,IAAI,CAAC;IAE7C,6DAA6D;IAC7D,aAAa,EAAE,MAAM,IAAI,CAAC;IAE1B;;;OAGG;IACH,WAAW,EAAE,CAAC,OAAO,CAAC,EAAE,WAAW,KAAK,IAAI,CAAC;IAE7C,6DAA6D;IAC7D,aAAa,EAAE,MAAM,IAAI,CAAC;IAE1B;;;;;OAKG;IACH,cAAc,EAAE,CAAC,WAAW,EAAE,MAAM,KAAK,OAAO,GAAG,MAAM,CAAC;IAE1D;;;;;OAKG;IACH,wBAAwB,EAAE,CAAC,OAAO,EAAE,MAAM,KAAK,MAAM,CAAC;IAEtD;;;OAGG;IACH,eAAe,EAAE,CAAC,WAAW,CAAC,EAAE,MAAM,KAAK,IAAI,CAAC;IAEhD,yEAAyE;IACzE,SAAS,EAAE,OAAO,CAAC;IAEnB,2FAA2F;IAC3F,KAAK,EAAE,KAAK,GAAG,IAAI,CAAC;IAEpB,8DAA8D;IAC9D,qBAAqB,EAAE,MAAM,OAAO,CAAC,IAAI,CAAC,CAAC;CAC5C"}

package/dist/theme.d.ts

@@ -0,0 +1,133 @@
+/**
+ * Defines the basic structure for color theming.
+ */
+export interface ThemeColors {
+    primary?: string;
+    secondary?: string;
+    accent?: string;
+    background?: string;
+    text?: string;
+    error?: string;
+    success?: string;
+}
+/**
+ * Defines the basic structure for font theming.
+ */
+export interface ThemeFonts {
+    primary?: string;
+    secondary?: string;
+}
+/**
+ * Defines the basic structure for spacing and layout theming.
+ */
+export interface ThemeSpacing {
+    small?: string | number;
+    medium?: string | number;
+    large?: string | number;
+}
+/**
+ * Defines the basic structure for border radius theming.
+ */
+export interface ThemeBorderRadius {
+    small?: string | number;
+    medium?: string | number;
+    large?: string | number;
+}
+/**
+ * Allows for overriding styles of specific UI components.
+ * Properties can be CSS-in-JS objects or class names, depending on implementation.
+ */
+export interface ThemeComponentStyles {
+    button?: Record<string, any> | string;
+    input?: Record<string, any> | string;
+    card?: Record<string, any> | string;
+    label?: Record<string, any> | string;
+}
+/**
+ * Defines the overall appearance/theme configuration.
+ * This allows for broad customization of the UI components.
+ */
+export interface Appearance {
+    colors?: ThemeColors;
+    fonts?: ThemeFonts;
+    spacing?: ThemeSpacing;
+    borderRadius?: ThemeBorderRadius;
+    componentStyles?: ThemeComponentStyles;
+    variables?: Record<string, string | number>;
+}
+/**
+ * Base UI configuration shared between SignIn and SignUp
+ */
+export interface BaseAuthUIConfig {
+    /** Visual appearance configuration */
+    appearance?: Appearance;
+    /** Application logo URL or SVG string */
+    logo?: string;
+    /** Application name for display */
+    appName?: string;
+    /** Render mode for cross-platform support */
+    renderMode?: 'modal' | 'page' | 'embedded';
+    /** Layout direction */
+    layout?: 'vertical' | 'horizontal';
+    /** Custom loading message */
+    loadingMessage?: string;
+    /** Loading spinner variant */
+    loadingSpinnerVariant?: 'circular' | 'linear' | 'dots';
+    /** Accessibility configuration */
+    a11y?: {
+        /** ARIA labels and descriptions */
+        labels?: Record<string, string>;
+        /** Element to receive initial focus */
+        initialFocus?: string;
+        /** Whether to trap focus within the auth UI */
+        trapFocus?: boolean;
+    };
+}
+/**
+ * Sign-in specific UI configuration
+ */
+export interface SignInUIConfig extends BaseAuthUIConfig {
+    /** Social sign-in buttons configuration */
+    socialButtons?: {
+        google?: boolean;
+        microsoft?: boolean;
+        github?: boolean;
+        facebook?: boolean;
+        twitter?: boolean;
+        apple?: boolean;
+        linkedin?: boolean;
+        layout?: 'vertical' | 'horizontal';
+        size?: 'small' | 'medium' | 'large';
+    };
+    /** "Remember me" checkbox configuration */
+    rememberMe?: {
+        enabled?: boolean;
+        defaultChecked?: boolean;
+    };
+    /** Sign-up link configuration */
+    signUpLink?: {
+        enabled?: boolean;
+        text?: string;
+        href?: string;
+    };
+}
+/**
+ * Sign-up specific UI configuration
+ */
+export interface SignUpUIConfig extends BaseAuthUIConfig {
+    /** Password requirements display configuration */
+    passwordRequirements?: {
+        show?: boolean;
+        rules?: Array<{
+            rule: string;
+            description: string;
+        }>;
+    };
+    /** Terms and conditions configuration */
+    terms?: {
+        enabled?: boolean;
+        text?: string;
+        link?: string;
+    };
+}
+//# sourceMappingURL=theme.d.ts.map

package/dist/theme.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"theme.d.ts","sourceRoot":"","sources":["../src/theme.ts"],"names":[],"mappings":"AAAA;;GAEG;AACH,MAAM,WAAW,WAAW;IAC1B,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,OAAO,CAAC,EAAE,MAAM,CAAC;CAClB;AAED;;GAEG;AACH,MAAM,WAAW,UAAU;IACzB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,SAAS,CAAC,EAAE,MAAM,CAAC;CACpB;AAED;;GAEG;AACH,MAAM,WAAW,YAAY;IAC3B,KAAK,CAAC,EAAE,MAAM,GAAG,MAAM,CAAC;IACxB,MAAM,CAAC,EAAE,MAAM,GAAG,MAAM,CAAC;IACzB,KAAK,CAAC,EAAE,MAAM,GAAG,MAAM,CAAC;CACzB;AAED;;GAEG;AACH,MAAM,WAAW,iBAAiB;IAChC,KAAK,CAAC,EAAE,MAAM,GAAG,MAAM,CAAC;IACxB,MAAM,CAAC,EAAE,MAAM,GAAG,MAAM,CAAC;IACzB,KAAK,CAAC,EAAE,MAAM,GAAG,MAAM,CAAC;CACzB;AAED;;;GAGG;AACH,MAAM,WAAW,oBAAoB;IACnC,MAAM,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,GAAG,MAAM,CAAC;IACtC,KAAK,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,GAAG,MAAM,CAAC;IACrC,IAAI,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,GAAG,MAAM,CAAC;IACpC,KAAK,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,GAAG,MAAM,CAAC;CACtC;AAED;;;GAGG;AACH,MAAM,WAAW,UAAU;IACzB,MAAM,CAAC,EAAE,WAAW,CAAC;IACrB,KAAK,CAAC,EAAE,UAAU,CAAC;IACnB,OAAO,CAAC,EAAE,YAAY,CAAC;IACvB,YAAY,CAAC,EAAE,iBAAiB,CAAC;IACjC,eAAe,CAAC,EAAE,oBAAoB,CAAC;IACvC,SAAS,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM,CAAC,CAAC;CAC7C;AAID;;GAEG;AACH,MAAM,WAAW,gBAAgB;IAC/B,sCAAsC;IACtC,UAAU,CAAC,EAAE,UAAU,CAAC;IACxB,yCAAyC;IACzC,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,mCAAmC;IACnC,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,6CAA6C;IAC7C,UAAU,CAAC,EAAE,OAAO,GAAG,MAAM,GAAG,UAAU,CAAC;IAC3C,uBAAuB;IACvB,MAAM,CAAC,EAAE,UAAU,GAAG,YAAY,CAAC;IACnC,6BAA6B;IAC7B,cAAc,CAAC,EAAE,MAAM,CAAC;IACxB,8BAA8B;IAC9B,qBAAqB,CAAC,EAAE,UAAU,GAAG,QAAQ,GAAG,MAAM,CAAC;IACvD,kCAAkC;IAClC,IAAI,CAAC,EAAE;QACL,mCAAmC;QACnC,MAAM,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;QAChC,uCAAuC;QACvC,YAAY,CAAC,EAAE,MAAM,CAAC;QACtB,+CAA+C;QAC/C,SAAS,CAAC,EAAE,OAAO,CAAC;KACrB,CAAC;CACH;AAED;;GAEG;AACH,MAAM,WAAW,cAAe,SAAQ,gBAAgB;IACtD,2CAA2C;IAC3C,aAAa,CAAC,EAAE;QACd,MAAM,CAAC,EAAE,OAAO,CAAC;QACjB,SAAS,CAAC,EAAE,OAAO,CAAC;QACpB,MAAM,CAAC,EAAE,OAAO,CAAC;QACjB,QAAQ,CAAC,EAAE,OAAO,CAAC;QACnB,OAAO,CAAC,EAAE,OAAO,CAAC;QAClB,KAAK,CAAC,EAAE,OAAO,CAAC;QAChB,QAAQ,CAAC,EAAE,OAAO,CAAC;QACnB,MAAM,CAAC,EAAE,UAAU,GAAG,YAAY,CAAC;QACnC,IAAI,CAAC,EAAE,OAAO,GAAG,QAAQ,GAAG,OAAO,CAAC;KACrC,CAAC;IACF,2CAA2C;IAC3C,UAAU,CAAC,EAAE;QACX,OAAO,CAAC,EAAE,OAAO,CAAC;QAClB,cAAc,CAAC,EAAE,OAAO,CAAC;KAC1B,CAAC;IACF,iCAAiC;IACjC,UAAU,CAAC,EAAE;QACX,OAAO,CAAC,EAAE,OAAO,CAAC;QAClB,IAAI,CAAC,EAAE,MAAM,CAAC;QACd,IAAI,CAAC,EAAE,MAAM,CAAC;KACf,CAAC;CACH;AAED;;GAEG;AACH,MAAM,WAAW,cAAe,SAAQ,gBAAgB;IACtD,kDAAkD;IAClD,oBAAoB,CAAC,EAAE;QACrB,IAAI,CAAC,EAAE,OAAO,CAAC;QACf,KAAK,CAAC,EAAE,KAAK,CAAC;YACZ,IAAI,EAAE,MAAM,CAAC;YACb,WAAW,EAAE,MAAM,CAAC;SACrB,CAAC,CAAC;KACJ,CAAC;IACF,yCAAyC;IACzC,KAAK,CAAC,EAAE;QACN,OAAO,CAAC,EAAE,OAAO,CAAC;QAClB,IAAI,CAAC,EAAE,MAAM,CAAC;QACd,IAAI,CAAC,EAAE,MAAM,CAAC;KACf,CAAC;CACH"}

package/package.json

@@ -0,0 +1,28 @@
+{
+  "name": "@tern-secure/types",
+  "version": "1.0.0",
+  "description": "Type definitions for TernSecure packages",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/TernSecure/typescript.git",
+    "directory": "packages/types"
+  },
+  "main": "dist/index.js",
+  "module": "dist/esm/index.js",
+  "types": "dist/index.d.ts",
+  "files": [
+    "dist"
+  ],
+  "engines": {
+    "node": ">=20"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "scripts": {
+    "clean": "rimraf dist",
+    "build": "pnpm clean && tsup && tsc -p tsconfig.add.json",
+    "dev": "tsup --watch",
+    "lint": "eslint src"
+  }
+}