{"_id":"sanitize-s3-objectkey","_rev":"5-c9e79a6c4499ccef6fac0acead283177","name":"sanitize-s3-objectkey","dist-tags":{"latest":"0.0.1"},"versions":{"0.0.1":{"name":"sanitize-s3-objectkey","version":"0.0.1","description":"Remove and replace illegal characters in S3 Object Keys","main":"index.js","scripts":{"test":"jest","lint":"eslint ."},"repository":{"type":"git","url":"git+https://github.com/Advanon/sanitize-s3-objectkey.git"},"keywords":["aws","s3","objectkey","sanitize"],"author":{"name":"Advanon AG"},"license":"Apache-2.0","bugs":{"url":"https://github.com/Advanon/sanitize-s3-objectkey/issues"},"homepage":"https://github.com/Advanon/sanitize-s3-objectkey#readme","devDependencies":{"eslint":"^6.3.0","jest":"^24.9.0"},"dependencies":{},"gitHead":"7af995f963b7251e700d2cd1ef85a435972d22cb","_id":"sanitize-s3-objectkey@0.0.1","_nodeVersion":"10.16.3","_npmVersion":"6.11.3","dist":{"integrity":"sha512-ZTk7aqLxy4sD40GWcYWoLfbe05XLmkKvh6vGKe13ADlei24xlezcvjgKy1qRArlaIbIMYaqK7PCalvZtulZlaQ==","shasum":"efa9887cd45275b40234fb4bb12fc5754fe64e7e","tarball":"https://registry.npmjs.org/sanitize-s3-objectkey/-/sanitize-s3-objectkey-0.0.1.tgz","fileCount":8,"unpackedSize":29951,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.4\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJdeOU3CRA9TVsSAnZWagAA1LsQAJv3wOA3I498ZZNPIsi3\nDsFrl8lZy71RwrzQ1FzsoZiMnt2tW8yO7tY5fFBYsPph074YhY6OcTn+Pn4G\nWUhkRbwajTxOofr80U1n1hnoBUoc50VMwbMoNO0nzgwOqi/zYN7dRrEvbBfP\nLkRSis6EH9dLXcpim6vK0XSOzxXUKBhZG0kvAbhX6Se8d/bqTcDNHUwX7/9C\nVoOAZ0BBqy6r1rqjiv1yaJrzDtgu9Y8Qf2FE6uKisrzfJg6seOSVHF5kbEl3\nQ/gnJt4t/L155IDs6Tvzcbp6GbTybyMexjecM56p/yr4P5cHpKMxgIVsy3kR\nCmwDEAxWJunbGUS4fagIHewkgdz8bIz7sDcEbXM5e7MvYxQFhE1l0+EQV7m8\nSuEMAJCD1asUMQVOrKl3wInrNSpoyVd4DEaDbLkJDqZY0awqtW6k3UVALtKW\nzeA4/ligccS+dl7oI8d83p2bwEyC8umDcShuInQpYzuPnssduaODGovEb5Px\nvt5qydXDt050AGFO12C6C+Gwi0TaZ1Aezbcg0001acAK9SqiVCxMYWBtnj2a\nw44qmjRDI4+/s0Td4ayVVq1Pc/z69zozj74l68Lxb8UaR5uswcOZ9l/PxhBu\n93gF/uAXVsPAbPQZfT/FE5zRL1dbT4tHDM0cBVfmomKnW2ys65WVxHKRSIiH\nladh\r\n=CBsO\r\n-----END PGP SIGNATURE-----\r\n","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCIQDYIti9f0SSkXbYENVBFSQmFdHfT9gjq+jG1SaWkVSzDwIgE3tj4KN8+t0kLL3gKxbDRHNdnhjCnXmNcKSz6GJzXXw="}]},"maintainers":[{"name":"advanon-ag","email":"it@advanon.com"}],"_npmUser":{"name":"advanon-ag","email":"it@advanon.com"},"directories":{},"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/sanitize-s3-objectkey_0.0.1_1568204087157_0.37439881464810654"},"_hasShrinkwrap":false}},"time":{"created":"2019-09-11T12:14:47.157Z","0.0.1":"2019-09-11T12:14:47.330Z","modified":"2022-05-17T02:52:15.137Z"},"maintainers":[{"email":"maciej.nowicki@cg24.com","name":"maciej.nowicki-cg24"},{"email":"it@advanon.com","name":"advanon-root"},{"email":"vlad.gramuzov@gmail.com","name":"pandomic"},{"email":"bejand2010c@gmail.com","name":"dbejan"}],"description":"Remove and replace illegal characters in S3 Object Keys","homepage":"https://github.com/Advanon/sanitize-s3-objectkey#readme","keywords":["aws","s3","objectkey","sanitize"],"repository":{"type":"git","url":"git+https://github.com/Advanon/sanitize-s3-objectkey.git"},"author":{"name":"Advanon AG"},"bugs":{"url":"https://github.com/Advanon/sanitize-s3-objectkey/issues"},"license":"Apache-2.0","readme":"# sanitize-s3-objectkey\n0 dependencies library to sanitize S3 object keys.\n\n## Motivation\nYou can use any UTF-8 character in an S3 object key name. However, using certain characters in key names may cause problems with some applications and protocols ([source](https://docs.aws.amazon.com/AmazonS3/latest/dev/UsingMetadata.html)).\nThis library applies some conversions on the provided object key to help mitigate these problems.  \nIn particular:\n- spaces at the beginning and end of the string are removed\n- spaces inside the string are replaced by a (configurable) separator\n- accents from latin characters are removed\n- illegal characters are removed\n\nThis project is heavily inspired by [s3-filename](https://github.com/hamxabaig/s3-filename).\n\n## Installation\n```sh\nnpm install sanitize-s3-objectkey\n```\n\n## Usage\n```js\nconst sanitize = require('sanitize-s3-objectkey');\n\nsanitize('áêīòü'); // aeiou\nsanitize('pipes|are|not|valid'); // pipesarenotvalid\nsanitize('spaces should be replaced'); // spaces-should-be-replaced\nsanitize('spaces should be replaced', '/'); // spaces/should/be/replaced\n```\n\n## Contributing\nFeedback, bug reports, and pull requests are welcome.\n\nFor pull requests, make sure to follow the following guidelines:\n* Add tests for each new feature and bug fix.\n* Follow the existing code style, enforced by eslint.\n* Separate unrelated changes into multiple pull requests.\n\n## License\nApache License 2.0, see [LICENSE](LICENSE.md).\n","readmeFilename":"README.md"}