@frigear-nu/cookie-consent 0.1.2 → 0.2.0

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.2.0",
   "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, addOptionalImports, inlineModuleRuntime, 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;
@@ -26,6 +26,12 @@ const module$1 = defineNuxtModule({
     registerTailwindSource(nuxt, resolver.resolve("./runtime/app"));
     registerLocales(nuxt, resolver.resolve("./runtime/i18n/lang"));
     const persistToUser = (options.persistToUser ?? true) && hasNuxtModule("@frigear-nu/users");
+    addOptionalImports(nuxt, "#cookie-consent/optional", [{
+      name: "useUserSession",
+      available: () => hasNuxtModule("@frigear-nu/auth", nuxt),
+      fallback: `() => { throw new Error('[@frigear-nu/cookie-consent] \`persistToUser\` needs \`@frigear-nu/users\`') }`,
+      fallbackType: "() => { loggedIn: import('vue').Ref<boolean> }"
+    }]);
     addImports([
       { name: "useCookieConsent", from: resolver.resolve("./runtime/app/composables/useCookieConsent") },
       { name: "onCookieConsent", from: resolver.resolve("./runtime/app/composables/useCookieConsent") },
@@ -35,10 +41,13 @@ const module$1 = defineNuxtModule({
       { name: "getCookieConsent", from: resolver.resolve("./runtime/server/utils/consent") },
       { name: "hasCookieConsent", from: resolver.resolve("./runtime/server/utils/consent") }
     ]);
+    inlineModuleRuntime(nuxt, resolver);
     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/components/CookieConsentBanner.vue

@@ -1,5 +1,7 @@
 <script setup>
 import { useWindowScroll } from "@vueuse/core";
+import { computed, onMounted, ref, useConsentT, useCookieConsent, useNuxtApp, useRoute, watch } from "#imports";
+import { useUserSession } from "#cookie-consent/optional";
 const { config, hasResponded, hydrateFromUser } = useCookieConsent();
 const { t, policyUrl } = useConsentT();
 const route = useRoute();

package/dist/runtime/app/components/CookieConsentBannerActions.vue

@@ -1,4 +1,5 @@
 <script setup>
+import { useConsentT, useCookieConsent } from "#imports";
 const { acceptAll, rejectAll, openPreferences } = useCookieConsent();
 const { t } = useConsentT();
 </script>

package/dist/runtime/app/components/CookieConsentManage.vue

@@ -1,4 +1,5 @@
 <script setup>
+import { useConsentT, useCookieConsent } from "#imports";
 const { openPreferences } = useCookieConsent();
 const { t } = useConsentT();
 </script>

package/dist/runtime/app/components/CookieConsentPreferences.vue

@@ -1,4 +1,5 @@
 <script setup>
+import { ref, useConsentT, useCookieConsent, watch } from "#imports";
 const { categories, consent, isPreferencesOpen, save, acceptAll, rejectAll } = useCookieConsent();
 const { t, label, description, localize } = useConsentT();
 const choices = ref({});

package/dist/runtime/app/composables/useConsentT.d.ts

@@ -1,8 +1,8 @@
 import type { ConsentCategory, ConsentMessages, Translated } from '../../../types.js';
 export declare function useConsentT(): {
-    locale: any;
+    locale: import("vue").ComputedRef<string>;
     /** The policy link target for the current locale, if `policyUrl` is set. */
-    policyUrl: any;
+    policyUrl: import("vue").ComputedRef<string | undefined>;
     /** The `policyLabel` option wins over the translated `policy` text. */
     t: (key: keyof ConsentMessages) => any;
     label: (category: ConsentCategory) => string;

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

@@ -1,4 +1,5 @@
 import { localize } from "../../utils/consent.js";
+import { computed, useModuleT, useNuxtApp, useRuntimeConfig } from "#imports";
 const EN = {
   description: "We use cookies to improve your experience. Choose which categories you allow.",
   accept: "Accept all",

package/dist/runtime/app/composables/useCookieConsent.d.ts

@@ -1,22 +1,22 @@
 import type { ConsentState } from '../../../types.js';
 export declare function useCookieConsent(): {
-    config: any;
+    config: {};
     categories: any;
-    consent: any;
-    hasResponded: any;
+    consent: import("vue").ComputedRef<ConsentState | null>;
+    hasResponded: import("vue").ComputedRef<boolean>;
     isAllowed: (key: string) => boolean;
     acceptAll: () => Promise<ConsentState>;
     rejectAll: () => Promise<ConsentState>;
     save: (choices: Record<string, boolean>) => Promise<ConsentState>;
     reset: () => Promise<void>;
     hydrateFromUser: () => Promise<void>;
-    isPreferencesOpen: any;
+    isPreferencesOpen: import("vue").Ref<boolean, boolean>;
     openPreferences: () => void;
-} | undefined;
+};
 /**
  * Runs `callback` once the visitor has granted `category` - immediately if they already did, or as
  * soon as they do. The optional return value is called when consent is withdrawn.
  *
  *     onCookieConsent("analytics", () => { startTracking(); return () => stopTracking() })
  */
-export declare function onCookieConsent(category: string, callback: () => (() => void) | undefined): any;
+export declare function onCookieConsent(category: string, callback: () => (() => void) | undefined): import("vue").WatchHandle;

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

@@ -1,4 +1,7 @@
+import { cookieConsentApi } from "../../utils/api.js";
 import { acceptAllChoices, buildConsent, normalizeConsent, rejectAllChoices } from "../../utils/consent.js";
+import { $fetch, computed, effectScope, getCurrentScope, onScopeDispose, useCookie, useNuxtApp, useRuntimeConfig, useState, watch } from "#imports";
+import { useUserSession } from "#cookie-consent/optional";
 const createCookieConsent = (nuxtApp) => {
   const config = useRuntimeConfig().public.cookieConsent;
   const cookie = useCookie(config.cookieName, {
@@ -18,7 +21,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 +49,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;
@@ -65,7 +68,11 @@ export function useCookieConsent() {
   const nuxtApp = useNuxtApp();
   let instance = instances.get(nuxtApp);
   if (!instance) {
-    instance = nuxtApp.runWithContext(() => effectScope(true).run(() => createCookieConsent(nuxtApp)));
+    let created;
+    nuxtApp.runWithContext(() => {
+      created = effectScope(true).run(() => createCookieConsent(nuxtApp));
+    });
+    instance = created;
     instances.set(nuxtApp, instance);
   }
   return instance;

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.2.0",
   "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.2.0",
+    "@frigear-nu/ui": "0.2.0",
     "@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.2.0",
+    "@frigear-nu/users": "1.2.0",
     "@nuxt/devtools": "^3.4.2",
     "@nuxt/eslint-config": "^1.17.0",
     "@nuxt/module-builder": "^1.0.3",