@simplr-ai/web-components 1.0.0

package/dist/index.d.cts

@@ -0,0 +1,211 @@
+import { SimplrFraudConfig, SimplrFlagsConfig, SimplrProfilesConfig, SimplrRUMConfig, AIDelegationConfig, SimplrFraud, SimplrFlags, SimplrProfiles, simplrRUM, SimplrAI, CollectedSignals, DeviceSignals, BehaviorSignals, EvalContext } from '@simplr-ai/js';
+export { AIDelegationConfig, BehaviorSignals, BindingMode, CollectedSignals, CreateDelegationOptions, DelegationInfo, DelegationResult, DelegationStats, DeviceSignals, EvalContext, FlagDefinition, FlagRule, IdentifyOptions, KeystrokeMetrics, MouseMetrics, ProfileIdentifyResult, ProfileOrderFraudResult, ProfileOrderInput, ProfileRiskResult, RUMActionType, RUMEvent, RUMEventType, RUMLogLevel, SimplrAI, SimplrFlags, SimplrFlagsConfig, SimplrFraud, SimplrFraudConfig, SimplrProfiles, SimplrProfilesConfig, SimplrRUM, SimplrRUMConfig, TouchMetrics, ValidationResult, clearDeviceId, createFingerprintHash, createSimplrAI, createSimplrProfiles, getDeviceId, murmurHash3, sha256, simplrFlags, simplrRUM } from '@simplr-ai/js';
+
+/**
+ * SimplrElements — the shared imperative controller / singleton.
+ *
+ * Builds and holds the configured `@simplr-ai/js` core instances
+ * (SimplrFraud + SimplrFlags + SimplrProfiles + SimplrRUM + SimplrAI) so that
+ * every custom element AND non-HTML consumers share ONE configured client.
+ *
+ * This is a THIN adapter — it never reimplements features. `check()` and
+ * `submitOrder()` POST to the documented public-key endpoints (`/v1/check`,
+ * `/v1/orders`) exactly as specified in the Simplr API contract, attaching the
+ * device + behavior signals collected by the core fraud client.
+ */
+
+/** POST /v1/check input (public-key client ingestion). */
+interface CheckInput {
+    email?: string;
+    phone?: string;
+    device?: Record<string, unknown>;
+    behavior?: Record<string, unknown>;
+    event_type?: string;
+    event_id?: string;
+    metadata?: Record<string, unknown>;
+    [key: string]: unknown;
+}
+type RiskLevel = "low" | "medium" | "high" | "critical";
+/** POST /v1/check result. */
+interface CheckResult {
+    type?: string;
+    risk_score: number;
+    risk_level: RiskLevel;
+    signals?: Record<string, unknown>;
+    email?: string;
+    phone_number?: string;
+    fingerprint_hash?: string;
+    checked_at?: string;
+    is_sandbox?: boolean;
+    [key: string]: unknown;
+}
+/** Configuration accepted by {@link SimplrController.configure}. */
+interface SimplrConfig {
+    /** Public API key (`pk_*`) — safe for the client. */
+    apiKey: string;
+    /** API base URL override (default `https://api.simplr.sh`). */
+    baseUrl?: string;
+    /** Whether to auto-start biometric tracking on configure (default true). */
+    autoStart?: boolean;
+    /** Whether to collect behavioral biometrics (default true). */
+    collectBiometrics?: boolean;
+    /** Core fraud / device-signal config overrides. */
+    fraud?: SimplrFraudConfig;
+    /** Feature-flags config. `true` = enable with defaults, object = customise, omit/false = skip. */
+    flags?: Partial<SimplrFlagsConfig> | boolean;
+    /** Profiles config. `true` = enable with the shared key/baseUrl, object = customise. */
+    profiles?: Partial<SimplrProfilesConfig> | boolean;
+    /** RUM config — requires at least `applicationId`. Omit to skip RUM. */
+    rum?: SimplrRUMConfig;
+    /** AI delegation config. `true` = enable with the shared key, object = customise. */
+    ai?: Partial<AIDelegationConfig> | boolean;
+}
+/**
+ * The Simplr controller. A single shared instance ({@link SimplrElements}) is
+ * exported; call `.configure()` once and every element + helper reads from it.
+ */
+declare class SimplrController {
+    private _config;
+    private _baseUrl;
+    /** Core device-fingerprint + behavioral-biometrics client. */
+    fraud: SimplrFraud | null;
+    /** Feature flags (local eval + murmurhash bucketing). */
+    flags: SimplrFlags | null;
+    /** Anonymous profiles + order fraud monitoring. */
+    profiles: SimplrProfiles | null;
+    /** Real User Monitoring (shared core singleton). */
+    rum: typeof simplrRUM | null;
+    /** AI delegation (OAuth-like). */
+    ai: SimplrAI | null;
+    private readyResolvers;
+    private _ready;
+    /** True once {@link configure} has built the core clients. */
+    get isConfigured(): boolean;
+    /** The resolved public API key, or undefined if not configured. */
+    get apiKey(): string | undefined;
+    /** The resolved API base URL. */
+    get baseUrl(): string;
+    /**
+     * Configure the shared client. Idempotent: if already configured with the
+     * same key it is a no-op, so multiple `<simplr-provider>` mounts are safe.
+     */
+    configure(config: SimplrConfig): SimplrController;
+    /** Resolves once the controller has been configured. */
+    ready(): Promise<void>;
+    private requireFraud;
+    /** Collect device fingerprint + behavioral biometrics together. */
+    collect(): Promise<CollectedSignals>;
+    /** Collect device fingerprint signals only. */
+    getDeviceSignals(): Promise<DeviceSignals>;
+    /** Collect behavioral biometric signals only (sync). */
+    getBehaviorSignals(): BehaviorSignals;
+    /** Input tracking handlers/attrs for a named field (keystroke biometrics). */
+    trackInput(fieldName: string): {
+        onKeyDown: (e: KeyboardEvent) => void;
+        onKeyUp: (e: KeyboardEvent) => void;
+        onPaste: () => void;
+        "data-simplr-field": string;
+    };
+    /** Reset collected behavioral data. */
+    reset(): void;
+    /**
+     * Run a fraud/identity check (POST `/v1/check`). Device + behavior signals
+     * are auto-collected and merged into the request unless already on `input`.
+     */
+    check(input?: CheckInput): Promise<CheckResult>;
+    private request;
+    /** Evaluate a feature flag locally. Returns false if flags aren't enabled. */
+    isFeatureEnabled(key: string, ctx?: EvalContext): boolean;
+    /** Tear down timers / trackers (useful for tests + SPA teardown). */
+    dispose(): void;
+}
+/** The shared controller singleton every element + helper reads from. */
+declare const SimplrElements: SimplrController;
+/**
+ * Imperative feature-flag helper mirroring the core local-eval contract.
+ * Reads from the shared controller.
+ */
+declare function isFeatureEnabled(key: string, ctx?: EvalContext): boolean;
+
+/** Map of tag name → element constructor for every Simplr custom element. */
+declare const SIMPLR_ELEMENTS: Record<string, CustomElementConstructor>;
+/**
+ * Register all Simplr custom elements with the browser's CustomElementRegistry.
+ * No-op (and safe) when there is no `customElements` (e.g. SSR / Node). Already
+ * registered tags are skipped, so calling this twice is harmless.
+ */
+declare function defineSimplrElements(): void;
+
+declare global {
+    interface Window {
+        SIMPLR_CONFIG?: {
+            apiKey?: string;
+            publicKey?: string;
+            baseUrl?: string;
+            autoStart?: boolean;
+            appId?: string;
+        };
+    }
+}
+declare class SimplrProviderElement extends HTMLElement {
+    static get observedAttributes(): string[];
+    connectedCallback(): void;
+    attributeChangedCallback(): void;
+    private tryConfigure;
+}
+
+declare class SimplrProtectedFormElement extends HTMLElement {
+    private form;
+    private onSubmit;
+    connectedCallback(): void;
+    disconnectedCallback(): void;
+    /** Field name used for the hidden signals input. */
+    get fieldName(): string;
+    private handleSubmit;
+}
+
+declare class SimplrProtectedInputElement extends HTMLElement {
+    static get observedAttributes(): string[];
+    private input;
+    private handlers;
+    private bound;
+    get field(): string;
+    connectedCallback(): void;
+    disconnectedCallback(): void;
+    attributeChangedCallback(): void;
+    private attach;
+    private detach;
+}
+
+declare class SimplrFeatureFlagElement extends HTMLElement {
+    static get observedAttributes(): string[];
+    private onConfigured;
+    private poll;
+    connectedCallback(): void;
+    disconnectedCallback(): void;
+    attributeChangedCallback(): void;
+    /** The flag key. */
+    get key(): string;
+    /** Whether this flag currently evaluates to enabled. */
+    get enabled(): boolean;
+    private evaluate;
+}
+
+declare class SimplrRumViewElement extends HTMLElement {
+    static get observedAttributes(): string[];
+    get viewName(): string;
+    connectedCallback(): void;
+    attributeChangedCallback(_n: string, oldV: string | null, newV: string | null): void;
+    private track;
+}
+
+declare class SimplrAiDelegationElement extends HTMLElement {
+    private trigger;
+    private onClick;
+    connectedCallback(): void;
+    disconnectedCallback(): void;
+    get userId(): string;
+    private run;
+}
+
+export { type CheckInput, type CheckResult, type RiskLevel, SIMPLR_ELEMENTS, SimplrAiDelegationElement, type SimplrConfig, SimplrController, SimplrElements, SimplrFeatureFlagElement, SimplrProtectedFormElement, SimplrProtectedInputElement, SimplrProviderElement, SimplrRumViewElement, defineSimplrElements, isFeatureEnabled };

