feat: add file path as input (#1601)

examples/file-uri-input/README.md

@@ -0,0 +1,17 @@
+# Generate models using file URI as input
+
+A basic example of how to generate models using file URI as input for AsyncAPI
+
+## 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/file-uri-input/__snapshots__/index.spec.ts.snap

@@ -0,0 +1,59 @@
+// Jest Snapshot v1, https://goo.gl/fbAQLP
+
+exports[`Should be able to generate models using file URI as input to output folder and should log expected output to console 1`] = `
+Array [
+  "class AnonymousSchema_1 {
+  private _displayName?: string;
+  private _email?: string;
+  private _additionalProperties?: Map<string, any>;
+
+  constructor(input: {
+    displayName?: string,
+    email?: string,
+    additionalProperties?: Map<string, any>,
+  }) {
+    this._displayName = input.displayName;
+    this._email = input.email;
+    this._additionalProperties = input.additionalProperties;
+  }
+
+  get displayName(): string | undefined { return this._displayName; }
+  set displayName(displayName: string | undefined) { this._displayName = displayName; }
+
+  get email(): string | undefined { return this._email; }
+  set email(email: string | undefined) { this._email = email; }
+
+  get additionalProperties(): Map<string, any> | undefined { return this._additionalProperties; }
+  set additionalProperties(additionalProperties: Map<string, any> | undefined) { this._additionalProperties = additionalProperties; }
+}",
+]
+`;
+
+exports[`Should be able to render models using file URI as input and should log expected output to console 1`] = `
+Array [
+  "class AnonymousSchema_1 {
+  private _displayName?: string;
+  private _email?: string;
+  private _additionalProperties?: Map<string, any>;
+
+  constructor(input: {
+    displayName?: string,
+    email?: string,
+    additionalProperties?: Map<string, any>,
+  }) {
+    this._displayName = input.displayName;
+    this._email = input.email;
+    this._additionalProperties = input.additionalProperties;
+  }
+
+  get displayName(): string | undefined { return this._displayName; }
+  set displayName(displayName: string | undefined) { this._displayName = displayName; }
+
+  get email(): string | undefined { return this._email; }
+  set email(email: string | undefined) { this._email = email; }
+
+  get additionalProperties(): Map<string, any> | undefined { return this._additionalProperties; }
+  set additionalProperties(additionalProperties: Map<string, any> | undefined) { this._additionalProperties = additionalProperties; }
+}",
+]
+`;

examples/file-uri-input/index.spec.ts

@@ -0,0 +1,26 @@
+const spy = jest.spyOn(global.console, 'log').mockImplementation(() => {
+  return;
+});
+import { generate, generateToFiles } from './index';
+
+describe('Should be able to render models using file URI as input', () => {
+  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();
+  });
+});
+
+describe('Should be able to generate models using file URI as input to output folder', () => {
+  afterAll(() => {
+    jest.restoreAllMocks();
+  });
+  test('and should log expected output to console', async () => {
+    await generateToFiles();
+    expect(spy.mock.calls.length).toEqual(1);
+    expect(spy.mock.calls[0]).toMatchSnapshot();
+  });
+});

examples/file-uri-input/index.ts

@@ -0,0 +1,26 @@
+import path from 'path';
+import { TypeScriptFileGenerator, TypeScriptGenerator } from '../../src';
+
+const generator = new TypeScriptGenerator();
+const fileGenerator = new TypeScriptFileGenerator();
+
+export async function generate(): Promise<void> {
+  const fileUri = `file://${path.resolve(__dirname, './testasyncapi.yml')}`;
+  const models = await generator.generate(fileUri);
+  for (const model of models) {
+    console.log(model.result);
+  }
+}
+
+export async function generateToFiles(): Promise<void> {
+  const outputFolder = './examples/file-uri-input/output';
+  const fileUri = `file://${path.resolve(__dirname, './testasyncapi.yml')}`;
+  const models = await fileGenerator.generateToFiles(fileUri, outputFolder);
+  for (const model of models) {
+    console.log(model.result);
+  }
+}
+if (require.main === module) {
+  generate();
+  generateToFiles();
+}

