@prismicio/svelte 2.2.2 → 2.2.3-pr.64.0df0234

package/src/kit/index.ts

@@ -1,9 +1,9 @@
-export { default as PrismicPreview } from "./PrismicPreview.svelte";
+export { default as PrismicPreview } from "./PrismicPreview.svelte"
 
-export { enableAutoPreviews } from "./enableAutoPreviews";
-export type { EnableAutoPreviewsConfig } from "./enableAutoPreviews";
+export { enableAutoPreviews } from "./enableAutoPreviews"
+export type { EnableAutoPreviewsConfig } from "./enableAutoPreviews"
 
-export { redirectToPreviewURL } from "./redirectToPreviewURL";
-export type { RedirectToPreviewURLConfig } from "./redirectToPreviewURL";
+export { redirectToPreviewURL } from "./redirectToPreviewURL"
+export type { RedirectToPreviewURLConfig } from "./redirectToPreviewURL"
 
-export type { CreateClientConfig } from "./types";
+export type { CreateClientConfig } from "./types"

package/src/kit/redirectToPreviewURL.ts

@@ -1,74 +1,64 @@
-import * as prismic from "@prismicio/client";
-import type { Cookies } from "@sveltejs/kit";
+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. */
 	// `Pick` is used to use the smallest possible subset of
 	// `prismic.Client`. Doing this reduces the surface area for breaking
 	// type changes.
-	client: Pick<prismic.Client, "resolvePreviewURL">;
+	client: Pick<prismic.Client, "resolvePreviewURL">
 
 	/**
 	 * The `request` object from a `+server` file.
 	 *
-	 * @see SvelteKit `+server` docs: \<https://kit.svelte.dev/docs/routing#server\>
+	 * @see SvelteKit `+server` docs: \<https://svelte.dev/docs/kit/routing#server\>
 	 */
-	request: Request;
+	request: Request
 
 	/**
 	 * The `cookies` object from a `+server` file.
 	 *
-	 * @see SvelteKit `+server` docs: \<https://kit.svelte.dev/docs/routing#server\>
+	 * @see SvelteKit `+server` docs: \<https://svelte.dev/docs/kit/routing#server\>
 	 */
-	cookies: Cookies;
+	cookies: Cookies
 
-	/**
-	 * The default redirect URL if a URL cannot be determined for the previewed
-	 * document.
-	 */
-	defaultURL?: string;
+	/** The default redirect URL if a URL cannot be determined for the previewed document. */
+	defaultURL?: string
 
