@merittdev/horus-lens 0.0.1

package/dist/browser.d.cts

@@ -0,0 +1,125 @@
+import { L as LensConfig, a as LensClient } from './index.d-DOCLVJGS.cjs';
+import { z } from 'zod';
+import './index.d-Bzgtl7-B.cjs';
+
+declare const AppContextSchema: z.ZodObject<{
+    release: z.ZodOptional<z.ZodString>;
+    gitSha: z.ZodOptional<z.ZodString>;
+    environment: z.ZodOptional<z.ZodString>;
+    featureFlags: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnion<readonly [z.ZodString, z.ZodBoolean, z.ZodNumber]>>>;
+    user: z.ZodOptional<z.ZodObject<{
+        id: z.ZodOptional<z.ZodString>;
+        email: z.ZodOptional<z.ZodString>;
+        name: z.ZodOptional<z.ZodString>;
+        organization: z.ZodOptional<z.ZodString>;
+    }, z.core.$strip>>;
+    extra: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
+}, z.core.$strip>;
+type AppContext = z.infer<typeof AppContextSchema>;
+
+/** Read-only gate check (param OR persisted flag). Never mutates storage. */
+declare function isGateActive(paramName?: string): boolean;
+
+/**
+ * The documented loader snippet — a GTM-style inline stub that queues commands
+ * until the async bundle loads and replays them. Ship this in docs / install
+ * flows so a page can call `Lens('init', ...)` before the SDK is downloaded.
+ */
+interface SnippetOptions {
+    accessId: string;
+    /** URL of the browser bundle (defaults to the public CDN latest build). */
+    cdnUrl?: string;
+}
+declare const DEFAULT_CDN_URL = "https://cdn.lens.dev/browser.js";
+declare function loaderSnippet(options: SnippetOptions): string;
+/** Example snippet string for documentation (placeholder access id + CDN). */
+declare const LOADER_SNIPPET: string;
+
+/**
+ * GTM-style command stub. The loader snippet defines:
+ *   window.Lens = function(){(window.Lens.q = window.Lens.q||[]).push(arguments)}
+ * so pages can call `Lens('init', ...)`, `Lens('identify', user)` etc. before
+ * the bundle downloads. On load we drain that queue, then replace the global
+ * with a live dispatcher that forwards subsequent calls to the running client.
+ */
+type LensCommand = 'init' | 'identify' | 'app' | 'open';
+interface LensGlobal {
+    (...args: unknown[]): void;
+    q?: Array<ArrayLike<unknown>>;
+}
+declare global {
+    interface Window {
+        Lens?: LensGlobal;
+    }
+}
+/** Structured result of replaying the pre-boot command queue. */
+interface QueuedCommands {
+    /** `init` argument: an access id string or a partial config object. */
+    init?: string | Record<string, unknown>;
+    identify?: NonNullable<AppContext['user']>;
+    app?: Partial<AppContext>;
+    open: boolean;
+}
+/** Drain `window.Lens.q` into a structured shape consumed by boot(). */
+declare function processQueue(): QueuedCommands;
+/**
+ * Replace `window.Lens` with a live function that forwards commands to the
+ * mounted overlay. Safe to call with `null` (gate inactive) — it installs a
+ * no-op-ish dispatcher that only handles future `init`-less commands.
+ */
+declare function installGlobal(browser: LensBrowser | null): void;
+
+/**
+ * Read-only context snapshot rendered as chips in the report panel. URL /
+ * route / browser / os / viewport are computed locally; console / network /
+ * error counts are not exposed through the public core API, so they are
+ * `null` (rendered as neutral placeholders) unless supplied externally.
+ */
+interface OverlayStats {
+    url: string;
+    route: string;
+    browser: string;
+    os: string;
+    viewport: {
+        width: number;
+        height: number;
+    };
+    replay: boolean;
+    console: number | null;
+    network: number | null;
+    errors: number | null;
+}
+
+interface BootOptions extends Partial<Omit<LensConfig, 'accessId'>> {
+    /** Falls back to a `<script data-lens-id>` attribute or a queued `init` call. */
+    accessId?: string;
+    /** Query param that gates activation. Default `'lens'` → `?lens=true`. */
+    paramName?: string;
+    /** Bypass the query-param gate (preview envs / the React provider). */
+    force?: boolean;
+}
+interface LensBrowser {
+    client: LensClient;
+    /** Open the report panel. */
+    open(): void;
+    /** Close the report panel (overlay stays mounted). */
+    close(): void;
+    /** Remove the overlay, stop the client, and clear gate persistence. */
+    destroy(): void;
+}
+
+/**
+ * Boot the overlay: gate check → resolve access id → start a LensClient →
+ * mount the overlay → wire the global command dispatcher. Returns `null` on the
+ * server, when the gate is inactive, or when no access id can be resolved.
+ */
+declare function boot(options?: BootOptions): LensBrowser | null;
+/**
+ * Auto-boot on bundle load when a queued `init` command or a
+ * `<script data-lens-id>` attribute supplies an access id and the gate is
+ * active. No-op during SSR. Exposed so the entry can self-initialize when
+ * loaded via the CDN snippet, while ESM consumers call `boot()` directly.
+ */
+declare function autoBoot(): LensBrowser | null;
+
+export { type BootOptions, DEFAULT_CDN_URL, LOADER_SNIPPET, type LensBrowser, type LensCommand, type LensGlobal, type OverlayStats, type QueuedCommands, type SnippetOptions, autoBoot, boot, installGlobal, isGateActive, loaderSnippet, processQueue };

