@embedpdf/viewer-chrome 3.0.0-next.14 → 3.0.0-next.16

package/dist/commands.d.cts

@@ -1,13 +1,34 @@
+import { AnnotationToolInput } from "@embedpdf/react/annotation";
 import { CommandDef } from "@embedpdf/react/commands";
 //#region src/config/commands.d.ts
+type Ctx = Parameters<NonNullable<CommandDef['run']>>[0];
+/** The dialog the Go to Page command opens without a page to go to (ui/go-to-page.tsx). */
+declare const GO_TO_PAGE_DIALOG = "go-to-page";
+/** The keyboard shortcuts sheet, which `?` opens (ui/shortcuts-sheet.tsx). */
+declare const SHORTCUTS_DIALOG = "shortcuts";
+/** The confirmation before marked areas are removed for good (ui/redact-confirm.tsx). */
+declare const REDACT_CONFIRM_DIALOG = "redact-confirm";
+/** The Print dialog: which pages, and whether annotations print (ui/print-dialog.tsx). */
+declare const PRINT_DIALOG = "print";
+/** The form designer's sidebar (ui/form-design-panel.tsx), which `form:design` opens. */
+declare const FORM_DESIGN_PANEL = "form-design";
+/** Form design's resting tool, the form plugin's: widgets select, move and resize there. */
+declare const FORM_DESIGN_TOOL = "form-edit";
+/**
+ * Whether a tool designs a form: design's resting tool, or a field tool. Neither fills, so the
+ * form lends its widgets to be selected, moved and resized.
+ */
+declare const isFormDesignTool: (tool: string | null | undefined) => boolean;
+/** Whether a form is being designed: the active tool designs it. */
+declare const isDesigningForm: (commandContext: Pick<Ctx, "tryGet">) => boolean;
 type ColorKey = 'color' | 'interiorColor' | 'fontColor';
 interface ToolAccentDefinition {
   primary: ColorKey;
   secondary?: ColorKey;
 }
 /**
- * toolId → the SAME icon + accent definition its toolbar button uses, recorded
- * as a side effect of the `tool()` command definitions below — ONE source of
+ * toolId → the same icon + accent definition its toolbar button uses, recorded
+ * as a side effect of the `tool()` command definitions below — one source of
  * truth, so the tool cursor (ui/tool-cursor.tsx) and the button can never
  * drift apart.
  */
@@ -17,6 +38,12 @@ declare const TOOL_ICONS: Record<string, {
 }>;
 declare const defaultCommands: CommandDef[];
 declare const MODE_SURFACES: readonly ["mode:annotate", "mode:shapes", "mode:insert", "mode:form", "mode:redact", "mode:measure"];
+/**
+ * A `tool:<id>` command for each tool of yours (`plugins.annotation.tools`) that no command has
+ * (`isTaken` says which ids do): labelled by its `meta.label`, else its id; drawn with its
+ * `meta.icon`, else the icon of the tool it extends; in that tool's feature, else `annotations`.
+ */
+declare function toolCommandsFor(tools: readonly AnnotationToolInput[], isTaken: (id: string) => boolean): CommandDef[];
 //#endregion
-export { MODE_SURFACES, TOOL_ICONS, ToolAccentDefinition, defaultCommands };
+export { FORM_DESIGN_PANEL, FORM_DESIGN_TOOL, GO_TO_PAGE_DIALOG, MODE_SURFACES, PRINT_DIALOG, REDACT_CONFIRM_DIALOG, SHORTCUTS_DIALOG, TOOL_ICONS, ToolAccentDefinition, defaultCommands, isDesigningForm, isFormDesignTool, toolCommandsFor };
 //# sourceMappingURL=commands.d.cts.map

package/dist/commands.d.ts

@@ -1,13 +1,34 @@
+import { AnnotationToolInput } from "@embedpdf/react/annotation";
 import { CommandDef } from "@embedpdf/react/commands";
 //#region src/config/commands.d.ts
+type Ctx = Parameters<NonNullable<CommandDef['run']>>[0];
+/** The dialog the Go to Page command opens without a page to go to (ui/go-to-page.tsx). */
+declare const GO_TO_PAGE_DIALOG = "go-to-page";
+/** The keyboard shortcuts sheet, which `?` opens (ui/shortcuts-sheet.tsx). */
+declare const SHORTCUTS_DIALOG = "shortcuts";
+/** The confirmation before marked areas are removed for good (ui/redact-confirm.tsx). */
+declare const REDACT_CONFIRM_DIALOG = "redact-confirm";
+/** The Print dialog: which pages, and whether annotations print (ui/print-dialog.tsx). */
+declare const PRINT_DIALOG = "print";
+/** The form designer's sidebar (ui/form-design-panel.tsx), which `form:design` opens. */
+declare const FORM_DESIGN_PANEL = "form-design";
+/** Form design's resting tool, the form plugin's: widgets select, move and resize there. */
+declare const FORM_DESIGN_TOOL = "form-edit";
+/**
+ * Whether a tool designs a form: design's resting tool, or a field tool. Neither fills, so the
+ * form lends its widgets to be selected, moved and resized.
+ */
+declare const isFormDesignTool: (tool: string | null | undefined) => boolean;
+/** Whether a form is being designed: the active tool designs it. */
+declare const isDesigningForm: (commandContext: Pick<Ctx, "tryGet">) => boolean;
 type ColorKey = 'color' | 'interiorColor' | 'fontColor';
 interface ToolAccentDefinition {
   primary: ColorKey;
   secondary?: ColorKey;
 }
 /**
- * toolId → the SAME icon + accent definition its toolbar button uses, recorded
- * as a side effect of the `tool()` command definitions below — ONE source of
+ * toolId → the same icon + accent definition its toolbar button uses, recorded
+ * as a side effect of the `tool()` command definitions below — one source of
  * truth, so the tool cursor (ui/tool-cursor.tsx) and the button can never
  * drift apart.
  */
@@ -17,6 +38,12 @@ declare const TOOL_ICONS: Record<string, {
 }>;
 declare const defaultCommands: CommandDef[];
 declare const MODE_SURFACES: readonly ["mode:annotate", "mode:shapes", "mode:insert", "mode:form", "mode:redact", "mode:measure"];
+/**
+ * A `tool:<id>` command for each tool of yours (`plugins.annotation.tools`) that no command has
+ * (`isTaken` says which ids do): labelled by its `meta.label`, else its id; drawn with its
+ * `meta.icon`, else the icon of the tool it extends; in that tool's feature, else `annotations`.
+ */
+declare function toolCommandsFor(tools: readonly AnnotationToolInput[], isTaken: (id: string) => boolean): CommandDef[];
 //#endregion
-export { MODE_SURFACES, TOOL_ICONS, ToolAccentDefinition, defaultCommands };
+export { FORM_DESIGN_PANEL, FORM_DESIGN_TOOL, GO_TO_PAGE_DIALOG, MODE_SURFACES, PRINT_DIALOG, REDACT_CONFIRM_DIALOG, SHORTCUTS_DIALOG, TOOL_ICONS, ToolAccentDefinition, defaultCommands, isDesigningForm, isFormDesignTool, toolCommandsFor };
 //# sourceMappingURL=commands.d.ts.map