@magiclabs.ai/magicbook-client 0.6.3 → 0.6.6

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 (24) hide show
  1. package/README.md +1 -6
  2. package/index.cjs +4853 -0
  3. package/index.cjs.map +1 -0
  4. package/index.d.cts +1751 -0
  5. package/index.d.ts +1751 -5
  6. package/index.js +4815 -0
  7. package/index.js.map +1 -0
  8. package/package.json +17 -30
  9. package/config.d.ts +0 -3
  10. package/data/design-request.d.ts +0 -494
  11. package/magicbook-client.js +0 -4666
  12. package/magicbook-client.umd.cjs +0 -4
  13. package/models/book.d.ts +0 -134
  14. package/models/client.d.ts +0 -8
  15. package/models/design-request/design-options.d.ts +0 -279
  16. package/models/design-request/image.d.ts +0 -64
  17. package/models/design-request/index.d.ts +0 -149
  18. package/models/galleon.d.ts +0 -1612
  19. package/utils/design-request-parser.d.ts +0 -3
  20. package/utils/engine-api/axios.d.ts +0 -15
  21. package/utils/engine-api/books.d.ts +0 -73
  22. package/utils/engine-api/design-options.d.ts +0 -27
  23. package/utils/engine-api/images.d.ts +0 -13
  24. package/utils/toolbox.d.ts +0 -6
