payload-live-preview 2.3.2 → 2.4.0

package/dist/adapters/sveltekit/client.d.ts

@@ -0,0 +1,37 @@
+/**
+ * `livePreviewNavigation()` — the SvelteKit glue a preview needed in its own
+ * layout before 2.4: it tells the runtime when a client navigation has
+ * committed and lends it `invalidateAll()` for route updates. Call it from the
+ * script of a layout that stays mounted across the preview routes.
+ *
+ * SvelteKit's two functions are passed in rather than imported: `$app/*` exists
+ * only inside a Kit build, and a package that imports it has to be compiled by
+ * the app as a Svelte library, which would change how Vite treats every other
+ * import of this package. `svelte` itself is an optional peer.
+ */
+/** The part of SvelteKit's `AfterNavigate` this reads; Kit 2 has no `shallow`. */
+interface CommittedNavigation {
+    readonly from: unknown;
+    readonly type?: string;
+    readonly shallow?: boolean;
+}
+/** SvelteKit's own `afterNavigate` and `invalidateAll` from `$app/navigation`. */
+interface SvelteKitNavigation {
+    readonly afterNavigate: (callback: (navigation: CommittedNavigation) => void) => void;
+    readonly invalidateAll: () => Promise<void>;
+}
+/**
+ * Must run while the component initialises, as `afterNavigate` must.
+ *
+ * ```svelte
+ * <script lang="ts">
+ *   import { afterNavigate, invalidateAll } from '$app/navigation';
+ *   import { livePreviewNavigation } from 'payload-live-preview/sveltekit/client';
+ *
+ *   livePreviewNavigation({ afterNavigate, invalidateAll });
+ * </script>
+ * ```
+ */
+declare function livePreviewNavigation({ afterNavigate, invalidateAll }: SvelteKitNavigation): void;
+
+export { type CommittedNavigation, type SvelteKitNavigation, livePreviewNavigation };

package/dist/adapters/sveltekit/client.js

@@ -0,0 +1,2 @@
+import{onMount as e,tick as t}from"svelte";var i="__livePreviewRouteRefresh";function o({afterNavigate:o,invalidateAll:n}){o(e=>{null!==e.from&&(!0===e.shallow&&"goto"===e.type||document.dispatchEvent(new Event("payload-live-preview:navigation")))}),e(()=>function registerRouteRefresh(e){const t="undefined"==typeof window?void 0:window;return void 0===t?()=>{}:(t[i]=e,()=>{t[i]===e&&(t[i]=void 0)})}(async()=>{await n(),await t()}))}export{o as livePreviewNavigation};
+//# sourceMappingURL=client.js.map

