@incodetech/tri-sdk 0.1.0

package/dist/index.d.ts

@@ -0,0 +1,128 @@
+type CollectorKey = 'fingerprint' | 'pointer' | 'pointermove' | 'focus' | 'input' | 'keystroke' | 'clipboard' | 'form' | 'change' | 'selection' | 'visibility' | 'navigation' | 'viewportresize' | 'viewport' | 'scroll' | 'devicemotion' | 'networkrequest' | 'networkconnection' | 'permissionchange' | 'environmental';
+type CollectorEventMap = {
+    pointer: 'pointerdown' | 'pointerup' | 'click' | 'dblclick' | 'contextmenu' | 'dragend';
+    focus: 'focusin' | 'focusout';
+    input: 'input';
+    keystroke: 'keydown' | 'keyup';
+    clipboard: 'paste' | 'cut' | 'copy';
+    form: 'submit' | 'invalid';
+    change: 'change';
+    selection: 'selectionchange';
+    visibility: 'visibilitychange';
+    pointermove: never;
+    fingerprint: never;
+    navigation: never;
+    viewport: never;
+    viewportresize: never;
+    scroll: never;
+    devicemotion: never;
+    networkrequest: never;
+    networkconnection: never;
+    permissionchange: never;
+    environmental: never;
+};
+type Layer = 'session' | 'behavioral' | 'device-fingerprinting' | 'environmental-integrity' | 'network-intelligence' | 'persistent-identity';
+
+/**
+ * Global PII capture level for the SDK.
+ *
+ * - `'all'`    — all fields emitted; PII identifiers and labels included.
+ *                Consumers should annotate sensitive elements with `data-tri-redact`.
+ * - `'redact'` — PII identifiers (`id`, `name`, label, classes) set to `null`.
+ *                Default. Per-element overrides via `data-tri-redact` / `data-tri-ignore`.
+ * - `'off'`    — Element Context Processor is skipped entirely; `element` is always `null`.
+ */
+type CaptureElementLevel = 'all' | 'redact' | 'off';
+type CaptureContentLevel = 'on' | 'off';
+/**
+ * Public SDK configuration. Both `layers` and `collectors` are optional; pass at
+ * most one. When neither is provided, every collector defaults to enabled (same
+ * behaviour as calling `start()` with no config).
+ */
+type TriSDKConfig = TriSDKConfigBase & (LayerBasedConfig | CollectorBasedConfig | NoCollectorSelectionConfig);
+type TriSDKConfigBase = {
+    capture?: {
+        element?: CaptureElementLevel;
+        content?: CaptureContentLevel;
+    };
+    profileId?: string;
+    api: {
+        key: string;
+        version: string;
+        url: string;
+    };
+};
+type EventConfig = {
+    enabled?: boolean;
+    exclude?: string[];
+};
+type CollectorEventsConfig<C extends CollectorKey> = {
+    /** Applied to every event emitted by this collector. */
+    exclude?: string[];
+} & {
+    [E in CollectorEventMap[C]]?: EventConfig;
+};
+type CollectorConfig<C extends CollectorKey> = [CollectorEventMap[C]] extends [
+    never
+] ? {
+    enabled?: boolean;
+} : {
+    enabled?: boolean;
+    events?: CollectorEventsConfig<C>;
+};
+type CollectorsConfig = {
+    [C in CollectorKey]?: CollectorConfig<C>;
+};
+type LayerBasedConfig = {
+    layers: Partial<Record<Layer, boolean>>;
+    collectors?: never;
+};
+type CollectorBasedConfig = {
+    layers?: never;
+    collectors: CollectorsConfig;
+};
+type NoCollectorSelectionConfig = {
+    layers?: never;
+    collectors?: never;
+};
+interface TriSDKInterface {
+    start(config?: TriSDKConfig): void;
+    reportEvent(name: string, metadata: Record<string, unknown>): void;
+}
+
+declare class TriSDK$1 implements TriSDKInterface {
+    private static _instance;
+    private initialized;
+    private activityManager;
+    private transportManager;
+    private tabManager;
+    private collectorManager;
+    private falconServiceManager;
+    constructor();
+    static get instance(): TriSDK$1;
+    /**
+     * Initialises the TRI SDK. Synchronous and idempotent — a second call is a
+     * no-op. Safe to call in SSR environments; if `document` is unavailable the
+     * function logs an error and returns without throwing.
+     */
+    start(config?: TriSDKConfig): void;
+    private _start;
+    /**
+     * Reports a host-defined event to the TRI backend. Fire-and-forget — never
+     * throws and never returns a promise the host must handle. Drops the event
+     * silently (with a dev warning) if called before `init`.
+     */
+    reportEvent(name: string, metadata: Record<string, unknown>): void;
+    private _shouldEarlyEscapeInit;
+    private _shouldEarlyEscapeReportEvent;
+    private _createFalconServiceManagerContext;
+    private _createActivityManagerContext;
+    private _createTransportManagerContext;
+    private _createTabManagerContext;
+    private _createLifecycleManagerContext;
+    private _createCollectorsManagerContext;
+}
+
+declare const TriSDK: TriSDK$1;
+
+export { TriSDK as default };