@supertokens-plugins/rownd-nodejs 0.2.0 → 0.3.0-beta.0

package/dist/index.d.ts

@@ -0,0 +1,826 @@
+import * as SuperTokens from 'supertokens-node';
+import { JSONObject, SuperTokensPlugin } from 'supertokens-node/types';
+
+type RowndSignInMethod = {
+    /**
+     * Enables email passwordless sign-in.
+     * @default Disabled when omitted.
+     */
+    method: "email";
+} | {
+    /**
+     * Enables phone passwordless sign-in.
+     * @default Disabled when omitted.
+     */
+    method: "phone";
+} | {
+    /**
+     * Enables Sign in with Apple.
+     * @default Disabled when omitted.
+     */
+    method: "apple";
+    /**
+     * Apple Services ID used by the hub Apple sign-in script.
+     * @default ""
+     */
+    clientId?: string;
+} | {
+    /**
+     * Enables Sign in with Google.
+     * @default Disabled when omitted.
+     */
+    method: "google";
+    /**
+     * Google web client ID used by the hub and Google scripts.
+     * @default ""
+     */
+    clientId?: string;
+    /**
+     * Google iOS client ID used by mobile-app flows.
+     * @default ""
+     */
+    iosClientId?: string;
+    /**
+     * Extra OAuth scopes requested by Google sign-in.
+     * @default []
+     */
+    scopes?: string[];
+    /**
+     * Enables Rownd's faster Google sign-in prompt for supported email domains.
+     * @default "enabled"
+     */
+    signInFasterWithGoogle?: "enabled" | "disabled";
+    /**
+     * Google One Tap prompt settings.
+     * @default autoPrompt false and 7000ms delay per platform.
+     */
+    oneTap?: {
+        browser?: {
+            /**
+             * Whether the browser hub should automatically show One Tap.
+             * @default false
+             */
+            autoPrompt?: boolean;
+            /**
+             * Delay before the browser One Tap prompt is shown, in milliseconds.
+             * @default 7000
+             */
+            delay?: number;
+        };
+        mobileApp?: {
+            /**
+             * Whether mobile-app integrations should automatically show One Tap.
+             * @default false
+             */
+            autoPrompt?: boolean;
+            /**
+             * Delay before the mobile-app One Tap prompt is shown, in milliseconds.
+             * @default 7000
+             */
+            delay?: number;
+        };
+    };
+} | {
+    /**
+     * Enables guest/instant-user sign-in.
+     * @default Disabled when omitted.
+     */
+    method: "anonymous";
+    /**
+     * Anonymous sign-in mode. "instant" emits Rownd instant-user config instead of the guest button.
+     * @default "guest"
+     */
+    type?: "guest" | "instant";
+    /**
+     * Button label for anonymous sign-in.
+     * @default "Continue as a guest"
+     */
+    displayName?: string;
+    /**
+     * Light-mode icon URL for the anonymous sign-in button.
+     * @default Built-in icon.
+     */
+    iconLightUrl?: string;
+    /**
+     * Dark-mode icon URL for the anonymous sign-in button.
+     * @default iconLightUrl or the built-in icon.
+     */
+    iconDarkUrl?: string;
+} | {
+    /**
+     * Enables a custom OAuth2 provider under this method key.
+     * @default Disabled when omitted.
+     */
+    method: string;
+    /**
+     * Provider display name in the sign-in button.
+     * @default method
+     */
+    displayName?: string;
+    /**
+     * Light-mode provider icon URL for the sign-in button.
+     * @default No custom icon.
+     */
+    iconLightUrl?: string;
+    /**
+     * Dark-mode provider icon URL for the sign-in button.
+     * @default iconLightUrl or no custom icon.
+     */
+    iconDarkUrl?: string;
+    /** Additional provider-specific config retained for future Rownd-compatible options. */
+    [key: string]: unknown;
+};
+type RowndBranding = {
+    /**
+     * Primary hub color in light mode.
+     * @default "#5b5bd6"
+     */
+    primaryColor?: string;
+    /**
+     * Primary hub color in dark mode.
+     * @default "#c8aaff"
+     */
+    primaryColorDarkMode?: string;
+    /**
+     * Light-mode logo URL.
+     * @default appConfig.icon
+     */
+    logo?: string;
+    /**
+     * Dark-mode logo URL.
+     * @default logo, then appConfig.icon
+     */
+    logoDarkMode?: string;
+    /**
+     * Raw Rownd animation asset/config overrides.
+     * @default undefined
+     */
+    animations?: JSONObject;
+    /**
+     * Whether hub controls use rounded corners.
+     * @default true
+     */
+    roundedCorners?: boolean;
+    /**
+     * Radius in pixels applied to hub containers and controls. Hub caps it at 30px.
+     * @default undefined
+     */
+    containerBorderRadius?: number;
+    /**
+     * Floating launcher placement, such as "bottom-left" or "hidden".
+     * @default "bottom-left"
+     */
+    placement?: string;
+    /**
+     * Hub-specific primary color override.
+     * @default primaryColor
+     */
+    hubPrimaryColor?: string;
+    /**
+     * Hub background color override.
+     * @default undefined
+     */
+    backgroundColor?: string;
+    /**
+     * Hub font family override.
+     * @default undefined
+     */
+    fontFamily?: string;
+    /**
+     * Hides Rownd verification icons in hub UI.
+     * @default false
+     */
+    hideVerificationIcons?: boolean;
+    /**
+     * Whether decorative swoops are shown on sign-in and wallet screens.
+     * @default true
+     */
+    visualSwoops?: boolean;
+    /**
+     * Whether modal background blur is enabled.
+     * @default true
+     */
+    blurBackground?: boolean;
+    /**
+     * Opacity applied to the modal background blur.
+     * @default undefined
+     */
+    blurBackgroundOpacity?: number;
+    /**
+     * Horizontal launcher offset in pixels.
+     * @default undefined
+     */
+    offsetX?: number;
+    /**
+     * Vertical launcher offset in pixels.
+     * @default undefined
+     */
+    offsetY?: number;
+    /**
+     * Raw CSS variable/property overrides consumed by Rownd hub.
+     * @default undefined
+     */
+    propertyOverrides?: JSONObject;
+    /**
+     * Hub color mode.
+     * @default "auto"
+     */
+    darkMode?: "auto" | "light" | "dark";
+    /**
+     * Whether the app icon/logo appears inside sign-in and profile modals.
+     * @default false
+     */
+    showAppIcon?: boolean;
+    /**
+     * Raw CSS snippets injected into the hub document.
+     * @default []
+     */
+    customStyles?: {
+        /** CSS text injected into a style tag. */
+        content: string;
+    }[];
+    /**
+     * Raw script snippets injected into the hub document.
+     * @default []
+     */
+    customScripts?: {
+        /** Script MIME type. */
+        type?: string;
+        /** Script text injected into a script tag. */
+        content: string;
+    }[];
+};
+type RowndLegal = {
+    /**
+     * Company name shown in legal copy.
+     * @default appConfig.name
+     */
+    companyName?: string;
+    /**
+     * Privacy policy link shown in legal/footer components.
+     * @default ""
+     */
+    privacyPolicyUrl?: string;
+    /**
+     * Terms and conditions link shown in legal/footer components.
+     * @default ""
+     */
+    termsConditionsUrl?: string;
+    /**
+     * Support address used in error and profile support links.
+     * @default Rownd support email.
+     */
+    supportEmail?: string;
+};
+type RowndAuthConfig = {
+    /**
+     * Whether the hub should preselect the user's previous sign-in method.
+     * @default true
+     */
+    rememberSignInMethod?: boolean;
+    /**
+     * Enables separate sign-in/sign-up intent flows.
+     * @default false
+     */
+    useExplicitSignUpFlow?: boolean;
+    /**
+     * Allows new users to authenticate before completing verification.
+     * @default false
+     */
+    allowUnverifiedUsers?: boolean;
+    /**
+     * Verification email customization.
+     * @default Rownd/SuperTokens email defaults.
+     */
+    email?: {
+        fromAddress?: string;
+        image?: string;
+        subject?: string;
+        callToActionText?: string;
+        verifyTemplate?: string;
+        customContent?: string;
+        customClosingContent?: string;
+    };
+    /**
+     * Mobile app install/interstitial customization for magic links.
+     * @default Rownd hub built-in mobile copy.
+     */
+    mobile?: {
+        title?: string;
+        image?: string;
+        callToActionText?: string;
+        hyperlinkText?: string;
+        hyperlinkRedirectUrl?: string;
+        customContent?: string;
+    };
+    /**
+     * Method to use first for explicit sign-up.
+     * @default The only visible ordered method, when there is exactly one.
+     */
+    primarySignUpMethod?: string;
+    /**
+     * Preferred identifier input when no auth order is provided.
+     * @default First ordered input, then "email".
+     */
+    preferredMethod?: string;
+    /**
+     * Per-platform sign-in button/input ordering.
+     * @default Rownd hub's built-in method order.
+     */
+    order?: {
+        /**
+         * Browser/default ordering. Each entry names an auth method and whether it renders as a button or input.
+         * @default undefined
+         */
+        default?: {
+            /** Whether the method renders as a button or identifier input. */
+            type: "button" | "input";
+            /** Sign-in method key, for example email, phone, google, apple, anonymous, or a custom provider key. */
+            name: string;
+            /**
+             * Hides the method from the initial sign-up view; sign-in flows can still show it.
+             * @default false
+             */
+            hidden?: boolean;
+        }[];
+        /**
+         * iOS webview ordering.
+         * @default default
+         */
+        ios?: {
+            /** Whether the method renders as a button or identifier input. */
+            type: "button" | "input";
+            /** Sign-in method key, for example email, phone, google, apple, anonymous, or a custom provider key. */
+            name: string;
+            /**
+             * Hides the method from the initial sign-up view; sign-in flows can still show it.
+             * @default false
+             */
+            hidden?: boolean;
+        }[];
+        /**
+         * Android webview ordering.
+         * @default default
+         */
+        android?: {
+            /** Whether the method renders as a button or identifier input. */
+            type: "button" | "input";
+            /** Sign-in method key, for example email, phone, google, apple, anonymous, or a custom provider key. */
+            name: string;
+            /**
+             * Hides the method from the initial sign-up view; sign-in flows can still show it.
+             * @default false
+             */
+            hidden?: boolean;
+        }[];
+    };
+    /**
+     * Extra fields collected during sign-in/sign-up.
+     * @default []
+     */
+    additionalFields?: {
+        /** User data key posted with the collected value. */
+        name: string;
+        /** Input renderer type, for example input, text, tel, email, or select. */
+        type: string;
+        /** Label shown next to the field. */
+        label: string;
+        /**
+         * Placeholder shown for text-like inputs.
+         * @default undefined
+         */
+        placeholder?: string;
+        /**
+         * Select/radio choices. For option-based fields, the first option is the default when no value is provided.
+         * @default First option value.
+         */
+        options: {
+            /** Submitted value for this option. */
+            value: string;
+            /** Label shown to the user for this option. */
+            label: string;
+        }[];
+    }[];
+};
+type RowndProfileConfig = {
+    /**
+     * Controls which account identifiers/sign-in methods are shown in the profile account section.
+     * @default All visible user-facing account fields.
+     */
+    accountInformation?: {
+        /**
+         * Per-method visibility.
+         * @default Each method enabled when omitted.
+         */
+        methods?: Record<string, {
+            /**
+             * Whether the method/account identifier is visible.
+             * @default true
+             */
+            enabled?: boolean;
+        }>;
+    };
+    /**
+     * Shows the personal information profile section.
+     * @default true
+     */
+    personalInformation?: {
+        /**
+         * Whether the section is visible.
+         * @default true
+         */
+        enabled?: boolean;
+    };
+    /**
+     * Shows the preferences/support profile section.
+     * @default true
+     */
+    preferences?: {
+        /**
+         * Whether the section is visible.
+         * @default true
+         */
+        enabled?: boolean;
+    };
+    /**
+     * Shows the sign-out button in the profile modal.
+     * @default true
+     */
+    signOutButton?: {
+        /**
+         * Whether the button is visible.
+         * @default true
+         */
+        enabled?: boolean;
+    };
+    /**
+     * Shows the delete-account action in preferences.
+     * @default false
+     */
+    deleteAccountButton?: {
+        /**
+         * Whether the delete-account action is visible.
+         * @default false
+         */
+        enabled?: boolean;
+    };
+    /**
+     * Shows the add sign-in methods action in the profile modal.
+     * @default true
+     */
+    addSignInMethodsButton?: {
+        /** Whether the button is visible. */
+        enabled?: boolean;
+    };
+};
+type RowndCustomContent = {
+    /**
+     * Text overrides for the sign-in modal.
+     * @default Rownd hub built-in copy.
+     */
+    signInModal?: {
+        /**
+         * Main modal title. Can be overridden per requestSignIn call.
+         * @default Rownd hub built-in title.
+         */
+        title?: string;
+        /**
+         * Main modal subtitle.
+         * @default Rownd hub built-in subtitle.
+         */
+        subtitle?: string;
+        /**
+         * Title when explicit sign-in intent is active.
+         * @default Rownd hub built-in sign-in title.
+         */
+        signInTitle?: string;
+        /**
+         * Title when explicit sign-up intent is active.
+         * @default Rownd hub built-in sign-up title.
+         */
+        signUpTitle?: string;
+        /**
+         * Subtitle when explicit sign-in intent is active.
+         * @default Rownd hub built-in sign-in subtitle.
+         */
+        signInSubtitle?: string;
+        /**
+         * Subtitle when explicit sign-up intent is active.
+         * @default Rownd hub built-in sign-up subtitle.
+         */
+        signUpSubtitle?: string;
+        /**
+         * Explicit sign-in CTA text.
+         * @default Rownd hub built-in sign-in button text.
+         */
+        signInButton?: string;
+        /**
+         * Explicit sign-up CTA text.
+         * @default Rownd hub built-in sign-up button text.
+         */
+        signUpButton?: string;
+    };
+    /**
+     * Profile modal text overrides.
+     * @default Rownd hub built-in profile copy.
+     */
+    profileModal?: {
+        /**
+         * Profile modal title.
+         * @default "Your profile"
+         */
+        title?: string;
+    };
+    /**
+     * Verification modal text overrides.
+     * @default Rownd hub built-in verification copy.
+     */
+    verificationModal?: {
+        /**
+         * Verification modal title.
+         * @default Rownd hub built-in verification title.
+         */
+        title?: string;
+        /**
+         * Verification modal subtitle.
+         * @default Rownd hub built-in verification subtitle.
+         */
+        subtitle?: string;
+    };
+    /**
+     * Sign-in failure modal text overrides.
+     * @default Rownd hub built-in error copy.
+     */
+    signInFailureModal?: {
+        /**
+         * Message shown when sign-in fails.
+         * @default Rownd hub built-in error copy.
+         */
+        failureMessage?: string;
+    };
+    /**
+     * No-account modal text overrides.
+     * @default Rownd hub built-in copy.
+     */
+    noAccountMessage?: {
+        /** No-account modal title. */
+        title?: string;
+    };
+    /**
+     * Raw mobile custom content config consumed by Rownd hub.
+     * @default undefined
+     */
+    mobile?: JSONObject;
+};
+type RowndAppConfigInput = {
+    /**
+     * Rownd app ID returned by the app-config endpoint.
+     * @default ""
+     */
+    id?: string;
+    /**
+     * App display name used in the hub UI and legal fallback copy.
+     * @default SuperTokens appInfo.appName
+     */
+    name?: string;
+    /**
+     * App icon URL used as the fallback logo/favicon.
+     * @default ""
+     */
+    icon?: string;
+    /**
+     * User profile fields that can verify a user.
+     * @default Rownd hub defaults.
+     */
+    userVerificationFields?: string[];
+    /**
+     * Visual customization for the hub UI.
+     * @default Defaults documented in RowndBranding.
+     */
+    branding?: RowndBranding;
+    /**
+     * Native/web app capability metadata from Rownd.
+     * @default undefined
+     */
+    capabilities?: JSONObject;
+    /**
+     * Browser/web app config from Rownd.
+     * @default undefined
+     */
+    web?: JSONObject;
+    /**
+     * Bottom sheet config from Rownd.
+     * @default undefined
+     */
+    bottomSheet?: JSONObject;
+    /**
+     * Rownd profile storage version metadata.
+     * @default undefined
+     */
+    profileStorageVersion?: string;
+    /**
+     * Allowed web origins metadata from Rownd hub config.
+     * @default undefined
+     */
+    allowedWebOrigins?: string[];
+    /**
+     * Legal links and support contact shown in hub flows.
+     * @default Defaults documented in RowndLegal.
+     */
+    legal?: RowndLegal;
+    /**
+     * Copy overrides for hub modals.
+     * @default Rownd hub built-in copy.
+     */
+    customContent?: RowndCustomContent;
+    /**
+     * Profile modal feature visibility.
+     * @default Defaults documented in RowndProfileConfig.
+     */
+    profile?: RowndProfileConfig;
+    /**
+     * Authentication flow options.
+     * @default Defaults documented in RowndAuthConfig.
+     */
+    auth?: RowndAuthConfig;
+    /**
+     * Enabled sign-in methods.
+     * @default []
+     */
+    signInMethods?: RowndSignInMethod[];
+};
+type RowndSubBrandConfigInput = RowndAppConfigInput & {
+    variant: {
+        id: string;
+        name?: string;
+        config?: JSONObject;
+    };
+};
+interface RowndPluginConfig {
+    rowndAppKey: string;
+    rowndAppSecret: string;
+    enableDebugLogs?: boolean;
+    telemetry?: RowndTelemetryConfig;
+    schema?: RowndSchema;
+    appConfig?: RowndAppConfigInput;
+    subBrands?: Record<string, RowndSubBrandConfigInput>;
+}
+type RowndTelemetryEvent = {
+    outcome: "success";
+    durationMs: number;
+    tenantId?: string;
+    rowndUserId?: string;
+    superTokensUserId?: string;
+} | {
+    outcome: "error";
+    durationMs: number;
+    tenantId?: string;
+    rowndUserId?: string;
+    superTokensUserId?: string;
+    error: {
+        message: string;
+        name?: string;
+    };
+};
+interface RowndTelemetryClient {
+    recordEvent: (event: RowndTelemetryEvent) => Promise<void> | void;
+}
+type RowndTelemetryConfig = {
+    provider: "opentelemetry";
+} | {
+    provider: "axiom";
+    token: string;
+    dataset: string;
+    url?: string;
+} | {
+    provider: "custom";
+    factory: () => RowndTelemetryClient;
+};
+type RowndUser = JSONObject & {
+    state: string;
+    auth_level: string;
+    data: JSONObject & {
+        user_id: string;
+        email?: string;
+        phone_number?: string;
+        google_id?: string;
+        apple_id?: string;
+        first_name?: string;
+        last_name?: string;
+    };
+    attributes?: JSONObject;
+    verified_data: JSONObject & {
+        email?: string | boolean;
+        phone_number?: string | boolean;
+        google_id?: string | boolean;
+        apple_id?: string | boolean;
+    };
+    groups?: JSONObject[];
+    meta?: JSONObject;
+};
+type RowndUserMetadata = {
+    original_rownd_user?: RowndUser;
+    rownd_pending_verification?: Array<{
+        id: string;
+        field: string;
+        value: string;
+        created_at: string;
+    }>;
+    [key: string]: unknown;
+};
+interface MigrationResponse {
+    status: "OK" | "ERROR";
+    message?: string;
+}
+interface RowndPluginNormalisedConfig {
+    rowndAppKey: string;
+    rowndAppSecret: string;
+    enableDebugLogs?: boolean;
+    telemetry?: RowndTelemetryConfig;
+    schema?: RowndSchema;
+    appConfig?: RowndAppConfigInput;
+    subBrands?: Record<string, RowndSubBrandConfigInput>;
+}
+interface SuperTokensUserImport {
+    externalUserId?: string;
+    timeJoined?: number;
+    userMetadata: JSONObject;
+    loginMethods: ({
+        recipeId: "emailpassword";
+        email: string;
+        passwordHash: string;
+        isVerified: boolean;
+        tenantIds?: string[];
+    } | {
+        recipeId: "thirdparty";
+        thirdPartyId: string;
+        thirdPartyUserId: string;
+        email: string;
+        isVerified: boolean;
+        tenantIds?: string[];
+    } | {
+        recipeId: "passwordless";
+        email?: string;
+        phoneNumber?: string;
+        isVerified: boolean;
+        tenantIds?: string[];
+    })[];
+}
+interface IRowndClient {
+    validateToken: (token: string) => Promise<{
+        user_id: string;
+    }>;
+    fetchUserInfo: (opts: {
+        user_id: string;
+        app_id?: string;
+    }) => Promise<RowndUser | undefined>;
+}
+type RowndSchemaField = {
+    display_name: string;
+    type: string;
+    user_visible: boolean;
+    owned_by?: string;
+    read_only?: boolean;
+    show_empty?: boolean;
+    include_in_session_claims?: boolean;
+    session_claim_name?: string;
+};
+type RowndSchema = Record<string, RowndSchemaField>;
+
+declare const init: (config: RowndPluginConfig) => SuperTokensPlugin;
+
+declare const PLUGIN_ID = "supertokens-plugin-rownd";
+declare const PLUGIN_SDK_VERSION: string[];
+declare const HANDLE_BASE_PATH = "/plugin/rownd";
+declare const PUBLIC_TENANT_ID = "public";
+declare const GUEST_AUTH_METHOD_ID = "guest";
+declare const ANONYMOUS_AUTH_METHOD_ID = "anonymous";
+declare const ROWND_JWT_CLAIMS: {
+    readonly AppUserId: "https://auth.rownd.io/app_user_id";
+    readonly IsVerifiedUser: "https://auth.rownd.io/is_verified_user";
+    readonly IsAnonymous: "https://auth.rownd.io/is_anonymous";
+    readonly IssuedOffline: "https://auth.rownd.io/issued_offline";
+    readonly JwtType: "https://auth.rownd.io/jwt_type";
+    readonly PlatformJwt: "https://auth.rownd.io/platform_jwt";
+    readonly AuthLevel: "https://auth.rownd.io/auth_level";
+};
+declare const DEFAULT_ROWND_SCHEMA: RowndSchema;
+
+declare const ROWND_PLUGIN_ERROR_MESSAGES: {
+    readonly MISSING_AUTHORIZATION_HEADER: "Missing authorization header";
+    readonly INVALID_TOKEN: "Invalid token";
+    readonly ROWND_USER_NOT_FOUND: "User not found in Rownd";
+};
+type RowndPluginErrorType = keyof typeof ROWND_PLUGIN_ERROR_MESSAGES;
+declare class RowndPluginError extends Error {
+    constructor(type: RowndPluginErrorType);
+}
+
+declare function setRowndClient(client: IRowndClient): void;
+declare function getRowndClient(): IRowndClient;
+
+declare const _default: {
+    init: (config: RowndPluginConfig) => SuperTokens.SuperTokensPlugin;
+};
+
+export { ANONYMOUS_AUTH_METHOD_ID, DEFAULT_ROWND_SCHEMA, GUEST_AUTH_METHOD_ID, HANDLE_BASE_PATH, type IRowndClient, type MigrationResponse, PLUGIN_ID, PLUGIN_SDK_VERSION, PUBLIC_TENANT_ID, ROWND_JWT_CLAIMS, ROWND_PLUGIN_ERROR_MESSAGES, type RowndAppConfigInput, type RowndAuthConfig, type RowndBranding, type RowndCustomContent, type RowndLegal, type RowndPluginConfig, RowndPluginError, type RowndPluginErrorType, type RowndPluginNormalisedConfig, type RowndProfileConfig, type RowndSchema, type RowndSchemaField, type RowndSignInMethod, type RowndSubBrandConfigInput, type RowndTelemetryClient, type RowndTelemetryConfig, type RowndTelemetryEvent, type RowndUser, type RowndUserMetadata, type SuperTokensUserImport, _default as default, getRowndClient, init, setRowndClient };