Add Binary data type (#703)

Author: delvedor

compiler/model/utils.ts

@@ -216,6 +216,17 @@ export function modelType (node: Node): model.ValueOf {
           return type
         }
 
+        case 'ArrayBuffer': {
+          const type: model.InstanceOf = {
+            kind: 'instance_of',
+            type: {
+              name: 'binary',
+              namespace: 'internal'
+            }
+          }
+          return type
+        }
+
         case 'Dictionary':
         case 'AdditionalProperties': {
           assert(node, node.getTypeArguments().length === 2, 'A Dictionary must have two arguments')

docs/modeling-guide.md

@@ -139,6 +139,38 @@ type TimeSpan = string
 type DateString = string
 ```
 
+### Binary
+
+Some APIs return a Binary stream of data instead of JSON.
+Create an alias of the `ArrayBuffer` type for the appropriate name.
+
+```ts
+export type MapboxVectorTiles = ArrayBuffer
+
+export class Response {
+  body: MapboxVectorTiles
+}
+```
+
+In the output schema.json `MapboxVectorTiles` will be defined as:
+
+```json
+{
+  "kind": "type_alias",
+  "name": {
+    "name": "MapboxVectorTiles",
+    "namespace": "_types"
+  },
+  "type": {
+    "kind": "instance_of",
+    "type": {
+      "name": "binary",
+      "namespace": "internal"
+    }
+  }
+}
+```
+
 ### Literal values
 
 The compiler supports literal values as well. This can be useful if a

output/schema/schema.json

@@ -17,8 +17,8 @@
  * under the License.
  */
 
-import { UserDefinedValue } from '@spec_utils/UserDefinedValue'
+import { MapboxVectorTiles } from '@_types/Binary'
 
 export class Response {
-  body: UserDefinedValue
+  body: MapboxVectorTiles
 }

output/schema/validation-errors.json

@@ -0,0 +1,21 @@
+/*
+ * Licensed to Elasticsearch B.V. under one or more contributor
+ * license agreements. See the NOTICE file distributed with
+ * this work for additional information regarding copyright
+ * ownership. Elasticsearch B.V. licenses this file to you under
+ * the Apache License, Version 2.0 (the "License"); you may
+ * not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *    http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing,
+ * software distributed under the License is distributed on an
+ * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ * KIND, either express or implied.  See the License for the
+ * specific language governing permissions and limitations
+ * under the License.
+ */
+
+// Vector tile response
+export type MapboxVectorTiles = ArrayBuffer

output/typescript/types.ts

@@ -115,6 +115,10 @@ function buildValue (type: M.ValueOf, openGenerics?: string[], origin?: M.TypeNa
         }
       }
 
+      if (type.type.name === 'binary' && type.type.namespace === 'internal') {
+        return 'ArrayBuffer'
+      }
+
       return `${createName(type.type)}${buildGenerics(type.generics, openGenerics)}`
     case 'array_of':
       return type.value.kind === 'union_of' || getShortcutType(type.value) != null