npm - @magiclabs.ai/magicbook-client - Versions diffs - 0.7.9-canary → 0.7.10-canary - Mend

@magiclabs.ai/magicbook-client 0.7.9-canary → 0.7.10-canary

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (9) hide show

package/README.md CHANGED Viewed

@@ -2,7 +2,7 @@
 # magicbook-client
-TypeScript package to create photo books with the Magicbook API.
+TypeScript package to create photo books with the MagicBook API.
 ## Installation
@@ -12,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')`
@@ -44,7 +44,7 @@ const designRequest = await client.createDesignRequest()
   (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.
+As images are getting ready to be handed over to MagicBook, for example when successfully uploaded, add them to the design request object.
 ```ts
 import {Image} from '@magiclabs.ai/magicbook-client'
@@ -70,11 +70,11 @@ const selectedImageCount = 200
 const designOptions = designRequest.getOptions(selectedImageCount)
 ```
-Before submitting the design request to Magicbook, register a callback to receive update events.
+Before submitting the design request to MagicBook, register a callback to receive update events.
 ```ts
 window.addEventListener(
-  'Magicbook.designRequestUpdated',
+  'MagicBook.designRequestUpdated',
   async((designRequestEvent: DesignRequestEvent) => {
     console.log(designRequestEvent.detail)
   }) as EventListener
@@ -106,10 +106,10 @@ Once the design request is complete, retrieve it in JSON format.
 await designRequest.getJSON(format)
 ```
-You can get alternate layouts for a specific page.
+You can get alternate layouts for a specific page. Optionally, you can pass surfaceCategoryName if your style supports it (only Snapfish).
 ```ts
-await designRequest.getAlternateLayouts(-1)
+await designRequest.getAlternateLayouts(-1, 'cover' | 'inside')
 ```
 When a user performs a specific action, log it by calling the `logEvent` method.
@@ -120,9 +120,28 @@ await designRequest.logEvent('book.viewed', data)
 ---
+## Usage as script
+```html
+<!doctype html>
+<html>
+  <head>
+    <script
+      type="text/javascript"
+      src="../node_modules/@magiclabs-ai/magicbook-client
+/index.iife.js"
+    ></script>
+  </head>
+  <script type="text/javascript">
+    const client = new MagicLabs.MagicBookClient('api-key')
+    ...
+  </script>
+</html>
+```
 ## Example
-To see the Magicbook client in action, run the following commands (make sure you created a `.env` file before building):
+To see the MagicBook client in action, run the following commands (make sure you created a `.env` file before building):
 ```bash
 npm run build

package/index.cjs CHANGED Viewed

@@ -34,7 +34,6 @@ __export(src_exports, {
   bookSizes: () => bookSizes,
   canSubmitDesignRequest: () => canSubmitDesignRequest,
   cancelledEventDetail: () => cancelledEventDetail,
-  canvasSchema: () => canvasSchema,
   coverTypes: () => coverTypes,
   designOptionsSchema: () => designOptionsSchema,
   designOptionsServerSchema: () => designOptionsServerSchema,
@@ -59,10 +58,13 @@ __export(src_exports, {
   positionSchema: () => positionSchema,
   propertySchema: () => propertySchema,
   reportingDataSchema: () => reportingDataSchema,
+  sflyCanvasSchema: () => sflyCanvasSchema,
+  snapCanvasSchema: () => snapCanvasSchema,
   states: () => states,
   statesToCloseWS: () => statesToCloseWS,
   statesToReport: () => statesToReport,
   styles: () => styles,
+  surfaceCategoryNames: () => surfaceCategoryNames,
   textStickerLevels: () => textStickerLevels,
   timeoutEventDetail: () => timeoutEventDetail
 });
@@ -387,16 +389,7 @@ var styles = {
   "03f332e3b2b947ebae73b67a9a22b6f4": { slug: "winter-sparkle-snap" },
   "97f70f6cdb5244a08d45772cccfa2788": { slug: "year-of-memories-snap" }
 };
-var bookSizes = [
-  "5x7",
-  "6x6",
-  "8x8",
-  "10x10",
-  "12x12",
-  "8x11",
-  "11x8",
-  "11x14"
-];
+var bookSizes = ["5x7", "6x6", "8x8", "10x10", "12x12", "8x11", "11x8", "11x14"];
 var coverTypes = ["sc", "hc", "pl"];
 var pageTypes = ["sp", "sl", "dl"];
 var imageDensities = ["low", "medium", "high"];
@@ -416,6 +409,7 @@ var cancelledEventDetail = {
   message: "Design canceled"
 };
 var formats = ["galleon", "snapfish"];
+var surfaceCategoryNames = ["inside", "cover"];
 // ../../core/utils/toolbox.ts
 function mergeNestedObject(obj, objToMerge) {
@@ -4672,9 +4666,9 @@ var DesignRequest = class {
     );
     return options;
   }
-  async getAlternateLayouts(pageNumber) {
+  async getAlternateLayouts(pageNumber, surfaceCategoryName) {
     if (this.state === "ready") {
-      return await this.client.engineAPI.spreads.layouts(this.parentId, pageNumber);
+      return await this.client.engineAPI.spreads.layouts(this.parentId, pageNumber, surfaceCategoryName);
     } else {
       throw new Error("Design request not ready");
     }
@@ -5122,14 +5116,19 @@ var photoStripSchema = z.object({
 var reportingDataSchema = z.object({
   properties: z.array(propertySchema)
 });
-var canvasSchema = z.object({
+var sflyCanvasSchema = z.object({
   backgroundId: z.string().nullable(),
   assets: z.array(assetSchema).optional()
 });
+var snapCanvasSchema = z.object({
+  surfaceNumber: z.number(),
+  surfaceData: z.record(z.any()),
+  version: z.string()
+});
 var pageSchema = z.object({
   pageNum: z.number(),
   type: z.string(),
-  canvas: canvasSchema
+  canvas: sflyCanvasSchema
 });
 var magicShopBookSchema = z.object({
   pages: z.array(pageSchema),
@@ -5202,7 +5201,7 @@ var SpreadsEndpoints = class {
       });
     });
   }
-  layouts(bookId, page) {
+  layouts(bookId, page, surfaceCategoryName) {
     return handleAsyncFunction(async () => {
       const res = await this.engineAPI.fetcher.call({
         path: "/v1/spreads/layouts",
@@ -5210,11 +5209,12 @@ var SpreadsEndpoints = class {
           method: "POST",
           body: cleanJSON({
             user_id: bookId,
-            page_num: page
+            page_num: page,
+            surfaceCategoryName
           })
         }
       });
-      return z.array(canvasSchema).parse(res);
+      return z.array(surfaceCategoryName ? snapCanvasSchema : sflyCanvasSchema).parse(res);
     });
   }
 };
@@ -5387,7 +5387,6 @@ var MagicBookClient = class {
   bookSizes,
   canSubmitDesignRequest,
   cancelledEventDetail,
-  canvasSchema,
   coverTypes,
   designOptionsSchema,
   designOptionsServerSchema,
@@ -5412,10 +5411,13 @@ var MagicBookClient = class {
   positionSchema,
   propertySchema,
   reportingDataSchema,
+  sflyCanvasSchema,
+  snapCanvasSchema,
   states,
   statesToCloseWS,
   statesToReport,
   styles,
+  surfaceCategoryNames,
   textStickerLevels,
   timeoutEventDetail
 });