swagger-typescript-api 13.0.5 → 13.0.6

package/LICENSE

@@ -19,4 +19,4 @@ MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
 IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
 CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
 TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
-SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

package/README.md

@@ -1,30 +1,15 @@
 # swagger-typescript-api
 
-<img
-  src="https://raw.githubusercontent.com/acacode/swagger-typescript-api/master/assets/swagger-typescript-api-logo.png"
-  title="swagger-typescript-api logo by js2me"
-  align="left"
-  height="180"
-  width="93"
-/>
+- Support for OpenAPI 3.0, 2.0, JSON and YAML
+- Generate the API client for Fetch or Axios from an OpenAPI Specification
 
-- Generate api via swagger scheme
-- Supports OA 3.0, 2.0, JSON, yaml
-- Generated api module use [**Fetch Api**](https://developer.mozilla.org/en-US/docs/Web/API/Fetch_API) or [**Axios**](https://github.com/axios/axios) to make requests.
+Any questions you can ask [**here**](https://github.com/acacode/swagger-typescript-api/discussions)
 
-<br>
+## Examples
 
-Any questions you can ask [**here**](https://github.com/acacode/swagger-typescript-api/issues) or in [**our Slack**](https://join.slack.com/t/acacode/shared_invite/enQtOTQ5ODgyODQzMzYwLWYxOGI1MzQ3Yzg1ZWI5ZTI5NzNiZjExZTE5OWI1YjQ4NjBiNTk4NWVlNjM5YmU1ZWI2ZDkyMzZkZGIxNjA5NTQ)(**#swagger-typescript-api** channel)
+All examples you can find [**here**](https://github.com/acacode/swagger-typescript-api/tree/main/tests)
 
-![](https://raw.githubusercontent.com/acacode/swagger-typescript-api/master/assets/components-converter-example.jpg)
-
-Thanks to [JetBrains](https://www.jetbrains.com/?from=swaggertypescriptapi) for providing a free license for their excellent Webstorm IDE.
-
-## 👀 Examples
-
-All examples you can find [**here**](https://github.com/acacode/swagger-typescript-api/tree/master/tests)
-
-## 📄 Usage
+## Usage
 
 ```muse
 Usage: sta [options]
@@ -203,7 +188,7 @@ generateTemplates({
 });
 ```
 
-## 💎 options
+## Options
 
 ### **`--templates`**
 
@@ -487,21 +472,13 @@ generateApi({
 
 See more about [swagger schema type/format data here](https://json-schema.org/understanding-json-schema/reference/string.html#dates-and-times)
 
-## 📄 Mass media
+## Mass media
 
 - [5 Lessons learned about swagger-typescript-api](https://christo8989.medium.com/5-lessons-learned-about-swagger-typescript-api-511240b34c1)
 - [Why Swagger schemes are needed in frontend development ?](https://dev.to/js2me/why-swagger-schemes-are-needed-in-frontend-development-2cb4)
 - [Migration en douceur vers TypeScript (French)](https://www.premieroctet.com/blog/migration-typescript/)
 - [swagger-typescript-api usage (Japanese)](https://zenn.dev/watahaya/articles/2f4a716c47903b)
 
-## 🚀 How it looks
-
-![](https://raw.githubusercontent.com/acacode/swagger-typescript-api/master/assets/npx.gif)
-
-![](https://raw.githubusercontent.com/acacode/swagger-typescript-api/master/assets/auth-example.gif)
-
-![](https://raw.githubusercontent.com/acacode/swagger-typescript-api/master/assets/typings1.gif)
-
-## 📝 License
+## License
 
-Licensed under the [MIT License](https://github.com/acacode/swagger-typescript-api/blob/master/LICENSE).
+Licensed under the [MIT License](https://github.com/acacode/swagger-typescript-api/blob/main/LICENSE).

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "swagger-typescript-api",
-  "version": "13.0.5",
+  "version": "13.0.6",
   "description": "Generate TypeScript/JavaScript API from Swagger schema",
   "homepage": "https://github.com/acacode/swagger-typescript-api",
   "bugs": "https://github.com/acacode/swagger-typescript-api/issues",
@@ -30,61 +30,7 @@
     "cli:yaml": "node index.js -r -d -p ./swagger-test-cli.yaml -n swagger-test-cli.ts",
     "format": "biome format --write .",
     "format:check": "biome format .",
-    "generate": "node tests/generate.js",
-    "generate-extended": "node tests/generate-extended.js",
-    "node": "node swagger-test-cli/generate.js",
-    "node:debug": "node --nolazy swagger-test-cli/generate.js",
-    "test-all": "yarn test-extended && yarn test-simple && yarn test-specific",
-    "test-all(update-snapshots)": "cross-env UPDATE_SNAPSHOTS=true yarn test-all",
-    "test-extended": "node --unhandled-rejections=strict scripts_runner.js generate-extended validate",
-    "test-simple": "node --unhandled-rejections=strict scripts_runner.js generate validate",
-    "test-specific": "node --unhandled-rejections=strict scripts_runner.js \"test:*\"",
-    "test-specific(update-snapshots)": "cross-env UPDATE_SNAPSHOTS=true node --unhandled-rejections=strict scripts_runner.js \"test:*\"",
-    "test:--add-readonly": "node tests/spec/readonly/test.js",
-    "test:--another-array-type": "node tests/spec/another-array-type/test.js",
-    "test:--axios": "node tests/spec/axios/test.js",
-    "test:--axios--single-http-client": "node tests/spec/axiosSingleHttpClient/test.js",
-    "test:--cli": "shx rm -rf tests/spec/cli/schema.ts && node index.js -p tests/spec/cli/schema.json -o tests/spec/cli -n schema.ts --extract-response-body --extract-response-error --api-class-name MySuperApi --type-prefix Prefix && node tests/spec/cli/test.js",
-    "test:--default-as-success": "node tests/spec/defaultAsSuccess/test.js",
-    "test:--default-response": "node tests/spec/defaultResponse/test.js",
-    "test:--dot-path-params": "node tests/spec/dot-path-params/test.js",
-    "test:--enum-names-as-values": "node tests/spec/enumNamesAsValues/test.js",
-    "test:--extract-request-body": "node tests/spec/extractRequestBody/test.js",
-    "test:--extract-request-params": "node tests/spec/extractRequestParams/test.js",
-    "test:--extract-response-body": "node tests/spec/extractResponseBody/test.js",
-    "test:--extract-response-error": "node tests/spec/extractResponseError/test.js",
-    "test:--js": "node tests/spec/js/test.js",
-    "test:--js--axios": "node tests/spec/jsAxios/test.js",
-    "test:--modular": "node tests/spec/modular/test.js",
-    "test:--module-name-first-tag": "node tests/spec/moduleNameFirstTag/test.js",
-    "test:--module-name-index": "node tests/spec/moduleNameIndex/test.js",
-    "test:--no-client": "node tests/spec/noClient/test.js",
-    "test:--object-types": "node tests/spec/object-types/test.js",
-    "test:--patch": "node tests/spec/patch/test.js",
-    "test:--primitive-type-constructs": "node tests/spec/primitive-type-constructs/test.js",
-    "test:--responses": "node tests/spec/responses/test.js",
-    "test:--route-types": "node tests/spec/routeTypes/test.js",
-    "test:--single-http-client": "node tests/spec/singleHttpClient/test.js",
-    "test:--templates": "node tests/spec/templates/test.js",
-    "test:--type-suffix--type-prefix": "node tests/spec/typeSuffixPrefix/test.js",
-    "test:--union-enums": "node tests/spec/unionEnums/test.js",
-    "test:additionalProperties2.0": "node tests/spec/additional-properties-2.0/test.js",
-    "test:another-query-params": "node tests/spec/another-query-params/test.js",
-    "test:const-keyword": "node tests/spec/const-keyword/test.js",
-    "test:deprecated": "node tests/spec/deprecated/test.js",
-    "test:discriminator": "node tests/spec/discriminator/test.js",
-    "test:enums2.0": "node tests/spec/enums-2.0/test.js",
-    "test:extra-templates": "node tests/spec/extra-templates/test.js",
-    "test:extract-enums": "node tests/spec/extract-enums/test.js",
-    "test:jsSingleHttpClientModular": "node tests/spec/jsSingleHttpClientModular/test.js",
-    "test:nullableRefTest2.0": "node tests/spec/nullable-2.0/test.js",
-    "test:nullableRefTest3.0": "node tests/spec/nullable-3.0/test.js",
-    "test:on-insert-path-param": "node tests/spec/on-insert-path-param/test.js",
-    "test:partialBaseTemplate": "node tests/spec/partialBaseTemplate/test.js",
-    "test:partialDefaultTemplate": "node tests/spec/partialDefaultTemplate/test.js",
-    "test:sort-types": "node tests/spec/sortTypes/test.js",
-    "test:sort-types-false": "node tests/spec/sortTypes-false/test.js",
-    "test:specProperty": "node tests/spec/specProperty/test.js",
+    "test": "vitest run",
     "validate": "node tests/validate.js",
     "validate:debug": "node --nolazy tests/validate.js"
   },
@@ -97,22 +43,20 @@
     "lodash": "^4.17.21",
     "nanoid": "^3.3.7",
     "node-emoji": "^2.1.3",
-    "prettier": "3.3.0",
+    "prettier": "~3.3.2",
     "swagger-schema-official": "2.0.0-bab6bed",
     "swagger2openapi": "^7.0.8",
-    "typescript": "5.4.5"
+    "typescript": "~5.4.5"
   },
   "devDependencies": {
-    "@biomejs/biome": "1.7.3",
-    "@types/lodash": "4.17.4",
-    "@types/node": "20.13.0",
+    "@biomejs/biome": "1.8.1",
+    "@types/lodash": "4.17.5",
+    "@types/node": "20.14.2",
     "axios": "1.7.2",
-    "cross-env": "7.0.3",
-    "dotenv": "16.4.5",
-    "git-diff": "2.0.6",
-    "shx": "0.3.4"
+    "shx": "0.3.4",
+    "vitest": "1.6.0"
   },
-  "packageManager": "yarn@4.2.2",
+  "packageManager": "yarn@4.3.0",
   "engines": {
     "node": ">=18.0.0"
   },

package/templates/base/http-client.ejs

@@ -1,3 +1,3 @@
 <% const { config } = it; %>
-<% /* https://github.com/acacode/swagger-typescript-api/tree/next/templates/base/http-clients/ */ %>
-<%~ includeFile(`@base/http-clients/${config.httpClientType}-http-client`, it) %>
+<% /* https://github.com/acacode/swagger-typescript-api/tree/main/templates/base/http-clients/ */ %>
+<%~ includeFile(`@base/http-clients/${config.httpClientType}-http-client`, it) %>

package/templates/base/route-name.ejs

@@ -40,4 +40,4 @@ if (route === "/")
   return _.camelCase(`${_.lowerCase(method)}Root`);
 
 return createCustomOperationId(method, route, moduleName);
-%>
+%>

package/templates/base/route-type.ejs

@@ -20,4 +20,4 @@ export namespace <%~ routeNamespace %> {
   export type RequestBody = <%~ (payload && payload.type) || 'never' %>;
   export type RequestHeaders = <%~ (headers && headers.type) || '{}' %>;
   export type ResponseBody = <%~ route.response.type %>;
-}
+}