feat: add Avro Schema input processor (#1753)

Co-authored-by: asyncapi-bot <bot+chan@asyncapi.io>%0ACo-authored-by: Jonas Lagoni <jonas-lt@live.dk>

README.md

@@ -193,6 +193,10 @@ The following table provides a short summary of available features for supported
     <td><a href="./docs/usage.md#generate-models-from-asyncapi-documents">AsyncAPI</a></td>
     <td>We support the following AsyncAPI versions: <em>2.0.0 -> 2.6.0</em>, which generates models for all the defined message payloads. It supports the following schemaFormats AsyncAPI Schema object, JSON Schema draft 7, <a href="./examples/asyncapi-avro-schema">AVRO 1.9</a>, <a href="./examples/asyncapi-raml-schema">RAML 1.0 data type</a>, and <a href="./examples/asyncapi-openapi-schema">OpenAPI 3.0 Schema</a>.</td>
   </tr>
+  <tr>
+    <td><a href="./docs/usage.md#generate-models-from-avro-schema-documents">Avro Schema<a></td>
+    <td>We support the following Avro versions: <a href="./examples/avro-schema-from-object">v1.x</a></td>
+  </tr>
   <tr>
     <td><a href="./docs/usage.md#generate-models-from-json-schema-documents">JSON Schema</a></td>
     <td>We support the following JSON Schema versions: <em>Draft-4, Draft-6 and Draft-7</em></td>

docs/usage.md

@@ -15,6 +15,7 @@ For more specific integration options, please check out the [integration documen
 - [Generate models from AsyncAPI documents](#generate-models-from-asyncapi-documents)
   * [Limitations and Compatibility](#limitations-and-compatibility)
     + [Polymorphism](#polymorphism)
+- [Generate models from Avro Schema documents](#generate-models-from-avro-schema-documents)
 - [Generate models from JSON Schema documents](#generate-models-from-json-schema-documents)
 - [Generate models from Swagger 2.0 documents](#generate-models-from-swagger-20-documents)
   * [Limitations and Compatibility](#limitations-and-compatibility-1)
@@ -107,6 +108,16 @@ There are three ways to generate models for a JSON Schema document.
 
 The library expects the `$schema` property for the document to be set in order to understand the input format. By default, if no other inputs are detected, it defaults to `JSON Schema draft 7`. The process of interpreting a JSON Schema to a model can be read [here](./inputs/JSON_Schema.md).
 
+## Generate models from Avro Schema documents
+
+See the below example to get started with Avro Schema for generating models.
+
+- [Generate from an Avro Schema JS Object](../examples/avro-schema-from-object)
+
+The Avro input processor expects the `name` and `type` property, as per [Avro Schema specs](https://avro.apache.org/docs/1.11.1/specification/#schema-declaration), in the input object in order to proceed successfully.
+
+> Note: Currently, we do not have a support for `map`, `fixed` and `byte` data type. It would be introduced soon.
+
 ## Generate models from Swagger 2.0 documents
 
 There are one way to generate models from a Swagger 2.0 document.

examples/README.md

@@ -43,6 +43,7 @@ These examples show a specific input and how they can be used:
 - [asyncapi-raml-schema](./asyncapi-raml-schema) - A basic example of how to use Modelina with an AsyncAPI document using RAML 1.0 data types as payload format.
 - [asyncapi-from-parser](./asyncapi-from-parser) - A basic example where an AsyncAPI JS object from the [parser-js](https://github.com/asyncapi/parser-js) is used to generate models.
 - [asyncapi-from-v1-parser](./asyncapi-from-v1-parser) - A basic example where an AsyncAPI JS object from the old v1 [parser-js](https://github.com/asyncapi/parser-js) is used to generate models.
+- [avro-schema-from-object](./avro-schema-from-object) - A basic example where an Avro Schema JS Object is used to generate models.
 - [json-schema-draft7-from-object](./json-schema-draft7-from-object) - A basic example where a JSON Schema draft 7 JS object is used to generate models.
 - [json-schema-draft6-from-object](./json-schema-draft6-from-object) - A basic example where a JSON Schema draft 6 JS object is used to generate models.
 - [json-schema-draft4-from-object](./json-schema-draft4-from-object) - A basic example where a JSON Schema draft 4 JS object is used to generate models.

examples/avro-schema-from-object/README.md

@@ -0,0 +1,17 @@
+# Avro Schema Input
+
+A basic example of how to use Modelina with an Avro Schema JS object to generate models.
+
+## How to run this example
+
+Run this example using:
+
+```sh
+npm i && npm run start
+```
+
+If you are on Windows, use the `start:windows` script instead:
+
+```sh
+npm i && npm run start:windows
+```

examples/avro-schema-from-object/__snapshots__/index.spec.ts.snap

@@ -0,0 +1,18 @@
+// Jest Snapshot v1, https://goo.gl/fbAQLP
+
+exports[`Should be able to render model using Avro Schema and should log expected output to console 1`] = `
+Array [
+  "class Person {
+  private _reservedName: string;
+
+  constructor(input: {
+    reservedName: string,
+  }) {
+    this._reservedName = input.reservedName;
+  }
+
+  get reservedName(): string { return this._reservedName; }
+  set reservedName(reservedName: string) { this._reservedName = reservedName; }
+}",
+]
+`;

examples/avro-schema-from-object/index.spec.ts

@@ -0,0 +1,15 @@
+const spy = jest.spyOn(global.console, 'log').mockImplementation(() => {
+  return;
+});
+import { generate } from './index';
+
+describe('Should be able to render model using Avro Schema', () => {
+  afterAll(() => {
+    jest.restoreAllMocks();
+  });
+  test('and should log expected output to console', async () => {
+    await generate();
+    expect(spy.mock.calls.length).toEqual(1);
+    expect(spy.mock.calls[0]).toMatchSnapshot();
+  });
+});

examples/avro-schema-from-object/index.ts

@@ -0,0 +1,27 @@
+import { TypeScriptGenerator } from '../../src';
+
+const generator = new TypeScriptGenerator();
+const AvroSchemaDoc = {
+  name: 'Person',
+  namespace: 'com.company',
+  type: 'record',
+  fields: [
+    {
+      name: 'name',
+      type: 'string',
+      example: 'Donkey',
+      minLength: 0,
+      maxLenght: 20
+    }
+  ]
+};
+
+export async function generate(): Promise<void> {
+  const models = await generator.generate(AvroSchemaDoc);
+  for (const model of models) {
+    console.log(model.result);
+  }
+}
+if (require.main === module) {
+  generate();
+}

examples/avro-schema-from-object/package.json

@@ -0,0 +1,12 @@
+{
+  "config": {
+    "example_name": "avro-schema-from-object"
+  },
+  "scripts": {
+    "install": "cd ../.. && npm i",
+    "start": "../../node_modules/.bin/ts-node --cwd ../../ ./examples/$npm_package_config_example_name/index.ts",
+    "start:windows": "..\\..\\node_modules\\.bin\\ts-node --cwd ..\\..\\ .\\examples\\%npm_package_config_example_name%\\index.ts",
+    "test": "../../node_modules/.bin/jest --config=../../jest.config.js ./examples/$npm_package_config_example_name/index.spec.ts",
+    "test:windows": "..\\..\\node_modules\\.bin\\jest --config=..\\..\\jest.config.js examples/%npm_package_config_example_name%/index.spec.ts"
+  }
+}