@embedpdf/viewer-chrome 3.0.0-next.0

package/dist/index.d.cts

@@ -0,0 +1,121 @@
+import { defaultChrome } from "./chrome.cjs";
+import { defaultCommands } from "./commands.cjs";
+import { AddItemSpec, BarChild, BarGroup, BarItem, BarSchema, BarSections, ChromeHelpers, ChromeHelpers as ChromeHelpers$1, ChromeSchema, ChromeSchema as ChromeSchema$1, CustomItem, Importance, MenuSchema, MenuSection, Variant, addItem, chromeHelpers, custom, defineChrome, group, item, removeItems, replaceItem, validateChrome } from "@embedpdf/react/toolbar";
+import { CommandDef, CommandDef as CommandDef$1, CommandsToken, ResolvedCommand, ResolvedCommand as ResolvedCommand$1 } from "@embedpdf/react/commands";
+import { ReactNode } from "react";
+import { CapabilityToken, CapabilityToken as CapabilityToken$1, DocInfo, DocumentsCapability, DocumentsCapability as DocumentsCapability$1, DocumentsToken, Engine, Engine as Engine$1, EngineFactory, EngineFactory as EngineFactory$1, InitialDocument, InitialDocument as InitialDocument$1, Kernel, Unsubscribe, Unsubscribe as Unsubscribe$1 } from "@embedpdf/react/runtime";
+import { I18nToken, TranslationDictionary } from "@embedpdf/react/i18n";
+import { AnnotationToken } from "@embedpdf/react/annotation";
+import { StageToken } from "@embedpdf/react/stage";
+import { SearchToken } from "@embedpdf/react/search";
+import { SelectionToken } from "@embedpdf/react/selection";
+import { FormToken } from "@embedpdf/react/form";
+import { RedactionToken } from "@embedpdf/react/redaction";
+import { InteractionToken } from "@embedpdf/react/interaction";
+import { ShellToken } from "@embedpdf/react/shell";
+import { MetadataToken } from "@embedpdf/react/metadata";
+//#region src/handle.d.ts
+/** `get`/`tryGet` bound to one document (see {@link ViewerHandle.forDocument}). */
+interface ScopedViewerHandle {
+  get<T>(token: CapabilityToken$1<T>): T;
+  tryGet<T>(token: CapabilityToken$1<T>): T | null;
+}
+interface ViewerHandle extends ScopedViewerHandle {
+  /** The document registry — the tab model: list/open/close/setActive/…. */
+  readonly documents: DocumentsCapability$1;
+  /** `get`/`tryGet` with document-scoped tokens bound to `documentId`
+   *  instead of the active document. */
+  forDocument(documentId: string): ScopedViewerHandle;
+  /**
+   * Re-run `select` on every kernel change; call `cb` when the selected value
+   * really changed (`isEqual`, default `Object.is` — capability getters return
+   * stable references between model changes, so identity works). Returns the
+   * unsubscribe. This is the ONLY reactivity primitive; DOM events on the
+   * element are sugar over it.
+   */
+  watch<T>(select: () => T, cb: (value: T, previous: T) => void, isEqual?: (a: T, b: T) => boolean): Unsubscribe$1;
+  execute(id: string, documentId?: string): void;
+  resolve(id: string, documentId?: string): ResolvedCommand$1 | null;
+  /** `watch` sugar for one command's resolved state (label/icon/enabled/active). */
+  watchCommand(id: string, cb: (cmd: ResolvedCommand$1 | null) => void): Unsubscribe$1;
+}
+declare function createViewerHandle(kernel: Kernel): ViewerHandle;
+//#endregion
+//#region src/ui/icons.d.ts
+type PathSpec = string | {
+  d: string;
+  /** Fill paint: `true` = currentColor (a filled glyph part); a slot
+   *  name = that accent color (nothing when the accent is absent). */
+  fill?: boolean | 'primary' | 'secondary';
+  /** Stroke paint: a slot name = that accent color (currentColor when
+   *  the accent is absent). */
+  stroke?: 'primary' | 'secondary';
+};
+/** A registrable icon: 24×24 stroke path data (Tabler/Lucide-style), exactly
+ *  the shape of the built-in set — user icons are not a lesser kind. */
+type IconDef = readonly PathSpec[];
+declare const ICON_PATHS: Record<string, readonly PathSpec[]>;
+//#endregion
+//#region src/ui/theme.d.ts
+type ThemeMode = 'light' | 'dark';
+type ThemePreference = ThemeMode | 'system';
+//#endregion
+//#region src/viewer.d.ts
+/**
+ * The customization surface — identical in the vanilla snippet and every
+ * framework wrapper. See README.md for the ladder this implements.
+ */
+interface ViewerCustomization {
+  /** ADDITIVE over the default vocabulary; a colliding id overrides. */
+  commands?: readonly CommandDef$1[];
+  /** ADDITIVE 24×24 stroke icons by name; a colliding name overrides. */
+  icons?: Readonly<Record<string, IconDef>>;
+  /** Per-locale translation overrides/additions; dotted keys expand. A code
+   *  with no built-in pack becomes a new locale (falls back to English). */
+  strings?: Readonly<Record<string, TranslationDictionary>>;
+  /** 'auto' (default) negotiates from the browser languages. */
+  locale?: 'auto' | (string & {});
+  /** Feature gating: a disabled category vanishes from every surface. */
+  disabledCategories?: readonly string[];
+  /** The structure — a value you OWN: the default (pass nothing), a transform
+   *  of it, or your own schema. Never merged. */
+  chrome?: ChromeSchema$1 | ((base: ChromeSchema$1, helpers: ChromeHelpers$1) => ChromeSchema$1);
+  /** Light/dark preference (string shorthand), or the full theme config with
+   *  `--ep-*` token overrides. Tokens are applied by the DELIVERY (the custom
+   *  element adopts them into its shadow root); direct consumers of this
+   *  package set the `--ep-*` variables in their own CSS instead. */
+  theme?: ThemePreference | ThemeConfig;
+}
+/** Token overrides — names WITHOUT the `--ep-` prefix ('accent', 'surface'…). */
+type ThemeTokens = Readonly<Record<string, string>>;
+interface ThemeConfig {
+  /** 'system' (default) follows the OS. */
+  preference?: ThemePreference;
+  /** Applied in BOTH modes (a later sheet: wins over the defaults). */
+  tokens?: ThemeTokens;
+  /** Dark-mode-only overrides, applied over `tokens`. */
+  dark?: ThemeTokens;
+}
+/** Normalize the shorthand — deliveries use this to read one shape. */
+declare const themeConfigOf: (theme: ThemePreference | ThemeConfig | undefined) => ThemeConfig;
+interface FullViewerProps extends ViewerCustomization {
+  /** Instance (borrowed) or thunk (viewer-owned) — the Viewer's own contract. */
+  engine: Engine$1 | EngineFactory$1;
+  /** Documents to open at mount; more arrive via the tab bar's open button. */
+  initialDocuments?: InitialDocument$1[];
+  /** Shown while the workspace boots. Default: a translated pulse line. */
+  fallback?: ReactNode;
+  /** Where the theme's `.dark` class goes — a DELIVERY concern, not user
+   *  config: the custom element passes its shadow wrapper so theming never
+   *  touches the host page. Default: document.documentElement. */
+  themeTarget?: HTMLElement | null;
+  /** Called once the workspace kernel is live, with the viewer handle — the
+   *  DRIVE surface (`el.viewer` on the custom element, `onReady` on the
+   *  wrappers). Capabilities resolve from the moment this fires; document-
+   *  scoped calls simply await their document. */
+  onViewer?: (viewer: ViewerHandle) => void;
+}
+declare function FullViewer({ engine, initialDocuments, fallback, commands, icons, strings, locale, disabledCategories, chrome, theme, themeTarget, onViewer }: FullViewerProps): import("react/jsx-runtime").JSX.Element;
+//#endregion
+export { type AddItemSpec, AnnotationToken, type BarChild, type BarGroup, type BarItem, type BarSchema, type BarSections, type CapabilityToken, type ChromeHelpers, type ChromeSchema, type CommandDef, CommandsToken, type CustomItem, type DocInfo, type DocumentsCapability, DocumentsToken, type Engine, type EngineFactory, FormToken, FullViewer, type FullViewerProps, I18nToken, type IconDef, type Importance, type InitialDocument, InteractionToken, type MenuSchema, type MenuSection, MetadataToken, type PathSpec, RedactionToken, type ResolvedCommand, type ScopedViewerHandle, SearchToken, SelectionToken, ShellToken, StageToken, type ThemeConfig, type ThemeMode, type ThemePreference, type ThemeTokens, type Unsubscribe, type Variant, type ViewerCustomization, type ViewerHandle, addItem, chromeHelpers, createViewerHandle, custom, defaultChrome, defaultCommands, ICON_PATHS as defaultIcons, defineChrome, group, item, removeItems, replaceItem, themeConfigOf, validateChrome };
+//# sourceMappingURL=index.d.cts.map

