@prismicio/vue 5.3.0 → 6.0.0-canary.331d154

package/dist/index.js

@@ -1,32 +1,15 @@
-import { default as default2 } from "./PrismicRichText/PrismicRichText.vue.js";
-import { default as default3 } from "./PrismicTable/PrismicTable.vue.js";
-import { default as default4 } from "./SliceZone/SliceZone.vue.js";
-import { default as default5 } from "./PrismicEmbed.vue.js";
-import { default as default6 } from "./PrismicImage.vue.js";
-import { default as default7 } from "./PrismicLink.vue.js";
-import { default as default8 } from "./PrismicText.vue.js";
-import { createPrismic } from "./createPrismic.js";
-import { prismicKey, usePrismic } from "./usePrismic.js";
+import { createPrismic, usePrismic } from "./createPrismic.js";
+import PrismicImage_default from "./PrismicImage.js";
+import PrismicLink_default from "./PrismicLink.js";
+import PrismicRichText_default from "./PrismicRichText/PrismicRichText.js";
 import { getRichTextComponentProps } from "./PrismicRichText/getRichTextComponentProps.js";
-import * as getTableComponentProps from "./PrismicTable/getTableComponentProps.js";
+import { getTableComponentProps_exports } from "./PrismicTable/getTableComponentProps.js";
+import PrismicTable_default from "./PrismicTable/PrismicTable.js";
+import PrismicText_default from "./PrismicText.js";
 import { TODOSliceComponent } from "./SliceZone/TODOSliceComponent.js";
-import { defineSliceZoneComponents } from "./SliceZone/defineSliceZoneComponents.js";
+import SliceZone_default from "./SliceZone/SliceZone.js";
 import { getSliceComponentProps } from "./SliceZone/getSliceComponentProps.js";
-export {
-  default5 as PrismicEmbed,
-  default6 as PrismicImage,
-  default7 as PrismicLink,
-  default2 as PrismicRichText,
-  default3 as PrismicTable,
-  default8 as PrismicText,
-  default4 as SliceZone,
-  TODOSliceComponent,
-  createPrismic,
-  defineSliceZoneComponents,
-  getRichTextComponentProps,
-  getSliceComponentProps,
-  getTableComponentProps,
-  prismicKey,
-  usePrismic
-};
-//# sourceMappingURL=index.js.map
+import { defineSliceZoneComponents } from "./SliceZone/defineSliceZoneComponents.js";
+import SliceSimulator_default from "./SliceSimulator.js";
+
+export { PrismicImage_default as PrismicImage, PrismicLink_default as PrismicLink, PrismicRichText_default as PrismicRichText, PrismicTable_default as PrismicTable, PrismicText_default as PrismicText, SliceSimulator_default as SliceSimulator, SliceZone_default as SliceZone, TODOSliceComponent, createPrismic, defineSliceZoneComponents, getRichTextComponentProps, getSliceComponentProps, getTableComponentProps_exports as getTableComponentProps, usePrismic };

package/dist/lib/devMsg.cjs

@@ -1,8 +1,25 @@
-"use strict";
-Object.defineProperty(exports, Symbol.toStringTag, { value: "Module" });
-const _package = require("../package.json.cjs");
+const require_package = require('../package.cjs');
+
+//#region src/lib/devMsg.ts
+/**
+* Returns a `prismic.dev/msg` URL for a given message slug.
+*
+* @example
+*
+* ```ts
+* devMsg("missing-param")
+* // => "https://prismic.dev/msg/svelte/v1.2.3/missing-param.md"
+* ```
+*
+* @param slug - Slug for the message. This corresponds to a Markdown file in
+*   the Git repository's `/messages` directory.
+*
+* @returns The `prismic.dev/msg` URL for the given slug.
+*/
 const devMsg = (slug) => {
-  return `https://prismic.dev/msg/vue/v${_package.version}/${slug}`;
+	return `https://prismic.dev/msg/vue/v${require_package.version}/${slug}`;
 };
+
+//#endregion
 exports.devMsg = devMsg;
-//# sourceMappingURL=devMsg.cjs.map
+//# sourceMappingURL=devMsg.cjs.map

package/dist/lib/devMsg.cjs.map

