@vulkano/core 1.20.1 → 1.20.2

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,21 @@
+/*
+ * 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 = {
+
+  // Extend methods of Scaffold Controller and Scaffold Model
+  scaffold: true,
+
+  // Allowed methods
+  allowedMethods: ['get', 'post', 'put', 'delete'],
+
+  // Model to CRUD (create, read, update, and delete) records
+  model: 'ExampleWithScaffold'
+
+};

package/examples/models/Example.js

@@ -0,0 +1,178 @@
+/* global Example */
+
+/**
+ * Example.js
+ */
+
+// This is an example for a simple model that provides CRUD operations.
+// Provide a flexible way to implement business logic in the model, which is a good practice
+// to keep the controller thin and focused on handling requests and responses.
+
+module.exports = {
+
+  /**
+   * Fields
+   */
+  attributes: {
+    name: {
+      type: String,
+      required: true
+    },
+    age: {
+      type: Number,
+      required: false,
+      validate: {
+        validator: (value) => {
+          const isValid = (value >= 21) ? true : false;
+          return isValid;
+        },
+        message: 'Invalid Age: Must be +21.',
+      }
+    }
+    // the fields:
+    // active, createdAt, updatedAt
+    // was created automatically
+  },
+
+  // Custom Index
+  indexes: [
+    {
+      name: 'text'
+    }
+  ],
+
+  /**
+   * Method to get all records by page
+   *
+   * @param {Object} props (page, perPage, search, sort)
+   * @returns {Promise}
+   */
+  getAll(props) {
+
+    // Props to Query
+    const defaultProps = {
+      sort: 'createdAt|DESC',
+      searchBy: ['name'],
+      filter: {
+        active: true
+      },
+    };
+
+    // Populate
+    const populate = [];
+
+    // Query to Run
+    const query = Paginate.serializeQuery(defaultProps, props);
+
+    // Pagination
+    return Paginate.get(Example, query, populate);
+
+  },
+
+  /**
+   * Method to get a record by id
+   *
+   * @param {ObjectID} id
+   * @returns {Promise}
+   */
+  getExample(_id) {
+
+    // This is to prevent error while run the findOne
+    if (!(/^[a-fA-F0-9]{24}$/).test(_id)) {
+      return VSError.reject('Invalid ID. Record not found', 404);
+    }
+
+    return Example.findOne({ _id })
+      .then( (r) => {
+
+        if (!r) {
+          return VSError.notFound();
+        }
+
+        return r.toObject({ transform: true });
+
+      });
+
+  },
+
+  /**
+   * Method to create a new record
+   * @param {Promise} data
+   */
+  create(data) {
+
+    const obj = new Example(data);
+    return obj.save();
+
+  },
+
+  /**
+   * Method to update a record
+   * @param {ObjectID} id
+   * @param {Object} data
+   * @returns {Promise}
+   */
+  update(_id, data) {
+
+    return Example.getExample(_id)
+      .then( (record) => {
+
+        // Merge current info with incoming values
+        const merged = { ...record, ...data };
+
+        return Example
+          .findOneAndUpdate({ _id }, merged, { new: true })
+          .then( (r) => {
+
+            const tmp = r.toObject({ transform: true });
+            return tmp;
+
+          });
+
+      });
+
+  },
+
+  /**
+   * Method to delete a record
+   * @param {ObjectID} id
+   * @returns {Promise}
+   */
+  delete(id) {
+
+    // Soft delete
+    return this.update(id, { active: false });
+
+  },
+
+  /**
+   * Before save callback
+   * @param {Callback} cb
+   */
+  beforeSave(cb) {
+
+    const data = this;
+
+    console.log('Running callback before save');
+    console.log(data);
+
+    // All good!
+    cb();
+
+  },
+
+  /**
+   * Callback after save
+   * @param {Callback} cb
+   */
+  afterSave(data, cb) {
+
+    console.log('Running callback after save');
+    console.log(data);
+
+    // All good!
+    cb();
+
+  },
+
+};

