304 Support readOnly properties (#365)

Author: kmoskwiak

index.js

@@ -37,6 +37,7 @@ program
     false,
   )
   .option("--union-enums", 'generate all "enum" types as union types (T1 | T2 | TN)', false)
+  .option("--add-readonly", "generate readonly properties", false)
   .option("--route-types", "generate type definitions for API routes", false)
   .option("--no-client", "do not generate an API class", false)
   .option("--enum-names-as-values", "use values in 'x-enumNames' as enum values (not only as keys)", false)
@@ -75,6 +76,7 @@ const {
   name,
   templates,
   unionEnums,
+  addReadonly,
   routeTypes,
   client,
   defaultAsSuccess,
@@ -113,6 +115,7 @@ generateApi({
   disableThrowOnError: disableThrowOnError,
   sortTypes: sortTypes,
   generateUnionEnums: unionEnums,
+  addReadonly,
   generateResponses: responses,
   extractRequestParams: !!extractRequestParams,
   extractRequestBody: !!extractRequestBody,

package.json

@@ -23,6 +23,7 @@
     "test:--default-as-success": "node tests/spec/defaultAsSuccess/test.js",
     "test:--templates": "node tests/spec/templates/test.js",
     "test:--union-enums": "node tests/spec/unionEnums/test.js",
+    "test:--add-readonly": "node tests/spec/readonly/test.js",
     "test:--responses": "node tests/spec/responses/test.js",
     "test:specProperty": "node tests/spec/specProperty/test.js",
     "test:--module-name-index": "node tests/spec/moduleNameIndex/test.js",

src/config.js

@@ -14,6 +14,8 @@ const config = {
   generateClient: true,
   /** CLI flag */
   generateUnionEnums: false,
+  /** CLI flag */
+  addReadonly: false,
   enumNamesAsValues: false,
   /** parsed swagger schema from getSwaggerObject() */
 

src/index.js

@@ -40,6 +40,7 @@ module.exports = {
     generateClient = config.generateClient,
     httpClientType = config.httpClientType,
     generateUnionEnums = config.generateUnionEnums,
+    addReadonly = config.addReadonly,
     moduleNameIndex = config.moduleNameIndex,
     moduleNameFirstTag = config.moduleNameFirstTag,
     extractRequestParams = config.extractRequestParams,
@@ -70,6 +71,7 @@ module.exports = {
         generateResponses,
         templates,
         generateUnionEnums,
+        addReadonly,
         moduleNameIndex,
         moduleNameFirstTag,
         prettierOptions,

src/schema.js

@@ -137,6 +137,7 @@ const getObjectTypeContent = (schema) => {
     const nullable = !!(rawTypeData.nullable || property.nullable);
     const fieldName = isValidName(name) ? name : `"${name}"`;
     const fieldValue = getInlineParseContent(property);
+    const readOnly = property.readOnly;
 
     return {
       $$raw: property,
@@ -160,7 +161,13 @@ const getObjectTypeContent = (schema) => {
       isNullable: nullable,
       name: fieldName,
       value: fieldValue,
-      field: _.compact([fieldName, !required && "?", ": ", fieldValue]).join(""),
+      field: _.compact([
+        readOnly && config.addReadonly && "readonly ",
+        fieldName,
+        !required && "?",
+        ": ",
+        fieldValue,
+      ]).join(""),
     };
   });
 

tests/spec/readonly/schema.json

@@ -0,0 +1,61 @@
+{
+  "swagger": "2.0",
+  "info": {
+    "version": "1.0.0",
+    "title": "Swagger Petstore",
+    "description": "A sample API that uses a petstore as an example to demonstrate features in the swagger-2.0 specification",
+    "termsOfService": "http://swagger.io/terms/",
+    "contact": {
+      "name": "Swagger API Team"
+    },
+    "license": {
+      "name": "MIT"
+    }
+  },
+  "host": "petstore.swagger.io",
+  "basePath": "/api",
+  "schemes": ["http"],
+  "consumes": ["application/json"],
+  "produces": ["application/json"],
+  "paths": {
+    "/pets": {
+      "get": {
+        "description": "Returns all pets from the system that the user has access to",
+        "produces": ["application/json"],
+        "responses": {
+          "200": {
+            "description": "A list of pets.",
+            "schema": {
+              "type": "array",
+              "items": {
+                "$ref": "#/definitions/Pet"
+              }
+            }
+          }
+        }
+      }
+    }
+  },
+  "definitions": {
+    "Pet": {
+      "type": "object",
+      "required": ["id", "name"],
+      "properties": {
+        "id": {
+          "type": "integer",
+          "readOnly": true,
+          "format": "int64"
+        },
+        "name": {
+          "type": "string"
+        },
+        "tag": {
+          "type": "string"
+        },
+        "multiple": {
+          "type": ["string", "number"]
+        }
+      }
+    }
+  }
+}

tests/spec/readonly/schema.ts

@@ -0,0 +1,18 @@
+/* eslint-disable */
+/* tslint:disable */
+/*
+ * ---------------------------------------------------------------
+ * ## THIS FILE WAS GENERATED VIA SWAGGER-TYPESCRIPT-API        ##
+ * ##                                                           ##
+ * ## AUTHOR: acacode                                           ##
+ * ## SOURCE: https://github.com/acacode/swagger-typescript-api ##
+ * ---------------------------------------------------------------
+ */
+
+export interface Pet {
+  /** @format int64 */
+  readonly id: number;
+  name: string;
+  tag?: string;
+  multiple?: string | number;
+}

tests/spec/readonly/test.js

@@ -0,0 +1,20 @@
+const { generateApiForTest } = require("../../helpers/generateApiForTest");
+const { resolve } = require("path");
+const validateGeneratedModule = require("../../helpers/validateGeneratedModule");
+const createSchemaInfos = require("../../helpers/createSchemaInfos");
+
+const schemas = createSchemaInfos({ absolutePathToSchemas: resolve(__dirname, "./") });
+
+schemas.forEach(({ absolutePath, apiFileName }) => {
+  generateApiForTest({
+    testName: "--route-types option test",
+    silent: true,
+    name: apiFileName,
+    input: absolutePath,
+    output: resolve(__dirname, "./"),
+    addReadonly: true,
+    generateClient: false,
+  }).then(() => {
+    validateGeneratedModule(resolve(__dirname, `./${apiFileName}`));
+  });
+});