nope/lib/helpers/generateSchemas.ts

/**
 * @author Martin Karkowski
 * @email m.karkowski@zema.de
 * @create date 2020-11-06 08:53:40
 * @modify date 2020-11-06 08:53:41
 * @desc [description]
 */

import { readFile } from "fs/promises";
import * as handlebars from 'handlebars';
import { join } from 'path';
import { Project } from "ts-morph";
import * as TJS from "typescript-json-schema";
import { Logger } from 'winston';
import { IJsonSchema } from "../../types/IJSONSchema";
import { analyzeFiles, defaultClassFilter, defaultFunctionFilter, defaultPropFilter } from "./analyzeTypescriptFiles";
import { createFile, createPath } from "./fileMethods";
import { flattenSchema } from "./jsonSchemaMethods";


/**
 * Generate the Client Templates.
 * @param options 
 */
export async function generateSchemas(options: {
  pathToClassSchemaTemplate: string,
  pathToFunctionSchemaTemplate: string,
  tempDir: string,
  inputDir: string,
  tsConfigFilePath: string,
  logger?: Logger,
}) {

  // Create the Output dir (if it doenst exists)
  await createPath(options.tempDir);

  // Function to Determine new project files.
  const project = new Project({
    tsConfigFilePath: options.tsConfigFilePath,
    addFilesFromTsConfig: false,
  });

  project.addSourceFilesAtPaths(options.inputDir);

  // Readin the Source-Files.
  const sourceFiles = project.getSourceFiles();

  // Generate the Files
  const result = analyzeFiles(sourceFiles, {
    classDecorator: 'exportsElementsToOpenAPI',
    methodDecorator: 'exportMethodToOpenAPI',
    propertyDecorator: 'exportPropertyToOpenAPI',
    filterClasses: defaultClassFilter({
      classDecorator: 'exportsElementsToOpenAPI',
      classInterface: ''
    }),
    filterFunctions: defaultFunctionFilter({
      functionDecorator: 'exportFunctionToOpenAPI'
    }),
    filterMethods: (cl, method) => {
      return method.isImplementation && method.isAsync && method.params.filter(param => param.baseType === 'function').length === 0
    },
    filterProperties: defaultPropFilter({
      propertyDecorator: 'exportPropertyToDispatcher',
      propertyType: 'nopeObservable'
    }),
    checkImport: type => type !== 'nopeObservable'
  }
  );

  // load the File.
  const classSchemaTemplate = await readFile(options.pathToClassSchemaTemplate, {
    encoding: 'utf-8'
  })

  // Renderfuncting
  const renderClassSchema = handlebars.compile(classSchemaTemplate);

  // Generate the Files.
  const classFiles: {
    className: string,
    name: string,
    content: string,
  }[] = result.classes.map(item => {
    return {
      className: item.className,
      name: item.className + 'Schema',
      content: renderClassSchema(item)
    }
  });

  // load the File.
  const classFunctionTemplate = await readFile(options.pathToFunctionSchemaTemplate, {
    encoding: 'utf-8'
  })

  // Renderfuncting
  const renderFunctionSchema = handlebars.compile(classFunctionTemplate);

  // Generate the Files.
  const functionFiles: {
    name: string,
    content: string,
    className: string,
  }[] = result.functions.map(item => {
    return {
      className: item.name,
      name: item.name + 'Schema',
      content: renderFunctionSchema(item)
    }
  });

  for (const file of classFiles) {
    // Generate the Path.
    const fileName = join(options.tempDir, 'classes', file.name + '.ts');
    await createFile(
      fileName,
      file.content
    );

    if (options.logger) {
      options.logger.info('Generated -> ' + fileName);
    }
  }

  for (const file of functionFiles) {
    // Generate the Path.
    const fileName = join(options.tempDir, 'functions', file.name + '.ts');
    await createFile(
      fileName,
      file.content
    );

    if (options.logger) {
      options.logger.info('Generated -> ' + fileName);
    }
  }

  // After all files has been written => Generate the Schemas:
  const _settings: TJS.PartialArgs = {
    required: true,
  };

  // Options for the TJS.Compiler;
  const compilerOptions: TJS.CompilerOptions = {
    strictNullChecks: true,
    skipLibCheck: true
  };

  const schemaMapping: { [index: string]: IJsonSchema } = {};

  for (const file of classFiles) {
    const _program = TJS.getProgramFromFiles(
      [join(options.tempDir, 'classes', file.name + '.ts')],
      compilerOptions
    );

    // We can either get the schema for one file and one type...
    const _schema = TJS.generateSchema(_program, "*", _settings);

    // Flatten the Schema.
    const _flattendSchema = flattenSchema(_schema as any)

    // Receive the Element
    schemaMapping[file.className] = _flattendSchema;

    // Generate the Path.
    const fileName = join(options.tempDir, 'schema', file.name + '.json')

    // Write down the Schema:
    await createFile(
      fileName,
      JSON.stringify(_flattendSchema, undefined, 4)
    );

    if (options.logger) {
      options.logger.info('Generated -> ' + fileName);
    }
  }

  for (const file of functionFiles) {
    const _program = TJS.getProgramFromFiles(
      [join(options.tempDir, 'functions', file.name + '.ts')],
      compilerOptions
    );

    // We can either get the schema for one file and one type...
    const _schema = TJS.generateSchema(_program, "*", _settings);

    // Flatten the Schema.
    const _flattendSchema = flattenSchema(_schema as any)

    // Receive the Element
    schemaMapping[file.className] = _flattendSchema;

    // Generate the Path.
    const fileName = join(options.tempDir, 'schema', file.name + '.json')

    // Write down the Schema:
    await createFile(
      fileName,
      JSON.stringify(_flattendSchema, undefined, 4)
    );

    if (options.logger) {
      options.logger.info('Generated -> ' + fileName);
    }
  }

  return {
    schemaMapping,
    analysis: result
  };
}