@prismicio/vue 4.3.0 → 4.3.1

package/dist/useStatefulPrismicClientMethod.cjs.map

@@ -1 +1 @@
-{"version":3,"file":"useStatefulPrismicClientMethod.cjs","sources":["../../src/useStatefulPrismicClientMethod.ts"],"sourcesContent":["import {\n\tClient,\n\tForbiddenError,\n\tParsingError,\n\tPrismicError,\n} from \"@prismicio/client\";\nimport { Ref, isRef, ref, shallowRef, unref, watch } from \"vue\";\n\nimport { PrismicClientComposableState, VueUseParameters } from \"./types\";\n\nimport { usePrismic } from \"./usePrismic\";\n\n// Helpers\ntype UnwrapPromise<T> = T extends Promise<infer U> ? U : T;\n// eslint-disable-next-line @typescript-eslint/no-explicit-any\ntype ClientMethodLike = (...args: any[]) => Promise<any> | any;\ntype ClientMethods = typeof Client.prototype;\ntype ClientError = PrismicError<unknown> | ParsingError | ForbiddenError;\n\n// Interfaces\n\n/**\n * @internal\n */\nexport type ClientMethodParameters<TMethodName extends keyof ClientMethods> =\n\tClientMethods[TMethodName] extends ClientMethodLike\n\t\t? VueUseParameters<Parameters<ClientMethods[TMethodName]>>\n\t\t: never;\n\n/**\n * @internal\n */\nexport type ClientMethodReturnType<TMethodName extends keyof ClientMethods> =\n\tClientMethods[TMethodName] extends ClientMethodLike\n\t\t? ReturnType<ClientMethods[TMethodName]>\n\t\t: never;\n\n/**\n * @internal\n */\nexport type ComposableOnlyParameters = {\n\tclient?: Ref<Client> | Client;\n};\n\n/**\n * The return type of a `@prismicio/client` Vue composable.\n *\n * @typeParam TData - The expected format of the `data` property of the returned\n *   object\n */\nexport type ClientComposableReturnType<TData = unknown> = {\n\t/**\n\t * The current state of the composable's client method call.\n\t */\n\tstate: Ref<PrismicClientComposableState>;\n\n\t/**\n\t * Data returned by the client.\n\t */\n\tdata: Ref<TData | null>;\n\n\t/**\n\t * Error returned by the composable's client method call if in an errror\n\t * state.\n\t */\n\terror: Ref<ClientError | Error | null>;\n\n\t/**\n\t * Perform the composable's client method call again.\n\t */\n\trefresh: () => Promise<void>;\n};\n\n/**\n * Determines if a value is a `@prismicio/client` params object.\n *\n * @param value - The value to check\n *\n * @returns `true` if `value` is a `@prismicio/client` params object, `false`\n *   otherwise\n */\nconst isParams = (\n\tvalue: unknown,\n): value is ClientMethodParameters<\"get\">[0] & ComposableOnlyParameters => {\n\t// This is a *very* naive check.\n\treturn typeof value === \"object\" && value !== null && !Array.isArray(value);\n};\n\n/**\n * A low level Vue composable that uses provided method name on plugin or\n * provided client with given arguments. The composable has its own internal\n * state manager to report async status, such as pending or error statuses.\n *\n * @typeParam TClientMethodName - A method name from `@prismicio/client`\n * @typeParam TClientMethodArguments - The method expected arguments\n * @typeParam TClientMethodReturnType - The method expected return type\n *\n * @param method - The `@prismicio/client` method name to use\n * @param args - The arguments to use with requested method\n *\n * @returns The composable payload {@link ClientComposableReturnType}\n *\n * @internal\n */\nexport const useStatefulPrismicClientMethod = <\n\tTClientMethodName extends keyof ClientMethods,\n\tTClientMethodArguments extends ClientMethodParameters<TClientMethodName>,\n\tTClientMethodReturnType extends UnwrapPromise<\n\t\tClientMethodReturnType<TClientMethodName>\n\t>,\n>(\n\tmethodName: TClientMethodName,\n\targs: TClientMethodArguments,\n): ClientComposableReturnType<TClientMethodReturnType> => {\n\tconst { client } = usePrismic();\n\n\tconst state = ref<PrismicClientComposableState>(\n\t\tPrismicClientComposableState.Idle,\n\t);\n\tconst data = shallowRef<TClientMethodReturnType | null>(null);\n\tconst error = ref<ClientError | Error | null>(null);\n\tconst refresh = async (): Promise<void> => {\n\t\tconst lastArg = unref(args[args.length - 1]);\n\t\tconst { client: explicitClient, ...params } = isParams(lastArg)\n\t\t\t? (lastArg as ClientMethodParameters<\"get\">[0] & ComposableOnlyParameters)\n\t\t\t: ({} as ComposableOnlyParameters);\n\t\tconst argsWithoutParams = isParams(lastArg) ? args.slice(0, -1) : args;\n\n\t\tstate.value = PrismicClientComposableState.Pending;\n\t\tdata.value = null;\n\t\terror.value = null;\n\t\ttry {\n\t\t\tdata.value = await (\n\t\t\t\t(unref(explicitClient) || client)[methodName] as ClientMethodLike\n\t\t\t)(\n\t\t\t\t...argsWithoutParams.map((arg: Ref<unknown> | unknown) => unref(arg)),\n\t\t\t\tparams,\n\t\t\t);\n\t\t\tstate.value = PrismicClientComposableState.Success;\n\t\t} catch (err) {\n\t\t\tstate.value = PrismicClientComposableState.Error;\n\t\t\terror.value = err as ClientError | Error;\n\t\t}\n\t};\n\n\t// Watch reactive args\n\tconst refArgs = args.filter((arg) => isRef(arg));\n\tif (refArgs.length) {\n\t\twatch(refArgs, refresh, { deep: true });\n\t}\n\n\t// Fetch once\n\trefresh();\n\n\treturn { state, data, error, refresh };\n};\n"],"names":["usePrismic","ref","shallowRef","unref","isRef","watch"],"mappings":";;;;AAiFA,MAAM,WAAW,CAChB,UACyE;AAElE,SAAA,OAAO,UAAU,YAAY,UAAU,QAAQ,CAAC,MAAM,QAAQ,KAAK;AAC3E;AAkBa,MAAA,iCAAiC,CAO7C,YACA,SACwD;AAClD,QAAA,EAAE,WAAWA,WAAAA;AAEnB,QAAM,QAAQC,IAAA;AAAA,IAAG;AAAA;AAAA,EAAA;AAGX,QAAA,OAAOC,eAA2C,IAAI;AACtD,QAAA,QAAQD,QAAgC,IAAI;AAClD,QAAM,UAAU,YAA0B;AACzC,UAAM,UAAUE,IAAAA,MAAM,KAAK,KAAK,SAAS,CAAC,CAAC;AACrC,UAAA,EAAE,QAAQ,gBAAgB,GAAG,OAAA,IAAW,SAAS,OAAO,IAC1D,UACA;AACE,UAAA,oBAAoB,SAAS,OAAO,IAAI,KAAK,MAAM,GAAG,EAAE,IAAI;AAElE,UAAM,QAAK;AACX,SAAK,QAAQ;AACb,UAAM,QAAQ;AACV,QAAA;AACH,WAAK,QAAQ,OACXA,IAAAA,MAAM,cAAc,KAAK,QAAQ,UAAU,EAE5C,GAAG,kBAAkB,IAAI,CAAC,QAAgCA,IAAAA,MAAM,GAAG,CAAC,GACpE,MAAM;AAEP,YAAM,QAAK;AAAA,aACH,KAAK;AACb,YAAM,QAAK;AACX,YAAM,QAAQ;AAAA,IACf;AAAA,EAAA;AAID,QAAM,UAAU,KAAK,OAAO,CAAC,QAAQC,IAAA,MAAM,GAAG,CAAC;AAC/C,MAAI,QAAQ,QAAQ;AACnBC,QAAA,MAAM,SAAS,SAAS,EAAE,MAAM,KAAM,CAAA;AAAA,EACvC;;AAKA,SAAO,EAAE,OAAO,MAAM,OAAO,QAAO;AACrC;;"}
+{"version":3,"file":"useStatefulPrismicClientMethod.cjs","sources":["../../src/useStatefulPrismicClientMethod.ts"],"sourcesContent":["import type {\n\tClient,\n\tForbiddenError,\n\tParsingError,\n\tPrismicError,\n} from \"@prismicio/client\"\nimport type { Ref } from \"vue\"\nimport { isRef, ref, shallowRef, unref, watch } from \"vue\"\n\nimport type { VueUseParameters } from \"./types\"\nimport { PrismicClientComposableState } from \"./types\"\n\nimport { usePrismic } from \"./usePrismic\"\n\n// Helpers\ntype UnwrapPromise<T> = T extends Promise<infer U> ? U : T\n// eslint-disable-next-line @typescript-eslint/no-explicit-any\ntype ClientMethodLike = (...args: any[]) => Promise<any> | any\ntype ClientMethods = typeof Client.prototype\ntype ClientError = PrismicError<unknown> | ParsingError | ForbiddenError\n\n// Interfaces\n\n/**\n * @internal\n */\nexport type ClientMethodParameters<TMethodName extends keyof ClientMethods> =\n\tClientMethods[TMethodName] extends ClientMethodLike\n\t\t? VueUseParameters<Parameters<ClientMethods[TMethodName]>>\n\t\t: never\n\n/**\n * @internal\n */\nexport type ClientMethodReturnType<TMethodName extends keyof ClientMethods> =\n\tClientMethods[TMethodName] extends ClientMethodLike\n\t\t? ReturnType<ClientMethods[TMethodName]>\n\t\t: never\n\n/**\n * @internal\n */\nexport type ComposableOnlyParameters = {\n\tclient?: Ref<Client> | Client\n}\n\n/**\n * The return type of a `@prismicio/client` Vue composable.\n *\n * @typeParam TData - The expected format of the `data` property of the returned\n *   object\n */\nexport type ClientComposableReturnType<TData = unknown> = {\n\t/**\n\t * The current state of the composable's client method call.\n\t */\n\tstate: Ref<PrismicClientComposableState>\n\n\t/**\n\t * Data returned by the client.\n\t */\n\tdata: Ref<TData | null>\n\n\t/**\n\t * Error returned by the composable's client method call if in an errror\n\t * state.\n\t */\n\terror: Ref<ClientError | Error | null>\n\n\t/**\n\t * Perform the composable's client method call again.\n\t */\n\trefresh: () => Promise<void>\n}\n\n/**\n * Determines if a value is a `@prismicio/client` params object.\n *\n * @param value - The value to check\n *\n * @returns `true` if `value` is a `@prismicio/client` params object, `false`\n *   otherwise\n */\nconst isParams = (\n\tvalue: unknown,\n): value is ClientMethodParameters<\"get\">[0] & ComposableOnlyParameters => {\n\t// This is a *very* naive check.\n\treturn typeof value === \"object\" && value !== null && !Array.isArray(value)\n}\n\n/**\n * A low level Vue composable that uses provided method name on plugin or\n * provided client with given arguments. The composable has its own internal\n * state manager to report async status, such as pending or error statuses.\n *\n * @typeParam TClientMethodName - A method name from `@prismicio/client`\n * @typeParam TClientMethodArguments - The method expected arguments\n * @typeParam TClientMethodReturnType - The method expected return type\n *\n * @param method - The `@prismicio/client` method name to use\n * @param args - The arguments to use with requested method\n *\n * @returns The composable payload {@link ClientComposableReturnType}\n *\n * @internal\n */\nexport const useStatefulPrismicClientMethod = <\n\tTClientMethodName extends keyof ClientMethods,\n\tTClientMethodArguments extends ClientMethodParameters<TClientMethodName>,\n\tTClientMethodReturnType extends UnwrapPromise<\n\t\tClientMethodReturnType<TClientMethodName>\n\t>,\n>(\n\tmethodName: TClientMethodName,\n\targs: TClientMethodArguments,\n): ClientComposableReturnType<TClientMethodReturnType> => {\n\tconst { client } = usePrismic()\n\n\tconst state = ref<PrismicClientComposableState>(\n\t\tPrismicClientComposableState.Idle,\n\t)\n\tconst data = shallowRef<TClientMethodReturnType | null>(null)\n\tconst error = ref<ClientError | Error | null>(null)\n\tconst refresh = async (): Promise<void> => {\n\t\tconst lastArg = unref(args[args.length - 1])\n\t\tconst { client: explicitClient, ...params } = isParams(lastArg)\n\t\t\t? (lastArg as ClientMethodParameters<\"get\">[0] & ComposableOnlyParameters)\n\t\t\t: ({} as ComposableOnlyParameters)\n\t\tconst argsWithoutParams = isParams(lastArg) ? args.slice(0, -1) : args\n\n\t\tstate.value = PrismicClientComposableState.Pending\n\t\tdata.value = null\n\t\terror.value = null\n\t\ttry {\n\t\t\tdata.value = await (\n\t\t\t\t(unref(explicitClient) || client)[methodName] as ClientMethodLike\n\t\t\t)(\n\t\t\t\t...argsWithoutParams.map((arg: Ref<unknown> | unknown) => unref(arg)),\n\t\t\t\tparams,\n\t\t\t)\n\t\t\tstate.value = PrismicClientComposableState.Success\n\t\t} catch (err) {\n\t\t\tstate.value = PrismicClientComposableState.Error\n\t\t\terror.value = err as ClientError | Error\n\t\t}\n\t}\n\n\t// Watch reactive args\n\tconst refArgs = args.filter((arg) => isRef(arg))\n\tif (refArgs.length) {\n\t\twatch(refArgs, refresh, { deep: true })\n\t}\n\n\t// Fetch once\n\trefresh()\n\n\treturn { state, data, error, refresh }\n}\n"],"names":["usePrismic","ref","shallowRef","unref","isRef","watch"],"mappings":";;;;AAmFA,MAAM,WAAW,CAChB,UACyE;AAElE,SAAA,OAAO,UAAU,YAAY,UAAU,QAAQ,CAAC,MAAM,QAAQ,KAAK;AAC3E;AAkBa,MAAA,iCAAiC,CAO7C,YACA,SACwD;AAClD,QAAA,EAAE,OAAM,IAAKA;AAEnB,QAAM,QAAQC,IAAA;AAAA,IAAG;AAAA;AAAA,EAAA;AAGX,QAAA,OAAOC,eAA2C,IAAI;AACtD,QAAA,QAAQD,QAAgC,IAAI;AAClD,QAAM,UAAU,YAA0B;AACzC,UAAM,UAAUE,IAAAA,MAAM,KAAK,KAAK,SAAS,CAAC,CAAC;AACrC,UAAA,EAAE,QAAQ,gBAAgB,GAAG,WAAW,SAAS,OAAO,IAC1D,UACA;AACE,UAAA,oBAAoB,SAAS,OAAO,IAAI,KAAK,MAAM,GAAG,EAAE,IAAI;AAElE,UAAM,QAAK;AACX,SAAK,QAAQ;AACb,UAAM,QAAQ;AACV,QAAA;AACH,WAAK,QAAQ,OACXA,IAAA,MAAM,cAAc,KAAK,QAAQ,UAAU,EAE5C,GAAG,kBAAkB,IAAI,CAAC,QAAgCA,UAAM,GAAG,CAAC,GACpE,MAAM;AAEP,YAAM,QAAK;AAAA,aACH,KAAK;AACb,YAAM,QAAK;AACX,YAAM,QAAQ;AAAA,IAAA;AAAA,EAEhB;AAGA,QAAM,UAAU,KAAK,OAAO,CAAC,QAAQC,IAAAA,MAAM,GAAG,CAAC;AAC/C,MAAI,QAAQ,QAAQ;AACnBC,QAAAA,MAAM,SAAS,SAAS,EAAE,MAAM,MAAM;AAAA,EAAA;;AAMvC,SAAO,EAAE,OAAO,MAAM,OAAO,QAAO;AACrC;;"}

