{"_id":"@akordacorp/assembly","_rev":"4-47493a5963daf7f2da2c6d4f425eb33b","name":"@akordacorp/assembly","dist-tags":{"latest":"1.1.2"},"versions":{"1.0.0":{"name":"@akordacorp/assembly","version":"1.0.0","description":"Contract Assembly Integration Resources (JS/CSS)","main":"akorda-assembly.js","scripts":{"test":"echo \"Error: no test specified\" && exit 1"},"repository":{"type":"git","url":"git+ssh://git@gitlab.com/akordacorp/fe-assembly.git"},"author":{"name":"Matt Meiske"},"license":"ISC","bugs":{"url":"https://gitlab.com/akordacorp/fe-assembly/issues"},"homepage":"https://gitlab.com/akordacorp/fe-assembly#readme","gitHead":"27329d3afac51fbf2762428e12f2635d1137c549","_id":"@akordacorp/assembly@1.0.0","_nodeVersion":"14.18.1","_npmVersion":"6.14.15","dist":{"integrity":"sha512-8DHkP5RcSBvFf291o5Tm+/2l4/iA9VkCzOIwAruFQjkiOnqq4SqVsFWccGc24PFKkVa7N+gjLG3Dis5spoFBOA==","shasum":"2c608ec085d6b57275674d84e1187cd1fc631d19","tarball":"https://registry.npmjs.org/@akordacorp/assembly/-/assembly-1.0.0.tgz","fileCount":4,"unpackedSize":2040563,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v4.10.10\r\nComment: https://openpgpjs.org\r\n\r\nwsFzBAEBCAAGBQJiKi5HACEJED1NWxICdlZqFiEECWMYAoorWMhJKdjhPU1b\r\nEgJ2VmqnAg//chtQCYeaJSO7dehLaVIt5rq35/PYE3wrVI3rSrGf0k/6FPpV\r\noUJgpe9tMhWHLRVnmFNeMsuZZihAthq+nwPuRAvDM7IilaB+b6ExUs982F6X\r\nC5g1XxSAJAWdxT94eblVE4jjF9R/5MpYAc91cEw9gR6l5cZmIFPNWnuiGZ8N\r\nzZUDPwBShpvg/zATRZTch4MN5OgwqI8iKwcXVu/KDQbRWuBy1KZlPtALdFq3\r\nDOPGCLO15F1Jq7CGzHTWDdGM6qKWBSce3oQGlBgR98FfDi3f6Wucy6GLNDmG\r\n04TY7V5ET4JSfCh/XBY2xlbWrYAB66pWot+pwNBSPBDKYxoFgg45yzmxeVM+\r\n5UqJpBGYCgOGjXoG0M86dgMTHtzvhA/9KlqGcI2533SmMshgIilBiZu3z+ie\r\njpzJWRYWCGvgmXo2qBv+7nRv6rm9CFhPIhhZZbgmmr4sozwDuFqC6TA2obNt\r\ndOQAecpt0Iy23OtQ/QowOS8QIzSigjokTaVmtSjDUmc4yfnWOkAmGef99LI3\r\nK6zoeyG/OYcjfPy+22FnpLqyMgDgvfxUUUI59aZ0IimVzYfgbk1swX0u79d4\r\nf7CkZ1ARpEYGLDSFXpsHfug5DXjRyI+F+hSjqK2KdNvHaRVvsYQjRIvbRPG4\r\ncM07WXANAQdCcUcqvWImMo/7CGD2dCbBKqM=\r\n=gWGj\r\n-----END PGP SIGNATURE-----\r\n","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCICrhxkuDWnGtZoWo2vZT4BhurPwwj3FUP2kB0zeiZEqvAiEAkmNwOzLzKxgvapOuCw9+fRUU5o7bv508bve2RjrZ/fA="}]},"_npmUser":{"name":"akordacorp","email":"matt@akorda.com"},"directories":{},"maintainers":[{"name":"akordacorp","email":"matt@akorda.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/assembly_1.0.0_1646931527541_0.3622422572477051"},"_hasShrinkwrap":false},"1.1.0":{"name":"@akordacorp/assembly","version":"1.1.0","description":"Contract Assembly Integration Resources (JS/CSS)","main":"akorda-assembly.js","scripts":{"test":"echo \"Error: no test specified\" && exit 1"},"author":{"name":"Matt Meiske"},"license":"SEE LICENSE IN LICENSE.md","gitHead":"049313bb85b4166c5f912779e82e15a4439b4a36","_id":"@akordacorp/assembly@1.1.0","_nodeVersion":"14.18.1","_npmVersion":"6.14.15","dist":{"integrity":"sha512-/VrREKBHbjGsr3iV+c5lgc/fgTDyM/AD1jGrQehmfGWCvhkXUlUezDta21s/DCxHx6BhfFLXuwSqoJRDF4J5MQ==","shasum":"932bd5e98609495a92c1b6396036ebecf7838b91","tarball":"https://registry.npmjs.org/@akordacorp/assembly/-/assembly-1.1.0.tgz","fileCount":5,"unpackedSize":2044049,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v4.10.10\r\nComment: https://openpgpjs.org\r\n\r\nwsFzBAEBCAAGBQJiKm3vACEJED1NWxICdlZqFiEECWMYAoorWMhJKdjhPU1b\r\nEgJ2VmpU4g/+M8mX8ytnJsPvqn0ufbMqckiaVaOv9tmzL9k6WBteSkIfKUex\r\n9/ETYUnQcsjUzPvElRQ5WiQDoe6McOVlfHRSvTixg8WE0Tq4nYF5y22CgJ80\r\nzFTZhz61IEYy774/wczvpYxfzMKaoh+0o3PGNRhSm3Lj6K2Kq5Rsvdi95jWt\r\n+KI6aKBgWT86QjjHFEqPHHnwf9twe5icwyoSaEhSPt9peV+bp4PxvzzoosXy\r\nsZptFD87YL2iREWEB0OPrEU2/9dscARNlXqyLv+9lI06N+5cYYMQTstE8nxb\r\nz5Lqnnt3o8TV+28BdyUyc4VOLcK4aBqzAIvHORVuazoXVusbtsiZTQ/ilGg4\r\nLHvHfqRC3DGPUuMvczb8XT7goipVSR5s8JWPdQ7z5dfzg2oWIfG5F9ivAQjV\r\nkcHQEOvbVXBTeRPy2XF6lO4wJqiNUg6FObd28icBzZ0XfSVsrJDpxMB2UjLw\r\nVeezIUAae2OrYvDAaak+fruy28DKi9HFZyeMZrZiAgaYCKiLtbXPdjj4R9VD\r\nlY5VFqLFnKHcyuYoC8K7d+w/l3X9RBsX8o3P6h0WA14LaHPGKERvbALy33XX\r\n+INYUZPKM5OjpkbEo3lZn9YaUWhLBh+5DcM1F1eddZV3lRyz5tNMaRsk9aE0\r\nH3Ux0eEonJxM1j7AppG4RtljyhAaG6KpU4w=\r\n=qV1Y\r\n-----END PGP SIGNATURE-----\r\n","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCIQCw0BDVhCQaioMeYu2SOH0rP/uXxgmybMDz8OMjkOzyfgIgL3hIDR8YwkxT/t53Wm/I158AnCQvXSOWWvWj4KR8gPY="}]},"_npmUser":{"name":"akordacorp","email":"matt@akorda.com"},"directories":{},"maintainers":[{"name":"akordacorp","email":"matt@akorda.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/assembly_1.1.0_1646947823565_0.4010829545926955"},"_hasShrinkwrap":false},"1.1.1":{"name":"@akordacorp/assembly","version":"1.1.1","description":"Contract Assembly Integration Resources (JS/CSS)","main":"akorda-assembly.js","scripts":{"test":"echo \"Error: no test specified\" && exit 1"},"author":{"name":"Matt Meiske"},"license":"SEE LICENSE IN LICENSE.md","gitHead":"049313bb85b4166c5f912779e82e15a4439b4a36","_id":"@akordacorp/assembly@1.1.1","_nodeVersion":"14.18.1","_npmVersion":"6.14.15","dist":{"integrity":"sha512-ZHgm7m2Onh65R//rZG5TFsxniJrFpdpDDaWY7MwYiiLSO3jIFXsTuwjs1wpNyXd1mILNIYckJUxwSVw3lTOMTg==","shasum":"04570bdc035b48ca0583fbbbc2287d0d3de435a0","tarball":"https://registry.npmjs.org/@akordacorp/assembly/-/assembly-1.1.1.tgz","fileCount":5,"unpackedSize":2044048,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v4.10.10\r\nComment: https://openpgpjs.org\r\n\r\nwsFzBAEBCAAGBQJiKm+EACEJED1NWxICdlZqFiEECWMYAoorWMhJKdjhPU1b\r\nEgJ2VmqKehAApNrQYbtPdslCSWL1tSYra2s5vky9s/adiZvttxO0Ndep5j+J\r\nxu/Bb9P6pbpIYy3fGIJNn2DybUNQN6vQOdwNV76jPOACpBWm5eLzDZJBQG4u\r\nMKP4OM548GYrx2eevm7rsLEXiYQJk/yfhv0lET6H6RgZ8eaRSf4XvOYehqqI\r\nRsAvnYsgIpOAIpUAytadoYgTlR1q2tuwYvdc4/NDH1T4fTdy0B3UxHsZOUjm\r\nAWC4otDJkYTSVmzIYeoXJ03C/A18RnfTE/1yBeCn2VIjSeIb+Q/3a/1sFrM7\r\nYc5Oy+yu2qVDzkP9KhVJZoo9ndAKh1zzAEpNNyvad2nAWcC537Y5J5mHepd5\r\nVZXa4vQaEmOPw/4/O9PmoiyL6+bza2/JtKlprXF49MIAziv2c7IzOmmjS1Rt\r\nHUH4C/usjbm2Gbwey0/nhkECv/UUuEcpR5LWHFX3V3y8ibUcMBLk3Bzv56tF\r\nSk7tfRfwA4uOHz2KsKeZMhBpDSTCfZRkbDsQ3NpVgv+f1pHuG8Ufyt3wf6kc\r\ne3rnQ0DA5aK07g2b2agyhGXdfhhcbNBdc+EFwCsLIiepl3k2x1ks19GcXSvh\r\n0RYrCdxkEexmSNVAntNFFrELDPXP6+FeKSUS9qOlTju3o1kCxqZK/fDbrUvv\r\ndbca1QvXY3scNBEf81KFxegH/sTIuq8QHmA=\r\n=G/LU\r\n-----END PGP SIGNATURE-----\r\n","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEYCIQCXiT+gM72b7gQPWtgbFhmPJHZneTZwzy+efYWMc1hRBwIhAKCHmkfbUlxxCTFhZwoz5XUebsvpliB519l1VCIE7Gz5"}]},"_npmUser":{"name":"akordacorp","email":"matt@akorda.com"},"directories":{},"maintainers":[{"name":"akordacorp","email":"matt@akorda.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/assembly_1.1.1_1646948228672_0.7398017336301046"},"_hasShrinkwrap":false},"1.1.2":{"name":"@akordacorp/assembly","version":"1.1.2","description":"Contract Assembly Integration Resources (JS/CSS)","main":"akorda-assembly.js","scripts":{"test":"echo \"Error: no test specified\" && exit 1"},"author":{"name":"Matt Meiske"},"license":"SEE LICENSE IN LICENSE.md","gitHead":"a4c7b830c93c80a81be031278c9a5ad39f4aed5e","_id":"@akordacorp/assembly@1.1.2","_nodeVersion":"14.18.1","_npmVersion":"6.14.15","dist":{"integrity":"sha512-2ulOnvgJ/7ATsFlkPvroIPPNsmwjuR02JOQC/sFpSnGQxh6xHbDs9sjDMVCK3OOCPhSuNZvW9zDztgtEqRlDkw==","shasum":"f29ebb9580f8e38436ce75731ba898dfa874db78","tarball":"https://registry.npmjs.org/@akordacorp/assembly/-/assembly-1.1.2.tgz","fileCount":5,"unpackedSize":2044127,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v4.10.10\r\nComment: https://openpgpjs.org\r\n\r\nwsFzBAEBCAAGBQJiKnhOACEJED1NWxICdlZqFiEECWMYAoorWMhJKdjhPU1b\r\nEgJ2VmrTcA/+PYJQkagvz2lMVCcmMmtzyf05u5WouE0rqWbAlFb3ttBPj9P9\r\nNXcfhSEGgwCJgerzi8upeYBlvGufv+AvodiBf48dCvhokatANMFiCFJatKQG\r\n9qsBf9FTe6zTW4BNljpa8oe1rZf4qCneilLjOpekKvUeDWL08xUgErg7hlLY\r\n60rgtcyZfK76AnDdWjKWMREqXwlu19cI7siImwBKfnviYTZz5j2eRb0zhUL/\r\n4OnXjCcLkU+rnB58MjVKp5J44ltDEgqZgqSAPVj8M4PoDPln6z89ez3FQMsg\r\nTWLTztf4FeLpUTsiuJ2vLiaXPHWMLjphIHs0/C30thV4pjf6ptXtCUWBPkxK\r\ntpaAyWdN34713pO+Dnefm/1TGm9m8cnuvhU/gAqcmcdfUJEdf/VgsXakaY8I\r\n/fAbJjpwoWVj/usKBEwp3tzATtitH8w3dU9AoQbyjPckWNB7lyiQSuvd3PUt\r\nkNwuT/vqnH2sL5ipZAEYXiFpicfrse75rWaAKOhe9ZSMh8iXo9z539y/4QcY\r\nEvTzBeUbdQ0svoMMXCC9YOQdBP+RrVDc8WGgy8hiH09TPNEldFrlw91GQZ6y\r\nNFkuIfaXKp207fb6fV9Hb/22frM0UVE8xebEa47YTb+/lcER4NMwqfECYQ6V\r\nkyt/mx4VlhOCZaawm1PeEkLNNdJMeSd2dss=\r\n=Goyh\r\n-----END PGP SIGNATURE-----\r\n","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEYCIQDrbbAHGvwb1xsbvK6XAtkfK+2EKFeQ+taTY/GpQ/4NZAIhAKUzRx1Ze2tYmcb71y/FroW26x6c4ru2EJOPyj026HDO"}]},"_npmUser":{"name":"akordacorp","email":"matt@akorda.com"},"directories":{},"maintainers":[{"name":"akordacorp","email":"matt@akorda.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/assembly_1.1.2_1646950478486_0.06937207815946689"},"_hasShrinkwrap":false}},"time":{"created":"2022-03-10T16:58:47.498Z","1.0.0":"2022-03-10T16:58:47.760Z","modified":"2022-04-04T12:31:04.739Z","1.1.0":"2022-03-10T21:30:23.804Z","1.1.1":"2022-03-10T21:37:08.867Z","1.1.2":"2022-03-10T22:14:38.732Z"},"maintainers":[{"name":"akordacorp","email":"matt@akorda.com"}],"description":"Contract Assembly Integration Resources (JS/CSS)","author":{"name":"Matt Meiske"},"license":"SEE LICENSE IN LICENSE.md","readme":"# Akorda - Developer Integration - Contract Assembly\n\nThis package contains two files:\n\n* `akorda-assembly.js`\n* `akorda-assembly.css`\n\nThese two resources are used to integrate Akorda's Contract Assembly feature into third-party environments.\n\n### Installation\n\n```\nyarn add @akordacorp/assembly\n```\n\nor\n\n```\nnpm install @akordacorp/assembly\n```\n\n### Usage\n\nOnce the browser has loaded the two resources (*akorda-assembly.js* and *akorda-assembly.css*), you can load Akorda's contract assembly feature using the js function `AkordaAssembly()`. For example:\n\n```javascript\n// reference the id of your contract playbook template that you'd like to use.\n// Assembly Questions should be configured for this playbook.\nconst akordaPlaybookId = 892;\n\n// the \"config\" argument is an object that includes various\n// properties (some required) for talking to the Akorda\n// application. More information about the config option\n// properties can be found in the documentation below.\nconst config = {\n  // the Akorda application URL (omitted if using a proxy)\n  appUrl: \"https://app.akorda.com\",\n  // the jwt token obtained via your client credentials (omitted if using a proxy)\n  accessToken: \"eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJsb2dnZWRJbkFzIjoiYWRtaW4iLCJpYXQiOjE0MjI3Nzk2Mzh9.gzSraSYS8EXBxLN_oWnFSRgCzcmJmMjLiuyu5CSpyHI\",\n  // the id of the DOM element in which to load the assembly feature.\n  targetElementId: \"akorda-assembly\",\n  // required information about the user\n  userInfo: {\n    firstName: \"Jane\",\n    lastName: \"Doe\",\n    email: \"jane.doe@akorda.com\"\n  },\n};\n\n// Call the AkordaAssembly() function with the required arguments\nAkordaAssembly(akordaPlaybookId, config);\n\n```\n\n### Config Properties\n\n***`config.appUrl`*** In a standard production environment, this url will be same url as the production Akorda application: **https://app.akorda.com**. If you are using an Akorda development or staging environment, this url may be different. Ask your Akorda representative for more information.\n\n***Important***: If you are proxing the calls to Akorda on the server, you must omit this property from the config.\n\n---\n\n***`config.targetElementId`*** In your web page, this is the ID of the DOM element in which you want the Akorda Contract Assembly feature to appear. The default is `akorda-assembly`, and might appear in the html of your web page as:\n\n```html\n<div id=\"akorda-assembly\"></div>\n```\n\n---\n\n***`config.accessToken`*** The JWT token that will be used for authentication and authorization in the Akorda application. You can acquire a token via the Akorda application by sending an HTTP POST request to `{appUrl}/api/login/authorize`, and include the form values: `client_id` and `client_secret`. Please contact your Akorda representative for these details.\n\n---\n\n***`config.userInfo`*** An object with the following structure:\n\n```json\n {\n    firstName: \"Jane\",\n    lastName: \"Doe\",\n    email: \"jane.doe@akorda.com\"\n  }\n```\n\nThis information allows Akorda to properly send emails on behalf of the user.\n\n### Use a Proxy\nThe best way to integrate Akorda Assembly is to use a server-side proxy that will avoid the challenges associated with cross-origin requests from the browser and keep your accessToken away from your client-side code.\n\nFor example, when the user loads your web page, your server could obtain a JWT access token using the Akorda provided client credentials (*client_id* and *client_secret*), and then return the page with a cookie (named `Authorization`) that has the JWT access token as the value.\n\nThen, when your client code calls `AkordaAssembly(playbookId, config)`, **omit** the `appUrl` and the `accessToken` from the *config* object. By omitting these, all data requests will be sent to your server instead of Akorda's application.\n\nNext, proxy the Akorda API calls (they all start with \"/api\") along with the authorization cookie to the Akorda application url (e.g., https://app.akorda.com).\n\nAn example/reference implementation (built using a simple NodeJS Express web app) is available here: https://github.com/akordacorp/assembly-reference-implementation.\n\nAnd if you need help, don't hesitate to contact your Akorda representative.\n\n\n","readmeFilename":"README.md"}