@spoosh/plugin-nextjs 0.3.1 → 0.5.0
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/index.d.mts +12 -3
- package/dist/index.d.ts +12 -3
- package/dist/index.js +1 -1
- package/dist/index.js.map +1 -1
- package/dist/index.mjs +1 -1
- package/dist/index.mjs.map +1 -1
- package/package.json +3 -3
package/dist/index.d.mts
CHANGED
|
@@ -15,9 +15,16 @@ interface NextjsWriteTriggerOptions {
|
|
|
15
15
|
/** Whether to trigger server revalidation. Overrides plugin default. */
|
|
16
16
|
serverRevalidate?: boolean;
|
|
17
17
|
}
|
|
18
|
-
type
|
|
18
|
+
type NextjsPagesOptions = object;
|
|
19
|
+
interface NextjsQueueTriggerOptions {
|
|
20
|
+
/** Additional paths to revalidate after queue item completes */
|
|
21
|
+
revalidatePaths?: string[];
|
|
22
|
+
/** Whether to trigger server revalidation. Overrides plugin default. */
|
|
23
|
+
serverRevalidate?: boolean;
|
|
24
|
+
}
|
|
19
25
|
type NextjsReadResult = object;
|
|
20
26
|
type NextjsWriteResult = object;
|
|
27
|
+
type NextjsQueueResult = object;
|
|
21
28
|
|
|
22
29
|
/**
|
|
23
30
|
* Next.js integration plugin for server-side revalidation.
|
|
@@ -52,9 +59,11 @@ declare function nextjsPlugin(config?: NextjsPluginConfig): SpooshPlugin<{
|
|
|
52
59
|
readOptions: NextjsReadOptions;
|
|
53
60
|
writeOptions: NextjsWriteOptions;
|
|
54
61
|
writeTriggerOptions: NextjsWriteTriggerOptions;
|
|
55
|
-
|
|
62
|
+
queueTriggerOptions: NextjsQueueTriggerOptions;
|
|
63
|
+
pagesOptions: NextjsPagesOptions;
|
|
56
64
|
readResult: NextjsReadResult;
|
|
57
65
|
writeResult: NextjsWriteResult;
|
|
66
|
+
queueResult: NextjsQueueResult;
|
|
58
67
|
}>;
|
|
59
68
|
|
|
60
|
-
export { type
|
|
69
|
+
export { type NextjsPagesOptions, type NextjsPluginConfig, type NextjsQueueResult, type NextjsQueueTriggerOptions, type NextjsReadOptions, type NextjsReadResult, type NextjsWriteOptions, type NextjsWriteResult, type NextjsWriteTriggerOptions, type ServerRevalidateHandler, nextjsPlugin };
|
package/dist/index.d.ts
CHANGED
|
@@ -15,9 +15,16 @@ interface NextjsWriteTriggerOptions {
|
|
|
15
15
|
/** Whether to trigger server revalidation. Overrides plugin default. */
|
|
16
16
|
serverRevalidate?: boolean;
|
|
17
17
|
}
|
|
18
|
-
type
|
|
18
|
+
type NextjsPagesOptions = object;
|
|
19
|
+
interface NextjsQueueTriggerOptions {
|
|
20
|
+
/** Additional paths to revalidate after queue item completes */
|
|
21
|
+
revalidatePaths?: string[];
|
|
22
|
+
/** Whether to trigger server revalidation. Overrides plugin default. */
|
|
23
|
+
serverRevalidate?: boolean;
|
|
24
|
+
}
|
|
19
25
|
type NextjsReadResult = object;
|
|
20
26
|
type NextjsWriteResult = object;
|
|
27
|
+
type NextjsQueueResult = object;
|
|
21
28
|
|
|
22
29
|
/**
|
|
23
30
|
* Next.js integration plugin for server-side revalidation.
|
|
@@ -52,9 +59,11 @@ declare function nextjsPlugin(config?: NextjsPluginConfig): SpooshPlugin<{
|
|
|
52
59
|
readOptions: NextjsReadOptions;
|
|
53
60
|
writeOptions: NextjsWriteOptions;
|
|
54
61
|
writeTriggerOptions: NextjsWriteTriggerOptions;
|
|
55
|
-
|
|
62
|
+
queueTriggerOptions: NextjsQueueTriggerOptions;
|
|
63
|
+
pagesOptions: NextjsPagesOptions;
|
|
56
64
|
readResult: NextjsReadResult;
|
|
57
65
|
writeResult: NextjsWriteResult;
|
|
66
|
+
queueResult: NextjsQueueResult;
|
|
58
67
|
}>;
|
|
59
68
|
|
|
60
|
-
export { type
|
|
69
|
+
export { type NextjsPagesOptions, type NextjsPluginConfig, type NextjsQueueResult, type NextjsQueueTriggerOptions, type NextjsReadOptions, type NextjsReadResult, type NextjsWriteOptions, type NextjsWriteResult, type NextjsWriteTriggerOptions, type ServerRevalidateHandler, nextjsPlugin };
|
package/dist/index.js
CHANGED
|
@@ -31,7 +31,7 @@ function nextjsPlugin(config = {}) {
|
|
|
31
31
|
const { serverRevalidator, skipServerRevalidation = false } = config;
|
|
32
32
|
return {
|
|
33
33
|
name: PLUGIN_NAME,
|
|
34
|
-
operations: ["write"],
|
|
34
|
+
operations: ["write", "queue"],
|
|
35
35
|
middleware: async (context, next) => {
|
|
36
36
|
const t = context.tracer?.(PLUGIN_NAME);
|
|
37
37
|
const response = await next();
|
package/dist/index.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"sources":["../src/index.ts","../src/plugin.ts"],"sourcesContent":["export * from \"./types\";\nexport * from \"./plugin\";\n","import type { SpooshPlugin } from \"@spoosh/core\";\nimport { resolvePathString } from \"@spoosh/core\";\n\nimport type {\n NextjsPluginConfig,\n NextjsReadOptions,\n NextjsWriteOptions,\n NextjsWriteTriggerOptions,\n
|
|
1
|
+
{"version":3,"sources":["../src/index.ts","../src/plugin.ts"],"sourcesContent":["export * from \"./types\";\nexport * from \"./plugin\";\n","import type { SpooshPlugin } from \"@spoosh/core\";\nimport { resolvePathString } from \"@spoosh/core\";\n\nimport type {\n NextjsPluginConfig,\n NextjsReadOptions,\n NextjsWriteOptions,\n NextjsWriteTriggerOptions,\n NextjsQueueTriggerOptions,\n NextjsPagesOptions,\n NextjsReadResult,\n NextjsWriteResult,\n NextjsQueueResult,\n} from \"./types\";\n\nconst PLUGIN_NAME = \"spoosh:nextjs\";\n\n/**\n * Next.js integration plugin for server-side revalidation.\n *\n * Automatically revalidates Next.js cache tags and paths after successful mutations.\n *\n * @param config - Plugin configuration\n *\n * @see {@link https://spoosh.dev/docs/react/plugins/nextjs | Next.js Plugin Documentation}\n *\n * @returns Next.js plugin instance\n *\n * @example\n * ```ts\n * import { Spoosh } from \"@spoosh/core\";\n * import { nextjsPlugin } from \"@spoosh/plugin-nextjs\";\n *\n * const spoosh = new Spoosh<ApiSchema, Error>(\"/api\")\n * .use([\n * nextjsPlugin({\n * serverRevalidator: async (tags, paths) => {\n * \"use server\";\n * const { revalidateTag, revalidatePath } = await import(\"next/cache\");\n * tags.forEach((tag) => revalidateTag(tag));\n * paths.forEach((path) => revalidatePath(path));\n * },\n * }),\n * ]);\n * ```\n */\nexport function nextjsPlugin(config: NextjsPluginConfig = {}): SpooshPlugin<{\n readOptions: NextjsReadOptions;\n writeOptions: NextjsWriteOptions;\n writeTriggerOptions: NextjsWriteTriggerOptions;\n queueTriggerOptions: NextjsQueueTriggerOptions;\n pagesOptions: NextjsPagesOptions;\n readResult: NextjsReadResult;\n writeResult: NextjsWriteResult;\n queueResult: NextjsQueueResult;\n}> {\n const { serverRevalidator, skipServerRevalidation = false } = config;\n\n return {\n name: PLUGIN_NAME,\n operations: [\"write\", \"queue\"],\n\n middleware: async (context, next) => {\n const t = context.tracer?.(PLUGIN_NAME);\n const response = await next();\n\n if (response.error) {\n return response;\n }\n\n if (!serverRevalidator) {\n t?.skip(\"No revalidator\", { color: \"muted\" });\n return response;\n }\n\n const pluginOptions = context.pluginOptions as\n | NextjsWriteTriggerOptions\n | undefined;\n\n const shouldRevalidate =\n pluginOptions?.serverRevalidate ?? !skipServerRevalidation;\n\n if (!shouldRevalidate) {\n t?.skip(\"Revalidation disabled\", { color: \"muted\" });\n return response;\n }\n\n const revalidatePaths = pluginOptions?.revalidatePaths ?? [];\n const params = context.request.params as\n | Record<string, string | number>\n | undefined;\n const resolvedTags = context.tags.map((tag) =>\n resolvePathString(tag, params)\n );\n\n if (resolvedTags.length > 0 || revalidatePaths.length > 0) {\n t?.log(`Revalidated`, {\n color: \"info\",\n info: [\n { label: \"tags\", value: resolvedTags },\n { label: \"paths\", value: revalidatePaths },\n ],\n });\n\n await serverRevalidator(resolvedTags, revalidatePaths);\n } else {\n t?.skip(\"Nothing to revalidate\", { color: \"muted\" });\n }\n\n return response;\n },\n };\n}\n"],"mappings":";;;;;;;;;;;;;;;;;;;;AAAA;AAAA;AAAA;AAAA;AAAA;;;ACCA,kBAAkC;AAclC,IAAM,cAAc;AA+Bb,SAAS,aAAa,SAA6B,CAAC,GASxD;AACD,QAAM,EAAE,mBAAmB,yBAAyB,MAAM,IAAI;AAE9D,SAAO;AAAA,IACL,MAAM;AAAA,IACN,YAAY,CAAC,SAAS,OAAO;AAAA,IAE7B,YAAY,OAAO,SAAS,SAAS;AACnC,YAAM,IAAI,QAAQ,SAAS,WAAW;AACtC,YAAM,WAAW,MAAM,KAAK;AAE5B,UAAI,SAAS,OAAO;AAClB,eAAO;AAAA,MACT;AAEA,UAAI,CAAC,mBAAmB;AACtB,WAAG,KAAK,kBAAkB,EAAE,OAAO,QAAQ,CAAC;AAC5C,eAAO;AAAA,MACT;AAEA,YAAM,gBAAgB,QAAQ;AAI9B,YAAM,mBACJ,eAAe,oBAAoB,CAAC;AAEtC,UAAI,CAAC,kBAAkB;AACrB,WAAG,KAAK,yBAAyB,EAAE,OAAO,QAAQ,CAAC;AACnD,eAAO;AAAA,MACT;AAEA,YAAM,kBAAkB,eAAe,mBAAmB,CAAC;AAC3D,YAAM,SAAS,QAAQ,QAAQ;AAG/B,YAAM,eAAe,QAAQ,KAAK;AAAA,QAAI,CAAC,YACrC,+BAAkB,KAAK,MAAM;AAAA,MAC/B;AAEA,UAAI,aAAa,SAAS,KAAK,gBAAgB,SAAS,GAAG;AACzD,WAAG,IAAI,eAAe;AAAA,UACpB,OAAO;AAAA,UACP,MAAM;AAAA,YACJ,EAAE,OAAO,QAAQ,OAAO,aAAa;AAAA,YACrC,EAAE,OAAO,SAAS,OAAO,gBAAgB;AAAA,UAC3C;AAAA,QACF,CAAC;AAED,cAAM,kBAAkB,cAAc,eAAe;AAAA,MACvD,OAAO;AACL,WAAG,KAAK,yBAAyB,EAAE,OAAO,QAAQ,CAAC;AAAA,MACrD;AAEA,aAAO;AAAA,IACT;AAAA,EACF;AACF;","names":[]}
|
package/dist/index.mjs
CHANGED
|
@@ -5,7 +5,7 @@ function nextjsPlugin(config = {}) {
|
|
|
5
5
|
const { serverRevalidator, skipServerRevalidation = false } = config;
|
|
6
6
|
return {
|
|
7
7
|
name: PLUGIN_NAME,
|
|
8
|
-
operations: ["write"],
|
|
8
|
+
operations: ["write", "queue"],
|
|
9
9
|
middleware: async (context, next) => {
|
|
10
10
|
const t = context.tracer?.(PLUGIN_NAME);
|
|
11
11
|
const response = await next();
|
package/dist/index.mjs.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"sources":["../src/plugin.ts"],"sourcesContent":["import type { SpooshPlugin } from \"@spoosh/core\";\nimport { resolvePathString } from \"@spoosh/core\";\n\nimport type {\n NextjsPluginConfig,\n NextjsReadOptions,\n NextjsWriteOptions,\n NextjsWriteTriggerOptions,\n
|
|
1
|
+
{"version":3,"sources":["../src/plugin.ts"],"sourcesContent":["import type { SpooshPlugin } from \"@spoosh/core\";\nimport { resolvePathString } from \"@spoosh/core\";\n\nimport type {\n NextjsPluginConfig,\n NextjsReadOptions,\n NextjsWriteOptions,\n NextjsWriteTriggerOptions,\n NextjsQueueTriggerOptions,\n NextjsPagesOptions,\n NextjsReadResult,\n NextjsWriteResult,\n NextjsQueueResult,\n} from \"./types\";\n\nconst PLUGIN_NAME = \"spoosh:nextjs\";\n\n/**\n * Next.js integration plugin for server-side revalidation.\n *\n * Automatically revalidates Next.js cache tags and paths after successful mutations.\n *\n * @param config - Plugin configuration\n *\n * @see {@link https://spoosh.dev/docs/react/plugins/nextjs | Next.js Plugin Documentation}\n *\n * @returns Next.js plugin instance\n *\n * @example\n * ```ts\n * import { Spoosh } from \"@spoosh/core\";\n * import { nextjsPlugin } from \"@spoosh/plugin-nextjs\";\n *\n * const spoosh = new Spoosh<ApiSchema, Error>(\"/api\")\n * .use([\n * nextjsPlugin({\n * serverRevalidator: async (tags, paths) => {\n * \"use server\";\n * const { revalidateTag, revalidatePath } = await import(\"next/cache\");\n * tags.forEach((tag) => revalidateTag(tag));\n * paths.forEach((path) => revalidatePath(path));\n * },\n * }),\n * ]);\n * ```\n */\nexport function nextjsPlugin(config: NextjsPluginConfig = {}): SpooshPlugin<{\n readOptions: NextjsReadOptions;\n writeOptions: NextjsWriteOptions;\n writeTriggerOptions: NextjsWriteTriggerOptions;\n queueTriggerOptions: NextjsQueueTriggerOptions;\n pagesOptions: NextjsPagesOptions;\n readResult: NextjsReadResult;\n writeResult: NextjsWriteResult;\n queueResult: NextjsQueueResult;\n}> {\n const { serverRevalidator, skipServerRevalidation = false } = config;\n\n return {\n name: PLUGIN_NAME,\n operations: [\"write\", \"queue\"],\n\n middleware: async (context, next) => {\n const t = context.tracer?.(PLUGIN_NAME);\n const response = await next();\n\n if (response.error) {\n return response;\n }\n\n if (!serverRevalidator) {\n t?.skip(\"No revalidator\", { color: \"muted\" });\n return response;\n }\n\n const pluginOptions = context.pluginOptions as\n | NextjsWriteTriggerOptions\n | undefined;\n\n const shouldRevalidate =\n pluginOptions?.serverRevalidate ?? !skipServerRevalidation;\n\n if (!shouldRevalidate) {\n t?.skip(\"Revalidation disabled\", { color: \"muted\" });\n return response;\n }\n\n const revalidatePaths = pluginOptions?.revalidatePaths ?? [];\n const params = context.request.params as\n | Record<string, string | number>\n | undefined;\n const resolvedTags = context.tags.map((tag) =>\n resolvePathString(tag, params)\n );\n\n if (resolvedTags.length > 0 || revalidatePaths.length > 0) {\n t?.log(`Revalidated`, {\n color: \"info\",\n info: [\n { label: \"tags\", value: resolvedTags },\n { label: \"paths\", value: revalidatePaths },\n ],\n });\n\n await serverRevalidator(resolvedTags, revalidatePaths);\n } else {\n t?.skip(\"Nothing to revalidate\", { color: \"muted\" });\n }\n\n return response;\n },\n };\n}\n"],"mappings":";AACA,SAAS,yBAAyB;AAclC,IAAM,cAAc;AA+Bb,SAAS,aAAa,SAA6B,CAAC,GASxD;AACD,QAAM,EAAE,mBAAmB,yBAAyB,MAAM,IAAI;AAE9D,SAAO;AAAA,IACL,MAAM;AAAA,IACN,YAAY,CAAC,SAAS,OAAO;AAAA,IAE7B,YAAY,OAAO,SAAS,SAAS;AACnC,YAAM,IAAI,QAAQ,SAAS,WAAW;AACtC,YAAM,WAAW,MAAM,KAAK;AAE5B,UAAI,SAAS,OAAO;AAClB,eAAO;AAAA,MACT;AAEA,UAAI,CAAC,mBAAmB;AACtB,WAAG,KAAK,kBAAkB,EAAE,OAAO,QAAQ,CAAC;AAC5C,eAAO;AAAA,MACT;AAEA,YAAM,gBAAgB,QAAQ;AAI9B,YAAM,mBACJ,eAAe,oBAAoB,CAAC;AAEtC,UAAI,CAAC,kBAAkB;AACrB,WAAG,KAAK,yBAAyB,EAAE,OAAO,QAAQ,CAAC;AACnD,eAAO;AAAA,MACT;AAEA,YAAM,kBAAkB,eAAe,mBAAmB,CAAC;AAC3D,YAAM,SAAS,QAAQ,QAAQ;AAG/B,YAAM,eAAe,QAAQ,KAAK;AAAA,QAAI,CAAC,QACrC,kBAAkB,KAAK,MAAM;AAAA,MAC/B;AAEA,UAAI,aAAa,SAAS,KAAK,gBAAgB,SAAS,GAAG;AACzD,WAAG,IAAI,eAAe;AAAA,UACpB,OAAO;AAAA,UACP,MAAM;AAAA,YACJ,EAAE,OAAO,QAAQ,OAAO,aAAa;AAAA,YACrC,EAAE,OAAO,SAAS,OAAO,gBAAgB;AAAA,UAC3C;AAAA,QACF,CAAC;AAED,cAAM,kBAAkB,cAAc,eAAe;AAAA,MACvD,OAAO;AACL,WAAG,KAAK,yBAAyB,EAAE,OAAO,QAAQ,CAAC;AAAA,MACrD;AAEA,aAAO;AAAA,IACT;AAAA,EACF;AACF;","names":[]}
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@spoosh/plugin-nextjs",
|
|
3
|
-
"version": "0.
|
|
3
|
+
"version": "0.5.0",
|
|
4
4
|
"description": "Next.js integration plugin for Spoosh - server revalidation after mutations",
|
|
5
5
|
"license": "MIT",
|
|
6
6
|
"repository": {
|
|
@@ -34,11 +34,11 @@
|
|
|
34
34
|
}
|
|
35
35
|
},
|
|
36
36
|
"peerDependencies": {
|
|
37
|
-
"@spoosh/core": ">=0.
|
|
37
|
+
"@spoosh/core": ">=0.15.0",
|
|
38
38
|
"next": ">=13.0.0"
|
|
39
39
|
},
|
|
40
40
|
"devDependencies": {
|
|
41
|
-
"@spoosh/core": "0.
|
|
41
|
+
"@spoosh/core": "0.15.0"
|
|
42
42
|
},
|
|
43
43
|
"scripts": {
|
|
44
44
|
"dev": "tsup --watch",
|