payload-live-preview 2.3.1 → 2.4.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (60) hide show
  1. package/README.md +13 -46
  2. package/dist/adapters/astro/index.js +1 -1
  3. package/dist/adapters/astro/index.js.map +1 -1
  4. package/dist/adapters/astro/middleware-entry.js +1 -1
  5. package/dist/adapters/astro/middleware-entry.js.map +1 -1
  6. package/dist/adapters/nextjs/client.d.ts +28 -0
  7. package/dist/adapters/nextjs/client.js +3 -0
  8. package/dist/adapters/nextjs/client.js.map +1 -0
  9. package/dist/adapters/nextjs/index.d.ts +34 -12
  10. package/dist/adapters/nextjs/index.js +1 -1
  11. package/dist/adapters/nextjs/index.js.map +1 -1
  12. package/dist/adapters/nuxt/client.d.ts +29 -0
  13. package/dist/adapters/nuxt/client.js +2 -0
  14. package/dist/adapters/nuxt/client.js.map +1 -0
  15. package/dist/adapters/nuxt/index.js +1 -1
  16. package/dist/adapters/nuxt/index.js.map +1 -1
  17. package/dist/adapters/nuxt/module.d.ts +23 -3
  18. package/dist/adapters/nuxt/module.js +1 -1
  19. package/dist/adapters/nuxt/module.js.map +1 -1
  20. package/dist/adapters/react/index.d.ts +2 -2
  21. package/dist/adapters/react/index.js +1 -1
  22. package/dist/adapters/react/index.js.map +1 -1
  23. package/dist/adapters/sveltekit/client.d.ts +37 -0
  24. package/dist/adapters/sveltekit/client.js +2 -0
  25. package/dist/adapters/sveltekit/client.js.map +1 -0
  26. package/dist/adapters/sveltekit/index.js +1 -1
  27. package/dist/adapters/sveltekit/index.js.map +1 -1
  28. package/dist/adapters/vue/index.d.ts +2 -2
  29. package/dist/adapters/vue/index.js +1 -1
  30. package/dist/adapters/vue/index.js.map +1 -1
  31. package/dist/client.cjs +1 -1
  32. package/dist/client.cjs.map +1 -1
  33. package/dist/client.js +1 -1
  34. package/dist/client.js.map +1 -1
  35. package/dist/core.cjs +1 -1
  36. package/dist/core.cjs.map +1 -1
  37. package/dist/core.d.cts +22 -14
  38. package/dist/core.d.ts +22 -14
  39. package/dist/core.js +1 -1
  40. package/dist/core.js.map +1 -1
  41. package/dist/{document-session-BuYuO3ae.d.ts → document-session-oK92QjES.d.ts} +7 -1
  42. package/dist/index.cjs +1 -1
  43. package/dist/index.cjs.map +1 -1
  44. package/dist/index.js +1 -1
  45. package/dist/index.js.map +1 -1
  46. package/dist/lean.cjs +1 -1
  47. package/dist/lean.cjs.map +1 -1
  48. package/dist/lean.js +1 -1
  49. package/dist/lean.js.map +1 -1
  50. package/dist/lexical.cjs.map +1 -1
  51. package/dist/lexical.js.map +1 -1
  52. package/dist/plugins.cjs +1 -1
  53. package/dist/plugins.cjs.map +1 -1
  54. package/dist/plugins.js +1 -1
  55. package/dist/plugins.js.map +1 -1
  56. package/dist/server.cjs.map +1 -1
  57. package/dist/server.js.map +1 -1
  58. package/dist/structural.cjs.map +1 -1
  59. package/dist/structural.js.map +1 -1
  60. package/package.json +23 -1
package/dist/{document-session-BuYuO3ae.d.ts → document-session-oK92QjES.d.ts} RENAMED
@@ -57,7 +57,7 @@ interface DocumentSessionOptions {
57
57
  /**
58
58
  * Milliseconds a merge may wait for the server; after that the update is `unavailable`
59
59
  * and `data` stays the last good document. Off by default: a merge waits as long as the
60
- * server takes.
60
+ * server takes. `0` keeps it off when 3.0 gives it a default (ADR 0007, row 27).
61
61
  */
62
62
  readonly timeoutMs?: number;
63
63
  /**
@@ -77,6 +77,12 @@ interface DocumentSessionOptions {
77
77
  * slug, and a create screen has no id yet. Without it the session merges every update.
78
78
  */
79
79
  readonly document?: PreviewDocument;
80
+ /**
81
+ * With a `locale` in `document`, also leave alone an update that names no locale, as 3.0
82
+ * does for every hook with a `locale` (ADR 0007, row 31). Off by default: such an update is
83
+ * merged.
84
+ */
85
+ readonly requireLocale?: boolean;
80
86
  /** Injected for tests. */
81
87
  readonly fetchFn?: typeof fetch;
82
88
  /** Window to listen on. Default the global one. */