@prismicio/svelte 2.2.1 → 2.2.2-canary.6d1bc0d

package/dist/PrismicTable.svelte.d.ts

@@ -2,17 +2,13 @@ import type { TableField } from "@prismicio/client";
 import type { Component } from "svelte";
 import type { RichTextComponents, TableComponents } from "./types";
 type Props = {
-    /**
-     * The Prismic table field to render.
-     */
+    /** The Prismic table field to render. */
     field: TableField;
-    /**
-     * An object that maps a rich text block type to a Svelte component.
-     */
+    /** An object that maps a rich text block type to a Svelte component. */
     components?: TableComponents & RichTextComponents;
     /**
-     * The component rendered when the field is empty. If a fallback is not
-     * given, `null` will be rendered.
+     * The component rendered when the field is empty. If a fallback is not given, `null` will be
+     * rendered.
      */
     fallback?: Component;
 };

package/dist/PrismicText.svelte

@@ -1,29 +1,25 @@
 <script lang="ts">
-	import type { RichTextField } from "@prismicio/client";
-	import { asText, isFilled } from "@prismicio/client";
-	import { DEV } from "esm-env";
+	import type { RichTextField } from "@prismicio/client"
+	import { asText, isFilled } from "@prismicio/client"
+	import { DEV } from "esm-env"
 
-	import { devMsg } from "./lib/devMsg";
+	import { devMsg } from "./lib/devMsg"
 
 	type Props = {
-		/**
-		 * A Rich Text or Title field from Prismic.
-		 */
-		field: RichTextField;
+		/** A Rich Text or Title field from Prismic. */
+		field: RichTextField
 
-		/**
-		 * The separator used between blocks. Defaults to `\n`.
-		 */
-		separator?: string | undefined;
+		/** The separator used between blocks. Defaults to `\n`. */
+		separator?: string | undefined
 
 		/**
-		 * The string rendered when the field is empty. If a fallback is not given,
-		 * `null` will be rendered.
+		 * The string rendered when the field is empty. If a fallback is not given, `null` will be
+		 * rendered.
 		 */
-		fallback?: string | undefined;
-	};
+		fallback?: string | undefined
+	}
 
