{"_id":"docspring-ts","_rev":"6-a2fcd730e32397c69c0a1a0a4e389ef8","name":"docspring-ts","dist-tags":{"latest":"3.0.0"},"versions":{"1.0.0":{"name":"docspring-ts","version":"1.0.0","author":{"name":"OpenAPI-Generator Contributors"},"license":"Unlicense","_id":"docspring-ts@1.0.0","maintainers":[{"name":"formapi","email":"dev@formapi.io"}],"homepage":"https://github.com/GIT_USER_ID/GIT_REPO_ID#readme","bugs":{"url":"https://github.com/GIT_USER_ID/GIT_REPO_ID/issues"},"dist":{"shasum":"22b792f5664ec5042a89d40b4fc43ad84693b892","tarball":"https://registry.npmjs.org/docspring-ts/-/docspring-ts-1.0.0.tgz","fileCount":59,"integrity":"sha512-xT6TUmt8RIsGM5hrssBVKk1tzKyJJ6GKjk/xMKN87hWl58BGbGNEOvlwzd5Wk9VVZfxKBsvsj5+4pO0ikOhOgA==","signatures":[{"sig":"MEUCIQD8r2AT3KS3tR8ZbQ560rAdbK1r+cD3gme3DrUWM037PgIgeM+Ht85vsijn0ZIu195bETtELC9I0oOQIIDaXWxpixg=","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":253197},"main":"dist/api.js","types":"dist/api.d.ts","gitHead":"7018bbf88238bd3e05826d93b815952bf26448e0","scripts":{"test":"npm run build && node dist/client.js","build":"tsc","clean":"rm -Rf node_modules/ *.js"},"_npmUser":{"name":"formapi","email":"dev@formapi.io"},"repository":{"url":"git+https://github.com/GIT_USER_ID/GIT_REPO_ID.git","type":"git"},"_npmVersion":"9.6.7","description":"NodeJS client for docspring-ts","directories":{},"_nodeVersion":"18.17.1","dependencies":{"rewire":"^3.0.2","request":"^2.81.0","bluebird":"^3.5.0"},"_hasShrinkwrap":false,"devDependencies":{"typescript":"^4.0","@types/node":"^12","@types/request":"^2.48.8","@types/bluebird":"^3.5.33"},"_npmOperationalInternal":{"tmp":"tmp/docspring-ts_1.0.0_1693368494712_0.4463032979371113","host":"s3://npm-registry-packages"}},"1.0.1":{"name":"docspring-ts","version":"1.0.1","author":{"name":"OpenAPI-Generator Contributors"},"license":"Unlicense","_id":"docspring-ts@1.0.1","maintainers":[{"name":"formapi","email":"support@docspring.com"}],"homepage":"https://github.com/GIT_USER_ID/GIT_REPO_ID#readme","bugs":{"url":"https://github.com/GIT_USER_ID/GIT_REPO_ID/issues"},"dist":{"shasum":"6bd1b6a31aee03ddd886ca20233b776097018311","tarball":"https://registry.npmjs.org/docspring-ts/-/docspring-ts-1.0.1.tgz","fileCount":224,"integrity":"sha512-q2htOGuoVsIOW1lg0VsnUFM3+O+kGWb0rioVXpcadbJVOW8kht/rTMo5YNX29ho1+Y7ssrza52Es1bK5oG6vlg==","signatures":[{"sig":"MEYCIQDWw5+JgmozDrB1gWCYNFGftvU+bHVoDOmxR570dnH8gQIhAPDKeHfr+5FRNDEynDuLlyAOdSHBpu3VmyoD/jZK7k1i","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":741604},"main":"dist/api.js","types":"dist/api.d.ts","gitHead":"cd5f1560806dbd98ec91efefd28cd9fcd3159a59","scripts":{"test":"npm run build && node dist/client.js","build":"tsc","clean":"rm -Rf node_modules/ *.js"},"_npmUser":{"name":"formapi","email":"support@docspring.com"},"repository":{"url":"git+https://github.com/GIT_USER_ID/GIT_REPO_ID.git","type":"git"},"_npmVersion":"9.6.7","description":"NodeJS client for docspring-ts","directories":{},"_nodeVersion":"18.17.1","dependencies":{"rewire":"^3.0.2","request":"^2.81.0","bluebird":"^3.5.0"},"_hasShrinkwrap":false,"devDependencies":{"typescript":"^4.0","@types/node":"^12","@types/request":"^2.48.8","@types/bluebird":"^3.5.33"},"_npmOperationalInternal":{"tmp":"tmp/docspring-ts_1.0.1_1693375775697_0.623115701549898","host":"s3://npm-registry-packages"}},"1.0.2":{"name":"docspring-ts","version":"1.0.2","author":{"name":"OpenAPI-Generator"},"_id":"docspring-ts@1.0.2","maintainers":[{"name":"formapi","email":"engineering@docspring.com"}],"homepage":"https://github.com/DocSpring/docspring-typescript#readme","bugs":{"url":"https://github.com/DocSpring/docspring-typescript/issues"},"dist":{"shasum":"94da51d27820f978a6cca299fb5dfa00f62c6865","tarball":"https://registry.npmjs.org/docspring-ts/-/docspring-ts-1.0.2.tgz","fileCount":176,"integrity":"sha512-YsZm19AsYuECyukIXImXVEdTnO9eZ0vECuOAMEHNsE8uzkrYGIB6oZgVSR6AP9cayhiOP2FdO4mjDTXfTOTV5w==","signatures":[{"sig":"MEYCIQD+7f+spbESJGpj68lrVNXY/JAhQL+XV3AoKpcUCULq1wIhALAHpCr/aCb3V/IWzZbr7CzcZJruDfKDSK1654hj7oL/","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":658829},"main":"./dist/index.js","gitHead":"2883fe7e667e9c66f038943126649a87878cfde9","scripts":{"build":"tsc","prepare":"npm run build"},"typings":"./dist/index.d.ts","_npmUser":{"name":"formapi","email":"engineering@docspring.com"},"repository":{"url":"git+https://github.com/DocSpring/docspring-typescript.git","type":"git"},"_npmVersion":"9.6.7","description":"OpenAPI client for docspring-ts","directories":{},"_nodeVersion":"18.17.1","_hasShrinkwrap":false,"devDependencies":{"typescript":"^4.0"},"_npmOperationalInternal":{"tmp":"tmp/docspring-ts_1.0.2_1695802147658_0.39665752527622233","host":"s3://npm-registry-packages"}},"2.0.0":{"name":"docspring-ts","version":"2.0.0","keywords":["fetch","typescript","openapi-client","openapi-generator"],"author":{"name":"OpenAPI-Generator Contributors"},"license":"Unlicense","_id":"docspring-ts@2.0.0","maintainers":[{"name":"formapi","email":"engineering@docspring.com"}],"homepage":"https://github.com/DocSpring/docspring-typescript#readme","bugs":{"url":"https://github.com/DocSpring/docspring-typescript/issues"},"dist":{"shasum":"9d2358136a3f0ac8543a54cf15a17146b8def057","tarball":"https://registry.npmjs.org/docspring-ts/-/docspring-ts-2.0.0.tgz","fileCount":198,"integrity":"sha512-t2NALdRkm5M8UJRlDfQPvFEdWDPeHOycSYY+rtScWIbf0R+N/poDarKWkJ8T73fFzWd34E8ZFMckJ46XZ3Eiaw==","signatures":[{"sig":"MEYCIQDI1n28GWSa29zKl5xvnCpk/w5IUXokAgMD+YiQk6QNWwIhAPrr+vapt93TX4NmpyCSGIZ3+rEzha8HhuNmrUXeIfOF","keyid":"SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U"}],"unpackedSize":889569},"main":"./dist/index.js","type":"commonjs","exports":{".":{"types":"./dist/index.d.js","require":"./dist/index.js"}},"gitHead":"51f0a5c9dc4c0ab806cad76e37565c6a375d209c","scripts":{"build":"tsc","prepare":"npm run build"},"typings":"./dist/index.d.ts","_npmUser":{"name":"formapi","email":"engineering@docspring.com"},"repository":{"url":"git+https://github.com/DocSpring/docspring-typescript.git","type":"git"},"_npmVersion":"10.9.2","description":"OpenAPI client for docspring-ts","directories":{},"_nodeVersion":"23.6.1","dependencies":{"es6-promise":"^4.2.4","whatwg-fetch":"^3.0.0"},"_hasShrinkwrap":false,"devDependencies":{"typescript":"^4.0","@types/node":"^22.13.5"},"_npmOperationalInternal":{"tmp":"tmp/docspring-ts_2.0.0_1740558851513_0.0011329958954211516","host":"s3://npm-registry-packages-npm-production"}},"2.1.0":{"name":"docspring-ts","version":"2.1.0","keywords":["fetch","typescript","openapi-client","openapi-generator"],"author":{"name":"OpenAPI-Generator Contributors"},"license":"Unlicense","_id":"docspring-ts@2.1.0","maintainers":[{"name":"formapi","email":"engineering@docspring.com"}],"homepage":"https://github.com/DocSpring/docspring-typescript#readme","bugs":{"url":"https://github.com/DocSpring/docspring-typescript/issues"},"dist":{"shasum":"2dbfdf76a94ae1255fd3fe82104bf07bbf73f056","tarball":"https://registry.npmjs.org/docspring-ts/-/docspring-ts-2.1.0.tgz","fileCount":210,"integrity":"sha512-rqVE9LTG84+CId9tJPKJKrxROYfGUDtkn2AHpaybfb1CQoFPaDLPAsCt0Hb2XA4pjtRqehhgiFrKizO4SmJI5w==","signatures":[{"sig":"MEQCIEsU1NVhQL3Q38om3yyrvNENbMjwf9UbiNp0crMuwVUZAiBWEOl/gj7vC3FNEUEY2A72eA1aRE8enjEfI1c39d5CHw==","keyid":"SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U"}],"unpackedSize":945445},"main":"./dist/index.js","type":"commonjs","exports":{".":{"types":"./dist/index.d.js","require":"./dist/index.js"}},"gitHead":"a486eacfb38c409dbab601f58ded35168675efa5","scripts":{"build":"tsc","prepare":"npm run build"},"typings":"./dist/index.d.ts","_npmUser":{"name":"formapi","email":"engineering@docspring.com"},"repository":{"url":"git+https://github.com/DocSpring/docspring-typescript.git","type":"git"},"_npmVersion":"9.6.7","description":"OpenAPI client for docspring-ts","directories":{},"_nodeVersion":"18.17.1","dependencies":{"es6-promise":"^4.2.4","whatwg-fetch":"^3.0.0"},"_hasShrinkwrap":false,"devDependencies":{"typescript":"^4.0","@types/node":"^22.13.11"},"_npmOperationalInternal":{"tmp":"tmp/docspring-ts_2.1.0_1742638772527_0.6278583274951728","host":"s3://npm-registry-packages-npm-production"}},"3.0.0":{"name":"docspring-ts","version":"3.0.0","description":"OpenAPI client for docspring-ts","author":{"name":"OpenAPI-Generator Contributors"},"repository":{"type":"git","url":"git+https://github.com/DocSpring/docspring-typescript.git"},"keywords":["fetch","typescript","openapi-client","openapi-generator"],"license":"Unlicense","main":"./dist/index.js","type":"commonjs","exports":{".":{"require":"./dist/index.js","types":"./dist/index.d.js"}},"typings":"./dist/index.d.ts","scripts":{"build":"tsc","prepare":"npm run build"},"dependencies":{"es6-promise":"^4.2.4","whatwg-fetch":"^3.0.0"},"devDependencies":{"@types/node":"^18.19.127","typescript":"^4.0"},"_id":"docspring-ts@3.0.0","gitHead":"6001a0bb83d0844386cd04dcbf07549cc5309121","bugs":{"url":"https://github.com/DocSpring/docspring-typescript/issues"},"homepage":"https://github.com/DocSpring/docspring-typescript#readme","_nodeVersion":"22.19.0","_npmVersion":"10.9.3","dist":{"integrity":"sha512-amAz0tFiIPjQ2WXpyNSI/MTYBNO9dJ0k8ieNQ0TTDMNMSjdoicosJZ26q3rExwrqWuwVBxnUM4p+uaOZmJmsTA==","shasum":"70cafb3074e35449b362b12726edc948b70cd012","tarball":"https://registry.npmjs.org/docspring-ts/-/docspring-ts-3.0.0.tgz","fileCount":213,"unpackedSize":972494,"signatures":[{"keyid":"SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U","sig":"MEUCIQC3lesCmH9Lp3g2CgfKh3trKT9DaY8YbASqf0yhYY/LBAIgSIY6CMlvILHGVuW3rpJvk25qqyRYHmJkPRqQblcjyK8="}]},"_npmUser":{"name":"formapi","email":"engineering@docspring.com"},"directories":{},"maintainers":[{"name":"formapi","email":"engineering@docspring.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages-npm-production","tmp":"tmp/docspring-ts_3.0.0_1758675594297_0.7203609025842852"},"_hasShrinkwrap":false}},"time":{"created":"2023-08-30T04:08:14.593Z","modified":"2025-09-24T00:59:54.677Z","1.0.0":"2023-08-30T04:08:14.958Z","1.0.1":"2023-08-30T06:09:35.887Z","1.0.2":"2023-09-27T08:09:07.973Z","2.0.0":"2025-02-26T08:34:11.895Z","2.1.0":"2025-03-22T10:19:32.703Z","3.0.0":"2025-09-24T00:59:54.492Z"},"bugs":{"url":"https://github.com/DocSpring/docspring-typescript/issues"},"author":{"name":"OpenAPI-Generator Contributors"},"license":"Unlicense","homepage":"https://github.com/DocSpring/docspring-typescript#readme","keywords":["fetch","typescript","openapi-client","openapi-generator"],"repository":{"type":"git","url":"git+https://github.com/DocSpring/docspring-typescript.git"},"description":"OpenAPI client for docspring-ts","maintainers":[{"name":"formapi","email":"engineering@docspring.com"}],"readme":"## docspring-ts@3.0.0\n\nThis generator creates TypeScript/JavaScript client that utilizes fetch-api.\n\n### Building\n\nTo build and compile the typescript sources to javascript use:\n```\nnpm install\nnpm run build\n```\n\n### Publishing\n\nFirst build the package then run ```npm publish```\n\n### Consuming\n\nNavigate to the folder of your consuming project and run one of the following commands.\n\n_published:_\n\n```\nnpm install docspring-ts@3.0.0 --save\n```\n\n_unPublished (not recommended):_\n\n```\nnpm install PATH_TO_GENERATED_PACKAGE --save\n```\n\n### Usage\n\nBelow code snippet shows exemplary usage of the configuration and the API based \non the typical `PetStore` example used for OpenAPI. \n\n```\nimport * as your_api from 'your_api_package'\n\n// Covers all auth methods included in your OpenAPI yaml definition\nconst authConfig: your_api.AuthMethodsConfiguration = {\n    \"api_key\": \"YOUR_API_KEY\"\n}\n\n// Implements a simple middleware to modify requests before (`pre`) they are sent\n// and after (`post`) they have been received \nclass Test implements your_api.Middleware {\n    pre(context: your_api.RequestContext): Promise<your_api.RequestContext> {\n        // Modify context here and return\n        return Promise.resolve(context);\n    }\n\n    post(context: your_api.ResponseContext): Promise<your_api.ResponseContext> {\n        return Promise.resolve(context);\n    }\n\n}\n\n// Create configuration parameter object\nconst configurationParameters = {\n    httpApi: new your_api.JQueryHttpLibrary(), // Can also be ignored - default is usually fine\n    baseServer: your_api.servers[0], // First server is default\n    authMethods: authConfig, // No auth is default\n    promiseMiddleware: [new Test()],\n}\n\n// Convert to actual configuration\nconst config = your_api.createConfiguration(configurationParameters);\n\n// Use configuration with your_api\nconst api = new your_api.PetApi(config);\nyour_api.Pet p = new your_api.Pet();\np.name = \"My new pet\";\np.photoUrls = [];\np.tags = [];\np.status = \"available\";\nPromise<your_api.Pet> createdPet = api.addPet(p);\n\n```\n","readmeFilename":"README.md"}