@magiclabs.ai/magicbook-client 0.2.1 → 0.3.3

package/models/client.d.ts

@@ -1,5 +1,5 @@
-import DesignRequest, { DesignRequestProps } from './design-request';
-export default class MagicBookClient {
+import { DesignRequest, DesignRequestProps } from './design-request';
+export declare class MagicBookClient {
     apiKey: string;
     constructor(apiKey: string);
     createDesignRequest(designRequestProps?: DesignRequestProps): Promise<DesignRequest>;

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

@@ -0,0 +1,15 @@
+export type ImageDensityOption = {
+    maxPageCount: number;
+    minPageCount: number;
+    maxImageCount: number;
+    avgImageCount: number;
+    minImageCount: number;
+};
+export type ImageDensityOptions = {
+    high: ImageDensityOption;
+    medium: ImageDensityOption;
+    low: ImageDensityOption;
+};
+export type DesignOptions = {
+    densities: ImageDensityOptions;
+};

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

@@ -0,0 +1,49 @@
+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];
+export type DesignRequestProps = {
+    title?: string;
+    occasion?: Occasion;
+    style?: Style;
+    bookSize?: BookSize;
+    coverType?: CoverType;
+    pageType?: PageType;
+    imageDensity?: ImageDensity;
+    imageFiltering?: ImageFiltering;
+    embellishmentLevel?: EmbellishmentLevel;
+    textStickerLevel?: TextStickerLevel;
+};
+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;
+    images: Images;
+    constructor(id: string, designRequestProps?: DesignRequestProps);
+    getOptions(imageCount: number): Promise<DesignOptions>;
+    submit(submitDesignRequest?: DesignRequestProps): Promise<DesignRequest>;
+    getJSON(): Promise<BookCreationRequest>;
+    startFakeProgress(): void;
+}

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@magiclabs.ai/magicbook-client",
   "private": false,
-  "version": "0.2.1",
+  "version": "0.3.3",
   "description": "TypeScript package to create photo books with the Magicbook API.",
   "type": "module",
   "main": "./magicbook-client.umd.cjs",
@@ -26,21 +26,21 @@
     "coverage": "vitest run --coverage"
   },
   "devDependencies": {
-    "@types/node": "^18.15.10",
-    "@typescript-eslint/eslint-plugin": "^5.57.0",
-    "@typescript-eslint/parser": "^5.57.0",
-    "@vitest/coverage-c8": "^0.29.8",
-    "@vitest/coverage-istanbul": "^0.29.8",
-    "@vitest/ui": "^0.29.8",
+    "@types/node": "^18.15.11",
+    "@typescript-eslint/eslint-plugin": "^5.58.0",
+    "@typescript-eslint/parser": "^5.58.0",
+    "@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",
-    "typescript": "^5.0.2",
+    "typescript": "^5.0.4",
     "vite": "^4.2.1",
-    "vite-plugin-dts": "^2.1.0",
-    "vitest": "^0.29.8"
+    "vite-plugin-dts": "^2.3.0",
+    "vitest": "^0.30.1"
   },
   "dependencies": {
     "@faker-js/faker": "^7.6.0",
-    "axios": "^1.3.4"
+    "axios": "^1.3.5"
   }
 }

package/data/nautilus.d.ts

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

package/models/design-request.d.ts

@@ -1,34 +0,0 @@
-import { BookCreationRequest } from './nautilus';
-import { Images } from './image';
-export type DesignRequestProps = {
-    title?: string;
-    occasion?: string;
-    style?: string;
-    bookFormat?: string;
-    coverType?: string;
-    pageType?: string;
-    imageDensity?: string;
-    embellishmentLevel?: string;
-    textStickerLevel?: string;
-};
-export type DesignRequestEventDetail = {
-    state: 'new' | 'designing' | 'completed' | 'canceled' | 'error';
-};
-export type DesignRequestEvent = CustomEvent<DesignRequestEventDetail>;
-export default class DesignRequest {
-    id: string;
-    title?: string;
-    occasion?: string;
-    style?: string;
-    bookFormat?: string;
-    coverType?: string;
-    pageType?: string;
-    imageDensity?: string;
-    embellishmentLevel?: string;
-    textStickerLevel?: string;
-    images: Images;
-    constructor(id: string, designRequestProps?: DesignRequestProps);
-    submit(submitDesignRequest?: DesignRequestProps): Promise<DesignRequest>;
-    getJSON(): Promise<BookCreationRequest>;
-    startFakeProgress(): void;
-}