@modular-rest/server 1.13.4 → 1.14.0

package/dist/application.js

@@ -107,7 +107,7 @@ async function createRest(options) {
     if (config_1.config.staticPath) {
         const defaultStaticPath = config_1.config.staticPath.actualPath || '';
         const defaultStaticRootPath = config_1.config.staticPath.path || '/assets';
-        const staticOptions = { ...config_1.config.staticPath };
+        const staticOptions = { ...config_1.config.staticPath, defer: true };
         delete staticOptions.actualPath;
         delete staticOptions.path;
         app.use((0, koa_mount_1.default)(defaultStaticRootPath, (0, koa_static_1.default)(defaultStaticPath, staticOptions)));

package/dist/services/data_provider/router.js

@@ -111,6 +111,11 @@ dataProvider.post('/find', async (ctx) => {
     await queryRequest
         .exec()
         .then(async (docs) => {
+        // Call trigger
+        service.triggers.call('find', body.database, body.collection, {
+            query: body.query,
+            queryResult: docs,
+        });
         ctx.body = { data: docs };
     })
         .catch(err => {
@@ -152,6 +157,11 @@ dataProvider.post('/find-one', async (ctx) => {
     await queryRequest
         .exec()
         .then(async (doc) => {
+        // Call trigger
+        service.triggers.call('find-one', body.database, body.collection, {
+            query: body.query,
+            queryResult: doc,
+        });
         ctx.body = { data: doc };
     })
         .catch(err => {
@@ -177,7 +187,13 @@ dataProvider.post('/count', async (ctx) => {
     }
     await collection
         .countDocuments(body.query)
+        .exec()
         .then(count => {
+        // Call trigger
+        service.triggers.call('count', body.database, body.collection, {
+            query: body.query,
+            queryResult: count,
+        });
         ctx.body = { data: count };
     })
         .catch(err => {
@@ -185,3 +201,211 @@ dataProvider.post('/count', async (ctx) => {
         ctx.body = err.message;
     });
 });
+dataProvider.post('/update-one', async (ctx) => {
+    const body = ctx.request.body;
+    const bodyValidate = (0, validator_1.validateObject)(body, 'database collection query update');
+    // fields validation
+    if (!bodyValidate.isValid) {
+        ctx.throw(412, JSON.stringify((0, reply_1.create)('e', { error: bodyValidate.requires })));
+    }
+    // access validation
+    const hasAccess = service.checkAccess(body.database, body.collection, security_1.AccessTypes.write, body.query, ctx.state.user);
+    if (!hasAccess)
+        ctx.throw(403, 'access denied');
+    // collection validation
+    const collection = service.getCollection(body.database, body.collection);
+    if (collection == null) {
+        ctx.throw(412, JSON.stringify((0, reply_1.create)('e', { error: 'wrong database or collection' })));
+    }
+    // get removing doc as output for triggers
+    const output = await collection.findOne(body.query).exec().then();
+    // operate on db
+    await collection
+        .updateOne(body.query, body.update, body.options)
+        .exec()
+        .then(writeOpResult => {
+        // Call trigger
+        service.triggers.call('update-one', body.database, body.collection, {
+            query: body.query,
+            queryResult: writeOpResult,
+        });
+        ctx.body = { data: writeOpResult };
+    })
+        .catch(err => {
+        ctx.status = err.status || 500;
+        ctx.body = err.message;
+    });
+});
+dataProvider.post('/insert-one', async (ctx) => {
+    const body = ctx.request.body;
+    const bodyValidate = (0, validator_1.validateObject)(body, 'database collection doc');
+    // fields validation
+    if (!bodyValidate.isValid) {
+        ctx.throw(412, JSON.stringify((0, reply_1.create)('e', { error: bodyValidate.requires })));
+    }
+    // access validation
+    const hasAccess = service.checkAccess(body.database, body.collection, security_1.AccessTypes.write, body.doc, ctx.state.user);
+    if (!hasAccess) {
+        console.log(body);
+        console.log(ctx.state.user.permission);
+        ctx.throw(403, 'access denied');
+    }
+    // collection validation
+    const collection = service.getCollection(body.database, body.collection);
+    if (collection == null) {
+        ctx.throw(412, JSON.stringify((0, reply_1.create)('e', { error: 'wrong database or collection' })));
+    }
+    // operate on db
+    await new collection(body.doc)
+        .save()
+        .then(async (newDoc) => {
+        // Call trigger
+        service.triggers.call('insert-one', body.database, body.collection, {
+            query: body.query,
+            queryResult: newDoc,
+        });
+        ctx.body = { data: newDoc };
+    })
+        .catch(err => {
+        ctx.status = err.status || 500;
+        ctx.body = err.message;
+    });
+});
+dataProvider.post('/remove-one', async (ctx) => {
+    const body = ctx.request.body;
+    const bodyValidate = (0, validator_1.validateObject)(body, 'database collection query');
+    // fields validation
+    if (!bodyValidate.isValid) {
+        ctx.throw(412, JSON.stringify((0, reply_1.create)('e', { error: bodyValidate.requires })));
+    }
+    // access validation
+    const hasAccess = service.checkAccess(body.database, body.collection, security_1.AccessTypes.write, body.query, ctx.state.user);
+    if (!hasAccess)
+        ctx.throw(403, 'access denied');
+    // collection validation
+    const collection = service.getCollection(body.database, body.collection);
+    if (collection == null) {
+        ctx.throw(412, JSON.stringify((0, reply_1.create)('e', { error: 'wrong database or collection' })));
+    }
+    // get removing doc as output for triggers
+    const output = await collection.findOne(body.query).exec().then();
+    // operate on db
+    await collection
+        .deleteOne(body.query)
+        .exec()
+        .then(async (result) => {
+        // Call trigger
+        service.triggers.call('remove-one', body.database, body.collection, {
+            query: body.query,
+            queryResult: result,
+        });
+        ctx.body = { data: result };
+    })
+        .catch((err) => {
+        ctx.status = err.status || 500;
+        ctx.body = err.message;
+    });
+});
+dataProvider.post('/aggregate', async (ctx) => {
+    const body = ctx.request.body;
+    const bodyValidate = (0, validator_1.validateObject)(body, 'database collection accessQuery');
+    // fields validation
+    if (!bodyValidate.isValid) {
+        ctx.throw(412, JSON.stringify((0, reply_1.create)('e', { error: bodyValidate.requires })));
+    }
+    // access validation
+    const hasAccess = service.checkAccess(body.database, body.collection, security_1.AccessTypes.read, body.accessQuery, ctx.state.user);
+    if (!hasAccess)
+        ctx.throw(403, 'access denied');
+    // collection validation
+    const collection = service.getCollection(body.database, body.collection);
+    if (collection == null) {
+        ctx.throw(412, JSON.stringify((0, reply_1.create)('e', { error: 'wrong database or collection' })));
+    }
+    // operate on db
+    await collection
+        .aggregate(body.pipelines)
+        .exec()
+        .then(async (result) => {
+        // Call trigger
+        service.triggers.call('aggregate', body.database, body.collection, {
+            query: body.query,
+            queryResult: result,
+        });
+        ctx.body = { data: result };
+    })
+        .catch((err) => {
+        ctx.status = err.status || 500;
+        ctx.body = err.message;
+    });
+});
+dataProvider.post('/findByIds', async (ctx, next) => {
+    const body = ctx.request.body;
+    const bodyValidate = (0, validator_1.validateObject)(body, 'database collection ids');
+    // fields validation
+    if (!bodyValidate.isValid) {
+        ctx.throw(412, JSON.stringify((0, reply_1.create)('e', { error: bodyValidate.requires })));
+    }
+    // access validation
+    const hasAccess = service.checkAccess(body.database, body.collection, security_1.AccessTypes.read, body.accessQuery || {}, ctx.state.user);
+    if (!hasAccess)
+        ctx.throw(403, 'access denied');
+    // collection validation
+    const collection = service.getCollection(body.database, body.collection);
+    if (collection == null) {
+        ctx.throw(412, JSON.stringify((0, reply_1.create)('e', { error: 'wrong database or collection' })));
+    }
+    const or = [];
+    try {
+        body.ids.forEach((id) => {
+            const castedid = service.getAsID(id);
+            or.push({ _id: castedid });
+        });
+    }
+    catch (e) {
+        console.log('ids.forEach', e);
+    }
+    const pipelines = [
+        {
+            $match: { $or: or },
+        },
+        // {
+        //     $sort: body.sort || { _id: 1 }
+        // }
+    ];
+    // operate on db
+    await collection
+        .aggregate(pipelines)
+        .exec()
+        .then(async (result) => {
+        ctx.state = { data: result };
+        await next();
+    })
+        .catch((err) => {
+        ctx.status = err.status || 500;
+        ctx.body = err.message;
+    });
+});
+// Final middleware for converting mongoose documents to JSON
+dataProvider.use('/', async (ctx, next) => {
+    // this event is responsible to covert whole mongoose doc to json form
+    // including getters, public properties
+    // each mongoose doc must have a "toJson" method being defined on its own Schema.
+    const state = ctx.state;
+    // let result;
+    // // array
+    // if(!isNaN(state.length)) {
+    //     result = [];
+    //     for (let index = 0; index < state.length; index++) {
+    //         const element = state[index];
+    //         if(element.hasOwnProperty('toJson'))
+    //             result.push(element.toJson());
+    //         else result.push(element);
+    //     }
+    // }
+    // // object
+    // else {
+    //     result = state.toJson();
+    // }
+    ctx.body = state;
+});

package/dist/services/data_provider/service.d.ts

@@ -1,4 +1,5 @@
 import mongoose, { Model, PopulateOptions, Query } from 'mongoose';
+import triggerOperator from '../../class/trigger_operator';
 import TypeCasters from './typeCasters';
 import { CollectionDefinition } from '../../class/collection_definition';
 import { User } from '../../class/user';
@@ -128,4 +129,4 @@ export declare function performPopulateToQueryObject<T = any>(queryObj: Query<T,
  * ```
  */
 export declare function performAdditionalOptionsToQueryObject<T = any>(queryObj: Query<T, any>, options: Record<string, any>): Query<T, any>;
-export { TypeCasters };
+export { triggerOperator as triggers, TypeCasters };

package/dist/services/data_provider/service.js

@@ -3,7 +3,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.TypeCasters = exports.name = void 0;
+exports.TypeCasters = exports.triggers = exports.name = void 0;
 exports.addCollectionDefinitionByList = addCollectionDefinitionByList;
 exports.getCollection = getCollection;
 exports.checkAccess = checkAccess;
@@ -13,6 +13,7 @@ exports.performAdditionalOptionsToQueryObject = performAdditionalOptionsToQueryO
 const mongoose_1 = __importDefault(require("mongoose"));
 const security_1 = require("../../class/security");
 const trigger_operator_1 = __importDefault(require("../../class/trigger_operator"));
+exports.triggers = trigger_operator_1.default;
 const typeCasters_1 = __importDefault(require("./typeCasters"));
 exports.TypeCasters = typeCasters_1.default;
 /**

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@modular-rest/server",
-	"version": "1.13.4",
+	"version": "1.14.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/application.ts

@@ -78,7 +78,7 @@ export async function createRest(options: RestOptions): Promise<{ app: Koa; serv
     const defaultStaticPath = config.staticPath.actualPath || '';
     const defaultStaticRootPath = config.staticPath.path || '/assets';
 
-    const staticOptions: Partial<StaticPathOptions> = { ...config.staticPath };
+    const staticOptions: Partial<StaticPathOptions> = { ...config.staticPath, defer: true };
 
     delete staticOptions.actualPath;
     delete staticOptions.path;

package/src/services/data_provider/router.ts

@@ -6,6 +6,7 @@ import nestedProperty from 'nested-property';
 import * as service from './service';
 import * as middleware from '../../middlewares';
 import { Context, Next } from 'koa';
+import mongoose from 'mongoose';
 
 const name = 'data-provider';
 
@@ -91,6 +92,12 @@ dataProvider.post('/find', async (ctx: Context) => {
   await queryRequest
     .exec()
     .then(async docs => {
+      // Call trigger
+      service.triggers.call('find', body.database, body.collection, {
+        query: body.query,
+        queryResult: docs,
+      });
+
       ctx.body = { data: docs };
     })
     .catch(err => {
@@ -144,6 +151,12 @@ dataProvider.post('/find-one', async (ctx: Context) => {
   await queryRequest
     .exec()
     .then(async doc => {
+      // Call trigger
+      service.triggers.call('find-one', body.database, body.collection, {
+        query: body.query,
+        queryResult: doc,
+      });
+
       ctx.body = { data: doc };
     })
     .catch(err => {
@@ -179,7 +192,14 @@ dataProvider.post('/count', async (ctx: Context) => {
 
   await collection
     .countDocuments(body.query)
+    .exec()
     .then(count => {
+      // Call trigger
+      service.triggers.call('count', body.database, body.collection, {
+        query: body.query,
+        queryResult: count,
+      });
+
       ctx.body = { data: count };
     })
     .catch(err => {
@@ -188,4 +208,276 @@ dataProvider.post('/count', async (ctx: Context) => {
     });
 });
 
+dataProvider.post('/update-one', async (ctx: Context) => {
+  const body = ctx.request.body;
+  const bodyValidate = validateObject(body, 'database collection query update');
+
+  // fields validation
+  if (!bodyValidate.isValid) {
+    ctx.throw(412, JSON.stringify(reply('e', { error: bodyValidate.requires })));
+  }
+
+  // access validation
+  const hasAccess = service.checkAccess(
+    body.database,
+    body.collection,
+    AccessTypes.write,
+    body.query,
+    ctx.state.user
+  );
+  if (!hasAccess) ctx.throw(403, 'access denied');
+
+  // collection validation
+  const collection = service.getCollection(body.database, body.collection);
+  if (collection == null) {
+    ctx.throw(412, JSON.stringify(reply('e', { error: 'wrong database or collection' })));
+  }
+
+  // get removing doc as output for triggers
+  const output: any = await collection.findOne(body.query).exec().then();
+
+  // operate on db
+  await collection
+    .updateOne(body.query, body.update, body.options)
+    .exec()
+    .then(writeOpResult => {
+      // Call trigger
+      service.triggers.call('update-one', body.database, body.collection, {
+        query: body.query,
+        queryResult: writeOpResult,
+      });
+
+      ctx.body = { data: writeOpResult };
+    })
+    .catch(err => {
+      ctx.status = err.status || 500;
+      ctx.body = err.message;
+    });
+});
+
+dataProvider.post('/insert-one', async (ctx: Context) => {
+  const body = ctx.request.body;
+  const bodyValidate = validateObject(body, 'database collection doc');
+
+  // fields validation
+  if (!bodyValidate.isValid) {
+    ctx.throw(412, JSON.stringify(reply('e', { error: bodyValidate.requires })));
+  }
+
+  // access validation
+  const hasAccess = service.checkAccess(
+    body.database,
+    body.collection,
+    AccessTypes.write,
+    body.doc,
+    ctx.state.user
+  );
+  if (!hasAccess) {
+    console.log(body);
+    console.log(ctx.state.user.permission);
+    ctx.throw(403, 'access denied');
+  }
+
+  // collection validation
+  const collection = service.getCollection(body.database, body.collection);
+  if (collection == null) {
+    ctx.throw(412, JSON.stringify(reply('e', { error: 'wrong database or collection' })));
+  }
+
+  // operate on db
+  await new collection(body.doc)
+    .save()
+    .then(async newDoc => {
+      // Call trigger
+      service.triggers.call('insert-one', body.database, body.collection, {
+        query: body.query,
+        queryResult: newDoc,
+      });
+
+      ctx.body = { data: newDoc };
+    })
+    .catch(err => {
+      ctx.status = err.status || 500;
+      ctx.body = err.message;
+    });
+});
+
+dataProvider.post('/remove-one', async (ctx: Context) => {
+  const body = ctx.request.body;
+  const bodyValidate = validateObject(body, 'database collection query');
+
+  // fields validation
+  if (!bodyValidate.isValid) {
+    ctx.throw(412, JSON.stringify(reply('e', { error: bodyValidate.requires })));
+  }
+
+  // access validation
+  const hasAccess = service.checkAccess(
+    body.database,
+    body.collection,
+    AccessTypes.write,
+    body.query,
+    ctx.state.user
+  );
+  if (!hasAccess) ctx.throw(403, 'access denied');
+
+  // collection validation
+  const collection = service.getCollection(body.database, body.collection);
+  if (collection == null) {
+    ctx.throw(412, JSON.stringify(reply('e', { error: 'wrong database or collection' })));
+  }
+
+  // get removing doc as output for triggers
+  const output: any = await collection.findOne(body.query).exec().then();
+
+  // operate on db
+  await collection
+    .deleteOne(body.query)
+    .exec()
+    .then(async (result: any) => {
+      // Call trigger
+      service.triggers.call('remove-one', body.database, body.collection, {
+        query: body.query,
+        queryResult: result,
+      });
+
+      ctx.body = { data: result };
+    })
+    .catch((err: Error) => {
+      ctx.status = (err as any).status || 500;
+      ctx.body = err.message;
+    });
+});
+
+dataProvider.post('/aggregate', async (ctx: Context) => {
+  const body = ctx.request.body;
+  const bodyValidate = validateObject(body, 'database collection accessQuery');
+
+  // fields validation
+  if (!bodyValidate.isValid) {
+    ctx.throw(412, JSON.stringify(reply('e', { error: bodyValidate.requires })));
+  }
+
+  // access validation
+  const hasAccess = service.checkAccess(
+    body.database,
+    body.collection,
+    AccessTypes.read,
+    body.accessQuery,
+    ctx.state.user
+  );
+  if (!hasAccess) ctx.throw(403, 'access denied');
+
+  // collection validation
+  const collection = service.getCollection(body.database, body.collection);
+  if (collection == null) {
+    ctx.throw(412, JSON.stringify(reply('e', { error: 'wrong database or collection' })));
+  }
+
+  // operate on db
+  await collection
+    .aggregate(body.pipelines)
+    .exec()
+    .then(async (result: any) => {
+      // Call trigger
+      service.triggers.call('aggregate', body.database, body.collection, {
+        query: body.query,
+        queryResult: result,
+      });
+
+      ctx.body = { data: result };
+    })
+    .catch((err: any) => {
+      ctx.status = err.status || 500;
+      ctx.body = err.message;
+    });
+});
+
+dataProvider.post('/findByIds', async (ctx: Context, next: Next) => {
+  const body = ctx.request.body;
+  const bodyValidate = validateObject(body, 'database collection ids');
+
+  // fields validation
+  if (!bodyValidate.isValid) {
+    ctx.throw(412, JSON.stringify(reply('e', { error: bodyValidate.requires })));
+  }
+
+  // access validation
+  const hasAccess = service.checkAccess(
+    body.database,
+    body.collection,
+    AccessTypes.read,
+    body.accessQuery || {},
+    ctx.state.user
+  );
+  if (!hasAccess) ctx.throw(403, 'access denied');
+
+  // collection validation
+  const collection = service.getCollection(body.database, body.collection);
+  if (collection == null) {
+    ctx.throw(412, JSON.stringify(reply('e', { error: 'wrong database or collection' })));
+  }
+
+  const or: Array<{ _id: any }> = [];
+
+  try {
+    body.ids.forEach((id: any) => {
+      const castedid = service.getAsID(id);
+      or.push({ _id: castedid });
+    });
+  } catch (e) {
+    console.log('ids.forEach', e);
+  }
+
+  const pipelines = [
+    {
+      $match: { $or: or },
+    },
+    // {
+    //     $sort: body.sort || { _id: 1 }
+    // }
+  ];
+
+  // operate on db
+  await collection
+    .aggregate(pipelines)
+    .exec()
+    .then(async (result: any[]) => {
+      ctx.state = { data: result };
+      await next();
+    })
+    .catch((err: Error) => {
+      ctx.status = (err as any).status || 500;
+      ctx.body = err.message;
+    });
+});
+
+// Final middleware for converting mongoose documents to JSON
+dataProvider.use('/', async (ctx: Context, next: Next) => {
+  // this event is responsible to covert whole mongoose doc to json form
+  // including getters, public properties
+  // each mongoose doc must have a "toJson" method being defined on its own Schema.
+
+  const state = ctx.state;
+  // let result;
+
+  // // array
+  // if(!isNaN(state.length)) {
+  //     result = [];
+
+  //     for (let index = 0; index < state.length; index++) {
+  //         const element = state[index];
+  //         if(element.hasOwnProperty('toJson'))
+  //             result.push(element.toJson());
+  //         else result.push(element);
+  //     }
+  // }
+  // // object
+  // else {
+  //     result = state.toJson();
+  // }
+
+  ctx.body = state;
+});
+
 export { name, dataProvider as main };

package/src/services/data_provider/service.ts

@@ -302,4 +302,5 @@ export function performAdditionalOptionsToQueryObject<T = any>(
   return queryObj;
 }
 
-export { TypeCasters };
+// Instead, export triggerOperator as triggers
+export { triggerOperator as triggers, TypeCasters };