package/models/design-request/design-options.d.ts DELETED
@@ -1,279 +0,0 @@
1
- import { z } from 'zod';
2
- export declare const imageDensityOptionSchema: z.ZodObject<{
3
- maxPageCount: z.ZodNumber;
4
- minPageCount: z.ZodNumber;
5
- maxImageCount: z.ZodNumber;
6
- avgImageCount: z.ZodNumber;
7
- minImageCount: z.ZodNumber;
8
- }, "strip", z.ZodTypeAny, {
9
- maxPageCount: number;
10
- minPageCount: number;
11
- maxImageCount: number;
12
- avgImageCount: number;
13
- minImageCount: number;
14
- }, {
15
- maxPageCount: number;
16
- minPageCount: number;
17
- maxImageCount: number;
18
- avgImageCount: number;
19
- minImageCount: number;
20
- }>;
21
- export type ImageDensityOption = z.infer<typeof imageDensityOptionSchema>;
22
- export declare const imageDensityOptionsSchema: z.ZodObject<{
23
- high: z.ZodObject<{
24
- maxPageCount: z.ZodNumber;
25
- minPageCount: z.ZodNumber;
26
- maxImageCount: z.ZodNumber;
27
- avgImageCount: z.ZodNumber;
28
- minImageCount: z.ZodNumber;
29
- }, "strip", z.ZodTypeAny, {
30
- maxPageCount: number;
31
- minPageCount: number;
32
- maxImageCount: number;
33
- avgImageCount: number;
34
- minImageCount: number;
35
- }, {
36
- maxPageCount: number;
37
- minPageCount: number;
38
- maxImageCount: number;
39
- avgImageCount: number;
40
- minImageCount: number;
41
- }>;
42
- medium: z.ZodObject<{
43
- maxPageCount: z.ZodNumber;
44
- minPageCount: z.ZodNumber;
45
- maxImageCount: z.ZodNumber;
46
- avgImageCount: z.ZodNumber;
47
- minImageCount: z.ZodNumber;
48
- }, "strip", z.ZodTypeAny, {
49
- maxPageCount: number;
50
- minPageCount: number;
51
- maxImageCount: number;
52
- avgImageCount: number;
53
- minImageCount: number;
54
- }, {
55
- maxPageCount: number;
56
- minPageCount: number;
57
- maxImageCount: number;
58
- avgImageCount: number;
59
- minImageCount: number;
60
- }>;
61
- low: z.ZodObject<{
62
- maxPageCount: z.ZodNumber;
63
- minPageCount: z.ZodNumber;
64
- maxImageCount: z.ZodNumber;
65
- avgImageCount: z.ZodNumber;
66
- minImageCount: z.ZodNumber;
67
- }, "strip", z.ZodTypeAny, {
68
- maxPageCount: number;
69
- minPageCount: number;
70
- maxImageCount: number;
71
- avgImageCount: number;
72
- minImageCount: number;
73
- }, {
74
- maxPageCount: number;
75
- minPageCount: number;
76
- maxImageCount: number;
77
- avgImageCount: number;
78
- minImageCount: number;
79
- }>;
80
- }, "strip", z.ZodTypeAny, {
81
- low: {
82
- maxPageCount: number;
83
- minPageCount: number;
84
- maxImageCount: number;
85
- avgImageCount: number;
86
- minImageCount: number;
87
- };
88
- medium: {
89
- maxPageCount: number;
90
- minPageCount: number;
91
- maxImageCount: number;
92
- avgImageCount: number;
93
- minImageCount: number;
94
- };
95
- high: {
96
- maxPageCount: number;
97
- minPageCount: number;
98
- maxImageCount: number;
99
- avgImageCount: number;
100
- minImageCount: number;
101
- };
102
- }, {
103
- low: {
104
- maxPageCount: number;
105
- minPageCount: number;
106
- maxImageCount: number;
107
- avgImageCount: number;
108
- minImageCount: number;
109
- };
110
- medium: {
111
- maxPageCount: number;
112
- minPageCount: number;
113
- maxImageCount: number;
114
- avgImageCount: number;
115
- minImageCount: number;
116
- };
117
- high: {
118
- maxPageCount: number;
119
- minPageCount: number;
120
- maxImageCount: number;
121
- avgImageCount: number;
122
- minImageCount: number;
123
- };
124
- }>;
125
- export type ImageDensityOptions = z.infer<typeof imageDensityOptionsSchema>;
126
- export declare const designOptionsSchema: z.ZodObject<{
127
- densities: z.ZodObject<{
128
- high: z.ZodObject<{
129
- maxPageCount: z.ZodNumber;
130
- minPageCount: z.ZodNumber;
131
- maxImageCount: z.ZodNumber;
132
- avgImageCount: z.ZodNumber;
133
- minImageCount: z.ZodNumber;
134
- }, "strip", z.ZodTypeAny, {
135
- maxPageCount: number;
136
- minPageCount: number;
137
- maxImageCount: number;
138
- avgImageCount: number;
139
- minImageCount: number;
140
- }, {
141
- maxPageCount: number;
142
- minPageCount: number;
143
- maxImageCount: number;
144
- avgImageCount: number;
145
- minImageCount: number;
146
- }>;
147
- medium: z.ZodObject<{
148
- maxPageCount: z.ZodNumber;
149
- minPageCount: z.ZodNumber;
150
- maxImageCount: z.ZodNumber;
151
- avgImageCount: z.ZodNumber;
152
- minImageCount: z.ZodNumber;
153
- }, "strip", z.ZodTypeAny, {
154
- maxPageCount: number;
155
- minPageCount: number;
156
- maxImageCount: number;
157
- avgImageCount: number;
158
- minImageCount: number;
159
- }, {
160
- maxPageCount: number;
161
- minPageCount: number;
162
- maxImageCount: number;
163
- avgImageCount: number;
164
- minImageCount: number;
165
- }>;
166
- low: z.ZodObject<{
167
- maxPageCount: z.ZodNumber;
168
- minPageCount: z.ZodNumber;
169
- maxImageCount: z.ZodNumber;
170
- avgImageCount: z.ZodNumber;
171
- minImageCount: z.ZodNumber;
172
- }, "strip", z.ZodTypeAny, {
173
- maxPageCount: number;
174
- minPageCount: number;
175
- maxImageCount: number;
176
- avgImageCount: number;
177
- minImageCount: number;
178
- }, {
179
- maxPageCount: number;
180
- minPageCount: number;
181
- maxImageCount: number;
182
- avgImageCount: number;
183
- minImageCount: number;
184
- }>;
185
- }, "strip", z.ZodTypeAny, {
186
- low: {
187
- maxPageCount: number;
188
- minPageCount: number;
189
- maxImageCount: number;
190
- avgImageCount: number;
191
- minImageCount: number;
192
- };
193
- medium: {
194
- maxPageCount: number;
195
- minPageCount: number;
196
- maxImageCount: number;
197
- avgImageCount: number;
198
- minImageCount: number;
199
- };
200
- high: {
201
- maxPageCount: number;
202
- minPageCount: number;
203
- maxImageCount: number;
204
- avgImageCount: number;
205
- minImageCount: number;
206
- };
207
- }, {
208
- low: {
209
- maxPageCount: number;
210
- minPageCount: number;
211
- maxImageCount: number;
212
- avgImageCount: number;
213
- minImageCount: number;
214
- };
215
- medium: {
216
- maxPageCount: number;
217
- minPageCount: number;
218
- maxImageCount: number;
219
- avgImageCount: number;
220
- minImageCount: number;
221
- };
222
- high: {
223
- maxPageCount: number;
224
- minPageCount: number;
225
- maxImageCount: number;
226
- avgImageCount: number;
227
- minImageCount: number;
228
- };
229
- }>;
230
- }, "strip", z.ZodTypeAny, {
231
- densities: {
232
- low: {
233
- maxPageCount: number;
234
- minPageCount: number;
235
- maxImageCount: number;
236
- avgImageCount: number;
237
- minImageCount: number;
238
- };
239
- medium: {
240
- maxPageCount: number;
241
- minPageCount: number;
242
- maxImageCount: number;
243
- avgImageCount: number;
244
- minImageCount: number;
245
- };
246
- high: {
247
- maxPageCount: number;
248
- minPageCount: number;
249
- maxImageCount: number;
250
- avgImageCount: number;
251
- minImageCount: number;
252
- };
253
- };
254
- }, {
255
- densities: {
256
- low: {
257
- maxPageCount: number;
258
- minPageCount: number;
259
- maxImageCount: number;
260
- avgImageCount: number;
261
- minImageCount: number;
262
- };
263
- medium: {
264
- maxPageCount: number;
265
- minPageCount: number;
266
- maxImageCount: number;
267
- avgImageCount: number;
268
- minImageCount: number;
269
- };
270
- high: {
271
- maxPageCount: number;
272
- minPageCount: number;
273
- maxImageCount: number;
274
- avgImageCount: number;
275
- minImageCount: number;
276
- };
277
- };
278
- }>;
279
- export type DesignOptions = z.infer<typeof designOptionsSchema>;
package/models/design-request/image.d.ts DELETED
@@ -1,64 +0,0 @@
1
- import { MagicBookClient } from '../client';
2
- import { z } from 'zod';
3
- export type Image = {
4
- handle: string;
5
- url: string;
6
- width: number;
7
- height: number;
8
- rotation: number;
9
- captureTime: string;
10
- cameraMake?: string;
11
- cameraModel?: string;
12
- filename: string;
13
- };
14
- export declare class Images {
15
- private client;
16
- private parentId;
17
- private images;
18
- length: number;
19
- constructor(client: MagicBookClient, parentId: string);
20
- add(image: Image): Promise<number>;
21
- }
22
- export declare const imageServerSchema: z.ZodObject<{
23
- handle: z.ZodString;
24
- url: z.ZodString;
25
- width: z.ZodNumber;
26
- height: z.ZodNumber;
27
- orientation: z.ZodNumber;
28
- taken_at: z.ZodString;
29
- camera_make: z.ZodOptional<z.ZodString>;
30
- camera: z.ZodOptional<z.ZodString>;
31
- filename: z.ZodString;
32
- }, "strip", z.ZodTypeAny, {
33
- url: string;
34
- width: number;
35
- height: number;
36
- handle: string;
37
- orientation: number;
38
- taken_at: string;
39
- filename: string;
40
- camera_make?: string | undefined;
41
- camera?: string | undefined;
42
- }, {
43
- url: string;
44
- width: number;
45
- height: number;
46
- handle: string;
47
- orientation: number;
48
- taken_at: string;
49
- filename: string;
50
- camera_make?: string | undefined;
51
- camera?: string | undefined;
52
- }>;
53
- export declare class ImageServer {
54
- handle: string;
55
- url: string;
56
- width: number;
57
- height: number;
58
- orientation: number;
59
- taken_at: string;
60
- camera_make?: string;
61
- camera?: string;
62
- filename: string;
63
- constructor(image: Image);
64
- }
package/models/design-request/index.d.ts DELETED
@@ -1,149 +0,0 @@
1
- import { Images } from './image';
2
- import { MagicBookClient } from '../client';
3
- import { bookSizes, coverTypes, embellishmentLevels, imageDensities, imageFilteringLevels, occasions, pageTypes, states, styles, textStickerLevels } from '../../data/design-request';
4
- export type Occasion = typeof occasions[number];
5
- export type Style = keyof typeof styles;
6
- export type BookSize = typeof bookSizes[number];
7
- export type CoverType = typeof coverTypes[number];
8
- export type PageType = typeof pageTypes[number];
9
- export type ImageDensity = typeof imageDensities[number];
10
- export type ImageFilteringLevel = typeof imageFilteringLevels[number];
11
- export type EmbellishmentLevel = typeof embellishmentLevels[number];
12
- export type TextStickerLevel = typeof textStickerLevels[number];
13
- export type DesignRequestProps = {
14
- title?: string;
15
- occasion?: Occasion;
16
- style?: Style;
17
- bookSize?: BookSize;
18
- coverType?: CoverType;
19
- pageType?: PageType;
20
- imageDensity?: ImageDensity;
21
- imageFilteringLevel?: ImageFilteringLevel;
22
- embellishmentLevel?: EmbellishmentLevel;
23
- textStickerLevel?: TextStickerLevel;
24
- };
25
- export type State = typeof states[number];
26
- export type DesignRequestEventDetail = {
27
- state: string;
28
- slug: State;
29
- progress: number;
30
- message: string;
31
- };
32
- export type DesignRequestEvent = CustomEvent<DesignRequestEventDetail>;
33
- export declare class DesignRequest {
34
- private client;
35
- private webSocket;
36
- state: State;
37
- parentId: string;
38
- title: string;
39
- occasion: Occasion;
40
- style: Style;
41
- bookSize: BookSize;
42
- coverType: CoverType;
43
- pageType: PageType;
44
- imageDensity: ImageDensity;
45
- imageFilteringLevel: ImageFilteringLevel;
46
- embellishmentLevel: EmbellishmentLevel;
47
- textStickerLevel: TextStickerLevel;
48
- images: Images;
49
- guid?: string;
50
- constructor(parentId: string, client: MagicBookClient, designRequestProps?: DesignRequestProps);
51
- getOptions(imageCount?: number): Promise<{
52
- densities: {
53
- low: {
54
- maxPageCount: number;
55
- minPageCount: number;
56
- maxImageCount: number;
57
- avgImageCount: number;
58
- minImageCount: number;
59
- };
60
- medium: {
61
- maxPageCount: number;
62
- minPageCount: number;
63
- maxImageCount: number;
64
- avgImageCount: number;
65
- minImageCount: number;
66
- };
67
- high: {
68
- maxPageCount: number;
69
- minPageCount: number;
70
- maxImageCount: number;
71
- avgImageCount: number;
72
- minImageCount: number;
73
- };
74
- };
75
- }>;
76
- submit(submitDesignRequestProps?: DesignRequestProps): Promise<this>;
77
- setGuid(guid: string): Promise<string>;
78
- getJSON(): Promise<{
79
- title: string;
80
- binding: string;
81
- coverSpecId: string;
82
- styleId: number;
83
- userId: string;
84
- magicShopBook: {
85
- pages: {
86
- type: string;
87
- pageNum: number;
88
- canvas: {
89
- backgroundId: string | null;
90
- assets?: {
91
- type: string;
92
- position: {
93
- x: number;
94
- y: number;
95
- rotation: number;
96
- width?: number | undefined;
97
- height?: number | undefined;
98
- };
99
- seqNum: number;
100
- z: number;
101
- imageAssignment?: {
102
- photoRefId: string;
103
- finalCrop: number[];
104
- } | undefined;
105
- id?: string | undefined;
106
- horizJustification?: string | undefined;
107
- vertJustification?: string | null | undefined;
108
- text?: string | undefined;
109
- fontId?: string | undefined;
110
- fontSize?: number | undefined;
111
- fontColor?: string | undefined;
112
- frame?: string | undefined;
113
- }[] | undefined;
114
- };
115
- }[];
116
- photoStrip: {
117
- url: string;
118
- photoRefId: string;
119
- encryptId: string;
120
- photoId: string;
121
- photoMetadata: {
122
- data: string | null;
123
- id: string;
124
- title: string;
125
- width: number;
126
- height: number;
127
- rotation: number;
128
- llx: number;
129
- lly: number;
130
- urx: number;
131
- ury: number;
132
- effect: string;
133
- source: string;
134
- uploadTime: string;
135
- };
136
- }[];
137
- };
138
- reportingData: {
139
- properties: {
140
- key: string;
141
- value?: any;
142
- }[];
143
- };
144
- }>;
145
- cancel(): Promise<this>;
146
- private eventHandler;
147
- private timeoutHandler;
148
- private getProgress;
149
- }