definition-generator-framework 1.13.1 → 2.0.0-rc0

package/dist/pipeline/1-select-definitions.spec.js

@@ -1,140 +0,0 @@
-'use strict';
-Object.defineProperty(exports, '__esModule', { value: true });
-const _1_select_definitions_helper_1 = require('./1-select-definitions-helper');
-const mocks_1 = require('../_mocks/mocks');
-const custom_validator_helper_spec_1 = require('../helpers/validator/custom-validator-helper/custom-validator.helper.spec');
-const definition_store_1 = require('../framework/definition-store');
-definition_store_1.DefinitionStore['definitionsMap'].set(custom_validator_helper_spec_1.AssetComponentName, new Map());
-describe('SELECT DEFINITIONS HELPER', () => {
-  let selectDefinitionsHelper;
-  beforeEach(() => {
-    selectDefinitionsHelper = new _1_select_definitions_helper_1.SelectDefinitionsHelper();
-  });
-  test('should handle empty files', () => {
-    let content = ``;
-    let fileInfo = (0, mocks_1.getMockFileInfo)(content);
-    let result = selectDefinitionsHelper.process(fileInfo);
-    expect(result.definitionPlaneTexts).toStrictEqual([]);
-    expect(result.errorLogs).toStrictEqual([]);
-  });
-  test('should handle files without definitions', () => {
-    let content = `
-      Explanation
-
-      ### ASSET
-      Name: singular name
-      Path: path to file
-    `;
-    let fileInfo = (0, mocks_1.getMockFileInfo)(content);
-    let result = selectDefinitionsHelper.process(fileInfo);
-    expect(result.definitionPlaneTexts).toStrictEqual([]);
-    expect(result.errorLogs).toStrictEqual([]);
-  });
-  test('should select definitions', () => {
-    let content = `
-      # DEFINITIONS
-      ### ASSET
-      Name: test
-      Path: test.png
-    `;
-    let fileInfo = (0, mocks_1.getMockFileInfo)(content);
-    let result = selectDefinitionsHelper.process(fileInfo);
-    expect(result.definitionPlaneTexts).toStrictEqual([
-      {
-        type: 'ASSET',
-        content: ['      Name: test', '      Path: test.png'],
-        location: { line: 3, path: fileInfo.path }
-      }
-    ]);
-    expect(result.errorLogs).toStrictEqual([]);
-  });
-  test('should ignore comments', () => {
-    let content = `
-      # DEFINITIONS
-      ### ASSET
-      Name: test // comment
-      Path: test.png     // comment
-      // ----comment----\r
-    `;
-    let fileInfo = (0, mocks_1.getMockFileInfo)(content);
-    let result = selectDefinitionsHelper.process(fileInfo);
-    expect(result.definitionPlaneTexts).toStrictEqual([
-      {
-        type: 'ASSET',
-        content: ['      Name: test', '      Path: test.png'],
-        location: { line: 3, path: fileInfo.path }
-      }
-    ]);
-    expect(result.errorLogs).toStrictEqual([]);
-  });
-  test('should not allow empty definitions', () => {
-    let content = `
-      # DEFINITIONS
-      ### ASSET
-    `;
-    let fileInfo = (0, mocks_1.getMockFileInfo)(content);
-    let result = selectDefinitionsHelper.process(fileInfo);
-    expect(result.definitionPlaneTexts).toStrictEqual([]);
-    expect(result.errorLogs).toStrictEqual([
-      {
-        description: 'Definitions cannot be empty!',
-        location: { line: 3, path: fileInfo.path }
-      }
-    ]);
-  });
-  test('should not allow unknown definition header after the first valid definition', () => {
-    let content = `
-      # DEFINITIONS
-      ### ASSET
-      Name: test
-      Path: test.png
-
-      ### Some text
-      some text
-    `;
-    let fileInfo = (0, mocks_1.getMockFileInfo)(content);
-    let result = selectDefinitionsHelper.process(fileInfo);
-    expect(result.errorLogs).toStrictEqual([
-      {
-        description: 'Invalid definition header: "### Some text"',
-        location: { line: 7, path: fileInfo.path }
-      }
-    ]);
-  });
-  test('invalid definitions should not corrupt other definitions', () => {
-    let content = `
-      # DEFINITIONS
-      ### ASSET
-      Name: test
-      Path: test.png
-
-      ### Some text
-      some text
-
-      ### ASSET
-      Name: test2
-      Path: test2.png
-    `;
-    let fileInfo = (0, mocks_1.getMockFileInfo)(content);
-    let result = selectDefinitionsHelper.process(fileInfo);
-    expect(result.definitionPlaneTexts).toStrictEqual([
-      {
-        type: 'ASSET',
-        content: ['      Name: test', '      Path: test.png'],
-        location: { line: 3, path: fileInfo.path }
-      },
-      {
-        type: 'ASSET',
-        content: ['      Name: test2', '      Path: test2.png'],
-        location: { line: 10, path: fileInfo.path }
-      }
-    ]);
-    expect(result.errorLogs).toStrictEqual([
-      {
-        description: 'Invalid definition header: "### Some text"',
-        location: { line: 7, path: fileInfo.path }
-      }
-    ]);
-  });
-});
-//# sourceMappingURL=1-select-definitions.spec.js.map

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

