@magek/common 0.0.1

package/dist/session-store-adapter.d.ts

@@ -0,0 +1,103 @@
+import { MagekConfig } from './config';
+import { UUID } from './concepts';
+import { SubscriptionEnvelope } from './envelope';
+/**
+ * Interface for session store adapters that handle connection and subscription management
+ * for real-time features like GraphQL subscriptions and WebSocket connections.
+ */
+export interface SessionStoreAdapter {
+    /**
+     * Establishes a new connection and stores connection metadata
+     *
+     * @param config - The Magek configuration object
+     * @param connectionId - Unique identifier for the connection
+     * @param connectionData - Metadata associated with the connection
+     * @returns A promise that resolves when the connection is established
+     */
+    storeConnection(config: MagekConfig, connectionId: UUID, connectionData: Record<string, any>): Promise<void>;
+    /**
+     * Retrieves connection data for a specific connection
+     *
+     * @param config - The Magek configuration object
+     * @param connectionId - Unique identifier for the connection
+     * @returns A promise that resolves to the connection data, or undefined if not found
+     */
+    fetchConnection(config: MagekConfig, connectionId: UUID): Promise<Record<string, any> | undefined>;
+    /**
+     * Removes a connection and all associated data
+     *
+     * @param config - The Magek configuration object
+     * @param connectionId - Unique identifier for the connection
+     * @returns A promise that resolves when the connection is removed
+     */
+    deleteConnection(config: MagekConfig, connectionId: UUID): Promise<void>;
+    /**
+     * Stores subscription information for a connection
+     *
+     * @param config - The Magek configuration object
+     * @param connectionId - Unique identifier for the connection
+     * @param subscriptionId - Unique identifier for the subscription
+     * @param subscriptionData - Metadata associated with the subscription
+     * @returns A promise that resolves when the subscription is stored
+     */
+    storeSubscription(config: MagekConfig, connectionId: UUID, subscriptionId: UUID, subscriptionData: Record<string, any>): Promise<void>;
+    /**
+     * Retrieves subscription data for a specific subscription
+     *
+     * @param config - The Magek configuration object
+     * @param subscriptionId - Unique identifier for the subscription
+     * @returns A promise that resolves to the subscription data, or undefined if not found
+     */
+    fetchSubscription(config: MagekConfig, subscriptionId: UUID): Promise<Record<string, any> | undefined>;
+    /**
+     * Removes a subscription
+     *
+     * @param config - The Magek configuration object
+     * @param connectionId - Unique identifier for the connection
+     * @param subscriptionId - Unique identifier for the subscription
+     * @returns A promise that resolves when the subscription is removed
+     */
+    deleteSubscription(config: MagekConfig, connectionId: UUID, subscriptionId: UUID): Promise<void>;
+    /**
+     * Retrieves all subscriptions for a specific connection
+     *
+     * @param config - The Magek configuration object
+     * @param connectionId - Unique identifier for the connection
+     * @returns A promise that resolves to an array of subscription data
+     */
+    fetchSubscriptionsForConnection(config: MagekConfig, connectionId: UUID): Promise<Array<Record<string, any>>>;
+    /**
+     * Removes all subscriptions associated with a connection
+     *
+     * @param config - The Magek configuration object
+     * @param connectionId - Unique identifier for the connection
+     * @returns A promise that resolves when all subscriptions are removed
+     */
+    deleteSubscriptionsForConnection(config: MagekConfig, connectionId: UUID): Promise<void>;
+    /**
+     * Retrieves subscriptions filtered by read model class name
+     * This method supports querying subscriptions by the read model type they are listening to
+     *
+     * @param config - The Magek configuration object
+     * @param className - The name of the read model class to filter subscriptions by
+     * @returns A promise that resolves to an array of subscription envelopes matching the class name
+     */
+    fetchSubscriptionsByClassName(config: MagekConfig, className: string): Promise<Array<SubscriptionEnvelope>>;
+    /**
+     * Health check methods for the session store
+     */
+    healthCheck?: {
+        /**
+         * Check if the session store is up and running
+         */
+        isUp(config: MagekConfig): Promise<boolean>;
+        /**
+         * Get detailed health information about the session store
+         */
+        details(config: MagekConfig): Promise<unknown>;
+        /**
+         * Get the URLs/endpoints of the session store
+         */
+        urls(config: MagekConfig): Promise<Array<string>>;
+    };
+}

package/dist/session-store-adapter.js

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

package/dist/stream-types.d.ts

@@ -0,0 +1 @@
+export type EventStream = Array<unknown>;

package/dist/stream-types.js

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

package/dist/super-kind.d.ts

@@ -0,0 +1,2 @@
+export declare const MAGEK_SUPER_KIND = "magek";
+export declare const DOMAIN_SUPER_KIND = "domain";

package/dist/super-kind.js

