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

package/dist/runtime/DocumentGate.vue.d.cts

@@ -0,0 +1,24 @@
+import type { FailedDocumentInfo, LockedDocumentInfo } from '@embedpdf/core';
+type __VLS_Slots = {
+    /** Rendered while the document is ready. */
+    default?(): unknown;
+    /** Shown while this subtree has no document: none is open, or it's still opening. */
+    fallback?(): unknown;
+    /** Shown while the document waits for its password; `#fallback` without it. */
+    locked?(props: {
+        document: LockedDocumentInfo;
+    }): unknown;
+    /** Shown when the document couldn't be opened, with why; `#fallback` without it. */
+    error?(props: {
+        document: FailedDocumentInfo;
+    }): unknown;
+};
+declare const __VLS_base: import("vue").DefineComponent<{}, {}, {}, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").PublicProps, Readonly<{}> & Readonly<{}>, {}, {}, {}, {}, string, import("vue").ComponentProvideOptions, true, {}, any>;
+declare const __VLS_export: __VLS_WithSlots<typeof __VLS_base, __VLS_Slots>;
+declare const _default: typeof __VLS_export;
+export default _default;
+type __VLS_WithSlots<T, S> = T & {
+    new (): {
+        $slots: S;
+    };
+};

package/dist/runtime/DocumentGate.vue.d.ts

@@ -0,0 +1,24 @@
+import type { FailedDocumentInfo, LockedDocumentInfo } from '@embedpdf/core';
+type __VLS_Slots = {
+    /** Rendered while the document is ready. */
+    default?(): unknown;
+    /** Shown while this subtree has no document: none is open, or it's still opening. */
+    fallback?(): unknown;
+    /** Shown while the document waits for its password; `#fallback` without it. */
+    locked?(props: {
+        document: LockedDocumentInfo;
+    }): unknown;
+    /** Shown when the document couldn't be opened, with why; `#fallback` without it. */
+    error?(props: {
+        document: FailedDocumentInfo;
+    }): unknown;
+};
+declare const __VLS_base: import("vue").DefineComponent<{}, {}, {}, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").PublicProps, Readonly<{}> & Readonly<{}>, {}, {}, {}, {}, string, import("vue").ComponentProvideOptions, true, {}, any>;
+declare const __VLS_export: __VLS_WithSlots<typeof __VLS_base, __VLS_Slots>;
+declare const _default: typeof __VLS_export;
+export default _default;
+type __VLS_WithSlots<T, S> = T & {
+    new (): {
+        $slots: S;
+    };
+};

package/dist/runtime/DocumentScope.vue.d.cts

@@ -0,0 +1,16 @@
+type __VLS_Props = {
+    /** The document's id. */
+    id: string;
+};
+type __VLS_Slots = {
+    default?(): unknown;
+};
+declare const __VLS_base: import("vue").DefineComponent<__VLS_Props, {}, {}, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").PublicProps, Readonly<__VLS_Props> & Readonly<{}>, {}, {}, {}, {}, string, import("vue").ComponentProvideOptions, false, {}, any>;
+declare const __VLS_export: __VLS_WithSlots<typeof __VLS_base, __VLS_Slots>;
+declare const _default: typeof __VLS_export;
+export default _default;
+type __VLS_WithSlots<T, S> = T & {
+    new (): {
+        $slots: S;
+    };
+};

package/dist/runtime/DocumentScope.vue.d.ts

@@ -0,0 +1,16 @@
+type __VLS_Props = {
+    /** The document's id. */
+    id: string;
+};
+type __VLS_Slots = {
+    default?(): unknown;
+};
+declare const __VLS_base: import("vue").DefineComponent<__VLS_Props, {}, {}, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").PublicProps, Readonly<__VLS_Props> & Readonly<{}>, {}, {}, {}, {}, string, import("vue").ComponentProvideOptions, false, {}, any>;
+declare const __VLS_export: __VLS_WithSlots<typeof __VLS_base, __VLS_Slots>;
+declare const _default: typeof __VLS_export;
+export default _default;
+type __VLS_WithSlots<T, S> = T & {
+    new (): {
+        $slots: S;
+    };
+};

package/dist/runtime/KernelProvider.vue.d.cts