package/dist/useStatefulPrismicClientMethod.d.ts

@@ -1,6 +1,7 @@
-import { Client, ForbiddenError, ParsingError, PrismicError } from "@prismicio/client";
-import { Ref } from "vue";
-import { PrismicClientComposableState, VueUseParameters } from "./types";
+import type { Client, ForbiddenError, ParsingError, PrismicError } from "@prismicio/client";
+import type { Ref } from "vue";
+import type { VueUseParameters } from "./types";
+import { PrismicClientComposableState } from "./types";
 type UnwrapPromise<T> = T extends Promise<infer U> ? U : T;
 type ClientMethodLike = (...args: any[]) => Promise<any> | any;
 type ClientMethods = typeof Client.prototype;

package/dist/useStatefulPrismicClientMethod.js.map

@@ -1 +1 @@
-{"version":3,"file":"useStatefulPrismicClientMethod.js","sources":["../../src/useStatefulPrismicClientMethod.ts"],"sourcesContent":["import {\n\tClient,\n\tForbiddenError,\n\tParsingError,\n\tPrismicError,\n} from \"@prismicio/client\";\nimport { Ref, isRef, ref, shallowRef, unref, watch } from \"vue\";\n\nimport { PrismicClientComposableState, VueUseParameters } from \"./types\";\n\nimport { usePrismic } from \"./usePrismic\";\n\n// Helpers\ntype UnwrapPromise<T> = T extends Promise<infer U> ? U : T;\n// eslint-disable-next-line @typescript-eslint/no-explicit-any\ntype ClientMethodLike = (...args: any[]) => Promise<any> | any;\ntype ClientMethods = typeof Client.prototype;\ntype ClientError = PrismicError<unknown> | ParsingError | ForbiddenError;\n\n// Interfaces\n\n/**\n * @internal\n */\nexport type ClientMethodParameters<TMethodName extends keyof ClientMethods> =\n\tClientMethods[TMethodName] extends ClientMethodLike\n\t\t? VueUseParameters<Parameters<ClientMethods[TMethodName]>>\n\t\t: never;\n\n/**\n * @internal\n */\nexport type ClientMethodReturnType<TMethodName extends keyof ClientMethods> =\n\tClientMethods[TMethodName] extends ClientMethodLike\n\t\t? ReturnType<ClientMethods[TMethodName]>\n\t\t: never;\n\n/**\n * @internal\n */\nexport type ComposableOnlyParameters = {\n\tclient?: Ref<Client> | Client;\n};\n\n/**\n * The return type of a `@prismicio/client` Vue composable.\n *\n * @typeParam TData - The expected format of the `data` property of the returned\n *   object\n */\nexport type ClientComposableReturnType<TData = unknown> = {\n\t/**\n\t * The current state of the composable's client method call.\n\t */\n\tstate: Ref<PrismicClientComposableState>;\n\n\t/**\n\t * Data returned by the client.\n\t */\n\tdata: Ref<TData | null>;\n\n\t/**\n\t * Error returned by the composable's client method call if in an errror\n\t * state.\n\t */\n\terror: Ref<ClientError | Error | null>;\n\n\t/**\n\t * Perform the composable's client method call again.\n\t */\n\trefresh: () => Promise<void>;\n};\n\n/**\n * Determines if a value is a `@prismicio/client` params object.\n *\n * @param value - The value to check\n *\n * @returns `true` if `value` is a `@prismicio/client` params object, `false`\n *   otherwise\n */\nconst isParams = (\n\tvalue: unknown,\n): value is ClientMethodParameters<\"get\">[0] & ComposableOnlyParameters => {\n\t// This is a *very* naive check.\n\treturn typeof value === \"object\" && value !== null && !Array.isArray(value);\n};\n\n/**\n * A low level Vue composable that uses provided method name on plugin or\n * provided client with given arguments. The composable has its own internal\n * state manager to report async status, such as pending or error statuses.\n *\n * @typeParam TClientMethodName - A method name from `@prismicio/client`\n * @typeParam TClientMethodArguments - The method expected arguments\n * @typeParam TClientMethodReturnType - The method expected return type\n *\n * @param method - The `@prismicio/client` method name to use\n * @param args - The arguments to use with requested method\n *\n * @returns The composable payload {@link ClientComposableReturnType}\n *\n * @internal\n */\nexport const useStatefulPrismicClientMethod = <\n\tTClientMethodName extends keyof ClientMethods,\n\tTClientMethodArguments extends ClientMethodParameters<TClientMethodName>,\n\tTClientMethodReturnType extends UnwrapPromise<\n\t\tClientMethodReturnType<TClientMethodName>\n\t>,\n>(\n\tmethodName: TClientMethodName,\n\targs: TClientMethodArguments,\n): ClientComposableReturnType<TClientMethodReturnType> => {\n\tconst { client } = usePrismic();\n\n\tconst state = ref<PrismicClientComposableState>(\n\t\tPrismicClientComposableState.Idle,\n\t);\n\tconst data = shallowRef<TClientMethodReturnType | null>(null);\n\tconst error = ref<ClientError | Error | null>(null);\n\tconst refresh = async (): Promise<void> => {\n\t\tconst lastArg = unref(args[args.length - 1]);\n\t\tconst { client: explicitClient, ...params } = isParams(lastArg)\n\t\t\t? (lastArg as ClientMethodParameters<\"get\">[0] & ComposableOnlyParameters)\n\t\t\t: ({} as ComposableOnlyParameters);\n\t\tconst argsWithoutParams = isParams(lastArg) ? args.slice(0, -1) : args;\n\n\t\tstate.value = PrismicClientComposableState.Pending;\n\t\tdata.value = null;\n\t\terror.value = null;\n\t\ttry {\n\t\t\tdata.value = await (\n\t\t\t\t(unref(explicitClient) || client)[methodName] as ClientMethodLike\n\t\t\t)(\n\t\t\t\t...argsWithoutParams.map((arg: Ref<unknown> | unknown) => unref(arg)),\n\t\t\t\tparams,\n\t\t\t);\n\t\t\tstate.value = PrismicClientComposableState.Success;\n\t\t} catch (err) {\n\t\t\tstate.value = PrismicClientComposableState.Error;\n\t\t\terror.value = err as ClientError | Error;\n\t\t}\n\t};\n\n\t// Watch reactive args\n\tconst refArgs = args.filter((arg) => isRef(arg));\n\tif (refArgs.length) {\n\t\twatch(refArgs, refresh, { deep: true });\n\t}\n\n\t// Fetch once\n\trefresh();\n\n\treturn { state, data, error, refresh };\n};\n"],"names":[],"mappings":";;AAiFA,MAAM,WAAW,CAChB,UACyE;AAElE,SAAA,OAAO,UAAU,YAAY,UAAU,QAAQ,CAAC,MAAM,QAAQ,KAAK;AAC3E;AAkBa,MAAA,iCAAiC,CAO7C,YACA,SACwD;AAClD,QAAA,EAAE,WAAW;AAEnB,QAAM,QAAQ;AAAA,IAAG;AAAA;AAAA,EAAA;AAGX,QAAA,OAAO,WAA2C,IAAI;AACtD,QAAA,QAAQ,IAAgC,IAAI;AAClD,QAAM,UAAU,YAA0B;AACzC,UAAM,UAAU,MAAM,KAAK,KAAK,SAAS,CAAC,CAAC;AACrC,UAAA,EAAE,QAAQ,gBAAgB,GAAG,OAAA,IAAW,SAAS,OAAO,IAC1D,UACA;AACE,UAAA,oBAAoB,SAAS,OAAO,IAAI,KAAK,MAAM,GAAG,EAAE,IAAI;AAElE,UAAM,QAAK;AACX,SAAK,QAAQ;AACb,UAAM,QAAQ;AACV,QAAA;AACH,WAAK,QAAQ,OACX,MAAM,cAAc,KAAK,QAAQ,UAAU,EAE5C,GAAG,kBAAkB,IAAI,CAAC,QAAgC,MAAM,GAAG,CAAC,GACpE,MAAM;AAEP,YAAM,QAAK;AAAA,aACH,KAAK;AACb,YAAM,QAAK;AACX,YAAM,QAAQ;AAAA,IACf;AAAA,EAAA;AAID,QAAM,UAAU,KAAK,OAAO,CAAC,QAAQ,MAAM,GAAG,CAAC;AAC/C,MAAI,QAAQ,QAAQ;AACnB,UAAM,SAAS,SAAS,EAAE,MAAM,KAAM,CAAA;AAAA,EACvC;;AAKA,SAAO,EAAE,OAAO,MAAM,OAAO,QAAO;AACrC;"}
+{"version":3,"file":"useStatefulPrismicClientMethod.js","sources":["../../src/useStatefulPrismicClientMethod.ts"],"sourcesContent":["import type {\n\tClient,\n\tForbiddenError,\n\tParsingError,\n\tPrismicError,\n} from \"@prismicio/client\"\nimport type { Ref } from \"vue\"\nimport { isRef, ref, shallowRef, unref, watch } from \"vue\"\n\nimport type { VueUseParameters } from \"./types\"\nimport { PrismicClientComposableState } from \"./types\"\n\nimport { usePrismic } from \"./usePrismic\"\n\n// Helpers\ntype UnwrapPromise<T> = T extends Promise<infer U> ? U : T\n// eslint-disable-next-line @typescript-eslint/no-explicit-any\ntype ClientMethodLike = (...args: any[]) => Promise<any> | any\ntype ClientMethods = typeof Client.prototype\ntype ClientError = PrismicError<unknown> | ParsingError | ForbiddenError\n\n// Interfaces\n\n/**\n * @internal\n */\nexport type ClientMethodParameters<TMethodName extends keyof ClientMethods> =\n\tClientMethods[TMethodName] extends ClientMethodLike\n\t\t? VueUseParameters<Parameters<ClientMethods[TMethodName]>>\n\t\t: never\n\n/**\n * @internal\n */\nexport type ClientMethodReturnType<TMethodName extends keyof ClientMethods> =\n\tClientMethods[TMethodName] extends ClientMethodLike\n\t\t? ReturnType<ClientMethods[TMethodName]>\n\t\t: never\n\n/**\n * @internal\n */\nexport type ComposableOnlyParameters = {\n\tclient?: Ref<Client> | Client\n}\n\n/**\n * The return type of a `@prismicio/client` Vue composable.\n *\n * @typeParam TData - The expected format of the `data` property of the returned\n *   object\n */\nexport type ClientComposableReturnType<TData = unknown> = {\n\t/**\n\t * The current state of the composable's client method call.\n\t */\n\tstate: Ref<PrismicClientComposableState>\n\n\t/**\n\t * Data returned by the client.\n\t */\n\tdata: Ref<TData | null>\n\n\t/**\n\t * Error returned by the composable's client method call if in an errror\n\t * state.\n\t */\n\terror: Ref<ClientError | Error | null>\n\n\t/**\n\t * Perform the composable's client method call again.\n\t */\n\trefresh: () => Promise<void>\n}\n\n/**\n * Determines if a value is a `@prismicio/client` params object.\n *\n * @param value - The value to check\n *\n * @returns `true` if `value` is a `@prismicio/client` params object, `false`\n *   otherwise\n */\nconst isParams = (\n\tvalue: unknown,\n): value is ClientMethodParameters<\"get\">[0] & ComposableOnlyParameters => {\n\t// This is a *very* naive check.\n\treturn typeof value === \"object\" && value !== null && !Array.isArray(value)\n}\n\n/**\n * A low level Vue composable that uses provided method name on plugin or\n * provided client with given arguments. The composable has its own internal\n * state manager to report async status, such as pending or error statuses.\n *\n * @typeParam TClientMethodName - A method name from `@prismicio/client`\n * @typeParam TClientMethodArguments - The method expected arguments\n * @typeParam TClientMethodReturnType - The method expected return type\n *\n * @param method - The `@prismicio/client` method name to use\n * @param args - The arguments to use with requested method\n *\n * @returns The composable payload {@link ClientComposableReturnType}\n *\n * @internal\n */\nexport const useStatefulPrismicClientMethod = <\n\tTClientMethodName extends keyof ClientMethods,\n\tTClientMethodArguments extends ClientMethodParameters<TClientMethodName>,\n\tTClientMethodReturnType extends UnwrapPromise<\n\t\tClientMethodReturnType<TClientMethodName>\n\t>,\n>(\n\tmethodName: TClientMethodName,\n\targs: TClientMethodArguments,\n): ClientComposableReturnType<TClientMethodReturnType> => {\n\tconst { client } = usePrismic()\n\n\tconst state = ref<PrismicClientComposableState>(\n\t\tPrismicClientComposableState.Idle,\n\t)\n\tconst data = shallowRef<TClientMethodReturnType | null>(null)\n\tconst error = ref<ClientError | Error | null>(null)\n\tconst refresh = async (): Promise<void> => {\n\t\tconst lastArg = unref(args[args.length - 1])\n\t\tconst { client: explicitClient, ...params } = isParams(lastArg)\n\t\t\t? (lastArg as ClientMethodParameters<\"get\">[0] & ComposableOnlyParameters)\n\t\t\t: ({} as ComposableOnlyParameters)\n\t\tconst argsWithoutParams = isParams(lastArg) ? args.slice(0, -1) : args\n\n\t\tstate.value = PrismicClientComposableState.Pending\n\t\tdata.value = null\n\t\terror.value = null\n\t\ttry {\n\t\t\tdata.value = await (\n\t\t\t\t(unref(explicitClient) || client)[methodName] as ClientMethodLike\n\t\t\t)(\n\t\t\t\t...argsWithoutParams.map((arg: Ref<unknown> | unknown) => unref(arg)),\n\t\t\t\tparams,\n\t\t\t)\n\t\t\tstate.value = PrismicClientComposableState.Success\n\t\t} catch (err) {\n\t\t\tstate.value = PrismicClientComposableState.Error\n\t\t\terror.value = err as ClientError | Error\n\t\t}\n\t}\n\n\t// Watch reactive args\n\tconst refArgs = args.filter((arg) => isRef(arg))\n\tif (refArgs.length) {\n\t\twatch(refArgs, refresh, { deep: true })\n\t}\n\n\t// Fetch once\n\trefresh()\n\n\treturn { state, data, error, refresh }\n}\n"],"names":[],"mappings":";;AAmFA,MAAM,WAAW,CAChB,UACyE;AAElE,SAAA,OAAO,UAAU,YAAY,UAAU,QAAQ,CAAC,MAAM,QAAQ,KAAK;AAC3E;AAkBa,MAAA,iCAAiC,CAO7C,YACA,SACwD;AAClD,QAAA,EAAE,OAAM,IAAK;AAEnB,QAAM,QAAQ;AAAA,IAAG;AAAA;AAAA,EAAA;AAGX,QAAA,OAAO,WAA2C,IAAI;AACtD,QAAA,QAAQ,IAAgC,IAAI;AAClD,QAAM,UAAU,YAA0B;AACzC,UAAM,UAAU,MAAM,KAAK,KAAK,SAAS,CAAC,CAAC;AACrC,UAAA,EAAE,QAAQ,gBAAgB,GAAG,WAAW,SAAS,OAAO,IAC1D,UACA;AACE,UAAA,oBAAoB,SAAS,OAAO,IAAI,KAAK,MAAM,GAAG,EAAE,IAAI;AAElE,UAAM,QAAK;AACX,SAAK,QAAQ;AACb,UAAM,QAAQ;AACV,QAAA;AACH,WAAK,QAAQ,OACX,MAAM,cAAc,KAAK,QAAQ,UAAU,EAE5C,GAAG,kBAAkB,IAAI,CAAC,QAAgC,MAAM,GAAG,CAAC,GACpE,MAAM;AAEP,YAAM,QAAK;AAAA,aACH,KAAK;AACb,YAAM,QAAK;AACX,YAAM,QAAQ;AAAA,IAAA;AAAA,EAEhB;AAGA,QAAM,UAAU,KAAK,OAAO,CAAC,QAAQ,MAAM,GAAG,CAAC;AAC/C,MAAI,QAAQ,QAAQ;AACnB,UAAM,SAAS,SAAS,EAAE,MAAM,MAAM;AAAA,EAAA;;AAMvC,SAAO,EAAE,OAAO,MAAM,OAAO,QAAO;AACrC;"}

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@prismicio/vue",
-	"version": "4.3.0",
+	"version": "4.3.1",
 	"description": "Vue plugin, components, and composables to fetch and present Prismic content",
 	"keywords": [
 		"typescript",
@@ -48,47 +48,46 @@
 		"release:dry": "standard-version --dry-run",
 		"release:beta": "npm run test && standard-version --release-as major --prerelease beta && git push --follow-tags && npm run build && npm publish --tag beta",
 		"release:beta:dry": "standard-version --release-as major --prerelease beta --dry-run",
-		"lint": "eslint --ext .js,.ts .",
-		"types": "vitest typecheck --run && tsc --noEmit",
-		"types:watch": "vitest typecheck",
+		"lint": "eslint",
+		"types": "vitest --typecheck.only --run && tsc --noEmit",
+		"types:watch": "vitest --typecheck.only",
 		"unit": "vitest run --coverage",
 		"unit:watch": "vitest watch",
 		"size": "size-limit",
 		"test": "npm run lint && npm run types && npm run unit && npm run build && npm run size"
 	},
 	"dependencies": {
-		"@prismicio/client": "^7.11.0",
+		"@prismicio/client": "^7.12.0",
 		"isomorphic-unfetch": "^3.1.0",
-		"vue-router": "^4.4.3"
+		"vue-router": "^4.5.0"
 	},
 	"devDependencies": {
-		"@prismicio/mock": "0.4.0",
-		"@size-limit/preset-small-lib": "^8.2.6",
+		"@eslint/js": "^9.16.0",
+		"@prismicio/mock": "^0.4.0",
+		"@size-limit/preset-small-lib": "^11.1.6",
 		"@trivago/prettier-plugin-sort-imports": "^4.3.0",
 		"@types/jsdom-global": "^3.0.7",
-		"@typescript-eslint/eslint-plugin": "^5.62.0",
-		"@typescript-eslint/parser": "^5.62.0",
-		"@vitejs/plugin-vue": "^4.6.2",
-		"@vitest/coverage-v8": "^0.34.6",
-		"@vue/compiler-sfc": "^3.4.38",
-		"@vue/eslint-config-typescript": "^11.0.3",
+		"@vitejs/plugin-vue": "^5.2.1",
+		"@vitest/coverage-v8": "^2.1.8",
+		"@vue/eslint-config-typescript": "^14.1.4",
 		"@vue/test-utils": "^2.4.6",
-		"eslint": "^8.57.0",
-		"eslint-config-prettier": "^8.10.0",
-		"eslint-plugin-prettier": "^4.2.1",
-		"eslint-plugin-tsdoc": "^0.2.17",
-		"eslint-plugin-vue": "^9.27.0",
-		"jsdom": "^24.0.0",
+		"eslint": "^9.16.0",
+		"eslint-config-prettier": "^9.1.0",
+		"eslint-plugin-prettier": "^5.2.1",
+		"eslint-plugin-tsdoc": "^0.4.0",
+		"eslint-plugin-vue": "^9.32.0",
+		"jsdom": "^25.0.1",
 		"jsdom-global": "^3.0.2",
-		"prettier": "^2.8.8",
-		"prettier-plugin-jsdoc": "^0.4.2",
-		"size-limit": "^8.2.6",
+		"prettier": "^3.4.1",
+		"prettier-plugin-jsdoc": "^1.3.0",
+		"size-limit": "^11.1.6",
 		"standard-version": "^9.5.0",
-		"typescript": "^5.5.4",
-		"vite": "^5.4.2",
-		"vite-plugin-sdk": "^0.1.2",
-		"vitest": "^0.34.6",
-		"vue": "^3.4.38"
+		"typescript": "^5.7.2",
+		"typescript-eslint": "^8.17.0",
+		"vite": "^6.0.2",
+		"vite-plugin-sdk": "^0.1.3",
+		"vitest": "^2.1.8",
+		"vue": "^3.5.13"
 	},
 	"peerDependencies": {
 		"vue": "^3.0.0"

package/src/components/PrismicEmbed.ts

@@ -1,5 +1,5 @@
-import { EmbedField } from "@prismicio/client";
-import {
+import type { EmbedField } from "@prismicio/client"
+import type {
 	AllowedComponentProps,
 	ComponentCustomProps,
 	ConcreteComponent,
@@ -7,16 +7,15 @@ import {
 	PropType,
 	Raw,
 	VNodeProps,
-	defineComponent,
-	h,
-} from "vue";
+} from "vue"
+import { defineComponent, h } from "vue"
 
-import { simplyResolveComponent } from "../lib/simplyResolveComponent";
+import { simplyResolveComponent } from "../lib/simplyResolveComponent"
 
 /**
  * The default component rendered to wrap the embed.
  */
-const defaultWrapper = "div";
+const defaultWrapper = "div"
 
 /**
  * Props for `<PrismicEmbed />`.
@@ -25,7 +24,7 @@ export type PrismicEmbedProps = {
 	/**
 	 * The Prismic embed field to render.
 	 */
-	field: EmbedField;
+	field: EmbedField
 
 	/**
 	 * An HTML tag name, a component, or a functional component used to wrap the
@@ -33,8 +32,8 @@ export type PrismicEmbedProps = {
 	 *
 	 * @defaultValue `"div"`
 	 */
-	wrapper?: string | ConcreteComponent | Raw<DefineComponent>;
-};
+	wrapper?: string | ConcreteComponent | Raw<DefineComponent>
+}
 
 /**
  * `<PrismicEmbed />` implementation.
@@ -59,7 +58,7 @@ export const PrismicEmbedImpl = /*#__PURE__*/ defineComponent({
 	setup(props) {
 		// Prevent fatal if user didn't check for field, throws `Invalid prop` warn
 		if (!props.field) {
-			return () => null;
+			return () => null
 		}
 
 		return () => {
@@ -68,10 +67,10 @@ export const PrismicEmbedImpl = /*#__PURE__*/ defineComponent({
 				"data-oembed-type": props.field.type,
 				"data-oembed-provider": props.field.provider_name,
 				innerHTML: props.field.html || null,
-			});
-		};
+			})
+		}
 	},
