@vulkano/core 1.20.1 → 1.22.0

package/database/mongodb.js

@@ -175,12 +175,17 @@ module.exports = async function loadDatabaseApplication() {
       }
 
       // Update
+      // Bound to "updateOne" (the Mongoose 8 document method) rather than the
+      // legacy "update" hook name: Mongoose no longer fires "update" middleware,
+      // and that name collides with the scaffold's own `Model.update()` static
+      // (schema.statics.update), which Mongoose auto-wraps with any hook whose
+      // name matches an existing static method.
       if (current.beforeUpdate) {
-        schema.pre('update', current.beforeUpdate);
+        schema.pre('updateOne', { document: true, query: false }, current.beforeUpdate);
         delete schema.statics.beforeUpdate;
       }
       if (current.afterUpdate) {
-        schema.post('update', current.afterUpdate);
+        schema.post('updateOne', { document: true, query: false }, current.afterUpdate);
         delete schema.statics.afterUpdate;
       }
 
@@ -195,12 +200,14 @@ module.exports = async function loadDatabaseApplication() {
       }
 
       // Remove
+      // Bound to "deleteOne" (the Mongoose 8 document method): `doc.remove()`
+      // and the legacy "remove" hook name were both removed upstream.
       if (current.beforeRemove) {
-        schema.pre('remove', current.beforeRemove);
+        schema.pre('deleteOne', { document: true, query: false }, current.beforeRemove);
         delete schema.statics.beforeRemove;
       }
       if (current.afterRemove) {
-        schema.post('remove', current.afterRemove);
+        schema.post('deleteOne', { document: true, query: false }, current.afterRemove);
         delete schema.statics.afterRemove;
       }
 

package/examples/config/express/cookies.js

@@ -0,0 +1,15 @@
+/**
+ * Cookies Config
+ */
+
+module.exports = {
+
+  // Enable cookie parser middleware
+  // @type Boolean
+  enabled: false,
+
+  // Secret key used to sign cookies — use https://api.wordpress.org/secret-key/1.1/salt/
+  // @type String
+  secret: process.env.COOKIES_SECRET_KEY || ''
+
+};

package/examples/config/express/cors.js

@@ -0,0 +1,23 @@
+/**
+ * CORS Config
+ */
+
+module.exports = {
+
+  // Enable CORS
+  // @type Boolean
+  enabled: false,
+
+  // Path where CORS headers are applied
+  // @type String
+  path: '/',
+
+  // Allowed origin
+  // @type String
+  origin: '*',
+
+  // Additional allowed request headers
+  // @type Array
+  headers: ['x-token-auth']
+
+};

package/examples/config/express/csp.js

@@ -0,0 +1,74 @@
+/**
+ * Content Security Policy
+ *
+ * Requires an endpoint to receive CSP violation reports.
+ */
+
+module.exports = {
+
+  // Enable CSP
+  enabled: false,
+
+  // Reporting endpoint
+  report: {
+    group: 'csp-endpoint',
+    max_age: '10886400',
+    endpoints: [
+      {
+        // Replace with your domain
+        url: 'https://yourdomain.com/__cspreport__'
+      }
+    ]
+  },
+
+  // CSP rules
+  rules: {
+
+    'default-src': ["'self'"],
+
+    'form-action': ["'self'"],
+
+    'font-src': [
+      "'self'",
+      'data:',
+      // 'fonts.googleapis.com',
+      // 'fonts.gstatic.com',
+    ],
+
+    'img-src': [
+      "'self'",
+      'data:',
+      // '*.google-analytics.com',
+    ],
+
+    'script-src': [
+      "'self'",
+      // "'unsafe-inline'",
+      // "'unsafe-eval'",
+    ],
+
+    'style-src': [
+      "'self'",
+      "'unsafe-inline'",
+      'cdnjs.cloudflare.com'
+    ],
+
+    'style-src-elem': [
+      "'self'",
+      // 'fonts.googleapis.com',
+    ],
+
+    'frame-src': ["'self'"],
+
+    'frame-ancestors': ["'self'"],
+
+    'connect-src': [
+      "'self'",
+      // '*.google-analytics.com',
+    ],
+
+    'report-to': ['csp-endpoint']
+
+  }
+
+};

package/examples/config/express/helmet.js

