@magiclabs.ai/magicbook-client 0.7.5 → 0.7.6-canary

package/index.d.cts

@@ -304,6 +304,33 @@ declare class SpreadsEndpoints {
         url?: string | null | undefined;
     }>;
     delete(spreadId: string, bookId: string): Promise<void>;
+    layouts(bookId: string, page: number): Promise<{
+        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;
+    }[]>;
 }
 
 declare class StoryboardItemsEndpoints {
@@ -974,15 +1001,15 @@ declare const textStickerLevels: readonly ["none", "few", "lots"];
 declare const timeoutEventDetail: DesignRequestEventDetail;
 declare const cancelledEventDetail: DesignRequestEventDetail;
 
-type Occasion = typeof occasions[number];
+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];
+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[];
@@ -1009,7 +1036,7 @@ type DesignRequestProps = {
     textStickerLevel?: TextStickerLevel;
     userId: string;
 };
-type State = typeof states[number];
+type State = (typeof states)[number];
 type DesignRequestEventDetail = {
     state: string;
     slug: State;
@@ -1064,6 +1091,33 @@ declare class DesignRequest {
             };
         };
     }>;
+    getAlternateLayouts(pageNumber: number): Promise<{
+        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;
+    }[]>;
     submit(submitDesignRequestProps?: Partial<DesignRequestProps>): Promise<this>;
     setGuid(guid: string): Promise<string>;
     cancel(): Promise<this>;

package/index.d.ts

@@ -304,6 +304,33 @@ declare class SpreadsEndpoints {
         url?: string | null | undefined;
     }>;
     delete(spreadId: string, bookId: string): Promise<void>;
+    layouts(bookId: string, page: number): Promise<{
+        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;
+    }[]>;
 }
 
 declare class StoryboardItemsEndpoints {
@@ -974,15 +1001,15 @@ declare const textStickerLevels: readonly ["none", "few", "lots"];
 declare const timeoutEventDetail: DesignRequestEventDetail;
 declare const cancelledEventDetail: DesignRequestEventDetail;
 
-type Occasion = typeof occasions[number];
+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];
+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[];
@@ -1009,7 +1036,7 @@ type DesignRequestProps = {
     textStickerLevel?: TextStickerLevel;
     userId: string;
 };
-type State = typeof states[number];
+type State = (typeof states)[number];
 type DesignRequestEventDetail = {
     state: string;
     slug: State;
@@ -1064,6 +1091,33 @@ declare class DesignRequest {
             };
         };
     }>;
+    getAlternateLayouts(pageNumber: number): Promise<{
+        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;
+    }[]>;
     submit(submitDesignRequestProps?: Partial<DesignRequestProps>): Promise<this>;
     setGuid(guid: string): Promise<string>;
     cancel(): Promise<this>;

package/index.js

@@ -4280,15 +4280,24 @@ var DesignRequest = class {
     }
   }
   async getOptions(imageCount) {
-    const options = designOptionsSchema.parse(snakeCaseObjectKeysToCamelCase(
-      await this.client.engineAPI.designOptions.retrieve(
-        this.bookSize,
-        imageCount || this.images.length,
-        this.imageFilteringLevel
+    const options = designOptionsSchema.parse(
+      snakeCaseObjectKeysToCamelCase(
+        await this.client.engineAPI.designOptions.retrieve(
+          this.bookSize,
+          imageCount || this.images.length,
+          this.imageFilteringLevel
+        )
       )
-    ));
+    );
     return options;
   }
+  async getAlternateLayouts(pageNumber) {
+    if (this.state === "ready") {
+      return await this.client.engineAPI.spreads.layouts(this.parentId, pageNumber);
+    } else {
+      throw new Error("Design request not ready");
+    }
+  }
   async submit(submitDesignRequestProps) {
     if (!canSubmitDesignRequest(this.state)) {
       throw new Error("You need to wait for the current design request to be ready before submitting a new one");
@@ -4296,9 +4305,7 @@ var DesignRequest = class {
       submitDesignRequestProps && this.updateDesignRequest(submitDesignRequestProps);
       this.webSocket = new WebSocket(`${this.client.webSocketHost}/?book_id=${this.parentId}`);
       await this.client.engineAPI.books.update(this.parentId, this.toBook());
-      this.updateDesignRequest(
-        (await this.client.engineAPI.books.design(this.parentId)).toDesignRequestProps()
-      );
+      this.updateDesignRequest((await this.client.engineAPI.books.design(this.parentId)).toDesignRequestProps());
       this.getProgress();
       return this;
     }
@@ -4813,6 +4820,21 @@ var SpreadsEndpoints = class {
       });
     });
   }
+  layouts(bookId, page) {
+    return handleAsyncFunction(async () => {
+      const res = await this.engineAPI.fetcher.call({
+        path: "/v1/spreads/layouts",
+        options: {
+          method: "POST",
+          body: cleanJSON({
+            user_id: bookId,
+            page_num: page
+          })
+        }
+      });
+      return z.array(canvasSchema).parse(res);
+    });
+  }
 };
 
 // ../../core/models/storyboard-item.ts