@cloudpdf/contract 3.0.0-next.7 → 3.0.0-next.9

package/dist/index.d.ts

@@ -6402,6 +6402,139 @@ declare const docOperations: {
             };
         };
     };
+    readonly 'doc.pages.insert': {
+        readonly operationId: "doc.pages.insert";
+        readonly title: "Insert pages from a PDF";
+        readonly summary: "Copy every page of an uploaded PDF into the document at an index.";
+        readonly method: "POST";
+        readonly path: "/v1/docs/:docId/layers/:layerName/pages/insert";
+        readonly credentials: readonly ["api-token", "doc-jwt"];
+        readonly scope: readonly [];
+        readonly docCapabilities: readonly ["doc.pages.assemble"];
+        readonly requestHeaders: readonly [AdminOperationHeader];
+        readonly params: z.ZodObject<{
+            docId: z.ZodString;
+        } & {
+            layerName: z.ZodString;
+        }, "strip", z.ZodTypeAny, {
+            docId: string;
+            layerName: string;
+        }, {
+            docId: string;
+            layerName: string;
+        }>;
+        readonly body: {
+            readonly contentType: "multipart/form-data";
+        };
+        readonly responses: {
+            readonly 200: {
+                readonly contentType: "application/json";
+                readonly schema: z.ZodObject<{
+                    meta: z.ZodType<_embedpdf_engine_core_runtime.MutationMeta, z.ZodTypeDef, _embedpdf_engine_core_runtime.MutationMeta>;
+                }, "passthrough", z.ZodTypeAny, z.objectOutputType<{
+                    meta: z.ZodType<_embedpdf_engine_core_runtime.MutationMeta, z.ZodTypeDef, _embedpdf_engine_core_runtime.MutationMeta>;
+                }, z.ZodTypeAny, "passthrough">, z.objectInputType<{
+                    meta: z.ZodType<_embedpdf_engine_core_runtime.MutationMeta, z.ZodTypeDef, _embedpdf_engine_core_runtime.MutationMeta>;
+                }, z.ZodTypeAny, "passthrough">>;
+            };
+            readonly 400: {
+                readonly contentType: "application/json";
+                readonly schema: z.ZodType<_embedpdf_engine_core_runtime.SerializedEngineError, z.ZodTypeDef, _embedpdf_engine_core_runtime.SerializedEngineError>;
+            };
+            readonly 404: {
+                readonly contentType: "application/json";
+                readonly schema: z.ZodType<_embedpdf_engine_core_runtime.SerializedEngineError, z.ZodTypeDef, _embedpdf_engine_core_runtime.SerializedEngineError>;
+            };
+        };
+        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.";
+    };
+    readonly 'doc.pages.insertBlank': {
+        readonly operationId: "doc.pages.insertBlank";
+        readonly title: "Insert blank pages";
+        readonly summary: "Create blank pages of an explicit size at an index.";
+        readonly method: "POST";
+        readonly path: "/v1/docs/:docId/layers/:layerName/pages/insert-blank";
+        readonly credentials: readonly ["api-token", "doc-jwt"];
+        readonly scope: readonly [];
+        readonly docCapabilities: readonly ["doc.pages.assemble"];
+        readonly requestHeaders: readonly [AdminOperationHeader];
+        readonly params: z.ZodObject<{
+            docId: z.ZodString;
+        } & {
+            layerName: z.ZodString;
+        }, "strip", z.ZodTypeAny, {
+            docId: string;
+            layerName: string;
+        }, {
+            docId: string;
+            layerName: string;
+        }>;
+        readonly body: {
+            readonly contentType: "application/json";
+            readonly schema: z.ZodRecord<z.ZodString, z.ZodUnknown>;
+        };
+        readonly responses: {
+            readonly 200: {
+                readonly contentType: "application/json";
+                readonly schema: z.ZodObject<{
+                    meta: z.ZodType<_embedpdf_engine_core_runtime.MutationMeta, z.ZodTypeDef, _embedpdf_engine_core_runtime.MutationMeta>;
+                }, "passthrough", z.ZodTypeAny, z.objectOutputType<{
+                    meta: z.ZodType<_embedpdf_engine_core_runtime.MutationMeta, z.ZodTypeDef, _embedpdf_engine_core_runtime.MutationMeta>;
+                }, z.ZodTypeAny, "passthrough">, z.objectInputType<{
+                    meta: z.ZodType<_embedpdf_engine_core_runtime.MutationMeta, z.ZodTypeDef, _embedpdf_engine_core_runtime.MutationMeta>;
+                }, z.ZodTypeAny, "passthrough">>;
+            };
+            readonly 400: {
+                readonly contentType: "application/json";
+                readonly schema: z.ZodType<_embedpdf_engine_core_runtime.SerializedEngineError, z.ZodTypeDef, _embedpdf_engine_core_runtime.SerializedEngineError>;
+            };
+            readonly 404: {
+                readonly contentType: "application/json";
+                readonly schema: z.ZodType<_embedpdf_engine_core_runtime.SerializedEngineError, z.ZodTypeDef, _embedpdf_engine_core_runtime.SerializedEngineError>;
+            };
+        };
+        readonly notes: "Body is `{\"size\": {\"width\", \"height\"}, \"count\"?, \"destIndex\"?}` — size in PDF points, count in [1, 100], destIndex omitted → append.";
+    };
+    readonly 'doc.pages.extract': {
+        readonly operationId: "doc.pages.extract";
+        readonly title: "Extract pages";
+        readonly summary: "Export the listed pages, in order, as a standalone PDF.";
+        readonly method: "POST";
+        readonly path: "/v1/docs/:docId/layers/:layerName/pages/extract";
+        readonly credentials: readonly ["api-token", "doc-jwt"];
+        readonly scope: readonly [];
+        readonly docCapabilities: readonly ["doc.download"];
+        readonly requestHeaders: readonly [AdminOperationHeader];
+        readonly params: z.ZodObject<{
+            docId: z.ZodString;
+        } & {
+            layerName: z.ZodString;
+        }, "strip", z.ZodTypeAny, {
+            docId: string;
+            layerName: string;
+        }, {
+            docId: string;
+            layerName: string;
+        }>;
+        readonly body: {
+            readonly contentType: "application/json";
+            readonly schema: z.ZodRecord<z.ZodString, z.ZodUnknown>;
+        };
+        readonly responses: {
+            readonly 200: {
+                readonly contentType: "application/pdf";
+            };
+            readonly 400: {
+                readonly contentType: "application/json";
+                readonly schema: z.ZodType<_embedpdf_engine_core_runtime.SerializedEngineError, z.ZodTypeDef, _embedpdf_engine_core_runtime.SerializedEngineError>;
+            };
+            readonly 404: {
+                readonly contentType: "application/json";
+                readonly schema: z.ZodType<_embedpdf_engine_core_runtime.SerializedEngineError, z.ZodTypeDef, _embedpdf_engine_core_runtime.SerializedEngineError>;
+            };
+        };
+        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.";
+    };
     readonly 'doc.redactions.apply': {
         readonly operationId: "doc.redactions.apply";
         readonly title: "Apply redactions";
@@ -7325,6 +7458,139 @@ declare const allOperations: {
             };
         };
     };
