Merge pull request #14 from Q42/feature/esm-output

Feature/esm output

Author: tstikvoort

package-lock.json

@@ -1,6 +1,6 @@
 {
   "name": "openapi-typescript-validator",
-  "version": "3.2.0",
+  "version": "3.3.0",
   "description": "Generate typescript with ajv validation based on openapi schemas",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",

package.json

@@ -71,4 +71,9 @@ export interface GenerateOptions {
    * don't output decoder files
    */
   skipDecoders?: boolean;
+
+  /**
+   * when this option is enabled, standaloneOptions.validatorOutput is automatically set to "module"
+   */
+  esm?: boolean;
 }

src/GenerateOptions.ts

@@ -55,7 +55,8 @@ export async function generate(options: GenerateOptions) {
         schema,
         options.addFormats ?? false,
         options.formatOptions,
-        options.standalone.validatorOutput,
+        options.esm ? "module" : options.standalone.validatorOutput,
+        options.esm ?? false,
         directories,
         prettierOptions
       );
@@ -65,7 +66,8 @@ export async function generate(options: GenerateOptions) {
         schema,
         options.addFormats ?? false,
         options.formatOptions,
-        options.standalone.validatorOutput,
+        options.esm ? "module" : options.standalone.validatorOutput,
+        options.esm ?? false,
         directories,
         prettierOptions
       );
@@ -81,7 +83,7 @@ export async function generate(options: GenerateOptions) {
   generateHelpers(prettierOptions, directories);
 
   if (options.skipMetaFile !== true) {
-    generateMetaFile(allDefinitions, directories, prettierOptions);
+    generateMetaFile(allDefinitions, directories, prettierOptions, options.esm ?? false);
   }
 
   console.info(`Successfully generated files for ${schemaFile}`);

src/generate.ts

@@ -1,19 +1,21 @@
 import { format, Options } from "prettier";
 import { mkdirSync, writeFileSync } from "fs";
 import path from "path";
+import { ValidatorOutput } from "../GenerateOptions";
 
 export function generateMetaFile(
   definitionNames: string[],
   outDirs: string[],
-  prettierOptions: Options
+  prettierOptions: Options,
+  esm: boolean
 ): void {
   const metas = definitionNames
     .map((definitionName) => {
       return `${definitionName}: info<${definitionName}>('${definitionName}', '#/definitions/${definitionName}'),`;
     })
     .join("\n");
 
-  const rawOutput = metaTemplate
+  const rawOutput = metaTemplate(esm)
     .replace(/\$Definitions/g, metas)
     .replace(/\$ModelImports/g, definitionNames.join(", "))
 
@@ -25,9 +27,11 @@ export function generateMetaFile(
   });
 }
 
-const metaTemplate = `
+const metaTemplate = (esm: boolean) => {
+  const importExtension = esm ? ".js" : "";
+  return `
 /* eslint-disable */
-import { $ModelImports } from './models';
+import { $ModelImports } from './models${importExtension}';
 
 export const schemaDefinitions = {
   $Definitions
@@ -41,4 +45,5 @@ export interface SchemaInfo<T> {
 function info<T>(definitionName: string, schemaRef: string): SchemaInfo<T> {
   return { definitionName, schemaRef };
 }
-`;
+`
+}

src/generate/generate-meta.ts

@@ -5,7 +5,7 @@ import addFormats, { FormatsPluginOptions } from "ajv-formats";
 import standaloneCode from "ajv/dist/standalone";
 import { mkdirSync, writeFileSync } from "fs";
 import * as path from "path";
-import { ValidatorOutput } from "../GenerateOptions";
+import { GenerateOptions, ValidatorOutput } from "../GenerateOptions";
 import { createDecoderName, createValidatorName } from "./generation-utils";
 
 export function generateStandaloneDecoders(
@@ -14,6 +14,7 @@ export function generateStandaloneDecoders(
   addFormats: boolean,
   formatOptions: FormatsPluginOptions | undefined,
   output: ValidatorOutput,
+  esm: boolean,
   outDirs: string[],
   prettierOptions: Options
 ): void {
@@ -32,12 +33,9 @@ export function generateStandaloneDecoders(
       prettierOptions
     );
 
-    const validatorImportStatement =
-      output === "module"
-        ? `import { ${validatorName} } from './validator'`
-        : `const { ${validatorName} } = require("./validator")`;
+    const validatorImportStatement = createValidatorImportStatement(validatorName, output, false, esm);
 
-    let rawDecoderOutput = decoderFileTemplate
+    let rawDecoderOutput = decoderFileTemplate(esm)
       .replace(/\$DecoderName/g, decoderName)
       .replace(/\$Class/g, definitionName)
       .replace(/\$ValidatorImports/g, validatorImportStatement)
@@ -51,7 +49,7 @@ export function generateStandaloneDecoders(
     );
 
     indexExports.push(
-      `export { ${decoderName} } from './${definitionName}/decoder';`
+      `export { ${decoderName} } from './${definitionName}/decoder${esm ? ".js" : ""}';`
     );
 
     outDirs.forEach((outDir) => {
@@ -91,6 +89,7 @@ export function generateStandaloneMergedDecoders(
   addFormats: boolean,
   formatOptions: FormatsPluginOptions | undefined,
   output: ValidatorOutput,
+  esm: boolean,
   outDirs: string[],
   prettierOptions: Options
 ) {
@@ -108,12 +107,9 @@ export function generateStandaloneMergedDecoders(
     .map((d) => createValidatorName(d))
     .join(", ");
 
-  const validatorImportStatement =
-    output === "module"
-      ? `import { ${validatorImports} } from './validators';`
-      : `const { ${validatorImports} } = require("./validators")`;
+  const validatorImportStatement = createValidatorImportStatement(validatorImports, output, true, esm);
 
-  const rawDecoderOutput = mergedDecodersFileTemplate
+  const rawDecoderOutput = mergedDecodersFileTemplate(esm)
     .replace(/\$ValidatorImports/g, validatorImportStatement)
     .replace(/\$ModelImports/g, definitionNames.join(", "))
     .replace(/\$Decoders/g, decoders);
@@ -150,6 +146,22 @@ export function generateStandaloneMergedDecoders(
   });
 }
 
+
+function createValidatorImportStatement(validatorImportString: string, output: ValidatorOutput, merged: boolean, esm: boolean) {
+  const fileName = merged ? 'validators' : 'validator';
+  switch (output) {
+    case 'commonjs':
+      return `const { ${validatorImportString} } = require("./${fileName}")`
+    case 'module':
+      if (esm) {
+        return `import { ${validatorImportString} } from './${fileName}.js'`
+      } else {
+        return `import { ${validatorImportString} } from './${fileName}'`
+      }
+  }
+}
+
+
 function standAloneValidatorOutput(
   schema: ParsedSchema,
   definitions: string[],
@@ -223,30 +235,36 @@ export const $DecoderName: Decoder<$Class> = {
 }
 `;
 
-const decoderFileTemplate = `
-/* eslint-disable */
+const decoderFileTemplate = (esm: boolean) => {
+  const importExtension = esm ? ".js" : "";
+  return `
+  /* eslint-disable */
 
-import { Decoder } from '../../helpers';
-import { validateJson, Validator } from '../../validate';
-import { $Class } from '../../models';
-$ValidatorImports
+  import { Decoder } from '../../helpers${importExtension}';
+  import { validateJson, Validator } from '../../validate${importExtension}';
+  import { $Class } from '../../models${importExtension}';
+  $ValidatorImports
 
-${decoderTemplate}
-`;
+  ${decoderTemplate}
+  `
+}
 
 const decodersFileTemplate = `
 /* eslint-disable */
 
 $Exports
 `;
 
-const mergedDecodersFileTemplate = `
-/* eslint-disable */
-
-import { Decoder } from './helpers';
-import { validateJson, Validator } from './validate';
-import { $ModelImports } from './models';
-$ValidatorImports
-
-$Decoders
-`;
+const mergedDecodersFileTemplate = (esm: boolean) => {
+  const importExtension = esm ? ".js" : "";
+  return `
+  /* eslint-disable */
+  
+  import { Decoder } from './helpers${importExtension}';
+  import { validateJson, Validator } from './validate${importExtension}';
+  import { $ModelImports } from './models${importExtension}';
+  $ValidatorImports
+  
+  $Decoders
+  `
+};