-});
+})
 
 // export the public type for h/tsx inference
 // also to avoid inline import() in generated d.ts files
@@ -86,6 +85,6 @@ export const PrismicEmbed = PrismicEmbedImpl as unknown as {
 		$props: AllowedComponentProps &
 			ComponentCustomProps &
 			VNodeProps &
-			PrismicEmbedProps;
-	};
-};
+			PrismicEmbedProps
+	}
+}

package/src/components/PrismicImage.ts

@@ -1,11 +1,11 @@
+import type { ImageField } from "@prismicio/client"
 import {
-	ImageField,
 	asImagePixelDensitySrcSet,
 	asImageSrc,
 	asImageWidthSrcSet,
 	isFilled,
-} from "@prismicio/client";
-import {
+} from "@prismicio/client"
+import type {
 	AllowedComponentProps,
 	ComponentCustomProps,
 	ComputedRef,
@@ -14,23 +14,20 @@ import {
 	PropType,
 	Raw,
 	VNodeProps,
-	computed,
-	defineComponent,
-	h,
-	unref,
-} from "vue";
+} from "vue"
+import { computed, defineComponent, h, unref } from "vue"
 
-import { __PRODUCTION__ } from "../lib/__PRODUCTION__";
-import { simplyResolveComponent } from "../lib/simplyResolveComponent";
+import { __PRODUCTION__ } from "../lib/__PRODUCTION__"
+import { simplyResolveComponent } from "../lib/simplyResolveComponent"
 
