@prismicio/vue 5.3.0-canary.5d9ea4c → 5.3.0-canary.87748cc

package/dist/src/usePrismic.d.ts

@@ -1,36 +0,0 @@
-import { PrismicPlugin } from "./types.js";
-import { InjectionKey } from "vue";
-
-//#region src/usePrismic.d.ts
-
-/**
- * `@prismicio/vue` plugin interface interface location used for
- * {@link usePrismic}.
- *
- * @internal
- */
-declare const prismicKey: 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}
- */
-declare const usePrismic: () => PrismicPlugin;
-//#endregion
-export { prismicKey, usePrismic };
-//# sourceMappingURL=usePrismic.d.ts.map

package/dist/src/usePrismic.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"usePrismic.d.ts","names":[],"sources":["../../src/usePrismic.ts"],"sourcesContent":[],"mappings":";;;;;;;AAWA;AAsBA;;;cAtBa,YAAkC,aAAa;;;;;;;;;;;;;;;;;;;;;cAsB/C,kBAAiB"}

package/dist/src/usePrismic.js

@@ -1,37 +0,0 @@
-import { inject } from "vue";
-
-//#region src/usePrismic.ts
-/**
-* `@prismicio/vue` plugin interface interface location used for
-* {@link usePrismic}.
-*
-* @internal
-*/
-const prismicKey = Symbol("prismic");
-/**
-* 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}
-*/
-const usePrismic = () => {
-	return inject(prismicKey, { options: { endpoint: "" } });
-};
-
-//#endregion
-export { prismicKey, usePrismic };
-//# sourceMappingURL=usePrismic.js.map

package/dist/src/usePrismic.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"usePrismic.js","names":[],"sources":["../../src/usePrismic.ts"],"sourcesContent":["import type { InjectionKey } from \"vue\"\nimport { inject } from \"vue\"\n\nimport type { PrismicPlugin } from \"./types\"\n\n/**\n * `@prismicio/vue` plugin interface interface location used for\n * {@link usePrismic}.\n *\n * @internal\n */\nexport const prismicKey = Symbol(\"prismic\") as InjectionKey<PrismicPlugin>\n\n/**\n * Accesses `@prismicio/vue` plugin interface.\n *\n * @example\n *\n * ```javascript\n * // With the composition API\n * import { usePrismic } from \"@prismicio/vue\"\n *\n * export default {\n * \tsetup() {\n * \t\tconst prismic = usePrismic()\n *\n * \t\treturn {}\n * \t},\n * }\n * ```\n *\n * @returns The interface {@link PrismicPlugin}\n */\nexport const usePrismic = (): PrismicPlugin => {\n\treturn inject(prismicKey, { options: { endpoint: \"\" } } as PrismicPlugin)\n}\n"],"mappings":";;;;;;;;;AAWA,MAAa,aAAa,OAAO,UAAU;;;;;;;;;;;;;;;;;;;;;AAsB3C,MAAa,mBAAkC;AAC9C,QAAO,OAAO,YAAY,EAAE,SAAS,EAAE,UAAU,IAAI,EAAE,CAAkB"}

package/dist/usePrismic.d.cts

@@ -1,36 +0,0 @@
-import { PrismicPlugin } from "./types.cjs";
-import { InjectionKey } from "vue";
-
-//#region src/usePrismic.d.ts
-
-/**
- * `@prismicio/vue` plugin interface interface location used for
- * {@link usePrismic}.
- *
- * @internal
- */
-declare const prismicKey: 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}
- */
-declare const usePrismic: () => PrismicPlugin;
-//#endregion
-export { prismicKey, usePrismic };
-//# sourceMappingURL=usePrismic.d.cts.map

package/dist/usePrismic.d.cts.map

@@ -1 +0,0 @@
-{"version":3,"file":"usePrismic.d.cts","names":[],"sources":["../src/usePrismic.ts"],"sourcesContent":[],"mappings":";;;;;;;AAWA;AAsBA;;;cAtBa,YAAkC,aAAa;;;;;;;;;;;;;;;;;;;;;cAsB/C,kBAAiB"}

package/src/PrismicEmbed.vue

@@ -1,42 +0,0 @@
-<script lang="ts" setup>
-import type { EmbedField } from "@prismicio/client"
-import { isFilled } from "@prismicio/client"
-
-import type { ComponentOrTagName } from "./types"
-
-/**
- * The default component rendered to wrap the embed.
- */
-const defaultWrapper = "div"
-
-/**
- * Props for `<PrismicEmbed />`.
- */
-export type PrismicEmbedProps = {
-	/**
-	 * The Prismic EMbed field to render.
-	 */
-	field: EmbedField
-
-	/**
-	 * An HTML tag name or a component used to wrap the output.
-	 *
-	 * @defaultValue `"div"`
-	 */
-	wrapper?: ComponentOrTagName
-}
-
-defineProps<PrismicEmbedProps>()
-defineOptions({ name: "PrismicEmbed" })
-</script>
-
-<template>
-	<component
-		v-if="isFilled.embed(field)"
-		:is="wrapper || defaultWrapper"
-		:data-oembed="field.embed_url"
-		:data-oembed-type="field.type"
-		:data-oembed-provider="field.provider_name"
-		v-html="field.html"
-	/>
-</template>

