swaggie 1.1.3-test.1 → 1.2.0

package/README.md

@@ -8,9 +8,7 @@
 ![NodeCI](https://github.com/yhnavein/swaggie/workflows/NodeCI/badge.svg)
 ![Test Coverage](https://img.shields.io/badge/test_coverage-98%25-brightgreen)
 ![npm downloads](https://img.shields.io/npm/dw/swaggie.svg)
-![npm bundle size](https://img.shields.io/bundlephobia/minzip/swaggie.svg)
 ![npm install size](https://packagephobia.now.sh/badge?p=swaggie)
-![Hackage Dependencies](https://img.shields.io/hackage-deps/v/swaggie)
 
 Generate Typescript code from an OpenAPI 3.0 document, so that accessing REST API resources from the client code is less error-prone, static-typed and just easier to use long-term.
 
@@ -86,7 +84,7 @@ swaggie -s https://petstore3.swagger.io/api/v3/openapi.json -o ./client/petstore
 swaggie -s $URL -o ./client/petstore.ts && prettier ./client/petstore.ts --write`
 ```
 
-And this can be easily automated (in the npm scripts for example)
+And this can be easily automated (in the `npm` scripts for example)
 
 ### Configuration File
 
@@ -238,6 +236,29 @@ If Petstore owners decide to remove method we use, then after running `swaggie`
 
 Without this approach, the error would be spotted by our end-user and he/she would not appreciate it at all!
 
+## Other features
+
+### Parameter adjustment
+
+In some cases you might want to adjust the parameters globally but without touching the OpenAPI spec. For example, the spec may explicitly define some of parameters as `required`, but you will handle them in the interceptor. In such case, you don't want to define them is every single method. This is where this feature comes in handy.
+
+Example (in the config file):
+
+```json
+{
+  "modifiers": {
+    "parameters": {
+      "clientId": "ignore",
+      "orgId": "optional",
+      "country": "required"
+    }
+  }
+}
+```
+
+This will ensure that `clientId` parameters will never appear in any of the generated methods, and `orgId` will be optional (regardless of what the spec says).
+You can also use `required` value to enforce the parameter to be required, _(but in this case, realistically it would be better to just fix the spec)_.
+
 ## Server config
 
 You might wonder how to set up server to fully utilize Swaggie's features. For that I've added a `samples/` folder with sample configurations.
@@ -270,18 +291,18 @@ function error(e) {
 
 ## Notes
 
-| Supported                                                                      | Not supported                              |
-| ------------------------------------------------------------------------------ | ------------------------------------------ |
-| OpenAPI 3                                                                      | Swagger, Open API 2.0                      |
-| `allOf`, `oneOf`, `anyOf`, `$ref` to schemas                                   | `not`                                      |
-| Spec formats: `JSON`, `YAML`                                                   | Very complex query params                  |
-| Extensions: `x-position`, `x-name`, `x-enumNames`, `x-enum-varnames`           | Multiple response types (one will be used) |
-| Content types: `JSON`, `text`, `multipart/form-data`                           | Multiple request types (one will be used)  |
-| Content types: `application/x-www-form-urlencoded`, `application/octet-stream` | References to other spec files             |
-| Different types of enum definitions (+ OpenAPI 3.1 support for enums)          |                                            |
-| Paths inheritance, comments (descriptions)                                     |                                            |
-| Getting documents from remote locations or as path reference (local file)      |                                            |
-| Grouping endpoints by tags + handle gracefully duplicate operation ids         |                                            |
+| Supported                                                                      | Not supported                                   |
+| ------------------------------------------------------------------------------ | ----------------------------------------------- |
+| OpenAPI 3                                                                      | Swagger, Open API 2.0                           |
+| `allOf`, `oneOf`, `anyOf`, `$ref` to schemas                                   | `not`                                           |
+| Spec formats: `JSON`, `YAML`                                                   | Very complex query params                       |
+| Extensions: `x-position`, `x-name`, `x-enumNames`, `x-enum-varnames`           | Multiple response types (only one will be used) |
+| Content types: `JSON`, `text`, `multipart/form-data`                           | Multiple request types (only one will be used)  |
+| Content types: `application/x-www-form-urlencoded`, `application/octet-stream` | References to other spec files                  |
+| Different types of enum definitions (+ OpenAPI 3.1 support for enums)          | OpenAPI callbacks                               |
+| Paths inheritance, comments (descriptions)                                     | OpenAPI webhooks                                |
+| Getting documents from remote locations or as path reference (local file)      |                                                 |
+| Grouping endpoints by tags + handle gracefully duplicate operation ids         |                                                 |
 
 ## Used by
 

package/dist/gen/genOperations.js

@@ -123,6 +123,15 @@ function prepareClient(
   });
 } exports.prepareOperations = prepareOperations;
 
+/**
+ * Marks parameters as skippable based on their position relative to the last required parameter.
+ *
+ * This function iterates through the list of parameters and finds the last required parameter
+ * (where `optional` is false). All parameters that come after this required parameter are marked
+ * as skippable. This is useful, as we can skip such parameters when calling the generated function.
+ *
+ * @param params - Array of operation parameters to analyze and mark as skippable. (in-place modification)
+ */
 function markParametersAsSkippable(params) {
   const lastRequiredParamIndex = params.map((p) => !p.optional).lastIndexOf(true);
   if (lastRequiredParamIndex === params.length - 1) {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "swaggie",
-  "version": "1.1.3-test.1",
+  "version": "1.2.0",
   "description": "Generate TypeScript REST client code from an OpenAPI spec",
   "author": {
     "name": "Piotr Dabrowski",
@@ -24,11 +24,11 @@
     "swaggie": "dist/cli.js"
   },
   "scripts": {
-    "build": "sucrase ./src -d ./dist --transforms typescript,imports && npm run rm-tests && npm run types",
+    "build": "sucrase ./src -d ./dist --transforms typescript,imports && yarn rm-tests && yarn types",
     "rm-tests": "find dist/ \\( -name '*.spec.js' -o -name 'types.js' \\) -type f -delete",
     "types": "tsc src/types.ts --outDir dist/ --declaration --emitDeclarationOnly && cp test/index.d.ts ./dist/",
-    "test": "mocha",
-    "coverage": "npx nyc -r text -r json-summary mocha"
+    "test": "tsx --test 'src/**/*.spec.ts' 'test/**/*.spec.ts'",
+    "coverage": "npx c8 yarn test"
   },
   "files": [
     "dist",
@@ -47,7 +47,8 @@
     "swr",
     "service",
     "typescript",
-    "codegen"
+    "codegen",
+    "TanStack Query"
   ],
   "dependencies": {
     "case": "^1.6.3",
@@ -58,14 +59,11 @@
     "undici": "^6.21.1"
   },
   "devDependencies": {
-    "@types/chai": "5.2.2",
     "@types/js-yaml": "4.0.9",
-    "@types/mocha": "10.0.10",
     "@types/node": "24.2.0",
-    "chai": "5.2.1",
-    "mocha": "11.7.1",
     "openapi-types": "^12.1.3",
     "sucrase": "3.35.0",
+    "tsx": "^4.20.3",
     "typescript": "5.9.2"
   }
 }