@rezo-zero/nuxt-cache-control 0.0.3

package/README.md

@@ -0,0 +1,93 @@
+# Nuxt Cache-Control
+
+[![npm version][npm-version-src]][npm-version-href]
+[![Nuxt][nuxt-src]][nuxt-href]
+
+Declare fine-grained cache control headers for your Nuxt application in each page.
+
+- [✨  Release Notes](/CHANGELOG.md)
+
+## Features
+
+- **Fine-grained cache control**: Set cache control headers for each page with `useCacheControl` composable.
+- **Prevents caching when response status is not 200**
+- **Prevents public responses when some cookies attached**: configure some cookies names for which cache-control will be private.
+
+## Quick Setup
+
+Install the module to your Nuxt application with one command:
+
+```bash
+npx nuxi module add @rezo-zero/nuxt-cache-control
+```
+
+### Configure module
+
+```ts
+// nuxt.config.ts
+export default defineNuxtConfig({
+    modules: [
+        '@rezo-zero/nuxt-cache-control'
+    ],
+    cacheControl: {
+        noCacheCookies: ['cart', 'session', 'auth']
+    }
+})
+```
+
+That's it! You can now use Nuxt Cache Control in your Nuxt app with `useCacheControl` composable.
+
+```ts
+export interface CacheControlOptions {
+    maxAge?: number // in seconds
+    sMaxAge?: number // in seconds
+    staleWhileRevalidate?: number | true // in seconds, or true, which means infinite staleWhileRevalidate
+    public: boolean
+}
+```
+
+
+## Contribution
+
+<details>
+  <summary>Local development</summary>
+  
+  ```bash
+  # Install dependencies
+  pnpm install
+  
+  # Generate type stubs
+  pnpm dev:prepare
+  
+  # Develop with the playground
+  pnpm dev
+  
+  # Build the playground
+  pnpm dev:build
+  
+  # Run ESLint
+  pnpm lint
+  
+  # Run Vitest
+  pnpm test
+  pnpm test:watch
+  
+  # Release new version
+  pnpm release
+  ```
+
+</details>
+
+
+<!-- Badges -->
+[npm-version-src]: https://img.shields.io/npm/v/@rezo-zero/nuxt-cache-control/latest.svg?style=flat&colorA=020420&colorB=00DC82
+[npm-version-href]: https://npmjs.com/package/@rezo-zero/nuxt-cache-control
+
+[npm-downloads-src]: https://img.shields.io/npm/dm/@rezo-zero/nuxt-cache-control.svg?style=flat&colorA=020420&colorB=00DC82
+[npm-downloads-href]: https://npmjs.com/package/@rezo-zero/nuxt-cache-control
+
+[license-src]: https://img.shields.io/npm/l/@rezo-zero/nuxt-cache-control.svg?style=flat&colorA=020420&colorB=00DC82
+[license-href]: https://npmjs.com/package/@rezo-zero/nuxt-cache-control
+
+[nuxt-src]: https://img.shields.io/badge/Nuxt-020420?logo=nuxt.js
+[nuxt-href]: https://nuxt.com

package/dist/module.cjs

@@ -0,0 +1,5 @@
+module.exports = function(...args) {
+  return import('./module.mjs').then(m => m.default.call(this, ...args))
+}
+const _meta = module.exports.meta = require('./module.json')
+module.exports.getMeta = () => Promise.resolve(_meta)

package/dist/module.d.mts

@@ -0,0 +1,8 @@
+import * as _nuxt_schema from '@nuxt/schema';
+
+interface ModuleOptions {
+    noCacheCookies?: string[];
+}
+declare const _default: _nuxt_schema.NuxtModule<ModuleOptions>;
+
+export { type ModuleOptions, _default as default };

package/dist/module.d.ts