package/src/PrismicRichText/DeprecatedPrismicRichText.vue

@@ -1,146 +0,0 @@
-<script lang="ts" setup>
-// TODO: Remove in v6
-import { asHTML, isFilled } from "@prismicio/client"
-import { DEV } from "esm-env"
-import type { Component, PropType } from "vue"
-import {
-	computed,
-	inject,
-	nextTick,
-	onBeforeUnmount,
-	onMounted,
-	ref,
-	watch,
-} from "vue"
-import { routerKey } from "vue-router"
-
-import { devMsg } from "../lib/devMsg"
-import { isInternalURL } from "../lib/isInternalURL"
-
-import { usePrismic } from "../usePrismic"
-
-import type { PrismicRichTextProps } from "./PrismicRichText.vue"
-
-/**
- * The default component rendered to wrap the HTML output.
- */
-const defaultWrapper = "div"
-
-// We're forced to declare props using the JavaScript syntax because `@vue/compiler-sfc`
-// has limitations for inferring types from complex objects.
-const props = defineProps({
-	field: {
-		type: Array as unknown as PropType<PrismicRichTextProps["field"]>,
-	},
-	fallback: {
-		type: String as PropType<string>,
-	},
-	linkResolver: {
-		type: Function as PropType<PrismicRichTextProps["linkResolver"]>,
-	},
-	serializer: {
-		type: [Object, Function] as PropType<PrismicRichTextProps["serializer"]>,
-	},
-	wrapper: {
-		type: [String, Object, Function] as PropType<
-			PrismicRichTextProps["wrapper"]
-		>,
-	},
-})
-defineOptions({ name: "DeprecatedPrismicRichText" })
-
-const { options } = usePrismic()
-
-if (DEV) {
-	onMounted(() => {
-		console.warn(
-			`[PrismicRichText] You're using the deprecated version of \`<PrismicRichText>\` because either the \`serializer\` prop or the plugin \`richTextSerializer\` option were provided. This API will be removed in a future major. For more details, see ${devMsg(
-				"html-serialization-is-deprecated-with-prismic-rich-text",
-			)}`,
-		)
-	})
-}
-
-const html = computed(() => {
-	if (!isFilled.richText(props.field)) {
-		return props.fallback ?? ""
-	}
-
-	const linkResolver = props.linkResolver ?? options.linkResolver
-	const serializer = props.serializer ?? options.richTextSerializer
-
-	return asHTML(props.field, { linkResolver, serializer })
-})
-
-// Internal links handling
-const root = ref<HTMLElement | Comment | Component | null>(null)
-
-const maybeRouter = inject(routerKey, null)
-
-type InternalLink = {
-	element: HTMLAnchorElement
-	listener: EventListener
-}
-
-let links: InternalLink[] = []
-
-const navigate: EventListener = function (
-	this: { href: string },
-	event: Event,
-) {
-	event.preventDefault()
-	maybeRouter?.push(this.href)
-}
-
-const addListeners = () => {
-	const node: HTMLElement | Comment | null =
-		root.value && "$el" in root.value ? root.value.$el : root.value
-	if (node && "querySelectorAll" in node) {
-		// Get all internal link tags and add listeners on them
-		links = Array.from(node.querySelectorAll("a"))
-			.map((element) => {
-				const href = element.getAttribute("href")
-
-				if (href && isInternalURL(href)) {
-					const listener = navigate.bind({ href })
-					element.addEventListener("click", listener)
-
-					return { element, listener }
-				} else {
-					return false
-				}
-			})
-			.filter((link): link is InternalLink => link as boolean)
-	}
-}
-
-const removeListeners = () => {
-	links.forEach(({ element, listener }) =>
-		element.removeEventListener("click", listener),
-	)
-	links = []
-}
-
-onMounted(() => {
-	removeListeners()
-	nextTick(addListeners)
-})
-
-watch(html, () => {
-	removeListeners()
-	nextTick(addListeners)
-})
-
-onBeforeUnmount(() => {
-	removeListeners()
-})
-</script>
-
-<template>
-	<component
-		v-if="isFilled.richText(field) || fallback"
-		ref="root"
-		:is="wrapper || defaultWrapper"
-		v-html="html"
-	/>
-</template>

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)
-}