{"_id":"@ahmedrowaihi/postman-sdk","_rev":"1-a1f2ce6ae2fbaff637f8cd5c0335a3f8","name":"@ahmedrowaihi/postman-sdk","dist-tags":{"latest":"1.0.2"},"versions":{"1.0.1":{"name":"@ahmedrowaihi/postman-sdk","version":"1.0.1","main":"main.js","license":"MIT","author":{"name":"Ahmed Rowaihi"},"description":"Convert Postman collection into javascript SDK","bin":{"postman-sdk":"dist/main.js"},"scripts":{"start":"npm run build && node dist/main.js","prebuild":"yarn run clean","build":"babel src -d dist","postbuild":"yarn run copy-files","clean":"rimraf dist/","copy-files":"copyfiles -u 1 src/boilerplate/**.* dist/","release":"standard-version","//copy-files":"copyfiles -u 1 src/boilerplate/**.* dist/ && copyfiles -u 1 src/collections/**.* dist/"},"dependencies":{"axios":"^1.2.1","copyfiles":"^2.4.1","ejs":"^3.1.8","fs-extra":"^11.1.0","postman-collection":"^4.1.7","prettier":"^2.8.1","yargs":"^17.6.2","yargs-parser":"^21.1.1"},"devDependencies":{"@babel/cli":"^7.20.7","@babel/core":"^7.20.12","@babel/preset-env":"^7.20.2","@types/postman-collection":"^3.5.7","babel-loader":"^9.1.2"},"gitHead":"cef65ad24af94a11adabdc1cee4fc624ebe9e88e","_id":"@ahmedrowaihi/postman-sdk@1.0.1","_nodeVersion":"18.12.0","_npmVersion":"8.19.2","dist":{"integrity":"sha512-FRKHwY8C9QGH6kXGgY0OZs3qaXX6H+j13/MJ8kWRsvblks/ou40uoQf/rZ8jgcA9Ns7rabHFfXxghu7WZeCNTQ==","shasum":"eeed20ba46c26c77cf6068b6eb6667770556a744","tarball":"https://registry.npmjs.org/@ahmedrowaihi/postman-sdk/-/postman-sdk-1.0.1.tgz","fileCount":13,"unpackedSize":27242,"signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEQCIGIew1tOHHrpASCI9rwKRePo1rwRqJQRTVK+xvaXustjAiAIY/oSxETyrWwsOkmcqIqnOdEgwB5rV21atD7RDqUwqw=="}],"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v4.10.10\r\nComment: https://openpgpjs.org\r\n\r\nwsFzBAEBCAAGBQJj5TaXACEJED1NWxICdlZqFiEECWMYAoorWMhJKdjhPU1b\r\nEgJ2VmoD0w//SAjs+AH2k+Ukk7fw04GAnklX3pjP3RT8THNHuVYTpEm6DQkM\r\ns79vYGl7SZmjrtLNTCKzZUu2tOk709OwW9JCq+d+SZY8G6ytA+HHGuxtqc2P\r\nCyuPhO1NcuF198pwazR6Vwjz+gkHsmso/cLeF9siE4UanYM1cjFOo9XNUpfd\r\nwrfVwRF9lHgdUnscIF4ODp0Zf+t630S54PSBV7cJnQrBFNoq5VRx4xxI5U+E\r\n1oa+NWFGKCh9yjsV5/xf1Cd0mb5ZrIt13SX/MDhYC4fGkGUrM7pMeZ+dw9Ia\r\npwLXKX5uMwHIZKonrMTz3Hf4yAwduYwIKAvCmZtq6mILrFwBrfP23yxBWZRu\r\nDYZLJYUjH88N54llLzISecZpG/ui3Ql4K2j9nGfA0a5CQIQn5NvnQr8zKDsl\r\nLrDkGvtUB3h0yD9pPt5fIlbqYzBoiIIO6DpjJWpsS7rqRtNyPFe54G0HmbZF\r\nCFmVbVfiQnfHZqosgdkioWJMDoUOJe8fuQGiAjTlWMGMxYS9W1aUnNmsDBGr\r\nQXeHKuovTFYO6t2KgyL/X+ON3jkBtrrASCizASReR4zuSQYgM4LU9JZWdOB2\r\nKB4oi+JyTqVorjU4hvWimWktjVS8H1NLHoyUHH5jLyPVULGR651/be4ktIqQ\r\nz0IwmQamdOn8QoI1E5Ncmf+ez7a4GIRwJvg=\r\n=H9QD\r\n-----END PGP SIGNATURE-----\r\n"},"_npmUser":{"name":"ahmedrowaihi","email":"ahmedrowaihi1@gmail.com"},"directories":{},"maintainers":[{"name":"ahmedrowaihi","email":"ahmedrowaihi1@gmail.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/postman-sdk_1.0.1_1675966103684_0.6273827693673812"},"_hasShrinkwrap":false},"1.0.2":{"name":"@ahmedrowaihi/postman-sdk","version":"1.0.2","main":"main.js","license":"MIT","author":{"name":"Ahmed Rowaihi"},"description":"Convert Postman collection into javascript SDK","bin":{"postman-sdk":"dist/main.js"},"scripts":{"start":"npm run build && node dist/main.js","prebuild":"yarn run clean","build":"babel src -d dist","postbuild":"yarn run copy-files","clean":"rimraf dist/","copy-files":"copyfiles -u 1 src/boilerplate/**.* dist/","release":"standard-version","//copy-files":"copyfiles -u 1 src/boilerplate/**.* dist/ && copyfiles -u 1 src/collections/**.* dist/"},"dependencies":{"axios":"^1.2.1","copyfiles":"^2.4.1","ejs":"^3.1.8","fs-extra":"^11.1.0","postman-collection":"^4.1.7","prettier":"^2.8.1","yargs":"^17.6.2","yargs-parser":"^21.1.1"},"devDependencies":{"@babel/cli":"^7.20.7","@babel/core":"^7.20.12","@babel/preset-env":"^7.20.2","@types/postman-collection":"^3.5.7","babel-loader":"^9.1.2","babel-preset-minify":"^0.5.2"},"gitHead":"bbb5e2901524a9b8b03751c3c6de78f550faf8b1","_id":"@ahmedrowaihi/postman-sdk@1.0.2","_nodeVersion":"18.12.0","_npmVersion":"8.19.2","dist":{"integrity":"sha512-iU6TI/3RL3Mp//6DOCd1kLCtM2Io5qwh69PQSdefhDIXOJRykem0X2cIviIMasfSsbiT1P3i7ZiV/MbJ+KQgYA==","shasum":"d1c169e480f0a73d279019254878e98905c03725","tarball":"https://registry.npmjs.org/@ahmedrowaihi/postman-sdk/-/postman-sdk-1.0.2.tgz","fileCount":13,"unpackedSize":18251,"signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEQCIDoTysth5LFD66ofiOjaBMmcKmN9mLepJneYkyqVqm3KAiBNhLbwlFraM4bhLEp7JMFbi++mn3VOZyKLSb8j9L/1jg=="}],"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v4.10.10\r\nComment: https://openpgpjs.org\r\n\r\nwsFzBAEBCAAGBQJj5Th0ACEJED1NWxICdlZqFiEECWMYAoorWMhJKdjhPU1b\r\nEgJ2Vmpcow/+KKzr6tUKoZM7oXujcKMbKJjsRfBdU0elOzSzQV9elpVzhH8w\r\no1HgbZjRFI3VuGDfFG4sQSmtFYbxfwMxJIaCtxua8SBs+KdNrxPCJxqyhQU+\r\nCerUf7GPO4/Nw8lW7tX8QHzwj+m4971Wdb1aF1iMiu3Y5+iySIqGzfLQjS8Y\r\nHcnU6vtjU0bMCBmK3vjGIIP24bCMkikD/lDGpC3AdkhbJOz72C4EG5V0Ui8X\r\nZmuE8vnZk9LGlf2emtmV9vh0dYtI+2bCynA38zo4OIoNg4R5ZpPFEB/uKayK\r\nWZz17ivgKskqN3ejO3pdX0Wx6Jp/Yejz365AnES/NoT3IMzIuLnlGNgM/2cE\r\ntzgpqwV/N6pjaly/rFAQ7zuLu8BiLUWxtusXVl4B+Ljw3Caj1hib3lEnswKS\r\n/UdKQj2ZUQWPwRbO+I7iByWFwq2ILIDuA8UFtYrsiMsHZHBkIkU2RVYTNTZA\r\nB8HS8V14+rb+17xBV6Z9XjCJyNeIsyG9YBo48YhS9D+D1gmE4VlSq9fYhn/u\r\nuzBkROtItAFqpJNy0rHu9dxm9gOVAVKHDFvee2MSAe+JbNSAZ069eH3UJs0G\r\nr8sBoklfIc0nqDXs/r+IVxytBPmWRm8xotfToITgwAJ5un5lIqih8+Sa2+8l\r\nqKu93FOAWZhdXy1tY9mivHO4XENjNTR5Ark=\r\n=fa+6\r\n-----END PGP SIGNATURE-----\r\n"},"_npmUser":{"name":"ahmedrowaihi","email":"ahmedrowaihi1@gmail.com"},"directories":{},"maintainers":[{"name":"ahmedrowaihi","email":"ahmedrowaihi1@gmail.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/postman-sdk_1.0.2_1675966580654_0.9463364427606231"},"_hasShrinkwrap":false}},"time":{"created":"2023-02-09T18:08:23.532Z","1.0.1":"2023-02-09T18:08:23.835Z","modified":"2023-02-09T18:16:20.915Z","1.0.2":"2023-02-09T18:16:20.844Z"},"maintainers":[{"name":"ahmedrowaihi","email":"ahmedrowaihi1@gmail.com"}],"description":"Convert Postman collection into javascript SDK","author":{"name":"Ahmed Rowaihi"},"license":"MIT","readme":"## postman-sdk\r\n\r\npostman-sdk is a utility library that converts a Postman collection json file into [axios](https://axios-http.com/docs/intro)\r\nclient class.\r\n\r\n## Usage\r\n\r\nTo run the utility, you need to have Node.js installed on your machine. You can download it from [here](https://nodejs.org/en/download/).\r\n\r\nTo install the utility, run the following command:\r\n\r\n```bash\r\nnpm install -g postman-sdk\r\n```\r\n\r\nor using npx:\r\n\r\n```bash\r\nnpx postman-sdk\r\n```\r\n\r\nExample To generate a TypeScript SDK, run the following command:\r\n\r\n```bash\r\npostman-sdk --ts --s ./collections/BigCollection.json --o ./SDK.ts --b https://api.example.com\r\n```\r\n\r\n## Options\r\n\r\n| Option                | Description                    | Default                            | required |\r\n| --------------------- | ------------------------------ | ---------------------------------- | -------- |\r\n| `--src`, `-s`         | Path to the Postman Collection | `./collections/BigCollection.json` | Yes      |\r\n| `--out`, `-o`         | Path to the output file        | `./SDK.ts`                         | No       |\r\n| `--baseURL`, `-b`     | Base URL for the API           | `https://api.example.com`          | No       |\r\n| `--typescript`, `-ts` | Generate a TypeScript SDK      | `true`                             | No       |\r\n| `--commonjs`, `-c`    | Generate a CommonJS SDK        | `false`                            | No       |\r\n| `--help`, `-h`        | Show this help message         | `false`                            | No       |\r\n\r\n## License\r\n\r\n[MIT](https://choosealicense.com/licenses/mit/)\r\n\r\n## Contributing\r\n\r\nPull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.\r\n\r\nPlease make sure to update tests as appropriate.\r\n\r\n## Authors\r\n\r\n- [**Ahmed Rowaihi**](https://twitter.com/ahmedrowaihi)\r\n\r\n## Requested Features\r\n\r\n- [x] Add support for other HTTP methods (e.g. PUT, PATCH, DELETE, etc.)\r\n- [x] Support TypeScript SDK generation\r\n- [x] Support CommonJS SDK generation\r\n- [x] basic class boilerplate strategey\r\n- [x] Proof of concept\r\n- [ ] - [ ] Add support for other languages (e.g. Python, Java, etc.)\r\n- [ ] Add support for other HTTP clients (e.g. fetch, etc.)\r\n- [ ] Assure that the generated SDK is compatible with the Postman collection version (e.g. v2.1, v2.0, etc.)\r\n- [ ] Add support for Postman environments\r\n- [ ] Add support for Postman variables\r\n- [ ] Add Paramas, Headers, and Body to the generated SDK methods with types if possible\r\n- [ ] Add more boilerplate strategies\r\n","readmeFilename":"README.md"}