genus-pdf-viewer 0.2.3 → 0.2.11

package/README.md

@@ -15,7 +15,7 @@ Framework-agnostic PDF viewer built on `pdfjs-dist` with a custom element and a
 npm install genus-pdf-viewer
 ```
 
-The package ships `pdf.worker.min.mjs` and resolves it automatically from the built package. Override `workerSrc` only if your app needs a custom asset location.
+The package ships `pdf.worker.bootstrap.mjs` and `pdf.worker.min.mjs`. Unbundled package usage resolves the worker beside the built package; bundled app usage resolves `assets/pdf.worker.bootstrap.mjs`, so host apps should copy both worker files into their deployed assets.
 
 ## Breaking Change
 
@@ -56,6 +56,7 @@ defineGenusPdfViewerElement();
 ```html
 <genus-pdf-viewer
   src="https://mozilla.github.io/pdf.js/web/compressed.tracemonkey-pldi-09.pdf"
+  proxy-url="/api/pdf-proxy"
   page="1"
   zoom="1"
   fit="width"
@@ -77,6 +78,9 @@ Config fields:
 - `fit?`: `"width" | "page" | "none"`
 - `continuous?`, `showToolbar?`, `allowDownload?`
 - `workerSrc?`: override the default worker URL
+- `proxyUrl?`: route cross-origin URL PDFs through your own same-origin proxy endpoint
+  If omitted, the viewer first tries `"/__proxy"` for cross-origin URL sources and falls back to the direct URL if that route is unavailable.
+  Set `proxyUrl: false` if you want to skip the proxy attempt.
 - `withCredentials?`, `httpHeaders?`: network request options for URL sources
 
 Element methods:
@@ -104,16 +108,16 @@ The viewer emits bubbling custom events:
 ## Package Exports
 
 - `genus-pdf-viewer`: main TypeScript and custom-element API
-- `genus-pdf-viewer/pdf.worker.min.mjs`: worker asset if you need to host it yourself
+- `genus-pdf-viewer/pdf.worker.bootstrap.mjs`: optional bootstrap worker asset for strict CSP deployments
+- `genus-pdf-viewer/pdf.worker.min.mjs`: optional worker asset if you need to host it yourself
 - `genus-pdf-viewer/styles.css`: packaged stylesheet export
 
 ## Angular / Vite Setup
 
-If your Angular app is using Vite-based dev/build tooling, prefer the JS API and pass a worker URL from the app's own `pdfjs-dist` install so the API and worker versions always match.
+The default setup is npm-install-only. The viewer creates a self-contained Blob worker URL for pdf.js, so Angular, Vite, Amplify, and other static hosts do not need to copy `pdf.worker*.mjs` into `/assets`.
 
 ```ts
 import { createGenusPdfViewer } from "genus-pdf-viewer";
-import workerUrl from "pdfjs-dist/build/pdf.worker.min.mjs?url";
 
 const host = document.getElementById("pdf-root");
 
@@ -124,12 +128,51 @@ if (host) {
     continuous: true,
     showToolbar: true,
     zoomStep: 0.15,
-    workerSrc: workerUrl,
   });
 }
 ```
 
-This is the setup used in `carewall_genusconnect` to avoid worker-path mismatches and fake-worker fallback.
+If your app has a strict Content Security Policy that blocks `blob:` workers, copy the package worker assets into your app assets folder and pass `workerSrc` explicitly.
+
+```json
+{
+  "glob": "pdf.worker*.mjs",
+  "input": "node_modules/genus-pdf-viewer/dist",
+  "output": "/assets"
+}
+```
+
+```ts
+import { createGenusPdfViewer } from "genus-pdf-viewer";
+
+const host = document.getElementById("pdf-root");
+
+if (host) {
+  createGenusPdfViewer(host, {
+    src: pdfUrl,
+    fit: "width",
+    continuous: true,
+    showToolbar: true,
+    zoomStep: 0.15,
+    workerSrc: "/assets/pdf.worker.bootstrap.mjs",
+  });
+}
+```
+
+If a remote PDF URL loads in the browser but fails inside the viewer with a CORS-style error, the PDF host is blocking fetch access for your app origin. This package cannot bypass that browser restriction. Fix it by either:
+
+- allowing your app origin in the PDF host's CORS policy
+- fetching the PDF in your app/backend and passing a `Blob` or `Uint8Array` to the viewer instead of the remote URL
+- routing the request through your own same-origin proxy and passing `proxyUrl`
+
+```ts
+createGenusPdfViewer(host, {
+  src: pdfUrl,
+  fit: "width",
+  continuous: true,
+  proxyUrl: "/api/pdf-proxy",
+});
+```
 
 ## Demo
 
