@prismicio/vue 5.2.1 → 5.3.0-canary.4c3e4ab

package/src/createPrismic.ts

@@ -1,154 +0,0 @@
-import type {
-	Client,
-	HTMLRichTextFunctionSerializer,
-	HTMLRichTextMapSerializer,
-	LinkResolverFunction,
-} from "@prismicio/client"
-import {
-	asDate,
-	asHTML,
-	asImagePixelDensitySrcSet,
-	asImageSrc,
-	asImageWidthSrcSet,
-	asLink,
-	asLinkAttrs,
-	asText,
-	cookie,
-	createClient,
-	documentToLinkField,
-	filter,
-	isFilled,
-} from "@prismicio/client"
-import type { App } from "vue"
-
-import type {
-	PrismicPlugin,
-	PrismicPluginClient,
-	PrismicPluginHelpers,
-	PrismicPluginOptions,
-} from "./types"
-
-import PrismicRichText from "./PrismicRichText/PrismicRichText.vue"
-import PrismicTable from "./PrismicTable/PrismicTable.vue"
-import SliceZone from "./SliceZone/SliceZone.vue"
-
-import PrismicEmbed from "./PrismicEmbed.vue"
-import PrismicImage from "./PrismicImage.vue"
-import PrismicLink from "./PrismicLink.vue"
-import PrismicText from "./PrismicText.vue"
-import { prismicKey } from "./usePrismic"
-
-/**
- * Creates a `@prismicio/vue` plugin instance that can be used by a Vue app.
- *
- * @param options - {@link PrismicPluginOptions}
- *
- * @returns `@prismicio/vue` plugin instance {@link PrismicPlugin}
- *
- * @see Prismic Official Vue.js documentation: {@link https://prismic.io/docs/technologies/vuejs}
- * @see Plugin repository: {@link https://github.com/prismicio/prismic-vue}
- */
-export const createPrismic = (options: PrismicPluginOptions): PrismicPlugin => {
-	// Create plugin client
-	let client: Client
-	if (options.client) {
-		client = options.client
-	} else {
-		client = createClient(options.endpoint, options.clientConfig)
-	}
-
-	const prismicClient: PrismicPluginClient = {
-		client,
-		filter,
-		cookie,
-	}
-
-	// Create plugin helpers
-	const prismicHelpers: PrismicPluginHelpers = {
-		asText,
-		asHTML: (richTextField, ...config) => {
-			const [configOrLinkResolver, maybeHTMLSerializer] = config
-
-			return asHTML(
-				richTextField,
-				typeof configOrLinkResolver === "function" ||
-					configOrLinkResolver == null
-					? {
-							linkResolver: configOrLinkResolver || options.linkResolver,
-							serializer:
-								(maybeHTMLSerializer as
-									| HTMLRichTextFunctionSerializer
-									| HTMLRichTextMapSerializer) || options.richTextSerializer,
-						}
-					: {
-							linkResolver: options.linkResolver,
-							serializer: options.richTextSerializer,
-							...configOrLinkResolver,
-						},
-			)
-		},
-		asLink: (linkField, config) => {
-			return asLink(
-				linkField,
-				typeof config === "function"
-					? { linkResolver: config }
-					: {
-							linkResolver: options.linkResolver,
-							// TODO: For some reasons, TypeScript narrows the type to "unknown" where it's supposed to be a union
-							// eslint-disable-next-line @typescript-eslint/no-explicit-any
-							...(config as any),
-						},
-			)
-		},
-		asLinkAttrs: (linkField, config) => {
-			return asLinkAttrs(linkField, {
-				// TODO: We can't really retrieve the generic type here, this might cause some unexpected type error in some edge-case scenario
-				// eslint-disable-next-line @typescript-eslint/no-explicit-any
-				linkResolver: options.linkResolver as LinkResolverFunction<any>,
-				...config,
-			})
-		},
-		asDate,
-		asImageSrc,
-		asImageWidthSrcSet,
-		asImagePixelDensitySrcSet,
-		isFilled,
-		documentToLinkField,
-	}
-
-	// Create plugin interface
-	const prismic: PrismicPlugin = {
-		options,
-
-		...prismicClient,
-		...prismicHelpers,
-
-		install(app: App): void {
-			app.provide(prismicKey, this)
-			app.config.globalProperties.$prismic = this
-
-			if (options.injectComponents !== false) {
-				app.component(PrismicLink.name!, PrismicLink)
-				app.component(PrismicEmbed.name!, PrismicEmbed)
-				app.component(PrismicImage.name!, PrismicImage)
-				app.component(PrismicTable.name!, PrismicTable)
-				app.component(PrismicText.name!, PrismicText)
-				app.component(PrismicRichText.name!, PrismicRichText)
-				app.component(SliceZone.name!, SliceZone)
-			}
-		},
-	}
-
-	return prismic
-}
-
-declare module "vue" {
-	export interface ComponentCustomProperties {
-		/**
-		 * `@prismicio/vue` plugin interface exposed on `this`.
-		 *
-		 * @see `@prismicio/vue` plugin interface {@link PrismicPlugin}
-		 */
-		$prismic: PrismicPlugin
-	}
-}

package/src/lib/Wrapper.vue

@@ -1,22 +0,0 @@
-<script lang="ts" setup>
-import type { ComponentOrTagName } from "../types"
-
-defineProps<{
-	/**
-	 * An HTML tag name or a component used to wrap the output. Output is not
-	 * wrapped by default.
-	 *
-	 * @defaultValue `"template"` (no wrapper)
-	 */
-	wrapper?: ComponentOrTagName
-}>()
-</script>
-
-<template>
-	<component v-if="wrapper" :is="wrapper" v-bind="$attrs">
-		<slot />
-	</component>
-	<template v-else>
-		<slot />
-	</template>
-</template>

package/src/usePrismic.ts

@@ -1,36 +0,0 @@
-import type { InjectionKey } from "vue"
-import { inject } from "vue"
-
-import type { PrismicPlugin } from "./types"
-
-/**
- * `@prismicio/vue` plugin interface interface location used for
- * {@link usePrismic}.
- *
- * @internal
- */
-export const prismicKey = Symbol("prismic") as InjectionKey<PrismicPlugin>
-
-/**
- * Accesses `@prismicio/vue` plugin interface.
- *
- * @example
- *
- * ```javascript
- * // With the composition API
- * import { usePrismic } from "@prismicio/vue"
- *
- * export default {
- * 	setup() {
- * 		const prismic = usePrismic()
- *
- * 		return {}
- * 	},
- * }
- * ```
- *
- * @returns The interface {@link PrismicPlugin}
- */
-export const usePrismic = (): PrismicPlugin => {
-	return inject(prismicKey, { options: { endpoint: "" } } as PrismicPlugin)
-}