@cloudpdf/contract 3.0.0-next.11 → 3.0.0-next.13

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/dist/index.d.ts CHANGED
@@ -5560,6 +5560,116 @@ declare const DocFieldParamsSchema: z.ZodObject<{
5560
5560
  * passwords in headers — they use the SDK's password-session flow.
5561
5561
  */
5562
5562
  declare const documentPasswordHeader: AdminOperationHeader;
5563
+ declare const DocSigningParamsSchema: z.ZodObject<{
5564
+ docId: z.ZodString;
5565
+ } & {
5566
+ layerName: z.ZodString;
5567
+ } & {
5568
+ signingId: z.ZodString;
5569
+ }, "strip", z.ZodTypeAny, {
5570
+ docId: string;
5571
+ layerName: string;
5572
+ signingId: string;
5573
+ }, {
5574
+ docId: string;
5575
+ layerName: string;
5576
+ signingId: string;
5577
+ }>;
5578
+ declare const DocVersionParamsSchema: z.ZodObject<{
5579
+ docId: z.ZodString;
5580
+ } & {
5581
+ sha: z.ZodString;
5582
+ }, "strip", z.ZodTypeAny, {
5583
+ docId: string;
5584
+ sha: string;
5585
+ }, {
5586
+ docId: string;
5587
+ sha: string;
5588
+ }>;
5589
+ declare const DocVersionFieldParamsSchema: z.ZodObject<{
5590
+ docId: z.ZodString;
5591
+ } & {
5592
+ sha: z.ZodString;
5593
+ } & {
5594
+ fieldKey: z.ZodString;
5595
+ }, "strip", z.ZodTypeAny, {
5596
+ docId: string;
5597
+ fieldKey: string;
5598
+ sha: string;
5599
+ }, {
5600
+ docId: string;
5601
+ fieldKey: string;
5602
+ sha: string;
5603
+ }>;
5604
+ declare const DocVersionDigestParamsSchema: z.ZodObject<{
5605
+ docId: z.ZodString;
5606
+ } & {
5607
+ sha: z.ZodString;
5608
+ } & {
5609
+ fieldKey: z.ZodString;
5610
+ } & {
5611
+ algorithm: z.ZodEnum<["sha1", "sha256", "sha384", "sha512"]>;
5612
+ }, "strip", z.ZodTypeAny, {
5613
+ docId: string;
5614
+ fieldKey: string;
5615
+ sha: string;
5616
+ algorithm: "sha256" | "sha1" | "sha384" | "sha512";
5617
+ }, {
5618
+ docId: string;
5619
+ fieldKey: string;
5620
+ sha: string;
5621
+ algorithm: "sha256" | "sha1" | "sha384" | "sha512";
5622
+ }>;
5623
+ declare const DocVersionRevisionParamsSchema: z.ZodObject<{
5624
+ docId: z.ZodString;
5625
+ } & {
5626
+ sha: z.ZodString;
5627
+ } & {
5628
+ index: z.ZodNumber;
5629
+ }, "strip", z.ZodTypeAny, {
5630
+ docId: string;
5631
+ sha: string;
5632
+ index: number;
5633
+ }, {
5634
+ docId: string;
5635
+ sha: string;
5636
+ index: number;
5637
+ }>;
5638
+ /** The flat analysis query: exactly one `since.*`; `level` only in exploratory mode. */
5639
+ declare const LayerSignaturesAnalysisQuerySchema: z.ZodObject<{
5640
+ 'since.signature': z.ZodOptional<z.ZodNumber>;
5641
+ 'since.revision': z.ZodOptional<z.ZodNumber>;
5642
+ level: z.ZodOptional<z.ZodEnum<["none", "lta", "fill", "annotate"]>>;
5643
+ }, "strip", z.ZodTypeAny, {
5644
+ 'since.signature'?: number | undefined;
5645
+ 'since.revision'?: number | undefined;
5646
+ level?: "fill" | "none" | "lta" | "annotate" | undefined;
5647
+ }, {
5648
+ 'since.signature'?: number | undefined;
5649
+ 'since.revision'?: number | undefined;
5650
+ level?: "fill" | "none" | "lta" | "annotate" | undefined;
5651
+ }>;
5652
+ declare const VersionAnalysisQuerySchema: z.ZodObject<{
5653
+ 'since.signature': z.ZodOptional<z.ZodNumber>;
5654
+ 'since.revision': z.ZodOptional<z.ZodNumber>;
5655
+ level: z.ZodOptional<z.ZodEnum<["none", "lta", "fill", "annotate"]>>;
5656
+ } & {
5657
+ until: z.ZodOptional<z.ZodNumber>;
5658
+ /** The judging policy version the caller expects — a cache key on this immutable URL, not an input. */
5659
+ policy: z.ZodOptional<z.ZodNumber>;
5660
+ }, "strip", z.ZodTypeAny, {
5661
+ 'since.signature'?: number | undefined;
5662
+ 'since.revision'?: number | undefined;
5663
+ level?: "fill" | "none" | "lta" | "annotate" | undefined;
5664
+ until?: number | undefined;
5665
+ policy?: number | undefined;
5666
+ }, {
5667
+ 'since.signature'?: number | undefined;
5668
+ 'since.revision'?: number | undefined;
5669
+ level?: "fill" | "none" | "lta" | "annotate" | undefined;
5670
+ until?: number | undefined;
5671
+ policy?: number | undefined;
5672
+ }>;
5563
5673
  declare const docOperations: {
5564
5674
  readonly 'doc.head': {
5565
5675
  readonly operationId: "doc.head";
@@ -5750,123 +5860,98 @@ declare const docOperations: {
5750
5860
  };
5751
5861
  };
5752
5862
  };
5753
- readonly 'doc.render': {
5754
- readonly operationId: "doc.render";
5755
- readonly title: "Render page";
5756
- readonly summary: "Render one page as an image at the current layer version.";
5863
+ readonly 'doc.signatures.list': {
5864
+ readonly operationId: "doc.signatures.list";
5865
+ readonly title: "List signatures";
5866
+ readonly summary: "The layer view of digital signatures: revisions, every signature field with its signed state, and the protection in force.";
5757
5867
  readonly method: "GET";
5758
- readonly path: "/v1/docs/:docId/layers/:layerName/render/pages/:pon/data";
5868
+ readonly path: "/v1/docs/:docId/layers/:layerName/signatures";
5759
5869
  readonly credentials: readonly ["api-token", "doc-jwt"];
5760
5870
  readonly scope: readonly [];
5761
- readonly docCapabilities: readonly ["doc.render"];
5871
+ readonly docCapabilities: readonly ["doc.forms.read"];
5762
5872
  readonly requestHeaders: readonly [AdminOperationHeader];
5763
5873
  readonly params: z.ZodObject<{
5764
5874
  docId: z.ZodString;
5765
5875
  } & {
5766
5876
  layerName: z.ZodString;
5767
- } & {
5768
- pon: z.ZodNumber;
5769
5877
  }, "strip", z.ZodTypeAny, {
5770
5878
  docId: string;
5771
5879
  layerName: string;
5772
- pon: number;
5773
5880
  }, {
5774
5881
  docId: string;
5775
5882
  layerName: string;
5776
- pon: number;
5777
5883
  }>;
5778
- readonly notes: string;
5779
5884
  readonly responses: {
5780
5885
  readonly 200: {
5781
- readonly contentType: "image/webp";
5886
+ readonly contentType: "application/json";
5887
+ readonly schema: z.ZodType<_embedpdf_engine_core_runtime.SignatureSnapshot, z.ZodTypeDef, _embedpdf_engine_core_runtime.SignatureSnapshot>;
5782
5888
  };
5783
5889
  readonly 404: {
5784
5890
  readonly contentType: "application/json";
5785
5891
  readonly schema: z.ZodType<_embedpdf_engine_core_runtime.SerializedEngineError, z.ZodTypeDef, _embedpdf_engine_core_runtime.SerializedEngineError>;
5786
5892
  };
5787
5893
  };
5894
+ readonly notes: string;
5788
5895
  };
5789
- readonly 'doc.text': {
5790
- readonly operationId: "doc.text";
5791
- readonly title: "Extract page text";
5792
- readonly summary: "Extracted text content for one page.";
5896
+ readonly 'doc.signatures.analysis': {
5897
+ readonly operationId: "doc.signatures.analysis";
5898
+ readonly title: "Analyze layer changes";
5899
+ readonly summary: "What the layer changed after a signature (or after any revision), judged against the restrictions in force.";
5793
5900
  readonly method: "GET";
5794
- readonly path: "/v1/docs/:docId/layers/:layerName/text/pages/:pon/data";
5901
+ readonly path: "/v1/docs/:docId/layers/:layerName/signatures/analysis";
5795
5902
  readonly credentials: readonly ["api-token", "doc-jwt"];
5796
5903
  readonly scope: readonly [];
5797
- readonly docCapabilities: readonly ["doc.text.copy"];
5904
+ readonly docCapabilities: readonly ["doc.forms.read"];
5798
5905
  readonly requestHeaders: readonly [AdminOperationHeader];
5799
5906
  readonly params: z.ZodObject<{
5800
5907
  docId: z.ZodString;
5801
5908
  } & {
5802
5909
  layerName: z.ZodString;
5803
- } & {
5804
- pon: z.ZodNumber;
5805
5910
  }, "strip", z.ZodTypeAny, {
5806
5911
  docId: string;
5807
5912
  layerName: string;
5808
- pon: number;
5809
5913
  }, {
5810
5914
  docId: string;
5811
5915
  layerName: string;
5812
- pon: number;
5813
5916
  }>;
5814
- readonly responses: {
5815
- readonly 200: {
5816
- readonly contentType: "application/json";
5817
- readonly schema: z.ZodType<_embedpdf_engine_core_runtime.PageTextSnapshot, z.ZodTypeDef, _embedpdf_engine_core_runtime.PageTextSnapshot>;
5818
- };
5819
- readonly 404: {
5820
- readonly contentType: "application/json";
5821
- readonly schema: z.ZodType<_embedpdf_engine_core_runtime.SerializedEngineError, z.ZodTypeDef, _embedpdf_engine_core_runtime.SerializedEngineError>;
5822
- };
5823
- };
5824
- };
5825
- readonly 'doc.annotations.list': {
5826
- readonly operationId: "doc.annotations.list";
5827
- readonly title: "List annotations";
5828
- readonly summary: "One page's annotations at the current layer version.";
5829
- readonly method: "GET";
5830
- readonly path: "/v1/docs/:docId/layers/:layerName/annotations/pages/:pon/items";
5831
- readonly credentials: readonly ["api-token", "doc-jwt"];
5832
- readonly scope: readonly [];
5833
- readonly docCapabilities: readonly ["doc.annotate.read"];
5834
- readonly requestHeaders: readonly [AdminOperationHeader];
5835
- readonly params: z.ZodObject<{
5836
- docId: z.ZodString;
5837
- } & {
5838
- layerName: z.ZodString;
5839
- } & {
5840
- pon: z.ZodNumber;
5917
+ readonly query: z.ZodObject<{
5918
+ 'since.signature': z.ZodOptional<z.ZodNumber>;
5919
+ 'since.revision': z.ZodOptional<z.ZodNumber>;
5920
+ level: z.ZodOptional<z.ZodEnum<["none", "lta", "fill", "annotate"]>>;
5841
5921
  }, "strip", z.ZodTypeAny, {
5842
- docId: string;
5843
- layerName: string;
5844
- pon: number;
5922
+ 'since.signature'?: number | undefined;
5923
+ 'since.revision'?: number | undefined;
5924
+ level?: "fill" | "none" | "lta" | "annotate" | undefined;
5845
5925
  }, {
5846
- docId: string;
5847
- layerName: string;
5848
- pon: number;
5926
+ 'since.signature'?: number | undefined;
5927
+ 'since.revision'?: number | undefined;
5928
+ level?: "fill" | "none" | "lta" | "annotate" | undefined;
5849
5929
  }>;
5850
5930
  readonly responses: {
5851
5931
  readonly 200: {
5852
5932
  readonly contentType: "application/json";
5853
- readonly schema: z.ZodType<_embedpdf_engine_core_runtime.AnnotationListPageSnapshot, z.ZodTypeDef, _embedpdf_engine_core_runtime.AnnotationListPageSnapshot>;
5933
+ readonly schema: z.ZodType<_embedpdf_engine_core_runtime.ChangeAnalysis, z.ZodTypeDef, _embedpdf_engine_core_runtime.ChangeAnalysis>;
5934
+ };
5935
+ readonly 400: {
5936
+ readonly contentType: "application/json";
5937
+ readonly schema: z.ZodType<_embedpdf_engine_core_runtime.SerializedEngineError, z.ZodTypeDef, _embedpdf_engine_core_runtime.SerializedEngineError>;
5854
5938
  };
5855
5939
  readonly 404: {
5856
5940
  readonly contentType: "application/json";
5857
5941
  readonly schema: z.ZodType<_embedpdf_engine_core_runtime.SerializedEngineError, z.ZodTypeDef, _embedpdf_engine_core_runtime.SerializedEngineError>;
5858
5942
  };
5859
5943
  };
5944
+ readonly notes: string;
5860
5945
  };
5861
- readonly 'doc.annotations.listAll': {
5862
- readonly operationId: "doc.annotations.listAll";
5863
- readonly title: "List all annotations";
5864
- readonly summary: "All pages' annotations as one coherent snapshot at the current layer version.";
5865
- readonly method: "GET";
5866
- readonly path: "/v1/docs/:docId/layers/:layerName/annotations/items";
5946
+ readonly 'doc.signatures.prepare': {
5947
+ readonly operationId: "doc.signatures.prepare";
5948
+ readonly title: "Prepare a signature";
5949
+ readonly summary: "Author and seal a signing candidate; returns the digest to sign and the version fences.";
5950
+ readonly method: "POST";
5951
+ readonly path: "/v1/docs/:docId/layers/:layerName/signatures/prepare";
5867
5952
  readonly credentials: readonly ["api-token", "doc-jwt"];
5868
5953
  readonly scope: readonly [];
5869
- readonly docCapabilities: readonly ["doc.annotate.read"];
5954
+ readonly docCapabilities: readonly ["doc.sign"];
5870
5955
  readonly requestHeaders: readonly [AdminOperationHeader];
5871
5956
  readonly params: z.ZodObject<{
5872
5957
  docId: z.ZodString;
@@ -5879,11 +5964,44 @@ declare const docOperations: {
5879
5964
  docId: string;
5880
5965
  layerName: string;
5881
5966
  }>;
5882
- readonly notes: "Returns one entry per page plus the audit-log cursor for reconciling subsequent document events. Page order is unspecified; join by `pageState.pageObjectNumber` when display order matters.";
5967
+ readonly body: {
5968
+ readonly contentType: "multipart/form-data";
5969
+ };
5883
5970
  readonly responses: {
5884
5971
  readonly 200: {
5885
5972
  readonly contentType: "application/json";
5886
- readonly schema: z.ZodType<_embedpdf_engine_core_runtime.AnnotationListSnapshotAllPages, z.ZodTypeDef, _embedpdf_engine_core_runtime.AnnotationListSnapshotAllPages>;
5973
+ readonly schema: z.ZodObject<{
5974
+ signingId: z.ZodString;
5975
+ digest: z.ZodString;
5976
+ algorithm: z.ZodEnum<["sha256", "sha384", "sha512"]>;
5977
+ byteRange: z.ZodTuple<[z.ZodNumber, z.ZodNumber, z.ZodNumber, z.ZodNumber], null>;
5978
+ contentsSize: z.ZodNumber;
5979
+ subFilter: z.ZodString;
5980
+ expectedVersion: z.ZodType<_embedpdf_engine_core_runtime.DocumentVersionRef, z.ZodTypeDef, _embedpdf_engine_core_runtime.DocumentVersionRef>;
5981
+ expiresAt: z.ZodNullable<z.ZodString>;
5982
+ }, "strip", z.ZodTypeAny, {
5983
+ expiresAt: string | null;
5984
+ signingId: string;
5985
+ digest: string;
5986
+ algorithm: "sha256" | "sha384" | "sha512";
5987
+ byteRange: [number, number, number, number];
5988
+ contentsSize: number;
5989
+ subFilter: string;
5990
+ expectedVersion: _embedpdf_engine_core_runtime.DocumentVersionRef;
5991
+ }, {
5992
+ expiresAt: string | null;
5993
+ signingId: string;
5994
+ digest: string;
5995
+ algorithm: "sha256" | "sha384" | "sha512";
5996
+ byteRange: [number, number, number, number];
5997
+ contentsSize: number;
5998
+ subFilter: string;
5999
+ expectedVersion: _embedpdf_engine_core_runtime.DocumentVersionRef;
6000
+ }>;
6001
+ };
6002
+ readonly 400: {
6003
+ readonly contentType: "application/json";
6004
+ readonly schema: z.ZodType<_embedpdf_engine_core_runtime.SerializedEngineError, z.ZodTypeDef, _embedpdf_engine_core_runtime.SerializedEngineError>;
5887
6005
  };
5888
6006
  readonly 404: {
5889
6007
  readonly contentType: "application/json";
@@ -5894,47 +6012,50 @@ declare const docOperations: {
5894
6012
  readonly schema: z.ZodType<_embedpdf_engine_core_runtime.SerializedEngineError, z.ZodTypeDef, _embedpdf_engine_core_runtime.SerializedEngineError>;
5895
6013
  };
5896
6014
  };
6015
+ readonly notes: string;
5897
6016
  };
5898
- readonly 'doc.annotations.create': {
5899
- readonly operationId: "doc.annotations.create";
5900
- readonly title: "Create annotation";
5901
- readonly summary: "Create an annotation on a page.";
6017
+ readonly 'doc.signatures.complete': {
6018
+ readonly operationId: "doc.signatures.complete";
6019
+ readonly title: "Complete a signature";
6020
+ readonly summary: "Install the CMS into the prepared candidate and publish the sealed bytes as the document's next base version.";
5902
6021
  readonly method: "POST";
5903
- readonly path: "/v1/docs/:docId/layers/:layerName/annotations/pages/:pon/items";
6022
+ readonly path: "/v1/docs/:docId/layers/:layerName/signatures/:signingId/complete";
5904
6023
  readonly credentials: readonly ["api-token", "doc-jwt"];
5905
6024
  readonly scope: readonly [];
5906
- readonly docCapabilities: readonly ["doc.annotate.modify"];
6025
+ readonly docCapabilities: readonly ["doc.sign"];
5907
6026
  readonly requestHeaders: readonly [AdminOperationHeader];
5908
6027
  readonly params: z.ZodObject<{
5909
6028
  docId: z.ZodString;
5910
6029
  } & {
5911
6030
  layerName: z.ZodString;
5912
6031
  } & {
5913
- pon: z.ZodNumber;
6032
+ signingId: z.ZodString;
5914
6033
  }, "strip", z.ZodTypeAny, {
5915
6034
  docId: string;
5916
6035
  layerName: string;
5917
- pon: number;
6036
+ signingId: string;
5918
6037
  }, {
5919
6038
  docId: string;
5920
6039
  layerName: string;
5921
- pon: number;
6040
+ signingId: string;
5922
6041
  }>;
5923
6042
  readonly body: {
5924
6043
  readonly contentType: "application/json";
5925
- readonly schema: z.ZodRecord<z.ZodString, z.ZodUnknown>;
6044
+ readonly schema: z.ZodObject<{
6045
+ cms: z.ZodEffects<z.ZodString, string, string>;
6046
+ expectedVersion: z.ZodType<_embedpdf_engine_core_runtime.DocumentVersionRef, z.ZodTypeDef, _embedpdf_engine_core_runtime.DocumentVersionRef>;
6047
+ }, "strip", z.ZodTypeAny, {
6048
+ expectedVersion: _embedpdf_engine_core_runtime.DocumentVersionRef;
6049
+ cms: string;
6050
+ }, {
6051
+ expectedVersion: _embedpdf_engine_core_runtime.DocumentVersionRef;
6052
+ cms: string;
6053
+ }>;
5926
6054
  };
5927
- readonly notes: string;
5928
6055
  readonly responses: {
5929
6056
  readonly 200: {
5930
6057
  readonly contentType: "application/json";
5931
- readonly schema: z.ZodObject<{
5932
- meta: z.ZodType<_embedpdf_engine_core_runtime.MutationMeta, z.ZodTypeDef, _embedpdf_engine_core_runtime.MutationMeta>;
5933
- }, "passthrough", z.ZodTypeAny, z.objectOutputType<{
5934
- meta: z.ZodType<_embedpdf_engine_core_runtime.MutationMeta, z.ZodTypeDef, _embedpdf_engine_core_runtime.MutationMeta>;
5935
- }, z.ZodTypeAny, "passthrough">, z.objectInputType<{
5936
- meta: z.ZodType<_embedpdf_engine_core_runtime.MutationMeta, z.ZodTypeDef, _embedpdf_engine_core_runtime.MutationMeta>;
5937
- }, z.ZodTypeAny, "passthrough">>;
6058
+ readonly schema: z.ZodType<_embedpdf_engine_core_runtime.SignatureCompleteResult, z.ZodTypeDef, _embedpdf_engine_core_runtime.SignatureCompleteResult>;
5938
6059
  };
5939
6060
  readonly 400: {
5940
6061
  readonly contentType: "application/json";
@@ -5944,55 +6065,42 @@ declare const docOperations: {
5944
6065
  readonly contentType: "application/json";
5945
6066
  readonly schema: z.ZodType<_embedpdf_engine_core_runtime.SerializedEngineError, z.ZodTypeDef, _embedpdf_engine_core_runtime.SerializedEngineError>;
5946
6067
  };
6068
+ readonly 409: {
6069
+ readonly contentType: "application/json";
6070
+ readonly schema: z.ZodType<_embedpdf_engine_core_runtime.SerializedEngineError, z.ZodTypeDef, _embedpdf_engine_core_runtime.SerializedEngineError>;
6071
+ };
5947
6072
  };
6073
+ readonly notes: string;
5948
6074
  };
5949
- readonly 'doc.annotations.update': {
5950
- readonly operationId: "doc.annotations.update";
5951
- readonly title: "Update annotation";
5952
- readonly summary: "Update one annotation by key.";
5953
- readonly method: "PATCH";
5954
- readonly path: "/v1/docs/:docId/layers/:layerName/annotations/pages/:pon/items/:annotKey";
6075
+ readonly 'doc.signatures.abort': {
6076
+ readonly operationId: "doc.signatures.abort";
6077
+ readonly title: "Abort a signature";
6078
+ readonly summary: "Discard a pending signing candidate.";
6079
+ readonly method: "DELETE";
6080
+ readonly path: "/v1/docs/:docId/layers/:layerName/signatures/:signingId";
5955
6081
  readonly credentials: readonly ["api-token", "doc-jwt"];
5956
6082
  readonly scope: readonly [];
5957
- readonly docCapabilities: readonly ["doc.annotate.modify"];
6083
+ readonly docCapabilities: readonly ["doc.sign"];
5958
6084
  readonly requestHeaders: readonly [AdminOperationHeader];
5959
6085
  readonly params: z.ZodObject<{
5960
6086
  docId: z.ZodString;
5961
6087
  } & {
5962
6088
  layerName: z.ZodString;
5963
6089
  } & {
5964
- pon: z.ZodNumber;
5965
- } & {
5966
- annotKey: z.ZodString;
6090
+ signingId: z.ZodString;
5967
6091
  }, "strip", z.ZodTypeAny, {
5968
6092
  docId: string;
5969
6093
  layerName: string;
5970
- pon: number;
5971
- annotKey: string;
6094
+ signingId: string;
5972
6095
  }, {
5973
6096
  docId: string;
5974
6097
  layerName: string;
5975
- pon: number;
5976
- annotKey: string;
6098
+ signingId: string;
5977
6099
  }>;
5978
- readonly body: {
5979
- readonly contentType: "application/json";
5980
- readonly schema: z.ZodRecord<z.ZodString, z.ZodUnknown>;
5981
- };
5982
6100
  readonly responses: {
5983
6101
  readonly 200: {
5984
6102
  readonly contentType: "application/json";
5985
- readonly schema: z.ZodObject<{
5986
- meta: z.ZodType<_embedpdf_engine_core_runtime.MutationMeta, z.ZodTypeDef, _embedpdf_engine_core_runtime.MutationMeta>;
5987
- }, "passthrough", z.ZodTypeAny, z.objectOutputType<{
5988
- meta: z.ZodType<_embedpdf_engine_core_runtime.MutationMeta, z.ZodTypeDef, _embedpdf_engine_core_runtime.MutationMeta>;
5989
- }, z.ZodTypeAny, "passthrough">, z.objectInputType<{
5990
- meta: z.ZodType<_embedpdf_engine_core_runtime.MutationMeta, z.ZodTypeDef, _embedpdf_engine_core_runtime.MutationMeta>;
5991
- }, z.ZodTypeAny, "passthrough">>;
5992
- };
5993
- readonly 400: {
5994
- readonly contentType: "application/json";
5995
- readonly schema: z.ZodType<_embedpdf_engine_core_runtime.SerializedEngineError, z.ZodTypeDef, _embedpdf_engine_core_runtime.SerializedEngineError>;
6103
+ readonly schema: z.ZodType<_embedpdf_engine_core_runtime.SignatureAbortResult, z.ZodTypeDef, _embedpdf_engine_core_runtime.SignatureAbortResult>;
5996
6104
  };
5997
6105
  readonly 404: {
5998
6106
  readonly contentType: "application/json";
@@ -6000,58 +6108,90 @@ declare const docOperations: {
6000
6108
  };
6001
6109
  };
6002
6110
  };
6003
- readonly 'doc.annotations.delete': {
6004
- readonly operationId: "doc.annotations.delete";
6005
- readonly title: "Delete annotation";
6006
- readonly summary: "Delete one annotation by key.";
6007
- readonly method: "DELETE";
6008
- readonly path: "/v1/docs/:docId/layers/:layerName/annotations/pages/:pon/items/:annotKey";
6111
+ readonly 'doc.versions.list': {
6112
+ readonly operationId: "doc.versions.list";
6113
+ readonly title: "List versions";
6114
+ readonly summary: "The document's base versions, oldest first, and its head.";
6115
+ readonly method: "GET";
6116
+ readonly path: "/v1/docs/:docId/versions";
6009
6117
  readonly credentials: readonly ["api-token", "doc-jwt"];
6010
6118
  readonly scope: readonly [];
6011
- readonly docCapabilities: readonly ["doc.annotate.modify"];
6119
+ readonly docCapabilities: readonly ["doc.open"];
6012
6120
  readonly requestHeaders: readonly [AdminOperationHeader];
6013
6121
  readonly params: z.ZodObject<{
6014
6122
  docId: z.ZodString;
6015
- } & {
6016
- layerName: z.ZodString;
6017
- } & {
6018
- pon: z.ZodNumber;
6019
- } & {
6020
- annotKey: z.ZodString;
6021
6123
  }, "strip", z.ZodTypeAny, {
6022
6124
  docId: string;
6023
- layerName: string;
6024
- pon: number;
6025
- annotKey: string;
6026
6125
  }, {
6027
6126
  docId: string;
6028
- layerName: string;
6029
- pon: number;
6030
- annotKey: string;
6031
6127
  }>;
6032
6128
  readonly responses: {
6033
6129
  readonly 200: {
6034
6130
  readonly contentType: "application/json";
6035
6131
  readonly schema: z.ZodObject<{
6036
- meta: z.ZodType<_embedpdf_engine_core_runtime.MutationMeta, z.ZodTypeDef, _embedpdf_engine_core_runtime.MutationMeta>;
6037
- }, "passthrough", z.ZodTypeAny, z.objectOutputType<{
6038
- meta: z.ZodType<_embedpdf_engine_core_runtime.MutationMeta, z.ZodTypeDef, _embedpdf_engine_core_runtime.MutationMeta>;
6039
- }, z.ZodTypeAny, "passthrough">, z.objectInputType<{
6040
- meta: z.ZodType<_embedpdf_engine_core_runtime.MutationMeta, z.ZodTypeDef, _embedpdf_engine_core_runtime.MutationMeta>;
6041
- }, z.ZodTypeAny, "passthrough">>;
6132
+ head: z.ZodString;
6133
+ versions: z.ZodArray<z.ZodObject<{
6134
+ sha256: z.ZodString;
6135
+ byteLength: z.ZodNumber;
6136
+ number: z.ZodNumber;
6137
+ parentSha256: z.ZodNullable<z.ZodString>;
6138
+ producer: z.ZodEnum<["upload", "signature"]>;
6139
+ signingId: z.ZodNullable<z.ZodString>;
6140
+ createdAt: z.ZodNumber;
6141
+ }, "strip", z.ZodTypeAny, {
6142
+ number: number;
6143
+ signingId: string | null;
6144
+ sha256: string;
6145
+ byteLength: number;
6146
+ parentSha256: string | null;
6147
+ producer: "signature" | "upload";
6148
+ createdAt: number;
6149
+ }, {
6150
+ number: number;
6151
+ signingId: string | null;
6152
+ sha256: string;
6153
+ byteLength: number;
6154
+ parentSha256: string | null;
6155
+ producer: "signature" | "upload";
6156
+ createdAt: number;
6157
+ }>, "many">;
6158
+ }, "strip", z.ZodTypeAny, {
6159
+ head: string;
6160
+ versions: {
6161
+ number: number;
6162
+ signingId: string | null;
6163
+ sha256: string;
6164
+ byteLength: number;
6165
+ parentSha256: string | null;
6166
+ producer: "signature" | "upload";
6167
+ createdAt: number;
6168
+ }[];
6169
+ }, {
6170
+ head: string;
6171
+ versions: {
6172
+ number: number;
6173
+ signingId: string | null;
6174
+ sha256: string;
6175
+ byteLength: number;
6176
+ parentSha256: string | null;
6177
+ producer: "signature" | "upload";
6178
+ createdAt: number;
6179
+ }[];
6180
+ }>;
6042
6181
  };
6043
6182
  readonly 404: {
6044
6183
  readonly contentType: "application/json";
6045
6184
  readonly schema: z.ZodType<_embedpdf_engine_core_runtime.SerializedEngineError, z.ZodTypeDef, _embedpdf_engine_core_runtime.SerializedEngineError>;
6046
6185
  };
6047
6186
  };
6187
+ readonly notes: "Every completed signature publishes a new version. Never cached: the list grows.";
6048
6188
  };
6049
- readonly 'doc.forms.get': {
6050
- readonly operationId: "doc.forms.get";
6051
- readonly title: "Get form snapshot";
6052
- readonly summary: "Reconciled form snapshot: fields, widgets, values.";
6189
+ readonly 'doc.versions.signatures': {
6190
+ readonly operationId: "doc.versions.signatures";
6191
+ readonly title: "Version signatures";
6192
+ readonly summary: "The signature snapshot of one base version (immutable).";
6053
6193
  readonly method: "GET";
6054
- readonly path: "/v1/docs/:docId/layers/:layerName/form";
6194
+ readonly path: "/v1/docs/:docId/versions/signatures/:sha";
6055
6195
  readonly credentials: readonly ["api-token", "doc-jwt"];
6056
6196
  readonly scope: readonly [];
6057
6197
  readonly docCapabilities: readonly ["doc.forms.read"];
@@ -6059,18 +6199,18 @@ declare const docOperations: {
6059
6199
  readonly params: z.ZodObject<{
6060
6200
  docId: z.ZodString;
6061
6201
  } & {
6062
- layerName: z.ZodString;
6202
+ sha: z.ZodString;
6063
6203
  }, "strip", z.ZodTypeAny, {
6064
6204
  docId: string;
6065
- layerName: string;
6205
+ sha: string;
6066
6206
  }, {
6067
6207
  docId: string;
6068
- layerName: string;
6208
+ sha: string;
6069
6209
  }>;
6070
6210
  readonly responses: {
6071
6211
  readonly 200: {
6072
6212
  readonly contentType: "application/json";
6073
- readonly schema: z.ZodType<_embedpdf_engine_core_runtime.FormSnapshot, z.ZodTypeDef, _embedpdf_engine_core_runtime.FormSnapshot>;
6213
+ readonly schema: z.ZodType<_embedpdf_engine_core_runtime.SignatureSnapshot, z.ZodTypeDef, _embedpdf_engine_core_runtime.SignatureSnapshot>;
6074
6214
  };
6075
6215
  readonly 404: {
6076
6216
  readonly contentType: "application/json";
@@ -6078,104 +6218,88 @@ declare const docOperations: {
6078
6218
  };
6079
6219
  };
6080
6220
  };
6081
- readonly 'doc.forms.setValue': {
6082
- readonly operationId: "doc.forms.setValue";
6083
- readonly title: "Set form value";
6084
- readonly summary: "Set one form field's value.";
6085
- readonly method: "POST";
6086
- readonly path: "/v1/docs/:docId/layers/:layerName/form/fields/:fieldKey/value";
6221
+ readonly 'doc.versions.signatureContents': {
6222
+ readonly operationId: "doc.versions.signatureContents";
6223
+ readonly title: "Signature contents";
6224
+ readonly summary: "The DER /Contents of a signed field in one base version (immutable).";
6225
+ readonly method: "GET";
6226
+ readonly path: "/v1/docs/:docId/versions/signatures/:sha/:fieldKey/contents";
6087
6227
  readonly credentials: readonly ["api-token", "doc-jwt"];
6088
6228
  readonly scope: readonly [];
6089
- readonly docCapabilities: readonly ["doc.forms.fill"];
6229
+ readonly docCapabilities: readonly ["doc.forms.read"];
6090
6230
  readonly requestHeaders: readonly [AdminOperationHeader];
6091
6231
  readonly params: z.ZodObject<{
6092
6232
  docId: z.ZodString;
6093
6233
  } & {
6094
- layerName: z.ZodString;
6234
+ sha: z.ZodString;
6095
6235
  } & {
6096
6236
  fieldKey: z.ZodString;
6097
6237
  }, "strip", z.ZodTypeAny, {
6098
6238
  docId: string;
6099
- layerName: string;
6100
6239
  fieldKey: string;
6240
+ sha: string;
6101
6241
  }, {
6102
6242
  docId: string;
6103
- layerName: string;
6104
6243
  fieldKey: string;
6244
+ sha: string;
6105
6245
  }>;
6106
- readonly body: {
6107
- readonly contentType: "application/json";
6108
- readonly schema: z.ZodRecord<z.ZodString, z.ZodUnknown>;
6109
- };
6110
6246
  readonly responses: {
6111
6247
  readonly 200: {
6112
- readonly contentType: "application/json";
6113
- readonly schema: z.ZodObject<{
6114
- meta: z.ZodType<_embedpdf_engine_core_runtime.MutationMeta, z.ZodTypeDef, _embedpdf_engine_core_runtime.MutationMeta>;
6115
- }, "passthrough", z.ZodTypeAny, z.objectOutputType<{
6116
- meta: z.ZodType<_embedpdf_engine_core_runtime.MutationMeta, z.ZodTypeDef, _embedpdf_engine_core_runtime.MutationMeta>;
6117
- }, z.ZodTypeAny, "passthrough">, z.objectInputType<{
6118
- meta: z.ZodType<_embedpdf_engine_core_runtime.MutationMeta, z.ZodTypeDef, _embedpdf_engine_core_runtime.MutationMeta>;
6119
- }, z.ZodTypeAny, "passthrough">>;
6120
- };
6121
- readonly 400: {
6122
- readonly contentType: "application/json";
6123
- readonly schema: z.ZodType<_embedpdf_engine_core_runtime.SerializedEngineError, z.ZodTypeDef, _embedpdf_engine_core_runtime.SerializedEngineError>;
6248
+ readonly contentType: "application/pkcs7-signature";
6124
6249
  };
6125
6250
  readonly 404: {
6126
6251
  readonly contentType: "application/json";
6127
6252
  readonly schema: z.ZodType<_embedpdf_engine_core_runtime.SerializedEngineError, z.ZodTypeDef, _embedpdf_engine_core_runtime.SerializedEngineError>;
6128
6253
  };
6129
6254
  };
6255
+ readonly notes: "`fieldKey` is the field's fully qualified name, token-text encoded (the same encoding attachment keys use).";
6130
6256
  };
6131
- readonly 'doc.forms.reset': {
6132
- readonly operationId: "doc.forms.reset";
6133
- readonly title: "Reset form field";
6134
- readonly summary: "Reset one form field to its default value.";
6135
- readonly method: "POST";
6136
- readonly path: "/v1/docs/:docId/layers/:layerName/form/fields/:fieldKey/reset";
6257
+ readonly 'doc.versions.signatureDigest': {
6258
+ readonly operationId: "doc.versions.signatureDigest";
6259
+ readonly title: "Signature digest";
6260
+ readonly summary: "The digest of a signed field's /ByteRange in one base version (immutable).";
6261
+ readonly method: "GET";
6262
+ readonly path: "/v1/docs/:docId/versions/signatures/:sha/:fieldKey/digest/:algorithm";
6137
6263
  readonly credentials: readonly ["api-token", "doc-jwt"];
6138
6264
  readonly scope: readonly [];
6139
- readonly docCapabilities: readonly ["doc.forms.fill"];
6265
+ readonly docCapabilities: readonly ["doc.forms.read"];
6140
6266
  readonly requestHeaders: readonly [AdminOperationHeader];
6141
6267
  readonly params: z.ZodObject<{
6142
6268
  docId: z.ZodString;
6143
6269
  } & {
6144
- layerName: z.ZodString;
6270
+ sha: z.ZodString;
6145
6271
  } & {
6146
6272
  fieldKey: z.ZodString;
6273
+ } & {
6274
+ algorithm: z.ZodEnum<["sha1", "sha256", "sha384", "sha512"]>;
6147
6275
  }, "strip", z.ZodTypeAny, {
6148
6276
  docId: string;
6149
- layerName: string;
6150
6277
  fieldKey: string;
6278
+ sha: string;
6279
+ algorithm: "sha256" | "sha1" | "sha384" | "sha512";
6151
6280
  }, {
6152
6281
  docId: string;
6153
- layerName: string;
6154
6282
  fieldKey: string;
6283
+ sha: string;
6284
+ algorithm: "sha256" | "sha1" | "sha384" | "sha512";
6155
6285
  }>;
6156
6286
  readonly responses: {
6157
6287
  readonly 200: {
6158
- readonly contentType: "application/json";
6159
- readonly schema: z.ZodObject<{
6160
- meta: z.ZodType<_embedpdf_engine_core_runtime.MutationMeta, z.ZodTypeDef, _embedpdf_engine_core_runtime.MutationMeta>;
6161
- }, "passthrough", z.ZodTypeAny, z.objectOutputType<{
6162
- meta: z.ZodType<_embedpdf_engine_core_runtime.MutationMeta, z.ZodTypeDef, _embedpdf_engine_core_runtime.MutationMeta>;
6163
- }, z.ZodTypeAny, "passthrough">, z.objectInputType<{
6164
- meta: z.ZodType<_embedpdf_engine_core_runtime.MutationMeta, z.ZodTypeDef, _embedpdf_engine_core_runtime.MutationMeta>;
6165
- }, z.ZodTypeAny, "passthrough">>;
6288
+ readonly contentType: "application/octet-stream";
6166
6289
  };
6167
6290
  readonly 404: {
6168
6291
  readonly contentType: "application/json";
6169
6292
  readonly schema: z.ZodType<_embedpdf_engine_core_runtime.SerializedEngineError, z.ZodTypeDef, _embedpdf_engine_core_runtime.SerializedEngineError>;
6170
6293
  };
6171
6294
  };
6295
+ readonly notes: "What a CMS verifier compares its message digest to.";
6172
6296
  };
6173
- readonly 'doc.forms.exportData': {
6174
- readonly operationId: "doc.forms.exportData";
6175
- readonly title: "Export form data";
6176
- readonly summary: "Export form data as FDF or XFDF.";
6297
+ readonly 'doc.versions.analysis': {
6298
+ readonly operationId: "doc.versions.analysis";
6299
+ readonly title: "Analyze version history";
6300
+ readonly summary: "What changed between two revisions of one base version (immutable).";
6177
6301
  readonly method: "GET";
6178
- readonly path: "/v1/docs/:docId/layers/:layerName/form/data";
6302
+ readonly path: "/v1/docs/:docId/versions/analysis/:sha";
6179
6303
  readonly credentials: readonly ["api-token", "doc-jwt"];
6180
6304
  readonly scope: readonly [];
6181
6305
  readonly docCapabilities: readonly ["doc.forms.read"];
@@ -6183,116 +6307,146 @@ declare const docOperations: {
6183
6307
  readonly params: z.ZodObject<{
6184
6308
  docId: z.ZodString;
6185
6309
  } & {
6186
- layerName: z.ZodString;
6310
+ sha: z.ZodString;
6187
6311
  }, "strip", z.ZodTypeAny, {
6188
6312
  docId: string;
6189
- layerName: string;
6313
+ sha: string;
6190
6314
  }, {
6191
6315
  docId: string;
6192
- layerName: string;
6316
+ sha: string;
6193
6317
  }>;
6194
6318
  readonly query: z.ZodObject<{
6195
- format: z.ZodOptional<z.ZodEnum<["fdf", "xfdf"]>>;
6319
+ 'since.signature': z.ZodOptional<z.ZodNumber>;
6320
+ 'since.revision': z.ZodOptional<z.ZodNumber>;
6321
+ level: z.ZodOptional<z.ZodEnum<["none", "lta", "fill", "annotate"]>>;
6322
+ } & {
6323
+ until: z.ZodOptional<z.ZodNumber>;
6324
+ /** The judging policy version the caller expects — a cache key on this immutable URL, not an input. */
6325
+ policy: z.ZodOptional<z.ZodNumber>;
6196
6326
  }, "strip", z.ZodTypeAny, {
6197
- format?: "fdf" | "xfdf" | undefined;
6327
+ 'since.signature'?: number | undefined;
6328
+ 'since.revision'?: number | undefined;
6329
+ level?: "fill" | "none" | "lta" | "annotate" | undefined;
6330
+ until?: number | undefined;
6331
+ policy?: number | undefined;
6198
6332
  }, {
6199
- format?: "fdf" | "xfdf" | undefined;
6333
+ 'since.signature'?: number | undefined;
6334
+ 'since.revision'?: number | undefined;
6335
+ level?: "fill" | "none" | "lta" | "annotate" | undefined;
6336
+ until?: number | undefined;
6337
+ policy?: number | undefined;
6200
6338
  }>;
6201
6339
  readonly responses: {
6202
6340
  readonly 200: {
6203
- readonly contentType: readonly ["application/vnd.adobe.xfdf", "application/vnd.fdf"];
6341
+ readonly contentType: "application/json";
6342
+ readonly schema: z.ZodType<_embedpdf_engine_core_runtime.ChangeAnalysis, z.ZodTypeDef, _embedpdf_engine_core_runtime.ChangeAnalysis>;
6343
+ };
6344
+ readonly 400: {
6345
+ readonly contentType: "application/json";
6346
+ readonly schema: z.ZodType<_embedpdf_engine_core_runtime.SerializedEngineError, z.ZodTypeDef, _embedpdf_engine_core_runtime.SerializedEngineError>;
6204
6347
  };
6205
6348
  readonly 404: {
6206
6349
  readonly contentType: "application/json";
6207
6350
  readonly schema: z.ZodType<_embedpdf_engine_core_runtime.SerializedEngineError, z.ZodTypeDef, _embedpdf_engine_core_runtime.SerializedEngineError>;
6208
6351
  };
6209
6352
  };
6353
+ readonly notes: string;
6210
6354
  };
6211
- readonly 'doc.forms.importData': {
6212
- readonly operationId: "doc.forms.importData";
6213
- readonly title: "Import form data";
6214
- readonly summary: "Import form data (FDF/XFDF), filling matching fields.";
6215
- readonly method: "POST";
6216
- readonly path: "/v1/docs/:docId/layers/:layerName/form/data";
6355
+ readonly 'doc.versions.download': {
6356
+ readonly operationId: "doc.versions.download";
6357
+ readonly title: "Download a version";
6358
+ readonly summary: "The bytes of one base version (immutable).";
6359
+ readonly method: "GET";
6360
+ readonly path: "/v1/docs/:docId/versions/download/:sha";
6217
6361
  readonly credentials: readonly ["api-token", "doc-jwt"];
6218
6362
  readonly scope: readonly [];
6219
- readonly docCapabilities: readonly ["doc.forms.fill"];
6363
+ readonly docCapabilities: readonly ["doc.download"];
6220
6364
  readonly requestHeaders: readonly [AdminOperationHeader];
6221
6365
  readonly params: z.ZodObject<{
6222
6366
  docId: z.ZodString;
6223
6367
  } & {
6224
- layerName: z.ZodString;
6368
+ sha: z.ZodString;
6225
6369
  }, "strip", z.ZodTypeAny, {
6226
6370
  docId: string;
6227
- layerName: string;
6371
+ sha: string;
6228
6372
  }, {
6229
6373
  docId: string;
6230
- layerName: string;
6374
+ sha: string;
6231
6375
  }>;
6232
- readonly body: {
6233
- readonly contentType: "application/json";
6234
- readonly schema: z.ZodRecord<z.ZodString, z.ZodUnknown>;
6235
- };
6236
6376
  readonly responses: {
6237
6377
  readonly 200: {
6238
- readonly contentType: "application/json";
6239
- readonly schema: z.ZodObject<{
6240
- meta: z.ZodType<_embedpdf_engine_core_runtime.MutationMeta, z.ZodTypeDef, _embedpdf_engine_core_runtime.MutationMeta>;
6241
- }, "passthrough", z.ZodTypeAny, z.objectOutputType<{
6242
- meta: z.ZodType<_embedpdf_engine_core_runtime.MutationMeta, z.ZodTypeDef, _embedpdf_engine_core_runtime.MutationMeta>;
6243
- }, z.ZodTypeAny, "passthrough">, z.objectInputType<{
6244
- meta: z.ZodType<_embedpdf_engine_core_runtime.MutationMeta, z.ZodTypeDef, _embedpdf_engine_core_runtime.MutationMeta>;
6245
- }, z.ZodTypeAny, "passthrough">>;
6378
+ readonly contentType: "application/pdf";
6246
6379
  };
6247
- readonly 400: {
6380
+ readonly 404: {
6248
6381
  readonly contentType: "application/json";
6249
6382
  readonly schema: z.ZodType<_embedpdf_engine_core_runtime.SerializedEngineError, z.ZodTypeDef, _embedpdf_engine_core_runtime.SerializedEngineError>;
6250
6383
  };
6384
+ };
6385
+ };
6386
+ readonly 'doc.versions.revision': {
6387
+ readonly operationId: "doc.versions.revision";
6388
+ readonly title: "Download a revision";
6389
+ readonly summary: "The byte prefix of one revision of a base version: exactly what a signature over it signed (immutable).";
6390
+ readonly method: "GET";
6391
+ readonly path: "/v1/docs/:docId/versions/revisions/:sha/:index";
6392
+ readonly credentials: readonly ["api-token", "doc-jwt"];
6393
+ readonly scope: readonly [];
6394
+ readonly docCapabilities: readonly ["doc.download"];
6395
+ readonly requestHeaders: readonly [AdminOperationHeader];
6396
+ readonly params: z.ZodObject<{
6397
+ docId: z.ZodString;
6398
+ } & {
6399
+ sha: z.ZodString;
6400
+ } & {
6401
+ index: z.ZodNumber;
6402
+ }, "strip", z.ZodTypeAny, {
6403
+ docId: string;
6404
+ sha: string;
6405
+ index: number;
6406
+ }, {
6407
+ docId: string;
6408
+ sha: string;
6409
+ index: number;
6410
+ }>;
6411
+ readonly responses: {
6412
+ readonly 200: {
6413
+ readonly contentType: "application/pdf";
6414
+ };
6251
6415
  readonly 404: {
6252
6416
  readonly contentType: "application/json";
6253
6417
  readonly schema: z.ZodType<_embedpdf_engine_core_runtime.SerializedEngineError, z.ZodTypeDef, _embedpdf_engine_core_runtime.SerializedEngineError>;
6254
6418
  };
6255
6419
  };
6256
6420
  };
6257
- readonly 'doc.pages.move': {
6258
- readonly operationId: "doc.pages.move";
6259
- readonly title: "Move pages";
6260
- readonly summary: "Reorder pages.";
6261
- readonly method: "POST";
6262
- readonly path: "/v1/docs/:docId/layers/:layerName/pages/move";
6421
+ readonly 'doc.render': {
6422
+ readonly operationId: "doc.render";
6423
+ readonly title: "Render page";
6424
+ readonly summary: "Render one page as an image at the current layer version.";
6425
+ readonly method: "GET";
6426
+ readonly path: "/v1/docs/:docId/layers/:layerName/render/pages/:pon/data";
6263
6427
  readonly credentials: readonly ["api-token", "doc-jwt"];
6264
6428
  readonly scope: readonly [];
6265
- readonly docCapabilities: readonly ["doc.pages.assemble"];
6429
+ readonly docCapabilities: readonly ["doc.render"];
6266
6430
  readonly requestHeaders: readonly [AdminOperationHeader];
6267
6431
  readonly params: z.ZodObject<{
6268
6432
  docId: z.ZodString;
6269
6433
  } & {
6270
6434
  layerName: z.ZodString;
6435
+ } & {
6436
+ pon: z.ZodNumber;
6271
6437
  }, "strip", z.ZodTypeAny, {
6272
6438
  docId: string;
6273
6439
  layerName: string;
6440
+ pon: number;
6274
6441
  }, {
6275
6442
  docId: string;
6276
6443
  layerName: string;
6444
+ pon: number;
6277
6445
  }>;
6278
- readonly body: {
6279
- readonly contentType: "application/json";
6280
- readonly schema: z.ZodRecord<z.ZodString, z.ZodUnknown>;
6281
- };
6446
+ readonly notes: string;
6282
6447
  readonly responses: {
6283
6448
  readonly 200: {
6284
- readonly contentType: "application/json";
6285
- readonly schema: z.ZodObject<{
6286
- meta: z.ZodType<_embedpdf_engine_core_runtime.MutationMeta, z.ZodTypeDef, _embedpdf_engine_core_runtime.MutationMeta>;
6287
- }, "passthrough", z.ZodTypeAny, z.objectOutputType<{
6288
- meta: z.ZodType<_embedpdf_engine_core_runtime.MutationMeta, z.ZodTypeDef, _embedpdf_engine_core_runtime.MutationMeta>;
6289
- }, z.ZodTypeAny, "passthrough">, z.objectInputType<{
6290
- meta: z.ZodType<_embedpdf_engine_core_runtime.MutationMeta, z.ZodTypeDef, _embedpdf_engine_core_runtime.MutationMeta>;
6291
- }, z.ZodTypeAny, "passthrough">>;
6292
- };
6293
- readonly 400: {
6294
- readonly contentType: "application/json";
6295
- readonly schema: z.ZodType<_embedpdf_engine_core_runtime.SerializedEngineError, z.ZodTypeDef, _embedpdf_engine_core_runtime.SerializedEngineError>;
6449
+ readonly contentType: "image/webp";
6296
6450
  };
6297
6451
  readonly 404: {
6298
6452
  readonly contentType: "application/json";
@@ -6300,61 +6454,87 @@ declare const docOperations: {
6300
6454
  };
6301
6455
  };
6302
6456
  };
6303
- readonly 'doc.pages.rotate': {
6304
- readonly operationId: "doc.pages.rotate";
6305
- readonly title: "Rotate pages";
6306
- readonly summary: "Set absolute rotation on pages.";
6307
- readonly method: "POST";
6308
- readonly path: "/v1/docs/:docId/layers/:layerName/pages/rotate";
6457
+ readonly 'doc.text': {
6458
+ readonly operationId: "doc.text";
6459
+ readonly title: "Extract page text";
6460
+ readonly summary: "Extracted text content for one page.";
6461
+ readonly method: "GET";
6462
+ readonly path: "/v1/docs/:docId/layers/:layerName/text/pages/:pon/data";
6309
6463
  readonly credentials: readonly ["api-token", "doc-jwt"];
6310
6464
  readonly scope: readonly [];
6311
- readonly docCapabilities: readonly ["doc.pages.assemble"];
6465
+ readonly docCapabilities: readonly ["doc.text.copy"];
6312
6466
  readonly requestHeaders: readonly [AdminOperationHeader];
6313
6467
  readonly params: z.ZodObject<{
6314
6468
  docId: z.ZodString;
6315
6469
  } & {
6316
6470
  layerName: z.ZodString;
6471
+ } & {
6472
+ pon: z.ZodNumber;
6317
6473
  }, "strip", z.ZodTypeAny, {
6318
6474
  docId: string;
6319
6475
  layerName: string;
6476
+ pon: number;
6320
6477
  }, {
6321
6478
  docId: string;
6322
6479
  layerName: string;
6480
+ pon: number;
6323
6481
  }>;
6324
- readonly body: {
6325
- readonly contentType: "application/json";
6326
- readonly schema: z.ZodRecord<z.ZodString, z.ZodUnknown>;
6327
- };
6328
6482
  readonly responses: {
6329
6483
  readonly 200: {
6330
6484
  readonly contentType: "application/json";
6331
- readonly schema: z.ZodObject<{
6332
- meta: z.ZodType<_embedpdf_engine_core_runtime.MutationMeta, z.ZodTypeDef, _embedpdf_engine_core_runtime.MutationMeta>;
6333
- }, "passthrough", z.ZodTypeAny, z.objectOutputType<{
6334
- meta: z.ZodType<_embedpdf_engine_core_runtime.MutationMeta, z.ZodTypeDef, _embedpdf_engine_core_runtime.MutationMeta>;
6335
- }, z.ZodTypeAny, "passthrough">, z.objectInputType<{
6336
- meta: z.ZodType<_embedpdf_engine_core_runtime.MutationMeta, z.ZodTypeDef, _embedpdf_engine_core_runtime.MutationMeta>;
6337
- }, z.ZodTypeAny, "passthrough">>;
6485
+ readonly schema: z.ZodType<_embedpdf_engine_core_runtime.PageTextSnapshot, z.ZodTypeDef, _embedpdf_engine_core_runtime.PageTextSnapshot>;
6338
6486
  };
6339
- readonly 400: {
6487
+ readonly 404: {
6340
6488
  readonly contentType: "application/json";
6341
6489
  readonly schema: z.ZodType<_embedpdf_engine_core_runtime.SerializedEngineError, z.ZodTypeDef, _embedpdf_engine_core_runtime.SerializedEngineError>;
6342
6490
  };
6491
+ };
6492
+ };
6493
+ readonly 'doc.annotations.list': {
6494
+ readonly operationId: "doc.annotations.list";
6495
+ readonly title: "List annotations";
6496
+ readonly summary: "One page's annotations at the current layer version.";
6497
+ readonly method: "GET";
6498
+ readonly path: "/v1/docs/:docId/layers/:layerName/annotations/pages/:pon/items";
6499
+ readonly credentials: readonly ["api-token", "doc-jwt"];
6500
+ readonly scope: readonly [];
6501
+ readonly docCapabilities: readonly ["doc.annotate.read"];
6502
+ readonly requestHeaders: readonly [AdminOperationHeader];
6503
+ readonly params: z.ZodObject<{
6504
+ docId: z.ZodString;
6505
+ } & {
6506
+ layerName: z.ZodString;
6507
+ } & {
6508
+ pon: z.ZodNumber;
6509
+ }, "strip", z.ZodTypeAny, {
6510
+ docId: string;
6511
+ layerName: string;
6512
+ pon: number;
6513
+ }, {
6514
+ docId: string;
6515
+ layerName: string;
6516
+ pon: number;
6517
+ }>;
6518
+ readonly responses: {
6519
+ readonly 200: {
6520
+ readonly contentType: "application/json";
6521
+ readonly schema: z.ZodType<_embedpdf_engine_core_runtime.AnnotationListPageSnapshot, z.ZodTypeDef, _embedpdf_engine_core_runtime.AnnotationListPageSnapshot>;
6522
+ };
6343
6523
  readonly 404: {
6344
6524
  readonly contentType: "application/json";
6345
6525
  readonly schema: z.ZodType<_embedpdf_engine_core_runtime.SerializedEngineError, z.ZodTypeDef, _embedpdf_engine_core_runtime.SerializedEngineError>;
6346
6526
  };
6347
6527
  };
6348
6528
  };
6349
- readonly 'doc.pages.delete': {
6350
- readonly operationId: "doc.pages.delete";
6351
- readonly title: "Delete pages";
6352
- readonly summary: "Delete pages.";
6353
- readonly method: "POST";
6354
- readonly path: "/v1/docs/:docId/layers/:layerName/pages/delete";
6529
+ readonly 'doc.annotations.listAll': {
6530
+ readonly operationId: "doc.annotations.listAll";
6531
+ readonly title: "List all annotations";
6532
+ readonly summary: "All pages' annotations as one coherent snapshot at the current layer version.";
6533
+ readonly method: "GET";
6534
+ readonly path: "/v1/docs/:docId/layers/:layerName/annotations/items";
6355
6535
  readonly credentials: readonly ["api-token", "doc-jwt"];
6356
6536
  readonly scope: readonly [];
6357
- readonly docCapabilities: readonly ["doc.pages.assemble"];
6537
+ readonly docCapabilities: readonly ["doc.annotate.read"];
6358
6538
  readonly requestHeaders: readonly [AdminOperationHeader];
6359
6539
  readonly params: z.ZodObject<{
6360
6540
  docId: z.ZodString;
@@ -6367,57 +6547,52 @@ declare const docOperations: {
6367
6547
  docId: string;
6368
6548
  layerName: string;
6369
6549
  }>;
6370
- readonly body: {
6371
- readonly contentType: "application/json";
6372
- readonly schema: z.ZodRecord<z.ZodString, z.ZodUnknown>;
6373
- };
6550
+ readonly notes: "Returns one entry per page plus the audit-log cursor for reconciling subsequent document events. Page order is unspecified; join by `pageState.pageObjectNumber` when display order matters.";
6374
6551
  readonly responses: {
6375
6552
  readonly 200: {
6376
6553
  readonly contentType: "application/json";
6377
- readonly schema: z.ZodObject<{
6378
- meta: z.ZodType<_embedpdf_engine_core_runtime.MutationMeta, z.ZodTypeDef, _embedpdf_engine_core_runtime.MutationMeta>;
6379
- }, "passthrough", z.ZodTypeAny, z.objectOutputType<{
6380
- meta: z.ZodType<_embedpdf_engine_core_runtime.MutationMeta, z.ZodTypeDef, _embedpdf_engine_core_runtime.MutationMeta>;
6381
- }, z.ZodTypeAny, "passthrough">, z.objectInputType<{
6382
- meta: z.ZodType<_embedpdf_engine_core_runtime.MutationMeta, z.ZodTypeDef, _embedpdf_engine_core_runtime.MutationMeta>;
6383
- }, z.ZodTypeAny, "passthrough">>;
6554
+ readonly schema: z.ZodType<_embedpdf_engine_core_runtime.AnnotationListSnapshotAllPages, z.ZodTypeDef, _embedpdf_engine_core_runtime.AnnotationListSnapshotAllPages>;
6384
6555
  };
6385
- readonly 400: {
6556
+ readonly 404: {
6386
6557
  readonly contentType: "application/json";
6387
6558
  readonly schema: z.ZodType<_embedpdf_engine_core_runtime.SerializedEngineError, z.ZodTypeDef, _embedpdf_engine_core_runtime.SerializedEngineError>;
6388
6559
  };
6389
- readonly 404: {
6560
+ readonly 409: {
6390
6561
  readonly contentType: "application/json";
6391
6562
  readonly schema: z.ZodType<_embedpdf_engine_core_runtime.SerializedEngineError, z.ZodTypeDef, _embedpdf_engine_core_runtime.SerializedEngineError>;
6392
6563
  };
6393
6564
  };
6394
6565
  };
6395
- readonly 'doc.pages.flatten': {
6396
- readonly operationId: "doc.pages.flatten";
6397
- readonly title: "Flatten pages";
6398
- readonly summary: "Flatten annotations and form fields into page content.";
6566
+ readonly 'doc.annotations.create': {
6567
+ readonly operationId: "doc.annotations.create";
6568
+ readonly title: "Create annotation";
6569
+ readonly summary: "Create an annotation on a page.";
6399
6570
  readonly method: "POST";
6400
- readonly path: "/v1/docs/:docId/layers/:layerName/pages/flatten";
6571
+ readonly path: "/v1/docs/:docId/layers/:layerName/annotations/pages/:pon/items";
6401
6572
  readonly credentials: readonly ["api-token", "doc-jwt"];
6402
6573
  readonly scope: readonly [];
6403
- readonly docCapabilities: readonly ["doc.pages.modify", "doc.annotate.modify"];
6574
+ readonly docCapabilities: readonly ["doc.annotate.modify"];
6404
6575
  readonly requestHeaders: readonly [AdminOperationHeader];
6405
6576
  readonly params: z.ZodObject<{
6406
6577
  docId: z.ZodString;
6407
6578
  } & {
6408
6579
  layerName: z.ZodString;
6580
+ } & {
6581
+ pon: z.ZodNumber;
6409
6582
  }, "strip", z.ZodTypeAny, {
6410
6583
  docId: string;
6411
6584
  layerName: string;
6585
+ pon: number;
6412
6586
  }, {
6413
6587
  docId: string;
6414
6588
  layerName: string;
6589
+ pon: number;
6415
6590
  }>;
6416
6591
  readonly body: {
6417
6592
  readonly contentType: "application/json";
6418
6593
  readonly schema: z.ZodRecord<z.ZodString, z.ZodUnknown>;
6419
- readonly required: false;
6420
6594
  };
6595
+ readonly notes: string;
6421
6596
  readonly responses: {
6422
6597
  readonly 200: {
6423
6598
  readonly contentType: "application/json";
@@ -6439,29 +6614,38 @@ declare const docOperations: {
6439
6614
  };
6440
6615
  };
6441
6616
  };
6442
- readonly 'doc.pages.insert': {
6443
- readonly operationId: "doc.pages.insert";
6444
- readonly title: "Insert pages from a PDF";
6445
- readonly summary: "Copy every page of an uploaded PDF into the document at an index.";
6446
- readonly method: "POST";
6447
- readonly path: "/v1/docs/:docId/layers/:layerName/pages/insert";
6617
+ readonly 'doc.annotations.update': {
6618
+ readonly operationId: "doc.annotations.update";
6619
+ readonly title: "Update annotation";
6620
+ readonly summary: "Update one annotation by key.";
6621
+ readonly method: "PATCH";
6622
+ readonly path: "/v1/docs/:docId/layers/:layerName/annotations/pages/:pon/items/:annotKey";
6448
6623
  readonly credentials: readonly ["api-token", "doc-jwt"];
6449
6624
  readonly scope: readonly [];
6450
- readonly docCapabilities: readonly ["doc.pages.assemble"];
6625
+ readonly docCapabilities: readonly ["doc.annotate.modify"];
6451
6626
  readonly requestHeaders: readonly [AdminOperationHeader];
6452
6627
  readonly params: z.ZodObject<{
6453
6628
  docId: z.ZodString;
6454
6629
  } & {
6455
6630
  layerName: z.ZodString;
6631
+ } & {
6632
+ pon: z.ZodNumber;
6633
+ } & {
6634
+ annotKey: z.ZodString;
6456
6635
  }, "strip", z.ZodTypeAny, {
6457
6636
  docId: string;
6458
6637
  layerName: string;
6638
+ pon: number;
6639
+ annotKey: string;
6459
6640
  }, {
6460
6641
  docId: string;
6461
6642
  layerName: string;
6643
+ pon: number;
6644
+ annotKey: string;
6462
6645
  }>;
6463
6646
  readonly body: {
6464
- readonly contentType: "multipart/form-data";
6647
+ readonly contentType: "application/json";
6648
+ readonly schema: z.ZodRecord<z.ZodString, z.ZodUnknown>;
6465
6649
  };
6466
6650
  readonly responses: {
6467
6651
  readonly 200: {
@@ -6483,28 +6667,77 @@ declare const docOperations: {
6483
6667
  readonly schema: z.ZodType<_embedpdf_engine_core_runtime.SerializedEngineError, z.ZodTypeDef, _embedpdf_engine_core_runtime.SerializedEngineError>;
6484
6668
  };
6485
6669
  };
6486
- readonly notes: "Multipart mutation envelope: a `body` field holding `{\"destIndex\"?: number}` (omitted → append) plus a `resource:source` file part carrying the standalone PDF whose pages are copied in. The inserted copies get fresh page object numbers, returned in insertion order.";
6487
6670
  };
6488
- readonly 'doc.pages.insertBlank': {
6489
- readonly operationId: "doc.pages.insertBlank";
6490
- readonly title: "Insert blank pages";
6491
- readonly summary: "Create blank pages of an explicit size at an index.";
6671
+ readonly 'doc.annotations.delete': {
6672
+ readonly operationId: "doc.annotations.delete";
6673
+ readonly title: "Delete annotation";
6674
+ readonly summary: "Delete one annotation by key.";
6675
+ readonly method: "DELETE";
6676
+ readonly path: "/v1/docs/:docId/layers/:layerName/annotations/pages/:pon/items/:annotKey";
6677
+ readonly credentials: readonly ["api-token", "doc-jwt"];
6678
+ readonly scope: readonly [];
6679
+ readonly docCapabilities: readonly ["doc.annotate.modify"];
6680
+ readonly requestHeaders: readonly [AdminOperationHeader];
6681
+ readonly params: z.ZodObject<{
6682
+ docId: z.ZodString;
6683
+ } & {
6684
+ layerName: z.ZodString;
6685
+ } & {
6686
+ pon: z.ZodNumber;
6687
+ } & {
6688
+ annotKey: z.ZodString;
6689
+ }, "strip", z.ZodTypeAny, {
6690
+ docId: string;
6691
+ layerName: string;
6692
+ pon: number;
6693
+ annotKey: string;
6694
+ }, {
6695
+ docId: string;
6696
+ layerName: string;
6697
+ pon: number;
6698
+ annotKey: string;
6699
+ }>;
6700
+ readonly responses: {
6701
+ readonly 200: {
6702
+ readonly contentType: "application/json";
6703
+ readonly schema: z.ZodObject<{
6704
+ meta: z.ZodType<_embedpdf_engine_core_runtime.MutationMeta, z.ZodTypeDef, _embedpdf_engine_core_runtime.MutationMeta>;
6705
+ }, "passthrough", z.ZodTypeAny, z.objectOutputType<{
6706
+ meta: z.ZodType<_embedpdf_engine_core_runtime.MutationMeta, z.ZodTypeDef, _embedpdf_engine_core_runtime.MutationMeta>;
6707
+ }, z.ZodTypeAny, "passthrough">, z.objectInputType<{
6708
+ meta: z.ZodType<_embedpdf_engine_core_runtime.MutationMeta, z.ZodTypeDef, _embedpdf_engine_core_runtime.MutationMeta>;
6709
+ }, z.ZodTypeAny, "passthrough">>;
6710
+ };
6711
+ readonly 404: {
6712
+ readonly contentType: "application/json";
6713
+ readonly schema: z.ZodType<_embedpdf_engine_core_runtime.SerializedEngineError, z.ZodTypeDef, _embedpdf_engine_core_runtime.SerializedEngineError>;
6714
+ };
6715
+ };
6716
+ };
6717
+ readonly 'doc.annotations.flatten': {
6718
+ readonly operationId: "doc.annotations.flatten";
6719
+ readonly title: "Flatten annotations";
6720
+ readonly summary: "Flatten a chosen set of one page's annotations into its content — pages.flatten for a selection. Painted annotations are removed; ineligible ones report skipped.";
6492
6721
  readonly method: "POST";
6493
- readonly path: "/v1/docs/:docId/layers/:layerName/pages/insert-blank";
6722
+ readonly path: "/v1/docs/:docId/layers/:layerName/annotations/pages/:pon/items/flatten";
6494
6723
  readonly credentials: readonly ["api-token", "doc-jwt"];
6495
6724
  readonly scope: readonly [];
6496
- readonly docCapabilities: readonly ["doc.pages.assemble"];
6725
+ readonly docCapabilities: readonly ["doc.pages.modify", "doc.annotate.modify"];
6497
6726
  readonly requestHeaders: readonly [AdminOperationHeader];
6498
6727
  readonly params: z.ZodObject<{
6499
6728
  docId: z.ZodString;
6500
6729
  } & {
6501
6730
  layerName: z.ZodString;
6731
+ } & {
6732
+ pon: z.ZodNumber;
6502
6733
  }, "strip", z.ZodTypeAny, {
6503
6734
  docId: string;
6504
6735
  layerName: string;
6736
+ pon: number;
6505
6737
  }, {
6506
6738
  docId: string;
6507
6739
  layerName: string;
6740
+ pon: number;
6508
6741
  }>;
6509
6742
  readonly body: {
6510
6743
  readonly contentType: "application/json";
@@ -6530,14 +6763,13 @@ declare const docOperations: {
6530
6763
  readonly schema: z.ZodType<_embedpdf_engine_core_runtime.SerializedEngineError, z.ZodTypeDef, _embedpdf_engine_core_runtime.SerializedEngineError>;
6531
6764
  };
6532
6765
  };
6533
- readonly notes: "Body is `{\"size\": {\"width\", \"height\"}, \"count\"?, \"destIndex\"?}` — size in PDF points, count in [1, 100], destIndex omitted → append.";
6534
6766
  };
6535
- readonly 'doc.pages.extract': {
6536
- readonly operationId: "doc.pages.extract";
6537
- readonly title: "Extract pages";
6538
- readonly summary: "Export the listed pages, in order, as a standalone PDF.";
6767
+ readonly 'doc.annotations.exportAppearance': {
6768
+ readonly operationId: "doc.annotations.exportAppearance";
6769
+ readonly title: "Export annotation appearances";
6770
+ readonly summary: "The chosen annotations' appearances as one single-page PDF sized to their union rect — vector, positions preserved. A read; the source is untouched.";
6539
6771
  readonly method: "POST";
6540
- readonly path: "/v1/docs/:docId/layers/:layerName/pages/extract";
6772
+ readonly path: "/v1/docs/:docId/layers/:layerName/annotations/pages/:pon/items/appearance";
6541
6773
  readonly credentials: readonly ["api-token", "doc-jwt"];
6542
6774
  readonly scope: readonly [];
6543
6775
  readonly docCapabilities: readonly ["doc.download"];
@@ -6546,12 +6778,16 @@ declare const docOperations: {
6546
6778
  docId: z.ZodString;
6547
6779
  } & {
6548
6780
  layerName: z.ZodString;
6781
+ } & {
6782
+ pon: z.ZodNumber;
6549
6783
  }, "strip", z.ZodTypeAny, {
6550
6784
  docId: string;
6551
6785
  layerName: string;
6786
+ pon: number;
6552
6787
  }, {
6553
6788
  docId: string;
6554
6789
  layerName: string;
6790
+ pon: number;
6555
6791
  }>;
6556
6792
  readonly body: {
6557
6793
  readonly contentType: "application/json";
@@ -6570,33 +6806,67 @@ declare const docOperations: {
6570
6806
  readonly schema: z.ZodType<_embedpdf_engine_core_runtime.SerializedEngineError, z.ZodTypeDef, _embedpdf_engine_core_runtime.SerializedEngineError>;
6571
6807
  };
6572
6808
  };
6573
- readonly notes: "A read, not a mutation: the source document is untouched and no event is published. Body is `{\"pageObjectNumbers\": number[]}`; the response body is the new PDF.";
6574
6809
  };
6575
- readonly 'doc.redactions.apply': {
6576
- readonly operationId: "doc.redactions.apply";
6577
- readonly title: "Apply redactions";
6578
- readonly summary: "Apply pending redactions, permanently removing content.";
6810
+ readonly 'doc.forms.get': {
6811
+ readonly operationId: "doc.forms.get";
6812
+ readonly title: "Get form snapshot";
6813
+ readonly summary: "Reconciled form snapshot: fields, widgets, values.";
6814
+ readonly method: "GET";
6815
+ readonly path: "/v1/docs/:docId/layers/:layerName/form";
6816
+ readonly credentials: readonly ["api-token", "doc-jwt"];
6817
+ readonly scope: readonly [];
6818
+ readonly docCapabilities: readonly ["doc.forms.read"];
6819
+ readonly requestHeaders: readonly [AdminOperationHeader];
6820
+ readonly params: z.ZodObject<{
6821
+ docId: z.ZodString;
6822
+ } & {
6823
+ layerName: z.ZodString;
6824
+ }, "strip", z.ZodTypeAny, {
6825
+ docId: string;
6826
+ layerName: string;
6827
+ }, {
6828
+ docId: string;
6829
+ layerName: string;
6830
+ }>;
6831
+ readonly responses: {
6832
+ readonly 200: {
6833
+ readonly contentType: "application/json";
6834
+ readonly schema: z.ZodType<_embedpdf_engine_core_runtime.FormSnapshot, z.ZodTypeDef, _embedpdf_engine_core_runtime.FormSnapshot>;
6835
+ };
6836
+ readonly 404: {
6837
+ readonly contentType: "application/json";
6838
+ readonly schema: z.ZodType<_embedpdf_engine_core_runtime.SerializedEngineError, z.ZodTypeDef, _embedpdf_engine_core_runtime.SerializedEngineError>;
6839
+ };
6840
+ };
6841
+ };
6842
+ readonly 'doc.forms.setValue': {
6843
+ readonly operationId: "doc.forms.setValue";
6844
+ readonly title: "Set form value";
6845
+ readonly summary: "Set one form field's value.";
6579
6846
  readonly method: "POST";
6580
- readonly path: "/v1/docs/:docId/layers/:layerName/redactions/apply";
6847
+ readonly path: "/v1/docs/:docId/layers/:layerName/form/fields/:fieldKey/value";
6581
6848
  readonly credentials: readonly ["api-token", "doc-jwt"];
6582
6849
  readonly scope: readonly [];
6583
- readonly docCapabilities: readonly ["doc.pages.modify", "doc.annotate.modify", "doc.redact"];
6850
+ readonly docCapabilities: readonly ["doc.forms.fill"];
6584
6851
  readonly requestHeaders: readonly [AdminOperationHeader];
6585
6852
  readonly params: z.ZodObject<{
6586
6853
  docId: z.ZodString;
6587
6854
  } & {
6588
6855
  layerName: z.ZodString;
6856
+ } & {
6857
+ fieldKey: z.ZodString;
6589
6858
  }, "strip", z.ZodTypeAny, {
6590
6859
  docId: string;
6591
6860
  layerName: string;
6861
+ fieldKey: string;
6592
6862
  }, {
6593
6863
  docId: string;
6594
6864
  layerName: string;
6865
+ fieldKey: string;
6595
6866
  }>;
6596
6867
  readonly body: {
6597
6868
  readonly contentType: "application/json";
6598
6869
  readonly schema: z.ZodRecord<z.ZodString, z.ZodUnknown>;
6599
- readonly required: false;
6600
6870
  };
6601
6871
  readonly responses: {
6602
6872
  readonly 200: {
@@ -6619,30 +6889,41 @@ declare const docOperations: {
6619
6889
  };
6620
6890
  };
6621
6891
  };
6622
- readonly 'doc.download': {
6623
- readonly operationId: "doc.download";
6624
- readonly title: "Download PDF";
6625
- readonly summary: "Download the layer's current PDF (base plus layer edits).";
6626
- readonly method: "GET";
6627
- readonly path: "/v1/docs/:docId/layers/:layerName/download";
6892
+ readonly 'doc.forms.reset': {
6893
+ readonly operationId: "doc.forms.reset";
6894
+ readonly title: "Reset form field";
6895
+ readonly summary: "Reset one form field to its default value.";
6896
+ readonly method: "POST";
6897
+ readonly path: "/v1/docs/:docId/layers/:layerName/form/fields/:fieldKey/reset";
6628
6898
  readonly credentials: readonly ["api-token", "doc-jwt"];
6629
6899
  readonly scope: readonly [];
6630
- readonly docCapabilities: readonly ["doc.download"];
6900
+ readonly docCapabilities: readonly ["doc.forms.fill"];
6631
6901
  readonly requestHeaders: readonly [AdminOperationHeader];
6632
6902
  readonly params: z.ZodObject<{
6633
6903
  docId: z.ZodString;
6634
6904
  } & {
6635
6905
  layerName: z.ZodString;
6906
+ } & {
6907
+ fieldKey: z.ZodString;
6636
6908
  }, "strip", z.ZodTypeAny, {
6637
6909
  docId: string;
6638
6910
  layerName: string;
6911
+ fieldKey: string;
6639
6912
  }, {
6640
6913
  docId: string;
6641
6914
  layerName: string;
6915
+ fieldKey: string;
6642
6916
  }>;
6643
6917
  readonly responses: {
6644
6918
  readonly 200: {
6645
- readonly contentType: "application/pdf";
6919
+ readonly contentType: "application/json";
6920
+ readonly schema: z.ZodObject<{
6921
+ meta: z.ZodType<_embedpdf_engine_core_runtime.MutationMeta, z.ZodTypeDef, _embedpdf_engine_core_runtime.MutationMeta>;
6922
+ }, "passthrough", z.ZodTypeAny, z.objectOutputType<{
6923
+ meta: z.ZodType<_embedpdf_engine_core_runtime.MutationMeta, z.ZodTypeDef, _embedpdf_engine_core_runtime.MutationMeta>;
6924
+ }, z.ZodTypeAny, "passthrough">, z.objectInputType<{
6925
+ meta: z.ZodType<_embedpdf_engine_core_runtime.MutationMeta, z.ZodTypeDef, _embedpdf_engine_core_runtime.MutationMeta>;
6926
+ }, z.ZodTypeAny, "passthrough">>;
6646
6927
  };
6647
6928
  readonly 404: {
6648
6929
  readonly contentType: "application/json";
@@ -6650,55 +6931,627 @@ declare const docOperations: {
6650
6931
  };
6651
6932
  };
6652
6933
  };
6653
- };
6654
- type DocOperationId = keyof typeof docOperations;
6655
- /** Every operation in the published contract: admin surfaces + doc plane. */
6656
- declare const allOperations: {
6657
- readonly 'doc.head': {
6658
- readonly operationId: "doc.head";
6659
- readonly title: "Open document";
6660
- readonly summary: "Open a document and return its head (versions, page count, security).";
6934
+ readonly 'doc.forms.exportData': {
6935
+ readonly operationId: "doc.forms.exportData";
6936
+ readonly title: "Export form data";
6937
+ readonly summary: "Export form data as FDF or XFDF.";
6661
6938
  readonly method: "GET";
6662
- readonly path: "/v1/docs/:docId/head";
6939
+ readonly path: "/v1/docs/:docId/layers/:layerName/form/data";
6663
6940
  readonly credentials: readonly ["api-token", "doc-jwt"];
6664
6941
  readonly scope: readonly [];
6665
- readonly docCapabilities: readonly ["doc.open"];
6942
+ readonly docCapabilities: readonly ["doc.forms.read"];
6943
+ readonly requestHeaders: readonly [AdminOperationHeader];
6944
+ readonly params: z.ZodObject<{
6945
+ docId: z.ZodString;
6946
+ } & {
6947
+ layerName: z.ZodString;
6948
+ }, "strip", z.ZodTypeAny, {
6949
+ docId: string;
6950
+ layerName: string;
6951
+ }, {
6952
+ docId: string;
6953
+ layerName: string;
6954
+ }>;
6955
+ readonly query: z.ZodObject<{
6956
+ format: z.ZodOptional<z.ZodEnum<["fdf", "xfdf"]>>;
6957
+ }, "strip", z.ZodTypeAny, {
6958
+ format?: "fdf" | "xfdf" | undefined;
6959
+ }, {
6960
+ format?: "fdf" | "xfdf" | undefined;
6961
+ }>;
6962
+ readonly responses: {
6963
+ readonly 200: {
6964
+ readonly contentType: readonly ["application/vnd.adobe.xfdf", "application/vnd.fdf"];
6965
+ };
6966
+ readonly 404: {
6967
+ readonly contentType: "application/json";
6968
+ readonly schema: z.ZodType<_embedpdf_engine_core_runtime.SerializedEngineError, z.ZodTypeDef, _embedpdf_engine_core_runtime.SerializedEngineError>;
6969
+ };
6970
+ };
6971
+ };
6972
+ readonly 'doc.forms.importData': {
6973
+ readonly operationId: "doc.forms.importData";
6974
+ readonly title: "Import form data";
6975
+ readonly summary: "Import form data (FDF/XFDF), filling matching fields.";
6976
+ readonly method: "POST";
6977
+ readonly path: "/v1/docs/:docId/layers/:layerName/form/data";
6978
+ readonly credentials: readonly ["api-token", "doc-jwt"];
6979
+ readonly scope: readonly [];
6980
+ readonly docCapabilities: readonly ["doc.forms.fill"];
6666
6981
  readonly requestHeaders: readonly [AdminOperationHeader];
6667
6982
  readonly params: z.ZodObject<{
6668
6983
  docId: z.ZodString;
6984
+ } & {
6985
+ layerName: z.ZodString;
6669
6986
  }, "strip", z.ZodTypeAny, {
6670
6987
  docId: string;
6988
+ layerName: string;
6671
6989
  }, {
6672
6990
  docId: string;
6991
+ layerName: string;
6673
6992
  }>;
6993
+ readonly body: {
6994
+ readonly contentType: "application/json";
6995
+ readonly schema: z.ZodRecord<z.ZodString, z.ZodUnknown>;
6996
+ };
6674
6997
  readonly responses: {
6675
6998
  readonly 200: {
6676
6999
  readonly contentType: "application/json";
6677
7000
  readonly schema: z.ZodObject<{
6678
- id: z.ZodString;
6679
- baseSha: z.ZodString;
6680
- storageSizeBytes: z.ZodNumber;
6681
- docVersion: z.ZodNumber;
6682
- state: z.ZodEnum<["pending", "ready", "failed", "deleting"]>;
6683
- encryption: z.ZodObject<{
6684
- state: z.ZodEnum<["unknown", "none", "encrypted", "unsupported"]>;
6685
- requiresPassword: z.ZodNullable<z.ZodBoolean>;
6686
- }, "strip", z.ZodTypeAny, {
6687
- state: "unknown" | "none" | "encrypted" | "unsupported";
6688
- requiresPassword: boolean | null;
6689
- }, {
6690
- state: "unknown" | "none" | "encrypted" | "unsupported";
6691
- requiresPassword: boolean | null;
6692
- }>;
6693
- permissions: z.ZodObject<{
6694
- known: z.ZodBoolean;
6695
- bits: z.ZodNullable<z.ZodNumber>;
6696
- allAllowed: z.ZodNullable<z.ZodBoolean>;
6697
- openedAs: z.ZodNullable<z.ZodEnum<["none", "user", "owner"]>>;
6698
- securityHandlerRevision: z.ZodNullable<z.ZodNumber>;
6699
- canUpgradeToOwner: z.ZodBoolean;
6700
- }, "strip", z.ZodTypeAny, {
6701
- known: boolean;
7001
+ meta: z.ZodType<_embedpdf_engine_core_runtime.MutationMeta, z.ZodTypeDef, _embedpdf_engine_core_runtime.MutationMeta>;
7002
+ }, "passthrough", z.ZodTypeAny, z.objectOutputType<{
7003
+ meta: z.ZodType<_embedpdf_engine_core_runtime.MutationMeta, z.ZodTypeDef, _embedpdf_engine_core_runtime.MutationMeta>;
7004
+ }, z.ZodTypeAny, "passthrough">, z.objectInputType<{
7005
+ meta: z.ZodType<_embedpdf_engine_core_runtime.MutationMeta, z.ZodTypeDef, _embedpdf_engine_core_runtime.MutationMeta>;
7006
+ }, z.ZodTypeAny, "passthrough">>;
7007
+ };
7008
+ readonly 400: {
7009
+ readonly contentType: "application/json";
7010
+ readonly schema: z.ZodType<_embedpdf_engine_core_runtime.SerializedEngineError, z.ZodTypeDef, _embedpdf_engine_core_runtime.SerializedEngineError>;
7011
+ };
7012
+ readonly 404: {
7013
+ readonly contentType: "application/json";
7014
+ readonly schema: z.ZodType<_embedpdf_engine_core_runtime.SerializedEngineError, z.ZodTypeDef, _embedpdf_engine_core_runtime.SerializedEngineError>;
7015
+ };
7016
+ };
7017
+ };
7018
+ readonly 'doc.pages.move': {
7019
+ readonly operationId: "doc.pages.move";
7020
+ readonly title: "Move pages";
7021
+ readonly summary: "Reorder pages.";
7022
+ readonly method: "POST";
7023
+ readonly path: "/v1/docs/:docId/layers/:layerName/pages/move";
7024
+ readonly credentials: readonly ["api-token", "doc-jwt"];
7025
+ readonly scope: readonly [];
7026
+ readonly docCapabilities: readonly ["doc.pages.assemble"];
7027
+ readonly requestHeaders: readonly [AdminOperationHeader];
7028
+ readonly params: z.ZodObject<{
7029
+ docId: z.ZodString;
7030
+ } & {
7031
+ layerName: z.ZodString;
7032
+ }, "strip", z.ZodTypeAny, {
7033
+ docId: string;
7034
+ layerName: string;
7035
+ }, {
7036
+ docId: string;
7037
+ layerName: string;
7038
+ }>;
7039
+ readonly body: {
7040
+ readonly contentType: "application/json";
7041
+ readonly schema: z.ZodRecord<z.ZodString, z.ZodUnknown>;
7042
+ };
7043
+ readonly responses: {
7044
+ readonly 200: {
7045
+ readonly contentType: "application/json";
7046
+ readonly schema: z.ZodObject<{
7047
+ meta: z.ZodType<_embedpdf_engine_core_runtime.MutationMeta, z.ZodTypeDef, _embedpdf_engine_core_runtime.MutationMeta>;
7048
+ }, "passthrough", z.ZodTypeAny, z.objectOutputType<{
7049
+ meta: z.ZodType<_embedpdf_engine_core_runtime.MutationMeta, z.ZodTypeDef, _embedpdf_engine_core_runtime.MutationMeta>;
7050
+ }, z.ZodTypeAny, "passthrough">, z.objectInputType<{
7051
+ meta: z.ZodType<_embedpdf_engine_core_runtime.MutationMeta, z.ZodTypeDef, _embedpdf_engine_core_runtime.MutationMeta>;
7052
+ }, z.ZodTypeAny, "passthrough">>;
7053
+ };
7054
+ readonly 400: {
7055
+ readonly contentType: "application/json";
7056
+ readonly schema: z.ZodType<_embedpdf_engine_core_runtime.SerializedEngineError, z.ZodTypeDef, _embedpdf_engine_core_runtime.SerializedEngineError>;
7057
+ };
7058
+ readonly 404: {
7059
+ readonly contentType: "application/json";
7060
+ readonly schema: z.ZodType<_embedpdf_engine_core_runtime.SerializedEngineError, z.ZodTypeDef, _embedpdf_engine_core_runtime.SerializedEngineError>;
7061
+ };
7062
+ };
7063
+ };
7064
+ readonly 'doc.pages.rotate': {
7065
+ readonly operationId: "doc.pages.rotate";
7066
+ readonly title: "Rotate pages";
7067
+ readonly summary: "Set absolute rotation on pages.";
7068
+ readonly method: "POST";
7069
+ readonly path: "/v1/docs/:docId/layers/:layerName/pages/rotate";
7070
+ readonly credentials: readonly ["api-token", "doc-jwt"];
7071
+ readonly scope: readonly [];
7072
+ readonly docCapabilities: readonly ["doc.pages.assemble"];
7073
+ readonly requestHeaders: readonly [AdminOperationHeader];
7074
+ readonly params: z.ZodObject<{
7075
+ docId: z.ZodString;
7076
+ } & {
7077
+ layerName: z.ZodString;
7078
+ }, "strip", z.ZodTypeAny, {
7079
+ docId: string;
7080
+ layerName: string;
7081
+ }, {
7082
+ docId: string;
7083
+ layerName: string;
7084
+ }>;
7085
+ readonly body: {
7086
+ readonly contentType: "application/json";
7087
+ readonly schema: z.ZodRecord<z.ZodString, z.ZodUnknown>;
7088
+ };
7089
+ readonly responses: {
7090
+ readonly 200: {
7091
+ readonly contentType: "application/json";
7092
+ readonly schema: z.ZodObject<{
7093
+ meta: z.ZodType<_embedpdf_engine_core_runtime.MutationMeta, z.ZodTypeDef, _embedpdf_engine_core_runtime.MutationMeta>;
7094
+ }, "passthrough", z.ZodTypeAny, z.objectOutputType<{
7095
+ meta: z.ZodType<_embedpdf_engine_core_runtime.MutationMeta, z.ZodTypeDef, _embedpdf_engine_core_runtime.MutationMeta>;
7096
+ }, z.ZodTypeAny, "passthrough">, z.objectInputType<{
7097
+ meta: z.ZodType<_embedpdf_engine_core_runtime.MutationMeta, z.ZodTypeDef, _embedpdf_engine_core_runtime.MutationMeta>;
7098
+ }, z.ZodTypeAny, "passthrough">>;
7099
+ };
7100
+ readonly 400: {
7101
+ readonly contentType: "application/json";
7102
+ readonly schema: z.ZodType<_embedpdf_engine_core_runtime.SerializedEngineError, z.ZodTypeDef, _embedpdf_engine_core_runtime.SerializedEngineError>;
7103
+ };
7104
+ readonly 404: {
7105
+ readonly contentType: "application/json";
7106
+ readonly schema: z.ZodType<_embedpdf_engine_core_runtime.SerializedEngineError, z.ZodTypeDef, _embedpdf_engine_core_runtime.SerializedEngineError>;
7107
+ };
7108
+ };
7109
+ };
7110
+ readonly 'doc.pages.delete': {
7111
+ readonly operationId: "doc.pages.delete";
7112
+ readonly title: "Delete pages";
7113
+ readonly summary: "Delete pages.";
7114
+ readonly method: "POST";
7115
+ readonly path: "/v1/docs/:docId/layers/:layerName/pages/delete";
7116
+ readonly credentials: readonly ["api-token", "doc-jwt"];
7117
+ readonly scope: readonly [];
7118
+ readonly docCapabilities: readonly ["doc.pages.assemble"];
7119
+ readonly requestHeaders: readonly [AdminOperationHeader];
7120
+ readonly params: z.ZodObject<{
7121
+ docId: z.ZodString;
7122
+ } & {
7123
+ layerName: z.ZodString;
7124
+ }, "strip", z.ZodTypeAny, {
7125
+ docId: string;
7126
+ layerName: string;
7127
+ }, {
7128
+ docId: string;
7129
+ layerName: string;
7130
+ }>;
7131
+ readonly body: {
7132
+ readonly contentType: "application/json";
7133
+ readonly schema: z.ZodRecord<z.ZodString, z.ZodUnknown>;
7134
+ };
7135
+ readonly responses: {
7136
+ readonly 200: {
7137
+ readonly contentType: "application/json";
7138
+ readonly schema: z.ZodObject<{
7139
+ meta: z.ZodType<_embedpdf_engine_core_runtime.MutationMeta, z.ZodTypeDef, _embedpdf_engine_core_runtime.MutationMeta>;
7140
+ }, "passthrough", z.ZodTypeAny, z.objectOutputType<{
7141
+ meta: z.ZodType<_embedpdf_engine_core_runtime.MutationMeta, z.ZodTypeDef, _embedpdf_engine_core_runtime.MutationMeta>;
7142
+ }, z.ZodTypeAny, "passthrough">, z.objectInputType<{
7143
+ meta: z.ZodType<_embedpdf_engine_core_runtime.MutationMeta, z.ZodTypeDef, _embedpdf_engine_core_runtime.MutationMeta>;
7144
+ }, z.ZodTypeAny, "passthrough">>;
7145
+ };
7146
+ readonly 400: {
7147
+ readonly contentType: "application/json";
7148
+ readonly schema: z.ZodType<_embedpdf_engine_core_runtime.SerializedEngineError, z.ZodTypeDef, _embedpdf_engine_core_runtime.SerializedEngineError>;
7149
+ };
7150
+ readonly 404: {
7151
+ readonly contentType: "application/json";
7152
+ readonly schema: z.ZodType<_embedpdf_engine_core_runtime.SerializedEngineError, z.ZodTypeDef, _embedpdf_engine_core_runtime.SerializedEngineError>;
7153
+ };
7154
+ };
7155
+ };
7156
+ readonly 'doc.pages.setName': {
7157
+ readonly operationId: "doc.pages.setName";
7158
+ readonly title: "Set page name";
7159
+ readonly summary: "Register or rename a /Names /Pages entry (a named page). A page-structure mutation: the layout version advances.";
7160
+ readonly method: "POST";
7161
+ readonly path: "/v1/docs/:docId/layers/:layerName/pages/names";
7162
+ readonly credentials: readonly ["api-token", "doc-jwt"];
7163
+ readonly scope: readonly [];
7164
+ readonly docCapabilities: readonly ["doc.pages.assemble"];
7165
+ readonly requestHeaders: readonly [AdminOperationHeader];
7166
+ readonly params: z.ZodObject<{
7167
+ docId: z.ZodString;
7168
+ } & {
7169
+ layerName: z.ZodString;
7170
+ }, "strip", z.ZodTypeAny, {
7171
+ docId: string;
7172
+ layerName: string;
7173
+ }, {
7174
+ docId: string;
7175
+ layerName: string;
7176
+ }>;
7177
+ readonly body: {
7178
+ readonly contentType: "application/json";
7179
+ readonly schema: z.ZodRecord<z.ZodString, z.ZodUnknown>;
7180
+ };
7181
+ readonly responses: {
7182
+ readonly 200: {
7183
+ readonly contentType: "application/json";
7184
+ readonly schema: z.ZodObject<{
7185
+ meta: z.ZodType<_embedpdf_engine_core_runtime.MutationMeta, z.ZodTypeDef, _embedpdf_engine_core_runtime.MutationMeta>;
7186
+ }, "passthrough", z.ZodTypeAny, z.objectOutputType<{
7187
+ meta: z.ZodType<_embedpdf_engine_core_runtime.MutationMeta, z.ZodTypeDef, _embedpdf_engine_core_runtime.MutationMeta>;
7188
+ }, z.ZodTypeAny, "passthrough">, z.objectInputType<{
7189
+ meta: z.ZodType<_embedpdf_engine_core_runtime.MutationMeta, z.ZodTypeDef, _embedpdf_engine_core_runtime.MutationMeta>;
7190
+ }, z.ZodTypeAny, "passthrough">>;
7191
+ };
7192
+ readonly 400: {
7193
+ readonly contentType: "application/json";
7194
+ readonly schema: z.ZodType<_embedpdf_engine_core_runtime.SerializedEngineError, z.ZodTypeDef, _embedpdf_engine_core_runtime.SerializedEngineError>;
7195
+ };
7196
+ readonly 404: {
7197
+ readonly contentType: "application/json";
7198
+ readonly schema: z.ZodType<_embedpdf_engine_core_runtime.SerializedEngineError, z.ZodTypeDef, _embedpdf_engine_core_runtime.SerializedEngineError>;
7199
+ };
7200
+ };
7201
+ };
7202
+ readonly 'doc.pages.removeName': {
7203
+ readonly operationId: "doc.pages.removeName";
7204
+ readonly title: "Remove page name";
7205
+ readonly summary: "Remove a /Names /Pages entry; the page itself stays.";
7206
+ readonly method: "POST";
7207
+ readonly path: "/v1/docs/:docId/layers/:layerName/pages/names/delete";
7208
+ readonly credentials: readonly ["api-token", "doc-jwt"];
7209
+ readonly scope: readonly [];
7210
+ readonly docCapabilities: readonly ["doc.pages.assemble"];
7211
+ readonly requestHeaders: readonly [AdminOperationHeader];
7212
+ readonly params: z.ZodObject<{
7213
+ docId: z.ZodString;
7214
+ } & {
7215
+ layerName: z.ZodString;
7216
+ }, "strip", z.ZodTypeAny, {
7217
+ docId: string;
7218
+ layerName: string;
7219
+ }, {
7220
+ docId: string;
7221
+ layerName: string;
7222
+ }>;
7223
+ readonly body: {
7224
+ readonly contentType: "application/json";
7225
+ readonly schema: z.ZodRecord<z.ZodString, z.ZodUnknown>;
7226
+ };
7227
+ readonly responses: {
7228
+ readonly 200: {
7229
+ readonly contentType: "application/json";
7230
+ readonly schema: z.ZodObject<{
7231
+ meta: z.ZodType<_embedpdf_engine_core_runtime.MutationMeta, z.ZodTypeDef, _embedpdf_engine_core_runtime.MutationMeta>;
7232
+ }, "passthrough", z.ZodTypeAny, z.objectOutputType<{
7233
+ meta: z.ZodType<_embedpdf_engine_core_runtime.MutationMeta, z.ZodTypeDef, _embedpdf_engine_core_runtime.MutationMeta>;
7234
+ }, z.ZodTypeAny, "passthrough">, z.objectInputType<{
7235
+ meta: z.ZodType<_embedpdf_engine_core_runtime.MutationMeta, z.ZodTypeDef, _embedpdf_engine_core_runtime.MutationMeta>;
7236
+ }, z.ZodTypeAny, "passthrough">>;
7237
+ };
7238
+ readonly 400: {
7239
+ readonly contentType: "application/json";
7240
+ readonly schema: z.ZodType<_embedpdf_engine_core_runtime.SerializedEngineError, z.ZodTypeDef, _embedpdf_engine_core_runtime.SerializedEngineError>;
7241
+ };
7242
+ readonly 404: {
7243
+ readonly contentType: "application/json";
7244
+ readonly schema: z.ZodType<_embedpdf_engine_core_runtime.SerializedEngineError, z.ZodTypeDef, _embedpdf_engine_core_runtime.SerializedEngineError>;
7245
+ };
7246
+ };
7247
+ };
7248
+ readonly 'doc.pages.flatten': {
7249
+ readonly operationId: "doc.pages.flatten";
7250
+ readonly title: "Flatten pages";
7251
+ readonly summary: "Flatten annotations and form fields into page content.";
7252
+ readonly method: "POST";
7253
+ readonly path: "/v1/docs/:docId/layers/:layerName/pages/flatten";
7254
+ readonly credentials: readonly ["api-token", "doc-jwt"];
7255
+ readonly scope: readonly [];
7256
+ readonly docCapabilities: readonly ["doc.pages.modify", "doc.annotate.modify"];
7257
+ readonly requestHeaders: readonly [AdminOperationHeader];
7258
+ readonly params: z.ZodObject<{
7259
+ docId: z.ZodString;
7260
+ } & {
7261
+ layerName: z.ZodString;
7262
+ }, "strip", z.ZodTypeAny, {
7263
+ docId: string;
7264
+ layerName: string;
7265
+ }, {
7266
+ docId: string;
7267
+ layerName: string;
7268
+ }>;
7269
+ readonly body: {
7270
+ readonly contentType: "application/json";
7271
+ readonly schema: z.ZodRecord<z.ZodString, z.ZodUnknown>;
7272
+ readonly required: false;
7273
+ };
7274
+ readonly responses: {
7275
+ readonly 200: {
7276
+ readonly contentType: "application/json";
7277
+ readonly schema: z.ZodObject<{
7278
+ meta: z.ZodType<_embedpdf_engine_core_runtime.MutationMeta, z.ZodTypeDef, _embedpdf_engine_core_runtime.MutationMeta>;
7279
+ }, "passthrough", z.ZodTypeAny, z.objectOutputType<{
7280
+ meta: z.ZodType<_embedpdf_engine_core_runtime.MutationMeta, z.ZodTypeDef, _embedpdf_engine_core_runtime.MutationMeta>;
7281
+ }, z.ZodTypeAny, "passthrough">, z.objectInputType<{
7282
+ meta: z.ZodType<_embedpdf_engine_core_runtime.MutationMeta, z.ZodTypeDef, _embedpdf_engine_core_runtime.MutationMeta>;
7283
+ }, z.ZodTypeAny, "passthrough">>;
7284
+ };
7285
+ readonly 400: {
7286
+ readonly contentType: "application/json";
7287
+ readonly schema: z.ZodType<_embedpdf_engine_core_runtime.SerializedEngineError, z.ZodTypeDef, _embedpdf_engine_core_runtime.SerializedEngineError>;
7288
+ };
7289
+ readonly 404: {
7290
+ readonly contentType: "application/json";
7291
+ readonly schema: z.ZodType<_embedpdf_engine_core_runtime.SerializedEngineError, z.ZodTypeDef, _embedpdf_engine_core_runtime.SerializedEngineError>;
7292
+ };
7293
+ };
7294
+ };
7295
+ readonly 'doc.pages.insert': {
7296
+ readonly operationId: "doc.pages.insert";
7297
+ readonly title: "Insert pages from a PDF";
7298
+ readonly summary: "Copy every page of an uploaded PDF into the document at an index.";
7299
+ readonly method: "POST";
7300
+ readonly path: "/v1/docs/:docId/layers/:layerName/pages/insert";
7301
+ readonly credentials: readonly ["api-token", "doc-jwt"];
7302
+ readonly scope: readonly [];
7303
+ readonly docCapabilities: readonly ["doc.pages.assemble"];
7304
+ readonly requestHeaders: readonly [AdminOperationHeader];
7305
+ readonly params: z.ZodObject<{
7306
+ docId: z.ZodString;
7307
+ } & {
7308
+ layerName: z.ZodString;
7309
+ }, "strip", z.ZodTypeAny, {
7310
+ docId: string;
7311
+ layerName: string;
7312
+ }, {
7313
+ docId: string;
7314
+ layerName: string;
7315
+ }>;
7316
+ readonly body: {
7317
+ readonly contentType: "multipart/form-data";
7318
+ };
7319
+ readonly responses: {
7320
+ readonly 200: {
7321
+ readonly contentType: "application/json";
7322
+ readonly schema: z.ZodObject<{
7323
+ meta: z.ZodType<_embedpdf_engine_core_runtime.MutationMeta, z.ZodTypeDef, _embedpdf_engine_core_runtime.MutationMeta>;
7324
+ }, "passthrough", z.ZodTypeAny, z.objectOutputType<{
7325
+ meta: z.ZodType<_embedpdf_engine_core_runtime.MutationMeta, z.ZodTypeDef, _embedpdf_engine_core_runtime.MutationMeta>;
7326
+ }, z.ZodTypeAny, "passthrough">, z.objectInputType<{
7327
+ meta: z.ZodType<_embedpdf_engine_core_runtime.MutationMeta, z.ZodTypeDef, _embedpdf_engine_core_runtime.MutationMeta>;
7328
+ }, z.ZodTypeAny, "passthrough">>;
7329
+ };
7330
+ readonly 400: {
7331
+ readonly contentType: "application/json";
7332
+ readonly schema: z.ZodType<_embedpdf_engine_core_runtime.SerializedEngineError, z.ZodTypeDef, _embedpdf_engine_core_runtime.SerializedEngineError>;
7333
+ };
7334
+ readonly 404: {
7335
+ readonly contentType: "application/json";
7336
+ readonly schema: z.ZodType<_embedpdf_engine_core_runtime.SerializedEngineError, z.ZodTypeDef, _embedpdf_engine_core_runtime.SerializedEngineError>;
7337
+ };
7338
+ };
7339
+ readonly notes: "Multipart mutation envelope: a `body` field holding `{\"destIndex\"?: number}` (omitted → append) plus a `resource:source` file part carrying the standalone PDF whose pages are copied in. The inserted copies get fresh page object numbers, returned in insertion order.";
7340
+ };
7341
+ readonly 'doc.pages.insertBlank': {
7342
+ readonly operationId: "doc.pages.insertBlank";
7343
+ readonly title: "Insert blank pages";
7344
+ readonly summary: "Create blank pages of an explicit size at an index.";
7345
+ readonly method: "POST";
7346
+ readonly path: "/v1/docs/:docId/layers/:layerName/pages/insert-blank";
7347
+ readonly credentials: readonly ["api-token", "doc-jwt"];
7348
+ readonly scope: readonly [];
7349
+ readonly docCapabilities: readonly ["doc.pages.assemble"];
7350
+ readonly requestHeaders: readonly [AdminOperationHeader];
7351
+ readonly params: z.ZodObject<{
7352
+ docId: z.ZodString;
7353
+ } & {
7354
+ layerName: z.ZodString;
7355
+ }, "strip", z.ZodTypeAny, {
7356
+ docId: string;
7357
+ layerName: string;
7358
+ }, {
7359
+ docId: string;
7360
+ layerName: string;
7361
+ }>;
7362
+ readonly body: {
7363
+ readonly contentType: "application/json";
7364
+ readonly schema: z.ZodRecord<z.ZodString, z.ZodUnknown>;
7365
+ };
7366
+ readonly responses: {
7367
+ readonly 200: {
7368
+ readonly contentType: "application/json";
7369
+ readonly schema: z.ZodObject<{
7370
+ meta: z.ZodType<_embedpdf_engine_core_runtime.MutationMeta, z.ZodTypeDef, _embedpdf_engine_core_runtime.MutationMeta>;
7371
+ }, "passthrough", z.ZodTypeAny, z.objectOutputType<{
7372
+ meta: z.ZodType<_embedpdf_engine_core_runtime.MutationMeta, z.ZodTypeDef, _embedpdf_engine_core_runtime.MutationMeta>;
7373
+ }, z.ZodTypeAny, "passthrough">, z.objectInputType<{
7374
+ meta: z.ZodType<_embedpdf_engine_core_runtime.MutationMeta, z.ZodTypeDef, _embedpdf_engine_core_runtime.MutationMeta>;
7375
+ }, z.ZodTypeAny, "passthrough">>;
7376
+ };
7377
+ readonly 400: {
7378
+ readonly contentType: "application/json";
7379
+ readonly schema: z.ZodType<_embedpdf_engine_core_runtime.SerializedEngineError, z.ZodTypeDef, _embedpdf_engine_core_runtime.SerializedEngineError>;
7380
+ };
7381
+ readonly 404: {
7382
+ readonly contentType: "application/json";
7383
+ readonly schema: z.ZodType<_embedpdf_engine_core_runtime.SerializedEngineError, z.ZodTypeDef, _embedpdf_engine_core_runtime.SerializedEngineError>;
7384
+ };
7385
+ };
7386
+ readonly notes: "Body is `{\"size\": {\"width\", \"height\"}, \"count\"?, \"destIndex\"?}` — size in PDF points, count in [1, 100], destIndex omitted → append.";
7387
+ };
7388
+ readonly 'doc.pages.extract': {
7389
+ readonly operationId: "doc.pages.extract";
7390
+ readonly title: "Extract pages";
7391
+ readonly summary: "Export the listed pages, in order, as a standalone PDF.";
7392
+ readonly method: "POST";
7393
+ readonly path: "/v1/docs/:docId/layers/:layerName/pages/extract";
7394
+ readonly credentials: readonly ["api-token", "doc-jwt"];
7395
+ readonly scope: readonly [];
7396
+ readonly docCapabilities: readonly ["doc.download"];
7397
+ readonly requestHeaders: readonly [AdminOperationHeader];
7398
+ readonly params: z.ZodObject<{
7399
+ docId: z.ZodString;
7400
+ } & {
7401
+ layerName: z.ZodString;
7402
+ }, "strip", z.ZodTypeAny, {
7403
+ docId: string;
7404
+ layerName: string;
7405
+ }, {
7406
+ docId: string;
7407
+ layerName: string;
7408
+ }>;
7409
+ readonly body: {
7410
+ readonly contentType: "application/json";
7411
+ readonly schema: z.ZodRecord<z.ZodString, z.ZodUnknown>;
7412
+ };
7413
+ readonly responses: {
7414
+ readonly 200: {
7415
+ readonly contentType: "application/pdf";
7416
+ };
7417
+ readonly 400: {
7418
+ readonly contentType: "application/json";
7419
+ readonly schema: z.ZodType<_embedpdf_engine_core_runtime.SerializedEngineError, z.ZodTypeDef, _embedpdf_engine_core_runtime.SerializedEngineError>;
7420
+ };
7421
+ readonly 404: {
7422
+ readonly contentType: "application/json";
7423
+ readonly schema: z.ZodType<_embedpdf_engine_core_runtime.SerializedEngineError, z.ZodTypeDef, _embedpdf_engine_core_runtime.SerializedEngineError>;
7424
+ };
7425
+ };
7426
+ readonly notes: "A read, not a mutation: the source document is untouched and no event is published. Body is `{\"pageObjectNumbers\": number[]}`; the response body is the new PDF.";
7427
+ };
7428
+ readonly 'doc.redactions.apply': {
7429
+ readonly operationId: "doc.redactions.apply";
7430
+ readonly title: "Apply redactions";
7431
+ readonly summary: "Apply pending redactions, permanently removing content.";
7432
+ readonly method: "POST";
7433
+ readonly path: "/v1/docs/:docId/layers/:layerName/redactions/apply";
7434
+ readonly credentials: readonly ["api-token", "doc-jwt"];
7435
+ readonly scope: readonly [];
7436
+ readonly docCapabilities: readonly ["doc.pages.modify", "doc.annotate.modify", "doc.redact"];
7437
+ readonly requestHeaders: readonly [AdminOperationHeader];
7438
+ readonly params: z.ZodObject<{
7439
+ docId: z.ZodString;
7440
+ } & {
7441
+ layerName: z.ZodString;
7442
+ }, "strip", z.ZodTypeAny, {
7443
+ docId: string;
7444
+ layerName: string;
7445
+ }, {
7446
+ docId: string;
7447
+ layerName: string;
7448
+ }>;
7449
+ readonly body: {
7450
+ readonly contentType: "application/json";
7451
+ readonly schema: z.ZodRecord<z.ZodString, z.ZodUnknown>;
7452
+ readonly required: false;
7453
+ };
7454
+ readonly responses: {
7455
+ readonly 200: {
7456
+ readonly contentType: "application/json";
7457
+ readonly schema: z.ZodObject<{
7458
+ meta: z.ZodType<_embedpdf_engine_core_runtime.MutationMeta, z.ZodTypeDef, _embedpdf_engine_core_runtime.MutationMeta>;
7459
+ }, "passthrough", z.ZodTypeAny, z.objectOutputType<{
7460
+ meta: z.ZodType<_embedpdf_engine_core_runtime.MutationMeta, z.ZodTypeDef, _embedpdf_engine_core_runtime.MutationMeta>;
7461
+ }, z.ZodTypeAny, "passthrough">, z.objectInputType<{
7462
+ meta: z.ZodType<_embedpdf_engine_core_runtime.MutationMeta, z.ZodTypeDef, _embedpdf_engine_core_runtime.MutationMeta>;
7463
+ }, z.ZodTypeAny, "passthrough">>;
7464
+ };
7465
+ readonly 400: {
7466
+ readonly contentType: "application/json";
7467
+ readonly schema: z.ZodType<_embedpdf_engine_core_runtime.SerializedEngineError, z.ZodTypeDef, _embedpdf_engine_core_runtime.SerializedEngineError>;
7468
+ };
7469
+ readonly 404: {
7470
+ readonly contentType: "application/json";
7471
+ readonly schema: z.ZodType<_embedpdf_engine_core_runtime.SerializedEngineError, z.ZodTypeDef, _embedpdf_engine_core_runtime.SerializedEngineError>;
7472
+ };
7473
+ };
7474
+ };
7475
+ readonly 'doc.download': {
7476
+ readonly operationId: "doc.download";
7477
+ readonly title: "Download PDF";
7478
+ readonly summary: "Download the layer's current PDF (base plus layer edits).";
7479
+ readonly method: "GET";
7480
+ readonly path: "/v1/docs/:docId/layers/:layerName/download";
7481
+ readonly credentials: readonly ["api-token", "doc-jwt"];
7482
+ readonly scope: readonly [];
7483
+ readonly docCapabilities: readonly ["doc.download"];
7484
+ readonly requestHeaders: readonly [AdminOperationHeader];
7485
+ readonly params: z.ZodObject<{
7486
+ docId: z.ZodString;
7487
+ } & {
7488
+ layerName: z.ZodString;
7489
+ }, "strip", z.ZodTypeAny, {
7490
+ docId: string;
7491
+ layerName: string;
7492
+ }, {
7493
+ docId: string;
7494
+ layerName: string;
7495
+ }>;
7496
+ readonly responses: {
7497
+ readonly 200: {
7498
+ readonly contentType: "application/pdf";
7499
+ };
7500
+ readonly 404: {
7501
+ readonly contentType: "application/json";
7502
+ readonly schema: z.ZodType<_embedpdf_engine_core_runtime.SerializedEngineError, z.ZodTypeDef, _embedpdf_engine_core_runtime.SerializedEngineError>;
7503
+ };
7504
+ };
7505
+ };
7506
+ };
7507
+ type DocOperationId = keyof typeof docOperations;
7508
+ /** Every operation in the published contract: admin surfaces + doc plane. */
7509
+ declare const allOperations: {
7510
+ readonly 'doc.head': {
7511
+ readonly operationId: "doc.head";
7512
+ readonly title: "Open document";
7513
+ readonly summary: "Open a document and return its head (versions, page count, security).";
7514
+ readonly method: "GET";
7515
+ readonly path: "/v1/docs/:docId/head";
7516
+ readonly credentials: readonly ["api-token", "doc-jwt"];
7517
+ readonly scope: readonly [];
7518
+ readonly docCapabilities: readonly ["doc.open"];
7519
+ readonly requestHeaders: readonly [AdminOperationHeader];
7520
+ readonly params: z.ZodObject<{
7521
+ docId: z.ZodString;
7522
+ }, "strip", z.ZodTypeAny, {
7523
+ docId: string;
7524
+ }, {
7525
+ docId: string;
7526
+ }>;
7527
+ readonly responses: {
7528
+ readonly 200: {
7529
+ readonly contentType: "application/json";
7530
+ readonly schema: z.ZodObject<{
7531
+ id: z.ZodString;
7532
+ baseSha: z.ZodString;
7533
+ storageSizeBytes: z.ZodNumber;
7534
+ docVersion: z.ZodNumber;
7535
+ state: z.ZodEnum<["pending", "ready", "failed", "deleting"]>;
7536
+ encryption: z.ZodObject<{
7537
+ state: z.ZodEnum<["unknown", "none", "encrypted", "unsupported"]>;
7538
+ requiresPassword: z.ZodNullable<z.ZodBoolean>;
7539
+ }, "strip", z.ZodTypeAny, {
7540
+ state: "unknown" | "none" | "encrypted" | "unsupported";
7541
+ requiresPassword: boolean | null;
7542
+ }, {
7543
+ state: "unknown" | "none" | "encrypted" | "unsupported";
7544
+ requiresPassword: boolean | null;
7545
+ }>;
7546
+ permissions: z.ZodObject<{
7547
+ known: z.ZodBoolean;
7548
+ bits: z.ZodNullable<z.ZodNumber>;
7549
+ allAllowed: z.ZodNullable<z.ZodBoolean>;
7550
+ openedAs: z.ZodNullable<z.ZodEnum<["none", "user", "owner"]>>;
7551
+ securityHandlerRevision: z.ZodNullable<z.ZodNumber>;
7552
+ canUpgradeToOwner: z.ZodBoolean;
7553
+ }, "strip", z.ZodTypeAny, {
7554
+ known: boolean;
6702
7555
  bits: number | null;
6703
7556
  allAllowed: boolean | null;
6704
7557
  openedAs: "none" | "user" | "owner" | null;
@@ -6717,60 +7570,449 @@ declare const allOperations: {
6717
7570
  reasons: z.ZodArray<z.ZodEnum<["password", "cdn", "permissions-unknown"]>, "many">;
6718
7571
  endpoint: z.ZodOptional<z.ZodString>;
6719
7572
  }, "strip", z.ZodTypeAny, {
6720
- required: boolean;
6721
- reasons: ("password" | "cdn" | "permissions-unknown")[];
6722
- endpoint?: string | undefined;
7573
+ required: boolean;
7574
+ reasons: ("password" | "cdn" | "permissions-unknown")[];
7575
+ endpoint?: string | undefined;
7576
+ }, {
7577
+ required: boolean;
7578
+ reasons: ("password" | "cdn" | "permissions-unknown")[];
7579
+ endpoint?: string | undefined;
7580
+ }>;
7581
+ }, "strip", z.ZodTypeAny, {
7582
+ id: string;
7583
+ baseSha: string;
7584
+ storageSizeBytes: number;
7585
+ docVersion: number;
7586
+ state: "pending" | "ready" | "failed" | "deleting";
7587
+ encryption: {
7588
+ state: "unknown" | "none" | "encrypted" | "unsupported";
7589
+ requiresPassword: boolean | null;
7590
+ };
7591
+ permissions: {
7592
+ known: boolean;
7593
+ bits: number | null;
7594
+ allAllowed: boolean | null;
7595
+ openedAs: "none" | "user" | "owner" | null;
7596
+ securityHandlerRevision: number | null;
7597
+ canUpgradeToOwner: boolean;
7598
+ };
7599
+ access: {
7600
+ required: boolean;
7601
+ reasons: ("password" | "cdn" | "permissions-unknown")[];
7602
+ endpoint?: string | undefined;
7603
+ };
7604
+ }, {
7605
+ id: string;
7606
+ baseSha: string;
7607
+ storageSizeBytes: number;
7608
+ docVersion: number;
7609
+ state: "pending" | "ready" | "failed" | "deleting";
7610
+ encryption: {
7611
+ state: "unknown" | "none" | "encrypted" | "unsupported";
7612
+ requiresPassword: boolean | null;
7613
+ };
7614
+ permissions: {
7615
+ known: boolean;
7616
+ bits: number | null;
7617
+ allAllowed: boolean | null;
7618
+ openedAs: "none" | "user" | "owner" | null;
7619
+ securityHandlerRevision: number | null;
7620
+ canUpgradeToOwner: boolean;
7621
+ };
7622
+ access: {
7623
+ required: boolean;
7624
+ reasons: ("password" | "cdn" | "permissions-unknown")[];
7625
+ endpoint?: string | undefined;
7626
+ };
7627
+ }>;
7628
+ };
7629
+ readonly 404: {
7630
+ readonly contentType: "application/json";
7631
+ readonly schema: z.ZodType<_embedpdf_engine_core_runtime.SerializedEngineError, z.ZodTypeDef, _embedpdf_engine_core_runtime.SerializedEngineError>;
7632
+ };
7633
+ };
7634
+ };
7635
+ readonly 'doc.manifest': {
7636
+ readonly operationId: "doc.manifest";
7637
+ readonly title: "Get manifest";
7638
+ readonly summary: "Full layer manifest at the layer's current version.";
7639
+ readonly method: "GET";
7640
+ readonly path: "/v1/docs/:docId/layers/:layerName/manifest";
7641
+ readonly credentials: readonly ["api-token", "doc-jwt"];
7642
+ readonly scope: readonly [];
7643
+ readonly docCapabilities: readonly ["doc.open"];
7644
+ readonly requestHeaders: readonly [AdminOperationHeader];
7645
+ readonly params: z.ZodObject<{
7646
+ docId: z.ZodString;
7647
+ } & {
7648
+ layerName: z.ZodString;
7649
+ }, "strip", z.ZodTypeAny, {
7650
+ docId: string;
7651
+ layerName: string;
7652
+ }, {
7653
+ docId: string;
7654
+ layerName: string;
7655
+ }>;
7656
+ readonly responses: {
7657
+ readonly 200: {
7658
+ readonly contentType: "application/json";
7659
+ readonly schema: z.ZodType<_embedpdf_engine_core_runtime.DocumentManifest, z.ZodTypeDef, _embedpdf_engine_core_runtime.DocumentManifest>;
7660
+ };
7661
+ readonly 404: {
7662
+ readonly contentType: "application/json";
7663
+ readonly schema: z.ZodType<_embedpdf_engine_core_runtime.SerializedEngineError, z.ZodTypeDef, _embedpdf_engine_core_runtime.SerializedEngineError>;
7664
+ };
7665
+ };
7666
+ };
7667
+ readonly 'doc.metadata.get': {
7668
+ readonly operationId: "doc.metadata.get";
7669
+ readonly title: "Get metadata";
7670
+ readonly summary: "Document metadata (PDF info dictionary view) for a layer.";
7671
+ readonly method: "GET";
7672
+ readonly path: "/v1/docs/:docId/layers/:layerName/metadata";
7673
+ readonly credentials: readonly ["api-token", "doc-jwt"];
7674
+ readonly scope: readonly [];
7675
+ readonly docCapabilities: readonly ["doc.open"];
7676
+ readonly requestHeaders: readonly [AdminOperationHeader];
7677
+ readonly params: z.ZodObject<{
7678
+ docId: z.ZodString;
7679
+ } & {
7680
+ layerName: z.ZodString;
7681
+ }, "strip", z.ZodTypeAny, {
7682
+ docId: string;
7683
+ layerName: string;
7684
+ }, {
7685
+ docId: string;
7686
+ layerName: string;
7687
+ }>;
7688
+ readonly responses: {
7689
+ readonly 200: {
7690
+ readonly contentType: "application/json";
7691
+ readonly schema: z.ZodType<_embedpdf_engine_core_runtime.DocumentMetadata, z.ZodTypeDef, _embedpdf_engine_core_runtime.DocumentMetadata>;
7692
+ };
7693
+ readonly 404: {
7694
+ readonly contentType: "application/json";
7695
+ readonly schema: z.ZodType<_embedpdf_engine_core_runtime.SerializedEngineError, z.ZodTypeDef, _embedpdf_engine_core_runtime.SerializedEngineError>;
7696
+ };
7697
+ };
7698
+ };
7699
+ readonly 'doc.signatures.list': {
7700
+ readonly operationId: "doc.signatures.list";
7701
+ readonly title: "List signatures";
7702
+ readonly summary: "The layer view of digital signatures: revisions, every signature field with its signed state, and the protection in force.";
7703
+ readonly method: "GET";
7704
+ readonly path: "/v1/docs/:docId/layers/:layerName/signatures";
7705
+ readonly credentials: readonly ["api-token", "doc-jwt"];
7706
+ readonly scope: readonly [];
7707
+ readonly docCapabilities: readonly ["doc.forms.read"];
7708
+ readonly requestHeaders: readonly [AdminOperationHeader];
7709
+ readonly params: z.ZodObject<{
7710
+ docId: z.ZodString;
7711
+ } & {
7712
+ layerName: z.ZodString;
7713
+ }, "strip", z.ZodTypeAny, {
7714
+ docId: string;
7715
+ layerName: string;
7716
+ }, {
7717
+ docId: string;
7718
+ layerName: string;
7719
+ }>;
7720
+ readonly responses: {
7721
+ readonly 200: {
7722
+ readonly contentType: "application/json";
7723
+ readonly schema: z.ZodType<_embedpdf_engine_core_runtime.SignatureSnapshot, z.ZodTypeDef, _embedpdf_engine_core_runtime.SignatureSnapshot>;
7724
+ };
7725
+ readonly 404: {
7726
+ readonly contentType: "application/json";
7727
+ readonly schema: z.ZodType<_embedpdf_engine_core_runtime.SerializedEngineError, z.ZodTypeDef, _embedpdf_engine_core_runtime.SerializedEngineError>;
7728
+ };
7729
+ };
7730
+ readonly notes: string;
7731
+ };
7732
+ readonly 'doc.signatures.analysis': {
7733
+ readonly operationId: "doc.signatures.analysis";
7734
+ readonly title: "Analyze layer changes";
7735
+ readonly summary: "What the layer changed after a signature (or after any revision), judged against the restrictions in force.";
7736
+ readonly method: "GET";
7737
+ readonly path: "/v1/docs/:docId/layers/:layerName/signatures/analysis";
7738
+ readonly credentials: readonly ["api-token", "doc-jwt"];
7739
+ readonly scope: readonly [];
7740
+ readonly docCapabilities: readonly ["doc.forms.read"];
7741
+ readonly requestHeaders: readonly [AdminOperationHeader];
7742
+ readonly params: z.ZodObject<{
7743
+ docId: z.ZodString;
7744
+ } & {
7745
+ layerName: z.ZodString;
7746
+ }, "strip", z.ZodTypeAny, {
7747
+ docId: string;
7748
+ layerName: string;
7749
+ }, {
7750
+ docId: string;
7751
+ layerName: string;
7752
+ }>;
7753
+ readonly query: z.ZodObject<{
7754
+ 'since.signature': z.ZodOptional<z.ZodNumber>;
7755
+ 'since.revision': z.ZodOptional<z.ZodNumber>;
7756
+ level: z.ZodOptional<z.ZodEnum<["none", "lta", "fill", "annotate"]>>;
7757
+ }, "strip", z.ZodTypeAny, {
7758
+ 'since.signature'?: number | undefined;
7759
+ 'since.revision'?: number | undefined;
7760
+ level?: "fill" | "none" | "lta" | "annotate" | undefined;
7761
+ }, {
7762
+ 'since.signature'?: number | undefined;
7763
+ 'since.revision'?: number | undefined;
7764
+ level?: "fill" | "none" | "lta" | "annotate" | undefined;
7765
+ }>;
7766
+ readonly responses: {
7767
+ readonly 200: {
7768
+ readonly contentType: "application/json";
7769
+ readonly schema: z.ZodType<_embedpdf_engine_core_runtime.ChangeAnalysis, z.ZodTypeDef, _embedpdf_engine_core_runtime.ChangeAnalysis>;
7770
+ };
7771
+ readonly 400: {
7772
+ readonly contentType: "application/json";
7773
+ readonly schema: z.ZodType<_embedpdf_engine_core_runtime.SerializedEngineError, z.ZodTypeDef, _embedpdf_engine_core_runtime.SerializedEngineError>;
7774
+ };
7775
+ readonly 404: {
7776
+ readonly contentType: "application/json";
7777
+ readonly schema: z.ZodType<_embedpdf_engine_core_runtime.SerializedEngineError, z.ZodTypeDef, _embedpdf_engine_core_runtime.SerializedEngineError>;
7778
+ };
7779
+ };
7780
+ readonly notes: string;
7781
+ };
7782
+ readonly 'doc.signatures.prepare': {
7783
+ readonly operationId: "doc.signatures.prepare";
7784
+ readonly title: "Prepare a signature";
7785
+ readonly summary: "Author and seal a signing candidate; returns the digest to sign and the version fences.";
7786
+ readonly method: "POST";
7787
+ readonly path: "/v1/docs/:docId/layers/:layerName/signatures/prepare";
7788
+ readonly credentials: readonly ["api-token", "doc-jwt"];
7789
+ readonly scope: readonly [];
7790
+ readonly docCapabilities: readonly ["doc.sign"];
7791
+ readonly requestHeaders: readonly [AdminOperationHeader];
7792
+ readonly params: z.ZodObject<{
7793
+ docId: z.ZodString;
7794
+ } & {
7795
+ layerName: z.ZodString;
7796
+ }, "strip", z.ZodTypeAny, {
7797
+ docId: string;
7798
+ layerName: string;
7799
+ }, {
7800
+ docId: string;
7801
+ layerName: string;
7802
+ }>;
7803
+ readonly body: {
7804
+ readonly contentType: "multipart/form-data";
7805
+ };
7806
+ readonly responses: {
7807
+ readonly 200: {
7808
+ readonly contentType: "application/json";
7809
+ readonly schema: z.ZodObject<{
7810
+ signingId: z.ZodString;
7811
+ digest: z.ZodString;
7812
+ algorithm: z.ZodEnum<["sha256", "sha384", "sha512"]>;
7813
+ byteRange: z.ZodTuple<[z.ZodNumber, z.ZodNumber, z.ZodNumber, z.ZodNumber], null>;
7814
+ contentsSize: z.ZodNumber;
7815
+ subFilter: z.ZodString;
7816
+ expectedVersion: z.ZodType<_embedpdf_engine_core_runtime.DocumentVersionRef, z.ZodTypeDef, _embedpdf_engine_core_runtime.DocumentVersionRef>;
7817
+ expiresAt: z.ZodNullable<z.ZodString>;
7818
+ }, "strip", z.ZodTypeAny, {
7819
+ expiresAt: string | null;
7820
+ signingId: string;
7821
+ digest: string;
7822
+ algorithm: "sha256" | "sha384" | "sha512";
7823
+ byteRange: [number, number, number, number];
7824
+ contentsSize: number;
7825
+ subFilter: string;
7826
+ expectedVersion: _embedpdf_engine_core_runtime.DocumentVersionRef;
7827
+ }, {
7828
+ expiresAt: string | null;
7829
+ signingId: string;
7830
+ digest: string;
7831
+ algorithm: "sha256" | "sha384" | "sha512";
7832
+ byteRange: [number, number, number, number];
7833
+ contentsSize: number;
7834
+ subFilter: string;
7835
+ expectedVersion: _embedpdf_engine_core_runtime.DocumentVersionRef;
7836
+ }>;
7837
+ };
7838
+ readonly 400: {
7839
+ readonly contentType: "application/json";
7840
+ readonly schema: z.ZodType<_embedpdf_engine_core_runtime.SerializedEngineError, z.ZodTypeDef, _embedpdf_engine_core_runtime.SerializedEngineError>;
7841
+ };
7842
+ readonly 404: {
7843
+ readonly contentType: "application/json";
7844
+ readonly schema: z.ZodType<_embedpdf_engine_core_runtime.SerializedEngineError, z.ZodTypeDef, _embedpdf_engine_core_runtime.SerializedEngineError>;
7845
+ };
7846
+ readonly 409: {
7847
+ readonly contentType: "application/json";
7848
+ readonly schema: z.ZodType<_embedpdf_engine_core_runtime.SerializedEngineError, z.ZodTypeDef, _embedpdf_engine_core_runtime.SerializedEngineError>;
7849
+ };
7850
+ };
7851
+ readonly notes: string;
7852
+ };
7853
+ readonly 'doc.signatures.complete': {
7854
+ readonly operationId: "doc.signatures.complete";
7855
+ readonly title: "Complete a signature";
7856
+ readonly summary: "Install the CMS into the prepared candidate and publish the sealed bytes as the document's next base version.";
7857
+ readonly method: "POST";
7858
+ readonly path: "/v1/docs/:docId/layers/:layerName/signatures/:signingId/complete";
7859
+ readonly credentials: readonly ["api-token", "doc-jwt"];
7860
+ readonly scope: readonly [];
7861
+ readonly docCapabilities: readonly ["doc.sign"];
7862
+ readonly requestHeaders: readonly [AdminOperationHeader];
7863
+ readonly params: z.ZodObject<{
7864
+ docId: z.ZodString;
7865
+ } & {
7866
+ layerName: z.ZodString;
7867
+ } & {
7868
+ signingId: z.ZodString;
7869
+ }, "strip", z.ZodTypeAny, {
7870
+ docId: string;
7871
+ layerName: string;
7872
+ signingId: string;
7873
+ }, {
7874
+ docId: string;
7875
+ layerName: string;
7876
+ signingId: string;
7877
+ }>;
7878
+ readonly body: {
7879
+ readonly contentType: "application/json";
7880
+ readonly schema: z.ZodObject<{
7881
+ cms: z.ZodEffects<z.ZodString, string, string>;
7882
+ expectedVersion: z.ZodType<_embedpdf_engine_core_runtime.DocumentVersionRef, z.ZodTypeDef, _embedpdf_engine_core_runtime.DocumentVersionRef>;
7883
+ }, "strip", z.ZodTypeAny, {
7884
+ expectedVersion: _embedpdf_engine_core_runtime.DocumentVersionRef;
7885
+ cms: string;
7886
+ }, {
7887
+ expectedVersion: _embedpdf_engine_core_runtime.DocumentVersionRef;
7888
+ cms: string;
7889
+ }>;
7890
+ };
7891
+ readonly responses: {
7892
+ readonly 200: {
7893
+ readonly contentType: "application/json";
7894
+ readonly schema: z.ZodType<_embedpdf_engine_core_runtime.SignatureCompleteResult, z.ZodTypeDef, _embedpdf_engine_core_runtime.SignatureCompleteResult>;
7895
+ };
7896
+ readonly 400: {
7897
+ readonly contentType: "application/json";
7898
+ readonly schema: z.ZodType<_embedpdf_engine_core_runtime.SerializedEngineError, z.ZodTypeDef, _embedpdf_engine_core_runtime.SerializedEngineError>;
7899
+ };
7900
+ readonly 404: {
7901
+ readonly contentType: "application/json";
7902
+ readonly schema: z.ZodType<_embedpdf_engine_core_runtime.SerializedEngineError, z.ZodTypeDef, _embedpdf_engine_core_runtime.SerializedEngineError>;
7903
+ };
7904
+ readonly 409: {
7905
+ readonly contentType: "application/json";
7906
+ readonly schema: z.ZodType<_embedpdf_engine_core_runtime.SerializedEngineError, z.ZodTypeDef, _embedpdf_engine_core_runtime.SerializedEngineError>;
7907
+ };
7908
+ };
7909
+ readonly notes: string;
7910
+ };
7911
+ readonly 'doc.signatures.abort': {
7912
+ readonly operationId: "doc.signatures.abort";
7913
+ readonly title: "Abort a signature";
7914
+ readonly summary: "Discard a pending signing candidate.";
7915
+ readonly method: "DELETE";
7916
+ readonly path: "/v1/docs/:docId/layers/:layerName/signatures/:signingId";
7917
+ readonly credentials: readonly ["api-token", "doc-jwt"];
7918
+ readonly scope: readonly [];
7919
+ readonly docCapabilities: readonly ["doc.sign"];
7920
+ readonly requestHeaders: readonly [AdminOperationHeader];
7921
+ readonly params: z.ZodObject<{
7922
+ docId: z.ZodString;
7923
+ } & {
7924
+ layerName: z.ZodString;
7925
+ } & {
7926
+ signingId: z.ZodString;
7927
+ }, "strip", z.ZodTypeAny, {
7928
+ docId: string;
7929
+ layerName: string;
7930
+ signingId: string;
7931
+ }, {
7932
+ docId: string;
7933
+ layerName: string;
7934
+ signingId: string;
7935
+ }>;
7936
+ readonly responses: {
7937
+ readonly 200: {
7938
+ readonly contentType: "application/json";
7939
+ readonly schema: z.ZodType<_embedpdf_engine_core_runtime.SignatureAbortResult, z.ZodTypeDef, _embedpdf_engine_core_runtime.SignatureAbortResult>;
7940
+ };
7941
+ readonly 404: {
7942
+ readonly contentType: "application/json";
7943
+ readonly schema: z.ZodType<_embedpdf_engine_core_runtime.SerializedEngineError, z.ZodTypeDef, _embedpdf_engine_core_runtime.SerializedEngineError>;
7944
+ };
7945
+ };
7946
+ };
7947
+ readonly 'doc.versions.list': {
7948
+ readonly operationId: "doc.versions.list";
7949
+ readonly title: "List versions";
7950
+ readonly summary: "The document's base versions, oldest first, and its head.";
7951
+ readonly method: "GET";
7952
+ readonly path: "/v1/docs/:docId/versions";
7953
+ readonly credentials: readonly ["api-token", "doc-jwt"];
7954
+ readonly scope: readonly [];
7955
+ readonly docCapabilities: readonly ["doc.open"];
7956
+ readonly requestHeaders: readonly [AdminOperationHeader];
7957
+ readonly params: z.ZodObject<{
7958
+ docId: z.ZodString;
7959
+ }, "strip", z.ZodTypeAny, {
7960
+ docId: string;
7961
+ }, {
7962
+ docId: string;
7963
+ }>;
7964
+ readonly responses: {
7965
+ readonly 200: {
7966
+ readonly contentType: "application/json";
7967
+ readonly schema: z.ZodObject<{
7968
+ head: z.ZodString;
7969
+ versions: z.ZodArray<z.ZodObject<{
7970
+ sha256: z.ZodString;
7971
+ byteLength: z.ZodNumber;
7972
+ number: z.ZodNumber;
7973
+ parentSha256: z.ZodNullable<z.ZodString>;
7974
+ producer: z.ZodEnum<["upload", "signature"]>;
7975
+ signingId: z.ZodNullable<z.ZodString>;
7976
+ createdAt: z.ZodNumber;
7977
+ }, "strip", z.ZodTypeAny, {
7978
+ number: number;
7979
+ signingId: string | null;
7980
+ sha256: string;
7981
+ byteLength: number;
7982
+ parentSha256: string | null;
7983
+ producer: "signature" | "upload";
7984
+ createdAt: number;
6723
7985
  }, {
6724
- required: boolean;
6725
- reasons: ("password" | "cdn" | "permissions-unknown")[];
6726
- endpoint?: string | undefined;
6727
- }>;
7986
+ number: number;
7987
+ signingId: string | null;
7988
+ sha256: string;
7989
+ byteLength: number;
7990
+ parentSha256: string | null;
7991
+ producer: "signature" | "upload";
7992
+ createdAt: number;
7993
+ }>, "many">;
6728
7994
  }, "strip", z.ZodTypeAny, {
6729
- id: string;
6730
- baseSha: string;
6731
- storageSizeBytes: number;
6732
- docVersion: number;
6733
- state: "pending" | "ready" | "failed" | "deleting";
6734
- encryption: {
6735
- state: "unknown" | "none" | "encrypted" | "unsupported";
6736
- requiresPassword: boolean | null;
6737
- };
6738
- permissions: {
6739
- known: boolean;
6740
- bits: number | null;
6741
- allAllowed: boolean | null;
6742
- openedAs: "none" | "user" | "owner" | null;
6743
- securityHandlerRevision: number | null;
6744
- canUpgradeToOwner: boolean;
6745
- };
6746
- access: {
6747
- required: boolean;
6748
- reasons: ("password" | "cdn" | "permissions-unknown")[];
6749
- endpoint?: string | undefined;
6750
- };
7995
+ head: string;
7996
+ versions: {
7997
+ number: number;
7998
+ signingId: string | null;
7999
+ sha256: string;
8000
+ byteLength: number;
8001
+ parentSha256: string | null;
8002
+ producer: "signature" | "upload";
8003
+ createdAt: number;
8004
+ }[];
6751
8005
  }, {
6752
- id: string;
6753
- baseSha: string;
6754
- storageSizeBytes: number;
6755
- docVersion: number;
6756
- state: "pending" | "ready" | "failed" | "deleting";
6757
- encryption: {
6758
- state: "unknown" | "none" | "encrypted" | "unsupported";
6759
- requiresPassword: boolean | null;
6760
- };
6761
- permissions: {
6762
- known: boolean;
6763
- bits: number | null;
6764
- allAllowed: boolean | null;
6765
- openedAs: "none" | "user" | "owner" | null;
6766
- securityHandlerRevision: number | null;
6767
- canUpgradeToOwner: boolean;
6768
- };
6769
- access: {
6770
- required: boolean;
6771
- reasons: ("password" | "cdn" | "permissions-unknown")[];
6772
- endpoint?: string | undefined;
6773
- };
8006
+ head: string;
8007
+ versions: {
8008
+ number: number;
8009
+ signingId: string | null;
8010
+ sha256: string;
8011
+ byteLength: number;
8012
+ parentSha256: string | null;
8013
+ producer: "signature" | "upload";
8014
+ createdAt: number;
8015
+ }[];
6774
8016
  }>;
6775
8017
  };
6776
8018
  readonly 404: {
@@ -6778,64 +8020,233 @@ declare const allOperations: {
6778
8020
  readonly schema: z.ZodType<_embedpdf_engine_core_runtime.SerializedEngineError, z.ZodTypeDef, _embedpdf_engine_core_runtime.SerializedEngineError>;
6779
8021
  };
6780
8022
  };
8023
+ readonly notes: "Every completed signature publishes a new version. Never cached: the list grows.";
8024
+ };
8025
+ readonly 'doc.versions.signatures': {
8026
+ readonly operationId: "doc.versions.signatures";
8027
+ readonly title: "Version signatures";
8028
+ readonly summary: "The signature snapshot of one base version (immutable).";
8029
+ readonly method: "GET";
8030
+ readonly path: "/v1/docs/:docId/versions/signatures/:sha";
8031
+ readonly credentials: readonly ["api-token", "doc-jwt"];
8032
+ readonly scope: readonly [];
8033
+ readonly docCapabilities: readonly ["doc.forms.read"];
8034
+ readonly requestHeaders: readonly [AdminOperationHeader];
8035
+ readonly params: z.ZodObject<{
8036
+ docId: z.ZodString;
8037
+ } & {
8038
+ sha: z.ZodString;
8039
+ }, "strip", z.ZodTypeAny, {
8040
+ docId: string;
8041
+ sha: string;
8042
+ }, {
8043
+ docId: string;
8044
+ sha: string;
8045
+ }>;
8046
+ readonly responses: {
8047
+ readonly 200: {
8048
+ readonly contentType: "application/json";
8049
+ readonly schema: z.ZodType<_embedpdf_engine_core_runtime.SignatureSnapshot, z.ZodTypeDef, _embedpdf_engine_core_runtime.SignatureSnapshot>;
8050
+ };
8051
+ readonly 404: {
8052
+ readonly contentType: "application/json";
8053
+ readonly schema: z.ZodType<_embedpdf_engine_core_runtime.SerializedEngineError, z.ZodTypeDef, _embedpdf_engine_core_runtime.SerializedEngineError>;
8054
+ };
8055
+ };
8056
+ };
8057
+ readonly 'doc.versions.signatureContents': {
8058
+ readonly operationId: "doc.versions.signatureContents";
8059
+ readonly title: "Signature contents";
8060
+ readonly summary: "The DER /Contents of a signed field in one base version (immutable).";
8061
+ readonly method: "GET";
8062
+ readonly path: "/v1/docs/:docId/versions/signatures/:sha/:fieldKey/contents";
8063
+ readonly credentials: readonly ["api-token", "doc-jwt"];
8064
+ readonly scope: readonly [];
8065
+ readonly docCapabilities: readonly ["doc.forms.read"];
8066
+ readonly requestHeaders: readonly [AdminOperationHeader];
8067
+ readonly params: z.ZodObject<{
8068
+ docId: z.ZodString;
8069
+ } & {
8070
+ sha: z.ZodString;
8071
+ } & {
8072
+ fieldKey: z.ZodString;
8073
+ }, "strip", z.ZodTypeAny, {
8074
+ docId: string;
8075
+ fieldKey: string;
8076
+ sha: string;
8077
+ }, {
8078
+ docId: string;
8079
+ fieldKey: string;
8080
+ sha: string;
8081
+ }>;
8082
+ readonly responses: {
8083
+ readonly 200: {
8084
+ readonly contentType: "application/pkcs7-signature";
8085
+ };
8086
+ readonly 404: {
8087
+ readonly contentType: "application/json";
8088
+ readonly schema: z.ZodType<_embedpdf_engine_core_runtime.SerializedEngineError, z.ZodTypeDef, _embedpdf_engine_core_runtime.SerializedEngineError>;
8089
+ };
8090
+ };
8091
+ readonly notes: "`fieldKey` is the field's fully qualified name, token-text encoded (the same encoding attachment keys use).";
6781
8092
  };
6782
- readonly 'doc.manifest': {
6783
- readonly operationId: "doc.manifest";
6784
- readonly title: "Get manifest";
6785
- readonly summary: "Full layer manifest at the layer's current version.";
8093
+ readonly 'doc.versions.signatureDigest': {
8094
+ readonly operationId: "doc.versions.signatureDigest";
8095
+ readonly title: "Signature digest";
8096
+ readonly summary: "The digest of a signed field's /ByteRange in one base version (immutable).";
6786
8097
  readonly method: "GET";
6787
- readonly path: "/v1/docs/:docId/layers/:layerName/manifest";
8098
+ readonly path: "/v1/docs/:docId/versions/signatures/:sha/:fieldKey/digest/:algorithm";
6788
8099
  readonly credentials: readonly ["api-token", "doc-jwt"];
6789
8100
  readonly scope: readonly [];
6790
- readonly docCapabilities: readonly ["doc.open"];
8101
+ readonly docCapabilities: readonly ["doc.forms.read"];
6791
8102
  readonly requestHeaders: readonly [AdminOperationHeader];
6792
8103
  readonly params: z.ZodObject<{
6793
8104
  docId: z.ZodString;
6794
8105
  } & {
6795
- layerName: z.ZodString;
8106
+ sha: z.ZodString;
8107
+ } & {
8108
+ fieldKey: z.ZodString;
8109
+ } & {
8110
+ algorithm: z.ZodEnum<["sha1", "sha256", "sha384", "sha512"]>;
6796
8111
  }, "strip", z.ZodTypeAny, {
6797
8112
  docId: string;
6798
- layerName: string;
8113
+ fieldKey: string;
8114
+ sha: string;
8115
+ algorithm: "sha256" | "sha1" | "sha384" | "sha512";
6799
8116
  }, {
6800
8117
  docId: string;
6801
- layerName: string;
8118
+ fieldKey: string;
8119
+ sha: string;
8120
+ algorithm: "sha256" | "sha1" | "sha384" | "sha512";
6802
8121
  }>;
6803
8122
  readonly responses: {
6804
8123
  readonly 200: {
8124
+ readonly contentType: "application/octet-stream";
8125
+ };
8126
+ readonly 404: {
6805
8127
  readonly contentType: "application/json";
6806
- readonly schema: z.ZodType<_embedpdf_engine_core_runtime.DocumentManifest, z.ZodTypeDef, _embedpdf_engine_core_runtime.DocumentManifest>;
8128
+ readonly schema: z.ZodType<_embedpdf_engine_core_runtime.SerializedEngineError, z.ZodTypeDef, _embedpdf_engine_core_runtime.SerializedEngineError>;
8129
+ };
8130
+ };
8131
+ readonly notes: "What a CMS verifier compares its message digest to.";
8132
+ };
8133
+ readonly 'doc.versions.analysis': {
8134
+ readonly operationId: "doc.versions.analysis";
8135
+ readonly title: "Analyze version history";
8136
+ readonly summary: "What changed between two revisions of one base version (immutable).";
8137
+ readonly method: "GET";
8138
+ readonly path: "/v1/docs/:docId/versions/analysis/:sha";
8139
+ readonly credentials: readonly ["api-token", "doc-jwt"];
8140
+ readonly scope: readonly [];
8141
+ readonly docCapabilities: readonly ["doc.forms.read"];
8142
+ readonly requestHeaders: readonly [AdminOperationHeader];
8143
+ readonly params: z.ZodObject<{
8144
+ docId: z.ZodString;
8145
+ } & {
8146
+ sha: z.ZodString;
8147
+ }, "strip", z.ZodTypeAny, {
8148
+ docId: string;
8149
+ sha: string;
8150
+ }, {
8151
+ docId: string;
8152
+ sha: string;
8153
+ }>;
8154
+ readonly query: z.ZodObject<{
8155
+ 'since.signature': z.ZodOptional<z.ZodNumber>;
8156
+ 'since.revision': z.ZodOptional<z.ZodNumber>;
8157
+ level: z.ZodOptional<z.ZodEnum<["none", "lta", "fill", "annotate"]>>;
8158
+ } & {
8159
+ until: z.ZodOptional<z.ZodNumber>;
8160
+ /** The judging policy version the caller expects — a cache key on this immutable URL, not an input. */
8161
+ policy: z.ZodOptional<z.ZodNumber>;
8162
+ }, "strip", z.ZodTypeAny, {
8163
+ 'since.signature'?: number | undefined;
8164
+ 'since.revision'?: number | undefined;
8165
+ level?: "fill" | "none" | "lta" | "annotate" | undefined;
8166
+ until?: number | undefined;
8167
+ policy?: number | undefined;
8168
+ }, {
8169
+ 'since.signature'?: number | undefined;
8170
+ 'since.revision'?: number | undefined;
8171
+ level?: "fill" | "none" | "lta" | "annotate" | undefined;
8172
+ until?: number | undefined;
8173
+ policy?: number | undefined;
8174
+ }>;
8175
+ readonly responses: {
8176
+ readonly 200: {
8177
+ readonly contentType: "application/json";
8178
+ readonly schema: z.ZodType<_embedpdf_engine_core_runtime.ChangeAnalysis, z.ZodTypeDef, _embedpdf_engine_core_runtime.ChangeAnalysis>;
8179
+ };
8180
+ readonly 400: {
8181
+ readonly contentType: "application/json";
8182
+ readonly schema: z.ZodType<_embedpdf_engine_core_runtime.SerializedEngineError, z.ZodTypeDef, _embedpdf_engine_core_runtime.SerializedEngineError>;
6807
8183
  };
6808
8184
  readonly 404: {
6809
8185
  readonly contentType: "application/json";
6810
8186
  readonly schema: z.ZodType<_embedpdf_engine_core_runtime.SerializedEngineError, z.ZodTypeDef, _embedpdf_engine_core_runtime.SerializedEngineError>;
6811
8187
  };
6812
8188
  };
8189
+ readonly notes: string;
6813
8190
  };
6814
- readonly 'doc.metadata.get': {
6815
- readonly operationId: "doc.metadata.get";
6816
- readonly title: "Get metadata";
6817
- readonly summary: "Document metadata (PDF info dictionary view) for a layer.";
8191
+ readonly 'doc.versions.download': {
8192
+ readonly operationId: "doc.versions.download";
8193
+ readonly title: "Download a version";
8194
+ readonly summary: "The bytes of one base version (immutable).";
6818
8195
  readonly method: "GET";
6819
- readonly path: "/v1/docs/:docId/layers/:layerName/metadata";
8196
+ readonly path: "/v1/docs/:docId/versions/download/:sha";
6820
8197
  readonly credentials: readonly ["api-token", "doc-jwt"];
6821
8198
  readonly scope: readonly [];
6822
- readonly docCapabilities: readonly ["doc.open"];
8199
+ readonly docCapabilities: readonly ["doc.download"];
6823
8200
  readonly requestHeaders: readonly [AdminOperationHeader];
6824
8201
  readonly params: z.ZodObject<{
6825
8202
  docId: z.ZodString;
6826
8203
  } & {
6827
- layerName: z.ZodString;
8204
+ sha: z.ZodString;
6828
8205
  }, "strip", z.ZodTypeAny, {
6829
8206
  docId: string;
6830
- layerName: string;
8207
+ sha: string;
6831
8208
  }, {
6832
8209
  docId: string;
6833
- layerName: string;
8210
+ sha: string;
6834
8211
  }>;
6835
8212
  readonly responses: {
6836
8213
  readonly 200: {
8214
+ readonly contentType: "application/pdf";
8215
+ };
8216
+ readonly 404: {
6837
8217
  readonly contentType: "application/json";
6838
- readonly schema: z.ZodType<_embedpdf_engine_core_runtime.DocumentMetadata, z.ZodTypeDef, _embedpdf_engine_core_runtime.DocumentMetadata>;
8218
+ readonly schema: z.ZodType<_embedpdf_engine_core_runtime.SerializedEngineError, z.ZodTypeDef, _embedpdf_engine_core_runtime.SerializedEngineError>;
8219
+ };
8220
+ };
8221
+ };
8222
+ readonly 'doc.versions.revision': {
8223
+ readonly operationId: "doc.versions.revision";
8224
+ readonly title: "Download a revision";
8225
+ readonly summary: "The byte prefix of one revision of a base version: exactly what a signature over it signed (immutable).";
8226
+ readonly method: "GET";
8227
+ readonly path: "/v1/docs/:docId/versions/revisions/:sha/:index";
8228
+ readonly credentials: readonly ["api-token", "doc-jwt"];
8229
+ readonly scope: readonly [];
8230
+ readonly docCapabilities: readonly ["doc.download"];
8231
+ readonly requestHeaders: readonly [AdminOperationHeader];
8232
+ readonly params: z.ZodObject<{
8233
+ docId: z.ZodString;
8234
+ } & {
8235
+ sha: z.ZodString;
8236
+ } & {
8237
+ index: z.ZodNumber;
8238
+ }, "strip", z.ZodTypeAny, {
8239
+ docId: string;
8240
+ sha: string;
8241
+ index: number;
8242
+ }, {
8243
+ docId: string;
8244
+ sha: string;
8245
+ index: number;
8246
+ }>;
8247
+ readonly responses: {
8248
+ readonly 200: {
8249
+ readonly contentType: "application/pdf";
6839
8250
  };
6840
8251
  readonly 404: {
6841
8252
  readonly contentType: "application/json";
@@ -7139,6 +8550,99 @@ declare const allOperations: {
7139
8550
  };
7140
8551
  };
7141
8552
  };
8553
+ readonly 'doc.annotations.flatten': {
8554
+ readonly operationId: "doc.annotations.flatten";
8555
+ readonly title: "Flatten annotations";
8556
+ readonly summary: "Flatten a chosen set of one page's annotations into its content — pages.flatten for a selection. Painted annotations are removed; ineligible ones report skipped.";
8557
+ readonly method: "POST";
8558
+ readonly path: "/v1/docs/:docId/layers/:layerName/annotations/pages/:pon/items/flatten";
8559
+ readonly credentials: readonly ["api-token", "doc-jwt"];
8560
+ readonly scope: readonly [];
8561
+ readonly docCapabilities: readonly ["doc.pages.modify", "doc.annotate.modify"];
8562
+ readonly requestHeaders: readonly [AdminOperationHeader];
8563
+ readonly params: z.ZodObject<{
8564
+ docId: z.ZodString;
8565
+ } & {
8566
+ layerName: z.ZodString;
8567
+ } & {
8568
+ pon: z.ZodNumber;
8569
+ }, "strip", z.ZodTypeAny, {
8570
+ docId: string;
8571
+ layerName: string;
8572
+ pon: number;
8573
+ }, {
8574
+ docId: string;
8575
+ layerName: string;
8576
+ pon: number;
8577
+ }>;
8578
+ readonly body: {
8579
+ readonly contentType: "application/json";
8580
+ readonly schema: z.ZodRecord<z.ZodString, z.ZodUnknown>;
8581
+ };
8582
+ readonly responses: {
8583
+ readonly 200: {
8584
+ readonly contentType: "application/json";
8585
+ readonly schema: z.ZodObject<{
8586
+ meta: z.ZodType<_embedpdf_engine_core_runtime.MutationMeta, z.ZodTypeDef, _embedpdf_engine_core_runtime.MutationMeta>;
8587
+ }, "passthrough", z.ZodTypeAny, z.objectOutputType<{
8588
+ meta: z.ZodType<_embedpdf_engine_core_runtime.MutationMeta, z.ZodTypeDef, _embedpdf_engine_core_runtime.MutationMeta>;
8589
+ }, z.ZodTypeAny, "passthrough">, z.objectInputType<{
8590
+ meta: z.ZodType<_embedpdf_engine_core_runtime.MutationMeta, z.ZodTypeDef, _embedpdf_engine_core_runtime.MutationMeta>;
8591
+ }, z.ZodTypeAny, "passthrough">>;
8592
+ };
8593
+ readonly 400: {
8594
+ readonly contentType: "application/json";
8595
+ readonly schema: z.ZodType<_embedpdf_engine_core_runtime.SerializedEngineError, z.ZodTypeDef, _embedpdf_engine_core_runtime.SerializedEngineError>;
8596
+ };
8597
+ readonly 404: {
8598
+ readonly contentType: "application/json";
8599
+ readonly schema: z.ZodType<_embedpdf_engine_core_runtime.SerializedEngineError, z.ZodTypeDef, _embedpdf_engine_core_runtime.SerializedEngineError>;
8600
+ };
8601
+ };
8602
+ };
8603
+ readonly 'doc.annotations.exportAppearance': {
8604
+ readonly operationId: "doc.annotations.exportAppearance";
8605
+ readonly title: "Export annotation appearances";
8606
+ readonly summary: "The chosen annotations' appearances as one single-page PDF sized to their union rect — vector, positions preserved. A read; the source is untouched.";
8607
+ readonly method: "POST";
8608
+ readonly path: "/v1/docs/:docId/layers/:layerName/annotations/pages/:pon/items/appearance";
8609
+ readonly credentials: readonly ["api-token", "doc-jwt"];
8610
+ readonly scope: readonly [];
8611
+ readonly docCapabilities: readonly ["doc.download"];
8612
+ readonly requestHeaders: readonly [AdminOperationHeader];
8613
+ readonly params: z.ZodObject<{
8614
+ docId: z.ZodString;
8615
+ } & {
8616
+ layerName: z.ZodString;
8617
+ } & {
8618
+ pon: z.ZodNumber;
8619
+ }, "strip", z.ZodTypeAny, {
8620
+ docId: string;
8621
+ layerName: string;
8622
+ pon: number;
8623
+ }, {
8624
+ docId: string;
8625
+ layerName: string;
8626
+ pon: number;
8627
+ }>;
8628
+ readonly body: {
8629
+ readonly contentType: "application/json";
8630
+ readonly schema: z.ZodRecord<z.ZodString, z.ZodUnknown>;
8631
+ };
8632
+ readonly responses: {
8633
+ readonly 200: {
8634
+ readonly contentType: "application/pdf";
8635
+ };
8636
+ readonly 400: {
8637
+ readonly contentType: "application/json";
8638
+ readonly schema: z.ZodType<_embedpdf_engine_core_runtime.SerializedEngineError, z.ZodTypeDef, _embedpdf_engine_core_runtime.SerializedEngineError>;
8639
+ };
8640
+ readonly 404: {
8641
+ readonly contentType: "application/json";
8642
+ readonly schema: z.ZodType<_embedpdf_engine_core_runtime.SerializedEngineError, z.ZodTypeDef, _embedpdf_engine_core_runtime.SerializedEngineError>;
8643
+ };
8644
+ };
8645
+ };
7142
8646
  readonly 'doc.forms.get': {
7143
8647
  readonly operationId: "doc.forms.get";
7144
8648
  readonly title: "Get form snapshot";
@@ -7485,6 +8989,98 @@ declare const allOperations: {
7485
8989
  };
7486
8990
  };
7487
8991
  };
8992
+ readonly 'doc.pages.setName': {
8993
+ readonly operationId: "doc.pages.setName";
8994
+ readonly title: "Set page name";
8995
+ readonly summary: "Register or rename a /Names /Pages entry (a named page). A page-structure mutation: the layout version advances.";
8996
+ readonly method: "POST";
8997
+ readonly path: "/v1/docs/:docId/layers/:layerName/pages/names";
8998
+ readonly credentials: readonly ["api-token", "doc-jwt"];
8999
+ readonly scope: readonly [];
9000
+ readonly docCapabilities: readonly ["doc.pages.assemble"];
9001
+ readonly requestHeaders: readonly [AdminOperationHeader];
9002
+ readonly params: z.ZodObject<{
9003
+ docId: z.ZodString;
9004
+ } & {
9005
+ layerName: z.ZodString;
9006
+ }, "strip", z.ZodTypeAny, {
9007
+ docId: string;
9008
+ layerName: string;
9009
+ }, {
9010
+ docId: string;
9011
+ layerName: string;
9012
+ }>;
9013
+ readonly body: {
9014
+ readonly contentType: "application/json";
9015
+ readonly schema: z.ZodRecord<z.ZodString, z.ZodUnknown>;
9016
+ };
9017
+ readonly responses: {
9018
+ readonly 200: {
9019
+ readonly contentType: "application/json";
9020
+ readonly schema: z.ZodObject<{
9021
+ meta: z.ZodType<_embedpdf_engine_core_runtime.MutationMeta, z.ZodTypeDef, _embedpdf_engine_core_runtime.MutationMeta>;
9022
+ }, "passthrough", z.ZodTypeAny, z.objectOutputType<{
9023
+ meta: z.ZodType<_embedpdf_engine_core_runtime.MutationMeta, z.ZodTypeDef, _embedpdf_engine_core_runtime.MutationMeta>;
9024
+ }, z.ZodTypeAny, "passthrough">, z.objectInputType<{
9025
+ meta: z.ZodType<_embedpdf_engine_core_runtime.MutationMeta, z.ZodTypeDef, _embedpdf_engine_core_runtime.MutationMeta>;
9026
+ }, z.ZodTypeAny, "passthrough">>;
9027
+ };
9028
+ readonly 400: {
9029
+ readonly contentType: "application/json";
9030
+ readonly schema: z.ZodType<_embedpdf_engine_core_runtime.SerializedEngineError, z.ZodTypeDef, _embedpdf_engine_core_runtime.SerializedEngineError>;
9031
+ };
9032
+ readonly 404: {
9033
+ readonly contentType: "application/json";
9034
+ readonly schema: z.ZodType<_embedpdf_engine_core_runtime.SerializedEngineError, z.ZodTypeDef, _embedpdf_engine_core_runtime.SerializedEngineError>;
9035
+ };
9036
+ };
9037
+ };
9038
+ readonly 'doc.pages.removeName': {
9039
+ readonly operationId: "doc.pages.removeName";
9040
+ readonly title: "Remove page name";
9041
+ readonly summary: "Remove a /Names /Pages entry; the page itself stays.";
9042
+ readonly method: "POST";
9043
+ readonly path: "/v1/docs/:docId/layers/:layerName/pages/names/delete";
9044
+ readonly credentials: readonly ["api-token", "doc-jwt"];
9045
+ readonly scope: readonly [];
9046
+ readonly docCapabilities: readonly ["doc.pages.assemble"];
9047
+ readonly requestHeaders: readonly [AdminOperationHeader];
9048
+ readonly params: z.ZodObject<{
9049
+ docId: z.ZodString;
9050
+ } & {
9051
+ layerName: z.ZodString;
9052
+ }, "strip", z.ZodTypeAny, {
9053
+ docId: string;
9054
+ layerName: string;
9055
+ }, {
9056
+ docId: string;
9057
+ layerName: string;
9058
+ }>;
9059
+ readonly body: {
9060
+ readonly contentType: "application/json";
9061
+ readonly schema: z.ZodRecord<z.ZodString, z.ZodUnknown>;
9062
+ };
9063
+ readonly responses: {
9064
+ readonly 200: {
9065
+ readonly contentType: "application/json";
9066
+ readonly schema: z.ZodObject<{
9067
+ meta: z.ZodType<_embedpdf_engine_core_runtime.MutationMeta, z.ZodTypeDef, _embedpdf_engine_core_runtime.MutationMeta>;
9068
+ }, "passthrough", z.ZodTypeAny, z.objectOutputType<{
9069
+ meta: z.ZodType<_embedpdf_engine_core_runtime.MutationMeta, z.ZodTypeDef, _embedpdf_engine_core_runtime.MutationMeta>;
9070
+ }, z.ZodTypeAny, "passthrough">, z.objectInputType<{
9071
+ meta: z.ZodType<_embedpdf_engine_core_runtime.MutationMeta, z.ZodTypeDef, _embedpdf_engine_core_runtime.MutationMeta>;
9072
+ }, z.ZodTypeAny, "passthrough">>;
9073
+ };
9074
+ readonly 400: {
9075
+ readonly contentType: "application/json";
9076
+ readonly schema: z.ZodType<_embedpdf_engine_core_runtime.SerializedEngineError, z.ZodTypeDef, _embedpdf_engine_core_runtime.SerializedEngineError>;
9077
+ };
9078
+ readonly 404: {
9079
+ readonly contentType: "application/json";
9080
+ readonly schema: z.ZodType<_embedpdf_engine_core_runtime.SerializedEngineError, z.ZodTypeDef, _embedpdf_engine_core_runtime.SerializedEngineError>;
9081
+ };
9082
+ };
9083
+ };
7488
9084
  readonly 'doc.pages.flatten': {
7489
9085
  readonly operationId: "doc.pages.flatten";
7490
9086
  readonly title: "Flatten pages";
@@ -11156,6 +12752,12 @@ declare const docsGroups: {
11156
12752
  readonly 'doc.redactions': {
11157
12753
  readonly title: "Redactions";
11158
12754
  };
12755
+ readonly 'doc.signatures': {
12756
+ readonly title: "Digital signatures";
12757
+ };
12758
+ readonly 'doc.versions': {
12759
+ readonly title: "Versions";
12760
+ };
11159
12761
  };
11160
12762
 
11161
- export { ADMIN_DOCUMENT_LIST_DEFAULT_LIMIT, ADMIN_DOCUMENT_LIST_MAX_LIMIT, type AdminCredential, type AdminDocumentCommitRequest, AdminDocumentCommitRequestSchema, type AdminDocumentCommitResponse, AdminDocumentCommitResponseSchema, type AdminDocumentImportRequest, AdminDocumentImportRequestSchema, type AdminDocumentImportResponse, AdminDocumentImportResponseSchema, type AdminDocumentInitRequest, AdminDocumentInitRequestSchema, type AdminDocumentInitResponse, AdminDocumentInitResponseSchema, type AdminDocumentListQuery, AdminDocumentListQuerySchema, type AdminDocumentListResponse, AdminDocumentListResponseSchema, type AdminDocumentRecord, AdminDocumentRecordSchema, type AdminDocumentResponse, AdminDocumentResponseSchema, type AdminErrorPayload, AdminErrorPayloadSchema, type AdminImportSource, AdminImportSourceSchema, type AdminInitUpload, AdminInitUploadSchema, type AdminLicenseStatusResponse, AdminLicenseStatusResponseSchema, type AdminOperation, type AdminOperationBody, type AdminOperationHeader, type AdminOperationId, type AdminOperationMethod, type AdminOperationResponse, type AdminPresignedUpload, AdminPresignedUploadSchema, type AdminTenantCreateRequest, AdminTenantCreateRequestSchema, type AdminTenantCreateResponse, AdminTenantCreateResponseSchema, type AdminTenantDocParams, AdminTenantDocParamsSchema, type AdminTenantJtiParams, AdminTenantJtiParamsSchema, type AdminTenantListQuery, AdminTenantListQuerySchema, type AdminTenantListResponse, AdminTenantListResponseSchema, type AdminTenantParams, AdminTenantParamsSchema, type AdminTenantRecord, AdminTenantRecordSchema, type AdminTenantResponse, AdminTenantResponseSchema, type AdminTenantScope, type AdminTenantShareParams, AdminTenantShareParamsSchema, type AdminThumbnailUnavailablePayload, AdminThumbnailUnavailablePayloadSchema, type AdminTokenIssueDocRequest, AdminTokenIssueDocRequestSchema, type AdminTokenIssueRequest, AdminTokenIssueRequestSchema, type AdminTokenIssueResponse, AdminTokenIssueResponseSchema, type AdminTokenIssueTenantRequest, AdminTokenIssueTenantRequestSchema, type AdminTokenRevokeRequest, AdminTokenRevokeRequestSchema, type AdminUploadProxyResponse, AdminUploadProxyResponseSchema, type DedupMode, DedupModeSchema, DocAnnotationParamsSchema, DocFieldParamsSchema, DocIdParamsSchema, DocLayerParamsSchema, type DocOperationId, DocPageParamsSchema, type DocsGroup, type DocumentState, DocumentStateSchema, type ShareExchangeRequest, ShareExchangeRequestSchema, type ShareGrantCreateRequest, ShareGrantCreateRequestSchema, type ShareGrantListQuery, ShareGrantListQuerySchema, type ShareGrantListResponse, ShareGrantListResponseSchema, type ShareGrantRecord, ShareGrantRecordSchema, type ShareGrantResponse, ShareGrantResponseSchema, type ShareGrantUpdateRequest, ShareGrantUpdateRequestSchema, type ShareSessionResponse, ShareSessionResponseSchema, type TenantSuspendRequest, TenantSuspendRequestSchema, type TenantUsageQuery, TenantUsageQuerySchema, type TenantUsageResponse, TenantUsageResponseSchema, type UploadPreference, UploadPreferenceSchema, adminCredentials, adminOperations, adminTenantScopes, adminWirePaths, allOperations, docOperations, docsGroups, documentPasswordHeader, tenantIdPattern };
12763
+ export { ADMIN_DOCUMENT_LIST_DEFAULT_LIMIT, ADMIN_DOCUMENT_LIST_MAX_LIMIT, type AdminCredential, type AdminDocumentCommitRequest, AdminDocumentCommitRequestSchema, type AdminDocumentCommitResponse, AdminDocumentCommitResponseSchema, type AdminDocumentImportRequest, AdminDocumentImportRequestSchema, type AdminDocumentImportResponse, AdminDocumentImportResponseSchema, type AdminDocumentInitRequest, AdminDocumentInitRequestSchema, type AdminDocumentInitResponse, AdminDocumentInitResponseSchema, type AdminDocumentListQuery, AdminDocumentListQuerySchema, type AdminDocumentListResponse, AdminDocumentListResponseSchema, type AdminDocumentRecord, AdminDocumentRecordSchema, type AdminDocumentResponse, AdminDocumentResponseSchema, type AdminErrorPayload, AdminErrorPayloadSchema, type AdminImportSource, AdminImportSourceSchema, type AdminInitUpload, AdminInitUploadSchema, type AdminLicenseStatusResponse, AdminLicenseStatusResponseSchema, type AdminOperation, type AdminOperationBody, type AdminOperationHeader, type AdminOperationId, type AdminOperationMethod, type AdminOperationResponse, type AdminPresignedUpload, AdminPresignedUploadSchema, type AdminTenantCreateRequest, AdminTenantCreateRequestSchema, type AdminTenantCreateResponse, AdminTenantCreateResponseSchema, type AdminTenantDocParams, AdminTenantDocParamsSchema, type AdminTenantJtiParams, AdminTenantJtiParamsSchema, type AdminTenantListQuery, AdminTenantListQuerySchema, type AdminTenantListResponse, AdminTenantListResponseSchema, type AdminTenantParams, AdminTenantParamsSchema, type AdminTenantRecord, AdminTenantRecordSchema, type AdminTenantResponse, AdminTenantResponseSchema, type AdminTenantScope, type AdminTenantShareParams, AdminTenantShareParamsSchema, type AdminThumbnailUnavailablePayload, AdminThumbnailUnavailablePayloadSchema, type AdminTokenIssueDocRequest, AdminTokenIssueDocRequestSchema, type AdminTokenIssueRequest, AdminTokenIssueRequestSchema, type AdminTokenIssueResponse, AdminTokenIssueResponseSchema, type AdminTokenIssueTenantRequest, AdminTokenIssueTenantRequestSchema, type AdminTokenRevokeRequest, AdminTokenRevokeRequestSchema, type AdminUploadProxyResponse, AdminUploadProxyResponseSchema, type DedupMode, DedupModeSchema, DocAnnotationParamsSchema, DocFieldParamsSchema, DocIdParamsSchema, DocLayerParamsSchema, type DocOperationId, DocPageParamsSchema, DocSigningParamsSchema, DocVersionDigestParamsSchema, DocVersionFieldParamsSchema, DocVersionParamsSchema, DocVersionRevisionParamsSchema, type DocsGroup, type DocumentState, DocumentStateSchema, LayerSignaturesAnalysisQuerySchema, type ShareExchangeRequest, ShareExchangeRequestSchema, type ShareGrantCreateRequest, ShareGrantCreateRequestSchema, type ShareGrantListQuery, ShareGrantListQuerySchema, type ShareGrantListResponse, ShareGrantListResponseSchema, type ShareGrantRecord, ShareGrantRecordSchema, type ShareGrantResponse, ShareGrantResponseSchema, type ShareGrantUpdateRequest, ShareGrantUpdateRequestSchema, type ShareSessionResponse, ShareSessionResponseSchema, type TenantSuspendRequest, TenantSuspendRequestSchema, type TenantUsageQuery, TenantUsageQuerySchema, type TenantUsageResponse, TenantUsageResponseSchema, type UploadPreference, UploadPreferenceSchema, VersionAnalysisQuerySchema, adminCredentials, adminOperations, adminTenantScopes, adminWirePaths, allOperations, docOperations, docsGroups, documentPasswordHeader, tenantIdPattern };