definition-generator-framework 1.2.2 → 1.2.3

package/dist/_mocks/mocks.d.ts

@@ -0,0 +1,7 @@
+import { Context, FileInfo, LocationInFile } from '../framework/framework.model';
+export declare function getMockContext(): Context;
+export declare function getMockContextFromContents(contents: string[]): Context;
+export declare function getMockFileInfo(content: string): FileInfo;
+export declare const SampleLocation1: LocationInFile;
+export declare const SampleLocation2: LocationInFile;
+export declare const SampleLocation3: LocationInFile;

package/dist/framework/framework.d.ts

@@ -0,0 +1,21 @@
+import Joi from 'joi';
+import { Output } from './framework.model';
+export type DefinitionComponentClassType<T> = new (...args: any[]) => DefinitionComponent<T>;
+export interface DefinitionComponentMeta {
+    definitionName: string;
+    singleton?: boolean;
+    validationSchema: Joi.Schema;
+}
+export declare function DefinitionComponentDecorator(meta: DefinitionComponentMeta): (ComponentClass: DefinitionComponentClassType<any>) => any;
+export declare abstract class DefinitionComponent<T> {
+    abstract process(definitions: T, context: Output): Promise<void>;
+}
+interface DefinitionModuleMeta {
+    modules: DefinitionComponentClassType<any>[];
+    interfaces: string;
+}
+export declare function DefinitionModuleDecorator(meta: DefinitionModuleMeta): (ModuleClass: DefinitionModuleClassType) => any;
+export type DefinitionModuleClassType = new (...args: any[]) => DefinitionModule;
+export declare abstract class DefinitionModule {
+}
+export {};

package/dist/framework/framework.data.d.ts

@@ -0,0 +1,6 @@
+import { DefinitionComponentClassType } from './framework';
+export declare class FrameworkData {
+    static readonly definitionNames: Set<string>;
+    static readonly modules: DefinitionComponentClassType<any>[];
+    static interfaces: string;
+}

package/dist/framework/framework.model.d.ts

@@ -0,0 +1,40 @@
+export interface FileSystem {
+    existsSync: (path: string) => boolean;
+}
+export interface FileInfo {
+    path: string;
+    content: string;
+}
+export interface LocationInFile {
+    readonly path: string;
+    readonly line: number;
+}
+export interface ErrorLog {
+    readonly description: string;
+    readonly location: LocationInFile;
+}
+export interface Config {
+    projectRoot: string;
+}
+export type RawData = undefined | string | ParsedStructure[] | Record<string, ParsedStructure>;
+export interface ParsedStructure {
+    readonly rawData: RawData;
+    readonly line: number;
+}
+export interface RawDefinition {
+    readonly type: string;
+    readonly parsedStructure: ParsedStructure;
+    readonly location: LocationInFile;
+}
+export interface Context {
+    readonly root: string;
+    readonly config: Config;
+    readonly rawDefinitions: RawDefinition[];
+    readonly files: FileInfo[];
+    readonly output: FileInfo[];
+    readonly errorLogs: ErrorLog[];
+}
+export interface Output {
+    addFile: (fileInfo: FileInfo) => void;
+    addError: (errorLog: ErrorLog) => void;
+}

package/dist/framework/kernel.d.ts

@@ -0,0 +1,5 @@
+export declare class Kernel {
+    static process(): Promise<void>;
+    private static generateOutputFiles;
+    private static getOutputFiles;
+}

package/dist/helpers/common-functions/common-functions.d.ts

@@ -0,0 +1,10 @@
+declare class CommonFunctionsClass {
+    decorateDefinitionName(name: string, definitionType: string): string;
+    kebabCaseToCamelCase(string: string): string;
+    lowerCaseFirstLetter(string: string): string;
+    upperCaseFirstLetter(string: string): string;
+    removeWhiteSpace(row: string): string;
+    removeComments(row: string): string;
+}
+export declare const CommonFunctions: CommonFunctionsClass;
+export {};

package/dist/helpers/duplicate-helper/duplicate-helper.d.ts

