jitar 0.1.3 → 0.2.1

package/CHANGELOG.md

@@ -0,0 +1,49 @@
+
+# Changelog
+
+## 0.2.1 (December 02, 2022)
+
+Fixes:
+- \[[`fb04f99`](https://github.com/MaskingTechnology/jitar/commit/fb04f99)] Fixed error deserialization at gateway [basmasking](https://github.com/MaskingTechnology/jitar/pull/69)
+
+
+## 0.2.0 (November 18, 2022)
+
+New features:
+- \[[`0c115e1`](https://github.com/MaskingTechnology/jitar/commit/0c115e1)] Added binary data serialization [basmasking](https://github.com/MaskingTechnology/jitar/pull/56)
+- \[[`38b90da`](https://github.com/MaskingTechnology/jitar/commit/38b90da)] Added date serialization [basmasking](https://github.com/MaskingTechnology/jitar/pull/58)
+- \[[`b27f571`](https://github.com/MaskingTechnology/jitar/commit/b27f571)] Split jitar into multiple packages [basmasking](https://github.com/MaskingTechnology/jitar/pull/60)
+
+
+## 0.1.3 (November 11, 2022)
+
+Fixes:
+- \[[`4b7a8d0`](https://github.com/MaskingTechnology/jitar/commit/4b7a8d0)] Added release script and released to npm [basmasking](https://github.com/BasMasking)
+
+## 0.1.2 (November 11, 2022)
+
+New features:
+- \[[`a842fb0`](https://github.com/MaskingTechnology/jitar/commit/a842fb0)] Data type validation on RPC calls [Yusuf-YENICERI](https://github.com/MaskingTechnology/jitar/pull/44)
+- \[[`265a5f5`](https://github.com/MaskingTechnology/jitar/commit/265a5f5)] Asset protection (public/private assets) [basmasking](https://github.com/MaskingTechnology/jitar/pull/48)
+- \[[`0b0cf57`](https://github.com/MaskingTechnology/jitar/commit/0b0cf57)] Extended error handling [basmeeuwissen](https://github.com/MaskingTechnology/jitar/pull/53)
+- \[[`ec63abd`](https://github.com/MaskingTechnology/jitar/commit/ec63abd)] Fixed segment in startClient documentation [pvvliet](https://github.com/MaskingTechnology/jitar/pull/54)
+
+## 0.1.1 (October 28, 2022)
+
+Fixes:
+- Linting issues (typing, code improvements, etc.)
+- \[[`e85db81`](https://github.com/MaskingTechnology/jitar/commit/e85db81)] Extended deserialization data validation [petermasking](https://github.com/MaskingTechnology/jitar/pull/24)
+- \[[`468d92c`](https://github.com/MaskingTechnology/jitar/commit/468d92c)] Improved the client id generation and validation [petermasking](https://github.com/MaskingTechnology/jitar/pull/22)
+
+## 0.1.0 (October 21, 2022)
+
+New features:
+- Segmentation (configurable)
+- Orchestration (automatic)
+- Load belancing (round robin)
+- Access protection (public/private)
+- Multi-version (procedures)
+- Data transportation (serialization)
+- Error handling
+- Health checks
+- RPC API (HTTP)

package/dist/core/types/Component.d.ts

@@ -1,4 +1,4 @@
-declare type Component = {
+type Component = {
     name: string;
     source?: string;
 };

package/dist/core/types/FlexObject.d.ts

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

package/dist/core/types/Module.d.ts

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

package/dist/core/types/SegmentImplementation.d.ts

@@ -1,4 +1,4 @@
-declare type SegmentImplementation = {
+type SegmentImplementation = {
     access: string;
     version: string;
     executable: Function;

package/dist/core/types/SegmentModule.d.ts

@@ -1,5 +1,5 @@
 import SegmentProcedure from './SegmentProcedure.js';
-declare type SegmentModule = {
+type SegmentModule = {
     procedures: SegmentProcedure[];
 };
 export default SegmentModule;

package/dist/core/types/SegmentProcedure.d.ts

@@ -1,5 +1,5 @@
 import SegmentImplementation from './SegmentImplementation.js';
-declare type SegmentProcedure = {
+type SegmentProcedure = {
     module: string;
     name: string;
     implementations: SegmentImplementation[];

package/dist/lib.d.ts

@@ -1,4 +1,31 @@
 export { default as HealthCheck } from './runtime/interfaces/HealthCheck.js';
+export { default as Version } from './core/Version.js';
+export { default as ImplementationNotFound } from './core/errors/ImplementationNotFound.js';
+export { default as InvalidVersionNumber } from './core/errors/InvalidVersionNumber.js';
+export { default as MissingParameterValue } from './core/errors/MissingParameterValue.js';
+export { default as ProcedureNotFound } from './core/errors/ProcedureNotFound.js';
+export { default as UnknownParameter } from './core/errors/UnknownParameter.js';
+export { default as InvalidPropertyType } from './runtime/serialization/errors/InvalidPropertyType.js';
+export { default as FileNotFound } from './runtime/errors/FileNotFound.js';
+export { default as LocalRepository } from './runtime/LocalRepository.js';
+export { default as LocalNode } from './runtime/LocalNode.js';
+export { default as Proxy } from './runtime/Proxy.js';
+export { default as ValueSerializer } from './runtime/serialization/ValueSerializer.js';
+export { default as ClientId } from './runtime/ClientId.js';
+export { default as RemoteNode } from './runtime/RemoteNode.js';
+export { default as LocalGateway } from './runtime/LocalGateway.js';
+export { default as ProcedureContainer } from './runtime/interfaces/ProcedureContainer.js';
+export { default as FileManager } from './runtime/interfaces/FileManager.js';
+export { default as File } from './runtime/models/File.js';
+export { default as CacheBuilder } from './runtime/caching/CacheBuilder.js';
+export { default as Gateway } from './runtime/Gateway.js';
+export { default as Node } from './runtime/Node.js';
+export { default as NodeMonitor } from './runtime/NodeMonitor.js';
+export { default as RemoteGateway } from './runtime/RemoteGateway.js';
+export { default as Repository } from './runtime/Repository.js';
+export { default as Runtime } from './runtime/Runtime.js';
+export { default as RemoteRepository } from './runtime/RemoteRepository.js';
+export { default as ModuleImporter } from './runtime/types/ModuleImporter.js';
+export { default as ModuleLoader } from './runtime/utils/ModuleLoader.js';
 export * from './client.js';
-export * from './server.js';
 export * from './hooks.js';

package/dist/lib.js

@@ -1,3 +1,27 @@
+export { default as Version } from './core/Version.js';
+export { default as ImplementationNotFound } from './core/errors/ImplementationNotFound.js';
+export { default as InvalidVersionNumber } from './core/errors/InvalidVersionNumber.js';
+export { default as MissingParameterValue } from './core/errors/MissingParameterValue.js';
+export { default as ProcedureNotFound } from './core/errors/ProcedureNotFound.js';
+export { default as UnknownParameter } from './core/errors/UnknownParameter.js';
+export { default as InvalidPropertyType } from './runtime/serialization/errors/InvalidPropertyType.js';
+export { default as FileNotFound } from './runtime/errors/FileNotFound.js';
+export { default as LocalRepository } from './runtime/LocalRepository.js';
+export { default as LocalNode } from './runtime/LocalNode.js';
+export { default as Proxy } from './runtime/Proxy.js';
+export { default as ValueSerializer } from './runtime/serialization/ValueSerializer.js';
+export { default as ClientId } from './runtime/ClientId.js';
+export { default as RemoteNode } from './runtime/RemoteNode.js';
+export { default as LocalGateway } from './runtime/LocalGateway.js';
+export { default as File } from './runtime/models/File.js';
+export { default as CacheBuilder } from './runtime/caching/CacheBuilder.js';
+export { default as Gateway } from './runtime/Gateway.js';
+export { default as Node } from './runtime/Node.js';
+export { default as NodeMonitor } from './runtime/NodeMonitor.js';
+export { default as RemoteGateway } from './runtime/RemoteGateway.js';
+export { default as Repository } from './runtime/Repository.js';
+export { default as Runtime } from './runtime/Runtime.js';
+export { default as RemoteRepository } from './runtime/RemoteRepository.js';
+export { default as ModuleLoader } from './runtime/utils/ModuleLoader.js';
 export * from './client.js';
-export * from './server.js';
 export * from './hooks.js';

package/dist/runtime/LocalGateway.d.ts

@@ -1,6 +1,7 @@
 import Version from '../core/Version.js';
 import Gateway from './Gateway.js';
 import Node from './Node.js';
+import Repository from './Repository.js';
 export default class LocalGateway extends Gateway {
     #private;
     get nodes(): Node[];
@@ -8,5 +9,6 @@ export default class LocalGateway extends Gateway {
     hasProcedure(fqn: string): boolean;
     addNode(node: Node): Promise<void>;
     removeNode(node: Node): void;
+    setBaseUrl(repository: Repository): Promise<void>;
     run(fqn: string, version: Version, args: Map<string, unknown>): Promise<unknown>;
 }

package/dist/runtime/LocalGateway.js

@@ -1,6 +1,8 @@
 import ProcedureNotFound from '../core/errors/ProcedureNotFound.js';
 import Gateway from './Gateway.js';
 import NodeBalancer from './NodeBalancer.js';
+import ModuleLoader from './utils/ModuleLoader.js';
+const NO_SEGMENTS = [];
 export default class LocalGateway extends Gateway {
     #nodes = new Set();
     #balancers = new Map();
@@ -33,6 +35,11 @@ export default class LocalGateway extends Gateway {
             balancer.removeNode(node);
         }
     }
+    async setBaseUrl(repository) {
+        const clientId = await repository.registerClient(NO_SEGMENTS);
+        const moduleLocation = await repository.getModuleLocation(clientId);
+        ModuleLoader.setBaseUrl(moduleLocation);
+    }
     #getBalancer(fqn) {
         return this.#balancers.get(fqn);
     }

package/dist/runtime/caching/types/SegmentFile.d.ts

@@ -1,5 +1,5 @@
 import SegmentImports from './SegmentImports.js';
-declare type SegmentFile = {
+type SegmentFile = {
     [key: string]: SegmentImports;
 };
 export default SegmentFile;

package/dist/runtime/caching/types/SegmentImportProperties.d.ts

@@ -1,4 +1,4 @@
-declare type SegmentImportProperties = {
+type SegmentImportProperties = {
     as?: string;
     access?: string;
     version?: string;

package/dist/runtime/caching/types/SegmentImports.d.ts

@@ -1,5 +1,5 @@
 import SegmentImportProperties from './SegmentImportProperties.js';
-declare type SegmentImports = {
+type SegmentImports = {
     [key: string]: SegmentImportProperties;
 };
 export default SegmentImports;

package/dist/runtime/serialization/ArrayBufferSerializer.d.ts

@@ -0,0 +1,10 @@
+import Serializer from './interfaces/Serializer.js';
+import SerializedArrayBuffer from './types/SerializedArrayBuffer.js';
+import TypedArray from './types/TypedArray.js';
+declare class ArrayBufferSerializer implements Serializer {
+    #private;
+    serialize(data: TypedArray): SerializedArrayBuffer;
+    deserialize(object: SerializedArrayBuffer): Promise<TypedArray>;
+}
+declare const instance: ArrayBufferSerializer;
+export default instance;

package/dist/runtime/serialization/ArrayBufferSerializer.js

@@ -0,0 +1,54 @@
+import InvalidPropertyType from './errors/InvalidPropertyType.js';
+import ReflectionHelper from '../../core/reflection/ReflectionHelper.js';
+class ArrayBufferSerializer {
+    serialize(data) {
+        const type = data.constructor.name;
+        const view = new DataView(data.buffer);
+        const bytes = [];
+        for (let index = 0; index < view.byteLength; index++) {
+            bytes.push(view.getUint8(index));
+        }
+        const returnvalue = { serialized: true, name: 'ArrayBuffer', type: type, bytes: bytes };
+        return returnvalue;
+    }
+    async deserialize(object) {
+        this.#validateSerializedArrayBuffer(object);
+        const type = object.type;
+        const bytes = object.bytes;
+        const buffer = new ArrayBuffer(bytes.length);
+        const view = new DataView(buffer);
+        for (let index = 0; index < bytes.length; index++) {
+            view.setUint8(index, bytes[index]);
+        }
+        const clazz = globalThis[type];
+        return ReflectionHelper.createInstance(clazz, [buffer]);
+    }
+    #validateSerializedArrayBuffer(object) {
+        if ((object.bytes instanceof Array) === false) {
+            throw new InvalidPropertyType('ArrayBuffer', 'bytes', 'Array');
+        }
+        if (this.#isValidType(object.type) === false) {
+            throw new InvalidPropertyType('ArrayBuffer', 'type', 'TypedArray');
+        }
+    }
+    #isValidType(type) {
+        switch (type) {
+            case 'Int8Array':
+            case 'Uint8Array':
+            case 'Uint8ClampedArray':
+            case 'Int16Array':
+            case 'Uint16Array':
+            case 'Int32Array':
+            case 'Uint32Array':
+            case 'Float32Array':
+            case 'Float64Array':
+            case 'BigInt64Array':
+            case 'BigUint64Array':
+                return true;
+            default:
+                return false;
+        }
+    }
+}
+const instance = new ArrayBufferSerializer();
+export default instance;

package/dist/runtime/serialization/DateSerializer.d.ts

@@ -0,0 +1,9 @@
+import Serializer from './interfaces/Serializer.js';
+import SerializedDate from './types/SerializedDate.js';
+declare class DateSerializer implements Serializer {
+    #private;
+    serialize(date: Date): SerializedDate;
+    deserialize(serializedDate: SerializedDate): Promise<Date>;
+}
+declare const instance: DateSerializer;
+export default instance;

package/dist/runtime/serialization/DateSerializer.js

@@ -0,0 +1,21 @@
+import InvalidPropertyType from './errors/InvalidPropertyType.js';
+class DateSerializer {
+    serialize(date) {
+        return { serialized: true, name: 'Date', value: date.toISOString() };
+    }
+    async deserialize(serializedDate) {
+        this.#validateDate(serializedDate);
+        return new Date(serializedDate.value);
+    }
+    #validateDate(serializedDate) {
+        if (typeof serializedDate.value !== 'string') {
+            throw new InvalidPropertyType('date', 'value', 'string');
+        }
+        const date = Date.parse(serializedDate.value);
+        if (Number.isNaN(date)) {
+            throw new InvalidPropertyType('date', 'value', 'date');
+        }
+    }
+}
+const instance = new DateSerializer();
+export default instance;

package/dist/runtime/serialization/ValueSerializer.d.ts

@@ -1,5 +1,6 @@
 import Serializer from './interfaces/Serializer.js';
 declare class ValueSerializer implements Serializer {
+    #private;
     serialize(value: unknown): unknown;
     deserialize(value: unknown): Promise<unknown>;
 }

package/dist/runtime/serialization/ValueSerializer.js

@@ -1,12 +1,17 @@
 import ReflectionHelper from '../../core/reflection/ReflectionHelper.js';
+import ArrayBufferSerializer from './ArrayBufferSerializer.js';
 import ArraySerializer from './ArraySerializer.js';
 import ClassSerializer from './ClassSerializer.js';
 import MapSerializer from './MapSerializer.js';
 import ObjectSerializer from './ObjectSerializer.js';
 import SetSerializer from './SetSerializer.js';
+import DateSerializer from './DateSerializer.js';
 class ValueSerializer {
     serialize(value) {
-        if (value instanceof Array) {
+        if (this.#isTypedArray(value)) {
+            return ArrayBufferSerializer.serialize(value);
+        }
+        else if (value instanceof Array) {
             return ArraySerializer.serialize(value);
         }
         else if (value instanceof Map) {
@@ -15,6 +20,9 @@ class ValueSerializer {
         else if (value instanceof Set) {
             return SetSerializer.serialize(value);
         }
+        if (value instanceof Date) {
+            return DateSerializer.serialize(value);
+        }
         else if (value instanceof Error) {
             return ClassSerializer.serialize(value);
         }
@@ -38,9 +46,24 @@ class ValueSerializer {
         switch (value.name) {
             case 'Map': return await MapSerializer.deserialize(value);
             case 'Set': return await SetSerializer.deserialize(value);
+            case 'Date': return await DateSerializer.deserialize(value);
+            case 'ArrayBuffer': return await ArrayBufferSerializer.deserialize(value);
             default: return await ClassSerializer.deserialize(value);
         }
     }
+    #isTypedArray(value) {
+        return (value instanceof Int8Array)
+            || (value instanceof Uint8Array)
+            || (value instanceof Uint8ClampedArray)
+            || (value instanceof Int16Array)
+            || (value instanceof Uint16Array)
+            || (value instanceof Int32Array)
+            || (value instanceof Uint32Array)
+            || (value instanceof Float32Array)
+            || (value instanceof Float64Array)
+            || (value instanceof BigInt64Array)
+            || (value instanceof BigUint64Array);
+    }
 }
 const instance = new ValueSerializer();
 export default instance;

package/dist/runtime/serialization/types/SerializableObject.d.ts

@@ -1,3 +1,3 @@
 import FlexObject from '../../../core/types/FlexObject.js';
-declare type SerializableObject = FlexObject;
+type SerializableObject = FlexObject;
 export default SerializableObject;

package/dist/runtime/serialization/types/Serialized.d.ts

@@ -1,4 +1,4 @@
-declare type Serialized = {
+type Serialized = {
     serialized: boolean;
     name: string;
 };

package/dist/runtime/serialization/types/SerializedArrayBuffer.d.ts

@@ -0,0 +1,6 @@
+import Serialized from './Serialized.js';
+type SerializedArrayBuffer = Serialized & {
+    type: string;
+    bytes: number[];
+};
+export default SerializedArrayBuffer;

package/dist/runtime/serialization/types/SerializedArrayBuffer.js

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

package/dist/runtime/serialization/types/SerializedClass.d.ts

@@ -1,6 +1,6 @@
 import FlexObject from '../../../core/types/FlexObject.js';
 import Serialized from './Serialized.js';
-declare type SerializedClass = Serialized & {
+type SerializedClass = Serialized & {
     source: string | null;
     args: unknown[];
     fields: FlexObject;

package/dist/runtime/serialization/types/SerializedDate.d.ts

@@ -0,0 +1,5 @@
+import Serialized from './Serialized.js';
+type SerializedDate = Serialized & {
+    value: string;
+};
+export default SerializedDate;

package/dist/runtime/serialization/types/SerializedDate.js

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

package/dist/runtime/serialization/types/SerializedMap.d.ts

@@ -1,5 +1,5 @@
 import Serialized from './Serialized.js';
-declare type SerializedMap = Serialized & {
+type SerializedMap = Serialized & {
     entries: {
         keys: unknown[];
         values: unknown[];

package/dist/runtime/serialization/types/SerializedObject.d.ts

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

package/dist/runtime/serialization/types/SerializedSet.d.ts

@@ -1,5 +1,5 @@
 import Serialized from './Serialized.js';
-declare type SerializedSet = Serialized & {
+type SerializedSet = Serialized & {
     values: unknown[];
 };
 export default SerializedSet;

package/dist/runtime/serialization/types/TypedArray.d.ts

@@ -0,0 +1,2 @@
+type TypedArray = Int8Array | Uint8Array | Uint8ClampedArray | Int16Array | Uint16Array | Int32Array | Uint32Array | Float32Array | Float64Array;
+export default TypedArray;

package/dist/runtime/serialization/types/TypedArray.js

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

package/dist/runtime/types/JitarHooks.d.ts

@@ -1,5 +1,5 @@
 import Runtime from '../Runtime.js';
-declare type JitarHooks = {
+type JitarHooks = {
     setRuntime: (runtime: Runtime) => void;
     setDependencyLoader: (loader: Function) => void;
 };

package/dist/runtime/types/ModuleImporter.d.ts

@@ -1,3 +1,3 @@
 import Module from '../../core/types/Module.js';
-declare type ModuleImporter = (name: string) => Promise<Module>;
+type ModuleImporter = (name: string) => Promise<Module>;
 export default ModuleImporter;

package/dist/runtime/utils/ModuleLoader.js

@@ -11,7 +11,7 @@ export default class ModuleLoader {
     }
     static async load(url) {
         if (url.startsWith('/jitar')) {
-            url = `../../${url}`;
+            url = `../..${url}`;
         }
         if (_baseUrl !== undefined && url.startsWith(_baseUrl) === false) {
             url = UrlRewriter.addBase(url, _baseUrl);

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "jitar",
-    "version": "0.1.3",
+    "version": "0.2.1",
     "description": "Distributed runtime for JavaScript and TypeScript to chop monolithic applications into micros.",
     "author": "Masking Technology <info@masking.tech> (https://jitar.dev)",
     "license": "MIT",
@@ -10,7 +10,6 @@
     "exports": {
         ".": "./dist/lib.js",
         "./client.js": "./dist/client.js",
-        "./server.js": "./dist/server.js",
         "./hooks.js": "./dist/hooks.js"
     },
     "scripts": {
@@ -21,34 +20,17 @@
         "clean": "rm -rf dist build",
         "release": "npm run clean && npm run build && npm publish"
     },
-    "dependencies": {
-        "@overnightjs/core": "^1.7.6",
-        "class-transformer": "^0.5.1",
-        "class-validator": "^0.13.2",
-        "express": "^4.18.1",
-        "express-http-proxy": "^1.6.3",
-        "fs-extra": "^10.1.0",
-        "glob": "^8.0.3",
-        "glob-promise": "^5.0.0",
-        "mime-types": "^2.1.35",
-        "tslog": "^3.3.3",
-        "yargs": "^17.6.0"
-    },
+    "dependencies": {},
     "devDependencies": {
-        "@types/express": "^4.17.13",
-        "@types/express-http-proxy": "^1.6.3",
-        "@types/fs-extra": "^9.0.13",
-        "@types/jest": "^28.1.3",
-        "@types/mime-types": "^2.1.1",
-        "@types/yargs": "^17.0.13",
         "@typescript-eslint/eslint-plugin": "^5.29.0",
         "@typescript-eslint/parser": "^5.29.0",
+        "@types/jest": "^28.1.3",
         "eslint": "^8.18.0",
         "jest": "^28.1.3",
         "ts-jest": "^28.0.8"
     },
     "engines": {
-        "node": ">=18.7" 
+        "node": ">=18.7"
     },
     "repository": {
         "type": "git",

package/dist/server/JitarServer.d.ts

@@ -1,8 +0,0 @@
-import { Server as OvernightServer } from '@overnightjs/core';
-import HealthCheck from '../runtime/interfaces/HealthCheck.js';
-export default class JitarServer extends OvernightServer {
-    #private;
-    constructor();
-    start(): Promise<void>;
-    addHealthCheck(name: string, healthCheck: HealthCheck): void;
-}