payload-live-preview 2.2.2 → 2.3.1

package/dist/client.d.cts

@@ -33,6 +33,8 @@ declare const DIAGNOSTIC_CODES: Readonly<{
     readonly UnattributableUpdate: "LP0202";
     /** An update carried a value for a field the page binds nowhere; editing it changes nothing on this page. */
     readonly UnboundField: "LP0203";
+    /** In development: a bound path covers its group under the `descendant` default, which 3.0 changes. */
+    readonly CoverageDefaultChanges: "LP0204";
     /** The visibility gate held offscreen writes back until they scroll into view. */
     readonly VisibilityGateDeferred: "LP0301";
     /** A value was refused because the attribute or the value itself is unsafe. */
@@ -57,7 +59,7 @@ declare const DIAGNOSTIC_CODES: Readonly<{
     readonly UnrenderedBlockKept: "LP0410";
     /** A patch cannot reach what the server would have drawn; `onUnfaithfulPatch` decided what happens next. */
     readonly UnfaithfulPatch: "LP0411";
-    /** The first write to a date, number or checkbox binding replaced a different reading of the same value. */
+    /** The first write to a date, number, checkbox, select or radio binding replaced a different reading of the same value. */
     readonly ServerFormatReplaced: "LP0412";
     /** A Lexical block has no renderer, and the write could not keep the markup the server rendered for it; it is gone. */
     readonly UnrenderedBlockLost: "LP0413";
@@ -77,7 +79,7 @@ declare const DIAGNOSTIC_CODES: Readonly<{
     readonly StartupFailed: "LP0605";
     /** Sending the ready handshake failed. */
     readonly ReadyFailed: "LP0606";
-    /** The page declared hydration, but no React commit, Vue mount or SvelteKit mount came within the cap; the runtime started without waiting. */
+    /** The page declared hydration, but no React commit, Vue mount, SvelteKit mount or `markHydrated()` call came within the cap; the runtime started without waiting. */
     readonly HydrationWaitTimedOut: "LP0607";
     /** The audit found no runtime in a response that carried preview intent. */
     readonly AuditRuntimeMissing: "LP0701";
@@ -119,6 +121,8 @@ declare const DIAGNOSTIC_CODES: Readonly<{
     readonly V2ReadinessGap: "LP0709";
     /** The preview runtime is served to anonymous visitors, not only inside the admin frame. */
     readonly RuntimeOnPublicPage: "LP0710";
+    /** An element carries attributes that only mean something beside `data-payload-field`, and has none. */
+    readonly AuditModifierWithoutField: "LP0711";
 }>;
 /** A diagnostic code, as it appears in log output and on the `error` event. */
 type DiagnosticCode = (typeof DIAGNOSTIC_CODES)[keyof typeof DIAGNOSTIC_CODES];
@@ -264,6 +268,8 @@ interface RenderContext {
      * completes the sentence 'field "x" …' in LP0411.
      */
     readonly reportUnfaithful?: (target: CachedElement, reason: string) => void;
+    /** The route of a Lexical internal link, as `internalLinkPattern` gives it. */
+    readonly internalLinkPattern?: string;
 }
 /**
  * A renderer writes one value into its element. It must not throw: one bad
@@ -702,7 +708,7 @@ interface LivePreviewInspection {
      * SvelteKit page is not connected yet; `timed-out` is LP0607.
      */
     readonly hydration: {
-        readonly mode: 'off' | 'react' | 'vue' | 'sveltekit';
+        readonly mode: 'off' | 'react' | 'vue' | 'sveltekit' | 'manual';
         readonly state: 'idle' | 'waiting' | 'committed' | 'timed-out';
     };
 }
@@ -855,6 +861,12 @@ interface LivePreviewClientConfig {
     readonly apiRoute?: string;
     /** Population depth used with `serverURL`. Required with it; `defaults: 'v1'` falls back to `1`. */
     readonly mergeDepth?: number;
+    /** Milliseconds the `serverURL` merge may wait before the update shows its raw values. Off by default. */
+    readonly mergeTimeoutMs?: number;
+    /** The route of a Lexical internal link with no `url` of its own, as `/{locale}/{slug}/`. */
+    readonly internalLinkPattern?: string;
+    /** Hold a route render until Payload reports the save: the route shows what is saved. */
+    readonly routeAfterSave?: boolean;
     /** Custom fetch for the `serverURL` merge request: attach auth headers or route through a proxy. */
     readonly mergeFetch?: typeof fetch;
     /** Verbose console output. Defaults to dev-mode detection. */

package/dist/client.d.ts

@@ -33,6 +33,8 @@ declare const DIAGNOSTIC_CODES: Readonly<{
     readonly UnattributableUpdate: "LP0202";
     /** An update carried a value for a field the page binds nowhere; editing it changes nothing on this page. */
     readonly UnboundField: "LP0203";
+    /** In development: a bound path covers its group under the `descendant` default, which 3.0 changes. */
+    readonly CoverageDefaultChanges: "LP0204";
     /** The visibility gate held offscreen writes back until they scroll into view. */
     readonly VisibilityGateDeferred: "LP0301";
     /** A value was refused because the attribute or the value itself is unsafe. */
@@ -57,7 +59,7 @@ declare const DIAGNOSTIC_CODES: Readonly<{
     readonly UnrenderedBlockKept: "LP0410";
     /** A patch cannot reach what the server would have drawn; `onUnfaithfulPatch` decided what happens next. */
     readonly UnfaithfulPatch: "LP0411";
-    /** The first write to a date, number or checkbox binding replaced a different reading of the same value. */
+    /** The first write to a date, number, checkbox, select or radio binding replaced a different reading of the same value. */
     readonly ServerFormatReplaced: "LP0412";
     /** A Lexical block has no renderer, and the write could not keep the markup the server rendered for it; it is gone. */
     readonly UnrenderedBlockLost: "LP0413";
@@ -77,7 +79,7 @@ declare const DIAGNOSTIC_CODES: Readonly<{
     readonly StartupFailed: "LP0605";
     /** Sending the ready handshake failed. */
     readonly ReadyFailed: "LP0606";
-    /** The page declared hydration, but no React commit, Vue mount or SvelteKit mount came within the cap; the runtime started without waiting. */
+    /** The page declared hydration, but no React commit, Vue mount, SvelteKit mount or `markHydrated()` call came within the cap; the runtime started without waiting. */
     readonly HydrationWaitTimedOut: "LP0607";
     /** The audit found no runtime in a response that carried preview intent. */
     readonly AuditRuntimeMissing: "LP0701";
@@ -119,6 +121,8 @@ declare const DIAGNOSTIC_CODES: Readonly<{
     readonly V2ReadinessGap: "LP0709";
     /** The preview runtime is served to anonymous visitors, not only inside the admin frame. */
     readonly RuntimeOnPublicPage: "LP0710";
+    /** An element carries attributes that only mean something beside `data-payload-field`, and has none. */
+    readonly AuditModifierWithoutField: "LP0711";
 }>;
 /** A diagnostic code, as it appears in log output and on the `error` event. */
 type DiagnosticCode = (typeof DIAGNOSTIC_CODES)[keyof typeof DIAGNOSTIC_CODES];
@@ -264,6 +268,8 @@ interface RenderContext {
      * completes the sentence 'field "x" …' in LP0411.
      */
     readonly reportUnfaithful?: (target: CachedElement, reason: string) => void;
+    /** The route of a Lexical internal link, as `internalLinkPattern` gives it. */
+    readonly internalLinkPattern?: string;
 }
 /**
  * A renderer writes one value into its element. It must not throw: one bad
@@ -702,7 +708,7 @@ interface LivePreviewInspection {
      * SvelteKit page is not connected yet; `timed-out` is LP0607.
      */
     readonly hydration: {
-        readonly mode: 'off' | 'react' | 'vue' | 'sveltekit';
+        readonly mode: 'off' | 'react' | 'vue' | 'sveltekit' | 'manual';
         readonly state: 'idle' | 'waiting' | 'committed' | 'timed-out';
     };
 }
@@ -855,6 +861,12 @@ interface LivePreviewClientConfig {
     readonly apiRoute?: string;
     /** Population depth used with `serverURL`. Required with it; `defaults: 'v1'` falls back to `1`. */
     readonly mergeDepth?: number;
+    /** Milliseconds the `serverURL` merge may wait before the update shows its raw values. Off by default. */
+    readonly mergeTimeoutMs?: number;
+    /** The route of a Lexical internal link with no `url` of its own, as `/{locale}/{slug}/`. */
+    readonly internalLinkPattern?: string;
+    /** Hold a route render until Payload reports the save: the route shows what is saved. */
+    readonly routeAfterSave?: boolean;
     /** Custom fetch for the `serverURL` merge request: attach auth headers or route through a proxy. */
     readonly mergeFetch?: typeof fetch;
     /** Verbose console output. Defaults to dev-mode detection. */