@magiclabs.ai/magicbook-client 0.7.11-canary → 0.7.13-canary

package/index.d.cts

@@ -920,6 +920,7 @@ declare class ImagesEndpoints {
         id?: string | undefined;
         camera_make?: string | undefined;
         camera?: string | undefined;
+        metadata?: Record<string, unknown> | undefined;
     }[]>;
     retrieve(imageId: string, bookId: string): Promise<{
         handle: string;
@@ -932,6 +933,7 @@ declare class ImagesEndpoints {
         id?: string | undefined;
         camera_make?: string | undefined;
         camera?: string | undefined;
+        metadata?: Record<string, unknown> | undefined;
     }>;
     update(imageId: string, bookId: string, image: ImageServer): Promise<{
         handle: string;
@@ -944,6 +946,7 @@ declare class ImagesEndpoints {
         id?: string | undefined;
         camera_make?: string | undefined;
         camera?: string | undefined;
+        metadata?: Record<string, unknown> | undefined;
     }>;
     delete(imageId: string, bookId: string): Promise<void>;
     addToBook(bookId: string, image: ImageServer): Promise<{
@@ -957,6 +960,7 @@ declare class ImagesEndpoints {
         id?: string | undefined;
         camera_make?: string | undefined;
         camera?: string | undefined;
+        metadata?: Record<string, unknown> | undefined;
     }>;
 }
 
@@ -988,8 +992,8 @@ declare const spreadServerSchema: z.ZodObject<{
     url?: string | null | undefined;
     width?: number | undefined;
     height?: number | undefined;
-    background?: unknown;
     metadata?: unknown;
+    background?: unknown;
 }, {
     state: string;
     book_id: string;
@@ -1003,8 +1007,8 @@ declare const spreadServerSchema: z.ZodObject<{
     url?: string | null | undefined;
     width?: number | undefined;
     height?: number | undefined;
-    background?: unknown;
     metadata?: unknown;
+    background?: unknown;
 }>;
 type SpreadServer = z.infer<typeof spreadServerSchema>;
 
@@ -1024,8 +1028,8 @@ declare class SpreadsEndpoints {
         url?: string | null | undefined;
         width?: number | undefined;
         height?: number | undefined;
-        background?: unknown;
         metadata?: unknown;
+        background?: unknown;
     }[]>;
     create(bookId: string, spread: SpreadServer): Promise<{
         state: string;
@@ -1040,8 +1044,8 @@ declare class SpreadsEndpoints {
         url?: string | null | undefined;
         width?: number | undefined;
         height?: number | undefined;
-        background?: unknown;
         metadata?: unknown;
+        background?: unknown;
     }>;
     retrieve(spreadId: string, bookId: string): Promise<{
         state: string;
@@ -1056,8 +1060,8 @@ declare class SpreadsEndpoints {
         url?: string | null | undefined;
         width?: number | undefined;
         height?: number | undefined;
-        background?: unknown;
         metadata?: unknown;
+        background?: unknown;
     }>;
     update(spreadId: string, bookId: string, spread: SpreadServer): Promise<{
         state: string;
@@ -1072,8 +1076,8 @@ declare class SpreadsEndpoints {
         url?: string | null | undefined;
         width?: number | undefined;
         height?: number | undefined;
-        background?: unknown;
         metadata?: unknown;
+        background?: unknown;
     }>;
     delete(spreadId: string, bookId: string): Promise<void>;
     layouts(bookId: string, page: number, surfaceCategoryName?: SurfaceCategoryName): Promise<({
@@ -1179,6 +1183,7 @@ declare class MagicBookClient {
 }
 
 type Image = {
+    id?: string;
     handle: string;
     url: string;
     width: number;
@@ -1188,15 +1193,17 @@ type Image = {
     cameraMake?: string;
     cameraModel?: string;
     filename: string;
+    metadata?: Record<string, unknown>;
 };
 declare class Images {
     private readonly client;
     private parentId;
-    private images;
+    list: Array<Image>;
     length: number;
     designRequestState: State;
     constructor(client: MagicBookClient, parentId: string, designRequestState: State);
-    add(image: Image): Promise<number>;
+    add(image: Image): Promise<Image>;
+    delete(imageId: string): Promise<number>;
 }
 declare const imageServerSchema: z.ZodObject<{
     id: z.ZodOptional<z.ZodString>;
@@ -1209,6 +1216,7 @@ declare const imageServerSchema: z.ZodObject<{
     camera_make: z.ZodOptional<z.ZodString>;
     camera: z.ZodOptional<z.ZodString>;
     filename: z.ZodString;
+    metadata: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
 }, "strip", z.ZodTypeAny, {
     handle: string;
     url: string;
@@ -1220,6 +1228,7 @@ declare const imageServerSchema: z.ZodObject<{
     id?: string | undefined;
     camera_make?: string | undefined;
     camera?: string | undefined;
+    metadata?: Record<string, unknown> | undefined;
 }, {
     handle: string;
     url: string;
@@ -1231,8 +1240,10 @@ declare const imageServerSchema: z.ZodObject<{
     id?: string | undefined;
     camera_make?: string | undefined;
     camera?: string | undefined;
+    metadata?: Record<string, unknown> | undefined;
 }>;
 declare class ImageServer {
+    id?: string;
     handle: string;
     url: string;
     width: number;
@@ -1242,6 +1253,7 @@ declare class ImageServer {
     camera_make?: string;
     camera?: string;
     filename: string;
+    metadata?: Record<string, unknown>;
     constructor(image: Image);
 }
 declare function imageServerToImage(imageServer: ImageServer): Image;

package/index.d.ts

@@ -920,6 +920,7 @@ declare class ImagesEndpoints {
         id?: string | undefined;
         camera_make?: string | undefined;
         camera?: string | undefined;
+        metadata?: Record<string, unknown> | undefined;
     }[]>;
     retrieve(imageId: string, bookId: string): Promise<{
         handle: string;
@@ -932,6 +933,7 @@ declare class ImagesEndpoints {
         id?: string | undefined;
         camera_make?: string | undefined;
         camera?: string | undefined;
+        metadata?: Record<string, unknown> | undefined;
     }>;
     update(imageId: string, bookId: string, image: ImageServer): Promise<{
         handle: string;
@@ -944,6 +946,7 @@ declare class ImagesEndpoints {
         id?: string | undefined;
         camera_make?: string | undefined;
         camera?: string | undefined;
+        metadata?: Record<string, unknown> | undefined;
     }>;
     delete(imageId: string, bookId: string): Promise<void>;
     addToBook(bookId: string, image: ImageServer): Promise<{
@@ -957,6 +960,7 @@ declare class ImagesEndpoints {
         id?: string | undefined;
         camera_make?: string | undefined;
         camera?: string | undefined;
+        metadata?: Record<string, unknown> | undefined;
     }>;
 }
 
@@ -988,8 +992,8 @@ declare const spreadServerSchema: z.ZodObject<{
     url?: string | null | undefined;
     width?: number | undefined;
     height?: number | undefined;
-    background?: unknown;
     metadata?: unknown;
+    background?: unknown;
 }, {
     state: string;
     book_id: string;
@@ -1003,8 +1007,8 @@ declare const spreadServerSchema: z.ZodObject<{
     url?: string | null | undefined;
     width?: number | undefined;
     height?: number | undefined;
-    background?: unknown;
     metadata?: unknown;
+    background?: unknown;
 }>;
 type SpreadServer = z.infer<typeof spreadServerSchema>;
 
@@ -1024,8 +1028,8 @@ declare class SpreadsEndpoints {
         url?: string | null | undefined;
         width?: number | undefined;
         height?: number | undefined;
-        background?: unknown;
         metadata?: unknown;
+        background?: unknown;
     }[]>;
     create(bookId: string, spread: SpreadServer): Promise<{
         state: string;
@@ -1040,8 +1044,8 @@ declare class SpreadsEndpoints {
         url?: string | null | undefined;
         width?: number | undefined;
         height?: number | undefined;
-        background?: unknown;
         metadata?: unknown;
+        background?: unknown;
     }>;
     retrieve(spreadId: string, bookId: string): Promise<{
         state: string;
@@ -1056,8 +1060,8 @@ declare class SpreadsEndpoints {
         url?: string | null | undefined;
         width?: number | undefined;
         height?: number | undefined;
-        background?: unknown;
         metadata?: unknown;
+        background?: unknown;
     }>;
     update(spreadId: string, bookId: string, spread: SpreadServer): Promise<{
         state: string;
@@ -1072,8 +1076,8 @@ declare class SpreadsEndpoints {
         url?: string | null | undefined;
         width?: number | undefined;
         height?: number | undefined;
-        background?: unknown;
         metadata?: unknown;
+        background?: unknown;
     }>;
     delete(spreadId: string, bookId: string): Promise<void>;
     layouts(bookId: string, page: number, surfaceCategoryName?: SurfaceCategoryName): Promise<({
@@ -1179,6 +1183,7 @@ declare class MagicBookClient {
 }
 
 type Image = {
+    id?: string;
     handle: string;
     url: string;
     width: number;
@@ -1188,15 +1193,17 @@ type Image = {
     cameraMake?: string;
     cameraModel?: string;
     filename: string;
+    metadata?: Record<string, unknown>;
 };
 declare class Images {
     private readonly client;
     private parentId;
-    private images;
+    list: Array<Image>;
     length: number;
     designRequestState: State;
     constructor(client: MagicBookClient, parentId: string, designRequestState: State);
-    add(image: Image): Promise<number>;
+    add(image: Image): Promise<Image>;
+    delete(imageId: string): Promise<number>;
 }
 declare const imageServerSchema: z.ZodObject<{
     id: z.ZodOptional<z.ZodString>;
@@ -1209,6 +1216,7 @@ declare const imageServerSchema: z.ZodObject<{
     camera_make: z.ZodOptional<z.ZodString>;
     camera: z.ZodOptional<z.ZodString>;
     filename: z.ZodString;
+    metadata: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
 }, "strip", z.ZodTypeAny, {
     handle: string;
     url: string;
@@ -1220,6 +1228,7 @@ declare const imageServerSchema: z.ZodObject<{
     id?: string | undefined;
     camera_make?: string | undefined;
     camera?: string | undefined;
+    metadata?: Record<string, unknown> | undefined;
 }, {
     handle: string;
     url: string;
@@ -1231,8 +1240,10 @@ declare const imageServerSchema: z.ZodObject<{
     id?: string | undefined;
     camera_make?: string | undefined;
     camera?: string | undefined;
+    metadata?: Record<string, unknown> | undefined;
 }>;
 declare class ImageServer {
+    id?: string;
     handle: string;
     url: string;
     width: number;
@@ -1242,6 +1253,7 @@ declare class ImageServer {
     camera_make?: string;
     camera?: string;
     filename: string;
+    metadata?: Record<string, unknown>;
     constructor(image: Image);
 }
 declare function imageServerToImage(imageServer: ImageServer): Image;

package/index.iife.js

@@ -4482,25 +4482,37 @@ var MagicLabs = (() => {
     }
   };
   var Images = class {
-    // eslint-disable-next-line no-unused-vars
     constructor(client, parentId, designRequestState) {
       this.client = client;
       this.parentId = parentId;
-      this.images = [];
-      this.length = this.images.length;
+      this.list = [];
+      this.length = this.list.length;
       this.designRequestState = designRequestState;
     }
     parentId;
-    images;
+    list;
     length;
     designRequestState;
     async add(image) {
       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));
+        const serverImage = await this.client.engineAPI.images.addToBook(this.parentId, new ImageServer(image));
+        const img = imageServerToImage(serverImage);
+        this.list.push(img);
+        this.length = this.list.length;
+        return new Promise((resolve) => {
+          resolve(img);
+        });
+      }
+    }
+    async delete(imageId) {
+      if (!canSubmitDesignRequest(this.designRequestState)) {
+        throw new Error("You need to wait for the current design request to be ready before deleting images.");
+      } else {
+        await this.client.engineAPI.images.delete(imageId, this.parentId);
+        this.list.splice(this.list.findIndex((image) => image.handle === imageId), 1);
+        this.length = this.list.length;
         return new Promise((resolve) => {
           resolve(this.length);
         });
@@ -4517,9 +4529,11 @@ var MagicLabs = (() => {
     taken_at: z.string(),
     camera_make: z.string().optional(),
     camera: z.string().optional(),
-    filename: z.string()
+    filename: z.string(),
+    metadata: z.record(z.unknown()).optional()
   });
   var ImageServer = class {
+    id;
     handle;
     url;
     width;
@@ -4529,7 +4543,9 @@ var MagicLabs = (() => {
     camera_make;
     camera;
     filename;
+    metadata;
     constructor(image) {
+      this.id = image.id;
       this.handle = image.handle;
       this.url = image.url;
       this.width = image.width;
@@ -4539,10 +4555,12 @@ var MagicLabs = (() => {
       this.camera_make = image.cameraMake;
       this.camera = image.cameraModel;
       this.filename = image.filename;
+      this.metadata = image.metadata;
     }
   };
   function imageServerToImage(imageServer) {
     return {
+      id: imageServer.id,
       handle: imageServer.handle,
       url: imageServer.url,
       width: imageServer.width,
@@ -4551,7 +4569,8 @@ var MagicLabs = (() => {
       captureTime: imageServer.taken_at,
       cameraMake: imageServer.camera_make,
       cameraModel: imageServer.camera,
-      filename: imageServer.filename
+      filename: imageServer.filename,
+      metadata: imageServer.metadata
     };
   }
   var imageDensityOptionSchema = z.object({
@@ -4748,7 +4767,7 @@ var MagicLabs = (() => {
     toBook() {
       const designRequest = {
         ...this,
-        images: this.images["images"]
+        images: this.images.list
         // eslint-disable-next-line @typescript-eslint/no-explicit-any
       };
       delete designRequest.client;
@@ -4959,7 +4978,7 @@ var MagicLabs = (() => {
     retrieve(imageId, bookId) {
       return handleAsyncFunction(async () => {
         const res = await this.engineAPI.fetcher.call({
-          path: `/v1/images/${imageId}/book/${bookId}/`
+          path: `/v1/images/${imageId}/book/${bookId}`
         });
         return imageServerSchema.parse(res);
       });
@@ -4967,7 +4986,7 @@ var MagicLabs = (() => {
     update(imageId, bookId, image) {
       return handleAsyncFunction(async () => {
         const res = await this.engineAPI.fetcher.call({
-          path: `/v1/images/${imageId}/book/${bookId}/`,
+          path: `/v1/images/${imageId}/book/${bookId}`,
           options: {
             method: "PUT",
             body: cleanJSON(image)
@@ -4979,7 +4998,7 @@ var MagicLabs = (() => {
     delete(imageId, bookId) {
       return handleAsyncFunction(async () => {
         await this.engineAPI.fetcher.call({
-          path: `/v1/images/${imageId}/book/${bookId}/`,
+          path: `/v1/images/${imageId}/book/${bookId}`,
           options: {
             method: "DELETE"
           }

package/index.js

@@ -4420,25 +4420,37 @@ var Book = class {
 
 // ../../core/models/design-request/image.ts
 var Images = class {
-  // eslint-disable-next-line no-unused-vars
   constructor(client, parentId, designRequestState) {
     this.client = client;
     this.parentId = parentId;
-    this.images = [];
-    this.length = this.images.length;
+    this.list = [];
+    this.length = this.list.length;
     this.designRequestState = designRequestState;
   }
   parentId;
-  images;
+  list;
   length;
   designRequestState;
   async add(image) {
     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));
+      const serverImage = await this.client.engineAPI.images.addToBook(this.parentId, new ImageServer(image));
+      const img = imageServerToImage(serverImage);
+      this.list.push(img);
+      this.length = this.list.length;
+      return new Promise((resolve) => {
+        resolve(img);
+      });
+    }
+  }
+  async delete(imageId) {
+    if (!canSubmitDesignRequest(this.designRequestState)) {
+      throw new Error("You need to wait for the current design request to be ready before deleting images.");
+    } else {
+      await this.client.engineAPI.images.delete(imageId, this.parentId);
+      this.list.splice(this.list.findIndex((image) => image.handle === imageId), 1);
+      this.length = this.list.length;
       return new Promise((resolve) => {
         resolve(this.length);
       });
@@ -4455,9 +4467,11 @@ var imageServerSchema = z.object({
   taken_at: z.string(),
   camera_make: z.string().optional(),
   camera: z.string().optional(),
-  filename: z.string()
+  filename: z.string(),
+  metadata: z.record(z.unknown()).optional()
 });
 var ImageServer = class {
+  id;
   handle;
   url;
   width;
@@ -4467,7 +4481,9 @@ var ImageServer = class {
   camera_make;
   camera;
   filename;
+  metadata;
   constructor(image) {
+    this.id = image.id;
     this.handle = image.handle;
     this.url = image.url;
     this.width = image.width;
@@ -4477,10 +4493,12 @@ var ImageServer = class {
     this.camera_make = image.cameraMake;
     this.camera = image.cameraModel;
     this.filename = image.filename;
+    this.metadata = image.metadata;
   }
 };
 function imageServerToImage(imageServer) {
   return {
+    id: imageServer.id,
     handle: imageServer.handle,
     url: imageServer.url,
     width: imageServer.width,
@@ -4489,7 +4507,8 @@ function imageServerToImage(imageServer) {
     captureTime: imageServer.taken_at,
     cameraMake: imageServer.camera_make,
     cameraModel: imageServer.camera,
-    filename: imageServer.filename
+    filename: imageServer.filename,
+    metadata: imageServer.metadata
   };
 }
 
@@ -4690,7 +4709,7 @@ var DesignRequest = class {
   toBook() {
     const designRequest = {
       ...this,
-      images: this.images["images"]
+      images: this.images.list
       // eslint-disable-next-line @typescript-eslint/no-explicit-any
     };
     delete designRequest.client;
@@ -4913,7 +4932,7 @@ var ImagesEndpoints = class {
   retrieve(imageId, bookId) {
     return handleAsyncFunction(async () => {
       const res = await this.engineAPI.fetcher.call({
-        path: `/v1/images/${imageId}/book/${bookId}/`
+        path: `/v1/images/${imageId}/book/${bookId}`
       });
       return imageServerSchema.parse(res);
     });
@@ -4921,7 +4940,7 @@ var ImagesEndpoints = class {
   update(imageId, bookId, image) {
     return handleAsyncFunction(async () => {
       const res = await this.engineAPI.fetcher.call({
-        path: `/v1/images/${imageId}/book/${bookId}/`,
+        path: `/v1/images/${imageId}/book/${bookId}`,
         options: {
           method: "PUT",
           body: cleanJSON(image)
@@ -4933,7 +4952,7 @@ var ImagesEndpoints = class {
   delete(imageId, bookId) {
     return handleAsyncFunction(async () => {
       await this.engineAPI.fetcher.call({
-        path: `/v1/images/${imageId}/book/${bookId}/`,
+        path: `/v1/images/${imageId}/book/${bookId}`,
         options: {
           method: "DELETE"
         }