package/examples/models/ExampleWithScaffold.js

@@ -0,0 +1,51 @@
+/**
+ * ExampleWithScaffold.js
+ */
+
+// This is an example for a simple model that provides CRUD operations with a scaffold.
+// Provide a flexible way to implement business logic in the model, which is a good practice
+// to keep the controller thin and focused on handling requests and responses.
+
+// Scaffold (Model name: ExampleWithScaffold) - Allowed Methods:
+// ExampleWidthScaffold.getAllExampleWidthScaffold(props) { page, perPage, search, sort }
+// ExampleWidthScaffold.getAll(props) (alias to getAllModelName)
+// ExampleWidthScaffold.create(payload) { name, age }
+// ExampleWidthScaffold.getByField(email, 'email') (alias)
+// ExampleWidthScaffold.getExampleWidthScaffold(id)
+// ExampleWidthScaffold.update(id, payload)
+// ExampleWidthScaffold.delete(id)
+
+module.exports = {
+
+  /**
+   * Fillable fields for the update method
+   * to prevent update of non-allowed fields like createdAt, updatedAt, etc.
+   * @type Array
+   */
+  fillable: ['name', 'age'],
+
+  /**
+   * Fields
+   */
+  attributes: {
+    name: {
+      type: String,
+      required: true
+    },
+    age: {
+      type: Number,
+      required: false,
+      validate: {
+        validator: (value) => {
+          const isValid = (value >= 21) ? true : false;
+          return isValid;
+        },
+        message: 'Invalid Age: Must be +21.',
+      }
+    },
+    // the fields:
+    // active, createdAt, updatedAt
+    // was created automatically
+  }
+
+};

package/examples/views/_shared/templates/default.html

@@ -0,0 +1,20 @@
+<!DOCTYPE HTML>
+<html lang="en">
+  <head>
+    <title>{{ title }}</title>
+    <meta charset=UTF-8 >
+    <meta http-equiv="X-UA-Compatible" content="IE=edge">
+    <meta name="viewport" content="width=device-width, initial-scale=1.0">
+    <link rel="shortcut icon" type="image/png" href="/favicon.png?v={{ app.pkg.version }}" />
+
+    {{ vite({ entry: 'app', type: 'style' }) | safe }}
+
+  </head>
+  <body>
+
+    <div id="app">{% block content %}{% endblock %}</div>
+
+    {{ vite({ entry: 'app', type: 'script' }) | safe }}
+
+  </body>
+</html>

package/examples/views/index.html

@@ -0,0 +1,7 @@
+{% extends "_shared/templates/default.html" %}
+
+{% block content %}
+
+Your content goes here.
+
+{% endblock %}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@vulkano/core",
-  "version": "1.20.1",
+  "version": "1.20.2",
   "description": "A MVC framework using Express 4",
   "license": "MIT",
   "author": "Vulkano Team",
@@ -69,4 +69,4 @@
     "socket.io-adapter": "^2.5.8",
     "undici": "^7.28.0"
   }
-}
+}

package/pnpm-workspace.yaml

@@ -4,10 +4,16 @@ allowBuilds:
 catalog:
   vite: npm:@voidzero-dev/vite-plus-core@latest
   vitest: npm:@voidzero-dev/vite-plus-test@latest
-  vite-plus: latest
+  vite-plus: ^0.2.4
 overrides:
   vite: "catalog:"
   vitest: "catalog:"
+  # Safety floor for the real "vite" package pnpm auto-installs to satisfy
+  # @voidzero-dev/vite-plus-test / @vitest/mocker's peerDependency (they
+  # require actual vite, not the vite-plus-core alias). Keeps it above the
+  # server.fs.deny bypass (GHSA-v6wh-96g9-6wx3), fixed in 8.0.16.
+  "@vitest/mocker>vite": ^8.1.4
+  "@voidzero-dev/vite-plus-test>vite": ^8.1.4
 peerDependencyRules:
   allowAny:
     - vite