package/dist/browser.d.ts

@@ -0,0 +1,125 @@
+import { L as LensConfig, a as LensClient } from './index.d-BA540Fae.js';
+import { z } from 'zod';
+import './index.d-Bzgtl7-B.js';
+
+declare const AppContextSchema: z.ZodObject<{
+    release: z.ZodOptional<z.ZodString>;
+    gitSha: z.ZodOptional<z.ZodString>;
+    environment: z.ZodOptional<z.ZodString>;
+    featureFlags: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnion<readonly [z.ZodString, z.ZodBoolean, z.ZodNumber]>>>;
+    user: z.ZodOptional<z.ZodObject<{
+        id: z.ZodOptional<z.ZodString>;
+        email: z.ZodOptional<z.ZodString>;
+        name: z.ZodOptional<z.ZodString>;
+        organization: z.ZodOptional<z.ZodString>;
+    }, z.core.$strip>>;
+    extra: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
+}, z.core.$strip>;
+type AppContext = z.infer<typeof AppContextSchema>;
+
+/** Read-only gate check (param OR persisted flag). Never mutates storage. */
+declare function isGateActive(paramName?: string): boolean;
+
+/**
+ * The documented loader snippet — a GTM-style inline stub that queues commands
+ * until the async bundle loads and replays them. Ship this in docs / install
+ * flows so a page can call `Lens('init', ...)` before the SDK is downloaded.
+ */
+interface SnippetOptions {
+    accessId: string;
+    /** URL of the browser bundle (defaults to the public CDN latest build). */
+    cdnUrl?: string;
+}
+declare const DEFAULT_CDN_URL = "https://cdn.lens.dev/browser.js";
+declare function loaderSnippet(options: SnippetOptions): string;
+/** Example snippet string for documentation (placeholder access id + CDN). */
+declare const LOADER_SNIPPET: string;
+
+/**
+ * GTM-style command stub. The loader snippet defines:
+ *   window.Lens = function(){(window.Lens.q = window.Lens.q||[]).push(arguments)}
+ * so pages can call `Lens('init', ...)`, `Lens('identify', user)` etc. before
+ * the bundle downloads. On load we drain that queue, then replace the global
+ * with a live dispatcher that forwards subsequent calls to the running client.
+ */
+type LensCommand = 'init' | 'identify' | 'app' | 'open';
+interface LensGlobal {
+    (...args: unknown[]): void;
+    q?: Array<ArrayLike<unknown>>;
+}
+declare global {
+    interface Window {
+        Lens?: LensGlobal;
+    }
+}
+/** Structured result of replaying the pre-boot command queue. */
+interface QueuedCommands {
+    /** `init` argument: an access id string or a partial config object. */
+    init?: string | Record<string, unknown>;
+    identify?: NonNullable<AppContext['user']>;
+    app?: Partial<AppContext>;
+    open: boolean;
+}
+/** Drain `window.Lens.q` into a structured shape consumed by boot(). */
+declare function processQueue(): QueuedCommands;
+/**
+ * Replace `window.Lens` with a live function that forwards commands to the
+ * mounted overlay. Safe to call with `null` (gate inactive) — it installs a
+ * no-op-ish dispatcher that only handles future `init`-less commands.
+ */
+declare function installGlobal(browser: LensBrowser | null): void;
+
+/**
+ * Read-only context snapshot rendered as chips in the report panel. URL /
+ * route / browser / os / viewport are computed locally; console / network /
+ * error counts are not exposed through the public core API, so they are
+ * `null` (rendered as neutral placeholders) unless supplied externally.
+ */
+interface OverlayStats {
+    url: string;
+    route: string;
+    browser: string;
+    os: string;
+    viewport: {
+        width: number;
+        height: number;
+    };
+    replay: boolean;
+    console: number | null;
+    network: number | null;
+    errors: number | null;
+}
+
+interface BootOptions extends Partial<Omit<LensConfig, 'accessId'>> {
+    /** Falls back to a `<script data-lens-id>` attribute or a queued `init` call. */
+    accessId?: string;
+    /** Query param that gates activation. Default `'lens'` → `?lens=true`. */
+    paramName?: string;
+    /** Bypass the query-param gate (preview envs / the React provider). */
+    force?: boolean;
+}
+interface LensBrowser {
+    client: LensClient;
+    /** Open the report panel. */
+    open(): void;
+    /** Close the report panel (overlay stays mounted). */
+    close(): void;
+    /** Remove the overlay, stop the client, and clear gate persistence. */
+    destroy(): void;
+}
+
+/**
+ * Boot the overlay: gate check → resolve access id → start a LensClient →
+ * mount the overlay → wire the global command dispatcher. Returns `null` on the
+ * server, when the gate is inactive, or when no access id can be resolved.
+ */
+declare function boot(options?: BootOptions): LensBrowser | null;
+/**
+ * Auto-boot on bundle load when a queued `init` command or a
+ * `<script data-lens-id>` attribute supplies an access id and the gate is
+ * active. No-op during SSR. Exposed so the entry can self-initialize when
+ * loaded via the CDN snippet, while ESM consumers call `boot()` directly.
+ */
+declare function autoBoot(): LensBrowser | null;
+
+export { type BootOptions, DEFAULT_CDN_URL, LOADER_SNIPPET, type LensBrowser, type LensCommand, type LensGlobal, type OverlayStats, type QueuedCommands, type SnippetOptions, autoBoot, boot, installGlobal, isGateActive, loaderSnippet, processQueue };

package/dist/browser.js

@@ -0,0 +1,24 @@
+import {
+  DEFAULT_CDN_URL,
+  LOADER_SNIPPET,
+  autoBoot,
+  boot,
+  installGlobal,
+  isGateActive,
+  loaderSnippet,
+  processQueue
+} from "./chunk-DU7HNRF4.js";
+import "./chunk-S6S3ZZQA.js";
+import "./chunk-DWOH2ENF.js";
+import "./chunk-PZ5AY32C.js";
+export {
+  DEFAULT_CDN_URL,
+  LOADER_SNIPPET,
+  autoBoot,
+  boot,
+  installGlobal,
+  isGateActive,
+  loaderSnippet,
+  processQueue
+};
+//# sourceMappingURL=browser.js.map

package/dist/browser.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":[],"sourcesContent":[],"mappings":"","names":[]}