package/dist/index.d.ts

@@ -0,0 +1,121 @@
+import { defaultChrome } from "./chrome.js";
+import { defaultCommands } from "./commands.js";
+import { ReactNode } from "react";
+import { CapabilityToken, CapabilityToken as CapabilityToken$1, DocInfo, DocumentsCapability, DocumentsCapability as DocumentsCapability$1, DocumentsToken, Engine, Engine as Engine$1, EngineFactory, EngineFactory as EngineFactory$1, InitialDocument, InitialDocument as InitialDocument$1, Kernel, Unsubscribe, Unsubscribe as Unsubscribe$1 } from "@embedpdf/react/runtime";
+import { StageToken } from "@embedpdf/react/stage";
+import { InteractionToken } from "@embedpdf/react/interaction";
+import { SelectionToken } from "@embedpdf/react/selection";
+import { AnnotationToken } from "@embedpdf/react/annotation";
+import { RedactionToken } from "@embedpdf/react/redaction";
+import { FormToken } from "@embedpdf/react/form";
+import { SearchToken } from "@embedpdf/react/search";
+import { I18nToken, TranslationDictionary } from "@embedpdf/react/i18n";
+import { CommandDef, CommandDef as CommandDef$1, CommandsToken, ResolvedCommand, ResolvedCommand as ResolvedCommand$1 } from "@embedpdf/react/commands";
+import { ShellToken } from "@embedpdf/react/shell";
+import { AddItemSpec, BarChild, BarGroup, BarItem, BarSchema, BarSections, ChromeHelpers, ChromeHelpers as ChromeHelpers$1, ChromeSchema, ChromeSchema as ChromeSchema$1, CustomItem, Importance, MenuSchema, MenuSection, Variant, addItem, chromeHelpers, custom, defineChrome, group, item, removeItems, replaceItem, validateChrome } from "@embedpdf/react/toolbar";
+import { MetadataToken } from "@embedpdf/react/metadata";
+//#region src/handle.d.ts
+/** `get`/`tryGet` bound to one document (see {@link ViewerHandle.forDocument}). */
+interface ScopedViewerHandle {
+  get<T>(token: CapabilityToken$1<T>): T;
+  tryGet<T>(token: CapabilityToken$1<T>): T | null;
+}
+interface ViewerHandle extends ScopedViewerHandle {
+  /** The document registry — the tab model: list/open/close/setActive/…. */
+  readonly documents: DocumentsCapability$1;
+  /** `get`/`tryGet` with document-scoped tokens bound to `documentId`
+   *  instead of the active document. */
+  forDocument(documentId: string): ScopedViewerHandle;
+  /**
+   * Re-run `select` on every kernel change; call `cb` when the selected value
+   * really changed (`isEqual`, default `Object.is` — capability getters return
+   * stable references between model changes, so identity works). Returns the
+   * unsubscribe. This is the ONLY reactivity primitive; DOM events on the
+   * element are sugar over it.
+   */
+  watch<T>(select: () => T, cb: (value: T, previous: T) => void, isEqual?: (a: T, b: T) => boolean): Unsubscribe$1;
+  execute(id: string, documentId?: string): void;
+  resolve(id: string, documentId?: string): ResolvedCommand$1 | null;
+  /** `watch` sugar for one command's resolved state (label/icon/enabled/active). */
+  watchCommand(id: string, cb: (cmd: ResolvedCommand$1 | null) => void): Unsubscribe$1;
+}
+declare function createViewerHandle(kernel: Kernel): ViewerHandle;
+//#endregion
+//#region src/ui/icons.d.ts
+type PathSpec = string | {
+  d: string;
+  /** Fill paint: `true` = currentColor (a filled glyph part); a slot
+   *  name = that accent color (nothing when the accent is absent). */
+  fill?: boolean | 'primary' | 'secondary';
+  /** Stroke paint: a slot name = that accent color (currentColor when
+   *  the accent is absent). */
+  stroke?: 'primary' | 'secondary';
+};
+/** A registrable icon: 24×24 stroke path data (Tabler/Lucide-style), exactly
+ *  the shape of the built-in set — user icons are not a lesser kind. */
+type IconDef = readonly PathSpec[];
+declare const ICON_PATHS: Record<string, readonly PathSpec[]>;
+//#endregion
+//#region src/ui/theme.d.ts
+type ThemeMode = 'light' | 'dark';
+type ThemePreference = ThemeMode | 'system';
+//#endregion
+//#region src/viewer.d.ts
+/**
+ * The customization surface — identical in the vanilla snippet and every
+ * framework wrapper. See README.md for the ladder this implements.
+ */
+interface ViewerCustomization {
+  /** ADDITIVE over the default vocabulary; a colliding id overrides. */
+  commands?: readonly CommandDef$1[];
+  /** ADDITIVE 24×24 stroke icons by name; a colliding name overrides. */
+  icons?: Readonly<Record<string, IconDef>>;
+  /** Per-locale translation overrides/additions; dotted keys expand. A code
+   *  with no built-in pack becomes a new locale (falls back to English). */
+  strings?: Readonly<Record<string, TranslationDictionary>>;
+  /** 'auto' (default) negotiates from the browser languages. */
+  locale?: 'auto' | (string & {});
+  /** Feature gating: a disabled category vanishes from every surface. */
+  disabledCategories?: readonly string[];
+  /** The structure — a value you OWN: the default (pass nothing), a transform
+   *  of it, or your own schema. Never merged. */
+  chrome?: ChromeSchema$1 | ((base: ChromeSchema$1, helpers: ChromeHelpers$1) => ChromeSchema$1);
+  /** Light/dark preference (string shorthand), or the full theme config with
+   *  `--ep-*` token overrides. Tokens are applied by the DELIVERY (the custom
+   *  element adopts them into its shadow root); direct consumers of this
+   *  package set the `--ep-*` variables in their own CSS instead. */
+  theme?: ThemePreference | ThemeConfig;
+}
+/** Token overrides — names WITHOUT the `--ep-` prefix ('accent', 'surface'…). */
+type ThemeTokens = Readonly<Record<string, string>>;
+interface ThemeConfig {
+  /** 'system' (default) follows the OS. */
+  preference?: ThemePreference;
+  /** Applied in BOTH modes (a later sheet: wins over the defaults). */
+  tokens?: ThemeTokens;
+  /** Dark-mode-only overrides, applied over `tokens`. */
+  dark?: ThemeTokens;
+}
+/** Normalize the shorthand — deliveries use this to read one shape. */
+declare const themeConfigOf: (theme: ThemePreference | ThemeConfig | undefined) => ThemeConfig;
+interface FullViewerProps extends ViewerCustomization {
+  /** Instance (borrowed) or thunk (viewer-owned) — the Viewer's own contract. */
+  engine: Engine$1 | EngineFactory$1;
+  /** Documents to open at mount; more arrive via the tab bar's open button. */
+  initialDocuments?: InitialDocument$1[];
+  /** Shown while the workspace boots. Default: a translated pulse line. */
+  fallback?: ReactNode;
+  /** Where the theme's `.dark` class goes — a DELIVERY concern, not user
+   *  config: the custom element passes its shadow wrapper so theming never
+   *  touches the host page. Default: document.documentElement. */
+  themeTarget?: HTMLElement | null;
+  /** Called once the workspace kernel is live, with the viewer handle — the
+   *  DRIVE surface (`el.viewer` on the custom element, `onReady` on the
+   *  wrappers). Capabilities resolve from the moment this fires; document-
+   *  scoped calls simply await their document. */
+  onViewer?: (viewer: ViewerHandle) => void;
+}
+declare function FullViewer({ engine, initialDocuments, fallback, commands, icons, strings, locale, disabledCategories, chrome, theme, themeTarget, onViewer }: FullViewerProps): import("react/jsx-runtime").JSX.Element;
+//#endregion
+export { type AddItemSpec, AnnotationToken, type BarChild, type BarGroup, type BarItem, type BarSchema, type BarSections, type CapabilityToken, type ChromeHelpers, type ChromeSchema, type CommandDef, CommandsToken, type CustomItem, type DocInfo, type DocumentsCapability, DocumentsToken, type Engine, type EngineFactory, FormToken, FullViewer, type FullViewerProps, I18nToken, type IconDef, type Importance, type InitialDocument, InteractionToken, type MenuSchema, type MenuSection, MetadataToken, type PathSpec, RedactionToken, type ResolvedCommand, type ScopedViewerHandle, SearchToken, SelectionToken, ShellToken, StageToken, type ThemeConfig, type ThemeMode, type ThemePreference, type ThemeTokens, type Unsubscribe, type Variant, type ViewerCustomization, type ViewerHandle, addItem, chromeHelpers, createViewerHandle, custom, defaultChrome, defaultCommands, ICON_PATHS as defaultIcons, defineChrome, group, item, removeItems, replaceItem, themeConfigOf, validateChrome };
+//# sourceMappingURL=index.d.ts.map