feat(models): union types for properties of enum like union strings and numbers

vmasek · vmasek · commit 0023555ed227 · 2020-01-12T16:53:35.000+01:00
example GitHub Blob `encoding: any` is now `'utf-8' | 'base64'`
and its TS quard is `['utf-8', 'base64'].includes(arg.encoding)` instead of "any" check
diff --git a/src/parser.ts b/src/parser.ts
@@ -326,16 +326,22 @@ function parseInterfaceProperties(
         typeof propSchema.additionalProperties !== 'boolean'
           ? propSchema.additionalProperties.$ref
           : propSchema.$ref;
-      const typescriptType = toTypescriptType(
-        isArray
-          ? determineArrayType(propSchema)
-          : ref
-          ? dereferenceType(ref)
-          : propSchema.additionalProperties &&
-            typeof propSchema.additionalProperties !== 'boolean'
-          ? propSchema.additionalProperties.type
-          : propSchema.type,
-      );
+      const typescriptType =
+        'enum' in propSchema
+          ? (propSchema.type === 'number'
+              ? propSchema.enum || []
+              : (propSchema.enum || []).map(str => `'${str}'`)
+            ).join(' | ')
+          : toTypescriptType(
+              isArray
+                ? determineArrayType(propSchema)
+                : ref
+                ? dereferenceType(ref)
+                : propSchema.additionalProperties &&
+                  typeof propSchema.additionalProperties !== 'boolean'
+                ? propSchema.additionalProperties.type
+                : propSchema.type,
+            );
       const isRef = !!parseReference(propSchema);
       const propertyAllOf =
         propSchema.allOf && propSchema.allOf.length
@@ -387,6 +393,11 @@ function parseInterfaceProperties(
                 guardFn(() => `is${prop.typescriptType}(arg.${name})`, prop),
               )
               .join(' && ')})`
+          : / \| /.test(typescriptType)
+          ? `[${(typescriptType || '').replace(
+              / \| /g,
+              ', ',
+            )}].includes(arg.${name})`
           : `is${typescriptType}(arg.${name})`,
       ).replace(/\s+/g, ' ')}) &&`;
 
