@prismicio/react 2.5.0 → 2.5.1

package/dist/clientHooks.d.ts

@@ -0,0 +1,357 @@
+import type * as prismicT from "@prismicio/types";
+import { ClientHookReturnType, HookOnlyParameters } 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 declare const usePrismicDocuments: <TDocument extends prismicT.PrismicDocument<Record<string, any>, string, string>>(params?: (Partial<import("@prismicio/client").BuildQueryURLArgs> & {
+    signal?: any;
+} & HookOnlyParameters) | undefined) => ClientHookReturnType<prismicT.Query<TDocument>>;
+/**
+ * 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 declare const useFirstPrismicDocument: <TDocument extends prismicT.PrismicDocument<Record<string, any>, string, string>>(params?: (Partial<import("@prismicio/client").BuildQueryURLArgs> & {
+    signal?: any;
+} & HookOnlyParameters) | undefined) => ClientHookReturnType<TDocument>;
+/**
+ * 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 declare const useAllPrismicDocumentsDangerously: <TDocument extends prismicT.PrismicDocument<Record<string, any>, string, string>>(params?: (Partial<Omit<import("@prismicio/client").BuildQueryURLArgs, "page">> & {
+    limit?: number | undefined;
+} & {
+    signal?: any;
+} & HookOnlyParameters) | undefined) => ClientHookReturnType<TDocument[]>;
+/**
+ * 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 declare const usePrismicDocumentByID: <TDocument extends prismicT.PrismicDocument<Record<string, any>, string, string>>(id: string, params?: (Partial<import("@prismicio/client").BuildQueryURLArgs> & {
+    signal?: any;
+} & HookOnlyParameters) | undefined) => ClientHookReturnType<TDocument>;
+/**
+ * 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 declare const usePrismicDocumentsByIDs: <TDocument extends prismicT.PrismicDocument<Record<string, any>, string, string>>(id: string[], params?: (Partial<import("@prismicio/client").BuildQueryURLArgs> & {
+    signal?: any;
+} & HookOnlyParameters) | undefined) => ClientHookReturnType<prismicT.Query<TDocument>>;
+/**
+ * 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 declare const useAllPrismicDocumentsByIDs: <TDocument extends prismicT.PrismicDocument<Record<string, any>, string, string>>(id: string[], params?: (Partial<import("@prismicio/client").BuildQueryURLArgs> & {
+    limit?: number | undefined;
+} & {
+    signal?: any;
+} & HookOnlyParameters) | undefined) => ClientHookReturnType<TDocument[]>;
+/**
+ * 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 declare const usePrismicDocumentByUID: <TDocument extends prismicT.PrismicDocument<Record<string, any>, string, string>>(documentType: any, uid: string, params?: (Partial<import("@prismicio/client").BuildQueryURLArgs> & {
+    signal?: any;
+} & HookOnlyParameters) | undefined) => ClientHookReturnType<TDocument>;
+/**
+ * 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 declare const usePrismicDocumentsByUIDs: <TDocument extends prismicT.PrismicDocument<Record<string, any>, string, string>>(documentType: any, uids: string[], params?: (Partial<import("@prismicio/client").BuildQueryURLArgs> & {
+    signal?: any;
+} & HookOnlyParameters) | undefined) => ClientHookReturnType<prismicT.Query<TDocument>>;
+/**
+ * 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 declare const useAllPrismicDocumentsByUIDs: <TDocument extends prismicT.PrismicDocument<Record<string, any>, string, string>>(documentType: any, uids: string[], params?: (Partial<import("@prismicio/client").BuildQueryURLArgs> & {
+    signal?: any;
+} & HookOnlyParameters) | undefined) => ClientHookReturnType<TDocument[]>;
+/**
+ * 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 declare const useSinglePrismicDocument: <TDocument extends prismicT.PrismicDocument<Record<string, any>, string, string>>(documentType: any, params?: (Partial<import("@prismicio/client").BuildQueryURLArgs> & {
+    signal?: any;
+} & HookOnlyParameters) | undefined) => ClientHookReturnType<TDocument>;
+/**
+ * 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 declare const usePrismicDocumentsByType: <TDocument extends prismicT.PrismicDocument<Record<string, any>, string, string>>(documentType: any, params?: (Partial<import("@prismicio/client").BuildQueryURLArgs> & {
+    signal?: any;
+} & HookOnlyParameters) | undefined) => ClientHookReturnType<prismicT.Query<TDocument>>;
+/**
+ * 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 declare const useAllPrismicDocumentsByType: <TDocument extends prismicT.PrismicDocument<Record<string, any>, string, string>>(documentType: any, params?: (Partial<Omit<import("@prismicio/client").BuildQueryURLArgs, "page">> & {
+    limit?: number | undefined;
+} & {
+    signal?: any;
+} & HookOnlyParameters) | undefined) => ClientHookReturnType<TDocument[]>;
+/**
+ * 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 declare const usePrismicDocumentsByTag: <TDocument extends prismicT.PrismicDocument<Record<string, any>, string, string>>(tag: string, params?: (Partial<import("@prismicio/client").BuildQueryURLArgs> & {
+    signal?: any;
+} & HookOnlyParameters) | undefined) => ClientHookReturnType<prismicT.Query<TDocument>>;
+/**
+ * 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 declare const useAllPrismicDocumentsByTag: <TDocument extends prismicT.PrismicDocument<Record<string, any>, string, string>>(tag: string, params?: (Partial<Omit<import("@prismicio/client").BuildQueryURLArgs, "page">> & {
+    limit?: number | undefined;
+} & {
+    signal?: any;
+} & HookOnlyParameters) | undefined) => ClientHookReturnType<TDocument[]>;
+/**
+ * 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 declare const usePrismicDocumentsBySomeTags: <TDocument extends prismicT.PrismicDocument<Record<string, any>, string, string>>(tag: string[], params?: (Partial<import("@prismicio/client").BuildQueryURLArgs> & {
+    signal?: any;
+} & HookOnlyParameters) | undefined) => ClientHookReturnType<prismicT.Query<TDocument>>;
+/**
+ * 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 declare const useAllPrismicDocumentsBySomeTags: <TDocument extends prismicT.PrismicDocument<Record<string, any>, string, string>>(tag: string[], params?: (Partial<Omit<import("@prismicio/client").BuildQueryURLArgs, "page">> & {
+    limit?: number | undefined;
+} & {
+    signal?: any;
+} & HookOnlyParameters) | undefined) => ClientHookReturnType<TDocument[]>;
+/**
+ * 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 declare const usePrismicDocumentsByEveryTag: <TDocument extends prismicT.PrismicDocument<Record<string, any>, string, string>>(tag: string[], params?: (Partial<import("@prismicio/client").BuildQueryURLArgs> & {
+    signal?: any;
+} & HookOnlyParameters) | undefined) => ClientHookReturnType<prismicT.Query<TDocument>>;
+/**
+ * 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 declare const useAllPrismicDocumentsByEveryTag: <TDocument extends prismicT.PrismicDocument<Record<string, any>, string, string>>(tag: string[], params?: (Partial<Omit<import("@prismicio/client").BuildQueryURLArgs, "page">> & {
+    limit?: number | undefined;
+} & {
+    signal?: any;
+} & HookOnlyParameters) | undefined) => ClientHookReturnType<TDocument[]>;

package/dist/clientHooks.js

@@ -0,0 +1,40 @@
+import { useStatefulPrismicClientMethod } from "./useStatefulPrismicClientMethod.js";
+const usePrismicDocuments = (...args) => useStatefulPrismicClientMethod("get", args);
+const useFirstPrismicDocument = (...args) => useStatefulPrismicClientMethod("getFirst", args);
+const useAllPrismicDocumentsDangerously = (...args) => useStatefulPrismicClientMethod("dangerouslyGetAll", args);
+const usePrismicDocumentByID = (...args) => useStatefulPrismicClientMethod("getByID", args);
+const usePrismicDocumentsByIDs = (...args) => useStatefulPrismicClientMethod("getByIDs", args);
+const useAllPrismicDocumentsByIDs = (...args) => useStatefulPrismicClientMethod("getAllByIDs", args);
+const usePrismicDocumentByUID = (...args) => useStatefulPrismicClientMethod("getByUID", args);
+const usePrismicDocumentsByUIDs = (...args) => useStatefulPrismicClientMethod("getByUIDs", args);
+const useAllPrismicDocumentsByUIDs = (...args) => useStatefulPrismicClientMethod("getAllByUIDs", args);
+const useSinglePrismicDocument = (...args) => useStatefulPrismicClientMethod("getSingle", args);
+const usePrismicDocumentsByType = (...args) => useStatefulPrismicClientMethod("getByType", args);
+const useAllPrismicDocumentsByType = (...args) => useStatefulPrismicClientMethod("getAllByType", args);
+const usePrismicDocumentsByTag = (...args) => useStatefulPrismicClientMethod("getByTag", args);
+const useAllPrismicDocumentsByTag = (...args) => useStatefulPrismicClientMethod("getAllByTag", args);
+const usePrismicDocumentsBySomeTags = (...args) => useStatefulPrismicClientMethod("getBySomeTags", args);
+const useAllPrismicDocumentsBySomeTags = (...args) => useStatefulPrismicClientMethod("getAllBySomeTags", args);
+const usePrismicDocumentsByEveryTag = (...args) => useStatefulPrismicClientMethod("getByEveryTag", args);
+const useAllPrismicDocumentsByEveryTag = (...args) => useStatefulPrismicClientMethod("getAllByEveryTag", args);
+export {
+  useAllPrismicDocumentsByEveryTag,
+  useAllPrismicDocumentsByIDs,
+  useAllPrismicDocumentsBySomeTags,
+  useAllPrismicDocumentsByTag,
+  useAllPrismicDocumentsByType,
+  useAllPrismicDocumentsByUIDs,
+  useAllPrismicDocumentsDangerously,
+  useFirstPrismicDocument,
+  usePrismicDocumentByID,
+  usePrismicDocumentByUID,
+  usePrismicDocuments,
+  usePrismicDocumentsByEveryTag,
+  usePrismicDocumentsByIDs,
+  usePrismicDocumentsBySomeTags,
+  usePrismicDocumentsByTag,
+  usePrismicDocumentsByType,
+  usePrismicDocumentsByUIDs,
+  useSinglePrismicDocument
+};
+//# sourceMappingURL=clientHooks.js.map

package/dist/clientHooks.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"clientHooks.js","sources":["../../src/clientHooks.ts"],"sourcesContent":["import type * as prismicT from \"@prismicio/types\";\n\nimport {\n\tClientHookReturnType,\n\tClientMethodParameters,\n\tHookOnlyParameters,\n\tuseStatefulPrismicClientMethod,\n} from \"./useStatefulPrismicClientMethod\";\n\n/**\n * A hook that queries content from the Prismic repository.\n *\n * @remarks\n * An additional `@prismicio/client` instance can be provided at\n * `params.client`.\n * @typeParam TDocument - Type of Prismic documents returned\n *\n * @param params - Parameters to filter, sort, and paginate results\n *\n * @returns The composable payload {@link ClientHookReturnType}\n *\n * @see Underlying `@prismicio/client` method {@link proto.get}\n */\nexport const usePrismicDocuments = <TDocument extends prismicT.PrismicDocument>(\n\t...args: [params?: ClientMethodParameters<\"get\">[0] & HookOnlyParameters]\n): ClientHookReturnType<prismicT.Query<TDocument>> =>\n\tuseStatefulPrismicClientMethod(\"get\", args);\n\n/**\n * A hook that queries content from the Prismic repository and returns only the\n * first result, if any.\n *\n * @remarks\n * An additional `@prismicio/client` instance can be provided at\n * `params.client`.\n * @typeParam TDocument - Type of the Prismic document returned\n *\n * @param params - Parameters to filter, sort, and paginate results\n *\n * @returns The composable payload {@link ClientHookReturnType}\n *\n * @see Underlying `@prismicio/client` method {@link proto.getFirst}\n */\nexport const useFirstPrismicDocument = <\n\tTDocument extends prismicT.PrismicDocument,\n>(\n\t...args: [params?: ClientMethodParameters<\"getFirst\">[0] & HookOnlyParameters]\n): ClientHookReturnType<TDocument> =>\n\tuseStatefulPrismicClientMethod(\"getFirst\", args);\n\n/**\n * A hook that queries content from the Prismic repository and returns all\n * matching content. If no predicates are provided, all documents will be\n * fetched.\n *\n * @remarks\n * An additional `@prismicio/client` instance can be provided at\n * `params.client`.\n * @typeParam TDocument - Type of Prismic documents returned\n *\n * @param params - Parameters to filter and sort results\n *\n * @returns The composable payload {@link ClientHookReturnType}\n *\n * @see Underlying `@prismicio/client` method {@link proto.getAll}\n */\nexport const useAllPrismicDocumentsDangerously = <\n\tTDocument extends prismicT.PrismicDocument,\n>(\n\t...args: [\n\t\tparams?: ClientMethodParameters<\"dangerouslyGetAll\">[0] &\n\t\t\tHookOnlyParameters,\n\t]\n): ClientHookReturnType<TDocument[]> =>\n\tuseStatefulPrismicClientMethod(\"dangerouslyGetAll\", args);\n\n/**\n * A hook that queries a document from the Prismic repository with a specific\n * ID.\n *\n * @remarks\n * An additional `@prismicio/client` instance can be provided at\n * `params.client`.\n * @typeParam TDocument - Type of the Prismic document returned\n *\n * @param id - ID of the document\n * @param params - Parameters to filter, sort, and paginate results\n *\n * @returns The composable payload {@link ClientHookReturnType}\n *\n * @see Underlying `@prismicio/client` method {@link proto.getByID}\n */\nexport const usePrismicDocumentByID = <\n\tTDocument extends prismicT.PrismicDocument,\n>(\n\t...args: [\n\t\tid: ClientMethodParameters<\"getByID\">[0],\n\t\tparams?: ClientMethodParameters<\"getByID\">[1] & HookOnlyParameters,\n\t]\n): ClientHookReturnType<TDocument> =>\n\tuseStatefulPrismicClientMethod(\"getByID\", args);\n\n/**\n * A hook that queries documents from the Prismic repository with specific IDs.\n *\n * @remarks\n * An additional `@prismicio/client` instance can be provided at\n * `params.client`.\n * @typeParam TDocument - Type of Prismic documents returned\n *\n * @param ids - A list of document IDs\n * @param params - Parameters to filter, sort, and paginate results\n *\n * @returns The composable payload {@link ClientHookReturnType}\n *\n * @see Underlying `@prismicio/client` method {@link proto.getByIDs}\n */\nexport const usePrismicDocumentsByIDs = <\n\tTDocument extends prismicT.PrismicDocument,\n>(\n\t...args: [\n\t\tid: ClientMethodParameters<\"getByIDs\">[0],\n\t\tparams?: ClientMethodParameters<\"getByIDs\">[1] & HookOnlyParameters,\n\t]\n): ClientHookReturnType<prismicT.Query<TDocument>> =>\n\tuseStatefulPrismicClientMethod(\"getByIDs\", args);\n\n/**\n * A hook that queries all documents from the Prismic repository with specific\n * IDs.\n *\n * @remarks\n * An additional `@prismicio/client` instance can be provided at\n * `params.client`.\n * @typeParam TDocument - Type of Prismic documents returned\n *\n * @param ids - A list of document IDs\n * @param params - Parameters to filter and sort results\n *\n * @returns The composable payload {@link ClientHookReturnType}\n *\n * @see Underlying `@prismicio/client` method {@link proto.getAllByIDs}\n */\nexport const useAllPrismicDocumentsByIDs = <\n\tTDocument extends prismicT.PrismicDocument,\n>(\n\t...args: [\n\t\tid: ClientMethodParameters<\"getAllByIDs\">[0],\n\t\tparams?: ClientMethodParameters<\"getAllByIDs\">[1] & HookOnlyParameters,\n\t]\n): ClientHookReturnType<TDocument[]> =>\n\tuseStatefulPrismicClientMethod(\"getAllByIDs\", args);\n\n/**\n * A hook that queries a document from the Prismic repository with a specific\n * UID and Custom Type.\n *\n * @remarks\n * An additional `@prismicio/client` instance can be provided at\n * `params.client`.\n * @typeParam TDocument - Type of the Prismic document returned\n *\n * @param documentType - The API ID of the document's Custom Type\n * @param uid - UID of the document\n * @param params - Parameters to filter, sort, and paginate results\n *\n * @returns The composable payload {@link ClientHookReturnType}\n *\n * @see Underlying `@prismicio/client` method {@link proto.getByUID}\n */\nexport const usePrismicDocumentByUID = <\n\tTDocument extends prismicT.PrismicDocument,\n>(\n\t...args: [\n\t\tdocumentType: ClientMethodParameters<\"getByUID\">[0],\n\t\tuid: ClientMethodParameters<\"getByUID\">[1],\n\t\tparams?: ClientMethodParameters<\"getByUID\">[2] & HookOnlyParameters,\n\t]\n): ClientHookReturnType<TDocument> =>\n\tuseStatefulPrismicClientMethod(\"getByUID\", args);\n\n/**\n * A hook that queries documents from the Prismic repository with specific UIDs\n * of a Custom Type.\n *\n * @remarks\n * An additional `@prismicio/client` instance can be provided at\n * `params.client`.\n * @typeParam TDocument - Type of the Prismic document returned\n *\n * @param documentType - The API ID of the document's Custom Type\n * @param uids - A list of document UIDs.\n * @param params - Parameters to filter, sort, and paginate results\n *\n * @returns The composable payload {@link ClientHookReturnType}\n *\n * @see Underlying `@prismicio/client` method {@link proto.getByUID}\n */\nexport const usePrismicDocumentsByUIDs = <\n\tTDocument extends prismicT.PrismicDocument,\n>(\n\t...args: [\n\t\tdocumentType: ClientMethodParameters<\"getByUIDs\">[0],\n\t\tuids: ClientMethodParameters<\"getByUIDs\">[1],\n\t\tparams?: ClientMethodParameters<\"getByUIDs\">[2] & HookOnlyParameters,\n\t]\n): ClientHookReturnType<prismicT.Query<TDocument>> =>\n\tuseStatefulPrismicClientMethod(\"getByUIDs\", args);\n\n/**\n * A hook that queries all documents from the Prismic repository with specific\n * UIDs of a Custom Type.\n *\n * @remarks\n * An additional `@prismicio/client` instance can be provided at\n * `params.client`.\n * @typeParam TDocument - Type of the Prismic document returned\n *\n * @param documentType - The API ID of the document's Custom Type\n * @param uids - A list of document UIDs.\n * @param params - Parameters to filter, sort, and paginate results\n *\n * @returns The composable payload {@link ClientHookReturnType}\n *\n * @see Underlying `@prismicio/client` method {@link proto.getByUID}\n */\nexport const useAllPrismicDocumentsByUIDs = <\n\tTDocument extends prismicT.PrismicDocument,\n>(\n\t...args: [\n\t\tdocumentType: ClientMethodParameters<\"getByUIDs\">[0],\n\t\tuids: ClientMethodParameters<\"getByUIDs\">[1],\n\t\tparams?: ClientMethodParameters<\"getByUIDs\">[2] & HookOnlyParameters,\n\t]\n): ClientHookReturnType<TDocument[]> =>\n\tuseStatefulPrismicClientMethod(\"getAllByUIDs\", args);\n\n/**\n * A hook that queries a singleton document from the Prismic repository for a\n * specific Custom Type.\n *\n * @remarks\n * An additional `@prismicio/client` instance can be provided at\n * `params.client`.\n * @typeParam TDocument - Type of the Prismic document returned\n *\n * @param documentType - The API ID of the singleton Custom Type\n * @param params - Parameters to filter, sort, and paginate results\n *\n * @returns The composable payload {@link ClientHookReturnType}\n *\n * @see Underlying `@prismicio/client` method {@link proto.getSingle}\n */\nexport const useSinglePrismicDocument = <\n\tTDocument extends prismicT.PrismicDocument,\n>(\n\t...args: [\n\t\tdocumentType: ClientMethodParameters<\"getSingle\">[0],\n\t\tparams?: ClientMethodParameters<\"getSingle\">[1] & HookOnlyParameters,\n\t]\n): ClientHookReturnType<TDocument> =>\n\tuseStatefulPrismicClientMethod(\"getSingle\", args);\n\n/**\n * A hook that queries documents from the Prismic repository for a specific\n * Custom Type.\n *\n * @remarks\n * An additional `@prismicio/client` instance can be provided at\n * `params.client`.\n * @typeParam TDocument - Type of Prismic documents returned\n *\n * @param documentType - The API ID of the Custom Type\n * @param params - Parameters to filter, sort, and paginate results\n *\n * @returns The composable payload {@link ClientHookReturnType}\n *\n * @see Underlying `@prismicio/client` method {@link proto.getByType}\n */\nexport const usePrismicDocumentsByType = <\n\tTDocument extends prismicT.PrismicDocument,\n>(\n\t...args: [\n\t\tdocumentType: ClientMethodParameters<\"getByType\">[0],\n\t\tparams?: ClientMethodParameters<\"getByType\">[1] & HookOnlyParameters,\n\t]\n): ClientHookReturnType<prismicT.Query<TDocument>> =>\n\tuseStatefulPrismicClientMethod(\"getByType\", args);\n\n/**\n * A hook that queries all documents from the Prismic repository for a specific\n * Custom Type.\n *\n * @remarks\n * An additional `@prismicio/client` instance can be provided at\n * `params.client`.\n * @typeParam TDocument - Type of Prismic documents returned\n *\n * @param documentType - The API ID of the Custom Type\n * @param params - Parameters to filter and sort results\n *\n * @returns The composable payload {@link ClientHookReturnType}\n *\n * @see Underlying `@prismicio/client` method {@link proto.getAllByType}\n */\nexport const useAllPrismicDocumentsByType = <\n\tTDocument extends prismicT.PrismicDocument,\n>(\n\t...args: [\n\t\tdocumentType: ClientMethodParameters<\"getAllByType\">[0],\n\t\tparams?: ClientMethodParameters<\"getAllByType\">[1] & HookOnlyParameters,\n\t]\n): ClientHookReturnType<TDocument[]> =>\n\tuseStatefulPrismicClientMethod(\"getAllByType\", args);\n\n/**\n * A hook that queries documents from the Prismic repository with a specific\n * tag.\n *\n * @remarks\n * An additional `@prismicio/client` instance can be provided at\n * `params.client`.\n * @typeParam TDocument - Type of Prismic documents returned\n *\n * @param tag - The tag that must be included on a document\n * @param params - Parameters to filter, sort, and paginate results\n *\n * @returns The composable payload {@link ClientHookReturnType}\n *\n * @see Underlying `@prismicio/client` method {@link proto.getByTag}\n */\nexport const usePrismicDocumentsByTag = <\n\tTDocument extends prismicT.PrismicDocument,\n>(\n\t...args: [\n\t\ttag: ClientMethodParameters<\"getByTag\">[0],\n\t\tparams?: ClientMethodParameters<\"getByTag\">[1] & HookOnlyParameters,\n\t]\n): ClientHookReturnType<prismicT.Query<TDocument>> =>\n\tuseStatefulPrismicClientMethod(\"getByTag\", args);\n\n/**\n * A hook that queries all documents from the Prismic repository with a specific\n * tag.\n *\n * @remarks\n * An additional `@prismicio/client` instance can be provided at\n * `params.client`.\n * @typeParam TDocument - Type of Prismic documents returned\n *\n * @param tag - The tag that must be included on a document\n * @param params - Parameters to filter and sort results\n *\n * @returns The composable payload {@link ClientHookReturnType}\n *\n * @see Underlying `@prismicio/client` method {@link proto.getAllByTag}\n */\nexport const useAllPrismicDocumentsByTag = <\n\tTDocument extends prismicT.PrismicDocument,\n>(\n\t...args: [\n\t\ttag: ClientMethodParameters<\"getAllByTag\">[0],\n\t\tparams?: ClientMethodParameters<\"getAllByTag\">[1] & HookOnlyParameters,\n\t]\n): ClientHookReturnType<TDocument[]> =>\n\tuseStatefulPrismicClientMethod(\"getAllByTag\", args);\n\n/**\n * A hook that queries documents from the Prismic repository with specific tags.\n * A document must be tagged with at least one of the queried tags to be\n * included.\n *\n * @remarks\n * An additional `@prismicio/client` instance can be provided at\n * `params.client`.\n * @typeParam TDocument - Type of Prismic documents returned\n *\n * @param tags - A list of tags that must be included on a document\n * @param params - Parameters to filter, sort, and paginate results\n *\n * @returns The composable payload {@link ClientHookReturnType}\n *\n * @see Underlying `@prismicio/client` method {@link proto.getByTags}\n */\nexport const usePrismicDocumentsBySomeTags = <\n\tTDocument extends prismicT.PrismicDocument,\n>(\n\t...args: [\n\t\ttag: ClientMethodParameters<\"getBySomeTags\">[0],\n\t\tparams?: ClientMethodParameters<\"getBySomeTags\">[1] & HookOnlyParameters,\n\t]\n): ClientHookReturnType<prismicT.Query<TDocument>> =>\n\tuseStatefulPrismicClientMethod(\"getBySomeTags\", args);\n\n/**\n * A hook that queries all documents from the Prismic repository with specific\n * tags. A document must be tagged with at least one of the queried tags to be\n * included.\n *\n * @remarks\n * An additional `@prismicio/client` instance can be provided at\n * `params.client`.\n * @typeParam TDocument - Type of Prismic documents returned\n *\n * @param tags - A list of tags that must be included on a document\n * @param params - Parameters to filter and sort results\n *\n * @returns The composable payload {@link ClientHookReturnType}\n *\n * @see Underlying `@prismicio/client` method {@link proto.getAllByTags}\n */\nexport const useAllPrismicDocumentsBySomeTags = <\n\tTDocument extends prismicT.PrismicDocument,\n>(\n\t...args: [\n\t\ttag: ClientMethodParameters<\"getAllBySomeTags\">[0],\n\t\tparams?: ClientMethodParameters<\"getAllBySomeTags\">[1] & HookOnlyParameters,\n\t]\n): ClientHookReturnType<TDocument[]> =>\n\tuseStatefulPrismicClientMethod(\"getAllBySomeTags\", args);\n\n/**\n * A hook that queries documents from the Prismic repository with specific tags.\n * A document must be tagged with all of the queried tags to be included.\n *\n * @remarks\n * An additional `@prismicio/client` instance can be provided at\n * `params.client`.\n * @typeParam TDocument - Type of Prismic documents returned\n *\n * @param tags - A list of tags that must be included on a document\n * @param params - Parameters to filter, sort, and paginate results\n *\n * @returns The composable payload {@link ClientHookReturnType}\n *\n * @see Underlying `@prismicio/client` method {@link proto.getByTags}\n */\nexport const usePrismicDocumentsByEveryTag = <\n\tTDocument extends prismicT.PrismicDocument,\n>(\n\t...args: [\n\t\ttag: ClientMethodParameters<\"getByEveryTag\">[0],\n\t\tparams?: ClientMethodParameters<\"getByEveryTag\">[1] & HookOnlyParameters,\n\t]\n): ClientHookReturnType<prismicT.Query<TDocument>> =>\n\tuseStatefulPrismicClientMethod(\"getByEveryTag\", args);\n\n/**\n * A hook that queries all documents from the Prismic repository with specific\n * tags. A document must be tagged with all of the queried tags to be included.\n *\n * @remarks\n * An additional `@prismicio/client` instance can be provided at\n * `params.client`.\n * @typeParam TDocument - Type of Prismic documents returned\n *\n * @param tags - A list of tags that must be included on a document\n * @param params - Parameters to filter and sort results\n *\n * @returns The composable payload {@link ClientHookReturnType}\n *\n * @see Underlying `@prismicio/client` method {@link proto.getAllByTags}\n */\nexport const useAllPrismicDocumentsByEveryTag = <\n\tTDocument extends prismicT.PrismicDocument,\n>(\n\t...args: [\n\t\ttag: ClientMethodParameters<\"getAllByEveryTag\">[0],\n\t\tparams?: ClientMethodParameters<\"getAllByEveryTag\">[1] & HookOnlyParameters,\n\t]\n): ClientHookReturnType<TDocument[]> =>\n\tuseStatefulPrismicClientMethod(\"getAllByEveryTag\", args);\n"],"names":[],"mappings":";AAuBO,MAAM,sBAAsB,IAC/B,SAEH,+BAA+B,OAAO,IAAI;AAiBpC,MAAM,0BAA0B,IAGnC,SAEH,+BAA+B,YAAY,IAAI;AAkBzC,MAAM,oCAAoC,IAG7C,SAKH,+BAA+B,qBAAqB,IAAI;AAkBlD,MAAM,yBAAyB,IAGlC,SAKH,+BAA+B,WAAW,IAAI;AAiBxC,MAAM,2BAA2B,IAGpC,SAKH,+BAA+B,YAAY,IAAI;AAkBzC,MAAM,8BAA8B,IAGvC,SAKH,+BAA+B,eAAe,IAAI;AAmB5C,MAAM,0BAA0B,IAGnC,SAMH,+BAA+B,YAAY,IAAI;AAmBzC,MAAM,4BAA4B,IAGrC,SAMH,+BAA+B,aAAa,IAAI;AAmB1C,MAAM,+BAA+B,IAGxC,SAMH,+BAA+B,gBAAgB,IAAI;AAkB7C,MAAM,2BAA2B,IAGpC,SAKH,+BAA+B,aAAa,IAAI;AAkB1C,MAAM,4BAA4B,IAGrC,SAKH,+BAA+B,aAAa,IAAI;AAkB1C,MAAM,+BAA+B,IAGxC,SAKH,+BAA+B,gBAAgB,IAAI;AAkB7C,MAAM,2BAA2B,IAGpC,SAKH,+BAA+B,YAAY,IAAI;AAkBzC,MAAM,8BAA8B,IAGvC,SAKH,+BAA+B,eAAe,IAAI;AAmB5C,MAAM,gCAAgC,IAGzC,SAKH,+BAA+B,iBAAiB,IAAI;AAmB9C,MAAM,mCAAmC,IAG5C,SAKH,+BAA+B,oBAAoB,IAAI;AAkBjD,MAAM,gCAAgC,IAGzC,SAKH,+BAA+B,iBAAiB,IAAI;AAkB9C,MAAM,mCAAmC,IAG5C,SAKH,+BAA+B,oBAAoB,IAAI;"}