@embedpdf/viewer-chrome 3.0.0-next.0

package/LICENSE

@@ -0,0 +1,215 @@
+REPOSITORY LICENSING NOTICE
+
+This repository contains code under more than one license.
+
+The Apache License 2.0 below applies only to the portions identified as
+Apache-2.0 in LICENSING.md. It does not apply to cloudpdf/server, which is
+licensed under the Fair Core License, FCL-1.0-ALv2. The authoritative terms
+for that component are in cloudpdf/server/LICENSE.
+
+Website content may have separate terms as described in LICENSING.md.
+
+This notice describes the scope of the licenses and does not modify the
+Apache License 2.0 text below.
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

package/README.md

@@ -0,0 +1,317 @@
+# @embedpdf/viewer-chrome
+
+The full viewer, as one React component. This package is the **single
+implementation** of the snippet UI — the measured toolbar, mode bands, panels,
+tab bar, theme — consumed by `@embedpdf/viewer` (the Preact-compiled
+`<embedpdf-viewer>` custom element) and every framework wrapper. It is private:
+apps install a delivery package, not the chrome.
+
+The customization surface below is **the** contract: the same object shape
+later powers `EmbedPDF.init({ ... })` and every wrapper's props, because all of
+it is plain data — nothing here is React-specific except the component itself.
+
+## Quickstart
+
+```tsx
+import { FullViewer } from '@embedpdf/viewer-chrome';
+import '@embedpdf/viewer-chrome/styles.css';
+import { localEngine } from '@embedpdf/engine';
+
+<FullViewer
+  engine={() => localEngine()}
+  initialDocuments={[{ name: 'Report', source: reportBytes }]}
+/>;
+```
+
+Everything renders at t≈0; only the pages wait on the wasm engine.
+
+## Customizing
+
+Two kinds of surface, two deliberate semantics:
+
+- **Registries** (`commands`, `icons`, `strings`) are **additive**: your
+  entries merge over the defaults by id; a colliding id overrides. Safe,
+  order-independent, upgrade-friendly.
+- **Structure** (`chrome`) is a **value you own**: take the default, transform
+  it, or write your own. It is never merged — there is no patch grammar to
+  learn, because the schema is small enough to read.
+
+### Remove features
+
+```tsx
+<FullViewer engine={engine} disabledCategories={['form', 'redaction']} />
+```
+
+A disabled category vanishes everywhere at once — toolbar, menus, overflow,
+shortcuts — because every surface is a projection of the same command registry.
+
+### Add a button
+
+The 90% case, end to end — one command, one icon, one string, one placement:
+
+```tsx
+<FullViewer
+  engine={engine}
+  icons={{
+    // 24×24 stroke path data — Tabler/Lucide icons paste in verbatim.
+    send: [
+      'M10 14L21 3',
+      'M21 3l-6.5 18a.5.5 0 0 1-1 0L10 14l-7-3.5a.5.5 0 0 1 0-1L21 3z',
+    ],
+  }}
+  strings={{
+    en: { 'acme.send': 'Send for signature' },
+    nl: { 'acme.send': 'Verstuur ter ondertekening' },
+  }}
+  commands={[
+    {
+      id: 'acme:send',
+      labelKey: 'acme.send',
+      icon: 'send',
+      shortcut: 'Mod+Shift+S',
+      enabled: (ctx) => ctx.documentId !== null,
+      run: (ctx) => {
+        void fetch(`/api/sign/${ctx.documentId}`, { method: 'POST' });
+      },
+    },
+  ]}
+  chrome={(base, h) =>
+    h.addItem(base, {
+      bar: 'main',
+      section: 'end',
+      group: 'panels',
+      item: 'acme:send',
+    })
+  }
+/>
+```
+
+That one registration is a button that degrades responsively (`importance` is
+the only responsive knob — there are no breakpoints to edit), drops into the
+derived overflow menu on narrow screens, has a working keyboard shortcut, and
+is localized. Referencing an unknown command or icon logs a dev-mode warning
+naming the exact id.
+
+`chrome` accepts the schema **value** or a **transform** of the default. The
+helpers come in as the second argument so simple edits need no imports:
+
+```tsx
+chrome={(base, h) =>
+  h.removeItems(
+    h.replaceItem(base, 'panel:comment', { command: 'acme:chat', importance: 5 }),
+    ['annotation:add-squiggly'],
+  )
+}
+```
+
+- `h.addItem(schema, { bar, section, group, item, at? })` — `bar` is a bar id
+  (`'main'`, a mode bar like `'annotate'`, or a strip); a new `group` id
+  creates that group at the end of the section.
+- `h.removeItems(schema, ids)` — purges the commands from every bar, mode bar,
+  strip, and menu; emptied groups disappear.
+- `h.replaceItem(schema, id, item)` — swaps a command in place, everywhere.
+- Plus the authoring sugar (`h.item`, `h.group`, `h.custom`, `h.defineChrome`)
+  for building bigger pieces inline.
+
+### Own the structure
+
+For real restructuring, don't patch — write the value. It is the complete
+structural definition of the viewer, and it is small:
+
+```tsx
+import {
+  FullViewer,
+  defineChrome,
+  group,
+  custom,
+  defaultChrome,
+} from '@embedpdf/viewer-chrome';
+
+// A minimal "reading room": zoom, search, download. Nothing else.
+const chrome = defineChrome({
+  bars: {
+    main: {
+      id: 'main',
+      sections: {
+        start: [
+          group('zoom', [
+            custom('zoom-controls', {
+              variants: ['inline', 'button'],
+              terminal: 'zoom:menu',
+            }),
+          ]),
+        ],
+        end: [group('actions', ['panel:search', 'document:download'])],
+      },
+    },
+  },
+  menus: { zoom: defaultChrome.menus.zoom },
+});
+
+<FullViewer engine={engine} chrome={chrome} />;
+```
+
+Adding an entry under `chrome.modeBars` adds a whole mode: the mode tab strip
+is derived from `modeBars` keys, so a custom review workflow is one command
+(the mode surface) plus one bar schema — not a special case.
+
+Your stability, your choice: pass no `chrome` and you track our default (new
+features appear on upgrade); own the value and your toolbar never moves — new
+EmbedPDF features arrive as new command ids you opt into by adding a line.
+
+### Locale
+
+```tsx
+<FullViewer engine={engine} locale="es" />        // fixed
+<FullViewer engine={engine} locale="auto" />      // negotiate from the browser (default)
+```
+
+`strings` may target any locale code, with dotted keys (`'acme.send'`)
+expanding into the pack. A code with no built-in pack becomes a new locale that
+falls back to English for everything you didn't provide.
+
+### Slots — your component inside the measured toolbar
+
+Reserve a socket in the chrome (`custom()` with a `terminal` command), then —
+through `<embedpdf-viewer>` or any wrapper — supply a child with the matching
+`slot` attribute:
+
+```tsx
+// @embedpdf/viewer-react
+<PDFViewer
+  src="/report.pdf"
+  commands={[{ id: 'acme:status', labelKey: 'acme.status', run: () => {} }]}
+  chrome={(base, h) =>
+    h.addItem(base, {
+      bar: 'main',
+      section: 'start',
+      group: 'workspace',
+      item: h.custom('doc-status', { terminal: 'acme:status' }),
+    })
+  }
+>
+  <DocStatus slot="doc-status" />
+</PDFViewer>
+```
+
+The child stays in YOUR world — light DOM, your framework's tree, your page
+CSS — while the browser projects it into the toolbar. The socket is measured
+live, so the solver budgets its true width; when it no longer fits, the
+`terminal` command represents it in the derived overflow menu. An unfilled
+socket displays its terminal command as native slot fallback, so the same
+chrome works with and without the child (and outside shadow DOM entirely —
+this package's own React consumers see the fallback).
+
+Slot names must be unique across the chrome (one `<slot name>` per shadow
+tree wins projection).
+
+### The frame — regions: arrangement, visibility, replacement
+
+Regions are a FIXED vocabulary (`header`, `tabs`, the toolbar band — each
+carries semantics the shell owns: measurement physics, the document gate,
+aria). Three independent knobs on each:
+
+```tsx
+// 1. ARRANGE + HIDE — part of the chrome value, because it is structure:
+chrome={(base) => ({
+  ...base,
+  frame: { toolbar: 'bottom', tabs: 'multiple', header: false },
+})}
+
+// 2. REPLACE — regions are sockets; the built-in is the slot fallback:
+<PDFViewer documents={docs} onReady={setViewer}>
+  <AcmeTabBar slot="tabs" viewer={viewer} />
+</PDFViewer>
+```
+
+`header` is the one region with **no** built-in: the viewer ships no brand
+row, locale picker or theme switch, because that chrome belongs to your app,
+not to the PDF. The socket is there so yours can sit inside the frame:
+
+```tsx
+<PDFViewer documents={docs}>
+  <AcmeHeader slot="header" />
+</PDFViewer>
+```
+
+Left unfilled it renders nothing, and `frame: { header: false }` drops the
+socket entirely. Theme and locale stay under your control as props —
+`theme={{ preference, tokens }}` and `locale` (`'auto'` negotiates from the
+browser) — so a switch in your own header is a state change on your side.
+
+A replacement region is fully functional through the handle — the kernel's
+document registry IS the tab model (`viewer.documents.list()/activeId()/
+setActive()/close()` + `viewer.watch`). A region hidden by the frame hides
+its socket too: visibility outranks slotted content. The mode band rides the
+main toolbar's content side (below a top bar, above a bottom bar).
+
+### Drive — control the viewer from code
+
+The handle (`el.viewer` on the custom element, `onReady` on the wrappers) is a
+thin skin over the kernel: `get(Token)` returns each plugin's **public
+capability lens** verbatim — the same documented API the chrome's own buttons
+use — plus ONE reactivity primitive and the command trio:
+
+```ts
+el.addEventListener('epdf:ready', () => {
+  const viewer = el.viewer;
+
+  viewer.execute('zoom:in'); // commands: UI verbs
+  const annotation = viewer.get(AnnotationToken); // capabilities: the API
+  await annotation.create(pon, draft);
+
+  viewer.watch(
+    // the one primitive
+    () => annotation.getSelectionProps(),
+    (props) => myPanel.render(props),
+  );
+  viewer.documents.list(); // the tab model
+});
+```
+
+Rule of thumb: **buttons speak commands; code speaks capabilities.** The
+token re-export list in `index.ts` is the public-API act — internal lenses
+(`/internal` entries) are structurally absent from delivery bundles. Coarse
+DOM events (`epdf:ready`, `epdf:documentchange`) are sugar over `watch`.
+
+### Theme — match your brand
+
+```tsx
+theme={{
+  preference: 'system',
+  tokens: { accent: '#7c3aed', 'accent-hover': '#6d28d9' },  // both modes
+  dark: { accent: '#a78bfa' },                               // dark overrides
+}}
+```
+
+Token names are the `--ep-*` variables in `styles.css` without the prefix —
+the prefix exists because custom properties inherit through shadow boundaries,
+so unprefixed names could collide with the host page. The custom element
+adopts the overrides into its shadow root; direct consumers of this package
+just set the `--ep-*` variables in their own CSS.
+
+### Restyle — reshape built-ins with page CSS
+
+Key elements carry shadow `part` attributes, so plain page CSS reaches them:
+
+```css
+embedpdf-viewer::part(toolbar-button) {
+  border-radius: 2px;
+}
+embedpdf-viewer::part(tab-active) {
+  font-weight: 700;
+}
+```
+
+The v1 part vocabulary — public API, grown by demand, never speculatively:
+`toolbar`, `toolbar-button(-active)`, `mode-tab(-active)`, `tab(-active)`,
+`menu`, `menu-item(-active)`.
+
+## What's deliberately NOT here (yet)
+
+- **The element registry** (`elements: { button: 'tag' }` + exported base
+  classes) — the last move of the six-move model.
+- **More regions & parts** — `header`/`tabs` sockets and the part list above
+  are the v1 vocabulary; grow by demand (names are public API).
+- **Radius/density/font tokens** — the token set is the color vocabulary
+  today; spacing/shape tokens need a component sweep and land separately.