inertia-sails 0.1.3 → 0.1.6

package/README.md

@@ -13,6 +13,7 @@ The quickest way to get setup an Inertia powered Sails app is to use the [create
 > Do replace `<project-name>` with the name you want your project to be.
 
 ## Frontend
+
 If you are using the [create-sails](https://github.com/sailscastshq/create-sails) scaffolding tool then the Frontend framework you choose from the CLI prompt should already be setup for you.
 
 ## Usage
@@ -52,7 +53,7 @@ module.exports = function defineCustomHook(sails) {
           fn: async function (req, res, next) {
             if (req.session.userId) {
               const loggedInUser = await User.findOne({
-                id: req.session.userId,
+                id: req.session.userId
               })
               if (!loggedInUser) {
                 sails.log.warn(
@@ -67,15 +68,16 @@ module.exports = function defineCustomHook(sails) {
               return next()
             }
             return next()
-          },
-        },
-      },
-    },
+          }
+        }
+      }
+    }
   }
 }
 ```
 
 ## Configuration
+
 If you used the `create-sails` scaffolding tool, you will find the configuration file for Inertia.js in `config/inertia.js`. You will mostly use this file for asset-versioning in Inertia by setting either a number or string that you can update when your assets changes. Below is an example of how this file looks like:
 
 ```js