-import { VueUseOptions } from "../types";
+import type { VueUseOptions } from "../types"
 
-import { usePrismic } from "../usePrismic";
+import { usePrismic } from "../usePrismic"
 
 /**
  * The default component rendered for images.
  */
-const defaultImageComponent = "img";
+const defaultImageComponent = "img"
 
 /**
  * Props for `<PrismicImage />`.
@@ -39,7 +36,7 @@ export type PrismicImageProps = {
 	/**
 	 * The Prismic image field to render.
 	 */
-	field: ImageField | ImageField<string>;
+	field: ImageField | ImageField<string>
 
 	/**
 	 * An HTML tag name, a component, or a functional component used to render
@@ -49,16 +46,17 @@ export type PrismicImageProps = {
 	 * HTML tag names and components will be rendered using the `img` tag
 	 * interface (`src`, `srcset`, and `alt` attribute). Components will also
 	 * receive an additional `copyright` props.
+	 *
 	 * @defaultValue The one provided to `@prismicio/vue` plugin if configured, `"img"` otherwise.
 	 */
-	imageComponent?: string | ConcreteComponent | Raw<DefineComponent>;
+	imageComponent?: string | ConcreteComponent | Raw<DefineComponent>
 
 	/**
 	 * An object of Imgix URL API parameters.
 	 *
 	 * @see Imgix URL parameters reference: https://docs.imgix.com/apis/rendering
 	 */
