@magiclabs.ai/magicbook-client 0.6.13-canary → 0.6.14-canary

package/README.md

@@ -94,14 +94,19 @@ After submitting you can set a GUID to the design request.
 await designRequest.setGuid('a9ccb406-015a-47df-bb59-ea171b8617ca')
 ```
 
-Finally, once the design request is complete, retrieve it in JSON format.
+Once the design request is complete, retrieve it in JSON format.
 
 ```ts
 await designRequest.getJSON()
 ```
 
-___
+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

@@ -20,6 +20,8 @@ var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: tru
 // src/index.ts
 var src_exports = {};
 __export(src_exports, {
+  Book: () => Book,
+  BookDesignRequest: () => BookDesignRequest,
   DesignRequest: () => DesignRequest,
   DesignRequestOptions: () => DesignRequestOptions,
   ImageServer: () => ImageServer,
@@ -27,6 +29,8 @@ __export(src_exports, {
   MagicBookClient: () => MagicBookClient,
   assetSchema: () => assetSchema,
   bookCreationRequestSchema: () => bookCreationRequestSchema,
+  bookDesignRequestSchema: () => bookDesignRequestSchema,
+  bookPropsSchema: () => bookPropsSchema,
   bookSizes: () => bookSizes,
   cancelledEventDetail: () => cancelledEventDetail,
   canvasSchema: () => canvasSchema,
@@ -4073,14 +4077,15 @@ var bookDesignRequestSchema = z.object({
   embellishment_level: z.enum(embellishmentLevels),
   text_sticker_level: z.enum(textStickerLevels)
 });
-var BookPropsSchema = z.object({
+var bookPropsSchema = z.object({
   id: z.string().optional(),
   title: z.string(),
   subtitle: z.string().optional(),
   design_request: bookDesignRequestSchema,
   state: z.enum(states).optional(),
   guid: z.string().optional(),
-  cancelled_at: z.string().optional()
+  cancelled_at: z.string().optional(),
+  mb_client_timeout: z.number().optional()
 });
 var Book = class {
   id;
@@ -4090,6 +4095,7 @@ var Book = class {
   state;
   guid;
   cancelled_at;
+  timeout;
   constructor(props) {
     this.id = props.id || "";
     this.title = props.title;
@@ -4098,6 +4104,7 @@ var Book = class {
     this.state = props.state;
     this.guid = props.guid;
     this.cancelled_at = props.cancelled_at;
+    this.timeout = props.mb_client_timeout ? props.mb_client_timeout * 1e3 : void 0;
   }
   toDesignRequestProps() {
     const props = { ...this, ...this.design_request };
@@ -4105,6 +4112,12 @@ var Book = class {
     delete props.design_request;
     return snakeCaseObjectKeysToCamelCase(props);
   }
+  toBookProps() {
+    return {
+      ...this,
+      mb_client_timeout: this.timeout ? this.timeout / 1e3 : void 0
+    };
+  }
 };
 
 // ../../core/models/design-request/image.ts
@@ -4195,11 +4208,6 @@ var designOptionsServerSchema = z.object({
   densities: imageDensityOptionsServerSchema
 });
 
-// ../../core/config.ts
-var defaultApiHost = "https://api.dev-sls.magicbook.io";
-var defaultWebSocketHost = "wss://socket.dev-sls.magicbook.io";
-var designRequestTimeout = parseInt("30000"?.toString() || "3000");
-
 // ../../core/models/design-request/index.ts
 var DesignRequestOptions = {
   occasion: occasions,
@@ -4248,6 +4256,7 @@ var DesignRequest = class {
   textStickerLevel;
   images;
   guid;
+  timeout;
   updateDesignRequest(designRequestProps) {
     Object.assign(this, designRequestProps);
   }
@@ -4266,10 +4275,10 @@ var DesignRequest = class {
       throw new Error("Design request already submitted");
     } else {
       submitDesignRequestProps && Object.assign(this, submitDesignRequestProps);
-      this.getProgress();
       this.updateDesignRequest(
         (await this.client.engineAPI.books.update(this.parentId, this.toBook())).toDesignRequestProps()
       );
+      this.getProgress();
       this.state = states[1];
       return this;
     }
@@ -4308,6 +4317,9 @@ var DesignRequest = class {
       throw new Error("Design request not ready");
     }
   }
+  async logEvent(name, data) {
+    return await this.client.engineAPI.events.createBookEvent(this.parentId, name, data);
+  }
   async eventHandler(detail, type = "MagicBook.designRequestUpdated") {
     const customEvent = new CustomEvent(type, { detail });
     if (statesToCloseWS.includes(detail.slug)) {
@@ -4323,9 +4335,13 @@ var DesignRequest = class {
     window.dispatchEvent(customEvent);
   }
   timeoutHandler() {
-    return setTimeout(async () => {
-      await this.eventHandler(timeoutEventDetail);
-    }, designRequestTimeout);
+    if (this.timeout) {
+      return setTimeout(async () => {
+        await this.eventHandler(timeoutEventDetail);
+      }, this.timeout);
+    } else {
+      throw new Error("Design request timeout not set");
+    }
   }
   async getProgress() {
     let timeout;
@@ -4452,14 +4468,14 @@ var BooksEndpoints = class {
           method: "POST"
         }
       });
-      BookPropsSchema.safeParse(res);
+      bookPropsSchema.safeParse(res);
       return new Book(res);
     });
   }
   retrieve(bookId) {
     return handleAsyncFunction(async () => {
       const res = await this.engineAPI.fetcher.call({ path: `/v1/books/${bookId}` });
-      BookPropsSchema.safeParse(res);
+      bookPropsSchema.safeParse(res);
       return new Book(res);
     });
   }
@@ -4472,7 +4488,7 @@ var BooksEndpoints = class {
           body: cleanJSON(book)
         }
       });
-      BookPropsSchema.safeParse(res);
+      bookPropsSchema.safeParse(res);
       return new Book(res);
     });
   }
@@ -4482,7 +4498,7 @@ var BooksEndpoints = class {
         path: `/v1/books/${bookId}/cancel`,
         options: { method: "POST" }
       });
-      BookPropsSchema.safeParse(res);
+      bookPropsSchema.safeParse(res);
       return new Book(res);
     });
   }
@@ -4533,6 +4549,38 @@ var DesignOptionsEndpoints = class {
   }
 };
 
+// ../../core/models/event.ts
+var eventContextSchema = z.record(z.string(), z.unknown()).optional();
+var eventSchema = z.object({
+  name: z.string(),
+  context: eventContextSchema
+});
+
+// ../../core/models/engine-api/endpoints/events.ts
+var EventsEndpoints = class {
+  // eslint-disable-next-line no-unused-vars
+  constructor(engineAPI) {
+    this.engineAPI = engineAPI;
+    bindThisToFunctions(this);
+  }
+  createBookEvent(bookId, name, data) {
+    return handleAsyncFunction(async () => {
+      const body = {
+        name
+      };
+      data && (body["context"] = data);
+      const res = await this.engineAPI.fetcher.call({
+        path: `/v1/events/book/${bookId}`,
+        options: {
+          method: "POST",
+          body: cleanJSON(body)
+        }
+      });
+      return eventSchema.parse(res);
+    });
+  }
+};
+
 // ../../core/models/fetcher.ts
 var baseOptions = {
   headers: {
@@ -4854,11 +4902,16 @@ var EngineAPI = class {
   }
   books = new BooksEndpoints(this);
   designOptions = new DesignOptionsEndpoints(this);
-  storyboardItems = new StoryboardItemsEndpoints(this);
+  events = new EventsEndpoints(this);
   images = new ImagesEndpoints(this);
+  storyboardItems = new StoryboardItemsEndpoints(this);
   spreads = new SpreadsEndpoints(this);
 };
 
+// ../../core/config.ts
+var defaultApiHost = "https://api.dev-sls.magicbook.io";
+var defaultWebSocketHost = "wss://socket.dev-sls.magicbook.io";
+
 // ../../core/models/client.ts
 var MagicBookClient = class {
   constructor(apiKey, apiHost = defaultApiHost, webSocketHost = defaultWebSocketHost) {
@@ -4875,6 +4928,8 @@ var MagicBookClient = class {
 };
 // Annotate the CommonJS export names for ESM import in node:
 0 && (module.exports = {
+  Book,
+  BookDesignRequest,
   DesignRequest,
   DesignRequestOptions,
   ImageServer,
@@ -4882,6 +4937,8 @@ var MagicBookClient = class {
   MagicBookClient,
   assetSchema,
   bookCreationRequestSchema,
+  bookDesignRequestSchema,
+  bookPropsSchema,
   bookSizes,
   cancelledEventDetail,
   canvasSchema,