definition-generator-framework 1.12.4 → 1.12.5

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

@@ -0,0 +1 @@
+export {};

package/dist/helpers/common-functions/common-functions.spec.js

@@ -0,0 +1,50 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const common_functions_1 = require("./common-functions");
+describe('COMMON FUNCTIONS', () => {
+    test('kabab case to camel case', () => {
+        expect(common_functions_1.CommonFunctions.kebabCaseToCamelCase('')).toEqual('');
+        expect(common_functions_1.CommonFunctions.kebabCaseToCamelCase('text')).toEqual('text');
+        expect(common_functions_1.CommonFunctions.kebabCaseToCamelCase('TEXT')).toEqual('text');
+        expect(common_functions_1.CommonFunctions.kebabCaseToCamelCase('text-asdf')).toEqual('textAsdf');
+        expect(common_functions_1.CommonFunctions.kebabCaseToCamelCase('TEXT-ASDF')).toEqual('textAsdf');
+    });
+    test('lower case first letter', () => {
+        expect(common_functions_1.CommonFunctions.lowerCaseFirstLetter('')).toEqual('');
+        expect(common_functions_1.CommonFunctions.lowerCaseFirstLetter('text')).toEqual('text');
+        expect(common_functions_1.CommonFunctions.lowerCaseFirstLetter(' ')).toEqual(' ');
+        expect(common_functions_1.CommonFunctions.lowerCaseFirstLetter('Text')).toEqual('text');
+        expect(common_functions_1.CommonFunctions.lowerCaseFirstLetter(' Text')).toEqual(' Text');
+    });
+    test('upper case first letter', () => {
+        expect(common_functions_1.CommonFunctions.upperCaseFirstLetter('')).toEqual('');
+        expect(common_functions_1.CommonFunctions.upperCaseFirstLetter('Text')).toEqual('Text');
+        expect(common_functions_1.CommonFunctions.upperCaseFirstLetter(' ')).toEqual(' ');
+        expect(common_functions_1.CommonFunctions.upperCaseFirstLetter('text')).toEqual('Text');
+        expect(common_functions_1.CommonFunctions.upperCaseFirstLetter(' text')).toEqual(' text');
+    });
+    test('remove whitespace', () => {
+        expect(common_functions_1.CommonFunctions.removeWhiteSpace('')).toEqual('');
+        expect(common_functions_1.CommonFunctions.removeWhiteSpace('text')).toEqual('text');
+        expect(common_functions_1.CommonFunctions.removeWhiteSpace('  text')).toEqual('text');
+        expect(common_functions_1.CommonFunctions.removeWhiteSpace('text  ')).toEqual('text');
+        expect(common_functions_1.CommonFunctions.removeWhiteSpace('text\n')).toEqual('text');
+        expect(common_functions_1.CommonFunctions.removeWhiteSpace('text\r')).toEqual('text');
+        expect(common_functions_1.CommonFunctions.removeWhiteSpace('text\r\n')).toEqual('text');
+        expect(common_functions_1.CommonFunctions.removeWhiteSpace('text//')).toEqual('text');
+        expect(common_functions_1.CommonFunctions.removeWhiteSpace('text //')).toEqual('text');
+        expect(common_functions_1.CommonFunctions.removeWhiteSpace('text // asdf')).toEqual('text');
+        expect(common_functions_1.CommonFunctions.removeWhiteSpace('text text')).toEqual('text text');
+        expect(common_functions_1.CommonFunctions.removeWhiteSpace('text    text')).toEqual('text text');
+    });
+    test('remove comments', () => {
+        expect(common_functions_1.CommonFunctions.removeComments('')).toEqual('');
+        expect(common_functions_1.CommonFunctions.removeComments('text')).toEqual('text');
+        expect(common_functions_1.CommonFunctions.removeComments('  text  ')).toEqual('  text');
+        expect(common_functions_1.CommonFunctions.removeComments('  text//')).toEqual('  text');
+        expect(common_functions_1.CommonFunctions.removeComments('  text //')).toEqual('  text');
+        expect(common_functions_1.CommonFunctions.removeComments('  text // asdf')).toEqual('  text');
+        expect(common_functions_1.CommonFunctions.removeComments('- Symbol: □             // Dirt\n')).toEqual('- Symbol: □');
+    });
+});
+//# sourceMappingURL=common-functions.spec.js.map

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

@@ -0,0 +1 @@
+export {};

package/dist/helpers/duplicate-helper/duplicate-helper.spec.js

