{"_id":"@algoraven/config","_rev":"7-1cf717b3f17cf85f28a161604d126298","name":"@algoraven/config","dist-tags":{"latest":"0.1.16"},"versions":{"0.1.13":{"author":{"name":"BitBird, Inc.","email":"hi@algoraven.com"},"name":"@algoraven/config","version":"0.1.13","private":false,"main":"build/index.js","types":"build/index.d.ts","dependencies":{"@algoraven/idl":"^0.0.409","@algoraven/scripts":"^0.0.21","@algoraven/util":"^0.0.131","@types/node-fetch":"^2.0.3","node-fetch":"^2.0.0","typescript":"^4.3.5"},"scripts":{"start":"tsc && node build/index.js","build":"tsc","prepare":"yarn format && yarn lint && yarn build","format":"prettier --write \"src/**/*.ts\" \"src/**/*.js\"","soft-format":"prettier --check \"src/**/*.ts\" \"src/**/*.js\"","lint":"tslint -p tsconfig.json --fix","soft-lint":"tslint -p tsconfig.json","upraven":"yarn add @algoraven/util@latest @algoraven/idl@latest @algoraven/scripts@latest","protect":"algoraven protect","precommit":"yarn format && yarn lint"},"devDependencies":{"pre-commit":"^1.2.2","prettier":"^1.19.1","tslint":"^6.0.0","tslint-config-prettier":"^1.18.0","tslint-etc":"^1.10.0","tslint-lines-between-class-members":"^1.3.6"},"pre-commit":["protect","lint","format","build"],"gitHead":"ad72527f44a27a076b227d54cdf75f37c0562ae2","description":"[](https://www.npmjs.com/package/@algoraven/config)","_id":"@algoraven/config@0.1.13","_nodeVersion":"14.18.0","_npmVersion":"6.14.15","dist":{"integrity":"sha512-ysmp6ANa/Cq/1Btk+xaL7iFZ5ECsl41HMEKKPYDTEPKPq6wUjSsOJ1KvaJJj/ka9AsACQT4Lk75dg4UQqUda5w==","shasum":"7af14af17160845559fa46d245e649a1626dd949","tarball":"https://registry.npmjs.org/@algoraven/config/-/config-0.1.13.tgz","fileCount":17,"unpackedSize":37599,"signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEYCIQCEARCnvgSLmL51uKwK0e0WLd+KenBQmyPvsSNhnEN8twIhAMK2uRcalNm2g8vQ50KPXGInDStTtLLppZDH1n11gDtk"}],"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v4.10.10\r\nComment: https://openpgpjs.org\r\n\r\nwsFzBAEBCAAGBQJisRFrACEJED1NWxICdlZqFiEECWMYAoorWMhJKdjhPU1b\r\nEgJ2VmriGg//Y8BYqDt3jVI2P1rPDjKXSKJ+eVJ45UscqJsI1kOXnX46cBuo\r\nr8xVbEDAbPyFw78vjnM9MbVEVRTNKlT10hS2A7D3UYThx7V0SzfiPN5GXR2B\r\ne1WP3reh+Se3Uk0eEAxwYcgmYD526MjT8tcYgB8HwimjTibMU/ikuLkAZBkd\r\nqR1DSewFuz0zaxS84rW/Nv3BQuCaS5jZGRzaNowf7UpLOHBCmRlXsS8AyKEQ\r\nA6x+JEppbuxCyza6OvcKB2S981n0rYztWWMfny1gHf9FKiNyhCamqeG2UwB/\r\nF0ncpLKk31Wm5O4gnazFnZPfTJ+Ltpz2STdeK2h3jBixMYgKkoDIpwMeXF4z\r\nJRqG34lHFTDJSVbDBfprRVY+q4ku5kvz2rOday2EDSQ14f8qeJxjAUpbkHTM\r\nSiROwI4k1QiYeYeiyAWVxXFv1aCcyMDOYixVJYdeOE0MdfVUTuyO05oa37WD\r\nSAOSMYxZf+Fnoc9ZtpTs/v0QM0jo31XquvDO0P0K3mxHYTJwUp/Rp0CLIbXN\r\n3v6Muc8LTppAuhFooFP9eo1hjIKLA7JpfEVbL+cFYFk9JUZ9nrWWkeacLRoO\r\nt9DCnfj0TY9sD8dbX6KKpgz4MCzW/bjVP4ZPPgglAt64qeY+57qFJBEARm2M\r\nNYkzIqYgeXtt6Z984+pj+1f+UBrT6EZzHdw=\r\n=49bH\r\n-----END PGP SIGNATURE-----\r\n"},"_npmUser":{},"directories":{},"maintainers":[{"name":"anthonykrivonos","email":"info@anthonykrivonos.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/config_0.1.13_1655771499717_0.5747357532854473"},"_hasShrinkwrap":false},"0.1.14":{"author":{"name":"BitBird, Inc.","email":"hi@algoraven.com"},"name":"@algoraven/config","version":"0.1.14","private":false,"main":"build/index.js","types":"build/index.d.ts","dependencies":{"@algoraven/idl":"^0.0.409","@algoraven/scripts":"^0.0.21","@algoraven/util":"^0.0.131","@types/node-fetch":"^2.0.3","node-fetch":"^2.0.0","typescript":"^4.3.5"},"scripts":{"start":"tsc && node build/index.js","build":"tsc","prepare":"yarn format && yarn lint && yarn build","format":"prettier --write \"src/**/*.ts\" \"src/**/*.js\"","soft-format":"prettier --check \"src/**/*.ts\" \"src/**/*.js\"","lint":"tslint -p tsconfig.json --fix","soft-lint":"tslint -p tsconfig.json","upraven":"yarn add @algoraven/util@latest @algoraven/idl@latest @algoraven/scripts@latest","protect":"algoraven protect","precommit":"yarn format && yarn lint"},"devDependencies":{"pre-commit":"^1.2.2","prettier":"^1.19.1","tslint":"^6.0.0","tslint-config-prettier":"^1.18.0","tslint-etc":"^1.10.0","tslint-lines-between-class-members":"^1.3.6"},"pre-commit":["protect","lint","format","build"],"gitHead":"9ca13f3968284f839cfedd93219983a726738d9c","description":"[](https://www.npmjs.com/package/@algoraven/config)","_id":"@algoraven/config@0.1.14","_nodeVersion":"14.18.0","_npmVersion":"6.14.15","dist":{"integrity":"sha512-HGC07LyUlB+CSrtPW3G8RPLpXhOOX5SsITcgG8E1ilRQFU0/CmLMHCCekP6U4MKgU1I6Of0ci30fnG6w/pjPbw==","shasum":"3ab2a53b27c1103bea96107da0b97da783f8b352","tarball":"https://registry.npmjs.org/@algoraven/config/-/config-0.1.14.tgz","fileCount":17,"unpackedSize":37799,"signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCIAl85D7dCwpYgSYKzb71RiQAuh41SjSBTX5MQPZhL+dqAiEA6U0cJBkM8OQBneDBoh+ZXxnZvVuwIlW9vBYrxOxls6s="}],"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v4.10.10\r\nComment: https://openpgpjs.org\r\n\r\nwsFzBAEBCAAGBQJi3NalACEJED1NWxICdlZqFiEECWMYAoorWMhJKdjhPU1b\r\nEgJ2VmrnhQ//fvIVW8l9rHgBtMSNxanR6094lpg7mX07Q/GKCZD+EU2BKOHl\r\nnlkm/pHTzXr0+RSi0zSgBiXlb40NuEBVnVxc1Oh5w01wl4zy7wSN78p5N49G\r\nBwA+g/EZ5ocepYb/glLLY+upmTIofDyFIKIUdMbLudAscMk2DV4SzMi7i2hY\r\nu7zeNcaCES+cTDfq9wy+YSpx1DFHemCDfhqLLfQy2fgig8hqvDBiZKoM2T3/\r\ndAIJuZFvRK4c8Z8ba5MQn1zLz4L0gNSJz09EBM0LqNH5InvxCKhMRMbQtOW6\r\nefVjg8uqXSJYEfc36nMhMRNfNTWoiL/C+OjGr7Pj0Z3U3Pc2Eyfu++vg6f3W\r\nD4pug3ey6SPVJZ+apea9KcL4S30z04vlGGkQfwEcN6usCP8pibuxXW6mPCmW\r\nbx8/g/9ieM3/n46i2W9cMHB/18p4xbvQ4o9U3XqHZlN0K2NwtoSAMuBHbj5u\r\nAdnu02CiSNGDiiKiRhuA9UOLGlyTAU0RBqmH+m2gs5JxOsLxDXLBGHpWAjHf\r\nirzr2AszgyXBZvOBhVn7GWqgSbRDjk1WcYVB8CmVQ5FVuYYcmJtpYFVYoxxk\r\nz69Jeel71UFEayFN3nhzRfjx7YZmrbrRFBvTozOk0wDRMVLOtaMPdY2+7GMZ\r\nyJd3PE1pPenM0Xnq/UkghsJx8/PQKEme2HA=\r\n=iWGa\r\n-----END PGP SIGNATURE-----\r\n"},"_npmUser":{"name":"anthonykrivonos","email":"info@anthonykrivonos.com"},"directories":{},"maintainers":[{"name":"anthonykrivonos","email":"info@anthonykrivonos.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/config_0.1.14_1658640037163_0.9856316511307972"},"_hasShrinkwrap":false},"0.1.15":{"author":{"name":"BitBird, Inc.","email":"hi@algoraven.com"},"name":"@algoraven/config","version":"0.1.15","main":"build/index.js","types":"build/index.d.ts","dependencies":{"@algoraven/idl":"^0.0.409","@algoraven/scripts":"^0.0.21","@algoraven/util":"^0.0.131","@types/node-fetch":"^2.0.3","node-fetch":"^2.0.0","typescript":"^4.3.5"},"scripts":{"start":"tsc && node build/index.js","build":"tsc","prepare":"yarn format && yarn lint && yarn build","format":"prettier --write \"src/**/*.ts\" \"src/**/*.js\"","soft-format":"prettier --check \"src/**/*.ts\" \"src/**/*.js\"","lint":"tslint -p tsconfig.json --fix","soft-lint":"tslint -p tsconfig.json","upraven":"yarn add @algoraven/util@latest @algoraven/idl@latest @algoraven/scripts@latest","protect":"algoraven protect","precommit":"yarn format && yarn lint"},"devDependencies":{"pre-commit":"^1.2.2","prettier":"^1.19.1","tslint":"^6.0.0","tslint-config-prettier":"^1.18.0","tslint-etc":"^1.10.0","tslint-lines-between-class-members":"^1.3.6"},"pre-commit":["protect","lint","format","build"],"gitHead":"944c048b291ecc3f2f97c3244ce17be7df6145d6","description":"[](https://www.npmjs.com/package/@algoraven/config)","_id":"@algoraven/config@0.1.15","_nodeVersion":"14.18.0","_npmVersion":"6.14.15","dist":{"integrity":"sha512-Irz5Vn5yAmO4vPbig6G9rJSXPzytOrrQQtzOvUSD5kfqko3JMXKgvUm/XjNPuASnuPiO4VUUDLLj5800HBGj4A==","shasum":"77f5e81340de3a417b8e901b204559e54167bd9f","tarball":"https://registry.npmjs.org/@algoraven/config/-/config-0.1.15.tgz","fileCount":17,"unpackedSize":37779,"signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEYCIQCjtrXAVlJ1JsPausAuyHMG/LeAsAsiPn+WcRv9yJmm5wIhAPlmZ/2sM+uqqt0PgR7q/hDzN46fbUeel2tPeqTmh5vz"}],"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v4.10.10\r\nComment: https://openpgpjs.org\r\n\r\nwsFzBAEBCAAGBQJi5VKIACEJED1NWxICdlZqFiEECWMYAoorWMhJKdjhPU1b\r\nEgJ2VmrRiA//f+8oIC+TWa5c2dS1SfLKbWWgil2gb/Y9CKlHLA04lRjpnOQs\r\nNYHOBDyoL78/IqPlxmSHovNbBU3uQHuVBQSAePXg4mxA/nIDdCyMP7Ivk2Eh\r\nP3zrFYI6M0veKxdDSd6D3q88COoFDT1NzrWvGJbAJJ9+56GIhBf5BM+4TLc3\r\n2KH1drwuh+W9/7o60ZdzXCvOJMsNMOuRh4aY5f5bJbUmxBjXTzVJ8UBwEUxq\r\nmTj3worZspv7l+SIC7PMAUGbIWhVrDxiiacPymclg867barmFgPLk1vTodoj\r\ntdP/EekDAoGiSN+06ExV7uhAn0mieK7TR6By5zbwEsCLPwDe/7ipQX0j4lRs\r\ni7JOIW6bsjFFCQxrEVUjsBhsmEj/XKwq19TNWdUkH7nglW41hAmmphboIgMC\r\nFqvpGf4OUTdFwkE4IcbQ/ekTYuP/5AccpfIV8u8LgmFwGyzZPGtmYLDD3H5M\r\nBA3/Qp9XJ42f65T5zCeAbC5rmGvclk0ajcpBwKOY96FffRILikong33GTLdn\r\nsXJTbPi8jltuqpPOWYQy6PltaNKG3gjwTxOdAqB4//V7LO9INBl+Z6n2DT4E\r\nBG5MGoiDkrbOgwTu0O+rzUDFxJAH/iUJkS+sAwbBF6dlnnak31bv+t1v7SxL\r\nGqljCxkEahxTbQEtfMgYJNbCkvw+Nq35zqA=\r\n=Lnkc\r\n-----END PGP SIGNATURE-----\r\n"},"_npmUser":{"name":"algoraven.com","email":"hi@algoraven.com"},"directories":{},"maintainers":[{"name":"algoraven.com","email":"hi@algoraven.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/config_0.1.15_1659196040151_0.6906689868363491"},"_hasShrinkwrap":false},"0.1.16":{"author":{"name":"BitBird, Inc.","email":"hi@algoraven.com"},"name":"@algoraven/config","version":"0.1.16","main":"build/index.js","types":"build/index.d.ts","dependencies":{"@algoraven/idl":"^0.0.409","@algoraven/scripts":"^0.0.21","@algoraven/util":"^0.0.131","@types/node-fetch":"^2.0.3","node-fetch":"^2.0.0","typescript":"^4.3.5"},"scripts":{"start":"tsc && node build/index.js","build":"tsc","prepare":"yarn format && yarn lint && yarn build","format":"prettier --write \"src/**/*.ts\" \"src/**/*.js\"","soft-format":"prettier --check \"src/**/*.ts\" \"src/**/*.js\"","lint":"tslint -p tsconfig.json --fix","soft-lint":"tslint -p tsconfig.json","upraven":"yarn add @algoraven/util@latest @algoraven/idl@latest @algoraven/scripts@latest","protect":"algoraven protect","precommit":"yarn format && yarn lint"},"devDependencies":{"pre-commit":"^1.2.2","prettier":"^1.19.1","tslint":"^6.0.0","tslint-config-prettier":"^1.18.0","tslint-etc":"^1.10.0","tslint-lines-between-class-members":"^1.3.6"},"pre-commit":["protect","lint","format","build"],"gitHead":"1472bf56bf8403aee212779508a2f03eaeff3558","description":"[](https://www.npmjs.com/package/@algoraven/config)","_id":"@algoraven/config@0.1.16","_nodeVersion":"14.18.0","_npmVersion":"6.14.15","dist":{"integrity":"sha512-Nqgjap8hd+wFO/dOreF94BBP3e+ZGZFrq/hdieI+wMRiKj6qO+Zy3GcyJaWd8SnprfxZF3uk3/XFboG7OwBcTg==","shasum":"cb28546a6729a72cf273c84c18b11ae7e75a0290","tarball":"https://registry.npmjs.org/@algoraven/config/-/config-0.1.16.tgz","fileCount":17,"unpackedSize":37875,"signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEQCIB3gUAmsO+Bzan9EyTcGlc4wUjeRQthyFaStQD8vbbdPAiAcms48rlYAvKF6Jt/7s0YlQvUffRZwBlNEismUzIDtYA=="}],"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v4.10.10\r\nComment: https://openpgpjs.org\r\n\r\nwsFzBAEBCAAGBQJjAsVpACEJED1NWxICdlZqFiEECWMYAoorWMhJKdjhPU1b\r\nEgJ2VmqQUA/8DmXz+wL5S8MLc/7Yz87DW5F9KFADZhyatM3EOQQfl0h/czhu\r\nllfJe8EhzdzIDXwXo/GlvY7NIdTxkkEznVgVGKDBiP4KvJ7wd1gnVCCYWlH+\r\nC5w/EwLzgmk7xtJLMbq9CYYmjhHty//82fv5rebd3uP9QfEzuGfoumPE796n\r\nAr2t9SyDCs+co0YLMCcMluQZR83sEu6NU4F9LSbBi0rys2RW3bQa1Ld7VCoA\r\nskA+BESR1y83hsIS+7eV6XxMSK5Hos1WOBA5JRQ08QZMwTamM6nrUJqeCTTF\r\nN5wQXyyCoN1kuVX27MXv8wRrxUVEkHN5H3BKyvPXDjj80MHlCJUrtPqM6ppk\r\nI8XSrLS/rSkDH57pYmIewZ6cHb9ig2BSSB+6W5wZMQejZLBxbvXVw7PqrWmb\r\n5S9NpWjdQnZc+VidJMr+skEr0vtTaE6ZBxX8L3y/HB+pVCPuxbf6djP9tNns\r\ndvr+EUaI3eb5TA62vFAtd65U2lSaC+RzsodlwRBm3dXSeAVv/LDvglfrQJQJ\r\n3QQxW0WR885vOBl7gAYKkanBVj69g2Az8dLOraLjEXVWZOt1/2500dhLnTxk\r\nRO3fvfBPIwn5PUekm3WQ3R/166azgmdrWEP8x8nVzBPyLC+34TBeVbYCoHz6\r\n7NOc/0FTaTulKprGlO15LOn8DMdRGMd+EpU=\r\n=BhLm\r\n-----END PGP SIGNATURE-----\r\n"},"_npmUser":{"name":"algoraven.com","email":"hi@algoraven.com"},"directories":{},"maintainers":[{"name":"algoraven.com","email":"hi@algoraven.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/config_0.1.16_1661125993739_0.8470961874710627"},"_hasShrinkwrap":false}},"time":{"created":"2022-06-21T00:31:39.653Z","0.1.13":"2022-06-21T00:31:39.972Z","modified":"2022-08-21T23:53:13.971Z","0.1.14":"2022-07-24T05:20:37.381Z","0.1.15":"2022-07-30T15:47:20.344Z","0.1.16":"2022-08-21T23:53:13.890Z"},"maintainers":[{"name":"algoraven.com","email":"hi@algoraven.com"}],"description":"[](https://www.npmjs.com/package/@algoraven/config)","author":{"name":"BitBird, Inc.","email":"hi@algoraven.com"},"readme":"# config\n\n[](https://www.npmjs.com/package/@algoraven/config)\n\nDynamic configuration variable storage for all things AlgoRaven.\n\n> ⚠️ Manual publishes are required to update the NPM library. No CI/CD is performed on merge.\n\n## Publishing to NPM\n\nConfig is a stable repository and changes only ever need to be made in the `data` folder.\n\nUnderlying code changes will require manual publishing to NPM. To publish:\n\n1. Push a commit up to `main` with a new version number.\n2. Run `yarn build` locally to build the source.\n3. Run `npm publish` locally to publish the package.\n\n## Creating Config Variables\n\n1. Navigate to your chosen service (i.e. `api`) under the environment you're wishing to add your variable to from within the [data](./data) directory.\n\n2. Create a new file within the service's folder with the exact name of your variable (i.e. `/data/staging/api/max_retry_count`).\n\n3. Repeat for [development](./data/development), [staging](./data/staging), and [production](./data/production) folders. If you would like to add a fallback value in case no environment is specified, add it to [default](./data/development).\n\n4. Your variable name will be its relative path from the environment directory, except with `.` replacing `/`. For instance, a variable at `/data/staging/api/max_retry_count` will be accessed via `api.max_retry_count`.\n\n## Using Config Variables\n\n1. Install: `yarn add @algoraven/config`\n\n2. Import the `Config` class as follows.\n ```\n import Config from '@algoraven/config'\n ```\n\n3. Initialize it with an access token and an environment. Defaults environment to `default`.\n ```\n const config = new Config('abcdefghijklmnop', 'production')\n ```\n\n3. Retrieve a config variable via the `config` object.\n ```\n // The second parameter is the default value if the config variable cannot be retrieved.\n // The third parameter is the duration to cache a non-empty result before trying again.\n const maxRetryCount = await config.getNumber('api.max_retry_count', 3, CACHE_DURATION.LONG)\n ```\n","readmeFilename":"README.md"}