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

package/dist/src/types.d.ts

@@ -1,357 +1,8 @@
-import { VueRichTextSerializer } from "./PrismicRichText/types.js";
-import { SliceComponentType } from "./SliceZone/types.js";
-import "./SliceZone/index.js";
-import { App, ConcreteComponent, DefineComponent, Raw } from "vue";
-import { AsLinkAttrsConfig, ClientConfig, CreateClient, HTMLRichTextFunctionSerializer, HTMLRichTextMapSerializer, LinkResolverFunction, asDate, asHTML, asImagePixelDensitySrcSet, asImageSrc, asImageWidthSrcSet, asLink, asLinkAttrs, asText, cookie, documentToLinkField, filter, isFilled } from "@prismicio/client";
+import { ConcreteComponent, DefineComponent, FunctionalComponent, Raw, defineAsyncComponent } from "vue";
 
 //#region src/types.d.ts
-/**
- * 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}
- */
-type PrismicPluginOptions = PrismicPluginOptionsWithClient | PrismicPluginOptionsWithEndpoint;
-/**
- * `@prismicio/client` related methods and properties exposed by
- * `@prismicio/vue` plugin and accessible through `this.$prismic` and
- * `usePrismic()`.
- */
-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()`.
- */
-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()`.
- */
-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;
-/**
- * A component or a tag name to be used as props.
- *
- * @internal
- */
 type ComponentOrTagName = string | ConcreteComponent | Raw<DefineComponent>;
+type VueComponent<TProps> = DefineComponent<{}, {}, any> | ReturnType<typeof defineAsyncComponent> | DefineComponent<TProps> | FunctionalComponent<TProps>;
 //#endregion
-export { ComponentOrTagName, PrismicPlugin, PrismicPluginOptions };
+export { ComponentOrTagName, VueComponent };
 //# sourceMappingURL=types.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"types.d.ts","names":[],"sources":["../../src/types.ts"],"sourcesContent":[],"mappings":";;;;;;;;;;AA+BoB,KAOf,8BAAA,GAA8B;EAOxB;;;;;;EAyEN,OAAA,CAAA,EAzEM,iBAyEkB,CAAA,KAAA,CAAA;EAQb;;;;;AA8B4B;;;;;AAoBzB;AAiGnB;EASY,qBAAA,CAAmB,EA/NN,kBA+NM;EAIX;;;;;AAiBpB;;;;;;;EAkE4B,qBAAA,CAAA,EAxSH,kBAwSG;EAOO;;;;AAqBnC;;;;;;EA2CY,wBAAkB,CAAA,EAAA,MAAA,EAAA;EAE3B;;;;;;;;;;;;;uBArVmB;;;;;;;;;;8BAWO;;;;;KAMxB,wBAAA;;;;;;;;iBAQW;;;;;;;;;;;;;uBAeZ,iCACA;;;;;;;;;;;;eAcU;;;;;;;KAQT,8BAAA,GAAiC;;;;;;;;;;;;UAY7B,WAAW;;;;;;;;;;;;;;;;;;;KAsBf,gCAAA,GAAmC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;iBA2DxB;;;;;;;;;;;;;;KAgBJ,oBAAA,GACT,iCACA;;;;;;KAOS,mBAAA;;;;UAIH,WAAW;;;;iBAKJ;;;;iBAKA;;;;;;KAOJ,oBAAA;;;;;;;iBAOI;;;;;;;;;;;;;;iBAeA;;;;;;;;;;;iBAYA;;;;;;;;;;;sBAYK;;;;;iBAML;;;;;;qBAOI;;;;;;6BAOQ;;;;;;oCAOO;;;;;mBAMjB;;;;;;;8BAQW;;;;;;KAOjB,aAAA;;;;;;oBAMO;;;;;;iBAOH;IACZ,sBACH;;;;;;KA4BW,kBAAA,YAET,oBACA,IAAI"}
+{"version":3,"file":"types.d.ts","names":[],"sources":["../../src/types.ts"],"sourcesContent":[],"mappings":";;;KAQY,kBAAA,YAET,oBACA,IAAI;KAEK,uBAGT,+BAEA,kBAAkB,wBAClB,gBAAgB,UAChB,oBAAoB"}

package/dist/src/types.js

@@ -0,0 +1,8 @@
+//#region src/types.ts
+const isVueComponent = (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
+export { isVueComponent };
+//# sourceMappingURL=types.js.map

package/dist/src/types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.js","names":[],"sources":["../../src/types.ts"],"sourcesContent":["import type {\n\tConcreteComponent,\n\tDefineComponent,\n\tFunctionalComponent,\n\tRaw,\n\tdefineAsyncComponent,\n} from \"vue\"\n\nexport type ComponentOrTagName =\n\t| string\n\t| ConcreteComponent\n\t| Raw<DefineComponent>\n\nexport type VueComponent<TProps> =\n\t// For reference within TypeScript files when `*.vue` type cannot be inferred\n\t// eslint-disable-next-line @typescript-eslint/no-empty-object-type, @typescript-eslint/no-explicit-any\n\t| DefineComponent<{}, {}, any>\n\t// Likewise, for reference with TypeScript files.\n\t| ReturnType<typeof defineAsyncComponent>\n\t| DefineComponent<TProps>\n\t| FunctionalComponent<TProps>\n\nexport const isVueComponent = <T>(\n\tcomponent: VueComponent<T> | unknown,\n): component is VueComponent<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":";AAsBA,MAAa,kBACZ,cACkC;AAClC,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"}