@@ -0,0 +1,11 @@
+import { Context, LocationInFile } from '../../framework/framework.model';
+export declare class DuplicateHelper {
+    private group;
+    private identifiers;
+    private identifierToLocation;
+    private addedIdentifiers;
+    private duplicates;
+    constructor(group: string);
+    newEntry(identifier: string, location: LocationInFile): boolean;
+    flush(context: Context): void;
+}

package/dist/helpers/output-helper/output-helper.d.ts

@@ -0,0 +1,18 @@
+declare class OutputHelperClass {
+    generateArrayOutput(options: {
+        preText?: string;
+        variableName: string;
+        variableType: string;
+        variable: any[];
+    }): Promise<string>;
+    generateOutput(options: {
+        preText?: string;
+        variableName: string;
+        variableType?: string;
+        variable: any;
+    }): Promise<string>;
+    private format;
+    private stringify;
+}
+export declare const OutputHelper: OutputHelperClass;
+export {};

package/dist/helpers/raw-definition-helper/raw-definition.helper.d.ts

@@ -0,0 +1,7 @@
+import { RawDefinition } from '../../framework/framework.model';
+export declare class RawDefinitionHelper {
+    static findLine(rawDefinition: RawDefinition, path: (string | number)[]): number;
+    static flatten(rawDefinition: RawDefinition): any;
+    private static findLineRawData;
+    private static flattenRawData;
+}

package/dist/helpers/validator/joi-custom-validators.d.ts

@@ -0,0 +1,23 @@
+import * as Joi from 'joi';
+import { FileSystem, Context } from '../../framework/framework.model';
+import { DefinitionComponentClassType } from '../../framework/framework';
+declare module 'joi' {
+    interface StringSchema {
+        uniqueNameGroup(definitionComponentClass: DefinitionComponentClassType<any>): Joi.StringSchema;
+        path(): Joi.StringSchema;
+        reference(definitionComponentClass: DefinitionComponentClassType<any> | DefinitionComponentClassType<any>[]): Joi.StringSchema;
+    }
+}
+export declare class JoiCustomValidators {
+    private static rootDirectory;
+    private static definitionNames;
+    private static duplicateHelpers;
+    static logDuplicates(context: Context): void;
+    static setRootDirectory(rootDirectory: string): void;
+    static decorate(fs: FileSystem): void;
+    private static getDefinitionTypesFromArray;
+    private static getValidationState;
+    private static getPathAndRawDefinition;
+    private static getDefinitionNames;
+    private static getDuplicateHelper;
+}

package/dist/helpers/validator/validator.d.ts

@@ -0,0 +1,12 @@
+import * as Joi from 'joi';
+import { Context, RawDefinition } from '../../framework/framework.model';
+export interface GroupDefinition {
+    name: string;
+    group: string[];
+}
+export declare class Validator {
+    static definitionToRawDefintion: Map<any, RawDefinition>;
+    static convert<T>(definitionType: string, schema: Joi.AnySchema, context: Context): T[];
+    static convertSingular<T>(definitionType: string, schema: Joi.AnySchema, context: Context): T | undefined;
+    static validate<T>(rawDefinition: RawDefinition, schema: Joi.AnySchema, context: Context, logErrors?: boolean): T | undefined;
+}

package/dist/index.d.ts

@@ -0,0 +1,5 @@
+export { Validator } from './helpers/validator/validator';
+export { JoiCustomValidators } from './helpers/validator/joi-custom-validators';
+export { DefinitionModule, DefinitionModuleDecorator, DefinitionComponent, DefinitionComponentDecorator } from './framework/framework';
+export { OutputHelper } from './helpers/output-helper/output-helper';
+export { Output, ErrorLog } from './framework/framework.model';

package/dist/pipeline/1-select-definitions-helper.d.ts

