definition-generator-framework 1.12.4 → 1.12.6

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

@@ -1,250 +1,262 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
+'use strict';
+Object.defineProperty(exports, '__esModule', { value: true });
 exports.Const = void 0;
-const vitest_1 = require("vitest");
-const mocks_1 = require("../../_mocks/mocks");
-const context_1 = require("../../framework/context");
-const output_helper_1 = require("./output-helper");
+const vitest_1 = require('vitest');
+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'
-                }
-            }
-        ]
+      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 = {
+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'
-                }
-            }
-        ]
+      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 noTypeExpected = `export const ConstSample = { type: 'item' };
 `;
-let basicConstExpected = `export const ConstSample: string = 'basic';
+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 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' }
-      }
-    ]
-  }
-};
+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' }
+      }
+    ]
+  }
+};
 `;
 (0, vitest_1.describe)('Output Helper: Array Output', () => {
-    (0, vitest_1.test)('should handle empty array', async () => {
-        let output = await output_helper_1.OutputHelper.generateArrayOutput({ variableName: 'Groups', variableType: 'any[]', variable: [] });
-        (0, vitest_1.expect)(output).toStrictEqual(emptyArrayExpected);
+  (0, vitest_1.test)('should handle empty array', async () => {
+    let output = await output_helper_1.OutputHelper.generateArrayOutput({
+      variableName: 'Groups',
+      variableType: 'any[]',
+      variable: []
     });
-    (0, vitest_1.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 }
-            ]
-        });
-        (0, vitest_1.expect)(output).toStrictEqual(basicArrayExpected);
+    (0, vitest_1.expect)(output).toStrictEqual(emptyArrayExpected);
+  });
+  (0, vitest_1.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 }
+      ]
     });
-    (0, vitest_1.test)('should handle complex array', async () => {
-        let output = await output_helper_1.OutputHelper.generateArrayOutput({
-            variableName: 'Groups',
-            variableType: 'any[]',
-            variable: [complexObject]
-        });
-        (0, vitest_1.expect)(output).toStrictEqual(complexArrayExpected);
+    (0, vitest_1.expect)(output).toStrictEqual(basicArrayExpected);
+  });
+  (0, vitest_1.test)('should handle complex array', async () => {
+    let output = await output_helper_1.OutputHelper.generateArrayOutput({
+      variableName: 'Groups',
+      variableType: 'any[]',
+      variable: [complexObject]
     });
-    (0, vitest_1.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' }]
-        });
-        (0, vitest_1.expect)(output).toStrictEqual(complexArrayReplaceExpected);
+    (0, vitest_1.expect)(output).toStrictEqual(complexArrayExpected);
+  });
+  (0, vitest_1.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' }]
     });
+    (0, vitest_1.expect)(output).toStrictEqual(complexArrayReplaceExpected);
+  });
 });
 (0, vitest_1.describe)('Output Helper: Const Output', () => {
-    (0, vitest_1.test)('should handle no type', async () => {
-        let output = await output_helper_1.OutputHelper.generateOutput({ variableName: 'ConstSample', variable: { type: 'item' } });
-        (0, vitest_1.expect)(output).toStrictEqual(noTypeExpected);
-    });
-    (0, vitest_1.test)('should handle basic value', async () => {
-        let output = await output_helper_1.OutputHelper.generateOutput({ variableName: 'ConstSample', variableType: 'string', variable: 'basic' });
-        (0, vitest_1.expect)(output).toStrictEqual(basicConstExpected);
+  (0, vitest_1.test)('should handle no type', async () => {
+    let output = await output_helper_1.OutputHelper.generateOutput({ variableName: 'ConstSample', variable: { type: 'item' } });
+    (0, vitest_1.expect)(output).toStrictEqual(noTypeExpected);
+  });
+  (0, vitest_1.test)('should handle basic value', async () => {
+    let output = await output_helper_1.OutputHelper.generateOutput({
+      variableName: 'ConstSample',
+      variableType: 'string',
+      variable: 'basic'
     });
-    (0, vitest_1.test)('should handle complex object', async () => {
-        let output = await output_helper_1.OutputHelper.generateOutput({ variableName: 'ConstSample', variableType: 'any', variable: complexObject });
-        (0, vitest_1.expect)(output).toStrictEqual(complexConstExpected);
+    (0, vitest_1.expect)(output).toStrictEqual(basicConstExpected);
+  });
+  (0, vitest_1.test)('should handle complex object', async () => {
+    let output = await output_helper_1.OutputHelper.generateOutput({
+      variableName: 'ConstSample',
+      variableType: 'any',
+      variable: complexObject
     });
-    (0, vitest_1.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' }]
-        });
-        (0, vitest_1.expect)(output).toStrictEqual(complexConstReplaceExpected);
+    (0, vitest_1.expect)(output).toStrictEqual(complexConstExpected);
+  });
+  (0, vitest_1.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' }]
     });
+    (0, vitest_1.expect)(output).toStrictEqual(complexConstReplaceExpected);
+  });
 });
 (0, vitest_1.describe)('Output Helper: stringify', () => {
-    (0, vitest_1.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
-        });
-        (0, vitest_1.expect)(output).toStrictEqual('{"a":undefined,"b":undefined}');
+  (0, vitest_1.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
     });
+    (0, vitest_1.expect)(output).toStrictEqual('{"a":undefined,"b":undefined}');
+  });
 });
 (0, vitest_1.describe)('Output Helper: convertToRelativePath', () => {
-    (0, vitest_1.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);
-        (0, vitest_1.expect)(output).toStrictEqual(desired);
-    });
+  (0, vitest_1.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);
+    (0, vitest_1.expect)(output).toStrictEqual(desired);
+  });
 });
-//# sourceMappingURL=output-helper.test.js.map
+//# sourceMappingURL=output-helper.test.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,143 @@
+'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';