@ti-engine/core 1.8.1 → 1.9.1

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ti-engine/core",
-  "version": "1.8.1",
+  "version": "1.9.1",
   "description": "Microservice framework for Node.js: a Redis-backed message exchange with end-to-end call tracing, retries and tamper-evident message envelopes.",
   "keywords": [
     "microservices",
@@ -18,49 +18,161 @@
   "main": "./bin/start-instance.js",
   "type": "commonjs",
   "exports": {
-    ".": "./bin/start-instance.js",
-    "./cache": "./utils/cache.js",
-    "./exceptions": "./utils/exceptions.js",
-    "./localization": "./utils/localization.js",
-    "./logger": "./utils/logger.js",
-    "./service-consumer": "./components/service-consumer.js",
-    "./service-instance": "./components/service-instance.js",
-    "./service-provider": "./components/service-provider.js",
-    "./tools": "./utils/tools.js"
+    ".": {
+      "types": "./types/bin/start-instance.d.ts",
+      "default": "./bin/start-instance.js"
+    },
+    "./cache": {
+      "types": "./types/utils/cache.d.ts",
+      "default": "./utils/cache.js"
+    },
+    "./exceptions": {
+      "types": "./types/utils/exceptions.d.ts",
+      "default": "./utils/exceptions.js"
+    },
+    "./localization": {
+      "types": "./types/utils/localization.d.ts",
+      "default": "./utils/localization.js"
+    },
+    "./logger": {
+      "types": "./types/utils/logger.d.ts",
+      "default": "./utils/logger.js"
+    },
+    "./service-consumer": {
+      "types": "./types/components/service-consumer.d.ts",
+      "default": "./components/service-consumer.js"
+    },
+    "./service-instance": {
+      "types": "./types/components/service-instance.d.ts",
+      "default": "./components/service-instance.js"
+    },
+    "./service-provider": {
+      "types": "./types/components/service-provider.d.ts",
+      "default": "./components/service-provider.js"
+    },
+    "./tools": {
+      "types": "./types/utils/tools.d.ts",
+      "default": "./utils/tools.js"
+    },
+    "./definitions": {
+      "types": "./types/components/definitions.types.d.ts",
+      "default": "./components/definitions.types.js"
+    }
   },
   "scripts": {
-    "test": "node --test"
+    "test": "node --test",
+    "build:types": "tsc -p tsconfig.types.json"
   },
   "imports": {
-    "#auditing": "./components/auditing.js",
-    "#cache": "./utils/cache.js",
-    "#config": "./utils/config.js",
-    "#connection-observer": "./components/connection-observer.js",
-    "#default-message-exchange": "./components/exchange/default/default-message-exchange.js",
-    "#default-message-receiver": "./components/exchange/default/default-message-receiver.js",
-    "#default-message-sender": "./components/exchange/default/default-message-sender.js",
-    "#exceptions": "./utils/exceptions.js",
+    "#auditing": {
+      "types": "./types/components/auditing.d.ts",
+      "default": "./components/auditing.js"
+    },
+    "#cache": {
+      "types": "./types/utils/cache.d.ts",
+      "default": "./utils/cache.js"
+    },
+    "#config": {
+      "types": "./types/utils/config.d.ts",
+      "default": "./utils/config.js"
+    },
+    "#connection-observer": {
+      "types": "./types/components/connection-observer.d.ts",
+      "default": "./components/connection-observer.js"
+    },
+    "#default-message-exchange": {
+      "types": "./types/components/exchange/default/default-message-exchange.d.ts",
+      "default": "./components/exchange/default/default-message-exchange.js"
+    },
+    "#default-message-receiver": {
+      "types": "./types/components/exchange/default/default-message-receiver.d.ts",
+      "default": "./components/exchange/default/default-message-receiver.js"
+    },
+    "#default-message-sender": {
+      "types": "./types/components/exchange/default/default-message-sender.d.ts",
+      "default": "./components/exchange/default/default-message-sender.js"
+    },
+    "#definitions": {
+      "types": "./types/components/definitions.types.d.ts",
+      "default": "./components/definitions.types.js"
+    },
+    "#exceptions": {
+      "types": "./types/utils/exceptions.d.ts",
+      "default": "./utils/exceptions.js"
+    },
     "#labels": "./bin/localization/labels.json",
-    "#localization": "./utils/localization.js",
-    "#logger": "./utils/logger.js",
-    "#message-dispatcher": "./components/exchange/message-dispatcher.js",
-    "#message-exchange": "./components/exchange/message-exchange.js",
-    "#message-handler": "./components/exchange/message-handler.js",
-    "#message-memory-cache": "./components/exchange/message-memory-cache.js",
-    "#message-observer": "./components/exchange/message-observer.js",
-    "#message-receiver": "./components/exchange/message-receiver.js",
-    "#message-sender": "./components/exchange/message-sender.js",
-    "#message-tracer": "./components/exchange/message-tracer.js",
-    "#redis-integration": "./integrations/redis-integration.js",
-    "#service-caller": "./components/service-caller.js",
-    "#service-consumer": "./components/service-consumer.js",
-    "#service-executor": "./components/service-executor.js",
-    "#service-instance": "./components/service-instance.js",
-    "#service-provider": "./components/service-provider.js",
+    "#localization": {
+      "types": "./types/utils/localization.d.ts",
+      "default": "./utils/localization.js"
+    },
+    "#logger": {
+      "types": "./types/utils/logger.d.ts",
+      "default": "./utils/logger.js"
+    },
+    "#message-dispatcher": {
+      "types": "./types/components/exchange/message-dispatcher.d.ts",
+      "default": "./components/exchange/message-dispatcher.js"
+    },
+    "#message-exchange": {
+      "types": "./types/components/exchange/message-exchange.d.ts",
+      "default": "./components/exchange/message-exchange.js"
+    },
+    "#message-handler": {
+      "types": "./types/components/exchange/message-handler.d.ts",
+      "default": "./components/exchange/message-handler.js"
+    },
+    "#message-memory-cache": {
+      "types": "./types/components/exchange/message-memory-cache.d.ts",
+      "default": "./components/exchange/message-memory-cache.js"
+    },
+    "#message-observer": {
+      "types": "./types/components/exchange/message-observer.d.ts",
+      "default": "./components/exchange/message-observer.js"
+    },
+    "#message-receiver": {
+      "types": "./types/components/exchange/message-receiver.d.ts",
+      "default": "./components/exchange/message-receiver.js"
+    },
+    "#message-sender": {
+      "types": "./types/components/exchange/message-sender.d.ts",
+      "default": "./components/exchange/message-sender.js"
+    },
+    "#message-tracer": {
+      "types": "./types/components/exchange/message-tracer.d.ts",
+      "default": "./components/exchange/message-tracer.js"
+    },
+    "#redis-integration": {
+      "types": "./types/integrations/redis-integration.d.ts",
+      "default": "./integrations/redis-integration.js"
+    },
+    "#service-caller": {
+      "types": "./types/components/service-caller.d.ts",
+      "default": "./components/service-caller.js"
+    },
+    "#service-consumer": {
+      "types": "./types/components/service-consumer.d.ts",
+      "default": "./components/service-consumer.js"
+    },
+    "#service-executor": {
+      "types": "./types/components/service-executor.d.ts",
+      "default": "./components/service-executor.js"
+    },
+    "#service-instance": {
+      "types": "./types/components/service-instance.d.ts",
+      "default": "./components/service-instance.js"
+    },
+    "#service-provider": {
+      "types": "./types/components/service-provider.d.ts",
+      "default": "./components/service-provider.js"
+    },
     "#settings": "./bin/settings.json",
-    "#tools": "./utils/tools.js"
+    "#tools": {
+      "types": "./types/utils/tools.d.ts",
+      "default": "./utils/tools.js"
+    }
   },
   "dependencies": {
+    "@types/node": "^24.10.1",
     "ioredis": "^6.0.0",
     "lodash": "^4.18.1",
     "node-schedule": "^2.1.1"
@@ -71,6 +183,7 @@
     "components/",
     "integrations/",
     "utils/",
+    "types/",
     "package.json",
     "README.md",
     "CHANGELOG.md",
@@ -87,5 +200,8 @@
   "homepage": "https://github.com/Belleal/ti-engine/tree/master/packages/core#readme",
   "engines": {
     "node": ">=20.12.0"
+  },
+  "devDependencies": {
+    "typescript": "^7.0.2"
   }
 }

package/types/bin/start-instance.d.ts

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

package/types/components/auditing.d.ts

@@ -0,0 +1,30 @@
+declare const _exported: Readonly<Auditing>;
+export { _exported as instance };
+import type { TiLogSeverity } from "#logger";
+/** @import { TiLogSeverity } from "#logger" */
+/**
+ * Used to create and/or return an Auditing System singleton instance.
+ *
+ * @class Auditing
+ * @singleton
+ * @public
+ */
+declare class Auditing {
+    #private;
+    /**
+     * @constructor
+     * @returns {Auditing}
+     */
+    constructor();
+    /**
+     * Used to generate a log entry and dispatch it to all enabled logging destinations.
+     *
+     * @method
+     * @param {string} message The primary log message.
+     * @param {TiLogSeverity} [severity=DEFAULT] The log severity level. If the current log filtering setting is higher than this then the log entry will be ignored.
+     * @param {string} [thread='main'] The logging thread to which the log entry belongs.
+     * @param {Object} [data={}] Optional JSON data containing details of the log entry.
+     * @public
+     */
+    log(message: string, severity?: TiLogSeverity, thread?: string, data?: Object): void;
+}

package/types/components/connection-observer.d.ts

@@ -0,0 +1,49 @@
+export = ConnectionObserver;
+/**
+ * An abstract class that allows the child class to observe and take action on various events related to external connections.
+ *
+ * @class ConnectionObserver
+ * @abstract
+ * @public
+ */
+declare class ConnectionObserver {
+    /**
+     * @constructor
+     * @throws {TiException.E_GEN_ABSTRACT_CLASS_INIT} If this class is instantiated directly.
+     */
+    constructor();
+    /**
+     * Needs to be invoked by the connection handler when the connection is disrupted.
+     * <br/>
+     * NOTE: Override this to add custom functionality.
+     *
+     * @method
+     * @param {string} identifier The identifier of the observed connection.
+     * @virtual
+     * @public
+     *
+     */
+    onConnectionDisrupted(identifier: string): void;
+    /**
+     * Needs to be invoked by the connection handler when the connection is recovered.
+     * <br/>
+     * NOTE: Override this to add custom functionality.
+     *
+     * @method
+     * @param {string} identifier The identifier of the observed connection.
+     * @virtual
+     * @public
+     */
+    onConnectionRecovered(identifier: string): void;
+    /**
+     * Needs to be invoked by the connection handler when the connection is irrevocably lost.
+     * <br/>
+     * NOTE: Override this to add custom functionality.
+     *
+     * @method
+     * @param {string} identifier The identifier of the observed connection.
+     * @virtual
+     * @public
+     */
+    onConnectionLost(identifier: string): void;
+}