payload-live-preview 2.3.2 → 2.4.0

package/dist/core.d.cts

@@ -1603,7 +1603,7 @@ interface DocumentSessionOptions {
     /**
      * Milliseconds a merge may wait for the server; after that the update is `unavailable`
      * and `data` stays the last good document. Off by default: a merge waits as long as the
-     * server takes.
+     * server takes. `0` keeps it off when 3.0 gives it a default (ADR 0007, row 27).
      */
     readonly timeoutMs?: number;
     /**
@@ -1623,6 +1623,12 @@ interface DocumentSessionOptions {
      * slug, and a create screen has no id yet. Without it the session merges every update.
      */
     readonly document?: PreviewDocument;
+    /**
+     * With a `locale` in `document`, also leave alone an update that names no locale, as 3.0
+     * does for every hook with a `locale` (ADR 0007, row 31). Off by default: such an update is
+     * merged.
+     */
+    readonly requireLocale?: boolean;
     /** Injected for tests. */
     readonly fetchFn?: typeof fetch;
     /** Window to listen on. Default the global one. */

package/dist/core.d.ts

@@ -1603,7 +1603,7 @@ interface DocumentSessionOptions {
     /**
      * Milliseconds a merge may wait for the server; after that the update is `unavailable`
      * and `data` stays the last good document. Off by default: a merge waits as long as the
-     * server takes.
+     * server takes. `0` keeps it off when 3.0 gives it a default (ADR 0007, row 27).
      */
     readonly timeoutMs?: number;
     /**
@@ -1623,6 +1623,12 @@ interface DocumentSessionOptions {
      * slug, and a create screen has no id yet. Without it the session merges every update.
      */
     readonly document?: PreviewDocument;
+    /**
+     * With a `locale` in `document`, also leave alone an update that names no locale, as 3.0
+     * does for every hook with a `locale` (ADR 0007, row 31). Off by default: such an update is
+     * merged.
+     */
+    readonly requireLocale?: boolean;
     /** Injected for tests. */
     readonly fetchFn?: typeof fetch;
     /** Window to listen on. Default the global one. */