-	imgixParams?: Parameters<typeof asImageSrc>[1];
+	imgixParams?: Parameters<typeof asImageSrc>[1]
 
 	/**
 	 * Adds an additional `srcset` attribute to the image following given widths.
@@ -76,7 +74,7 @@ export type PrismicImageProps = {
 	widths?:
 		| NonNullable<Parameters<typeof asImageWidthSrcSet>[1]>["widths"]
 		| "thumbnails"
-		| "defaults";
+		| "defaults"
 
 	/**
 	 * Adds an additional `srcset` attribute to the image following giving pixel
@@ -93,15 +91,15 @@ export type PrismicImageProps = {
 		| NonNullable<
 				Parameters<typeof asImagePixelDensitySrcSet>[1]
 		  >["pixelDensities"]
-		| "defaults";
-};
+		| "defaults"
+}
 
 /**
  * Options for {@link usePrismicImage}.
  */
 export type UsePrismicImageOptions = VueUseOptions<
 	Omit<PrismicImageProps, "imageComponent">
->;
+>
 
 /**
  * Return type of {@link usePrismicImage}.
@@ -110,23 +108,23 @@ export type UsePrismicImageReturnType = {
 	/**
 	 * Resolved image `src` value.
 	 */
-	src: ComputedRef<string | null>;
+	src: ComputedRef<string | null>
 
 	/**
 	 * Resolved image `srcset` value.
 	 */