-	/**
-	 * The route parameter prefixed during preview sessions.
-	 */
-	routePrefix?: string;
-};
+	/** 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 const redirectToPreviewURL = async (
 	config: RedirectToPreviewURLConfig,
 ): Promise<Response> => {
-	const previewToken =
-		new URL(config.request.url).searchParams.get("token") ?? undefined;
-	const documentID =
-		new URL(config.request.url).searchParams.get("documentId") ?? undefined;
-	const routePrefix = config.routePrefix ?? "preview";
+	const previewToken = new URL(config.request.url).searchParams.get("token") ?? undefined
+	const documentID = new URL(config.request.url).searchParams.get("documentId") ?? undefined
+	const routePrefix = config.routePrefix ?? "preview"
 
 	const previewURL = await config.client.resolvePreviewURL({
 		previewToken,
 		documentID,
 		defaultURL: config.defaultURL || "/",
-	});
+	})
 
 	// Prevent a flash of non-preview content by setting the preview token
 	// on the initial page load.
@@ -76,7 +66,7 @@ export const redirectToPreviewURL = async (
 		config.cookies.set(prismic.cookie.preview, previewToken, {
 			path: "/",
 			httpOnly: false,
-		});
+		})
 	}
 
 	return new Response(undefined, {
@@ -84,5 +74,5 @@ export const redirectToPreviewURL = async (
 		headers: {
 			Location: "/" + routePrefix + previewURL,
 		},
-	});
-};
+	})
+}

package/src/kit/types.ts

@@ -1,14 +1,11 @@
-import type { ClientConfig } from "@prismicio/client";
-import type { Cookies } from "@sveltejs/kit";
+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;
-};
+	cookies?: Cookies
+}

package/src/lib/devMsg.ts

@@ -1,20 +1,18 @@
-import { version } from "../../package.json";
+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: string): string => {
-	return `https://prismic.dev/msg/svelte/v${version}/${slug}`;
-};
+	return `https://prismic.dev/msg/svelte/v${version}/${slug}`
+}

package/src/types.ts

@@ -27,160 +27,140 @@ import type {
 	TableFieldHead,
 	TableFieldHeadRow,
 	TableFieldHeaderCell,
-} from "@prismicio/client";
-import type { Component, Snippet } from "svelte";
-import type { HTMLAttributes } from "svelte/elements";
+} 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.
-	 */
-	as?: string;
-} & HTMLAttributes<HTMLElement>;
+	/** The HTML element type rendered for this node type. */
+	as?: string
+} & HTMLAttributes<HTMLElement>
 
 export type RichTextComponents = {
-	heading1?: RichTextComponent<RTHeading1Node> | ComponentShorthand;
-	heading2?: RichTextComponent<RTHeading2Node> | ComponentShorthand;
-	heading3?: RichTextComponent<RTHeading3Node> | ComponentShorthand;
-	heading4?: RichTextComponent<RTHeading4Node> | ComponentShorthand;
-	heading5?: RichTextComponent<RTHeading5Node> | ComponentShorthand;
-	heading6?: RichTextComponent<RTHeading6Node> | ComponentShorthand;
-	paragraph?: RichTextComponent<RTParagraphNode> | ComponentShorthand;
-	preformatted?: RichTextComponent<RTPreformattedNode> | ComponentShorthand;
-	strong?: RichTextComponent<RTStrongNode> | ComponentShorthand;
-	em?: RichTextComponent<RTEmNode> | ComponentShorthand;
-	listItem?: RichTextComponent<RTListItemNode> | ComponentShorthand;
-	oListItem?: RichTextComponent<RTOListItemNode> | ComponentShorthand;
-	list?: RichTextComponent<RTListNode> | ComponentShorthand;
-	oList?: RichTextComponent<RTOListNode> | ComponentShorthand;
-	image?: RichTextComponent<RTImageNode> | HTMLAttributes<HTMLImageElement>;
-	embed?: RichTextComponent<RTEmbedNode> | HTMLAttributes<HTMLDivElement>;
-	hyperlink?: RichTextComponent<RTLinkNode> | HTMLAttributes<HTMLAnchorElement>;
-	label?: RichTextComponent<RTLabelNode> | HTMLAttributes<HTMLSpanElement>;
-	span?: RichTextComponent<RTSpanNode>;
-};
+	heading1?: RichTextComponent<RTHeading1Node> | ComponentShorthand
+	heading2?: RichTextComponent<RTHeading2Node> | ComponentShorthand
+	heading3?: RichTextComponent<RTHeading3Node> | ComponentShorthand
+	heading4?: RichTextComponent<RTHeading4Node> | ComponentShorthand
+	heading5?: RichTextComponent<RTHeading5Node> | ComponentShorthand
+	heading6?: RichTextComponent<RTHeading6Node> | ComponentShorthand
+	paragraph?: RichTextComponent<RTParagraphNode> | ComponentShorthand
+	preformatted?: RichTextComponent<RTPreformattedNode> | ComponentShorthand
+	strong?: RichTextComponent<RTStrongNode> | ComponentShorthand
+	em?: RichTextComponent<RTEmNode> | ComponentShorthand
+	listItem?: RichTextComponent<RTListItemNode> | ComponentShorthand
+	oListItem?: RichTextComponent<RTOListItemNode> | ComponentShorthand
+	list?: RichTextComponent<RTListNode> | ComponentShorthand
+	oList?: RichTextComponent<RTOListNode> | ComponentShorthand
+	image?: RichTextComponent<RTImageNode> | HTMLAttributes<HTMLImageElement>
+	embed?: RichTextComponent<RTEmbedNode> | HTMLAttributes<HTMLDivElement>
+	hyperlink?: RichTextComponent<RTLinkNode> | HTMLAttributes<HTMLAnchorElement>
+	label?: RichTextComponent<RTLabelNode> | HTMLAttributes<HTMLSpanElement>
+	span?: RichTextComponent<RTSpanNode>
+}
 
 export type RichTextComponent<TNode extends RTAnyNode = RTAnyNode> = Component<
 	RichTextComponentProps<TNode>
