@prismicio/vue 5.2.0 → 5.3.0-canary.5d9ea4c

package/dist/types.d.ts

@@ -1,369 +0,0 @@
-import type { AsLinkAttrsConfig, ClientConfig, CreateClient, HTMLRichTextFunctionSerializer, HTMLRichTextMapSerializer, LinkResolverFunction, asDate, asHTML, asImagePixelDensitySrcSet, asImageSrc, asImageWidthSrcSet, asLink, asLinkAttrs, asText, cookie, documentToLinkField, filter, isFilled } from "@prismicio/client";
-import type { App, ConcreteComponent, DefineComponent, Raw, Ref } from "vue";
-import type { VueRichTextSerializer } from "./PrismicRichText/types";
-import type { SliceComponentType } from "./SliceZone";
-/**
- * Options used by `@prismicio/vue` components.
- */
-type PrismicPluginComponentsOptions = {
-    /**
-     * The `rel` attribute to apply on links. This prop can be provided a function
-     * to use the link's metadata to determine the `rel` value.
-     *
-     * @defaultValue `"noreferrer"` for external links.
-     */
-    linkRel?: AsLinkAttrsConfig["rel"];
-    /**
-     * An HTML tag name or a component used to render internal links.
-     *
-     * @remarks
-     * HTML tag names will be rendered using the anchor tag interface (`href`,
-     * `target`, and `rel` attributes).
-     * @remarks
-     * Components will be rendered using Vue Router {@link RouterLink} interface
-     * (`to` props).
-     *
-     * @defaultValue {@link RouterLink}
-     */
-    linkInternalComponent?: ComponentOrTagName;
-    /**
-     * An HTML tag name or a component used to render external links.
-     *
-     * @remarks
-     * HTML tag names will be rendered using the anchor tag interface (`href`,
-     * `target`, and `rel` attributes).
-     * @remarks
-     * Components will be rendered using Vue Router {@link RouterLink} interface
-     * (`to` props).
-     *
-     * @defaultValue `"a"`
-     */
-    linkExternalComponent?: ComponentOrTagName;
-    /**
-     * Default widths to use when rendering an image with `widths="defaults"`
-     *
-     * @remarks
-     * Consider configuring image widths within your content type definition and
-     * using `widths="auto"` instead to give content writers the ability to crop
-     * images in the editor.
-     *
-     * @defaultValue `@prismicio/client` defaults
-     */
-    imageWidthSrcSetDefaults?: number[];
-    /**
-     * Default pixel densities to use when rendering an image with
-     * `pixel-densities="defaults"`
-     *
-     * @defaultValue `@prismicio/client` defaults
-     */
-    imagePixelDensitySrcSetDefaults?: number[];
-    /**
-     * An optional map of Rich Text block types to Vue Components. It is used to
-     * render rich text or title fields.
-     *
-     * @see Templating Rich Text and title fields from Prismic {@link https://prismic.io/docs/rich-text}
-     */
-    richTextComponents?: VueRichTextSerializer;
-    /**
-     * A component or a functional component rendered if a component mapping from
-     * the `components` prop cannot be found.
-     *
-     * @remarks
-     * Components will be rendered using the {@link SliceComponentProps} interface.
-     *
-     * @defaultValue `null` when `process.env.NODE_ENV === "production"` else {@link TODOSliceComponent}
-     */
-    sliceZoneDefaultComponent?: SliceComponentType;
-};
-/**
- * Common options supported by `@prismicio/vue` plugin.
- */
-type PrismicPluginOptionsBase = {
-    /**
-     * An optional link resolver function used to resolve links to Prismic
-     * documents when not using the route resolver parameter with
-     * `@prismicio/client`.
-     *
-     * @see Link resolver documentation {@link https://prismic.io/docs/core-concepts/link-resolver-route-resolver#link-resolver}
-     */
-    linkResolver?: LinkResolverFunction;
-    /**
-     * An optional HTML serializer to customize the way rich text fields are
-     * rendered.
-     *
-     * @remarks
-     * To provide global components for the `<PrismicRichText />` component, use
-     * the `components.richTextComponents` option instead.
-     *
-     * @deprecated Use `components.richTextComponents` instead.
-     *
-     * @see HTML serializer documentation {@link https://prismic.io/docs/core-concepts/html-serializer}
-     */
-    richTextSerializer?: HTMLRichTextFunctionSerializer | HTMLRichTextMapSerializer;
-    /**
-     * Whether or not to inject components globally.
-     *
-     * @defaultValue `true`
-     */
-    injectComponents?: boolean;
-    /**
-     * Options used by Prismic Vue components.
-     *
-     * @see Components options {@link PrismicPluginComponentsOptions}
-     */
-    components?: PrismicPluginComponentsOptions;
-};
-/**
- * Options to init `@prismicio/vue` plugin with a client instance.
- *
- * @see {@link PrismicPluginOptionsBase} for shared options
- */
-type PrismicPluginOptionsWithClient = PrismicPluginOptionsBase & {
-    /**
-     * A `@prismicio/client` instance used to fetch content from a Prismic
-     * repository to configure the plugin with.
-     *
-     * @remarks
-     * The client will be used by `@prismicio/vue` composables, such as
-     * {@link usePrismicDocuments} and exposed through `this.$prismic.client` and
-     * `usePrismic().client`.
-     *
-     * @see Prismic client documentation {@link https://prismic.io/docs/technologies/javascript}
-     */
-    client: ReturnType<CreateClient>;
-    /**
-     * Ensures type union is a strict or.
-     *
-     * @internal
-     */
-    endpoint?: never;
-    /**
-     * Ensures type union is a strict or.
-     *
-     * @internal
-     */
-    clientConfig?: never;
-};
-/**
- * Options to init `@prismicio/vue` plugin with a repository ID or API endpoint.
- *
- * @see {@link PrismicPluginOptionsBase} for shared options
- */
-type PrismicPluginOptionsWithEndpoint = PrismicPluginOptionsBase & {
-    /**
-     * A Prismic repository endpoint to init the plugin's `@prismicio/client`
-     * instance used to fetch content from a Prismic repository with.
-     *
-     * @remarks
-     * Said client will be used by `@prismicio/vue` composables, such as
-     * {@link usePrismicDocuments} and exposed through `this.$prismic.client` and
-     * `usePrismic().client`.
-     *
-     * @example
-     *
-     * ```javascript
-     * // A repository ID
-     * "my-repo"
-     *
-     * //A full repository endpoint
-     * "https://my-repo.cdn.prismic.io/api/v2"
-     * ```
-     *
-     * @see Prismic client documentation {@link https://prismic.io/docs/technologies/javascript}
-     */
-    endpoint: string;
-    /**
-     * An optional object to configure `@prismicio/client` instance further.
-     *
-     * @example
-     *
-     * ```javascript
-     * // Accessing a private private repository
-     * {
-     * 	"accessToken": "abc"
-     * }
-     * ```
-     *
-     * @example
-     *
-     * ```javascript
-     * // Using a route resolver
-     * {
-     * 	"defaultParams": {
-     * 		"routes": [
-     * 			{
-     * 				"type": "page",
-     * 				"path": "/:uid"
-     * 			},
-     * 			{
-     * 				"type": "post",
-     * 				"path": "/blog/:uid"
-     * 			}
-     * 		]
-     * 	}
-     * }
-     * ```
-     *
-     * @see Prismic client documentation {@link https://prismic.io/docs/technologies/javascript}
-     * @see Route resolver documentation {@link https://prismic.io/docs/core-concepts/link-resolver-route-resolver#route-resolver}
-     */
-    clientConfig?: ClientConfig;
-    /**
-     * Ensures type union is a strict or.
-     *
-     * @internal
-     */
-    client?: never;
-};
-/**
- * `@prismicio/vue` plugin options.
- *
- * @see Prismic Official Vue.js documentation: {@link https://prismic.io/docs/technologies/vuejs}
- * @see Plugin repository: {@link https://github.com/prismicio/prismic-vue}
- */
-export type PrismicPluginOptions = PrismicPluginOptionsWithClient | PrismicPluginOptionsWithEndpoint;
-/**
- * `@prismicio/client` related methods and properties exposed by
- * `@prismicio/vue` plugin and accessible through `this.$prismic` and
- * `usePrismic()`.
- */
-export type PrismicPluginClient = {
-    /**
-     * A `@prismicio/client` instance.
-     */
-    client: ReturnType<CreateClient>;
-    /**
-     * Query filters from `@prismicio/client`.
-     */
-    filter: typeof filter;
-    /**
-     * Prismic cookies from `@prismicio/client`.
-     */
-    cookie: typeof cookie;
-};
-/**
- * `@prismicio/client` related methods exposed by `@prismicio/vue` plugin and
- * accessible through `this.$prismic` and `usePrismic()`.
- */
-export type PrismicPluginHelpers = {
-    /**
-     * Serializes a rich text or title field to a plain text string. This is
-     * `@prismicio/client` {@link asText} function.
-     *
-     * @see Templating rich text and title fields {@link https://prismic.io/docs/technologies/vue-template-content#rich-text-and-titles}
-     */
-    asText: typeof asText;
-    /**
-     * Serializes a rich text or title field to an HTML string. This is
-     * `@prismicio/client` {@link asHTML} function.
-     *
-     * @remarks
-     * If no `linkResolver` is provided the function will use the one provided to
-     * the plugin at {@link PrismicPluginOptions.linkResolver} if available.
-     * @remarks
-     * If no `htmlSerializer` is provided the function will use the one provided
-     * to the plugin at {@link PrismicPluginOptions.htmlSerializer} if available.
-     *
-     * @see Templating rich text and title fields {@link https://prismic.io/docs/technologies/vue-template-content#rich-text-and-titles}
-     */
-    asHTML: typeof asHTML;
-    /**
-     * Resolves any type of link field or document to a URL. This is
-     * `@prismicio/client` {@link asLink} function.
-     *
-     * @remarks
-     * If no `linkResolver` is provided the function will use the one provided to
-     * the plugin at {@link PrismicPluginOptions.linkResolver} if available.
-     *
-     * @see Templating link fields {@link https://prismic.io/docs/technologies/vue-template-content#links-and-content-relationships}
-     */
-    asLink: typeof asLink;
-    /**
-     * Resolves any type of link field or document to a set of link attributes.
-     * This is `@prismicio/client` {@link asLinkAttrs} function.
-     *
-     * @remarks
-     * If no `linkResolver` is provided the function will use the one provided to
-     * the plugin at {@link PrismicPluginOptions.linkResolver} if available.
-     *
-     * @see Templating link fields {@link https://prismic.io/docs/technologies/vue-template-content#links-and-content-relationships}
-     */
-    asLinkAttrs: typeof asLinkAttrs;
-    /**
-     * Transforms a date or timestamp field into a JavaScript Date object. This is
-     * `@prismicio/client` {@link asDate} function.
-     */
-    asDate: typeof asDate;
-    /**
-     * Returns the URL of an image field with optional image transformations (via
-     * Imgix URL parameters). This is `@prismicio/client` {@link asImageSrc}
-     * function.
-     */
-    asImageSrc: typeof asImageSrc;
-    /**
-     * Creates a width-based `srcset` from an image field with optional image
-     * transformations (via Imgix URL parameters). This is `@prismicio/client`
-     * {@link asImageWidthSrcSet} function.
-     */
-    asImageWidthSrcSet: typeof asImageWidthSrcSet;
-    /**
-     * Creates a pixel-density-based `srcset` from an image field with optional
-     * image transformations (via Imgix URL parameters). This is
-     * `@prismicio/client` {@link asImagePixelDensitySrcSet} function.
-     */
-    asImagePixelDensitySrcSet: typeof asImagePixelDensitySrcSet;
-    /**
-     * Helpers to determine if a field is filled. This is `@prismicio/client`
-     * {@link isFilled} object.
-     */
-    isFilled: typeof isFilled;
-    /**
-     * Converts a document into a link field. This is `@prismicio/client`
-     * {@link documentToLinkField} function.
-     *
-     * @internal
-     */
-    documentToLinkField: typeof documentToLinkField;
-};
-/**
- * Methods and properties exposed by `@prismicio/vue` plugin and accessible
- * through `this.$prismic` and `usePrismic()`.
- */
-export type PrismicPlugin = {
-    /**
-     * Options uses to initialize the plugin.
-     *
-     * @see `@prismicio/vue` plugin options {@link PrismicPluginOptions}
-     */
-    readonly options: PrismicPluginOptions;
-    /**
-     * `@prismicio/vue` plugin install function used by Vue.
-     *
-     * @internal
-     */
-    install: (app: App) => void;
-} & PrismicPluginClient & PrismicPluginHelpers;
-/**
- * Type to transform a static object into one that allows passing Refs as
- * values.
- *
- * @internal
- */
-export type VueUseOptions<T> = {
-    [K in keyof T]: Ref<T[K]> | T[K];
-};
-/**
- * Type to transform a static tuple into one that allows passing Refs as values.
- *
- * @internal
- */
-export type VueUseParameters<T> = {
-    [K in keyof T]: T extends number ? Ref<T[K]> | T[K] : T[K];
-};
-/**
- * A component or a tag name to be used as props.
- *
- * @internal
- */
-export type ComponentOrTagName = string | ConcreteComponent | Raw<DefineComponent>;
-export {};

