@dargmuesli/nuxt-cookie-control 6.4.0 → 6.4.2

package/README.md

@@ -1,6 +1,8 @@
 # Nuxt Cookie Control
 
-[![npm version][npm-version-src]][npm-version-href] [![npm downloads][npm-downloads-src]][npm-downloads-href]
+[![ci status][ci-image]][ci-url]
+[![npm version][npm-version-src]][npm-version-href]
+[![npm downloads][npm-downloads-src]][npm-downloads-href]
 
 ![nuxt-cookie-control](https://drive.google.com/a/broj42.com/uc?id=19sFguJo7SKUvmH4xu9DhK9ZXzR6oWLX8)
 
@@ -64,7 +66,7 @@ const {
   cookiesEnabledIds,
   isConsentGiven,
   isModalActive,
-  moduleOptions
+  moduleOptions,
 } = useCookieControl()
 
 // example: react to a cookie being accepted
@@ -72,14 +74,14 @@ watch(
   () => cookiesEnabledIds.value,
   (current, previous) => {
     if (
-      (!previous?.includes('google-analytics') &&
-        current?.includes('google-analytics'))
+      !previous?.includes('google-analytics') &&
+      current?.includes('google-analytics')
     ) {
       // cookie with id `google-analytics` got added
       window.location.reload() // placeholder for your custom change handler
     }
   },
-  { deep: true }
+  { deep: true },
 )
 </script>
 ```
@@ -91,7 +93,7 @@ watch(
 const cookieControl = useCookieControl()
 
 if (cookieControl.cookiesEnabledIds.value.includes('google-analytics')) {
-    initGoogleAnalytics() // placeholder for your custom initialization
+  initGoogleAnalytics() // placeholder for your custom initialization
 }
 ```
 
@@ -197,20 +199,24 @@ localeTexts: {
 
 #### Cookies
 
-Every property the includes a `{ en: ... }` value is a translatable property that could instead only specify a string (`'...'`) or other locales as well (`{ de: ..., uk: ... }`).
+Every property that includes a `{ en: ... }` value is a translatable property that could instead only specify a string (`'...'`) or other locales as well (`{ de: ..., uk: ... }`).
 
 ```javascript
 {
   description: {
-    en:  'Used for cookie control.'
+    en: 'This cookie stores preferences.'
   },
-  id: 'ga', // if unset, `getCookieId(cookie)` returns the cookie's slugified name instead, which e.g. is used to fill the state's `enabledCookieIds` list
+  id: 'p', // if unset, `getCookieId(cookie)` returns the cookie's slugified name instead, which e.g. is used to fill the state's `enabledCookieIds` list
   // use a short cookie id to save bandwidth!
   name: {
-    en: 'Google Analytics' // you always have to specify a cookie name (in English)
+    en: 'Preferences' // you always have to specify a cookie name (in English)
   },
-  src: 'https://www.googletagmanager.com/gtag/js?id=<API-KEY>',
-  targetCookieIds: ['cookie_control_consent', 'cookie_control_enabled_cookies']
+  links: {
+    'https://example.com/privacy': 'Privacy Policy',
+    'https://example.com/terms': 'Terms of Service',
+  },
+  src: 'https://example.com/preferences/js?id=<API-KEY>',
+  targetCookieIds: ['xmpl_a', 'xmpl_b']
 }
 ```
 
@@ -241,7 +247,7 @@ Every property the includes a `{ en: ... }` value is a translatable property tha
 
 ```html
 <template #cookie="{config}">
-  <span v-for="c in config" :key="c.id" v-text="c.cookies"/>
+  <span v-for="c in config" :key="c.id" v-text="c.cookies" />
 </template>
 ```
 
@@ -249,11 +255,14 @@ Every property the includes a `{ en: ... }` value is a translatable property tha
 
 - locale: `['en']`
 ```html
-<CookieControl locale="de"/>
+<CookieControl locale="de" />
 ```
 
 
 <!-- Badges -->
+[ci-image]: https://img.shields.io/github/actions/workflow/status/dargmuesli/nuxt-cookie-control/ci.yml
+[ci-url]: https://github.com/dargmuesli/nuxt-cookie-control/actions/workflows/ci.yml
+
 [npm-version-src]: https://badgen.net/npm/v/@dargmuesli/nuxt-cookie-control/latest
 [npm-version-href]: https://npmjs.com/package/@dargmuesli/nuxt-cookie-control
 

package/dist/module.d.mts

@@ -0,0 +1,58 @@
+import * as _nuxt_schema from '@nuxt/schema';
+import { CookieOptions } from 'nuxt/app';
+
+type Locale = 'ar' | 'az' | 'bg' | 'ca' | 'cs' | 'da' | 'de' | 'en' | 'es' | 'fi' | 'fr' | 'hr' | 'hu' | 'it' | 'ja' | 'ko' | 'lt' | 'nl' | 'no' | 'oc' | 'pt' | 'pl' | 'ro' | 'rs' | 'ru' | 'sk' | 'sv' | 'tr' | 'uk';
+type PartialRecord<K extends keyof any, T> = Partial<Record<K, T>>;
+type Translatable = string | PartialRecord<Locale, string>;
+interface Cookie {
+    description?: Translatable;
+    id?: string;
+    name: Translatable;
+    links?: Record<string, string | null>;
+    src?: string;
+    targetCookieIds?: string[];
+}
+interface LocaleStrings {
+    accept: string;
+    acceptAll: string;
+    bannerDescription: string;
+    bannerTitle: string;
+    close: string;
+    cookiesFunctional: string;
+    cookiesNecessary: string;
+    cookiesOptional: string;
+    iframeBlocked: string;
+    decline: string;
+    declineAll: string;
+    here: string;
+    manageCookies: string;
+    save: string;
+    settingsUnsaved: string;
+}
+interface ModuleOptions {
+    barPosition: 'top-left' | 'top-right' | 'top-full' | 'bottom-left' | 'bottom-right' | 'bottom-full';
+    closeModalOnClickOutside: boolean;
+    colors: false | Record<string, any>;
+    cookieExpiryOffsetMs: number;
+    cookieNameCookiesEnabledIds: string;
+    cookieNameIsConsentGiven: string;
+    cookies: {
+        necessary: Cookie[];
+        optional: Cookie[];
+    };
+    cookieOptions: CookieOptions;
+    isAcceptNecessaryButtonEnabled: boolean;
+    isControlButtonEnabled: boolean;
+    isCookieIdVisible: boolean;
+    isCssEnabled: boolean;
+    isCssPonyfillEnabled: boolean;
+    isDashInDescriptionEnabled: boolean;
+    isIframeBlocked: boolean;
+    isModalForced: boolean;
+    locales: Locale[];
+    localeTexts: PartialRecord<Locale, Partial<LocaleStrings>>;
+}
+
+declare const _default: _nuxt_schema.NuxtModule<ModuleOptions>;
+
+export { _default as default };

package/dist/module.json

@@ -1,6 +1,6 @@
 {
   "name": "@dargmuesli/nuxt-cookie-control",
-  "version": "6.4.0",
+  "version": "6.4.2",
   "configKey": "cookieControl",
   "compatibility": {
     "nuxt": "^3.0.0"

package/dist/module.mjs

@@ -3,7 +3,7 @@ import { pathToFileURL } from 'node:url';
 import { createResolver, defineNuxtModule, addPlugin, addImports, addTemplate, extendWebpackConfig, extendViteConfig, resolvePath } from '@nuxt/kit';
 
 const name = "@dargmuesli/nuxt-cookie-control";
-const version = "6.4.0";
+const version = "6.4.2";
 
 const en = {
   accept: "Accept",

package/dist/runtime/components/CookieControl.vue

@@ -186,7 +186,6 @@
 <script setup lang="ts">
 import { ref, computed, onBeforeMount, watch } from 'vue'
 
-import { useNuxtApp } from '#app'
 import { Cookie, CookieType, Locale, Translatable } from '../types'
 import {
   getAllCookieIdsString,
@@ -195,8 +194,9 @@ import {
   removeCookie,
   resolveTranslatable,
 } from '../methods'
-import setCssVariables from '#cookie-control/set-vars'
 
+import { useNuxtApp } from '#app'
+import setCssVariables from '#cookie-control/set-vars'
 import { useCookieControl, useCookie } from '#imports'
 
 export interface Props {

package/dist/runtime/components/CookieIframe.vue

@@ -21,8 +21,9 @@
 <script setup lang="ts">
 import { computed } from 'vue'
 
-import { useNuxtApp } from '#app'
 import { Cookie } from '../types'
+
+import { useNuxtApp } from '#app'
 import { useCookieControl } from '#imports'
 
 const { cookiesEnabled, isModalActive, moduleOptions } = useCookieControl()

package/dist/runtime/plugin.d.ts

@@ -1,5 +1,5 @@
-import { Plugin } from '#app';
 import { State } from './types';
+import { Plugin } from '#app';
 declare const plugin: Plugin<{
     cookies: State;
 }>;

package/dist/types.d.mts

@@ -0,0 +1,7 @@
+
+import {  } from './module'
+
+
+
+
+export { default } from './module'

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@dargmuesli/nuxt-cookie-control",
-  "version": "6.4.0",
+  "version": "6.4.2",
   "description": "Nuxt Cookie Control Module",
   "author": "Dario Ferderber <dario.ferderber@broj42.com>",
   "maintainers": [
@@ -21,7 +21,7 @@
   "engines": {
     "node": ">=16"
   },
-  "packageManager": "pnpm@8.6.12",
+  "packageManager": "pnpm@8.7.1",
   "exports": {
     ".": {
       "import": "./dist/module.mjs",
@@ -44,7 +44,7 @@
     "prepare": "husky install"
   },
   "dependencies": {
-    "@nuxt/kit": "3.6.5",
+    "@nuxt/kit": "3.7.1",
     "@sindresorhus/slugify": "2.2.1",
     "css-vars-ponyfill": "2.4.8",
     "string-replace-loader": "3.1.0"
@@ -52,17 +52,17 @@
   "devDependencies": {
     "@commitlint/cli": "17.7.1",
     "@commitlint/config-conventional": "17.7.0",
-    "@dargmuesli/nuxt-cookie-control": "link:.",
-    "@nuxt/module-builder": "0.4.0",
-    "@nuxtjs/eslint-config-typescript": "12.0.0",
-    "eslint": "8.47.0",
+    "@dargmuesli/nuxt-cookie-control": "link:",
+    "@nuxt/module-builder": "0.5.1",
+    "@nuxtjs/eslint-config-typescript": "12.1.0",
+    "eslint": "8.48.0",
     "eslint-config-prettier": "9.0.0",
     "eslint-plugin-prettier": "5.0.0",
     "husky": "8.0.3",
-    "lint-staged": "14.0.0",
-    "nuxt": "3.6.5",
-    "prettier": "3.0.1",
-    "typescript": "5.1.6",
+    "lint-staged": "14.0.1",
+    "nuxt": "3.7.1",
+    "prettier": "3.0.3",
+    "typescript": "5.2.2",
     "vue": "3.3.4",
     "vue-tsc": "1.8.8",
     "webpack": "5.88.2"