@elu-labs/analytics-browser 1.410.0

package/dist/index.d.ts

@@ -0,0 +1,122 @@
+/** Exact declared source configuration; source key/token inference across sites is forbidden. */
+interface LegacyStorageOptions {
+    readonly sourceArtifactSha256: string;
+    readonly token: string;
+    readonly persistence: 'localStorage' | 'cookie' | 'localStorage+cookie';
+    readonly persistence_name?: string;
+    readonly consent_persistence_name?: string;
+    readonly opt_out_capturing_cookie_prefix?: string;
+    readonly prefer_cookie_on_conflict: boolean;
+    readonly respect_dnt: boolean;
+    readonly opt_out_capturing_by_default: boolean;
+}
+
+type V1JsonPrimitive = string | number | boolean | null;
+type V1JsonValue = V1JsonPrimitive | V1JsonObject | readonly V1JsonValue[];
+interface V1JsonObject {
+    readonly [key: string]: V1JsonValue;
+}
+
+/** Page-lifetime heap and main-thread sampling. Disabled unless enabled locally or remotely. */
+interface PerformanceCaptureConfig {
+    readonly memory?: boolean;
+    readonly long_tasks?: boolean;
+    /** Milliseconds between visible-page samples. Defaults to 30,000; minimum 5,000. */
+    readonly sample_interval_ms?: number;
+}
+type EluPerformanceCaptureOptions = boolean | Readonly<PerformanceCaptureConfig>;
+
+type V1FacadeProperties = Readonly<Record<string, unknown>>;
+interface V1FacadeCaptureOptions {
+    readonly $set?: V1FacadeProperties;
+    readonly $set_once?: V1FacadeProperties;
+    /** Explicit event time; must not precede persisted activity or the call is dropped. */
+    readonly timestamp?: Date;
+}
+interface V1FacadeFlagOptions {
+    /** Report `$feature_flag_called` for this read; defaults to true. */
+    readonly send_event?: boolean;
+    /** Return only values received from the flag endpoint during this owner's lifetime. */
+    readonly fresh?: boolean;
+}
+interface V1FacadeIsFeatureEnabledOptions extends V1FacadeFlagOptions {
+    readonly defaultValue?: boolean;
+}
+interface V1FacadeFlagResult {
+    readonly key: string;
+    readonly enabled: boolean;
+    readonly variant: string | undefined;
+    readonly payload: V1JsonValue | undefined;
+}
+type V1FacadeFlagVariant = string | boolean;
+type V1FacadeFlagsCallback = (flags: readonly string[], variants: Readonly<Record<string, V1FacadeFlagVariant>>, context?: Readonly<{
+    errorsLoading?: boolean;
+}>) => void;
+interface V1FacadeOptInOptions {
+    /** Event name for the opt-in capture; `null` or `false` captures nothing. */
+    readonly captureEventName?: string | null | false;
+    readonly captureProperties?: V1FacadeProperties;
+}
+interface V1FacadeFeatureFlags {
+    readonly hasLoadedFlags: boolean;
+    getFlags(): readonly string[];
+    getFlagVariants(): Readonly<Record<string, V1FacadeFlagVariant>>;
+    getFlagPayloads(): Readonly<Record<string, V1JsonValue>>;
+    getFeatureFlag(key: string, options?: V1FacadeFlagOptions): V1FacadeFlagVariant | undefined;
+    getFeatureFlagPayload(key: string): V1JsonValue | undefined;
+    getFeatureFlagResult(key: string, options?: V1FacadeFlagOptions): V1FacadeFlagResult | undefined;
+    isFeatureEnabled(key: string, options?: V1FacadeIsFeatureEnabledOptions): boolean | undefined;
+    reloadFeatureFlags(): void;
+    onFeatureFlags(callback: V1FacadeFlagsCallback): () => void;
+}
+
+/** The frozen customer API shared by the direct package client and window.elu. */
+interface EluClient {
+    identify(distinctId?: string, propertiesToSet?: V1FacadeProperties, propertiesToSetOnce?: V1FacadeProperties): void;
+    capture(eventName: string, properties?: V1FacadeProperties | null, options?: V1FacadeCaptureOptions): undefined;
+    reset(resetDeviceId?: boolean): void;
+    alias(alias: string, original?: string): undefined;
+    get_distinct_id(): string | undefined;
+    setPersonProperties(propertiesToSet?: V1FacadeProperties, propertiesToSetOnce?: V1FacadeProperties): void;
+    captureException(error: unknown, additionalProperties?: V1FacadeProperties): undefined;
+    register(properties: V1FacadeProperties, days?: number): void;
+    register_once(properties: V1FacadeProperties, defaultValue?: unknown, days?: number): void;
+    unregister(property: string): void;
+    getFeatureFlag(key: string, options?: V1FacadeFlagOptions): V1FacadeFlagVariant | undefined;
+    getFeatureFlagPayload(key: string): V1JsonValue | undefined;
+    getFeatureFlagResult(key: string, options?: V1FacadeFlagOptions): V1FacadeFlagResult | undefined;
+    isFeatureEnabled(key: string, options?: V1FacadeIsFeatureEnabledOptions): boolean | undefined;
+    reloadFeatureFlags(): void;
+    onFeatureFlags(callback: V1FacadeFlagsCallback): () => void;
+    setPersonPropertiesForFlags(properties: V1FacadeProperties, reloadFeatureFlags?: boolean): void;
+    resetPersonPropertiesForFlags(reloadFeatureFlags?: boolean): void;
+    setGroupPropertiesForFlags(properties: Readonly<Record<string, V1FacadeProperties>>, reloadFeatureFlags?: boolean): void;
+    resetGroupPropertiesForFlags(groupType?: string): void;
+    group(groupType: string, groupKey: string, groupPropertiesToSet?: V1FacadeProperties): void;
+    resetGroups(): void;
+    getGroups(): Readonly<Record<string, string>>;
+    opt_in_capturing(options?: V1FacadeOptInOptions): void;
+    opt_out_capturing(): void;
+    readonly featureFlags: V1FacadeFeatureFlags;
+}
+
+type EluPageviewMode = false | true | 'history_change';
+
+/** Optional package initialization only; the frozen window.elu method surface is unchanged. */
+interface EluInitializationOptions {
+    readonly legacy_storage?: LegacyStorageOptions;
+    readonly capture_pageview?: EluPageviewMode;
+    readonly autocapture?: boolean;
+    readonly capture_exceptions?: boolean;
+    readonly capture_performance?: EluPerformanceCaptureOptions;
+    readonly loaded?: (client: EluClient) => unknown;
+}
+
+/**
+ * Creates the direct package client with the same methods and startup buffering as the loader.
+ * Importing the module performs no setup; call this once per site key in a browser.
+ */
+declare const createEluClient: (siteKey: string, options?: EluInitializationOptions) => EluClient;
+
+export { createEluClient };
+export type { EluClient };