@prismicio/vue 4.3.0 → 5.0.0-alpha.0

package/src/useStatefulPrismicClientMethod.ts

@@ -1,156 +0,0 @@
-import {
-	Client,
-	ForbiddenError,
-	ParsingError,
-	PrismicError,
-} from "@prismicio/client";
-import { Ref, isRef, ref, shallowRef, unref, watch } from "vue";
-
-import { PrismicClientComposableState, VueUseParameters } from "./types";
-
-import { usePrismic } from "./usePrismic";
-
-// Helpers
-type UnwrapPromise<T> = T extends Promise<infer U> ? U : T;
-// eslint-disable-next-line @typescript-eslint/no-explicit-any
-type ClientMethodLike = (...args: any[]) => Promise<any> | any;
-type ClientMethods = typeof Client.prototype;
-type ClientError = PrismicError<unknown> | ParsingError | ForbiddenError;
-
-// Interfaces
-
-/**
- * @internal
- */
-export type ClientMethodParameters<TMethodName extends keyof ClientMethods> =
-	ClientMethods[TMethodName] extends ClientMethodLike
-		? VueUseParameters<Parameters<ClientMethods[TMethodName]>>
-		: never;
-
-/**
- * @internal
- */
-export type ClientMethodReturnType<TMethodName extends keyof ClientMethods> =
-	ClientMethods[TMethodName] extends ClientMethodLike
-		? ReturnType<ClientMethods[TMethodName]>
-		: never;
-
-/**
- * @internal
- */
-export type ComposableOnlyParameters = {
-	client?: Ref<Client> | Client;
-};
-
-/**
- * The return type of a `@prismicio/client` Vue composable.
- *
- * @typeParam TData - The expected format of the `data` property of the returned
- *   object
- */
-export type ClientComposableReturnType<TData = unknown> = {
-	/**
-	 * The current state of the composable's client method call.
-	 */
-	state: Ref<PrismicClientComposableState>;
-
-	/**
-	 * Data returned by the client.
-	 */
-	data: Ref<TData | null>;
-
-	/**
-	 * Error returned by the composable's client method call if in an errror
-	 * state.
-	 */
-	error: Ref<ClientError | Error | null>;
-
-	/**
-	 * Perform the composable's client method call again.
-	 */
-	refresh: () => Promise<void>;
-};
-
-/**
- * Determines if a value is a `@prismicio/client` params object.
- *
- * @param value - The value to check
- *
- * @returns `true` if `value` is a `@prismicio/client` params object, `false`
- *   otherwise
- */
-const isParams = (
-	value: unknown,
-): value is ClientMethodParameters<"get">[0] & ComposableOnlyParameters => {
-	// This is a *very* naive check.
-	return typeof value === "object" && value !== null && !Array.isArray(value);
-};
-
-/**
- * A low level Vue composable that uses provided method name on plugin or
- * provided client with given arguments. The composable has its own internal
- * state manager to report async status, such as pending or error statuses.
- *
- * @typeParam TClientMethodName - A method name from `@prismicio/client`
- * @typeParam TClientMethodArguments - The method expected arguments
- * @typeParam TClientMethodReturnType - The method expected return type
- *
- * @param method - The `@prismicio/client` method name to use
- * @param args - The arguments to use with requested method
- *
- * @returns The composable payload {@link ClientComposableReturnType}
- *
- * @internal
- */
-export const useStatefulPrismicClientMethod = <
-	TClientMethodName extends keyof ClientMethods,
-	TClientMethodArguments extends ClientMethodParameters<TClientMethodName>,
-	TClientMethodReturnType extends UnwrapPromise<
-		ClientMethodReturnType<TClientMethodName>
-	>,
->(
-	methodName: TClientMethodName,
-	args: TClientMethodArguments,
-): ClientComposableReturnType<TClientMethodReturnType> => {
-	const { client } = usePrismic();
-
-	const state = ref<PrismicClientComposableState>(
-		PrismicClientComposableState.Idle,
-	);
-	const data = shallowRef<TClientMethodReturnType | null>(null);
-	const error = ref<ClientError | Error | null>(null);
-	const refresh = async (): Promise<void> => {
-		const lastArg = unref(args[args.length - 1]);
-		const { client: explicitClient, ...params } = isParams(lastArg)
-			? (lastArg as ClientMethodParameters<"get">[0] & ComposableOnlyParameters)
-			: ({} as ComposableOnlyParameters);
-		const argsWithoutParams = isParams(lastArg) ? args.slice(0, -1) : args;
-
-		state.value = PrismicClientComposableState.Pending;
-		data.value = null;
-		error.value = null;
-		try {
-			data.value = await (
-				(unref(explicitClient) || client)[methodName] as ClientMethodLike
-			)(
-				...argsWithoutParams.map((arg: Ref<unknown> | unknown) => unref(arg)),
-				params,
-			);
-			state.value = PrismicClientComposableState.Success;
-		} catch (err) {
-			state.value = PrismicClientComposableState.Error;
-			error.value = err as ClientError | Error;
-		}
-	};
-
-	// Watch reactive args
-	const refArgs = args.filter((arg) => isRef(arg));
-	if (refArgs.length) {
-		watch(refArgs, refresh, { deep: true });
-	}
-
-	// Fetch once
-	refresh();
-
-	return { state, data, error, refresh };
-};

