@merittdev/horus-lens 0.0.1 → 0.0.2

package/README.md

@@ -0,0 +1,100 @@
+# 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 { LensProvider } from '@merittdev/horus-lens/react';
+
+<LensProvider
+  accessId="lai_your_access_id"
+  endpoint="https://api-lens.meritt.app"
+  app={{ release: APP_VERSION, gitSha: COMMIT_SHA, user: { id: user.id } }}
+>
+  <App />
+</LensProvider>
+```
+
+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), and `useLens()` 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 components (your own admin, no hosted dashboard)
+
+```tsx
+import {
+  createLensApi, LensDashboardProvider,
+  ReportsTable, ReportDetail, IntegrationSettings, OnboardingWizard,
+} from '@merittdev/horus-lens/dashboard';
+import '@merittdev/horus-lens/dist/dashboard.css';
+
+const api = createLensApi({
+  baseUrl: '/api/lens',        // your server-side proxy
+  getToken: () => '',          // credentials attach server-side — never in the browser
+});
+```
+
+Ships a reports table (search + pagination), tabbed report detail with a replay
+player, integration management (OAuth to Linear/GitHub/Jira, single active
+destination), and a self-serve onboarding wizard. Light-first monochrome design that
+drops into any admin; dark mode via `.dark`, `[data-theme="dark"]`, or
+`<LensDashboardProvider theme="dark">`.
+
+## 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** — server-side only: management API, dashboard proxy, CI.
+
+## 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/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@merittdev/horus-lens",
-  "version": "0.0.1",
+  "version": "0.0.2",
   "description": "Lens — context-rich issue capture for web apps: overlay, replay, and drop-in dashboard components",
   "license": "MIT",
   "type": "module",
@@ -51,15 +51,36 @@
   "devDependencies": {
     "tsup": "^8.4.0",
     "typescript": "^5.7.3",
-    "@horus-lens/core": "0.0.1",
     "@horus-lens/browser": "0.0.1",
-    "@horus-lens/react": "0.0.1",
     "@horus-lens/dashboard": "0.0.1",
-    "@horus-lens/shared": "0.0.1"
+    "@horus-lens/react": "0.0.1",
+    "@horus-lens/shared": "0.0.1",
+    "@horus-lens/core": "0.0.1"
   },
   "publishConfig": {
     "access": "public"
   },
+  "keywords": [
+    "bug-reporting",
+    "session-replay",
+    "rrweb",
+    "feedback",
+    "issue-tracking",
+    "linear",
+    "jira",
+    "github",
+    "screenshot",
+    "developer-tools"
+  ],
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/Meritt-dev/horus-lens.git",
+    "directory": "packages/lens"
+  },
+  "homepage": "https://github.com/Meritt-dev/horus-lens#readme",
+  "bugs": {
+    "url": "https://github.com/Meritt-dev/horus-lens/issues"
+  },
   "scripts": {
     "build": "tsup && node scripts/copy-assets.mjs",
     "typecheck": "tsc --noEmit",