{"_id":"@amplience/image-studio-sdk","_rev":"9-aa497b00fafd17017ee6747b16df4712","name":"@amplience/image-studio-sdk","dist-tags":{"latest":"0.5.1"},"versions":{"0.1.0":{"name":"@amplience/image-studio-sdk","version":"0.1.0","keywords":[],"author":"","license":"Apache-2.0","_id":"@amplience/image-studio-sdk@0.1.0","maintainers":[{"name":"sclarke-amplience","email":"sclarke@amplience.com"},{"name":"rezakalfane","email":"reza.kalfane@gmail.com"},{"name":"rs-amp","email":"rsimpson@amplience.com"},{"name":"techiedarren","email":"npm@dmlee.me"},{"name":"srweeks","email":"sweeks@amplience.com"},{"name":"amplience-admin","email":"operations@amplience.com"},{"name":"petercoulton-human","email":"petercoulton@gmail.com"},{"name":"easen-amp","email":"measen@amplience.com"},{"name":"ccorbett","email":"ccorbett@amplience.com"},{"name":"liliiamykhailova","email":"lmykhailova@amplience.com"},{"name":"gbrown-amp","email":"gbrown@amplience.com"},{"name":"nsmith-amp","email":"nsmith@amplience.com"},{"name":"amp-automation","email":"opssupport@amplience.com"}],"homepage":"https://github.com/amplience/image-studio-sdk#readme","bugs":{"url":"https://github.com/amplience/image-studio-sdk/issues"},"dist":{"shasum":"9dbce10b3333306ad717bad3b0006c9266d0e1da","tarball":"https://registry.npmjs.org/@amplience/image-studio-sdk/-/image-studio-sdk-0.1.0.tgz","fileCount":75,"integrity":"sha512-efmAm2AdKlhKhsKQ/SVBD4iity5AOUIFGpzcldNPCWjXJMo+ARPFPwz/ncXVDvJcoNVMYQzJzGP50qNIP2pj/w==","signatures":[{"sig":"MEYCIQDtI2DIfb/brznd4slZCV0rio4eHaI3jD9KGXWBOTkRfAIhAMz8S+xgHoJcovYmCylGUCxPyDl3KS3DWtABeF4LrI6U","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":40490},"main":"dist/cjs/index.js","type":"module","exports":{"import":{"types":"./dist/esm/index.d.ts","default":"./dist/esm/index.js"},"require":{"types":"./dist/cjs/index.d.ts","default":"./dist/cjs/index.js"}},"gitHead":"343bb844db16cac837ec28be3c90ae3786e8753e","scripts":{"fix":"eslint . --fix --ext .ts","lint":"eslint . --ext .ts --max-warnings 0","build":"npm-run-all clean build:cjs build:esm","clean":"rimraf dist","build:cjs":"tsc --project tsconfig.json --outdir ./dist/cjs/","build:esm":"tsc --project tsconfig.json --module es2022 --outdir ./dist/esm/","storybook":"storybook dev -p 6006","build-storybook":"storybook build"},"typings":"dist/cjs/index.d.ts","_npmUser":{"name":"amp-automation","email":"opssupport@amplience.com"},"repository":{"url":"git+https://github.com/amplience/image-studio-sdk.git","type":"git"},"_npmVersion":"10.5.0","description":"Image Studio SDK","directories":{},"_nodeVersion":"20.12.2","_hasShrinkwrap":false,"devDependencies":{"eslint":"^8.57.0","rimraf":"^6.0.0","prettier":"^3.3.2","storybook":"^8.2.1","typescript":"^5.5.3","npm-run-all":"^4.1.5","@storybook/html":"^8.2.1","@storybook/test":"^8.2.1","@storybook/blocks":"^8.2.1","@storybook/html-vite":"^8.2.1","@storybook/addon-links":"^8.2.1","eslint-config-prettier":"^9.1.0","eslint-plugin-prettier":"^5.1.3","eslint-plugin-storybook":"^0.8.0","@chromatic-com/storybook":"^1.6.1","@storybook/addon-essentials":"^8.2.1","@storybook/addon-interactions":"^8.2.1","@typescript-eslint/eslint-plugin":"^7.16.0"},"_npmOperationalInternal":{"tmp":"tmp/image-studio-sdk_0.1.0_1725899984200_0.2001098581074603","host":"s3://npm-registry-packages"}},"0.3.0":{"name":"@amplience/image-studio-sdk","version":"0.3.0","keywords":[],"license":"Apache-2.0","_id":"@amplience/image-studio-sdk@0.3.0","maintainers":[{"name":"sclarke-amplience","email":"sclarke@amplience.com"},{"name":"rezakalfane","email":"reza.kalfane@gmail.com"},{"name":"rs-amp","email":"rsimpson@amplience.com"},{"name":"techiedarren","email":"npm@dmlee.me"},{"name":"srweeks","email":"sweeks@amplience.com"},{"name":"amplience-admin","email":"operations@amplience.com"},{"name":"petercoulton-human","email":"petercoulton@gmail.com"},{"name":"easen-amp","email":"measen@amplience.com"},{"name":"ccorbett","email":"ccorbett@amplience.com"},{"name":"liliiamykhailova","email":"lmykhailova@amplience.com"},{"name":"gbrown-amp","email":"gbrown@amplience.com"},{"name":"nsmith-amp","email":"nsmith@amplience.com"},{"name":"amp-automation","email":"opssupport@amplience.com"}],"homepage":"https://github.com/amplience/image-studio-sdk#readme","bugs":{"url":"https://github.com/amplience/image-studio-sdk/issues"},"auto":{"plugins":["npm","conventional-commits","protected-branch"]},"dist":{"shasum":"00898fc0f1c38cf99adb5713b66ce2a982f9d5b1","tarball":"https://registry.npmjs.org/@amplience/image-studio-sdk/-/image-studio-sdk-0.3.0.tgz","fileCount":76,"integrity":"sha512-Y1OyDdI+vwHkPictqXlb0UQrXmIuqob35fpW/SMTNKwFkRdOh9MzO0J8Meyk4JmSi+c8c6JypuzSpXTsklyF5w==","signatures":[{"sig":"MEUCIQCp9LMCBkhYEielUSyc2moAiKj1jsMlBfVazbHyAKROZQIgC9Qrv2KBh7Ge8Be7rwsi2ULq5FVb1rBghsNpNjLLYPY=","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":50536},"main":"dist/cjs/index.js","type":"module","exports":{"import":{"types":"./dist/esm/index.d.ts","default":"./dist/esm/index.js"},"require":{"types":"./dist/cjs/index.d.ts","default":"./dist/cjs/index.js"}},"gitHead":"906223506e73e703cc0838344730d53c099b9015","scripts":{"fix":"eslint . --fix --ext .ts","lint":"eslint . --ext .ts --max-warnings 0","build":"npm-run-all clean build:cjs build:esm","clean":"rimraf dist","build:cjs":"tsc --project tsconfig.json --outdir ./dist/cjs/","build:esm":"tsc --project tsconfig.json --module es2022 --outdir ./dist/esm/","storybook":"storybook dev -p 6006","build-storybook":"storybook build"},"typings":"dist/cjs/index.d.ts","_npmUser":{"name":"amp-automation","email":"opssupport@amplience.com"},"repository":{"url":"git+https://github.com/amplience/image-studio-sdk.git","type":"git"},"_npmVersion":"10.5.0","description":"Image Studio SDK","directories":{},"_nodeVersion":"20.12.2","_hasShrinkwrap":false,"devDependencies":{"auto":"^11.2.1","eslint":"^8.57.0","rimraf":"^6.0.0","prettier":"^3.3.2","storybook":"^8.2.1","typescript":"^5.5.3","npm-run-all":"^4.1.5","@storybook/html":"^8.2.1","@storybook/test":"^8.2.1","@storybook/blocks":"^8.2.1","@storybook/html-vite":"^8.2.1","@storybook/addon-links":"^8.2.1","eslint-config-prettier":"^9.1.0","eslint-plugin-prettier":"^5.1.3","eslint-plugin-storybook":"^0.8.0","@chromatic-com/storybook":"^1.6.1","@auto-it/protected-branch":"^11.2.1","@storybook/addon-essentials":"^8.2.1","@auto-it/conventional-commits":"^11.2.1","@storybook/addon-interactions":"^8.2.1","@typescript-eslint/eslint-plugin":"^7.16.0"},"_npmOperationalInternal":{"tmp":"tmp/image-studio-sdk_0.3.0_1729248525182_0.40317380413502524","host":"s3://npm-registry-packages"}},"0.4.0":{"name":"@amplience/image-studio-sdk","version":"0.4.0","keywords":[],"license":"Apache-2.0","_id":"@amplience/image-studio-sdk@0.4.0","maintainers":[{"name":"amp-adm-srv-npm","email":"amp-adm-srv-npm@amplience.com"},{"name":"gnewso","email":"gnewsome@amplience.com"},{"name":"rs-amp","email":"rsimpson@amplience.com"},{"name":"techiedarren","email":"npm@dmlee.me"},{"name":"srweeks","email":"sweeks@amplience.com"},{"name":"amplience-admin","email":"operations@amplience.com"},{"name":"petercoulton-human","email":"petercoulton@gmail.com"},{"name":"easen-amp","email":"measen@amplience.com"},{"name":"ccorbett","email":"ccorbett@amplience.com"},{"name":"gbrown-amp","email":"gbrown@amplience.com"},{"name":"nsmith-amp","email":"nsmith@amplience.com"},{"name":"amp-automation","email":"opssupport@amplience.com"}],"homepage":"https://github.com/amplience/image-studio-sdk#readme","bugs":{"url":"https://github.com/amplience/image-studio-sdk/issues"},"auto":{"plugins":["npm","conventional-commits","protected-branch"]},"dist":{"shasum":"ed97e9fef2587ef89a0caf8131dca07b717610de","tarball":"https://registry.npmjs.org/@amplience/image-studio-sdk/-/image-studio-sdk-0.4.0.tgz","fileCount":76,"integrity":"sha512-LxGXNONEz6Pt7f6yhGAnWRy1ZKR//etan1uKIckz0fANPCoPVVzCMU02iNZYWKF0tQPkxNG2CQ5eS/bK2re79A==","signatures":[{"sig":"MEYCIQDmakNhV1xI1PwJA3r3a4dB3HggRaH8HaZhrrhNhCJhxgIhAKar2tQYuLjSyWw870NPLIHtM/N16J0zIVOu7miBuY5F","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":54063},"main":"dist/cjs/index.js","type":"module","exports":{"import":{"types":"./dist/esm/index.d.ts","default":"./dist/esm/index.js"},"require":{"types":"./dist/cjs/index.d.ts","default":"./dist/cjs/index.js"}},"gitHead":"056426acdd640b99f25a583198059dee4f347c73","scripts":{"fix":"eslint . --fix --ext .ts","lint":"eslint . --ext .ts --max-warnings 0","build":"npm-run-all clean build:cjs build:esm","clean":"rimraf dist","build:cjs":"tsc --project tsconfig.json --outdir ./dist/cjs/","build:esm":"tsc --project tsconfig.json --module es2022 --outdir ./dist/esm/","storybook":"storybook dev -p 6006","build-storybook":"storybook build"},"typings":"dist/cjs/index.d.ts","_npmUser":{"name":"amp-automation","email":"opssupport@amplience.com"},"repository":{"url":"git+https://github.com/amplience/image-studio-sdk.git","type":"git"},"_npmVersion":"10.5.0","description":"Image Studio SDK","directories":{},"_nodeVersion":"20.12.2","_hasShrinkwrap":false,"devDependencies":{"auto":"^11.2.1","eslint":"^8.57.0","rimraf":"^6.0.0","prettier":"^3.3.2","storybook":"^8.2.1","typescript":"^5.5.3","npm-run-all":"^4.1.5","@storybook/html":"^8.2.1","@storybook/test":"^8.2.1","@storybook/blocks":"^8.2.1","@storybook/html-vite":"^8.2.1","@storybook/addon-links":"^8.2.1","eslint-config-prettier":"^9.1.0","eslint-plugin-prettier":"^5.1.3","eslint-plugin-storybook":"^0.8.0","@chromatic-com/storybook":"^1.6.1","@auto-it/protected-branch":"^11.2.1","@storybook/addon-essentials":"^8.2.1","@auto-it/conventional-commits":"^11.2.1","@storybook/addon-interactions":"^8.2.1","@typescript-eslint/eslint-plugin":"^7.16.0"},"_npmOperationalInternal":{"tmp":"tmp/image-studio-sdk_0.4.0_1731667550988_0.07027001870101857","host":"s3://npm-registry-packages"}},"0.5.0":{"name":"@amplience/image-studio-sdk","version":"0.5.0","keywords":[],"license":"Apache-2.0","_id":"@amplience/image-studio-sdk@0.5.0","maintainers":[{"name":"amplience-admin","email":"operations@amplience.com"},{"name":"petercoulton-human","email":"petercoulton@gmail.com"},{"name":"easen-amp","email":"measen@amplience.com"},{"name":"ccorbett","email":"ccorbett@amplience.com"},{"name":"gbrown-amp","email":"gbrown@amplience.com"},{"name":"nsmith-amp","email":"nsmith@amplience.com"},{"name":"amp-automation","email":"opssupport@amplience.com"},{"name":"srweeks","email":"sweeks@amplience.com"},{"name":"techiedarren","email":"npm@dmlee.me"},{"name":"rs-amp","email":"rsimpson@amplience.com"},{"name":"amp-adm-srv-npm","email":"amp-adm-srv-npm@amplience.com"},{"name":"gnewso","email":"gnewsome@amplience.com"}],"homepage":"https://github.com/amplience/image-studio-sdk#readme","bugs":{"url":"https://github.com/amplience/image-studio-sdk/issues"},"auto":{"plugins":["npm","conventional-commits","protected-branch"]},"dist":{"shasum":"f7a39ee757556816fbde24bddab5c5181344e04d","tarball":"https://registry.npmjs.org/@amplience/image-studio-sdk/-/image-studio-sdk-0.5.0.tgz","fileCount":148,"integrity":"sha512-zariEfq3QvMRfe+SLMsfOI3Zp1WtiPzd0S0SK00J9GlRdDKmj+6KwHd2WyBPnIT0KQNFlpNMdz/ol7GcbIowyA==","signatures":[{"sig":"MEYCIQCMppOQgTfav4rJasa9eiewvVfIrCzAED+Hpj/UZ8c4GAIhANMBnwxFqp2dqsCTte9zAMRPP0lPXcc4/8e96gjb/3s6","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":98285},"main":"dist/cjs/index.js","type":"module","exports":{"import":{"types":"./dist/esm/index.d.ts","default":"./dist/esm/index.js"},"require":{"types":"./dist/cjs/index.d.ts","default":"./dist/cjs/index.js"}},"gitHead":"7bb8dc8bf423f9564fe1539a3f818e4d121f4be6","scripts":{"fix":"eslint . --fix --ext .ts","lint":"eslint . --ext .ts --max-warnings 0","build":"npm-run-all clean build:cjs build:esm","clean":"rimraf dist","prepare":"husky","build:cjs":"tsc --project tsconfig.json --outdir ./dist/cjs/","build:esm":"tsc --project tsconfig.json --module es2022 --outdir ./dist/esm/","precommit":"npm run lint","storybook":"storybook dev -p 6006","build-storybook":"storybook build"},"typings":"dist/cjs/index.d.ts","_npmUser":{"name":"amp-automation","email":"opssupport@amplience.com"},"repository":{"url":"git+https://github.com/amplience/image-studio-sdk.git","type":"git"},"_npmVersion":"10.5.0","description":"Image Studio SDK","directories":{},"_nodeVersion":"20.12.2","_hasShrinkwrap":false,"devDependencies":{"auto":"^11.2.1","husky":"^9.1.6","eslint":"^8.57.0","rimraf":"^6.0.0","prettier":"^3.3.2","storybook":"^8.2.1","typescript":"^5.5.3","npm-run-all":"^4.1.5","@storybook/html":"^8.2.1","@storybook/test":"^8.2.1","@storybook/blocks":"^8.2.1","@storybook/html-vite":"^8.2.1","@storybook/addon-links":"^8.2.1","eslint-config-prettier":"^9.1.0","eslint-plugin-prettier":"^5.1.3","eslint-plugin-storybook":"^0.8.0","@chromatic-com/storybook":"^1.6.1","@auto-it/protected-branch":"^11.2.1","@storybook/addon-essentials":"^8.2.1","@auto-it/conventional-commits":"^11.2.1","@storybook/addon-interactions":"^8.2.1","@typescript-eslint/eslint-plugin":"^7.16.0"},"_npmOperationalInternal":{"tmp":"tmp/image-studio-sdk_0.5.0_1733488632550_0.0436516077114093","host":"s3://npm-registry-packages"}},"0.5.1":{"name":"@amplience/image-studio-sdk","version":"0.5.1","keywords":[],"license":"Apache-2.0","_id":"@amplience/image-studio-sdk@0.5.1","maintainers":[{"name":"amplience-admin","email":"operations@amplience.com"},{"name":"petercoulton-human","email":"petercoulton@gmail.com"},{"name":"easen-amp","email":"measen@amplience.com"},{"name":"ccorbett","email":"ccorbett@amplience.com"},{"name":"gbrown-amp","email":"gbrown@amplience.com"},{"name":"nsmith-amp","email":"nsmith@amplience.com"},{"name":"amp-automation","email":"opssupport@amplience.com"},{"name":"srweeks","email":"sweeks@amplience.com"},{"name":"techiedarren","email":"npm@dmlee.me"},{"name":"rs-amp","email":"rsimpson@amplience.com"},{"name":"amp-adm-srv-npm","email":"amp-adm-srv-npm@amplience.com"},{"name":"gnewso","email":"gnewsome@amplience.com"}],"homepage":"https://github.com/amplience/image-studio-sdk#readme","bugs":{"url":"https://github.com/amplience/image-studio-sdk/issues"},"auto":{"plugins":["npm","conventional-commits","protected-branch"]},"dist":{"shasum":"fc036413fe91917b961b503ff87944a872b3ae4e","tarball":"https://registry.npmjs.org/@amplience/image-studio-sdk/-/image-studio-sdk-0.5.1.tgz","fileCount":148,"integrity":"sha512-pflkuIt2tXa6PA6jvY4Nu8StO/WBe+dMzZJ/brBSurRySapc0mPKddq4f1OBJHwxh2T2V9Z1u3Eodll2/CloJw==","signatures":[{"sig":"MEQCIDV1eEIxgFkp13YWe95UfrNqVYdp1udg3kqfaq0luYM7AiAEi0nkuMwRVyBObWKGLubrtQznzrgUPKLVaEZPozNFWA==","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":101244},"main":"dist/cjs/index.js","type":"module","exports":{"import":{"types":"./dist/esm/index.d.ts","default":"./dist/esm/index.js"},"require":{"types":"./dist/cjs/index.d.ts","default":"./dist/cjs/index.js"}},"gitHead":"58b3f3e2dea21de07ec585940e88c01ae6ae9006","scripts":{"fix":"eslint . --fix --ext .ts","lint":"eslint . --ext .ts --max-warnings 0","build":"npm-run-all clean build:cjs build:esm","clean":"rimraf dist","prepare":"husky","build:cjs":"tsc --project tsconfig.json --outdir ./dist/cjs/","build:esm":"tsc --project tsconfig.json --module es2022 --outdir ./dist/esm/","precommit":"npm run lint","storybook":"storybook dev -p 6006","build-storybook":"storybook build"},"typings":"dist/cjs/index.d.ts","_npmUser":{"name":"amp-automation","email":"opssupport@amplience.com"},"repository":{"url":"git+https://github.com/amplience/image-studio-sdk.git","type":"git"},"_npmVersion":"10.5.0","description":"Image Studio SDK","directories":{},"_nodeVersion":"20.12.2","_hasShrinkwrap":false,"devDependencies":{"auto":"^11.2.1","husky":"^9.1.6","eslint":"^8.57.0","rimraf":"^6.0.0","prettier":"^3.3.2","storybook":"^8.2.1","typescript":"^5.5.3","npm-run-all":"^4.1.5","@storybook/html":"^8.2.1","@storybook/test":"^8.2.1","@storybook/blocks":"^8.2.1","@storybook/html-vite":"^8.2.1","@storybook/addon-links":"^8.2.1","eslint-config-prettier":"^9.1.0","eslint-plugin-prettier":"^5.1.3","eslint-plugin-storybook":"^0.8.0","@chromatic-com/storybook":"^1.6.1","@auto-it/protected-branch":"^11.2.1","@storybook/addon-essentials":"^8.2.1","@auto-it/conventional-commits":"^11.2.1","@storybook/addon-interactions":"^8.2.1","@typescript-eslint/eslint-plugin":"^7.16.0"},"_npmOperationalInternal":{"tmp":"tmp/image-studio-sdk_0.5.1_1734526773788_0.2986545096444111","host":"s3://npm-registry-packages-npm-production"}}},"time":{"created":"2024-09-09T16:39:44.095Z","modified":"2025-06-16T11:38:06.595Z","0.1.0":"2024-09-09T16:39:44.383Z","0.3.0":"2024-10-18T10:48:45.401Z","0.4.0":"2024-11-15T10:45:51.221Z","0.5.0":"2024-12-06T12:37:12.755Z","0.5.1":"2024-12-18T12:59:33.941Z"},"bugs":{"url":"https://github.com/amplience/image-studio-sdk/issues"},"license":"Apache-2.0","homepage":"https://github.com/amplience/image-studio-sdk#readme","keywords":[],"repository":{"url":"git+https://github.com/amplience/image-studio-sdk.git","type":"git"},"description":"Image Studio SDK","maintainers":[{"email":"operations@amplience.com","name":"amplience-admin"},{"email":"petercoulton@gmail.com","name":"petercoulton-human"},{"email":"measen@amplience.com","name":"easen-amp"},{"email":"ccorbett@amplience.com","name":"ccorbett"},{"email":"gbrown@amplience.com","name":"gbrown-amp"},{"email":"nsmith@amplience.com","name":"nsmith-amp"},{"email":"opssupport@amplience.com","name":"amp-automation"},{"email":"sweeks@amplience.com","name":"srweeks"},{"email":"npm@dmlee.me","name":"techiedarren"},{"email":"rsimpson@amplience.com","name":"rs-amp"},{"email":"amp-adm-srv-npm@amplience.com","name":"amp-adm-srv-npm"},{"email":"gnewsome@amplience.com","name":"gnewso"},{"email":"lkcheung@amplience.com","name":"labski42"}],"readme":"# @amplience/image-studio-sdk\n\n> Official SDK for embedding Amplience Image Studio\n\nThis SDK is designed to help embed the Amplience Image Studio into business admin interfaces, allowing merchants, marketers and authors to generate images as part of their existing tools and workflow.\n\n\n## Installation\n\nUsing npm:\n\n```sh\nnpm install @amplience/image-studio-sdk --save\n```\n\n## Usage\n\nES6:\n\n```js\nimport { AmplienceImageStudio } from '@amplience/image-studio-sdk';\n\nconst sdk = new AmplienceImageStudio();\n```\n\nCommonJS:\n\n```js\nconst { AmplienceImageStudio } = require('@amplience/image-studio-sdk');\n\nconst sdk = new AmplienceImageStudio();\n```\n\n_Creating a global instance of `AmplienceImageStudio` is advised against, and a new one should be created for each interaction due to shared promise management you may get expected results if you make asynchronous interactions with the same instance._\n## AmplienceImageStudio - Quick Start\n\n### Image Studio Actions\n\nEach action contains a default set of behavioural options:\n\n| Action | Options |\n|:----------|:-|\n| `editImages` | allowImageSave: true<br>allowLogout: false<br>allowCreate: false |\n| `launch` | allowImageSave: false<br>allowLogout: true<br>allowCreate: true |\n\nThe user can override the default action behaviours by adding the relevant options to the [`sdkMetadataOverride`](#sdkmetadata) member found within [`AmplienceImageStudioOptions`](#amplienceimagestudiooptions)\n\n#### Edit Images\n\nImage Studio expects an array of images for editing, once the user has editied the images and clicked 'Save Image', the resultant image will be returned within the response object and the Image Studio window will be closed.\n\n_Note: Image Studio currently only uses the first image you submit via this call_\n\n```js\nconst sdk = new AmplienceImageStudio({\n    domain: IMAGE_STUDIO_DOMAIN,\n}).withEventListener(ImageStudioEventType.ImageSave, (data) => {\n    const imageData = data as ImageSaveEventData;\n    // imageData.url = 'https://url-to-your-updated-image',\n    // imageData.name = 'updated-image-name',\n    // imageData.mimeType = 'image/jpeg',\n    return SDKEventType.Success;\n});\n\n// This action launches the studio, and resolves a successful promise once the session is closed\nawait sdk.editImages([{\n    url: 'https://url-to-your-image',\n    name: 'image-name',\n    mimeType: 'image/jpeg',\n}]);\n```\n\n#### Launch\n\nLaunches an Image Studio session standalone, which allows the user to select their own image for editing. Users are _not_ able to save content back to their application and will only be able to download their creations locally.\n\n```js\nconst sdk = new AmplienceImageStudio({\n    domain: IMAGE_STUDIO_DOMAIN,\n});\n\n// This action launches the studio in create mode, resolves a successful promise once the session is closed\nawait sdk.launch();\n```\n\n\n## AmplienceImageStudioOptions\n\nWhen creating an `AmplienceImageStudio` instance, the constructor takes an `AmplienceImageStudioOptions` object. This defines several options for customizing the behaviour of the studio:\n\n| Key | Description | Default | Optional |\n|:----------|:-------------|:-:|:-:|\n| domain |  base domain for your image-studio deployment | - | No |\n| sdkMetadataOverride |    object containing behavioural overrides for image-studio [SDKMetadata](#sdkmetadata)   | {} | Yes |\n| windowTarget | window.open() `target` override, please see [MDN](https://developer.mozilla.org/en-US/docs/Web/API/Window/open) | '_blank' | Yes |\n| windowFeatures | window.open() `windowFeatures` override, please see [MDN](https://developer.mozilla.org/en-US/docs/Web/API/Window/open) | '' | Yes |\n\n### SDKMetadata\n\nThis SDK controls certain behaviours within image-studio through optional enablement flags.\n\n_Failing to submit an option to image-studio will not result in any bad behaviour. Image-Studio determines and controls the default behaviour of every option, however the structure and options available are controlled by this SDK._\n\n| Option | Description | Default |\n|:----------|:-|:-:|\n| `allowImageSave` | allows content to be saved back to the SDK | `false` |\n| `allowLogout` | allows users to logout | `true` |\n| `allowCreate` | allows users to create new content | `true` |\n|`orgId`*| user organisation ID (used for entitlements and credit consumption) | ''\n\nAlong with the above options, some properties can be set following the builder pattern:\n\n\n```js\nconst sdk = new AmplienceImageStudio({domain: IMAGE_STUDIO_DOMAIN})\n    .withDecodedOrgId('Org_Exampleid');\n```\n\nHere are the options that use this approach:\n\n| Option | Description |\n|:----------|:-|\n| `.withEventListener(ImageStudioEventType.ImageSave, () => {return null;})` | - Allows for users to listen for, and respond to ImageStudioEvents. <br> - User callback must conform to [EventListenerCallback](#eventlistenercallback) <br> - `null` response signifies to use default studio response |\n| `.withEncodedOrgId('b3JnYW5pemF0aW9u')` | - Set the user organisation to be used for entitlements and credit consumption. <br> - must provide Base64 encoded ID i.e. GQL data|\n| `.withDecodedOrgId('Org_Exampleid')` |  - Set the user organisation to be used for entitlements and credit consumption. <br> - must provide plain text ID i.e. dc-extensions-sdk data|\n\n### EventListenerCallback\nYour callback will fire upon receiving the [ImageStudoEventType](./src/types/ImageStudioEventType.ts) that you scubscribed to when registering the callback.\n\nEvent Listeners Callbacks must either return a valid SDKEventType or NULL. \nEvent Listener Callbacks have [Configurations](./src/types/EventListenerCallback.ts) that dictate the valid SDKEventType's that a user can resolve, once validated an SDKEvent will be fired back to ImageStudio, these allow a user to react to Image Studio events and submit reactive responses to the Studio.\nIf a user resolves NULL, the SDK will lookup the `default` Image Studio response from the config, if this is `undefined`, then no response is sent to Image Studio.\n\n\n## Releases\n\n_TLDR `auto` will perform automatic canary builds on `push` and the full release (including version bumping) during PR merge._\n\nThis project uses `auto` for the release process, a conventional commits plugin handles version bumping based on the commit history. [Docs](https://intuit.github.io/auto/docs/generated/conventional-commits)\n\nThe release process follows the configuration [HERE](https://intuit.github.io/auto/docs/build-platforms/github-actions)\n\nWe have also included another plugin, `protected-branch` which works around the fact this repo contains branch protection on `main`. At the time of writing, this plugin isnot documented but the code can be found [HERE](https://github.com/intuit/auto/tree/main/plugins/protected-branch)\n\nThis project contains a Ruleset for `main`, with the following options enabled:\n```\n- Restrict creations\n- restrict deletions\n- block force pushes\n- Requires a pull request before merging\n    - approvals: 1\n    - dismiss stale pull requests\n    - require review from code owners\n    - require conversation resolution before merging\n```\n\nIn order to get around CODEOWNERS being required, we have followed the recommendations for adding @amplience/automation team as owners to `package.json`, `package-lock.json` and `CHANGELOG.md` - this allows `auto` to modify these at release time. The amp automation team also requires `admin` access to this github repo (repo -> settings -> collaborators and teams)\n\nThe release process requires a fine grained PAT token to perform the release process: this has been shared to this public repo through `secrets.GH_PUBLIC_REPO_CONTENTS_ACCESS`, the underlying token this references has been scoped to public repo's only. If this pattern is to be used against another project in future, and this is private, please add a PRIVATE variant of this PAT to cover private repos - otherwise add your project to the existing PAT token list of repositories. The purpose of `GH_PUBLIC_REPO_CONTENTS_ACCESS` secret is to cover _only_ public repositories.\n\nThe initial part of the release process (checkouts, builds and package write) is controlled by the auto generate `GH_TOKEN` user, we have scoped this user with the correct permissions as found under `permissions:` within [release.yml](.github/workflows/release.yml)\n\nThe `GH_PUBLIC_REPO_CONTENTS_ACCESS` PAT is specificially used for the latter `release` portion (ie non-canary builds) and this user requires special privileges to perform package writes, changelog updates and commit's back to the repo itself (this is done via PR). At the time of writing the repository persmissions (through fine grained PAT) are:\n\n```\n- actions: read and write\n- contents: read and write\n- pull-requests: read and write\n- issues: read\n- metadata: read\n```\n\n## License\n\nThis software is licensed under the [Apache License, Version 2.0](http://www.apache.org/licenses/LICENSE-2.0),\n\nCopyright 2024 Amplience\n\nLicensed under the Apache License, Version 2.0 (the \"License\");\nyou may not use this file except in compliance with the License.\nYou may obtain a copy of the License at\n\n    http://www.apache.org/licenses/LICENSE-2.0\n\nUnless required by applicable law or agreed to in writing, software\ndistributed under the License is distributed on an \"AS IS\" BASIS,\nWITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\nSee the License for the specific language governing permissions and\nlimitations under the License.\n","readmeFilename":"README.md"}