@magiclabs.ai/magicbook-client 0.7.3 → 0.7.4

package/index.d.cts

@@ -9,6 +9,7 @@ declare class BooksEndpoints {
     create(book: Partial<Book>): Promise<Book>;
     retrieve(bookId: string): Promise<Book>;
     update(bookId: string, book: Partial<Book>): Promise<Book>;
+    design(bookId: string): Promise<Book>;
     cancel(bookId: string): Promise<Book>;
     report(bookId: string, report: BookReport): Promise<void>;
     delete(bookId: string): Promise<void>;
@@ -390,7 +391,8 @@ declare class Images {
     private parentId;
     private images;
     length: number;
-    constructor(client: MagicBookClient, parentId: string);
+    designRequestState: State;
+    constructor(client: MagicBookClient, parentId: string, designRequestState: State);
     add(image: Image): Promise<number>;
 }
 declare const imageServerSchema: z.ZodObject<{
@@ -444,6 +446,7 @@ declare const states: readonly ["new", "ingesting", "submitted", "storyboarding"
 declare const statesToCloseWS: ReadonlyArray<typeof states[number]>;
 declare const statesToReport: ReadonlyArray<typeof states[number]>;
 declare const isDesignRequestSubmitted: (state: string) => boolean;
+declare const canSubmitDesignRequest: (state: string) => boolean;
 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: {
@@ -1008,7 +1011,7 @@ type DesignRequestEventDetail = {
 };
 type DesignRequestEvent = CustomEvent<DesignRequestEventDetail>;
 declare class DesignRequest {
-    private readonly parentId;
+    readonly parentId: string;
     private readonly client;
     state: State;
     title: string;
@@ -1232,6 +1235,7 @@ declare const bookPropsSchema: z.ZodObject<{
     cancelled_at: z.ZodOptional<z.ZodString>;
     mb_client_timeout: z.ZodOptional<z.ZodNumber>;
     user_id: z.ZodOptional<z.ZodString>;
+    revision: z.ZodOptional<z.ZodNumber>;
 }, "strip", z.ZodTypeAny, {
     title: string;
     design_request: {
@@ -1252,6 +1256,7 @@ declare const bookPropsSchema: z.ZodObject<{
     cancelled_at?: string | undefined;
     mb_client_timeout?: number | undefined;
     user_id?: string | undefined;
+    revision?: number | undefined;
 }, {
     title: string;
     design_request: {
@@ -1272,11 +1277,13 @@ declare const bookPropsSchema: z.ZodObject<{
     cancelled_at?: string | undefined;
     mb_client_timeout?: number | undefined;
     user_id?: string | undefined;
+    revision?: number | undefined;
 }>;
 type BookProps = z.infer<typeof bookPropsSchema>;
 declare class Book {
     id: string;
     title: string;
+    revision?: number;
     subtitle?: string;
     design_request: BookDesignRequest;
     state?: State;
@@ -3458,4 +3465,4 @@ declare const bookCreationRequestSchema: z.ZodObject<{
 }>;
 type BookCreationRequest = z.infer<typeof bookCreationRequestSchema>;
 
-export { Asset, Book, BookCreationRequest, BookDesignRequest, BookDesignRequestProps, BookProps, BookReport, BookSize, Canvas, CoverType, DesignOptions, DesignOptionsServer, DesignRequest, DesignRequestEvent, DesignRequestEventDetail, DesignRequestOptions, DesignRequestProps, EmbellishmentLevel, Image, ImageAssignment, ImageDensity, ImageDensityOption, ImageDensityOptionServer, ImageDensityOptions, ImageDensityOptionsServer, ImageFilteringLevel, ImageServer, Images, MagicBookClient, MagicShopBook, Occasion, Page, PageType, PhotoMetadata, PhotoStrip, Position, Property, ReportingData, State, Style, TextStickerLevel, assetSchema, bookCreationRequestSchema, bookDesignRequestSchema, bookPropsSchema, bookSizes, cancelledEventDetail, canvasSchema, coverTypes, designOptionsSchema, designOptionsServerSchema, embellishmentLevels, imageAssignmentSchema, imageDensities, imageDensityOptionSchema, imageDensityOptionServerSchema, imageDensityOptionsSchema, imageDensityOptionsServerSchema, imageFilteringLevels, imageServerSchema, isDesignRequestSubmitted, magicShopBookSchema, occasions, pageSchema, pageTypes, photoMetadataSchema, photoStripSchema, positionSchema, propertySchema, reportingDataSchema, states, statesToCloseWS, statesToReport, styles, textStickerLevels, timeoutEventDetail };
+export { Asset, Book, BookCreationRequest, BookDesignRequest, BookDesignRequestProps, BookProps, BookReport, BookSize, Canvas, CoverType, DesignOptions, DesignOptionsServer, DesignRequest, DesignRequestEvent, DesignRequestEventDetail, DesignRequestOptions, DesignRequestProps, EmbellishmentLevel, Image, ImageAssignment, ImageDensity, ImageDensityOption, ImageDensityOptionServer, ImageDensityOptions, ImageDensityOptionsServer, ImageFilteringLevel, ImageServer, Images, MagicBookClient, MagicShopBook, Occasion, Page, PageType, PhotoMetadata, PhotoStrip, Position, Property, ReportingData, State, Style, TextStickerLevel, assetSchema, bookCreationRequestSchema, bookDesignRequestSchema, bookPropsSchema, bookSizes, canSubmitDesignRequest, cancelledEventDetail, canvasSchema, coverTypes, designOptionsSchema, designOptionsServerSchema, embellishmentLevels, imageAssignmentSchema, imageDensities, imageDensityOptionSchema, imageDensityOptionServerSchema, imageDensityOptionsSchema, imageDensityOptionsServerSchema, imageFilteringLevels, imageServerSchema, isDesignRequestSubmitted, magicShopBookSchema, occasions, pageSchema, pageTypes, photoMetadataSchema, photoStripSchema, positionSchema, propertySchema, reportingDataSchema, states, statesToCloseWS, statesToReport, styles, textStickerLevels, timeoutEventDetail };

package/index.d.ts

@@ -9,6 +9,7 @@ declare class BooksEndpoints {
     create(book: Partial<Book>): Promise<Book>;
     retrieve(bookId: string): Promise<Book>;
     update(bookId: string, book: Partial<Book>): Promise<Book>;
+    design(bookId: string): Promise<Book>;
     cancel(bookId: string): Promise<Book>;
     report(bookId: string, report: BookReport): Promise<void>;
     delete(bookId: string): Promise<void>;
@@ -390,7 +391,8 @@ declare class Images {
     private parentId;
     private images;
     length: number;
-    constructor(client: MagicBookClient, parentId: string);
+    designRequestState: State;
+    constructor(client: MagicBookClient, parentId: string, designRequestState: State);
     add(image: Image): Promise<number>;
 }
 declare const imageServerSchema: z.ZodObject<{
@@ -444,6 +446,7 @@ declare const states: readonly ["new", "ingesting", "submitted", "storyboarding"
 declare const statesToCloseWS: ReadonlyArray<typeof states[number]>;
 declare const statesToReport: ReadonlyArray<typeof states[number]>;
 declare const isDesignRequestSubmitted: (state: string) => boolean;
+declare const canSubmitDesignRequest: (state: string) => boolean;
 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: {
@@ -1008,7 +1011,7 @@ type DesignRequestEventDetail = {
 };
 type DesignRequestEvent = CustomEvent<DesignRequestEventDetail>;
 declare class DesignRequest {
-    private readonly parentId;
+    readonly parentId: string;
     private readonly client;
     state: State;
     title: string;
@@ -1232,6 +1235,7 @@ declare const bookPropsSchema: z.ZodObject<{
     cancelled_at: z.ZodOptional<z.ZodString>;
     mb_client_timeout: z.ZodOptional<z.ZodNumber>;
     user_id: z.ZodOptional<z.ZodString>;
+    revision: z.ZodOptional<z.ZodNumber>;
 }, "strip", z.ZodTypeAny, {
     title: string;
     design_request: {
@@ -1252,6 +1256,7 @@ declare const bookPropsSchema: z.ZodObject<{
     cancelled_at?: string | undefined;
     mb_client_timeout?: number | undefined;
     user_id?: string | undefined;
+    revision?: number | undefined;
 }, {
     title: string;
     design_request: {
@@ -1272,11 +1277,13 @@ declare const bookPropsSchema: z.ZodObject<{
     cancelled_at?: string | undefined;
     mb_client_timeout?: number | undefined;
     user_id?: string | undefined;
+    revision?: number | undefined;
 }>;
 type BookProps = z.infer<typeof bookPropsSchema>;
 declare class Book {
     id: string;
     title: string;
+    revision?: number;
     subtitle?: string;
     design_request: BookDesignRequest;
     state?: State;
@@ -3458,4 +3465,4 @@ declare const bookCreationRequestSchema: z.ZodObject<{
 }>;
 type BookCreationRequest = z.infer<typeof bookCreationRequestSchema>;
 
-export { Asset, Book, BookCreationRequest, BookDesignRequest, BookDesignRequestProps, BookProps, BookReport, BookSize, Canvas, CoverType, DesignOptions, DesignOptionsServer, DesignRequest, DesignRequestEvent, DesignRequestEventDetail, DesignRequestOptions, DesignRequestProps, EmbellishmentLevel, Image, ImageAssignment, ImageDensity, ImageDensityOption, ImageDensityOptionServer, ImageDensityOptions, ImageDensityOptionsServer, ImageFilteringLevel, ImageServer, Images, MagicBookClient, MagicShopBook, Occasion, Page, PageType, PhotoMetadata, PhotoStrip, Position, Property, ReportingData, State, Style, TextStickerLevel, assetSchema, bookCreationRequestSchema, bookDesignRequestSchema, bookPropsSchema, bookSizes, cancelledEventDetail, canvasSchema, coverTypes, designOptionsSchema, designOptionsServerSchema, embellishmentLevels, imageAssignmentSchema, imageDensities, imageDensityOptionSchema, imageDensityOptionServerSchema, imageDensityOptionsSchema, imageDensityOptionsServerSchema, imageFilteringLevels, imageServerSchema, isDesignRequestSubmitted, magicShopBookSchema, occasions, pageSchema, pageTypes, photoMetadataSchema, photoStripSchema, positionSchema, propertySchema, reportingDataSchema, states, statesToCloseWS, statesToReport, styles, textStickerLevels, timeoutEventDetail };
+export { Asset, Book, BookCreationRequest, BookDesignRequest, BookDesignRequestProps, BookProps, BookReport, BookSize, Canvas, CoverType, DesignOptions, DesignOptionsServer, DesignRequest, DesignRequestEvent, DesignRequestEventDetail, DesignRequestOptions, DesignRequestProps, EmbellishmentLevel, Image, ImageAssignment, ImageDensity, ImageDensityOption, ImageDensityOptionServer, ImageDensityOptions, ImageDensityOptionsServer, ImageFilteringLevel, ImageServer, Images, MagicBookClient, MagicShopBook, Occasion, Page, PageType, PhotoMetadata, PhotoStrip, Position, Property, ReportingData, State, Style, TextStickerLevel, assetSchema, bookCreationRequestSchema, bookDesignRequestSchema, bookPropsSchema, bookSizes, canSubmitDesignRequest, cancelledEventDetail, canvasSchema, coverTypes, designOptionsSchema, designOptionsServerSchema, embellishmentLevels, imageAssignmentSchema, imageDensities, imageDensityOptionSchema, imageDensityOptionServerSchema, imageDensityOptionsSchema, imageDensityOptionsServerSchema, imageFilteringLevels, imageServerSchema, isDesignRequestSubmitted, magicShopBookSchema, occasions, pageSchema, pageTypes, photoMetadataSchema, photoStripSchema, positionSchema, propertySchema, reportingDataSchema, states, statesToCloseWS, statesToReport, styles, textStickerLevels, timeoutEventDetail };

package/index.js

@@ -18,6 +18,7 @@ var states = [
 var statesToCloseWS = ["error", "timeout", "ready", "cancelled"];
 var statesToReport = ["error", "timeout"];
 var isDesignRequestSubmitted = (state) => !["new", "ingesting"].includes(state);
+var canSubmitDesignRequest = (state) => ["new", "ingesting", "ready"].includes(state);
 var occasions = [
   "baby",
   "birthday",
@@ -181,7 +182,7 @@ var styles = {
   6116: { slug: "boho-baby-sfly" },
   6117: { slug: "simply-gallery-sfly" },
   6118: { slug: "this-is-love-sfly" },
-  6120: { slug: "wedding-gallery-sfly" },
+  6120: { slug: "wedding-photo-album-sfly" },
   6121: { slug: "watercolorwashes-sfly" },
   6124: { slug: "graduation-photo-album-sfly" },
   6125: { slug: "modern-year-in-review-photo-album-sfly" },
@@ -4023,11 +4024,13 @@ var bookPropsSchema = z.object({
   guid: z.string().optional(),
   cancelled_at: z.string().optional(),
   mb_client_timeout: z.number().optional(),
-  user_id: z.string().optional()
+  user_id: z.string().optional(),
+  revision: z.number().optional()
 });
 var Book = class {
   id;
   title;
+  revision;
   subtitle;
   design_request;
   state;
@@ -4045,11 +4048,13 @@ var Book = class {
     this.cancelled_at = props.cancelled_at;
     this.timeout = props.mb_client_timeout ? props.mb_client_timeout * 1e3 : void 0;
     this.user_id = props.user_id;
+    this.revision = props.revision;
   }
   toDesignRequestProps() {
     const props = { ...this, ...this.design_request };
     props.style = getStyleIdBySlug(props.style);
     delete props.design_request;
+    delete props.revision;
     return snakeCaseObjectKeysToCamelCase(props);
   }
   toBookProps() {
@@ -4063,22 +4068,28 @@ var Book = class {
 // ../../core/models/design-request/image.ts
 var Images = class {
   // eslint-disable-next-line no-unused-vars
-  constructor(client, parentId) {
+  constructor(client, parentId, designRequestState) {
     this.client = client;
     this.parentId = parentId;
     this.images = [];
     this.length = this.images.length;
+    this.designRequestState = designRequestState;
   }
   parentId;
   images;
   length;
+  designRequestState;
   async add(image) {
-    this.images.push(image);
-    this.length = this.images.length;
-    await this.client.engineAPI.images.addToBook(this.parentId, new ImageServer(image));
-    return new Promise((resolve) => {
-      resolve(this.length);
-    });
+    if (!canSubmitDesignRequest(this.designRequestState)) {
+      throw new Error("You need to wait for the current design request to be ready before adding new images.");
+    } else {
+      this.images.push(image);
+      this.length = this.images.length;
+      await this.client.engineAPI.images.addToBook(this.parentId, new ImageServer(image));
+      return new Promise((resolve) => {
+        resolve(this.length);
+      });
+    }
   }
 };
 var imageServerSchema = z.object({
@@ -4176,7 +4187,7 @@ var DesignRequest = class {
     this.imageFilteringLevel = designRequestProps?.imageFilteringLevel || imageFilteringLevels[0];
     this.embellishmentLevel = designRequestProps?.embellishmentLevel || embellishmentLevels[0];
     this.textStickerLevel = designRequestProps?.textStickerLevel || textStickerLevels[0];
-    this.images = new Images(this.client, this.parentId);
+    this.images = new Images(this.client, this.parentId, this.state);
     this.userId = designRequestProps?.userId;
   }
   state;
@@ -4198,6 +4209,9 @@ var DesignRequest = class {
   timeout;
   updateDesignRequest(designRequestProps) {
     Object.assign(this, designRequestProps);
+    if (designRequestProps.state) {
+      this.images.designRequestState = designRequestProps.state;
+    }
   }
   async getOptions(imageCount) {
     const options = designOptionsSchema.parse(snakeCaseObjectKeysToCamelCase(
@@ -4210,16 +4224,16 @@ var DesignRequest = class {
     return options;
   }
   async submit(submitDesignRequestProps) {
-    if (isDesignRequestSubmitted(this.state)) {
-      throw new Error("Design request already submitted");
+    if (!canSubmitDesignRequest(this.state)) {
+      throw new Error("You need to wait for the current design request to be ready before submitting a new one");
     } else {
-      submitDesignRequestProps && Object.assign(this, submitDesignRequestProps);
+      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.update(this.parentId, this.toBook())).toDesignRequestProps()
+        (await this.client.engineAPI.books.design(this.parentId)).toDesignRequestProps()
       );
       this.getProgress();
-      this.state = states[1];
       return this;
     }
   }
@@ -4242,10 +4256,10 @@ var DesignRequest = class {
     } else if (!isDesignRequestSubmitted(this.state)) {
       throw new Error("Design request not submitted");
     } else {
-      this.updateDesignRequest(
-        (await this.client.engineAPI.books.cancel(this.parentId)).toDesignRequestProps()
-      );
-      this.state = "cancelled";
+      this.updateDesignRequest({
+        ...(await this.client.engineAPI.books.cancel(this.parentId)).toDesignRequestProps(),
+        state: "cancelled"
+      });
       await this.eventHandler(cancelledEventDetail);
       return this;
     }
@@ -4271,7 +4285,7 @@ var DesignRequest = class {
         });
       }
     }
-    this.state = detail.slug;
+    this.updateDesignRequest({ state: detail.slug });
     window.dispatchEvent(customEvent);
   }
   timeoutHandler() {
@@ -4288,7 +4302,7 @@ var DesignRequest = class {
       let timeout;
       this.webSocket.onmessage = async (event) => {
         const detail = JSON.parse(event.data);
-        if (this.state !== detail.slug) {
+        if (this.state !== detail.slug || detail.slug === "submitted") {
           timeout && clearTimeout(timeout);
           timeout = this.timeoutHandler();
           await this.eventHandler(detail);
@@ -4298,10 +4312,13 @@ var DesignRequest = class {
     }
   }
   toBook() {
-    const designRequest = { ...this };
-    delete designRequest["client"];
-    delete designRequest["images"]["client"];
-    delete designRequest["webSocket"];
+    const designRequest = {
+      ...this,
+      images: this.images["images"]
+      // eslint-disable-next-line @typescript-eslint/no-explicit-any
+    };
+    delete designRequest.client;
+    delete designRequest.webSocket;
     const styleSlug = styles[this.style].slug;
     const bookDesignRequest = camelCaseObjectKeysToSnakeCase(cleanJSON(designRequest));
     bookDesignRequest.style = styleSlug;
@@ -4436,6 +4453,16 @@ var BooksEndpoints = class {
       return new Book(res);
     });
   }
+  design(bookId) {
+    return handleAsyncFunction(async () => {
+      const res = await this.engineAPI.fetcher.call({
+        path: `/v1/books/${bookId}/design`,
+        options: { method: "POST" }
+      });
+      bookPropsSchema.safeParse(res);
+      return new Book(res);
+    });
+  }
   cancel(bookId) {
     return handleAsyncFunction(async () => {
       const res = await this.engineAPI.fetcher.call({
@@ -4887,6 +4914,7 @@ export {
   bookDesignRequestSchema,
   bookPropsSchema,
   bookSizes,
+  canSubmitDesignRequest,
   cancelledEventDetail,
   canvasSchema,
   coverTypes,