@@ -0,0 +1,54 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const duplicate_helper_1 = require("./duplicate-helper");
+const mocks_1 = require("../../_mocks/mocks");
+const context_1 = require("../../framework/context");
+describe('Duplicate Helper', () => {
+    test('should handle single entry', () => {
+        (0, mocks_1.resetContext)();
+        let helper = new duplicate_helper_1.DuplicateHelper('ASSET: Name');
+        expect(helper.newEntry('identifier', mocks_1.SampleLocation1)).toBeTruthy();
+        helper.logDuplicateErrors();
+        expect(context_1.Context.errorLogs).toStrictEqual([]);
+    });
+    test('should detect duplicate', () => {
+        (0, mocks_1.resetContext)();
+        let helper = new duplicate_helper_1.DuplicateHelper('ASSET: Name');
+        expect(helper.newEntry('identifier', mocks_1.SampleLocation1)).toBeTruthy();
+        expect(helper.newEntry('identifier', mocks_1.SampleLocation2)).toBeFalsy();
+        helper.logDuplicateErrors();
+        expect(context_1.Context.errorLogs).toStrictEqual([
+            {
+                description: 'Value should be singular! Group: "ASSET: Name", Value: "identifier"',
+                location: mocks_1.SampleLocation1
+            },
+            {
+                description: 'Value should be singular! Group: "ASSET: Name", Value: "identifier"',
+                location: mocks_1.SampleLocation2
+            }
+        ]);
+    });
+    test('should detect multiple duplicate', () => {
+        (0, mocks_1.resetContext)();
+        let helper = new duplicate_helper_1.DuplicateHelper('ASSET: Name');
+        expect(helper.newEntry('identifier', mocks_1.SampleLocation1)).toBeTruthy();
+        expect(helper.newEntry('identifier', mocks_1.SampleLocation2)).toBeFalsy();
+        expect(helper.newEntry('identifier', mocks_1.SampleLocation3)).toBeFalsy();
+        helper.logDuplicateErrors();
+        expect(context_1.Context.errorLogs).toStrictEqual([
+            {
+                description: 'Value should be singular! Group: "ASSET: Name", Value: "identifier"',
+                location: mocks_1.SampleLocation1
+            },
+            {
+                description: 'Value should be singular! Group: "ASSET: Name", Value: "identifier"',
+                location: mocks_1.SampleLocation2
+            },
+            {
+                description: 'Value should be singular! Group: "ASSET: Name", Value: "identifier"',
+                location: mocks_1.SampleLocation3
+            }
+        ]);
+    });
+});
+//# sourceMappingURL=duplicate-helper.spec.js.map

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

@@ -0,0 +1,24 @@
+export declare const Const: {
+    type: string;
+    material: string;
+    maxQuantity: number;
+    mainHand: undefined;
+    offHand: undefined;
+    bothHands: {
+        imageOnCharacter: string;
+        parryDice: undefined;
+        attacks: {
+            actionIcon: string;
+            attackDices: string[];
+            range: string;
+            requiresSetup: boolean;
+            unparryable: boolean;
+            lowersQuantity: boolean;
+            projectileType: string;
+            sounds: {
+                hit: string;
+                pre: string;
+            };
+        }[];
+    };
+};

package/dist/helpers/output-helper/output-helper.spec.js

