npm - @cloudpdf/contract - Versions diffs - 3.0.0-next.11 → 3.0.0-next.12 - Mend

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

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.

Files changed (7) hide show

package/dist/index.d.ts CHANGED Viewed

@@ -6046,6 +6046,99 @@ declare const docOperations: {
             };
         };
     };
+    readonly 'doc.annotations.flatten': {
+        readonly operationId: "doc.annotations.flatten";
+        readonly title: "Flatten annotations";
+        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.";
+        readonly method: "POST";
+        readonly path: "/v1/docs/:docId/layers/:layerName/annotations/pages/:pon/items/flatten";
+        readonly credentials: readonly ["api-token", "doc-jwt"];
+        readonly scope: readonly [];
+        readonly docCapabilities: readonly ["doc.pages.modify", "doc.annotate.modify"];
+        readonly requestHeaders: readonly [AdminOperationHeader];
+        readonly params: z.ZodObject<{
+            docId: z.ZodString;
+        } & {
+            layerName: z.ZodString;
+        } & {
+            pon: z.ZodNumber;
+        }, "strip", z.ZodTypeAny, {
+            docId: string;
+            layerName: string;
+            pon: number;
+        }, {
+            docId: string;
+            layerName: string;
+            pon: number;
+        }>;
+        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 'doc.annotations.exportAppearance': {
+        readonly operationId: "doc.annotations.exportAppearance";
+        readonly title: "Export annotation appearances";
+        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.";
+        readonly method: "POST";
+        readonly path: "/v1/docs/:docId/layers/:layerName/annotations/pages/:pon/items/appearance";
+        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;
+        } & {
+            pon: z.ZodNumber;
+        }, "strip", z.ZodTypeAny, {
+            docId: string;
+            layerName: string;
+            pon: number;
+        }, {
+            docId: string;
+            layerName: string;
+            pon: number;
+        }>;
+        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 'doc.forms.get': {
         readonly operationId: "doc.forms.get";
         readonly title: "Get form snapshot";
@@ -6392,6 +6485,98 @@ declare const docOperations: {
             };
         };
     };
