feat: add file output for TypeScript generator (#536)

docs/advanced.md

@@ -32,6 +32,7 @@ The file generators all follow the same pattern regardless of output language, w
 
 Supported by:
 - Java
+- TypeScript
 - C#
 - JavaScript
 

docs/languages/TypeScript.md

@@ -10,6 +10,7 @@ There are special use-cases that each language supports; this document pertains
 - [Generate union types instead of enums](#generate-union-types-instead-of-enums)
 - [Generate un/marshal functions for classes](#generate-unmarshal-functions-for-classes)
 - [Generate example data function](#generate-example-data-function)
+- [Rendering complete models to a specific module system](#rendering-complete-models-to-a-specific-module-system)
 
 <!-- tocstop -->
 
@@ -50,3 +51,11 @@ You might stumble upon a user case (we had one in code generation) where you wan
 This can be done by including the preset `TS_COMMON_PRESET` using the option `example`.
 
 Check out this [example out for a live demonstration](../../examples/typescript-generate-example).
+
+
+## Rendering complete models to a specific module system
+In some cases you might need to render the complete models to a specific module system such as ESM and CJS.
+
+Check out this [example for a live demonstration how to generate the complete TypeScript models to use ESM module system](../../examples/typescript-use-esm).
+
+Check out this [example for a live demonstration how to generate the complete TypeScript models to use CJS module system](../../examples/typescript-use-cjs).

examples/README.md

@@ -7,6 +7,8 @@ This directory contains a series of self-contained examples that you can use as
 - [typescript-enum-type](./typescript-enum-type) - A basic example of how to use Modelina can output different types of enums in TypeScript.
 - [typescript-generate-marshalling](./typescript-generate-marshalling) - A basic example of how to use the un/marshalling functionality of the typescript class.
 - [typescript-generate-example](./typescript-generate-example) - A basic example of how to use Modelina and output a TypeScript class with an example function.
+- [typescript-use-esm](./typescript-use-esm) - A basic example that generate the models to use ESM module system.
+- [typescript-use-cjs](./typescript-use-cjs) - A basic example that generate the models to use CJS module system.
 - [indentation-type-and-size](./indentation-type-and-size) - This example shows how to change the indentation type and size of the generated model.
 - [asyncapi-from-object](./asyncapi-from-object) - A basic example where an AsyncAPI JS object is used to generate models.
 - [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.

examples/javascript-use-esm/__snapshots__/index.spec.ts.snap

@@ -4,7 +4,7 @@ exports[`Should be able to render models to ESM module system and should log exp
 Array [
   "
 
-export default class Person {
+class Person {
   email;
 
   constructor(input) {
@@ -13,15 +13,17 @@ export default class Person {
 
   get email() { return this.email; }
   set email(email) { this.email = email; }
-}",
+}
+export default Person;
+",
 ]
 `;
 
 exports[`Should be able to render models to ESM module system and should log expected output to console 2`] = `
 Array [
   "import Person from './Person';
 
-export default class Root {
+class Root {
   person;
 
   constructor(input) {
@@ -30,6 +32,8 @@ export default class Root {
 
   get person() { return this.person; }
   set person(person) { this.person = person; }
-}",
+}
+export default Root;
+",
 ]
 `;

examples/javascript-use-esm/package.json

@@ -1,5 +1,5 @@
 {
-  "config" : { "example_name" : "javascript-module-system" },
+  "config" : { "example_name" : "javascript-use-esm" },
   "scripts": {
     "install": "cd ../.. && npm i",
     "start": "../../node_modules/.bin/ts-node --cwd ../../ ./examples/$npm_package_config_example_name/index.ts",

examples/typescript-use-cjs/README.md

@@ -0,0 +1,17 @@
+# TypeScript models use CJS module system
+
+This example shows how you can generate the models to use CJS module system.
+
+## 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/typescript-use-cjs/__snapshots__/index.spec.ts.snap

@@ -0,0 +1,41 @@
+// Jest Snapshot v1, https://goo.gl/fbAQLP
+
+exports[`Should be able to render models to ESM module system and should log expected output to console 1`] = `
+Array [
+  "
+
+class Person {
+  private _email?: string;
+
+  constructor(input: {
+    email?: string,
+  }) {
+    this._email = input.email;
+  }
+
+  get email(): string | undefined { return this._email; }
+  set email(email: string | undefined) { this._email = email; }
+}
+module.exports = Person;",
+]
+`;
+
+exports[`Should be able to render models to ESM module system and should log expected output to console 2`] = `
+Array [
+  "const Person = require('./Person');
+
+class Root {
+  private _person?: Person;
+
+  constructor(input: {
+    person?: Person,
+  }) {
+    this._person = input.person;
+  }
+
+  get person(): Person | undefined { return this._person; }
+  set person(person: Person | undefined) { this._person = person; }
+}
+module.exports = Root;",
+]
+`;

examples/typescript-use-cjs/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 models to ESM module system', () => {
+  afterAll(() => {
+    jest.restoreAllMocks();
+  });
+  test('and should log expected output to console', async () => {
+    await generate();
+    //Generate is called 2x, so even though we expect 2 models, we double it
+    expect(spy.mock.calls.length).toEqual(4);
+    expect(spy.mock.calls[1]).toMatchSnapshot();
+    expect(spy.mock.calls[2]).toMatchSnapshot();
+  });
+});

examples/typescript-use-cjs/index.ts

@@ -0,0 +1,33 @@
+import { TypeScriptGenerator } from '../../src';
+
+const generator = new TypeScriptGenerator();
+const jsonSchemaDraft7 = {
+  $schema: 'http://json-schema.org/draft-07/schema#',
+  type: 'object',
+  additionalProperties: false,
+  properties: {
+    person: {
+      type: 'object',
+      additionalProperties: false,
+      properties: {
+        email: {
+          type: 'string',
+          format: 'email'
+        }
+      }
+    }
+  }
+};
+
+export async function generate() : Promise<void> {
+  const models = await generator.generateCompleteModels(
+    jsonSchemaDraft7, 
+    {
+      moduleSystem: 'CJS'
+    }
+  );
+  for (const model of models) {
+    console.log(model.result);
+  }
+}
+generate();

examples/typescript-use-cjs/package.json

@@ -0,0 +1,10 @@
+{
+  "config" : { "example_name" : "typescript-use-cjs" },
+  "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/typescript-use-esm/README.md

@@ -0,0 +1,17 @@
+# TypeScript models use ESM module system
+
+This example shows how you can generate the models to use ESM module system.
+
+## 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/typescript-use-esm/__snapshots__/index.spec.ts.snap

@@ -0,0 +1,43 @@
+// Jest Snapshot v1, https://goo.gl/fbAQLP
+
+exports[`Should be able to render models to ESM module system and should log expected output to console 1`] = `
+Array [
+  "
+
+class Person {
+  private _email?: string;
+
+  constructor(input: {
+    email?: string,
+  }) {
+    this._email = input.email;
+  }
+
+  get email(): string | undefined { return this._email; }
+  set email(email: string | undefined) { this._email = email; }
+}
+export default Person;
+",
+]
+`;
+
+exports[`Should be able to render models to ESM module system and should log expected output to console 2`] = `
+Array [
+  "import Person from './Person';
+
+class Root {
+  private _person?: Person;
+
+  constructor(input: {
+    person?: Person,
+  }) {
+    this._person = input.person;
+  }
+
+  get person(): Person | undefined { return this._person; }
+  set person(person: Person | undefined) { this._person = person; }
+}
+export default Root;
+",
+]
+`;

examples/typescript-use-esm/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 models to ESM module system', () => {
+  afterAll(() => {
+    jest.restoreAllMocks();
+  });
+  test('and should log expected output to console', async () => {
+    await generate();
+    //Generate is called 2x, so even though we expect 2 models, we double it
+    expect(spy.mock.calls.length).toEqual(4);
+    expect(spy.mock.calls[1]).toMatchSnapshot();
+    expect(spy.mock.calls[2]).toMatchSnapshot();
+  });
+});

examples/typescript-use-esm/index.ts

@@ -0,0 +1,33 @@
+import { TypeScriptGenerator } from '../../src';
+
+const generator = new TypeScriptGenerator();
+const jsonSchemaDraft7 = {
+  $schema: 'http://json-schema.org/draft-07/schema#',
+  type: 'object',
+  additionalProperties: false,
+  properties: {
+    person: {
+      type: 'object',
+      additionalProperties: false,
+      properties: {
+        email: {
+          type: 'string',
+          format: 'email'
+        }
+      }
+    }
+  }
+};
+
+export async function generate() : Promise<void> {
+  const models = await generator.generateCompleteModels(
+    jsonSchemaDraft7, 
+    {
+      moduleSystem: 'ESM'
+    }
+  );
+  for (const model of models) {
+    console.log(model.result);
+  }
+}
+generate();

examples/typescript-use-esm/package.json

@@ -0,0 +1,10 @@
+{
+  "config" : { "example_name" : "typescript-use-esm" },
+  "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"
+  }
+}

src/generators/javascript/JavaScriptFileGenerator.ts

@@ -14,7 +14,8 @@ export class JavaScriptFileGenerator extends JavaScriptGenerator implements Abst
    */
   public async generateToFiles(input: Record<string, unknown> | CommonInputModel, outputDirectory: string, options?: JavaScriptRenderCompleteModelOptions): Promise<OutputModel[]> {
     let generatedModels = await this.generateCompleteModels(input, options || {});
-    generatedModels = generatedModels.filter((outputModel) => { return outputModel.modelName !== undefined; });
+    //Filter anything out that have not been successfully generated
+    generatedModels = generatedModels.filter((outputModel) => { return outputModel.modelName !== ''; });
     for (const outputModel of generatedModels) {
       const filePath = path.resolve(outputDirectory, `${outputModel.modelName}.js`);
       await FileHelpers.writerToFileSystem(outputModel.result, filePath);

src/generators/javascript/JavaScriptGenerator.ts

@@ -42,14 +42,25 @@ export class JavaScriptGenerator extends AbstractGenerator<JavaScriptOptions, Ja
   // eslint-disable-next-line @typescript-eslint/no-unused-vars
   async renderCompleteModel(model: CommonModel, inputModel: CommonInputModel, options: JavaScriptRenderCompleteModelOptions): Promise<RenderOutput> {
     const outputModel = await this.render(model, inputModel);
-    const modelDependencies = model.getNearestDependencies().map((dependencyModelName) => {
-      const formattedDependencyModelName = this.options.namingConvention?.type ? this.options.namingConvention.type(dependencyModelName, { inputModel, model: inputModel.models[String(dependencyModelName)] }) : dependencyModelName;
+    let modelDependencies = model.getNearestDependencies();
+    //Ensure model dependencies have their rendered name
+    modelDependencies = modelDependencies.map((dependencyModelName) => {
+      return this.options.namingConvention?.type ? this.options.namingConvention.type(dependencyModelName, { inputModel, model: inputModel.models[String(dependencyModelName)] }) : dependencyModelName;
+    });
+    //Filter out any dependencies that is recursive to it'self
+    modelDependencies = modelDependencies.filter((dependencyModelName) => {
+      return dependencyModelName !== outputModel.renderedName;
+    });
+    //Create the correct dependency imports
+    modelDependencies = modelDependencies.map((formattedDependencyModelName) => {
       if (options.moduleSystem === 'CJS') {
         return `const ${formattedDependencyModelName} = require('./${formattedDependencyModelName}');`;
       }
       return `import ${formattedDependencyModelName} from './${formattedDependencyModelName}';`;
     });
-    let modelCode = `export default ${outputModel.result}`;
+    let modelCode = `${outputModel.result}
+export default ${outputModel.renderedName};
+`;
     if (options.moduleSystem === 'CJS') {
       modelCode = `${outputModel.result}
 module.exports = ${outputModel.renderedName};`;