@modular-rest/server 1.14.1 → 1.16.0

package/README.md

@@ -58,7 +58,7 @@ createRest({
 - Event system
 - Extensible architecture
 
-## TypeScript Support 
+## TypeScript Support
 
 This package includes full TypeScript type definitions for all API components. The entire codebase is written in TypeScript, providing:
 

package/dist/class/cms_trigger.d.ts

@@ -1,3 +1,4 @@
+import { DatabaseTriggerContext } from './database_trigger';
 /**
  * Type for CMS operations that can trigger a callback
  * @typedef {('update-one' | 'insert-one' | 'remove-one')} CmsOperation
@@ -7,16 +8,6 @@
  * - 'remove-one': Triggered when removing a document from the CMS
  */
 export type CmsOperation = 'update-one' | 'insert-one' | 'remove-one';
-/**
- * Context interface for CMS trigger callbacks
- * @interface CmsTriggerContext
- * @property {Record<string, any>} query - The query parameters used in the CMS operation
- * @property {any} queryResult - The result of the CMS operation
- */
-export interface CmsTriggerContext {
-    query: Record<string, any>;
-    queryResult: any;
-}
 /**
  * Defines a callback to be executed on specific CMS operations
  * @class CmsTrigger
@@ -26,7 +17,7 @@ export interface CmsTriggerContext {
  * ```typescript
  * const trigger = new CmsTrigger('insert-one', (context) => {
  *   console.log('New CMS document inserted:', context.queryResult);
- *   // Perform additional actions after CMS document insertion
+ *   // Perform additional actions after CMS document insertion.
  * });
  *
  * // Use the trigger in RestOptions
@@ -38,7 +29,7 @@ export interface CmsTriggerContext {
  */
 export declare class CmsTrigger {
     operation: CmsOperation;
-    callback: (context: CmsTriggerContext) => void;
+    callback: (context: DatabaseTriggerContext) => void;
     /**
      * Creates a new CmsTrigger instance
      * @param {CmsOperation} operation - The CMS operation to trigger on
@@ -56,6 +47,6 @@ export declare class CmsTrigger {
      * });
      * ```
      */
-    constructor(operation: CmsOperation, callback?: (context: CmsTriggerContext) => void);
+    constructor(operation: CmsOperation, callback?: (context: DatabaseTriggerContext) => void);
 }
 export default CmsTrigger;

package/dist/class/cms_trigger.js

@@ -10,7 +10,7 @@ exports.CmsTrigger = void 0;
  * ```typescript
  * const trigger = new CmsTrigger('insert-one', (context) => {
  *   console.log('New CMS document inserted:', context.queryResult);
- *   // Perform additional actions after CMS document insertion
+ *   // Perform additional actions after CMS document insertion.
  * });
  *
  * // Use the trigger in RestOptions

package/dist/class/database_trigger.d.ts

@@ -5,12 +5,18 @@ export type DatabaseOperation = 'find' | 'find-one' | 'count' | 'update-one' | '
 /**
  * Context interface for database trigger callbacks
  * @interface DatabaseTriggerContext
- * @property {Record<string, any>} query - The query parameters used in the database operation
- * @property {any | any[]} queryResult - The result of the database operation
+ * @property {Record<string, any>} doc - The document data for insert/update operations
+ * @property {Record<string, any>} query - The query data for find/find-one operations
+ * @property {Record<string, any>} update - The update data for update operations
+ * @property {Record<string, any>[]} pipelines - The aggregation pipelines for aggregate operations
+ * @property {Record<string, any> } queryResult - The result of the database operation
  */
 export interface DatabaseTriggerContext {
-    query: Record<string, any>;
-    queryResult: any | any[];
+    doc?: Record<string, any>;
+    query?: Record<string, any>;
+    update?: Record<string, any>;
+    pipelines?: Record<string, any>[];
+    queryResult: Record<string, any>;
 }
 /**
  * The callback function to be executed on specific database operations

package/dist/class/user.d.ts

@@ -37,7 +37,7 @@ export declare class User {
      *
      * @hidden
      */
-    constructor(id: string, permissionGroup: string, phone: string, email: string, password: string, type: string, model: any);
+    constructor(id: string, permissionGroup: string, phone: string, email: string, password: string, type: 'user' | 'anonymous', model: any);
     /**
      * Get brief user information
      * @returns Brief user info object

package/dist/services/data_provider/router.js

@@ -227,6 +227,7 @@ dataProvider.post('/update-one', async (ctx) => {
         // Call trigger
         service.triggers.call('update-one', body.database, body.collection, {
             query: body.query,
+            update: body.update,
             queryResult: writeOpResult,
         });
         ctx.body = { data: writeOpResult };
@@ -261,7 +262,7 @@ dataProvider.post('/insert-one', async (ctx) => {
         .then(async (newDoc) => {
         // Call trigger
         service.triggers.call('insert-one', body.database, body.collection, {
-            query: body.query,
+            doc: body.doc,
             queryResult: newDoc,
         });
         ctx.body = { data: newDoc };
@@ -329,7 +330,7 @@ dataProvider.post('/aggregate', async (ctx) => {
         .then(async (result) => {
         // Call trigger
         service.triggers.call('aggregate', body.database, body.collection, {
-            query: body.query,
+            pipelines: body.pipelines,
             queryResult: result,
         });
         ctx.body = { data: result };

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@modular-rest/server",
-	"version": "1.14.1",
+	"version": "1.16.0",
 	"description": "TypeScript version of a nodejs module based on KOAJS for developing Rest-APIs in a modular solution.",
 	"main": "dist/index.js",
 	"types": "dist/index.d.ts",

package/src/class/cms_trigger.ts

@@ -1,3 +1,5 @@
+import { DatabaseTriggerContext } from './database_trigger';
+
 /**
  * Type for CMS operations that can trigger a callback
  * @typedef {('update-one' | 'insert-one' | 'remove-one')} CmsOperation
@@ -8,17 +10,6 @@
  */
 export type CmsOperation = 'update-one' | 'insert-one' | 'remove-one';
 
-/**
- * Context interface for CMS trigger callbacks
- * @interface CmsTriggerContext
- * @property {Record<string, any>} query - The query parameters used in the CMS operation
- * @property {any} queryResult - The result of the CMS operation
- */
-export interface CmsTriggerContext {
-  query: Record<string, any>;
-  queryResult: any;
-}
-
 /**
  * Defines a callback to be executed on specific CMS operations
  * @class CmsTrigger
@@ -28,7 +19,7 @@ export interface CmsTriggerContext {
  * ```typescript
  * const trigger = new CmsTrigger('insert-one', (context) => {
  *   console.log('New CMS document inserted:', context.queryResult);
- *   // Perform additional actions after CMS document insertion
+ *   // Perform additional actions after CMS document insertion.
  * });
  *
  * // Use the trigger in RestOptions
@@ -40,7 +31,7 @@ export interface CmsTriggerContext {
  */
 export class CmsTrigger {
   operation: CmsOperation;
-  callback: (context: CmsTriggerContext) => void;
+  callback: (context: DatabaseTriggerContext) => void;
 
   /**
    * Creates a new CmsTrigger instance
@@ -59,7 +50,10 @@ export class CmsTrigger {
    * });
    * ```
    */
-  constructor(operation: CmsOperation, callback: (context: CmsTriggerContext) => void = () => {}) {
+  constructor(
+    operation: CmsOperation,
+    callback: (context: DatabaseTriggerContext) => void = () => {}
+  ) {
     this.operation = operation;
     this.callback = callback;
   }

package/src/class/database_trigger.ts

@@ -13,12 +13,18 @@ export type DatabaseOperation =
 /**
  * Context interface for database trigger callbacks
  * @interface DatabaseTriggerContext
- * @property {Record<string, any>} query - The query parameters used in the database operation
- * @property {any | any[]} queryResult - The result of the database operation
+ * @property {Record<string, any>} doc - The document data for insert/update operations
+ * @property {Record<string, any>} query - The query data for find/find-one operations
+ * @property {Record<string, any>} update - The update data for update operations
+ * @property {Record<string, any>[]} pipelines - The aggregation pipelines for aggregate operations
+ * @property {Record<string, any> } queryResult - The result of the database operation
  */
 export interface DatabaseTriggerContext {
-  query: Record<string, any>;
-  queryResult: any | any[];
+  doc?: Record<string, any>;
+  query?: Record<string, any>;
+  update?: Record<string, any>;
+  pipelines?: Record<string, any>[];
+  queryResult: Record<string, any>;
 }
 
 /**

package/src/class/user.ts

@@ -48,7 +48,7 @@ export class User {
     phone: string,
     email: string,
     password: string,
-    type: string,
+    type: 'user' | 'anonymous',
     model: any
   ) {
     this.id = id;

package/src/services/data_provider/router.ts

@@ -244,6 +244,7 @@ dataProvider.post('/update-one', async (ctx: Context) => {
       // Call trigger
       service.triggers.call('update-one', body.database, body.collection, {
         query: body.query,
+        update: body.update,
         queryResult: writeOpResult,
       });
 
@@ -290,7 +291,7 @@ dataProvider.post('/insert-one', async (ctx: Context) => {
     .then(async newDoc => {
       // Call trigger
       service.triggers.call('insert-one', body.database, body.collection, {
-        query: body.query,
+        doc: body.doc,
         queryResult: newDoc,
       });
 
@@ -381,7 +382,7 @@ dataProvider.post('/aggregate', async (ctx: Context) => {
     .then(async (result: any) => {
       // Call trigger
       service.triggers.call('aggregate', body.database, body.collection, {
-        query: body.query,
+        pipelines: body.pipelines,
         queryResult: result,
       });