package/dist/usePrismic.cjs

@@ -1,10 +0,0 @@
-"use strict";
-Object.defineProperty(exports, Symbol.toStringTag, { value: "Module" });
-const vue = require("vue");
-const prismicKey = Symbol("prismic");
-const usePrismic = () => {
-  return vue.inject(prismicKey, { options: { endpoint: "" } });
-};
-exports.prismicKey = prismicKey;
-exports.usePrismic = usePrismic;
-//# sourceMappingURL=usePrismic.cjs.map

package/dist/usePrismic.cjs.map

@@ -1 +0,0 @@
-{"version":3,"file":"usePrismic.cjs","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"],"names":["inject"],"mappings":";;;AAWa,MAAA,aAAa,OAAO,SAAS;AAsBnC,MAAM,aAAa,MAAoB;AACtC,SAAAA,IAAAA,OAAO,YAAY,EAAE,SAAS,EAAE,UAAU,GAAA,GAAuB;AACzE;;;"}

package/dist/usePrismic.js

@@ -1,10 +0,0 @@
-import { inject } from "vue";
-const prismicKey = Symbol("prismic");
-const usePrismic = () => {
-  return inject(prismicKey, { options: { endpoint: "" } });
-};
-export {
-  prismicKey,
-  usePrismic
-};
-//# sourceMappingURL=usePrismic.js.map

package/dist/usePrismic.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"usePrismic.js","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"],"names":[],"mappings":";AAWa,MAAA,aAAa,OAAO,SAAS;AAsBnC,MAAM,aAAa,MAAoB;AACtC,SAAA,OAAO,YAAY,EAAE,SAAS,EAAE,UAAU,GAAA,GAAuB;AACzE;"}