@frigear-nu/cookie-consent 0.1.2 → 0.1.3

package/dist/module.d.mts

@@ -87,6 +87,11 @@ interface ConsentState {
     ts: number;
     categories: Record<string, boolean>;
 }
+/** The response of `GET` and `POST /api/cookie-consent`: the signed-in user's stored choice. */
+interface ConsentDto {
+    /** `null` while the user has not answered. */
+    consent: ConsentState | null;
+}
 
 declare module '@nuxt/schema' {
   interface NuxtConfig {
@@ -137,4 +142,4 @@ declare module 'nitropack' {
 declare const _default: _nuxt_schema.NuxtModule<ModuleOptions, ModuleOptions, false>;
 
 export { _default as default };
-export type { ConsentCategory, ConsentCookie, ConsentMessages, ConsentState, ModuleOptions, PublicModuleOptions };
+export type { ConsentCategory, ConsentCookie, ConsentDto, ConsentMessages, ConsentState, ModuleOptions, PublicModuleOptions };

package/dist/module.json

@@ -1,7 +1,7 @@
 {
   "name": "@frigear-nu/cookie-consent",
   "configKey": "cookieConsent",
-  "version": "0.1.2",
+  "version": "0.1.3",
   "builder": {
     "@nuxt/module-builder": "1.0.3",
     "unbuild": "unknown"

package/dist/module.mjs

@@ -1,5 +1,5 @@
-import { defineNuxtModule, createResolver, hasNuxtModule, addImports, addServerImports, addComponentsDir, addServerHandler } from '@nuxt/kit';
-import { registerModule, registerTailwindSource, registerLocales, extendDatabaseTable } from '@frigear-nu/module-kit/utils';
+import { defineNuxtModule, createResolver, hasNuxtModule, addImports, addServerImports, addComponentsDir } from '@nuxt/kit';
+import { registerModule, registerTailwindSource, registerLocales, addModuleRoutes, extendDatabaseTable } from '@frigear-nu/module-kit/utils';
 import { mergeCategories, DEFAULT_CATEGORIES, computeVersion } from '../dist/runtime/utils/consent.js';
 
 const DEFAULT_MAX_AGE = 60 * 60 * 24 * 180;
@@ -37,8 +37,10 @@ const module$1 = defineNuxtModule({
     ]);
     addComponentsDir({ path: resolver.resolve("./runtime/app/components"), priority: -1 });
     if (persistToUser) {
-      addServerHandler({ route: "/api/cookie-consent", method: "get", handler: resolver.resolve("./runtime/server/routes/cookie-consent/index.get") });
-      addServerHandler({ route: "/api/cookie-consent", method: "post", handler: resolver.resolve("./runtime/server/routes/cookie-consent/index.post") });
+      addModuleRoutes(resolver, [
+        { method: "get", path: "", file: "cookie-consent/index.get" },
+        { method: "post", path: "", file: "cookie-consent/index.post" }
+      ], { base: "/api/cookie-consent" });
       extendDatabaseTable(nuxt, {
         resolver,
         file: (dialect) => `./runtime/server/db/schema.${dialect}`

package/dist/runtime/app/composables/useCookieConsent.js

@@ -1,3 +1,4 @@
+import { cookieConsentApi } from "../../utils/api.js";
 import { acceptAllChoices, buildConsent, normalizeConsent, rejectAllChoices } from "../../utils/consent.js";
 const createCookieConsent = (nuxtApp) => {
   const config = useRuntimeConfig().public.cookieConsent;
@@ -18,7 +19,7 @@ const createCookieConsent = (nuxtApp) => {
     const { loggedIn } = useUserSession();
     if (!loggedIn.value) return;
     try {
-      await $fetch("/api/cookie-consent", { method: "POST", body: { categories: state.categories, version: state.v } });
+      await $fetch(cookieConsentApi.root, { method: "POST", body: { categories: state.categories, version: state.v } });
     } catch (error) {
       console.warn("[cookie-consent] Failed to store consent on the user.", error);
     }
@@ -46,7 +47,7 @@ const createCookieConsent = (nuxtApp) => {
     const { loggedIn } = useUserSession();
     if (!loggedIn.value) return;
     try {
-      const { consent: stored } = await $fetch("/api/cookie-consent");
+      const { consent: stored } = await $fetch(cookieConsentApi.root);
       const state = normalizeConsent(stored, config.categories, config.version, stored?.ts);
       if (state) {
         cookie.value = state;

package/dist/runtime/server/routes/cookie-consent/index.post.js

@@ -1,6 +1,7 @@
 import { db, schema } from "@nuxthub/db";
 import { eq } from "drizzle-orm";
 import { z } from "zod";
+import { apiError } from "@frigear-nu/module-kit/server";
 import { buildConsent } from "../../../utils/consent.js";
 import { getCookieConsentConfig } from "../../utils/consent.js";
 const bodySchema = z.object({
@@ -12,12 +13,12 @@ export default defineEventHandler(async (event) => {
   const config = getCookieConsentConfig(event);
   const body = await readValidatedBody(event, bodySchema.parse);
   if (body.version !== config.version) {
-    throw createError({ statusCode: 409, statusMessage: "Outdated cookie consent version." });
+    throw apiError(409, "outdated_version", "Outdated cookie consent version.");
   }
   const known = new Set(config.categories.map((category) => category.key));
   const unknown = Object.keys(body.categories).filter((key) => !known.has(key));
   if (unknown.length) {
-    throw createError({ statusCode: 400, statusMessage: `Unknown categories: ${unknown.join(", ")}` });
+    throw apiError(400, "unknown_categories", `Unknown categories: ${unknown.join(", ")}`, { categories: unknown });
   }
   const state = buildConsent(config.categories, config.version, body.categories);
   await db.update(schema.users).set({
@@ -26,5 +27,5 @@ export default defineEventHandler(async (event) => {
     cookieConsentCategories: JSON.stringify(state.categories)
   }).where(eq(schema.users.id, user.id));
   await useNitroApp().hooks.callHook("cookie-consent:saved", { userId: user.id, state, acceptedAt: state.ts });
-  return state;
+  return { consent: state };
 });

package/dist/runtime/utils/api.d.ts

@@ -0,0 +1,8 @@
+/** The cookie-consent API (registered only while consent is persisted on the user). */
+export declare const cookieConsentApi: {
+    /**
+     * Session only. `GET`: `{ consent }`, the signed-in user's stored choice (`null` before they answered).
+     * `POST { categories, version }`: stores the choice and answers the same `{ consent }` shape (200).
+     */
+    readonly root: "/api/cookie-consent";
+};

package/dist/runtime/utils/api.js

@@ -0,0 +1,7 @@
+export const cookieConsentApi = {
+  /**
+   * Session only. `GET`: `{ consent }`, the signed-in user's stored choice (`null` before they answered).
+   * `POST { categories, version }`: stores the choice and answers the same `{ consent }` shape (200).
+   */
+  root: "/api/cookie-consent"
+};

package/dist/runtime/utils/index.d.ts

@@ -1,3 +1,4 @@
 export { extendCookieConsent, defineConsentCategory } from './extend.js';
 export { DEFAULT_CATEGORIES, mergeCategories, computeVersion, buildConsent, normalizeConsent, acceptAllChoices, rejectAllChoices, localize, } from './consent.js';
-export type { ConsentCategory, ConsentCookie, ConsentState, Translated } from '../../types.js';
+export { cookieConsentApi } from './api.js';
+export type { ConsentCategory, ConsentCookie, ConsentDto, ConsentState, Translated } from '../../types.js';

package/dist/runtime/utils/index.js

@@ -9,3 +9,4 @@ export {
   rejectAllChoices,
   localize
 } from "./consent.js";
+export { cookieConsentApi } from "./api.js";

package/dist/types.d.mts

@@ -2,4 +2,4 @@ export { type Translated } from '@frigear-nu/ui/translated'
 
 export { default } from './module.mjs'
 
-export { type ConsentCategory, type ConsentCookie, type ConsentMessages, type ConsentState, type ModuleOptions, type PublicModuleOptions } from './module.mjs'
+export { type ConsentCategory, type ConsentCookie, type ConsentDto, type ConsentMessages, type ConsentState, type ModuleOptions, type PublicModuleOptions } from './module.mjs'

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@frigear-nu/cookie-consent",
-  "version": "0.1.2",
+  "version": "0.1.3",
   "description": "GDPR cookie consent banner with categories - modules contribute categories (extendCookieConsent), apps gate scripts on consent, and the choice is stored as proof on the user.",
   "homepage": "https://docs.frigear.dev/modules/cookie-consent",
   "repository": {
@@ -21,6 +21,11 @@
       "types": "./dist/runtime/utils/index.d.ts",
       "import": "./dist/runtime/utils/index.js",
       "default": "./dist/runtime/utils/index.js"
+    },
+    "./api": {
+      "types": "./dist/runtime/utils/api.d.ts",
+      "import": "./dist/runtime/utils/api.js",
+      "default": "./dist/runtime/utils/api.js"
     }
   },
   "files": [
@@ -30,8 +35,8 @@
     "playground"
   ],
   "dependencies": {
-    "@frigear-nu/module-kit": "1.1.2",
-    "@frigear-nu/ui": "0.1.2",
+    "@frigear-nu/module-kit": "1.1.3",
+    "@frigear-nu/ui": "0.1.3",
     "@libsql/client": "^0.18.0",
     "@nuxt/kit": "^4.6.1",
     "@vueuse/core": "^15.0.0",
@@ -60,8 +65,8 @@
     }
   },
   "devDependencies": {
-    "@frigear-nu/auth": "0.1.3",
-    "@frigear-nu/users": "1.1.3",
+    "@frigear-nu/auth": "0.1.4",
+    "@frigear-nu/users": "1.1.4",
     "@nuxt/devtools": "^3.4.2",
     "@nuxt/eslint-config": "^1.17.0",
     "@nuxt/module-builder": "^1.0.3",