definition-generator-framework 1.12.12 → 1.13.0

package/dist/decorators/definition-component.js

@@ -1,6 +1,17 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.SingleDefinitionComponent = exports.DefinitionComponent = exports.DefinitionComponentDecorator = void 0;
+function toPascalCase(input) {
+    return input
+        .replace(/[-_]/g, ' ')
+        .replace(/([a-z])([A-Z])/g, '$1 $2')
+        .replace(/\s+/g, ' ')
+        .trim()
+        .toLowerCase()
+        .split(' ')
+        .map(word => word.charAt(0).toUpperCase() + word.slice(1))
+        .join('');
+}
 function DefinitionComponentDecorator(meta) {
     return function (ComponentClass) {
         if (meta.singleton) {
@@ -18,6 +29,7 @@ function DefinitionComponentDecorator(meta) {
         }
         ComponentClass.$meta = {
             componentName: meta.componentName,
+            pascalCaseComponentName: toPascalCase(meta.componentName),
             keyName: meta.keyName,
             singleton: meta.singleton,
             validationSchema: meta.validationSchema

package/dist/framework/context.js

@@ -21,7 +21,7 @@ class Context {
         this.output.push({
             path: request.path,
             content: await file_content_generator_1.FileContentGenerator.generate({
-                preText: request.preText,
+                preText: helpers_lib_1.Comparator.isArray(request.preText) ? request.preText.join('\n') : request.preText,
                 variableName: request.variableName,
                 variableType: request.variableType,
                 variable: request.variable,

package/dist/framework/file-generators/index-file-generator.d.ts

@@ -0,0 +1,13 @@
+export declare class IndexFileGenerator {
+    private static premadeInterfaces;
+    private static idTypes;
+    static addPremadeInterface(value: string): void;
+    static addIdType(constantName: string, keys: string[]): void;
+    static generateFile(pretext: string, outputIndexFile: string): Promise<void>;
+    private static createIndexFile;
+    private static generateFileDevMode;
+    private static generateExportsContent;
+    private static generateInterfacesContent;
+    private static getInterfacesFromFile;
+    static generateTypes(): string;
+}

package/dist/framework/file-generators/index-file-generator.js

@@ -0,0 +1,139 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || function (mod) {
+    if (mod && mod.__esModule) return mod;
+    var result = {};
+    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+    __setModuleDefault(result, mod);
+    return result;
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.IndexFileGenerator = void 0;
+const fs = __importStar(require("fs"));
+const glob = __importStar(require("glob"));
+const helpers_lib_1 = require("helpers-lib");
+const context_1 = require("../context");
+const file_content_generator_1 = require("../file-content-generator/file-content-generator");
+const START_COMMAND = '// ---- INDEX OUTPUT ----';
+const END_COMMAND = '// ---- END ----';
+class IndexFileGenerator {
+    static { this.premadeInterfaces = []; }
+    static { this.idTypes = []; }
+    static addPremadeInterface(value) {
+        this.premadeInterfaces.push(value);
+    }
+    static addIdType(constantName, keys) {
+        let value = `export type ${constantName}ID = ${keys.map(key => `'${key}'`).join(' | ')};`;
+        this.idTypes.push(value);
+    }
+    static async generateFile(pretext, outputIndexFile) {
+        if (context_1.Context.config.compilerModulesPath) {
+            let content = await this.generateFileDevMode(pretext);
+            if (content) {
+                await this.createIndexFile(content);
+            }
+        }
+        else {
+            await this.createIndexFile(outputIndexFile);
+        }
+    }
+    static async createIndexFile(outputIndexFile) {
+        let outputContent = outputIndexFile;
+        let typesContent = this.generateTypes();
+        if (typesContent) {
+            outputContent += '\n\n' + typesContent;
+        }
+        context_1.Context.output.push({
+            path: '/index.ts',
+            content: await file_content_generator_1.FileContentGenerator.format(outputContent)
+        });
+    }
+    static async generateFileDevMode(pretext) {
+        let fileUrls = glob.sync(`${context_1.Context.config.compilerModulesPath}/**/*.ts`).map(filePath => filePath.replace(/\\/g, '/'));
+        if (fileUrls.length === 0) {
+            helpers_lib_1.ConsoleHelper.log(`No typescript file found to generate index.ts file.`, 'red');
+        }
+        let exportsContent = this.generateExportsContent();
+        let interfacesContent = await this.generateInterfacesContent(fileUrls);
+        if (interfacesContent !== undefined) {
+            let output = `${pretext}\n${exportsContent}\n\n${interfacesContent}`;
+            output = await file_content_generator_1.FileContentGenerator.format(output);
+            fs.writeFileSync(`${context_1.Context.compilerExecutionPath}/output-index-file.ts`, `// AUTO GENERATED - CHANGES WILL BE REPLACED\nexport const OutputIndexFile = \`${output}\`;\n`);
+            helpers_lib_1.ConsoleHelper.log(`Index content 'output-index-file.ts' is generated.`, 'green');
+            return output;
+        }
+    }
+    static generateExportsContent() {
+        return context_1.Context.exports
+            .map(exportItem => `export { ${exportItem.variableName} } from '.${exportItem.path.substring(0, exportItem.path.lastIndexOf('.'))}';`)
+            .join('\n');
+    }
+    static async generateInterfacesContent(fileUrls) {
+        let errorCount = 0;
+        let outputs = [];
+        fileUrls.forEach(fileUrl => {
+            let fileName = fileUrl.substring(fileUrl.lastIndexOf('/') + 1, fileUrl.lastIndexOf('.'));
+            let fileContent = fs.readFileSync(fileUrl, 'utf-8');
+            try {
+                let output = this.getInterfacesFromFile(fileName, fileContent);
+                if (output) {
+                    outputs.push(output);
+                }
+            }
+            catch (error) {
+                errorCount++;
+                helpers_lib_1.ConsoleHelper.log(`Error parsing file: ${fileUrl}, error: '${error.message}'`, 'red');
+            }
+        });
+        let output = `//-------------------------- DEFINITIONS --------------------------\n`;
+        if (this.premadeInterfaces.length > 0) {
+            output += '// ---- premade ----';
+            output += this.premadeInterfaces.join('\n');
+            output += '\n\n';
+        }
+        output += outputs.join('\n');
+        return errorCount === 0 ? output : undefined;
+    }
+    static getInterfacesFromFile(fileName, fileContent) {
+        let index = fileContent.indexOf(START_COMMAND);
+        let definitionsFound = index !== -1;
+        let contents = [];
+        while (index !== -1) {
+            let endIndex = fileContent.indexOf(END_COMMAND, index);
+            if (endIndex === -1) {
+                throw new Error(`No end command found.`);
+            }
+            contents.push(fileContent.substring(fileContent.indexOf('\n', index + START_COMMAND.length) + 1, endIndex));
+            index = fileContent.indexOf(START_COMMAND, endIndex);
+        }
+        if (definitionsFound) {
+            return `// ---- ${fileName} ----\n${contents.join('\n')}`;
+        }
+    }
+    static generateTypes() {
+        let output = '';
+        if (this.idTypes.length > 0) {
+            output += `//-------------------------- ID TYPES --------------------------\n`;
+            output += this.idTypes.join('\n');
+            output += '\n';
+        }
+        return output;
+    }
+}
+exports.IndexFileGenerator = IndexFileGenerator;
+//# sourceMappingURL=index-file-generator.js.map

package/dist/framework/file-generators/types-file-generator.d.ts

@@ -0,0 +1,6 @@
+export declare class TypesFileGenerator {
+    private static idTypes;
+    static addIdType(constantName: string, keys: string[]): void;
+    static generateFile(pretext: string): Promise<void>;
+    private static generateContent;
+}

package/dist/framework/file-generators/types-file-generator.js

@@ -0,0 +1,35 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.TypesFileGenerator = void 0;
+const glob_1 = require("glob");
+const helpers_lib_1 = require("helpers-lib");
+const context_1 = require("../context");
+const file_content_generator_1 = require("../file-content-generator/file-content-generator");
+class TypesFileGenerator {
+    static { this.idTypes = []; }
+    static addIdType(constantName, keys) {
+        let value = `export type ${constantName}ID = ${keys.map(key => `'${key}'`).join(' | ')};`;
+        this.idTypes.push(value);
+    }
+    static async generateFile(pretext) {
+        let fileUrls = glob_1.glob.sync(`${context_1.Context.config.compilerModulesPath}/**/*.ts`).map(filePath => filePath.replace(/\\/g, '/'));
+        if (fileUrls.length === 0) {
+            helpers_lib_1.ConsoleHelper.log(`No typescript file found to generate index.ts file.`, 'red');
+        }
+        let output = this.generateContent();
+        context_1.Context.output.push({
+            path: '/types.ts',
+            content: await file_content_generator_1.FileContentGenerator.format(output)
+        });
+    }
+    static generateContent() {
+        let output = '';
+        if (this.idTypes.length > 0) {
+            output += `//-------------------------- ID TYPES --------------------------\n`;
+            output += this.idTypes.join('\n');
+        }
+        return output;
+    }
+}
+exports.TypesFileGenerator = TypesFileGenerator;
+//# sourceMappingURL=types-file-generator.js.map

package/dist/framework/interfaces.d.ts

@@ -9,7 +9,7 @@ export interface AddFileOptions {
     path: string;
     variableName: string;
     variable: any;
-    preText?: string;
+    preText?: string | string[];
     variableType?: string;
     replaceMap?: {
         target: string;

package/dist/framework/kernel.js

@@ -34,7 +34,7 @@ const _3_config_1 = require("../pipeline/3-config");
 const raw_data_parser_1 = require("../pipeline/raw-data-parser");
 const context_1 = require("./context");
 const definition_store_1 = require("./definition-store");
-const index_file_generator_1 = require("./index-file-generator/index-file-generator");
+const index_file_generator_1 = require("./file-generators/index-file-generator");
 const KeyValueRegex = /^[a-z]+([a-zA-Z0-9]+)*$/;
 const HeavySeperator = '======================================================';
 const LightSeperator = '------------------------------------------------------';
@@ -219,13 +219,17 @@ class Kernel {
         for (let preparedItem of preparedItems) {
             if (preparedItem.definitionToProcess) {
                 let module = new preparedItem.ModuleClass();
+                let keyName = preparedItem.ModuleClass.$meta.keyName;
+                if (keyName) {
+                    index_file_generator_1.IndexFileGenerator.addIdType(preparedItem.ModuleClass.$meta.pascalCaseComponentName, preparedItem.definitionToProcess.map((definition) => definition[keyName]));
+                }
                 await module.process(preparedItem.definitionToProcess, preparedItem.output);
             }
         }
         context_1.Context.flushErrorLogs(); // Still there might be some errors that customly added
         custom_validator_helper_1.CustomValidatorHelper.logDuplicates();
         if (context_1.Context.successful) {
-            index_file_generator_1.IndexFileGenerator.generateIndexFile(indexFilePretext, outputIndexFile);
+            await index_file_generator_1.IndexFileGenerator.generateFile(indexFilePretext, outputIndexFile);
         }
         return this.getOutputFiles();
     }

package/dist/index.d.ts

@@ -7,11 +7,11 @@ export { JoiCustomValidators } from './helpers/validator/joi-custom-validators';
 export { Validator } from './helpers/validator/validator';
 export * from './pre-made-components/_validators/shape-validators';
 export * from './pre-made-components/_validators/sprite-validators';
-export { SpriteComponent } from './pre-made-components/assets/1-sprite';
-export { SpriteGroupComponent } from './pre-made-components/assets/2-sprite-group';
-export { FontComponent } from './pre-made-components/assets/3-font';
-export { ScriptComponent } from './pre-made-components/events/1-script';
+export { SpriteComponent, SpriteID } from './pre-made-components/assets/1-sprite';
+export { SpriteGroupComponent, SpriteGroupID } from './pre-made-components/assets/2-sprite-group';
+export { FontComponent, FontID } from './pre-made-components/assets/3-font';
+export { ScriptComponent, ScriptID } from './pre-made-components/events/1-script';
 export { ScriptTestComponent } from './pre-made-components/events/2-script-test';
-export { EventComponent } from './pre-made-components/events/3-event';
+export { EventComponent, EventID } from './pre-made-components/events/3-event';
 export { EventTestComponent } from './pre-made-components/events/4-event-test';
 export { ScriptTesting } from './pre-made-components/events/scripting-setup';

package/dist/pre-made-components/assets/1-sprite.d.ts

@@ -2,6 +2,7 @@ import { Vec2 } from 'helpers-lib';
 import { DefinitionComponent } from '../../decorators/definition-component';
 import { Output } from '../../framework/interfaces';
 import { ValidatedSpriteUrl } from '../../helpers/validator/custom-validators/sprite.custom-validator';
+export type SpriteID = string;
 export interface RawSpriteDefinition {
     id: string;
     url: ValidatedSpriteUrl;

package/dist/pre-made-components/assets/2-sprite-group.d.ts

@@ -1,5 +1,6 @@
 import { DefinitionComponent } from '../../decorators/definition-component';
 import { Output } from '../../framework/interfaces';
+export type SpriteGroupID = string;
 interface SpriteGroupDefinition {
     id: string;
     group: string[];

package/dist/pre-made-components/assets/3-font.d.ts

@@ -1,12 +1,13 @@
 import { DefinitionComponent } from '../../decorators/definition-component';
 import { Output } from '../../framework/interfaces';
+export type FontID = string;
 interface RawFontDefinition {
     id: string;
     fontFamily: string;
     url: string;
 }
 export interface FontDefinition {
-    readonly id: string;
+    readonly id: FontID;
     readonly fontFamily: string;
 }
 export declare class FontComponent extends DefinitionComponent<RawFontDefinition> {

package/dist/pre-made-components/assets/3-font.js

@@ -16,7 +16,7 @@ exports.FontComponent = void 0;
 const helpers_lib_1 = require("helpers-lib");
 const joi_1 = __importDefault(require("joi"));
 const definition_component_1 = require("../../decorators/definition-component");
-const index_file_generator_1 = require("../../framework/index-file-generator/index-file-generator");
+const index_file_generator_1 = require("../../framework/file-generators/index-file-generator");
 const INDEX_ENTRY = `
 export interface FontDefinition {
   readonly id: string;

package/dist/pre-made-components/events/1-script.d.ts

@@ -1,6 +1,7 @@
 import { ScriptDefinition } from 'script-engine-lib';
 import { DefinitionComponent } from '../../decorators/definition-component';
 import { Output } from '../../framework/interfaces';
+export type ScriptID = string;
 export declare const ScriptNames: Set<string>;
 export declare class ScriptComponent extends DefinitionComponent<ScriptDefinition> {
     process(definitions: ScriptDefinition[], output: Output): Promise<void>;

package/dist/pre-made-components/events/3-event.d.ts

@@ -1,6 +1,7 @@
 import { ScriptDefinition } from 'script-engine-lib';
 import { DefinitionComponent } from '../../decorators/definition-component';
 import { Output } from '../../framework/interfaces';
+export type EventID = string;
 export declare class EventComponent extends DefinitionComponent<ScriptDefinition> {
     process(definitions: ScriptDefinition[], output: Output): Promise<void>;
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "definition-generator-framework",
-  "version": "1.12.12",
+  "version": "1.13.0",
   "description": "Definition Generator Framework",
   "main": "dist/index.js",
   "files": [