@@ -0,0 +1,8 @@
+import * as _nuxt_schema from '@nuxt/schema';
+
+interface ModuleOptions {
+    noCacheCookies?: string[];
+}
+declare const _default: _nuxt_schema.NuxtModule<ModuleOptions>;
+
+export { type ModuleOptions, _default as default };

package/dist/module.json

@@ -0,0 +1,8 @@
+{
+  "name": "nuxt-cache-control",
+  "configKey": "cacheControl",
+  "compatibility": {
+    "nuxt": "^3.10.0"
+  },
+  "version": "0.0.3"
+}

package/dist/module.mjs

@@ -0,0 +1,28 @@
+import { defineNuxtModule, createResolver, addImports, addServerPlugin } from '@nuxt/kit';
+import { defu } from 'defu';
+
+const module = defineNuxtModule({
+  meta: {
+    name: "nuxt-cache-control",
+    configKey: "cacheControl",
+    // Compatibility constraints
+    compatibility: {
+      // Semver version of supported nuxt versions
+      nuxt: "^3.10.0"
+    }
+  },
+  setup(options, nuxt) {
+    const { resolve } = createResolver(import.meta.url);
+    nuxt.options.runtimeConfig.cacheControl = defu(nuxt.options.runtimeConfig.cacheControl || {}, options);
+    addImports({
+      name: "useCacheControl",
+      // name of the composable to be used
+      as: "useCacheControl",
+      from: resolve("runtime/composables/use-cache-control")
+      // path of composable
+    });
+    addServerPlugin(resolve("runtime/server/plugins/cache-control"));
+  }
+});
+
+export { module as default };

package/dist/runtime/composables/use-cache-control.d.ts

@@ -0,0 +1,10 @@
+/**
+ * @see https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Cache-Control#directives
+ */
+export interface CacheControlOptions {
+    maxAge?: number;
+    sMaxAge?: number;
+    staleWhileRevalidate?: number | true;
+    public: boolean;
+}
+export declare function useCacheControl(cacheControl: CacheControlOptions): void;

package/dist/runtime/composables/use-cache-control.mjs

@@ -0,0 +1,13 @@
+import { getCurrentInstance, useSSRContext } from "vue";
+export function useCacheControl(cacheControl) {
+  if (process.client) {
+    return;
+  }
+  if (!getCurrentInstance()) {
+    return;
+  }
+  const ssrContext = useSSRContext();
+  if (ssrContext && ssrContext.event) {
+    ssrContext.event.context.cacheControl = cacheControl;
+  }
+}

package/dist/runtime/server/plugins/cache-control.d.ts

@@ -0,0 +1,2 @@
+declare const _default: any;
+export default _default;

package/dist/runtime/server/plugins/cache-control.mjs

@@ -0,0 +1,37 @@
+export default defineNitroPlugin((nitroApp) => {
+  nitroApp.hooks.hook("render:response", (_response, { event }) => {
+    const qs = getQuery(event);
+    if (getResponseStatus(event) !== 200) {
+      setResponseHeader(event, "Cache-Control", `private, no-cache, no-store, must-revalidate`);
+      return;
+    }
+    if (qs.url && qs.statusCode) {
+      setResponseHeader(event, "Cache-Control", `private, no-cache, no-store, must-revalidate`);
+      return;
+    }
+    const cacheControl = event.context.cacheControl || {
+      maxAge: 0,
+      public: false
+    };
+    const cookies = parseCookies(event);
+    const noCacheCookies = useRuntimeConfig().cacheControl.noCacheCookies || [];
+    const noCache = noCacheCookies.some((cookie) => cookies[cookie]);
+    if (!noCache && cacheControl.public) {
+      const cacheControlHeader = [`public`];
+      if (cacheControl?.maxAge >= 0) {
+        cacheControlHeader.push(`max-age=${cacheControl.maxAge}`);
+      }
+      if (cacheControl?.sMaxAge >= 0) {
+        cacheControlHeader.push(`s-maxage=${cacheControl.sMaxAge}`);
+      }
+      if (cacheControl?.staleWhileRevalidate === true) {
+        cacheControlHeader.push(`stale-while-revalidate`);
+      } else if (cacheControl?.staleWhileRevalidate > 0) {
+        cacheControlHeader.push(`stale-while-revalidate=${cacheControl.staleWhileRevalidate}`);
+      }
+      setResponseHeader(event, "Cache-Control", cacheControlHeader.join(", "));
+    } else {
+      setResponseHeader(event, "Cache-Control", `private, no-cache, no-store, must-revalidate`);
+    }
+  });
+});