package/dist/adapters/sveltekit/client.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"client.js","names":["SLOT","livePreviewNavigation","afterNavigate","invalidateAll","navigation","from","shallow","type","document","dispatchEvent","Event","onMount","registerRouteRefresh","refresh","target","window","async","tick"],"sources":["../../../src/core/navigation-lifecycle.ts","../../../src/core/route-refresh.ts","../../../src/adapters/sveltekit/client.ts"],"sourcesContent":["/**\n * Binds the document lifecycle the runtime cannot see: a back/forward-cache\n * restore re-runs no scripts, so a client that stayed attached comes back\n * bound to a frozen document and quietly stops updating; a soft navigation\n * replaces the content the binding cache describes. Both are silent failures.\n */\n\n/** The part of the client this owner drives. */\nexport interface NavigationLifecycleTarget {\n  suspend(): boolean;\n  resume(): boolean;\n  /** Re-scan bindings after replacing markup without crossing a navigation boundary. */\n  refreshCache(): void;\n  /** Re-scan and replay the last accepted document after a committed router navigation. */\n  refreshAfterNavigation?(): void;\n}\n\n/** Package-owned event dispatched after a framework router commit. @internal */\nexport const NAVIGATION_COMMIT_EVENT = 'payload-live-preview:navigation';\nconst ASTRO_INITIAL_PAGE_LOAD_EVENT = 'astro:page-load';\nconst ASTRO_AFTER_SWAP_EVENT = 'astro:after-swap';\n\nexport interface NavigationLifecycleOptions {\n  /** Where `pagehide`/`pageshow` fire; they exist only on the window. Defaults to `window`. */\n  readonly windowTarget?: EventTarget;\n  /** Event target for soft-navigation events. Defaults to `document`. */\n  readonly documentTarget?: EventTarget;\n  /**\n   * Events after which the DOM was replaced and the current editor state must\n   * be replayed, e.g. `astro:page-load`. Empty by default: only the host knows\n   * which its router fires.\n   */\n  readonly softNavigationEvents?: readonly string[];\n}\n\n/** Returns an unbind function; calling it twice is harmless. */\nexport function bindNavigationLifecycle(\n  target: NavigationLifecycleTarget,\n  options: NavigationLifecycleOptions = {},\n): () => void {\n  const windowTarget = options.windowTarget ?? (globalThis as { window?: EventTarget }).window;\n  const documentTarget =\n    options.documentTarget ?? (globalThis as { document?: EventTarget }).document;\n  const softEvents = [...new Set(options.softNavigationEvents ?? [])];\n\n  const onPageHide = (): void => {\n    target.suspend();\n  };\n  const onPageShow = (event: Event): void => {\n    // Only a persisted restore needs reacquiring; an ordinary load already started.\n    if ((event as Event & { readonly persisted?: boolean }).persisted === true) {\n      target.resume();\n    }\n  };\n  let astroNavigationArmed = false;\n  const onAstroAfterSwap = (): void => {\n    astroNavigationArmed = true;\n  };\n  const onSoftNavigation = (event: Event): void => {\n    // Astro emits page-load for the initial document too. A client-router\n    // commit is the page-load preceded by after-swap, including before the\n    // browser's initial `load` when a subresource is slow.\n    if (event.type === ASTRO_INITIAL_PAGE_LOAD_EVENT) {\n      if (!astroNavigationArmed) return;\n      astroNavigationArmed = false;\n    }\n    if (target.refreshAfterNavigation === undefined) target.refreshCache();\n    else target.refreshAfterNavigation();\n  };\n\n  let unbound = false;\n\n  windowTarget?.addEventListener('pagehide', onPageHide);\n  windowTarget?.addEventListener('pageshow', onPageShow);\n  for (const name of softEvents) documentTarget?.addEventListener(name, onSoftNavigation);\n  const observesAstro = softEvents.includes(ASTRO_INITIAL_PAGE_LOAD_EVENT);\n  if (observesAstro) documentTarget?.addEventListener(ASTRO_AFTER_SWAP_EVENT, onAstroAfterSwap);\n\n  return (): void => {\n    if (unbound) return;\n    unbound = true;\n    windowTarget?.removeEventListener('pagehide', onPageHide);\n    windowTarget?.removeEventListener('pageshow', onPageShow);\n    for (const name of softEvents) documentTarget?.removeEventListener(name, onSoftNavigation);\n    if (observesAstro) {\n      documentTarget?.removeEventListener(ASTRO_AFTER_SWAP_EVENT, onAstroAfterSwap);\n    }\n  };\n}\n","/**\n * The seam between a host framework's own router and the route strategy.\n *\n * The route strategy answers a revision by fetching the route and morphing it\n * into the living page. On a page whose DOM belongs to a reconciler that is\n * working against the framework, and it was seen to break once: `removeChild`\n * on `null` inside React's commit phase, over markup this package had patched.\n * A host that re-renders the route itself does the same job without the morph\n * and without the second HTML request, so it is given the chance to.\n *\n * Why a named slot on `window` and not a reference: the runtime is an inline\n * script that builds its strategy before any application code has hydrated, so\n * there is nothing to hand a component; `window.__livePreview`, the only other\n * public surface, is created later and not at all outside a preview; and the\n * two richer extension points — plugins and events — are reachable only through\n * the programmatic client, which a page using an adapter does not have. One\n * slot, written by whoever mounts and read at the moment of a refresh, is the\n * smallest thing that survives both orders of arrival.\n */\n\n/**\n * A host's own route refresh. It must settle once the fresh markup is\n * committed: the runtime re-applies the revision on top of it, and doing that\n * against the markup being replaced would write into nodes about to be dropped.\n * A function that returns nothing is taken as already committed; the route\n * strategy says once that it could not wait (LP0810), and 3.0 requires the\n * promise (ADR 0028).\n */\nexport type RouteRefresh = () => void | Promise<void>;\n\n/** Read late, so it does not matter whether the runtime or the component came first. */\nconst SLOT = '__livePreviewRouteRefresh';\n\ntype WindowSlot = Record<string, RouteRefresh | undefined>;\n\nfunction slot(): WindowSlot | undefined {\n  return typeof window === 'undefined' ? undefined : (window as unknown as WindowSlot);\n}\n\n/**\n * Lend the runtime the host's route refresh; the return value undoes it, for a\n * component's cleanup. A later registration wins, and undoing one that has\n * already been replaced does nothing — two components on one page would\n * otherwise take the slot from each other on unmount.\n */\nexport function registerRouteRefresh(refresh: RouteRefresh): () => void {\n  const target = slot();\n  if (target === undefined) return () => undefined;\n  target[SLOT] = refresh;\n  return () => {\n    // Cleared rather than deleted: the slot is read through `?.` anyway, and\n    // removing the key buys nothing a lint rule would not have to be argued out of.\n    if (target[SLOT] === refresh) target[SLOT] = undefined;\n  };\n}\n\n/** The registered refresh, or `undefined` on a page that registered none. */\nexport function readRouteRefresh(): RouteRefresh | undefined {\n  return slot()?.[SLOT];\n}\n","/**\n * `livePreviewNavigation()` — the SvelteKit glue a preview needed in its own\n * layout before 2.4: it tells the runtime when a client navigation has\n * committed and lends it `invalidateAll()` for route updates. Call it from the\n * script of a layout that stays mounted across the preview routes.\n *\n * SvelteKit's two functions are passed in rather than imported: `$app/*` exists\n * only inside a Kit build, and a package that imports it has to be compiled by\n * the app as a Svelte library, which would change how Vite treats every other\n * import of this package. `svelte` itself is an optional peer.\n */\n\nimport { onMount, tick } from 'svelte';\nimport { NAVIGATION_COMMIT_EVENT } from '@core/navigation-lifecycle';\nimport { registerRouteRefresh } from '@core/route-refresh';\n\n/** The part of SvelteKit's `AfterNavigate` this reads; Kit 2 has no `shallow`. */\nexport interface CommittedNavigation {\n  readonly from: unknown;\n  readonly type?: string;\n  readonly shallow?: boolean;\n}\n\n/** SvelteKit's own `afterNavigate` and `invalidateAll` from `$app/navigation`. */\nexport interface SvelteKitNavigation {\n  readonly afterNavigate: (callback: (navigation: CommittedNavigation) => void) => void;\n  readonly invalidateAll: () => Promise<void>;\n}\n\n/**\n * Must run while the component initialises, as `afterNavigate` must.\n *\n * ```svelte\n * <script lang=\"ts\">\n *   import { afterNavigate, invalidateAll } from '$app/navigation';\n *   import { livePreviewNavigation } from 'payload-live-preview/sveltekit/client';\n *\n *   livePreviewNavigation({ afterNavigate, invalidateAll });\n * </script>\n * ```\n */\nexport function livePreviewNavigation({ afterNavigate, invalidateAll }: SvelteKitNavigation): void {\n  afterNavigate((navigation) => {\n    // The mount call has no `from`: startup already applies the editor's document.\n    if (navigation.from === null) return;\n    // A shallow `goto` (SvelteKit 3) keeps the rendered route; it only sets page state.\n    if (navigation.shallow === true && navigation.type === 'goto') return;\n    document.dispatchEvent(new Event(NAVIGATION_COMMIT_EVENT));\n  });\n  // `invalidateAll()` settles the route's loads; `tick()` the DOM they render.\n  // The returned cleanup gives the registration back when the layout unmounts.\n  onMount(() =>\n    registerRouteRefresh(async () => {\n      await invalidateAll();\n      await tick();\n    }),\n  );\n}\n"],"mappings":"2CAkBO,ICaDA,EAAO,4BCUN,SAASC,GAAsBC,cAAEA,EAAAC,cAAeA,IACrDD,EAAeE,IAEW,OAApBA,EAAWC,QAEY,IAAvBD,EAAWE,SAAwC,SAApBF,EAAWG,MAC9CC,SAASC,cAAc,IAAIC,MF7BQ,uCEiCrCC,EAAQ,IDNH,SAASC,qBAAqBC,GACnC,MAAMC,EAVmB,oBAAXC,YAAyB,EAAaA,OAWpD,YAAe,IAAXD,EAA6B,QACjCA,EAAOd,GAAQa,EACR,KAGDC,EAAOd,KAAUa,IAASC,EAAOd,QAAQ,IAEjD,CCFIY,CAAqBI,gBACbb,UACAc,MAGZ,Q","ignoreList":[]}