@@ -579,9 +590,9 @@ function transformParameters(
     const isArray = /^array$/i.test(type);
     const typescriptType =
       'enum' in param
-        ? (param.type === 'string'
-            ? (param.enum || []).map(str => `'${str}'`)
-            : param.enum || []
+        ? (param.type === 'number'
+            ? param.enum || []
+            : (param.enum || []).map(str => `'${str}'`)
           ).join(' | ')
         : toTypescriptType(
             isArray
diff --git a/tests/custom/api/guards/dog.model.guard.ts b/tests/custom/api/guards/dog.model.guard.ts
@@ -12,8 +12,8 @@ export function isDog(arg: any): arg is Dog {
     typeof arg === 'object' &&
   // bark?: boolean
     ( typeof arg.bark === 'undefined' || typeof arg.bark === 'boolean' ) &&
-  // breed?: string
-    ( typeof arg.breed === 'undefined' || typeof arg.breed === 'string' ) &&
+  // breed?: 'Dingo' | 'Husky' | 'Retriever' | 'Shepherd'
+    ( typeof arg.breed === 'undefined' || ['Dingo', 'Husky', 'Retriever', 'Shepherd'].includes(arg.breed) ) &&
   // extends Pet
     isPet(arg) &&
 
diff --git a/tests/custom/api/models/dog.model.ts b/tests/custom/api/models/dog.model.ts
@@ -5,5 +5,5 @@ import {
 
 export interface Dog extends Pet {
   bark?: boolean;
-  breed?: string;
+  breed?: 'Dingo' | 'Husky' | 'Retriever' | 'Shepherd';
 }
diff --git a/tests/gcloud-firestore/api/guards/composite-filter.model.guard.ts b/tests/gcloud-firestore/api/guards/composite-filter.model.guard.ts
@@ -12,8 +12,8 @@ export function isCompositeFilter(arg: any): arg is CompositeFilter {
     typeof arg === 'object' &&
   // filters?: Filter[]
     ( typeof arg.filters === 'undefined' || (Array.isArray(arg.filters) && arg.filters.every(item => isFilter(item))) ) &&
-  // op?: string
-    ( typeof arg.op === 'undefined' || typeof arg.op === 'string' ) &&
+  // op?: 'OPERATOR_UNSPECIFIED' | 'AND'
+    ( typeof arg.op === 'undefined' || ['OPERATOR_UNSPECIFIED', 'AND'].includes(arg.op) ) &&
 
     true
   );
diff --git a/tests/gcloud-firestore/api/guards/field-filter.model.guard.ts b/tests/gcloud-firestore/api/guards/field-filter.model.guard.ts
@@ -13,8 +13,8 @@ export function isFieldFilter(arg: any): arg is FieldFilter {
     typeof arg === 'object' &&
   // field?: FieldReference
     ( typeof arg.field === 'undefined' || isFieldReference(arg.field) ) &&
-  // op?: string
-    ( typeof arg.op === 'undefined' || typeof arg.op === 'string' ) &&
+  // op?: 'OPERATOR_UNSPECIFIED' | 'LESS_THAN' | 'LESS_THAN_OR_EQUAL' | 'GREATER_THAN' | 'GREATER_THAN_OR_EQUAL' | 'EQUAL'
+    ( typeof arg.op === 'undefined' || ['OPERATOR_UNSPECIFIED', 'LESS_THAN', 'LESS_THAN_OR_EQUAL', 'GREATER_THAN', 'GREATER_THAN_OR_EQUAL', 'EQUAL'].includes(arg.op) ) &&
   // value?: Value
     ( typeof arg.value === 'undefined' || isValue(arg.value) ) &&
 
diff --git a/tests/gcloud-firestore/api/guards/field-transform.model.guard.ts b/tests/gcloud-firestore/api/guards/field-transform.model.guard.ts
@@ -9,8 +9,8 @@ export function isFieldTransform(arg: any): arg is FieldTransform {
     typeof arg === 'object' &&
   // fieldPath?: string
     ( typeof arg.fieldPath === 'undefined' || typeof arg.fieldPath === 'string' ) &&
-  // setToServerValue?: string
-    ( typeof arg.setToServerValue === 'undefined' || typeof arg.setToServerValue === 'string' ) &&
+  // setToServerValue?: 'SERVER_VALUE_UNSPECIFIED' | 'REQUEST_TIME'
+    ( typeof arg.setToServerValue === 'undefined' || ['SERVER_VALUE_UNSPECIFIED', 'REQUEST_TIME'].includes(arg.setToServerValue) ) &&
 
     true
   );
diff --git a/tests/gcloud-firestore/api/guards/index-field.model.guard.ts b/tests/gcloud-firestore/api/guards/index-field.model.guard.ts
@@ -9,8 +9,8 @@ export function isIndexField(arg: any): arg is IndexField {
     typeof arg === 'object' &&
   // fieldPath?: string
     ( typeof arg.fieldPath === 'undefined' || typeof arg.fieldPath === 'string' ) &&
-  // mode?: string
-    ( typeof arg.mode === 'undefined' || typeof arg.mode === 'string' ) &&
+  // mode?: 'MODE_UNSPECIFIED' | 'ASCENDING' | 'DESCENDING'
+    ( typeof arg.mode === 'undefined' || ['MODE_UNSPECIFIED', 'ASCENDING', 'DESCENDING'].includes(arg.mode) ) &&
 
     true
   );
diff --git a/tests/gcloud-firestore/api/guards/index.model.guard.ts b/tests/gcloud-firestore/api/guards/index.model.guard.ts
@@ -16,8 +16,8 @@ export function isIndex(arg: any): arg is Index {
     ( typeof arg.fields === 'undefined' || (Array.isArray(arg.fields) && arg.fields.every(item => isIndexField(item))) ) &&
   // name?: string
     ( typeof arg.name === 'undefined' || typeof arg.name === 'string' ) &&
-  // state?: string
-    ( typeof arg.state === 'undefined' || typeof arg.state === 'string' ) &&
+  // state?: 'STATE_UNSPECIFIED' | 'CREATING' | 'READY' | 'ERROR'
+    ( typeof arg.state === 'undefined' || ['STATE_UNSPECIFIED', 'CREATING', 'READY', 'ERROR'].includes(arg.state) ) &&
 
     true
   );
diff --git a/tests/gcloud-firestore/api/guards/order.model.guard.ts b/tests/gcloud-firestore/api/guards/order.model.guard.ts
@@ -10,8 +10,8 @@ export function isOrder(arg: any): arg is Order {
   return (
     arg != null &&
     typeof arg === 'object' &&
-  // direction?: string
-    ( typeof arg.direction === 'undefined' || typeof arg.direction === 'string' ) &&
+  // direction?: 'DIRECTION_UNSPECIFIED' | 'ASCENDING' | 'DESCENDING'
+    ( typeof arg.direction === 'undefined' || ['DIRECTION_UNSPECIFIED', 'ASCENDING', 'DESCENDING'].includes(arg.direction) ) &&
   // field?: FieldReference
     ( typeof arg.field === 'undefined' || isFieldReference(arg.field) ) &&
 
diff --git a/tests/gcloud-firestore/api/guards/target-change.model.guard.ts b/tests/gcloud-firestore/api/guards/target-change.model.guard.ts
@@ -16,8 +16,8 @@ export function isTargetChange(arg: any): arg is TargetChange {
     ( typeof arg.readTime === 'undefined' || typeof arg.readTime === 'string' ) &&
   // resumeToken?: string
     ( typeof arg.resumeToken === 'undefined' || typeof arg.resumeToken === 'string' ) &&
-  // targetChangeType?: string
-    ( typeof arg.targetChangeType === 'undefined' || typeof arg.targetChangeType === 'string' ) &&
+  // targetChangeType?: 'NO_CHANGE' | 'ADD' | 'REMOVE' | 'CURRENT' | 'RESET'
+    ( typeof arg.targetChangeType === 'undefined' || ['NO_CHANGE', 'ADD', 'REMOVE', 'CURRENT', 'RESET'].includes(arg.targetChangeType) ) &&
   // targetIds?: number[]
     ( typeof arg.targetIds === 'undefined' || (Array.isArray(arg.targetIds) && arg.targetIds.every(item => typeof item === 'number')) ) &&
 
diff --git a/tests/gcloud-firestore/api/guards/unary-filter.model.guard.ts b/tests/gcloud-firestore/api/guards/unary-filter.model.guard.ts
@@ -12,8 +12,8 @@ export function isUnaryFilter(arg: any): arg is UnaryFilter {
     typeof arg === 'object' &&
   // field?: FieldReference
     ( typeof arg.field === 'undefined' || isFieldReference(arg.field) ) &&
-  // op?: string
-    ( typeof arg.op === 'undefined' || typeof arg.op === 'string' ) &&
+  // op?: 'OPERATOR_UNSPECIFIED' | 'IS_NAN' | 'IS_NULL'
+    ( typeof arg.op === 'undefined' || ['OPERATOR_UNSPECIFIED', 'IS_NAN', 'IS_NULL'].includes(arg.op) ) &&
 
     true
   );
diff --git a/tests/gcloud-firestore/api/guards/value.model.guard.ts b/tests/gcloud-firestore/api/guards/value.model.guard.ts
@@ -26,8 +26,8 @@ export function isValue(arg: any): arg is Value {
     ( typeof arg.integerValue === 'undefined' || typeof arg.integerValue === 'string' ) &&
   // mapValue?: MapValue
     ( typeof arg.mapValue === 'undefined' || isMapValue(arg.mapValue) ) &&
-  // nullValue?: string
-    ( typeof arg.nullValue === 'undefined' || typeof arg.nullValue === 'string' ) &&
+  // nullValue?: 'NULL_VALUE'
+    ( typeof arg.nullValue === 'undefined' || is'NULL_VALUE'(arg.nullValue) ) &&
   // referenceValue?: string
     ( typeof arg.referenceValue === 'undefined' || typeof arg.referenceValue === 'string' ) &&
   // stringValue?: string
diff --git a/tests/gcloud-firestore/api/models/composite-filter.model.ts b/tests/gcloud-firestore/api/models/composite-filter.model.ts
@@ -8,5 +8,5 @@ import {
  */
 export interface CompositeFilter {
   filters?: Filter[];  // The list of filters to combine.Must contain at least one filter.
-  op?: string;  // The operator for combining multiple filters.
+  op?: 'OPERATOR_UNSPECIFIED' | 'AND';  // The operator for combining multiple filters.
 }
diff --git a/tests/gcloud-firestore/api/models/field-filter.model.ts b/tests/gcloud-firestore/api/models/field-filter.model.ts
@@ -9,6 +9,6 @@ import {
  */
 export interface FieldFilter {
   field?: FieldReference;  // The field to filter by.
-  op?: string;  // The operator to filter by.
+  op?: 'OPERATOR_UNSPECIFIED' | 'LESS_THAN' | 'LESS_THAN_OR_EQUAL' | 'GREATER_THAN' | 'GREATER_THAN_OR_EQUAL' | 'EQUAL';  // The operator to filter by.
   value?: Value;  // The value to compare to.
 }
diff --git a/tests/gcloud-firestore/api/models/field-transform.model.ts b/tests/gcloud-firestore/api/models/field-transform.model.ts
@@ -5,5 +5,5 @@
  */
 export interface FieldTransform {
   fieldPath?: string;  // The path of the field. See Document.fields for the field path syntaxreference.
-  setToServerValue?: string;  // Sets the field to the given server value.
+  setToServerValue?: 'SERVER_VALUE_UNSPECIFIED' | 'REQUEST_TIME';  // Sets the field to the given server value.
 }
diff --git a/tests/gcloud-firestore/api/models/index-field.model.ts b/tests/gcloud-firestore/api/models/index-field.model.ts
@@ -5,5 +5,5 @@
  */
 export interface IndexField {
   fieldPath?: string;  // The path of the field. Must match the field path specification describedby google.firestore.v1beta1.Document.fields.Special field path `__name__` may be used by itself or at the end of apath. `__type__` may be used only at the end of path.
-  mode?: string;  // The field's mode.
+  mode?: 'MODE_UNSPECIFIED' | 'ASCENDING' | 'DESCENDING';  // The field's mode.
 }
diff --git a/tests/gcloud-firestore/api/models/index.model.ts b/tests/gcloud-firestore/api/models/index.model.ts
@@ -10,5 +10,5 @@ export interface Index {
   collectionId?: string;  // The collection ID to which this index applies. Required.
   fields?: IndexField[];  // The fields to index.
   name?: string;  // The resource name of the index.Output only.
-  state?: string;  // The state of the index.Output only.
+  state?: 'STATE_UNSPECIFIED' | 'CREATING' | 'READY' | 'ERROR';  // The state of the index.Output only.
 }
diff --git a/tests/gcloud-firestore/api/models/order.model.ts b/tests/gcloud-firestore/api/models/order.model.ts
@@ -7,6 +7,6 @@ import {
  * An order on a field.
  */
 export interface Order {
-  direction?: string;  // The direction to order by. Defaults to `ASCENDING`.
+  direction?: 'DIRECTION_UNSPECIFIED' | 'ASCENDING' | 'DESCENDING';  // The direction to order by. Defaults to `ASCENDING`.
   field?: FieldReference;  // The field to order by.
 }
diff --git a/tests/gcloud-firestore/api/models/target-change.model.ts b/tests/gcloud-firestore/api/models/target-change.model.ts
@@ -10,6 +10,6 @@ export interface TargetChange {
   cause?: Status;  // The error that resulted in this change, if applicable.
   readTime?: string;  // The consistent `read_time` for the given `target_ids` (omitted when thetarget_ids are not at a consistent snapshot).The stream is guaranteed to send a `read_time` with `target_ids` emptywhenever the entire stream reaches a new consistent snapshot. ADD,CURRENT, and RESET messages are guaranteed to (eventually) result in anew consistent snapshot (while NO_CHANGE and REMOVE messages are not).For a given stream, `read_time` is guaranteed to be monotonicallyincreasing.
   resumeToken?: string;  // A token that can be used to resume the stream for the given `target_ids`,or all targets if `target_ids` is empty.Not set on every target change.
-  targetChangeType?: string;  // The type of change that occurred.
+  targetChangeType?: 'NO_CHANGE' | 'ADD' | 'REMOVE' | 'CURRENT' | 'RESET';  // The type of change that occurred.
   targetIds?: number[];  // The target IDs of targets that have changed.If empty, the change applies to all targets.For `target_change_type=ADD`, the order of the target IDs matches the orderof the requests to add the targets. This allows clients to unambiguouslyassociate server-assigned target IDs with added targets.For other states, the order of the target IDs is not defined.
 }
diff --git a/tests/gcloud-firestore/api/models/unary-filter.model.ts b/tests/gcloud-firestore/api/models/unary-filter.model.ts
@@ -8,5 +8,5 @@ import {
  */
 export interface UnaryFilter {
   field?: FieldReference;  // The field to which to apply the operator.
-  op?: string;  // The unary operator to apply.
+  op?: 'OPERATOR_UNSPECIFIED' | 'IS_NAN' | 'IS_NULL';  // The unary operator to apply.
 }
diff --git a/tests/gcloud-firestore/api/models/value.model.ts b/tests/gcloud-firestore/api/models/value.model.ts
@@ -16,7 +16,7 @@ export interface Value {
   geoPointValue?: LatLng;  // A geo point value representing a point on the surface of Earth.
   integerValue?: string;  // An integer value.
   mapValue?: MapValue;  // A map value.
-  nullValue?: string;  // A null value.
+  nullValue?: 'NULL_VALUE';  // A null value.
   referenceValue?: string;  // A reference to a document. For example:`projects/{project_id}/databases/{database_id}/documents/{document_path}`.
   stringValue?: string;  // A string value.The string, represented as UTF-8, must not exceed 1 MiB - 89 bytes.Only the first 1,500 bytes of the UTF-8 representation are considered byqueries.
   timestampValue?: string;  // A timestamp value.Precise only to microseconds. When stored, any additional precision isrounded down.
diff --git a/tests/github/api/guards/blob.model.guard.ts b/tests/github/api/guards/blob.model.guard.ts
@@ -9,8 +9,8 @@ export function isBlob(arg: any): arg is Blob {
     typeof arg === 'object' &&
   // content?: string
     ( typeof arg.content === 'undefined' || typeof arg.content === 'string' ) &&
-  // encoding?: any
-    ( typeof arg.encoding === 'undefined' || isany(arg.encoding) ) &&
+  // encoding?: 'utf-8' | 'base64'
+    ( typeof arg.encoding === 'undefined' || ['utf-8', 'base64'].includes(arg.encoding) ) &&
   // sha?: string
     ( typeof arg.sha === 'undefined' || typeof arg.sha === 'string' ) &&
   // size?: number
diff --git a/tests/github/api/guards/edit-team.model.guard.ts b/tests/github/api/guards/edit-team.model.guard.ts
@@ -9,8 +9,8 @@ export function isEditTeam(arg: any): arg is EditTeam {
     typeof arg === 'object' &&
   // name: string
     ( typeof arg.name === 'string' ) &&
-  // permission?: any
-    ( typeof arg.permission === 'undefined' || isany(arg.permission) ) &&
+  // permission?: 'pull' | 'push' | 'admin'
+    ( typeof arg.permission === 'undefined' || ['pull', 'push', 'admin'].includes(arg.permission) ) &&
 
     true
   );
diff --git a/tests/github/api/guards/milestone.model.guard.ts b/tests/github/api/guards/milestone.model.guard.ts
@@ -21,8 +21,8 @@ export function isMilestone(arg: any): arg is Milestone {
     ( typeof arg.number === 'undefined' || typeof arg.number === 'number' ) &&
   // open_issues?: number
     ( typeof arg.open_issues === 'undefined' || typeof arg.open_issues === 'number' ) &&
-  // state?: any
-    ( typeof arg.state === 'undefined' || isany(arg.state) ) &&
+  // state?: 'open' | 'closed'
+    ( typeof arg.state === 'undefined' || ['open', 'closed'].includes(arg.state) ) &&
   // title?: string
     ( typeof arg.title === 'undefined' || typeof arg.title === 'string' ) &&
   // url?: string
diff --git a/tests/github/api/guards/org-teams-post.model.guard.ts b/tests/github/api/guards/org-teams-post.model.guard.ts
@@ -9,8 +9,8 @@ export function isOrgTeamsPost(arg: any): arg is OrgTeamsPost {
     typeof arg === 'object' &&
   // name: string
     ( typeof arg.name === 'string' ) &&
-  // permission?: any
-    ( typeof arg.permission === 'undefined' || isany(arg.permission) ) &&
+  // permission?: 'pull' | 'push' | 'admin'
+    ( typeof arg.permission === 'undefined' || ['pull', 'push', 'admin'].includes(arg.permission) ) &&
   // repo_names?: string[]
     ( typeof arg.repo_names === 'undefined' || (Array.isArray(arg.repo_names) && arg.repo_names.every(item => typeof item === 'string')) ) &&
 
diff --git a/tests/github/api/models/blob.model.ts b/tests/github/api/models/blob.model.ts
@@ -2,7 +2,7 @@
 
 export interface Blob {
   content?: string;
-  encoding?: any;
+  encoding?: 'utf-8' | 'base64';
   sha?: string;
   size?: number;
 }
diff --git a/tests/github/api/models/edit-team.model.ts b/tests/github/api/models/edit-team.model.ts
@@ -2,5 +2,5 @@
 
 export interface EditTeam {
   name: string;
-  permission?: any;
+  permission?: 'pull' | 'push' | 'admin';
 }
diff --git a/tests/github/api/models/milestone.model.ts b/tests/github/api/models/milestone.model.ts
@@ -8,7 +8,7 @@ export interface Milestone {
   due_on?: string;  // ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ
   number?: number;
   open_issues?: number;
-  state?: any;
+  state?: 'open' | 'closed';
   title?: string;
   url?: string;
 }
diff --git a/tests/github/api/models/org-teams-post.model.ts b/tests/github/api/models/org-teams-post.model.ts
@@ -2,6 +2,6 @@
 
 export interface OrgTeamsPost {
   name: string;
-  permission?: any;
+  permission?: 'pull' | 'push' | 'admin';
   repo_names?: string[];
 }

Original file line number	Diff line number	Diff line change
`@@ -5,5 +5,5 @@ import {`
`5`	`5`
`6`	`6`	`export interface Dog extends Pet {`
`7`	`7`	`bark?: boolean;`
`8`		`- breed?: string;`
	`8`	`+ breed?: 'Dingo' \| 'Husky' \| 'Retriever' \| 'Shepherd';`
`9`	`9`	`}`