@magiclabs.ai/magicbook-client 0.6.3 → 0.6.6

package/index.d.cts

@@ -0,0 +1,1751 @@
+import { z } from 'zod';
+
+type Image = {
+    handle: string;
+    url: string;
+    width: number;
+    height: number;
+    rotation: number;
+    captureTime: string;
+    cameraMake?: string;
+    cameraModel?: string;
+    filename: string;
+};
+declare class Images {
+    private readonly client;
+    private parentId;
+    private images;
+    length: number;
+    constructor(client: MagicBookClient, parentId: string);
+    add(image: Image): Promise<number>;
+}
+declare const imageServerSchema: z.ZodObject<{
+    id: z.ZodOptional<z.ZodString>;
+    handle: z.ZodString;
+    url: z.ZodString;
+    width: z.ZodNumber;
+    height: z.ZodNumber;
+    orientation: z.ZodNumber;
+    taken_at: z.ZodString;
+    camera_make: z.ZodOptional<z.ZodString>;
+    camera: z.ZodOptional<z.ZodString>;
+    filename: z.ZodString;
+}, "strip", z.ZodTypeAny, {
+    handle: string;
+    url: string;
+    width: number;
+    height: number;
+    orientation: number;
+    taken_at: string;
+    filename: string;
+    id?: string | undefined;
+    camera_make?: string | undefined;
+    camera?: string | undefined;
+}, {
+    handle: string;
+    url: string;
+    width: number;
+    height: number;
+    orientation: number;
+    taken_at: string;
+    filename: string;
+    id?: string | undefined;
+    camera_make?: string | undefined;
+    camera?: string | undefined;
+}>;
+declare class ImageServer {
+    handle: string;
+    url: string;
+    width: number;
+    height: number;
+    orientation: number;
+    taken_at: string;
+    camera_make?: string;
+    camera?: string;
+    filename: string;
+    constructor(image: Image);
+}
+
+declare const states: readonly ["new", "ingesting", "submitted", "storyboarding", "deduplication", "image-selection", "designing", "layouting", "embellishing", "polishing", "ready", "timeout", "error", "cancelled"];
+declare const occasions: readonly ["baby", "birthday", "default", "everyday", "family", "kids", "life-stories", "portfolio", "school-memories", "seasonal-holidays", "special-celebrations", "sports-and-hobbies", "travel", "wedding", "year-in-review"];
+declare const styles: {
+    1005: {
+        slug: string;
+    };
+    1101: {
+        slug: string;
+    };
+    1103: {
+        slug: string;
+    };
+    1201: {
+        slug: string;
+    };
+    3001: {
+        slug: string;
+    };
+    4034: {
+        slug: string;
+    };
+    4035: {
+        slug: string;
+    };
+    5017: {
+        slug: string;
+    };
+    5033: {
+        slug: string;
+    };
+    5079: {
+        slug: string;
+    };
+    5082: {
+        slug: string;
+    };
+    5085: {
+        slug: string;
+    };
+    5091: {
+        slug: string;
+    };
+    5118: {
+        slug: string;
+    };
+    5120: {
+        slug: string;
+    };
+    5121: {
+        slug: string;
+    };
+    5122: {
+        slug: string;
+    };
+    5127: {
+        slug: string;
+    };
+    5134: {
+        slug: string;
+    };
+    5138: {
+        slug: string;
+    };
+    5142: {
+        slug: string;
+    };
+    5144: {
+        slug: string;
+    };
+    5146: {
+        slug: string;
+    };
+    5149: {
+        slug: string;
+    };
+    5150: {
+        slug: string;
+    };
+    5155: {
+        slug: string;
+    };
+    5157: {
+        slug: string;
+    };
+    5161: {
+        slug: string;
+    };
+    5165: {
+        slug: string;
+    };
+    5167: {
+        slug: string;
+    };
+    5168: {
+        slug: string;
+    };
+    5171: {
+        slug: string;
+    };
+    5174: {
+        slug: string;
+    };
+    5183: {
+        slug: string;
+    };
+    5188: {
+        slug: string;
+    };
+    5189: {
+        slug: string;
+    };
+    5213: {
+        slug: string;
+    };
+    5218: {
+        slug: string;
+    };
+    5219: {
+        slug: string;
+    };
+    5220: {
+        slug: string;
+    };
+    5226: {
+        slug: string;
+    };
+    5228: {
+        slug: string;
+    };
+    5238: {
+        slug: string;
+    };
+    5242: {
+        slug: string;
+    };
+    5250: {
+        slug: string;
+    };
+    5255: {
+        slug: string;
+    };
+    5258: {
+        slug: string;
+    };
+    5259: {
+        slug: string;
+    };
+    5261: {
+        slug: string;
+    };
+    5262: {
+        slug: string;
+    };
+    5265: {
+        slug: string;
+    };
+    5266: {
+        slug: string;
+    };
+    5272: {
+        slug: string;
+    };
+    5274: {
+        slug: string;
+    };
+    5278: {
+        slug: string;
+    };
+    5292: {
+        slug: string;
+    };
+    5297: {
+        slug: string;
+    };
+    5299: {
+        slug: string;
+    };
+    5304: {
+        slug: string;
+    };
+    5305: {
+        slug: string;
+    };
+    5308: {
+        slug: string;
+    };
+    6000: {
+        slug: string;
+    };
+    6001: {
+        slug: string;
+    };
+    6002: {
+        slug: string;
+    };
+    6003: {
+        slug: string;
+    };
+    6004: {
+        slug: string;
+    };
+    6005: {
+        slug: string;
+    };
+    6006: {
+        slug: string;
+    };
+    6007: {
+        slug: string;
+    };
+    6008: {
+        slug: string;
+    };
+    6009: {
+        slug: string;
+    };
+    6010: {
+        slug: string;
+    };
+    6011: {
+        slug: string;
+    };
+    6012: {
+        slug: string;
+    };
+    6013: {
+        slug: string;
+    };
+    6014: {
+        slug: string;
+    };
+    6015: {
+        slug: string;
+    };
+    6016: {
+        slug: string;
+    };
+    6017: {
+        slug: string;
+    };
+    6018: {
+        slug: string;
+    };
+    6019: {
+        slug: string;
+    };
+    6020: {
+        slug: string;
+    };
+    6021: {
+        slug: string;
+    };
+    6022: {
+        slug: string;
+    };
+    6023: {
+        slug: string;
+    };
+    6024: {
+        slug: string;
+    };
+    6025: {
+        slug: string;
+    };
+    6026: {
+        slug: string;
+    };
+    6027: {
+        slug: string;
+    };
+    6028: {
+        slug: string;
+    };
+    6030: {
+        slug: string;
+    };
+    6031: {
+        slug: string;
+    };
+    6032: {
+        slug: string;
+    };
+    6033: {
+        slug: string;
+    };
+    6034: {
+        slug: string;
+    };
+    6035: {
+        slug: string;
+    };
+    6036: {
+        slug: string;
+    };
+    6038: {
+        slug: string;
+    };
+    6039: {
+        slug: string;
+    };
+    6040: {
+        slug: string;
+    };
+    6041: {
+        slug: string;
+    };
+    6042: {
+        slug: string;
+    };
+    6043: {
+        slug: string;
+    };
+    6044: {
+        slug: string;
+    };
+    6045: {
+        slug: string;
+    };
+    6047: {
+        slug: string;
+    };
+    6057: {
+        slug: string;
+    };
+    6052: {
+        slug: string;
+    };
+    6054: {
+        slug: string;
+    };
+    6051: {
+        slug: string;
+    };
+    6058: {
+        slug: string;
+    };
+    6056: {
+        slug: string;
+    };
+    6055: {
+        slug: string;
+    };
+    6046: {
+        slug: string;
+    };
+    6053: {
+        slug: string;
+    };
+    6050: {
+        slug: string;
+    };
+    6063: {
+        slug: string;
+    };
+    6060: {
+        slug: string;
+    };
+    6059: {
+        slug: string;
+    };
+    6048: {
+        slug: string;
+    };
+    6049: {
+        slug: string;
+    };
+    6037: {
+        slug: string;
+    };
+    6061: {
+        slug: string;
+    };
+    6068: {
+        slug: string;
+    };
+    6067: {
+        slug: string;
+    };
+    6065: {
+        slug: string;
+    };
+    6066: {
+        slug: string;
+    };
+    6064: {
+        slug: string;
+    };
+    6071: {
+        slug: string;
+    };
+    6072: {
+        slug: string;
+    };
+    6073: {
+        slug: string;
+    };
+    6074: {
+        slug: string;
+    };
+    6085: {
+        slug: string;
+    };
+    6084: {
+        slug: string;
+    };
+    5402: {
+        slug: string;
+    };
+    6083: {
+        slug: string;
+    };
+    6082: {
+        slug: string;
+    };
+    6086: {
+        slug: string;
+    };
+    6101: {
+        slug: string;
+    };
+    6103: {
+        slug: string;
+    };
+    6104: {
+        slug: string;
+    };
+    6105: {
+        slug: string;
+    };
+    6116: {
+        slug: string;
+    };
+    6117: {
+        slug: string;
+    };
+    6118: {
+        slug: string;
+    };
+    6120: {
+        slug: string;
+    };
+    6121: {
+        slug: string;
+    };
+    6124: {
+        slug: string;
+    };
+    6125: {
+        slug: string;
+    };
+    6126: {
+        slug: string;
+    };
+    6132: {
+        slug: string;
+    };
+    6133: {
+        slug: string;
+    };
+    6137: {
+        slug: string;
+    };
+    6075: {
+        slug: string;
+    };
+    6078: {
+        slug: string;
+    };
+    6089: {
+        slug: string;
+    };
+    6096: {
+        slug: string;
+    };
+    6097: {
+        slug: string;
+    };
+    6098: {
+        slug: string;
+    };
+    6099: {
+        slug: string;
+    };
+};
+declare const bookSizes: readonly ["8x8", "10x10", "12x12", "8x11", "11x8", "11x14"];
+declare const coverTypes: readonly ["sc", "hc", "pl"];
+declare const pageTypes: readonly ["sp", "sl", "dl"];
+declare const imageDensities: readonly ["low", "medium", "high"];
+declare const imageFilteringLevels: readonly ["best", "most", "all"];
+declare const embellishmentLevels: readonly ["none", "few", "lots"];
+declare const textStickerLevels: readonly ["none", "few", "lots"];
+
+type Occasion = typeof occasions[number];
+type Style = keyof typeof styles;
+type BookSize = typeof bookSizes[number];
+type CoverType = typeof coverTypes[number];
+type PageType = typeof pageTypes[number];
+type ImageDensity = typeof imageDensities[number];
+type ImageFilteringLevel = typeof imageFilteringLevels[number];
+type EmbellishmentLevel = typeof embellishmentLevels[number];
+type TextStickerLevel = typeof textStickerLevels[number];
+declare const DesignRequestOptions: {
+    occasion: readonly ["baby", "birthday", "default", "everyday", "family", "kids", "life-stories", "portfolio", "school-memories", "seasonal-holidays", "special-celebrations", "sports-and-hobbies", "travel", "wedding", "year-in-review"];
+    style: number[];
+    bookSize: readonly ["8x8", "10x10", "12x12", "8x11", "11x8", "11x14"];
+    coverType: readonly ["sc", "hc", "pl"];
+    pageType: readonly ["sp", "sl", "dl"];
+    imageDensity: readonly ["low", "medium", "high"];
+    imageFilteringLevel: readonly ["best", "most", "all"];
+    embellishmentLevel: readonly ["none", "few", "lots"];
+    textStickerLevel: readonly ["none", "few", "lots"];
+};
+type DesignRequestProps = {
+    title?: string;
+    state?: State;
+    occasion?: Occasion;
+    style?: Style;
+    bookSize?: BookSize;
+    coverType?: CoverType;
+    pageType?: PageType;
+    imageDensity?: ImageDensity;
+    imageFilteringLevel?: ImageFilteringLevel;
+    embellishmentLevel?: EmbellishmentLevel;
+    textStickerLevel?: TextStickerLevel;
+};
+type State = typeof states[number];
+type DesignRequestEventDetail = {
+    state: string;
+    slug: State;
+    progress: number;
+    message: string;
+};
+type DesignRequestEvent = CustomEvent<DesignRequestEventDetail>;
+declare class DesignRequest {
+    private readonly client;
+    private webSocket;
+    state: State;
+    parentId: string;
+    title: string;
+    occasion: Occasion;
+    style: Style;
+    bookSize: BookSize;
+    coverType: CoverType;
+    pageType: PageType;
+    imageDensity: ImageDensity;
+    imageFilteringLevel: ImageFilteringLevel;
+    embellishmentLevel: EmbellishmentLevel;
+    textStickerLevel: TextStickerLevel;
+    images: Images;
+    guid?: string;
+    constructor(parentId: string, client: MagicBookClient, designRequestProps?: DesignRequestProps);
+    private updateDesignRequest;
+    getOptions(imageCount?: number): Promise<{
+        densities: {
+            low: {
+                maxPageCount: number;
+                minPageCount: number;
+                maxImageCount: number;
+                avgImageCount: number;
+                minImageCount: number;
+            };
+            medium: {
+                maxPageCount: number;
+                minPageCount: number;
+                maxImageCount: number;
+                avgImageCount: number;
+                minImageCount: number;
+            };
+            high: {
+                maxPageCount: number;
+                minPageCount: number;
+                maxImageCount: number;
+                avgImageCount: number;
+                minImageCount: number;
+            };
+        };
+    }>;
+    submit(submitDesignRequestProps?: DesignRequestProps): Promise<this>;
+    setGuid(guid: string): Promise<string>;
+    cancel(): Promise<this>;
+    getJSON(): Promise<{
+        title: string;
+        binding: string;
+        coverSpecId: string;
+        styleId: number;
+        userId: string;
+        magicShopBook: {
+            pages: {
+                type: string;
+                pageNum: number;
+                canvas: {
+                    backgroundId: string | null;
+                    assets?: {
+                        type: string;
+                        position: {
+                            x: number;
+                            y: number;
+                            rotation: number;
+                            width?: number | undefined;
+                            height?: number | undefined;
+                        };
+                        seqNum: number;
+                        z: number;
+                        imageAssignment?: {
+                            photoRefId: string;
+                            finalCrop: number[];
+                        } | undefined;
+                        id?: string | undefined;
+                        horizJustification?: string | undefined;
+                        vertJustification?: string | null | undefined;
+                        text?: string | undefined;
+                        fontId?: string | undefined;
+                        fontSize?: number | undefined;
+                        fontColor?: string | undefined;
+                        frame?: string | undefined;
+                    }[] | undefined;
+                };
+            }[];
+            photoStrip: {
+                url: string;
+                photoRefId: string;
+                encryptId: string;
+                photoId: string;
+                photoMetadata: {
+                    data: string | null;
+                    id: string;
+                    title: string;
+                    width: number;
+                    height: number;
+                    rotation: number;
+                    llx: number;
+                    lly: number;
+                    urx: number;
+                    ury: number;
+                    effect: string;
+                    source: string;
+                    uploadTime: string;
+                };
+            }[];
+        };
+        reportingData: {
+            properties: {
+                key: string;
+                value?: any;
+            }[];
+        };
+    }>;
+    private eventHandler;
+    private timeoutHandler;
+    private getProgress;
+    private toBook;
+}
+
+type BookReport = {
+    error: 'timeout' | 'design';
+    step: string;
+};
+type BookDesignRequestProps = {
+    occasion: Occasion;
+    style: string;
+    book_size: BookSize;
+    cover_type: CoverType;
+    page_type: PageType;
+    image_density: ImageDensity;
+    image_filtering_level: ImageFilteringLevel;
+    embellishment_level: EmbellishmentLevel;
+    text_sticker_level: TextStickerLevel;
+};
+declare class BookDesignRequest {
+    occasion: Occasion;
+    style: string;
+    book_size: BookSize;
+    cover_type: CoverType;
+    page_type: PageType;
+    image_density: ImageDensity;
+    image_filtering_level: ImageFilteringLevel;
+    embellishment_level: EmbellishmentLevel;
+    text_sticker_level: TextStickerLevel;
+    constructor(props: BookDesignRequestProps);
+}
+declare const BookPropsSchema: z.ZodObject<{
+    id: z.ZodOptional<z.ZodString>;
+    title: z.ZodString;
+    design_request: z.ZodObject<{
+        occasion: z.ZodEnum<["baby", "birthday", "default", "everyday", "family", "kids", "life-stories", "portfolio", "school-memories", "seasonal-holidays", "special-celebrations", "sports-and-hobbies", "travel", "wedding", "year-in-review"]>;
+        style: z.ZodString;
+        book_size: z.ZodEnum<["8x8", "10x10", "12x12", "8x11", "11x8", "11x14"]>;
+        cover_type: z.ZodEnum<["sc", "hc", "pl"]>;
+        page_type: z.ZodEnum<["sp", "sl", "dl"]>;
+        image_density: z.ZodEnum<["low", "medium", "high"]>;
+        image_filtering_level: z.ZodEnum<["best", "most", "all"]>;
+        embellishment_level: z.ZodEnum<["none", "few", "lots"]>;
+        text_sticker_level: z.ZodEnum<["none", "few", "lots"]>;
+    }, "strip", z.ZodTypeAny, {
+        occasion: "baby" | "birthday" | "default" | "everyday" | "family" | "kids" | "life-stories" | "portfolio" | "school-memories" | "seasonal-holidays" | "special-celebrations" | "sports-and-hobbies" | "travel" | "wedding" | "year-in-review";
+        style: string;
+        book_size: "8x8" | "10x10" | "12x12" | "8x11" | "11x8" | "11x14";
+        cover_type: "sc" | "hc" | "pl";
+        page_type: "sp" | "sl" | "dl";
+        image_density: "low" | "medium" | "high";
+        image_filtering_level: "best" | "most" | "all";
+        embellishment_level: "none" | "few" | "lots";
+        text_sticker_level: "none" | "few" | "lots";
+    }, {
+        occasion: "baby" | "birthday" | "default" | "everyday" | "family" | "kids" | "life-stories" | "portfolio" | "school-memories" | "seasonal-holidays" | "special-celebrations" | "sports-and-hobbies" | "travel" | "wedding" | "year-in-review";
+        style: string;
+        book_size: "8x8" | "10x10" | "12x12" | "8x11" | "11x8" | "11x14";
+        cover_type: "sc" | "hc" | "pl";
+        page_type: "sp" | "sl" | "dl";
+        image_density: "low" | "medium" | "high";
+        image_filtering_level: "best" | "most" | "all";
+        embellishment_level: "none" | "few" | "lots";
+        text_sticker_level: "none" | "few" | "lots";
+    }>;
+    state: z.ZodOptional<z.ZodEnum<["new", "ingesting", "submitted", "storyboarding", "deduplication", "image-selection", "designing", "layouting", "embellishing", "polishing", "ready", "timeout", "error", "cancelled"]>>;
+    guid: z.ZodOptional<z.ZodString>;
+    cancelled_at: z.ZodOptional<z.ZodString>;
+}, "strip", z.ZodTypeAny, {
+    title: string;
+    design_request: {
+        occasion: "baby" | "birthday" | "default" | "everyday" | "family" | "kids" | "life-stories" | "portfolio" | "school-memories" | "seasonal-holidays" | "special-celebrations" | "sports-and-hobbies" | "travel" | "wedding" | "year-in-review";
+        style: string;
+        book_size: "8x8" | "10x10" | "12x12" | "8x11" | "11x8" | "11x14";
+        cover_type: "sc" | "hc" | "pl";
+        page_type: "sp" | "sl" | "dl";
+        image_density: "low" | "medium" | "high";
+        image_filtering_level: "best" | "most" | "all";
+        embellishment_level: "none" | "few" | "lots";
+        text_sticker_level: "none" | "few" | "lots";
+    };
+    id?: string | undefined;
+    state?: "new" | "ingesting" | "submitted" | "storyboarding" | "deduplication" | "image-selection" | "designing" | "layouting" | "embellishing" | "polishing" | "ready" | "timeout" | "error" | "cancelled" | undefined;
+    guid?: string | undefined;
+    cancelled_at?: string | undefined;
+}, {
+    title: string;
+    design_request: {
+        occasion: "baby" | "birthday" | "default" | "everyday" | "family" | "kids" | "life-stories" | "portfolio" | "school-memories" | "seasonal-holidays" | "special-celebrations" | "sports-and-hobbies" | "travel" | "wedding" | "year-in-review";
+        style: string;
+        book_size: "8x8" | "10x10" | "12x12" | "8x11" | "11x8" | "11x14";
+        cover_type: "sc" | "hc" | "pl";
+        page_type: "sp" | "sl" | "dl";
+        image_density: "low" | "medium" | "high";
+        image_filtering_level: "best" | "most" | "all";
+        embellishment_level: "none" | "few" | "lots";
+        text_sticker_level: "none" | "few" | "lots";
+    };
+    id?: string | undefined;
+    state?: "new" | "ingesting" | "submitted" | "storyboarding" | "deduplication" | "image-selection" | "designing" | "layouting" | "embellishing" | "polishing" | "ready" | "timeout" | "error" | "cancelled" | undefined;
+    guid?: string | undefined;
+    cancelled_at?: string | undefined;
+}>;
+type BookProps = z.infer<typeof BookPropsSchema>;
+declare class Book {
+    id: string;
+    title: string;
+    design_request: BookDesignRequest;
+    state?: State;
+    guid?: string;
+    cancelled_at?: string;
+    constructor(props: BookProps);
+    toDesignRequestProps(): Record<string, unknown>;
+}
+
+declare class BooksEndpoints {
+    private readonly engineAPI;
+    constructor(engineAPI: EngineAPI);
+    create(): Promise<Book>;
+    retrieve(bookId: string): Promise<Book>;
+    update(bookId: string, book: Partial<Book>): Promise<Book>;
+    cancel(bookId: string): Promise<Book>;
+    report(bookId: string, report: BookReport): Promise<void>;
+    delete(bookId: string): Promise<void>;
+    retrieveGalleon(bookId: string): Promise<{
+        title: string;
+        binding: string;
+        coverSpecId: string;
+        styleId: number;
+        userId: string;
+        magicShopBook: {
+            pages: {
+                type: string;
+                pageNum: number;
+                canvas: {
+                    backgroundId: string | null;
+                    assets?: {
+                        type: string;
+                        position: {
+                            x: number;
+                            y: number;
+                            rotation: number;
+                            width?: number | undefined;
+                            height?: number | undefined;
+                        };
+                        seqNum: number;
+                        z: number;
+                        imageAssignment?: {
+                            photoRefId: string;
+                            finalCrop: number[];
+                        } | undefined;
+                        id?: string | undefined;
+                        horizJustification?: string | undefined;
+                        vertJustification?: string | null | undefined;
+                        text?: string | undefined;
+                        fontId?: string | undefined;
+                        fontSize?: number | undefined;
+                        fontColor?: string | undefined;
+                        frame?: string | undefined;
+                    }[] | undefined;
+                };
+            }[];
+            photoStrip: {
+                url: string;
+                photoRefId: string;
+                encryptId: string;
+                photoId: string;
+                photoMetadata: {
+                    data: string | null;
+                    id: string;
+                    title: string;
+                    width: number;
+                    height: number;
+                    rotation: number;
+                    llx: number;
+                    lly: number;
+                    urx: number;
+                    ury: number;
+                    effect: string;
+                    source: string;
+                    uploadTime: string;
+                };
+            }[];
+        };
+        reportingData: {
+            properties: {
+                key: string;
+                value?: any;
+            }[];
+        };
+    }>;
+}
+
+declare class DesignOptionsEndpoints {
+    private readonly engineAPI;
+    constructor(engineAPI: EngineAPI);
+    retrieve(bookSize: BookSize, imageCount: number, imageFilteringLevel: ImageFilteringLevel): Promise<{
+        densities: {
+            low: {
+                max_page_count: number;
+                min_page_count: number;
+                max_image_count: number;
+                avg_image_count: number;
+                min_image_count: number;
+            };
+            medium: {
+                max_page_count: number;
+                min_page_count: number;
+                max_image_count: number;
+                avg_image_count: number;
+                min_image_count: number;
+            };
+            high: {
+                max_page_count: number;
+                min_page_count: number;
+                max_image_count: number;
+                avg_image_count: number;
+                min_image_count: number;
+            };
+        };
+    }>;
+}
+
+type CallProps = {
+    path: string;
+    options?: RequestInit;
+    apiKey?: string;
+};
+declare class Fetcher {
+    baseUrl: URL;
+    options: RequestInit;
+    constructor(baseUrl: string, options?: RequestInit | undefined);
+    call(props: CallProps): Promise<any>;
+    cleanUrl(url: string): string;
+}
+
+declare class ImagesEndpoints {
+    private readonly engineAPI;
+    constructor(engineAPI: EngineAPI);
+    list(bookId: string): Promise<{
+        handle: string;
+        url: string;
+        width: number;
+        height: number;
+        orientation: number;
+        taken_at: string;
+        filename: string;
+        id?: string | undefined;
+        camera_make?: string | undefined;
+        camera?: string | undefined;
+    }[]>;
+    retrieve(imageId: string, bookId: string): Promise<{
+        handle: string;
+        url: string;
+        width: number;
+        height: number;
+        orientation: number;
+        taken_at: string;
+        filename: string;
+        id?: string | undefined;
+        camera_make?: string | undefined;
+        camera?: string | undefined;
+    }>;
+    update(imageId: string, bookId: string, image: ImageServer): Promise<{
+        handle: string;
+        url: string;
+        width: number;
+        height: number;
+        orientation: number;
+        taken_at: string;
+        filename: string;
+        id?: string | undefined;
+        camera_make?: string | undefined;
+        camera?: string | undefined;
+    }>;
+    delete(imageId: string, bookId: string): Promise<void>;
+    addToBook(bookId: string, image: ImageServer): Promise<{
+        handle: string;
+        url: string;
+        width: number;
+        height: number;
+        orientation: number;
+        taken_at: string;
+        filename: string;
+        id?: string | undefined;
+        camera_make?: string | undefined;
+        camera?: string | undefined;
+    }>;
+}
+
+declare const spreadServerSchema: z.ZodObject<{
+    id: z.ZodOptional<z.ZodString>;
+    book_id: z.ZodString;
+    state: z.ZodString;
+    spread_type: z.ZodString;
+    width: z.ZodOptional<z.ZodNumber>;
+    height: z.ZodOptional<z.ZodNumber>;
+    sequence: z.ZodNumber;
+    wells: z.ZodArray<z.ZodUnknown, "many">;
+    background: z.ZodUnknown;
+    laid_out_at: z.ZodNullable<z.ZodString>;
+    embellished_at: z.ZodNullable<z.ZodString>;
+    polished_at: z.ZodNullable<z.ZodString>;
+    metadata: z.ZodUnknown;
+    url: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+}, "strip", z.ZodTypeAny, {
+    state: string;
+    book_id: string;
+    spread_type: string;
+    sequence: number;
+    wells: unknown[];
+    laid_out_at: string | null;
+    embellished_at: string | null;
+    polished_at: string | null;
+    id?: string | undefined;
+    width?: number | undefined;
+    height?: number | undefined;
+    background?: unknown;
+    metadata?: unknown;
+    url?: string | null | undefined;
+}, {
+    state: string;
+    book_id: string;
+    spread_type: string;
+    sequence: number;
+    wells: unknown[];
+    laid_out_at: string | null;
+    embellished_at: string | null;
+    polished_at: string | null;
+    id?: string | undefined;
+    width?: number | undefined;
+    height?: number | undefined;
+    background?: unknown;
+    metadata?: unknown;
+    url?: string | null | undefined;
+}>;
+type SpreadServer = z.infer<typeof spreadServerSchema>;
+
+declare class SpreadsEndpoints {
+    private readonly engineAPI;
+    constructor(engineAPI: EngineAPI);
+    list(bookId: string): Promise<{
+        state: string;
+        book_id: string;
+        spread_type: string;
+        sequence: number;
+        wells: unknown[];
+        laid_out_at: string | null;
+        embellished_at: string | null;
+        polished_at: string | null;
+        id?: string | undefined;
+        width?: number | undefined;
+        height?: number | undefined;
+        background?: unknown;
+        metadata?: unknown;
+        url?: string | null | undefined;
+    }[]>;
+    create(bookId: string, spread: SpreadServer): Promise<{
+        state: string;
+        book_id: string;
+        spread_type: string;
+        sequence: number;
+        wells: unknown[];
+        laid_out_at: string | null;
+        embellished_at: string | null;
+        polished_at: string | null;
+        id?: string | undefined;
+        width?: number | undefined;
+        height?: number | undefined;
+        background?: unknown;
+        metadata?: unknown;
+        url?: string | null | undefined;
+    }>;
+    retrieve(spreadId: string, bookId: string): Promise<{
+        state: string;
+        book_id: string;
+        spread_type: string;
+        sequence: number;
+        wells: unknown[];
+        laid_out_at: string | null;
+        embellished_at: string | null;
+        polished_at: string | null;
+        id?: string | undefined;
+        width?: number | undefined;
+        height?: number | undefined;
+        background?: unknown;
+        metadata?: unknown;
+        url?: string | null | undefined;
+    }>;
+    update(spreadId: string, bookId: string, spread: SpreadServer): Promise<{
+        state: string;
+        book_id: string;
+        spread_type: string;
+        sequence: number;
+        wells: unknown[];
+        laid_out_at: string | null;
+        embellished_at: string | null;
+        polished_at: string | null;
+        id?: string | undefined;
+        width?: number | undefined;
+        height?: number | undefined;
+        background?: unknown;
+        metadata?: unknown;
+        url?: string | null | undefined;
+    }>;
+    delete(spreadId: string, bookId: string): Promise<void>;
+}
+
+declare class StoryboardItemsEndpoints {
+    private readonly engineAPI;
+    constructor(engineAPI: EngineAPI);
+    list(bookId: string): Promise<{
+        id: string;
+        book_id: string;
+        sequence: number;
+        similarity: number;
+        duplicate: boolean;
+        selected: boolean;
+        surface_weight: number;
+        scene: number;
+        subscene: number;
+        image: {
+            id: string;
+            url: string;
+            width: number;
+            height: number;
+            taken_at: number;
+            category: string;
+            aesthetic_score: number;
+            faces: {
+                score: number;
+                bounding_box: {
+                    width: number;
+                    height: number;
+                    x: number;
+                    y: number;
+                };
+                size: number;
+                eyes_open_score: number;
+                smile_score: number;
+                facing_camera_score: number;
+            }[];
+            roi: {
+                width: number;
+                height: number;
+                x: number;
+                y: number;
+            };
+        };
+        front_cover?: boolean | undefined;
+        back_cover?: boolean | undefined;
+        spine_break?: boolean | undefined;
+    }[]>;
+}
+
+declare class EngineAPI {
+    baseUrl: URL;
+    apiKey: string;
+    fetcher: Fetcher;
+    constructor(baseUrl: string, apiKey: string);
+    readonly books: BooksEndpoints;
+    readonly designOptions: DesignOptionsEndpoints;
+    readonly storyboardItems: StoryboardItemsEndpoints;
+    readonly images: ImagesEndpoints;
+    readonly spreads: SpreadsEndpoints;
+}
+
+declare class MagicBookClient {
+    private readonly apiKey;
+    private readonly apiHost;
+    readonly webSocketHost: string;
+    engineAPI: EngineAPI;
+    constructor(apiKey: string, apiHost?: string, webSocketHost?: string);
+    createDesignRequest(designRequestProps?: DesignRequestProps): Promise<DesignRequest>;
+}
+
+declare const imageDensityOptionSchema: z.ZodObject<{
+    maxPageCount: z.ZodNumber;
+    minPageCount: z.ZodNumber;
+    maxImageCount: z.ZodNumber;
+    avgImageCount: z.ZodNumber;
+    minImageCount: z.ZodNumber;
+}, "strip", z.ZodTypeAny, {
+    maxPageCount: number;
+    minPageCount: number;
+    maxImageCount: number;
+    avgImageCount: number;
+    minImageCount: number;
+}, {
+    maxPageCount: number;
+    minPageCount: number;
+    maxImageCount: number;
+    avgImageCount: number;
+    minImageCount: number;
+}>;
+type ImageDensityOption = z.infer<typeof imageDensityOptionSchema>;
+declare const imageDensityOptionsSchema: z.ZodObject<{
+    high: z.ZodObject<{
+        maxPageCount: z.ZodNumber;
+        minPageCount: z.ZodNumber;
+        maxImageCount: z.ZodNumber;
+        avgImageCount: z.ZodNumber;
+        minImageCount: z.ZodNumber;
+    }, "strip", z.ZodTypeAny, {
+        maxPageCount: number;
+        minPageCount: number;
+        maxImageCount: number;
+        avgImageCount: number;
+        minImageCount: number;
+    }, {
+        maxPageCount: number;
+        minPageCount: number;
+        maxImageCount: number;
+        avgImageCount: number;
+        minImageCount: number;
+    }>;
+    medium: z.ZodObject<{
+        maxPageCount: z.ZodNumber;
+        minPageCount: z.ZodNumber;
+        maxImageCount: z.ZodNumber;
+        avgImageCount: z.ZodNumber;
+        minImageCount: z.ZodNumber;
+    }, "strip", z.ZodTypeAny, {
+        maxPageCount: number;
+        minPageCount: number;
+        maxImageCount: number;
+        avgImageCount: number;
+        minImageCount: number;
+    }, {
+        maxPageCount: number;
+        minPageCount: number;
+        maxImageCount: number;
+        avgImageCount: number;
+        minImageCount: number;
+    }>;
+    low: z.ZodObject<{
+        maxPageCount: z.ZodNumber;
+        minPageCount: z.ZodNumber;
+        maxImageCount: z.ZodNumber;
+        avgImageCount: z.ZodNumber;
+        minImageCount: z.ZodNumber;
+    }, "strip", z.ZodTypeAny, {
+        maxPageCount: number;
+        minPageCount: number;
+        maxImageCount: number;
+        avgImageCount: number;
+        minImageCount: number;
+    }, {
+        maxPageCount: number;
+        minPageCount: number;
+        maxImageCount: number;
+        avgImageCount: number;
+        minImageCount: number;
+    }>;
+}, "strip", z.ZodTypeAny, {
+    low: {
+        maxPageCount: number;
+        minPageCount: number;
+        maxImageCount: number;
+        avgImageCount: number;
+        minImageCount: number;
+    };
+    medium: {
+        maxPageCount: number;
+        minPageCount: number;
+        maxImageCount: number;
+        avgImageCount: number;
+        minImageCount: number;
+    };
+    high: {
+        maxPageCount: number;
+        minPageCount: number;
+        maxImageCount: number;
+        avgImageCount: number;
+        minImageCount: number;
+    };
+}, {
+    low: {
+        maxPageCount: number;
+        minPageCount: number;
+        maxImageCount: number;
+        avgImageCount: number;
+        minImageCount: number;
+    };
+    medium: {
+        maxPageCount: number;
+        minPageCount: number;
+        maxImageCount: number;
+        avgImageCount: number;
+        minImageCount: number;
+    };
+    high: {
+        maxPageCount: number;
+        minPageCount: number;
+        maxImageCount: number;
+        avgImageCount: number;
+        minImageCount: number;
+    };
+}>;
+type ImageDensityOptions = z.infer<typeof imageDensityOptionsSchema>;
+declare const designOptionsSchema: z.ZodObject<{
+    densities: z.ZodObject<{
+        high: z.ZodObject<{
+            maxPageCount: z.ZodNumber;
+            minPageCount: z.ZodNumber;
+            maxImageCount: z.ZodNumber;
+            avgImageCount: z.ZodNumber;
+            minImageCount: z.ZodNumber;
+        }, "strip", z.ZodTypeAny, {
+            maxPageCount: number;
+            minPageCount: number;
+            maxImageCount: number;
+            avgImageCount: number;
+            minImageCount: number;
+        }, {
+            maxPageCount: number;
+            minPageCount: number;
+            maxImageCount: number;
+            avgImageCount: number;
+            minImageCount: number;
+        }>;
+        medium: z.ZodObject<{
+            maxPageCount: z.ZodNumber;
+            minPageCount: z.ZodNumber;
+            maxImageCount: z.ZodNumber;
+            avgImageCount: z.ZodNumber;
+            minImageCount: z.ZodNumber;
+        }, "strip", z.ZodTypeAny, {
+            maxPageCount: number;
+            minPageCount: number;
+            maxImageCount: number;
+            avgImageCount: number;
+            minImageCount: number;
+        }, {
+            maxPageCount: number;
+            minPageCount: number;
+            maxImageCount: number;
+            avgImageCount: number;
+            minImageCount: number;
+        }>;
+        low: z.ZodObject<{
+            maxPageCount: z.ZodNumber;
+            minPageCount: z.ZodNumber;
+            maxImageCount: z.ZodNumber;
+            avgImageCount: z.ZodNumber;
+            minImageCount: z.ZodNumber;
+        }, "strip", z.ZodTypeAny, {
+            maxPageCount: number;
+            minPageCount: number;
+            maxImageCount: number;
+            avgImageCount: number;
+            minImageCount: number;
+        }, {
+            maxPageCount: number;
+            minPageCount: number;
+            maxImageCount: number;
+            avgImageCount: number;
+            minImageCount: number;
+        }>;
+    }, "strip", z.ZodTypeAny, {
+        low: {
+            maxPageCount: number;
+            minPageCount: number;
+            maxImageCount: number;
+            avgImageCount: number;
+            minImageCount: number;
+        };
+        medium: {
+            maxPageCount: number;
+            minPageCount: number;
+            maxImageCount: number;
+            avgImageCount: number;
+            minImageCount: number;
+        };
+        high: {
+            maxPageCount: number;
+            minPageCount: number;
+            maxImageCount: number;
+            avgImageCount: number;
+            minImageCount: number;
+        };
+    }, {
+        low: {
+            maxPageCount: number;
+            minPageCount: number;
+            maxImageCount: number;
+            avgImageCount: number;
+            minImageCount: number;
+        };
+        medium: {
+            maxPageCount: number;
+            minPageCount: number;
+            maxImageCount: number;
+            avgImageCount: number;
+            minImageCount: number;
+        };
+        high: {
+            maxPageCount: number;
+            minPageCount: number;
+            maxImageCount: number;
+            avgImageCount: number;
+            minImageCount: number;
+        };
+    }>;
+}, "strip", z.ZodTypeAny, {
+    densities: {
+        low: {
+            maxPageCount: number;
+            minPageCount: number;
+            maxImageCount: number;
+            avgImageCount: number;
+            minImageCount: number;
+        };
+        medium: {
+            maxPageCount: number;
+            minPageCount: number;
+            maxImageCount: number;
+            avgImageCount: number;
+            minImageCount: number;
+        };
+        high: {
+            maxPageCount: number;
+            minPageCount: number;
+            maxImageCount: number;
+            avgImageCount: number;
+            minImageCount: number;
+        };
+    };
+}, {
+    densities: {
+        low: {
+            maxPageCount: number;
+            minPageCount: number;
+            maxImageCount: number;
+            avgImageCount: number;
+            minImageCount: number;
+        };
+        medium: {
+            maxPageCount: number;
+            minPageCount: number;
+            maxImageCount: number;
+            avgImageCount: number;
+            minImageCount: number;
+        };
+        high: {
+            maxPageCount: number;
+            minPageCount: number;
+            maxImageCount: number;
+            avgImageCount: number;
+            minImageCount: number;
+        };
+    };
+}>;
+type DesignOptions = z.infer<typeof designOptionsSchema>;
+declare const imageDensityOptionServerSchema: z.ZodObject<{
+    max_page_count: z.ZodNumber;
+    min_page_count: z.ZodNumber;
+    max_image_count: z.ZodNumber;
+    avg_image_count: z.ZodNumber;
+    min_image_count: z.ZodNumber;
+}, "strip", z.ZodTypeAny, {
+    max_page_count: number;
+    min_page_count: number;
+    max_image_count: number;
+    avg_image_count: number;
+    min_image_count: number;
+}, {
+    max_page_count: number;
+    min_page_count: number;
+    max_image_count: number;
+    avg_image_count: number;
+    min_image_count: number;
+}>;
+type ImageDensityOptionServer = z.infer<typeof imageDensityOptionServerSchema>;
+declare const imageDensityOptionsServerSchema: z.ZodObject<{
+    high: z.ZodObject<{
+        max_page_count: z.ZodNumber;
+        min_page_count: z.ZodNumber;
+        max_image_count: z.ZodNumber;
+        avg_image_count: z.ZodNumber;
+        min_image_count: z.ZodNumber;
+    }, "strip", z.ZodTypeAny, {
+        max_page_count: number;
+        min_page_count: number;
+        max_image_count: number;
+        avg_image_count: number;
+        min_image_count: number;
+    }, {
+        max_page_count: number;
+        min_page_count: number;
+        max_image_count: number;
+        avg_image_count: number;
+        min_image_count: number;
+    }>;
+    medium: z.ZodObject<{
+        max_page_count: z.ZodNumber;
+        min_page_count: z.ZodNumber;
+        max_image_count: z.ZodNumber;
+        avg_image_count: z.ZodNumber;
+        min_image_count: z.ZodNumber;
+    }, "strip", z.ZodTypeAny, {
+        max_page_count: number;
+        min_page_count: number;
+        max_image_count: number;
+        avg_image_count: number;
+        min_image_count: number;
+    }, {
+        max_page_count: number;
+        min_page_count: number;
+        max_image_count: number;
+        avg_image_count: number;
+        min_image_count: number;
+    }>;
+    low: z.ZodObject<{
+        max_page_count: z.ZodNumber;
+        min_page_count: z.ZodNumber;
+        max_image_count: z.ZodNumber;
+        avg_image_count: z.ZodNumber;
+        min_image_count: z.ZodNumber;
+    }, "strip", z.ZodTypeAny, {
+        max_page_count: number;
+        min_page_count: number;
+        max_image_count: number;
+        avg_image_count: number;
+        min_image_count: number;
+    }, {
+        max_page_count: number;
+        min_page_count: number;
+        max_image_count: number;
+        avg_image_count: number;
+        min_image_count: number;
+    }>;
+}, "strip", z.ZodTypeAny, {
+    low: {
+        max_page_count: number;
+        min_page_count: number;
+        max_image_count: number;
+        avg_image_count: number;
+        min_image_count: number;
+    };
+    medium: {
+        max_page_count: number;
+        min_page_count: number;
+        max_image_count: number;
+        avg_image_count: number;
+        min_image_count: number;
+    };
+    high: {
+        max_page_count: number;
+        min_page_count: number;
+        max_image_count: number;
+        avg_image_count: number;
+        min_image_count: number;
+    };
+}, {
+    low: {
+        max_page_count: number;
+        min_page_count: number;
+        max_image_count: number;
+        avg_image_count: number;
+        min_image_count: number;
+    };
+    medium: {
+        max_page_count: number;
+        min_page_count: number;
+        max_image_count: number;
+        avg_image_count: number;
+        min_image_count: number;
+    };
+    high: {
+        max_page_count: number;
+        min_page_count: number;
+        max_image_count: number;
+        avg_image_count: number;
+        min_image_count: number;
+    };
+}>;
+type ImageDensityOptionsServer = z.infer<typeof imageDensityOptionsServerSchema>;
+declare const designOptionsServerSchema: z.ZodObject<{
+    densities: z.ZodObject<{
+        high: z.ZodObject<{
+            max_page_count: z.ZodNumber;
+            min_page_count: z.ZodNumber;
+            max_image_count: z.ZodNumber;
+            avg_image_count: z.ZodNumber;
+            min_image_count: z.ZodNumber;
+        }, "strip", z.ZodTypeAny, {
+            max_page_count: number;
+            min_page_count: number;
+            max_image_count: number;
+            avg_image_count: number;
+            min_image_count: number;
+        }, {
+            max_page_count: number;
+            min_page_count: number;
+            max_image_count: number;
+            avg_image_count: number;
+            min_image_count: number;
+        }>;
+        medium: z.ZodObject<{
+            max_page_count: z.ZodNumber;
+            min_page_count: z.ZodNumber;
+            max_image_count: z.ZodNumber;
+            avg_image_count: z.ZodNumber;
+            min_image_count: z.ZodNumber;
+        }, "strip", z.ZodTypeAny, {
+            max_page_count: number;
+            min_page_count: number;
+            max_image_count: number;
+            avg_image_count: number;
+            min_image_count: number;
+        }, {
+            max_page_count: number;
+            min_page_count: number;
+            max_image_count: number;
+            avg_image_count: number;
+            min_image_count: number;
+        }>;
+        low: z.ZodObject<{
+            max_page_count: z.ZodNumber;
+            min_page_count: z.ZodNumber;
+            max_image_count: z.ZodNumber;
+            avg_image_count: z.ZodNumber;
+            min_image_count: z.ZodNumber;
+        }, "strip", z.ZodTypeAny, {
+            max_page_count: number;
+            min_page_count: number;
+            max_image_count: number;
+            avg_image_count: number;
+            min_image_count: number;
+        }, {
+            max_page_count: number;
+            min_page_count: number;
+            max_image_count: number;
+            avg_image_count: number;
+            min_image_count: number;
+        }>;
+    }, "strip", z.ZodTypeAny, {
+        low: {
+            max_page_count: number;
+            min_page_count: number;
+            max_image_count: number;
+            avg_image_count: number;
+            min_image_count: number;
+        };
+        medium: {
+            max_page_count: number;
+            min_page_count: number;
+            max_image_count: number;
+            avg_image_count: number;
+            min_image_count: number;
+        };
+        high: {
+            max_page_count: number;
+            min_page_count: number;
+            max_image_count: number;
+            avg_image_count: number;
+            min_image_count: number;
+        };
+    }, {
+        low: {
+            max_page_count: number;
+            min_page_count: number;
+            max_image_count: number;
+            avg_image_count: number;
+            min_image_count: number;
+        };
+        medium: {
+            max_page_count: number;
+            min_page_count: number;
+            max_image_count: number;
+            avg_image_count: number;
+            min_image_count: number;
+        };
+        high: {
+            max_page_count: number;
+            min_page_count: number;
+            max_image_count: number;
+            avg_image_count: number;
+            min_image_count: number;
+        };
+    }>;
+}, "strip", z.ZodTypeAny, {
+    densities: {
+        low: {
+            max_page_count: number;
+            min_page_count: number;
+            max_image_count: number;
+            avg_image_count: number;
+            min_image_count: number;
+        };
+        medium: {
+            max_page_count: number;
+            min_page_count: number;
+            max_image_count: number;
+            avg_image_count: number;
+            min_image_count: number;
+        };
+        high: {
+            max_page_count: number;
+            min_page_count: number;
+            max_image_count: number;
+            avg_image_count: number;
+            min_image_count: number;
+        };
+    };
+}, {
+    densities: {
+        low: {
+            max_page_count: number;
+            min_page_count: number;
+            max_image_count: number;
+            avg_image_count: number;
+            min_image_count: number;
+        };
+        medium: {
+            max_page_count: number;
+            min_page_count: number;
+            max_image_count: number;
+            avg_image_count: number;
+            min_image_count: number;
+        };
+        high: {
+            max_page_count: number;
+            min_page_count: number;
+            max_image_count: number;
+            avg_image_count: number;
+            min_image_count: number;
+        };
+    };
+}>;
+type DesignOptionsServer = z.infer<typeof designOptionsServerSchema>;
+
+export { BookSize, CoverType, DesignOptions, DesignOptionsServer, DesignRequest, DesignRequestEvent, DesignRequestEventDetail, DesignRequestOptions, DesignRequestProps, EmbellishmentLevel, Image, ImageDensity, ImageDensityOption, ImageDensityOptionServer, ImageDensityOptions, ImageDensityOptionsServer, ImageFilteringLevel, ImageServer, Images, MagicBookClient, Occasion, PageType, State, Style, TextStickerLevel, designOptionsSchema, designOptionsServerSchema, imageDensityOptionSchema, imageDensityOptionServerSchema, imageDensityOptionsSchema, imageDensityOptionsServerSchema, imageServerSchema };