inertia-sails 1.1.0 → 1.3.0

package/README.md

@@ -75,7 +75,7 @@ Return an Inertia page response:
 return {
   page: 'users/index',       // Component name
   props: { users: [...] },   // Props passed to component
-  viewData: { title: '...' } // Data for root EJS template
+  locals: { title: '...' }   // Locals for root EJS template
 }
 ```
 
@@ -106,12 +106,12 @@ Share data across all requests (app-wide):
 sails.inertia.shareGlobally('appName', 'My App')
 ```
 
-#### `viewData(key, value)`
+#### `local(key, value)`
 
-Share data with the root EJS template:
+Set a local variable for the root EJS template:
 
 ```js
-sails.inertia.viewData('title', 'Dashboard')
+sails.inertia.local('title', 'Dashboard')
 ```
 
 ### Once Props (Cached)

package/index.js

@@ -30,7 +30,7 @@
  * @typedef {Object} InertiaRenderData
  * @property {string} page - The component name to render
  * @property {Object.<string, *>} [props] - Props to pass to the component
- * @property {Object.<string, *>} [viewData] - Additional view data for the root template
+ * @property {Object.<string, *>} [locals] - Additional locals for the root EJS template
  */
 
 /**
@@ -116,7 +116,7 @@ module.exports = function defineInertiaHook(sails) {
       // Global shared props (for app-wide data like app name, version)
       // These are merged with request-scoped shares
       sails.inertia.globalSharedProps = {}
-      sails.inertia.globalSharedViewData = {}
+      sails.inertia.globalSharedLocals = {}
       // Default history encryption from config
       sails.inertia.defaultEncryptHistory = sails.config.inertia.history.encrypt
       sails.on('router:before', function () {
@@ -215,42 +215,42 @@ module.exports = function defineInertiaHook(sails) {
     },
 
     /**
-     * Add view data for the current request.
+     * Set a local for the current request's root EJS template.
      * Uses AsyncLocalStorage to ensure data doesn't leak between concurrent requests.
-     * @param {string} key - The key of the view data
-     * @param {*} value - The value of the view data
+     * @param {string} key - The local variable name
+     * @param {*} value - The value
      * @returns {*} - The value that was set
      */
-    viewData(key, value) {
+    local(key, value) {
       const context = requestContext.getContext()
       if (context) {
-        requestContext.setSharedViewData(key, value)
+        requestContext.setSharedLocal(key, value)
         return value
       }
       // Fallback to global if called outside request
-      sails.inertia.globalSharedViewData[key] = value
+      sails.inertia.globalSharedLocals[key] = value
       return value
     },
 
     /**
-     * Add view data globally across all requests.
-     * @param {string} key - The key of the view data
-     * @param {*} value - The value of the view data
+     * Set a local globally across all requests.
+     * @param {string} key - The local variable name
+     * @param {*} value - The value
      * @returns {*} - The value that was set
      */
-    viewDataGlobally(key, value) {
-      sails.inertia.globalSharedViewData[key] = value
+    localGlobally(key, value) {
+      sails.inertia.globalSharedLocals[key] = value
       return value
     },
 
     /**
-     * Get view data (merges global + request-scoped)
-     * @param {string} key - The key of the view data to get
-     * @returns {*} - The view data
+     * Get locals (merges global + request-scoped)
+     * @param {string} key - The local variable name to get
+     * @returns {*} - The locals
      */
-    getViewData(key) {
-      const globalData = sails.inertia.globalSharedViewData
-      const requestData = requestContext.getSharedViewData()
+    getLocals(key) {
+      const globalData = sails.inertia.globalSharedLocals
+      const requestData = requestContext.getSharedLocals()
       const merged = { ...globalData, ...requestData }
       return key ? merged[key] : merged
     },

package/lib/helpers/request-context.js

@@ -11,7 +11,7 @@
  *   req: Request,
  *   res: Response,
  *   sharedProps: {},      // Request-scoped shared props
- *   sharedViewData: {},   // Request-scoped view data
+ *   sharedLocals: {},     // Request-scoped locals for root EJS template
  *   encryptHistory: null, // Request-scoped history encryption (null = use default)
  *   clearHistory: false,  // Request-scoped clear history flag
  *   refreshOnceProps: [], // Props to force-refresh for this request
@@ -40,7 +40,7 @@ module.exports = {
       req,
       res,
       sharedProps: {},
-      sharedViewData: {},
+      sharedLocals: {},
       encryptHistory: null,
       clearHistory: false,
       refreshOnceProps: [], // Props to force-refresh for this request
@@ -97,23 +97,23 @@ module.exports = {
   },
 
   /**
-   * Get request-scoped shared view data
-   * @returns {Object} - The shared view data for this request
+   * Get request-scoped shared locals
+   * @returns {Object} - The shared locals for this request
    */
-  getSharedViewData() {
+  getSharedLocals() {
     const context = requestContext.getStore()
-    return context?.sharedViewData || {}
+    return context?.sharedLocals || {}
   },
 
   /**
-   * Set request-scoped shared view data
+   * Set a request-scoped shared local
    * @param {string} key - The key
    * @param {*} value - The value
    */
-  setSharedViewData(key, value) {
+  setSharedLocal(key, value) {
     const context = requestContext.getStore()
     if (context) {
-      context.sharedViewData[key] = value
+      context.sharedLocals[key] = value
     }
   },
 

package/lib/render.js

@@ -8,11 +8,11 @@ module.exports = async function render(req, res, data) {
   // Use request-scoped rootView if set, otherwise fall back to config
   const rootView = requestContext.getRootView() || sails.config.inertia.rootView
 
-  // Use request-scoped view data merged with global view data
-  // This prevents view data from leaking between concurrent requests
-  const allViewData = {
-    ...sails.inertia.getViewData(), // Merges global + request-scoped
-    ...data.viewData
+  // Use request-scoped locals merged with global locals
+  // This prevents locals from leaking between concurrent requests
+  const allLocals = {
+    ...sails.inertia.getLocals(), // Merges global + request-scoped
+    ...data.locals
   }
 
   let page = await buildPageObject(req, data.page, data.props)
@@ -32,9 +32,6 @@ module.exports = async function render(req, res, data) {
     return res.json(page)
   } else {
     // Implements full page reload
-    return res.view(rootView, {
-      page,
-      viewData: allViewData
-    })
+    return res.view(rootView, { page, ...allLocals })
   }
 }

package/package.json

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