@@ -0,0 +1,249 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Const = void 0;
+const mocks_1 = require("../../_mocks/mocks");
+const context_1 = require("../../framework/context");
+const output_helper_1 = require("./output-helper");
+let complexObject = {
+    type: 'bow',
+    material: 'WoodenItemMaterial',
+    maxQuantity: 10,
+    mainHand: undefined,
+    offHand: undefined,
+    bothHands: {
+        imageOnCharacter: 'BodyPartImageNames',
+        parryDice: undefined,
+        attacks: [
+            {
+                actionIcon: 'AssetNames.characterActionBowAttack',
+                attackDices: ['DiceType.d6', 'DiceType.d6'],
+                range: 'WeaponRange.ranged',
+                requiresSetup: false,
+                unparryable: true,
+                lowersQuantity: true,
+                projectileType: 'ProjectileType.arrow',
+                sounds: {
+                    hit: 'AssetGroups.battleSoundArrowHit',
+                    pre: 'AssetGroups.battleSoundArrowShot'
+                }
+            }
+        ]
+    }
+};
+let emptyArrayExpected = `export const Groups: any[] = [];
+`;
+let basicArrayExpected = `export const Groups: any[] = [
+  { name: 'test1', source: './src/definitions-sample/images/test1.png' },
+  { name: 'test2', source: './src/definitions-sample/images/test2.png', pixelPerfectInteraction: true }
+];
+`;
+let complexArrayExpected = `export const Groups: any[] = [
+  {
+    type: 'bow',
+    material: 'WoodenItemMaterial',
+    maxQuantity: 10,
+    mainHand: undefined,
+    offHand: undefined,
+    bothHands: {
+      imageOnCharacter: 'BodyPartImageNames',
+      parryDice: undefined,
+      attacks: [
+        {
+          actionIcon: 'AssetNames.characterActionBowAttack',
+          attackDices: ['DiceType.d6', 'DiceType.d6'],
+          range: 'WeaponRange.ranged',
+          requiresSetup: false,
+          unparryable: true,
+          lowersQuantity: true,
+          projectileType: 'ProjectileType.arrow',
+          sounds: { hit: 'AssetGroups.battleSoundArrowHit', pre: 'AssetGroups.battleSoundArrowShot' }
+        }
+      ]
+    }
+  }
+];
+`;
+let complexArrayReplaceExpected = `export const Groups: any[] = [
+  {
+    type: 'bow',
+    material: 'WoodenItemMaterial',
+    maxQuantity: 10,
+    mainHand: undefined,
+    offHand: undefined,
+    bothHands: {
+      imageOnCharacter: 'BodyPartImageNames',
+      parryDice: undefined,
+      attacks: [
+        {
+          actionIcon: 'AssetNames.characterActionBowAttack',
+          attackDices: [DiceType.d6, DiceType.d6],
+          range: 'WeaponRange.ranged',
+          requiresSetup: false,
+          unparryable: true,
+          lowersQuantity: true,
+          projectileType: 'ProjectileType.arrow',
+          sounds: { hit: 'AssetGroups.battleSoundArrowHit', pre: 'AssetGroups.battleSoundArrowShot' }
+        }
+      ]
+    }
+  }
+];
+`;
+exports.Const = {
+    type: 'bow',
+    material: 'WoodenItemMaterial',
+    maxQuantity: 10,
+    mainHand: undefined,
+    offHand: undefined,
+    bothHands: {
+        imageOnCharacter: 'BodyPartImageNames',
+        parryDice: undefined,
+        attacks: [
+            {
+                actionIcon: 'AssetNames.characterActionBowAttack',
+                attackDices: ['DiceType.d6', 'DiceType.d6'],
+                range: 'WeaponRange.ranged',
+                requiresSetup: false,
+                unparryable: true,
+                lowersQuantity: true,
+                projectileType: 'ProjectileType.arrow',
+                sounds: {
+                    hit: 'AssetGroups.battleSoundArrowHit',
+                    pre: 'AssetGroups.battleSoundArrowShot'
+                }
+            }
+        ]
+    }
+};
+let noTypeExpected = `export const ConstSample = { type: 'item' };
+`;
+let basicConstExpected = `export const ConstSample: string = 'basic';
+`;
+let complexConstExpected = `export const ConstSample: any = {
+  type: 'bow',
+  material: 'WoodenItemMaterial',
+  maxQuantity: 10,
+  mainHand: undefined,
+  offHand: undefined,
+  bothHands: {
+    imageOnCharacter: 'BodyPartImageNames',
+    parryDice: undefined,
+    attacks: [
+      {
+        actionIcon: 'AssetNames.characterActionBowAttack',
+        attackDices: ['DiceType.d6', 'DiceType.d6'],
+        range: 'WeaponRange.ranged',
+        requiresSetup: false,
+        unparryable: true,
+        lowersQuantity: true,
+        projectileType: 'ProjectileType.arrow',
+        sounds: { hit: 'AssetGroups.battleSoundArrowHit', pre: 'AssetGroups.battleSoundArrowShot' }
+      }
+    ]
+  }
+};
+`;
+let complexConstReplaceExpected = `export const ConstSample: any = {
+  type: 'bow',
+  material: 'WoodenItemMaterial',
+  maxQuantity: 10,
+  mainHand: undefined,
+  offHand: undefined,
+  bothHands: {
+    imageOnCharacter: 'BodyPartImageNames',
+    parryDice: undefined,
+    attacks: [
+      {
+        actionIcon: 'AssetNames.characterActionBowAttack',
+        attackDices: ['DiceType.d6', 'DiceType.d6'],
+        range: WeaponRange,
+        requiresSetup: false,
+        unparryable: true,
+        lowersQuantity: true,
+        projectileType: 'ProjectileType.arrow',
+        sounds: { hit: 'AssetGroups.battleSoundArrowHit', pre: 'AssetGroups.battleSoundArrowShot' }
+      }
+    ]
+  }
+};
+`;
+describe('Output Helper: Array Output', () => {
+    test('should handle empty array', async () => {
+        let output = await output_helper_1.OutputHelper.generateArrayOutput({ variableName: 'Groups', variableType: 'any[]', variable: [] });
+        expect(output).toStrictEqual(emptyArrayExpected);
+    });
+    test('should handle basic array', async () => {
+        let output = await output_helper_1.OutputHelper.generateArrayOutput({
+            variableName: 'Groups',
+            variableType: 'any[]',
+            variable: [
+                { name: 'test1', source: './src/definitions-sample/images/test1.png' },
+                { name: 'test2', source: './src/definitions-sample/images/test2.png', pixelPerfectInteraction: true }
+            ]
+        });
+        expect(output).toStrictEqual(basicArrayExpected);
+    });
+    test('should handle complex array', async () => {
+        let output = await output_helper_1.OutputHelper.generateArrayOutput({
+            variableName: 'Groups',
+            variableType: 'any[]',
+            variable: [complexObject]
+        });
+        expect(output).toStrictEqual(complexArrayExpected);
+    });
+    test('should handle replacing complex array', async () => {
+        let output = await output_helper_1.OutputHelper.generateArrayOutput({
+            variableName: 'Groups',
+            variableType: 'any[]',
+            variable: [complexObject],
+            replaceMap: [{ target: `"DiceType.d6"`, replace: 'DiceType.d6' }]
+        });
+        expect(output).toStrictEqual(complexArrayReplaceExpected);
+    });
+});
+describe('Output Helper: Const Output', () => {
+    test('should handle no type', async () => {
+        let output = await output_helper_1.OutputHelper.generateOutput({ variableName: 'ConstSample', variable: { type: 'item' } });
+        expect(output).toStrictEqual(noTypeExpected);
+    });
+    test('should handle basic value', async () => {
+        let output = await output_helper_1.OutputHelper.generateOutput({ variableName: 'ConstSample', variableType: 'string', variable: 'basic' });
+        expect(output).toStrictEqual(basicConstExpected);
+    });
+    test('should handle complex object', async () => {
+        let output = await output_helper_1.OutputHelper.generateOutput({ variableName: 'ConstSample', variableType: 'any', variable: complexObject });
+        expect(output).toStrictEqual(complexConstExpected);
+    });
+    test('should handle replacing complex object', async () => {
+        let output = await output_helper_1.OutputHelper.generateOutput({
+            variableName: 'ConstSample',
+            variableType: 'any',
+            variable: complexObject,
+            replaceMap: [{ target: `"WeaponRange.ranged"`, replace: 'WeaponRange' }]
+        });
+        expect(output).toStrictEqual(complexConstReplaceExpected);
+    });
+});
+describe('Output Helper: stringify', () => {
+    test('should not lose properties with undefined or null value', async () => {
+        let output = await output_helper_1.OutputHelper['stringify']({
+            a: undefined,
+            // eslint-disable-next-line no-null/no-null
+            b: null
+        });
+        expect(output).toStrictEqual('{"a":undefined,"b":undefined}');
+    });
+});
+describe('Output Helper: convertToRelativePath', () => {
+    test('should convert to relative path', async () => {
+        (0, mocks_1.resetContext)();
+        context_1.Context.outputPath = 'D:/Projects/Game-Dev/Starfighter/Starfighter-Definitions-Generator/src/.asset-build';
+        context_1.Context.config.projectRoot = 'D:/Projects/Game-Dev/Starfighter/Starfighter-Definitions-Generator/';
+        let original = '.src/definitions-sample/images/nested/test2.png';
+        let desired = '../../../definitions-sample/images/nested/test2.png';
+        let filePath = '/0-global-definitions/assets/images.ts';
+        let output = output_helper_1.OutputHelper['convertToRelativePath'](filePath, original);
+        expect(output).toStrictEqual(desired);
+    });
+});
+//# sourceMappingURL=output-helper.spec.js.map

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

