@penkov/swagger-code-gen 1.3.3 → 1.4.0

package/README.md

@@ -10,12 +10,248 @@ npm install -D @penkov/swagger-code-gen
 Usage:
 ```shell
 generate-client --url <URI> output_filename.ts
+generate-client --url <URI> --includeTags tag1 tag2 -- output_filename.ts
 ```
 
 Cli parameters:
 * `--url <URI>` - the swagger url
+* `--includeTags <tags...>` - Space-separated list of tags of paths to be included. Path is included if it contains any of specified tag
+  Path is included if exclusion list is empty or path contains any of the tags from inclusion list.
+  If the tag is both in inclusion and exclusion lists, it gets excluded.
+* `--excludeTags <tags...>` - Space-separated list of tags of paths to be excluded. 
+  Path is excluded if exclusion list is non-empty and path contains any of the tags from exclusion list.
+  If the tag is both in inclusion and exclusion lists, it gets excluded.
 * `--referencedObjectsNullableByDefault` - then specified, the generated code will assume that
   any object's field, that references another object, can be null, unless it is explicitly specified to be not nullable
   (which is default in .net world: asp generates wrong spec)
 * `--enableScats` - generate additional wrappers in [scats](https://www.npmjs.com/package/scats) 
   style for all objects and create a service with methods for each endpoint.
+
+
+
+# Example of generated code:
+
+```shell
+generate-client --enableScats --url https://petstore3.swagger.io/api/v3/openapi.json petstore.ts
+```
+
+Will generate:
+```typescript
+// header skipped
+
+export interface Customer {
+  readonly id: number;
+  readonly username: string;
+  readonly address: ReadonlyArray<Address>;
+}
+
+
+export interface Address {
+  readonly street: string;
+  readonly city: string;
+  readonly state: string;
+  readonly zip: string;
+}
+
+
+export interface Category {
+  readonly id: number;
+  readonly name: string;
+}
+
+
+export interface User {
+  readonly id: number;
+  readonly username: string;
+  readonly firstName: string;
+  readonly lastName: string;
+  readonly email: string;
+  readonly password: string;
+  readonly phone: string;
+  readonly userStatus: number;
+}
+
+
+export interface Tag {
+  readonly id: number;
+  readonly name: string;
+}
+
+
+export interface Pet {
+  readonly id: number;
+  readonly name: string;
+  readonly category: Category;
+  readonly photoUrls: ReadonlyArray<string>;
+  readonly tags: ReadonlyArray<Tag>;
+  readonly status: string;
+}
+
+
+export interface ApiResponse {
+  readonly code: number;
+  readonly type: string;
+  readonly message: string;
+}
+
+
+
+/**
+ * PUT /pet
+ * @summary Update an existing pet
+ * @description Update an existing pet by Id
+ * @param {Pet} body Update an existent pet in the store
+ * @param {RequestOptions} requestOptions Additional request params
+ * @return {Pet} Successful operation
+ */
+export async function updatePet(
+        body: Pet,
+        requestOptions: RequestOptions = defaultRequestOptions()
+): Promise<Pet> {
+  let query = '';
+  const request = new Request(`${requestOptions.apiPrefix}/pet${query}`, {
+    method: 'put',
+    body: JSON.stringify(body),
+    headers: {
+      ...option(requestOptions.headers).getOrElseValue({}),
+    }
+  });
+  return requestImpl<Pet>(request, requestOptions);
+}
+
+
+// ...
+
+
+/**
+ * GET /pet/findByStatus
+ * @summary Finds Pets by status
+ * @description Multiple status values can be provided with comma separated strings
+ * @param {&#39;available&#39; | &#39;pending&#39; | &#39;sold&#39;} status Status values that need to be considered for filter
+ * @param {RequestOptions} requestOptions Additional request params
+ * @return {ReadonlyArray&lt;Pet&gt;} successful operation
+ */
+export async function findPetsByStatus(
+        status: 'available' | 'pending' | 'sold' = 'available',
+        requestOptions: RequestOptions = defaultRequestOptions()
+): Promise<ReadonlyArray<Pet>> {
+  let query = '';
+  const queryParams = [];
+  queryParams.push(`status=${status}`);
+  if (queryParams.length > 0) {
+    query = '?' + queryParams.join('&');
+  }
+  const request = new Request(`${requestOptions.apiPrefix}/pet/findByStatus${query}`, {
+    method: 'get',
+    body: undefined,
+    headers: {
+      ...option(requestOptions.headers).getOrElseValue({}),
+    }
+  });
+  const preProcessed = option(requestOptions.preProcessRequest).map(cb => cb(request)).getOrElseValue(request);
+  const resp = await fetch(preProcessed);
+  if (resp.ok) {
+    const postProcessed = option(requestOptions.postProcessResponse)
+            .map(cb => cb(preProcessed, resp))
+            .getOrElseValue(resp);
+    const json = option(resp.headers.get('content-length'))
+            .map(x => parseInt(x))
+            .getOrElseValue(0) > 0 ? await postProcessed.json() : null;
+    return json as ReadonlyArray<Pet>;
+  } else {
+    throw resp;
+  }
+}
+
+
+// ...
+
+
+
+// scats wrappers
+
+export class OrderDto {
+
+  constructor(
+          readonly id: number,
+          readonly petId: number,
+          readonly quantity: number,
+          readonly shipDate: string,
+          readonly status: string,
+          readonly complete: boolean,
+  ) {}
+
+
+  static fromJson(json: Order): OrderDto {
+    return new OrderDto(
+            json.id,
+            json.petId,
+            json.quantity,
+            json.shipDate,
+            json.status,
+            json.complete,
+    );
+  }
+
+  copy(fields: Partial<OrderDto>): OrderDto {
+    return new OrderDto(
+            option(fields.id).getOrElseValue(this.id),
+            option(fields.petId).getOrElseValue(this.petId),
+            option(fields.quantity).getOrElseValue(this.quantity),
+            option(fields.shipDate).getOrElseValue(this.shipDate),
+            option(fields.status).getOrElseValue(this.status),
+            option(fields.complete).getOrElseValue(this.complete),
+    );
+  }
+
+  get toJson(): Order {
+    return {
+      id: this.id,
+      petId: this.petId,
+      quantity: this.quantity,
+      shipDate: this.shipDate,
+      status: this.status,
+      complete: this.complete,
+    };
+  }
+}
+
+
+export class ApiClient {
+
+  constructor(private readonly requestOptions: RequestOptions = defaultRequestOptions()) {
+  }
+
+
+  async updatePet(
+          body: Pet,
+          requestOptions: RequestOptions = this.requestOptions
+  ): Promise<TryLike<PetDto>> {
+    return (await Try.promise(() =>
+            updatePet(
+                    body,
+                    requestOptions
+            )
+    ))
+            .map(res => PetDto.fromJson(res))
+            ;
+  }
+
+  async addPet(
+          body: Pet,
+          requestOptions: RequestOptions = this.requestOptions
+  ): Promise<TryLike<PetDto>> {
+    return (await Try.promise(() =>
+            addPet(
+                    body,
+                    requestOptions
+            )
+    ))
+            .map(res => PetDto.fromJson(res))
+            ;
+  }
+
+//...
+}
+
+```

package/dist/cli.mjs

@@ -1,13 +1,16 @@
 #!/usr/bin/env node
 import { main } from './index.js';
 import { Command } from "commander";
+import { HashSet } from "scats";
 const program = new Command();
 program
     .name('Swagger client code generator')
     .description('CLI to generate client based on swagger definitions')
     .version('1.0.0')
-    .option('--url <URI>', 'The url with swagger definitions')
+    .requiredOption('--url <URI>', 'The url with swagger definitions')
     .option('--referencedObjectsNullableByDefault', 'Assume that referenced objects can be null (say hello to .net assholes)', false)
+    .option('--includeTags <tags...>', 'Space-separated list of tags of paths to be included. Path is included if it contains any of specified tag')
+    .option('--excludeTags <tags...>', 'Space-separated list of tags of paths to be excluded. Path is excluded if it contains any of specified tag')
     .option('--enableScats', 'Generate scats', false)
     .argument('outputFile', 'File with generated code')
     .parse();
@@ -15,7 +18,11 @@ const url = program.opts().url;
 const referencedObjectsNullableByDefault = program.opts().referencedObjectsNullableByDefault;
 const enableScats = program.opts().enableScats;
 const outputFile = program.args[0];
+const includeTags = HashSet.from(program.opts().includeTags || []);
+const excludeTags = HashSet.from(program.opts().excludeTags || []);
 main(url, enableScats, outputFile, {
-    referencedObjectsNullableByDefault: referencedObjectsNullableByDefault
+    referencedObjectsNullableByDefault: referencedObjectsNullableByDefault,
+    includeTags: includeTags,
+    excludeTags: excludeTags
 }).then(() => {
 });

package/dist/components-parse.js

@@ -17,5 +17,9 @@ export function resolvePaths(json, schemasTypes, options) {
     return Collection.from(Object.keys(jsonSchemas)).flatMap(path => {
         const methods = jsonSchemas[path];
         return Collection.from(Object.keys(methods)).map(methodName => new Method(path, methodName, methods[methodName], schemasTypes, options));
+    }).filter(m => {
+        const included = options.includeTags.isEmpty || options.includeTags.intersect(m.tags).nonEmpty;
+        const excluded = options.excludeTags.nonEmpty && options.excludeTags.intersect(m.tags).nonEmpty;
+        return included && !excluded;
     });
 }

package/dist/method.js

@@ -1,13 +1,13 @@
-import { Collection, HashMap, identity, option } from 'scats';
+import { Collection, HashMap, HashSet, identity, option } from 'scats';
 import { Property } from './property.js';
 import { Parameter } from './parameter.js';
 import { SchemaFactory } from './schemas.js';
-const sortByIn = HashMap.of(['path', 0], ['query', 1], ['header', 2], ['body', 3]);
+const sortByIn = HashMap.of(['path', 0], ['query', 1], ['header', 2], ['cookie', 3], ['body', 4]);
 export class Method {
     constructor(path, method, def, schemasTypes, options) {
         this.path = path;
         this.method = method;
-        this.tags = option(def.tags).getOrElseValue([]);
+        this.tags = HashSet.from(option(def.tags).getOrElseValue([]));
         this.summary = def.summary;
         this.description = def.description;
         this.operationId = option(def.operationId);

package/dist/templates/index.ejs

@@ -11,9 +11,8 @@
  *********************************************************
  *********************************************************/
 import fetch, {Request, Response} from 'node-fetch';
-import {option, Option} from 'scats';
 <% if (scats) {%>
-import {Collection, Try, TryLike, none} from 'scats';
+import {option, Option, Collection, Try, TryLike, none} from 'scats';
 <% } %>
 
 export interface RequestOptions {
@@ -34,6 +33,26 @@ export const defaultReqOpts: RequestOptions = {
 
 const defaultRequestOptions = () => defaultReqOpts;
 
+
+async function requestImpl<T>(request: Request, requestOptions: RequestOptions): Promise<T> {
+    const preProcessed = requestOptions.preProcessRequest ? requestOptions.preProcessRequest(request) : request;
+    const resp = await fetch(preProcessed);
+    if (resp.ok) {
+        const postProcessed = requestOptions.postProcessResponse ? requestOptions.postProcessResponse(preProcessed, resp) : resp;
+        let json: any = null;
+        if (postProcessed.headers.has('content-length')) {
+            const ct = parseInt(postProcessed.headers.get('content-length'));
+            if (ct > 0) {
+                json = await postProcessed.json()
+            }
+        }
+        return json as T;
+    } else {
+        throw resp;
+    }
+
+}
+
 <% schemas.foreach(schema => { %>
 <%- include('schema.ejs', {schema: schema}); %>
 <% }); %>

package/dist/templates/method.ejs

@@ -62,7 +62,7 @@ export async function <%= method.endpointName %>(
         method: '<%= method.method %>',
         body: <%= method.body.map(() => 'JSON.stringify(body)').getOrElseValue('undefined') %>,
         headers: {
-            ...option(requestOptions.headers).getOrElseValue({}),
+            ...requestOptions.headers || {},
             <%_ if (method.parameters.filter(x => x.in === 'header').nonEmpty) { -%>
             <%_ method.parameters.filter(x => x.in === 'header').foreach(p => { -%>
             <%= p.name %>: <%= method.wrapParamsInObject ? 'params.' : '' %><%= p.uniqueName %>
@@ -70,17 +70,5 @@ export async function <%= method.endpointName %>(
             <%_ }  -%>
         }
     });
-    const preProcessed = option(requestOptions.preProcessRequest).map(cb => cb(request)).getOrElseValue(request);
-    const resp = await fetch(preProcessed);
-    if (resp.ok) {
-        const postProcessed = option(requestOptions.postProcessResponse)
-            .map(cb => cb(preProcessed, resp))
-            .getOrElseValue(resp);
-        const json = option(resp.headers.get('content-length'))
-            .map(x => parseInt(x))
-            .getOrElseValue(0) > 0 ? await postProcessed.json() : null;
-        return json as <%- method.response.responseType %>;
-    } else {
-        throw resp;
-    }
+    return requestImpl<<%- method.response.responseType %>>(request, requestOptions);
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@penkov/swagger-code-gen",
-  "version": "1.3.3",
+  "version": "1.4.0",
   "type": "module",
   "bin": {
     "generate-client": "./dist/cli.mjs"