@magiclabs.ai/magicbook-client 0.3.0 → 0.4.0

package/models/book.d.ts

@@ -0,0 +1,37 @@
+import { BookSize, CoverType, EmbellishmentLevel, ImageDensity, ImageFiltering, Occasion, PageType, State, TextStickerLevel } from './design-request';
+export type BookDesignRequestProps = {
+    occasion: Occasion;
+    style: string;
+    book_size: BookSize;
+    cover_type: CoverType;
+    page_type: PageType;
+    image_density: ImageDensity;
+    image_filtering: ImageFiltering;
+    embellishment_level: EmbellishmentLevel;
+    text_sticker_level: TextStickerLevel;
+};
+export declare class BookDesignRequest {
+    occasion: Occasion;
+    style: string;
+    book_size: BookSize;
+    cover_type: CoverType;
+    page_type: PageType;
+    image_density: ImageDensity;
+    image_filtering: ImageFiltering;
+    embellishment_level: EmbellishmentLevel;
+    text_sticker_level: TextStickerLevel;
+    constructor(props: BookDesignRequestProps);
+}
+export type BookProps = {
+    id: string;
+    state: State;
+    title: string;
+    design_request: BookDesignRequestProps;
+};
+export declare class Book {
+    id: string;
+    state: State;
+    title: string;
+    design_request: BookDesignRequest;
+    constructor(props: BookProps);
+}

package/models/design-request/image.d.ts

@@ -10,7 +10,20 @@ export type Image = {
     filename: string;
 };
 export declare class Images {
+    private parentId;
     private images;
-    constructor();
-    add(image: Image): Promise<Image>;
+    constructor(parentId: string);
+    add(image: Image): Promise<number>;
+}
+export declare class ImageServer {
+    handle: string;
+    url: string;
+    width: number;
+    height: number;
+    orientation: number;
+    taken_at: string;
+    camera_make?: string;
+    camera?: string;
+    filename: string;
+    constructor(image: Image);
 }

package/models/design-request/index.d.ts

@@ -1,16 +1,14 @@
-import { BookCreationRequest } from '../galleon';
-import { BookSizes, CoverTypes, EmbellishmentLevels, ImageDensities, ImageFilterings, Occasions, PageTypes, States, Styles, TextStickerLevels } from '../../data/design-request';
-import { DesignOptions } from './design-options';
 import { Images } from './image';
-export type Occasion = typeof Occasions[number];
-export type Style = typeof Styles[number];
-export type BookSize = typeof BookSizes[number];
-export type CoverType = typeof CoverTypes[number];
-export type PageType = typeof PageTypes[number];
-export type ImageDensity = typeof ImageDensities[number];
-export type ImageFiltering = typeof ImageFilterings[number];
-export type EmbellishmentLevel = typeof EmbellishmentLevels[number];
-export type TextStickerLevel = typeof TextStickerLevels[number];
+import { bookSizes, coverTypes, embellishmentLevels, imageDensities, imageFilterings, occasions, pageTypes, states, styles, textStickerLevels } from '../../data/design-request';
+export type Occasion = typeof occasions[number];
+export type Style = keyof typeof styles;
+export type BookSize = typeof bookSizes[number];
+export type CoverType = typeof coverTypes[number];
+export type PageType = typeof pageTypes[number];
+export type ImageDensity = typeof imageDensities[number];
+export type ImageFiltering = typeof imageFilterings[number];
+export type EmbellishmentLevel = typeof embellishmentLevels[number];
+export type TextStickerLevel = typeof textStickerLevels[number];
 export type DesignRequestProps = {
     title?: string;
     occasion?: Occasion;
@@ -23,27 +21,27 @@ export type DesignRequestProps = {
     embellishmentLevel?: EmbellishmentLevel;
     textStickerLevel?: TextStickerLevel;
 };
-export type State = typeof States[number];
+export type State = typeof states[number];
 export type DesignRequestEventDetail = {
     state: State;
 };
 export type DesignRequestEvent = CustomEvent<DesignRequestEventDetail>;
 export declare class DesignRequest {
-    id: string;
-    title?: string;
-    occasion?: Occasion;
-    style?: Style;
-    bookSize?: BookSize;
-    coverType?: CoverType;
-    pageType?: PageType;
-    imageDensity?: ImageDensity;
-    imageFiltering?: ImageFiltering;
-    embellishmentLevel?: EmbellishmentLevel;
-    textStickerLevel?: TextStickerLevel;
+    parentId: string;
+    title: string;
+    occasion: Occasion;
+    style: Style;
+    bookSize: BookSize;
+    coverType: CoverType;
+    pageType: PageType;
+    imageDensity: ImageDensity;
+    imageFiltering: ImageFiltering;
+    embellishmentLevel: EmbellishmentLevel;
+    textStickerLevel: TextStickerLevel;
     images: Images;
-    constructor(id: string, designRequestProps?: DesignRequestProps);
-    getOptions(imageCount: number): Promise<DesignOptions>;
-    submit(submitDesignRequest?: DesignRequestProps): Promise<DesignRequest>;
-    getJSON(): Promise<BookCreationRequest>;
-    startFakeProgress(): void;
+    constructor(parentId: string, designRequestProps?: DesignRequestProps);
+    getOptions(imageCount: number): Promise<import("./design-options").DesignOptions>;
+    submit(submitDesignRequestProps?: DesignRequestProps): Promise<this>;
+    getJSON(): Promise<import("../galleon").BookCreationRequest>;
+    private getProgress;
 }

package/package.json

@@ -1,12 +1,12 @@
 {
   "name": "@magiclabs.ai/magicbook-client",
   "private": false,
-  "version": "0.3.0",
+  "version": "0.4.0",
   "description": "TypeScript package to create photo books with the Magicbook API.",
   "type": "module",
   "main": "./magicbook-client.umd.cjs",
   "module": "./magicbook-client.js",
-  "types": "./index.d.ts",
+  "types": "./src/index.d.ts",
   "repository": {
     "type": "git",
     "url": "https://github.com/56kcloud/mb-client.git"
@@ -18,7 +18,7 @@
     }
   },
   "scripts": {
-    "watch": "vite build --watch",
+    "watch": "./scripts/build.sh -w",
     "build": "./scripts/build.sh",
     "deploy": "./scripts/deploy-npm.sh",
     "lint": "eslint . --ext js,jsx,ts,tsx --config .eslintrc.json --no-eslintrc",
@@ -26,21 +26,22 @@
     "coverage": "vitest run --coverage"
   },
   "devDependencies": {
-    "@types/node": "^18.15.11",
-    "@typescript-eslint/eslint-plugin": "^5.58.0",
-    "@typescript-eslint/parser": "^5.58.0",
+    "@types/node": "^18.16.3",
+    "@typescript-eslint/eslint-plugin": "^5.59.2",
+    "@typescript-eslint/parser": "^5.59.2",
     "@vitest/coverage-c8": "^0.30.1",
     "@vitest/coverage-istanbul": "^0.30.1",
     "@vitest/ui": "^0.30.1",
     "eslint-plugin-sort-imports-es6-autofix": "^0.6.0",
-    "jsdom": "^21.1.1",
+    "jsdom": "^22.0.0",
+    "rollup-plugin-execute": "^1.1.1",
     "typescript": "^5.0.4",
-    "vite": "^4.2.1",
+    "vite": "^4.3.4",
     "vite-plugin-dts": "^2.3.0",
     "vitest": "^0.30.1"
   },
   "dependencies": {
     "@faker-js/faker": "^7.6.0",
-    "axios": "^1.3.5"
+    "axios": "^1.4.0"
   }
 }

