@magiclabs.ai/magicbook-client 0.2.0

package/models/client.d.ts

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

package/models/design-request.d.ts

@@ -0,0 +1,34 @@
+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;
+}

package/models/image.d.ts

@@ -0,0 +1,16 @@
+export type Image = {
+    handle: string;
+    url: string;
+    width: number;
+    height: number;
+    rotation: number;
+    captureTime: string;
+    cameraMake?: string;
+    cameraModel?: string;
+    filename: string;
+};
+export declare class Images {
+    private images;
+    constructor();
+    add(image: Image): Promise<Image>;
+}

package/models/nautilus.d.ts

@@ -0,0 +1,75 @@
+export interface BookCreationRequest {
+    title: string;
+    coverSpecId: string;
+    styleId: number;
+    userId: string;
+    magicShopBook: MagicShopBook;
+    reportingData: ReportingData;
+}
+export interface MagicShopBook {
+    pages: Page[];
+    photoStrip: PhotoStrip[];
+}
+export interface Page {
+    pageNum: number;
+    type: string;
+    canvas: Canvas;
+}
+export interface Canvas {
+    backgroundId?: string;
+    assets: Asset[];
+}
+export interface Asset {
+    type: string;
+    imageAssignment?: ImageAssignment;
+    position: Position;
+    seqNum: number;
+    z: number;
+    id?: string;
+    horizJustification?: string;
+    vertJustification?: string;
+    text?: string;
+    fontId?: string;
+    fontSize?: number;
+    fontColor?: string;
+    frame?: string;
+}
+export interface ImageAssignment {
+    photoRefId: number;
+    finalCrop: number[];
+}
+export interface Position {
+    x: number;
+    y: number;
+    width?: number;
+    height?: number;
+    rotation: number;
+}
+export interface PhotoStrip {
+    url: string;
+    encryptId: string;
+    photoRefId: number;
+    photoMetadata: PhotoMetadata;
+}
+export interface PhotoMetadata {
+    id: string;
+    llx: number;
+    lly: number;
+    urx: number;
+    ury: number;
+    data: string;
+    title: string;
+    width: number;
+    effect: string;
+    height: number;
+    source: string;
+    rotation: number;
+    uploadTime: string;
+}
+export interface ReportingData {
+    properties: Property[];
+}
+export interface Property {
+    key: string;
+    value: string | number | boolean | null;
+}

package/package.json

@@ -0,0 +1,46 @@
+{
+  "name": "@magiclabs.ai/magicbook-client",
+  "private": false,
+  "version": "0.2.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",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/56kcloud/mb-client.git"
+  },
+  "exports": {
+    ".": {
+      "import": "./magicbook-client.js",
+      "require": "./magicbook-client.umd.cjs"
+    }
+  },
+  "scripts": {
+    "watch": "vite build --watch",
+    "build": "./scripts/build.sh",
+    "deploy": "./scripts/deploy-npm.sh",
+    "lint": "eslint . --ext js,jsx,ts,tsx --config .eslintrc.json --no-eslintrc",
+    "test": "vitest --ui",
+    "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",
+    "eslint-plugin-sort-imports-es6-autofix": "^0.6.0",
+    "jsdom": "^21.1.1",
+    "typescript": "^5.0.2",
+    "vite": "^4.2.1",
+    "vite-plugin-dts": "^2.1.0",
+    "vitest": "^0.29.8"
+  },
+  "dependencies": {
+    "@faker-js/faker": "^7.6.0",
+    "axios": "^1.3.4"
+  }
+}