+    readonly 'doc.pages.setName': {
+        readonly operationId: "doc.pages.setName";
+        readonly title: "Set page name";
+        readonly summary: "Register or rename a /Names /Pages entry (a named page). A page-structure mutation: the layout version advances.";
+        readonly method: "POST";
+        readonly path: "/v1/docs/:docId/layers/:layerName/pages/names";
+        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 'doc.pages.removeName': {
+        readonly operationId: "doc.pages.removeName";
+        readonly title: "Remove page name";
+        readonly summary: "Remove a /Names /Pages entry; the page itself stays.";
+        readonly method: "POST";
+        readonly path: "/v1/docs/:docId/layers/:layerName/pages/names/delete";
+        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 'doc.pages.flatten': {
         readonly operationId: "doc.pages.flatten";
         readonly title: "Flatten pages";
@@ -7139,6 +7324,99 @@ declare const allOperations: {
             };
         };
     };
+    readonly 'doc.annotations.flatten': {
+        readonly operationId: "doc.annotations.flatten";
+        readonly title: "Flatten annotations";
+        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.";
+        readonly method: "POST";
+        readonly path: "/v1/docs/:docId/layers/:layerName/annotations/pages/:pon/items/flatten";
+        readonly credentials: readonly ["api-token", "doc-jwt"];
+        readonly scope: readonly [];
+        readonly docCapabilities: readonly ["doc.pages.modify", "doc.annotate.modify"];
+        readonly requestHeaders: readonly [AdminOperationHeader];
+        readonly params: z.ZodObject<{
+            docId: z.ZodString;
+        } & {
+            layerName: z.ZodString;
+        } & {
+            pon: z.ZodNumber;
+        }, "strip", z.ZodTypeAny, {
+            docId: string;
+            layerName: string;
+            pon: number;
+        }, {
+            docId: string;
+            layerName: string;
+            pon: number;
+        }>;
+        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 'doc.annotations.exportAppearance': {
+        readonly operationId: "doc.annotations.exportAppearance";
+        readonly title: "Export annotation appearances";
+        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.";
+        readonly method: "POST";
+        readonly path: "/v1/docs/:docId/layers/:layerName/annotations/pages/:pon/items/appearance";
+        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;
+        } & {
+            pon: z.ZodNumber;
+        }, "strip", z.ZodTypeAny, {
+            docId: string;
+            layerName: string;
+            pon: number;
+        }, {
+            docId: string;
+            layerName: string;
+            pon: number;
+        }>;
+        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 'doc.forms.get': {
         readonly operationId: "doc.forms.get";
         readonly title: "Get form snapshot";
@@ -7485,6 +7763,98 @@ declare const allOperations: {
             };
         };
     };
+    readonly 'doc.pages.setName': {
+        readonly operationId: "doc.pages.setName";
+        readonly title: "Set page name";
+        readonly summary: "Register or rename a /Names /Pages entry (a named page). A page-structure mutation: the layout version advances.";
+        readonly method: "POST";
+        readonly path: "/v1/docs/:docId/layers/:layerName/pages/names";
+        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 'doc.pages.removeName': {
+        readonly operationId: "doc.pages.removeName";
+        readonly title: "Remove page name";
+        readonly summary: "Remove a /Names /Pages entry; the page itself stays.";
+        readonly method: "POST";
+        readonly path: "/v1/docs/:docId/layers/:layerName/pages/names/delete";
+        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 'doc.pages.flatten': {
         readonly operationId: "doc.pages.flatten";
         readonly title: "Flatten pages";

package/dist/index.js CHANGED Viewed

@@ -1036,6 +1036,42 @@ var docOperations = {
       404: { contentType: "application/json", schema: EngineErrorPayloadSchema }
     }
   },
+  "doc.annotations.flatten": {
+    operationId: "doc.annotations.flatten",
+    title: "Flatten annotations",
+    summary: "Flatten a chosen set of one page's annotations into its content \u2014 pages.flatten for a selection. Painted annotations are removed; ineligible ones report skipped.",
+    method: "POST",
+    path: wireTemplates.layerAnnotationItemsFlatten,
+    credentials: docCredentials,
+    scope: [],
+    docCapabilities: ["doc.pages.modify", "doc.annotate.modify"],
+    requestHeaders: [documentPasswordHeader],
+    params: DocPageParamsSchema,
+    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 }
+    }
+  },
+  "doc.annotations.exportAppearance": {
+    operationId: "doc.annotations.exportAppearance",
+    title: "Export annotation appearances",
+    summary: "The chosen annotations' appearances as one single-page PDF sized to their union rect \u2014 vector, positions preserved. A read; the source is untouched.",
+    method: "POST",
+    path: wireTemplates.layerAnnotationItemsAppearance,
+    credentials: docCredentials,
+    scope: [],
+    docCapabilities: ["doc.download"],
+    requestHeaders: [documentPasswordHeader],
+    params: DocPageParamsSchema,
+    body: { contentType: "application/json", schema: looseJson },
+    responses: {
+      200: { contentType: "application/pdf" },
+      400: { contentType: "application/json", schema: EngineErrorPayloadSchema },
+      404: { contentType: "application/json", schema: EngineErrorPayloadSchema }
+    }
+  },
   "doc.forms.get": {
     operationId: "doc.forms.get",
     title: "Get form snapshot",
@@ -1175,6 +1211,42 @@ var docOperations = {
       404: { contentType: "application/json", schema: EngineErrorPayloadSchema }
     }
   },
+  "doc.pages.setName": {
+    operationId: "doc.pages.setName",
+    title: "Set page name",
+    summary: "Register or rename a /Names /Pages entry (a named page). A page-structure mutation: the layout version advances.",
+    method: "POST",
+    path: wireTemplates.layerPagesNames,
+    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 }
+    }
+  },
+  "doc.pages.removeName": {
+    operationId: "doc.pages.removeName",
+    title: "Remove page name",
+    summary: "Remove a /Names /Pages entry; the page itself stays.",
+    method: "POST",
+    path: wireTemplates.layerPagesNamesDelete,
+    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 }
+    }
+  },
   "doc.pages.flatten": {
     operationId: "doc.pages.flatten",
     title: "Flatten pages",