inertia-sails 1.4.0 → 1.4.1

package/README.md

@@ -90,6 +90,11 @@ Return a URL string to redirect:
 return '/dashboard'
 ```
 
+`inertiaRedirect` performs an Inertia location visit. It does not return a
+page object, so `sails.inertia.preserveFragment()` does not apply to this
+response type. If you already know the fragment you want, include it in the
+returned URL.
+
 #### Preserving URL fragments
 
 When a standard Inertia redirect should carry the current hash to the next
@@ -222,6 +227,22 @@ return {
 }
 ```
 
+Or pass the rescue option inline:
+
+```js
+return {
+  page: 'dashboard',
+  props: {
+    analytics: sails.inertia.defer(
+      async () => {
+        return await Analytics.getExpensiveReport()
+      },
+      { rescue: true }
+    )
+  }
+}
+```
+
 When a rescued deferred prop throws, it is omitted from `props` and its key is
 reported in `rescuedProps`, allowing the client `<Deferred>` component to show
 its rescue slot instead of failing the whole deferred response.

package/package.json

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

package/tests/helpers/preserve-fragment.test.js

@@ -53,6 +53,17 @@ function runWithContext(req, callback) {
 }
 
 describe('preserveFragment', function () {
+  it('does not preserve fragments unless explicitly requested', async function () {
+    const hook = createHook()
+    const req = { session: {} }
+
+    await runWithContext(req, async () => {
+      assert.equal(requestContext.getPreserveFragment(), false)
+      assert.equal(hook.consumePreserveFragment(req), false)
+      assert.equal(hasOwn(req.session, '_inertiaPreserveFragment'), false)
+    })
+  })
+
   it('stores preserveFragment in request context and session', async function () {
     const hook = createHook()
     /** @type {{ session: Record<string, any> }} */
@@ -66,6 +77,16 @@ describe('preserveFragment', function () {
     })
   })
 
+  it('keeps the chainable helper shape when passed a boolean', async function () {
+    const hook = createHook()
+    /** @type {{ session: Record<string, any> }} */
+    const req = { session: {} }
+
+    await runWithContext(req, async () => {
+      assert.equal(hook.preserveFragment(true), hook)
+    })
+  })
+
   it('consumes and clears session-backed preserveFragment metadata', async function () {
     const hook = createHook()
     const req = {

package/tests/props/resolve-page-props.test.js

@@ -1,8 +1,22 @@
 const { describe, it } = require('node:test')
 const assert = require('node:assert/strict')
+const defineInertiaHook = require('../..')
 const resolvePageProps = require('../../lib/props/resolve-page-props')
 const DeferProp = require('../../lib/props/defer-prop')
 
+function createHook() {
+  /** @type {Record<string, any>} */
+  const sails = {
+    config: {},
+    log: {
+      warn() {}
+    }
+  }
+  const hook = defineInertiaHook(/** @type {any} */ (sails))
+  sails.inertia = hook
+  return hook
+}
+
 describe('resolvePageProps', function () {
   it('keeps the existing resolved props return shape', async function () {
     const props = await resolvePageProps({
@@ -44,6 +58,21 @@ describe('resolvePageProps', function () {
     assert.deepEqual(result.rescuedProps, ['permissions'])
   })
 
+  it('rescues deferred props from the hook options shorthand', async function () {
+    const hook = createHook()
+    const result = await resolvePageProps.withMetadata({
+      analytics: hook.defer(
+        async () => {
+          throw new Error('Analytics service unavailable')
+        },
+        { rescue: true }
+      )
+    })
+
+    assert.deepEqual(result.props, {})
+    assert.deepEqual(result.rescuedProps, ['analytics'])
+  })
+
   it('throws deferred prop failures unless rescue is enabled', async function () {
     await assert.rejects(
       () =>