inertia-sails 0.0.0 → 0.0.1

package/index.js

@@ -0,0 +1,103 @@
+/**
+ * inertia 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
+ */
+
+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')
+
+ module.exports = function defineInertiaHook(sails) {
+   var hook
+   const sharedProps = {}
+   const sharedViewData = {}
+   let version = 1
+   let rootView = 'app'
+	return {
+    share(key, value = null) {
+      sharedProps[key] = value
+    },
+    getShared(key = null) {
+        return sharedProps[key] ?? sharedProps
+    },
+    viewData(key, value) {
+      sharedViewData[key] = value
+    },
+    getViewData(key) {
+      return sharedViewData[key] ?? sharedViewData
+    },
+    version(newVersion) {
+      version = newVersion
+    },
+    setRootView(newRootView) {
+      rootView = newRootView
+    },
+    getRootView() {
+      return rootView
+    },
+
+		initialize: async function(cb) {
+      hook = this
+			return cb()
+		},
+
+		routes: {
+      before: {
+        'GET /*': function(req, res, next) {
+              hook.render = async function(component, props = {}, viewData = {}) {
+
+                const allProps = {
+                  ...sharedProps,
+                  ...props
+                }
+
+                const allViewData = {
+                  ...sharedViewData,
+                  ...viewData
+                }
+
+                const url = req.url || req.originalUrl
+                const currentVersion = version
+
+                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 });
+            }
+
+            // Set Inertia headers
+            if (isInertiaRequest(req)) {
+              res.set(INERTIA, true)
+              res.set('Vary', 'Accept')
+            }
+            return next()
+          }
+				}
+		},
+	}
+}

package/package.json

@@ -1,14 +1,21 @@
 {
   "name": "inertia-sails",
-  "version": "0.0.0",
-  "description": "The Sails adapter for Inertia.js",
+  "version": "0.0.1",
+  "description": "The Sails adapter for Inertia.",
   "main": "index.js",
+  "sails": {
+    "isHook": true,
+    "hookName": "inertia"
+  },
   "scripts": {
     "test": "echo \"Error: no test specified\" && exit 1"
   },
   "repository": {
     "type": "git",
-    "url": "git+https://github.com/sailscastshq/inertia-sails.git"
+    "url": "git+https://github.com/sailscasts/inertia-sails.git"
+  },
+  "peerDependencies": {
+    "sails": ">=1"
   },
   "keywords": [
     "Inertia",
@@ -17,7 +24,7 @@
   "author": "Kelvin Omereshone Oghenerhoro <kelvin@sailscasts.com>",
   "license": "MIT",
   "bugs": {
-    "url": "https://github.com/sailscastshq/inertia-sails/issues"
+    "url": "https://github.com/sailscasts/inertia-sails/issues"
   },
-  "homepage": "https://github.com/sailscastshq/inertia-sails#readme"
+  "homepage": "https://github.com/sailscasts/inertia-sails#readme"
 }

package/private/get-partial-data.js

@@ -0,0 +1,3 @@
+module.exports = function(props, only = []) {
+  return  Object.assign({}, ...only.map(key => ({ [key]: props[key] })))
+}

package/private/inertia-headers.js

@@ -0,0 +1,7 @@
+module.exports = {
+  INERTIA: 'X-Inertia',
+  VERSION: 'X-Inertia-Version',
+  PARTIAL_DATA: 'X-Inertia-Partial-Data',
+  PARTIAL_COMPONENT: 'X-Inertia-Partial-Component',
+  LOCATION: 'X-Inertia-Location'
+}

package/private/is-inertia-request.js

@@ -0,0 +1,4 @@
+const { INERTIA } = require('./inertia-headers')
+module.exports = function isInertiaRequest(req) {
+  return req.get(INERTIA)
+}

package/README.md

@@ -1,3 +0,0 @@
-# Inertia.js Sails Adapter
-
-Visit [inertia.sailscasts.com](https://inertia.sailscasts.com) to learn more.