@prismicio/svelte 2.2.2 → 2.2.3

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;

package/dist/lib/devMsg.js

@@ -3,15 +3,13 @@ import { version } from "../../package.json";
  * 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 const devMsg = (slug) => {

package/dist/types.d.ts

@@ -1,13 +1,9 @@
 import type { RTAnyNode, RTEmNode, RTEmbedNode, RTHeading1Node, RTHeading2Node, RTHeading3Node, RTHeading4Node, RTHeading5Node, RTHeading6Node, RTImageNode, RTLabelNode, RTLinkNode, RTListItemNode, RTListNode, RTOListItemNode, RTOListNode, RTParagraphNode, RTPreformattedNode, RTSpanNode, RTStrongNode, Slice, TableField, TableFieldBody, TableFieldBodyRow, TableFieldDataCell, TableFieldHead, TableFieldHeadRow, TableFieldHeaderCell } from "@prismicio/client";
 import type { Component, Snippet } from "svelte";
 import type { HTMLAttributes } from "svelte/elements";
-/**
- * A shorthand definition for `<PrismicRichText />` component types.
- */
+/** A shorthand definition for `<PrismicRichText />` component types. */
 export type ComponentShorthand = {
-    /**
-     * The HTML element type rendered for this node type.
-     */
+    /** The HTML element type rendered for this node type. */
     as?: string;
 } & HTMLAttributes<HTMLElement>;
 export type RichTextComponents = {
@@ -63,38 +59,28 @@ export type TableComponents = {
     }> | HTMLAttributes<HTMLTableCellElement>;
 };
 /**
- * Props for a component rendering content from a Prismic Slice using the
- * `<SliceZone>` component.
+ * Props for a component rendering content from a Prismic Slice using the `<SliceZone>` component.
  *
  * @typeParam TSlice - The Slice passed as a prop.
- * @typeParam TContext - Arbitrary data passed to `<SliceZone>` and made
- *   available to all Slice components.
+ * @typeParam TContext - Arbitrary data passed to `<SliceZone>` and made available to all Slice
+ *   components.
  */
 export type SliceComponentProps<TSlice extends SliceLike = SliceLike, TContext = unknown> = {
-    /**
-     * Slice data for this component.
-     */
+    /** Slice data for this component. */
     slice: TSlice;
-    /**
-     * The index of the Slice in the Slice Zone.
-     */
+    /** The index of the Slice in the Slice Zone. */
     index: number;
-    /**
-     * All Slices from the Slice Zone to which the Slice belongs.
-     */
+    /** All Slices from the Slice Zone to which the Slice belongs. */
     slices: SliceZoneLike<TSlice extends SliceLikeGraphQL ? SliceLikeGraphQL : SliceLikeRestV2>;
-    /**
-     * Arbitrary data passed to `<SliceZone>` and made available to all Slice
-     * components.
-     */
+    /** Arbitrary data passed to `<SliceZone>` and made available to all Slice components. */
     context: TContext;
 };
 /**
- * The minimum required properties to represent a Prismic Slice from the Prismic
- * Rest API V2 for the `<SliceZone>` component.
+ * The minimum required properties to represent a Prismic Slice from the Prismic Rest API V2 for the
+ * `<SliceZone>` component.
  *
- * If using Prismic's Rest API V2, use the `Slice` export from
- * `@prismicio/types` for a full interface.
+ * If using Prismic's Rest API V2, use the `Slice` export from `@prismicio/types` for a full
+ * interface.
  *
  * @typeParam SliceType - Type name of the Slice.
  */
@@ -102,8 +88,8 @@ type SliceLikeRestV2<SliceType extends string = string> = {
     slice_type: Slice<SliceType>["slice_type"];
 };
 /**
- * The minimum required properties to represent a Prismic Slice from the Prismic
- * GraphQL API for the `<SliceZone>` component.
+ * The minimum required properties to represent a Prismic Slice from the Prismic GraphQL API for the
+ * `<SliceZone>` component.
  *
  * @typeParam SliceType - Type name of the Slice.
  */
@@ -111,29 +97,27 @@ type SliceLikeGraphQL<SliceType extends string = string> = {
     type: Slice<SliceType>["slice_type"];
 };
 /**
- * The minimum required properties to represent a Prismic Slice for the
- * `<SliceZone>` component.
+ * The minimum required properties to represent a Prismic Slice for the `<SliceZone>` component.
  *
- * If using Prismic's Rest API V2, use the `Slice` export from
- * `@prismicio/types` for a full interface.
+ * If using Prismic's Rest API V2, use the `Slice` export from `@prismicio/types` for a full
+ * interface.
  *
  * @typeParam SliceType - Type name of the Slice.
  */
 type SliceLike<SliceType extends string = string> = (SliceLikeRestV2<SliceType> | SliceLikeGraphQL<SliceType>) & {
     /**
-     * If `true`, this Slice has been modified from its original value using a
-     * mapper and `@prismicio/client`'s `mapSliceZone()`.
+     * If `true`, this Slice has been modified from its original value using a mapper and
+     * `@prismicio/client`'s `mapSliceZone()`.
      *
      * @internal
      */
     __mapped?: true;
 };
 /**
- * A looser version of the `SliceZone` type from `@prismicio/client` using
- * `SliceLike`.
+ * A looser version of the `SliceZone` type from `@prismicio/client` using `SliceLike`.
  *
- * If using Prismic's Rest API V2, use the `SliceZone` export from
- * `@prismicio/client` for the full type.
+ * If using Prismic's Rest API V2, use the `SliceZone` export from `@prismicio/client` for the full
+ * type.
  *
  * @typeParam TSlice - The type(s) of a Slice in the Slice Zone.
  */

package/package.json

@@ -1,18 +1,35 @@
 {
 	"name": "@prismicio/svelte",
-	"version": "2.2.2",
+	"version": "2.2.3",
 	"description": "Svelte components to present Prismic content.",
 	"keywords": [
-		"typescript",
-		"prismic"
+		"prismic",
+		"typescript"
 	],
+	"license": "Apache-2.0",
+	"author": "Prismic <contact@prismic.io> (https://prismic.io)",
 	"repository": {
 		"type": "git",
 		"url": "ssh://git@github.com/prismicio/prismic-svelte.git"
 	},
-	"license": "Apache-2.0",
-	"author": "Prismic <contact@prismic.io> (https://prismic.io)",
+	"files": [
+		"./dist",
+		"./src"
+	],
 	"type": "module",
+	"main": "./dist/index.js",
+	"module": "./dist/index.js",
+	"types": "./dist/index.d.ts",
+	"typesVersions": {
+		"*": {
+			"*": [
+				"dist/index.d.ts"
+			],
+			"kit": [
+				"dist/kit/index.d.ts"
+			]
+		}
+	},
 	"exports": {
 		".": {
 			"types": "./dist/index.d.ts",
@@ -26,27 +43,13 @@
 		},
 		"./package.json": "./package.json"
 	},
-	"main": "./dist/index.js",
-	"module": "./dist/index.js",
-	"types": "./dist/index.d.ts",
-	"typesVersions": {
-		"*": {
-			"*": [
-				"dist/index.d.ts"
-			],
-			"kit": [
-				"dist/kit/index.d.ts"
-			]
-		}
+	"publishConfig": {
+		"access": "public"
 	},
-	"files": [
-		"./dist",
-		"./src"
-	],
 	"scripts": {
 		"build": "svelte-package --input ./src",
 		"dev": "svelte-package --input ./src --watch",
-		"format": "prettier --write --plugin prettier-plugin-svelte .",
+		"format": "oxfmt",
 		"prepare": "npm run build",
 		"lint": "oxlint --deny-warnings",
 		"types": "tsc --noEmit",
@@ -55,29 +58,26 @@
 		"test": "npm run lint && npm run types && npm run unit && npm run build"
 	},
 	"dependencies": {
-		"@prismicio/simulator": "^0.2.2",
+		"@prismicio/simulator": "^0.2.4",
 		"esm-env": "^1.2.2"
 	},
 	"devDependencies": {
-		"@prismicio/client": "^7.21.8",
+		"@prismicio/client": "^7.22.3",
 		"@prismicio/mock": "^0.7.2",
-		"@sveltejs/kit": "^2.57.0",
-		"@sveltejs/package": "^2.5.7",
-		"@sveltejs/vite-plugin-svelte": "^7.0.0",
-		"@testing-library/svelte": "^5.3.1",
-		"@trivago/prettier-plugin-sort-imports": "^6.0.2",
-		"@types/node": "^25.5.2",
-		"@vitest/coverage-v8": "^4.1.3",
-		"globals": "^17.4.0",
-		"happy-dom": "^20.8.9",
-		"oxlint": "^1.59.0",
-		"prettier": "^3.8.1",
-		"prettier-plugin-jsdoc": "^1.8.0",
-		"prettier-plugin-svelte": "^3.5.1",
+		"@sveltejs/kit": "^2.70.3",
+		"@sveltejs/package": "^3.0.0",
+		"@sveltejs/vite-plugin-svelte": "^7.3.1",
+		"@testing-library/svelte": "^5.4.2",
+		"@types/node": "^26.6.5",
+		"@vitest/coverage-v8": "^5.0.3",
+		"globals": "^17.13.0",
+		"happy-dom": "^20.14.6",
+		"oxfmt": "^0.72.0",
+		"oxlint": "^1.87.0",
 		"standard-version": "^9.5.0",
-		"svelte": "^5.55.2",
-		"typescript": "^6.0.2",
-		"vitest": "^4.1.3"
+		"svelte": "^5.57.2",
+		"typescript": "^6.0.3",
+		"vitest": "^5.0.3"
 	},
 	"peerDependencies": {
 		"@prismicio/client": ">=7",
@@ -90,9 +90,6 @@
 		}
 	},
 	"engines": {
-		"node": ">=20"
-	},
-	"publishConfig": {
-		"access": "public"
+		"node": ">=22"
 	}
 }

package/src/PrismicEmbed.svelte

@@ -1,15 +1,13 @@
 <script lang="ts">
-	import type { EmbedField } from "@prismicio/client";
-	import { isFilled } from "@prismicio/client";
+	import type { EmbedField } from "@prismicio/client"
+	import { isFilled } from "@prismicio/client"
 
 	type Props = {
-		/**
-		 * An Embed field from Prismic.
-		 */
-		field: EmbedField;
-	};
+		/** An Embed field from Prismic. */
+		field: EmbedField
+	}
 