@@ -1,11 +0,0 @@
-import { ErrorLog, LocationInFile, ParsedStructure, RawDefinition } from '../framework/interfaces';
-import { DefinitionPlaneText } from './1-select-definitions.helper';
-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/2-structure-parser.helper.js

@@ -1,70 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.StructureParserHelper = void 0;
-const array_parser_1 = require("./parsers/array-parser");
-const object_parser_1 = require("./parsers/object-parser");
-const primitive_parser_1 = require("./parsers/primitive-parser");
-var ParsedStructureType;
-(function (ParsedStructureType) {
-    ParsedStructureType["primitive"] = "primitive";
-    ParsedStructureType["array"] = "array";
-    ParsedStructureType["object"] = "object";
-})(ParsedStructureType || (ParsedStructureType = {}));
-class StructureParserHelper {
-    static getParsedStructure(content, location) {
-        let structureType = this.getStructureType(content[0]);
-        switch (structureType) {
-            case ParsedStructureType.object:
-                return object_parser_1.ObjectParser.parse(content, location);
-            case ParsedStructureType.array:
-                return array_parser_1.ArrayParser.parse(content, location);
-            case ParsedStructureType.primitive:
-                return primitive_parser_1.PrimitiveParser.parse(content, location);
-        }
-    }
-    static getStructureType(firstLine) {
-        if (firstLine.startsWith('-') && !firstLine.match(/^-?\d+(\.\d+)?$/)) {
-            return ParsedStructureType.array;
-        }
-        else if (firstLine.match(/^[\w]+:/)) {
-            return ParsedStructureType.object;
-        }
-        else {
-            return ParsedStructureType.primitive;
-        }
-    }
-    process(definitionPlaneTexts) {
-        let errorLogs = [];
-        let structuredDefinitions = definitionPlaneTexts
-            .map(definitionPlaneText => {
-            try {
-                if (definitionPlaneText.content.length) {
-                    let structuredDefinition = {
-                        componentName: definitionPlaneText.type,
-                        location: definitionPlaneText.location,
-                        parsedStructure: StructureParserHelper.getParsedStructure(definitionPlaneText.content, {
-                            line: definitionPlaneText.location.line + 1,
-                            path: definitionPlaneText.location.path
-                        })
-                    };
-                    return structuredDefinition;
-                }
-            }
-            catch (error) {
-                if (error?.description && error?.location) {
-                    errorLogs.push(error);
-                }
-                else {
-                    errorLogs.push({
-                        description: `Unexpected Error! Error: "${error}"`,
-                        location: definitionPlaneText.location
-                    });
-                }
-            }
-        })
-            .filter(item => item);
-        return { rawDefinitions: structuredDefinitions, errorLogs };
-    }
-}
-exports.StructureParserHelper = StructureParserHelper;
-//# sourceMappingURL=2-structure-parser.helper.js.map

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

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

package/dist/pipeline/2-structure-parser.helper.spec.js