examples/file-uri-input/package.json

@@ -0,0 +1,10 @@
+{
+  "config" : { "example_name" : "file-uri-input" },
+  "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"
+  }
+}

examples/file-uri-input/testasyncapi.yml

@@ -0,0 +1,23 @@
+asyncapi: '2.6.0'
+info:
+  title: Account Service
+  version: 1.0.0
+  description: This service is in charge of processing user signups
+channels:
+  user/signedup:
+    subscribe:
+      message:
+        $ref: '#/components/messages/UserSignedUp'
+components:
+  messages:
+    UserSignedUp:
+      payload:
+        type: object
+        properties:
+          displayName:
+            type: string
+            description: Name of the user
+          email:
+            type: string
+            format: email
+            description: Email of the user

src/generators/AbstractFileGenerator.ts

@@ -7,7 +7,7 @@ export type FileGenerator = (content: string, toFile: string) => Promise<void>;
  */
 export interface AbstractFileGenerator<RenderCompleteModelOptions> {
   generateToFiles(
-    input: Record<string, unknown> | InputMetaModel,
+    input: any | InputMetaModel,
     outputDirectory: string,
     options: RenderCompleteModelOptions
   ): Promise<OutputModel[]>;

src/generators/cplusplus/CplusplusFileGenerator.ts

@@ -16,7 +16,7 @@ export class CplusplusFileGenerator
    * @param options
    */
   public async generateToFiles(
-    input: Record<string, unknown> | InputMetaModel,
+    input: any | InputMetaModel,
     outputDirectory: string,
     options?: CplusplusRenderCompleteModelOptions,
     ensureFilesWritten = false

src/generators/csharp/CSharpFileGenerator.ts

@@ -18,7 +18,7 @@ export class CSharpFileGenerator
    * @param ensureFilesWritten verify that the files is completely written before returning, this can happen if the file system is swamped with write requests.
    */
   public async generateToFiles(
-    input: Record<string, unknown> | InputMetaModel,
+    input: any | InputMetaModel,
     outputDirectory: string,
     options: DeepPartial<CSharpRenderCompleteModelOptions>,
     ensureFilesWritten = false

src/generators/dart/DartFileGenerator.ts

@@ -17,7 +17,7 @@ export class DartFileGenerator
    * @param ensureFilesWritten verify that the files is completely written before returning, this can happen if the file system is swamped with write requests.
    */
   public async generateToFiles(
-    input: Record<string, unknown> | InputMetaModel,
+    input: any | InputMetaModel,
     outputDirectory: string,
     options: DartRenderCompleteModelOptions,
     ensureFilesWritten = false

src/generators/go/GoFileGenerator.ts

@@ -17,7 +17,7 @@ export class GoFileGenerator
    * @param ensureFilesWritten verify that the files is completely written before returning, this can happen if the file system is swamped with write requests.
    */
   public async generateToFiles(
-    input: Record<string, unknown> | InputMetaModel,
+    input: any | InputMetaModel,
     outputDirectory: string,
     options: GoRenderCompleteModelOptions,
     ensureFilesWritten = false

src/generators/java/JavaFileGenerator.ts

@@ -17,7 +17,7 @@ export class JavaFileGenerator
    * @param ensureFilesWritten verify that the files is completely written before returning, this can happen if the file system is swamped with write requests.
    */
   public async generateToFiles(
-    input: Record<string, unknown> | InputMetaModel,
+    input: any | InputMetaModel,
     outputDirectory: string,
     options: JavaRenderCompleteModelOptions,
     ensureFilesWritten = false

src/generators/javascript/JavaScriptFileGenerator.ts

@@ -17,7 +17,7 @@ export class JavaScriptFileGenerator
    * @param ensureFilesWritten verify that the files is completely written before returning, this can happen if the file system is swamped with write requests.
    */
   public async generateToFiles(
-    input: Record<string, unknown> | InputMetaModel,
+    input: any | InputMetaModel,
     outputDirectory: string,
     options?: JavaScriptRenderCompleteModelOptions,
     ensureFilesWritten = false

src/generators/kotlin/KotlinFileGenerator.ts

@@ -17,7 +17,7 @@ export class KotlinFileGenerator
    * @param ensureFilesWritten verify that the files is completely written before returning, this can happen if the file system is swamped with write requests.
    */
   public async generateToFiles(
-    input: Record<string, unknown> | InputMetaModel,
+    input: any | InputMetaModel,
     outputDirectory: string,
     options: KotlinRenderCompleteModelOptions,
     ensureFilesWritten = false

src/generators/php/PhpFileGenerator.ts

@@ -17,7 +17,7 @@ export class PhpFileGenerator
    * @param ensureFilesWritten
    */
   public async generateToFiles(
-    input: Record<string, unknown> | InputMetaModel,
+    input: any | InputMetaModel,
     outputDirectory: string,
     options?: PhpRenderCompleteModelOptions,
     ensureFilesWritten = false

src/generators/python/PythonFileGenerator.ts

@@ -17,7 +17,7 @@ export class PythonFileGenerator
    * @param ensureFilesWritten verify that the files is completely written before returning, this can happen if the file system is swamped with write requests.
    */
   public async generateToFiles(
-    input: Record<string, unknown> | InputMetaModel,
+    input: any | InputMetaModel,
     outputDirectory: string,
     options: PythonRenderCompleteModelOptions,
     ensureFilesWritten = false

src/generators/rust/RustFileGenerator.ts

@@ -17,7 +17,7 @@ export class RustFileGenerator
    * @param ensureFilesWritten verify that the files is completely written before returning, this can happen if the file system is swamped with write requests.
    */
   public async generateToFiles(
-    input: Record<string, unknown> | InputMetaModel,
+    input: any | InputMetaModel,
     outputDirectory: string,
     options: RustRenderCompleteModelOptions,
     ensureFilesWritten = false
@@ -50,7 +50,7 @@ export class RustFileGenerator
    * @param ensureFilesWritten verify that the files is completely written before returning, this can happen if the file system is swamped with write requests.
    */
   public async generateToPackage(
-    input: Record<string, unknown> | InputMetaModel,
+    input: any | InputMetaModel,
     outputDirectory: string,
     options: RustRenderCompleteModelOptions,
     ensureFilesWritten = false

src/generators/rust/RustGenerator.ts

@@ -419,7 +419,7 @@ export class RustGenerator extends AbstractGenerator<
   }
 
   async generateCompleteSupport(
-    input: Record<string, unknown> | InputMetaModel,
+    input: any | InputMetaModel,
     completeModelOptions: Partial<RustRenderCompleteModelOptions>,
     options?: DeepPartial<RustOptions>
   ): Promise<OutputModel[]> {

src/generators/template/TemplateFileGenerator.ts

@@ -16,7 +16,7 @@ export class TemplateFileGenerator
    * @param options
    */
   public async generateToFiles(
-    input: Record<string, unknown> | InputMetaModel,
+    input: any | InputMetaModel,
     outputDirectory: string,
     options?: TemplateRenderCompleteModelOptions,
     ensureFilesWritten = false

src/generators/typescript/TypeScriptFileGenerator.ts

@@ -13,7 +13,7 @@ export class TypeScriptFileGenerator extends TypeScriptGenerator {
    * @param ensureFilesWritten verify that the files is completely written before returning, this can happen if the file system is swamped with write requests.
    */
   public async generateToFiles(
-    input: Record<string, unknown> | InputMetaModel,
+    input: any | InputMetaModel,
     outputDirectory: string,
     options?: TypeScriptRenderCompleteModelOptions,
     ensureFilesWritten = false