@@ -0,0 +1,20 @@
+import { FileInfo, LocationInFile, ErrorLog } from '../framework/framework.model';
+export interface DefinitionPlaneText {
+    readonly type: string;
+    readonly content: string[];
+    readonly location: LocationInFile;
+}
+export interface SelectDefinitionsResult {
+    definitionPlaneTexts: DefinitionPlaneText[];
+    errorLogs: ErrorLog[];
+}
+export declare class SelectDefinitionsHelper {
+    private definitionsStarted;
+    private currentItem;
+    private definitionPlaneTexts;
+    private errorLogs;
+    private currentFilePath;
+    process(file: FileInfo): SelectDefinitionsResult;
+    private flushCurrentItem;
+    private onDeclarationEncountered;
+}

package/dist/pipeline/2-structure-parser.helper.d.ts

@@ -0,0 +1,11 @@
+import { DefinitionPlaneText } from './1-select-definitions-helper';
+import { LocationInFile, ErrorLog, RawDefinition, ParsedStructure } from '../framework/framework.model';
+export interface StructureParserResult {
+    readonly rawDefinitions: RawDefinition[];
+    readonly errorLogs: ErrorLog[];
+}
+export declare class StructureParserHelper {
+    static getParsedStructure(content: string[], location: LocationInFile): ParsedStructure;
+    private static getStructureType;
+    process(definitionPlaneTexts: DefinitionPlaneText[]): StructureParserResult;
+}

package/dist/pipeline/3-config.d.ts

@@ -0,0 +1,10 @@
+import * as Joi from 'joi';
+import { Context } from '../framework/framework.model';
+export declare const ConfigDefinitionName = "CONFIG";
+export declare class Config {
+    static $meta: {
+        definitionName: string;
+        validationSchema: Joi.ObjectSchema<any>;
+    };
+    static process(context: Context): void;
+}

package/dist/pipeline/_mocks/index.d.ts

@@ -0,0 +1,13 @@
+import { DefinitionPlaneText } from '../1-select-definitions-helper';
+import { LocationInFile, ErrorLog, RawData, RawDefinition, ParsedStructure } from '../../framework/framework.model';
+export declare function getBaseStructure(location: LocationInFile, parsedStructure: ParsedStructure): RawDefinition;
+export declare function getMockDefinitionPlaneText(content: string[]): DefinitionPlaneText;
+export declare function getExpectedStructure(expected: RawData, offset: number, location: LocationInFile): RawDefinition;
+export declare function getExpectedParsedStructure(content: string | undefined, location: LocationInFile): ParsedStructure;
+export declare class ExpectErrorHelper {
+    private parser;
+    constructor(parser: {
+        parse: (content: string[], location: LocationInFile) => ParsedStructure;
+    });
+    expect(content: string[], expectedError: ErrorLog): void;
+}

package/dist/pipeline/parsers/array-parser.d.ts

@@ -0,0 +1,4 @@
+import { LocationInFile, ParsedStructure } from '../../framework/framework.model';
+export declare class ArrayParser {
+    static parse(content: string[], location: LocationInFile): ParsedStructure;
+}

package/dist/pipeline/parsers/object-parser.d.ts

@@ -0,0 +1,4 @@
+import { LocationInFile, ParsedStructure } from '../../framework/framework.model';
+export declare class ObjectParser {
+    static parse(content: string[], location: LocationInFile): ParsedStructure;
+}

package/dist/pipeline/parsers/primitive-parser.d.ts

@@ -0,0 +1,7 @@
+import { LocationInFile, ParsedStructure } from '../../framework/framework.model';
+export declare class PrimitiveParser {
+    static parse(content: string[], location: LocationInFile): ParsedStructure;
+    private static parsePlaneString;
+    private static parseQuotedString;
+    private static parseMultilineString;
+}

package/dist/pipeline/raw-data-parser.d.ts

@@ -0,0 +1,6 @@
+import { Context } from '../framework/framework.model';
+export declare class RawDataParser {
+    private static selectDefinitionsHelper;
+    private static structureParserHelper;
+    static process(context: Context): void;
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "definition-generator-framework",
-  "version": "1.2.2",
+  "version": "1.2.3",
   "description": "Definition Generator Framework",
   "main": "dist/index.js",
   "repository": {