@magiclabs.ai/magicbook-client 0.6.1 → 0.6.3

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 (8) hide show
  1. package/README.md +5 -0
  2. package/data/design-request.d.ts +4 -1
  3. package/magicbook-client.js +884 -857
  4. package/magicbook-client.umd.cjs +4 -4
  5. package/models/book.d.ts +3 -3
  6. package/models/design-request/index.d.ts +9 -1
  7. package/package.json +12 -12
  8. package/utils/engine-api/books.d.ts +1 -0
package/README.md CHANGED
@@ -94,6 +94,11 @@ After submitting you can set a GUID to the design request.
94
94
  await designRequest.setGuid('a9ccb406-015a-47df-bb59-ea171b8617ca')
95
95
  ```
96
96
 
97
+ The design request can be canceled by triggering a cancellation event through this method.
98
+ ```ts
99
+ await designRequest.cancel()
100
+ ```
101
+
97
102
  Finally, once the design request is complete, retrieve it in JSON format.
98
103
 
99
104
  ```ts
package/data/design-request.d.ts CHANGED
@@ -1,4 +1,5 @@
1
- export declare const states: readonly ["new", "ingesting", "submitted", "storyboarding", "deduplication", "image selection", "designing", "layouting", "embellishing", "polishing", "ready", "error"];
1
+ import { DesignRequestEventDetail } from '../models/design-request';
2
+ export declare const states: readonly ["new", "ingesting", "submitted", "storyboarding", "deduplication", "image-selection", "designing", "laying-out", "embellishing", "polishing", "ready", "error", "cancelled"];
2
3
  export 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"];
3
4
  export declare const styles: {
4
5
  1005: {
@@ -489,3 +490,5 @@ export declare const imageDensities: readonly ["low", "medium", "high"];
489
490
  export declare const imageFilteringLevels: readonly ["best", "most", "all"];
490
491
  export declare const embellishmentLevels: readonly ["none", "few", "lots"];
491
492
  export declare const textStickerLevels: readonly ["none", "few", "lots"];
493
+ export declare const timeoutMessage: DesignRequestEventDetail;
494
+ export declare const cancelledMessage: DesignRequestEventDetail;