@magiclabs.ai/magicbook-client 0.2.0 → 0.3.0

package/README.md

@@ -0,0 +1,109 @@
+
+![GitHub CI](https://github.com/magiclabs-ai/mb-client/actions/workflows/test.yml/badge.svg) ![GitHub CI](https://github.com/magiclabs-ai/mb-client/actions/workflows/linter.yml/badge.svg) [![npm version](https://img.shields.io/npm/v/@magiclabs.ai/magicbook-client.svg)](https://www.npmjs.com/package/@magiclabs.ai/magicbook-client)
+
+# magicbook-client
+
+TypeScript package to create photo books with the Magicbook API.
+
+## Installation
+
+```bash
+npm install @magiclabs.ai/magicbook-client
+```
+
+## Usage
+
+Create a Magicbook API client instance with your API key. 
+
+```ts
+const client = new MagicBookClient('api-key')`
+```
+
+Initiate the creation of a photo book by creating a design request. The design request can be initialized by passing parameters (design choices) to the initialization object.
+
+```ts
+const designRequest = await client.createDesignRequest({
+  title: 'Australia 2023',
+  occasion: 'travel',
+  style: '1234',
+  bookSize: '8x8',
+  coverType: 'hc',
+  pageType: 'sp'
+})
+```
+
+Individual parameters can also be set directly on the design request instance:
+
+```ts
+const designRequest = await client.createDesignRequest()
+designRequest.title = 'Australia 2023',
+designRequest.occasion = 'travel',
+designRequest.style = '1234',
+designRequest.bookSize = '8x8',
+designRequest.coverType = 'hc',
+designRequest.pageType = 'sp'
+```
+As images are getting ready to be handed over to Magicbook, for example when successfully uploaded, add them to the design request object.
+
+```ts
+import {Image} from '@magiclabs.ai/magicbook-client'
+
+const image: Image = {...}
+await designRequest.images.add(image)
+```
+
+This would typically be done in an event handler connected to the image manager.
+
+```ts
+window.addEventListener('ImageManager.ImageUploaded', async (item) => {
+  const image: DesignRequestImage = {...}
+  await designRequest.images.add(image)
+})
+```
+
+Optionally, you can retrieve design options for the design request by calling the `getOptions` method, providing the total number of images selected by the user. The returned object contains the image densities (i.e. page count and image per page estimations)
+
+```ts
+const selectedImageCount = 200
+...
+const designOptions = designRequest.getOptions(selectedImageCount)
+```
+
+Before submitting the design request to Magicbook, register a callback to receive update events.
+
+```ts
+window.addEventListener('Magicbook.designRequestUpdated', async ((designRequestEvent: DesignRequestEvent) => {
+  console.log(designRequestEvent.detail)
+}) as EventListener)
+```
+
+Submit the design request. Again, the argument object can receive additional or updated design parameters.
+
+```ts
+designRequest.submit({
+  imageDensity: 'high',
+  imageFiltering: 'best',
+  embellishmentLevel: 'few',
+  textStickerLevel: 'none'
+})
+```
+
+Finally, once the design request is complete, retrieve it in JSON format.
+
+```ts
+await designRequest.getJSON()
+```
+
+___
+
+
+## Example
+
+To see the Magicbook client in action, run the following commands after navigating to the `./example` directory:
+
+```bash
+npm run build
+cd example
+npm i
+npm run dev
+```

package/data/design-options.d.ts

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

package/data/design-request.d.ts

@@ -0,0 +1,10 @@
+export declare const States: readonly ["new", "designing", "completed", "canceled", "error"];
+export declare const Occasions: readonly ["baby", "birthday", "default", "everyday", "family", "kids", "life-stories", "none", "portfolio", "school-memories", "seasonal-holidays", "special-celebrations", "sports-and-hobbies", "travel", "wedding", "year-in-review"];
+export declare const Styles: readonly ["2020-what-a-year-sfly", "a-year-in-color-sfly", "adventure-awaits-sfly", "autumn-memories-sfly", "babys-first-sfly", "babys-first-year-sfly", "beach-bliss-sfly", "beach-travel-sfly", "beach-wedding-sfly", "best-dad-ever-sfly", "best-day-ever-sfly", "best-grandparents-ever-sfly", "best-mom-ever-sfly", "black-and-white-rustic-sfly", "black-white-photo-album-sfly", "boho-baby-sfly", "boho-summer-sfly", "boho-travel-by-umaiana-studio-sfly", "boho-wedding-sfly", "bold-year-in-review-by-float-paperie-sfly", "bon-voyage-sfly", "bright-and-bold-kids-year-in-review-by-sarah-hawkins-designs-sfly", "bright-color-pop-sfly", "celebrate-family-by-float-paperie-sfly", "celebration-of-life-by-sarah-hawkins-designs-sfly", "chalkboard-chic-sfly", "cheerful-color-sfly", "chic-celebrations-by-float-paperie-sfly", "classic-baby-sfly", "classic-disney-sfly", "classic-recipes-sfly", "classic-school-yearbook-sfly", "classic-wedding-mma", "classic-wedding-sfly", "colorful-birthday-sfly", "colorful-childhood-sfly", "colorful-elementary-school-yearbook-sfly", "colorful-florals-by-potts-design-sfly", "colorful-gradients-sfly", "colorful-memories-by-britt-bass-sfly", "colorful-school-days-by-float-paperie-sfly", "colorful-year-in-review-by-sarah-hawkins-designs-sfly", "colorfully-fun-sfly", "digiscrap-sfly", "disney-adventure-sfly", "disney-family-adventures-sfly", "elegant-wedding-greenery-by-kim-thoa-sfly", "elegant-wedding-sfly", "elegantly-scripted-year-in-review-sfly", "elevated-rustic-sfly", "everyday-boho-by-umaiana-studio-sfly", "everyday-chalkboard-by-potts-design-sfly", "everyday-fairytale-by-jenny-romanski-sfly", "everyday-happiness-sfly", "everyday-indigo-sfly", "everyday-neutrals-sfly", "everyday-recipes-by-slightly-stationery-sfly", "everyday-rustic-sfly", "everyday-sentiments-sfly", "everyday-watercolor-sfly", "everything-sports-sfly", "family-blessings-by-potts-design-sfly", "family-favorites-by-lure-design-sfly", "family-vacation-sfly", "family-yearbook-sfly", "familygram-sfly", "forever-love-by-with-merriment-sfly", "fun-in-the-sun-sfly", "gilded-wedding-guestbook-sfly", "gilded-wedding-sfly", "go-sports-by-lure-design-sfly", "graduation-celebration-sfly", "graduation-photo-album-sfly", "hello-spring-sfly", "hello-summer-sfly", "high-school-memories-sfly", "holiday-memories-sfly", "its-a-girl-thing-sfly", "kraft-pop-sfly", "life-is-grand-sfly", "little-love-sfly", "love-and-thanks-sfly", "love-grows-sfly", "love-is-all-we-need-sfly", "love-you-because-sfly", "made-with-love-sfly", "milestone-anniversaries-sfly", "modern-baby-sfly", "modern-black-sfly", "modern-celebrations-sfly", "modern-dark-neutrals-sfly", "modern-grey-sfly", "modern-indigo-sfly", "modern-light-neutrals-sfly", "modern-love-story-sfly", "modern-photo-album-sfly", "modern-travel-sfly", "modern-wedding-mma", "modern-wedding-sfly", "modern-wedding-story-sfly", "modern-white-sfly", "modern-year-in-review-photo-album-sfly", "muted-everyday-abstract-sfly", "national-parks-travel-by-eiman-design-co-sfly", "natural-neutrals-sfly", "ombre-watercolor-sfly", "our-wedding-day-guestbook-sfly", "our-wedding-day-sfly", "outdoor-adventures-by-sarah-hawkins-designs-sfly", "outdoor-wedding-sfly", "painted-seasons-sfly", "pet-lover-sfly", "reunion-sfly", "road-trip-travel-by-sarah-hawkins-designs-sfly", "rustic-farmhouse-sfly", "rustic-gilded-wedding-sfly", "rustic-wedding-mma", "rustic-wedding-sfly", "school-days-yearbook-sfly", "shimmer-and-shine-sfly", "simple-elegant-wedding-sfly", "simply-black-sfly", "simply-bold-type-sfly", "simply-gallery-sfly", "simply-gray-sfly", "simply-modern-sfly", "simply-scrapbook-sfly", "softly-rustic-sfly", "sparkle-and-shine-sfly", "summertime-fun-sfly", "the-story-of-me-sfly", "the-travel-bug-sfly", "this-is-love-sfly", "together-again-sfly", "travel-abroad-sfly", "travel-adventures-sfly", "travel-gallery-sfly", "travel-memories-sfly", "travel-snapshots-sfly", "tropical-travel-sfly", "tropical-travels-sfly", "usa-travel-sfly", "vintage-disney-sfly", "vintage-travel-sfly", "vintage-wedding-sfly", "vivid-watercolor-sfly", "watercolor-baby-boy-sfly", "watercolor-baby-girl-sfly", "watercolor-floral-wedding-by-kim-thoa-sfly", "watercolor-greenery-by-sarah-hawkins-designs-sfly", "watercolor-year-in-review-sfly", "watercolorwashes-sfly", "wedding-gallery-sfly", "welcome-baby-sfly", "what-i-love-about-you-sfly", "whimsical-recipes-by-slightly-stationery-sfly", "whimsy-chalkboard-sfly", "winter-getaway-sfly", "winter-memories-by-sarah-hawkins-design-sfly", "world-travel-sfly"];
+export declare const BookSizes: readonly ["8x8", "10x10", "12x12", "8x11", "11x8", "11x14"];
+export declare const CoverTypes: readonly ["sc", "hc", "pl"];
+export declare const PageTypes: readonly ["sp", "sl", "dl"];
+export declare const ImageDensities: readonly ["low", "medium", "high"];
+export declare const ImageFilterings: readonly ["best", "most", "all"];
+export declare const EmbellishmentLevels: readonly ["none", "few", "lots"];
+export declare const TextStickerLevels: readonly ["none", "few", "lots"];

package/data/galleon.d.ts

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

package/index.d.ts

@@ -1,3 +1,3 @@
-export { default as MagicBookClient } from './models/client';
-export type { Image } from './models/image';
-export type { DesignRequestEvent, DesignRequestProps, DesignRequestEventDetail } from './models/design-request';
+export * from './models/client';
+export * from './models/design-request/image';
+export * from './models/design-request';