package/dist/types.d.mts

@@ -0,0 +1,16 @@
+
+import type { ModuleOptions } from './module.js'
+
+
+declare module '@nuxt/schema' {
+  interface NuxtConfig { ['cacheControl']?: Partial<ModuleOptions> }
+  interface NuxtOptions { ['cacheControl']?: ModuleOptions }
+}
+
+declare module 'nuxt/schema' {
+  interface NuxtConfig { ['cacheControl']?: Partial<ModuleOptions> }
+  interface NuxtOptions { ['cacheControl']?: ModuleOptions }
+}
+
+
+export type { ModuleOptions, default } from './module.js'

package/dist/types.d.ts

@@ -0,0 +1,16 @@
+
+import type { ModuleOptions } from './module'
+
+
+declare module '@nuxt/schema' {
+  interface NuxtConfig { ['cacheControl']?: Partial<ModuleOptions> }
+  interface NuxtOptions { ['cacheControl']?: ModuleOptions }
+}
+
+declare module 'nuxt/schema' {
+  interface NuxtConfig { ['cacheControl']?: Partial<ModuleOptions> }
+  interface NuxtOptions { ['cacheControl']?: ModuleOptions }
+}
+
+
+export type { ModuleOptions, default } from './module'

package/package.json

@@ -0,0 +1,55 @@
+{
+  "name": "@rezo-zero/nuxt-cache-control",
+  "version": "0.0.3",
+  "description": "Declare fine-grained cache control headers for your Nuxt application in each page",
+  "license": "MIT",
+  "type": "module",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/rezozero/nuxt-cache-control.git"
+  },
+  "exports": {
+    ".": {
+      "types": "./dist/types.d.ts",
+      "import": "./dist/module.mjs",
+      "require": "./dist/module.cjs"
+    }
+  },
+  "main": "./dist/module.cjs",
+  "types": "./dist/types.d.ts",
+  "files": [
+    "dist"
+  ],
+  "scripts": {
+    "prepack": "nuxt-module-build build",
+    "dev": "nuxi dev playground",
+    "dev:build": "nuxi build playground",
+    "dev:prepare": "nuxt-module-build build --stub && nuxt-module-build prepare && nuxi prepare playground",
+    "release": "npm run lint && npm run test && npm run prepack && changelogen --release && npm publish --access=public && git push --follow-tags",
+    "lint": "eslint .",
+    "test": "vitest run",
+    "test:watch": "vitest watch"
+  },
+  "dependencies": {
+    "@nuxt/kit": "^3.11.1",
+    "defu": "^6.1.4"
+  },
+  "devDependencies": {
+    "@nuxt/devtools": "latest",
+    "@nuxt/eslint-config": "^0.2.0",
+    "@nuxt/module-builder": "^0.5.5",
+    "@nuxt/schema": "^3.11.1",
+    "@nuxt/test-utils": "^3.12.0",
+    "@types/node": "^20.11.29",
+    "changelogen": "^0.5.5",
+    "eslint": "^8.57.0",
+    "eslint-config-prettier": "^9.1.0",
+    "eslint-plugin-prettier": "^5.1.3",
+    "nuxt": "^3.11.1",
+    "prettier": "^3.2.5",
+    "vitest": "^1.4.0"
+  },
+  "engines": {
+    "node": "^20"
+  }
+}