Allow top level enum types

.vscode/extensions.json

@@ -0,0 +1,9 @@
+{
+    // See https://go.microsoft.com/fwlink/?LinkId=827846 to learn about workspace recommendations.
+    // Extension identifier format: ${publisher}.${name}. Example: vscode.csharp
+
+    // List of extensions which should be recommended for users of this workspace.
+    "recommendations": ["streetsidesoftware.avro"],
+    // List of extensions recommended by VS Code that should not be recommended for users of this workspace.
+    "unwantedRecommendations": []
+}

package.json

@@ -1,6 +1,6 @@
 {
     "name": "avro-typescript",
-    "version": "1.0.0",
+    "version": "1.1.0",
     "description": "TypeScript code generator for Apache Avro types",
     "main": "./lib/index.js",
     "typings": "lib/index.d.ts",
@@ -11,6 +11,7 @@
         "test": "test"
     },
     "scripts": {
+        "test-update": "jest -u",
         "test": "jest",
         "build": "tsc"
     },

src/index.ts

@@ -3,25 +3,26 @@ export {
     Field,
     isArrayType,
     isEnumType,
+    isLogicalType,
     isMapType,
     isOptional,
     isRecordType,
     RecordType,
     Type,
-    isLogicalType,
 } from "./model";
 
 import {
     EnumType,
     Field,
     isArrayType,
     isEnumType,
+    isLogicalType,
     isMapType,
     isOptional,
     isRecordType,
     RecordType,
+    Schema,
     Type,
-    isLogicalType,
 } from "./model";
 
 /** Convert a primitive type from avro to TypeScript */
@@ -44,9 +45,11 @@ export function convertPrimitive(avroType: string): string {
 }
 
 /** Converts an Avro record type to a TypeScript file */
-export function avroToTypeScript(recordType: RecordType): string {
+export function avroToTypeScript(schema: Schema): string {
     const output: string[] = [];
-    convertRecord(recordType, output);
+    if (isEnumType(schema)) convertEnum(schema, output);
+    else if (isRecordType(schema)) convertRecord(schema, output);
+    else throw "Unknown top level type " + (schema as unknown)["type"];
     return output.join("\n");
 }
 

src/model.ts

@@ -1,6 +1,6 @@
 /**** Contains the Interfaces and Type Guards for Avro schema */
 
-export interface Schema {}
+export type Schema = RecordType | EnumType;
 
 export type Type = NameOrType | NameOrType[];
 export type NameOrType = TypeNames | RecordType | ArrayType | NamedType | LogicalType;

test/__snapshots__/avtsc.test.ts.snap

@@ -21,3 +21,8 @@ export interface ExampleType {
 }
 "
 `;
+
+exports[`enumToTypesScript it should generate an enum 1`] = `
+"export enum CompanySize { SMALL, MEDIUM, LARGE };
+"
+`;

test/avtsc.test.ts

@@ -1,5 +1,6 @@
 import * as fs from "fs";
 import { avroToTypeScript, RecordType } from "../src";
+import { Schema } from "../src/model";
 
 describe("avroToTypeScript", () => {
     test("it should generate an interface", () => {
@@ -9,7 +10,7 @@ describe("avroToTypeScript", () => {
     });
 
     test("it should correctly type strings with logicalType", () => {
-        const schema: RecordType = {
+        const schema: Schema = {
             type: "record",
             name: "datedRecord",
             fields: [
@@ -22,6 +23,23 @@ describe("avroToTypeScript", () => {
                 },
             ],
         };
+        expect(avroToTypeScript(schema)).not.toEqual(expect.stringContaining("UNKNOWN"));
+    });
+});
+
+describe("enumToTypesScript", () => {
+    test("it should generate an enum", () => {
+        const schemaText = fs.readFileSync(__dirname + "/just-enum.avsc", "utf-8");
+        const schema = JSON.parse(schemaText);
+        expect(avroToTypeScript(schema as RecordType)).toMatchSnapshot();
+    });
+
+    test("it should correctly type strings with logicalType", () => {
+        const schema: Schema = {
+            type: "enum",
+            name: "CompanySize",
+            symbols: ["SMALL", "MEDIUM", "LARGE"],
+        };
 
         expect(avroToTypeScript(schema)).not.toEqual(expect.stringContaining("UNKNOWN"));
     });

test/just-enum.avsc

@@ -0,0 +1,6 @@
+{
+    "type": "enum",
+    "name": "CompanySize",
+    "namespace": "com.example.avro",
+    "symbols": ["SMALL", "MEDIUM", "LARGE"]
+}