@@ -0,0 +1,17 @@
+import type { Kernel } from '@embedpdf/core';
+type __VLS_Props = {
+    /** The kernel, created and started by its owner. Read once. */
+    kernel: Kernel;
+};
+type __VLS_Slots = {
+    default?(): unknown;
+};
+declare const __VLS_base: import("vue").DefineComponent<__VLS_Props, {}, {}, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").PublicProps, Readonly<__VLS_Props> & Readonly<{}>, {}, {}, {}, {}, string, import("vue").ComponentProvideOptions, false, {}, any>;
+declare const __VLS_export: __VLS_WithSlots<typeof __VLS_base, __VLS_Slots>;
+declare const _default: typeof __VLS_export;
+export default _default;
+type __VLS_WithSlots<T, S> = T & {
+    new (): {
+        $slots: S;
+    };
+};

package/dist/runtime/KernelProvider.vue.d.ts

@@ -0,0 +1,17 @@
+import type { Kernel } from '@embedpdf/core';
+type __VLS_Props = {
+    /** The kernel, created and started by its owner. Read once. */
+    kernel: Kernel;
+};
+type __VLS_Slots = {
+    default?(): unknown;
+};
+declare const __VLS_base: import("vue").DefineComponent<__VLS_Props, {}, {}, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").PublicProps, Readonly<__VLS_Props> & Readonly<{}>, {}, {}, {}, {}, string, import("vue").ComponentProvideOptions, false, {}, any>;
+declare const __VLS_export: __VLS_WithSlots<typeof __VLS_base, __VLS_Slots>;
+declare const _default: typeof __VLS_export;
+export default _default;
+type __VLS_WithSlots<T, S> = T & {
+    new (): {
+        $slots: S;
+    };
+};

package/dist/runtime/SvgShapes.vue.d.cts

@@ -0,0 +1,7 @@
+import { type SvgShape } from '@embedpdf/web';
+type __VLS_Props = {
+    shapes: readonly SvgShape[];
+};
+declare const __VLS_export: import("vue").DefineComponent<__VLS_Props, {}, {}, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").PublicProps, Readonly<__VLS_Props> & Readonly<{}>, {}, {}, {}, {}, string, import("vue").ComponentProvideOptions, false, {}, any>;
+declare const _default: typeof __VLS_export;
+export default _default;

package/dist/runtime/SvgShapes.vue.d.ts

@@ -0,0 +1,7 @@
+import { type SvgShape } from '@embedpdf/web';
+type __VLS_Props = {
+    shapes: readonly SvgShape[];
+};
+declare const __VLS_export: import("vue").DefineComponent<__VLS_Props, {}, {}, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").PublicProps, Readonly<__VLS_Props> & Readonly<{}>, {}, {}, {}, {}, string, import("vue").ComponentProvideOptions, false, {}, any>;
+declare const _default: typeof __VLS_export;
+export default _default;

package/dist/runtime/Viewer.vue.d.cts

