@byline/host-tanstack-start 4.6.1 → 4.7.0

package/dist/admin-shell/collections/edit.js

@@ -5,6 +5,7 @@ import { getDefaultStatus, getWorkflowStatuses } from "@byline/core";
 import { useTranslation } from "@byline/i18n/react";
 import { Container, Section, useToastManager } from "@byline/ui/react";
 import { getAdminRoutePath } from "../../routes/admin-path.js";
+import { clearListReturnState } from "../../routes/list-return-storage.js";
 import { copyDocumentToLocale, deleteDocument, deleteDocumentLocale, duplicateCollectionDocument, hasDeleteSideEffectFailures, unpublishDocument, updateCollectionDocumentSystemFields, updateCollectionDocumentWithPatches, updateDocumentStatus } from "../../server-fns/collections/index.js";
 import { useNavigate } from "../chrome/loose-router.js";
 import { useTanStackNavigationGuard } from "./tanstack-navigation-guard.js";
@@ -390,6 +391,7 @@ const EditView = ({ collectionDefinition, adminConfig, initialData, locale, cont
                 status: 'success',
                 message: description
             });
+            clearListReturnState(path, String(initialData.id));
             navigate({
                 to: getAdminRoutePath('collections', '$collection'),
                 params: {
@@ -533,13 +535,16 @@ const EditView = ({ collectionDefinition, adminConfig, initialData, locale, cont
                 restoreWarnings: restoreWarnings,
                 nextStatus: nextStatus,
                 workflowStatuses: workflowStatuses,
-                onCancel: ()=>navigate({
+                onCancel: ()=>{
+                    clearListReturnState(path, String(initialData.id));
+                    navigate({
                         to: getAdminRoutePath('collections', '$collection'),
                         params: {
                             collection: path
                         },
                         search: returnSearch
-                    }),
+                    });
+                },
                 collectionPath: path
             })
         })

package/dist/routes/create-collection-edit-route.js

@@ -1,5 +1,5 @@
 import { Fragment, jsx, jsxs } from "react/jsx-runtime";
-import { useEffect, useRef } from "react";
+import { useEffect, useRef, useState } from "react";
 import { createFileRoute, notFound } from "@tanstack/react-router";
 import { getCollectionAdminConfig, getCollectionDefinition } from "@byline/core";
 import { useTranslation } from "@byline/i18n/react";
@@ -12,6 +12,7 @@ import { getCollectionDocument } from "../server-fns/collections/index.js";
 import { getAdminRoutePath } from "./admin-path.js";
 import { getContentLocaleRouteConfig } from "./get-content-locale-route-config.js";
 import { decodeListReturnState } from "./list-return-state.js";
+import { persistListReturnState, readListReturnState } from "./list-return-storage.js";
 const searchSchema = z.object({
     locale: z.string().optional(),
     action: z["enum"]([
@@ -46,6 +47,17 @@ function createCollectionEditRoute(path) {
             const toastManager = useToastManager();
             const navigate = useNavigate();
             const { contentLocales, defaultContentLocale } = getContentLocaleRouteConfig();
+            const [returnSearch, setReturnSearch] = useState(()=>decodeListReturnState(search.from));
+            useEffect(()=>{
+                if (null != search.from && search.from.length > 0) {
+                    persistListReturnState(collection, id, search.from);
+                    setReturnSearch(decodeListReturnState(search.from));
+                } else setReturnSearch(decodeListReturnState(readListReturnState(collection, id)));
+            }, [
+                search.from,
+                collection,
+                id
+            ]);
             const createdToastFiredRef = useRef(false);
             useEffect(()=>{
                 if ('created' !== search.action) {
@@ -108,7 +120,7 @@ function createCollectionEditRoute(path) {
                         locale: locale,
                         contentLocales: contentLocales,
                         defaultContentLocale: defaultContentLocale,
-                        returnSearch: decodeListReturnState(search.from)
+                        returnSearch: returnSearch
                     })
                 ]
             });

package/dist/routes/list-return-storage.d.ts

@@ -0,0 +1,13 @@
+/**
+ * This Source Code is subject to the terms of the Mozilla Public
+ * License, v. 2.0. If a copy of the MPL was not distributed with this
+ * file, You can obtain one at http://mozilla.org/MPL/2.0/.
+ *
+ * Copyright (c) Infonomic Company Limited
+ */
+/** Persist the encoded `from` state for one document. No-op when unavailable. */
+export declare function persistListReturnState(collection: string, id: string, from: string): void;
+/** Read the stored `from` state for one document, or `undefined`. */
+export declare function readListReturnState(collection: string, id: string): string | undefined;
+/** Clear the stored `from` state for one document (on close / delete). */
+export declare function clearListReturnState(collection: string, id: string): void;

package/dist/routes/list-return-storage.js

@@ -0,0 +1,36 @@
+const KEY_PREFIX = 'byline:list-return:';
+function storage() {
+    try {
+        return globalThis.sessionStorage ?? void 0;
+    } catch  {
+        return;
+    }
+}
+function keyFor(collection, id) {
+    return `${KEY_PREFIX}${collection}:${id}`;
+}
+function persistListReturnState(collection, id, from) {
+    if (0 === from.length) return;
+    const store = storage();
+    if (null == store) return;
+    try {
+        store.setItem(keyFor(collection, id), from);
+    } catch  {}
+}
+function readListReturnState(collection, id) {
+    const store = storage();
+    if (null == store) return;
+    try {
+        return store.getItem(keyFor(collection, id)) ?? void 0;
+    } catch  {
+        return;
+    }
+}
+function clearListReturnState(collection, id) {
+    const store = storage();
+    if (null == store) return;
+    try {
+        store.removeItem(keyFor(collection, id));
+    } catch  {}
+}
+export { clearListReturnState, persistListReturnState, readListReturnState };

package/package.json

@@ -3,7 +3,7 @@
   "private": false,
   "type": "module",
   "license": "MPL-2.0",
-  "version": "4.6.1",
+  "version": "4.7.0",
   "engines": {
     "node": ">=20.9.0"
   },
@@ -118,13 +118,13 @@
     "react-json-view-lite": "^2.5.0",
     "react-swipeable": "^7.0.2",
     "zod": "^4.4.3",
-    "@byline/admin": "4.6.1",
-    "@byline/ai": "4.6.1",
-    "@byline/client": "4.6.1",
-    "@byline/auth": "4.6.1",
-    "@byline/core": "4.6.1",
-    "@byline/ui": "4.6.1",
-    "@byline/i18n": "4.6.1"
+    "@byline/admin": "4.7.0",
+    "@byline/ai": "4.7.0",
+    "@byline/auth": "4.7.0",
+    "@byline/ui": "4.7.0",
+    "@byline/core": "4.7.0",
+    "@byline/client": "4.7.0",
+    "@byline/i18n": "4.7.0"
   },
   "peerDependencies": {
     "@tanstack/react-router": "^1.167.0",

package/src/admin-shell/collections/edit.tsx

@@ -16,6 +16,7 @@ import { useTranslation } from '@byline/i18n/react'
 import { Container, Section, useToastManager } from '@byline/ui/react'
 
 import { getAdminRoutePath } from '../../routes/admin-path.js'
+import { clearListReturnState } from '../../routes/list-return-storage.js'
 import {
   copyDocumentToLocale,
   deleteDocument,
@@ -373,7 +374,10 @@ export const EditView = ({
         },
       })
       setEditState({ status: 'success', message: description })
-      // Navigate back to the collection list after deletion.
+      // Navigate back to the collection list after deletion. The return
+      // target has now been consumed — clear the stored fallback so a later
+      // visit doesn't resurrect a stale list position.
+      clearListReturnState(path, String(initialData.id))
       navigate({
         to: getAdminRoutePath('collections', '$collection'),
         params: { collection: path },
@@ -536,13 +540,17 @@ export const EditView = ({
           restoreWarnings={restoreWarnings}
           nextStatus={nextStatus}
           workflowStatuses={workflowStatuses}
-          onCancel={() =>
+          onCancel={() => {
+            // Close consumes the return target — clear the stored fallback so
+            // re-opening this document later degrades to the bare list unless
+            // a fresh `from` is supplied.
+            clearListReturnState(path, String(initialData.id))
             navigate({
               to: getAdminRoutePath('collections', '$collection'),
               params: { collection: path },
               search: returnSearch,
             })
-          }
+          }}
           collectionPath={path}
         />
       </Container>

package/src/routes/create-collection-edit-route.tsx

@@ -6,7 +6,7 @@
  * Copyright (c) Infonomic Company Limited
  */
 
-import { useEffect, useRef } from 'react'
+import { useEffect, useRef, useState } from 'react'
 import { createFileRoute, notFound } from '@tanstack/react-router'
 
 import type { CollectionDefinition } from '@byline/core'
@@ -22,6 +22,7 @@ import { getCollectionDocument } from '../server-fns/collections/index.js'
 import { getAdminRoutePath } from './admin-path.js'
 import { getContentLocaleRouteConfig } from './get-content-locale-route-config.js'
 import { decodeListReturnState } from './list-return-state.js'
+import { persistListReturnState, readListReturnState } from './list-return-storage.js'
 
 const searchSchema = z.object({
   locale: z.string().optional(),
@@ -83,6 +84,24 @@ export function createCollectionEditRoute(path: string) {
       const navigate = useNavigate()
       const { contentLocales, defaultContentLocale } = getContentLocaleRouteConfig()
 
+      // Return-to-list state. The URL `from` param is the primary carrier;
+      // when present we also mirror it into tab-scoped sessionStorage so the
+      // full-page preview round-trip (which discards the admin URL) can
+      // recover it. When the URL has no `from` — e.g. the editor was
+      // re-opened from the public preview bar's Edit link — we fall back to
+      // the stored value. See list-return-storage.ts.
+      const [returnSearch, setReturnSearch] = useState<Record<string, unknown> | undefined>(() =>
+        decodeListReturnState(search.from)
+      )
+      useEffect(() => {
+        if (search.from != null && search.from.length > 0) {
+          persistListReturnState(collection, id, search.from)
+          setReturnSearch(decodeListReturnState(search.from))
+        } else {
+          setReturnSearch(decodeListReturnState(readListReturnState(collection, id)))
+        }
+      }, [search.from, collection, id])
+
       // Post-create toast for the create → edit redirect (?action=created).
       // Ref-guarded for the same reason as the list route's created toast:
       // `toastManager` changes identity on every add, so the effect depends
@@ -138,7 +157,7 @@ export function createCollectionEditRoute(path: string) {
             locale={locale}
             contentLocales={contentLocales}
             defaultContentLocale={defaultContentLocale}
-            returnSearch={decodeListReturnState(search.from)}
+            returnSearch={returnSearch}
           />
         </>
       )

package/src/routes/list-return-storage.test.node.ts

@@ -0,0 +1,77 @@
+/**
+ * This Source Code is subject to the terms of the Mozilla Public
+ * License, v. 2.0. If a copy of the MPL was not distributed with this
+ * file, You can obtain one at http://mozilla.org/MPL/2.0/.
+ *
+ * Copyright (c) Infonomic Company Limited
+ */
+
+import { afterEach, describe, expect, it } from 'vitest'
+
+import {
+  clearListReturnState,
+  persistListReturnState,
+  readListReturnState,
+} from './list-return-storage.js'
+
+/** Minimal Map-backed `Storage` stand-in — node mode has no sessionStorage. */
+function mockSessionStorage(): Storage {
+  const map = new Map<string, string>()
+  return {
+    get length() {
+      return map.size
+    },
+    clear: () => map.clear(),
+    getItem: (k: string) => (map.has(k) ? (map.get(k) as string) : null),
+    key: (i: number) => Array.from(map.keys())[i] ?? null,
+    removeItem: (k: string) => {
+      map.delete(k)
+    },
+    setItem: (k: string, v: string) => {
+      map.set(k, v)
+    },
+  }
+}
+
+function stub(): void {
+  ;(globalThis as { sessionStorage?: Storage }).sessionStorage = mockSessionStorage()
+}
+
+describe('list-return-storage', () => {
+  afterEach(() => {
+    delete (globalThis as { sessionStorage?: Storage }).sessionStorage
+  })
+
+  it('persists and reads a value keyed by collection + id', () => {
+    stub()
+    persistListReturnState('news', '42', 'page=6&order=title')
+    expect(readListReturnState('news', '42')).toBe('page=6&order=title')
+  })
+
+  it('scopes stored state by collection + id', () => {
+    stub()
+    persistListReturnState('news', '42', 'page=6')
+    expect(readListReturnState('news', '99')).toBeUndefined()
+    expect(readListReturnState('pages', '42')).toBeUndefined()
+  })
+
+  it('clears a stored value on consume', () => {
+    stub()
+    persistListReturnState('news', '42', 'page=6')
+    clearListReturnState('news', '42')
+    expect(readListReturnState('news', '42')).toBeUndefined()
+  })
+
+  it('ignores an empty from value (nothing worth carrying)', () => {
+    stub()
+    persistListReturnState('news', '42', '')
+    expect(readListReturnState('news', '42')).toBeUndefined()
+  })
+
+  it('degrades silently when sessionStorage is unavailable', () => {
+    // No stub installed — mirrors SSR / privacy-mode contexts.
+    expect(() => persistListReturnState('news', '42', 'page=6')).not.toThrow()
+    expect(readListReturnState('news', '42')).toBeUndefined()
+    expect(() => clearListReturnState('news', '42')).not.toThrow()
+  })
+})

package/src/routes/list-return-storage.ts

@@ -0,0 +1,80 @@
+/**
+ * This Source Code is subject to the terms of the Mozilla Public
+ * License, v. 2.0. If a copy of the MPL was not distributed with this
+ * file, You can obtain one at http://mozilla.org/MPL/2.0/.
+ *
+ * Copyright (c) Infonomic Company Limited
+ */
+
+/**
+ * Tab-scoped fallback for the collection editor's return-to-list state.
+ *
+ * The primary carrier is the `from` URL param (see list-return-state.ts) —
+ * pure, shareable, and enough for every in-app navigation. But the preview
+ * affordance does a full-page `window.location.assign()` to the public site,
+ * which discards the admin URL (and its `from`). When the editor is re-opened
+ * from the public preview bar's "Edit" link, that link carries only the
+ * collection and document id — no `from` — so the URL alone can no longer say
+ * which list page / filter to return to on close.
+ *
+ * sessionStorage bridges that gap: it survives a full-page navigation within
+ * the same tab, is scoped to the tab, and never leaks into shareable URLs. The
+ * editor persists `from` whenever it renders with one, keyed by collection +
+ * document id, and reads it back only when the URL carries no `from`. Closing
+ * or deleting the document consumes (clears) the entry, so a later visit to
+ * the same document with no context degrades to the bare list rather than a
+ * stale page.
+ *
+ * Every access is guarded: an absent `sessionStorage` (SSR, privacy modes,
+ * quota failures) degrades silently to "no stored state" — never an error.
+ */
+
+const KEY_PREFIX = 'byline:list-return:'
+
+/** Resolve `sessionStorage` defensively — absent under SSR, may throw in some
+ * sandboxed / privacy contexts. */
+function storage(): Storage | undefined {
+  try {
+    return globalThis.sessionStorage ?? undefined
+  } catch {
+    return undefined
+  }
+}
+
+function keyFor(collection: string, id: string): string {
+  return `${KEY_PREFIX}${collection}:${id}`
+}
+
+/** Persist the encoded `from` state for one document. No-op when unavailable. */
+export function persistListReturnState(collection: string, id: string, from: string): void {
+  if (from.length === 0) return
+  const store = storage()
+  if (store == null) return
+  try {
+    store.setItem(keyFor(collection, id), from)
+  } catch {
+    // Quota exceeded / storage disabled — persistence is best-effort only.
+  }
+}
+
+/** Read the stored `from` state for one document, or `undefined`. */
+export function readListReturnState(collection: string, id: string): string | undefined {
+  const store = storage()
+  if (store == null) return undefined
+  try {
+    return store.getItem(keyFor(collection, id)) ?? undefined
+  } catch {
+    return undefined
+  }
+}
+
+/** Clear the stored `from` state for one document (on close / delete). */
+export function clearListReturnState(collection: string, id: string): void {
+  const store = storage()
+  if (store == null) return
+  try {
+    store.removeItem(keyFor(collection, id))
+  } catch {
+    // Best-effort — nothing to recover if removal fails.
+  }
+}