@magiclabs.ai/magicbook-client 0.2.0 → 0.2.1

package/README.md

@@ -0,0 +1,101 @@
+
+![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',
+  bookFormat: '8x8',
+  coverType: 'HC',
+  pageType: 'LF'
+})
+```
+
+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.bookFormat = '8x8',
+designRequest.coverType = 'HC',
+designRequest.pageType = 'LF'
+```
+
+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: Image = {...}
+  await designRequest.images.add(image)
+})
+```
+
+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',
+  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/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@magiclabs.ai/magicbook-client",
   "private": false,
-  "version": "0.2.0",
+  "version": "0.2.1",
   "description": "TypeScript package to create photo books with the Magicbook API.",
   "type": "module",
   "main": "./magicbook-client.umd.cjs",