Introduce temporary props

packages/core/src/history.ts

@@ -66,6 +66,9 @@ class History {
 
   protected getPageData(page: Page): Promise<Page | ArrayBuffer> {
     return new Promise((resolve) => {
+      if (page.temporaryProps) {
+        page.temporaryProps.forEach((key) => { delete page.props[key] })
+      }
       return page.encryptHistory ? encryptHistory(page).then(resolve) : resolve(page)
     })
   }

packages/core/src/types.ts

@@ -117,6 +117,7 @@ export interface Page<SharedProps extends PageProps = PageProps> {
   mergeProps?: string[]
   deepMergeProps?: string[]
   matchPropsOn?: string[]
+  temporaryProps?: string[]
 
   /** @internal */
   rememberedState: Record<string, unknown>

packages/react/test-app/Pages/TemporaryProps.tsx

@@ -0,0 +1,18 @@
+import { Link } from '@inertiajs/react'
+
+export default function TemporaryProps({
+  regular,
+  tmp,
+}: {
+  regular?: number
+  tmp?: number
+}) {
+  return (
+    <>
+      <div>regular is {regular ?? 'undefined'}</div>
+      <div>tmp is {tmp ?? 'undefined'}</div>
+
+      <Link href="/">homepage</Link>
+    </>
+  )
+}

packages/svelte/test-app/Pages/TemporaryProps.svelte

@@ -0,0 +1,10 @@
+<script lang="ts">
+  import { Link } from '@inertiajs/svelte'
+
+  export let regular: number | undefined
+  export let tmp: number | undefined
+</script>
+
+<div>regular is {regular ?? 'undefined'}</div>
+<div>tmp is {tmp ?? 'undefined'}</div>
+<Link href="/">homepage</Link>

packages/vue3/test-app/Pages/TemporaryProps.vue

@@ -0,0 +1,14 @@
+<script setup lang="ts">
+import { Link } from '@inertiajs/vue3'
+
+defineProps<{
+  regular?: number
+  tmp?: number
+}>()
+</script>
+
+<template>
+  <div>regular is {{ regular ?? 'undefined' }}</div>
+  <div>tmp is {{ tmp ?? 'undefined' }}</div>
+  <Link href="/">homepage</Link>
+</template>

tests/app/server.js

@@ -285,6 +285,17 @@ app.get('/history/version/:pageNumber', (req, res) => {
   })
 })
 
+app.get('/temporary-props', (req, res) => {
+  inertia.render(req, res, {
+    component: 'TemporaryProps',
+    props: {
+      regular: 1,
+      tmp: 1,
+    },
+    temporaryProps: ['tmp']
+  })
+})
+
 app.get('/when-visible', (req, res) => {
   const page = () =>
     inertia.render(req, res, {

tests/temporary-props.spec.ts

@@ -0,0 +1,19 @@
+import { expect, test } from '@playwright/test'
+
+test('temporary props disappear after partial reload and remain absent on back', async ({ page }) => {
+  await page.goto('/temporary-props')
+
+  // Initially, both props are present
+  await expect(page.getByText('regular is 1')).toBeVisible()
+  await expect(page.getByText('tmp is 1')).toBeVisible()
+
+  // Navigate away and then go back to ensure history state doesn't contain tmp
+  await page.getByRole('link', { name: 'homepage' }).click()
+  await page.waitForURL('/')
+  await page.goBack()
+  await page.waitForURL('/temporary-props')
+
+  await expect(page.getByText('regular is 1')).toBeVisible()
+  // tmp should be absent when pulled from history
+  await expect(page.getByText('tmp is undefined')).toBeVisible()
+})