-	const { field }: Props = $props();
+	const { field }: Props = $props()
 </script>
 
 <!--

package/src/PrismicImage.svelte

@@ -1,75 +1,61 @@
 <script lang="ts">
-	import {
-		asImagePixelDensitySrcSet,
-		asImageWidthSrcSet,
-		isFilled,
-	} from "@prismicio/client";
-	import type { ImageFieldImage } from "@prismicio/client";
-	import type { ImgixURLParams } from "imgix-url-builder";
-	import type { HTMLImgAttributes } from "svelte/elements";
+	import { asImagePixelDensitySrcSet, asImageWidthSrcSet, isFilled } from "@prismicio/client"
+	import type { ImageFieldImage } from "@prismicio/client"
+	import type { ImgixURLParams } from "imgix-url-builder"
+	import type { HTMLImgAttributes } from "svelte/elements"
 
 	type Props = Omit<HTMLImgAttributes, "src" | "srcset" | "alt"> & {
-		/**
-		 * The Prismic image field or thumbnail to render.
-		 */
-		field: ImageFieldImage | null | undefined;
+		/** The Prismic image field or thumbnail to render. */
+		field: ImageFieldImage | null | undefined
 
 		/**
 		 * An object of Imgix URL API parameters to transform the image.
 		 *
 		 * See: https://docs.imgix.com/apis/rendering
 		 */
-		imgixParams?: ImgixURLParams;
+		imgixParams?: ImgixURLParams
 
 		/**
 		 * Declare an image as decorative by providing `alt=""`.
 		 *
-		 * See:
-		 * https://developer.mozilla.org/en-US/docs/Web/API/HTMLImageElement/alt#decorative_images
+		 * See: https://developer.mozilla.org/en-US/docs/Web/API/HTMLImageElement/alt#decorative_images
 		 */
-		alt?: "";
+		alt?: ""
 
 		/**
-		 * Declare an image as decorative only if the Image field does not have
-		 * alternative text by providing `fallbackAlt=""`.
+		 * Declare an image as decorative only if the Image field does not have alternative text by
+		 * providing `fallbackAlt=""`.
 		 *
-		 * See:
-		 * https://developer.mozilla.org/en-US/docs/Web/API/HTMLImageElement/alt#decorative_images
+		 * See: https://developer.mozilla.org/en-US/docs/Web/API/HTMLImageElement/alt#decorative_images
 		 */
-		fallbackAlt?: "";
+		fallbackAlt?: ""
 	} & (
 			| {
 					/**
 					 * Widths used to build a `srcset` value for the Image field.
 					 *
-					 * If a `widths` prop is not given or `"defaults"` is passed, the
-					 * following widths will be used: 640, 750, 828, 1080, 1200, 1920,
-					 * 2048, 3840.
+					 * If a `widths` prop is not given or `"defaults"` is passed, the following widths will be
+					 * used: 640, 750, 828, 1080, 1200, 1920, 2048, 3840.
 					 *
-					 * If the Image field contains responsive views, each responsive view
-					 * can be used as a width in the resulting `srcset` by passing
-					 * `"thumbnails"` as the `widths` prop.
+					 * If the Image field contains responsive views, each responsive view can be used as a
+					 * width in the resulting `srcset` by passing `"thumbnails"` as the `widths` prop.
 					 */
-					widths?:
-						| NonNullable<Parameters<typeof asImageWidthSrcSet>[1]>["widths"]
-						| "defaults";
-					pixelDensities?: never;
+					widths?: NonNullable<Parameters<typeof asImageWidthSrcSet>[1]>["widths"] | "defaults"
+					pixelDensities?: never
 			  }
 			| {
 					/**
 					 * Pixel densities used to build a `srcset` value for the Image field.
 					 *
-					 * If a `pixelDensities` prop is passed `"defaults"`, the following
-					 * pixel densities will be used: 1, 2, 3.
+					 * If a `pixelDensities` prop is passed `"defaults"`, the following pixel densities will
+					 * be used: 1, 2, 3.
 					 */
 					pixelDensities:
-						| NonNullable<
-								Parameters<typeof asImagePixelDensitySrcSet>[1]
-						  >["pixelDensities"]
-						| "defaults";
-					widths?: never;
+						| NonNullable<Parameters<typeof asImagePixelDensitySrcSet>[1]>["pixelDensities"]
+						| "defaults"
+					widths?: never
 			  }
-		);
+		)
 
 	const {
 		field,
@@ -81,59 +67,51 @@
 		widths,
 		pixelDensities,
 		...restProps
-	}: Props = $props();
+	}: Props = $props()
 
 	const { resolvedWidth, resolvedHeight } = $derived.by(() => {
 		if (!isFilled.imageThumbnail(field))
-			return { resolvedWidth: undefined, resolvedHeight: undefined };
+			return { resolvedWidth: undefined, resolvedHeight: undefined }
 
-		const ar = field.dimensions.width / field.dimensions.height;
+		const ar = field.dimensions.width / field.dimensions.height
 
-		let resolvedWidth = castInt(width) ?? field.dimensions.width;
-		let resolvedHeight = castInt(height) ?? field.dimensions.height;
+		let resolvedWidth = castInt(width) ?? field.dimensions.width
+		let resolvedHeight = castInt(height) ?? field.dimensions.height
 		if (resolvedWidth != null && resolvedHeight == null) {
-			resolvedHeight = resolvedWidth / ar;
+			resolvedHeight = resolvedWidth / ar
 		} else if (resolvedWidth == null && resolvedHeight != null) {
-			resolvedWidth = resolvedHeight * ar;
+			resolvedWidth = resolvedHeight * ar
 		}
 
-		return { resolvedWidth, resolvedHeight };
-	});
+		return { resolvedWidth, resolvedHeight }
+	})
 
 	const { src, srcset } = $derived.by(() => {
-		if (!isFilled.imageThumbnail(field))
-			return { src: undefined, srcset: undefined };
+		if (!isFilled.imageThumbnail(field)) return { src: undefined, srcset: undefined }
 
 		if (pixelDensities) {
 			return asImagePixelDensitySrcSet(field, {
 				...imgixParams,
-				pixelDensities:
-					pixelDensities === "defaults" ? undefined : pixelDensities,
-			} as ImgixURLParams);
+				pixelDensities: pixelDensities === "defaults" ? undefined : pixelDensities,
+			} as ImgixURLParams)
 		}
 
 		return asImageWidthSrcSet(field, {
 			...imgixParams,
 			widths: widths === "defaults" ? undefined : widths,
-		});
-	});
-
-	function castInt(
-		input: string | number | null | undefined,
-	): number | null | undefined {
-		if (
-			typeof input === "number" ||
-			typeof input === "undefined" ||
-			input === null
-		) {
-			return input;
+		})
+	})
+
+	function castInt(input: string | number | null | undefined): number | null | undefined {
+		if (typeof input === "number" || typeof input === "undefined" || input === null) {
+			return input
 		} else {
-			const parsed = Number.parseInt(input);
+			const parsed = Number.parseInt(input)
 
 			if (Number.isNaN(parsed)) {
-				return undefined;
+				return undefined
 			} else {
-				return parsed;
+				return parsed
 			}
 		}
 	}

