@prismicio/react 2.9.0 → 3.0.0-alpha.0

package/src/types.ts

@@ -1,23 +0,0 @@
-import * as prismicR from "@prismicio/richtext";
-
-/**
- * A function mapping Rich Text block types to React Components. It is used to
- * render Rich Text or Title fields.
- *
- * @see Templating rich text and title fields from Prismic {@link https://prismic.io/docs/technologies/templating-rich-text-and-title-fields-javascript}
- */
-export type JSXFunctionSerializer =
-	prismicR.RichTextFunctionSerializer<JSX.Element>;
-
-/**
- * A map of Rich Text block types to React Components. It is used to render Rich
- * Text or Title fields.
- *
- * @see Templating Rich Text and Title fields from Prismic {@link https://prismic.io/docs/technologies/templating-rich-text-and-title-fields-javascript}
- */
-export type JSXMapSerializer = prismicR.RichTextMapSerializer<JSX.Element>;
-
-/**
- * States of a `@prismicio/client` hook.
- */
-export type PrismicClientHookState = "idle" | "loading" | "loaded" | "failed";

package/src/usePrismicClient.ts

@@ -1,30 +0,0 @@
-import type * as prismic from "@prismicio/client";
-
-import { usePrismicContext } from "./usePrismicContext";
-
-/**
- * Retrieve the `@prismicio/client` instance provided to `<PrismicProvider>`
- * higher in the React tree.
- *
- * @param explicitClient - An optional `@prismicio/client` instance to override
- *   the Client provided to `<PrismicProvider>`.
- *
- * @returns The `@prismicio/client` instance provided to `<PrismicProvider>`.
- */
-export const usePrismicClient = <
-	TDocuments extends prismic.PrismicDocument = prismic.PrismicDocument,
->(
-	explicitClient?: prismic.Client<TDocuments>,
-): prismic.Client<TDocuments> => {
-	const context = usePrismicContext();
-
-	const client = explicitClient || context?.client;
-
-	if (!client) {
-		throw new Error(
-			"A @prismicio/client is required to query documents. Provide a client to the hook or to a <PrismicProvider> higher in your component tree.",
-		);
-	}
-
-	return client;
-};

package/src/usePrismicContext.ts

@@ -1,13 +0,0 @@
-import * as React from "react";
-
-import { PrismicContext, PrismicContextValue } from "./PrismicProvider";
-
-/**
- * React hook used to read shared configuration for `@prismicio/react`
- * components and hooks.
- *
- * @returns The closest `<PrismicProvider>` context value.
- */
-export const usePrismicContext = (): PrismicContextValue => {
-	return React.useContext(PrismicContext) || {};
-};

package/src/usePrismicPreviewResolver.ts

@@ -1,93 +0,0 @@
-import type * as prismic from "@prismicio/client";
-
-import * as React from "react";
-
-import { usePrismicContext } from "./usePrismicContext";
-import {
-	ClientHookReturnType,
-	useStatefulPrismicClientMethod,
-} from "./useStatefulPrismicClientMethod";
-
-export type UsePrismicPreviewResolverArgs = {
-	/**
-	 * An optional `@prismicio/client` instance to override the Client provided to
-	 * `<PrismicProvider>`
-	 */
-	client?: prismic.Client;
-
-	/**
-	 * A function that maps a Prismic document to a URL within your app.
-	 */
-	linkResolver?: Parameters<
-		prismic.Client["resolvePreviewURL"]
-	>[0]["linkResolver"];
-
-	/**
-	 * A fallback URL if the Link Resolver does not return a value.
-	 */
-	defaultURL?: Parameters<prismic.Client["resolvePreviewURL"]>[0]["defaultURL"];
-
-	/**
-	 * The preview token (also known as a ref) that will be used to query preview
-	 * content from the Prismic repository.
-	 */
-	previewToken?: Parameters<
-		prismic.Client["resolvePreviewURL"]
-	>[0]["previewToken"];
-
-	/**
-	 * The previewed document that will be used to determine the destination URL.
-	 */
-	documentID?: Parameters<prismic.Client["resolvePreviewURL"]>[0]["documentID"];
-
-	/**
-	 * A function to automatically navigate to the resolved URL. If a function is
-	 * not provded, `usePreviewResolver` will not navigate to the URL.
-	 *
-	 * @param url - The resolved preview URL.
-	 */
-	navigate?: (url: string) => unknown;
-};
-
-/**
- * Resolve a preview session's URL. The resolved URL can be used to redirect to
- * the previewed document.
- *
- * If a `navigate` function is provided, the hook will automatically navigate to
- * the previewed document's URL.
- *
- * @param args - Arguments to configure how a URL is resolved.
- *
- * @returns A tuple containing the resolved URL and the hook's state.
- */
-export const usePrismicPreviewResolver = (
-	args: UsePrismicPreviewResolverArgs = {},
-): ClientHookReturnType<string> => {
-	const context = usePrismicContext();
-
-	const linkResolver = args.linkResolver || context.linkResolver;
-
-	const result = useStatefulPrismicClientMethod(
-		"resolvePreviewURL",
-		[
-			{
-				linkResolver,
-				defaultURL: args.defaultURL || "/",
-				previewToken: args.previewToken,
-				documentID: args.documentID,
-			},
-		],
-		args.client,
-	);
-
-	const [resolvedURL] = result;
-	const { navigate } = args;
-
-	React.useEffect(() => {
-		if (resolvedURL && navigate) {
-			navigate(resolvedURL);
-		}
-	}, [resolvedURL, navigate]);
-
-	return result;
-};

package/src/useStatefulPrismicClientMethod.ts