@@ -0,0 +1,57 @@
+import type { AnyPlugin, Engine, EngineFactory, Identity, InitialDocument, Kernel, ViewerPageSettings } from '@embedpdf/core';
+type __VLS_Props = {
+    /**
+     * The engine, as an instance or a function. An instance is borrowed: the
+     * viewer uses it and never destroys it (a module-level `localEngine()`
+     * shared by every viewer). A function is the viewer's own: it calls it when
+     * it mounts and destroys the engine when it unmounts. Read once.
+     */
+    engine: Engine | EngineFactory;
+    /** The plugins, created once next to the engine. Read once. */
+    plugins: AnyPlugin[];
+    /** Documents to open when the viewer starts, with optional tab names. Read once. */
+    initialDocuments?: InitialDocument[];
+    /**
+     * Who the user is, for every document opened without an `identity` of its
+     * own (which replaces this one). Documents opened after a change use the new
+     * value; open ones keep theirs. The local engine only: the cloud engine reads
+     * it from the document's token.
+     */
+    identity?: Identity;
+    /**
+     * What the user may do, as permissions, in every document opened without a
+     * `scope` of its own. Left out, they may do everything. Changes reach the
+     * documents opened after them, as `identity`.
+     */
+    scope?: readonly string[];
+    /** The color every part without a color of its own follows. CSS `--epdf-accent` wins over it. */
+    accent?: string;
+    /** How pages look: `background` before the picture arrives, and the `shadow` under each page. */
+    page?: Partial<ViewerPageSettings>;
+};
+type __VLS_Slots = {
+    /** The viewer's content, mounted once the kernel has started. */
+    default?(): unknown;
+    /** Shown while the kernel starts; the composables already work in it. */
+    fallback?(): unknown;
+    /** Shown when the kernel couldn't be created or started. Without it, a failed start shows nothing. */
+    error?(props: {
+        error: unknown;
+    }): unknown;
+};
+declare const __VLS_base: import("vue").DefineComponent<__VLS_Props, {
+    /** The started kernel; null before it starts and after a failed start. */
+    kernel: import("vue").ComputedRef<Kernel | null>;
+}, {}, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {
+    ready: (kernel: Kernel) => any;
+}, string, import("vue").PublicProps, Readonly<__VLS_Props> & Readonly<{
+    onReady?: ((kernel: Kernel) => any) | undefined;
+}>, {}, {}, {}, {}, string, import("vue").ComponentProvideOptions, false, {}, any>;
+declare const __VLS_export: __VLS_WithSlots<typeof __VLS_base, __VLS_Slots>;
+declare const _default: typeof __VLS_export;
+export default _default;
+type __VLS_WithSlots<T, S> = T & {
+    new (): {
+        $slots: S;
+    };
+};

package/dist/runtime/Viewer.vue.d.ts

@@ -0,0 +1,57 @@
+import type { AnyPlugin, Engine, EngineFactory, Identity, InitialDocument, Kernel, ViewerPageSettings } from '@embedpdf/core';
+type __VLS_Props = {
+    /**
+     * The engine, as an instance or a function. An instance is borrowed: the
+     * viewer uses it and never destroys it (a module-level `localEngine()`
+     * shared by every viewer). A function is the viewer's own: it calls it when
+     * it mounts and destroys the engine when it unmounts. Read once.
+     */
+    engine: Engine | EngineFactory;
+    /** The plugins, created once next to the engine. Read once. */
+    plugins: AnyPlugin[];
+    /** Documents to open when the viewer starts, with optional tab names. Read once. */
+    initialDocuments?: InitialDocument[];
+    /**
+     * Who the user is, for every document opened without an `identity` of its
+     * own (which replaces this one). Documents opened after a change use the new
+     * value; open ones keep theirs. The local engine only: the cloud engine reads
+     * it from the document's token.
+     */
+    identity?: Identity;
+    /**
+     * What the user may do, as permissions, in every document opened without a
+     * `scope` of its own. Left out, they may do everything. Changes reach the
+     * documents opened after them, as `identity`.
+     */
+    scope?: readonly string[];
+    /** The color every part without a color of its own follows. CSS `--epdf-accent` wins over it. */
+    accent?: string;
+    /** How pages look: `background` before the picture arrives, and the `shadow` under each page. */
+    page?: Partial<ViewerPageSettings>;
+};
+type __VLS_Slots = {
+    /** The viewer's content, mounted once the kernel has started. */
+    default?(): unknown;
+    /** Shown while the kernel starts; the composables already work in it. */
+    fallback?(): unknown;
+    /** Shown when the kernel couldn't be created or started. Without it, a failed start shows nothing. */
+    error?(props: {
+        error: unknown;
+    }): unknown;
+};
+declare const __VLS_base: import("vue").DefineComponent<__VLS_Props, {
+    /** The started kernel; null before it starts and after a failed start. */
+    kernel: import("vue").ComputedRef<Kernel | null>;
+}, {}, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {
+    ready: (kernel: Kernel) => any;
+}, string, import("vue").PublicProps, Readonly<__VLS_Props> & Readonly<{
+    onReady?: ((kernel: Kernel) => any) | undefined;
+}>, {}, {}, {}, {}, string, import("vue").ComponentProvideOptions, false, {}, any>;
+declare const __VLS_export: __VLS_WithSlots<typeof __VLS_base, __VLS_Slots>;
+declare const _default: typeof __VLS_export;
+export default _default;
+type __VLS_WithSlots<T, S> = T & {
+    new (): {
+        $slots: S;
+    };
+};