@@ -0,0 +1,19 @@
+/**
+ * Helmet Config
+ * See https://helmetjs.github.io/ for all available options
+ */
+
+module.exports = {
+
+  // Referrer policy header
+  referrerPolicy: {
+    policy: 'strict-origin-when-cross-origin'
+  },
+
+  // Disable built-in CSP — managed separately via csp.js
+  contentSecurityPolicy: false,
+
+  // Disable COEP to allow embedding cross-origin resources
+  crossOriginEmbedderPolicy: false
+
+};

package/examples/config/express/json.js

@@ -0,0 +1,14 @@
+/**
+ * Express JSON body parser config
+ */
+
+module.exports = {
+
+  // MIME types accepted as JSON body
+  type: [
+    'application/json',
+    'application/csp-report',
+    'application/reports+json'
+  ]
+
+};

package/examples/config/express/jwt.js

@@ -0,0 +1,39 @@
+/**
+ * JWT Config
+ */
+
+module.exports = {
+
+  // Enable JWT
+  // @type Boolean
+  enabled: false,
+
+  // Secret key — use https://api.wordpress.org/secret-key/1.1/salt/ to generate one
+  // @type String
+  key: process.env.JWT_SECRET_KEY || '',
+
+  // Header name used to send the token
+  // @type String
+  header: 'x-token-auth',
+
+  // Query parameter name used to send the token
+  // @type String
+  queryParameter: 'token',
+
+  // Cookie name used to send the token
+  // @type String
+  cookieName: 'token',
+
+  // Path where the token is required
+  // @type String
+  path: '/api/',
+
+  // Paths excluded from token verification
+  // See https://github.com/jfromaniello/express-unless for pattern examples
+  // @type Array
+  ignore: [
+    '/api/',
+    /^\/api\/auth(?!\/(current))/i
+  ]
+
+};

package/examples/config/express/permissionPolicy.js

@@ -0,0 +1,24 @@
+/**
+ * Permission Policy Config
+ */
+
+module.exports = {
+
+  // Enable Permission Policy header
+  // @type Boolean
+  enabled: false,
+
+  // Browser features to restrict — empty list means blocked for all origins
+  // @type Array
+  permissions: [
+    'accelerometer=()',
+    'camera=()',
+    'geolocation=()',
+    'gyroscope=()',
+    'magnetometer=()',
+    'microphone=()',
+    'payment=()',
+    'usb=()'
+  ]
+
+};

package/examples/config/express/settings.js

@@ -0,0 +1,25 @@
+/**
+ * Express server settings
+ */
+
+module.exports = {
+
+  // Show "X-Powered-By" header
+  // @type Boolean
+  poweredBy: false,
+
+  // Request timeout in milliseconds
+  // @type Number
+  timeout: 120000,
+
+  // Folder to upload files
+  // @type String
+  uploadPath: 'public/files',
+
+  // Number of proxy hops to trust for X-Forwarded-* headers.
+  // Use 1 when behind a single load balancer, true to trust all (less secure).
+  // See https://expressjs.com/en/guide/behind-proxies.html
+  // @type Number | Boolean
+  trustProxy: 1
+
+};

package/examples/config/middlewares/auth.js

@@ -0,0 +1,38 @@
+/**
+ * Middleware.js
+ *
+ * This file intercept all requests to make validations before running a controller
+ *
+ */
+module.exports = (req, res, next) => {
+
+  const {
+    auth: authEncripted
+  } = req;
+
+  if (authEncripted) {
+    const decoded = Jwt.decrypt(authEncripted);
+    req.auth = (decoded) ? { ...decoded, token: Jwt.getToken(req) } : {};
+  }
+
+  // Remove this line if you need make validations
+  next();
+
+  //
+  // You can make validations to check ACL or anything before to run a controller
+  // Example:
+  //
+
+  /*
+  if (req.auth && +req.auth.role !== 1) {
+    const data = {
+      success: false,
+      error: 'You don\'t have permissions to access this option.'
+    }
+    res.status(403).jsonp(data);
+  } else {
+    next();
+  }
+  */
+
+};

package/examples/config/sockets/adapters/mongodb.js