+    readonly 'doc.pages.insert': {
+        readonly operationId: "doc.pages.insert";
+        readonly title: "Insert pages from a PDF";
+        readonly summary: "Copy every page of an uploaded PDF into the document at an index.";
+        readonly method: "POST";
+        readonly path: "/v1/docs/:docId/layers/:layerName/pages/insert";
+        readonly credentials: readonly ["api-token", "doc-jwt"];
+        readonly scope: readonly [];
+        readonly docCapabilities: readonly ["doc.pages.assemble"];
+        readonly requestHeaders: readonly [AdminOperationHeader];
+        readonly params: z.ZodObject<{
+            docId: z.ZodString;
+        } & {
+            layerName: z.ZodString;
+        }, "strip", z.ZodTypeAny, {
+            docId: string;
+            layerName: string;
+        }, {
+            docId: string;
+            layerName: string;
+        }>;
+        readonly body: {
+            readonly contentType: "multipart/form-data";
+        };
+        readonly responses: {
+            readonly 200: {
+                readonly contentType: "application/json";
+                readonly schema: z.ZodObject<{
+                    meta: z.ZodType<_embedpdf_engine_core_runtime.MutationMeta, z.ZodTypeDef, _embedpdf_engine_core_runtime.MutationMeta>;
+                }, "passthrough", z.ZodTypeAny, z.objectOutputType<{
+                    meta: z.ZodType<_embedpdf_engine_core_runtime.MutationMeta, z.ZodTypeDef, _embedpdf_engine_core_runtime.MutationMeta>;
+                }, z.ZodTypeAny, "passthrough">, z.objectInputType<{
+                    meta: z.ZodType<_embedpdf_engine_core_runtime.MutationMeta, z.ZodTypeDef, _embedpdf_engine_core_runtime.MutationMeta>;
+                }, z.ZodTypeAny, "passthrough">>;
+            };
+            readonly 400: {
+                readonly contentType: "application/json";
+                readonly schema: z.ZodType<_embedpdf_engine_core_runtime.SerializedEngineError, z.ZodTypeDef, _embedpdf_engine_core_runtime.SerializedEngineError>;
+            };
+            readonly 404: {
+                readonly contentType: "application/json";
+                readonly schema: z.ZodType<_embedpdf_engine_core_runtime.SerializedEngineError, z.ZodTypeDef, _embedpdf_engine_core_runtime.SerializedEngineError>;
+            };
+        };
+        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.";
+    };
+    readonly 'doc.pages.insertBlank': {
+        readonly operationId: "doc.pages.insertBlank";
+        readonly title: "Insert blank pages";
+        readonly summary: "Create blank pages of an explicit size at an index.";
+        readonly method: "POST";
+        readonly path: "/v1/docs/:docId/layers/:layerName/pages/insert-blank";
+        readonly credentials: readonly ["api-token", "doc-jwt"];
+        readonly scope: readonly [];
+        readonly docCapabilities: readonly ["doc.pages.assemble"];
+        readonly requestHeaders: readonly [AdminOperationHeader];
+        readonly params: z.ZodObject<{
+            docId: z.ZodString;
+        } & {
+            layerName: z.ZodString;
+        }, "strip", z.ZodTypeAny, {
+            docId: string;
+            layerName: string;
+        }, {
+            docId: string;
+            layerName: string;
+        }>;
+        readonly body: {
+            readonly contentType: "application/json";
+            readonly schema: z.ZodRecord<z.ZodString, z.ZodUnknown>;
+        };
+        readonly responses: {
+            readonly 200: {
+                readonly contentType: "application/json";
+                readonly schema: z.ZodObject<{
+                    meta: z.ZodType<_embedpdf_engine_core_runtime.MutationMeta, z.ZodTypeDef, _embedpdf_engine_core_runtime.MutationMeta>;
+                }, "passthrough", z.ZodTypeAny, z.objectOutputType<{
+                    meta: z.ZodType<_embedpdf_engine_core_runtime.MutationMeta, z.ZodTypeDef, _embedpdf_engine_core_runtime.MutationMeta>;
+                }, z.ZodTypeAny, "passthrough">, z.objectInputType<{
+                    meta: z.ZodType<_embedpdf_engine_core_runtime.MutationMeta, z.ZodTypeDef, _embedpdf_engine_core_runtime.MutationMeta>;
+                }, z.ZodTypeAny, "passthrough">>;
+            };
+            readonly 400: {
+                readonly contentType: "application/json";
+                readonly schema: z.ZodType<_embedpdf_engine_core_runtime.SerializedEngineError, z.ZodTypeDef, _embedpdf_engine_core_runtime.SerializedEngineError>;
+            };
+            readonly 404: {
+                readonly contentType: "application/json";
+                readonly schema: z.ZodType<_embedpdf_engine_core_runtime.SerializedEngineError, z.ZodTypeDef, _embedpdf_engine_core_runtime.SerializedEngineError>;
+            };
+        };
+        readonly notes: "Body is `{\"size\": {\"width\", \"height\"}, \"count\"?, \"destIndex\"?}` — size in PDF points, count in [1, 100], destIndex omitted → append.";
+    };
+    readonly 'doc.pages.extract': {
+        readonly operationId: "doc.pages.extract";
+        readonly title: "Extract pages";
+        readonly summary: "Export the listed pages, in order, as a standalone PDF.";
+        readonly method: "POST";
+        readonly path: "/v1/docs/:docId/layers/:layerName/pages/extract";
+        readonly credentials: readonly ["api-token", "doc-jwt"];
+        readonly scope: readonly [];
+        readonly docCapabilities: readonly ["doc.download"];
+        readonly requestHeaders: readonly [AdminOperationHeader];
+        readonly params: z.ZodObject<{
+            docId: z.ZodString;
+        } & {
+            layerName: z.ZodString;
+        }, "strip", z.ZodTypeAny, {
+            docId: string;
+            layerName: string;
+        }, {
+            docId: string;
+            layerName: string;
+        }>;
+        readonly body: {
+            readonly contentType: "application/json";
+            readonly schema: z.ZodRecord<z.ZodString, z.ZodUnknown>;
+        };
+        readonly responses: {
+            readonly 200: {
+                readonly contentType: "application/pdf";
+            };
+            readonly 400: {
+                readonly contentType: "application/json";
+                readonly schema: z.ZodType<_embedpdf_engine_core_runtime.SerializedEngineError, z.ZodTypeDef, _embedpdf_engine_core_runtime.SerializedEngineError>;
+            };
+            readonly 404: {
+                readonly contentType: "application/json";
+                readonly schema: z.ZodType<_embedpdf_engine_core_runtime.SerializedEngineError, z.ZodTypeDef, _embedpdf_engine_core_runtime.SerializedEngineError>;
+            };
+        };
+        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.";
+    };
     readonly 'doc.redactions.apply': {
         readonly operationId: "doc.redactions.apply";
         readonly title: "Apply redactions";

package/dist/index.js

@@ -1174,6 +1174,65 @@ var docOperations = {
       404: { contentType: "application/json", schema: EngineErrorPayloadSchema }
     }
   },
