{"_id":"@apeleghq/cose-algorithms","name":"@apeleghq/cose-algorithms","dist-tags":{"latest":"20240911.0.0"},"versions":{"20240911.0.0":{"name":"@apeleghq/cose-algorithms","version":"20240911.0.0","description":"A mapping of IANA COSE Algorithm names to their values","type":"module","main":"./dist/coseAlgorithms.cjs","types":"./dist/coseAlgorithms.dts","module":"./dist/coseAlgorithms.js","exports":{".":{"import":{"types":"./dist/coseAlgorithms.d.ts","default":"./dist/coseAlgorithms.js"},"require":{"types":"./dist/coseAlgorithms.d.cts","default":"./dist/coseAlgorithms.cjs"}}},"devDependencies":{"@types/node":"^22.5.4","@typescript-eslint/eslint-plugin":"^8.5.0","@typescript-eslint/parser":"^8.5.0","eslint":"^8.57.0","eslint-config-prettier":"^9.1.0","eslint-plugin-prettier":"^5.1.3","prettier":"^3.3.3","ts-node":"^10.9.2","typescript":"^5.6.2"},"repository":{"type":"git","url":"git+https://github.com/ApelegHQ/ts-cose-algorithms.git"},"scripts":{"lint":"eslint . --ext .js,.jsx,.ts,.tsx","lint:fix":"eslint . --ext .js,.jsx,.ts,.tsx --fix","build":"tsc --declarationMap --declaration","prepack":"npm run build","prepublishOnly":"npm run lint","preversion":"npm run lint","version":"npm run lint && git add -A src","postversion":"git push && git push --tags"},"author":{"name":"Apeleg Limited"},"license":"CC0-1.0","keywords":["cose","cose-algorithms","rfc9053","rfc9054"],"_id":"@apeleghq/cose-algorithms@20240911.0.0","gitHead":"3c5c91ec14b084e0ab24d4bca25d30f146e66ddb","bugs":{"url":"https://github.com/ApelegHQ/ts-cose-algorithms/issues"},"homepage":"https://github.com/ApelegHQ/ts-cose-algorithms#readme","_nodeVersion":"20.17.0","_npmVersion":"10.8.2","dist":{"integrity":"sha512-4Yo4yoh7DusxtrOuRbOwerETDScvNHGjHKVxPwkQbzW1dM67WaXTG+YLvi+WJaEIXII8f1+4fTwbCX/oFuyxgQ==","shasum":"0ba9476d3489df538ca700ecb2f0f3f59646678b","tarball":"https://registry.npmjs.org/@apeleghq/cose-algorithms/-/cose-algorithms-20240911.0.0.tgz","fileCount":12,"unpackedSize":80598,"attestations":{"url":"https://registry.npmjs.org/-/npm/v1/attestations/@apeleghq%2fcose-algorithms@20240911.0.0","provenance":{"predicateType":"https://slsa.dev/provenance/v1"}},"signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEYCIQDg5aoLUynXlUXLIAXsgA9vp85ox2dmgsfHHN2k3kmsrAIhAIYPkarvK0HeFO3+8pL0dda0VOG8U6GibS0Y5V2zOXw7"}]},"_npmUser":{"name":"er-ci-bot","email":"npmjs.com+er-ci-bot+fd8b22b478b6fac7@apeleg.com"},"directories":{},"maintainers":[{"name":"er-ci-bot","email":"npmjs.com+er-ci-bot+fd8b22b478b6fac7@apeleg.com"},{"name":"corrideat","email":"3857362+corrideat@users.noreply.github.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/cose-algorithms_20240911.0.0_1726087120322_0.6645913345330468"},"_hasShrinkwrap":false}},"time":{"created":"2024-09-11T20:38:40.218Z","20240911.0.0":"2024-09-11T20:38:40.500Z","modified":"2024-09-11T20:38:41.093Z"},"maintainers":[{"name":"er-ci-bot","email":"npmjs.com+er-ci-bot+fd8b22b478b6fac7@apeleg.com"},{"name":"corrideat","email":"3857362+corrideat@users.noreply.github.com"}],"description":"A mapping of IANA COSE Algorithm names to their values","homepage":"https://github.com/ApelegHQ/ts-cose-algorithms#readme","keywords":["cose","cose-algorithms","rfc9053","rfc9054"],"repository":{"type":"git","url":"git+https://github.com/ApelegHQ/ts-cose-algorithms.git"},"author":{"name":"Apeleg Limited"},"bugs":{"url":"https://github.com/ApelegHQ/ts-cose-algorithms/issues"},"license":"CC0-1.0","readme":"🔒 **Identifiers from IANA's COSE Algorithms Registry**\r\n\r\n [![Reliability Rating](https://sonarcloud.io/api/project_badges/measure?project=Exact-Realty_ts-cose-algorithms&metric=reliability_rating)](https://sonarcloud.io/summary/new_code?id=Exact-Realty_ts-cose-algorithms)\r\n [![Vulnerabilities](https://sonarcloud.io/api/project_badges/measure?project=Exact-Realty_ts-cose-algorithms&metric=vulnerabilities)](https://sonarcloud.io/summary/new_code?id=Exact-Realty_ts-cose-algorithms)\r\n [![Bugs](https://sonarcloud.io/api/project_badges/measure?project=Exact-Realty_ts-cose-algorithms&metric=bugs)](https://sonarcloud.io/summary/new_code?id=Exact-Realty_ts-cose-algorithms)\r\n [![Security Rating](https://sonarcloud.io/api/project_badges/measure?project=Exact-Realty_ts-cose-algorithms&metric=security_rating)](https://sonarcloud.io/summary/new_code?id=Exact-Realty_ts-cose-algorithms)\r\n [![Maintainability Rating](https://sonarcloud.io/api/project_badges/measure?project=Exact-Realty_ts-cose-algorithms&metric=sqale_rating)](https://sonarcloud.io/summary/new_code?id=Exact-Realty_ts-cose-algorithms)\r\n [![NPM Downloads](https://img.shields.io/npm/dw/%40exact-realty/cose-algorithms?style=flat-square)](https://www.npmjs.com/package/%40exact-realty/cose-algorithms)\r\n\r\n---\r\n### 🚀 Features\r\n\r\n- Implements all assigined entries in [IANA's COSE Algorithm](https://www.iana.org/assignments/cose/cose.xhtml#algorithms) that have a name and a value.\r\n- Simple exported constants, with no code to execute.\r\n- Some name transformations were required to make them valid JS identifiers.\r\n  - For example, `HMAC 256/64` becomes `HMAC256_s_64` and `ECDH-SS + HKDF-256`\r\n    becomes `ECDH_SS_and_HKDF_256`.\r\n- Incudes `JSDoc` with a description as well as a note as to whether the value\r\n  is currently deprecated or recommended.\r\n- It does _not_ support reverse lookups. For example, there is not built in way\r\n  to find the name for, for example, the value `0` (a reverse lookup would yield\r\n  `Reserved`).\r\n\r\n### 💻 Installation\r\n\r\nTo install the package, you can use npm or yarn:\r\n\r\n```sh\r\nnpm install @apeleghq/cose-algorithms\r\n```\r\n\r\nor\r\n\r\n```sh\r\nyarn add @apeleghq/cose-algorithms\r\n```\r\n\r\n### 📚 Usage\r\n\r\n#### Decrypting Data\r\n\r\n```javascript\r\nimport { encodings, decrypt } from '@apeleghq/cose-algorithms';\r\n\r\n```\r\n\r\n### 🤝 Contributing\r\n\r\nWe welcome any contributions and feedback! Please feel free to submit pull\r\nrequests, bug reports or feature requests to our GitHub repository.\r\n\r\n### 📜 License\r\n\r\nThis project is dedicated to the public domain, and you may do with it as you\r\nwish. Check out the `LICENSE.txt` file for more information.\r\n\r\nIf you download the full sources, note that some support files might (such as\r\n`.prettierrc.cjs`) might have a different license. In those cases, that license\r\napplies.\r\n","readmeFilename":"README.md"}