-	const { field, separator, fallback, ...restProps }: Props = $props();
+	const { field, separator, fallback, ...restProps }: Props = $props()
 
 	$effect(() => {
 		if (DEV) {
@@ -33,10 +29,10 @@
 						"classname-is-not-a-valid-prop",
 					)}.`,
 					$state.snapshot(field),
-				);
+				)
 			}
 		}
-	});
+	})
 
 	if (DEV) {
 		if (typeof field === "string") {
@@ -44,7 +40,7 @@
 				`[PrismicText] The "field" prop only accepts a Rich Text or Title field's value but was provided a different type of field instead (e.g. a Key Text or Select field). You can resolve this error by rendering the field value inline without <PrismicText>. For more details, see ${devMsg(
 					"prismictext-works-only-with-rich-text-and-title-fields",
 				)}`,
-			);
+			)
 		}
 	}
 </script>

package/dist/PrismicText.svelte.d.ts

@@ -1,16 +1,12 @@
 import type { RichTextField } from "@prismicio/client";
 type Props = {
-    /**
-     * A Rich Text or Title field from Prismic.
-     */
+    /** A Rich Text or Title field from Prismic. */
     field: RichTextField;
-    /**
-     * The separator used between blocks. Defaults to `\n`.
-     */
+    /** The separator used between blocks. Defaults to `\n`. */
     separator?: string | undefined;
     /**
-     * The string rendered when the field is empty. If a fallback is not given,
-     * `null` will be rendered.
+     * The string rendered when the field is empty. If a fallback is not given, `null` will be
+     * rendered.
      */
     fallback?: string | undefined;
 };

package/dist/SliceSimulator.svelte

@@ -9,35 +9,35 @@
 		onClickHandler,
 		simulatorClass,
 		simulatorRootClass,
-	} from "@prismicio/simulator/kit";
+	} from "@prismicio/simulator/kit"
 
-	const defaultProps = getDefaultProps();
+	const defaultProps = getDefaultProps()
 
-	export let zIndex = defaultProps.zIndex;
-	export let background = defaultProps.background;
+	export let zIndex = defaultProps.zIndex
+	export let background = defaultProps.background
 
-	let slices = getDefaultSlices();
-	let message = getDefaultMessage();
+	let slices = getDefaultSlices()
+	let message = getDefaultMessage()
 
 	if (typeof window !== "undefined") {
-		const simulatorManager = new SimulatorManager();
+		const simulatorManager = new SimulatorManager()
 
 		simulatorManager.state.on(
 			StateEventType.Slices,
 			(newSlices) => {
-				slices = newSlices;
+				slices = newSlices
 			},
 			"simulator-slices",
-		);
+		)
 		simulatorManager.state.on(
 			StateEventType.Message,
 			(newMessage) => {
-				message = newMessage;
+				message = newMessage
 			},
 			"simulator-message",
-		);
+		)
 
-		simulatorManager.init();
+		simulatorManager.init()
 	}
 </script>
 

package/dist/SliceZone/SliceZone.svelte

@@ -1,54 +1,49 @@
 <script lang="ts">
-	import type { Component } from "svelte";
+	import type { Component } from "svelte"
 
-	import type { SliceComponentProps, SliceZoneLike } from "../types";
-
-	import TodoComponent from "./TodoComponent.svelte";
+	import type { SliceComponentProps, SliceZoneLike } from "../types"
+	import TodoComponent from "./TodoComponent.svelte"
 
 	type Props = {
-		/**
-		 * An array of Prismic Slices, such as the `slices` property from a Prismic
-		 * document.
-		 */
-		slices?: SliceZoneLike;
+		/** An array of Prismic Slices, such as the `slices` property from a Prismic document. */
+		slices?: SliceZoneLike
 
 		/**
 		 * An object that maps Slice components to their corresponding API IDs.
 		 *
-		 * @example An example map:
+		 * @example
+		 * 	An example map:
 		 *
-		 * ```js
-		 * import BlockQuote from "./BlockQuote.svelte";
-		 * import HeroImage from "./HeroImage.svelte";
+		 * 	```js
+		 * 	import BlockQuote from "./BlockQuote.svelte";
+		 * 	import HeroImage from "./HeroImage.svelte";
 		 *
-		 * const components = {
+		 * 	const components = {
 		 * 	block_quote: BlockQuote,
 		 * 	hero_image: HeroImage,
-		 * };
-		 * ```
+		 * 	};
+		 * 	```
 		 */
 		// eslint-disable-next-line @typescript-eslint/no-explicit-any
-		components?: Record<string, Component<any>>;
+		components?: Record<string, Component<any>>
 
-		/**
-		 * Arbitrary data passed to all Slice components as a `context` prop.
-		 */
+		/** Arbitrary data passed to all Slice components as a `context` prop. */
 		// eslint-disable-next-line @typescript-eslint/no-explicit-any
-		context?: any;
+		context?: any
 
 		/**
-		 * The Svelte component rendered if a component mapping from the
-		 * `components` prop cannot be found.
+		 * The Svelte component rendered if a component mapping from the `components` prop cannot be
+		 * found.
 		 */
-		defaultComponent?: Component<SliceComponentProps> | undefined;
-	};
+		defaultComponent?: Component<SliceComponentProps> | undefined
+	}
 
 	const {
 		slices = [],
 		components = {},
 		context = {},
 		defaultComponent = undefined,
-	}: Props = $props();
+	}: Props = $props()
 </script>
 
 <!--

package/dist/SliceZone/SliceZone.svelte.d.ts

@@ -1,34 +1,30 @@
 import type { Component } from "svelte";
 import type { SliceComponentProps, SliceZoneLike } from "../types";
 type Props = {
-    /**
-     * An array of Prismic Slices, such as the `slices` property from a Prismic
-     * document.
-     */
+    /** An array of Prismic Slices, such as the `slices` property from a Prismic document. */
     slices?: SliceZoneLike;
     /**
      * An object that maps Slice components to their corresponding API IDs.
      *
-     * @example An example map:
+     * @example
+     * 	An example map:
      *
-     * ```js
-     * import BlockQuote from "./BlockQuote.svelte";
-     * import HeroImage from "./HeroImage.svelte";
+     * 	```js
+     * 	import BlockQuote from "./BlockQuote.svelte";
+     * 	import HeroImage from "./HeroImage.svelte";
      *
-     * const components = {
+     * 	const components = {
      * 	block_quote: BlockQuote,
      * 	hero_image: HeroImage,
-     * };
-     * ```
+     * 	};
+     * 	```
      */
     components?: Record<string, Component<any>>;
-    /**
-     * Arbitrary data passed to all Slice components as a `context` prop.
-     */
+    /** Arbitrary data passed to all Slice components as a `context` prop. */
     context?: any;
     /**
-     * The Svelte component rendered if a component mapping from the
-     * `components` prop cannot be found.
+     * The Svelte component rendered if a component mapping from the `components` prop cannot be
+     * found.
      */
     defaultComponent?: Component<SliceComponentProps> | undefined;
 };

package/dist/SliceZone/TodoComponent.svelte

@@ -1,22 +1,22 @@
 <script lang="ts">
-	import { DEV } from "esm-env";
+	import { DEV } from "esm-env"
 
 	type Props = {
-		slice: { slice_type: string } | { type: string };
-	};
+		slice: { slice_type: string } | { type: string }
+	}
 
-	const { slice }: Props = $props();
+	const { slice }: Props = $props()
 
-	const type = $derived("slice_type" in slice ? slice.slice_type : slice.type);
+	const type = $derived("slice_type" in slice ? slice.slice_type : slice.type)
 
 	$effect(() => {
 		if (DEV) {
 			console.warn(
 				`[SliceZone] Could not find a component for Slice type "${type}"`,
 				$state.snapshot(slice),
-			);
+			)
 		}
-	});
+	})
 </script>
 
 {#if DEV}

package/dist/index.d.ts

@@ -7,9 +7,7 @@ export { default as PrismicTable } from "./PrismicTable.svelte";
 export { default as PrismicText } from "./PrismicText.svelte";
 export { default as SliceZone } from "./SliceZone/SliceZone.svelte";
 export { default as SliceSimulator } from "./SliceSimulator.svelte";
-/**
- * @deprecated Replaced with `RichTextComponents`
- */
+/** @deprecated Replaced with `RichTextComponents` */
 export type SvelteRichTextSerializer = RichTextComponents;
 export type { RichTextComponents };
 export type { RichTextComponentProps, SliceComponentProps } from "./types";

package/dist/kit/PrismicPreview.svelte

@@ -1,62 +1,51 @@
 <script lang="ts">
-	import { beforeNavigate, goto, invalidateAll } from "$app/navigation";
-	import { getToolbarSrc } from "@prismicio/client";
-	import { onMount } from "svelte";
+	import { beforeNavigate, goto, invalidateAll } from "$app/navigation"
+	import { getToolbarSrc } from "@prismicio/client"
+	import { onMount } from "svelte"
 
 	type Props = {
 		/**
-		 * The name of your Prismic repository. A Prismic Toolbar will be registered
-		 * using this repository.
+		 * The name of your Prismic repository. A Prismic Toolbar will be registered using this
+		 * repository.
 		 */
-		repositoryName: string;
+		repositoryName: string
 
-		/**
-		 * The route parameter prefixed during preview sessions.
-		 */
-		routePrefix?: string;
+		/** The route parameter prefixed during preview sessions. */
+		routePrefix?: string
 
 		/**
-		 * The name of the preview-specific route parameter prefixed during preview
-		 * sessions.
+		 * The name of the preview-specific route parameter prefixed during preview sessions.
 		 *
-		 * Only set this value if the route parameter's name differs from the
-		 * parameter's value.
+		 * Only set this value if the route parameter's name differs from the parameter's value.
 		 */
-		routePrefixName?: string;
-	};
+		routePrefixName?: string
+	}
 
-	const {
-		repositoryName,
-		routePrefix = "preview",
-		routePrefixName = routePrefix,
-	}: Props = $props();
+	const { repositoryName, routePrefix = "preview", routePrefixName = routePrefix }: Props = $props()
 
-	const toolbarSrc = $derived(getToolbarSrc(repositoryName));
+	const toolbarSrc = $derived(getToolbarSrc(repositoryName))
 
-	/**
-	 * Set to `true` when the next `beforeNavigate()` call should not prefix the
-	 * route.
-	 */
-	let endingPreview = $state(false);
+	/** Set to `true` when the next `beforeNavigate()` call should not prefix the route. */
+	let endingPreview = $state(false)
 
 	// Register Prismic toolbar event handlers to refresh data on content updates.
 	onMount(() => {
-		const controller = new AbortController();
+		const controller = new AbortController()
 
 		window.addEventListener(
 			"prismicPreviewUpdate",
 			(event) => {
-				event.preventDefault();
-				invalidateAll();
+				event.preventDefault()
+				invalidateAll()
 			},
 			{ signal: controller.signal },
-		);
+		)
 		window.addEventListener(
 			"prismicPreviewEnd",
 			(event) => {
-				event.preventDefault();
+				event.preventDefault()
 
-				endingPreview = true;
+				endingPreview = true
 
 				goto(
 					new URL(
@@ -70,15 +59,15 @@
 						invalidateAll: true,
 						noScroll: true,
 					},
-				);
+				)
 			},
 			{ signal: controller.signal },
-		);
+		)
 
 		return () => {
-			controller.abort();
-		};
-	});
+			controller.abort()
+		}
+	})
 
 	beforeNavigate((navigation) => {
 		// Prefix links with the preview route parameter if the current
@@ -92,19 +81,14 @@
 			// event, don't prefix the route. The exception is only
 			// valid for one call.
 			if (endingPreview) {
-				endingPreview = false;
-				return;
+				endingPreview = false
+				return
 			}
 
-			navigation.cancel();
-			goto(
-				new URL(
-					routePrefix + navigation.to.url.pathname,
-					navigation.to.url.origin,
-				),
-			);
+			navigation.cancel()
+			goto(new URL(routePrefix + navigation.to.url.pathname, navigation.to.url.origin))
 		}
-	});
+	})
 </script>
 
 <svelte:head>

package/dist/kit/PrismicPreview.svelte.d.ts

@@ -1,19 +1,15 @@
 type Props = {
     /**
-     * The name of your Prismic repository. A Prismic Toolbar will be registered
-     * using this repository.
+     * The name of your Prismic repository. A Prismic Toolbar will be registered using this
+     * repository.
      */
     repositoryName: string;
-    /**
-     * The route parameter prefixed during preview sessions.
-     */
+    /** The route parameter prefixed during preview sessions. */
     routePrefix?: string;
     /**
-     * The name of the preview-specific route parameter prefixed during preview
-     * sessions.
+     * The name of the preview-specific route parameter prefixed during preview sessions.
      *
-     * Only set this value if the route parameter's name differs from the
-     * parameter's value.
+     * Only set this value if the route parameter's name differs from the parameter's value.
      */
     routePrefixName?: string;
 };

package/dist/kit/enableAutoPreviews.d.ts

@@ -1,22 +1,17 @@
 import * as prismic from "@prismicio/client";
 import type { Cookies } from "@sveltejs/kit";
-/**
- * Configuration for `enableAutoPreviews`.
- */
+/** Configuration for `enableAutoPreviews`. */
 export type EnableAutoPreviewsConfig = {
-    /**
-     * Prismic client with which automatic previews will be enabled.
-     */
+    /** Prismic client with which automatic previews will be enabled. */
     client: Pick<prismic.Client, "queryContentFromRef">;
     /**
-     * The `cookies` object provided to a route's `load()` function. This
-     * parameter is required to load previews.
+     * The `cookies` object provided to a route's `load()` function. This parameter is required to
+     * load previews.
      */
     cookies?: Cookies;
 };
 /**
- * Configures a Prismic client to automatically query draft content during a
- * preview session.
+ * Configures a Prismic client to automatically query draft content during a preview session.
  *
  * @param config - Configuration for the function.
  */

package/dist/kit/enableAutoPreviews.js

@@ -1,7 +1,6 @@
 import * as prismic from "@prismicio/client";
 /**
- * Configures a Prismic client to automatically query draft content during a
- * preview session.
+ * Configures a Prismic client to automatically query draft content during a preview session.
  *
  * @param config - Configuration for the function.
  */

package/dist/kit/redirectToPreviewURL.d.ts

@@ -1,9 +1,7 @@
 import * as prismic from "@prismicio/client";
 import type { Cookies } from "@sveltejs/kit";
 export type RedirectToPreviewURLConfig = {
-    /**
-     * The Prismic client configured for the preview session's repository.
-     */
+    /** The Prismic client configured for the preview session's repository. */
     client: Pick<prismic.Client, "resolvePreviewURL">;
     /**
      * The `request` object from a `+server` file.
@@ -17,33 +15,27 @@ export type RedirectToPreviewURLConfig = {
      * @see SvelteKit `+server` docs: \<https://kit.svelte.dev/docs/routing#server\>
      */
     cookies: Cookies;
-    /**
-     * The default redirect URL if a URL cannot be determined for the previewed
-     * document.
-     */
+    /** The default redirect URL if a URL cannot be determined for the previewed document. */
     defaultURL?: string;
-    /**
-     * The route parameter prefixed during preview sessions.
-     */
+    /** The route parameter prefixed during preview sessions. */
     routePrefix?: string;
 };
 /**
- * Redirects a visitor to the URL of a previewed Prismic document from within a
- * SvelteKit `+server` file.
+ * Redirects a visitor to the URL of a previewed Prismic document from within a SvelteKit `+server`
+ * file.
  *
  * Return the created `Response` in your `+server` file.
  *
  * @example
+ * 	```typescript
+ * 	import { createClient } from "$lib/prismicio.js"
+ * 	import { redirectToPreviewURL } from "@prismicio/svelte/kit"
  *