@@ -0,0 +1,12 @@
+module.exports = {
+
+  //
+  // Connection: you can use the same connection
+  // set a custom Mongo URI connection to manage the sockets
+  //
+  connection: process.env.SOCKETS_MONGO_URI || null,
+
+  // Collection to save the records
+  collection: process.env.SOCKETS_MONGO_COLLECTION || 'socket.io-adapter-events'
+
+};

package/examples/config/sockets/adapters/redis.js

@@ -0,0 +1,9 @@
+module.exports = {
+
+  host: process.env.REDIS_HOST || 'localhost',
+
+  port: process.env.REDIS_PORT || '6379',
+
+  password: process.env.REDIS_PASSWORD || ''
+
+};

package/examples/config/sockets/config.js

@@ -0,0 +1,50 @@
+/**
+ *
+ * Sockets Config
+ *
+ */
+
+module.exports = {
+
+  // Enable sockets
+  enabled: true,
+
+  // Socket IO Adapter (redis|mongodb|memory)
+  adapter: 'memory',
+
+  // Socket configuration
+  config: {
+
+    // Transports
+    transports: ['websocket', 'polling'],
+
+    // Socket timeout
+    timeout: 4000,
+
+    // Interval
+    interval: 2000,
+
+  },
+
+  // Connections
+  connections: {
+
+    users: 0,
+
+    // Clients connected
+    clients: {}
+
+  },
+
+  // Event handlers
+  // onConnect: (io, socket, clients, counter) => {
+  //   counter.users++;
+  //   clients[socket.request.user._id] = socket.id;
+  //   io.emit('users:counter', counter.users);
+  // },
+  // onDisconnect: (io, socket, clients, counter) => {
+  //   counter.users--;
+  //   delete clients[socket.request.user._id];
+  //   io.emit('users:counter', counter.users);
+  // }
+};

package/examples/config/sockets/cors.js

@@ -0,0 +1,32 @@
+module.exports = (req, callback) => {
+
+  const {
+    origin,
+    host,
+  } = req.headers || {};
+
+  const realOrigin = origin || host;
+
+  const allowedOrigin = [
+    'localhost',
+    'yourdomain.com'
+  ];
+
+  let found = false;
+
+  allowedOrigin.forEach((o) => {
+
+    if ((realOrigin || '').indexOf(o) !== -1) {
+      found = true;
+    }
+
+  });
+
+  if (found) {
+    callback(null, true);
+  } else {
+    console.log('Invalid origin', realOrigin || 'No Origin');
+    callback(new Error(`Invalid origin ${realOrigin} - Socket CORS`));
+  }
+
+};

package/examples/config/sockets/events.js

@@ -0,0 +1,12 @@
+module.exports = {
+
+  // Examples Chat
+  // event:action: folder.YourController.method
+  //
+  // 'chat:signin': 'sockets.ChatController.signin',
+  // 'chat:message': 'sockets.ChatController.save',
+  // 'chat:history': 'sockets.ChatController.get'
+
+  'echo': 'sockets.EchoController.echo'
+
+};

package/examples/config/sockets/middlewares/auth.js

@@ -0,0 +1,20 @@
+module.exports = (socket, next) => {
+
+  // Security
+  const user = Jwt.socket(socket);
+
+  const {
+    _id
+  } = user || {};
+
+  if (!_id) {
+    console.log('Sockets Middleware: Invalid ID');
+    next(new Error(`Invalid user ${_id || 'or token'}`));
+  }
+
+  // eslint-disable-next-line no-param-reassign
+  socket.request.user = user || {};
+
+  next();
+
+};

package/examples/config/views/config.js

@@ -0,0 +1,8 @@
+
+module.exports = {
+
+ engine: 'nunjucks|handlebars',
+
+ ext: '.html'
+
+};

package/examples/config/views/filters/example.js

@@ -0,0 +1,6 @@
+// Filter-style helper (positional arg):
+// Nunjucks: {{ 'hello' | example }}
+// Handlebars: {{ example 'hello' }}
+module.exports = (str) => {
+  return (str || '').split('').join(' ');
+};

package/examples/config/views/helpers/strpad.js

