inertia-sails 1.0.0 → 1.0.1

package/README.md

@@ -205,9 +205,10 @@ settings: sails.inertia.deepMerge(() => updatedSettings)
 
 ### Infinite Scroll
 
-Paginate data with automatic merge behavior:
+Paginate data with automatic merge behavior. Works with Inertia.js v2's `<InfiniteScroll>` component:
 
 ```js
+// Controller
 const page = this.req.param('page', 0)
 const perPage = 20
 const invoices = await Invoice.find().paginate(page, perPage)
@@ -226,6 +227,23 @@ return {
 }
 ```
 
+```vue
+<!-- Vue component -->
+<script setup>
+import { InfiniteScroll } from '@inertiajs/vue3'
+
+defineProps({ invoices: Object })
+</script>
+
+<template>
+  <InfiniteScroll data="invoices">
+    <div v-for="invoice in invoices.data" :key="invoice.id">
+      {{ invoice.invoiceNumber }}
+    </div>
+  </InfiniteScroll>
+</template>
+```
+
 ### History Encryption
 
 Encrypt sensitive data in browser history:

package/lib/helpers/build-page-object.js

@@ -3,6 +3,7 @@ const resolveDeferredProps = require('../props/resolve-deferred-props')
 const resolveMergeProps = require('../props/resolve-merge-props')
 const { resolveOncePropsMetadata } = require('../props/resolve-once-props')
 const resolvePageProps = require('../props/resolve-page-props')
+const resolveScrollProps = require('../props/resolve-scroll-props')
 
 /**
  * @typedef {Object} InertiaPageObject
@@ -16,6 +17,7 @@ const resolvePageProps = require('../props/resolve-page-props')
  * @property {string[]} [deepMergeProps] - Props that should be deep merged
  * @property {Object.<string, string[]>} [deferredProps] - Deferred props by group
  * @property {Object.<string, *>} [onceProps] - Once-prop metadata
+ * @property {Object.<string, *>} [scrollProps] - Scroll props for InfiniteScroll component
  * @property {Object.<string, *>} [flash] - Flash data (not persisted in history)
  */
 
@@ -60,7 +62,8 @@ module.exports = async function buildPageObject(req, component, pageProps) {
     encryptHistory: sails.inertia.shouldEncryptHistory(),
     ...resolveMergeProps(req, allProps),
     ...resolveDeferredProps(req, component, allProps),
-    ...resolveOncePropsMetadata(allProps)
+    ...resolveOncePropsMetadata(allProps),
+    ...resolveScrollProps(allProps)
   }
 
   // Consume flash data from session and add to props

package/lib/props/resolve-scroll-props.js

@@ -0,0 +1,52 @@
+const ScrollProp = require('./scroll-prop')
+
+/**
+ * Resolve scroll props metadata for the page response.
+ * Extracts ScrollProp instances and builds the scrollProps object
+ * expected by Inertia.js v2's <InfiniteScroll> component.
+ *
+ * @param {Object} pageProps - The page props
+ * @returns {Object} - Object with scrollProps if any exist
+ *
+ * @example
+ * // Input props with ScrollProp instance:
+ * { invoices: ScrollProp { pageName: 'page', currentPage: 1, ... } }
+ *
+ * // Output:
+ * {
+ *   scrollProps: {
+ *     invoices: {
+ *       pageName: 'page',
+ *       currentPage: 1,
+ *       previousPage: null,
+ *       nextPage: 2,
+ *       reset: false
+ *     }
+ *   }
+ * }
+ */
+module.exports = function resolveScrollProps(pageProps) {
+  const scrollProps = {}
+
+  for (const [key, value] of Object.entries(pageProps || {})) {
+    if (value instanceof ScrollProp) {
+      // Build scroll prop metadata in the format Inertia.js expects
+      const hasNextPage = value.currentPage < value.totalPages
+      const hasPreviousPage = value.currentPage > 1
+
+      scrollProps[key] = {
+        pageName: value.pageName,
+        currentPage: value.currentPage,
+        previousPage: hasPreviousPage ? value.currentPage - 1 : null,
+        nextPage: hasNextPage ? value.currentPage + 1 : null,
+        reset: false
+      }
+    }
+  }
+
+  if (Object.keys(scrollProps).length === 0) {
+    return {}
+  }
+
+  return { scrollProps }
+}

package/package.json

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