- * ```typescript
- * import { createClient } from "../lib/prismicio.js";
- * import { redirectToPreviewURL } from "@prismicio/svelte/kit";
- *
- * export async function GET({ fetch, request }) {
- * 	const client = createClient({ fetch });
+ * 	export async function GET({ fetch, request }) {
+ * 		const client = createClient({ fetch })
  *
- * 	return await redirectToPreviewURL({ client, request });
- * }
- * ```
+ * 		return await redirectToPreviewURL({ client, request })
+ * 	}
+ * 	```
  */
 export declare const redirectToPreviewURL: (config: RedirectToPreviewURLConfig) => Promise<Response>;

package/dist/kit/redirectToPreviewURL.js

@@ -1,22 +1,21 @@
 import * as prismic from "@prismicio/client";
 /**
- * Redirects a visitor to the URL of a previewed Prismic document from within a
- * SvelteKit `+server` file.
+ * Redirects a visitor to the URL of a previewed Prismic document from within a SvelteKit `+server`
+ * file.
  *
  * Return the created `Response` in your `+server` file.
  *
  * @example
+ * 	```typescript
+ * 	import { createClient } from "$lib/prismicio.js"
+ * 	import { redirectToPreviewURL } from "@prismicio/svelte/kit"
  *
- * ```typescript
- * import { createClient } from "../lib/prismicio.js";
- * import { redirectToPreviewURL } from "@prismicio/svelte/kit";
+ * 	export async function GET({ fetch, request }) {
+ * 		const client = createClient({ fetch })
  *
- * export async function GET({ fetch, request }) {
- * 	const client = createClient({ fetch });
- *
- * 	return await redirectToPreviewURL({ client, request });
- * }
- * ```
+ * 		return await redirectToPreviewURL({ client, request })
+ * 	}
+ * 	```
  */
 export const redirectToPreviewURL = async (config) => {
     const previewToken = new URL(config.request.url).searchParams.get("token") ?? undefined;

package/dist/kit/types.d.ts

@@ -1,13 +1,10 @@
 import type { ClientConfig } from "@prismicio/client";
 import type { Cookies } from "@sveltejs/kit";
-/**
- * Configuration for creating a Prismic client with automatic preview support in
- * SvelteKit apps.
- */
+/** Configuration for creating a Prismic client with automatic preview support in SvelteKit apps. */
 export type CreateClientConfig = ClientConfig & {
     /**
-     * The `cookies` object provided to a route's `load()` function. This
-     * parameter is required to load previews.
+     * The `cookies` object provided to a route's `load()` function. This parameter is required to
+     * load previews.
      */
     cookies?: Cookies;
 };

package/dist/lib/devMsg.d.ts

@@ -2,15 +2,13 @@
  * Returns a `prismic.dev/msg` URL for a given message slug.
  *
  * @example
+ * 	```ts
+ * 	devMsg("missing-param")
+ * 	// => "https://prismic.dev/msg/svelte/v1.2.3/missing-param.md"
+ * 	```
  *
- * ```ts
- * devMsg("missing-param");
- * // => "https://prismic.dev/msg/svelte/v1.2.3/missing-param.md"
- * ```
- *
- * @param slug - Slug for the message. This corresponds to a Markdown file in
- *   the Git repository's `/messages` directory.
- *
+ * @param slug - Slug for the message. This corresponds to a Markdown file in the Git repository's
+ *   `/messages` directory.
  * @returns The `prismic.dev/msg` URL for the given slug.
  */
 export declare const devMsg: (slug: string) => string;