package/vetur/attributes.json

@@ -1,113 +0,0 @@
-{
-	"prismic-embed/field": {
-		"type": "object",
-		"description": "The Prismic embed field to render."
-	},
-	"prismic-embed/wrapper": {
-		"type": "string | object | function",
-		"description": "An HTML tag name, a component, or a functional component used to wrap the output. Defaults to `\"div\"`."
-	},
-	"prismic-image/field": {
-		"type": "object",
-		"description": "The Prismic image field to render."
-	},
-	"prismic-image/image-component": {
-		"type": "string | object | function",
-		"description": "An HTML tag name, a component, or a functional component used to render images. Defaults to the one provided to `@prismicio/vue` plugin if configured, `\"img\"` otherwise."
-	},
-	"prismic-image/imgix-params": {
-		"type": "object",
-		"description": "An object of Imgix URL API parameters."
-	},
-	"prismic-image/widths": {
-		"type": "array | string",
-		"description": "Adds an additional `srcset` attribute to the image following given widths."
-	},
-	"prismic-image/pixel-densities": {
-		"type": "array | string",
-		"description": "Adds an additional `srcset` attribute to the image following giving pixel densities."
-	},
-	"prismic-link/field": {
-		"type": "object",
-		"description": "The Prismic link field or document to render."
-	},
-	"prismic-link/link-resolver": {
-		"type": "function",
-		"description": "A link resolver function used to resolve links when not using the route resolver parameter with `@prismicio/client`. Defaults to the link resolver provided to `@prismicio/vue` plugin if configured."
-	},
-	"prismic-link/target": {
-		"type": "string",
-		"description": "An explicit `target` attribute to apply to the rendered link."
-	},
-	"prismic-link/rel": {
-		"type": "string",
-		"description": "An explicit `rel` attribute to apply to the rendered link."
-	},
-	"prismic-link/blank-target-rel-attribute": {
-		"type": "string",
-		"description": "Value of the `rel` attribute to use on links rendered with `target=\"_blank\"`. Defaults to the one provided to `@prismicio/vue` plugin if configured, `\"noopener noreferrer\"` otherwise."
-	},
-	"prismic-link/internal-component": {
-		"type": "string | object | function",
-		"description": "An HTML tag name, a component, or a functional component used to render internal links. Defaults to the one provided to `@prismicio/vue` plugin if configured, `\"router-link\"` otherwise."
-	},
-	"prismic-link/external-component": {
-		"type": "string | object | function",
-		"description": "An HTML tag name, a component, or a functional component used to render external links. Defaults to the one provided to `@prismicio/vue` plugin if configured, `\"a\"` otherwise."
-	},
-	"prismic-rich-text/field": {
-		"type": "array",
-		"description": "The Prismic rich text or title field to render."
-	},
-	"prismic-rich-text/link-resolver": {
-		"type": "function",
-		"description": "A link resolver function used to resolve links when not using the route resolver parameter with `@prismicio/client`. Defaults to the link resolver provided to `@prismicio/vue` plugin if configured."
-	},
-	"prismic-rich-text/serializer": {
-		"type": "function | object",
-		"description": "An HTML serializer to customize the way rich text fields are rendered. Defaults to the HTML serializer provided to `@prismicio/vue` plugin if configured."
-	},
-	"prismic-rich-text/wrapper": {
-		"type": "string | object | function",
-		"description": "An HTML tag name, a component, or a functional component used to wrap the output. Defaults to `\"div\"`."
-	},
-	"prismic-rich-text/fallback": {
-		"type": "string",
-		"description": "The HTML value to be rendered when the field is empty. If a fallback is not given, `\"\"` (nothing) will be rendered."
-	},
-	"prismic-text/field": {
-		"type": "array",
-		"description": "The Prismic rich text or title field to render."
-	},
-	"prismic-text/separator": {
-		"type": "string",
-		"description": "Separator used to join each element. Defaults to `\" \"` (a space)"
-	},
-	"prismic-text/wrapper": {
-		"type": "string | object | function",
-		"description": "An HTML tag name, a component, or a functional component used to wrap the output. Defaults to `\"div\"`."
-	},
-	"prismic-text/fallback": {
-		"type": "string",
-		"description": "The string value to be rendered when the field is empty. If a fallback is not given, `\"\"` (nothing) will be rendered."
-	},
-	"slice-zone/slices": {
-		"type": "array",
-		"description": "List of Slice data from the Slice Zone."
-	},
-	"slice-zone/components": {
-		"type": "array",
-		"description": "A record mapping Slice types to Vue components."
-	},
-	"slice-zone/context": {
-		"description": "Arbitrary data made available to all Slice components."
-	},
-	"slice-zone/default-component": {
-		"type": "string | object | function",
-		"description": "A component or a functional component rendered if a component mapping from the `components` prop cannot be found. Defaults to the Slice Zone default component provided to `@prismicio/vue` plugin if configured, otherwise `null` when `process.env.NODE_ENV === \"production\"` else `\"todo-slice-component\"`"
-	},
-	"slice-zone/wrapper": {
-		"type": "string | object | function",
-		"description": "An HTML tag name, a component, or a functional component used to wrap the output. The Slice Zone is not wrapped by default."
-	}
-}