@@ -1 +1 @@
-{"version":3,"file":"devMsg.cjs","sources":["../../../src/lib/devMsg.ts"],"sourcesContent":["import { version } from \"../../package.json\"\n\n/**\n * Returns a `prismic.dev/msg` URL for a given message slug.\n *\n * @example\n *\n * ```ts\n * devMsg(\"missing-param\")\n * // => \"https://prismic.dev/msg/svelte/v1.2.3/missing-param.md\"\n * ```\n *\n * @param slug - Slug for the message. This corresponds to a Markdown file in\n *   the Git repository's `/messages` directory.\n *\n * @returns The `prismic.dev/msg` URL for the given slug.\n */\nexport const devMsg = (slug: string): string => {\n\treturn `https://prismic.dev/msg/vue/v${version}/${slug}`\n}\n"],"names":["version"],"mappings":";;;AAiBa,MAAA,SAAS,CAAC,SAAwB;AACvC,SAAA,gCAAgCA,SAAAA,OAAO,IAAI,IAAI;AACvD;;"}
+{"version":3,"file":"devMsg.cjs","names":["version"],"sources":["../../src/lib/devMsg.ts"],"sourcesContent":["import { version } from \"../../package.json\"\n\n/**\n * Returns a `prismic.dev/msg` URL for a given message slug.\n *\n * @example\n *\n * ```ts\n * devMsg(\"missing-param\")\n * // => \"https://prismic.dev/msg/svelte/v1.2.3/missing-param.md\"\n * ```\n *\n * @param slug - Slug for the message. This corresponds to a Markdown file in\n *   the Git repository's `/messages` directory.\n *\n * @returns The `prismic.dev/msg` URL for the given slug.\n */\nexport const devMsg = (slug: string): string => {\n\treturn `https://prismic.dev/msg/vue/v${version}/${slug}`\n}\n"],"mappings":";;;;;;;;;;;;;;;;;;AAiBA,MAAa,UAAU,SAAyB;AAC/C,QAAO,gCAAgCA,wBAAQ,GAAG"}

package/dist/lib/devMsg.js

@@ -1,8 +1,25 @@
-import { version } from "../package.json.js";
+import { version } from "../package.js";
+
+//#region src/lib/devMsg.ts
+/**
+* Returns a `prismic.dev/msg` URL for a given message slug.
+*
+* @example
+*
+* ```ts
+* devMsg("missing-param")
+* // => "https://prismic.dev/msg/svelte/v1.2.3/missing-param.md"
+* ```
+*
+* @param slug - Slug for the message. This corresponds to a Markdown file in
+*   the Git repository's `/messages` directory.
+*
+* @returns The `prismic.dev/msg` URL for the given slug.
+*/
 const devMsg = (slug) => {
-  return `https://prismic.dev/msg/vue/v${version}/${slug}`;
+	return `https://prismic.dev/msg/vue/v${version}/${slug}`;
 };
-export {
-  devMsg
-};
-//# sourceMappingURL=devMsg.js.map
+
+//#endregion
+export { devMsg };
+//# sourceMappingURL=devMsg.js.map

package/dist/lib/devMsg.js.map

@@ -1 +1 @@
-{"version":3,"file":"devMsg.js","sources":["../../../src/lib/devMsg.ts"],"sourcesContent":["import { version } from \"../../package.json\"\n\n/**\n * Returns a `prismic.dev/msg` URL for a given message slug.\n *\n * @example\n *\n * ```ts\n * devMsg(\"missing-param\")\n * // => \"https://prismic.dev/msg/svelte/v1.2.3/missing-param.md\"\n * ```\n *\n * @param slug - Slug for the message. This corresponds to a Markdown file in\n *   the Git repository's `/messages` directory.\n *\n * @returns The `prismic.dev/msg` URL for the given slug.\n */\nexport const devMsg = (slug: string): string => {\n\treturn `https://prismic.dev/msg/vue/v${version}/${slug}`\n}\n"],"names":[],"mappings":";AAiBa,MAAA,SAAS,CAAC,SAAwB;AACvC,SAAA,gCAAgC,OAAO,IAAI,IAAI;AACvD;"}
+{"version":3,"file":"devMsg.js","names":[],"sources":["../../src/lib/devMsg.ts"],"sourcesContent":["import { version } from \"../../package.json\"\n\n/**\n * Returns a `prismic.dev/msg` URL for a given message slug.\n *\n * @example\n *\n * ```ts\n * devMsg(\"missing-param\")\n * // => \"https://prismic.dev/msg/svelte/v1.2.3/missing-param.md\"\n * ```\n *\n * @param slug - Slug for the message. This corresponds to a Markdown file in\n *   the Git repository's `/messages` directory.\n *\n * @returns The `prismic.dev/msg` URL for the given slug.\n */\nexport const devMsg = (slug: string): string => {\n\treturn `https://prismic.dev/msg/vue/v${version}/${slug}`\n}\n"],"mappings":";;;;;;;;;;;;;;;;;;AAiBA,MAAa,UAAU,SAAyB;AAC/C,QAAO,gCAAgC,QAAQ,GAAG"}

