payload-live-preview 2.0.0-beta.0 → 2.0.0

package/dist/adapters/nuxt/index.d.ts

@@ -1,4 +1,7 @@
-import { b as PreviewAdapterOptions, c as PreviewRequestLike } from '../../options-CEzzfHJu.js';
+import { P as PreviewAdapterOptions, a as PreviewRequestLike } from '../../options-BW1eqXvc.js';
+import { F as FragmentEndpointOptions$1, a as FragmentRegistry$1, b as FragmentRegistryEntry$1, c as FragmentRenderer$1 } from '../../fragment-endpoint-3Mlz7GDz.js';
+export { d as FragmentRenderInput } from '../../fragment-endpoint-3Mlz7GDz.js';
+export { L as LivePreviewLocals } from '../../locals-DBXDMxOA.js';
 
 /**
  * Nuxt 3 / Nitro adapter: the server handler decides before the Vue app
@@ -52,7 +55,7 @@ interface NitroAppLike {
     };
 }
 type NitroHandler = (event: H3EventLike) => Promise<Response | undefined>;
-/** Where the server handler leaves its decision for the plugin, on `event.context`. */
+/** Where the server handler leaves its decision for the plugin, on `event.context`. @internal */
 declare const DECISION_CONTEXT_KEY = "livePreviewDecision";
 /**
  * Nitro plugin body (`defineNitroPlugin(livePreviewNitroPlugin(...))`): on
@@ -73,4 +76,56 @@ declare function renderLivePreviewScript(options?: LivePreviewNuxtOptions & {
 /** The CSP header value for consumers that set the header themselves; it builds and never gates, so `manageCsp: false` still yields frame-ancestors. */
 declare function buildLivePreviewCsp(options: LivePreviewNuxtOptions, nonce: string, existing?: string, mode?: 'frame-ancestors' | 'full'): string;
 
-export { DECISION_CONTEXT_KEY, type LivePreviewNuxtOptions, type NitroHandler, PreviewAdapterOptions, buildLivePreviewCsp, defineLivePreviewServerHandler, livePreviewNitroPlugin, renderLivePreviewScript };
+/**
+ * A Vue component as `import Hero from './Hero.vue'` yields it — an options
+ * object, or a functional component, which is also an object structurally.
+ * Duck-typed rather than imported from `vue`, so the optional peer stays
+ * optional at typecheck time as well.
+ */
+type VueComponentLike = object;
+type FragmentRegistryEntry<Props extends object = object> = FragmentRegistryEntry$1<VueComponentLike, Props>;
+/** @internal */
+type FragmentRegistry = FragmentRegistry$1<VueComponentLike>;
+/** @internal */
+type FragmentRenderer = FragmentRenderer$1<VueComponentLike>;
+type FragmentEndpointOptions = FragmentEndpointOptions$1<VueComponentLike>;
+/**
+ * Build the endpoint. Nitro hands a route handler an H3 event, so wrap it:
+ *
+ * ```ts
+ * // server/routes/payload/fragment.post.ts
+ * const endpoint = createFragmentEndpoint({ registry, authorize });
+ * export default defineEventHandler((event) => endpoint(toWebRequest(event)));
+ * ```
+ */
+declare function createFragmentEndpoint(options: FragmentEndpointOptions): (request: Request) => Promise<Response>;
+
+/**
+ * The route half of `delivery: 'asset'` for Nuxt.
+ *
+ * Nitro hands a route handler an H3 event, so the handler takes the web request
+ * the event converts to — the same shape `createFragmentEndpoint()` uses here:
+ *
+ * ```ts
+ * // server/routes/payload-live-preview/[file].get.ts
+ * import { createRuntimeAssetRoute } from 'payload-live-preview/nuxt';
+ *
+ * const asset = createRuntimeAssetRoute(livePreviewOptions);
+ * export default defineEventHandler((event) => asset(toWebRequest(event)));
+ * ```
+ *
+ * The dynamic segment carries the content hash; the handler answers the one
+ * name this package build produces and 404s the rest, which is what lets the
+ * response promise a year of `immutable`. Everything it decides is in
+ * `@adapters/shared/runtime-asset` — the same answer the other adapters give.
+ */
+
+/**
+ * Takes the adapter's own options so the one object can be passed to both
+ * halves: only `assetPath` and `runtime` are read, but those two are exactly
+ * what the page and the route have to agree on, and `runtime: LEAN_RUNTIME`
+ * means the page asks for that artifact's hash.
+ */
+declare function createRuntimeAssetRoute(options?: LivePreviewNuxtOptions): (request: Request) => Response;
+
+export { DECISION_CONTEXT_KEY, type FragmentEndpointOptions, type FragmentRegistry, type FragmentRegistryEntry, type FragmentRenderer, type LivePreviewNuxtOptions, type NitroHandler, PreviewAdapterOptions, type VueComponentLike, buildLivePreviewCsp, createFragmentEndpoint, createRuntimeAssetRoute, defineLivePreviewServerHandler, livePreviewNitroPlugin, renderLivePreviewScript };