@prismicio/react 2.9.1 → 3.0.0-alpha.0

package/src/clientHooks.ts

@@ -1,472 +0,0 @@
-import type * as prismic from "@prismicio/client";
-
-import {
-	ClientHookReturnType,
-	ClientMethodParameters,
-	HookOnlyParameters,
-	useStatefulPrismicClientMethod,
-} from "./useStatefulPrismicClientMethod";
-
-/**
- * A hook that queries content from the Prismic repository.
- *
- * @remarks
- * An additional `@prismicio/client` instance can be provided at
- * `params.client`.
- * @typeParam TDocument - Type of Prismic documents returned
- *
- * @param params - Parameters to filter, sort, and paginate results
- *
- * @returns The composable payload {@link ClientHookReturnType}
- *
- * @see Underlying `@prismicio/client` method {@link proto.get}
- */
-export const usePrismicDocuments = <TDocument extends prismic.PrismicDocument>(
-	...args: [params?: ClientMethodParameters<"get">[0] & HookOnlyParameters]
-): ClientHookReturnType<prismic.Query<TDocument>> =>
-	useStatefulPrismicClientMethod("get", args);
-
-/**
- * A hook that queries content from the Prismic repository and returns only the
- * first result, if any.
- *
- * @remarks
- * An additional `@prismicio/client` instance can be provided at
- * `params.client`.
- * @typeParam TDocument - Type of the Prismic document returned
- *
- * @param params - Parameters to filter, sort, and paginate results
- *
- * @returns The composable payload {@link ClientHookReturnType}
- *
- * @see Underlying `@prismicio/client` method {@link proto.getFirst}
- */
-export const useFirstPrismicDocument = <
-	TDocument extends prismic.PrismicDocument,
->(
-	...args: [params?: ClientMethodParameters<"getFirst">[0] & HookOnlyParameters]
-): ClientHookReturnType<TDocument> =>
-	useStatefulPrismicClientMethod("getFirst", args);
-
-/**
- * A hook that queries content from the Prismic repository and returns all
- * matching content. If no predicates are provided, all documents will be
- * fetched.
- *
- * @remarks
- * An additional `@prismicio/client` instance can be provided at
- * `params.client`.
- * @typeParam TDocument - Type of Prismic documents returned
- *
- * @param params - Parameters to filter and sort results
- *
- * @returns The composable payload {@link ClientHookReturnType}
- *
- * @see Underlying `@prismicio/client` method {@link proto.getAll}
- */
-export const useAllPrismicDocumentsDangerously = <
-	TDocument extends prismic.PrismicDocument,
->(
-	...args: [
-		params?: ClientMethodParameters<"dangerouslyGetAll">[0] &
-			HookOnlyParameters,
-	]
-): ClientHookReturnType<TDocument[]> =>
-	useStatefulPrismicClientMethod("dangerouslyGetAll", args);
-
-/**
- * A hook that queries a document from the Prismic repository with a specific
- * ID.
- *
- * @remarks
- * An additional `@prismicio/client` instance can be provided at
- * `params.client`.
- * @typeParam TDocument - Type of the Prismic document returned
- *
- * @param id - ID of the document
- * @param params - Parameters to filter, sort, and paginate results
- *
- * @returns The composable payload {@link ClientHookReturnType}
- *
- * @see Underlying `@prismicio/client` method {@link proto.getByID}
- */
-export const usePrismicDocumentByID = <
-	TDocument extends prismic.PrismicDocument,
->(
-	...args: [
-		id: ClientMethodParameters<"getByID">[0],
-		params?: ClientMethodParameters<"getByID">[1] & HookOnlyParameters,
-	]
-): ClientHookReturnType<TDocument> =>
-	useStatefulPrismicClientMethod("getByID", args);
-
-/**
- * A hook that queries documents from the Prismic repository with specific IDs.
- *
- * @remarks
- * An additional `@prismicio/client` instance can be provided at
- * `params.client`.
- * @typeParam TDocument - Type of Prismic documents returned
- *
- * @param ids - A list of document IDs
- * @param params - Parameters to filter, sort, and paginate results
- *
- * @returns The composable payload {@link ClientHookReturnType}
- *
- * @see Underlying `@prismicio/client` method {@link proto.getByIDs}
- */
-export const usePrismicDocumentsByIDs = <
-	TDocument extends prismic.PrismicDocument,
->(
-	...args: [
-		id: ClientMethodParameters<"getByIDs">[0],
-		params?: ClientMethodParameters<"getByIDs">[1] & HookOnlyParameters,
-	]
-): ClientHookReturnType<prismic.Query<TDocument>> =>
-	useStatefulPrismicClientMethod("getByIDs", args);
-
-/**
- * A hook that queries all documents from the Prismic repository with specific
- * IDs.
- *
- * @remarks
- * An additional `@prismicio/client` instance can be provided at
- * `params.client`.
- * @typeParam TDocument - Type of Prismic documents returned
- *
- * @param ids - A list of document IDs
- * @param params - Parameters to filter and sort results
- *
- * @returns The composable payload {@link ClientHookReturnType}
- *
- * @see Underlying `@prismicio/client` method {@link proto.getAllByIDs}
- */
-export const useAllPrismicDocumentsByIDs = <
-	TDocument extends prismic.PrismicDocument,
->(
-	...args: [
-		id: ClientMethodParameters<"getAllByIDs">[0],
-		params?: ClientMethodParameters<"getAllByIDs">[1] & HookOnlyParameters,
-	]
-): ClientHookReturnType<TDocument[]> =>
-	useStatefulPrismicClientMethod("getAllByIDs", args);
-
-/**
- * A hook that queries a document from the Prismic repository with a specific
- * UID and Custom Type.
- *
- * @remarks
- * An additional `@prismicio/client` instance can be provided at
- * `params.client`.
- * @typeParam TDocument - Type of the Prismic document returned
- *
- * @param documentType - The API ID of the document's Custom Type
- * @param uid - UID of the document
- * @param params - Parameters to filter, sort, and paginate results
- *
- * @returns The composable payload {@link ClientHookReturnType}
- *
- * @see Underlying `@prismicio/client` method {@link proto.getByUID}
- */
-export const usePrismicDocumentByUID = <
-	TDocument extends prismic.PrismicDocument,
->(
-	...args: [
-		documentType: ClientMethodParameters<"getByUID">[0],
-		uid: ClientMethodParameters<"getByUID">[1],
-		params?: ClientMethodParameters<"getByUID">[2] & HookOnlyParameters,
-	]
-): ClientHookReturnType<TDocument> =>
-	useStatefulPrismicClientMethod("getByUID", args);
-
-/**
- * A hook that queries documents from the Prismic repository with specific UIDs
- * of a Custom Type.
- *
- * @remarks
- * An additional `@prismicio/client` instance can be provided at
- * `params.client`.
- * @typeParam TDocument - Type of the Prismic document returned
- *
- * @param documentType - The API ID of the document's Custom Type
- * @param uids - A list of document UIDs.
- * @param params - Parameters to filter, sort, and paginate results
- *
- * @returns The composable payload {@link ClientHookReturnType}
- *
- * @see Underlying `@prismicio/client` method {@link proto.getByUID}
- */
-export const usePrismicDocumentsByUIDs = <
-	TDocument extends prismic.PrismicDocument,
->(
-	...args: [
-		documentType: ClientMethodParameters<"getByUIDs">[0],
-		uids: ClientMethodParameters<"getByUIDs">[1],
-		params?: ClientMethodParameters<"getByUIDs">[2] & HookOnlyParameters,
-	]
-): ClientHookReturnType<prismic.Query<TDocument>> =>
-	useStatefulPrismicClientMethod("getByUIDs", args);
-
-/**
- * A hook that queries all documents from the Prismic repository with specific
- * UIDs of a Custom Type.
- *
- * @remarks
- * An additional `@prismicio/client` instance can be provided at
- * `params.client`.
- * @typeParam TDocument - Type of the Prismic document returned
- *
- * @param documentType - The API ID of the document's Custom Type
- * @param uids - A list of document UIDs.
- * @param params - Parameters to filter, sort, and paginate results
- *
- * @returns The composable payload {@link ClientHookReturnType}
- *
- * @see Underlying `@prismicio/client` method {@link proto.getByUID}
- */
-export const useAllPrismicDocumentsByUIDs = <
-	TDocument extends prismic.PrismicDocument,
->(
-	...args: [
-		documentType: ClientMethodParameters<"getByUIDs">[0],
-		uids: ClientMethodParameters<"getByUIDs">[1],
-		params?: ClientMethodParameters<"getByUIDs">[2] & HookOnlyParameters,
-	]
-): ClientHookReturnType<TDocument[]> =>
-	useStatefulPrismicClientMethod("getAllByUIDs", args);
-
-/**
- * A hook that queries a singleton document from the Prismic repository for a
- * specific Custom Type.
- *
- * @remarks
- * An additional `@prismicio/client` instance can be provided at
- * `params.client`.
- * @typeParam TDocument - Type of the Prismic document returned
- *
- * @param documentType - The API ID of the singleton Custom Type
- * @param params - Parameters to filter, sort, and paginate results
- *
- * @returns The composable payload {@link ClientHookReturnType}
- *
- * @see Underlying `@prismicio/client` method {@link proto.getSingle}
- */
-export const useSinglePrismicDocument = <
-	TDocument extends prismic.PrismicDocument,
->(
-	...args: [
-		documentType: ClientMethodParameters<"getSingle">[0],
-		params?: ClientMethodParameters<"getSingle">[1] & HookOnlyParameters,
-	]
-): ClientHookReturnType<TDocument> =>
-	useStatefulPrismicClientMethod("getSingle", args);
-
-/**
- * A hook that queries documents from the Prismic repository for a specific
- * Custom Type.
- *
- * @remarks
- * An additional `@prismicio/client` instance can be provided at
- * `params.client`.
- * @typeParam TDocument - Type of Prismic documents returned
- *
- * @param documentType - The API ID of the Custom Type
- * @param params - Parameters to filter, sort, and paginate results
- *
- * @returns The composable payload {@link ClientHookReturnType}
- *
- * @see Underlying `@prismicio/client` method {@link proto.getByType}
- */
-export const usePrismicDocumentsByType = <
-	TDocument extends prismic.PrismicDocument,
->(
-	...args: [
-		documentType: ClientMethodParameters<"getByType">[0],
-		params?: ClientMethodParameters<"getByType">[1] & HookOnlyParameters,
-	]
-): ClientHookReturnType<prismic.Query<TDocument>> =>
-	useStatefulPrismicClientMethod("getByType", args);
-
-/**
- * A hook that queries all documents from the Prismic repository for a specific
- * Custom Type.
- *
- * @remarks
- * An additional `@prismicio/client` instance can be provided at
- * `params.client`.
- * @typeParam TDocument - Type of Prismic documents returned
- *
- * @param documentType - The API ID of the Custom Type
- * @param params - Parameters to filter and sort results
- *
- * @returns The composable payload {@link ClientHookReturnType}
- *
- * @see Underlying `@prismicio/client` method {@link proto.getAllByType}
- */
-export const useAllPrismicDocumentsByType = <
-	TDocument extends prismic.PrismicDocument,
->(
-	...args: [
-		documentType: ClientMethodParameters<"getAllByType">[0],
-		params?: ClientMethodParameters<"getAllByType">[1] & HookOnlyParameters,
-	]
-): ClientHookReturnType<TDocument[]> =>
-	useStatefulPrismicClientMethod("getAllByType", args);
-
-/**
- * A hook that queries documents from the Prismic repository with a specific
- * tag.
- *
- * @remarks
- * An additional `@prismicio/client` instance can be provided at
- * `params.client`.
- * @typeParam TDocument - Type of Prismic documents returned
- *
- * @param tag - The tag that must be included on a document
- * @param params - Parameters to filter, sort, and paginate results
- *
- * @returns The composable payload {@link ClientHookReturnType}
- *
- * @see Underlying `@prismicio/client` method {@link proto.getByTag}
- */
-export const usePrismicDocumentsByTag = <
-	TDocument extends prismic.PrismicDocument,
->(
-	...args: [
-		tag: ClientMethodParameters<"getByTag">[0],
-		params?: ClientMethodParameters<"getByTag">[1] & HookOnlyParameters,
-	]
-): ClientHookReturnType<prismic.Query<TDocument>> =>
-	useStatefulPrismicClientMethod("getByTag", args);
-
-/**
- * A hook that queries all documents from the Prismic repository with a specific
- * tag.
- *
- * @remarks
- * An additional `@prismicio/client` instance can be provided at
- * `params.client`.
- * @typeParam TDocument - Type of Prismic documents returned
- *
- * @param tag - The tag that must be included on a document
- * @param params - Parameters to filter and sort results
- *
- * @returns The composable payload {@link ClientHookReturnType}
- *
- * @see Underlying `@prismicio/client` method {@link proto.getAllByTag}
- */
-export const useAllPrismicDocumentsByTag = <
-	TDocument extends prismic.PrismicDocument,
->(
-	...args: [
-		tag: ClientMethodParameters<"getAllByTag">[0],
-		params?: ClientMethodParameters<"getAllByTag">[1] & HookOnlyParameters,
-	]
-): ClientHookReturnType<TDocument[]> =>
-	useStatefulPrismicClientMethod("getAllByTag", args);
-
-/**
- * A hook that queries documents from the Prismic repository with specific tags.
- * A document must be tagged with at least one of the queried tags to be
- * included.
- *
- * @remarks
- * An additional `@prismicio/client` instance can be provided at
- * `params.client`.
- * @typeParam TDocument - Type of Prismic documents returned
- *
- * @param tags - A list of tags that must be included on a document
- * @param params - Parameters to filter, sort, and paginate results
- *
- * @returns The composable payload {@link ClientHookReturnType}
- *
- * @see Underlying `@prismicio/client` method {@link proto.getByTags}
- */
-export const usePrismicDocumentsBySomeTags = <
-	TDocument extends prismic.PrismicDocument,
->(
-	...args: [
-		tag: ClientMethodParameters<"getBySomeTags">[0],
-		params?: ClientMethodParameters<"getBySomeTags">[1] & HookOnlyParameters,
-	]
-): ClientHookReturnType<prismic.Query<TDocument>> =>
-	useStatefulPrismicClientMethod("getBySomeTags", args);
-
-/**
- * A hook that queries all documents from the Prismic repository with specific
- * tags. A document must be tagged with at least one of the queried tags to be
- * included.
- *
- * @remarks
- * An additional `@prismicio/client` instance can be provided at
- * `params.client`.
- * @typeParam TDocument - Type of Prismic documents returned
- *
- * @param tags - A list of tags that must be included on a document
- * @param params - Parameters to filter and sort results
- *
- * @returns The composable payload {@link ClientHookReturnType}
- *
- * @see Underlying `@prismicio/client` method {@link proto.getAllByTags}
- */
-export const useAllPrismicDocumentsBySomeTags = <
-	TDocument extends prismic.PrismicDocument,
->(
-	...args: [
-		tag: ClientMethodParameters<"getAllBySomeTags">[0],
-		params?: ClientMethodParameters<"getAllBySomeTags">[1] & HookOnlyParameters,
-	]
-): ClientHookReturnType<TDocument[]> =>
-	useStatefulPrismicClientMethod("getAllBySomeTags", args);
-
-/**
- * A hook that queries documents from the Prismic repository with specific tags.
- * A document must be tagged with all of the queried tags to be included.
- *
- * @remarks
- * An additional `@prismicio/client` instance can be provided at
- * `params.client`.
- * @typeParam TDocument - Type of Prismic documents returned
- *
- * @param tags - A list of tags that must be included on a document
- * @param params - Parameters to filter, sort, and paginate results
- *
- * @returns The composable payload {@link ClientHookReturnType}
- *
- * @see Underlying `@prismicio/client` method {@link proto.getByTags}
- */
-export const usePrismicDocumentsByEveryTag = <
-	TDocument extends prismic.PrismicDocument,
->(
-	...args: [
-		tag: ClientMethodParameters<"getByEveryTag">[0],
-		params?: ClientMethodParameters<"getByEveryTag">[1] & HookOnlyParameters,
-	]
-): ClientHookReturnType<prismic.Query<TDocument>> =>
-	useStatefulPrismicClientMethod("getByEveryTag", args);
-
-/**
- * A hook that queries all documents from the Prismic repository with specific
- * tags. A document must be tagged with all of the queried tags to be included.
- *
- * @remarks
- * An additional `@prismicio/client` instance can be provided at
- * `params.client`.
- * @typeParam TDocument - Type of Prismic documents returned
- *
- * @param tags - A list of tags that must be included on a document
- * @param params - Parameters to filter and sort results
- *
- * @returns The composable payload {@link ClientHookReturnType}
- *
- * @see Underlying `@prismicio/client` method {@link proto.getAllByTags}
- */
-export const useAllPrismicDocumentsByEveryTag = <
-	TDocument extends prismic.PrismicDocument,
->(
-	...args: [
-		tag: ClientMethodParameters<"getAllByEveryTag">[0],
-		params?: ClientMethodParameters<"getAllByEveryTag">[1] & HookOnlyParameters,
-	]
-): ClientHookReturnType<TDocument[]> =>
-	useStatefulPrismicClientMethod("getAllByEveryTag", args);

