@nuxtjs/prismic 4.0.1 → 4.1.0-pr.235.302ce94

package/LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2024 Nuxt.js Community
+Copyright (c) 2025 Nuxt.js Community
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

package/README.md

@@ -12,26 +12,14 @@ Replace all on all files (README.md, CONTRIBUTING.md, bug_report.md, package.jso
 
 [![npm version][npm-version-src]][npm-version-href]
 [![npm downloads][npm-downloads-src]][npm-downloads-href]
-[![Github Actions CI][github-actions-ci-src]][github-actions-ci-href]
-[![Codecov][codecov-src]][codecov-href]
-[![Conventional Commits][conventional-commits-src]][conventional-commits-href]
-[![License][license-src]][license-href]
 
-Easily connect your Nuxt.js application to your content hosted on [Prismic][prismic].
+Easily connect your [Nuxt][nuxt] application to your content hosted on [Prismic][prismic].
 
-- [✨  Release Notes][changelog]
-- [🏀 Online Playground][playground]
-- [📖  Module Documentation][nuxt-docs]
-- [📚  Prismic Documentation][prismic-docs]
+- 🚀  Add Prismic to your Nuxt app in seconds.
+- 🍡  Fetch and present Prismic content with components and composables.
+- 🏀  [Try it now on the online playground][playground].
 
-## Features
-
-<!-- Highlight some of the features your module provide here -->
-- 🚀 &nbsp;Add Prismic to your Nuxt app in seconds;
-- 🎣 &nbsp;Access Prismic SDK through composition and options API;
-- 🖼 &nbsp;Prismic previews supported.
-
-## Quick Setup
+## Install
 
 Install the module to your Nuxt application with one command:
 
@@ -42,18 +30,22 @@ npx nuxi@latest module add prismic
 Then, configure your Prismic API endpoint:
 
 ```javascript
-import { defineNuxtConfig } from 'nuxt'
+import { defineNuxtConfig } from "nuxt"
 
 export default defineNuxtConfig({
-	modules: ['@nuxtjs/prismic'],
+	modules: ["@nuxtjs/prismic"],
 	prismic: {
-		endpoint: 'my-repository'
+		endpoint: "my-repository",
 	},
-});
+})
 ```
 
 That's it! You can now use Prismic in your Nuxt app ✨
 
+## Documentation
+
+To discover what's new on this package check out [the changelog][changelog]. For full documentation, visit the [official Prismic documentation][prismic-docs].
+
 ## Contributing
 
 Whether you're helping us fix bugs, improve the docs, or spread the word, we'd love to have you as part of the Prismic developer community!
@@ -66,6 +58,8 @@ Whether you're helping us fix bugs, improve the docs, or spread the word, we'd l
 
 **Submitting code changes**: For small fixes, feel free to [open a pull request][repo-pull-requests] with a description of your changes. For large changes, please first [open an issue][repo-feature-request] so we can discuss if and how the changes should be implemented.
 
+For more clarity on this project and its structure you can also check out the detailed [CONTRIBUTING.md][contributing] document.
+
 ## License
 
 [MIT License](./LICENSE)
@@ -76,11 +70,11 @@ Whether you're helping us fix bugs, improve the docs, or spread the word, we'd l
 
 <!-- Replace link with a more useful one if available -->
 
-[playground]: https://stackblitz.com/github/nuxt-modules/prismic/tree/master/examples/minimal?file=pages%2Findex.vue
-[nuxt-docs]: https://prismic.nuxtjs.org
-[prismic-docs]: https://prismic.io/docs/technical-reference/prismicio-vue?version=v4
+[prismic-docs]: https://prismic.io/docs/nuxt
+[nuxt-docs]: https://nuxt.com
 [changelog]: ./CHANGELOG.md
 [contributing]: ./CONTRIBUTING.md
+[playground]: https://stackblitz.com/github/nuxt-modules/prismic/tree/master/examples/minimal?file=pages%2Findex.vue
 
 <!-- Replace link with a more useful one if available -->
 
@@ -95,11 +89,3 @@ Whether you're helping us fix bugs, improve the docs, or spread the word, we'd l
 [npm-version-href]: https://npmjs.com/package/@nuxtjs/prismic
 [npm-downloads-src]: https://img.shields.io/npm/dm/@nuxtjs/prismic.svg?style=flat&colorA=020420&colorB=00DC82
 [npm-downloads-href]: https://npmjs.com/package/@nuxtjs/prismic
-[github-actions-ci-src]: https://img.shields.io/github/actions/workflow/status/nuxt-modules/prismic/ci.yml.svg?style=flat&colorA=020420&colorB=00DC82
-[github-actions-ci-href]: https://github.com/nuxt-modules/prismic/actions?query=workflow%3Aci
-[codecov-src]: https://img.shields.io/codecov/c/github/nuxt-modules/prismic.svg?style=flat&colorA=020420&colorB=00DC82
-[codecov-href]: https://codecov.io/gh/nuxt-modules/prismic
-[conventional-commits-src]: https://img.shields.io/badge/Conventional%20Commits-1.0.0-yellow.svg?style=flat&colorA=020420&colorB=00DC82
-[conventional-commits-href]: https://conventionalcommits.org
-[license-src]: https://img.shields.io/npm/l/@nuxtjs/prismic.svg?style=flat&colorA=020420&colorB=00DC82
-[license-href]: https://npmjs.com/package/@nuxtjs/prismic

package/dist/module.d.mts

@@ -1,31 +1,29 @@
 import * as _nuxt_schema from '@nuxt/schema';
-import { PrismicPluginOptions } from '@prismicio/vue';
+import { ClientConfig } from '@prismicio/client';
 
 /**
- * `@nuxtjs/prismic` module options.
+ * Prismic Nuxt module options.
  *
- * @see Module documentation: {@link https://prismic.nuxtjs.org}
- * @see Prismic documentation: {@link https://prismic.io/docs/nuxt-3-setup}
+ * @see {@link https://prismic.io/docs/nuxt}
+ * @see {@link https://prismic.io/docs/technical-reference/nuxtjs-prismic}
  */
-type PrismicModuleOptions = Omit<PrismicPluginOptions, 'endpoint' | 'client' | 'linkResolver' | 'richTextSerializer' | 'components'> & {
+type PrismicModuleOptions = {
     /**
-     * A Prismic repository endpoint to init the module's `@prismicio/client`
-     * instance used to fetch content from a Prismic repository with.
+     * The Prismic repository name or full Content API endpoint to init the
+     * module's client instance used to fetch content from a Prismic repository
+     * with.
      *
-     * @remarks
-     * Said client will be used exposed through `this.$prismic.client` and
-     * `usePrismic().client`.
      * @example
      *
-     * ```javascript
-     * // A repository ID
-     * "my-repo";
+     * ```typescript
+     * // With a repository name
+     * createClient("my-repo")
      *
-     * //A full repository endpoint
-     * "https://my-repo.cdn.prismic.io/api/v2";
+     * // With a full Prismic Content API endpoint
+     * createClient("https://my-repo.cdn.prismic.io/api/v2")
      * ```
      *
-     * @see Prismic client documentation {@link https://prismic.io/docs/technical-reference/prismicio-client}
+     * @see {@link https://prismic.io/docs/technical-reference/prismicio-client}
      */
     endpoint?: string;
     /**
@@ -38,35 +36,25 @@ type PrismicModuleOptions = Omit<PrismicPluginOptions, 'endpoint' | 'client' | '
      */
     environment?: string;
     /**
-     * An optional path to a file exporting a `@prismicio/client` instance used
-     * to fetch content from a Prismic repository to configure the module with.
+     * Configuration options that determines how content will be queries from the
+     * Prismic repository.
      *
-     * @remarks
-     * Said client will be used exposed through `this.$prismic.client` and
-     * `usePrismic().client`.
-     * @see Prismic client documentation {@link https://prismic.io/docs/technical-reference/prismicio-client}
+     * @see {@link https://prismic.io/docs/technical-reference/prismicio-client}
      */
-    client?: string;
+    clientConfig?: ClientConfig;
     /**
-     * An optional path to a file exporting a link resolver function used to
-     * resolve links to Prismic documents when not using the route resolver
-     * parameter with `@prismicio/client`.
+     * An optional path to a file exporting a Prismic client instance used to
+     * fetch content from a Prismic repository to configure the module with.
      *
-     * @see Link resolver documentation {@link https://prismic.io/docs/route-resolver#link-resolver}
-     */
-    linkResolver?: string;
-    /**
-     * An optional path to a file exporting an HTML serializer to customize
-     * the way rich text fields are rendered.
-     *
-     * @deprecated Use `components.richTextComponents` instead.
+     * @remarks
+     * When provided, it takes precedence over the `endpoint` and `clientConfig`
+     * options.
      *
-     * @see HTML serializer documentation {@link https://prismic.io/docs/rich-text}
+     * @see {@link https://prismic.io/docs/technical-reference/prismicio-client}
      */
-    richTextSerializer?: string;
+    client?: string;
     /**
-     * Desired path of the preview page used by Prismic to enter preview
-     * session.
+     * Desired path of the preview page used by Prismic to enter preview session.
      *
      * @remarks
      * `false` can be used to disable the preview page.
@@ -83,54 +71,39 @@ type PrismicModuleOptions = Omit<PrismicPluginOptions, 'endpoint' | 'client' | '
      * @defaultValue `true`
      */
     toolbar?: boolean;
-    /**
-     * Whether to enable Prismic Nuxt DevTools integration.
-     *
-     * @defaultValue `true`
-     */
-    devtools?: boolean;
-    /**
-     * Options used by Prismic Vue components.
-     */
-    components?: Omit<Required<PrismicPluginOptions>['components'], 'richTextComponents' | 'linkRel' | 'sliceZoneDefaultComponent' | 'linkInternalComponent' | 'linkExternalComponent'> & {
-        /**
-         * An optional path to a file exporting the `rel` attribute to apply on links.
-         * It can export a function to use the link's metadata to determine the `rel` value.
-         *
-         * @defaultValue `"noreferrer"` for external links.
-         */
-        linkRel?: string;
+    /** Options used by Prismic Vue components. */
+    componentsConfig?: {
         /**
-         * An optional path to a file exporting a map of Rich Text block types to Vue Components.
-         * It is used to render Rich Text or title fields.
+         * The path to a file exporting a default link resolver function used to
+         * resolve links.
          *
-         * @see Templating Rich Text and title fields from Prismic {@link https://prismic.io/docs/rich-text}
+         * @see {@link https://prismic.io/docs/routes}
          */
-        richTextComponents?: string;
+        linkResolver?: string;
         /**
-         * An optional path to a file exporting 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.
+         * The path to a file exporting default components or shorthand definitions
+         * for rich text and table components.
          *
-         * @defaultValue `null` when `process.env.NODE_ENV === "production"` else {@link TODOSliceComponent}
+         * @see {@link https://prismic.io/docs/fields/rich-text}
+         * @see {@link https://prismic.io/docs/fields/table}
          */
-        sliceZoneDefaultComponent?: string;
+        defaultComponents?: string;
     };
 };
-
-declare module '@nuxt/schema' {
+/**
+ * Prismic Nuxt module options.
+ *
+ * @see {@link https://prismic.io/docs/nuxt}
+ * @see {@link https://prismic.io/docs/technical-reference/nuxtjs-prismic}
+ */
+type ModuleOptions = PrismicModuleOptions;
+declare module "@nuxt/schema" {
     interface PublicRuntimeConfig {
-        /**
-         * `@nuxtjs/prismic` module options.
-         *
-         * @see Module documentation: {@link https://prismic.nuxtjs.org}
-         * @see Prismic documentation: {@link https://prismic.io/docs/nuxt-3-setup}
-         */
+        /** The Prismic Nuxt module options. */
         prismic: PrismicModuleOptions;
     }
 }
 declare const _default: _nuxt_schema.NuxtModule<PrismicModuleOptions, PrismicModuleOptions, false>;
 
-export { type PrismicModuleOptions as ModuleOptions, type PrismicModuleOptions, _default as default };
+export { _default as default };
+export type { ModuleOptions, PrismicModuleOptions };

package/dist/module.json

@@ -4,9 +4,9 @@
   "compatibility": {
     "nuxt": ">=3.7.0"
   },
-  "version": "4.0.1",
+  "version": "4.1.0-pr.235.302ce94",
   "builder": {
-    "@nuxt/module-builder": "0.8.4",
-    "unbuild": "2.0.0"
+    "@nuxt/module-builder": "1.0.2",
+    "unbuild": "3.6.1"
   }
 }