package/dist/runtime/capabilities.d.cts

@@ -0,0 +1,52 @@
+import type { MaybeRefOrGetter, Ref } from 'vue';
+import type { CapabilityToken, EventHook } from '@embedpdf/core';
+/**
+ * Like {@link useCapability}, but a ref that is null while the token can't
+ * resolve: no plugin, no document, or a document that isn't ready yet. It
+ * changes when the subtree's document does, so a `watch` on it rebinds.
+ */
+export declare function useOptionalCapability<Capability>(token: MaybeRefOrGetter<CapabilityToken<Capability>>): Readonly<Ref<Capability | null>>;
+/**
+ * The capability a subtree resolves to, as a ref: the document's while one is
+ * ready, else the stand-in for a document plugin. A token no plugin provides
+ * throws here, at setup: that is a setup mistake.
+ */
+export declare function useCapabilityRef<Capability>(token: MaybeRefOrGetter<CapabilityToken<Capability>>): Readonly<Ref<Capability>>;
+/**
+ * A plugin's API for this subtree: `const stage = useCapability(StageToken)`,
+ * then `stage.zoomIn()` in a handler or a template. The object stays the same
+ * for the component's life and always calls the capability of the document in
+ * scope, so it is safe to keep in a closure. A read (`stage.getZoomLevel()`)
+ * in a template or a computed updates when its answer changes.
+ *
+ * Outside a document (none open, not ready yet, or none in scope), a document
+ * plugin's members belong to its stand-in: reading one never throws, so chrome
+ * renders before the first document opens, and calling one refuses with
+ * `PluginError('not-ready')`: a method that returns a promise rejects, the
+ * others throw.
+ */
+export declare function useCapability<Capability>(token: MaybeRefOrGetter<CapabilityToken<Capability>>): Capability;
+/**
+ * A value read from a capability, as a ref. Strict: while the token can't
+ * resolve, reading it throws the kernel's reason (`no document`, `document is
+ * loading`), for code that knows a document exists, such as anything inside a
+ * `<DocumentGate>`. {@link useOptionalSelector} is its total twin.
+ */
+export declare function useSelector<Capability, Value>(token: MaybeRefOrGetter<CapabilityToken<Capability>>, select: (capability: Capability) => Value, isEqual?: (left: Value, right: Value) => boolean): Readonly<Ref<Value>>;
+/**
+ * Null-safe {@link useSelector}: `fallback` whenever the token can't resolve
+ * (no provider, or a document-scoped token with no document). For chrome that
+ * stays mounted across the empty workspace (a zoom readout, a mode band). A
+ * read through a capability whose document closed a moment ago is `fallback`
+ * too.
+ */
+export declare function useOptionalSelector<Capability, Value>(token: MaybeRefOrGetter<CapabilityToken<Capability>>, select: (capability: Capability) => Value, fallback: Value, isEqual?: (left: Value, right: Value) => boolean): Readonly<Ref<Value>>;
+/**
+ * Subscribe to a capability's {@link EventHook} while the component lives:
+ * `useCapabilityEvent(ActionsToken, (actions) => actions.onExecuted, handler)`.
+ * Events carry occurrences, never state (a late subscriber that needs the
+ * current value uses a selector). It subscribes to the document in scope, again
+ * when that document changes, and ends with the component. Null-safe: with no
+ * plugin or no document there is no subscription.
+ */
+export declare function useCapabilityEvent<Capability, Event>(token: MaybeRefOrGetter<CapabilityToken<Capability>>, select: (capability: Capability) => EventHook<Event>, handler: (event: Event) => void): void;

package/dist/runtime/capabilities.d.ts