@@ -1,280 +0,0 @@
-'use strict';
-Object.defineProperty(exports, '__esModule', { value: true });
-const _2_structure_parser_helper_1 = require('./2-structure-parser.helper');
-const mocks_1 = require('../_mocks/mocks');
-function getMockDefinitionPlaneText(content) {
-  return {
-    type: 'ASSET',
-    content,
-    location: mocks_1.SampleLocation1
-  };
-}
-function getBaseRawDefinition(definitionPlaneText, parsedStructure) {
-  return {
-    componentName: definitionPlaneText.type,
-    location: definitionPlaneText.location,
-    parsedStructure: parsedStructure
-  };
-}
-function getExpectedRawDefinition(expected, offset, definitionPlaneText) {
-  let rawDefinition = getBaseRawDefinition(definitionPlaneText, {
-    rawData: expected,
-    line: definitionPlaneText.location.line + offset
-  });
-  return rawDefinition;
-}
-describe('STRUCTURE PARSER HELPER', () => {
-  let structureParserHelper;
-  beforeEach(() => {
-    structureParserHelper = new _2_structure_parser_helper_1.StructureParserHelper();
-  });
-  describe('Primitive', () => {
-    test('empty content', () => {
-      let definitionPlaneText = getMockDefinitionPlaneText([]);
-      let result = structureParserHelper.process([definitionPlaneText]);
-      expect(result.rawDefinitions).toStrictEqual([]);
-      expect(result.errorLogs).toStrictEqual([]);
-    });
-    test('primitive string', () => {
-      let definitionPlaneText = getMockDefinitionPlaneText(['text']);
-      let result = structureParserHelper.process([definitionPlaneText]);
-      expect(result.rawDefinitions).toStrictEqual([getExpectedRawDefinition('text', 1, definitionPlaneText)]);
-      expect(result.errorLogs).toStrictEqual([]);
-    });
-    test('primitive quoted string', () => {
-      let definitionPlaneText = getMockDefinitionPlaneText(['"text with spaces"']);
-      let result = structureParserHelper.process([definitionPlaneText]);
-      expect(result.rawDefinitions).toStrictEqual([getExpectedRawDefinition('text with spaces', 1, definitionPlaneText)]);
-      expect(result.errorLogs).toStrictEqual([]);
-    });
-    it('primitive multiline string', () => {
-      let definitionPlaneText = getMockDefinitionPlaneText(['`', 'text text', 'text', '`']);
-      let result = structureParserHelper.process([definitionPlaneText]);
-      expect(result.rawDefinitions).toStrictEqual([getExpectedRawDefinition('text text\ntext', 1, definitionPlaneText)]);
-      expect(result.errorLogs).toStrictEqual([]);
-    });
-    test('primitive number', () => {
-      let definitionPlaneText = getMockDefinitionPlaneText(['123.123']);
-      let result = structureParserHelper.process([definitionPlaneText]);
-      expect(result.rawDefinitions).toStrictEqual([getExpectedRawDefinition('123.123', 1, definitionPlaneText)]);
-      expect(result.errorLogs).toStrictEqual([]);
-    });
-    test('primitive negative number', () => {
-      let definitionPlaneText = getMockDefinitionPlaneText(['-123.123']);
-      let result = structureParserHelper.process([definitionPlaneText]);
-      expect(result.rawDefinitions).toStrictEqual([getExpectedRawDefinition('-123.123', 1, definitionPlaneText)]);
-      expect(result.errorLogs).toStrictEqual([]);
-    });
-    test('primitive undefined', () => {
-      let definitionPlaneText = getMockDefinitionPlaneText(['undefined']);
-      let result = structureParserHelper.process([definitionPlaneText]);
-      expect(result.rawDefinitions).toStrictEqual([getExpectedRawDefinition(undefined, 1, definitionPlaneText)]);
-      expect(result.errorLogs).toStrictEqual([]);
-    });
-  });
-  describe('Array', () => {
-    it('basic', () => {
-      let definitionPlaneText = getMockDefinitionPlaneText(['- orange', '- banana']);
-      let result = structureParserHelper.process([definitionPlaneText]);
-      let expectedStructure = getBaseRawDefinition(definitionPlaneText, {
-        line: definitionPlaneText.location.line + 1,
-        rawData: [
-          {
-            line: definitionPlaneText.location.line + 1,
-            rawData: 'orange'
-          },
-          {
-            line: definitionPlaneText.location.line + 2,
-            rawData: 'banana'
-          }
-        ]
-      });
-      expect(result.rawDefinitions).toStrictEqual([expectedStructure]);
-      expect(result.errorLogs).toStrictEqual([]);
-    });
-    it('array contains array', () => {
-      let definitionPlaneText = getMockDefinitionPlaneText(['- - orange', '  - banana', '- - 1', '  - 2']);
-      let result = structureParserHelper.process([definitionPlaneText]);
-      let expectedStructure = getBaseRawDefinition(definitionPlaneText, {
-        line: definitionPlaneText.location.line + 1,
-        rawData: [
-          {
-            line: definitionPlaneText.location.line + 1,
-            rawData: [
-              {
-                line: definitionPlaneText.location.line + 1,
-                rawData: 'orange'
-              },
-              {
-                line: definitionPlaneText.location.line + 2,
-                rawData: 'banana'
-              }
-            ]
-          },
-          {
-            line: definitionPlaneText.location.line + 3,
-            rawData: [
-              {
-                line: definitionPlaneText.location.line + 3,
-                rawData: '1'
-              },
-              {
-                line: definitionPlaneText.location.line + 4,
-                rawData: '2'
-              }
-            ]
-          }
-        ]
-      });
-      expect(result.rawDefinitions).toStrictEqual([expectedStructure]);
-      expect(result.errorLogs).toStrictEqual([]);
-    });
-    it('array contains object', () => {
-      let definitionPlaneText = getMockDefinitionPlaneText(['- Name: arrow', '  Quantity: 4', '- Name: axe', '  Quantity: 1']);
-      let result = structureParserHelper.process([definitionPlaneText]);
-      let expectedStructure = getBaseRawDefinition(definitionPlaneText, {
-        line: definitionPlaneText.location.line + 1,
-        rawData: [
-          {
-            line: definitionPlaneText.location.line + 1,
-            rawData: {
-              name: {
-                line: definitionPlaneText.location.line + 1,
-                rawData: 'arrow'
-              },
-              quantity: {
-                line: definitionPlaneText.location.line + 2,
-                rawData: '4'
-              }
-            }
-          },
-          {
-            line: definitionPlaneText.location.line + 3,
-            rawData: {
-              name: {
-                line: definitionPlaneText.location.line + 3,
-                rawData: 'axe'
-              },
-              quantity: {
-                line: definitionPlaneText.location.line + 4,
-                rawData: '1'
-              }
-            }
-          }
-        ]
-      });
-      expect(result.rawDefinitions).toStrictEqual([expectedStructure]);
-      expect(result.errorLogs).toStrictEqual([]);
-    });
-  });
-  describe('Object', () => {
-    it('basic', () => {
-      let definitionPlaneText = getMockDefinitionPlaneText(['Name: axe', 'Quantity: 1']);
-      let result = structureParserHelper.process([definitionPlaneText]);
-      let expectedStructure = getBaseRawDefinition(definitionPlaneText, {
-        line: definitionPlaneText.location.line + 1,
-        rawData: {
-          name: {
-            line: definitionPlaneText.location.line + 1,
-            rawData: 'axe'
-          },
-          quantity: {
-            line: definitionPlaneText.location.line + 2,
-            rawData: '1'
-          }
-        }
-      });
-      expect(result.rawDefinitions).toStrictEqual([expectedStructure]);
-      expect(result.errorLogs).toStrictEqual([]);
-    });
-    it('object contains object', () => {
-      let definitionPlaneText = getMockDefinitionPlaneText([
-        'Attacker:',
-        '  Name: firstObjectName',
-        '  Age: 25',
-        'Defender:',
-        '  Name: secondObjectName',
-        '  Age: 35'
-      ]);
-      let result = structureParserHelper.process([definitionPlaneText]);
-      let expectedStructure = getBaseRawDefinition(definitionPlaneText, {
-        line: definitionPlaneText.location.line + 1,
-        rawData: {
-          attacker: {
-            line: definitionPlaneText.location.line + 1,
-            rawData: {
-              name: {
-                line: definitionPlaneText.location.line + 2,
-                rawData: 'firstObjectName'
-              },
-              age: {
-                line: definitionPlaneText.location.line + 3,
-                rawData: '25'
-              }
-            }
-          },
-          defender: {
-            line: definitionPlaneText.location.line + 4,
-            rawData: {
-              name: {
-                line: definitionPlaneText.location.line + 5,
-                rawData: 'secondObjectName'
-              },
-              age: {
-                line: definitionPlaneText.location.line + 6,
-                rawData: '35'
-              }
-            }
-          }
-        }
-      });
-      expect(result.rawDefinitions).toStrictEqual([expectedStructure]);
-      expect(result.errorLogs).toStrictEqual([]);
-    });
-    it('object contains array', () => {
-      let definitionPlaneText = getMockDefinitionPlaneText([
-        'Array1:',
-        '- apple',
-        '- orange',
-        'Array2:',
-        '- xWing',
-        '- tieFighter'
-      ]);
-      let result = structureParserHelper.process([definitionPlaneText]);
-      let expectedStructure = getBaseRawDefinition(definitionPlaneText, {
-        line: definitionPlaneText.location.line + 1,
-        rawData: {
-          array1: {
-            line: definitionPlaneText.location.line + 1,
-            rawData: [
-              {
-                line: definitionPlaneText.location.line + 2,
-                rawData: 'apple'
-              },
-              {
-                line: definitionPlaneText.location.line + 3,
-                rawData: 'orange'
-              }
-            ]
-          },
-          array2: {
-            line: definitionPlaneText.location.line + 4,
-            rawData: [
-              {
-                line: definitionPlaneText.location.line + 5,
-                rawData: 'xWing'
-              },
-              {
-                line: definitionPlaneText.location.line + 6,
-                rawData: 'tieFighter'
-              }
-            ]
-          }
-        }
-      });
-      expect(result.rawDefinitions).toStrictEqual([expectedStructure]);
-      expect(result.errorLogs).toStrictEqual([]);
-    });
-  });
-});
-//# sourceMappingURL=2-structure-parser.helper.spec.js.map

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

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