@zerohive/hive-viewer 0.1.0

package/README.md

@@ -0,0 +1,62 @@
+# @zerohive/hive-viewer
+
+A self-hostable, browser-first document viewer/editor for React and Next.js.
+
+## Install
+
+```bash
+npm i @zerohive/hive-viewer
+```
+
+Import styles once in your app:
+
+```ts
+import '@zerohive/hive-viewer/styles.css';
+```
+
+## Usage
+
+```tsx
+import { DocumentViewer } from '@zerohive/hive-viewer';
+
+export default function Page() {
+  return (
+    <DocumentViewer
+      mode="edit"
+      fileUrl="https://example.com/my.pdf"
+      fileName="my.pdf"
+      fileType="pdf"
+      allowSigning
+      onSignRequest={async () => ({
+        signatureImageUrl: 'https://.../sig.png',
+        signedBy: 'Jane Doe',
+        dateSigned: new Date().toISOString(),
+        comment: 'Approved'
+      })}
+      onSave={(b64, meta) => { /* persist */ }}
+    />
+  );
+}
+```
+
+## Signing Workflow (decoupled)
+
+- If `allowSigning={true}`, the toolbar shows **Sign Document**.
+- Clicking it calls `onSignRequest()` (parent handles biometric/e-signature/KYC/etc.).
+- The returned `Signature` is immediately displayed:
+  - `view/edit`: signatures appear in the right signature panel and can be **placed** onto the page by clicking **Place signature**.
+  - `create`: signatures are appended to the end of the document (no right panel).
+
+## Progressive loading and caching
+
+- `fileUrl` loading uses streaming where available (`fetch` + `ReadableStream`).
+- For PDFs, `pdfjs` is configured with `rangeChunkSize` so rendering can start before the full file downloads.
+- In `fileUrl` mode, the package caches the ArrayBuffer in-memory during the session to avoid re-fetching when switching layouts/modes.
+
+## Security
+
+- Markdown/HTML content is sanitized via DOMPurify before rendering.
+
+## Props
+
+See `src/types.ts` for full types.