@dargmuesli/nuxt-cookie-control 4.4.1 → 4.6.0

package/README.md

@@ -4,38 +4,49 @@
 ![Nuxt Cookie Control](https://drive.google.com/a/broj42.com/uc?id=1FGQVyj2s0OT-gpTYxH_FuQhe6oU9iejW)
 
 
-Continuing Dario Ferderber's work on [gitlab.com/broj42/nuxt-cookie-control](https://gitlab.com/broj42/nuxt-cookie-control).
+✅ Translated for: ar, az, cs, da, de, en, es, fr, hr, hu, it, ja, ko, lt, nl, no, pt, ru, sk, tr and uk
 
-🚩 **Make sure to read the Migration instructions for all major version updates like [v2.0.0](https://github.com/dargmuesli/nuxt-cookie-control/releases/tag/2.0.0), [v3.0.0](https://github.com/dargmuesli/nuxt-cookie-control/releases/tag/3.0.0) and following!**
+✅ Vue 3 support
+
+✅ Components and composables are [auto-imported](https://nuxt.com/docs/guide/concepts/auto-imports)
+
+🚩 API changes since continuing Dario Ferderber's work on [gitlab.com/broj42/nuxt-cookie-control](https://gitlab.com/broj42/nuxt-cookie-control), make sure to read the README!
+
+
+## 🚀 Getting Started
 
 [![Stackblitz](https://developer.stackblitz.com/img/open_in_stackblitz.svg)](https://stackblitz.com/github/dargmuesli/nuxt-cookie-control?file=playground%2Fapp.vue)
 
-## 🚀 Usage
+### Installation
 ```bash
 npm i -D @dargmuesli/nuxt-cookie-control
 yarn add -D @dargmuesli/nuxt-cookie-control
 pnpm i -D @dargmuesli/nuxt-cookie-control
 ```
 
-
+### Configuration
 ```javascript
 // nuxt.config.js
 
 modules: [
   '@dargmuesli/nuxt-cookie-control'
-]
+],
+cookieControl: {
+  // typed module options
+}
+
 // or
+
 modules: [
   ['@dargmuesli/nuxt-cookie-control', {
-    // module options
+    // untyped module options
   }]
 ]
 ```
 
-Components and composables are [auto-imported](https://nuxt.com/docs/guide/concepts/auto-imports)!
-
+### Usage
 ```html
-<!-- component.vue -->
+<!-- app.vue -->
 
 <template>
   <CookieControl locale="en" />
@@ -49,61 +60,39 @@ const {
   isModalActive,
   moduleOptions
 } = useCookieControl()
+
+// example: react to a cookie being accepted
+watch(
+  () => cookiesEnabledIds.value,
+  (current, previous) => {
+    if (
+      (!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 }
+)
 </script>
 ```
-## Component Slots
-### Bar
-```html
-<CookieControl>
-  <template #bar>
-    <h3>Bar title</h3>
-    <p>Bar description (you can use $cookies.text.barDescription)</p>
-    <n-link>Go somewhere</n-link>
-  </template>
-</CookieControl>
-```
-### Modal
-```html
-<template #modal>
-  <h3>Modal title</h3>
-  <p>Modal description</p>
-</template>
-```
-### Cookie
-```html
-<template #cookie="{config}">
-  <span v-for="c in config" :key="c.id" v-text="c.cookies"/>
-</template>
-```
 
-## Props
-- locale: `['en']`
-```html
-<CookieControl locale="de"/>
+```ts
+//  plugins/analytics.client.ts
+
+// example: initialization based on enabled cookies
+const cookieControl = useCookieControl()
+
+if (cookieControl.cookiesEnabledIds.value.includes('google-analytics')) {
+    initGoogleAnalytics() // placeholder for your custom initialization
+}
 ```
 
-Currently available:
-- ar
-- az
-- cs
-- da
-- de
-- en
-- es
-- fr
-- hr
-- hu
-- it
-- ja
-- ko
-- nl
-- no
-- pt
-- ru
-- sk
-- uk
-
-## Module Options
+
+## API
+
+### Module Options
 
 ```javascript
 // Position of cookie bar.
@@ -196,7 +185,7 @@ localeTexts: {
 }
 ```
 
-### Cookies
+#### 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: ... }`).
 
@@ -214,6 +203,40 @@ Every property the includes a `{ en: ... }` value is a translatable property tha
 }
 ```
 
+### Component Slots
+
+#### Bar
+```html
+<CookieControl>
+  <template #bar>
+    <h3>Bar title</h3>
+    <p>Bar description (you can use $cookies.text.barDescription)</p>
+    <n-link>Go somewhere</n-link>
+  </template>
+</CookieControl>
+```
+
+#### Modal
+```html
+<template #modal>
+  <h3>Modal title</h3>
+  <p>Modal description</p>
+</template>
+```
+
+#### Cookie
+```html
+<template #cookie="{config}">
+  <span v-for="c in config" :key="c.id" v-text="c.cookies"/>
+</template>
+```
+
+### Props
+- locale: `['en']`
+```html
+<CookieControl locale="de"/>
+```
+
 
 <!-- Badges -->
 [npm-version-src]: https://badgen.net/npm/v/@dargmuesli/nuxt-cookie-control/latest

package/dist/module.json

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

package/dist/module.mjs

@@ -2,7 +2,7 @@ import { resolve } from 'node:path';
 import { createResolver, defineNuxtModule, addPlugin, addImports, addTemplate, extendWebpackConfig, resolvePath } from '@nuxt/kit';
 
 const name = "@dargmuesli/nuxt-cookie-control";
-const version = "4.4.1";
+const version = "4.6.0";
 
 const en = {
   accept: "Accept",

package/dist/runtime/locale/lt.d.ts

@@ -0,0 +1,3 @@
+import { LocaleStrings } from '../types';
+declare const _default: LocaleStrings;
+export default _default;

package/dist/runtime/locale/lt.mjs

@@ -0,0 +1,17 @@
+export default {
+  accept: "Sutinku",
+  acceptAll: "Sutinku su visais",
+  bannerDescription: "Mes naudojame savo slapukus and tre\u010Di\u0173j\u0173 \u0161ali\u0173 slapukus tam, kad gal\u0117tume geriau suprasti kaip svetain\u0117 veikia ir yra naudojama bei tobulinti savo teikiamas paslaugas. J\u016Bs bet kuriuo metu galite pakeisti sutikim\u0105 d\u0117l slapuk\u0173 naudojimo paspaud\u0119 slapuk\u0173 mygtuk\u0105 kuris atsiras kai \u0161ioje reklamjuost\u0117je padarysite pasirinkim\u0105.",
+  bannerTitle: "Slapukai",
+  close: "U\u017Edaryti",
+  cookiesFunctional: "Funkciniai slapukai",
+  cookiesNecessary: "B\u016Btinieji slapukai",
+  cookiesOptional: "Pasirinktiniai slapukai",
+  decline: "At\u0161aukti",
+  declineAll: "At\u0161aukti visk\u0105",
+  here: "\u010Dia",
+  iframeBlocked: "Nor\u0117dami matyti, leiskite naudoti funkcinius slapukus",
+  manageCookies: "Su\u017Einoti daugiau ir pritaikyti",
+  save: "I\u0161saugoti",
+  settingsUnsaved: "J\u016Bs nei\u0161saugojote vis\u0173 nustatym\u0173"
+};

package/dist/runtime/locale/tr.d.ts

@@ -0,0 +1,3 @@
+import { LocaleStrings } from '../types';
+declare const _default: LocaleStrings;
+export default _default;

package/dist/runtime/locale/tr.mjs

@@ -0,0 +1,17 @@
+export default {
+  accept: "Kabul etmek",
+  acceptAll: "T\xFCm\xFCn\xFC kabul et",
+  bannerDescription: "Bu web sitesini do\u011Fru bir \u015Fekilde g\xF6r\xFCnt\xFCleyebilmek ve teklifimizi geli\u015Ftirmek i\xE7in bu web sitesinin nas\u0131l kullan\u0131ld\u0131\u011F\u0131n\u0131 daha iyi anlayabilmek i\xE7in kendi ve \xFC\xE7\xFCnc\xFC taraf \xE7erezlerimizi kullan\u0131yoruz. \xC7erez kullanma izni ile ilgili karar, bu banner \xFCzerinde bir se\xE7im yap\u0131ld\u0131ktan sonra g\xF6r\xFCnen \xE7erez d\xFC\u011Fmesi arac\u0131l\u0131\u011F\u0131yla herhangi bir zamanda de\u011Fi\u015Ftirilebilir.",
+  bannerTitle: "\xC7erezler",
+  close: "Kapat",
+  cookiesFunctional: "\u0130\u015Flevsel \xE7erezler",
+  cookiesNecessary: "Gerekli \xE7erezler",
+  cookiesOptional: "\u0130ste\u011Fe ba\u011Fl\u0131 \xE7erezler",
+  decline: "Reddetmek",
+  declineAll: "T\xFCm\xFCn\xFC reddet",
+  here: "here",
+  iframeBlocked: "Bunu g\xF6rmek i\xE7in l\xFCtfen i\u015Flevsel \xE7erezleri etkinle\u015Ftirin",
+  manageCookies: "\xC7erezleri y\xF6net",
+  save: "Kaydet",
+  settingsUnsaved: "Kaydedilmemi\u015F ayarlar mevcut"
+};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@dargmuesli/nuxt-cookie-control",
-  "version": "4.4.1",
+  "version": "4.6.0",
   "description": "Nuxt Cookies Control Module",
   "author": "Dario Ferderber <dario.ferderber@broj42.com>",
   "maintainers": [
@@ -36,7 +36,7 @@
     "lint": "pnpm prepack && eslint --ext .js,.ts,.vue . && nuxi typecheck playground"
   },
   "dependencies": {
-    "@nuxt/kit": "3.2.0",
+    "@nuxt/kit": "3.2.2",
     "@sindresorhus/slugify": "2.2.0",
     "css-vars-ponyfill": "2.4.8",
     "js-cookie": "3.0.1",
@@ -45,17 +45,17 @@
   "devDependencies": {
     "@nuxt/module-builder": "0.2.1",
     "@nuxtjs/eslint-config-typescript": "12.0.0",
-    "@types/js-cookie": "3.0.2",
+    "@types/js-cookie": "3.0.3",
     "eslint": "8.34.0",
     "eslint-config-prettier": "8.6.0",
     "eslint-plugin-prettier": "4.2.1",
     "husky": "8.0.3",
     "lint-staged": "13.1.2",
-    "nuxt": "3.2.0",
+    "nuxt": "3.2.2",
     "prettier": "2.8.4",
     "typescript": "4.9.5",
     "vue": "3.2.47",
-    "vue-tsc": "1.0.24",
+    "vue-tsc": "1.1.7",
     "webpack": "5.75.0"
   },
   "resolutions": {