@tickboxhq/nuxt 0.0.1

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Tiny Systems Limited
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,53 @@
+# @tickboxhq/nuxt
+
+Nuxt module for Tickbox. Wires up the Vue adapter, auto-imports `useConsent`, auto-registers `<ConsentBanner>`, and reads the consent cookie on the server so SSR'd pages reflect the visitor's choice.
+
+## Install
+
+```bash
+npm install @tickboxhq/nuxt
+```
+
+```ts
+// nuxt.config.ts
+export default defineNuxtConfig({
+  modules: ['@tickboxhq/nuxt'],
+})
+```
+
+```ts
+// consent.config.ts (project root)
+import { defineConsent, jurisdictions } from '@tickboxhq/core'
+
+export default defineConsent({
+  jurisdiction: jurisdictions.UK_DUAA,
+  policy: { version: '2026-05-06', url: '/privacy' },
+  categories: {
+    necessary: { required: true },
+    analytics: { vendors: ['plausible', 'fathom'] },
+  },
+})
+```
+
+## Use it
+
+`useConsent` is auto-imported. `<ConsentBanner>` is auto-registered.
+
+```vue
+<script setup lang="ts">
+const { granted, grant, deny } = useConsent('analytics')
+</script>
+
+<template>
+  <div>
+    <p v-if="granted">Analytics on</p>
+    <button @click="deny">Turn off</button>
+  </div>
+</template>
+```
+
+## Module options
+
+| Option | Default | Description |
+| --- | --- | --- |
+| `configPath` | `'~/consent.config'` | Path to the consent config file (relative to project root or using `~` / `@` aliases) |

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,15 @@
+import { NuxtModule } from '@nuxt/schema';
+
+interface ModuleOptions {
+    /**
+     * Path to the user's consent config file.
+     * The file must default-export a `ConsentConfig` (typically created via `defineConsent`).
+     *
+     * @default '~/consent.config'
+     */
+    configPath?: string;
+}
+declare const tickboxModule: NuxtModule<ModuleOptions>;
+
+export { tickboxModule as default };
+export type { ModuleOptions };

package/dist/module.d.ts

@@ -0,0 +1,15 @@
+import { NuxtModule } from '@nuxt/schema';
+
+interface ModuleOptions {
+    /**
+     * Path to the user's consent config file.
+     * The file must default-export a `ConsentConfig` (typically created via `defineConsent`).
+     *
+     * @default '~/consent.config'
+     */
+    configPath?: string;
+}
+declare const tickboxModule: NuxtModule<ModuleOptions>;
+
+export { tickboxModule as default };
+export type { ModuleOptions };

package/dist/module.json

@@ -0,0 +1,12 @@
+{
+  "name": "@tickboxhq/nuxt",
+  "configKey": "tickbox",
+  "compatibility": {
+    "nuxt": ">=3.0.0"
+  },
+  "version": "0.0.1",
+  "builder": {
+    "@nuxt/module-builder": "0.8.4",
+    "unbuild": "unknown"
+  }
+}

package/dist/module.mjs

@@ -0,0 +1,45 @@
+import { defineNuxtModule, createResolver, resolveAlias, addTemplate, addPlugin, addImports, addComponent } from '@nuxt/kit';
+
+const tickboxModule = defineNuxtModule({
+  meta: {
+    name: "@tickboxhq/nuxt",
+    configKey: "tickbox",
+    compatibility: {
+      nuxt: ">=3.0.0"
+    }
+  },
+  defaults: {
+    configPath: "~/consent.config"
+  },
+  setup(options, nuxt) {
+    const resolver = createResolver(import.meta.url);
+    const aliases = {
+      "~": nuxt.options.srcDir,
+      "@": nuxt.options.srcDir,
+      "~~": nuxt.options.rootDir,
+      "@@": nuxt.options.rootDir
+    };
+    const resolvedConfigPath = resolveAlias(options.configPath ?? "~/consent.config", aliases);
+    addTemplate({
+      filename: "tickbox-config.mjs",
+      write: true,
+      getContents: () => `export { default } from ${JSON.stringify(resolvedConfigPath)}
+`
+    });
+    nuxt.options.build.transpile.push("@tickboxhq/vue", "@tickboxhq/core");
+    addPlugin(resolver.resolve("./runtime/plugin"));
+    addImports([
+      {
+        name: "useConsent",
+        from: "@tickboxhq/vue"
+      }
+    ]);
+    addComponent({
+      name: "ConsentBanner",
+      filePath: "@tickboxhq/vue",
+      export: "ConsentBanner"
+    });
+  }
+});
+
+export { tickboxModule as default };