@@ -0,0 +1,51 @@
+/**
+ * Pads a string to a certain length with another string.
+ * The padding is applied from the left, right, or both sides of the string.
+ *
+ * Example: {{ strpad('hello world', 20, '*', 'left') }} => '*********hello world'
+ *
+ * @param {*} str
+ * @param {*} _len
+ * @param {*} _pad
+ * @param {*} _dir
+ * @returns String
+ */
+
+module.exports = (str, _len, _pad, _dir) => {
+
+  const STR_PAD_LEFT = 1;
+  const STR_PAD_RIGHT = 2;
+  const STR_PAD_BOTH = 3;
+
+  const len = _len || 0;
+  const pad = _pad || ' ';
+  const dir = _dir || STR_PAD_RIGHT;
+
+  let newStr = '';
+
+  if (len + 1 >= str.length) {
+
+    const padlen = len - str.length;
+    const right = Math.ceil(padlen / 2);
+    const left = padlen - right;
+
+    switch (dir) {
+      case STR_PAD_LEFT:
+        newStr = Array(len + 1 - str.length).join(pad) + str;
+        break;
+      case 'left':
+        newStr = Array(len + 1 - str.length).join(pad) + str;
+        break;
+      case STR_PAD_BOTH:
+        newStr = Array(left + 1).join(pad) + str + Array(right + 1).join(pad);
+        break;
+      default:
+        newStr = str + Array(len + 1 - str.length).join(pad);
+        break;
+    }
+
+  }
+
+  return newStr;
+
+};

package/examples/controllers/ExampleController.js

@@ -0,0 +1,22 @@
+// This is an example for a simple controller that renders a view.
+// It is a good starting point for creating a simple web application.
+
+module.exports = {
+
+  // Method to render the home page
+  // Example: domain.com/example/
+  get(req, res) {
+
+    res.render('example/index.html', { title: 'This is an example home page' });
+
+  },
+
+  // Method to render the about page
+  // Example: domain.com/example/about/
+  about(req, res) {
+
+    res.render('example/about.html', { title: 'This is an example about page' });
+
+  }
+
+};

package/examples/controllers/RestExampleController.js

@@ -0,0 +1,78 @@
+/* global Example */
+
+/*
+ * This endpoint is protected by JWT, please disabled it to test
+ */
+
+// This is an example for Full API Rest controller that provides CRUD operations.
+// It is a good starting point for creating a RESTful API.
+// The business logic is implemented in the Example model, which is a good practice
+// to keep the controller thin and focused on handling requests and responses.
+
+module.exports = {
+
+  // Method to get all records from the model
+  // Example: GET /projects/?page=1
+  get(req, res) {
+
+    // Status code: 200 (default)
+    res.vsr(Example.getAll(req.query || {}));
+
+  },
+
+  // Method to create a new record in the model
+  // Example: POST /projects/
+  post(req, res) {
+
+    const {
+      body
+    } = req || {};
+
+    // Status code: 201 (created)
+    res.vsr(Example.create(body), 201);
+
+  },
+
+  // Method to get a record by id from the model
+  // Example: GET /projects/:id
+  'get :id': (req, res) => {
+
+    const {
+      id
+    } = req.params;
+
+    // Status code: 200 (default)
+    res.vsr(Example.getExample(id));
+
+  },
+
+  // Method to update a record by id in the model
+  // Example: PUT /projects/:id
+  'put :id': (req, res) => {
+
+    const {
+      id
+    } = req.params;
+
+    const {
+      body
+    } = req || {};
+
+    // Status code: 202 (accepted)
+    res.vsr(Example.update(id, body), 202);
+
+  },
+
+  // Method to delete a record by id from the model
+  // Example: DELETE /projects/:id
+  'delete :id': (req, res) => {
+
+    const {
+      id
+    } = req.params;
+
+    res.vsr(Example.remove(id), 204);
+
+  }
+
+};

package/examples/controllers/RestScaffoldController.js

@@ -0,0 +1,18 @@
+/*
+ * This endpoint is protected by JWT, please disable it to test
+ */
+
+// Scaffold Controller is a controller that provides CRUD operations for a model.
+// It is a generic controller that can be used to create, read, update, and delete records
+// from a model. It is a good starting point for creating a
+// RESTful API.
+
+module.exports = {
+
+  // Model to CRUD (create, read, update, and delete) records — must exist as global.ExampleWithScaffold
+  scaffold: 'ExampleWithScaffold',
+
+  // Allowed methods
+  allowedMethods: ['get', 'post', 'put', 'delete']
+
+};