![](\"https://raw.githubusercontent.com/leganux/apied-pipper/main/apiedpiper.jpg\" "\\"apied")
\n\n \n
\n\n\n
\n\n## How to use\n\n**Install**\n\n```text\nnpm install apied-piper\n```\n\n```javascript\n// example definition object\nlet definitionObject = {\n employee: {\n operation: {\n createOne: true,\n createMany: true,\n getMany: true,\n getOneById: true,\n getOneWhere: true,\n findUpdateOrCreate: true,\n findUpdate: true,\n updateById: true,\n findIdAndDelete: true,\n },\n definition: {\n name: {\n type: 'string',\n mandatory: true\n },\n position: {\n type: 'age',\n },\n location: {\n type: 'string',\n },\n }\n }\n}\n\n// import library\nlet piedPiper = require('apied-piper');\n\n\n//Create new service API REST instance\nlet microService = new piedPiper(definitionObject, 'mongodb://localhost:27017/piedpipper', 3000, options)\n\n\n// construct routes\nmicroService.constructRoutes()\n\n\n// start the service\nmicroService.start()\n\n```\n\n**Full example definition object**\n\n```javascript\nlet definitionObject = {\n kindOfClassmate: {\n operation: {\n all: true\n },\n definition: {\n name: {\n type: 'string',\n mandatory: true\n },\n active: {\n type: 'boolean',\n mandatory: true\n },\n createdAt: {\n type: 'date',\n mandatory: true,\n default_function: dateFunction\n },\n }\n },\n classmate: {\n operation: {\n all: true\n },\n definition: {\n name: {\n type: 'string',\n mandatory: true\n },\n age: {\n type: 'number',\n mandatory: true\n },\n kind: {\n type: 'oid',\n rel: 'kindOfClassmate'\n },\n moreInfo: {\n type: 'any',\n },\n }\n },\n classRoom: {\n operation: {\n createOne: true,\n createMany: true,\n getMany: true,\n getOneById: true,\n getOneWhere: true,\n findUpdateOrCreate: true,\n findUpdate: true,\n updateById: true,\n findIdAndDelete: true,\n },\n definition: {\n name: {\n type: 'string',\n mandatory: true\n },\n description: {\n type: 'string',\n mandatory: true\n },\n isOpen: {\n type: 'boolean',\n },\n position: {\n type: 'number',\n },\n createdAt: {\n type: 'date',\n mandatory: true,\n default_function: dateFunction\n },\n classmates: {\n type: 'array_oid',\n rel: 'classmate'\n }\n\n }\n }\n}\n\n```\n\n**SSL support**\n\n```javascript\n\nlet options = {active_cors: false}\nlet ssl_config = {\n private: \"path/to/private/key\", // SSL key file location\n cert: \"path/to/certificate/file\", // CERT file location\n port: 443,// SSL port\n}\n\nlet microService = new piedPiper(definitionObject, 'mongodb://localhost:27017/apied-pipper', 80, options, ssl_config)\n\n```\n\n**Options**\n\nOptions can be used to personalize every instance of APIed-Piper\n\n```javascript\n\nlet options = {\n active_cors: true, // if you want to allow cors from everywhere *optional*\n api_base_uri: '/apiv2/', // the base url you consume. default = /api/ *optional*\n activeLogRequest: true, // shows in console all the http request in te API *optional*\n acl: {[object]}, //the acl definition for auth routes. Read the documentation below *optional*\n acl_custom: {[object]}, //the acl definition for auth in custom routes *optional*\n middleware: async function (req, res, next) { //custom middelware function for rutes, use as express middelware *optional*\n next()\n },\n db_timestamps: true // adds automaticalli collections fields updateAt & createdAt *optional*\n\n}\n\n\n```\n\n**Mailing (for register activation and reset password)**\n\nYou can review nodemailer documentation for more info\n\n```javascript\n\nlet transport = {\n host: \"smtp.apipedpiper.com\",\n port: 587,\n secure: false, // upgrade later with STARTTLS\n auth: {\n user: \"apiedpiper\",\n pass: \"tables\",\n },\n}\nlet data = await microService.configureMailer(transport)\n\n// console data: \n\n{\n verify:[object],\n transporter\n:\n {\n ClassTransporter\n Nodemailer\n }\n\n}\n\n```\n\nNow you can use this config to send mails\n\n```javascript\n\nlet message = {\n from: \"sender@server.com\",\n to: \"apied-piper@leganux.com\",\n subject: \"Default mail from Apied Piper\",\n html: \"Default mail from Apied Piper
\",\n attachments: [\n {\n filename: 'text3.txt',\n path: '/path/to/file.txt'\n }\n\n ]\n}\n\nlet data = await microService.sendMail(message)\n\n// console data: \n{\n Object\n Nodemailer\n sended\n}\n\n```\n\n**ACL and Login**\n\nNow in version 3.0+ you can create an easy ACL to allow or disallow access some profiles to some routes. This acl\nincludes the pre-register of first admin user, a register module, a login module, a token generator and finaly an\nautomatic middleware to validate sessions.\nAPIed-Piper now is a solution all in one to easy deploy APIs with protection included.\n\nTo use those new functions you must to invoque activeLoginAndRegister method as describe bellow\n\nThe ACL object defines which role has what permissions, a continuation an example.\n\n```javascript\n\nlet acl = {\n Admin: {\n kindOfClassmate: '*',\n classmate: '*',\n classRoom: '*',\n },\n User: {\n kindOfClassmate: {\n getMany: true,\n getOneById: true,\n getOneWhere: true,\n findUpdateOrCreate: true,\n findUpdate: true,\n updateById: true,\n findIdAndDelete: true,\n datatable: true,\n datatable_aggregate: true,\n },\n classmate: {\n createOne: true,\n createMany: true,\n getMany: true,\n getOneById: true,\n getOneWhere: true,\n },\n classRoom: {\n getMany: true,\n getOneById: true,\n getOneWhere: true,\n },\n\n }\n}\n\n```\n\nconfig and call to method (now you need to execute config email to activate users via email)\n\n```javascript\nlet defaultUser = {user: \"Jared\", pass: \"Meinertzhagens-Haversack\", email: \"JaredDunn@piedpiper.com\"} // defines the first admin will be created in system, be carafull\nlet collection = 'signature-box' //the model and collection name to save profiles and roles\n\nlet optionsLogin = {\n activeNewUsers: true, //DEPRECATED ----> REMOVED FOR SCURITY REASONS\n adminProfileName: \"Admin\", // the name of main role default:admin\n fAfterRegister: async function (user) { // callback to execute after user register\n return user\n },\n durationToken: 60, // time in munites will token live default:60\n JWTPASSWORD: \"bachmanityinsanity\", // the token pasword for auth\n sendConfirmMail: { //mandatory to activate users by mail\n from: 'activate@myserver.com',//mail of sender, typically the mail of nodemailer config\n subject: 'Please activate account',//topic of activation subject\n html: \"Please activate account, open next link:\n ![](\"https://leganux.net/web/wp-content/uploads/2020/01/circullogo.png\" "\\"hover")
\n
\n APIed Piper is another project of leganux.net © 2021 all rights reserved\n
\n This project is distributed under the MIT license. \n\n
\n
\nThe logo and the name of APIed Piper is inspired by the name of PiedPiper, the fictional company of Richard Hendrikcs, a character from the HBO series, Silicon Valley. This inspiration was taken for fun purposes only. The original name and logo reserve their rights to their original creators. \n