@@ -0,0 +1,52 @@
+import type { MaybeRefOrGetter, Ref } from 'vue';
+import type { CapabilityToken, EventHook } from '@embedpdf/core';
+/**
+ * Like {@link useCapability}, but a ref that is null while the token can't
+ * resolve: no plugin, no document, or a document that isn't ready yet. It
+ * changes when the subtree's document does, so a `watch` on it rebinds.
+ */
+export declare function useOptionalCapability<Capability>(token: MaybeRefOrGetter<CapabilityToken<Capability>>): Readonly<Ref<Capability | null>>;
+/**
+ * The capability a subtree resolves to, as a ref: the document's while one is
+ * ready, else the stand-in for a document plugin. A token no plugin provides
+ * throws here, at setup: that is a setup mistake.
+ */
+export declare function useCapabilityRef<Capability>(token: MaybeRefOrGetter<CapabilityToken<Capability>>): Readonly<Ref<Capability>>;
+/**
+ * A plugin's API for this subtree: `const stage = useCapability(StageToken)`,
+ * then `stage.zoomIn()` in a handler or a template. The object stays the same
+ * for the component's life and always calls the capability of the document in
+ * scope, so it is safe to keep in a closure. A read (`stage.getZoomLevel()`)
+ * in a template or a computed updates when its answer changes.
+ *
+ * Outside a document (none open, not ready yet, or none in scope), a document
+ * plugin's members belong to its stand-in: reading one never throws, so chrome
+ * renders before the first document opens, and calling one refuses with
+ * `PluginError('not-ready')`: a method that returns a promise rejects, the
+ * others throw.
+ */
+export declare function useCapability<Capability>(token: MaybeRefOrGetter<CapabilityToken<Capability>>): Capability;
+/**
+ * A value read from a capability, as a ref. Strict: while the token can't
+ * resolve, reading it throws the kernel's reason (`no document`, `document is
+ * loading`), for code that knows a document exists, such as anything inside a
+ * `<DocumentGate>`. {@link useOptionalSelector} is its total twin.
+ */
+export declare function useSelector<Capability, Value>(token: MaybeRefOrGetter<CapabilityToken<Capability>>, select: (capability: Capability) => Value, isEqual?: (left: Value, right: Value) => boolean): Readonly<Ref<Value>>;
+/**
+ * Null-safe {@link useSelector}: `fallback` whenever the token can't resolve
+ * (no provider, or a document-scoped token with no document). For chrome that
+ * stays mounted across the empty workspace (a zoom readout, a mode band). A
+ * read through a capability whose document closed a moment ago is `fallback`
+ * too.
+ */
+export declare function useOptionalSelector<Capability, Value>(token: MaybeRefOrGetter<CapabilityToken<Capability>>, select: (capability: Capability) => Value, fallback: Value, isEqual?: (left: Value, right: Value) => boolean): Readonly<Ref<Value>>;
+/**
+ * Subscribe to a capability's {@link EventHook} while the component lives:
+ * `useCapabilityEvent(ActionsToken, (actions) => actions.onExecuted, handler)`.
+ * Events carry occurrences, never state (a late subscriber that needs the
+ * current value uses a selector). It subscribes to the document in scope, again
+ * when that document changes, and ends with the component. Null-safe: with no
+ * plugin or no document there is no subscription.
+ */
+export declare function useCapabilityEvent<Capability, Event>(token: MaybeRefOrGetter<CapabilityToken<Capability>>, select: (capability: Capability) => EventHook<Event>, handler: (event: Event) => void): void;

package/dist/runtime/documents.d.cts