@@ -1,196 +0,0 @@
-import type * as prismic from "@prismicio/client";
-
-import * as React from "react";
-
-import { PrismicClientHookState } from "./types";
-import { usePrismicClient } from "./usePrismicClient";
-
-type StateMachineState<TData> = {
-	state: PrismicClientHookState;
-	data?: TData;
-	error?: Error;
-};
-
-type StateMachineAction<TData> =
-	| [type: "start"]
-	| [type: "succeed", payload: TData]
-	| [type: "fail", payload: Error];
-
-const reducer = <TData>(
-	state: StateMachineState<TData>,
-	action: StateMachineAction<TData>,
-): StateMachineState<TData> => {
-	switch (action[0]) {
-		case "start": {
-			return { state: "loading" };
-		}
-
-		case "succeed": {
-			return { state: "loaded", data: action[1] };
-		}
-
-		case "fail": {
-			return {
-				...state,
-				state: "failed",
-				error: action[1],
-			};
-		}
-	}
-};
-
-const initialState: StateMachineState<never> = {
-	state: "idle",
-};
-
-type UnwrapPromise<T> = T extends Promise<infer U> ? U : T;
-
-type ClientPrototype = typeof prismic.Client.prototype;
-
-type ClientMethod<MethodName extends keyof ClientPrototype> =
-	// eslint-disable-next-line @typescript-eslint/no-explicit-any
-	ClientPrototype[MethodName] extends (...args: any[]) => any
-		? ClientPrototype[MethodName]
-		: never;
-
-type ClientMethodName = keyof {
-	[P in keyof prismic.Client as prismic.Client[P] extends (
-		// eslint-disable-next-line @typescript-eslint/no-explicit-any
-		...args: any[]
-	) => // eslint-disable-next-line @typescript-eslint/no-explicit-any
-	Promise<any>
-		? P
-		: never]: unknown;
-};
-
-export type ClientMethodParameters<MethodName extends keyof ClientPrototype> =
-	Parameters<ClientMethod<MethodName>>;
-
-export type HookOnlyParameters = {
-	client?: prismic.Client;
-	skip?: boolean;
-};
-
-/**
- * Determines if a value is a `@prismicio/client` params object.
- *
- * @param value - The value to check.
- *
- * @returns `true` if `value` is a `@prismicio/client` params object, `false`
- *   otherwise.
- */
-const isParams = (
-	value: unknown,
-): value is ClientMethodParameters<"get">[0] & HookOnlyParameters => {
-	// This is a *very* naive check.
-	return typeof value === "object" && value !== null && !Array.isArray(value);
-};
-
-/**
- * The return value of a `@prismicio/client` React hook.
- *
- * @typeParam TData - Data returned by the client.
- */
-export type ClientHookReturnType<TData = unknown> = [
-	/**
-	 * Data returned by the client.
-	 */
-	data: TData | undefined,
-
-	/**
-	 * The current state of the hook's client method call.
-	 */
-	state: Pick<StateMachineState<TData>, "state" | "error">,
-];
-
-/**
- * Creates a React hook that forwards arguments to a specific method of a
- * `@prismicio/client` instance. The created hook has its own internal state
- * manager to report async status, such as pending or error statuses.
- *
- * @param methodName - The `@prismicio/client` method to which hook arguments
- *   will be forwarded.
- *
- * @returns A new React hook configured for the provided method.
- *
- * @internal
- */
-export const useStatefulPrismicClientMethod = <
-	TMethodName extends ClientMethodName,
-	TArgs extends Parameters<ClientMethod<TMethodName>>,
-	TData extends UnwrapPromise<ReturnType<ClientMethod<TMethodName>>>,
->(
-	methodName: TMethodName,
-	args: TArgs,
-	explicitClient?: prismic.Client,
-): ClientHookReturnType<TData> => {
-	const lastArg = args[args.length - 1];
-	const {
-		client: lastArgExplicitClient,
-		skip,
-		...params
-	} = isParams(lastArg) ? lastArg : ({} as HookOnlyParameters);
-	const argsWithoutParams = isParams(lastArg) ? args.slice(0, -1) : args;
-
-	const client = usePrismicClient(explicitClient || lastArgExplicitClient);
-
-	const [state, dispatch] = React.useReducer<
-		React.Reducer<StateMachineState<TData>, StateMachineAction<TData>>
-	>(reducer, initialState);
-
-	React.useEffect(
-		() => {
-			// Used to prevent dispatching an action if the hook was cleaned up.
-			let didCancel = false;
-
-			if (!skip) {
-				if (!didCancel) {
-					dispatch(["start"]);
-				}
-
-				// @ts-expect-error - Merging method arg types is too complex
-				client[methodName]
-					.call(client, ...argsWithoutParams, params)
-					.then((result) => {
-						if (!didCancel) {
-							dispatch(["succeed", result as TData]);
-						}
-					})
-					.catch((error) => {
-						if (!didCancel) {
-							dispatch(["fail", error]);
-						}
-					});
-			}
-
-			// Ensure we don't dispatch an action if the hook is cleaned up.
-			() => {
-				didCancel = true;
-			};
-		},
-		// We must disable exhaustive-deps since we are using
-		// JSON.stringify on params (effectively a deep equality check).
-		// We want this effect to run again anytime params change.
-		// eslint-disable-next-line react-hooks/exhaustive-deps
-		[
-			client,
-			methodName,
-			skip,
-			// eslint-disable-next-line react-hooks/exhaustive-deps
-			JSON.stringify(argsWithoutParams),
-			// eslint-disable-next-line react-hooks/exhaustive-deps
-			JSON.stringify(params),
-		],
-	);
-
-	return React.useMemo(
-		() => [
-			state.data,
-			{
-				state: state.state,
-				error: state.error,
-			},
-		],
-		[state],
-	);
-};