@zinejs/pdf 0.8.2 → 0.9.1

package/LICENSE

@@ -0,0 +1,73 @@
+# PolyForm Noncommercial License 1.0.0
+
+<https://polyformproject.org/licenses/noncommercial/1.0.0>
+
+## Acceptance
+
+In order to get any license under these terms, you must agree to them as both strict obligations and conditions to all your licenses.
+
+## Copyright License
+
+The licensor grants you a copyright license for the software to do everything you might do with the software that would otherwise infringe the licensor's copyright in it for any permitted purpose.  However, you may only distribute the software according to [Distribution License](#distribution-license) and make changes or new works based on the software according to [Changes and New Works License](#changes-and-new-works-license).
+
+## Distribution License
+
+The licensor grants you an additional copyright license to distribute copies of the software.  Your license to distribute covers distributing the software with changes and new works permitted by [Changes and New Works License](#changes-and-new-works-license).
+
+## Notices
+
+You must ensure that anyone who gets a copy of any part of the software from you also gets a copy of these terms or the URL for them above, as well as copies of any plain-text lines beginning with `Required Notice:` that the licensor provided with the software.  For example:
+
+> Required Notice: Copyright Yoyodyne, Inc. (http://example.com)
+
+## Changes and New Works License
+
+The licensor grants you an additional copyright license to make changes and new works based on the software for any permitted purpose.
+
+## Patent License
+
+The licensor grants you a patent license for the software that covers patent claims the licensor can license, or becomes able to license, that you would infringe by using the software.
+
+## Noncommercial Purposes
+
+Any noncommercial purpose is a permitted purpose.
+
+## Personal Uses
+
+Personal use for research, experiment, and testing for the benefit of public knowledge, personal study, private entertainment, hobby projects, amateur pursuits, or religious observance, without any anticipated commercial application, is use for a permitted purpose.
+
+## Noncommercial Organizations
+
+Use by any charitable organization, educational institution, public research organization, public safety or health organization, environmental protection organization, or government institution is use for a permitted purpose regardless of the source of funding or obligations resulting from the funding.
+
+## Fair Use
+
+You may have "fair use" rights for the software under the law. These terms do not limit them.
+
+## No Other Rights
+
+These terms do not allow you to sublicense or transfer any of your licenses to anyone else, or prevent the licensor from granting licenses to anyone else.  These terms do not imply any other licenses.
+
+## Patent Defense
+
+If you make any written claim that the software infringes or contributes to infringement of any patent, your patent license for the software granted under these terms ends immediately. If your company makes such a claim, your patent license ends immediately for work on behalf of your company.
+
+## Violations
+
+The first time you are notified in writing that you have violated any of these terms, or done anything with the software not covered by your licenses, your licenses can nonetheless continue if you come into full compliance with these terms, and take practical steps to correct past violations, within 32 days of receiving notice.  Otherwise, all your licenses end immediately.
+
+## No Liability
+
+***As far as the law allows, the software comes as is, without any warranty or condition, and the licensor will not be liable to you for any damages arising out of these terms or the use or nature of the software, under any kind of legal claim.***
+
+## Definitions
+
+The **licensor** is the individual or entity offering these terms, and the **software** is the software the licensor makes available under these terms.
+
+**You** refers to the individual or entity agreeing to these terms.
+
+**Your company** is any legal entity, sole proprietorship, or other kind of organization that you work for, plus all organizations that have control over, are under the control of, or are under common control with that organization.  **Control** means ownership of substantially all the assets of an entity, or the power to direct its management and policies by vote, contract, or otherwise.  Control can be direct or indirect.
+
+**Your licenses** are all the licenses granted to you for the software under these terms.
+
+**Use** means anything you do with the software requiring one of your licenses.

package/README.md

@@ -1,6 +1,8 @@
 # @zinejs/pdf
 
-PDF content source for [zinejs](https://github.com/), powered by [pdf.js](https://mozilla.github.io/pdf.js/). Renders PDF pages to canvases that the zinejs core paints as a flipbook.
+PDF content source for [zinejs](https://zinejs.com/docs/), powered by [pdf.js](https://mozilla.github.io/pdf.js/). Renders PDF pages to canvases that [`@zinejs/core`](https://www.npmjs.com/package/@zinejs/core) paints as a flipbook.
+
+> **Docs and examples:** [zinejs.com/docs](https://zinejs.com/docs/) · [CDN example](https://zinejs.com/examples/html-cdn)
 
 ## Install
 
@@ -8,118 +10,84 @@ PDF content source for [zinejs](https://github.com/), powered by [pdf.js](https:
 npm install @zinejs/core @zinejs/pdf
 ```
 
-`pdfjs-dist` is a normal dependency of `@zinejs/pdf`, so it installs with the package. The plugin still loads it lazily (dynamic `import`) so it never lands in the `@zinejs/core` bundle. If your app already depends on `pdfjs-dist`, the package manager will typically dedupe to one copy — keep major versions compatible so the worker matches the library.
+`pdfjs-dist` installs with this package. It is loaded lazily (dynamic `import`) so it never lands in the `@zinejs/core` bundle. If your app already depends on `pdfjs-dist`, keep major versions compatible so the worker matches the library.
 
 ## Usage
 
 ```js
-import { Zine } from '@zinejs/core';
-import { PdfSource } from '@zinejs/pdf';
+import { Zine } from '@zinejs/core'
+import { PdfSource } from '@zinejs/pdf'
 
-const book = new Zine(document.getElementById('book'), {
+new Zine(document.getElementById('book'), {
   source: new PdfSource('document.pdf'),
-});
-```
-
-Under a bundler that's all you need — the pdf.js worker is resolved for you.
-
-### CDN / no bundler
-
-Both packages ship **UMD** builds (`dist/index.umd.js`) that share the `ZineJS` global — load **core first**, then pdf (the pdf build uses `extend: true` so it merges into `ZineJS` instead of replacing it).
-
-Modern `pdfjs-dist` is ESM-only, so load it in a module script first, expose
-`globalThis.pdfjsLib`, then use classic deferred `<script>` tags for the UMD
-builds (and pass an explicit `workerSrc` — no bundler rewrites the worker URL):
-
-```html
-<script type="module">
-  import * as pdfjsLib from 'https://cdn.jsdelivr.net/npm/pdfjs-dist/build/pdf.min.mjs';
-  globalThis.pdfjsLib = pdfjsLib;
-</script>
-
-<script defer src="https://cdn.jsdelivr.net/npm/@zinejs/core/dist/index.umd.js"></script>
-<script defer src="https://cdn.jsdelivr.net/npm/@zinejs/pdf/dist/index.umd.js"></script>
-<script defer>
-  const book = new ZineJS.Zine(document.getElementById('book'), {
-    source: new ZineJS.PdfSource('document.pdf', {
-      workerSrc: 'https://cdn.jsdelivr.net/npm/pdfjs-dist/build/pdf.worker.min.mjs',
-    }),
-  });
-</script>
-```
-
-Image-only books can skip pdf.js and use a plain classic script:
-
-```html
-<script src="https://cdn.jsdelivr.net/npm/@zinejs/core/dist/index.umd.js"></script>
-<script>
-  new ZineJS.Zine(document.getElementById('book'), {
-    source: new ZineJS.ImageSource(['page-01.png', 'page-02.png']),
-  });
-</script>
+})
 ```
 
-`PdfSource` prefers `globalThis.pdfjsLib` when present (CDN), otherwise dynamic-imports `pdfjs-dist` (bundlers).
-
-## The pdf.js worker (`workerSrc`)
+Under a bundler that is all you need: the pdf.js worker is resolved for you.
 
-pdf.js parses and rasterizes in a Web Worker, a separate file the host must locate. By default `PdfSource` resolves it to (the `legacy/` path since `legacy` defaults to true; `build/` when `legacy: false`):
+`src` can also be raw bytes or a pdf.js document you already opened:
 
 ```js
-new URL('pdfjs-dist/legacy/build/pdf.worker.min.mjs', import.meta.url).href
+new PdfSource(arrayBuffer)
+new PdfSource(await getDocument(url).promise)
 ```
 
-Resolution precedence: an explicit `workerSrc` option → an already-set `pdfjsLib.GlobalWorkerOptions.workerSrc` → the auto-default above. You only pass `workerSrc` when the default can't apply.
+## The pdf.js worker
 
-### Vite / webpack 5 / esbuild
+pdf.js parses and rasterizes in a Web Worker. By default `PdfSource` finds the worker via Vite's
+`?url` import, webpack's `new URL('pdfjs-dist/…', import.meta.url)` emit, or the sibling
+`pdfjs-dist` install. If that cannot be resolved, it falls back to a jsDelivr URL pinned to the
+same `pdfjs-dist` version that loaded, and warns once in the console. Set `cdnFallback: false`
+for CSP-restricted or offline apps (then pass `workerSrc`, or the open fails clearly instead of
+loading a network worker that CSP would block).
 
-Nothing to do — these bundlers statically rewrite the `new URL(..., import.meta.url)` above and emit the worker asset:
+Resolution order: `workerSrc` option, then `pdfjsLib.GlobalWorkerOptions.workerSrc`, then that
+auto-default. Pass `workerSrc` for CDN / UMD, offline / CSP setups, or if auto-resolve fails in
+your bundler:
 
 ```js
-new PdfSource('document.pdf');
-```
-
-### Custom path
-
-Serving the worker yourself (copied to your public dir, etc.):
+import { PdfSource } from '@zinejs/pdf'
+import workerSrc from 'pdfjs-dist/legacy/build/pdf.worker.min.mjs?url'
 
-```js
-new PdfSource('document.pdf', { workerSrc: '/assets/pdf.worker.min.mjs' });
+new PdfSource('document.pdf', { workerSrc })
+// CSP / offline: also disable the CDN last resort
+new PdfSource('document.pdf', { workerSrc, cdnFallback: false })
 ```
 
-### Already configuring pdf.js yourself
-
-If your app sets `GlobalWorkerOptions.workerSrc`, `PdfSource` leaves it alone — no `workerSrc` needed.
+Keep the worker on the same build as the library (`legacy` vs modern). If you already set
+`GlobalWorkerOptions.workerSrc`, leave `workerSrc` off. A pre-created pdf.js document needs no
+worker from this package.
 
-## Passing bytes or a pre-created document
-
-```js
-new PdfSource(arrayBuffer);              // raw PDF bytes (ArrayBuffer | Uint8Array)
-new PdfSource(await getDocument(...).promise); // a pdf.js document you created; no workerSrc needed
-```
+CDN / no bundler: load pdf.js first, expose `globalThis.pdfjsLib`, then the UMD builds (core
+first). See the [HTML CDN example](https://zinejs.com/examples/html-cdn). A UMD host has no
+bundler to resolve the worker locally, so it uses your `workerSrc`, an already-set
+`GlobalWorkerOptions.workerSrc`, or the version-matched CDN fallback (matched to the global
+pdf.js's version; silent here, since a CSP/offline failure surfaces through the browser and pdf.js
+anyway). Set `cdnFallback: false` to require explicit configuration instead.
 
 ## Options
 
-```ts
+```js
 new PdfSource(src, {
-  workerSrc,          // string — override the auto-resolved worker URL (see above)
+  workerSrc,           // override the auto-resolved worker URL
+  cdnFallback: true,   // false: never load the worker from jsDelivr (CSP / offline)
   renderScale: 1,      // pages rasterize at renderScale × devicePixelRatio
-  preload: 1,          // adjacent pages to prefetch around a requested page
-  maxCacheBytes,       // soft cap on cached page bytes (default ~256 MB); LRU-evicts beyond it
-  progressive: true,   // paint a low-res page first, then swap to crisp (faster first paint)
-  disableAutoFetch: true, // fetch only the byte ranges visible pages need (range-capable servers)
-  legacy: true,        // load pdf.js's transpiled build (default); false serves the lean modern build
-});
+  preload: 1,          // adjacent pages to prefetch (default 1)
+  maxCacheBytes,       // soft cap on cached page bytes (default ~256 MB)
+  progressive: false,  // true: low-res first, then crisp
+  disableAutoFetch: false, // true: fetch only the ranges visible pages need
+  legacy: true,        // false: lean modern pdf.js (recent engines only)
+})
 ```
 
-`src` is a URL string, `ArrayBuffer`/`Uint8Array` of PDF bytes, or a pre-created pdf.js document.
+### Legacy vs modern (`legacy`)
 
-### Legacy vs modern build (`legacy`)
-
-pdf.js ships two builds. The `legacy` build is transpiled with polyfills and runs on both older and current browsers; the `modern` build is smaller and a touch faster but needs a recent engine. `PdfSource` defaults to `legacy: true`, favouring reach. Pass `legacy: false` to load the modern build when your audience is on current browsers:
+pdf.js ships two builds. The **legacy** build is transpiled with polyfills and is the default, so PDF books stay usable on older engines as well as current ones. The **modern** build is smaller and a touch faster. Pass `legacy: false` when your audience is on recent browsers:
 
 ```js
-new PdfSource('document.pdf', { legacy: false });
+new PdfSource('document.pdf', { legacy: false })
 ```
 
-The flag also picks the matching worker (`legacy/build/pdf.worker.min.mjs` vs `build/pdf.worker.min.mjs`) — the two must be a matched pair. It's ignored when you pass a pre-created document or set `globalThis.pdfjsLib`, since those already chose their build.
+The flag also picks the matching worker. It is ignored when you pass a pre-created document or set `globalThis.pdfjsLib`, since those already chose their build.
+
+Mozilla documents legacy as Chrome 125+, Firefox ESR, Safari 18+, and Chromium Edge. We have seen PDF text rasterize correctly back to Chrome 114. Full notes: [browser support](https://github.com/awecode/zinejs#browser-support).