@@ -0,0 +1,42 @@
+import type { DocumentsCapability, EventHook, PageInfo, ViewerSettings } from '@embedpdf/core';
+import type { Ref } from 'vue';
+import type { FieldRefs } from './refs.cjs';
+/**
+ * The documents API: open, close, unlock, download, and the tabs. Inside a
+ * `<DocumentScope>`, the calls that leave out the document use that one, so
+ * `download()` without an id downloads the document in scope. The object never
+ * changes, so it's safe to keep in a closure. What to show comes from
+ * `useDocument()` and `useDocumentsState()`.
+ */
+export declare function useDocuments(): DocumentsCapability;
+/**
+ * The document this component talks to: the one its `<DocumentScope>` names,
+ * or else the active one. Its `id`, `name`, `status`, `pageCount`,
+ * `hasUnsavedChanges`, and why it's locked or failed, as refs. With no
+ * document, an empty one that reads as still opening. With a selector, one ref
+ * for the value it picks.
+ */
+export declare const useDocument: import("../index.cjs").StateComposable<import("@embedpdf/core").DocumentInfo>;
+/**
+ * Every open document, in tab order (loading, locked and failed ones too), and
+ * the active one's id, as refs. With a selector, one ref for the value it picks.
+ */
+export declare const useDocumentsState: import("../index.cjs").StateComposable<import("@embedpdf/core").DocumentsState>;
+/** Subscribe to one documents event while the component lives: `useDocumentsEvent((documents) => documents.onOpened, handler)`. */
+export declare function useDocumentsEvent<Event>(select: (documents: DocumentsCapability) => EventHook<Event>, handler: (event: Event) => void): void;
+/**
+ * The pages of the document this component talks to, in order: each with its
+ * `ref`, `index`, `label`, size and rotation. Needs no Stage, so a thumbnail
+ * list or a page picker works anywhere. The same array until a page is added,
+ * removed, moved or rotated; empty with no document.
+ */
+export declare function usePageList(): Readonly<Ref<readonly PageInfo[]>>;
+/**
+ * The viewer's own settings (`<Viewer :identity :scope :accent :page>`), as
+ * refs, or one ref for the value `select` picks: the accent every part without
+ * a color of its own follows, and how pages look. What paints a page or an
+ * accent reads it here, through `paint()` from `@embedpdf/web`, so a CSS
+ * variable still wins.
+ */
+export declare function useViewerSettings(): FieldRefs<ViewerSettings>;
+export declare function useViewerSettings<Selected>(select: (settings: ViewerSettings) => Selected): Readonly<Ref<Selected>>;

package/dist/runtime/documents.d.ts

@@ -0,0 +1,42 @@
+import type { DocumentsCapability, EventHook, PageInfo, ViewerSettings } from '@embedpdf/core';
+import type { Ref } from 'vue';
+import type { FieldRefs } from './refs.js';
+/**
+ * The documents API: open, close, unlock, download, and the tabs. Inside a
+ * `<DocumentScope>`, the calls that leave out the document use that one, so
+ * `download()` without an id downloads the document in scope. The object never
+ * changes, so it's safe to keep in a closure. What to show comes from
+ * `useDocument()` and `useDocumentsState()`.
+ */
+export declare function useDocuments(): DocumentsCapability;
+/**
+ * The document this component talks to: the one its `<DocumentScope>` names,
+ * or else the active one. Its `id`, `name`, `status`, `pageCount`,
+ * `hasUnsavedChanges`, and why it's locked or failed, as refs. With no
+ * document, an empty one that reads as still opening. With a selector, one ref
+ * for the value it picks.
+ */
+export declare const useDocument: import("../index.js").StateComposable<import("@embedpdf/core").DocumentInfo>;
+/**
+ * Every open document, in tab order (loading, locked and failed ones too), and
+ * the active one's id, as refs. With a selector, one ref for the value it picks.
+ */
+export declare const useDocumentsState: import("../index.js").StateComposable<import("@embedpdf/core").DocumentsState>;
+/** Subscribe to one documents event while the component lives: `useDocumentsEvent((documents) => documents.onOpened, handler)`. */
+export declare function useDocumentsEvent<Event>(select: (documents: DocumentsCapability) => EventHook<Event>, handler: (event: Event) => void): void;
+/**
+ * The pages of the document this component talks to, in order: each with its
+ * `ref`, `index`, `label`, size and rotation. Needs no Stage, so a thumbnail
+ * list or a page picker works anywhere. The same array until a page is added,
+ * removed, moved or rotated; empty with no document.
+ */
+export declare function usePageList(): Readonly<Ref<readonly PageInfo[]>>;
+/**
+ * The viewer's own settings (`<Viewer :identity :scope :accent :page>`), as
+ * refs, or one ref for the value `select` picks: the accent every part without
+ * a color of its own follows, and how pages look. What paints a page or an
+ * accent reads it here, through `paint()` from `@embedpdf/web`, so a CSS
+ * variable still wins.
+ */
+export declare function useViewerSettings(): FieldRefs<ViewerSettings>;
+export declare function useViewerSettings<Selected>(select: (settings: ViewerSettings) => Selected): Readonly<Ref<Selected>>;

package/dist/runtime/kernel.d.cts