+  "doc.pages.insert": {
+    operationId: "doc.pages.insert",
+    title: "Insert pages from a PDF",
+    summary: "Copy every page of an uploaded PDF into the document at an index.",
+    method: "POST",
+    path: wireTemplates.layerPagesInsert,
+    credentials: docCredentials,
+    scope: [],
+    docCapabilities: ["doc.pages.assemble"],
+    requestHeaders: [documentPasswordHeader],
+    params: DocLayerParamsSchema,
+    body: {
+      contentType: "multipart/form-data"
+    },
+    responses: {
+      200: { contentType: "application/json", schema: MutationResponseSchema },
+      400: { contentType: "application/json", schema: EngineErrorPayloadSchema },
+      404: { contentType: "application/json", schema: EngineErrorPayloadSchema }
+    },
+    notes: 'Multipart mutation envelope: a `body` field holding `{"destIndex"?: number}` (omitted \u2192 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.'
+  },
+  "doc.pages.insertBlank": {
+    operationId: "doc.pages.insertBlank",
+    title: "Insert blank pages",
+    summary: "Create blank pages of an explicit size at an index.",
+    method: "POST",
+    path: wireTemplates.layerPagesInsertBlank,
+    credentials: docCredentials,
+    scope: [],
+    docCapabilities: ["doc.pages.assemble"],
+    requestHeaders: [documentPasswordHeader],
+    params: DocLayerParamsSchema,
+    body: { contentType: "application/json", schema: looseJson },
+    responses: {
+      200: { contentType: "application/json", schema: MutationResponseSchema },
+      400: { contentType: "application/json", schema: EngineErrorPayloadSchema },
+      404: { contentType: "application/json", schema: EngineErrorPayloadSchema }
+    },
+    notes: 'Body is `{"size": {"width", "height"}, "count"?, "destIndex"?}` \u2014 size in PDF points, count in [1, 100], destIndex omitted \u2192 append.'
+  },
+  "doc.pages.extract": {
+    operationId: "doc.pages.extract",
+    title: "Extract pages",
+    summary: "Export the listed pages, in order, as a standalone PDF.",
+    method: "POST",
+    path: wireTemplates.layerPagesExtract,
+    credentials: docCredentials,
+    scope: [],
+    docCapabilities: ["doc.download"],
+    requestHeaders: [documentPasswordHeader],
+    params: DocLayerParamsSchema,
+    body: { contentType: "application/json", schema: looseJson },
+    responses: {
+      200: { contentType: "application/pdf" },
+      400: { contentType: "application/json", schema: EngineErrorPayloadSchema },
+      404: { contentType: "application/json", schema: EngineErrorPayloadSchema }
+    },
+    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.'
+  },
   "doc.redactions.apply": {
     operationId: "doc.redactions.apply",
     title: "Apply redactions",