inertia-sails 0.0.8 → 0.1.0

package/README.md

@@ -0,0 +1,104 @@
+# Inertia.js Sails Adapter
+
+## Installation
+
+## Backend
+
+The quickest way to get setup an Inertia powered Sails app is to use the [create-sails](https://github.com/sailscastshq/create-sails) scaffolding tool. Just run
+
+```sh
+  npx create-sails <project-name>
+```
+
+> 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
+
+### Responses
+
+Sending back an Inertia responses is pretty simple, just use the `sails.inertia.render` method in your Sails actions(You can look at the example actions if you used create-sails). The `render` method accepts two arguments, the first is the name of the component you want to render from within your `pages` directory in `assets/js` (without the file extension).
+
+The second argument is the props object where you can provide props to your components.
+
+## Shared Data
+
+If you have data that you want to be provided as a prop to every component (a common use-case is informationa about the authenticated user) you can use the `sails.inertia.share` method.
+
+In Sails having a custom hook by running `sails generate hook custom` will scaffolding a project level hook in which you can share the loggedIn user information for example. Below is a real world use case:
+
+```js
+/**
+ * custom hook
+ *
+ * @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
+ */
+
+module.exports = function defineCustomHook(sails) {
+  return {
+    /**
+     * Runs when this Sails app loads/lifts.
+     */
+    initialize: async function () {
+      sails.log.info('Initializing custom hook (`custom`)')
+    },
+    routes: {
+      before: {
+        'GET /': {
+          skipAssets: true,
+          fn: async function (req, res, next) {
+            if (req.session.userId) {
+              const loggedInUser = await User.findOne({
+                id: req.session.userId,
+              })
+              if (!loggedInUser) {
+                sails.log.warn(
+                  'Somehow, the user record for the logged-in user (`' +
+                    req.session.userId +
+                    '`) has gone missing....'
+                )
+                delete req.session.userId
+                return res.redirect('/signin')
+              }
+              sails.inertia.share('loggedInUser', loggedInUser)
+              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
+/**
+ * Inertia configuration
+ * (sails.config.inertia)
+ *
+ * Use the settings below to configure session integration in your app.
+ *
+ * For more information on Inertia configuration, visit:
+ * https://inertia-sails.sailscasts.com
+ */
+
+module.exports.inertia = {
+  /**
+   * https://inertiajs.com/asset-versioning
+   * You can pass a string, number that changes when your assets change
+   *  or a function that returns the said string, number.
+   * e.g 4 or () => 4
+   */
+  // version: 1,
+}
+```
+
+
+Visit [inertiajs.com](https://inertiajs.com/) to learn more.

package/index.js

@@ -19,13 +19,76 @@ module.exports = function defineInertiaHook(sails) {
   let sharedProps = {}
   let sharedViewData = {}
   let rootView = 'app'
+
+  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.status(statusCode)
+      res.set('X-Inertia-Location', url)
+    }
+
+    // Set Inertia headers
+    if (isInertiaRequest(req)) {
+      res.set(INERTIA, true)
+      res.set('Vary', 'Accept')
+    }
+    return next()
+  }
   return {
     defaults: {
       inertia: {
         version: 1,
       },
     },
-    initialize: async function (cb) {
+    initialize: async function () {
       hook = this
       sails.inertia = hook
 
@@ -36,7 +99,8 @@ module.exports = function defineInertiaHook(sails) {
 
       hook.share('errors', {})
 
-      return cb()
+      // Register Inertia middleware
+      sails.registerActionMiddleware(inertiaMiddleware, '*')
     },
 
     share: (key, value = null) => (sharedProps[key] = value),
@@ -54,84 +118,5 @@ module.exports = function defineInertiaHook(sails) {
     setRootView: (newRootView) => (rootView = newRootView),
 
     getRootView: () => rootView,
-
-    routes: {
-      before: {
-        'GET /*': {
-          skipAssets: true,
-          fn: function (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: {},
-                url,
-              }
-
-              // Implements inertia partial reload. See https://inertiajs.com/partial-reload
-              let dataKeys
-              if (
-                req.get(PARTIAL_DATA) &&
-                req.get(PARTIAL_COMPONENT) === component
-              ) {
-                dataKeys = req.get(PARTIAL_DATA).split(',')
-              } else {
-                dataKeys = Object.keys(allProps)
-              }
-
-              page.props = getPageProps(allProps, dataKeys)
-
-              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.status(statusCode)
-              res.set('X-Inertia-Location', url)
-            }
-
-            // Set Inertia headers
-            if (isInertiaRequest(req)) {
-              res.set(INERTIA, true)
-              res.set('Vary', 'Accept')
-            }
-            return next()
-          },
-        },
-      },
-    },
   }
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "inertia-sails",
-  "version": "0.0.8",
+  "version": "0.1.0",
   "description": "The Sails adapter for Inertia.",
   "main": "index.js",
   "sails": {