@@ -0,0 +1,5 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.DOMAIN_SUPER_KIND = exports.MAGEK_SUPER_KIND = void 0;
+exports.MAGEK_SUPER_KIND = 'magek';
+exports.DOMAIN_SUPER_KIND = 'domain';

package/dist/typelevel.d.ts

@@ -0,0 +1,28 @@
+/**
+ * Interface to get information from a `TReflected`
+ * class.
+ *
+ * Usage:
+ *
+ * ```typescript
+ * function printName<T>(cls : Class<T>){
+ *   console.log(cls.name)
+ * }
+ *
+ * printName(Person)  // Prints "Person"
+ * ```
+ */
+export interface Class<TReflected> {
+    new (...args: any[]): TReflected;
+}
+export interface AnyClass extends Class<any> {
+}
+export interface Instance {
+    constructor: {
+        name: string;
+    };
+}
+export declare function toClassTitle(instance: Instance): string;
+export type ReadOnlyNonEmptyArray<TElement> = {
+    readonly 0: TElement;
+} & ReadonlyArray<TElement>;

package/dist/typelevel.js

@@ -0,0 +1,9 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.toClassTitle = toClassTitle;
+function toClassTitle(instance) {
+    return instance.constructor.name
+        .replace(/([A-Z])([a-z])/g, ' $1$2')
+        .replace(/([a-z])([A-Z])/g, '$1 $2')
+        .trim();
+}

package/dist/user-app.d.ts

@@ -0,0 +1,18 @@
+import { MagekConfig } from './config';
+/**
+ * `UserApp` represents the expected interface when we `require` the `dist/index.js` file of a Magek app
+ */
+export interface UserApp {
+    Magek: {
+        config: MagekConfig;
+        configureCurrentEnv(configurator: (config: MagekConfig) => void): void;
+        configuredEnvironments: Set<string>;
+    };
+    eventDispatcher(_: unknown): Promise<void>;
+    graphQLDispatcher(_: unknown): Promise<unknown>;
+    triggerScheduledCommands(_: unknown): Promise<void>;
+    notifySubscribers(_: unknown): Promise<void>;
+    consumeEventStream(_: unknown): Promise<unknown>;
+    produceEventStream(_: unknown): Promise<unknown>;
+    health(_: unknown): Promise<any>;
+}

package/dist/user-app.js

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

package/package.json

@@ -0,0 +1,66 @@
+{
+  "name": "@magek/common",
+  "version": "0.0.1",
+  "description": "Contains Magek common helpers used by the core and provider packages",
+  "keywords": [
+    "framework-common-helpers"
+  ],
+  "author": "Boosterin Labs SLU",
+  "homepage": "https://magek.ai",
+  "license": "Apache-2.0",
+  "publishConfig": {
+    "access": "public"
+  },
+  "main": "dist/index.js",
+  "files": [
+    "dist"
+  ],
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/theam/magek.git"
+  },
+  "bugs": {
+    "url": "https://github.com/theam/magek/issues"
+  },
+  "engines": {
+    "node": ">=22.0.0 <23.0.0"
+  },
+  "dependencies": {
+    "tslib": "2.8.1",
+    "class-transformer": "~0.5.1",
+    "execa": "9.6.1",
+    "reflect-metadata": "0.2.2",
+    "uuid": "^13.0.0"
+  },
+  "devDependencies": {
+    "@magek/eslint-config": "^0.0.1",
+    "@types/chai": "5.2.3",
+    "@types/chai-as-promised": "8.0.2",
+    "@types/mocha": "10.0.10",
+    "@types/node": "22.19.3",
+    "@types/sinon": "21.0.0",
+    "@types/sinon-chai": "4.0.0",
+    "@types/uuid": "11.0.0",
+    "chai": "6.2.2",
+    "chai-as-promised": "8.0.2",
+    "mocha": "11.7.5",
+    "c8": "^10.1.3",
+    "rimraf": "6.1.2",
+    "sinon": "21.0.1",
+    "sinon-chai": "4.0.1",
+    "tsx": "^4.19.2",
+    "typescript": "5.9.3",
+    "@faker-js/faker": "10.2.0",
+    "fast-check": "4.5.3",
+    "graphql": "16.12.0"
+  },
+  "scripts": {
+    "format": "prettier --write --ext '.js,.ts' **/*.ts **/*/*.ts",
+    "lint:check": "eslint \"**/*.ts\"",
+    "lint:fix": "eslint --quiet --fix \"**/*.ts\"",
+    "build": "tsc -b tsconfig.json",
+    "clean": "rimraf ./dist tsconfig.tsbuildinfo",
+    "test:helpers": "npm run test",
+    "test": "tsc --noEmit -p tsconfig.test.json && c8 mocha --forbid-only \"test/**/*.test.ts\""
+  }
+}