@heliyos/heliyos-api-core 1.0.44 → 1.0.46

package/dist/events.d.ts

@@ -0,0 +1,51 @@
+export declare enum EventType {
+    AUDIT = "AUDIT",
+    INTERACTION = "INTERACTION"
+}
+export declare enum ActorType {
+    USER = "USER",
+    SYSTEM = "SYSTEM",
+    AGENT = "AGENT"
+}
+interface IActor {
+    type: ActorType;
+    uuid: string;
+}
+interface IEventMetadata {
+    eventType: EventType;
+    actor: IActor;
+    organizationUUID: string;
+    objectType: string;
+    objectUUID: string;
+}
+/**
+ * Creates a timestamped event log entry in the events collection
+ *
+ * @param metadata - Event metadata object containing:
+ *   - eventType: Type of event (AUDIT/INTERACTION)
+ *   - actor: Who performed the action (USER/SYSTEM/AGENT with their UUID)
+ *   - organizationUUID: Organization identifier
+ *   - objectType: Type of object being modified (e.g., 'User', 'Document')
+ *   - objectUUID: Unique identifier of the modified object
+ * @param originalVersion - The state of the object before changes
+ * @param updatedVersion - The state of the object after changes
+ * @param changeSummary - Human-readable description of what changed
+ *
+ * @example
+ * await logEvent(
+ *   {
+ *     eventType: EventType.AUDIT,
+ *     actor: { type: ActorType.USER, uuid: 'user-123e4567-e89b-12d3-a456-426614174000' },
+ *     organizationUUID: '123e4567-e89b-12d3-a456-426614174000',
+ *     objectType: 'User',
+ *     objectUUID: '123e4567-e89b-12d3-a456-426614174000'
+ *   },
+ *   { name: 'John' },
+ *   { name: 'John Doe' },
+ *   'Updated user name from John to John Doe'
+ * );
+ *
+ * @throws Will throw an error if the event creation fails
+ */
+export declare function logEvent(metadata: IEventMetadata, originalVersion: any, updatedVersion: any, changeSummary: string): Promise<void>;
+export {};

package/dist/events.js

@@ -0,0 +1,139 @@
+"use strict";
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ActorType = exports.EventType = void 0;
+exports.logEvent = logEvent;
+const mongoose_1 = require("./mongoose");
+const logger_1 = require("./logger");
+// Define the event types and actor types
+var EventType;
+(function (EventType) {
+    EventType["AUDIT"] = "AUDIT";
+    EventType["INTERACTION"] = "INTERACTION";
+})(EventType || (exports.EventType = EventType = {}));
+var ActorType;
+(function (ActorType) {
+    ActorType["USER"] = "USER";
+    ActorType["SYSTEM"] = "SYSTEM";
+    ActorType["AGENT"] = "AGENT";
+})(ActorType || (exports.ActorType = ActorType = {}));
+// Create the schema for events
+const eventSchema = new mongoose_1.Schema({
+    timestamp: {
+        type: Date,
+        required: true,
+        index: true
+    },
+    metadata: {
+        eventType: {
+            type: String,
+            enum: Object.values(EventType),
+            required: true
+        },
+        actor: {
+            type: {
+                type: String,
+                enum: Object.values(ActorType),
+                required: true
+            },
+            uuid: {
+                type: String,
+                required: true
+            }
+        },
+        organizationUUID: {
+            type: String,
+            required: true,
+            index: true
+        },
+        objectType: {
+            type: String,
+            required: true,
+            index: true
+        },
+        objectUUID: {
+            type: String,
+            required: true,
+            index: true
+        }
+    },
+    originalVersion: {
+        type: mongoose_1.Schema.Types.Mixed,
+        required: true
+    },
+    updatedVersion: {
+        type: mongoose_1.Schema.Types.Mixed,
+        required: true
+    },
+    changeSummary: {
+        type: String,
+        required: true
+    }
+}, {
+    collection: 'events',
+    timeseries: {
+        timeField: 'timestamp',
+        metaField: 'metadata',
+        granularity: 'seconds'
+    }
+});
+// Create the model
+const Event = (0, mongoose_1.model)('events', eventSchema);
+/**
+ * Creates a timestamped event log entry in the events collection
+ *
+ * @param metadata - Event metadata object containing:
+ *   - eventType: Type of event (AUDIT/INTERACTION)
+ *   - actor: Who performed the action (USER/SYSTEM/AGENT with their UUID)
+ *   - organizationUUID: Organization identifier
+ *   - objectType: Type of object being modified (e.g., 'User', 'Document')
+ *   - objectUUID: Unique identifier of the modified object
+ * @param originalVersion - The state of the object before changes
+ * @param updatedVersion - The state of the object after changes
+ * @param changeSummary - Human-readable description of what changed
+ *
+ * @example
+ * await logEvent(
+ *   {
+ *     eventType: EventType.AUDIT,
+ *     actor: { type: ActorType.USER, uuid: 'user-123e4567-e89b-12d3-a456-426614174000' },
+ *     organizationUUID: '123e4567-e89b-12d3-a456-426614174000',
+ *     objectType: 'User',
+ *     objectUUID: '123e4567-e89b-12d3-a456-426614174000'
+ *   },
+ *   { name: 'John' },
+ *   { name: 'John Doe' },
+ *   'Updated user name from John to John Doe'
+ * );
+ *
+ * @throws Will throw an error if the event creation fails
+ */
+function logEvent(metadata, originalVersion, updatedVersion, changeSummary) {
+    return __awaiter(this, void 0, void 0, function* () {
+        try {
+            yield Event.create({
+                timestamp: new Date(),
+                metadata,
+                originalVersion,
+                updatedVersion,
+                changeSummary
+            });
+        }
+        catch (error) {
+            logger_1.logger.error('Failed to create event log', {
+                error,
+                metadata,
+                changeSummary
+            });
+            throw error;
+        }
+    });
+}