package/src/PrismicLink.svelte

@@ -1,56 +1,45 @@
 <script lang="ts">
-	import { asLinkAttrs } from "@prismicio/client";
-	import type {
-		AsLinkAttrsConfig,
-		LinkField,
-		PrismicDocument,
-	} from "@prismicio/client";
-	import type { HTMLAnchorAttributes } from "svelte/elements";
+	import { asLinkAttrs } from "@prismicio/client"
+	import type { AsLinkAttrsConfig, LinkField, PrismicDocument } from "@prismicio/client"
+	import type { HTMLAnchorAttributes } from "svelte/elements"
 
 	type Props = Omit<HTMLAnchorAttributes, "rel" | "href"> & {
 		/**
-		 * The `rel` attribute for the link. By default, `"noreferrer"` is provided
-		 * if the link's URL is external. This prop can be provided a function to
-		 * use the link's metadata to determine the `rel` value.
+		 * The `rel` attribute for the link. By default, `"noreferrer"` is provided if the link's URL is
+		 * external. This prop can be provided a function to use the link's metadata to determine the
+		 * `rel` value.
 		 */
-		rel?: string | AsLinkAttrsConfig["rel"];
+		rel?: string | AsLinkAttrsConfig["rel"]
 	} & (
 			| {
-					/**
-					 * A Prismic link field, content relationship field, or link to media
-					 * field.
-					 */
-					field: LinkField | null | undefined;
-					document?: never;
-					href?: never;
+					/** A Prismic link field, content relationship field, or link to media field. */
+					field: LinkField | null | undefined
+					document?: never
+					href?: never
 			  }
 			| {
-					/**
-					 * A Prismic document.
-					 */
-					document: PrismicDocument | null | undefined;
-					field?: never;
-					href?: never;
+					/** A Prismic document. */
+					document: PrismicDocument | null | undefined
+					field?: never
+					href?: never
 			  }
 			| {
-					href: HTMLAnchorAttributes["href"];
-					document: never;
-					field?: never;
+					href: HTMLAnchorAttributes["href"]
+					document: never
+					field?: never
 			  }
-		);
+		)
 