@@ -0,0 +1 @@
+export {};

package/dist/helpers/raw-definition-helper/raw-definition.helper.spec.js

@@ -0,0 +1,135 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const mocks_1 = require("../../_mocks/mocks");
+const raw_definition_helper_1 = require("./raw-definition.helper");
+const ComponentName = 'ASSET';
+describe('RAW DEFINITION HELPER', () => {
+    describe('Find Parsed Structure', () => {
+        test('nested definition', () => {
+            let rawDefinition = {
+                componentName: ComponentName,
+                location: mocks_1.SampleLocation1,
+                parsedStructure: {
+                    line: mocks_1.SampleLocation1.line + 1,
+                    rawData: {
+                        obj1: {
+                            line: mocks_1.SampleLocation1.line + 2,
+                            rawData: [
+                                {
+                                    line: mocks_1.SampleLocation1.line + 3,
+                                    rawData: {
+                                        obj2: {
+                                            line: mocks_1.SampleLocation1.line + 4,
+                                            rawData: 'test data'
+                                        }
+                                    }
+                                }
+                            ]
+                        }
+                    }
+                }
+            };
+            expect(raw_definition_helper_1.RawDefinitionHelper.findLine(rawDefinition, [])).toEqual(mocks_1.SampleLocation1.line + 1);
+            expect(raw_definition_helper_1.RawDefinitionHelper.findLine(rawDefinition, ['obj1'])).toEqual(mocks_1.SampleLocation1.line + 2);
+            expect(raw_definition_helper_1.RawDefinitionHelper.findLine(rawDefinition, ['obj1', 0])).toEqual(mocks_1.SampleLocation1.line + 3);
+            expect(raw_definition_helper_1.RawDefinitionHelper.findLine(rawDefinition, ['obj1', 0, 'obj2'])).toEqual(mocks_1.SampleLocation1.line + 4);
+            expect(raw_definition_helper_1.RawDefinitionHelper.findLine(rawDefinition, ['notExists'])).toEqual(mocks_1.SampleLocation1.line + 1);
+        });
+    });
+    describe('Flattening', () => {
+        test('primitive', () => {
+            let rawDefinition = {
+                componentName: ComponentName,
+                location: mocks_1.SampleLocation1,
+                parsedStructure: {
+                    line: 0,
+                    rawData: 'test'
+                }
+            };
+            let expected = 'test';
+            expect(raw_definition_helper_1.RawDefinitionHelper.flatten(rawDefinition)).toStrictEqual(expected);
+        });
+        test('array', () => {
+            let rawDefinition = {
+                componentName: ComponentName,
+                location: mocks_1.SampleLocation1,
+                parsedStructure: {
+                    line: 0,
+                    rawData: [
+                        {
+                            line: 0,
+                            rawData: [
+                                {
+                                    line: 0,
+                                    rawData: 'orange'
+                                },
+                                {
+                                    line: 0,
+                                    rawData: 'banana'
+                                }
+                            ]
+                        },
+                        {
+                            line: 0,
+                            rawData: [
+                                {
+                                    line: 0,
+                                    rawData: '1'
+                                },
+                                {
+                                    line: 0,
+                                    rawData: '2'
+                                }
+                            ]
+                        }
+                    ]
+                }
+            };
+            let expected = [
+                ['orange', 'banana'],
+                ['1', '2']
+            ];
+            expect(raw_definition_helper_1.RawDefinitionHelper.flatten(rawDefinition)).toStrictEqual(expected);
+        });
+        test('object', () => {
+            let rawDefinition = {
+                componentName: ComponentName,
+                location: mocks_1.SampleLocation1,
+                parsedStructure: {
+                    line: 0,
+                    rawData: {
+                        array1: {
+                            line: 0,
+                            rawData: [
+                                {
+                                    line: 0,
+                                    rawData: 'apple'
+                                },
+                                {
+                                    line: 0,
+                                    rawData: 'orange'
+                                }
+                            ]
+                        },
+                        array2: {
+                            line: 0,
+                            rawData: [
+                                {
+                                    line: 0,
+                                    rawData: 'xWing'
+                                },
+                                {
+                                    line: 0,
+                                    rawData: 'tieFighter'
+                                }
+                            ]
+                        }
+                    }
+                }
+            };
+            let expected = { array1: ['apple', 'orange'], array2: ['xWing', 'tieFighter'] };
+            expect(raw_definition_helper_1.RawDefinitionHelper.flatten(rawDefinition)).toStrictEqual(expected);
+        });
+    });
+});
+//# sourceMappingURL=raw-definition.helper.spec.js.map

package/dist/helpers/validator/custom-validator-helper/custom-validator.helper.spec.d.ts

@@ -0,0 +1 @@
+export declare const AssetComponentName = "ASSET";