@embedpdf/engine-core 3.0.0-next.0 → 3.0.0-next.10

package/dist/wire.d.ts

@@ -1,5 +1,5 @@
-import { $ as CaretDraftSchema, $i as LayerScopes, $t as CircleDraftSchema, A as FileAttachmentWireDraftSchema, Aa as EmbeddedFileItem, Ac as PdfSize, Ai as AnnotationCreateResult, Ar as FormFieldDeleteResult, Bc as PdfPageActions, Bo as PageRenderOptions, Cc as InkList, Ci as ToggleFieldWidget, Co as AnnotationAppearancesQuery, Cr as SearchQuery, D as FileAttachmentDTOSchema, Dc as PdfQuad, Di as FormWidgetRef, Dn as HighlightPatchSchema, Dr as SearchSnippet, Dt as LinePatchSchema, Ec as PdfPoint, Ei as FormFieldRef, En as HighlightDraftSchema, Er as SearchSliceBudget, Et as LineDraftSchema, F as StampDTOSchema, Fc as PdfActionTree, Fn as RedactionApplyScope, Fo as PageNetworkRenderFormat, Fr as FormWidgetLinkResult, G as TextDTOSchema, Gi as CacheDelta, Gn as PageRotateResult, Gr as FormFieldPatch, Hr as FormFieldValue, Hs as DocCapability, I as StampWireDraftSchema, Ii as AppearanceOutcome, Ir as FormEffect, Jn as PageMoveResult, Jo as PageTextSnapshot, Jt as SquarePatchSchema, K as TextDraftSchema, Ki as MutationMeta, Kn as PageRotateInput, Kt as SquareDTOSchema, L as StampWirePatchSchema, Ln as PageFlattenInput, Lt as PolygonDTOSchema, Mc as DocumentActionsSnapshot, Mi as AnnotationMoveResult, Mn as MetadataUpdateResult, Mo as PageImageOptions, Mr as FormImportResult, Mt as PolylineDraftSchema, Ni as AnnotationUpdateResult, Nr as FormRepairResult, Nt as PolylinePatchSchema, O as FileAttachmentIconSchema, Oa as AttachmentFileInfo, Oc as PdfRect, P as ResourceRefSchema, Pc as PdfActionNode, Pn as RedactionApplyResult, Pr as FormSetValueResult, Q as CaretDTOSchema, Qi as LayerScopePlane, Qr as FormFieldOptionInput, Qs as RevisionToken, Qt as CircleDTOSchema, Rc as PdfAnnotationActions, Rt as PolygonDraftSchema, Sc as CalloutLine, So as AnnotationAppearanceRenderOptions, Tc as LinePoints, Ti as FormValueEntry, Tn as HighlightDTOSchema, To as PageState, Tr as SearchSlice, Tt as LineDTOSchema, Ui as AnnotationListMutationMeta, Un as PageDeleteResult, Vc as DocumentMetadata, Vo as PageRenderQuery, Vr as FormDataFormat, W as NoteIconSchema, Wi as RefetchReason, Wn as PageDeleteInput, Xi as DocumentManifest, Xn as PageMoveInput, Yn as PageStructureCache, Ys as PdfBits, Zi as ManifestPage, Zr as FormFieldDraft, Zs as AnnotationRef, _ as UnsupportedPatchSchema, _t as LinkDraftSchema, a as AnnotationDTOSchema, ac as BlendMode, ao as SerializedEngineError, at as FreeTextDraftSchema, bc as StrikeoutIntent, bn as UnderlineDraftSchema, bt as PdfLinkTargetSchema, cn as StrikeoutDraftSchema, cs as PageLayout, da as AttachmentsCache, dc as LineEnding, dt as InkDraftSchema, en as CirclePatchSchema, eo as AnnotationStableId, et as CaretPatchSchema, f as KIND_BY_SUBTYPE, fc as LineEndings, ft as InkPatchSchema, g as UnsupportedDraftSchema, gi as FormFieldOption, go as AnnotationAppearanceImageOptions, gt as LinkDTOSchema, h as UnsupportedDTOSchema, hi as FormFieldFlags, hn as SquigglyPatchSchema, ii as FormSnapshot, it as FreeTextDTOSchema, j as WireAttachmentFileSchema, ja as EmbeddedFileRef, ji as AnnotationDeleteResult, jr as FormFieldUpdateResult, jt as PolylineDTOSchema, k as FileAttachmentPatchSchema, kc as PdfRotation, kr as FormFieldCreateResult, la as AttachmentCreateResult, lc as FreeTextIntent, ln as StrikeoutPatchSchema, mc as PdfRectDifferences, mn as SquigglyDraftSchema, mo as CachePins, n as AnnotationListSnapshotAllPages, nc as AnnotationBorderStyle, ni as WidgetPlacement, oc as CaretIntent, oi as WidgetAppearanceSchema, os as PageListSnapshot, ot as FreeTextPatchSchema, pi as FormFieldDTO, pn as SquigglyDTOSchema, po as PdfSaveMode, q as TextPatchSchema, qo as PageGeometrySnapshot, qt as SquareDraftSchema, r as ANNOTATION_KINDS, rc as AnnotationFlags, ri as FormKind, s as AnnotationDraftSchema, sc as Color, sn as StrikeoutDTOSchema, ss as PageBoxes, t as AnnotationListPageSnapshot, u as AnnotationPatchSchema, ua as AttachmentDeleteResult, uc as InkIntent, us as MetadataPatch, ut as InkDTOSchema, vo as AnnotationAppearanceManifest, vt as LinkPatchSchema, wr as SearchRequest, xc as TextAlignment, xn as UnderlinePatchSchema, xr as SearchMatch, xt as PdfLinkTargetWritableSchema, yc as StandardFont, yn as UnderlineDTOSchema, yt as PdfDestinationSchema, zc as PdfFieldActions, zn as PageFlattenResult, zr as FormEffectsResult, zt as PolygonPatchSchema } from "./AnnotationListSnapshot-W0RCsyDE.js";
-import { c as DocumentSecurityState, f as PdfPermissionInfo } from "./DocumentSecurityService-B-tULKNY.js";
+import { $ as CaretDraftSchema, $c as StandardFont, $r as FormEffectsResult, $t as CircleDraftSchema, A as FileAttachmentWireDraftSchema, Aa as AttachmentDeleteResult, Ai as FormFieldOption, Ar as SearchSnippet, Bc as CaretIntent, Bi as FormFieldRef, Bs as PageBoxes, D as FileAttachmentDTOSchema, Di as FormFieldDTO, Dn as HighlightPatchSchema, Dr as SearchRequest, Dt as LinePatchSchema, En as HighlightDraftSchema, Er as SearchQuery, Et as LineDraftSchema, F as StampDTOSchema, Fn as RedactionApplyScope, G as TextDTOSchema, Gc as LineEnding, Gi as AnnotationDeleteResult, Gn as PageDeleteResult, Go as PageState, Gr as FormFieldUpdateResult, Ho as AnnotationAppearanceRenderOptions, I as StampWireDraftSchema, Ic as AnnotationBorderStyle, Io as AnnotationAppearanceImageOptions, Ja as AttachmentFileInfo, Jc as PdfRectDifferences, Jn as PageRotateInput, Jr as FormSetValueResult, Jt as SquarePatchSchema, K as TextDraftSchema, Kc as LineEndings, Ki as AnnotationMoveResult, Kn as PageDeleteInput, Kr as FormImportResult, Kt as SquareDTOSchema, L as StampWirePatchSchema, Lc as AnnotationFlags, Li as ToggleFieldWidget, Ln as PageFlattenInput, Lt as PolygonDTOSchema, Mc as RevisionToken, Mn as MetadataUpdateResult, Mt as PolylineDraftSchema, No as PdfSaveMode, Nt as PolylinePatchSchema, O as FileAttachmentIconSchema, Or as SearchSlice, P as ResourceRefSchema, Pn as RedactionApplyResult, Po as CachePins, Q as CaretDTOSchema, Qn as PageMoveInput, Qo as PageImageOptions, Qt as CircleDTOSchema, Ro as AnnotationAppearanceManifest, Rt as PolygonDraftSchema, Sc as DocCapability, Tn as HighlightDTOSchema, To as SerializedEngineError, Tt as LineDTOSchema, Uc as FreeTextIntent, Uo as AnnotationAppearancesQuery, Ur as FormFieldCreateResult, Us as MetadataPatch, Vc as Color, Vi as FormWidgetRef, Vs as PageLayout, W as NoteIconSchema, Wc as InkIntent, Wi as AnnotationCreateResult, Wn as PageInsertResult, Wr as FormFieldDeleteResult, Xa as EmbeddedFileItem, Xi as AppearanceOutcome, Xn as PageMoveResult, Xr as FormEffect, Yr as FormWidgetLinkResult, Za as EmbeddedFileRef, Zn as PageStructureCache, _ as UnsupportedPatchSchema, _i as FormKind, _t as LinkDraftSchema, a as AnnotationDTOSchema, aa as CacheDelta, ai as FormFieldPatch, al as LinePoints, at as FreeTextDraftSchema, bi as WidgetAppearanceSchema, bl as PdfPageActions, bn as UnderlineDraftSchema, bo as AnnotationStableId, bs as PageTextSnapshot, bt as PdfLinkTargetSchema, cl as PdfRect, cn as StrikeoutDraftSchema, da as ManifestPage, di as FormFieldDraft, dt as InkDraftSchema, el as StrikeoutIntent, en as CirclePatchSchema, et as CaretPatchSchema, f as KIND_BY_SUBTYPE, fa as LayerScopePlane, fi as FormFieldOptionInput, fl as DocumentActionsSnapshot, ft as InkPatchSchema, g as UnsupportedDraftSchema, gi as WidgetPlacement, gt as LinkDTOSchema, h as UnsupportedDTOSchema, hl as PdfActionTree, hn as SquigglyPatchSchema, ia as RefetchReason, it as FreeTextDTOSchema, j as WireAttachmentFileSchema, ja as AttachmentsCache, jc as AnnotationRef, jt as PolylineDTOSchema, k as FileAttachmentPatchSchema, ka as AttachmentCreateResult, kc as PdfBits, ki as FormFieldFlags, kr as SearchSliceBudget, ll as PdfRotation, ln as StrikeoutPatchSchema, ml as PdfActionNode, mn as SquigglyDraftSchema, n as AnnotationListSnapshotAllPages, ni as FormFieldValue, nl as CalloutLine, oa as MutationMeta, ol as PdfPoint, os as PageRenderOptions, ot as FreeTextPatchSchema, pa as LayerScopes, pn as SquigglyDTOSchema, ps as PageGeometrySnapshot, q as TextPatchSchema, qi as AnnotationUpdateResult, qn as PageRotateResult, qr as FormRepairResult, qt as SquareDraftSchema, r as ANNOTATION_KINDS, ra as AnnotationListMutationMeta, rl as InkList, s as AnnotationDraftSchema, sl as PdfQuad, sn as StrikeoutDTOSchema, ss as PageRenderQuery, t as AnnotationListPageSnapshot, ti as FormDataFormat, tl as TextAlignment, ts as PageNetworkRenderFormat, u as AnnotationPatchSchema, ua as DocumentManifest, ul as PdfSize, ut as InkDTOSchema, vi as FormSnapshot, vl as PdfAnnotationActions, vt as LinkPatchSchema, wr as SearchMatch, xl as DocumentMetadata, xn as UnderlinePatchSchema, xt as PdfLinkTargetWritableSchema, yl as PdfFieldActions, yn as UnderlineDTOSchema, yt as PdfDestinationSchema, zc as BlendMode, zi as FormValueEntry, zn as PageFlattenResult, zs as PageListSnapshot, zt as PolygonPatchSchema } from "./AnnotationListSnapshot-DDxHpJQU.js";
+import { c as DocumentSecurityState, f as PdfPermissionInfo } from "./DocumentSecurityService-o9aeTHwT.js";
 import { z } from "zod";
 //#region src/geometry/schemas.d.ts
 declare const PdfPointSchema: z.ZodType<PdfPoint>;
