chore(): Update oazapfts version to v4.3.3 (latest), enabling enum using a flag --useEnumType

.github/dependabot.yml

@@ -1,6 +1,14 @@
 version: 2
 updates:
- - package-ecosystem: "npm"
- directory: "/"
+ - package-ecosystem: npm
+ directory: /
+ open-pull-requests-limit: 999
+ rebase-strategy: disabled
  schedule:
- interval: "weekly"
+ interval: weekly
+ - package-ecosystem: github-actions
+ directory: /
+ open-pull-requests-limit: 999
+ rebase-strategy: disabled
+ schedule:
+ interval: weekly

.github/workflows/ci.yml

@@ -1,17 +1,17 @@
 name: CI
 on:
  push:
- branches: [master]
+ branches: [main]
  pull_request:
- branches: [master]
+ branches: [main]
 jobs:
  ci:
  runs-on: ubuntu-latest
  steps:
- - uses: actions/checkout@v2
- - uses: actions/setup-node@v2
+ - uses: actions/checkout@v3
+ - uses: actions/setup-node@v3
  with:
- node-version: 16.x
+ node-version: 18
  check-latest: true
  - run: npm ci
  - run: npm test

README.md

@@ -1,5 +1,7 @@
 # 🍻 oazapfts!
 
+[![CI](https://github.com/cellular/oazapfts/actions/workflows/ci.yml/badge.svg)](https://github.com/cellular/oazapfts/actions/workflows/ci.yml)
+
 Generate TypeScript clients to tap into OpenAPI servers.
 
 ## Features
@@ -26,22 +28,26 @@ oazapfts <spec> [filename]
 Options:
 --exclude, -e tag to exclude
 --include, -i tag to include
+--optimistic
+--useEnumType
 ```
 
 Where `<spec>` is the URL or local path of an OpenAPI or Swagger spec (in either json or yml) and `<filename>` is the location of the `.ts` file to be generated. If the filename is omitted, the code is written to stdout.
 
+Use the `useEnumType` option to generate typescript enums instead of union of values.
+
 ## Overriding the defaults
 
 The generated file exports a `defaults` constant that can be used to override the `basePath`, provide a custom `fetch` implementation or to send additional headers with each request:
 
 ```ts
-import * as api from "./api.ts";
-import nodeFetch from "node-fetch";
+import * as api from './api.ts';
+import nodeFetch from 'node-fetch';
 
-api.default.basePath = "https://example.com/api";
+api.default.basePath = 'https://example.com/api';
 
 api.defaults.headers = {
- access_token: "secret",
+ access_token: 'secret',
 };
 
 api.defaults.fetch = nodeFetch;
@@ -97,7 +103,7 @@ if (res.status === 404) {
 The above code can be simplified by using the `handle` helper:
 
 ```ts
-import { handle } from "oazapfts";
+import { handle } from 'oazapfts';
 
 await handle(api.getPetById(1), {
  200(pet) {
@@ -127,7 +133,7 @@ await handle(api.getPetById(1), {
 Instead of handling errors right in place we can also use the `ok` helper:
 
 ```ts
-import { ok } from "oazapfts";
+import { ok } from 'oazapfts';
 
 const pet = await ok(api.getPetById(1));
 ```
@@ -137,8 +143,8 @@ With this pattern `pet` will be typed as `Pet` and a `HttpError` will be thrown
 You can even turn your whole API into an optimistic one:
 
 ```ts
-import { optimistic } from "oazapfts";
-import * as rawApi from "./api.ts";
+import { optimistic } from 'oazapfts';
+import * as rawApi from './api.ts';
 
 const api = optimistic(rawApi);
 const pet = await api.getPetById(1);
@@ -150,7 +156,7 @@ Since version 3.1.0 you can also use the `--optimistic` flag on the command line
 
 ## About the name
 
-The name comes from a combination of syllables **oa** (OpenAPI) and **ts** (TypeScript) and is [pronounced 🗣](https://youtu.be/chvb-K95rBE) like the Bavarian _O'zapt'is!_ (it's tapped), the famous words that mark the beginning of the Oktoberfest.
+The name comes from a combination of syllables **oa** (OpenAPI) and **ts** (TypeScript) and is [pronounced 🗣](https://www.youtube.com/watch?v=chvb-K95rBE) like the Bavarian _O'zapt'is!_ (it's tapped), the famous words that mark the beginning of the Oktoberfest.
 
 # License
 

demo/allOf.json

@@ -0,0 +1,80 @@
+{
+ "openapi": "3.0.1",
+ "info": {
+ "title": "Swagger allOf example",
+ "version": "1.0.0"
+ },
+ "servers": [
+ {
+ "url": "https://testUrl.test"
+ }
+ ],
+ "paths": {
+ "/circle/{circle_id}": {
+ "get": {
+ "tags": ["circle"],
+ "summary": "Find circle by ID",
+ "description": "Returns a single circle",
+ "operationId": "getCircleById",
+ "parameters": [
+ {
+ "name": "circle_id",
+ "in": "path",
+ "description": "ID of circle to return",
+ "required": true,
+ "schema": {
+ "type": "integer"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "successful operation",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Circle"
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "components": {
+ "schemas": {
+ "Circle": {
+ "allOf": [
+ {
+ "$ref": "#/components/schemas/Shape"
+ },
+ {
+ "type": "object",
+ "properties": {
+ "radius": {
+ "type": "integer",
+ "format": "int32"
+ }
+ },
+ "additionalProperties": false
+ }
+ ],
+ "properties": {
+ "circumference": {
+ "type": "integer",
+ "format": "int32"
+ }
+ }
+ },
+ "Shape": {
+ "type": "object",
+ "properties": {
+ "numberOfCorners": {
+ "type": "integer"
+ }
+ }
+ }
+ }
+ }
+}