@magiclabs.ai/magicbook-client 0.7.5 → 0.7.6

package/README.md

@@ -1,4 +1,3 @@
-
 ![GitHub CI](https://github.com/magiclabs-ai/mb-client/actions/workflows/ci.yml/badge.svg) [![npm version](https://img.shields.io/npm/v/@magiclabs.ai/magicbook-client.svg)](https://www.npmjs.com/package/@magiclabs.ai/magicbook-client)
 
 # magicbook-client
@@ -13,7 +12,7 @@ npm install @magiclabs.ai/magicbook-client
 
 ## Usage
 
-Create a Magicbook API client instance with your API key. 
+Create a Magicbook API client instance with your API key.
 
 ```ts
 const client = new MagicBookClient('api-key')`
@@ -37,13 +36,14 @@ Individual parameters can also be set directly on the design request instance (e
 
 ```ts
 const designRequest = await client.createDesignRequest()
-designRequest.title = 'Australia 2023',
-designRequest.occasion = 'travel',
-designRequest.style = '1234',
-designRequest.bookSize = '8x8',
-designRequest.coverType = 'hc',
-designRequest.pageType = 'sp'
+;(designRequest.title = 'Australia 2023'),
+  (designRequest.occasion = 'travel'),
+  (designRequest.style = '1234'),
+  (designRequest.bookSize = '8x8'),
+  (designRequest.coverType = 'hc'),
+  (designRequest.pageType = 'sp')
 ```
+
 As images are getting ready to be handed over to Magicbook, for example when successfully uploaded, add them to the design request object.
 
 ```ts
@@ -73,9 +73,12 @@ const designOptions = designRequest.getOptions(selectedImageCount)
 Before submitting the design request to Magicbook, register a callback to receive update events.
 
 ```ts
-window.addEventListener('Magicbook.designRequestUpdated', async ((designRequestEvent: DesignRequestEvent) => {
-  console.log(designRequestEvent.detail)
-}) as EventListener)
+window.addEventListener(
+  'Magicbook.designRequestUpdated',
+  async((designRequestEvent: DesignRequestEvent) => {
+    console.log(designRequestEvent.detail)
+  }) as EventListener
+)
 ```
 
 Submit the design request. Again, the argument object can receive additional or updated design parameters.
@@ -102,13 +105,19 @@ Once the design request is complete, retrieve it in JSON format.
 await designRequest.getJSON()
 ```
 
+You can get alternate layouts for a specific page.
+
+```ts
+await designRequest.getAlternateLayouts(-1)
+```
+
 When a user performs a specific action, log it by calling the `logEvent` method.
 
 ```ts
 await designRequest.logEvent('book.viewed', data)
 ```
 
-___
+---
 
 ## Example
 

package/index.cjs

@@ -4349,15 +4349,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");
@@ -4365,9 +4374,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;
     }
@@ -4882,6 +4889,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