package/src/lib/isInternalURL.ts

@@ -1,14 +0,0 @@
-/**
- * Determines if a URL is internal or external.
- *
- * @param url - The URL to check if internal or external.
- *
- * @returns `true` if `url` is internal, `false` otherwise.
- */
-// TODO: This does not detect all relative URLs as internal such as `about` or `./about`. This function assumes relative URLs start with a "/" or "#"`.
-export const isInternalURL = (url: string): boolean => {
-	const isInternal = /^(\/(?!\/)|#)/.test(url);
-	const isSpecialLink = !isInternal && !/^https?:\/\//.test(url);
-
-	return isInternal && !isSpecialLink;
-};

package/src/lib/pascalCase.ts

@@ -1,79 +0,0 @@
-// `PascalCase`-related types have been taken from the `type-fest` package.
-//
-// They are copied here to mininize dependencies in this project.
-//
-// See: https://github.com/sindresorhus/type-fest/blob/61c35052f09caa23de5eef96d95196375d8ed498/source/camel-case.d.ts
-
-type WordSeparators = "-" | "_" | " ";
-
-type Split<
-	S extends string,
-	Delimiter extends string,
-> = S extends `${infer Head}${Delimiter}${infer Tail}`
-	? [Head, ...Split<Tail, Delimiter>]
-	: S extends Delimiter
-	? []
-	: [S];
-
-type InnerCamelCaseStringArray<
-	// eslint-disable-next-line @typescript-eslint/no-explicit-any
-	Parts extends readonly any[],
-	PreviousPart,
-> = Parts extends [`${infer FirstPart}`, ...infer RemainingParts]
-	? FirstPart extends undefined
-		? ""
-		: FirstPart extends ""
-		? InnerCamelCaseStringArray<RemainingParts, PreviousPart>
-		: `${PreviousPart extends ""
-				? FirstPart
-				: Capitalize<FirstPart>}${InnerCamelCaseStringArray<
-				RemainingParts,
-				FirstPart
-		  >}`
-	: "";
-
-type CamelCaseStringArray<Parts extends readonly string[]> = Parts extends [
-	`${infer FirstPart}`,
-	...infer RemainingParts,
-]
-	? Uncapitalize<`${FirstPart}${InnerCamelCaseStringArray<
-			RemainingParts,
-			FirstPart
-	  >}`>
-	: never;
-
-type CamelCase<K> = K extends string
-	? CamelCaseStringArray<
-			Split<K extends Uppercase<K> ? Lowercase<K> : K, WordSeparators>
-	  >
-	: K;
-
-/**
- * Converts a string literal to Pascal case.
- *
- * Taken from the `type-fest` package.
- *
- * See:
- * https://github.com/sindresorhus/type-fest/blob/61c35052f09caa23de5eef96d95196375d8ed498/source/pascal-case.d.ts
- */
-export type PascalCase<Value> = CamelCase<Value> extends string
-	? Capitalize<CamelCase<Value>>
-	: CamelCase<Value>;
-
-/**
- * Converts a string to Pascal case.
- *
- * @param input - The string to convert.
- *
- * @returns `input` as Pascal case.
- */
-export const pascalCase = <Input extends string>(
-	input: Input,
-): PascalCase<Input> => {
-	const camelCased = input.replace(/(?:-|_)(\w)/g, (_, c) => {
-		return c ? c.toUpperCase() : "";
-	});
-
-	return (camelCased[0].toUpperCase() +
-		camelCased.slice(1)) as PascalCase<Input>;
-};