@cloudpdf/sdk 3.0.0-next.15 → 3.0.0-next.16

package/dist/cjs/api/types/ChangeItem.d.ts

@@ -1,5 +1,5 @@
 import type * as CloudPDF from "../index.js";
-export type ChangeItem = CloudPDF.ChangeItem.Skipped | CloudPDF.ChangeItem.AnnotationsCreate | CloudPDF.ChangeItem.AnnotationsUpdate | CloudPDF.ChangeItem.AnnotationsDelete | CloudPDF.ChangeItem.AnnotationsReorder | CloudPDF.ChangeItem.AnnotationsRestore | CloudPDF.ChangeItem.FormsSetValue | CloudPDF.ChangeItem.FormsSetDisplay | CloudPDF.ChangeItem.FormsSetAppearanceText | CloudPDF.ChangeItem.FormsReset | CloudPDF.ChangeItem.FormsCreate | CloudPDF.ChangeItem.FormsUpdate | CloudPDF.ChangeItem.FormsDelete | CloudPDF.ChangeItem.FormsRestore | CloudPDF.ChangeItem.FormsSetSignatureAppearance | CloudPDF.ChangeItem.FormsAddWidget | CloudPDF.ChangeItem.FormsRemoveWidget | CloudPDF.ChangeItem.FormsDeleteWidget | CloudPDF.ChangeItem.FormsRestoreWidget | CloudPDF.ChangeItem.FormsReorderWidgets | CloudPDF.ChangeItem.FormsReorderCalculations | CloudPDF.ChangeItem.FormsUpdateWidget | CloudPDF.ChangeItem.MetadataUpdate | CloudPDF.ChangeItem.MetadataUpdateCustom;
+export type ChangeItem = CloudPDF.ChangeItem.Skipped | CloudPDF.ChangeItem.AnnotationsCreate | CloudPDF.ChangeItem.AnnotationsUpdate | CloudPDF.ChangeItem.AnnotationsDelete | CloudPDF.ChangeItem.AnnotationsReorder | CloudPDF.ChangeItem.AnnotationsRestore | CloudPDF.ChangeItem.FormsSetValue | CloudPDF.ChangeItem.FormsSetDisplay | CloudPDF.ChangeItem.FormsSetAppearanceText | CloudPDF.ChangeItem.FormsReset | CloudPDF.ChangeItem.FormsCreate | CloudPDF.ChangeItem.FormsUpdate | CloudPDF.ChangeItem.FormsDelete | CloudPDF.ChangeItem.FormsRestore | CloudPDF.ChangeItem.FormsSetSignatureAppearance | CloudPDF.ChangeItem.FormsAddWidget | CloudPDF.ChangeItem.FormsRemoveWidget | CloudPDF.ChangeItem.FormsDeleteWidget | CloudPDF.ChangeItem.FormsRestoreWidget | CloudPDF.ChangeItem.FormsReorderWidgets | CloudPDF.ChangeItem.FormsReorderCalculations | CloudPDF.ChangeItem.FormsUpdateWidget | CloudPDF.ChangeItem.MetadataUpdate | CloudPDF.ChangeItem.MetadataUpdateCustom | CloudPDF.ChangeItem.OutlineCreate | CloudPDF.ChangeItem.OutlineUpdate | CloudPDF.ChangeItem.OutlineMove | CloudPDF.ChangeItem.OutlineDelete | CloudPDF.ChangeItem.OutlineRestore | CloudPDF.ChangeItem.PagesRotate | CloudPDF.ChangeItem.PagesReorder | CloudPDF.ChangeItem.PagesDelete | CloudPDF.ChangeItem.PagesInsertBlank | CloudPDF.ChangeItem.PagesInsert | CloudPDF.ChangeItem.PagesRestore | CloudPDF.ChangeItem.AttachmentsCreate | CloudPDF.ChangeItem.AttachmentsDelete | CloudPDF.ChangeItem.AttachmentsRestore;
 export declare namespace ChangeItem {
     interface Skipped {
         type: "skipped";
@@ -28,8 +28,23 @@ export declare namespace ChangeItem {
             readonly FormsSetSignatureAppearance: "forms.setSignatureAppearance";
             readonly MetadataUpdate: "metadata.update";
             readonly MetadataUpdateCustom: "metadata.updateCustom";
+            readonly OutlineCreate: "outline.create";
+            readonly OutlineUpdate: "outline.update";
+            readonly OutlineMove: "outline.move";
+            readonly OutlineDelete: "outline.delete";
+            readonly PagesRotate: "pages.rotate";
+            readonly PagesReorder: "pages.reorder";
+            readonly PagesDelete: "pages.delete";
+            readonly PagesInsertBlank: "pages.insertBlank";
+            readonly PagesInsert: "pages.insert";
+            readonly AttachmentsCreate: "attachments.create";
+            readonly AttachmentsDelete: "attachments.delete";
             readonly AnnotationsRestore: "annotations.restore";
             readonly FormsRestore: "forms.restore";
+            readonly FormsRestoreWidget: "forms.restoreWidget";
+            readonly OutlineRestore: "outline.restore";
+            readonly PagesRestore: "pages.restore";
+            readonly AttachmentsRestore: "attachments.restore";
         };
         type Op = (typeof Op)[keyof typeof Op];
     }
@@ -209,4 +224,622 @@ export declare namespace ChangeItem {
         custom: Record<string, string>;
         meta: CloudPDF.MutationMeta;
     }
+    interface OutlineCreate {
+        type: "outline.create";
+        item: CloudPDF.OutlineItem;
+        order: CloudPDF.OutlineOrder;
+        meta: CloudPDF.OutlineMutationMeta;
+    }
+    interface OutlineUpdate {
+        type: "outline.update";
+        skipped?: string[] | undefined;
+        item: CloudPDF.OutlineItem;
+        meta: CloudPDF.OutlineMutationMeta;
+    }
+    interface OutlineMove {
+        type: "outline.move";
+        orders: CloudPDF.OutlineOrder[];
+        meta: CloudPDF.OutlineMutationMeta;
+    }
+    interface OutlineDelete {
+        type: "outline.delete";
+        meta: CloudPDF.OutlineMutationMeta;
+    }
+    interface OutlineRestore {
+        type: "outline.restore";
+        items: CloudPDF.OutlineItem[];
+        order: CloudPDF.OutlineOrder;
+        meta: CloudPDF.OutlineMutationMeta;
+    }
+    interface PagesRotate {
+        type: "pages.rotate";
+        pages: CloudPDF.PageRef[];
+        rotation: number;
+        layout: ChangeItemPagesRotate.Layout;
+        meta: CloudPDF.MutationMeta;
+    }
+    namespace ChangeItemPagesRotate {
+        interface Layout {
+            pageCount: number;
+            pages: Layout.Pages.Item[];
+            namedPages: Layout.NamedPages.Item[];
+        }
+        namespace Layout {
+            type Pages = Pages.Item[];
+            namespace Pages {
+                interface Item {
+                    index: number;
+                    ref: CloudPDF.PageRef;
+                    label: string | null;
+                    size: Item.Size;
+                    rotation: number;
+                    userUnit: number;
+                    tabOrder: Item.TabOrder | null;
+                    boxes: Item.Boxes;
+                    pdfCropBox: Item.PdfCropBox;
+                    actions?: CloudPDF.PdfPageActions | undefined;
+                }
+                namespace Item {
+                    interface Size {
+                        width: number;
+                        height: number;
+                    }
+                    const TabOrder: {
+                        readonly Rows: "rows";
+                        readonly Columns: "columns";
+                        readonly Structure: "structure";
+                        readonly Annotations: "annotations";
+                        readonly Widgets: "widgets";
+                    };
+                    type TabOrder = (typeof TabOrder)[keyof typeof TabOrder];
+                    interface Boxes {
+                        media: Boxes.Media;
+                        crop: Boxes.Crop;
+                        bleed: Boxes.Bleed;
+                        trim: Boxes.Trim;
+                        art: Boxes.Art;
+                    }
+                    namespace Boxes {
+                        interface Media {
+                            x: number;
+                            y: number;
+                            width: number;
+                            height: number;
+                        }
+                        interface Crop {
+                            x: number;
+                            y: number;
+                            width: number;
+                            height: number;
+                        }
+                        interface Bleed {
+                            x: number;
+                            y: number;
+                            width: number;
+                            height: number;
+                        }
+                        interface Trim {
+                            x: number;
+                            y: number;
+                            width: number;
+                            height: number;
+                        }
+                        interface Art {
+                            x: number;
+                            y: number;
+                            width: number;
+                            height: number;
+                        }
+                    }
+                    interface PdfCropBox {
+                        left: number;
+                        bottom: number;
+                        right: number;
+                        top: number;
+                    }
+                }
+            }
+            type NamedPages = NamedPages.Item[];
+            namespace NamedPages {
+                interface Item {
+                    name: string;
+                    target: CloudPDF.ChangeItemPagesRotateLayoutNamedPagesItemTarget;
+                }
+            }
+        }
+    }
+    interface PagesReorder {
+        type: "pages.reorder";
+        pages: CloudPDF.PageRef[];
+        layout: ChangeItemPagesReorder.Layout;
+        meta: CloudPDF.MutationMeta;
+    }
+    namespace ChangeItemPagesReorder {
+        interface Layout {
+            pageCount: number;
+            pages: Layout.Pages.Item[];
+            namedPages: Layout.NamedPages.Item[];
+        }
+        namespace Layout {
+            type Pages = Pages.Item[];
+            namespace Pages {
+                interface Item {
+                    index: number;
+                    ref: CloudPDF.PageRef;
+                    label: string | null;
+                    size: Item.Size;
+                    rotation: number;
+                    userUnit: number;
+                    tabOrder: Item.TabOrder | null;
+                    boxes: Item.Boxes;
+                    pdfCropBox: Item.PdfCropBox;
+                    actions?: CloudPDF.PdfPageActions | undefined;
+                }
+                namespace Item {
+                    interface Size {
+                        width: number;
+                        height: number;
+                    }
+                    const TabOrder: {
+                        readonly Rows: "rows";
+                        readonly Columns: "columns";
+                        readonly Structure: "structure";
+                        readonly Annotations: "annotations";
+                        readonly Widgets: "widgets";
+                    };
+                    type TabOrder = (typeof TabOrder)[keyof typeof TabOrder];
+                    interface Boxes {
+                        media: Boxes.Media;
+                        crop: Boxes.Crop;
+                        bleed: Boxes.Bleed;
+                        trim: Boxes.Trim;
+                        art: Boxes.Art;
+                    }
+                    namespace Boxes {
+                        interface Media {
+                            x: number;
+                            y: number;
+                            width: number;
+                            height: number;
+                        }
+                        interface Crop {
+                            x: number;
+                            y: number;
+                            width: number;
+                            height: number;
+                        }
+                        interface Bleed {
+                            x: number;
+                            y: number;
+                            width: number;
+                            height: number;
+                        }
+                        interface Trim {
+                            x: number;
+                            y: number;
+                            width: number;
+                            height: number;
+                        }
+                        interface Art {
+                            x: number;
+                            y: number;
+                            width: number;
+                            height: number;
+                        }
+                    }
+                    interface PdfCropBox {
+                        left: number;
+                        bottom: number;
+                        right: number;
+                        top: number;
+                    }
+                }
+            }
+            type NamedPages = NamedPages.Item[];
+            namespace NamedPages {
+                interface Item {
+                    name: string;
+                    target: CloudPDF.ChangeItemPagesReorderLayoutNamedPagesItemTarget;
+                }
+            }
+        }
+    }
+    interface PagesDelete {
+        type: "pages.delete";
+        pages: CloudPDF.PageRef[];
+        layout: ChangeItemPagesDelete.Layout;
+        meta: CloudPDF.MutationMeta;
+    }
+    namespace ChangeItemPagesDelete {
+        interface Layout {
+            pageCount: number;
+            pages: Layout.Pages.Item[];
+            namedPages: Layout.NamedPages.Item[];
+        }
+        namespace Layout {
+            type Pages = Pages.Item[];
+            namespace Pages {
+                interface Item {
+                    index: number;
+                    ref: CloudPDF.PageRef;
+                    label: string | null;
+                    size: Item.Size;
+                    rotation: number;
+                    userUnit: number;
+                    tabOrder: Item.TabOrder | null;
+                    boxes: Item.Boxes;
+                    pdfCropBox: Item.PdfCropBox;
+                    actions?: CloudPDF.PdfPageActions | undefined;
+                }
+                namespace Item {
+                    interface Size {
+                        width: number;
+                        height: number;
+                    }
+                    const TabOrder: {
+                        readonly Rows: "rows";
+                        readonly Columns: "columns";
+                        readonly Structure: "structure";
+                        readonly Annotations: "annotations";
+                        readonly Widgets: "widgets";
+                    };
+                    type TabOrder = (typeof TabOrder)[keyof typeof TabOrder];
+                    interface Boxes {
+                        media: Boxes.Media;
+                        crop: Boxes.Crop;
+                        bleed: Boxes.Bleed;
+                        trim: Boxes.Trim;
+                        art: Boxes.Art;
+                    }
+                    namespace Boxes {
+                        interface Media {
+                            x: number;
+                            y: number;
+                            width: number;
+                            height: number;
+                        }
+                        interface Crop {
+                            x: number;
+                            y: number;
+                            width: number;
+                            height: number;
+                        }
+                        interface Bleed {
+                            x: number;
+                            y: number;
+                            width: number;
+                            height: number;
+                        }
+                        interface Trim {
+                            x: number;
+                            y: number;
+                            width: number;
+                            height: number;
+                        }
+                        interface Art {
+                            x: number;
+                            y: number;
+                            width: number;
+                            height: number;
+                        }
+                    }
+                    interface PdfCropBox {
+                        left: number;
+                        bottom: number;
+                        right: number;
+                        top: number;
+                    }
+                }
+            }
+            type NamedPages = NamedPages.Item[];
+            namespace NamedPages {
+                interface Item {
+                    name: string;
+                    target: CloudPDF.ChangeItemPagesDeleteLayoutNamedPagesItemTarget;
+                }
+            }
+        }
+    }
+    interface PagesInsertBlank {
+        type: "pages.insertBlank";
+        insertedPages: CloudPDF.PageRef[];
+        layout: ChangeItemPagesInsertBlank.Layout;
+        meta: CloudPDF.MutationMeta;
+    }
+    namespace ChangeItemPagesInsertBlank {
+        interface Layout {
+            pageCount: number;
+            pages: Layout.Pages.Item[];
+            namedPages: Layout.NamedPages.Item[];
+        }
+        namespace Layout {
+            type Pages = Pages.Item[];
+            namespace Pages {
+                interface Item {
+                    index: number;
+                    ref: CloudPDF.PageRef;
+                    label: string | null;
+                    size: Item.Size;
+                    rotation: number;
+                    userUnit: number;
+                    tabOrder: Item.TabOrder | null;
+                    boxes: Item.Boxes;
+                    pdfCropBox: Item.PdfCropBox;
+                    actions?: CloudPDF.PdfPageActions | undefined;
+                }
+                namespace Item {
+                    interface Size {
+                        width: number;
+                        height: number;
+                    }
+                    const TabOrder: {
+                        readonly Rows: "rows";
+                        readonly Columns: "columns";
+                        readonly Structure: "structure";
+                        readonly Annotations: "annotations";
+                        readonly Widgets: "widgets";
+                    };
+                    type TabOrder = (typeof TabOrder)[keyof typeof TabOrder];
+                    interface Boxes {
+                        media: Boxes.Media;
+                        crop: Boxes.Crop;
+                        bleed: Boxes.Bleed;
+                        trim: Boxes.Trim;
+                        art: Boxes.Art;
+                    }
+                    namespace Boxes {
+                        interface Media {
+                            x: number;
+                            y: number;
+                            width: number;
+                            height: number;
+                        }
+                        interface Crop {
+                            x: number;
+                            y: number;
+                            width: number;
+                            height: number;
+                        }
+                        interface Bleed {
+                            x: number;
+                            y: number;
+                            width: number;
+                            height: number;
+                        }
+                        interface Trim {
+                            x: number;
+                            y: number;
+                            width: number;
+                            height: number;
+                        }
+                        interface Art {
+                            x: number;
+                            y: number;
+                            width: number;
+                            height: number;
+                        }
+                    }
+                    interface PdfCropBox {
+                        left: number;
+                        bottom: number;
+                        right: number;
+                        top: number;
+                    }
+                }
+            }
+            type NamedPages = NamedPages.Item[];
+            namespace NamedPages {
+                interface Item {
+                    name: string;
+                    target: CloudPDF.ChangeItemPagesInsertBlankLayoutNamedPagesItemTarget;
+                }
+            }
+        }
+    }
+    interface PagesInsert {
+        type: "pages.insert";
+        insertedPages: CloudPDF.PageRef[];
+        layout: ChangeItemPagesInsert.Layout;
+        meta: CloudPDF.MutationMeta;
+    }
+    namespace ChangeItemPagesInsert {
+        interface Layout {
+            pageCount: number;
+            pages: Layout.Pages.Item[];
+            namedPages: Layout.NamedPages.Item[];
+        }
+        namespace Layout {
+            type Pages = Pages.Item[];
+            namespace Pages {
+                interface Item {
+                    index: number;
+                    ref: CloudPDF.PageRef;
+                    label: string | null;
+                    size: Item.Size;
+                    rotation: number;
+                    userUnit: number;
+                    tabOrder: Item.TabOrder | null;
+                    boxes: Item.Boxes;
+                    pdfCropBox: Item.PdfCropBox;
+                    actions?: CloudPDF.PdfPageActions | undefined;
+                }
+                namespace Item {
+                    interface Size {
+                        width: number;
+                        height: number;
+                    }
+                    const TabOrder: {
+                        readonly Rows: "rows";
+                        readonly Columns: "columns";
+                        readonly Structure: "structure";
+                        readonly Annotations: "annotations";
+                        readonly Widgets: "widgets";
+                    };
+                    type TabOrder = (typeof TabOrder)[keyof typeof TabOrder];
+                    interface Boxes {
+                        media: Boxes.Media;
+                        crop: Boxes.Crop;
+                        bleed: Boxes.Bleed;
+                        trim: Boxes.Trim;
+                        art: Boxes.Art;
+                    }
+                    namespace Boxes {
+                        interface Media {
+                            x: number;
+                            y: number;
+                            width: number;
+                            height: number;
+                        }
+                        interface Crop {
+                            x: number;
+                            y: number;
+                            width: number;
+                            height: number;
+                        }
+                        interface Bleed {
+                            x: number;
+                            y: number;
+                            width: number;
+                            height: number;
+                        }
+                        interface Trim {
+                            x: number;
+                            y: number;
+                            width: number;
+                            height: number;
+                        }
+                        interface Art {
+                            x: number;
+                            y: number;
+                            width: number;
+                            height: number;
+                        }
+                    }
+                    interface PdfCropBox {
+                        left: number;
+                        bottom: number;
+                        right: number;
+                        top: number;
+                    }
+                }
+            }
+            type NamedPages = NamedPages.Item[];
+            namespace NamedPages {
+                interface Item {
+                    name: string;
+                    target: CloudPDF.ChangeItemPagesInsertLayoutNamedPagesItemTarget;
+                }
+            }
+        }
+    }
+    interface PagesRestore {
+        type: "pages.restore";
+        pages: CloudPDF.PageRef[];
+        layout: ChangeItemPagesRestore.Layout;
+        meta: CloudPDF.MutationMeta;
+    }
+    namespace ChangeItemPagesRestore {
+        interface Layout {
+            pageCount: number;
+            pages: Layout.Pages.Item[];
+            namedPages: Layout.NamedPages.Item[];
+        }
+        namespace Layout {
+            type Pages = Pages.Item[];
+            namespace Pages {
+                interface Item {
+                    index: number;
+                    ref: CloudPDF.PageRef;
+                    label: string | null;
+                    size: Item.Size;
+                    rotation: number;
+                    userUnit: number;
+                    tabOrder: Item.TabOrder | null;
+                    boxes: Item.Boxes;
+                    pdfCropBox: Item.PdfCropBox;
+                    actions?: CloudPDF.PdfPageActions | undefined;
+                }
+                namespace Item {
+                    interface Size {
+                        width: number;
+                        height: number;
+                    }
+                    const TabOrder: {
+                        readonly Rows: "rows";
+                        readonly Columns: "columns";
+                        readonly Structure: "structure";
+                        readonly Annotations: "annotations";
+                        readonly Widgets: "widgets";
+                    };
+                    type TabOrder = (typeof TabOrder)[keyof typeof TabOrder];
+                    interface Boxes {
+                        media: Boxes.Media;
+                        crop: Boxes.Crop;
+                        bleed: Boxes.Bleed;
+                        trim: Boxes.Trim;
+                        art: Boxes.Art;
+                    }
+                    namespace Boxes {
+                        interface Media {
+                            x: number;
+                            y: number;
+                            width: number;
+                            height: number;
+                        }
+                        interface Crop {
+                            x: number;
+                            y: number;
+                            width: number;
+                            height: number;
+                        }
+                        interface Bleed {
+                            x: number;
+                            y: number;
+                            width: number;
+                            height: number;
+                        }
+                        interface Trim {
+                            x: number;
+                            y: number;
+                            width: number;
+                            height: number;
+                        }
+                        interface Art {
+                            x: number;
+                            y: number;
+                            width: number;
+                            height: number;
+                        }
+                    }
+                    interface PdfCropBox {
+                        left: number;
+                        bottom: number;
+                        right: number;
+                        top: number;
+                    }
+                }
+            }
+            type NamedPages = NamedPages.Item[];
+            namespace NamedPages {
+                interface Item {
+                    name: string;
+                    target: CloudPDF.ChangeItemPagesRestoreLayoutNamedPagesItemTarget;
+                }
+            }
+        }
+    }
+    interface AttachmentsCreate {
+        type: "attachments.create";
+        attachment: CloudPDF.Attachment;
+        meta: CloudPDF.AttachmentMutationMeta;
+    }
+    interface AttachmentsDelete {
+        type: "attachments.delete";
+        meta: CloudPDF.AttachmentMutationMeta;
+    }
+    interface AttachmentsRestore {
+        type: "attachments.restore";
+        attachment: CloudPDF.Attachment;
+        meta: CloudPDF.AttachmentMutationMeta;
+    }
 }