@@ -52,10 +52,10 @@ declare const DocumentHeadSchema: z.ZodObject<{
     state: z.ZodEnum<["unknown", "none", "encrypted", "unsupported"]>;
     requiresPassword: z.ZodNullable<z.ZodBoolean>;
   }, "strip", z.ZodTypeAny, {
-    state: "none" | "unknown" | "encrypted" | "unsupported";
+    state: "unknown" | "none" | "encrypted" | "unsupported";
     requiresPassword: boolean | null;
   }, {
-    state: "none" | "unknown" | "encrypted" | "unsupported";
+    state: "unknown" | "none" | "encrypted" | "unsupported";
     requiresPassword: boolean | null;
   }>;
   permissions: z.ZodObject<{
@@ -94,13 +94,13 @@ declare const DocumentHeadSchema: z.ZodObject<{
     endpoint?: string | undefined;
   }>;
 }, "strip", z.ZodTypeAny, {
-  docVersion: number;
   id: string;
   baseSha: string;
   storageSizeBytes: number;
+  docVersion: number;
   state: "pending" | "ready" | "failed" | "deleting";
   encryption: {
-    state: "none" | "unknown" | "encrypted" | "unsupported";
+    state: "unknown" | "none" | "encrypted" | "unsupported";
     requiresPassword: boolean | null;
   };
   permissions: {
@@ -117,13 +117,13 @@ declare const DocumentHeadSchema: z.ZodObject<{
     endpoint?: string | undefined;
   };
 }, {
-  docVersion: number;
   id: string;
   baseSha: string;
   storageSizeBytes: number;
+  docVersion: number;
   state: "pending" | "ready" | "failed" | "deleting";
   encryption: {
-    state: "none" | "unknown" | "encrypted" | "unsupported";
+    state: "unknown" | "none" | "encrypted" | "unsupported";
     requiresPassword: boolean | null;
   };
   permissions: {
@@ -142,23 +142,26 @@ declare const DocumentHeadSchema: z.ZodObject<{
 }>;
 type DocumentHead = z.infer<typeof DocumentHeadSchema>;
 declare const AccessRequestSchema: z.ZodObject<{
-  docId: z.ZodString;
+  /** Deprecated: identity now rides the PATH
+   *  (`/v1/docs/:docId/layers/:layerName/access`). Kept optional for the
+   *  legacy `/v1/access` alias, which requires `docId` in the body. */
+  docId: z.ZodOptional<z.ZodString>;
   layerName: z.ZodOptional<z.ZodString>;
   password: z.ZodOptional<z.ZodString>;
   passwordGrant: z.ZodOptional<z.ZodString>;
   mode: z.ZodOptional<z.ZodEnum<["any", "owner"]>>;
 }, "strip", z.ZodTypeAny, {
-  docId: string;
-  mode?: "owner" | "any" | undefined;
   password?: string | undefined;
+  docId?: string | undefined;
   layerName?: string | undefined;
   passwordGrant?: string | undefined;
-}, {
-  docId: string;
   mode?: "owner" | "any" | undefined;
+}, {
   password?: string | undefined;
+  docId?: string | undefined;
   layerName?: string | undefined;
   passwordGrant?: string | undefined;
+  mode?: "owner" | "any" | undefined;
 }>;
 type AccessRequest = z.infer<typeof AccessRequestSchema>;
 declare const DocumentSecurityStateSchema: z.ZodType<DocumentSecurityState>;
@@ -361,11 +364,11 @@ declare const AccessResponseSchema: z.ZodObject<{
     background: z.ZodEnum<["white"]>;
     enforced: z.ZodBoolean;
   }, "strip", z.ZodTypeAny, {
-    background: "white";
     fullPage: {
       widths: number[];
     };
     formats: ("webp" | "png")[];
+    background: "white";
     enforced: boolean;
     tiles?: {
       tileSizes: number[];
@@ -376,11 +379,11 @@ declare const AccessResponseSchema: z.ZodObject<{
     } | undefined;
     maxRenderPixels?: number | undefined;
   }, {
-    background: "white";
     fullPage: {
       widths: number[];
     };
     formats: ("webp" | "png")[];
+    background: "white";
     enforced: boolean;
     tiles?: {
       tileSizes: number[];
@@ -433,11 +436,11 @@ declare const AccessResponseSchema: z.ZodObject<{
     mode: "not-needed" | "client-retry" | "server-session";
   };
   renderPolicy?: {
-    background: "white";
     fullPage: {
       widths: number[];
     };
     formats: ("webp" | "png")[];
+    background: "white";
     enforced: boolean;
     tiles?: {
       tileSizes: number[];
@@ -490,11 +493,11 @@ declare const AccessResponseSchema: z.ZodObject<{
     mode: "not-needed" | "client-retry" | "server-session";
   };
   renderPolicy?: {
-    background: "white";
     fullPage: {
       widths: number[];
     };
     formats: ("webp" | "png")[];
+    background: "white";
     enforced: boolean;
     tiles?: {
       tileSizes: number[];
@@ -538,11 +541,12 @@ declare const DocumentManifestSchema: z.ZodType<DocumentManifest>;
 declare const AnnotationListPageSnapshotSchema: z.ZodType<AnnotationListPageSnapshot>;
 declare const AnnotationListSnapshotAllPagesSchema: z.ZodType<AnnotationListSnapshotAllPages>;
 /**
- * Wire shape of `GET /v1/docs/:docId/pages/:pon/text@contentVersion=N` and the
- * `pages.text` worker result. Carries the same `pageState` envelope
- * every page-scoped read returns, plus the full plain-text extraction
- * in display order and PDFium's char-count (which may exceed
- * `text.length / 1` when astral-plane characters are present).
+ * Wire shape of `GET …/text/pages/:pon/data@<contentVersion>` and the
+ * `pages.text` worker result: the UTF-16-faithful extraction, the CHARACTER
+ * space size (`charCount` — the space geometry runs tile; NOT `text.length`),
+ * and the optional character→text anchor map. Malformed maps are rejected
+ * here with the shared `charMapViolation` invariants — absent/empty map
+ * REQUIRES `charCount === text.length` (identity).
  */
 declare const PageTextSnapshotSchema: z.ZodType<PageTextSnapshot>;
 declare const PageGeometrySnapshotSchema: z.ZodType<PageGeometrySnapshot>;
@@ -669,6 +673,37 @@ declare const PageDeleteInputSchema: z.ZodType<PageDeleteInput>;
  * pages keep identity + revisions (see `PageDeleteResult`).
  */
 declare const PageDeleteResultSchema: z.ZodType<PageDeleteResult>;
+/**
+ * Page insert (bytes) input — the JSON `body` part of the multipart
+ * mutation envelope; the PDF itself rides the `resource:source` part.
+ * `destIndex` omitted → append.
+ */
+declare const PageInsertInputSchema: z.ZodType<{
+  destIndex?: number;
+}>;
+/**
+ * Blank-page insert input — plain JSON, pages.insert minus the bytes.
+ * `size` is in PDF points (un-rotated); `count` shares the contract cap
+ * with the worker so a request the schema accepts cannot then fail the
+ * worker's own guard.
+ */
+declare const PageInsertBlankInputSchema: z.ZodType<{
+  size: {
+    width: number;
+    height: number;
+  };
+  count?: number;
+  destIndex?: number;
+}>;
+/** Page extract input: the pages to export, in the order they should appear. */
+declare const PageExtractInputSchema: z.ZodType<{
+  pageObjectNumbers: number[];
+}>;
+/**
+ * Page insert result — shared by bytes-insert and blank-insert: the fresh
+ * PONs in insertion order plus the full new layout (see `PageInsertResult`).
+ */
+declare const PageInsertResultSchema: z.ZodType<PageInsertResult>;
 /**
  * Metadata write result. The Info dict is rewritten in place, so the
  * result returns the re-read `metadata` plus cloud coherence pins. No
@@ -769,6 +804,8 @@ declare const encodeMetadataToken: (metadataVersion: number) => string;
 declare const decodeMetadataToken: (raw: string) => number;
 declare const encodeAnnotationToken: (annotationVersion: number) => string;
 declare const decodeAnnotationToken: (raw: string) => number;
+declare const encodeAnnotationsAllToken: (annotationsVersion: number) => string;
+declare const decodeAnnotationsAllToken: (raw: string) => number;
 declare const encodeActionsToken: (actionsVersion: number) => string;
 declare const decodeActionsToken: (raw: string) => number;
 declare const encodeAttachmentsToken: (attachmentsVersion: number) => string;
@@ -813,6 +850,15 @@ interface SearchToken {
   skip: number;
   budget?: SearchSliceBudget;
 }
+/**
+ * The search RESULT representation this client speaks — part of the token
+ * (and therefore the versioned URL), so a response-shape change can never
+ * serve a stale CDN body to a newer client: new tokens are new cache keys,
+ * and old tokens fail decode on new servers. Deliberately ALWAYS encoded —
+ * an exception to the omit-defaults rule, because its entire job is to
+ * change the token bytes when the format changes.
+ */
+declare const SEARCH_RESULT_FORMAT = "segments1";
 declare const encodeSearchToken: (input: SearchToken) => string;
 declare const decodeSearchToken: (raw: string) => SearchToken;
 declare function encodeTokenText(text: string): string;
@@ -821,8 +867,21 @@ declare function decodeTokenText(encoded: string): string;
 //#region src/wire/paths.d.ts
 declare const DEFAULT_LAYER_NAME = "default";
 declare const wirePaths: {
-  /** POST: grant document access/caching credentials for the current bearer. */
-  readonly access: "/v1/access";
+  /**
+   * POST: grant access/caching credentials for the current bearer on
+   * the document + layer namespace the path names (cross-checked
+   * against the token like every layer route — the grant is
+   * layer-scoped in substance: CDN coverage, scopes, and the client's
+   * binding all carry the layer). Path-addressed so the affinity tier —
+   * the `X-CloudPDF-Doc` header derivation AND the chart's uri-mode
+   * regex — pins the session bootstrap to the document's pod from the
+   * very first request. Default-layer callers spell `layers/default/`,
+   * same as every other layer route.
+   */
+  readonly access: (docId: string, layerName: string) => string;
+  /** Deprecated alias (docId in the BODY) — served for one prerelease
+   *  cycle so pre-rename clients keep working; remove after. */
+  readonly accessLegacy: "/v1/access";
   /**
    * GET: open the document referenced by the doc-scoped JWT and
    * return its `DocumentHead`. The server materialises the base
@@ -959,6 +1018,8 @@ declare const wirePaths: {
    * object served from the base worker session.
    */
   readonly docPageAnnotations: (docId: string, pageObjectNumber: number, annotationVersion: number) => string;
+  /** Immutable BASE whole-document annotation listing (bulk hydration). */
+  readonly docAnnotationsAll: (docId: string, annotationsVersion: number) => string;
   /** Immutable BASE appearance batch (twin of
    *  `layerPageAnnotationAppearances` — same `annotations` plane gate). */
   readonly docPageAnnotationAppearances: (docId: string, pageObjectNumber: number, token: TokenInput) => string;
@@ -969,6 +1030,8 @@ declare const wirePaths: {
    * collection name — see file-level docstring.
    */
   readonly layerPageAnnotations: (docId: string, layerName: string, pageObjectNumber: number, annotationVersion: number) => string;
+  /** Immutable LAYER whole-document annotation listing (bulk hydration). */
+  readonly layerAnnotationsAll: (docId: string, layerName: string, annotationsVersion: number) => string;
   readonly layerPageAnnotationsCurrent: (docId: string, layerName: string, pageObjectNumber: number) => string;
   /**
    * GET: batch-rendered annotation appearance bitmaps for a single page as a
@@ -1047,6 +1110,20 @@ declare const wirePaths: {
   readonly layerPagesRotate: (docId: string, layerName: string) => string;
   readonly layerPagesDelete: (docId: string, layerName: string) => string;
   readonly layerPagesFlatten: (docId: string, layerName: string) => string;
+  /**
+   * POST (multipart mutation envelope): copy every page of the `source`
+   * resource part (a standalone PDF) in at the body's `destIndex`.
+   */
+  readonly layerPagesInsert: (docId: string, layerName: string) => string;
+  /** POST (plain JSON): create blank pages — pages.insert minus the bytes. */
+  readonly layerPagesInsertBlank: (docId: string, layerName: string) => string;
+  /**
+   * POST (plain JSON → `application/pdf` bytes): export the listed pages,
+   * in caller order, as a standalone PDF. A READ over the current layer
+   * state (gated like /download), so it is a POST only for its body —
+   * nothing mutates and no event is published.
+   */
+  readonly layerPagesExtract: (docId: string, layerName: string) => string;
   readonly layerRedactionsApply: (docId: string, layerName: string) => string;
   readonly layerEvents: (docId: string, layerName: string) => string;
   readonly layerDownload: (docId: string, layerName: string) => string;
@@ -1066,6 +1143,38 @@ declare const wirePaths: {
    */
   readonly docWarm: "/v1/warm";
 };
+/**
+ * Fastify-style templates for the PLAIN (unversioned) doc-plane routes —
+ * the backend-callable subset that the `@cloudpdf/contract` contract
+ * documents. The immutable `@{version}` variants above remain viewer
+ * protocol and are deliberately absent. These templates are the single
+ * statement of those paths: the contract package imports them, and the
+ * server's route table is pinned to them by the doc-plane registry
+ * conformance test.
+ */
+declare const wireTemplates: {
+  readonly docHead: "/v1/docs/:docId/head";
+  readonly layerManifest: "/v1/docs/:docId/layers/:layerName/manifest";
+  readonly layerMetadata: "/v1/docs/:docId/layers/:layerName/metadata";
+  readonly layerRenderPage: "/v1/docs/:docId/layers/:layerName/render/pages/:pon/data";
+  readonly layerTextPage: "/v1/docs/:docId/layers/:layerName/text/pages/:pon/data";
+  readonly layerAnnotationItemsAll: "/v1/docs/:docId/layers/:layerName/annotations/items";
+  readonly layerAnnotationItems: "/v1/docs/:docId/layers/:layerName/annotations/pages/:pon/items";
+  readonly layerAnnotationItem: "/v1/docs/:docId/layers/:layerName/annotations/pages/:pon/items/:annotKey";
+  readonly layerForm: "/v1/docs/:docId/layers/:layerName/form";
+  readonly layerFormFieldValue: "/v1/docs/:docId/layers/:layerName/form/fields/:fieldKey/value";
+  readonly layerFormFieldReset: "/v1/docs/:docId/layers/:layerName/form/fields/:fieldKey/reset";
+  readonly layerFormData: "/v1/docs/:docId/layers/:layerName/form/data";
+  readonly layerPagesMove: "/v1/docs/:docId/layers/:layerName/pages/move";
+  readonly layerPagesRotate: "/v1/docs/:docId/layers/:layerName/pages/rotate";
+  readonly layerPagesDelete: "/v1/docs/:docId/layers/:layerName/pages/delete";
+  readonly layerPagesFlatten: "/v1/docs/:docId/layers/:layerName/pages/flatten";
+  readonly layerPagesInsert: "/v1/docs/:docId/layers/:layerName/pages/insert";
+  readonly layerPagesInsertBlank: "/v1/docs/:docId/layers/:layerName/pages/insert-blank";
+  readonly layerPagesExtract: "/v1/docs/:docId/layers/:layerName/pages/extract";
+  readonly layerRedactionsApply: "/v1/docs/:docId/layers/:layerName/redactions/apply";
+  readonly layerDownload: "/v1/docs/:docId/layers/:layerName/download";
+};
 //#endregion
 //#region src/wire/resources.d.ts
 /**
@@ -1077,7 +1186,7 @@ declare const wirePaths: {
  *   3. Update the route handler to call `requireResource(req, docId, '<id>', pdfBits)`
  *   4. CDN signer automatically considers it
  */
-type DocResourceId = 'head' | 'manifest' | 'page-render' | 'page-render-annotated' | 'page-text' | 'page-geometry' | 'page-annotations' | 'layout' | 'metadata' | 'actions' | 'attachments' | 'attachment-files' | 'layer-manifest' | 'layer-layout' | 'layer-metadata' | 'layer-actions' | 'layer-page-render' | 'layer-page-render-annotated' | 'layer-page-text' | 'layer-page-geometry' | 'layer-search-rects' | 'layer-search-full' | 'annotations-read' | 'layer-attachments' | 'layer-attachment-files' | 'download-current' | 'download-versioned';
+type DocResourceId = 'head' | 'manifest' | 'page-render' | 'page-render-annotated' | 'page-text' | 'page-geometry' | 'page-annotations' | 'annotations-all' | 'layout' | 'metadata' | 'actions' | 'attachments' | 'attachment-files' | 'layer-manifest' | 'layer-layout' | 'layer-metadata' | 'layer-actions' | 'layer-page-render' | 'layer-page-render-annotated' | 'layer-page-text' | 'layer-page-geometry' | 'layer-search-rects' | 'layer-search-full' | 'annotations-read' | 'layer-annotations-all' | 'layer-attachments' | 'layer-attachment-files' | 'download-current' | 'download-versioned';
 /**
  * 'origin' — unversioned URL, response can change over time. CDN must
  * not cache (the bytes are not immutable). Routed straight to origin
@@ -1323,7 +1432,7 @@ declare const RenderTokenSchema: {
  * permission tiers must never share cache entries).
  */
 declare const SearchTokenSchema: {
-  readonly fields: readonly ["epoch", "matchCase", "matchDiacritics", "maxMatches", "maxPages", "q", "regex", "skip", "startPage", "wholeWord"];
+  readonly fields: readonly ["epoch", "format", "matchCase", "matchDiacritics", "maxMatches", "maxPages", "q", "regex", "skip", "startPage", "wholeWord"];
   readonly maxLength: 2048;
 };
 /**
@@ -1484,6 +1593,7 @@ declare const AnnotationBaseShape: {
   readonly flags: z.ZodType<AnnotationFlags, z.ZodTypeDef, AnnotationFlags>;
   readonly rect: z.ZodType<PdfRect, z.ZodTypeDef, PdfRect>;
   readonly contents: z.ZodNullable<z.ZodString>;
+  readonly subject: z.ZodNullable<z.ZodString>;
   readonly author: z.ZodNullable<z.ZodString>;
   readonly created: z.ZodNullable<z.ZodString>;
   readonly modified: z.ZodNullable<z.ZodString>;
@@ -1506,6 +1616,7 @@ declare const AnnotationBaseShape: {
  */
 declare const AnnotationDraftBaseShape: {
   readonly contents: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+  readonly subject: z.ZodOptional<z.ZodNullable<z.ZodString>>;
   readonly blendMode: z.ZodOptional<z.ZodType<BlendMode, z.ZodTypeDef, BlendMode>>;
   readonly nm: z.ZodOptional<z.ZodString>;
   readonly flags: z.ZodOptional<z.ZodType<Partial<AnnotationFlags>, z.ZodTypeDef, Partial<AnnotationFlags>>>;
@@ -1524,6 +1635,7 @@ declare const AnnotationDraftBaseShape: {
  */
 declare const AnnotationPatchBaseShape: {
   readonly contents: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+  readonly subject: z.ZodOptional<z.ZodNullable<z.ZodString>>;
   readonly blendMode: z.ZodOptional<z.ZodType<BlendMode, z.ZodTypeDef, BlendMode>>;
   readonly groupId: z.ZodOptional<z.ZodString>;
   readonly flags: z.ZodOptional<z.ZodType<Partial<AnnotationFlags>, z.ZodTypeDef, Partial<AnnotationFlags>>>;
@@ -1542,5 +1654,5 @@ declare const AttachmentFileInfoSchema: z.ZodType<AttachmentFileInfo>;
 declare const EmbeddedFileRefSchema: z.ZodType<EmbeddedFileRef>;
 declare const EmbeddedFileItemSchema: z.ZodType<EmbeddedFileItem>;
 //#endregion
-export { ANNOTATION_KINDS, type AccessRequest, AccessRequestSchema, type AccessResponse, AccessResponseSchema, ActionsTokenSchema, AnnotationAppearanceManifestSchema, AnnotationAppearancesQuerySchema, AnnotationAppearancesRenderTokenSchema, AnnotationBaseShape, AnnotationBorderStyleSchema, AnnotationCreateResultSchema, AnnotationDTOSchema, AnnotationDeleteResultSchema, AnnotationDraftBaseShape, AnnotationDraftSchema, AnnotationFlagsPartialSchema, AnnotationFlagsSchema, AnnotationListMutationMetaSchema, AnnotationListPageSnapshotSchema, AnnotationListSnapshotAllPagesSchema, AnnotationMoveResultSchema, AnnotationPatchBaseShape, AnnotationPatchSchema, AnnotationRefSchema, type AnnotationRenderVersion, AnnotationStableIdSchema, AnnotationTokenSchema, AnnotationUpdateResultSchema, AppearanceOutcomeSchema, type ApplyCdnAccessInput, type ApplyCdnAccessResult, AttachmentCreateResultSchema, AttachmentDeleteResultSchema, AttachmentFileInfoSchema, AttachmentsCacheSchema, BlendModeSchema, type CacheDelta, CacheDeltaSchema, CachePinsSchema, CalloutLineSchema, type CapabilityRequirement, CaretDTOSchema, CaretDraftSchema, CaretIntentSchema, CaretPatchSchema, type CdnAccessInfoForApply, type CdnCoverageEntry, CircleDTOSchema, CircleDraftSchema, CirclePatchSchema, ColorSchema, ContentTokenSchema, DEFAULT_LAYER_NAME, DOC_RESOURCES, type DocResourceDescriptor, type DocResourceId, DocTokenSchema, DocumentActionsSnapshotSchema, type DocumentHead, DocumentHeadSchema, type DocumentManifest, DocumentManifestSchema, DocumentMetadataSchema, DocumentSecurityStateSchema, type DownloadToken, EmbeddedFileItemSchema, EmbeddedFileRefSchema, EngineErrorPayloadSchema, FileAttachmentDTOSchema, FileAttachmentIconSchema, FileAttachmentPatchSchema, FileAttachmentWireDraftSchema, FormDataFormatSchema, FormEffectSchema, FormEffectsResultSchema, FormFieldCreateResultSchema, FormFieldDTOSchema, FormFieldDeleteResultSchema, FormFieldDraftSchema, FormFieldFlagsSchema, FormFieldOptionInputSchema, FormFieldOptionSchema, FormFieldPatchSchema, FormFieldRefSchema, FormFieldUpdateResultSchema, FormFieldValueSchema, FormImportResultSchema, FormKindSchema, FormRepairResultSchema, FormSetValueResultSchema, FormSnapshotSchema, FormValueEntrySchema, FormWidgetLinkResultSchema, FormWidgetRefSchema, FreeTextDTOSchema, FreeTextDraftSchema, FreeTextIntentSchema, FreeTextPatchSchema, HighlightDTOSchema, HighlightDraftSchema, HighlightPatchSchema, InkDTOSchema, InkDraftSchema, InkIntentSchema, InkListSchema, InkPatchSchema, KIND_BY_SUBTYPE, type LayerScopePlane, type LayerScopes, LayerScopesSchema, LayoutTokenSchema, LineDTOSchema, LineDraftSchema, LineEndingSchema, LineEndingsSchema, LinePatchSchema, LinePointsSchema, LinkDTOSchema, LinkDraftSchema, LinkPatchSchema, type ManifestPage, ManifestPageSchema, MetadataPatchSchema, MetadataTokenSchema, MetadataUpdateResultSchema, type MutationMeta, MutationMetaSchema, NoteIconSchema, type OpenDocumentResponse, OpenDocumentResponseSchema, PageBoxesSchema, PageDeleteInputSchema, PageDeleteResultSchema, PageFlattenInputSchema, PageFlattenResultSchema, PageGeometrySnapshotSchema, PageLayoutSchema, PageListSnapshotSchema, PageMoveInputSchema, PageMoveResultSchema, PageNetworkRenderFormatSchema, PageRenderAnnotatedQuerySchema, PageRenderQuerySchema, PageRotateInputSchema, PageRotateResultSchema, PageStateSchema, PageStructureCacheSchema, PageTextSnapshotSchema, PdfActionNodeSchema, PdfActionTreeSchema, PdfActionTypeSchema, PdfAnnotationActionsSchema, PdfDestinationSchema, PdfFieldActionsSchema, PdfLinkTargetSchema, PdfLinkTargetWritableSchema, PdfPageActionsSchema, PdfPointSchema, PdfQuadSchema, PdfRectDifferencesSchema, PdfRectSchema, PdfRotationSchema, PdfSaveModeSchema, PdfSizeSchema, PointSchema, PolygonDTOSchema, PolygonDraftSchema, PolygonPatchSchema, PolylineDTOSchema, PolylineDraftSchema, PolylinePatchSchema, RectSchema, RedactionApplyResultSchema, RedactionApplyScopeSchema, RefetchReasonSchema, type RenderPolicy, RenderTokenSchema, type RenderVersions, ResourceRefSchema, RevisionTokenSchema, type RouteKind, SearchMatchSchema, SearchModeSchema, SearchQuerySchema, SearchRequestSchema, SearchSliceSchema, SearchSnippetSchema, type SearchToken, SearchTokenSchema, SquareDTOSchema, SquareDraftSchema, SquarePatchSchema, SquigglyDTOSchema, SquigglyDraftSchema, SquigglyPatchSchema, StampDTOSchema, StampWireDraftSchema, StampWirePatchSchema, StandardFontSchema, StrikeoutDTOSchema, StrikeoutDraftSchema, StrikeoutIntentSchema, StrikeoutPatchSchema, TextAlignmentSchema, TextDTOSchema, TextDraftSchema, TextPatchSchema, ToggleFieldWidgetSchema, type TokenInput, type TokenQuery, type TokenScalar, type TokenSchema, UnderlineDTOSchema, UnderlineDraftSchema, UnderlinePatchSchema, UnsupportedDTOSchema, UnsupportedDraftSchema, UnsupportedPatchSchema, type WeakAnnotationSessionPagesRequest, WeakAnnotationSessionPagesRequestSchema, type WeakAnnotationSessionResponse, WeakAnnotationSessionResponseSchema, WidgetAppearanceSchema, WidgetPlacementSchema, WireAttachmentFileSchema, type WireFlat, type WireScalar, annotationAppearancesImageOptionsToToken, annotationAppearancesImageOptionsToWire, annotationRenderOptionsFromImageOptions, applyCdnAccess, cdnCoverageForScope, checkResourceAccess, decodeActionsToken, decodeAnnotationAppearancesRenderToken, decodeAnnotationToken, decodeAttachmentsToken, decodeContentToken, decodeDocToken, decodeDownloadToken, decodeLayoutToken, decodeMetadataToken, decodeRenderToken, decodeSearchToken, decodeToken, decodeTokenText, encodeActionsToken, encodeAnnotationAppearancesRenderToken, encodeAnnotationToken, encodeAttachmentsToken, encodeContentToken, encodeDocToken, encodeDownloadToken, encodeLayoutToken, encodeMetadataToken, encodeRenderToken, encodeSearchToken, encodeToken, encodeTokenText, flatten, pageRenderOptionsFromImageOptions, renderImageOptionsToToken, renderImageOptionsToWire, resolveResourceIdForPath, unflatten, wirePaths };
+export { ANNOTATION_KINDS, type AccessRequest, AccessRequestSchema, type AccessResponse, AccessResponseSchema, ActionsTokenSchema, AnnotationAppearanceManifestSchema, AnnotationAppearancesQuerySchema, AnnotationAppearancesRenderTokenSchema, AnnotationBaseShape, AnnotationBorderStyleSchema, AnnotationCreateResultSchema, AnnotationDTOSchema, AnnotationDeleteResultSchema, AnnotationDraftBaseShape, AnnotationDraftSchema, AnnotationFlagsPartialSchema, AnnotationFlagsSchema, AnnotationListMutationMetaSchema, AnnotationListPageSnapshotSchema, AnnotationListSnapshotAllPagesSchema, AnnotationMoveResultSchema, AnnotationPatchBaseShape, AnnotationPatchSchema, AnnotationRefSchema, type AnnotationRenderVersion, AnnotationStableIdSchema, AnnotationTokenSchema, AnnotationUpdateResultSchema, AppearanceOutcomeSchema, type ApplyCdnAccessInput, type ApplyCdnAccessResult, AttachmentCreateResultSchema, AttachmentDeleteResultSchema, AttachmentFileInfoSchema, AttachmentsCacheSchema, BlendModeSchema, type CacheDelta, CacheDeltaSchema, CachePinsSchema, CalloutLineSchema, type CapabilityRequirement, CaretDTOSchema, CaretDraftSchema, CaretIntentSchema, CaretPatchSchema, type CdnAccessInfoForApply, type CdnCoverageEntry, CircleDTOSchema, CircleDraftSchema, CirclePatchSchema, ColorSchema, ContentTokenSchema, DEFAULT_LAYER_NAME, DOC_RESOURCES, type DocResourceDescriptor, type DocResourceId, DocTokenSchema, DocumentActionsSnapshotSchema, type DocumentHead, DocumentHeadSchema, type DocumentManifest, DocumentManifestSchema, DocumentMetadataSchema, DocumentSecurityStateSchema, type DownloadToken, EmbeddedFileItemSchema, EmbeddedFileRefSchema, EngineErrorPayloadSchema, FileAttachmentDTOSchema, FileAttachmentIconSchema, FileAttachmentPatchSchema, FileAttachmentWireDraftSchema, FormDataFormatSchema, FormEffectSchema, FormEffectsResultSchema, FormFieldCreateResultSchema, FormFieldDTOSchema, FormFieldDeleteResultSchema, FormFieldDraftSchema, FormFieldFlagsSchema, FormFieldOptionInputSchema, FormFieldOptionSchema, FormFieldPatchSchema, FormFieldRefSchema, FormFieldUpdateResultSchema, FormFieldValueSchema, FormImportResultSchema, FormKindSchema, FormRepairResultSchema, FormSetValueResultSchema, FormSnapshotSchema, FormValueEntrySchema, FormWidgetLinkResultSchema, FormWidgetRefSchema, FreeTextDTOSchema, FreeTextDraftSchema, FreeTextIntentSchema, FreeTextPatchSchema, HighlightDTOSchema, HighlightDraftSchema, HighlightPatchSchema, InkDTOSchema, InkDraftSchema, InkIntentSchema, InkListSchema, InkPatchSchema, KIND_BY_SUBTYPE, type LayerScopePlane, type LayerScopes, LayerScopesSchema, LayoutTokenSchema, LineDTOSchema, LineDraftSchema, LineEndingSchema, LineEndingsSchema, LinePatchSchema, LinePointsSchema, LinkDTOSchema, LinkDraftSchema, LinkPatchSchema, type ManifestPage, ManifestPageSchema, MetadataPatchSchema, MetadataTokenSchema, MetadataUpdateResultSchema, type MutationMeta, MutationMetaSchema, NoteIconSchema, type OpenDocumentResponse, OpenDocumentResponseSchema, PageBoxesSchema, PageDeleteInputSchema, PageDeleteResultSchema, PageExtractInputSchema, PageFlattenInputSchema, PageFlattenResultSchema, PageGeometrySnapshotSchema, PageInsertBlankInputSchema, PageInsertInputSchema, PageInsertResultSchema, PageLayoutSchema, PageListSnapshotSchema, PageMoveInputSchema, PageMoveResultSchema, PageNetworkRenderFormatSchema, PageRenderAnnotatedQuerySchema, PageRenderQuerySchema, PageRotateInputSchema, PageRotateResultSchema, PageStateSchema, PageStructureCacheSchema, PageTextSnapshotSchema, PdfActionNodeSchema, PdfActionTreeSchema, PdfActionTypeSchema, PdfAnnotationActionsSchema, PdfDestinationSchema, PdfFieldActionsSchema, PdfLinkTargetSchema, PdfLinkTargetWritableSchema, PdfPageActionsSchema, PdfPointSchema, PdfQuadSchema, PdfRectDifferencesSchema, PdfRectSchema, PdfRotationSchema, PdfSaveModeSchema, PdfSizeSchema, PointSchema, PolygonDTOSchema, PolygonDraftSchema, PolygonPatchSchema, PolylineDTOSchema, PolylineDraftSchema, PolylinePatchSchema, RectSchema, RedactionApplyResultSchema, RedactionApplyScopeSchema, RefetchReasonSchema, type RenderPolicy, RenderTokenSchema, type RenderVersions, ResourceRefSchema, RevisionTokenSchema, type RouteKind, SEARCH_RESULT_FORMAT, SearchMatchSchema, SearchModeSchema, SearchQuerySchema, SearchRequestSchema, SearchSliceSchema, SearchSnippetSchema, type SearchToken, SearchTokenSchema, SquareDTOSchema, SquareDraftSchema, SquarePatchSchema, SquigglyDTOSchema, SquigglyDraftSchema, SquigglyPatchSchema, StampDTOSchema, StampWireDraftSchema, StampWirePatchSchema, StandardFontSchema, StrikeoutDTOSchema, StrikeoutDraftSchema, StrikeoutIntentSchema, StrikeoutPatchSchema, TextAlignmentSchema, TextDTOSchema, TextDraftSchema, TextPatchSchema, ToggleFieldWidgetSchema, type TokenInput, type TokenQuery, type TokenScalar, type TokenSchema, UnderlineDTOSchema, UnderlineDraftSchema, UnderlinePatchSchema, UnsupportedDTOSchema, UnsupportedDraftSchema, UnsupportedPatchSchema, type WeakAnnotationSessionPagesRequest, WeakAnnotationSessionPagesRequestSchema, type WeakAnnotationSessionResponse, WeakAnnotationSessionResponseSchema, WidgetAppearanceSchema, WidgetPlacementSchema, WireAttachmentFileSchema, type WireFlat, type WireScalar, annotationAppearancesImageOptionsToToken, annotationAppearancesImageOptionsToWire, annotationRenderOptionsFromImageOptions, applyCdnAccess, cdnCoverageForScope, checkResourceAccess, decodeActionsToken, decodeAnnotationAppearancesRenderToken, decodeAnnotationToken, decodeAnnotationsAllToken, decodeAttachmentsToken, decodeContentToken, decodeDocToken, decodeDownloadToken, decodeLayoutToken, decodeMetadataToken, decodeRenderToken, decodeSearchToken, decodeToken, decodeTokenText, encodeActionsToken, encodeAnnotationAppearancesRenderToken, encodeAnnotationToken, encodeAnnotationsAllToken, encodeAttachmentsToken, encodeContentToken, encodeDocToken, encodeDownloadToken, encodeLayoutToken, encodeMetadataToken, encodeRenderToken, encodeSearchToken, encodeToken, encodeTokenText, flatten, pageRenderOptionsFromImageOptions, renderImageOptionsToToken, renderImageOptionsToWire, resolveResourceIdForPath, unflatten, wirePaths, wireTemplates };
 //# sourceMappingURL=wire.d.ts.map