package/dist/lib/isInternalURL.cjs

@@ -1,9 +1,20 @@
-"use strict";
-Object.defineProperty(exports, Symbol.toStringTag, { value: "Module" });
+
+//#region src/lib/isInternalURL.ts
+/**
+* Determines if a URL is internal or external.
+*
+* @param url - The URL to check if internal or external
+*
+* @returns `true` if `url` is internal, `false` otherwise
+*/
 const isInternalURL = (url) => {
-  const isInternal = /^\/(?!\/)/.test(url);
-  const isSpecialLink = !isInternal && !/^https?:\/\//i.test(url);
-  return isInternal && !isSpecialLink;
+	/** @see Regex101 expression: {@link https://regex101.com/r/1y7iod/1} */
+	const isInternal = /^\/(?!\/)/.test(url);
+	/** @see Regex101 expression: {@link https://regex101.com/r/RnUseS/1} */
+	const isSpecialLink = !isInternal && !/^https?:\/\//i.test(url);
+	return isInternal && !isSpecialLink;
 };
+
+//#endregion
 exports.isInternalURL = isInternalURL;
-//# sourceMappingURL=isInternalURL.cjs.map
+//# sourceMappingURL=isInternalURL.cjs.map

package/dist/lib/isInternalURL.cjs.map

@@ -1 +1 @@
-{"version":3,"file":"isInternalURL.cjs","sources":["../../../src/lib/isInternalURL.ts"],"sourcesContent":["/**\n * Determines if a URL is internal or external.\n *\n * @param url - The URL to check if internal or external\n *\n * @returns `true` if `url` is internal, `false` otherwise\n */\n// TODO: This does not detect all relative URLs as internal, such as `about` or `./about`. This function assumes relative URLs start with a \"/\"`.\nexport const isInternalURL = (url: string): boolean => {\n\t/**\n\t * @see Regex101 expression: {@link https://regex101.com/r/1y7iod/1}\n\t */\n\tconst isInternal = /^\\/(?!\\/)/.test(url)\n\t/**\n\t * @see Regex101 expression: {@link https://regex101.com/r/RnUseS/1}\n\t */\n\tconst isSpecialLink = !isInternal && !/^https?:\\/\\//i.test(url)\n\n\treturn isInternal && !isSpecialLink\n}\n"],"names":[],"mappings":";;AAQa,MAAA,gBAAgB,CAAC,QAAwB;AAI/C,QAAA,aAAa,YAAY,KAAK,GAAG;AAIvC,QAAM,gBAAgB,CAAC,cAAc,CAAC,gBAAgB,KAAK,GAAG;AAE9D,SAAO,cAAc,CAAC;AACvB;;"}
+{"version":3,"file":"isInternalURL.cjs","names":[],"sources":["../../src/lib/isInternalURL.ts"],"sourcesContent":["/**\n * Determines if a URL is internal or external.\n *\n * @param url - The URL to check if internal or external\n *\n * @returns `true` if `url` is internal, `false` otherwise\n */\n// TODO: This does not detect all relative URLs as internal, such as `about` or `./about`. This function assumes relative URLs start with a \"/\"`.\nexport const isInternalURL = (url: string): boolean => {\n\t/** @see Regex101 expression: {@link https://regex101.com/r/1y7iod/1} */\n\tconst isInternal = /^\\/(?!\\/)/.test(url)\n\t/** @see Regex101 expression: {@link https://regex101.com/r/RnUseS/1} */\n\tconst isSpecialLink = !isInternal && !/^https?:\\/\\//i.test(url)\n\n\treturn isInternal && !isSpecialLink\n}\n"],"mappings":";;;;;;;;;AAQA,MAAa,iBAAiB,QAAyB;;CAEtD,MAAM,aAAa,YAAY,KAAK,IAAI;;CAExC,MAAM,gBAAgB,CAAC,cAAc,CAAC,gBAAgB,KAAK,IAAI;AAE/D,QAAO,cAAc,CAAC"}

package/dist/lib/isInternalURL.js