package/dist/index.d.ts

@@ -0,0 +1,211 @@
+import { SimplrFraudConfig, SimplrFlagsConfig, SimplrProfilesConfig, SimplrRUMConfig, AIDelegationConfig, SimplrFraud, SimplrFlags, SimplrProfiles, simplrRUM, SimplrAI, CollectedSignals, DeviceSignals, BehaviorSignals, EvalContext } from '@simplr-ai/js';
+export { AIDelegationConfig, BehaviorSignals, BindingMode, CollectedSignals, CreateDelegationOptions, DelegationInfo, DelegationResult, DelegationStats, DeviceSignals, EvalContext, FlagDefinition, FlagRule, IdentifyOptions, KeystrokeMetrics, MouseMetrics, ProfileIdentifyResult, ProfileOrderFraudResult, ProfileOrderInput, ProfileRiskResult, RUMActionType, RUMEvent, RUMEventType, RUMLogLevel, SimplrAI, SimplrFlags, SimplrFlagsConfig, SimplrFraud, SimplrFraudConfig, SimplrProfiles, SimplrProfilesConfig, SimplrRUM, SimplrRUMConfig, TouchMetrics, ValidationResult, clearDeviceId, createFingerprintHash, createSimplrAI, createSimplrProfiles, getDeviceId, murmurHash3, sha256, simplrFlags, simplrRUM } from '@simplr-ai/js';
+
+/**
+ * SimplrElements — the shared imperative controller / singleton.
+ *
+ * Builds and holds the configured `@simplr-ai/js` core instances
+ * (SimplrFraud + SimplrFlags + SimplrProfiles + SimplrRUM + SimplrAI) so that
+ * every custom element AND non-HTML consumers share ONE configured client.
+ *
+ * This is a THIN adapter — it never reimplements features. `check()` and
+ * `submitOrder()` POST to the documented public-key endpoints (`/v1/check`,
+ * `/v1/orders`) exactly as specified in the Simplr API contract, attaching the
+ * device + behavior signals collected by the core fraud client.
+ */
+
+/** POST /v1/check input (public-key client ingestion). */
+interface CheckInput {
+    email?: string;
+    phone?: string;
+    device?: Record<string, unknown>;
+    behavior?: Record<string, unknown>;
+    event_type?: string;
+    event_id?: string;
+    metadata?: Record<string, unknown>;
+    [key: string]: unknown;
+}
+type RiskLevel = "low" | "medium" | "high" | "critical";
+/** POST /v1/check result. */
+interface CheckResult {
+    type?: string;
+    risk_score: number;
+    risk_level: RiskLevel;
+    signals?: Record<string, unknown>;
+    email?: string;
+    phone_number?: string;
+    fingerprint_hash?: string;
+    checked_at?: string;
+    is_sandbox?: boolean;
+    [key: string]: unknown;
+}
+/** Configuration accepted by {@link SimplrController.configure}. */
+interface SimplrConfig {
+    /** Public API key (`pk_*`) — safe for the client. */
+    apiKey: string;
+    /** API base URL override (default `https://api.simplr.sh`). */
+    baseUrl?: string;
+    /** Whether to auto-start biometric tracking on configure (default true). */
+    autoStart?: boolean;
+    /** Whether to collect behavioral biometrics (default true). */
+    collectBiometrics?: boolean;
+    /** Core fraud / device-signal config overrides. */
+    fraud?: SimplrFraudConfig;
+    /** Feature-flags config. `true` = enable with defaults, object = customise, omit/false = skip. */
+    flags?: Partial<SimplrFlagsConfig> | boolean;
+    /** Profiles config. `true` = enable with the shared key/baseUrl, object = customise. */
+    profiles?: Partial<SimplrProfilesConfig> | boolean;
+    /** RUM config — requires at least `applicationId`. Omit to skip RUM. */
+    rum?: SimplrRUMConfig;
+    /** AI delegation config. `true` = enable with the shared key, object = customise. */
+    ai?: Partial<AIDelegationConfig> | boolean;
+}
+/**
+ * The Simplr controller. A single shared instance ({@link SimplrElements}) is
+ * exported; call `.configure()` once and every element + helper reads from it.
+ */
+declare class SimplrController {
+    private _config;
+    private _baseUrl;
+    /** Core device-fingerprint + behavioral-biometrics client. */
+    fraud: SimplrFraud | null;
+    /** Feature flags (local eval + murmurhash bucketing). */
+    flags: SimplrFlags | null;
+    /** Anonymous profiles + order fraud monitoring. */
+    profiles: SimplrProfiles | null;
+    /** Real User Monitoring (shared core singleton). */
+    rum: typeof simplrRUM | null;
+    /** AI delegation (OAuth-like). */
+    ai: SimplrAI | null;
+    private readyResolvers;
+    private _ready;
+    /** True once {@link configure} has built the core clients. */
+    get isConfigured(): boolean;
+    /** The resolved public API key, or undefined if not configured. */
+    get apiKey(): string | undefined;
+    /** The resolved API base URL. */
+    get baseUrl(): string;
+    /**
+     * Configure the shared client. Idempotent: if already configured with the
+     * same key it is a no-op, so multiple `<simplr-provider>` mounts are safe.
+     */
+    configure(config: SimplrConfig): SimplrController;
+    /** Resolves once the controller has been configured. */
+    ready(): Promise<void>;
+    private requireFraud;
+    /** Collect device fingerprint + behavioral biometrics together. */
+    collect(): Promise<CollectedSignals>;
+    /** Collect device fingerprint signals only. */
+    getDeviceSignals(): Promise<DeviceSignals>;
+    /** Collect behavioral biometric signals only (sync). */
+    getBehaviorSignals(): BehaviorSignals;
+    /** Input tracking handlers/attrs for a named field (keystroke biometrics). */
+    trackInput(fieldName: string): {
+        onKeyDown: (e: KeyboardEvent) => void;
+        onKeyUp: (e: KeyboardEvent) => void;
+        onPaste: () => void;
+        "data-simplr-field": string;
+    };
+    /** Reset collected behavioral data. */
+    reset(): void;
+    /**
+     * Run a fraud/identity check (POST `/v1/check`). Device + behavior signals
+     * are auto-collected and merged into the request unless already on `input`.
+     */
+    check(input?: CheckInput): Promise<CheckResult>;
+    private request;
+    /** Evaluate a feature flag locally. Returns false if flags aren't enabled. */
+    isFeatureEnabled(key: string, ctx?: EvalContext): boolean;
+    /** Tear down timers / trackers (useful for tests + SPA teardown). */
+    dispose(): void;
+}
+/** The shared controller singleton every element + helper reads from. */
+declare const SimplrElements: SimplrController;
+/**
+ * Imperative feature-flag helper mirroring the core local-eval contract.
+ * Reads from the shared controller.
+ */
+declare function isFeatureEnabled(key: string, ctx?: EvalContext): boolean;
+
+/** Map of tag name → element constructor for every Simplr custom element. */
+declare const SIMPLR_ELEMENTS: Record<string, CustomElementConstructor>;
+/**
+ * Register all Simplr custom elements with the browser's CustomElementRegistry.
+ * No-op (and safe) when there is no `customElements` (e.g. SSR / Node). Already
+ * registered tags are skipped, so calling this twice is harmless.
+ */
+declare function defineSimplrElements(): void;
+
+declare global {
+    interface Window {
+        SIMPLR_CONFIG?: {
+            apiKey?: string;
+            publicKey?: string;
+            baseUrl?: string;
+            autoStart?: boolean;
+            appId?: string;
+        };
+    }
+}
+declare class SimplrProviderElement extends HTMLElement {
+    static get observedAttributes(): string[];
+    connectedCallback(): void;
+    attributeChangedCallback(): void;
+    private tryConfigure;
+}
+
+declare class SimplrProtectedFormElement extends HTMLElement {
+    private form;
+    private onSubmit;
+    connectedCallback(): void;
+    disconnectedCallback(): void;
+    /** Field name used for the hidden signals input. */
+    get fieldName(): string;
+    private handleSubmit;
+}
+
+declare class SimplrProtectedInputElement extends HTMLElement {
+    static get observedAttributes(): string[];
+    private input;
+    private handlers;
+    private bound;
+    get field(): string;
+    connectedCallback(): void;
+    disconnectedCallback(): void;
+    attributeChangedCallback(): void;
+    private attach;
+    private detach;
+}
+
+declare class SimplrFeatureFlagElement extends HTMLElement {
+    static get observedAttributes(): string[];
+    private onConfigured;
+    private poll;
+    connectedCallback(): void;
+    disconnectedCallback(): void;
+    attributeChangedCallback(): void;
+    /** The flag key. */
+    get key(): string;
+    /** Whether this flag currently evaluates to enabled. */
+    get enabled(): boolean;
+    private evaluate;
+}
+
+declare class SimplrRumViewElement extends HTMLElement {
+    static get observedAttributes(): string[];
+    get viewName(): string;
+    connectedCallback(): void;
+    attributeChangedCallback(_n: string, oldV: string | null, newV: string | null): void;
+    private track;
+}
+
+declare class SimplrAiDelegationElement extends HTMLElement {
+    private trigger;
+    private onClick;
+    connectedCallback(): void;
+    disconnectedCallback(): void;
+    get userId(): string;
+    private run;
+}
+
+export { type CheckInput, type CheckResult, type RiskLevel, SIMPLR_ELEMENTS, SimplrAiDelegationElement, type SimplrConfig, SimplrController, SimplrElements, SimplrFeatureFlagElement, SimplrProtectedFormElement, SimplrProtectedInputElement, SimplrProviderElement, SimplrRumViewElement, defineSimplrElements, isFeatureEnabled };