definition-generator-framework 1.13.1 → 2.0.0-rc1

package/dist/index.d.mts

@@ -0,0 +1,204 @@
+import Joi from 'joi';
+import { Vec2, Vector } from 'helpers-lib';
+import { ScriptDefinition, ScriptTestActionDefinition, ScriptEngineSimulatorFunctions } from 'script-engine-lib';
+
+interface FileSystem {
+    existsSync: (path: string) => boolean;
+}
+interface AddFileOptions {
+    path: string;
+    variableName: string;
+    variable: any;
+    preText?: string | string[];
+    variableType?: string;
+    replaceMap?: {
+        target: string;
+        replace: string;
+    }[];
+    assetUrl?: string;
+}
+interface LocationInFile {
+    readonly path: string;
+    readonly line: number;
+}
+interface ErrorLog {
+    readonly description: string;
+    readonly location: LocationInFile;
+}
+type RawData = undefined | string | ParsedStructure[] | Record<string, ParsedStructure>;
+interface ParsedStructure {
+    readonly rawData: RawData;
+    readonly line: number;
+}
+interface RawDefinition {
+    readonly componentName: string;
+    readonly parsedStructure: ParsedStructure;
+    readonly location: LocationInFile;
+}
+interface Output {
+    addFile: (request: AddFileOptions) => Promise<void>;
+    addError: (errorLog: ErrorLog) => void;
+    convertLocationInFileToLink: (location: LocationInFile) => string;
+}
+
+type DefinitionComponentClassType<T> = new (...args: any[]) => DefinitionComponent<T> | SingleDefinitionComponent<T>;
+interface DefinitionComponentMeta {
+    componentName: string;
+    keyName?: string;
+    singleton?: boolean;
+    validationSchema: Joi.Schema;
+}
+declare function DefinitionComponentDecorator(meta: DefinitionComponentMeta): (ComponentClass: DefinitionComponentClassType<any>) => any;
+declare abstract class DefinitionComponent<T> {
+    static getSchema(): Joi.Schema;
+    abstract process(definitions: T[], context: Output): Promise<void>;
+}
+declare abstract class SingleDefinitionComponent<T> {
+    static getSchema(): Joi.Schema;
+    abstract process(definitions: T, context: Output): Promise<void>;
+}
+
+interface DefinitionGeneratorMeta {
+    modules: DefinitionComponentClassType<any>[];
+    indexFilePretext: string;
+    outputIndexFile: string;
+}
+declare function DefinitionGeneratorDecorator(meta: DefinitionGeneratorMeta): (ModuleClass: DefinitionGeneratorClassType) => any;
+type DefinitionGeneratorClassType = new (...args: any[]) => DefinitionGenerator;
+declare abstract class DefinitionGenerator {
+}
+
+declare class DefinitionStore {
+    static getDefinitions<T>(definitionClass: DefinitionComponentClassType<T>): T[];
+    static getDefinition<T>(definitionClass: DefinitionComponentClassType<T>, key: string): T | undefined;
+    static getDefinitionOrFail<T>(definitionClass: DefinitionComponentClassType<T>, key: string): T;
+    static getSingletonDefinition<T>(definitionClass: DefinitionComponentClassType<T>): T | undefined;
+    static getSingletonDefinitionOrFail<T>(definitionClass: DefinitionComponentClassType<T>): T;
+    static getLocationInFile<T>(definitionClass: DefinitionComponentClassType<T>, definition: T, path: readonly string[]): LocationInFile;
+    static getLocationInFileById<T>(definitionClass: DefinitionComponentClassType<T>, key: string, path: readonly string[]): LocationInFile;
+}
+
+type SpriteID = string;
+interface RawSpriteDefinition {
+    id: string;
+    url: ValidatedSpriteUrl;
+    scale: number;
+    anchor: Vec2;
+    boundingShapes: Vec2[][];
+}
+declare class SpriteComponent extends DefinitionComponent<RawSpriteDefinition> {
+    process(definitions: RawSpriteDefinition[], output: Output): Promise<void>;
+}
+
+interface PositionOnSpriteValidationOptions {
+    selectSpriteDefinition: (value: any) => RawSpriteDefinition;
+    positionsJsonPath: string | string[];
+    includeRotationFromAnchor?: boolean;
+    checkIfPositionIsOnSprite?: boolean;
+}
+
+interface ReferenceCustomValidatorOptions {
+    additionalValidation?: Joi.Schema;
+}
+declare module 'joi' {
+    interface StringSchema {
+        unique(nameSpace: Set<string>): Joi.StringSchema;
+        path(): Joi.StringSchema;
+        sprite(): Joi.StringSchema;
+        reference(definitionComponentClass: DefinitionComponentClassType<any> | DefinitionComponentClassType<any>[], options?: ReferenceCustomValidatorOptions): Joi.StringSchema;
+        lazyReference(componentName: string, options?: ReferenceCustomValidatorOptions): Joi.StringSchema;
+    }
+    interface ObjectSchema {
+        /**
+         * Converts the values to relative position from anchor on sprite.
+         */
+        positionOnSprite(options: PositionOnSpriteValidationOptions): Joi.ObjectSchema;
+    }
+}
+declare class JoiCustomValidators {
+    static decorate(joi: object, fs: FileSystem): void;
+}
+
+interface ValidatedSpriteUrl {
+    readonly url: string;
+    readonly size: Vec2;
+}
+
+interface ValidatedItem<T> {
+    readonly definition: T;
+    readonly rawDefinition: RawDefinition;
+}
+declare class Validator {
+    static definitionToRawDefintion: Map<any, RawDefinition>;
+    static getRawDefinitions(componentName: string): RawDefinition[];
+    static validateAndConvert<T>(componentName: string, schema: Joi.AnySchema): ValidatedItem<T>[];
+    static validateAndConvertSingular<T>(componentName: string, schema: Joi.AnySchema): ValidatedItem<T> | undefined;
+}
+
+declare const PoligonSchema: () => Joi.ArraySchema<Vec2[][]>;
+declare const Vec2Schema: () => Joi.ObjectSchema<Vec2>;
+declare const HexColorSchema: () => Joi.StringSchema;
+declare const RotationSchema: () => Joi.NumberSchema<number>;
+declare const FixedArraySchema: (itemSchema: Joi.ObjectSchema<any>, size: number) => Joi.ArraySchema;
+
+declare const PixelPerfectSpriteSchema: () => Joi.StringSchema;
+declare const SpriteSchema: (restrictions?: {
+    size?: Vector;
+    scale?: number;
+}) => Joi.StringSchema;
+
+type SpriteGroupID = string;
+interface SpriteGroupDefinition {
+    id: string;
+    group: string[];
+}
+declare class SpriteGroupComponent extends DefinitionComponent<SpriteGroupDefinition> {
+    process(definitions: SpriteGroupDefinition[], output: Output): Promise<void>;
+}
+
+type FontID = string;
+interface RawFontDefinition {
+    id: string;
+    fontFamily: string;
+    url: string;
+}
+declare class FontComponent extends DefinitionComponent<RawFontDefinition> {
+    constructor();
+    process(definitions: RawFontDefinition[], output: Output): Promise<void>;
+}
+
+type ScriptID = string;
+declare class ScriptComponent extends DefinitionComponent<ScriptDefinition> {
+    process(definitions: ScriptDefinition[], output: Output): Promise<void>;
+}
+
+interface ScriptTestCasesDefinition {
+    readonly actionsBeforeTesting: readonly ScriptTestActionDefinition[];
+}
+interface ScriptTestDefinition {
+    readonly script: string;
+    readonly cases: readonly ScriptTestCasesDefinition[];
+}
+
+declare class ScriptTestComponent extends DefinitionComponent<ScriptTestDefinition> {
+    process(definitions: ScriptTestDefinition[], output: Output): Promise<void>;
+}
+
+type EventID = string;
+declare class EventComponent extends DefinitionComponent<ScriptDefinition> {
+    process(definitions: ScriptDefinition[], output: Output): Promise<void>;
+}
+
+declare class EventTestComponent extends DefinitionComponent<ScriptTestDefinition> {
+    process(definitions: ScriptTestDefinition[], output: Output): Promise<void>;
+}
+
+declare class ScriptTesting<ScriptInputType, EventInputType> {
+    constructor(scriptSimulatorFunctionsConstructor: new (input: ScriptInputType) => ScriptEngineSimulatorFunctions, eventSimulatorFunctionsConstructor: new (input: EventInputType) => ScriptEngineSimulatorFunctions, richTextTags: Set<string> | undefined);
+    setScriptInput(scriptId: string, input: ScriptInputType): void;
+    setEventInput(eventId: string, input: EventInputType): void;
+    addCustomScriptTestCase(customMessage: string, scriptId: string, testCase: ScriptTestCasesDefinition): void;
+    addCustomEventTestCase(customMessage: string, eventId: string, testCase: ScriptTestCasesDefinition): void;
+}
+
+export { DefinitionComponent, type DefinitionComponentClassType, DefinitionComponentDecorator, DefinitionGenerator, DefinitionGeneratorDecorator, DefinitionStore, type ErrorLog, EventComponent, type EventID, EventTestComponent, FixedArraySchema, FontComponent, type FontID, HexColorSchema, JoiCustomValidators, type LocationInFile, type Output, PixelPerfectSpriteSchema, PoligonSchema, RotationSchema, ScriptComponent, type ScriptID, ScriptTestComponent, ScriptTesting, SingleDefinitionComponent, SpriteComponent, SpriteGroupComponent, type SpriteGroupID, type SpriteID, SpriteSchema, type ValidatedSpriteUrl, Validator, Vec2Schema };