->;
+>
 
 export type RichTextComponentProps<TNode extends RTAnyNode = RTAnyNode> = {
-	node: TNode;
-	children: Snippet;
-};
+	node: TNode
+	children: Snippet
+}
 
 // Define the type for the components prop
 export type TableComponents = {
 	table?:
 		| Component<{
-				table: TableField<"filled">;
-				children: Snippet;
+				table: TableField<"filled">
+				children: Snippet
 		  }>
-		| HTMLAttributes<HTMLTableElement>;
+		| HTMLAttributes<HTMLTableElement>
 	thead?:
 		| Component<{
-				head: TableFieldHead;
-				children: Snippet;
+				head: TableFieldHead
+				children: Snippet
 		  }>
-		| HTMLAttributes<HTMLTableSectionElement>;
+		| HTMLAttributes<HTMLTableSectionElement>
 	tbody?:
 		| Component<{
-				body: TableFieldBody;
-				children: Snippet;
+				body: TableFieldBody
+				children: Snippet
 		  }>
-		| HTMLAttributes<HTMLTableSectionElement>;
+		| HTMLAttributes<HTMLTableSectionElement>
 	tr?:
 		| Component<{
-				row: TableFieldHeadRow | TableFieldBodyRow;
-				children: Snippet;
+				row: TableFieldHeadRow | TableFieldBodyRow
+				children: Snippet
 		  }>
-		| HTMLAttributes<HTMLTableRowElement>;
+		| HTMLAttributes<HTMLTableRowElement>
 	th?:
 		| Component<{
-				cell: TableFieldHeaderCell;
-				children: Snippet;
+				cell: TableFieldHeaderCell
+				children: Snippet
 		  }>
-		| HTMLAttributes<HTMLTableCellElement>;
+		| HTMLAttributes<HTMLTableCellElement>
 	td?:
 		| Component<{
-				cell: TableFieldDataCell;
-				children: Snippet;
+				cell: TableFieldDataCell
+				children: Snippet
 		  }>
-		| HTMLAttributes<HTMLTableCellElement>;
-};
+		| 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: TSlice;
+export type SliceComponentProps<TSlice extends SliceLike = SliceLike, TContext = unknown> = {
+	/** Slice data for this component. */
+	slice: TSlice
 
-	/**
-	 * The index of the Slice in the Slice Zone.
-	 */
-	index: number;
+	/** 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. */
 	// TODO: We have to keep this list of Slices general due to circular
 	// reference limtiations. If we had another generic to determine the full
 	// union of Slice types, it would include TSlice. This causes TypeScript to
 	// throw a compilation error.
-	slices: SliceZoneLike<
-		TSlice extends SliceLikeGraphQL ? SliceLikeGraphQL : SliceLikeRestV2
-	>;
+	slices: SliceZoneLike<TSlice extends SliceLikeGraphQL ? SliceLikeGraphQL : SliceLikeRestV2>
 
-	/**
-	 * Arbitrary data passed to `<SliceZone>` and made available to all Slice
-	 * components.
-	 */
-	context: TContext;
-};
+	/** 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.
  */
 type SliceLikeRestV2<SliceType extends string = string> = {
-	slice_type: Slice<SliceType>["slice_type"];
-};
+	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.
  */
 type SliceLikeGraphQL<SliceType extends string = string> = {
-	type: Slice<SliceType>["slice_type"];
-};
+	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.
  */
@@ -189,22 +169,20 @@ type SliceLike<SliceType extends string = string> = (
 	| 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;
-};
+	__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.
  */
-export type SliceZoneLike<TSlice extends SliceLike = SliceLike> =
-	readonly TSlice[];
+export type SliceZoneLike<TSlice extends SliceLike = SliceLike> = readonly TSlice[]