package/utils/design-request-parser.d.ts

@@ -0,0 +1,3 @@
+import { Book } from '../models/book';
+import { DesignRequest } from '..';
+export declare function designRequestToBook(designRequest: DesignRequest): Book;

package/utils/engine-api/axios.d.ts

@@ -0,0 +1,15 @@
+import { AxiosRequestConfig } from 'axios';
+type baseRequest = {
+    url: string;
+    needsToken?: boolean;
+    options?: AxiosRequestConfig<any>;
+};
+type payloadRequest = baseRequest & {
+    payload?: unknown;
+};
+export declare function get({ url, needsToken, options }: baseRequest): Promise<import("axios").AxiosResponse<any, any>>;
+export declare function remove({ url, needsToken, options }: baseRequest): Promise<import("axios").AxiosResponse<any, any>>;
+export declare function post({ url, needsToken, options, payload }: payloadRequest): Promise<import("axios").AxiosResponse<any, any>>;
+export declare function put({ url, needsToken, options, payload }: payloadRequest): Promise<import("axios").AxiosResponse<any, any>>;
+export declare function APIHandler<T>(fn: () => Promise<T>): Promise<T>;
+export {};

package/utils/engine-api/books.d.ts

@@ -0,0 +1,6 @@
+import { Book } from '../../models/book';
+import { BookCreationRequest } from '../../models/galleon';
+export declare function createBook(payload?: Book): Promise<Book>;
+export declare function retrieveBook(bookId: string): Promise<Book>;
+export declare function updateBook(payload: Book): Promise<Book>;
+export declare function retrieveGalleon(bookId: string): Promise<BookCreationRequest>;

package/utils/engine-api/design-options.d.ts

@@ -0,0 +1,3 @@
+import { BookSize } from '../../models/design-request';
+import { DesignOptions } from '../../models/design-request/design-options';
+export declare function getDesignOptions(bookSize: BookSize, imageCount: number): Promise<DesignOptions>;

package/utils/engine-api/images.d.ts

@@ -0,0 +1,2 @@
+import { ImageServer } from '../../models/design-request/image';
+export declare function addImageInBook(bookId: string, payload: ImageServer): Promise<import("axios").AxiosResponse<any, any>>;

package/utils/toolbox.d.ts

@@ -0,0 +1,6 @@
+export declare function assign(obj: Record<string, any>, fields: Array<string>, value: unknown): void;
+export declare function mergeNestedObject(obj: Record<string, any>, objToMerge: Record<string, any>): Record<string, any>;
+export declare function camelCaseToSnakeCase(str: string): string;
+export declare function camelCaseObjectKeysToSnakeCase(camelCaseObject: Record<string, unknown>): Record<string, unknown>;
+export declare function snakeCaseToCamelCase(str: string): string;
+export declare function snakeCaseObjectKeysToCamelCase(snakeCaseObject: Record<string, unknown>): Record<string, unknown>;

package/data/design-options.d.ts

@@ -1,2 +0,0 @@
-import { DesignOptions } from '../models/design-request/design-options';
-export declare const designOptions: DesignOptions;

package/data/galleon.d.ts

@@ -1,2 +0,0 @@
-import { BookCreationRequest } from '../models/galleon';
-export declare const galleonJSON: BookCreationRequest;