@@ -151,7 +194,7 @@ npm pack --dry-run
 
 ## Publish
 
-This repo is configured for the existing public npm package `genus-pdf-viewer`.
+This repo is configured to publish the npm package `genus-pdf-viewer`.
 
 ```bash
 npm publish

package/dist/index.d.ts

@@ -1,3 +1,4 @@
-export { createGenusPdfViewer, defineGenusPdfViewerElement, GenusPdfViewerElement, } from "./viewer.js";
+export { createGenusPdfViewer, defineGenusPdfViewerElement, GenusPdfViewerElement, PDF_WORKER_BOOTSTRAP_ASSET_PATH, releaseDefaultPdfWorkerSrc, resolveDefaultPdfWorkerSrc, } from "./viewer.js";
+export type { ResolveDefaultPdfWorkerSrcOptions } from "./viewer.js";
 export type { GenusPdfViewerConfig, GenusPdfViewerErrorEventDetail, GenusPdfViewerEventMap, GenusPdfViewerFit, GenusPdfViewerPageChangeEventDetail, GenusPdfViewerReadyEventDetail, GenusPdfViewerSource, GenusPdfViewerZoomChangeEventDetail, } from "./types.js";
 //# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,oBAAoB,EACpB,2BAA2B,EAC3B,qBAAqB,GACtB,MAAM,aAAa,CAAC;AAErB,YAAY,EACV,oBAAoB,EACpB,8BAA8B,EAC9B,sBAAsB,EACtB,iBAAiB,EACjB,mCAAmC,EACnC,8BAA8B,EAC9B,oBAAoB,EACpB,mCAAmC,GACpC,MAAM,YAAY,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,oBAAoB,EACpB,2BAA2B,EAC3B,qBAAqB,EACrB,+BAA+B,EAC/B,0BAA0B,EAC1B,0BAA0B,GAC3B,MAAM,aAAa,CAAC;AAErB,YAAY,EAAE,iCAAiC,EAAE,MAAM,aAAa,CAAC;AAErE,YAAY,EACV,oBAAoB,EACpB,8BAA8B,EAC9B,sBAAsB,EACtB,iBAAiB,EACjB,mCAAmC,EACnC,8BAA8B,EAC9B,oBAAoB,EACpB,mCAAmC,GACpC,MAAM,YAAY,CAAC"}

package/dist/index.js

@@ -1,2 +1,2 @@
-export { createGenusPdfViewer, defineGenusPdfViewerElement, GenusPdfViewerElement, } from "./viewer.js";
+export { createGenusPdfViewer, defineGenusPdfViewerElement, GenusPdfViewerElement, PDF_WORKER_BOOTSTRAP_ASSET_PATH, releaseDefaultPdfWorkerSrc, resolveDefaultPdfWorkerSrc, } from "./viewer.js";
 //# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,oBAAoB,EACpB,2BAA2B,EAC3B,qBAAqB,GACtB,MAAM,aAAa,CAAC"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,oBAAoB,EACpB,2BAA2B,EAC3B,qBAAqB,EACrB,+BAA+B,EAC/B,0BAA0B,EAC1B,0BAA0B,GAC3B,MAAM,aAAa,CAAC"}

package/dist/pdf-worker-source.generated.d.ts

@@ -0,0 +1,2 @@
+export declare const PDF_WORKER_SOURCE: string;
+//# sourceMappingURL=pdf-worker-source.generated.d.ts.map

package/dist/pdf-worker-source.generated.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"pdf-worker-source.generated.d.ts","sourceRoot":"","sources":["../src/pdf-worker-source.generated.ts"],"names":[],"mappings":"AAEA,eAAO,MAAM,iBAAiB,EAAE,MAAko8wC,CAAC"}