@@ -100,5 +102,4 @@ module.exports.inertia = {
 }
 ```
 
-
 Visit [inertiajs.com](https://inertiajs.com/) to learn more.

package/index.js

@@ -4,103 +4,39 @@
  * @description :: A hook definition.  Extends Sails by adding shadow routes, implicit actions, and/or initialization logic.
  * @docs        :: https://sailsjs.com/docs/concepts/extending-sails/hooks
  */
-
-const { encode } = require('querystring')
-const isInertiaRequest = require('./private/is-inertia-request')
-const {
-  INERTIA,
-  PARTIAL_DATA,
-  PARTIAL_COMPONENT,
-} = require('./private/inertia-headers')
-const getPartialData = require('./private/get-partial-data')
-
+const inertia = require('./private/inertia-middleware')
 module.exports = function defineInertiaHook(sails) {
   let hook
   let sharedProps = {}
   let sharedViewData = {}
   let rootView = 'app'
+  const routesToBindInertiaTo = [
+    'GET r|^((?![^?]*\\/[^?\\/]+\\.[^?\\/]+(\\?.*)?).)*$|',
+    // (^^Leave out assets)
+    'POST /*',
+    'PATCH /*',
+    'PUT /*',
+    'DELETE /*'
+  ]
 
-  const inertiaMiddleware = (req, res, next) => {
-    hook.render = function (component, props = {}, viewData = {}) {
-      const allProps = {
-        ...sharedProps,
-        ...props,
-      }
-
-      const allViewData = {
-        ...sharedViewData,
-        ...viewData,
-      }
-
-      let url = req.url || req.originalUrl
-      const assetVersion = sails.config.inertia.version
-      const currentVersion =
-        typeof assetVersion == 'function' ? assetVersion() : assetVersion
-
-      const page = {
-        component,
-        version: currentVersion,
-        props: allProps,
-        url,
-      }
-
-      // Implements inertia partial reload. See https://inertiajs.com/partial-reload
-      if (req.get(PARTIAL_DATA) && req.get(PARTIAL_COMPONENT) === component) {
-        const only = req.get(PARTIAL_DATA).split(',')
-        page.props = only.length ? getPartialData(props, only) : page.props
-      }
-
-      const queryParams = req.query
-      if (req.method == 'GET' && Object.keys(queryParams).length) {
-        // Keep original request query params
-        url += `?${encode(queryParams)}`
-      }
-
-      // Implements inertia requests
-      if (isInertiaRequest(req)) {
-        return res.status(200).json(page)
-      }
-
-      // Implements full page reload
-      return sails.hooks.views.render(rootView, {
-        page,
-        viewData: allViewData,
-      })
-    }
-    hook.location = function (url = req.headers['referer']) {
-      const statusCode = ['PUT', 'PATCH', 'DELETE'].includes(req.method)
-        ? 303
-        : 409
-      res.set('X-Inertia-Location', url)
-      return res.redirect(statusCode, url)
-    }
-
-    // Set Inertia headers
-    if (isInertiaRequest(req)) {
-      res.set(INERTIA, true)
-      res.set('Vary', 'Accept')
-    }
-    return next()
-  }
   return {
     defaults: {
       inertia: {
-        version: 1,
-      },
+        version: 1
+      }
     },
     initialize: async function () {
       hook = this
       sails.inertia = hook
 
-      hook.share('flash', {
-        success: null,
-        error: null,
+      sails.on('router:before', function routerBefore() {
+        routesToBindInertiaTo.forEach(function iterator(routeAddress) {
+          sails.router.bind(
+            routeAddress,
+            inertia(sails, { hook, sharedProps, sharedViewData, rootView })
+          )
+        })
       })
-
-      hook.share('errors', {})
-
-      // Register Inertia middleware
-      sails.registerActionMiddleware(inertiaMiddleware, '*')
     },
 
     share: (key, value = null) => (sharedProps[key] = value),
@@ -117,6 +53,6 @@ module.exports = function defineInertiaHook(sails) {
 
     setRootView: (newRootView) => (rootView = newRootView),
 
-    getRootView: () => rootView,
+    getRootView: () => rootView
   }
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "inertia-sails",
-  "version": "0.1.3",
+  "version": "0.1.6",
   "description": "The Sails adapter for Inertia.",
   "main": "index.js",
   "sails": {
@@ -8,9 +8,8 @@
     "hookName": "inertia"
   },
   "scripts": {
-    "lint": "npx prettier --check .",
-    "lint:fix": "npx prettier --write .",
-    "prepare": "husky install"
+    "test": "echo \"Error: no test specified\" && exit 1",
+    "prepare": "cd .. && husky install"
   },
   "repository": {
     "type": "git",
@@ -26,15 +25,7 @@
   "author": "Kelvin Omereshone Oghenerhoro <kelvin@sailscasts.com>",
   "license": "MIT",
   "bugs": {
-    "url": "https://github.com/sailscastshq/inertia-sails/issues"
+    "url": "https://github.com/sailscastshq/boring-stack/issues"
   },
-  "homepage": "https://github.com/sailscastshq/inertia-sails#readme",
-  "devDependencies": {
-    "husky": "^8.0.2",
-    "lint-staged": "^13.1.0",
-    "prettier": "^2.6.2"
-  },
-  "lint-staged": {
-    "**/*": "prettier --write --ignore-unknown"
-  }
+  "homepage": "https://github.com/sailscastshq/boring-stack/inertia-sails#readme"
 }

package/private/inertia-middleware.js

@@ -0,0 +1,79 @@
+const { encode } = require('querystring')
+const isInertiaRequest = require('./is-inertia-request')
+
+const {
+  INERTIA,
+  PARTIAL_DATA,
+  PARTIAL_COMPONENT
+} = require('./inertia-headers')
+
+const getPartialData = require('./get-partial-data')
+const resolveValidationErrors = require('./resolve-validation-errors')
+function inertia(sails, { hook, sharedProps, sharedViewData, rootView }) {
+  return function inertiaMiddleware(req, res, next) {
+    hook.share('errors', resolveValidationErrors(req))
+
+    hook.render = function (component, props = {}, viewData = {}) {
+      const allProps = {
+        ...sharedProps,
+        ...props
+      }
+
+      const allViewData = {
+        ...sharedViewData,
+        ...viewData
+      }
+
+      let url = req.url || req.originalUrl
+      const assetVersion = sails.config.inertia.version
+      const currentVersion =
+        typeof assetVersion == 'function' ? assetVersion() : assetVersion
+
+      const page = {
+        component,
+        version: currentVersion,
+        props: allProps,
+        url
+      }
+
+      // Implements inertia partial reload. See https://inertiajs.com/partial-reload
+      if (req.get(PARTIAL_DATA) && req.get(PARTIAL_COMPONENT) === component) {
+        const only = req.get(PARTIAL_DATA).split(',')
+        page.props = only.length ? getPartialData(props, only) : page.props
+      }
+
+      const queryParams = req.query
+      if (req.method == 'GET' && Object.keys(queryParams).length) {
+        // Keep original request query params
+        url += `?${encode(queryParams)}`
+      }
+
+      // Implements inertia requests
+      if (isInertiaRequest(req)) {
+        return res.status(200).json(page)
+      }
+
+      // Implements full page reload
+      return sails.hooks.views.render(rootView, {
+        page,
+        viewData: allViewData
+      })
+    }
+    hook.location = function (url = req.headers['referer']) {
+      const statusCode = ['PUT', 'PATCH', 'DELETE'].includes(req.method)
+        ? 303
+        : 409
+      res.set('X-Inertia-Location', url)
+      return res.redirect(statusCode, url)
+    }
+
+    // Set Inertia headers
+    if (isInertiaRequest(req)) {
+      res.set(INERTIA, true)
+      res.set('Vary', 'Accept')
+    }
+    return next()
+  }
+}
+
+module.exports = inertia

package/private/resolve-validation-errors.js

@@ -0,0 +1,40 @@
+/**
+ * @module resolveValidationErrors
+ * @description Resolves and formats validation errors from the session for Inertia responses.
+ *
+ * @param {Object} req - The current HTTP request object.
+ * @returns {Object} An object representing the validation errors in the desired format.
+ */
+module.exports = function resolveValidationErrors(req) {
+  if (!req.session || !req.session.errors) {
+    return {}
+  }
+
+  const flashedErrors = req.session.errors
+
+  const collectedErrors = Object.keys(flashedErrors).reduce((result, bag) => {
+    const errorsForBag = flashedErrors[bag]
+    const mappedErrors = errorsForBag.map((error) =>
+      error.replace(/"([^"]+)"/, '$1')
+    )
+    // Ensure that single errors are wrapped in an array
+    result[bag] = mappedErrors.length > 1 ? mappedErrors : mappedErrors[0]
+    return result
+  }, {})
+
+  const inertiaErrorBag = req.headers['x-inertia-error-bag']
+
+  if (inertiaErrorBag && collectedErrors[inertiaErrorBag]) {
+    const selectedErrors = {
+      [inertiaErrorBag]: collectedErrors[inertiaErrorBag]
+    }
+    return selectedErrors
+  }
+
+  if (collectedErrors.default) {
+    const defaultErrors = { default: collectedErrors.default }
+    return defaultErrors
+  }
+
+  return collectedErrors
+}

package/.husky/pre-commit

@@ -1,4 +0,0 @@
-#!/usr/bin/env sh
-. "$(dirname -- "$0")/_/husky.sh"
-
-npx lint-staged

package/.prettierrc.js

@@ -1,4 +0,0 @@
-module.exports = {
-  semi: false,
-  singleQuote: true,
-}