@@ -0,0 +1,36 @@
+import type { MaybeRefOrGetter, Ref } from 'vue';
+import type { Kernel } from '@embedpdf/core';
+/** What `<Viewer>` gives the components inside it. */
+export interface ViewerBinding {
+    /** The kernel, from the moment `<Viewer>` creates it; null before that. */
+    readonly kernel: Kernel | null;
+    /** Read inside a computed: the computed runs again on every change the kernel announces. */
+    track(): void;
+}
+/** Installed by `<Viewer>`, not by app code. */
+export declare function provideViewer(binding: ViewerBinding): void;
+/** The binding of the nearest `<Viewer>`, with its kernel. */
+export declare function useViewerBinding(): ViewerBinding & {
+    readonly kernel: Kernel;
+};
+/** The kernel of the nearest `<Viewer>`. */
+export declare function useKernel(): Kernel;
+/**
+ * A value derived from the kernel, as a ref. `select` runs again on every
+ * kernel change and on a change to any ref it reads; the ref keeps its value
+ * while `isEqual` says the new one is the same, so nothing that reads it
+ * updates.
+ */
+export declare function useKernelValue<Value>(select: (kernel: Kernel) => Value, isEqual?: (left: Value, right: Value) => boolean): Readonly<Ref<Value>>;
+/** Installed by `<DocumentScope>`: the document the subtree talks to. */
+export declare function provideDocumentScope(id: MaybeRefOrGetter<string | null>): void;
+/**
+ * The document the nearest `<DocumentScope>` binds this subtree to, or null
+ * when it follows the active document. For readers that pass it to
+ * `kernel.tryCapability`; UI that needs the id itself uses {@link useDocumentId}.
+ */
+export declare function useDocumentScope(): Readonly<Ref<string | null>>;
+/** The active document's id, or null with none open. */
+export declare function useActiveDocumentId(): Readonly<Ref<string | null>>;
+/** The document id for this subtree: the nearest `<DocumentScope>`, else the active document. */
+export declare function useDocumentId(): Readonly<Ref<string | null>>;

package/dist/runtime/kernel.d.ts

@@ -0,0 +1,36 @@
+import type { MaybeRefOrGetter, Ref } from 'vue';
+import type { Kernel } from '@embedpdf/core';
+/** What `<Viewer>` gives the components inside it. */
+export interface ViewerBinding {
+    /** The kernel, from the moment `<Viewer>` creates it; null before that. */
+    readonly kernel: Kernel | null;
+    /** Read inside a computed: the computed runs again on every change the kernel announces. */
+    track(): void;
+}
+/** Installed by `<Viewer>`, not by app code. */
+export declare function provideViewer(binding: ViewerBinding): void;
+/** The binding of the nearest `<Viewer>`, with its kernel. */
+export declare function useViewerBinding(): ViewerBinding & {
+    readonly kernel: Kernel;
+};
+/** The kernel of the nearest `<Viewer>`. */
+export declare function useKernel(): Kernel;
+/**
+ * A value derived from the kernel, as a ref. `select` runs again on every
+ * kernel change and on a change to any ref it reads; the ref keeps its value
+ * while `isEqual` says the new one is the same, so nothing that reads it
+ * updates.
+ */
+export declare function useKernelValue<Value>(select: (kernel: Kernel) => Value, isEqual?: (left: Value, right: Value) => boolean): Readonly<Ref<Value>>;
+/** Installed by `<DocumentScope>`: the document the subtree talks to. */
+export declare function provideDocumentScope(id: MaybeRefOrGetter<string | null>): void;
+/**
+ * The document the nearest `<DocumentScope>` binds this subtree to, or null
+ * when it follows the active document. For readers that pass it to
+ * `kernel.tryCapability`; UI that needs the id itself uses {@link useDocumentId}.
+ */
+export declare function useDocumentScope(): Readonly<Ref<string | null>>;
+/** The active document's id, or null with none open. */
+export declare function useActiveDocumentId(): Readonly<Ref<string | null>>;
+/** The document id for this subtree: the nearest `<DocumentScope>`, else the active document. */
+export declare function useDocumentId(): Readonly<Ref<string | null>>;

package/dist/runtime/page.d.cts

