@magiclabs.ai/magicbook-client 0.4.2 → 0.4.7-dev
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.
- package/magicbook-client.js +3797 -984
- package/magicbook-client.umd.cjs +3 -3
- package/models/book.d.ts +97 -4
- package/models/design-request/design-options.d.ts +274 -10
- package/models/design-request/image.d.ts +32 -0
- package/models/design-request/index.d.ts +90 -2
- package/models/galleon.d.ts +1576 -57
- package/package.json +3 -2
- package/utils/engine-api/books.d.ts +65 -2
- package/utils/engine-api/design-options.d.ts +25 -2
- package/utils/engine-api/images.d.ts +1 -1
package/package.json
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@magiclabs.ai/magicbook-client",
|
|
3
3
|
"private": false,
|
|
4
|
-
"version": "0.4.
|
|
4
|
+
"version": "0.4.7-dev",
|
|
5
5
|
"description": "TypeScript package to create photo books with the Magicbook API.",
|
|
6
6
|
"type": "module",
|
|
7
7
|
"main": "./magicbook-client.umd.cjs",
|
|
@@ -42,6 +42,7 @@
|
|
|
42
42
|
},
|
|
43
43
|
"dependencies": {
|
|
44
44
|
"@faker-js/faker": "^7.6.0",
|
|
45
|
-
"axios": "^1.4.0"
|
|
45
|
+
"axios": "^1.4.0",
|
|
46
|
+
"zod": "^3.21.4"
|
|
46
47
|
}
|
|
47
48
|
}
|
|
@@ -1,6 +1,69 @@
|
|
|
1
1
|
import { Book } from '../../models/book';
|
|
2
|
-
import { BookCreationRequest } from '../../models/galleon';
|
|
3
2
|
export declare function createBook(payload?: Book): Promise<Book>;
|
|
4
3
|
export declare function retrieveBook(bookId: string): Promise<Book>;
|
|
5
4
|
export declare function updateBook(payload: Book): Promise<Book>;
|
|
6
|
-
export declare function retrieveGalleon(bookId: string): Promise<
|
|
5
|
+
export declare function retrieveGalleon(bookId: string): Promise<{
|
|
6
|
+
title: string;
|
|
7
|
+
coverSpecId: string;
|
|
8
|
+
styleId: number;
|
|
9
|
+
userId: string;
|
|
10
|
+
magicShopBook: {
|
|
11
|
+
pages: {
|
|
12
|
+
type: string;
|
|
13
|
+
pageNum: number;
|
|
14
|
+
canvas: {
|
|
15
|
+
assets: {
|
|
16
|
+
type: string;
|
|
17
|
+
position: {
|
|
18
|
+
x: number;
|
|
19
|
+
y: number;
|
|
20
|
+
rotation: number;
|
|
21
|
+
width?: number | undefined;
|
|
22
|
+
height?: number | undefined;
|
|
23
|
+
};
|
|
24
|
+
seqNum: number;
|
|
25
|
+
z: number;
|
|
26
|
+
imageAssignment?: {
|
|
27
|
+
photoRefId: number;
|
|
28
|
+
finalCrop: number[];
|
|
29
|
+
} | undefined;
|
|
30
|
+
id?: string | undefined;
|
|
31
|
+
horizJustification?: string | undefined;
|
|
32
|
+
vertJustification?: string | undefined;
|
|
33
|
+
text?: string | undefined;
|
|
34
|
+
fontId?: string | undefined;
|
|
35
|
+
fontSize?: number | undefined;
|
|
36
|
+
fontColor?: string | undefined;
|
|
37
|
+
frame?: string | undefined;
|
|
38
|
+
}[];
|
|
39
|
+
backgroundId?: string | undefined;
|
|
40
|
+
};
|
|
41
|
+
}[];
|
|
42
|
+
photoStrip: {
|
|
43
|
+
url: string;
|
|
44
|
+
photoRefId: number;
|
|
45
|
+
encryptId: string;
|
|
46
|
+
photoMetadata: {
|
|
47
|
+
data: string;
|
|
48
|
+
id: string;
|
|
49
|
+
title: string;
|
|
50
|
+
width: number;
|
|
51
|
+
height: number;
|
|
52
|
+
rotation: number;
|
|
53
|
+
llx: number;
|
|
54
|
+
lly: number;
|
|
55
|
+
urx: number;
|
|
56
|
+
ury: number;
|
|
57
|
+
effect: string;
|
|
58
|
+
source: string;
|
|
59
|
+
uploadTime: string;
|
|
60
|
+
};
|
|
61
|
+
}[];
|
|
62
|
+
};
|
|
63
|
+
reportingData: {
|
|
64
|
+
properties: {
|
|
65
|
+
value: string | number | boolean | null;
|
|
66
|
+
key: string;
|
|
67
|
+
}[];
|
|
68
|
+
};
|
|
69
|
+
}>;
|
|
@@ -1,3 +1,26 @@
|
|
|
1
1
|
import { BookSize } from '../../models/design-request';
|
|
2
|
-
|
|
3
|
-
|
|
2
|
+
export declare function getDesignOptions(bookSize: BookSize, imageCount: number): Promise<{
|
|
3
|
+
densities: {
|
|
4
|
+
low: {
|
|
5
|
+
maxPageCount: number;
|
|
6
|
+
minPageCount: number;
|
|
7
|
+
maxImageCount: number;
|
|
8
|
+
avgImageCount: number;
|
|
9
|
+
minImageCount: number;
|
|
10
|
+
};
|
|
11
|
+
medium: {
|
|
12
|
+
maxPageCount: number;
|
|
13
|
+
minPageCount: number;
|
|
14
|
+
maxImageCount: number;
|
|
15
|
+
avgImageCount: number;
|
|
16
|
+
minImageCount: number;
|
|
17
|
+
};
|
|
18
|
+
high: {
|
|
19
|
+
maxPageCount: number;
|
|
20
|
+
minPageCount: number;
|
|
21
|
+
maxImageCount: number;
|
|
22
|
+
avgImageCount: number;
|
|
23
|
+
minImageCount: number;
|
|
24
|
+
};
|
|
25
|
+
};
|
|
26
|
+
}>;
|
|
@@ -1,2 +1,2 @@
|
|
|
1
1
|
import { ImageServer } from '../../models/design-request/image';
|
|
2
|
-
export declare function addImageInBook(bookId: string, payload: ImageServer): Promise<
|
|
2
|
+
export declare function addImageInBook(bookId: string, payload: ImageServer): Promise<ImageServer>;
|