{"_id":"@amplience/content-studio-sdk","_rev":"5-6a71aae6d7694a3ab310fee0211a4f39","name":"@amplience/content-studio-sdk","dist-tags":{"latest":"0.1.1"},"versions":{"0.1.1":{"name":"@amplience/content-studio-sdk","version":"0.1.1","license":"Apache-2.0","_id":"@amplience/content-studio-sdk@0.1.1","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"}],"dist":{"shasum":"06a6a639351e94c82636775b1c1236d39136ddff","tarball":"https://registry.npmjs.org/@amplience/content-studio-sdk/-/content-studio-sdk-0.1.1.tgz","fileCount":20,"integrity":"sha512-5I2fWK9sTm7ZhpBfMUZ3K3pRR7IdadR2DG9ZCWrZ7jM5QmVsj2lutlL4bLC1kZUCp7AUFxapBpoIE1bskJ3Nag==","signatures":[{"sig":"MEUCIQCayYOOxES4f1e0wOmqRTX2G2FwIllVqyvb15AwKKelogIgFw7UL92aJo4b9l/NpahR4WSMejUMUoHjq5MwNxilbjc=","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":18653},"main":"./dist/cjs/index.js","type":"module","types":"./dist/cjs/index.d.ts","module":"./dist/esm/index.js","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":"33d021cb491fc8c64488466ae1f145086a382f5f","scripts":{"lint":"eslint --ext js,ts,tsx .","build":"npm-run-all clean build:cjs build:esm","clean":"rimraf dist","build:cjs":"tsc --project tsconfig.json --module commonjs --outDir ./dist/cjs/","build:esm":"tsc --project tsconfig.json --module es2022 --outDir ./dist/esm/","storybook":"storybook dev -p 6006","build-storybook":"storybook build"},"_npmUser":{"name":"amp-automation","email":"opssupport@amplience.com"},"_npmVersion":"10.5.0","description":"> Official SDK for embedding Amplience Content Studio","directories":{},"_nodeVersion":"20.12.2","dependencies":{"message-event-channel":"^1.1.0"},"_hasShrinkwrap":false,"devDependencies":{"react":"^18.2.0","rimraf":"5.0.5","copyfiles":"^2.4.1","react-dom":"^18.2.0","storybook":"^7.6.16","typescript":"","npm-run-all":"^4.1.5","@storybook/html":"^7.6.16","@storybook/test":"^7.6.16","@storybook/blocks":"^7.6.16","@storybook/html-vite":"^7.6.16","@storybook/addon-links":"^7.6.16","@storybook/addon-essentials":"^7.6.16","@storybook/addon-interactions":"^7.6.16"},"_npmOperationalInternal":{"tmp":"tmp/content-studio-sdk_0.1.1_1716393087586_0.808592388457585","host":"s3://npm-registry-packages"}}},"time":{"created":"2024-05-22T15:51:27.461Z","modified":"2025-06-16T11:31:12.061Z","0.1.1":"2024-05-22T15:51:27.748Z"},"license":"Apache-2.0","description":"> Official SDK for embedding Amplience Content Studio","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/content-studio-sdk\n\n> Official SDK for embedding Amplience Content Studio\n\nThis SDK is designed to help embed the Amplience Content Studio into business admin interfaces, allowing merchants, marketers and authors to generate content as part of their existing tools and workflow.\n\n\n## Installation\n\nUsing npm:\n\n```sh\nnpm install @amplience/content-studio-sdk --save\n```\n\n## Usage\n\nES6:\n\n```js\nimport { AmplienceContentStudio } from '@amplience/content-studio-sdk';\n\nconst sdk = new AmplienceContentStudio();\n```\n\nCommonJS:\n\n```js\nconst { AmplienceContentStudio } = require('@amplience/content-studio-sdk');\n\nconst sdk = new AmplienceContentStudio();\n```\n\n### Get Content\n\nThe SDK can be used to launch Content Studio, allowing the user to generate or select previously created content and return it to your application.\n\n```js\nsdk.getContent()\n    .then((result) => {\n        console.log('received content', result);\n    })\n    .catch((error) => {\n        console.log('received error', error);\n    });\n```\n\nThis will return an object with a success indicator, the content itself, and information about the template that generated the content.\n\n```json\n{\n    \"success\": true,\n    \"template\": {\n        \"id\": \"Q29udGVudEdlbmVyYXRpb25CcmllZlRlbXBsYXRlOnByb2R1Y3QtZGVzY3JpcHRpb24=\",\n        \"label\": \"Product description\"\n    },\n    \"content\": {\n        // Will vary by type of content\n        \"description\": \"Lorem ipsum dolor sit amet...\",\n    },\n}\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.","readmeFilename":"README.md"}