-	const { field, document, rel, children, ...restProps }: Props = $props();
+	const { field, document, rel, children, ...restProps }: Props = $props()
 
 	const linkAttrs = $derived(
 		asLinkAttrs(field ?? document, {
 			rel: typeof rel === "function" ? rel : undefined,
 		}),
-	);
-	const href = $derived(
-		("href" in restProps ? restProps.href : linkAttrs.href) || "",
-	);
+	)
+	const href = $derived(("href" in restProps ? restProps.href : linkAttrs.href) || "")
 
-	const resolvedRel = $derived(typeof rel === "string" ? rel : linkAttrs.rel);
+	const resolvedRel = $derived(typeof rel === "string" ? rel : linkAttrs.rel)
 </script>
 
 <!--

package/src/PrismicRichText/DefaultComponent.svelte

@@ -1,26 +1,22 @@
 <script lang="ts">
-	import type { HTMLAttributes } from "svelte/elements";
+	import type { HTMLAttributes } from "svelte/elements"
 
-	import type { RichTextComponentProps } from "../types";
+	import PrismicEmbed from "../PrismicEmbed.svelte"
+	import PrismicImage from "../PrismicImage.svelte"
+	import PrismicLink from "../PrismicLink.svelte"
+	import type { RichTextComponentProps } from "../types"
 
