feat(models): properties are optional as default, required stated explicitly

Signed-off-by: Vojtech Mašek <[email protected]>

Author: vmasek

src/parser.ts

@@ -222,7 +222,10 @@ function defineEnum(
   };
 }
 
-function parseInterfaceProperties(properties: { [propertyName: string]: Schema } = {}): Property[] {
+function parseInterfaceProperties(
+  properties: { [propertyName: string]: Schema } = {},
+  requiredProps: string[] = [],
+): Property[] {
   return Object.entries<Schema>(properties).map(
     ([propName, propSchema]: [string, Schema]) => {
       const isArray = /^array$/i.test(propSchema.type || '');
@@ -240,6 +243,7 @@ function parseInterfaceProperties(properties: { [propertyName: string]: Schema }
         isArray,
         isDictionary: propSchema.additionalProperties,
         isRef: !!parseReference(propSchema),
+        isRequired: requiredProps.includes(propName),
         name: /^[A-Za-z_$][\w$]*$/.test(propName) ? propName : `'${propName}'`,
         description: replaceNewLines(propSchema.description),
         type: typescriptType.replace('[]', ''),
@@ -290,10 +294,13 @@ function defineInterface(schema: Schema, definitionKey: string): Definition {
     ? toCamelCase(dereferenceType((schema.allOf.find(allOfSchema => !!allOfSchema.$ref) || {}).$ref), false)
     : undefined;
   const allOfProps: Schema = schema.allOf ? schema.allOf.reduce((props, allOfSchema) => ({...props, ...allOfSchema.properties}), {}) : {};
-  const properties: Property[] = parseInterfaceProperties({
-    ...schema.properties,
-    ...allOfProps,
-  } as { [propertyName: string]: Schema });
+  const properties: Property[] = parseInterfaceProperties(
+    {
+      ...schema.properties,
+      ...allOfProps,
+    } as { [propertyName: string]: Schema },
+    schema.required,
+  );
 
   return {
     name: name,

templates/ngx-model.mustache

@@ -14,7 +14,7 @@ import {
  */
 {{/description}}export interface {{&name}} {{#extend}}extends {{.}} {{/extend}}{
 {{#properties}}
-  {{&name}}: {{#isDictionary}}{ [key: string]: {{typescriptType}} }{{/isDictionary}}{{^isDictionary}}{{typescriptType}}{{/isDictionary}}{{#isArray}}[]{{/isArray}};{{#description}}  // {{&.}}{{/description}}
+  {{&name}}{{^isRequired}}?{{/isRequired}}: {{#isDictionary}}{ [key: string]: {{typescriptType}} }{{/isDictionary}}{{^isDictionary}}{{typescriptType}}{{/isDictionary}}{{#isArray}}[]{{/isArray}};{{#description}}  // {{&.}}{{/description}}
 {{/properties}}
 }
 {{/isEnum}}
@@ -29,4 +29,4 @@ import {
   {{name}} = {{#isNumeric}}{{value}}{{/isNumeric}}{{^isNumeric}}"{{value}}"{{/isNumeric}},
     {{/properties}}
 }
-{{/isEnum}}
+{{/isEnum}}

tests/custom/api/models/cat.model.ts

@@ -5,7 +5,7 @@ import {
 } from '.';
 
 export interface Cat extends Pet {
-  age: number;
-  eaten: Mouse[];
-  hunts: boolean;
+  age?: number;
+  eaten?: Mouse[];
+  hunts?: boolean;
 }

tests/custom/api/models/customer.model.ts

@@ -5,7 +5,7 @@ import {
 } from '.';
 
 export interface Customer extends Model {
-  address: string;
-  name: string;
-  right: Right;
+  address?: string;
+  name?: string;
+  right?: Right;
 }

tests/custom/api/models/data-model.model.ts

@@ -1,9 +1,9 @@
 /* tslint:disable */
 
 export interface DataModel {
-  entities: number[];
-  id: number;
-  imageData: string;  // base64 user uploaded image string
-  imageUrl: string;  // url to user avatar image
-  roleId: number;
+  entities?: number[];
+  id?: number;
+  imageData?: string;  // base64 user uploaded image string
+  imageUrl?: string;  // url to user avatar image
+  roleId?: number;
 }

tests/custom/api/models/data.model.ts

@@ -1,10 +1,10 @@
 /* tslint:disable */
 
 export interface Data {
-  email: string;
-  firstName: string;
-  id: number;
-  lastName: string;
-  phone: string;
-  title: string;
+  email?: string;
+  firstName?: string;
+  id?: number;
+  lastName?: string;
+  phone?: string;
+  title?: string;
 }

tests/custom/api/models/dog.model.ts

@@ -4,6 +4,6 @@ import {
 } from '.';
 
 export interface Dog extends Pet {
-  bark: boolean;
-  breed: string;
+  bark?: boolean;
+  breed?: string;
 }

tests/custom/api/models/model.model.ts

@@ -1,9 +1,9 @@
 /* tslint:disable */
 
 export interface Model {
-  created: number;
-  deleted: number;
-  id: string;
-  recursivePointer: Model;
-  updated: number;
+  created?: number;
+  deleted?: number;
+  id?: string;
+  recursivePointer?: Model;
+  updated?: number;
 }

tests/custom/api/models/mouse.model.ts

@@ -4,5 +4,5 @@ import {
 } from '.';
 
 export interface Mouse extends Pet {
-  color: string;
+  color?: string;
 }

tests/custom/api/models/my-interface.model.ts

@@ -4,7 +4,7 @@ import {
 } from '.';
 
 export interface MyInterface {
-  myId: string;
-  myMap: { [key: string]: Data };
-  myName: string;
+  myId?: string;
+  myMap?: { [key: string]: Data };
+  myName?: string;
 }