{"_id":"@basketry/sorbet-http-client","_rev":"1-adca68ee26b8f20d3900cccecfb38e0c","name":"@basketry/sorbet-http-client","dist-tags":{"latest":"0.0.2"},"versions":{"0.0.1":{"name":"@basketry/sorbet-http-client","version":"0.0.1","description":"Basketry generator for generating HTTP clients implemented in Ruby/Sorbet","main":"./lib/index.js","scripts":{"test":"jest","clean":"run-s -s clean:*","create-snapshot":"ts-node ./src/snapshot/create-snapshot.ts","lint":"run-s -s lint:*","fix":"run-s -s fix:*","clean:output":"rimraf lib","start":"node ./lib/index.js","prebuild":"run-s -s clean lint","build":"tsc","lint:eslint":"eslint src/**/*.*","fix:eslint":"eslint --fix src/**/*.*","lint:prettier":"prettier -c .","fix:prettier":"prettier -w .","clean:coverage":"rimraf coverage","pretest":"run-s -s clean","prepack":"run-s -s build"},"keywords":[],"author":{"name":"Steve Konves"},"license":"MIT","repository":{"type":"git","url":"git+https://github.com/basketry/sorbet-http-client.git"},"bugs":{"url":"https://github.com/basketry/sorbet-http-client/issues"},"homepage":"https://github.com/basketry/sorbet-http-client#readme","devDependencies":{"@types/jest":"^27.4.0","@types/node":"^17.0.10","@types/pluralize":"^0.0.29","@typescript-eslint/eslint-plugin":"^5.8.1","@typescript-eslint/parser":"^5.8.1","eslint":"^8.5.0","eslint-config-prettier":"^8.3.0","eslint-plugin-import":"^2.25.3","jest":"^27.4.7","npm-run-all":"^4.1.5","rimraf":"^3.0.2","ts-jest":"^27.1.3","ts-node":"^10.4.0","typescript":"^4.5.5"},"dependencies":{"@basketry/sorbet":"^0.0.14","basketry":"^0.0.25","case":"^1.6.3","pluralize":"^8.0.0","prettier":"^2.5.1"},"types":"./lib/index.d.ts","gitHead":"879955a3cbfdd1d50329f47b05be35e0a5aa3d40","_id":"@basketry/sorbet-http-client@0.0.1","_nodeVersion":"18.4.0","_npmVersion":"8.12.1","dist":{"integrity":"sha512-1soZAGPY1roXlMyBBGgwQLg8D63RBTdvAh64GZpXpFe+xSNEVa02kj3HWTuQkqogPunYVwNmuoGEWMi6+edGFg==","shasum":"1726b66bbf209889c9091718aa2d1ad0ec3420df","tarball":"https://registry.npmjs.org/@basketry/sorbet-http-client/-/sorbet-http-client-0.0.1.tgz","fileCount":24,"unpackedSize":57856,"signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEYCIQC0KHozTsOBblLhxnHQU27KRyIv1+vRh62YdUcVOcqNzQIhANyvYCxTjvci2iDmkNh83Fzn/GAcRY4pvx4UwqcdtU+6"}],"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v4.10.10\r\nComment: https://openpgpjs.org\r\n\r\nwsFzBAEBCAAGBQJirji+ACEJED1NWxICdlZqFiEECWMYAoorWMhJKdjhPU1b\r\nEgJ2Vmr+YA//ZiuyNjv9o6SU6VNHZHVS2YzTMAMav9zOvlbpgGrmqzS/Q8u4\r\nQ10I2WY60AKqdhLIIsoqWLOMyEAX5YigT8rT7RTOhjDNkU9XlFs4CUEYdJAo\r\nmysXBnmlxr1DF/ZDt2h3+4Syw4TD4qqSRpgLdY55buSJJDf+W4Z3F0BUH6AC\r\n6HoIDAnyT7lOwPdbLcKGbMMidTdusroITXJckxb752DDg0NlNB7CyQbDh5za\r\nVALsQLqUlitRKI0a02XR6P7WkwTqzQvO/Wqo7OD3DQwd2GabynujXv4nJHpb\r\nAvFBP6RQ1hmK/5/BhfH7dDjUq2+xMqnoHBDRiyJ4ng8bStVVWFE3lDCXOq25\r\n4lYGCKlz9iATxdd7GErUNMU5u8sVX8pmVFljNUvYeaJLzqMTdyprdItxm+sw\r\n7/FSNesin5ZIeli/PuZeDZKAlPbRFEgx7cwxW3Lf8YRWONqnvrBl3K0kTKVi\r\nsqiI4/DvS/pew3HY2WrdRaXCOsvCN3TG/tzrTnxqGPJk40Q2RIvaB8KNev9t\r\nzwe5onJfq9f5PvAnza3PjlBnVrD+iACn22jrNKp2QXB8UOi66O6UmQRAHCFi\r\nKDGgaSHmDcqtfc8I9kIx6hY8636wWtM0oLye1qmqaq3fQi88F13t+bBT9r0S\r\n9FNwGZisuR2ceCQpax7qQ9X5LMmXqwTwnqc=\r\n=KrnC\r\n-----END PGP SIGNATURE-----\r\n"},"_npmUser":{"name":"skonves","email":"stephen.konves@gmail.com"},"directories":{},"maintainers":[{"name":"skonves","email":"stephen.konves@gmail.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/sorbet-http-client_0.0.1_1655584958509_0.6856389405262024"},"_hasShrinkwrap":false},"0.0.2":{"name":"@basketry/sorbet-http-client","version":"0.0.2","description":"Basketry generator for generating HTTP clients implemented in Ruby/Sorbet","main":"./lib/index.js","scripts":{"test":"jest","clean":"run-s -s clean:*","create-snapshot":"ts-node ./src/snapshot/create-snapshot.ts","lint":"run-s -s lint:*","fix":"run-s -s fix:*","clean:output":"rimraf lib","start":"node ./lib/index.js","prebuild":"run-s -s clean lint","build":"tsc","lint:eslint":"eslint src/**/*.*","fix:eslint":"eslint --fix src/**/*.*","lint:prettier":"prettier -c .","fix:prettier":"prettier -w .","clean:coverage":"rimraf coverage","pretest":"run-s -s clean","prepack":"run-s -s build"},"keywords":[],"author":{"name":"Steve Konves"},"license":"MIT","repository":{"type":"git","url":"git+https://github.com/basketry/sorbet-http-client.git"},"bugs":{"url":"https://github.com/basketry/sorbet-http-client/issues"},"homepage":"https://github.com/basketry/sorbet-http-client#readme","devDependencies":{"@types/jest":"^27.4.0","@types/node":"^17.0.10","@types/pluralize":"^0.0.29","@typescript-eslint/eslint-plugin":"^5.8.1","@typescript-eslint/parser":"^5.8.1","eslint":"^8.5.0","eslint-config-prettier":"^8.3.0","eslint-plugin-import":"^2.25.3","jest":"^27.4.7","npm-run-all":"^4.1.5","rimraf":"^3.0.2","ts-jest":"^27.1.3","ts-node":"^10.4.0","typescript":"^4.5.5"},"dependencies":{"@basketry/sorbet":"^0.0.14","basketry":"^0.0.25","case":"^1.6.3","pluralize":"^8.0.0","prettier":"^2.5.1"},"types":"./lib/index.d.ts","gitHead":"ed8c9f6bf7382239a8273b71bb2c106d9243e377","_id":"@basketry/sorbet-http-client@0.0.2","_nodeVersion":"18.12.1","_npmVersion":"8.19.2","dist":{"integrity":"sha512-GcyoTvIcSGe/a6syy7DQifFEQD7nTGvyvn8V8TPTfDCOI705+9+uvZbnd6i9XsbeCPSoJHEWSZTVM0BMy72IFQ==","shasum":"e020e48ab9670220b2e5991bfb56b97c474d660b","tarball":"https://registry.npmjs.org/@basketry/sorbet-http-client/-/sorbet-http-client-0.0.2.tgz","fileCount":24,"unpackedSize":56844,"signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEYCIQC+Q6f3qo869n6Z+DtPJXNR3WYuB/pVBSTL8SMm7ANw5gIhAINYGqSjmKkYRJpgpi2YQoRtIDdmpoGuZ9sw6owSZeum"}],"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v4.10.10\r\nComment: https://openpgpjs.org\r\n\r\nwsFzBAEBCAAGBQJjijzKACEJED1NWxICdlZqFiEECWMYAoorWMhJKdjhPU1b\r\nEgJ2Vmp/JA/9ERIbmWhrliupfhuu2yygJ9gzaFJpa/V/ORNURIbWvpva7ALD\r\ndTbyXDUc9SG9FMJ4+ByJfAgpfKD0MndsrdE/yfK76cECaOFmjMWHONSNOuIt\r\nDnq7Eyynf9LlhPvBN8Smz4kQ1H9cSAvUaEQVZ8WoNVA4fMW4prZkvW+bcVHL\r\nnlylR1Gce1JCGAWDz6Cg9yO6Fq9l3RuAU/1ZleQUfH+JZgA6ptHTzvT6U7hC\r\nzwM5Y+bEsdoBrOM4KjHqS99CFszJgqb952wwwo0CJY+vKK4niiaMzH6VyglM\r\nkdFxXSlKRyftoc3VmaAdsBvKGu83kEa+V8nS/s8O3YM7/5hqxEGJcs13PNC5\r\nHH3J31fUSPW4SwPlWBGbdF6BbpWj563FiEvhThlhMsqYO2Pm46Knlr0ZNo5+\r\nr2mYhyip6m7LUlflEk3K9Bj26NsjyXigv60n17M5PMGkvheegA14jbwrmZYF\r\n4fB5/omfSi2J0Fa8beKgHzsRBL3A4uMQZxyZstIHlAGzWKMDQXEdKBSnkiLG\r\nVlrIw3SbzVeik8IeUqmGs8Lifp/UgIMcnTXpA1FMyrZwUMX1VDnUNnisq1O6\r\n3pfviLiSRkSCsxU9ZhV7lFPZrFDlfavU81fPzsxJkscXTq8dIlRJfdIB6MUj\r\nbdqNxgyPPgnMBZIPPBKvMns3XnjEK0FRnAw=\r\n=1h7z\r\n-----END PGP SIGNATURE-----\r\n"},"_npmUser":{"name":"skonves","email":"stephen.konves@gmail.com"},"directories":{},"maintainers":[{"name":"skonves","email":"stephen.konves@gmail.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/sorbet-http-client_0.0.2_1670003914349_0.796187329526201"},"_hasShrinkwrap":false}},"time":{"created":"2022-06-18T20:42:38.448Z","0.0.1":"2022-06-18T20:42:38.682Z","modified":"2022-12-02T17:58:34.699Z","0.0.2":"2022-12-02T17:58:34.575Z"},"maintainers":[{"name":"skonves","email":"stephen.konves@gmail.com"}],"description":"Basketry generator for generating HTTP clients implemented in Ruby/Sorbet","homepage":"https://github.com/basketry/sorbet-http-client#readme","keywords":[],"repository":{"type":"git","url":"git+https://github.com/basketry/sorbet-http-client.git"},"author":{"name":"Steve Konves"},"bugs":{"url":"https://github.com/basketry/sorbet-http-client/issues"},"license":"MIT","readme":"[![main](https://github.com/basketry/sorbet-http-client/workflows/build/badge.svg?branch=main&event=push)](https://github.com/basketry/sorbet-http-client/actions?query=workflow%3Abuild+branch%3Amain+event%3Apush)\n[![master](https://img.shields.io/npm/v/@basketry/sorbet-http-client)](https://www.npmjs.com/package/@basketry/sorbet-http-client)\n\n# Ruby/Sorbey HTTP Client\n\n[Basketry generator](https://github.com/basketry) generator for generating HTTP clients implemented in Ruby/Sorbet. This generator can be coupled with any Basketry pipeline. It is recommended to use this generator alongside the [`@basketry/sorbet`](https://github.com/basketry/sorbet) generator.\n\n## Quick Start\n\nThe following example converts a \"Swagger\" doc into [Sorbet](https://sorbet.org/) types:\n\n1. Save `https://petstore.swagger.io/v2/swagger.json` as `petstore.json` in the root of your project.\n1. Install packages: `npm install -g basketry @basketry/swagger-2 @basketry/sorbet @basketry/sorbet-http-client`\n1. Generate code: `basketry --source petstore.json --parser @basketry/swagger-2 --generators @basketry/sorbet @basketry/sorbet-http-client --output src`\n\nWhen the last step is run, basketry will parse the source file (`petstore.json`) using the specified parser (`@basketry/swagger-2`) and then run each specified generator writing the output folder (`src`).\n\n## Folder Structure\n\nExample config without options:\n\n```json\n{\n  \"source\": \"petstore.json\",\n  \"parser\": \"@basketry/swagger-2\",\n  \"generators\": [\"@basketry/sorbet\", \"@basketry/sorbet-http-client\"],\n  \"output\": \"\",\n  \"options\": { \"basketry\": { \"subfolder\": \"app/lib\" } }\n}\n```\n\nResulting output:\n\n```\nmy_project/\n├─ app/\n│  ├─ lib/\n│  │  ├─ petstore/\n│  │  │  ├─ v1/\n│  │  │  │  ├─ http_client_helpers.rb\n│  │  │  │  ├─ pets_http_client.rb\n│  │  │  │  ├─ stores_http_client.rb\n│  │  │  │  ├─ users_http_client.rb\n├─ .gitattributes\n├─ basketry.config.json\n├─ petstore.json\n```\n\n## Options\n\nAll Rails generator options are namespaced within a `sorbet` property. This generator's options include all options accepted by `@basketry/sorbet`. For this reason, it is recommended that all `sorbet` options be defined as common options to ensure that code generated by all sorbet-related generators use the same module and folder structure conventions.\n\nExample config:\n\n```json\n{\n  \"source\": \"petstore.json\",\n  \"parser\": \"@basketry/swagger-2\",\n  \"generators\": [\"@basketry/sorbet\", \"@basketry/sorbet-validators\"],\n  \"output\": \"\",\n  \"options\": {\n    \"basketry\": {\n      \"subfolder\": \"app/lib\"\n    }\n  }\n}\n```\n\n## Snapshots\n\nAn example of generated HTTP client code can be found as a test snapshot at [`/src/snapshot/`](./src/snapshot/).\n\n---\n\n## For contributors:\n\n### Run this project\n\n1.  Install packages: `npm ci`\n1.  Build the code: `npm run build`\n1.  Run it! `npm start`\n\nNote that the `lint` script is run prior to `build`. Auto-fixable linting or formatting errors may be fixed by running `npm run fix`.\n\n### Create and run tests\n\n1.  Add tests by creating files with the `.test.ts` suffix\n1.  Run the tests: `npm t`\n1.  Test coverage can be viewed at `/coverage/lcov-report/index.html`\n\n### Publish a new package version\n\n1. Ensure latest code is published on the `main` branch.\n1. Create the new version number with `npm version {major|minor|patch}`\n1. Push the branch and the version tag: `git push origin main --follow-tags`\n\nThe [publish workflow](https://github.com/basketry/sorbet-validators/actions/workflows/publish.yml) will build and pack the new version then push the package to NPM. Note that publishing requires write access to the `main` branch.\n\n---\n\nGenerated with [generator-ts-console](https://www.npmjs.com/package/generator-ts-console)\n","readmeFilename":"README.md"}