{"_id":"@chamaeleonidae/chmln","_rev":"5-c799b16a48cde6a62e8030490f440ddc","name":"@chamaeleonidae/chmln","dist-tags":{"latest":"1.0.1"},"versions":{"1.0.0-alpha.1":{"name":"@chamaeleonidae/chmln","version":"1.0.0-alpha.1","license":"Apache-2.0","_id":"@chamaeleonidae/chmln@1.0.0-alpha.1","maintainers":[{"name":"try.nbfontana","email":"neri@trychameleon.com"},{"name":"mamuh","email":"mariana@trychameleon.com"},{"name":"esau_chmln","email":"esau@trychameleon.com"},{"name":"max_mitrani","email":"max@trychameleon.com"},{"name":"felipe-from-chameleon","email":"felipe@trychameleon.com"},{"name":"bnorton","email":"brian.nort@gmail.com"}],"homepage":"https://github.com/chamaeleonidae/===","bugs":{"url":"https://github.com/chamaeleonidae/===/issues"},"dist":{"shasum":"bc3c638c6654b11ebcc701b45a5f66cd9be2433e","tarball":"https://registry.npmjs.org/@chamaeleonidae/chmln/-/chmln-1.0.0-alpha.1.tgz","fileCount":4,"integrity":"sha512-Dmzum2Nw9UQ8xuY7KK1b7K/Yds8iXwunmOhuFZC2eSsaYjnHo1JshV7h43RrluwZTsotd7xukVklHmwYM20SZQ==","signatures":[{"sig":"MEYCIQCnYpeQaP7C63pKwMkSgqauc6do5HvlmDdhaUIQBcc3VQIhAIU/6q+oB8k9kXxo2jgdF0R5Two0dhigmLR8jiwt13JA","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":17208,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.13\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJhHYY1CRA9TVsSAnZWagAAQmIP/i/XCqHbgnHQpv0RtHQo\nw4tUWbc+CFQn5FlESxtKo0Xb9xE/XLhL3fnqwlbWbxc8YGr+D7FvJMX3FlNV\nCBk8r6OPghqS04O01tSopru1oDP1QOQQHr9ZaIb2O8t3BdYZ0hUqGkhi/gRh\npf5lDQio+kdGJH1MyRdTcmLqyY1gZk9zgsFECXxVkiTNxiCnuwpOldlexoa1\nAlIm8omBLemaIfG8tQ82YxYU95QmWZqdRuRazBFyTw6Pdr2szuqqMf41rv8h\n/C2vP5c4ICXs5HJApQFVD8qYcFHUfdFjxIInfkV38lb8oBQ52HloF0/olytE\nhU/Vv7GMMuTI83979fKrlN1cT1nY0waTYbst3Zb/ivD4LtjpxccsdLnOjWTM\nSrVh9AxeZWmIx5oh0LnviJG8ewjQQYU5iljGrm+PFv8Wylp16rLnM0WjmLu1\n81OeCFOyz34XYXNNCwaR42o4Gb9iRXVAlKQNnLpa0xmUvuVTKyF2pLKMaEKB\nb/jNF18lIQP8VXVugAqLrOd9rUAvKuhZMctzgf9HT6M3XPDPKHmmmzL4puXE\n+5+yOwmMo2u2yGWsnJfIEFsCX9J/jcKV613NalYMGirXmIT5lZDqVv9LwVQo\nDcgM4OF5TAlQshVF9Xvp2Qq8cQsBDm8nXBRhicCJdekR4ffAunJtUpG5AAdc\n47S6\r\n=32tz\r\n-----END PGP SIGNATURE-----\r\n"},"main":"index.js","gitHead":"95e857131c7e58e4d5c22c1873c364676416819c","_npmUser":{"name":"try.nbfontana","email":"neri@trychameleon.com"},"repository":{"url":"git+https://github.com/chamaeleonidae/%3D%3D%3D.git","type":"git"},"_npmVersion":"6.14.13","description":"The official Chameleon JavaScript browser client library","directories":{},"_nodeVersion":"12.22.3","_hasShrinkwrap":false,"_npmOperationalInternal":{"tmp":"tmp/chmln_1.0.0-alpha.1_1629324853579_0.33295679590377136","host":"s3://npm-registry-packages"}},"1.0.0-alpha.2":{"name":"@chamaeleonidae/chmln","version":"1.0.0-alpha.2","license":"Apache-2.0","_id":"@chamaeleonidae/chmln@1.0.0-alpha.2","maintainers":[{"name":"try.nbfontana","email":"neri@trychameleon.com"},{"name":"mamuh","email":"mariana@trychameleon.com"},{"name":"esau_chmln","email":"esau@trychameleon.com"},{"name":"max_mitrani","email":"max@trychameleon.com"},{"name":"felipe-from-chameleon","email":"felipe@trychameleon.com"},{"name":"bnorton","email":"brian.nort@gmail.com"}],"homepage":"https://github.com/chamaeleonidae/chmln","bugs":{"url":"https://github.com/chamaeleonidae/chmln/issues"},"dist":{"shasum":"56b0dc3cd2308b28f7564cd3974e5e8990383395","tarball":"https://registry.npmjs.org/@chamaeleonidae/chmln/-/chmln-1.0.0-alpha.2.tgz","fileCount":4,"integrity":"sha512-MJlB7glBOoB8S/Ol6pJNyh4+iZUYH78gMapH37QaElvY1EJ0x4C8976zDFaciXQ9xKedWGEjDJn0YgdKOpWAyw==","signatures":[{"sig":"MEYCIQCkc4XVaMXclz3u4J4NBGD8gaqohnsdORhVYC5VXZHveAIhALoGaFXnZK3ZpDJbJOYhIKhd7niMsImPMp6TINMjPicn","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":17214,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.13\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJhHYaFCRA9TVsSAnZWagAAJxkP/3is/5z8CJMwcOy2qGHc\nSETnqcb2v8e1Y2vS4cuyIEjcXvQ+apSVL4OeSFgoFf9v7iwrAZCnw3w4MNC2\n5KDR7hVg3qUT5nR4WT+4x5H2Mv0Za1f9eUzTLSxdqNoNh86WoK69nCBFtNX/\nz8J0X5lH874oU2eSqUi4PN9nk5MS4bzWuGMtZ/OSYCCwvOjsdZfqUGjBUoGQ\nRa4ZtUQwhQNGPBY0WJYoz5SVaLixfG4rKzlqB7W92xzK1MIFv0JU3PwpMaOu\nzPgOsLxP7vTOA1XSUezn0267f+k0a2LC0cHaFe0Tok9JZGEAtXv9C8gYW9vy\nd7VZOMv+nsw8iE4S09P+pAtNvzVrflp8Aktccp0OxEuCNc7ygtvk6gPHMb7L\nxAW2FaXFLicyfNWP0h/t0grTqr6GqKKQj3rzInbYtw771Ol+edBVnJKJoRPd\nKoYx39+23TMfbJc6vnofdf0XsTD+OjRMBr3wZxUp5Sv+b40kiWLG3BBsK4v/\nWA9UywIjtjRlP6kc+RXhV19kxHGDW1OjQoJaONK1f6F0UiUJITvVTnfRhTSH\nKyRDJ4mWpPAVCy95r5hUT9waASMmAh0orDU9CHknECDoZlu7eTQauQTfVcpF\neGvZaAUchqzMNBAp26EocR7XQt+k3hMrh6+clnYZPEsOEGRmp6vbkjLPlQ2t\n5ioU\r\n=lOMA\r\n-----END PGP SIGNATURE-----\r\n"},"main":"index.js","gitHead":"bbbbce8ea9e5abc4ee317d8827f02fca0d2828c9","_npmUser":{"name":"try.nbfontana","email":"neri@trychameleon.com"},"repository":{"url":"git+https://github.com/chamaeleonidae/chmln.git","type":"git"},"_npmVersion":"6.14.13","description":"The official Chameleon JavaScript browser client library","directories":{},"_nodeVersion":"12.22.3","_hasShrinkwrap":false,"_npmOperationalInternal":{"tmp":"tmp/chmln_1.0.0-alpha.2_1629324933096_0.6587026338513513","host":"s3://npm-registry-packages"}},"1.0.1":{"name":"@chamaeleonidae/chmln","version":"1.0.1","license":"Apache-2.0","_id":"@chamaeleonidae/chmln@1.0.1","maintainers":[{"name":"bnorton","email":"brian.nort@gmail.com"},{"name":"try.nbfontana","email":"neri@trychameleon.com"},{"name":"felipe-from-chameleon","email":"felipe@trychameleon.com"},{"name":"max_mitrani","email":"max@trychameleon.com"},{"name":"esau_chmln","email":"esau@trychameleon.com"},{"name":"mamuh","email":"mariana@trychameleon.com"}],"homepage":"https://github.com/chamaeleonidae/chmln","bugs":{"url":"https://github.com/chamaeleonidae/chmln/issues"},"dist":{"shasum":"93f6e8686a3089e1220ad85374e916f92c39c19e","tarball":"https://registry.npmjs.org/@chamaeleonidae/chmln/-/chmln-1.0.1.tgz","fileCount":5,"integrity":"sha512-Ys9LkOzDtjsUY9bbwFU0SbPqpXAjHCmDGZ7N90hEZdncRomgXGUi/BUvzVNsyPk97EpH9JtlrYHcIZhtGPDaXQ==","signatures":[{"sig":"MEUCICnCUUth+geaq81PiGc0bMGCwtbrijL1MQb0sCYDp4WNAiEAxCY5LXBSkoBfxZZzkUw3IvO2jdtweLVOpMEQwyCQLTc=","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":18483,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v4.10.10\r\nComment: https://openpgpjs.org\r\n\r\nwsFzBAEBCAAGBQJio3MSACEJED1NWxICdlZqFiEECWMYAoorWMhJKdjhPU1b\r\nEgJ2VmqEyQ/7ByC6UDJAR018k86CUQ4yGf39Zp1RaXJgisfhb7nTEgUfhrCm\r\nibwjrqwRjBw6hFmp4L/zH6YLGAaR2xYzGF3z1His29p7ajXbxsQcVJNAr67Q\r\niaWGbKANQvgGgThfvOvEPVqif9f/F2t72ysIXZA8GsWkc3a6j/GOL6LXx+qA\r\nezP+JkGSwlzqcnl5QaU2luDb5rfbYBlaSdVAiF+kudaL96fLAOYl1wyyOXFO\r\nSnDmzcMg4I5XvrRuaNyho2diMnXyaYipU9zU2uATC6lPK7r0GEzl0+/5qKrB\r\nXqs4+iR+GggrY1M4bXuTaV7stc7Vxnke49KMr6sE07CU3deLSKaaYEr3NBkQ\r\ntTilMsIRTAMdAdZJboe0pKjkkkrPsrsy+8zj5kulHF9Dd+yjDN9hVdWJGSza\r\npWIPaxPXsufeKzUiBz/6cLUwK7gxACuvx4MlpH9TVxI+zKvMvO/I5eUlA23B\r\nvkLNbULpq6F0pqlztGcz1rprwsIEDKoR0xx41qGePxwSzyO0i/gEhY/j9Ads\r\n1oGRKmkHST9thvVjG52atb6K979spvqNfxI2rH6PhOqsSIXjP2L9NO83b/BA\r\nuFohrVjHcAsVeUzyHFoyGk7GP34PvSVcoVfd6xtIXVZt0U5GOUA9Tcakzkrx\r\nnPCViyjFz3b/e8tYZlkN+0XPlt/ZNoYMVT0=\r\n=muUM\r\n-----END PGP SIGNATURE-----\r\n"},"main":"index.js","gitHead":"1d109a6cab295a1e131dec967d577fe5bced4eab","_npmUser":{"name":"bnorton","email":"brian.nort@gmail.com"},"repository":{"url":"git+https://github.com/chamaeleonidae/chmln.git","type":"git"},"_npmVersion":"6.14.4","description":"The official chameleon.io JavaScript client library","directories":{},"_nodeVersion":"12.16.3","_hasShrinkwrap":false,"_npmOperationalInternal":{"tmp":"tmp/chmln_1.0.1_1654878994475_0.8861636036298608","host":"s3://npm-registry-packages"}}},"time":{"created":"2021-08-18T22:14:13.514Z","modified":"2026-04-09T16:01:10.276Z","1.0.0-alpha.1":"2021-08-18T22:14:13.726Z","1.0.0-alpha.2":"2021-08-18T22:15:33.269Z","1.0.1":"2022-06-10T16:36:34.621Z"},"bugs":{"url":"https://github.com/chamaeleonidae/chmln/issues"},"license":"Apache-2.0","homepage":"https://github.com/chamaeleonidae/chmln","repository":{"url":"git+https://github.com/chamaeleonidae/chmln.git","type":"git"},"description":"The official chameleon.io JavaScript client library","maintainers":[{"email":"brian.nort@gmail.com","name":"bnorton"},{"email":"neri@trychameleon.com","name":"try.nbfontana"},{"email":"felipe@trychameleon.com","name":"felipe-from-chameleon"},{"email":"mariana@trychameleon.com","name":"mamuh"}],"readme":"# Chameleon JavaScript Library\n\nEasily add Chameleon to your product!\n\nThe Chameleon JavaScript Library is a set of methods attached to a global `chmln` object intended to be used by applications to display Chameleon Experiences to users.\n\n## Installation via NPM\n\nThis library is available as a package on NPM. To install into a project using NPM with a front-end packager such as Webpack or Browserify:\n\n```\n  npm install --save @chamaeleonidae/chmln\n```\n\nYou can grab your [token](https://app.chameleon.io/setup/install) then require the lib like a standard Node.js module:\n\n```javascript\nconst chmln = require('@chamaeleonidae/chmln');\n\nchmln.init('YOUR_TOKEN', { fastUrl: 'https://fast.chameleon.io/' });\n```\n\n> Note for accounts created before *2022-05-21* you must omit the fastUrl\n> If you're unsure, verify your account-specific instructions on the [installation page](https://app.chameleon.io/setup/install).\n\n```javascript\nchmln.init('YOUR_TOKEN');\n```\n\n> To use Chameleon as first-party (i.e. via `chameleon.your-product.com`), first [contact us](https://app.chameleon.io/help) to set this up, then use this updated script with your custom domain.\n\n```javascript\nchmln.init('YOUR_TOKEN', { fastUrl: 'https://chameleon.your-product.com/' }); // << CHANGE ME\n```\n\n\n## Usage\n\nFirst, follow the installation process above. The script loads asynchronously and won’t affect your page loading times.\n\nNext, identify your users by sending a unique ID (this normally matches the UIDs from your database). Without this, Chameleon can’t display Experiences to users. You should also [send additional user data](https://help.trychameleon.com/en/articles/1226443-how-do-i-send-my-users-data-to-chameleon) (such as “email address”, “role”) or company data (such as “plan type”, “subdomain”) so you can target Experiences to the right users, at the right time.\n\n```javascript\nchmln.identify(USER.ID_IN_DB, {     // REQUIRED Unique ID of each user in your database (e.g. 23443 or \"590b80e5f433ea81b96c9bf6\")\n  email: USER.EMAIL,                // RECOMMENDED Used to connect data coming from various integrations\n\n  // SUGGESTED - User properties:\n  created: USER.SIGN_UP_DATE,       // Send dates in ISO or unix timestamp format (e.g. \"2017-07-01T03:21:10Z\" or 1431432000)\n  name: USER.NAME,                  // We will parse this to extra first and surnames (e.g. \"James Doe\")\n  role: USER.ROLE,                  // Send properties useful for targeting types of users (e.g. \"Admin\")\n  logins: USER.LOGIN_COUNT,         // Send any data about user engagement (e.g. 39)\n  project: USER.PROJECT_ID,         // Send any unique data for a user that might appear in any page URLs (e.g. 09876 or \"12a34b56\")\n\n  // OPTIONAL - Company properties:\n  company: {                        // For B2B products, send company / account information here\n    uid: COMPANY.ID_IN_DB,          // Unique ID of the company / account in your database (e.g. 9832 or \"590b80e5f433ea81b96c9bf7\")\n    created: COMPANY.SIGN_UP_DATE,  // To enable targeting all users based on this company property\n    name: COMPANY.NAME,             // Send any data that appears within URLs, such as subdomains (e.g. \"airbnb\")\n    trial_ends: COMPANY.TRIAL_ENDS, // Send data about key milestones (e.g. \"2017-08-01T03:21:10Z\")\n    version: COMPANY.VERSION,       // If your software varies by version then this will help show the correct guidance (e.g. \"1.56\")\n    plan: COMPANY.PLAN,             // Send null when no value exists (e.g. \"Gold\", \"Advanced\")\n    spend: COMPANY.CLV              // Send other properties that will help in targeting users (e.g. sales rep, source, stage)\n  }\n});\n```\n\nOptionally you have the ability to track user events:\n\n```javascript\nchmln.track(PLAN_CHANGED);          // Example event \"PLAN_CHANGED\" can be used for targeting or measuring success\nchmln.track(ACTIVATED);             // Having a defined activation point can be helpful for targeting onboarding experiences.\n```\n","readmeFilename":"README.md"}