@magiclabs.ai/magicbook-client 0.7.9-canary → 0.7.10-canary
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/README.md +27 -8
- package/index.cjs +21 -19
- package/index.cjs.map +1 -1
- package/index.d.cts +31 -7
- package/index.d.ts +31 -7
- package/index.iife.js +5333 -0
- package/index.js +18 -18
- package/index.js.map +1 -1
- package/package.json +2 -2
package/index.d.cts
CHANGED
|
@@ -838,6 +838,8 @@ declare const timeoutEventDetail: DesignRequestEventDetail;
|
|
|
838
838
|
declare const cancelledEventDetail: DesignRequestEventDetail;
|
|
839
839
|
declare const formats: readonly ["galleon", "snapfish"];
|
|
840
840
|
type Format = (typeof formats)[number];
|
|
841
|
+
declare const surfaceCategoryNames: readonly ["inside", "cover"];
|
|
842
|
+
type SurfaceCategoryName = (typeof surfaceCategoryNames)[number];
|
|
841
843
|
|
|
842
844
|
declare class BooksEndpoints {
|
|
843
845
|
private readonly engineAPI;
|
|
@@ -1074,7 +1076,7 @@ declare class SpreadsEndpoints {
|
|
|
1074
1076
|
metadata?: unknown;
|
|
1075
1077
|
}>;
|
|
1076
1078
|
delete(spreadId: string, bookId: string): Promise<void>;
|
|
1077
|
-
layouts(bookId: string, page: number): Promise<{
|
|
1079
|
+
layouts(bookId: string, page: number, surfaceCategoryName?: SurfaceCategoryName): Promise<({
|
|
1078
1080
|
backgroundId: string | null;
|
|
1079
1081
|
assets?: {
|
|
1080
1082
|
type: string;
|
|
@@ -1100,7 +1102,11 @@ declare class SpreadsEndpoints {
|
|
|
1100
1102
|
fontColor?: string | undefined;
|
|
1101
1103
|
frame?: string | undefined;
|
|
1102
1104
|
}[] | undefined;
|
|
1103
|
-
}
|
|
1105
|
+
} | {
|
|
1106
|
+
surfaceNumber: number;
|
|
1107
|
+
surfaceData: Record<string, any>;
|
|
1108
|
+
version: string;
|
|
1109
|
+
})[]>;
|
|
1104
1110
|
}
|
|
1105
1111
|
|
|
1106
1112
|
declare class StoryboardItemsEndpoints {
|
|
@@ -1332,7 +1338,7 @@ declare class DesignRequest {
|
|
|
1332
1338
|
};
|
|
1333
1339
|
};
|
|
1334
1340
|
}>;
|
|
1335
|
-
getAlternateLayouts(pageNumber: number): Promise<{
|
|
1341
|
+
getAlternateLayouts(pageNumber: number, surfaceCategoryName?: SurfaceCategoryName): Promise<({
|
|
1336
1342
|
backgroundId: string | null;
|
|
1337
1343
|
assets?: {
|
|
1338
1344
|
type: string;
|
|
@@ -1358,7 +1364,11 @@ declare class DesignRequest {
|
|
|
1358
1364
|
fontColor?: string | undefined;
|
|
1359
1365
|
frame?: string | undefined;
|
|
1360
1366
|
}[] | undefined;
|
|
1361
|
-
}
|
|
1367
|
+
} | {
|
|
1368
|
+
surfaceNumber: number;
|
|
1369
|
+
surfaceData: Record<string, any>;
|
|
1370
|
+
version: string;
|
|
1371
|
+
})[]>;
|
|
1362
1372
|
submit(submitDesignRequestProps?: Partial<DesignRequestProps>): Promise<this>;
|
|
1363
1373
|
setGuid(guid: string): Promise<string>;
|
|
1364
1374
|
cancel(): Promise<this>;
|
|
@@ -2381,7 +2391,7 @@ declare const reportingDataSchema: z.ZodObject<{
|
|
|
2381
2391
|
}[];
|
|
2382
2392
|
}>;
|
|
2383
2393
|
type ReportingData = z.infer<typeof reportingDataSchema>;
|
|
2384
|
-
declare const
|
|
2394
|
+
declare const sflyCanvasSchema: z.ZodObject<{
|
|
2385
2395
|
backgroundId: z.ZodNullable<z.ZodString>;
|
|
2386
2396
|
assets: z.ZodOptional<z.ZodArray<z.ZodObject<{
|
|
2387
2397
|
type: z.ZodString;
|
|
@@ -2524,7 +2534,21 @@ declare const canvasSchema: z.ZodObject<{
|
|
|
2524
2534
|
frame?: string | undefined;
|
|
2525
2535
|
}[] | undefined;
|
|
2526
2536
|
}>;
|
|
2527
|
-
type
|
|
2537
|
+
type SflyCanvas = z.infer<typeof sflyCanvasSchema>;
|
|
2538
|
+
declare const snapCanvasSchema: z.ZodObject<{
|
|
2539
|
+
surfaceNumber: z.ZodNumber;
|
|
2540
|
+
surfaceData: z.ZodRecord<z.ZodString, z.ZodAny>;
|
|
2541
|
+
version: z.ZodString;
|
|
2542
|
+
}, "strip", z.ZodTypeAny, {
|
|
2543
|
+
surfaceNumber: number;
|
|
2544
|
+
surfaceData: Record<string, any>;
|
|
2545
|
+
version: string;
|
|
2546
|
+
}, {
|
|
2547
|
+
surfaceNumber: number;
|
|
2548
|
+
surfaceData: Record<string, any>;
|
|
2549
|
+
version: string;
|
|
2550
|
+
}>;
|
|
2551
|
+
type SnapCanvas = z.infer<typeof snapCanvasSchema>;
|
|
2528
2552
|
declare const pageSchema: z.ZodObject<{
|
|
2529
2553
|
pageNum: z.ZodNumber;
|
|
2530
2554
|
type: z.ZodString;
|
|
@@ -3705,4 +3729,4 @@ declare const bookCreationRequestSchema: z.ZodObject<{
|
|
|
3705
3729
|
}>;
|
|
3706
3730
|
type BookCreationRequest = z.infer<typeof bookCreationRequestSchema>;
|
|
3707
3731
|
|
|
3708
|
-
export { type Asset, Book, type BookCreationRequest, BookDesignRequest, type BookDesignRequestProps, type BookProps, type BookReport, type BookSize, type
|
|
3732
|
+
export { type Asset, Book, type BookCreationRequest, BookDesignRequest, type BookDesignRequestProps, type BookProps, type BookReport, type BookSize, type CoverType, type DesignOptions, type DesignOptionsServer, DesignRequest, type DesignRequestEvent, type DesignRequestEventDetail, DesignRequestOptions, type DesignRequestProps, type EmbellishmentLevel, type Format, type Image, type ImageAssignment, type ImageDensity, type ImageDensityOption, type ImageDensityOptionServer, type ImageDensityOptions, type ImageDensityOptionsServer, type ImageFilteringLevel, ImageServer, Images, MagicBookClient, type MagicShopBook, type Occasion, type Page, type PageType, type PhotoMetadata, type PhotoStrip, type Position, type Property, type ReportingData, type SflyCanvas, type SnapCanvas, type State, type Style, type SurfaceCategoryName, type TextStickerLevel, assetSchema, bookCreationRequestSchema, bookDesignRequestSchema, bookPropsSchema, bookSizes, canSubmitDesignRequest, cancelledEventDetail, coverTypes, designOptionsSchema, designOptionsServerSchema, embellishmentLevels, formats, imageAssignmentSchema, imageDensities, imageDensityOptionSchema, imageDensityOptionServerSchema, imageDensityOptionsSchema, imageDensityOptionsServerSchema, imageFilteringLevels, imageServerSchema, imageServerToImage, isDesignRequestSubmitted, magicShopBookSchema, occasions, pageSchema, pageTypes, photoMetadataSchema, photoStripSchema, positionSchema, propertySchema, reportingDataSchema, sflyCanvasSchema, snapCanvasSchema, states, statesToCloseWS, statesToReport, styles, surfaceCategoryNames, textStickerLevels, timeoutEventDetail };
|
package/index.d.ts
CHANGED
|
@@ -838,6 +838,8 @@ declare const timeoutEventDetail: DesignRequestEventDetail;
|
|
|
838
838
|
declare const cancelledEventDetail: DesignRequestEventDetail;
|
|
839
839
|
declare const formats: readonly ["galleon", "snapfish"];
|
|
840
840
|
type Format = (typeof formats)[number];
|
|
841
|
+
declare const surfaceCategoryNames: readonly ["inside", "cover"];
|
|
842
|
+
type SurfaceCategoryName = (typeof surfaceCategoryNames)[number];
|
|
841
843
|
|
|
842
844
|
declare class BooksEndpoints {
|
|
843
845
|
private readonly engineAPI;
|
|
@@ -1074,7 +1076,7 @@ declare class SpreadsEndpoints {
|
|
|
1074
1076
|
metadata?: unknown;
|
|
1075
1077
|
}>;
|
|
1076
1078
|
delete(spreadId: string, bookId: string): Promise<void>;
|
|
1077
|
-
layouts(bookId: string, page: number): Promise<{
|
|
1079
|
+
layouts(bookId: string, page: number, surfaceCategoryName?: SurfaceCategoryName): Promise<({
|
|
1078
1080
|
backgroundId: string | null;
|
|
1079
1081
|
assets?: {
|
|
1080
1082
|
type: string;
|
|
@@ -1100,7 +1102,11 @@ declare class SpreadsEndpoints {
|
|
|
1100
1102
|
fontColor?: string | undefined;
|
|
1101
1103
|
frame?: string | undefined;
|
|
1102
1104
|
}[] | undefined;
|
|
1103
|
-
}
|
|
1105
|
+
} | {
|
|
1106
|
+
surfaceNumber: number;
|
|
1107
|
+
surfaceData: Record<string, any>;
|
|
1108
|
+
version: string;
|
|
1109
|
+
})[]>;
|
|
1104
1110
|
}
|
|
1105
1111
|
|
|
1106
1112
|
declare class StoryboardItemsEndpoints {
|
|
@@ -1332,7 +1338,7 @@ declare class DesignRequest {
|
|
|
1332
1338
|
};
|
|
1333
1339
|
};
|
|
1334
1340
|
}>;
|
|
1335
|
-
getAlternateLayouts(pageNumber: number): Promise<{
|
|
1341
|
+
getAlternateLayouts(pageNumber: number, surfaceCategoryName?: SurfaceCategoryName): Promise<({
|
|
1336
1342
|
backgroundId: string | null;
|
|
1337
1343
|
assets?: {
|
|
1338
1344
|
type: string;
|
|
@@ -1358,7 +1364,11 @@ declare class DesignRequest {
|
|
|
1358
1364
|
fontColor?: string | undefined;
|
|
1359
1365
|
frame?: string | undefined;
|
|
1360
1366
|
}[] | undefined;
|
|
1361
|
-
}
|
|
1367
|
+
} | {
|
|
1368
|
+
surfaceNumber: number;
|
|
1369
|
+
surfaceData: Record<string, any>;
|
|
1370
|
+
version: string;
|
|
1371
|
+
})[]>;
|
|
1362
1372
|
submit(submitDesignRequestProps?: Partial<DesignRequestProps>): Promise<this>;
|
|
1363
1373
|
setGuid(guid: string): Promise<string>;
|
|
1364
1374
|
cancel(): Promise<this>;
|
|
@@ -2381,7 +2391,7 @@ declare const reportingDataSchema: z.ZodObject<{
|
|
|
2381
2391
|
}[];
|
|
2382
2392
|
}>;
|
|
2383
2393
|
type ReportingData = z.infer<typeof reportingDataSchema>;
|
|
2384
|
-
declare const
|
|
2394
|
+
declare const sflyCanvasSchema: z.ZodObject<{
|
|
2385
2395
|
backgroundId: z.ZodNullable<z.ZodString>;
|
|
2386
2396
|
assets: z.ZodOptional<z.ZodArray<z.ZodObject<{
|
|
2387
2397
|
type: z.ZodString;
|
|
@@ -2524,7 +2534,21 @@ declare const canvasSchema: z.ZodObject<{
|
|
|
2524
2534
|
frame?: string | undefined;
|
|
2525
2535
|
}[] | undefined;
|
|
2526
2536
|
}>;
|
|
2527
|
-
type
|
|
2537
|
+
type SflyCanvas = z.infer<typeof sflyCanvasSchema>;
|
|
2538
|
+
declare const snapCanvasSchema: z.ZodObject<{
|
|
2539
|
+
surfaceNumber: z.ZodNumber;
|
|
2540
|
+
surfaceData: z.ZodRecord<z.ZodString, z.ZodAny>;
|
|
2541
|
+
version: z.ZodString;
|
|
2542
|
+
}, "strip", z.ZodTypeAny, {
|
|
2543
|
+
surfaceNumber: number;
|
|
2544
|
+
surfaceData: Record<string, any>;
|
|
2545
|
+
version: string;
|
|
2546
|
+
}, {
|
|
2547
|
+
surfaceNumber: number;
|
|
2548
|
+
surfaceData: Record<string, any>;
|
|
2549
|
+
version: string;
|
|
2550
|
+
}>;
|
|
2551
|
+
type SnapCanvas = z.infer<typeof snapCanvasSchema>;
|
|
2528
2552
|
declare const pageSchema: z.ZodObject<{
|
|
2529
2553
|
pageNum: z.ZodNumber;
|
|
2530
2554
|
type: z.ZodString;
|
|
@@ -3705,4 +3729,4 @@ declare const bookCreationRequestSchema: z.ZodObject<{
|
|
|
3705
3729
|
}>;
|
|
3706
3730
|
type BookCreationRequest = z.infer<typeof bookCreationRequestSchema>;
|
|
3707
3731
|
|
|
3708
|
-
export { type Asset, Book, type BookCreationRequest, BookDesignRequest, type BookDesignRequestProps, type BookProps, type BookReport, type BookSize, type
|
|
3732
|
+
export { type Asset, Book, type BookCreationRequest, BookDesignRequest, type BookDesignRequestProps, type BookProps, type BookReport, type BookSize, type CoverType, type DesignOptions, type DesignOptionsServer, DesignRequest, type DesignRequestEvent, type DesignRequestEventDetail, DesignRequestOptions, type DesignRequestProps, type EmbellishmentLevel, type Format, type Image, type ImageAssignment, type ImageDensity, type ImageDensityOption, type ImageDensityOptionServer, type ImageDensityOptions, type ImageDensityOptionsServer, type ImageFilteringLevel, ImageServer, Images, MagicBookClient, type MagicShopBook, type Occasion, type Page, type PageType, type PhotoMetadata, type PhotoStrip, type Position, type Property, type ReportingData, type SflyCanvas, type SnapCanvas, type State, type Style, type SurfaceCategoryName, type TextStickerLevel, assetSchema, bookCreationRequestSchema, bookDesignRequestSchema, bookPropsSchema, bookSizes, canSubmitDesignRequest, cancelledEventDetail, coverTypes, designOptionsSchema, designOptionsServerSchema, embellishmentLevels, formats, imageAssignmentSchema, imageDensities, imageDensityOptionSchema, imageDensityOptionServerSchema, imageDensityOptionsSchema, imageDensityOptionsServerSchema, imageFilteringLevels, imageServerSchema, imageServerToImage, isDesignRequestSubmitted, magicShopBookSchema, occasions, pageSchema, pageTypes, photoMetadataSchema, photoStripSchema, positionSchema, propertySchema, reportingDataSchema, sflyCanvasSchema, snapCanvasSchema, states, statesToCloseWS, statesToReport, styles, surfaceCategoryNames, textStickerLevels, timeoutEventDetail };
|