@nuxtjs/prismic 3.0.0-rc.4 → 3.0.0-rc.6
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/module.d.ts +12 -12
- package/dist/module.json +1 -1
- package/dist/module.mjs +17 -15
- package/dist/runtime/plugin.client.d.ts +2 -2
- package/dist/runtime/plugin.d.ts +2 -2
- package/dist/runtime/plugin.mjs +1 -0
- package/dist/runtime/usePrismicPreview.d.ts +6 -6
- package/dist/types.d.ts +1 -0
- package/package.json +10 -10
- package/src/lib/logger.ts +2 -2
- package/src/module.ts +16 -15
package/dist/module.d.ts
CHANGED
|
@@ -1,20 +1,20 @@
|
|
|
1
1
|
import * as _nuxt_schema from '@nuxt/schema';
|
|
2
2
|
import { PrismicPluginOptions } from '@prismicio/vue';
|
|
3
3
|
|
|
4
|
-
type PrismicModuleOptions = Omit<PrismicPluginOptions, 'endpoint' | 'client' | 'linkResolver' | 'htmlSerializer'> & {
|
|
5
|
-
endpoint: string;
|
|
6
|
-
client?: string;
|
|
7
|
-
linkResolver?: string;
|
|
8
|
-
htmlSerializer?: string;
|
|
9
|
-
preview?: string | false;
|
|
10
|
-
toolbar?: boolean;
|
|
4
|
+
type PrismicModuleOptions = Omit<PrismicPluginOptions, 'endpoint' | 'client' | 'linkResolver' | 'htmlSerializer'> & {
|
|
5
|
+
endpoint: string;
|
|
6
|
+
client?: string;
|
|
7
|
+
linkResolver?: string;
|
|
8
|
+
htmlSerializer?: string;
|
|
9
|
+
preview?: string | false;
|
|
10
|
+
toolbar?: boolean;
|
|
11
11
|
};
|
|
12
12
|
|
|
13
|
-
declare module '@nuxt/schema' {
|
|
14
|
-
interface PublicRuntimeConfig {
|
|
15
|
-
prismic: PrismicModuleOptions;
|
|
16
|
-
}
|
|
17
|
-
}
|
|
13
|
+
declare module '@nuxt/schema' {
|
|
14
|
+
interface PublicRuntimeConfig {
|
|
15
|
+
prismic: PrismicModuleOptions;
|
|
16
|
+
}
|
|
17
|
+
}
|
|
18
18
|
declare const _default: _nuxt_schema.NuxtModule<PrismicModuleOptions>;
|
|
19
19
|
|
|
20
20
|
export { PrismicModuleOptions, _default as default };
|
package/dist/module.json
CHANGED
package/dist/module.mjs
CHANGED
|
@@ -2,10 +2,10 @@ import { join } from 'node:path';
|
|
|
2
2
|
import { defu } from 'defu';
|
|
3
3
|
import { defineNuxtModule, createResolver, addPlugin, addComponent, addImports, extendPages, addTemplate } from '@nuxt/kit';
|
|
4
4
|
import * as prismicVue from '@prismicio/vue';
|
|
5
|
-
import consola from 'consola';
|
|
5
|
+
import { consola } from 'consola';
|
|
6
6
|
import { existsSync } from 'node:fs';
|
|
7
7
|
|
|
8
|
-
const logger = consola.
|
|
8
|
+
const logger = consola.withTag("nuxt:prismic");
|
|
9
9
|
|
|
10
10
|
const fileExists = (path, extensions = ["js", "ts"]) => {
|
|
11
11
|
if (!path) {
|
|
@@ -37,7 +37,10 @@ const module = defineNuxtModule({
|
|
|
37
37
|
hooks: {},
|
|
38
38
|
setup(options, nuxt) {
|
|
39
39
|
var _a;
|
|
40
|
-
|
|
40
|
+
(_a = nuxt.options.runtimeConfig).public || (_a.public = {});
|
|
41
|
+
const moduleOptions = defu(nuxt.options.runtimeConfig.public.prismic, options);
|
|
42
|
+
nuxt.options.runtimeConfig.public.prismic = moduleOptions;
|
|
43
|
+
if (!moduleOptions.endpoint) {
|
|
41
44
|
logger.warn("Options `endpoint` is required, disabling module...");
|
|
42
45
|
return;
|
|
43
46
|
}
|
|
@@ -60,14 +63,12 @@ const module = defineNuxtModule({
|
|
|
60
63
|
});
|
|
61
64
|
}
|
|
62
65
|
};
|
|
63
|
-
proxyUserFileWithUndefinedFallback("client",
|
|
64
|
-
proxyUserFileWithUndefinedFallback("linkResolver",
|
|
65
|
-
proxyUserFileWithUndefinedFallback("htmlSerializer",
|
|
66
|
-
(_a = nuxt.options.runtimeConfig).public || (_a.public = {});
|
|
67
|
-
nuxt.options.runtimeConfig.public.prismic = defu(nuxt.options.runtimeConfig.public.prismic, options);
|
|
66
|
+
proxyUserFileWithUndefinedFallback("client", moduleOptions.client);
|
|
67
|
+
proxyUserFileWithUndefinedFallback("linkResolver", moduleOptions.linkResolver);
|
|
68
|
+
proxyUserFileWithUndefinedFallback("htmlSerializer", moduleOptions.htmlSerializer);
|
|
68
69
|
addPlugin(resolver.resolve("runtime/plugin"));
|
|
69
70
|
addPlugin(resolver.resolve("runtime/plugin.client"));
|
|
70
|
-
if (
|
|
71
|
+
if (moduleOptions.injectComponents) {
|
|
71
72
|
[
|
|
72
73
|
"PrismicEmbed",
|
|
73
74
|
"PrismicImage",
|
|
@@ -96,21 +97,22 @@ const module = defineNuxtModule({
|
|
|
96
97
|
as: "usePrismicPreview",
|
|
97
98
|
from: resolver.resolve("runtime/usePrismicPreview")
|
|
98
99
|
});
|
|
99
|
-
if (
|
|
100
|
-
const maybeUserPreviewPage = fileExists(join(nuxt.options.srcDir, nuxt.options.dir.pages,
|
|
100
|
+
if (moduleOptions.preview) {
|
|
101
|
+
const maybeUserPreviewPage = fileExists(join(nuxt.options.srcDir, nuxt.options.dir.pages, moduleOptions.preview), ["js", "ts", "vue"]);
|
|
101
102
|
if (maybeUserPreviewPage) {
|
|
102
|
-
logger.info(`Using user-defined preview page at \`${maybeUserPreviewPage.replace(join(nuxt.options.srcDir), "~").replace(nuxt.options.rootDir, "~~").replace(/\\/g, "/")}\`, available at \`${
|
|
103
|
+
logger.info(`Using user-defined preview page at \`${maybeUserPreviewPage.replace(join(nuxt.options.srcDir), "~").replace(nuxt.options.rootDir, "~~").replace(/\\/g, "/")}\`, available at \`${moduleOptions.preview}\``);
|
|
103
104
|
} else {
|
|
104
|
-
logger.info(`Using default preview page, available at \`${
|
|
105
|
+
logger.info(`Using default preview page, available at \`${moduleOptions.preview}\``);
|
|
105
106
|
extendPages((pages) => {
|
|
106
107
|
pages.unshift({
|
|
107
108
|
name: "prismic-preview",
|
|
108
|
-
path:
|
|
109
|
+
path: moduleOptions.preview,
|
|
110
|
+
// Checked before
|
|
109
111
|
file: resolver.resolve("runtime/preview.vue")
|
|
110
112
|
});
|
|
111
113
|
});
|
|
112
114
|
}
|
|
113
|
-
if (!
|
|
115
|
+
if (!moduleOptions.toolbar) {
|
|
114
116
|
logger.warn("`toolbar` option is disabled but `preview` is enabled. Previews won't work unless you manually load the toolbar.");
|
|
115
117
|
}
|
|
116
118
|
}
|
|
@@ -1,2 +1,2 @@
|
|
|
1
|
-
declare const _default: any;
|
|
2
|
-
export default _default;
|
|
1
|
+
declare const _default: any;
|
|
2
|
+
export default _default;
|
package/dist/runtime/plugin.d.ts
CHANGED
|
@@ -1,2 +1,2 @@
|
|
|
1
|
-
declare const _default: any;
|
|
2
|
-
export default _default;
|
|
1
|
+
declare const _default: any;
|
|
2
|
+
export default _default;
|
package/dist/runtime/plugin.mjs
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
|
-
/**
|
|
2
|
-
* Resolves Prismic previews on the preview entry page (`/preview`)
|
|
3
|
-
*
|
|
4
|
-
* @param defaultURL - The default URL to redirect to if the previewed document doesn't map to one.
|
|
5
|
-
*/
|
|
6
|
-
export declare const usePrismicPreview: (defaultURL?: string) => void;
|
|
1
|
+
/**
|
|
2
|
+
* Resolves Prismic previews on the preview entry page (`/preview`)
|
|
3
|
+
*
|
|
4
|
+
* @param defaultURL - The default URL to redirect to if the previewed document doesn't map to one.
|
|
5
|
+
*/
|
|
6
|
+
export declare const usePrismicPreview: (defaultURL?: string) => void;
|
package/dist/types.d.ts
CHANGED
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@nuxtjs/prismic",
|
|
3
|
-
"version": "3.0.0-rc.
|
|
3
|
+
"version": "3.0.0-rc.6",
|
|
4
4
|
"description": "Easily connect your Nuxt 3 application to your content hosted on Prismic",
|
|
5
5
|
"keywords": [
|
|
6
6
|
"nuxt",
|
|
@@ -50,22 +50,22 @@
|
|
|
50
50
|
"unit:watch": "vitest watch"
|
|
51
51
|
},
|
|
52
52
|
"dependencies": {
|
|
53
|
-
"@nuxt/kit": "^3.3
|
|
53
|
+
"@nuxt/kit": "^3.4.3",
|
|
54
54
|
"@prismicio/client": "^6.7.3",
|
|
55
|
-
"@prismicio/vue": "^3.1.
|
|
56
|
-
"consola": "^
|
|
55
|
+
"@prismicio/vue": "^3.1.4",
|
|
56
|
+
"consola": "^3.1.0",
|
|
57
57
|
"defu": "^6.1.2"
|
|
58
58
|
},
|
|
59
59
|
"devDependencies": {
|
|
60
|
-
"@nuxt/module-builder": "^0.
|
|
60
|
+
"@nuxt/module-builder": "^0.3.1",
|
|
61
61
|
"@nuxtjs/eslint-config-typescript": "^12.0.0",
|
|
62
|
-
"@vitest/coverage-c8": "^0.
|
|
63
|
-
"eslint": "^8.
|
|
62
|
+
"@vitest/coverage-c8": "^0.31.0",
|
|
63
|
+
"eslint": "^8.39.0",
|
|
64
64
|
"mock-fs": "^5.2.0",
|
|
65
|
-
"nuxt": "^3.3
|
|
65
|
+
"nuxt": "^3.4.3",
|
|
66
66
|
"standard-version": "^9.5.0",
|
|
67
|
-
"typescript": "^
|
|
68
|
-
"vitest": "^0.
|
|
67
|
+
"typescript": "^5.0.4",
|
|
68
|
+
"vitest": "^0.31.0"
|
|
69
69
|
},
|
|
70
70
|
"engines": {
|
|
71
71
|
"node": ">=14.15.0"
|
package/src/lib/logger.ts
CHANGED
|
@@ -1,3 +1,3 @@
|
|
|
1
|
-
import consola from 'consola'
|
|
1
|
+
import { consola } from 'consola'
|
|
2
2
|
|
|
3
|
-
export const logger = consola.
|
|
3
|
+
export const logger = consola.withTag('nuxt:prismic')
|
package/src/module.ts
CHANGED
|
@@ -45,7 +45,12 @@ export default defineNuxtModule<PrismicModuleOptions>({
|
|
|
45
45
|
}),
|
|
46
46
|
hooks: {},
|
|
47
47
|
setup (options, nuxt) {
|
|
48
|
-
|
|
48
|
+
// Expose options through public runtime config
|
|
49
|
+
nuxt.options.runtimeConfig.public ||= {} as typeof nuxt.options.runtimeConfig.public
|
|
50
|
+
const moduleOptions: PrismicModuleOptions = defu(nuxt.options.runtimeConfig.public.prismic, options)
|
|
51
|
+
nuxt.options.runtimeConfig.public.prismic = moduleOptions
|
|
52
|
+
|
|
53
|
+
if (!moduleOptions.endpoint) {
|
|
49
54
|
logger.warn('Options `endpoint` is required, disabling module...')
|
|
50
55
|
return
|
|
51
56
|
}
|
|
@@ -76,20 +81,16 @@ export default defineNuxtModule<PrismicModuleOptions>({
|
|
|
76
81
|
})
|
|
77
82
|
}
|
|
78
83
|
}
|
|
79
|
-
proxyUserFileWithUndefinedFallback('client',
|
|
80
|
-
proxyUserFileWithUndefinedFallback('linkResolver',
|
|
81
|
-
proxyUserFileWithUndefinedFallback('htmlSerializer',
|
|
82
|
-
|
|
83
|
-
// Expose options through public runtime config
|
|
84
|
-
nuxt.options.runtimeConfig.public ||= {} as typeof nuxt.options.runtimeConfig.public
|
|
85
|
-
nuxt.options.runtimeConfig.public.prismic = defu(nuxt.options.runtimeConfig.public.prismic, options)
|
|
84
|
+
proxyUserFileWithUndefinedFallback('client', moduleOptions.client!)
|
|
85
|
+
proxyUserFileWithUndefinedFallback('linkResolver', moduleOptions.linkResolver!)
|
|
86
|
+
proxyUserFileWithUndefinedFallback('htmlSerializer', moduleOptions.htmlSerializer!)
|
|
86
87
|
|
|
87
88
|
// Add plugin
|
|
88
89
|
addPlugin(resolver.resolve('runtime/plugin'))
|
|
89
90
|
addPlugin(resolver.resolve('runtime/plugin.client'))
|
|
90
91
|
|
|
91
92
|
// Add components auto import
|
|
92
|
-
if (
|
|
93
|
+
if (moduleOptions.injectComponents) {
|
|
93
94
|
[
|
|
94
95
|
'PrismicEmbed',
|
|
95
96
|
'PrismicImage',
|
|
@@ -126,25 +127,25 @@ export default defineNuxtModule<PrismicModuleOptions>({
|
|
|
126
127
|
})
|
|
127
128
|
|
|
128
129
|
// Add preview route
|
|
129
|
-
if (
|
|
130
|
-
const maybeUserPreviewPage = fileExists(join(nuxt.options.srcDir, nuxt.options.dir.pages,
|
|
130
|
+
if (moduleOptions.preview) {
|
|
131
|
+
const maybeUserPreviewPage = fileExists(join(nuxt.options.srcDir, nuxt.options.dir.pages, moduleOptions.preview), ['js', 'ts', 'vue'])
|
|
131
132
|
|
|
132
133
|
if (maybeUserPreviewPage) {
|
|
133
134
|
logger.info(`Using user-defined preview page at \`${maybeUserPreviewPage.replace(join(nuxt.options.srcDir), '~').replace(nuxt.options.rootDir, '~~').replace(/\\/g, '/')
|
|
134
|
-
}\`, available at \`${
|
|
135
|
+
}\`, available at \`${moduleOptions.preview}\``)
|
|
135
136
|
} else {
|
|
136
|
-
logger.info(`Using default preview page, available at \`${
|
|
137
|
+
logger.info(`Using default preview page, available at \`${moduleOptions.preview}\``)
|
|
137
138
|
|
|
138
139
|
extendPages((pages) => {
|
|
139
140
|
pages.unshift({
|
|
140
141
|
name: 'prismic-preview',
|
|
141
|
-
path:
|
|
142
|
+
path: moduleOptions.preview as string, // Checked before
|
|
142
143
|
file: resolver.resolve('runtime/preview.vue')
|
|
143
144
|
})
|
|
144
145
|
})
|
|
145
146
|
}
|
|
146
147
|
|
|
147
|
-
if (!
|
|
148
|
+
if (!moduleOptions.toolbar) {
|
|
148
149
|
logger.warn('`toolbar` option is disabled but `preview` is enabled. Previews won\'t work unless you manually load the toolbar.')
|
|
149
150
|
}
|
|
150
151
|
}
|