@@ -1,9 +1,19 @@
+//#region src/lib/isInternalURL.ts
+/**
+* Determines if a URL is internal or external.
+*
+* @param url - The URL to check if internal or external
+*
+* @returns `true` if `url` is internal, `false` otherwise
+*/
 const isInternalURL = (url) => {
-  const isInternal = /^\/(?!\/)/.test(url);
-  const isSpecialLink = !isInternal && !/^https?:\/\//i.test(url);
-  return isInternal && !isSpecialLink;
+	/** @see Regex101 expression: {@link https://regex101.com/r/1y7iod/1} */
+	const isInternal = /^\/(?!\/)/.test(url);
+	/** @see Regex101 expression: {@link https://regex101.com/r/RnUseS/1} */
+	const isSpecialLink = !isInternal && !/^https?:\/\//i.test(url);
+	return isInternal && !isSpecialLink;
 };
-export {
-  isInternalURL
-};
-//# sourceMappingURL=isInternalURL.js.map
+
+//#endregion
+export { isInternalURL };
+//# sourceMappingURL=isInternalURL.js.map

package/dist/lib/isInternalURL.js.map

@@ -1 +1 @@
-{"version":3,"file":"isInternalURL.js","sources":["../../../src/lib/isInternalURL.ts"],"sourcesContent":["/**\n * Determines if a URL is internal or external.\n *\n * @param url - The URL to check if internal or external\n *\n * @returns `true` if `url` is internal, `false` otherwise\n */\n// TODO: This does not detect all relative URLs as internal, such as `about` or `./about`. This function assumes relative URLs start with a \"/\"`.\nexport const isInternalURL = (url: string): boolean => {\n\t/**\n\t * @see Regex101 expression: {@link https://regex101.com/r/1y7iod/1}\n\t */\n\tconst isInternal = /^\\/(?!\\/)/.test(url)\n\t/**\n\t * @see Regex101 expression: {@link https://regex101.com/r/RnUseS/1}\n\t */\n\tconst isSpecialLink = !isInternal && !/^https?:\\/\\//i.test(url)\n\n\treturn isInternal && !isSpecialLink\n}\n"],"names":[],"mappings":"AAQa,MAAA,gBAAgB,CAAC,QAAwB;AAI/C,QAAA,aAAa,YAAY,KAAK,GAAG;AAIvC,QAAM,gBAAgB,CAAC,cAAc,CAAC,gBAAgB,KAAK,GAAG;AAE9D,SAAO,cAAc,CAAC;AACvB;"}
+{"version":3,"file":"isInternalURL.js","names":[],"sources":["../../src/lib/isInternalURL.ts"],"sourcesContent":["/**\n * Determines if a URL is internal or external.\n *\n * @param url - The URL to check if internal or external\n *\n * @returns `true` if `url` is internal, `false` otherwise\n */\n// TODO: This does not detect all relative URLs as internal, such as `about` or `./about`. This function assumes relative URLs start with a \"/\"`.\nexport const isInternalURL = (url: string): boolean => {\n\t/** @see Regex101 expression: {@link https://regex101.com/r/1y7iod/1} */\n\tconst isInternal = /^\\/(?!\\/)/.test(url)\n\t/** @see Regex101 expression: {@link https://regex101.com/r/RnUseS/1} */\n\tconst isSpecialLink = !isInternal && !/^https?:\\/\\//i.test(url)\n\n\treturn isInternal && !isSpecialLink\n}\n"],"mappings":";;;;;;;;AAQA,MAAa,iBAAiB,QAAyB;;CAEtD,MAAM,aAAa,YAAY,KAAK,IAAI;;CAExC,MAAM,gBAAgB,CAAC,cAAc,CAAC,gBAAgB,KAAK,IAAI;AAE/D,QAAO,cAAc,CAAC"}

package/dist/package.cjs

@@ -0,0 +1,12 @@
+
+//#region package.json
+var version = "6.0.0-canary.331d154";
+
+//#endregion
+Object.defineProperty(exports, 'version', {
+  enumerable: true,
+  get: function () {
+    return version;
+  }
+});
+//# sourceMappingURL=package.cjs.map

package/dist/package.cjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"package.cjs","names":[],"sources":["../package.json"],"sourcesContent":[""],"mappings":""}

package/dist/package.js

@@ -0,0 +1,6 @@
+//#region package.json
+var version = "6.0.0-canary.331d154";
+
+//#endregion
+export { version };
+//# sourceMappingURL=package.js.map

package/dist/package.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"package.js","names":[],"sources":["../package.json"],"sourcesContent":[""],"mappings":""}

package/dist/types.cjs

@@ -0,0 +1,9 @@
+
+//#region src/types.ts
+const isComponent = (component) => {
+	return !!component && (typeof component === "function" || typeof component === "object" && ("render" in component && typeof component.render === "function" || "setup" in component && typeof component.setup === "function" || "__file" in component && !!component.__file || "__name" in component && !!component.__name || "props" in component && typeof component.props === "object"));
+};
+
+//#endregion
+exports.isComponent = isComponent;
+//# sourceMappingURL=types.cjs.map