package/dist/index.d.ts

@@ -19,3 +19,4 @@ export { HttpError } from "./@types/globals/customError";
 export type { ICoreAppOptions } from "./@types/globals/middleware";
 export type { RolesPermissionsType, ResourcePolicyActionsType, } from "./static/authPolicyFile";
 export { Schema, Document, Model, FilterQuery, UpdateQuery, Pagination, Types, mongooseConnection, mongoInstance, } from "./mongoose";
+export { logEvent, EventType, ActorType } from './events';

package/dist/index.js

@@ -23,7 +23,7 @@ var __importStar = (this && this.__importStar) || function (mod) {
     return result;
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.mongoInstance = exports.mongooseConnection = exports.Types = exports.Model = exports.Document = exports.Schema = exports.HttpError = exports.getSecretsManagerSecret = exports.resendSendEmail = exports.pusherTriggerBatch = exports.pusherTrigger = exports.pusher = exports.emailTemplates = exports.getEmailTemplate = exports.allowedOrigin = exports.logger = exports.SQSUtil = exports.getRedisClient = exports.authorizeUser = exports.authPolicy = exports.loadAppEnv = exports.joiObject = exports.validate = exports.axios = exports.coreApp = exports.authentication = void 0;
+exports.ActorType = exports.EventType = exports.logEvent = exports.mongoInstance = exports.mongooseConnection = exports.Types = exports.Model = exports.Document = exports.Schema = exports.HttpError = exports.getSecretsManagerSecret = exports.resendSendEmail = exports.pusherTriggerBatch = exports.pusherTrigger = exports.pusher = exports.emailTemplates = exports.getEmailTemplate = exports.allowedOrigin = exports.logger = exports.SQSUtil = exports.getRedisClient = exports.authorizeUser = exports.authPolicy = exports.loadAppEnv = exports.joiObject = exports.validate = exports.axios = exports.coreApp = exports.authentication = void 0;
 const dotenv = __importStar(require("dotenv"));
 dotenv.config();
 // Core exports
@@ -72,3 +72,7 @@ Object.defineProperty(exports, "Model", { enumerable: true, get: function () { r
 Object.defineProperty(exports, "Types", { enumerable: true, get: function () { return mongoose_1.Types; } });
 Object.defineProperty(exports, "mongooseConnection", { enumerable: true, get: function () { return mongoose_1.mongooseConnection; } });
 Object.defineProperty(exports, "mongoInstance", { enumerable: true, get: function () { return mongoose_1.mongoInstance; } });
+var events_1 = require("./events");
+Object.defineProperty(exports, "logEvent", { enumerable: true, get: function () { return events_1.logEvent; } });
+Object.defineProperty(exports, "EventType", { enumerable: true, get: function () { return events_1.EventType; } });
+Object.defineProperty(exports, "ActorType", { enumerable: true, get: function () { return events_1.ActorType; } });

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@heliyos/heliyos-api-core",
-  "version": "1.0.44",
+  "version": "1.0.46",
   "description": "Heliyos's core api functions and middlewares. Its a private package hosted on npm.",
   "main": "./dist/index.js",
   "scripts": {
@@ -40,7 +40,7 @@
     "helmet": "^8.0.0",
     "http": "0.0.1-security",
     "joi": "^17.13.3",
-    "mongoose": "8.8.0",
+    "mongoose": "8.9.5",
     "morgan": "1.10.0",
     "pusher": "5.2.0",
     "redis": "4.7.0",