-	import PrismicEmbed from "../PrismicEmbed.svelte";
-	import PrismicImage from "../PrismicImage.svelte";
-	import PrismicLink from "../PrismicLink.svelte";
+	type Props = RichTextComponentProps & HTMLAttributes<HTMLElement> & { as?: string }
 
-	type Props = RichTextComponentProps &
-		HTMLAttributes<HTMLElement> & { as?: string };
-
-	const { node, children, as, ...attrs }: Props = $props();
+	const { node, children, as, ...attrs }: Props = $props()
 
 	const dirProp = $derived(
 		"direction" in node && node.direction === "rtl" ? { direction: "rtl" } : {},
-	);
+	)
 </script>
 
 {#if as}
-	<svelte:element this={as} {...dirProp} {...attrs} {...attrs}
-		>{@render children()}</svelte:element
-	>
+	<svelte:element this={as} {...dirProp} {...attrs} {...attrs}>{@render children()}</svelte:element>
 {:else if node.type === "heading1"}
 	<h1 {...dirProp} {...attrs}>{@render children()}</h1>
 {:else if node.type === "heading2"}

package/src/PrismicRichText/PrismicRichText.svelte

@@ -1,26 +1,21 @@
 <script lang="ts">
-	import type { RichTextField } from "@prismicio/client";
-	import { asTree } from "@prismicio/client/richtext";
+	import type { RichTextField } from "@prismicio/client"
+	import { asTree } from "@prismicio/client/richtext"
 
-	import type { RichTextComponents } from "../types";
-
-	import Serialize from "./Serialize.svelte";
+	import type { RichTextComponents } from "../types"
+	import Serialize from "./Serialize.svelte"
 
 	type Props = {
-		/**
-		 * The Prismic rich text field to render.
-		 */
-		field: RichTextField;
+		/** The Prismic rich text field to render. */
+		field: RichTextField
 
-		/**
-		 * An object that maps a rich text block type to a Svelte component.
-		 */
-		components?: RichTextComponents;
-	};
+		/** An object that maps a rich text block type to a Svelte component. */
+		components?: RichTextComponents
+	}
 
-	const { field, components = {} }: Props = $props();
+	const { field, components = {} }: Props = $props()
 
-	const children = $derived(asTree(field).children);
+	const children = $derived(asTree(field).children)
 </script>
 
 <!--