package/vetur/tags.json

@@ -1,60 +0,0 @@
-{
-	"prismic-embed": {
-		"attributes": [
-			"field",
-			"wrapper"
-		],
-		"description": "Component to render a Prismic embed field."
-	},
-	"prismic-image": {
-		"attributes": [
-			"field",
-			"image-component",
-			"imgix-params",
-			"widths",
-			"pixel-densities"
-		],
-		"description": "Component to render a Prismic image field."
-	},
-	"prismic-link": {
-		"attributes": [
-			"field",
-			"link-resolver",
-			"target",
-			"rel",
-			"blank-target-rel-attribute",
-			"internal-component",
-			"external-component"
-		],
-		"description": "Component to render a Prismic link field."
-	},
-	"prismic-rich-text": {
-		"attributes": [
-			"field",
-			"link-resolver",
-			"serializer",
-			"wrapper",
-			"fallback"
-		],
-		"description": "Component to render a Prismic rich text field as HTML."
-	},
-	"prismic-text": {
-		"attributes": [
-			"field",
-			"separator",
-			"wrapper",
-			"fallback"
-		],
-		"description": "Component to render a Prismic rich text field as plain text."
-	},
-	"slice-zone": {
-		"attributes": [
-			"slices",
-			"components",
-			"context",
-			"default-component",
-			"wrapper"
-		],
-		"description": "Component to render a Prismic Slice Zone."
-	}
-}