package/dist/index.d.ts

@@ -1,17 +1,204 @@
-export { DefinitionComponent, DefinitionComponentClassType, DefinitionComponentDecorator, SingleDefinitionComponent } from './decorators/definition-component';
-export { DefinitionGenerator, DefinitionGeneratorDecorator } from './decorators/definition-generator';
-export { DefinitionStore } from './framework/definition-store';
-export { ErrorLog, LocationInFile, Output } from './framework/interfaces';
-export { ValidatedSpriteUrl } from './helpers/validator/custom-validators/sprite.custom-validator';
-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, 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, 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';
+import Joi from 'joi';
+import { Vec2, Vector } from 'helpers-lib';
+import { ScriptDefinition, ScriptTestActionDefinition, ScriptEngineSimulatorFunctions } from 'script-engine-lib';
+
+interface FileSystem {
+    existsSync: (path: string) => boolean;
+}
+interface AddFileOptions {
+    path: string;
+    variableName: string;
+    variable: any;
+    preText?: string | string[];
+    variableType?: string;
+    replaceMap?: {
+        target: string;
+        replace: string;
+    }[];
+    assetUrl?: string;
+}
+interface LocationInFile {
+    readonly path: string;
+    readonly line: number;
+}
+interface ErrorLog {
+    readonly description: string;
+    readonly location: LocationInFile;
+}
+type RawData = undefined | string | ParsedStructure[] | Record<string, ParsedStructure>;
+interface ParsedStructure {
+    readonly rawData: RawData;
+    readonly line: number;
+}
+interface RawDefinition {
+    readonly componentName: string;
+    readonly parsedStructure: ParsedStructure;
+    readonly location: LocationInFile;
+}
+interface Output {
+    addFile: (request: AddFileOptions) => Promise<void>;
+    addError: (errorLog: ErrorLog) => void;
+    convertLocationInFileToLink: (location: LocationInFile) => string;
+}
+
+type DefinitionComponentClassType<T> = new (...args: any[]) => DefinitionComponent<T> | SingleDefinitionComponent<T>;
+interface DefinitionComponentMeta {
+    componentName: string;
+    keyName?: string;
+    singleton?: boolean;
+    validationSchema: Joi.Schema;
+}
+declare function DefinitionComponentDecorator(meta: DefinitionComponentMeta): (ComponentClass: DefinitionComponentClassType<any>) => any;
+declare abstract class DefinitionComponent<T> {
+    static getSchema(): Joi.Schema;
+    abstract process(definitions: T[], context: Output): Promise<void>;
+}
+declare abstract class SingleDefinitionComponent<T> {
+    static getSchema(): Joi.Schema;
+    abstract process(definitions: T, context: Output): Promise<void>;
+}
+
+interface DefinitionGeneratorMeta {
+    modules: DefinitionComponentClassType<any>[];
+    indexFilePretext: string;
+    outputIndexFile: string;
+}
+declare function DefinitionGeneratorDecorator(meta: DefinitionGeneratorMeta): (ModuleClass: DefinitionGeneratorClassType) => any;
+type DefinitionGeneratorClassType = new (...args: any[]) => DefinitionGenerator;
+declare abstract class DefinitionGenerator {
+}
+
+declare class DefinitionStore {
+    static getDefinitions<T>(definitionClass: DefinitionComponentClassType<T>): T[];
+    static getDefinition<T>(definitionClass: DefinitionComponentClassType<T>, key: string): T | undefined;
+    static getDefinitionOrFail<T>(definitionClass: DefinitionComponentClassType<T>, key: string): T;
+    static getSingletonDefinition<T>(definitionClass: DefinitionComponentClassType<T>): T | undefined;
+    static getSingletonDefinitionOrFail<T>(definitionClass: DefinitionComponentClassType<T>): T;
+    static getLocationInFile<T>(definitionClass: DefinitionComponentClassType<T>, definition: T, path: readonly string[]): LocationInFile;
+    static getLocationInFileById<T>(definitionClass: DefinitionComponentClassType<T>, key: string, path: readonly string[]): LocationInFile;
+}
+
+type SpriteID = string;
+interface RawSpriteDefinition {
+    id: string;
+    url: ValidatedSpriteUrl;
+    scale: number;
+    anchor: Vec2;
+    boundingShapes: Vec2[][];
+}
+declare class SpriteComponent extends DefinitionComponent<RawSpriteDefinition> {
+    process(definitions: RawSpriteDefinition[], output: Output): Promise<void>;
+}
+
+interface PositionOnSpriteValidationOptions {
+    selectSpriteDefinition: (value: any) => RawSpriteDefinition;
+    positionsJsonPath: string | string[];
+    includeRotationFromAnchor?: boolean;
+    checkIfPositionIsOnSprite?: boolean;
+}
+
+interface ReferenceCustomValidatorOptions {
+    additionalValidation?: Joi.Schema;
+}
+declare module 'joi' {
+    interface StringSchema {
+        unique(nameSpace: Set<string>): Joi.StringSchema;
+        path(): Joi.StringSchema;
+        sprite(): Joi.StringSchema;
+        reference(definitionComponentClass: DefinitionComponentClassType<any> | DefinitionComponentClassType<any>[], options?: ReferenceCustomValidatorOptions): Joi.StringSchema;
+        lazyReference(componentName: string, options?: ReferenceCustomValidatorOptions): Joi.StringSchema;
+    }
+    interface ObjectSchema {
+        /**
+         * Converts the values to relative position from anchor on sprite.
+         */
+        positionOnSprite(options: PositionOnSpriteValidationOptions): Joi.ObjectSchema;
+    }
+}
+declare class JoiCustomValidators {
+    static decorate(joi: object, fs: FileSystem): void;
+}
+
+interface ValidatedSpriteUrl {
+    readonly url: string;
+    readonly size: Vec2;
+}
+
+interface ValidatedItem<T> {
+    readonly definition: T;
+    readonly rawDefinition: RawDefinition;
+}
+declare class Validator {
+    static definitionToRawDefintion: Map<any, RawDefinition>;
+    static getRawDefinitions(componentName: string): RawDefinition[];
+    static validateAndConvert<T>(componentName: string, schema: Joi.AnySchema): ValidatedItem<T>[];
+    static validateAndConvertSingular<T>(componentName: string, schema: Joi.AnySchema): ValidatedItem<T> | undefined;
+}
+
+declare const PoligonSchema: () => Joi.ArraySchema<Vec2[][]>;
+declare const Vec2Schema: () => Joi.ObjectSchema<Vec2>;
+declare const HexColorSchema: () => Joi.StringSchema;
+declare const RotationSchema: () => Joi.NumberSchema<number>;
+declare const FixedArraySchema: (itemSchema: Joi.ObjectSchema<any>, size: number) => Joi.ArraySchema;
+
+declare const PixelPerfectSpriteSchema: () => Joi.StringSchema;
+declare const SpriteSchema: (restrictions?: {
+    size?: Vector;
+    scale?: number;
+}) => Joi.StringSchema;
+
+type SpriteGroupID = string;
+interface SpriteGroupDefinition {
+    id: string;
+    group: string[];
+}
+declare class SpriteGroupComponent extends DefinitionComponent<SpriteGroupDefinition> {
+    process(definitions: SpriteGroupDefinition[], output: Output): Promise<void>;
+}
+
+type FontID = string;
+interface RawFontDefinition {
+    id: string;
+    fontFamily: string;
+    url: string;
+}
+declare class FontComponent extends DefinitionComponent<RawFontDefinition> {
+    constructor();
+    process(definitions: RawFontDefinition[], output: Output): Promise<void>;
+}
+
+type ScriptID = string;
+declare class ScriptComponent extends DefinitionComponent<ScriptDefinition> {
+    process(definitions: ScriptDefinition[], output: Output): Promise<void>;
+}
+
+interface ScriptTestCasesDefinition {
+    readonly actionsBeforeTesting: readonly ScriptTestActionDefinition[];
+}
+interface ScriptTestDefinition {
+    readonly script: string;
+    readonly cases: readonly ScriptTestCasesDefinition[];
+}
+
+declare class ScriptTestComponent extends DefinitionComponent<ScriptTestDefinition> {
+    process(definitions: ScriptTestDefinition[], output: Output): Promise<void>;
+}
+
+type EventID = string;
+declare class EventComponent extends DefinitionComponent<ScriptDefinition> {
+    process(definitions: ScriptDefinition[], output: Output): Promise<void>;
+}
+
+declare class EventTestComponent extends DefinitionComponent<ScriptTestDefinition> {
+    process(definitions: ScriptTestDefinition[], output: Output): Promise<void>;
+}
+
+declare class ScriptTesting<ScriptInputType, EventInputType> {
+    constructor(scriptSimulatorFunctionsConstructor: new (input: ScriptInputType) => ScriptEngineSimulatorFunctions, eventSimulatorFunctionsConstructor: new (input: EventInputType) => ScriptEngineSimulatorFunctions, richTextTags: Set<string> | undefined);
+    setScriptInput(scriptId: string, input: ScriptInputType): void;
+    setEventInput(eventId: string, input: EventInputType): void;
+    addCustomScriptTestCase(customMessage: string, scriptId: string, testCase: ScriptTestCasesDefinition): void;
+    addCustomEventTestCase(customMessage: string, eventId: string, testCase: ScriptTestCasesDefinition): void;
+}
+
+export { DefinitionComponent, type DefinitionComponentClassType, DefinitionComponentDecorator, DefinitionGenerator, DefinitionGeneratorDecorator, DefinitionStore, type ErrorLog, EventComponent, type EventID, EventTestComponent, FixedArraySchema, FontComponent, type FontID, HexColorSchema, JoiCustomValidators, type LocationInFile, type Output, PixelPerfectSpriteSchema, PoligonSchema, RotationSchema, ScriptComponent, type ScriptID, ScriptTestComponent, ScriptTesting, SingleDefinitionComponent, SpriteComponent, SpriteGroupComponent, type SpriteGroupID, type SpriteID, SpriteSchema, type ValidatedSpriteUrl, Validator, Vec2Schema };