@merittdev/horus-lens 0.0.1 → 0.0.3

package/README.md

@@ -0,0 +1,129 @@
+# Lens — `@merittdev/horus-lens`
+
+Context-rich issue capture for web apps, part of the [Horus](https://horus.sh) ecosystem.
+
+A teammate visits your app with `?lens=true`, an overlay appears, they describe the
+issue (pick an element, mark an area, or record their steps), press Submit — and Lens
+ships a report with a session replay, screenshot, console + network buffers, DOM
+snapshot, environment, release/git SHA, and user context. Reports become issues in
+**Linear, GitHub, or Jira** automatically, with the screenshot embedded and a
+shareable replay link.
+
+## Install
+
+```bash
+npm install @merittdev/horus-lens
+```
+
+Or with a script tag (any website — no build step):
+
+```html
+<script>
+  window.Lens=window.Lens||function(){(Lens.q=Lens.q||[]).push(arguments)};
+  Lens('init', 'lai_your_access_id');
+</script>
+<script async src="https://cdn.jsdelivr.net/npm/@merittdev/horus-lens/dist/lens.min.js"></script>
+```
+
+## Quickstart
+
+### React
+
+```tsx
+import { Lens } from '@merittdev/horus-lens/react';
+
+// anywhere in your root layout — renders nothing, mounts the overlay
+<Lens
+  accessId="lai_your_access_id"
+  app={{ release: APP_VERSION, gitSha: COMMIT_SHA, user: { id: user.id } }}
+/>
+```
+
+The React entry additionally captures the React component tree of whatever element
+the reporter picks. Use `enabled={isPreviewEnv}` to force the overlay on (e.g. every
+preview deployment). Wrap children with `<Lens>` only when a descendant needs the
+`useLens()` hook for programmatic control.
+
+### Script tag
+
+Context can be pushed before the bundle even loads:
+
+```js
+Lens('identify', { id: 'u_42', email: 'sarah@acme.com' });
+Lens('app', { release: 'v2.14.3', featureFlags: { newCheckout: true } });
+Lens('open'); // open the report panel programmatically
+```
+
+### Dashboard (your own admin, no hosted dashboard)
+
+One component, one config. On an access-controlled page (your admin auth is the
+gate), read the credentials server-side and hand them to the component:
+
+```tsx
+// page.tsx — server component, env stays on the server
+import LensPageClient from './LensPageClient';
+
+export default function Page() {
+  return <LensPageClient config={{ projects: JSON.parse(process.env.LENS_PROJECTS ?? '[]') }} />;
+}
+
+// LensPageClient.tsx — client component
+'use client'
+import { LensProvider, LensAdmin, type LensAdminConfig } from '@merittdev/horus-lens/dashboard';
+import '@merittdev/horus-lens/dist/dashboard.css';
+
+export default function LensPageClient({ config }: { config: LensAdminConfig }) {
+  return (
+    <LensProvider config={config}>
+      <LensAdmin />
+    </LensProvider>
+  );
+}
+```
+
+```bash
+LENS_PROJECTS=[{"name":"front","accessId":"lai_…","secretKey":"las_…"}]
+```
+
+No projects yet? Pass `config={{ projects: [], adminToken: process.env.LENS_ADMIN_TOKEN }}`
+and the built-in wizard mints the first project and hands you that env line.
+
+You get the full surface: reports (search + pagination + shareable
+`?report=` deep links), replay player, integrations (OAuth to
+Linear/GitHub/Jira with provider-fed dropdowns), project switcher, onboarding.
+Light-first monochrome; dark mode via `theme="dark"`, `.dark`, or
+`[data-theme="dark"]`.
+
+Prefer keys to never reach the browser at all (shared machines, stricter
+compliance)? Use proxy mode instead: mount the package's server handlers and
+drop the `config` prop — see `@merittdev/horus-lens/server`
+(`createLensProxy` + `createLensProjectsRoute`). Piecemeal components
+(`ReportsTable`, `ReportDetail`, …) remain exported for custom layouts.
+
+## When does the overlay appear?
+
+Never, for normal visitors. The SDK stays dormant until a page is opened with
+**`?lens=true`** — then the pill appears and persists for the session
+(`?lens=false` turns it off). Zero bundle cost for real users when you gate the
+import on the same check.
+
+## Keys
+
+- `lai_…` **access id** — public by design (like a GA measurement id). Enforced by a
+  per-project origin allowlist and rate limits on the API.
+- `las_…` **secret key** — full project access. Read it server-side and hand it only
+  to access-controlled surfaces (your admin page via `<LensProvider config>`), CI, or
+  the management API — never a public page.
+
+The SDK talks to the hosted Lens API out of the box — no endpoint configuration.
+Self-hosting? Pass `endpoint` (React/script `init` config) to point anywhere else.
+
+## Self-hosting
+
+The Lens API is a single Docker image (Fastify + Postgres + your own S3 bucket —
+assets upload browser→S3 via presigned URLs and never transit the API). See the
+[repository](https://github.com/Meritt-dev/horus-lens) for deployment docs.
+
+## License
+
+MIT © Meritt Dev

package/dist/browser.cjs

@@ -29086,7 +29086,7 @@ var ConnectIntegrationResponseSchema = external_exports.object({
 // ../core/dist/index.js
 var SDK_NAME = "@merittdev/horus-lens";
 var SDK_VERSION = "0.0.1";
-var DEFAULT_ENDPOINT = "http://localhost:5625";
+var DEFAULT_ENDPOINT = "https://api-lens.meritt.app";
 var DEFAULT_REPLAY_WINDOW_MS = 15e3;
 var DEFAULT_MAX_CONSOLE_ENTRIES = 200;
 var DEFAULT_MAX_NETWORK_ENTRIES = 100;