@magek/core 0.0.2 → 0.0.4

package/dist/graphql-dispatcher.js

@@ -25,19 +25,19 @@ class MagekGraphQLDispatcher {
     }
     async dispatch(request) {
         const logger = (0, common_1.getLogger)(this.config, 'MagekGraphQLDispatcher#dispatch');
-        const envelopeOrError = await this.config.provider.graphQL.rawToEnvelope(this.config, request);
+        const envelopeOrError = await this.config.runtime.graphQL.rawToEnvelope(this.config, request);
         logger.debug('Received the following GraphQL envelope: ', envelopeOrError);
         switch (envelopeOrError.eventType) {
             case 'CONNECT':
-                return this.config.provider.graphQL.handleResult(null, common_1.graphQLWebsocketSubprotocolHeaders);
+                return this.config.runtime.graphQL.handleResult(null, common_1.graphQLWebsocketSubprotocolHeaders);
             case 'MESSAGE':
                 const responseHeaders = { ...this.config.defaultResponseHeaders };
                 const result = await this.handleMessage(envelopeOrError, responseHeaders);
-                return this.config.provider.graphQL.handleResult(result, responseHeaders);
+                return this.config.runtime.graphQL.handleResult(result, responseHeaders);
             case 'DISCONNECT':
-                return this.config.provider.graphQL.handleResult(await this.handleDisconnect(envelopeOrError.connectionID));
+                return this.config.runtime.graphQL.handleResult(await this.handleDisconnect(envelopeOrError.connectionID));
             default:
-                return this.config.provider.graphQL.handleResult({
+                return this.config.runtime.graphQL.handleResult({
                     errors: [new Error(`Unknown message type ${envelopeOrError.eventType}`)],
                 });
         }

package/dist/index.d.ts

@@ -8,53 +8,52 @@ export { MagekTouchEntityHandler } from './touch-entity-handler';
 export * from './services/token-verifiers';
 export * from './instrumentation/index';
 export * from './decorators/health-sensor';
-export * as Injectable from './injectable';
 /**
  * Pushes a page of events to be processed by the event dispatcher.
  *
- * @param rawEvents A provider-specific representation of the events to be processed
+ * @param rawEvents A runtime-specific representation of the events to be processed
  * @returns A promise that resolves when the events are processed
  */
 export declare function eventDispatcher(rawEvents: unknown): Promise<void>;
 /**
  * Serves a GraphQL request. GraphQL resolvers can send response objects back to the client.
  *
- * @param rawRequest A provider-specific representation of the GraphQL request.
+ * @param rawRequest A runtime-specific representation of the GraphQL request.
  * @returns A promise that resolves to the GraphQL response.
  */
 export declare function graphQLDispatcher(rawRequest: unknown): Promise<unknown>;
 /**
  * Triggers pending scheduled commands. This function is meant to be called by a scheduler.
  *
- * @param rawRequest A provider-specific representation of the request to trigger scheduled commands
+ * @param rawRequest A runtime-specific representation of the request to trigger scheduled commands
  * @returns A promise that resolves when the scheduled commands are triggered
  */
 export declare function triggerScheduledCommands(rawRequest: unknown): Promise<void>;
 /**
  * Notifies subscribers of a new update on a read model
  *
- * @param rawRequest A provider-specific representation of the request to notify subscribers.
+ * @param rawRequest A runtime-specific representation of the request to notify subscribers.
  * @returns A promise that resolves when the subscribers are notified
  */
 export declare function notifySubscribers(rawRequest: unknown): Promise<void>;
 /**
  * Consumes events from the event stream and dispatches them to the event handlers
  *
- * @param rawEvent A provider-specific representation of the event to be processed
+ * @param rawEvent A runtime-specific representation of the event to be processed
  * @returns A promise that resolves when the event is processed
  */
 export declare function consumeEventStream(rawEvent: unknown): Promise<unknown>;
 /**
  * Produces events to the event stream
  *
- * @param rawEvent A provider-specific representation of the event to be produced
+ * @param rawEvent A runtime-specific representation of the event to be produced
  * @returns A promise that resolves when the event is produced
  */
 export declare function produceEventStream(rawEvent: unknown): Promise<unknown>;
 /**
  * Returns the health of the application
  *
- * @param request A provider-specific representation of the request to check the health
+ * @param request A runtime-specific representation of the request to check the health
  * @returns A promise that resolves to the health of the application
  */
 export declare function health(request: unknown): Promise<unknown>;

package/dist/index.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.Injectable = exports.MagekTouchEntityHandler = exports.MagekDataMigrationEntity = exports.MagekDataMigrationFinished = exports.MagekDataMigrations = exports.RegisterHandler = exports.Magek = void 0;
+exports.MagekTouchEntityHandler = exports.MagekDataMigrationEntity = exports.MagekDataMigrationFinished = exports.MagekDataMigrations = exports.RegisterHandler = exports.Magek = void 0;
 exports.eventDispatcher = eventDispatcher;
 exports.graphQLDispatcher = graphQLDispatcher;
 exports.triggerScheduledCommands = triggerScheduledCommands;
@@ -34,11 +34,10 @@ Object.defineProperty(exports, "MagekTouchEntityHandler", { enumerable: true, ge
 tslib_1.__exportStar(require("./services/token-verifiers"), exports);
 tslib_1.__exportStar(require("./instrumentation/index"), exports);
 tslib_1.__exportStar(require("./decorators/health-sensor"), exports);
-exports.Injectable = require("./injectable");
 /**
  * Pushes a page of events to be processed by the event dispatcher.
  *
- * @param rawEvents A provider-specific representation of the events to be processed
+ * @param rawEvents A runtime-specific representation of the events to be processed
  * @returns A promise that resolves when the events are processed
  */
 async function eventDispatcher(rawEvents) {
@@ -47,7 +46,7 @@ async function eventDispatcher(rawEvents) {
 /**
  * Serves a GraphQL request. GraphQL resolvers can send response objects back to the client.
  *
- * @param rawRequest A provider-specific representation of the GraphQL request.
+ * @param rawRequest A runtime-specific representation of the GraphQL request.
  * @returns A promise that resolves to the GraphQL response.
  */
 async function graphQLDispatcher(rawRequest) {
@@ -56,7 +55,7 @@ async function graphQLDispatcher(rawRequest) {
 /**
  * Triggers pending scheduled commands. This function is meant to be called by a scheduler.
  *
- * @param rawRequest A provider-specific representation of the request to trigger scheduled commands
+ * @param rawRequest A runtime-specific representation of the request to trigger scheduled commands
  * @returns A promise that resolves when the scheduled commands are triggered
  */
 async function triggerScheduledCommands(rawRequest) {
@@ -65,7 +64,7 @@ async function triggerScheduledCommands(rawRequest) {
 /**
  * Notifies subscribers of a new update on a read model
  *
- * @param rawRequest A provider-specific representation of the request to notify subscribers.
+ * @param rawRequest A runtime-specific representation of the request to notify subscribers.
  * @returns A promise that resolves when the subscribers are notified
  */
 async function notifySubscribers(rawRequest) {
@@ -74,7 +73,7 @@ async function notifySubscribers(rawRequest) {
 /**
  * Consumes events from the event stream and dispatches them to the event handlers
  *
- * @param rawEvent A provider-specific representation of the event to be processed
+ * @param rawEvent A runtime-specific representation of the event to be processed
  * @returns A promise that resolves when the event is processed
  */
 async function consumeEventStream(rawEvent) {
@@ -83,7 +82,7 @@ async function consumeEventStream(rawEvent) {
 /**
  * Produces events to the event stream
  *
- * @param rawEvent A provider-specific representation of the event to be produced
+ * @param rawEvent A runtime-specific representation of the event to be produced
  * @returns A promise that resolves when the event is produced
  */
 async function produceEventStream(rawEvent) {
@@ -92,7 +91,7 @@ async function produceEventStream(rawEvent) {
 /**
  * Returns the health of the application
  *
- * @param request A provider-specific representation of the request to check the health
+ * @param request A runtime-specific representation of the request to check the health
  * @returns A promise that resolves to the health of the application
  */
 async function health(request) {

package/dist/magek.d.ts

@@ -20,7 +20,6 @@ export declare class Magek {
      * Initializes the Magek project
      */
     static start(codeRootPath: string): void;
-    private static runInjectableCommands;
     /**
      * This function returns a "Searcher" configured to search instances of the read model class passed as param.
      * For more information, check the Searcher class.

package/dist/magek.js

@@ -13,7 +13,6 @@ const entity_touched_1 = require("./core-concepts/touch-entity/events/entity-tou
 const read_model_searcher_1 = require("./services/read-model-searcher");
 const delete_event_dispatcher_1 = require("./delete-event-dispatcher");
 const event_search_1 = require("./event-search");
-const core_1 = require("@oclif/core");
 /**
  * Main class to interact with Magek and configure it.
  * Sensible defaults are used whenever possible:
@@ -40,7 +39,6 @@ class Magek {
      * Initializes the Magek project
      */
     static start(codeRootPath) {
-        var _a;
         if (!this.config.eventStoreAdapter) {
             throw new Error('No eventStoreAdapter configured. Please add one in MagekConfig.');
         }
@@ -55,36 +53,6 @@ class Magek {
         importer_1.Importer.importUserProjectFiles(codeRootPath);
         this.configureMagekConcepts();
         this.config.validate();
-        const args = process.argv;
-        if (((_a = process.env['MAGEK_CLI_HOOK']) === null || _a === void 0 ? void 0 : _a.trim()) !== 'true') {
-            return;
-        }
-        const injectable = this.config.injectable;
-        if (injectable) {
-            const { commands } = injectable;
-            // Run the injectable CLI commands using oclif
-            this.runInjectableCommands(args, commands, projectRootPath).catch((error) => {
-                if (error instanceof core_1.Errors.ExitError) {
-                    process.exit(error.oclif.exit);
-                }
-                console.error(error);
-                process.exit(1);
-            });
-        }
-    }
-    static async runInjectableCommands(args, commands, projectRootPath) {
-        // Get the subcommand from args (skip node and script path)
-        const subcommand = args[2];
-        if (!subcommand || !commands[subcommand]) {
-            console.log('Available commands:', Object.keys(commands).join(', '));
-            return;
-        }
-        const CommandClass = commands[subcommand];
-        // Create a minimal oclif config
-        const config = await core_1.Config.load({ root: projectRootPath });
-        // Instantiate and run the command
-        const instance = new CommandClass(args.slice(3), config);
-        await instance.run();
     }
     /**
      * This function returns a "Searcher" configured to search instances of the read model class passed as param.
@@ -152,7 +120,9 @@ Magek.config = new common_1.MagekConfig(checkAndGetCurrentEnv());
 function checkAndGetCurrentEnv() {
     const env = process.env.MAGEK_ENV;
     if (!env || env.trim().length == 0) {
-        throw new Error('Magek environment is missing. You need to provide an environment to configure your Magek project');
+        throw new Error('Magek environment is missing. You need to provide an environment to configure your Magek project.\n\n' +
+            'To fix this error, set the MAGEK_ENV environment variable.\n' +
+            'Common environment names: local, development, staging, production, test');
     }
     return env;
 }

package/dist/scheduled-command-dispatcher.js

@@ -40,7 +40,7 @@ class MagekScheduledCommandDispatcher {
      */
     async dispatch(request) {
         const logger = (0, common_1.getLogger)(this.config, 'MagekScheduledCommandDispatcher#dispatch');
-        const envelopeOrError = await this.config.provider.scheduled.rawToEnvelope(this.config, request);
+        const envelopeOrError = await this.config.runtime.scheduled.rawToEnvelope(this.config, request);
         logger.debug('Received ScheduledCommand envelope...', envelopeOrError);
         await this.dispatchCommand(envelopeOrError);
     }

package/dist/sensor/health/health-indicators/database-events-health-indicator.js

@@ -9,7 +9,7 @@ class MagekDatabaseEventsHealthIndicator {
                 status: await this.isUp(config),
             };
             if (healthIndicatorMetadata.healthIndicatorConfiguration.details) {
-                const details = await config.provider.sensor.databaseEventsHealthDetails(config);
+                const details = await config.runtime.sensor.databaseEventsHealthDetails(config);
                 result.details = details;
             }
             return result;
@@ -19,7 +19,7 @@ class MagekDatabaseEventsHealthIndicator {
         }
     }
     async isUp(config) {
-        const databaseEvents = await config.provider.sensor.isDatabaseEventUp(config);
+        const databaseEvents = await config.runtime.sensor.isDatabaseEventUp(config);
         return databaseEvents ? common_1.HealthStatus.UP : common_1.HealthStatus.DOWN;
     }
 }

package/dist/sensor/health/health-indicators/database-health-indicator.js

@@ -10,7 +10,7 @@ class MagekDatabaseHealthIndicator {
             };
             if (healthIndicatorMetadata.healthIndicatorConfiguration.details) {
                 const details = {
-                    urls: await config.provider.sensor.databaseUrls(config),
+                    urls: await config.runtime.sensor.databaseUrls(config),
                 };
                 result.details = details;
             }
@@ -21,8 +21,8 @@ class MagekDatabaseHealthIndicator {
         }
     }
     async isUp(config) {
-        const databaseEvents = await config.provider.sensor.isDatabaseEventUp(config);
-        const databaseReadModels = await config.provider.sensor.areDatabaseReadModelsUp(config);
+        const databaseEvents = await config.runtime.sensor.isDatabaseEventUp(config);
+        const databaseReadModels = await config.runtime.sensor.areDatabaseReadModelsUp(config);
         return databaseEvents && databaseReadModels ? common_1.HealthStatus.UP : common_1.HealthStatus.DOWN;
     }
 }

package/dist/sensor/health/health-indicators/database-read-models-health-indicator.js

@@ -9,7 +9,7 @@ class MagekDatabaseReadModelsHealthIndicator {
                 status: await this.isUp(config),
             };
             if (healthIndicatorMetadata.healthIndicatorConfiguration.details) {
-                const details = await config.provider.sensor.databaseReadModelsHealthDetails(config);
+                const details = await config.runtime.sensor.databaseReadModelsHealthDetails(config);
                 result.details = details;
             }
             return result;
@@ -19,7 +19,7 @@ class MagekDatabaseReadModelsHealthIndicator {
         }
     }
     async isUp(config) {
-        const databaseReadModels = await config.provider.sensor.areDatabaseReadModelsUp(config);
+        const databaseReadModels = await config.runtime.sensor.areDatabaseReadModelsUp(config);
         return databaseReadModels ? common_1.HealthStatus.UP : common_1.HealthStatus.DOWN;
     }
 }

package/dist/sensor/health/health-indicators/function-health-indicator.js

@@ -10,7 +10,7 @@ class MagekFunctionHealthIndicator {
                 status: await this.isUp(config),
             };
             if (healthIndicatorMetadata.healthIndicatorConfiguration.details) {
-                const graphQLUrl = await config.provider.sensor.graphQLFunctionUrl(config);
+                const graphQLUrl = await config.runtime.sensor.graphQLFunctionUrl(config);
                 const osInfoResult = await (0, os_info_1.osInfo)();
                 result.details = {
                     ...osInfoResult,
@@ -24,7 +24,7 @@ class MagekFunctionHealthIndicator {
         }
     }
     async isUp(config) {
-        return (await config.provider.sensor.isGraphQLFunctionUp(config)) ? common_1.HealthStatus.UP : common_1.HealthStatus.DOWN;
+        return (await config.runtime.sensor.isGraphQLFunctionUp(config)) ? common_1.HealthStatus.UP : common_1.HealthStatus.DOWN;
     }
 }
 exports.MagekFunctionHealthIndicator = MagekFunctionHealthIndicator;

package/dist/sensor/health/health-indicators/health-indicator.js

@@ -21,9 +21,9 @@ class MagekHealthIndicator {
         }
     }
     async isUp(config) {
-        const graphqlUp = await config.provider.sensor.isGraphQLFunctionUp(config);
-        const databaseEvents = await config.provider.sensor.isDatabaseEventUp(config);
-        const databaseReadModels = await config.provider.sensor.areDatabaseReadModelsUp(config);
+        const graphqlUp = await config.runtime.sensor.isGraphQLFunctionUp(config);
+        const databaseEvents = await config.runtime.sensor.isDatabaseEventUp(config);
+        const databaseReadModels = await config.runtime.sensor.areDatabaseReadModelsUp(config);
         return graphqlUp && databaseEvents && databaseReadModels ? common_1.HealthStatus.UP : common_1.HealthStatus.DOWN;
     }
 }

package/dist/sensor/health/health-service.js

@@ -16,7 +16,7 @@ class MagekHealthService {
     }
     async health(request) {
         try {
-            const healthEnvelope = this.config.provider.sensor.rawRequestToHealthEnvelope(request);
+            const healthEnvelope = this.config.runtime.sensor.rawRequestToHealthEnvelope(request);
             await this.validate(healthEnvelope);
             const healthProviders = this.getHealthProviders();
             const parents = this.parentsHealthProviders(healthEnvelope, healthProviders);
@@ -24,10 +24,10 @@ class MagekHealthService {
             // Check if all components are healthy
             const isHealthy = this.isOverallHealthy(healthIndicatorResults);
             // Use the new health specific response handler
-            return await this.config.provider.api.healthRequestResult(healthIndicatorResults, isHealthy);
+            return await this.config.runtime.api.healthRequestResult(healthIndicatorResults, isHealthy);
         }
         catch (e) {
-            return await this.config.provider.api.requestFailed(e);
+            return await this.config.runtime.api.requestFailed(e);
         }
     }
     async validate(healthEnvelope) {

package/dist/services/graphql/websocket-protocol/graphql-websocket-protocol.js

@@ -43,7 +43,7 @@ class GraphQLWebsocketHandler {
         catch (e) {
             const error = e;
             logger.error(e);
-            await this.config.provider.messaging.sendMessage(this.config, envelope.connectionID, new common_1.GraphQLInitError(error.message));
+            await this.config.runtime.messaging.sendMessage(this.config, envelope.connectionID, new common_1.GraphQLInitError(error.message));
         }
     }
     async handleInit(connectionID, clientMessage) {
@@ -61,7 +61,7 @@ class GraphQLWebsocketHandler {
         logger.debug('Storing connection data: ', connectionData);
         await this.config.sessionStore.storeConnection(this.config, connectionID, connectionData);
         logger.debug('Sending ACK');
-        await this.config.provider.messaging.sendMessage(this.config, connectionID, new common_1.GraphQLInitAck());
+        await this.config.runtime.messaging.sendMessage(this.config, connectionID, new common_1.GraphQLInitAck());
     }
     async handleStart(connectionID, envelope, message) {
         const logger = (0, common_1.getLogger)(this.config, 'GraphQLWebsocketHandler#handleStart');
@@ -69,7 +69,7 @@ class GraphQLWebsocketHandler {
             throw new Error(`Missing "id" in ${message.type} message`);
         }
         if (!message.payload || !message.payload.query) {
-            await this.config.provider.messaging.sendMessage(this.config, connectionID, new common_1.GraphQLError(message.id, {
+            await this.config.runtime.messaging.sendMessage(this.config, connectionID, new common_1.GraphQLError(message.id, {
                 errors: [new Error('Message payload is invalid it must contain at least the "query" property')],
             }));
             return;
@@ -83,8 +83,8 @@ class GraphQLWebsocketHandler {
         }
         logger.debug('Operation finished. Sending DATA:', result);
         // It was a query or mutation. We send data and complete the operation
-        await this.config.provider.messaging.sendMessage(this.config, connectionID, new common_1.GraphQLData(message.id, result));
-        await this.config.provider.messaging.sendMessage(this.config, connectionID, new common_1.GraphQLComplete(message.id));
+        await this.config.runtime.messaging.sendMessage(this.config, connectionID, new common_1.GraphQLData(message.id, result));
+        await this.config.runtime.messaging.sendMessage(this.config, connectionID, new common_1.GraphQLComplete(message.id));
     }
     async augmentEnvelope(connectionID, envelope, message) {
         const logger = (0, common_1.getLogger)(this.config, 'GraphQLWebsocketHandler#augmentEnvelope');
@@ -108,7 +108,7 @@ class GraphQLWebsocketHandler {
         await this.callbacks.onStopOperation(connectionID, message.id);
         logger.debug('Stop operation finished');
         try {
-            await this.config.provider.messaging.sendMessage(this.config, connectionID, new common_1.GraphQLComplete(message.id));
+            await this.config.runtime.messaging.sendMessage(this.config, connectionID, new common_1.GraphQLComplete(message.id));
         }
         catch (e) {
             // It could be the case that the client already closed the connection without waiting for stop operation to finish

package/dist/subscribers-notifier.js

@@ -96,7 +96,7 @@ class MagekSubscribersNotifier {
         const readModel = result.data;
         const message = new common_1.GraphQLData(subscription.operation.id, { data: readModel });
         logger.debug(`Notifying connectionID '${subscription.connectionID}' with the following wrappeed read model: `, readModel);
-        await this.config.provider.messaging.sendMessage(this.config, subscription.connectionID, message);
+        await this.config.runtime.messaging.sendMessage(this.config, subscription.connectionID, message);
         logger.debug('Notifications sent');
     }
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@magek/core",
-  "version": "0.0.2",
+  "version": "0.0.4",
   "description": "Library for your Magek apps",
   "author": "Boosterin Labs SLU",
   "homepage": "https://magek.ai",
@@ -23,26 +23,25 @@
     "node": ">=22.0.0 <23.0.0"
   },
   "dependencies": {
-    "@magek/common": "^0.0.2",
+    "@magek/common": "^0.0.4",
     "fp-ts": "2.16.11",
     "graphql-scalars": "1.25.0",
     "inflected": "2.1.0",
     "iterall": "1.3.0",
     "jsonwebtoken": "9.0.3",
-    "jwks-rsa": "3.2.0",
+    "jwks-rsa": "3.2.1",
     "tslib": "2.8.1",
     "validator": "13.15.26",
-    "@oclif/core": "4.8.0",
     "fast-check": "4.5.3"
   },
   "devDependencies": {
-    "@magek/eslint-config": "^0.0.2",
+    "@magek/eslint-config": "^0.0.4",
     "@types/chai": "5.2.3",
     "@types/chai-as-promised": "8.0.2",
     "@types/inflected": "2.1.3",
     "@types/jsonwebtoken": "9.0.10",
     "@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",
     "chai": "6.2.2",

package/dist/injectable/index.d.ts

@@ -1,21 +0,0 @@
-import type { Command as OclifCommand, Config } from '@oclif/core';
-/**
- * Type for a concrete oclif Command class (non-abstract).
- * This represents a class constructor that creates Command instances.
- */
-export type ConcreteCommand = new (argv: string[], config: Config) => OclifCommand;
-/**
- * Injectable interface for registering custom CLI commands with Magek.
- * Commands should be oclif Command classes (concrete implementations, not abstract).
- */
-export interface Injectable {
-    /**
-     * Map of command names to oclif Command classes.
-     * The command name will be used as the subcommand name.
-     */
-    commands: Record<string, ConcreteCommand>;
-}
-/**
- * Type for an oclif Command class.
- */
-export type Command = ConcreteCommand;

package/dist/injectable/index.js

@@ -1,2 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });