jitar 0.1.0 → 0.1.2

package/src/core/Implementation.ts

@@ -1,53 +0,0 @@
-
-import MissingParameterValue from './errors/MissingParameterValue.js';
-import ReflectionParameter from './reflection/models/ReflectionParameter.js';
-import * as AccessLevel from './definitions/AccessLevel.js';
-import Version from './Version.js';
-
-export default class Implementation
-{
-    #version: Version;
-    #access: string;
-    #parameters: ReflectionParameter[];
-    #executable: Function;
-
-    constructor(version: Version, access: string, parameters: ReflectionParameter[], executable: Function)
-    {
-        this.#version = version;
-        this.#access = access;
-        this.#parameters = parameters;
-        this.#executable = executable;
-    }
-
-    get version() { return this.#version; }
-
-    get public() { return this.#access === AccessLevel.PUBLIC; }
-
-    get parameters() { return this.#parameters; }
-
-    async run(args: Map<string, unknown>): Promise<unknown>
-    {
-        const values = this.#extractParameterValues(args);
-
-        return await this.#executable.call(this.#executable, ...values);
-    }
-
-    #extractParameterValues(parameters: Map<string, unknown>): unknown[]
-    {
-        const values: unknown[] = [];
-
-        for (const parameter of this.#parameters)
-        {
-            const value = parameters.get(parameter.name);
-
-            if (value === undefined && parameter.isOptional === false)
-            {
-                throw new MissingParameterValue(parameter.name);
-            }
-
-            values.push(value);
-        }
-
-        return values;
-    }
-}

package/src/core/Procedure.ts

@@ -1,98 +0,0 @@
-
-import ImplementationNotFound from './errors/ImplementationNotFound.js';
-import Implementation from './Implementation.js';
-import FqnBuilder from './utils/FqnBuilder.js';
-import Version from './Version.js';
-
-export default class Procedure
-{
-    #module: string;
-    #name: string;
-    #fqn: string;
-    #implementations: Map<Version, Implementation> = new Map();
-    #latestImplementation?: Implementation;
-
-    constructor(module: string, name: string)
-    {
-        this.#module = module;
-        this.#name = name;
-
-        this.#fqn = FqnBuilder.build(module, name);
-    }
-
-    get module() { return this.#module; }
-
-    get name() { return this.#name; }
-
-    get fqn() { return this.#fqn; }
-
-    get public()
-    {
-        // If at least one implementation is public, the procedure is public
-        // Public procedures can be called from outside the segment
-
-        const implementations = [...this.#implementations.values()];
-
-        return implementations.some(implementation => implementation.public);
-    }
-
-    addImplementation(implementation: Implementation): void
-    {
-        this.#implementations.set(implementation.version, implementation);
-
-        if (this.#isNewLatestImplementation(implementation))
-        {
-            this.#latestImplementation = implementation;
-        }
-    }
-
-    #isNewLatestImplementation(implementation: Implementation): boolean
-    {
-        return this.#latestImplementation === undefined
-            || implementation.version.greater(this.#latestImplementation.version);
-    }
-
-    getImplementation(version: Version): Implementation | undefined
-    {
-        const selectedVersion = this.#selectAvailableVersion(version);
-
-        return this.#implementations.get(selectedVersion);
-    }
-
-    #selectAvailableVersion(version: Version): Version
-    {
-        let selectedVersion = Version.DEFAULT;
-
-        for (const implementationVersion of this.#implementations.keys())
-        {
-            if (implementationVersion.equals(version))
-            {
-                return implementationVersion;
-            }
-
-            if (implementationVersion.greater(version))
-            {
-                continue;
-            }
-
-            if (selectedVersion.less(implementationVersion))
-            {
-                selectedVersion = implementationVersion;
-            }
-        }
-
-        return selectedVersion;
-    }
-
-    async run(version: Version, args: Map<string, unknown>): Promise<unknown>
-    {
-        const implementation = this.getImplementation(version);
-
-        if (implementation === undefined)
-        {
-            throw new ImplementationNotFound(this.fqn, version.toString());
-        }
-
-        return implementation.run(args);
-    }
-}

package/src/core/Segment.ts

@@ -1,62 +0,0 @@
-
-import ErrorManager from './ErrorManager.js';
-import ProcedureNotFound from './errors/ProcedureNotFound.js';
-import Runner from './interfaces/Runner.js';
-import Procedure from './Procedure.js';
-import Version from './Version.js';
-
-export default class Segment implements Runner
-{
-    #id: string;
-    #procedures: Map<string, Procedure> = new Map();
-
-    constructor(id: string)
-    {
-        this.#id = id;
-    }
-
-    get id() { return this.#id; }
-
-    addProcedure(procedure: Procedure): void
-    {
-        this.#procedures.set(procedure.fqn, procedure);
-    }
-
-    hasProcedure(fqn: string): boolean
-    {
-        const procedure = this.getProcedure(fqn);
-
-        return procedure !== undefined;
-    }
-
-    getProcedure(fqn: string): Procedure | undefined
-    {
-        return this.#procedures.get(fqn);
-    }
-
-    getPublicProcedures()
-    {
-        const procedures = [...this.#procedures.values()];
-
-        return procedures.filter(procedure => procedure.public);
-    }
-
-    async run(fqn: string, version: Version, args: Map<string, unknown>): Promise<unknown>
-    {
-        const procedure = this.getProcedure(fqn);
-
-        if (procedure === undefined)
-        {
-            throw new ProcedureNotFound(fqn);
-        }
-
-        try
-        {
-            return await procedure.run(version, args);
-        }
-        catch (error: unknown)
-        {
-            throw ErrorManager.handle(error, fqn, version.toString());
-        }
-    }
-}

package/src/core/SegmentBuilder.ts

@@ -1,55 +0,0 @@
-
-import SegmentModule from './types/SegmentModule.js';
-import SegmentProcedure from './types/SegmentProcedure.js';
-import SegmentImplementation from './types/SegmentImplementation.js';
-
-import ReflectionHelper from './reflection/ReflectionHelper.js';
-
-import Implementation from './Implementation.js';
-import Procedure from './Procedure.js';
-import Segment from './Segment.js';
-import Version from './Version.js';
-
-export default class SegmentBuilder
-{
-    static build(id: string, module: SegmentModule): Segment
-    {
-        const segment = new Segment(id);
-
-        for (const definition of module.procedures)
-        {
-            const procedure = this.#buildProcedure(definition);
-
-            segment.addProcedure(procedure);
-        };
-
-        return segment;
-    }
-
-    static #buildProcedure(definition: SegmentProcedure): Procedure
-    {
-        const module = definition.module;
-        const name = definition.name;
-
-        const procedure = new Procedure(module, name);
-
-        for (const implementationDefinition of definition.implementations)
-        {
-            const implementation = this.#buildImplementation(implementationDefinition);
-
-            procedure.addImplementation(implementation);
-        }
-
-        return procedure;
-    }
-
-    static #buildImplementation(definition: SegmentImplementation): Implementation
-    {
-        const version = Version.parse(definition.version);
-        const access = definition.access;
-        const executable = definition.executable;
-        const parameters = ReflectionHelper.getFunctionParameters(executable);
-
-        return new Implementation(version, access, parameters, executable);
-    }
-}

package/src/core/Version.ts

@@ -1,68 +0,0 @@
-
-import InvalidVersionNumber from './errors/InvalidVersionNumber.js';
-
-export default class Version
-{
-    static get DEFAULT(): Version { return new Version(0, 0, 0); }
-
-    #major: number;
-    #minor: number;
-    #patch: number;
-
-    constructor(major = 0, minor = 0, patch = 0)
-    {
-        this.#major = major;
-        this.#minor = minor;
-        this.#patch = patch;
-    }
-
-    get major() { return this.#major; }
-
-    get minor() { return this.#minor; }
-
-    get patch() { return this.#patch; }
-
-    equals(version: Version): boolean
-    {
-        return this.#major === version.major
-            && this.#minor === version.minor
-            && this.#patch === version.patch;
-    }
-
-    greater(version: Version): boolean
-    {
-        if (this.#major !== version.major) return this.#major > version.major;
-        if (this.#minor !== version.minor) return this.#minor > version.minor;
-        if (this.#patch !== version.patch) return this.#patch > version.patch;
-
-        return false;
-    }
-
-    less(version: Version): boolean
-    {
-        if (this.#major !== version.major) return this.#major < version.major;
-        if (this.#minor !== version.minor) return this.#minor < version.minor;
-        if (this.#patch !== version.patch) return this.#patch < version.patch;
-
-        return false;
-    }
-
-    toString(): string
-    {
-        return `${this.#major}.${this.#minor}.${this.#patch}`;
-    }
-
-    static parse(number: string): Version
-    {
-        const parts = number.split('.');
-
-        switch (parts.length)
-        {
-            case 1: return new Version(Number.parseInt(parts[0]));
-            case 2: return new Version(Number.parseInt(parts[0]), Number.parseInt(parts[1]));
-            case 3: return new Version(Number.parseInt(parts[0]), Number.parseInt(parts[1]), Number.parseInt(parts[2]));
-
-            default: throw new InvalidVersionNumber(number);
-        }
-    }
-}

package/src/core/definitions/AccessLevel.ts

@@ -1,3 +0,0 @@
-
-export const PRIVATE = 'private';
-export const PUBLIC = 'public';

package/src/core/errors/ImplementationNotFound.ts

@@ -1,12 +0,0 @@
-
-import Component from '../types/Component.js';
-
-export default class ImplementationNotFound extends Error
-{
-    constructor(fqn: string, version: string)
-    {
-        super(`No implementation found for procedure '${fqn}' with version '${version}'`);
-    }
-}
-
-(ImplementationNotFound as Component).source = '/jitar/core/errors/ImplementationNotFound.js';

package/src/core/errors/InvalidVersionNumber.ts

@@ -1,12 +0,0 @@
-
-import Component from '../types/Component.js';
-
-export default class InvalidVersionNumber extends Error
-{
-    constructor(number: string)
-    {
-        super(`Invalid version number '${number}'`);
-    }
-}
-
-(InvalidVersionNumber as Component).source = '/jitar/core/errors/InvalidVersionNumber.js';

package/src/core/errors/MissingParameterValue.ts

@@ -1,12 +0,0 @@
-
-import Component from '../types/Component.js';
-
-export default class MissingParameterValue extends Error
-{
-    constructor(parameterName: string)
-    {
-        super(`Missing value for parameter '${parameterName}'`);
-    }
-}
-
-(MissingParameterValue as Component).source = '/jitar/core/errors/MissingParameterValue.js';

package/src/core/errors/NotImplemented.ts

@@ -1,12 +0,0 @@
-
-import Component from '../types/Component.js';
-
-export default class NotImplemented extends Error
-{
-    constructor()
-    {
-        super('Not implemented');
-    }
-}
-
-(NotImplemented as Component).source = '/jitar/core/errors/NotImplemented.js';

package/src/core/errors/ProcedureNotFound.ts

@@ -1,12 +0,0 @@
-
-import Component from '../types/Component.js';
-
-export default class ProcedureNotFound extends Error
-{
-    constructor(fqn: string)
-    {
-        super(`Procedure '${fqn}' not found`);
-    }
-}
-
-(ProcedureNotFound as Component).source = '/jitar/core/errors/ProcedureNotFound.js';

package/src/core/interfaces/Runner.ts

@@ -1,7 +0,0 @@
-
-import Version from '../Version.js';
-
-export default interface Runner
-{
-    run(fqn: string, version: Version, args: Map<string, unknown>): Promise<unknown>;
-}

package/src/core/reflection/ParameterParser.ts

@@ -1,74 +0,0 @@
-
-import ReflectionParameter from './models/ReflectionParameter.js';
-
-const STRIP_COMMENTS = /((\/\/.*$)|(\/\*[\s\S]*?\*\/))/mg;
-
-export default class ParameterParser
-{
-    static parse(code: string, functionIndicator: string): ReflectionParameter[]
-    {
-        const pureCode = this.#removeComments(code);
-        const parameterString = this.#extractParameterString(pureCode, functionIndicator);
-        const parameterList = this.#parseParamaterString(parameterString);
-
-        return parameterList.map(parameter => this.#extractParameter(parameter));
-    }
-
-    static #removeComments(code: string): string
-    {
-        return code.replace(STRIP_COMMENTS, '');
-    }
-
-    static #extractParameterString(code: string, functionIndicator: string): string
-    {
-        const indicatorPosition = code.indexOf(functionIndicator);
-
-        const bodyStart = code.indexOf('{', indicatorPosition);
-        const definition = code.substring(indicatorPosition, bodyStart).trim();
-
-        const startPosition = definition.indexOf('(') + 1;
-        const endPosition = definition.lastIndexOf(')', startPosition);
-
-        return definition.slice(startPosition, endPosition);
-    }
-
-    static #parseParamaterString(parameterString: string): string[]
-    {
-        const parameters: string[] = [];
-
-        let level = 0;
-        let buffer = '';
-
-        for (let character of parameterString)
-        {
-            switch (character)
-            {
-                case '(': level++; break;
-                case ')': level--; break;
-                case ',':
-                    if (level === 0)
-                    {
-                        parameters.push(buffer);
-                        character = '';
-                        buffer = '';
-                    }
-            }
-
-            buffer += character;
-        }
-
-        if (buffer !== '')
-        {
-            parameters.push(buffer);
-        }
-
-        return parameters;
-    }
-
-    static #extractParameter(parameter: string): ReflectionParameter
-    {
-        const [name, defaultValue] = parameter.split('=').map(part => part.trim());
-
-        return new ReflectionParameter(name, defaultValue);
-    }
-}

package/src/core/reflection/ReflectionHelper.ts

@@ -1,118 +0,0 @@
-
-import ReflectionField from './models/ReflectionField.js';
-import ReflectionParameter from './models/ReflectionParameter.js';
-import ParameterParser from './ParameterParser.js';
-
-const CONSTRUCTOR_NAME = 'constructor';
-const FUNCTION_NAME = 'function';
-
-export default class ReflectionHelper
-{
-    static createInstance(clazz: Function, args: unknown[] = []): object
-    {
-        // eslint-disable-next-line @typescript-eslint/no-explicit-any
-        return new (clazz as any)(...args);
-    }
-
-    static isClassObject(object: object): boolean
-    {
-        return object.constructor.toString().startsWith('class');
-    }
-
-    static getObjectClass(object: object): Function
-    {
-        return object.constructor;
-    }
-
-    static getParentClass(clazz: Function): Function
-    {
-        return Object.getPrototypeOf(clazz);
-    }
-
-    static getFields(clazz: Function): ReflectionField[]
-    {
-        const object = this.createInstance(clazz);
-        const publicFields = this.#getPublicFields(object);
-        const propertyFields = this.#getPropertyFields(clazz);
-
-        return [...publicFields, ...propertyFields];
-    }
-
-    static getObjectFields(object: object): ReflectionField[]
-    {
-        const clazz = this.getObjectClass(object);
-        const publicFields = this.#getPublicFields(object);
-        const propertyFields = this.#getPropertyFields(clazz);
-
-        return [...publicFields, ...propertyFields];
-    }
-
-    static #getPublicFields(object: object): ReflectionField[]
-    {
-        const fieldNames = Object.getOwnPropertyNames(object);
-
-        return fieldNames.map(fieldName => new ReflectionField(fieldName, true, true));
-    }
-
-    static #getPropertyFields(clazz: Function): ReflectionField[]
-    {
-        const methods = Object.getOwnPropertyDescriptors(clazz.prototype);
-
-        const fields = [];
-
-        for (const name in methods)
-        {
-            const description = methods[name];
-
-            const hasGetter = description.get !== undefined;
-            const hasSetter = description.set !== undefined;
-
-            if (hasGetter === false && hasSetter === false)
-            {
-                // This is not a property.
-
-                continue;
-            }
-
-            fields.push(new ReflectionField(name, hasGetter, hasSetter));
-        }
-
-        const parentClazz = this.getParentClass(clazz);
-
-        if (parentClazz.name !== '')
-        {
-            const parentFields = this.#getPropertyFields(parentClazz);
-
-            return [...fields, ...parentFields];
-        }
-
-        return fields;
-    }
-
-    static getConstructorParameters(clazz: Function): ReflectionParameter[]
-    {
-        const code = clazz.toString();
-        const hasConstructor = code.includes(CONSTRUCTOR_NAME);
-
-        if (hasConstructor === false)
-        {
-            const parentClazz = this.getParentClass(clazz);
-
-            if (parentClazz.name === '')
-            {
-                return [];
-            }
-
-            return this.getConstructorParameters(parentClazz);
-        }
-
-        return ParameterParser.parse(code, CONSTRUCTOR_NAME);
-    }
-
-    static getFunctionParameters(funktion: Function): ReflectionParameter[]
-    {
-        const code = funktion.toString();
-
-        return ParameterParser.parse(code, FUNCTION_NAME);
-    }
-}

package/src/core/reflection/models/ReflectionField.ts

@@ -1,22 +0,0 @@
-
-export default class ReflectionField
-{
-    #name: string;
-    #canGet: boolean;
-    #canSet: boolean;
-
-    constructor(name: string, canGet: boolean, canSet: boolean)
-    {
-        this.#name = name;
-        this.#canGet = canGet;
-        this.#canSet = canSet;
-    }
-
-    get name() { return this.#name; }
-
-    get canGet() { return this.#canGet; }
-
-    get canSet() { return this.#canSet; }
-
-    get canGetAndSet() { return this.#canGet && this.#canSet; }
-}

package/src/core/reflection/models/ReflectionParameter.ts

@@ -1,18 +0,0 @@
-
-export default class ReflectionParameter
-{
-    #name: string;
-    #defaultValue?: string;
-
-    constructor(name: string, defaultValue?: string)
-    {
-        this.#name = name;
-        this.#defaultValue = defaultValue;
-    }
-
-    get name() { return this.#name; }
-
-    get defaultValue() { return this.#defaultValue; }
-
-    get isOptional() { return this.#defaultValue !== undefined; }
-}

package/src/core/types/Component.ts

@@ -1,8 +0,0 @@
-
-type Component =
-    {
-        name: string;
-        source?: string;
-    }
-
-export default Component;

package/src/core/types/FlexObject.ts

@@ -1,4 +0,0 @@
-
-type FlexObject = { [key: string]: unknown };
-
-export default FlexObject;

package/src/core/types/Module.ts

@@ -1,6 +0,0 @@
-
-import FlexObject from './FlexObject.js';
-
-type Module = FlexObject;
-
-export default Module;

package/src/core/types/SegmentImplementation.ts

@@ -1,9 +0,0 @@
-
-type SegmentImplementation =
-    {
-        access: string;
-        version: string;
-        executable: Function;
-    }
-
-export default SegmentImplementation;