-	srcset: ComputedRef<string | null>;
+	srcset: ComputedRef<string | null>
 
 	/**
 	 * Resolved image `alt` value.
 	 */
-	alt: ComputedRef<string>;
+	alt: ComputedRef<string>
 
 	/**
 	 * Resolved image `copyright` value.
 	 */
-	copyright: ComputedRef<string | null>;
-};
+	copyright: ComputedRef<string | null>
+}
 
 /**
  * A low level composable that returns a resolved information about a Prismic
@@ -139,28 +137,28 @@ export type UsePrismicImageReturnType = {
 export const usePrismicImage = (
 	props: UsePrismicImageOptions,
 ): UsePrismicImageReturnType => {
-	const { options } = usePrismic();
+	const { options } = usePrismic()
 
 	const asImage = computed(() => {
-		const field = unref(props.field);
+		const field = unref(props.field)
 
 		if (!isFilled.image(field)) {
 			return {
 				src: null,
 				srcset: null,
-			};
+			}
 		}
 
-		const imgixParams = unref(props.imgixParams);
-		const widths = unref(props.widths);
-		const pixelDensities = unref(props.pixelDensities);
+		const imgixParams = unref(props.imgixParams)
+		const widths = unref(props.widths)
+		const pixelDensities = unref(props.pixelDensities)
 
 		if (widths) {
 			if (!__PRODUCTION__ && pixelDensities) {
 				console.warn(
 					"[PrismicImage] Only one of `widths` or `pixelDensities` props can be provided. You can resolve this warning by removing either the `widths` or `pixelDensities` prop. `widths` will be used in this case.",
 					props,
-				);
+				)
 			}
 
 			return asImageWidthSrcSet(field, {
@@ -169,7 +167,7 @@ export const usePrismicImage = (
 					widths === "defaults"
 						? options.components?.imageWidthSrcSetDefaults
 						: widths,
-			});
+			})
 		} else if (pixelDensities) {
 			return asImagePixelDensitySrcSet(field, {
 				...imgixParams,
@@ -177,35 +175,35 @@ export const usePrismicImage = (
 					pixelDensities === "defaults"
 						? options.components?.imagePixelDensitySrcSetDefaults
 						: pixelDensities,
-			});
+			})
 		} else {
 			return {
 				src: asImageSrc(field, imgixParams),
 				srcset: null,
-			};
+			}
 		}
-	});
+	})
 
 	const src = computed(() => {
-		return asImage.value.src;
-	});
+		return asImage.value.src
+	})
 	const srcset = computed(() => {
-		return asImage.value.srcset;
-	});
+		return asImage.value.srcset
+	})
 	const alt = computed(() => {
-		return unref(props.field).alt || "";
-	});
+		return unref(props.field).alt || ""
+	})
 	const copyright = computed(() => {
-		return unref(props.field).copyright || null;
-	});
+		return unref(props.field).copyright || null
+	})
 
 	return {
 		src,
 		srcset,
 		alt,
 		copyright,
-	};
-};
+	}
+}
 
 /**
  * `<PrismicImage />` implementation.
@@ -254,42 +252,42 @@ export const PrismicImageImpl = /*#__PURE__*/ defineComponent({
 	setup(props) {
 		// Prevent fatal if user didn't check for field, throws `Invalid prop` warn
 		if (!props.field) {
-			return () => null;
+			return () => null
 		}
 
-		const { options } = usePrismic();
+		const { options } = usePrismic()
 
 		const type = computed(() => {
 			return (
 				props.imageComponent ||
 				options.components?.imageComponent ||
 				defaultImageComponent
-			);
-		});
+			)
+		})
 
-		const { src, srcset, alt, copyright } = usePrismicImage(props);
+		const { src, srcset, alt, copyright } = usePrismicImage(props)
 
 		return () => {
 			const attributes = {
 				src: src.value,
 				srcset: srcset.value,
 				alt: alt.value,
-			};
+			}
 
 			switch (type.value) {
 				case "img":
 					// Fitting img tag interface
-					return h("img", attributes);
+					return h("img", attributes)
 
 				default:
 					return h(simplyResolveComponent(type.value), {
 						...attributes,
 						copyright: copyright.value,
-					});
+					})
 			}
-		};
+		}
 	},
-});
+})
 
 // export the public type for h/tsx inference
 // also to avoid inline import() in generated d.ts files
@@ -304,6 +302,6 @@ export const PrismicImage = PrismicImageImpl as unknown as {
 		$props: AllowedComponentProps &
 			ComponentCustomProps &
 			VNodeProps &
-			PrismicImageProps;
-	};
-};
+			PrismicImageProps
+	}
+}