@embedpdf/svelte 0.0.0-stage → 3.0.0-next.16

package/LICENSE

@@ -0,0 +1,192 @@
+Copyright 2026 CloudPDF LTD
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use files in this distribution except in compliance with the License.
+You may obtain a copy of the License at
+
+    https://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.
+
+-----------------------------------------------------------------------
+
+                                 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

package/README.md

@@ -1,3 +1,313 @@
-# Temporary Holding Version
+# @embedpdf/svelte
 
-This version is a temporary placeholder for this package. An operational version to replace this has been submitted for review and is awaiting a staged release.
+The Svelte 5 adapter for EmbedPDF: components that take snippets, and functions that give you
+reactive state for your runes. One entry point per feature, with the same names as
+`@embedpdf/react`:
+
+```ts
+import { DocumentGate, Viewer } from '@embedpdf/svelte/runtime';
+import {
+  Stage,
+  stagePlugin,
+  useStage,
+  useStageState,
+} from '@embedpdf/svelte/stage';
+import { RenderLayer, renderPlugin } from '@embedpdf/svelte/render';
+```
+
+The behavior is React's (`packages/framework/react`); the plugins' contracts are the API. This
+file explains how the adapter works and how to add a plugin's binding to it.
+
+## How it works
+
+### One signal for the kernel
+
+`<Viewer>` creates the kernel in the browser when it mounts, and puts a `KernelBinding` in
+context (`src/runtime/binding.svelte.ts`). The binding turns the kernel's one change stream into
+one Svelte signal: a version that moves on every change. Every reader reads that version inside a
+`$derived`, computes its value again after a change, and passes it on only when it differs. The
+binding subscribes for the kernel's whole life, so a reader gives the current value in a template,
+an effect, a `$derived` or an event handler alike.
+
+### Two shapes of reader
+
+- **A record of named values** (a plugin's state, its settings, the document, scroll metrics) is a
+  reactive object whose fields are getters: `state.zoomLevel`. Each field is its own `$derived`,
+  so a template or an effect that reads `zoomLevel` runs again only when `zoomLevel` changes.
+  Destructuring (`const { zoomLevel } = state`) reads once, like any Svelte reactive object.
+- **One value** is `{ current }`, like Svelte's `MediaQuery`: `pages.current`. A state or settings
+  reader called with a selector is one too: `useStageState((state) => state.zoomLevel).current`.
+
+### Capability handles
+
+`use<Plugin>()` (`useStage()`, `useDocuments()`) returns a handle (`src/runtime/capability-handle.ts`)
+that is always the capability of the document in scope: a component calls it once, and the handle
+resolves the capability again on every call, so a new active document or a changed
+`<DocumentScope id>` needs nothing from you. Without a ready document a document plugin's calls
+reach its stand-in (`standInFor` from `@embedpdf/core`) and refuse with
+`PluginError('not-ready')`: a method that returns a promise (`form.setValue`, `redaction.markPage`)
+returns a rejected promise, so `.catch()` sees it, and every other method throws. Its settings
+calls still work.
+
+**The read rule, the same in every adapter:** a method named `get*`, `list*`, `is*`, `has*` or
+`can*` (the capability vocabulary's reads, see `docs/conventions/naming.md`) is a read: called in
+a template, a `$derived` or an `$effect`, it updates when its answer changes:
+`disabled={!stage.canGoNext()}`. Every other method (a verb, an event) tracks nothing, so an effect
+that calls `thumbs.reveal(state.currentPageIndex)` runs again only when the index changes. A
+synchronous read outside that vocabulary (`redaction.estimateCollateral()`) doesn't update a
+template by itself.
+
+### Contexts
+
+| Context                            | Provided by                       | Read by                                             |
+| ---------------------------------- | --------------------------------- | --------------------------------------------------- |
+| The kernel binding                 | `<Viewer>`                        | every reader (`useKernelBinding()`)                 |
+| The document scope                 | `<DocumentScope id>`              | every reader (`documentScopeOf()`)                  |
+| The stage lens                     | `<Stage>`, `<StageScope token>`   | the stage readers, `<Scrollbar>` (`stageTokenOf()`) |
+| The page                           | each `<Stage>` page, `<PageView>` | layers (`usePage()`)                                |
+| The projection and the pages shown | `<Stage>`, `<PageView>`           | `<Anchored>` (`src/anchored/context.ts`)            |
+
+Contexts hold functions or live objects, never plain values, so a prop that changes (`id`,
+`token`) reaches the readers. `usePage()` gives an object that reads the current page context on
+every access: `page.transform` in a template follows the zoom.
+
+## Adding a plugin binding
+
+Take the search plugin as the example. Everything below lives in this package.
+
+### 1. The entry point
+
+`src/search.ts` re-exports the plugin (registration travels with the UI), then the components and
+readers:
+
+```ts
+/** @embedpdf/svelte/search — … */
+export * from '@embedpdf/plugin-search';
+
+export { default as SearchLayer } from './search/SearchLayer.svelte';
+export type { SearchLayerProps } from './search/props';
+export {
+  useSearch,
+  useSearchEvent,
+  useSearchHits,
+  useSearchSettings,
+  useSearchState,
+} from './search/readers.svelte';
+```
+
+Add it to `package.json` twice, in the same shape as the others: `exports["./search"]` with
+`types`, `svelte` and `default` pointing at `./src/search.ts`, and `publishConfig.exports["./search"]`
+pointing at `./dist/search.d.ts` / `./dist/search.js`. Add `export * from './search'` to
+`src/index.ts`. Files with runes end in `.svelte.ts`; the entry itself only re-exports, so it's
+plain `.ts`.
+
+### 2. The readers (`src/search/readers.svelte.ts`)
+
+```ts
+import type { EventHook, PageRef } from '@embedpdf/core';
+import { SearchToken, searchState } from '@embedpdf/plugin-search';
+import type { SearchCapability, SearchHit } from '@embedpdf/plugin-search';
+import {
+  useCapability,
+  useCapabilityEvent,
+  useOptionalSelector,
+} from '../runtime/readers.svelte';
+import { settingsReader, stateReader } from '../runtime/state.svelte';
+import {
+  valueOf,
+  type CurrentValue,
+  type MaybeGetter,
+} from '../runtime/values.svelte';
+
+/** The API: a handle, always the capability of the document in scope. */
+export function useSearch(): SearchCapability {
+  return useCapability(SearchToken);
+}
+
+/** The state: one line, from the plugin's `defineState` declaration. */
+export const useSearchState = stateReader(searchState);
+
+/** The settings: one line, from the token. */
+export const useSearchSettings = settingsReader(SearchToken);
+
+/** Events, cleaned up when the component goes away, subscribed again when the document changes. */
+export function useSearchEvent<T>(
+  select: (search: SearchCapability) => EventHook<T>,
+  handler: (event: T) => void,
+): void {
+  useCapabilityEvent(SearchToken, select, handler);
+}
+
+const NO_HITS: readonly SearchHit[] = Object.freeze([]);
+
+/** One value is `{ current }`. An argument that changes is a function (`() => page`). */
+export function useSearchHits(
+  page?: MaybeGetter<PageRef | number | undefined>,
+): CurrentValue<readonly SearchHit[]> {
+  return useOptionalSelector(
+    SearchToken,
+    (search) => {
+      const only = valueOf(page);
+      return search.listHits(only === undefined ? undefined : { page: only });
+    },
+    NO_HITS,
+  );
+}
+```
+
+- Use `useOptionalSelector` (a fallback without a document) for chrome that renders before a
+  document opens; `useSelector` throws the kernel's reason instead, like React's.
+- A selector that builds a fresh object or array each time passes an `isEqual`
+  (`shallowEqual`, `shallowArray`), so readers wake only when something changed.
+- A plugin without a state declaration builds the record itself: `declaredState(binding, token,
+read, empty)` and `readRecord(whole, keys)` from `../runtime/state.svelte` (see
+  `useStageSettings` in `src/stage/readers.svelte.ts`).
+- Readers are called while a component is created, like every `use…()` function.
+
+### 3. A component (`src/search/SearchLayer.svelte`, `src/search/props.ts`)
+
+The props interface goes in a `.ts` file, so the entry can export it. Map React's props this way:
+
+| React                             | Svelte                                                                                                                                                                      |
+| --------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| `onHitClick`                      | `onHitClick`, a callback prop (`onHitClick?.(hit)`)                                                                                                                         |
+| `renderLink={(link) => …}`        | a snippet named without `render`: `link?: Snippet<[link: LinkInfo]>`, `{@render link?.(info)}`                                                                              |
+| `children`                        | `children?: Snippet`                                                                                                                                                        |
+| a page function (`{(page) => …}`) | `children: Snippet<[page: PageContextValue]>`, rendered per page: the content between the tags, or `{#snippet children(page)}` when it needs the page (`<Stage>` does this) |
+| `zoom` + `onZoomChange`           | `zoom = $bindable()`, for `bind:zoom`                                                                                                                                       |
+| `className`, `style={{ … }}`      | `class`, `style` (a string), appended after the component's own                                                                                                             |
+
+Snippet arguments stay live: pass the current value, and the snippet updates with it. A
+component whose content is a per-page template takes it as `children`, not as a snippet named
+`page`: in Svelte snippets and props share one namespace, and `page` is the two-way current page
+(`bind:page`), as on Vue (`v-model:page`) and Angular (`[(page)]`). Content written straight
+between the tags is a `children` snippet with no parameter; it can still be rendered with the
+page as its argument.
+
+### 4. A layer on each page
+
+A layer reads the page it draws on with `usePage()`, and the plugin through an optional reader
+(nothing without a document, so the layer just draws nothing). A plugin with a host lens
+(`@embedpdf/plugin-x/contract/host`) is read with that token, as `<RenderLayer>` does:
+
+```svelte
+<script lang="ts">
+  import { SearchToken } from '@embedpdf/plugin-search';
+  import { usePage } from '../runtime/page';
+  import { useOptionalSelector } from '../runtime/readers.svelte';
+
+  const page = usePage();
+  const hits = useOptionalSelector(
+    SearchToken,
+    (search) => search.listHits({ page: page.ref }),
+    [],
+  );
+</script>
+
+{#each hits.current as hit (hit.start)}
+  {#each hit.segments as segment, index (index)}
+    {@const box = page.transform.pageToViewRect(segment.rect)}
+    <div
+      style:position="absolute"
+      style:left="{box.x}px"
+      style:top="{box.y}px"
+      style:width="{box.width}px"
+      style:height="{box.height}px"
+    ></div>
+  {/each}
+{/each}
+```
+
+- Positions come from `page.transform`; never multiply by the zoom or the pixel ratio.
+- DOM work (listeners, observers, `bindPaintedImage`) goes in a `$effect` that returns its cleanup.
+  Read what should re-run the effect at its top, and do the work in `untrack`.
+- A handler that must stop an event before the Stage sees it is a native listener, in an effect:
+  Svelte 5 delegates `onpointerdown`, `onclick`, `onpointermove` and the other bubbling events to
+  the root, so a `stopPropagation()` there runs after the Stage's own listener. For a press, use
+  `isolatePointerDown(element, onPress)` from `@embedpdf/web` (as `<Anchored>` does); for the
+  wheel, `isolateWheel`.
+- A layer that paints a part of the page itself (the annotations, the form fields) says so with
+  `usePaintsPagePart` (`src/runtime/page-layers.svelte.ts`), and `<RenderLayer>` leaves that part
+  out of the page's picture.
+- Shared, framework-free browser code belongs in `@embedpdf/web`; if what you need isn't there,
+  write it small, here, and say so (it's a candidate to move).
+
+### 5. Tests (`test/<feature>/*.test.ts`)
+
+Port React's binding tests (not the plugin's). The fixtures in `test/fixtures/`:
+
+- `viewerWith(plugins, Component, props, engine?)` mounts a `<Viewer>` around a component and
+  returns its kernel once mounted; `counter-plugin.ts` has a document plugin, a fake engine that
+  opens any document at once (`pagedEngine(n)` for `n` pages), and `bytesInput(id)`.
+- `Probes.svelte` takes `{ read, pick, seen, scope? }` entries: it calls `read()` while created
+  and pushes `pick(result)` on every change, so `seen.length` counts updates the way React's
+  tests count renders.
+- After a kernel call, `flushSync()` from `svelte` runs the effects before you assert.
+
+```ts
+it('wakes only when the hit count changes', async () => {
+  const count = {
+    read: () => useSearchState(),
+    pick: (state) => state.hitCount,
+    seen: [],
+  };
+  const { kernel } = await viewerWith([searchPlugin()], Probes, {
+    probes: [count],
+  });
+  await kernel.documents.open(bytesInput('a'));
+  flushSync();
+  expect(latest(count.seen)).toBe(0);
+});
+```
+
+A component that needs snippets gets a small harness component in `test/fixtures/`, written in
+Svelte (see `StageHarness.svelte`, `GateHarness.svelte`).
+
+The tests compile with `svelte/compiler` through `test/helpers/svelte-compile.ts`: Vitest here runs
+on Vite 5, and `@sveltejs/vite-plugin-svelte` needs Vite 6.
+
+### 6. Checks
+
+```sh
+pnpm --filter @embedpdf/svelte test
+pnpm --filter @embedpdf/svelte typecheck      # svelte-check over src and test
+pnpm --filter @embedpdf/svelte build          # svelte-package into dist, then the publish check
+pnpm --filter @embedpdf/docs-content snippets
+pnpm --filter @embedpdf/docs-content samples <area>
+```
+
+Nothing in the workspace reads `dist`, so the build ends by proving it.
+`tooling/build/src/fully-specify-imports.mjs` gives every relative import in `dist` its file
+(`./readers.svelte.js`, which Node, webpack and TypeScript's `node16` need; svelte-package keeps
+the source's extensionless imports). `tooling/build/src/check-framework-package.mjs` then packs
+the package, runs publint and attw on the tarball, and type-checks the app in `consumer/` against
+it with `svelte-check`: the lines in `consumer/Canary.svelte` marked `error expected` must fail,
+and nothing else may. A failure there is what a user would get from npm.
+
+## Good to know
+
+- **A local named `state` turns off `$state`** in that component: Svelte reads `$state` as the
+  store `state`. Name the reader's object something else (`stageState`) when the component also
+  uses `$state`.
+- **A changing `style={string}` rewrites the element's whole inline style**, dropping what code set
+  on it (the rich-text editor's `line-height`). Use `style:` directives on elements that code also
+  styles, or set the property again after each change, as `useRichTextEditor` does.
+- **A read in an effect subscribes.** `$effect(() => remember(stage.getViewpoint()))` runs on every
+  kernel change; for a one-off read use `onMount` or `untrack`.
+- **The engine and the plugins are read once.** Put them in `<script module>` (or a module), like
+  React's module scope; `<Viewer>` warns when they change.
+- **A snippet can't draw "nothing, use the default".** A React render prop that returns
+  `undefined` falls back to the default part; a snippet that is passed always draws. So a snippet
+  that serves many parts draws all of them: the toolbar's `custom` draws every custom item (one it
+  draws nothing for shows nothing, not its command), and the default (a native `<slot>` socket
+  with the item's command inside) is for when no `custom` snippet is passed.
+- **An argument that is an element is a function** (`useCommandShortcuts({ target: () => area })`
+  with `bind:this={area}`): the element is set after the component is created, and the reader
+  binds once it's there.
+- **A part handed to a snippet is a snippet declared in the `{#each}`** (`<LinkLayer>`'s
+  `native`, passed to its `link` snippet as `{ link, native }`): declared inside the block, it
+  closes over the item, and the app draws it with `{@render native()}`.
+- **A layer that only listens doesn't need native listeners.** `<SearchLayer>`'s
+  `onpointerdown`/`onclick` stop nothing, so Svelte's delegation is fine there; only a press that
+  must not reach the Stage (a link, a selection handle) goes through `isolatePointerDown` or
+  `attachSelectionHandle`.

package/dist/actions/readers.svelte.d.ts

@@ -0,0 +1,29 @@
+import type { EventHook } from '@embedpdf/core';
+import type { ActionsCapability, ActionUiAdapter } from '@embedpdf/plugin-actions';
+import { type MaybeGetter } from '../runtime/values.svelte.js';
+/**
+ * The actions API (`execute`, `executeNamed`, `dispatch`, the settings) of the nearest
+ * `<DocumentScope>`'s document, else the active one. Outside a ready document the settings calls
+ * work and every other method throws `not-ready`.
+ */
+export declare function useActions(): ActionsCapability;
+/** The actions settings (`policy`, `triggers`, `openSequence`, `javascript`), with or without a document. Takes a selector. */
+export declare const useActionsSettings: import("../index.js").SettingsReader<import("@embedpdf/plugin-actions").ActionsSettings & object>;
+/** Subscribe to one actions event while the component lives: `useActionsEvent((actions) => actions.onExecuted, handler)`. */
+export declare function useActionsEvent<T>(select: (actions: ActionsCapability) => EventHook<T>, handler: (event: T) => void): void;
+/** Your own handlers for any of the adapter's effects: `openUri`, `print`, `alert`, `gotoPage`. */
+export type ActionsUiHandlers = Partial<ActionUiAdapter>;
+/**
+ * Install the UI adapter for the action dispatcher of the document in scope, for as long as the
+ * component lives. The defaults (which effects may show themselves for which start, websites
+ * opened through `sanitizeExternalUri`, the browser's print dialog and alert) are
+ * `@embedpdf/web`'s `createDefaultActionsUiAdapter`, written once for every framework; this is
+ * the Svelte glue.
+ *
+ * `handlers` replace any of the defaults. They are read each time an action needs them, so a
+ * handler that reads `$state` sees its current value, and handlers passed as a function
+ * (`() => handlers`) can be swapped without installing the adapter again. The adapter is
+ * installed again only when the document or its Stage changes. The `doc.print` permission is
+ * checked by the plugin, before any handler runs.
+ */
+export declare function useActionsUiAdapter(handlers?: MaybeGetter<ActionsUiHandlers | undefined>): void;

package/dist/actions/readers.svelte.js

@@ -0,0 +1,55 @@
+/**
+ * The actions' readers: the API, the settings, the events, and the UI adapter a component
+ * installs for as long as it lives.
+ */
+import { untrack } from 'svelte';
+import { ActionsToken } from '@embedpdf/plugin-actions';
+import { StageToken } from '@embedpdf/plugin-stage/contract';
+import { createDefaultActionsUiAdapter } from '@embedpdf/web';
+import { useCapability, useCapabilityEvent, useOptionalCapability, } from '../runtime/readers.svelte.js';
+import { settingsReader } from '../runtime/state.svelte.js';
+import { valueOf } from '../runtime/values.svelte.js';
+/**
+ * The actions API (`execute`, `executeNamed`, `dispatch`, the settings) of the nearest
+ * `<DocumentScope>`'s document, else the active one. Outside a ready document the settings calls
+ * work and every other method throws `not-ready`.
+ */
+export function useActions() {
+    return useCapability(ActionsToken);
+}
+/** The actions settings (`policy`, `triggers`, `openSequence`, `javascript`), with or without a document. Takes a selector. */
+export const useActionsSettings = settingsReader(ActionsToken);
+/** Subscribe to one actions event while the component lives: `useActionsEvent((actions) => actions.onExecuted, handler)`. */
+export function useActionsEvent(select, handler) {
+    useCapabilityEvent(ActionsToken, select, handler);
+}
+/**
+ * Install the UI adapter for the action dispatcher of the document in scope, for as long as the
+ * component lives. The defaults (which effects may show themselves for which start, websites
+ * opened through `sanitizeExternalUri`, the browser's print dialog and alert) are
+ * `@embedpdf/web`'s `createDefaultActionsUiAdapter`, written once for every framework; this is
+ * the Svelte glue.
+ *
+ * `handlers` replace any of the defaults. They are read each time an action needs them, so a
+ * handler that reads `$state` sees its current value, and handlers passed as a function
+ * (`() => handlers`) can be swapped without installing the adapter again. The adapter is
+ * installed again only when the document or its Stage changes. The `doc.print` permission is
+ * checked by the plugin, before any handler runs.
+ */
+export function useActionsUiAdapter(handlers) {
+    const actions = useOptionalCapability(ActionsToken);
+    const stage = useOptionalCapability(StageToken);
+    $effect(() => {
+        const current = actions.current;
+        const view = stage.current;
+        if (!current)
+            return;
+        return untrack(() => {
+            const adapter = createDefaultActionsUiAdapter({
+                overrides: () => valueOf(handlers),
+                goToPage: (page) => view?.goToPage(page),
+            });
+            return current.setUiAdapter(adapter);
+        });
+    });
+}

package/dist/actions.d.ts

@@ -0,0 +1,13 @@
+/**
+ * @embedpdf/svelte/actions — the action engine's UI port.
+ *
+ * The plugin has no DOM: opening a website, printing and showing an alert are this layer's job.
+ * `useActionsUiAdapter()` installs the browser's defaults (the same sanitizer and `window.open`
+ * the link layer uses; print is the browser's dialog), and you can replace any of them. Without
+ * it, actions routed to the adapter (a website, a print) report a `no-adapter` diagnostic instead
+ * of running. The other readers are the plugin's: `useActions()` (the API),
+ * `useActionsSettings()` and `useActionsEvent()`.
+ */
+export * from '@embedpdf/plugin-actions';
+export { useActions, useActionsEvent, useActionsSettings, useActionsUiAdapter, } from './actions/readers.svelte.js';
+export type { ActionsUiHandlers } from './actions/readers.svelte.js';

package/dist/actions.js

@@ -0,0 +1,13 @@
+/**
+ * @embedpdf/svelte/actions — the action engine's UI port.
+ *
+ * The plugin has no DOM: opening a website, printing and showing an alert are this layer's job.
+ * `useActionsUiAdapter()` installs the browser's defaults (the same sanitizer and `window.open`
+ * the link layer uses; print is the browser's dialog), and you can replace any of them. Without
+ * it, actions routed to the adapter (a website, a print) report a `no-adapter` diagnostic instead
+ * of running. The other readers are the plugin's: `useActions()` (the API),
+ * `useActionsSettings()` and `useActionsEvent()`.
+ */
+// Registration travels with the UI.
+export * from '@embedpdf/plugin-actions';
+export { useActions, useActionsEvent, useActionsSettings, useActionsUiAdapter, } from './actions/readers.svelte.js';

package/dist/anchored/Anchored.svelte

@@ -0,0 +1,24 @@
+<!--
+  Places its content around a page-space anchor, on whichever page surface it's in: next to a
+  selection, an annotation, a search match. Once the content's size is measured, it flips to the
+  other side when the chosen one has no room and stays inside the view, unless `pinned`.
+
+  On a page that isn't shown it renders nothing and reads only the pages on screen, so a
+  document with hundreds of badges costs only the ones in view while people scroll and zoom.
+-->
+<script lang="ts">
+  import { useShownPages } from './context.js';
+  import PlacedAnchored from './PlacedAnchored.svelte';
+  import type { AnchoredProps } from './props.js';
+
+  let { anchor, placement, gap, pinned, children }: AnchoredProps = $props();
+
+  const shownPages = useShownPages();
+  const visible = $derived(
+    !!anchor?.bounds && (!shownPages || shownPages().has(anchor.page.objectNumber)),
+  );
+</script>
+
+{#if visible}
+  <PlacedAnchored {anchor} {placement} {gap} {pinned} {children} />
+{/if}

package/dist/anchored/Anchored.svelte.d.ts

@@ -0,0 +1,4 @@
+import type { AnchoredProps } from './props.js';
+declare const Anchored: import("svelte").Component<AnchoredProps, {}, "">;
+type Anchored = ReturnType<typeof Anchored>;
+export default Anchored;