@magek/common 0.0.2 → 0.0.3

package/dist/concepts/register.d.ts

@@ -49,7 +49,7 @@ export declare class Register {
      *
      * @param {UUID} requestID - The ID of the current request
      * @param {Record<string, string>} responseHeaders - The response headers object. It can be changed by the user.
-     * @param {FlusherFunction} flusher - The provider-dependent function used to flush the events to the event store.
+     * @param {FlusherFunction} flusher - The runtime-dependent function used to flush the events to the event store.
      * @param {UserEnvelope} [currentUser] - The current user envelope, if available
      * @param {ContextEnvelope} [context] - The current context envelope, if available
      */
@@ -80,7 +80,7 @@ export declare class Register {
      */
     events(...events: Array<EventInterface | NotificationInterface>): Register;
     /**
-     * Flushes the accumulated events and commands to the event store using the provider-depdent flusher function.
+     * Flushes the accumulated events and commands to the event store using the runtime-dependent flusher function.
      * This method can be called from a command or event handler to force the persistion of the events
      * to the event store. After the events have been flushed, the eventList is cleared, so the same
      * register instance can be used to register more events.

package/dist/concepts/register.js

@@ -28,7 +28,7 @@ class Register {
      *
      * @param {UUID} requestID - The ID of the current request
      * @param {Record<string, string>} responseHeaders - The response headers object. It can be changed by the user.
-     * @param {FlusherFunction} flusher - The provider-dependent function used to flush the events to the event store.
+     * @param {FlusherFunction} flusher - The runtime-dependent function used to flush the events to the event store.
      * @param {UserEnvelope} [currentUser] - The current user envelope, if available
      * @param {ContextEnvelope} [context] - The current context envelope, if available
      */
@@ -69,7 +69,7 @@ class Register {
         return this;
     }
     /**
-     * Flushes the accumulated events and commands to the event store using the provider-depdent flusher function.
+     * Flushes the accumulated events and commands to the event store using the runtime-dependent flusher function.
      * This method can be called from a command or event handler to force the persistion of the events
      * to the event store. After the events have been flushed, the eventList is cleared, so the same
      * register instance can be used to register more events.

package/dist/config.d.ts

@@ -1,5 +1,5 @@
 import { CommandMetadata, DataMigrationMetadata, EntityInterface, EntityMetadata, EventHandlerInterface, EventMetadata, EventStreamConfiguration, GlobalErrorHandlerMetadata, NotificationMetadata, ProjectionMetadata, QueryMetadata, ReadModelInterface, ReadModelMetadata, ReducerMetadata, RoleMetadata, ScheduledCommandMetadata, SchemaMigrationMetadata, TokenVerifier } from './concepts';
-import { ProviderLibrary } from './provider';
+import { Runtime } from './runtime';
 import { EventStoreAdapter } from './event-store-adapter';
 import { ReadModelStoreAdapter } from './read-model-store-adapter';
 import { SessionStoreAdapter } from './session-store-adapter';
@@ -15,14 +15,13 @@ export declare class MagekConfig {
     logLevel: Level;
     logPrefix?: string;
     logger?: Logger;
-    private _provider?;
+    private _runtime?;
     eventStoreAdapter?: EventStoreAdapter;
     readModelStoreAdapter?: ReadModelStoreAdapter;
     sessionStoreAdapter?: SessionStoreAdapter;
     appName: string;
     assets?: Array<string>;
     defaultResponseHeaders: Record<string, string>;
-    injectable?: unknown;
     readonly subscriptions: {
         maxConnectionDurationInSeconds: number;
         maxDurationInSeconds: number;
@@ -88,8 +87,8 @@ export declare class MagekConfig {
     get thereAreRoles(): boolean;
     currentVersionFor(className: string): number;
     validate(): void;
-    get provider(): ProviderLibrary;
-    set provider(provider: ProviderLibrary);
+    get runtime(): Runtime;
+    set runtime(runtime: Runtime);
     get userProjectRootPath(): string;
     set userProjectRootPath(path: string);
     get eventStore(): EventStoreAdapter;

package/dist/config.js

@@ -120,13 +120,13 @@ class MagekConfig {
     validate() {
         this.validateAllMigrations();
     }
-    get provider() {
-        if (!this._provider)
-            throw new Error('It is required to set a valid provider runtime in your configuration files');
-        return this._provider;
+    get runtime() {
+        if (!this._runtime)
+            throw new Error('It is required to set a runtime implementation (graphQL, api, messaging, scheduled, sensor) in your configuration files');
+        return this._runtime;
     }
-    set provider(provider) {
-        this._provider = provider;
+    set runtime(runtime) {
+        this._runtime = runtime;
     }
     get userProjectRootPath() {
         if (!this._userProjectRootPath)

package/dist/envelope.d.ts

@@ -5,7 +5,7 @@ import { Class } from './typelevel';
 /**
  * An `Envelope` carries a command/event body together with the name
  * of its class. This is important information for the `Distributor` to
- * work. Each provider has to implement their own `Envelope`.
+ * work. Each runtime has to implement their own `Envelope`.
  */
 export interface Envelope {
     currentUser?: UserEnvelope;
@@ -167,7 +167,7 @@ export interface ContextEnvelope {
         headers: unknown;
         body: unknown;
     };
-    /** Provider-dependent raw request context object */
+    /** Runtime-dependent raw request context object */
     rawContext: unknown;
 }
 export type EventEnvelopeFromDatabase = EventEnvelope & {

package/dist/index.d.ts

@@ -22,7 +22,7 @@ export * from './instrumentation/trace-types';
 export * from './sensor/health-indicator-configuration';
 export * from './internal-info';
 export * from './stream-types';
-export * from './provider';
+export * from './runtime';
 export * from './event-store-adapter';
 export * from './read-model-store-adapter';
 export * from './session-store-adapter';

package/dist/index.js

@@ -25,7 +25,7 @@ tslib_1.__exportStar(require("./instrumentation/trace-types"), exports);
 tslib_1.__exportStar(require("./sensor/health-indicator-configuration"), exports);
 tslib_1.__exportStar(require("./internal-info"), exports);
 tslib_1.__exportStar(require("./stream-types"), exports);
-tslib_1.__exportStar(require("./provider"), exports);
+tslib_1.__exportStar(require("./runtime"), exports);
 tslib_1.__exportStar(require("./event-store-adapter"), exports);
 tslib_1.__exportStar(require("./read-model-store-adapter"), exports);
 tslib_1.__exportStar(require("./session-store-adapter"), exports);

package/dist/read-model-store-adapter.d.ts

@@ -25,7 +25,7 @@ export interface ReadModelStoreAdapter {
     fetch<TReadModel extends ReadModelInterface>(config: MagekConfig, readModelName: string, readModelID: UUID, sequenceKey?: SequenceKey): Promise<ReadOnlyNonEmptyArray<TReadModel> | undefined>;
     /**
      * Searches for read models based on specific parameters
-     * This method signature matches the original provider library interface
+     * This method signature matches the original runtime interface
      *
      * @param config - The Magek configuration object
      * @param readModelName - The name of the read model type

package/dist/{provider.d.ts → runtime.d.ts}

@@ -1,13 +1,16 @@
 import { MagekConfig } from './config';
 import { GraphQLRequestEnvelope, GraphQLRequestEnvelopeError, HealthEnvelope, ScheduledCommandEnvelope } from './envelope';
-export interface ProviderLibrary {
-    graphQL: ProviderGraphQLLibrary;
-    api: ProviderAPIHandling;
-    messaging: ProviderMessagingLibrary;
-    scheduled: ScheduledCommandsLibrary;
-    sensor: ProviderSensorLibrary;
+export interface Runtime {
+    graphQL: GraphQLRuntime;
+    api: APIRuntime;
+    messaging: MessagingRuntime;
+    scheduled: ScheduledRuntime;
+    sensor: SensorRuntime;
 }
-export interface ProviderMessagingLibrary {
+/**
+ * Runtime messaging adapter for pushing data to client connections.
+ */
+export interface MessagingRuntime {
     /**
      * Sends a message to a specific connection.
      *
@@ -18,7 +21,7 @@ export interface ProviderMessagingLibrary {
      */
     sendMessage(config: MagekConfig, connectionID: string, data: unknown): Promise<void>;
 }
-export interface ProviderSensorLibrary {
+export interface SensorRuntime {
     databaseEventsHealthDetails(config: MagekConfig): Promise<unknown>;
     databaseReadModelsHealthDetails(config: MagekConfig): Promise<unknown>;
     isDatabaseEventUp(config: MagekConfig): Promise<boolean>;
@@ -28,7 +31,7 @@ export interface ProviderSensorLibrary {
     graphQLFunctionUrl(config: MagekConfig): Promise<string>;
     rawRequestToHealthEnvelope(rawRequest: unknown): HealthEnvelope;
 }
-export interface ProviderGraphQLLibrary {
+export interface GraphQLRuntime {
     /**
      * Converts a raw GraphQL request to a `GraphQLRequestEnvelope` or a `GraphQLRequestEnvelopeError`.
      *
@@ -46,7 +49,7 @@ export interface ProviderGraphQLLibrary {
      */
     handleResult(result?: unknown, headers?: Record<string, string>): Promise<unknown>;
 }
-export interface ProviderAPIHandling {
+export interface APIRuntime {
     /**
      * Handles a successful API request by returning the response body.
      *
@@ -71,7 +74,7 @@ export interface ProviderAPIHandling {
      */
     healthRequestResult(body: unknown, isHealthy: boolean): Promise<unknown>;
 }
-export interface ScheduledCommandsLibrary {
+export interface ScheduledRuntime {
     /**
      * Converts a raw message into a `ScheduledCommandEnvelope`.
      *

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@magek/common",
-  "version": "0.0.2",
+  "version": "0.0.3",
   "description": "Contains Magek common helpers used by the core and provider packages",
   "keywords": [
     "framework-common-helpers"
@@ -33,11 +33,11 @@
     "uuid": "^13.0.0"
   },
   "devDependencies": {
-    "@magek/eslint-config": "^0.0.2",
+    "@magek/eslint-config": "^0.0.3",
     "@types/chai": "5.2.3",
     "@types/chai-as-promised": "8.0.2",
     "@types/mocha": "10.0.10",
-    "@types/node": "22.19.3",
+    "@types/node": "22.19.7",
     "@types/sinon": "21.0.0",
     "@types/sinon-chai": "4.0.0",
     "@types/uuid": "11.0.0",