package/dist/runtime/plugin.js

@@ -0,0 +1,39 @@
+import { ConsentStore, applyConsent } from "@tickboxhq/core";
+import { ConsentStoreKey } from "@tickboxhq/vue";
+import { defineNuxtPlugin, useRequestHeaders } from "nuxt/app";
+import userConfig from "#build/tickbox-config";
+export default defineNuxtPlugin({
+  name: "tickbox",
+  enforce: "pre",
+  setup(nuxtApp) {
+    const config = userConfig?.default ?? userConfig;
+    if (!config || typeof config !== "object" || !("jurisdiction" in config)) {
+      console.error(
+        "[@tickboxhq/nuxt] Could not load consent config from `#tickbox-config`. Make sure your `consent.config.ts` default-exports a value created via `defineConsent()`."
+      );
+      return;
+    }
+    if (config.jurisdiction === "auto") {
+      console.warn(
+        '[@tickboxhq/nuxt] `jurisdiction: "auto"` is not yet supported by the Nuxt module. Set an explicit jurisdiction in your consent config for now.'
+      );
+      return;
+    }
+    const store = new ConsentStore(config, {
+      jurisdiction: config.jurisdiction,
+      storage: config.storage,
+      applyEffects: true,
+      onApply: import.meta.client ? applyConsent : void 0
+    });
+    if (import.meta.server) {
+      const headers = useRequestHeaders(["cookie"]);
+      store.hydrateFromHeader(headers.cookie);
+    }
+    if (import.meta.client) {
+      nuxtApp.hook("app:mounted", () => {
+        store.hydrate();
+      });
+    }
+    nuxtApp.vueApp.provide(ConsentStoreKey, store);
+  }
+});

package/dist/types.d.mts

@@ -0,0 +1,7 @@
+import type { NuxtModule } from '@nuxt/schema'
+
+import type { default as Module } from './module.js'
+
+export type ModuleOptions = typeof Module extends NuxtModule<infer O> ? Partial<O> : Record<string, any>
+
+export { default } from './module.js'

package/dist/types.d.ts

@@ -0,0 +1,7 @@
+import type { NuxtModule } from '@nuxt/schema'
+
+import type { default as Module } from './module'
+
+export type ModuleOptions = typeof Module extends NuxtModule<infer O> ? Partial<O> : Record<string, any>
+
+export { default } from './module'

package/package.json

@@ -0,0 +1,47 @@
+{
+  "name": "@tickboxhq/nuxt",
+  "version": "0.0.1",
+  "description": "Nuxt 3/4 module for Tickbox consent management",
+  "license": "MIT",
+  "homepage": "https://tickbox.dev",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/tickboxhq/tickbox.git",
+    "directory": "packages/nuxt"
+  },
+  "type": "module",
+  "main": "./dist/module.cjs",
+  "module": "./dist/module.mjs",
+  "types": "./dist/types.d.mts",
+  "exports": {
+    ".": {
+      "types": "./dist/types.d.mts",
+      "import": "./dist/module.mjs",
+      "require": "./dist/module.cjs"
+    }
+  },
+  "files": [
+    "dist",
+    "README.md"
+  ],
+  "publishConfig": {
+    "access": "public"
+  },
+  "dependencies": {
+    "@nuxt/kit": "^3.13.0",
+    "@tickboxhq/vue": "0.0.1",
+    "@tickboxhq/core": "0.0.1"
+  },
+  "peerDependencies": {
+    "nuxt": "^3.0.0 || ^4.0.0"
+  },
+  "devDependencies": {
+    "@nuxt/module-builder": "^0.8.4",
+    "@nuxt/schema": "^3.13.0",
+    "typescript": "^5.7.2"
+  },
+  "scripts": {
+    "build": "nuxt-module-build build",
+    "typecheck": "tsc --noEmit"
+  }
+}