package/dist/types.cjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.cjs","names":[],"sources":["../src/types.ts"],"sourcesContent":["import type { Component as _Component } from \"vue\"\n\nexport type ComponentOrTagName = string | _Component\n\n// For reference within TypeScript files when `*.vue` type cannot be inferred\nexport type Component<TProps> = _Component | _Component<TProps>\n\n/**\n * A shorthand definition for `<PrismicRichText />` and `<PrismicTable />`\n * component types.\n */\nexport type ComponentShorthand = {\n\t/** The HTML element type rendered for this node type. */\n\tas?: string\n\n\t/** Other attributes to apply to the element type. */\n\t[Attribute: string]: string | boolean | null | undefined\n}\n\nexport const isComponent = <T>(\n\tcomponent: Component<T> | ComponentShorthand | undefined,\n): component is Component<T> => {\n\treturn (\n\t\t!!component &&\n\t\t(typeof component === \"function\" ||\n\t\t\t(typeof component === \"object\" &&\n\t\t\t\t((\"render\" in component && typeof component.render === \"function\") ||\n\t\t\t\t\t(\"setup\" in component && typeof component.setup === \"function\") ||\n\t\t\t\t\t(\"__file\" in component && !!component.__file) ||\n\t\t\t\t\t(\"__name\" in component && !!component.__name) ||\n\t\t\t\t\t(\"props\" in component && typeof component.props === \"object\"))))\n\t)\n}\n"],"mappings":";;AAmBA,MAAa,eACZ,cAC+B;AAC/B,QACC,CAAC,CAAC,cACD,OAAO,cAAc,cACpB,OAAO,cAAc,aACnB,YAAY,aAAa,OAAO,UAAU,WAAW,cACrD,WAAW,aAAa,OAAO,UAAU,UAAU,cACnD,YAAY,aAAa,CAAC,CAAC,UAAU,UACrC,YAAY,aAAa,CAAC,CAAC,UAAU,UACrC,WAAW,aAAa,OAAO,UAAU,UAAU"}

package/dist/types.d.cts

@@ -0,0 +1,18 @@
+import { Component } from "vue";
+
+//#region src/types.d.ts
+type ComponentOrTagName = string | Component;
+type Component$1<TProps> = Component | Component<TProps>;
+/**
+ * A shorthand definition for `<PrismicRichText />` and `<PrismicTable />`
+ * component types.
+ */
+type ComponentShorthand = {
+  /** The HTML element type rendered for this node type. */
+  as?: string;
+  /** Other attributes to apply to the element type. */
+  [Attribute: string]: string | boolean | null | undefined;
+};
+//#endregion
+export { Component$1 as Component, ComponentOrTagName, ComponentShorthand };
+//# sourceMappingURL=types.d.cts.map

package/dist/types.d.cts.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.d.cts","names":[],"sources":["../src/types.ts"],"sourcesContent":[],"mappings":";;;KAEY,kBAAA,YAA8B;KAG9B,sBAAoB,YAAa,UAAW;AAHxD;AAGA;;;AAA6C,KAMjC,kBAAA,GANiC;EAAU;EAM3C,EAAA,CAAA,EAAA,MAAA"}

package/dist/types.d.ts

@@ -1,369 +1,18 @@
-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 {};
+import { Component } from "vue";
+
+//#region src/types.d.ts
+type ComponentOrTagName = string | Component;
+type Component$1<TProps> = Component | Component<TProps>;
+/**
+ * A shorthand definition for `<PrismicRichText />` and `<PrismicTable />`
+ * component types.
+ */
+type ComponentShorthand = {
+  /** The HTML element type rendered for this node type. */
+  as?: string;
+  /** Other attributes to apply to the element type. */
+  [Attribute: string]: string | boolean | null | undefined;
+};
+//#endregion
+export { Component$1 as Component, ComponentOrTagName, ComponentShorthand };
+//# sourceMappingURL=types.d.ts.map

package/dist/types.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.d.ts","names":[],"sources":["../src/types.ts"],"sourcesContent":[],"mappings":";;;KAEY,kBAAA,YAA8B;KAG9B,sBAAoB,YAAa,UAAW;AAHxD;AAGA;;;AAA6C,KAMjC,kBAAA,GANiC;EAAU;EAM3C,EAAA,CAAA,EAAA,MAAA"}