@@ -0,0 +1,15 @@
+import type { Ref } from 'vue';
+import type { PageTransform } from '@embedpdf/core-geometry';
+import type { PageViewDemand } from '@embedpdf/plugin-render/contract';
+import type { PageContext } from '@embedpdf/web';
+export { makePageContext } from '@embedpdf/web';
+/** The page context. Its members are documented on `PageContext` in `@embedpdf/web`. */
+export type PageContextValue = PageContext<PageTransform, PageViewDemand>;
+/** Installed by page surfaces (`<Stage>` pages), not by app code. */
+export declare function providePage(page: Readonly<Ref<PageContextValue>>): void;
+/**
+ * The page this component is drawn on, as a ref: inside a `<Stage>`'s
+ * `#page` or `#page-chrome` slot. The ref is the same for the page's life;
+ * its value changes when the page's geometry does (a zoom, a rotation).
+ */
+export declare function usePage(): Readonly<Ref<PageContextValue>>;

package/dist/runtime/page.d.ts

@@ -0,0 +1,15 @@
+import type { Ref } from 'vue';
+import type { PageTransform } from '@embedpdf/core-geometry';
+import type { PageViewDemand } from '@embedpdf/plugin-render/contract';
+import type { PageContext } from '@embedpdf/web';
+export { makePageContext } from '@embedpdf/web';
+/** The page context. Its members are documented on `PageContext` in `@embedpdf/web`. */
+export type PageContextValue = PageContext<PageTransform, PageViewDemand>;
+/** Installed by page surfaces (`<Stage>` pages), not by app code. */
+export declare function providePage(page: Readonly<Ref<PageContextValue>>): void;
+/**
+ * The page this component is drawn on, as a ref: inside a `<Stage>`'s
+ * `#page` or `#page-chrome` slot. The ref is the same for the page's life;
+ * its value changes when the page's geometry does (a zoom, a rotation).
+ */
+export declare function usePage(): Readonly<Ref<PageContextValue>>;

package/dist/runtime/refs.d.cts

@@ -0,0 +1,12 @@
+import type { Ref } from 'vue';
+/** One read-only ref per field of `Value`. */
+export type FieldRefs<Value extends object> = {
+    readonly [Key in keyof Value]-?: Readonly<Ref<Value[Key]>>;
+};
+/**
+ * One computed ref per field of `whole`. Each field updates only when its own
+ * value changes. The fields are the ones `whole` has now (`keys` names them
+ * when they are known without a value): records read this way keep their
+ * fields.
+ */
+export declare function fieldRefs<Value extends object>(whole: Readonly<Ref<Value>>, keys?: readonly string[]): FieldRefs<Value>;

package/dist/runtime/refs.d.ts

@@ -0,0 +1,12 @@
+import type { Ref } from 'vue';
+/** One read-only ref per field of `Value`. */
+export type FieldRefs<Value extends object> = {
+    readonly [Key in keyof Value]-?: Readonly<Ref<Value[Key]>>;
+};
+/**
+ * One computed ref per field of `whole`. Each field updates only when its own
+ * value changes. The fields are the ones `whole` has now (`keys` names them
+ * when they are known without a value): records read this way keep their
+ * fields.
+ */
+export declare function fieldRefs<Value extends object>(whole: Readonly<Ref<Value>>, keys?: readonly string[]): FieldRefs<Value>;

package/dist/runtime/surface-box.d.cts

@@ -0,0 +1,12 @@
+/**
+ * A page surface's boxes (`pageSurfaceLayout` from `@embedpdf/web`) as Vue style values, for
+ * the Stage's pages and `<PageView>`: Vue adds no unit to a number, so each is in pixels here.
+ */
+import type { SurfaceBox } from '@embedpdf/web';
+/** `left`, `top`, `width` and `height` in pixels. */
+export declare function pixelBox(box: SurfaceBox): {
+    left: string;
+    top: string;
+    width: string;
+    height: string;
+};

package/dist/runtime/surface-box.d.ts

@@ -0,0 +1,12 @@
+/**
+ * A page surface's boxes (`pageSurfaceLayout` from `@embedpdf/web`) as Vue style values, for
+ * the Stage's pages and `<PageView>`: Vue adds no unit to a number, so each is in pixels here.
+ */
+import type { SurfaceBox } from '@embedpdf/web';
+/** `left`, `top`, `width` and `height` in pixels. */
+export declare function pixelBox(box: SurfaceBox): {
+    left: string;
+    top: string;
+    width: string;
+    height: string;
+};