├── docs
    ├── tsconfig.json
    ├── public
    │   ├── icon.png
    │   ├── preview.png
    │   ├── preview-dark.png
    │   ├── logo-dark.svg
    │   └── logo-light.svg
    ├── .gitignore
    ├── tokens.config.ts
    ├── nuxt.config.js
    ├── app.config.ts
    ├── package.json
    ├── components
    │   └── Logo.vue
    └── content
    │   └── index.md
├── example
    ├── tsconfig.json
    ├── pages
    │   ├── bar.vue
    │   ├── foo.vue
    │   └── index.vue
    └── nuxt.config.js
├── renovate.json
├── .eslintrc.js
├── .gitignore
├── .eslintignore
├── .editorconfig
├── .github
    ├── ISSUE_TEMPLATE
    │   ├── config.yml
    │   ├── question.md
    │   ├── feature_request.md
    │   └── bug_report.md
    └── workflows
    │   └── ci.yml
├── jest.config.js
├── .versionrc
├── templates
    ├── plugin.server.js
    └── plugin.client.js
├── netlify.toml
├── tsconfig.json
├── LICENSE
├── package.json
├── src
    └── module.ts
├── CHANGELOG.md
└── README.md


/docs/tsconfig.json:
--------------------------------------------------------------------------------
1 | {
2 |   "extends": "./.nuxt/tsconfig.json"
3 | }
4 | 


--------------------------------------------------------------------------------
/example/tsconfig.json:
--------------------------------------------------------------------------------
1 | {
2 |   "extends": "../tsconfig.json"
3 | }
4 | 


--------------------------------------------------------------------------------
/renovate.json:
--------------------------------------------------------------------------------
1 | {
2 |   "extends": [
3 |     "@nuxtjs"
4 |   ]
5 | }
6 | 


--------------------------------------------------------------------------------
/.eslintrc.js:
--------------------------------------------------------------------------------
1 | module.exports = {
2 |   extends: ['@nuxtjs/eslint-config-typescript']
3 | }
4 | 


--------------------------------------------------------------------------------
/docs/public/icon.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/nuxt-community/ackee-module/main/docs/public/icon.png


--------------------------------------------------------------------------------
/example/pages/bar.vue:
--------------------------------------------------------------------------------
1 | <script>
2 | import _ from './index.vue'
3 | export default _
4 | </script>
5 | 


--------------------------------------------------------------------------------
/example/pages/foo.vue:
--------------------------------------------------------------------------------
1 | <script>
2 | import _ from './index.vue'
3 | export default _
4 | </script>
5 | 


--------------------------------------------------------------------------------
/docs/public/preview.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/nuxt-community/ackee-module/main/docs/public/preview.png


--------------------------------------------------------------------------------
/docs/public/preview-dark.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/nuxt-community/ackee-module/main/docs/public/preview-dark.png


--------------------------------------------------------------------------------
/.gitignore:
--------------------------------------------------------------------------------
 1 | node_modules
 2 | *.iml
 3 | .idea
 4 | *.log*
 5 | .nuxt
 6 | .vscode
 7 | .DS_Store
 8 | coverage
 9 | dist
10 | 


--------------------------------------------------------------------------------
/docs/.gitignore:
--------------------------------------------------------------------------------
 1 | node_modules
 2 | *.iml
 3 | .idea
 4 | *.log*
 5 | .nuxt
 6 | .vscode
 7 | .DS_Store
 8 | coverage
 9 | dist
10 | sw.*
11 | .output
12 | 


--------------------------------------------------------------------------------
/.eslintignore:
--------------------------------------------------------------------------------
 1 | node_modules
 2 | dist
 3 | .nuxt
 4 | coverage
 5 | *.log*
 6 | .DS_Store
 7 | .code
 8 | *.iml
 9 | package-lock.json
10 | templates/*
11 | sw.js
12 | 


--------------------------------------------------------------------------------
/docs/tokens.config.ts:
--------------------------------------------------------------------------------
1 | import { defineTheme, palette } from 'pinceau'
2 | 
3 | export default defineTheme({
4 |   color: {
5 |     primary: palette('#65deb1')
6 |   }
7 | })
8 | 


--------------------------------------------------------------------------------
/docs/nuxt.config.js:
--------------------------------------------------------------------------------
 1 | export default defineNuxtConfig({
 2 |   extends: ['@nuxt-themes/docus'],
 3 | 
 4 |   modules: [
 5 |     'nuxt-plausible'
 6 |   ],
 7 | 
 8 |   plausible: {
 9 |     domain: 'ackee.nuxtjs.org'
10 |   }
11 | })
12 | 


--------------------------------------------------------------------------------
/.editorconfig:
--------------------------------------------------------------------------------
 1 | # editorconfig.org
 2 | root = true
 3 | 
 4 | [*]
 5 | indent_size = 2
 6 | indent_style = space
 7 | end_of_line = lf
 8 | charset = utf-8
 9 | trim_trailing_whitespace = true
10 | insert_final_newline = true
11 | 
12 | [*.md]
13 | trim_trailing_whitespace = false
14 | 


--------------------------------------------------------------------------------
/example/nuxt.config.js:
--------------------------------------------------------------------------------
 1 | export default {
 2 |   buildModules: [
 3 |     '../src/module.ts'
 4 |   ],
 5 |   ackee: {
 6 |     server: '',
 7 |     domainId: '',
 8 |     detailed: 'opt-in',
 9 |     ignoreLocalhost: false,
10 |     ignoreOwnVisits: false
11 |   },
12 |   publicRuntimeConfig: {
13 |     ackeeTestEvent: ''
14 |   }
15 | }
16 | 


--------------------------------------------------------------------------------
/docs/app.config.ts:
--------------------------------------------------------------------------------
 1 | export default defineAppConfig({
 2 |   docus: {
 3 |     socials: {
 4 |       twitter: '@nuxt_js',
 5 |       github: 'nuxt-community/ackee-module'
 6 |     },
 7 |     header: {
 8 |       title: 'Nuxt Ackee',
 9 |       logo: true
10 |     },
11 |     title: 'Nuxt Ackee',
12 |     url: 'https://ackee.nuxtjs.org'
13 |   }
14 | })
15 | 


--------------------------------------------------------------------------------
/.github/ISSUE_TEMPLATE/config.yml:
--------------------------------------------------------------------------------
1 | blank_issues_enabled: false
2 | contact_links:
3 |   - name: Nuxt Community Discord
4 |     url: https://discord.nuxtjs.org
5 |     about: Consider asking questions about the module here.
6 |   - name: Documentation
7 |     url: https://ackee.nuxtjs.org
8 |     about: Check our documentation before reporting issues or questions.
9 | 


--------------------------------------------------------------------------------
/jest.config.js:
--------------------------------------------------------------------------------
 1 | module.exports = {
 2 |   transform: {
 3 |     '\\.(js|ts)$': [
 4 |       'babel-jest',
 5 |       {
 6 |         presets: ['@babel/preset-env', '@babel/preset-typescript'],
 7 |         plugins: ['@babel/plugin-transform-runtime']
 8 |       }
 9 |     ]
10 |   },
11 |   collectCoverage: true,
12 |   collectCoverageFrom: ['src/**', '!templates/**']
13 | }
14 | 


--------------------------------------------------------------------------------
/docs/package.json:
--------------------------------------------------------------------------------
 1 | {
 2 |   "name": "nuxt-ackee-docs",
 3 |   "version": "1.0.0",
 4 |   "private": true,
 5 |   "scripts": {
 6 |     "dev": "nuxi dev",
 7 |     "build": "nuxi build",
 8 |     "start": "nuxi start",
 9 |     "generate": "nuxi generate"
10 |   },
11 |   "dependencies": {
12 |     "@nuxt-themes/docus": "^1.1.3",
13 |     "nuxt": "^3.0.0"
14 |   },
15 |   "devDependencies": {
16 |     "nuxt-plausible": "^0.1.2"
17 |   }
18 | }
19 | 


--------------------------------------------------------------------------------
/.versionrc:
--------------------------------------------------------------------------------
 1 | {
 2 |   "types": [
 3 |     {
 4 |       "type": "feat",
 5 |       "section": "Features"
 6 |     },
 7 |     {
 8 |       "type": "fix",
 9 |       "section": "Bug Fixes"
10 |     },
11 |     {
12 |       "type": "refactor",
13 |       "section": "Refactor"
14 |     },
15 |     {
16 |       "type": "docs",
17 |       "section": "Documentation"
18 |     },
19 |     {
20 |       "type": "chore",
21 |       "section": "Chore"
22 |     }
23 |   ]
24 | }
25 | 


--------------------------------------------------------------------------------
/templates/plugin.server.js:
--------------------------------------------------------------------------------
 1 | /**
 2 |  * @type {import('@nuxt/types').Plugin}
 3 |  */
 4 | export default function (context, inject) {
 5 |   inject('ackee', {
 6 |     <% if (['opt-in', 'opt-out'].includes(options.detailed)) { %>
 7 |     details: {
 8 |       value: null,
 9 |       preference: null,
10 |       unknown: true,
11 |       optIn() {},
12 |       optOut() {}
13 |     },<% } %>
14 |     record() {},
15 |     updateRecord() {},
16 |     action() {},
17 |     updateAction() {}
18 |   })
19 | }
20 | 


--------------------------------------------------------------------------------
/netlify.toml:
--------------------------------------------------------------------------------
 1 | # Global settings applied to the whole site.
 2 | #
 3 | # “base” is the directory to change to before starting build. If you set base:
 4 | #        that is where we will look for package.json/.nvmrc/etc, not repo root!
 5 | # “command” is your build command.
 6 | # “publish” is the directory to publish (relative to the root of your repo).
 7 | 
 8 | [build]
 9 |   base    = "docs"
10 |   command = "yarn generate"
11 |   publish = "dist"
12 |   ignore  = "git diff --quiet HEAD^ HEAD . ../package.json"
13 | 


--------------------------------------------------------------------------------
/.github/ISSUE_TEMPLATE/question.md:
--------------------------------------------------------------------------------
 1 | ---
 2 | name: Question
 3 | about: Ask a question about the module.
 4 | title: ''
 5 | labels: question
 6 | assignees: ''
 7 | ---
 8 | 
 9 | <!--
10 | 
11 |  **IMPORTANT!**
12 | Please make sure to look for an answer to your question in our documentation before asking a question here.
13 | 
14 | If you have a general question regarding Nuxt Hue use Discord `modules` channel. Thanks!
15 | 
16 | Documentation: https://ackee.nuxtjs.org
17 | Nuxt Discord: https://discord.nuxtjs.org
18 | 
19 | -->
20 | 


--------------------------------------------------------------------------------
/tsconfig.json:
--------------------------------------------------------------------------------
 1 | {
 2 |   "compilerOptions": {
 3 |     "strict": true,
 4 |     "target": "es2018",
 5 |     "module": "esnext",
 6 |     "lib": [
 7 |       "esnext",
 8 |       "dom"
 9 |     ],
10 |     "esModuleInterop": true,
11 |     "moduleResolution": "node",
12 |     "declaration": false,
13 |     "skipLibCheck": true,
14 |     "resolveJsonModule": true,
15 |     "allowSyntheticDefaultImports": true,
16 |     "types": [
17 |       "node",
18 |       "jest"
19 |     ]
20 |   },
21 |   "exclude": [
22 |     "node_modules",
23 |     "dist"
24 |   ]
25 | }
26 | 


--------------------------------------------------------------------------------
/.github/ISSUE_TEMPLATE/feature_request.md:
--------------------------------------------------------------------------------
 1 | ---
 2 | name: Feature request
 3 | about: Suggest an idea or enhancement for this project.
 4 | title: ''
 5 | labels: enhancement
 6 | assignees: ''
 7 | ---
 8 | 
 9 | ### Is your feature request related to a problem? Please describe.
10 | <!-- A clear and concise description of what the problem is. Ex. I'm always frustrated when [...] -->
11 | 
12 | ### Describe the solution you'd like to see
13 | <!-- A clear and concise description of what you want to happen. -->
14 | 
15 | ### Describe alternatives you've considered
16 | <!-- A clear and concise description of any alternative solutions or features you've considered. -->
17 | 
18 | ### Additional context
19 | <!-- Add any other context or screenshots about the feature request here. -->
20 | 


--------------------------------------------------------------------------------
/.github/workflows/ci.yml:
--------------------------------------------------------------------------------
 1 | name: ci
 2 | 
 3 | on:
 4 |   push:
 5 |     branches:
 6 |       - main
 7 |   pull_request:
 8 |     branches:
 9 |       - main
10 | 
11 | jobs:
12 |   ci:
13 |     runs-on: ${{ matrix.os }}
14 | 
15 |     strategy:
16 |       matrix:
17 |         os: [ubuntu-latest]
18 |         node: [14]
19 | 
20 |     steps:
21 |       - uses: actions/setup-node@v2
22 |         with:
23 |           node-version: ${{ matrix.node }}
24 | 
25 |       - name: checkout
26 |         uses: actions/checkout@master
27 | 
28 |       - name: cache node_modules
29 |         uses: actions/cache@v2
30 |         with:
31 |           path: node_modules
32 |           key: ${{ matrix.os }}-node-v${{ matrix.node }}-deps-${{ hashFiles(format('{0}{1}', github.workspace, '/yarn.lock')) }}
33 | 
34 |       - name: Install dependencies
35 |         if: steps.cache.outputs.cache-hit != 'true'
36 |         run: yarn
37 | 
38 |       - name: Lint
39 |         run: yarn lint
40 |       # - name: Coverage
41 |       #   uses: codecov/codecov-action@v1
42 | 


--------------------------------------------------------------------------------
/.github/ISSUE_TEMPLATE/bug_report.md:
--------------------------------------------------------------------------------
 1 | ---
 2 | name: Bug report
 3 | about: Report a bug report to help us improve the module.
 4 | title: ''
 5 | labels: bug
 6 | assignees: ''
 7 | ---
 8 | 
 9 | ## Version
10 | Node: <!-- ex: 12.0.0 -->
11 | Nuxt: <!-- ex: 2.0.0 -->
12 | Module: <!-- ex: 1.0.0 -->
13 | 
14 | ## Nuxt configuration
15 | <!-- If relevant, please include the configuration you are using for this module. -->
16 | 
17 | ## Reproduction
18 | <!-- Without a minimal reproduction we wont be able to look into your issue properly. -->
19 | 
20 | **Link (optional):** 
21 | - [ ] GitHub repository
22 | 
23 | ### Steps to reproduce
24 | 
25 | 
26 | ### What is expected?
27 | 
28 | 
29 | ### What is actually happening?
30 | 
31 | 
32 | ## Additional information
33 | <!-- Anything you'd like to add. -->
34 | 
35 | ## Checklist
36 | * [ ]  I have tested with the latest Nuxt version and the issue still occurs
37 | * [ ]  I have tested with the latest module version and the issue still occurs
38 | * [ ]  I have searched the issue tracker and this issue hasn't been reported yet
39 | 


--------------------------------------------------------------------------------
/LICENSE:
--------------------------------------------------------------------------------
 1 | MIT License
 2 | 
 3 | Copyright (c) 2021 Nuxt.js Community
 4 | 
 5 | Permission is hereby granted, free of charge, to any person obtaining a copy
 6 | of this software and associated documentation files (the "Software"), to deal
 7 | in the Software without restriction, including without limitation the rights
 8 | to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 9 | copies of the Software, and to permit persons to whom the Software is
10 | furnished to do so, subject to the following conditions:
11 | 
12 | The above copyright notice and this permission notice shall be included in all
13 | copies or substantial portions of the Software.
14 | 
15 | THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16 | IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17 | FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18 | AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19 | LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20 | OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21 | SOFTWARE.
22 | 


--------------------------------------------------------------------------------
/package.json:
--------------------------------------------------------------------------------
 1 | {
 2 |   "name": "@nuxtjs/ackee",
 3 |   "version": "3.0.2",
 4 |   "description": "Nuxt.js module for Ackee analytics",
 5 |   "keywords": [
 6 |     "nuxt",
 7 |     "module",
 8 |     "nuxt-module"
 9 |   ],
10 |   "repository": "nuxt-community/ackee-module",
11 |   "license": "MIT",
12 |   "main": "dist/module.js",
13 |   "types": "dist/module.d.ts",
14 |   "files": [
15 |     "dist",
16 |     "templates"
17 |   ],
18 |   "scripts": {
19 |     "build": "siroc build",
20 |     "dev": "nuxt-ts example",
21 |     "lint": "eslint --ext .js,.ts,.vue .",
22 |     "release": "yarn build && yarn test && standard-version && git push --follow-tags && npm publish",
23 |     "test": "yarn lint"
24 |   },
25 |   "dependencies": {
26 |     "ackee-tracker": "^5.1.0",
27 |     "consola": "^2.15.3",
28 |     "defu": "^5.0.0"
29 |   },
30 |   "devDependencies": {
31 |     "@babel/plugin-transform-runtime": "latest",
32 |     "@babel/preset-env": "latest",
33 |     "@babel/preset-typescript": "latest",
34 |     "@nuxt/test-utils": "latest",
35 |     "@nuxt/types": "latest",
36 |     "@nuxt/typescript-runtime": "latest",
37 |     "@nuxtjs/eslint-config-typescript": "latest",
38 |     "@siroc/jest-preset": "latest",
39 |     "@types/jest": "latest",
40 |     "babel-eslint": "latest",
41 |     "babel-jest": "latest",
42 |     "eslint": "latest",
43 |     "jest": "latest",
44 |     "nuxt-edge": "latest",
45 |     "siroc": "latest",
46 |     "standard-version": "latest"
47 |   },
48 |   "publishConfig": {
49 |     "access": "public"
50 |   }
51 | }
52 | 


--------------------------------------------------------------------------------
/example/pages/index.vue:
--------------------------------------------------------------------------------
 1 | <template>
 2 |   <div>
 3 |     <pre>{{ $route.path }}</pre> works!
 4 |     <hr>
 5 |     <ul>
 6 |       <li>
 7 |         <nuxt-link to="/">
 8 |           Index
 9 |         </nuxt-link>
10 |       </li>
11 |       <li>
12 |         <nuxt-link to="/foo">
13 |           Foo
14 |         </nuxt-link>
15 |       </li>
16 |       <li>
17 |         <nuxt-link to="/bar">
18 |           Bar
19 |         </nuxt-link>
20 |       </li>
21 |     </ul>
22 |     <hr>
23 |     <button @click="sendEvent">
24 |       Send Event
25 |     </button>
26 |     <template v-if="$ackee.details">
27 |       <hr>
28 |       Only when <pre>options.detailed = 'opt-in'|'opt-out'</pre>:<br>
29 |       Value: <pre>{{ $ackee.details.value }}</pre><br>
30 |       Preference: <pre>{{ $ackee.details.preference }}</pre><br>
31 |       Unknown: <pre>{{ $ackee.details.unknown }}</pre><br>
32 |       <button @click="$ackee.details.optIn">
33 |         Opt-In
34 |       </button>
35 |       <button @click="$ackee.details.optOut">
36 |         Opt-Out
37 |       </button>
38 |       <button @click="clearStorage">
39 |         Clear local storage
40 |       </button>
41 |     </template>
42 |   </div>
43 | </template>
44 | 
45 | <script>
46 | export default {
47 |   methods: {
48 |     sendEvent () {
49 |       if (this.$config.ackeeTestEvent) {
50 |         this.$ackee.action(
51 |           this.$config.ackeeTestEvent,
52 |           { key: 'Test', value: 1 }
53 |         )
54 |       }
55 |     },
56 |     clearStorage () {
57 |       window.localStorage.clear()
58 |       window.location.reload()
59 |     }
60 |   }
61 | }
62 | </script>
63 | 
64 | <style scoped>
65 | pre {
66 |   display: inline
67 | }
68 | </style>
69 | 


--------------------------------------------------------------------------------
/src/module.ts:
--------------------------------------------------------------------------------
 1 | import { resolve } from 'path'
 2 | import defu from 'defu'
 3 | import { Module } from '@nuxt/types'
 4 | import consola from 'consola'
 5 | const log = consola.withScope('nuxt:ackee')
 6 | 
 7 | export interface ModuleOptions {
 8 |   server?: string;
 9 |   domainId?: string;
10 |   detailed?: boolean | 'opt-in' | 'opt-out';
11 |   ignoreLocalhost?: boolean;
12 |   ignoreOwnVisits?: boolean;
13 |   storageKey?: string;
14 | }
15 | const DEFAULTS: ModuleOptions = {
16 |   server: '',
17 |   domainId: '',
18 |   detailed: false,
19 |   ignoreLocalhost: true,
20 |   ignoreOwnVisits: true,
21 |   storageKey: 'nuxt-ackee'
22 | }
23 | const CONFIG_KEY = 'ackee'
24 | 
25 | const nuxtModule: Module<ModuleOptions> = /* async */ function (moduleOptions: ModuleOptions) {
26 |   const options = defu<ModuleOptions, ModuleOptions>(this.options[CONFIG_KEY]!, moduleOptions, DEFAULTS)
27 |   // const { nuxt } = this
28 | 
29 |   if (!options.server || !options.domainId) {
30 |     return log.warn('Could not activate @nuxtjs/ackee module, `server` and `domainId` properties are required')
31 |   }
32 | 
33 |   this.addPlugin({
34 |     src: resolve(__dirname, '../templates', 'plugin.server.js'),
35 |     fileName: 'nuxt-ackee.server.js',
36 |     options
37 |   })
38 |   this.addPlugin({
39 |     src: resolve(__dirname, '../templates', 'plugin.client.js'),
40 |     ssr: false,
41 |     fileName: 'nuxt-ackee.client.js',
42 |     options
43 |   })
44 | }
45 | 
46 |   ; (nuxtModule as any).meta = require('../package.json')
47 | 
48 | declare module '@nuxt/types' {
49 |   interface NuxtConfig { [CONFIG_KEY]?: ModuleOptions } // Nuxt 2.14+
50 |   interface Configuration { [CONFIG_KEY]?: ModuleOptions } // Nuxt 2.9 - 2.13
51 | }
52 | 
53 | export default nuxtModule
54 | 


--------------------------------------------------------------------------------
/CHANGELOG.md:
--------------------------------------------------------------------------------
 1 | # Changelog
 2 | 
 3 | All notable changes to this project will be documented in this file. See [standard-version](https://github.com/conventional-changelog/standard-version) for commit guidelines.
 4 | 
 5 | ### [3.0.2](https://github.com/nuxt-community/ackee-module/compare/v3.0.1...v3.0.2) (2021-06-27)
 6 | 
 7 | 
 8 | ### Documentation
 9 | 
10 | * add initial credit ([7164793](https://github.com/nuxt-community/ackee-module/commit/71647938b3dacdeb38945f0a5336c644a58023d9))
11 | * typo ([14bcf0d](https://github.com/nuxt-community/ackee-module/commit/14bcf0d9baf5cd859f2f76865b956a33e8204126))
12 | 
13 | 
14 | ### Chore
15 | 
16 | * **deps:** maintain dependencies ([07b36df](https://github.com/nuxt-community/ackee-module/commit/07b36df2177ebf3de29dddceb96f85a47d063ec5))
17 | * add .versionrc ([5e8a2f7](https://github.com/nuxt-community/ackee-module/commit/5e8a2f7800cb1c1c28aab4ade83bae8b72672dc2))
18 | * **config:** update issue templates ([0648b5e](https://github.com/nuxt-community/ackee-module/commit/0648b5e10233998b609315fa1c720460df34f9bb))
19 | 
20 | ### [3.0.1](https://github.com/nuxt-community/ackee-module/compare/v3.0.0...v3.0.1) (2021-03-10)
21 | 
22 | ## [3.0.0](https://github.com/nuxt-community/ackee-module/compare/v2.0.0...v3.0.0) (2021-03-10)
23 | 
24 | 
25 | ### ⚠ BREAKING CHANGES
26 | 
27 | * upgrade to ackee tracker 5
28 | 
29 | ### Features
30 | 
31 | * add opt-in/opt-out mode to options.detailed ([32bf48e](https://github.com/nuxt-community/ackee-module/commit/32bf48e2370fda9342a0a50495f20cb2a7983e58))
32 | * allow ignoreOwnVisits option to be used ([2448e58](https://github.com/nuxt-community/ackee-module/commit/2448e58a098865718b57945f43340ff314c26906))
33 | * upgrade to ackee tracker 5 ([cee1ae7](https://github.com/nuxt-community/ackee-module/commit/cee1ae7da1d9c9e9f2007780a634f27847769d19))
34 | 
35 | 
36 | ### Bug Fixes
37 | 
38 | * client plugin doesn't need async ([c66907d](https://github.com/nuxt-community/ackee-module/commit/c66907da7c654ac06ef772ea5b217833389b462c))
39 | 


--------------------------------------------------------------------------------
/templates/plugin.client.js:
--------------------------------------------------------------------------------
 1 | <% if (['opt-in', 'opt-out'].includes(options.detailed)) { %>import Vue from 'vue'
 2 | <% } %>import * as ackeeTracker from 'ackee-tracker'
 3 | 
 4 | <% if (['opt-in', 'opt-out'].includes(options.detailed)) { %>
 5 | const storageKey = '<%= options.storageKey %>'
 6 | <% } %>
 7 | 
 8 | /**
 9 |  * @type {import('@nuxt/types').Plugin}
10 |  */
11 | export default function(context, inject) {
12 |   <% if (options.detailed === 'opt-in') { %>
13 |   const detailed = window.localStorage.getItem(storageKey) === 'opted-in'
14 |   <% } else if (options.detailed === 'opt-out') { %>
15 |   const detailed = window.localStorage.getItem(storageKey) !== 'opted-out'
16 |   <% } else { %>
17 |   const detailed = <%= options.detailed ? 'true' : 'false' %>
18 |   <% } %>
19 | 
20 |   // plugin is called only once when laoding the app on client-side
21 |   const ackee = ackeeTracker.create(
22 |     '<%= options.server %>',
23 |     {
24 |       detailed,
25 |       ignoreLocalhost: <%= options.ignoreLocalhost ? 'true' : 'false' %>,
26 |       ignoreOwnVisits: <%= options.ignoreOwnVisits ? 'true' : 'false' %>
27 |     }
28 |   )
29 | 
30 |   <% if (['opt-in', 'opt-out'].includes(options.detailed)) { %>
31 |   ackee.details = new Vue({
32 |     data: {
33 |       value: detailed,
34 |       preference: window.localStorage.getItem(storageKey),
35 |       unknown: false
36 |     },
37 |     methods: {
38 |       optIn() {
39 |         window.localStorage.setItem(storageKey, 'opted-in')
40 |         this.value = true
41 |         this.preference = 'opted-in'
42 |       },
43 |       optOut() {
44 |         window.localStorage.setItem(storageKey, 'opted-out')
45 |         this.value = false
46 |         this.preference = 'opted-out'
47 |       }
48 |     }
49 |   })
50 |   <% } %>
51 | 
52 |   inject('ackee', ackee)
53 | 
54 |   let currentRecord
55 |   context.app.router.afterEach((to, from) => {
56 |     if (currentRecord) {
57 |       currentRecord.stop()
58 |     }
59 | 
60 |     currentRecord = ackee.record(
61 |       '<%= options.domainId %>'<% if (['opt-in', 'opt-out'].includes(options.detailed)) { %>,
62 |       ackeeTracker.attributes(ackee.details.value)<% } %>
63 |     )
64 |   })
65 | }
66 | 


--------------------------------------------------------------------------------
/README.md:
--------------------------------------------------------------------------------
 1 | # @nuxtjs/ackee
 2 | 
 3 | [![npm version][npm-version-src]][npm-version-href]
 4 | [![npm downloads][npm-downloads-src]][npm-downloads-href]
 5 | [![Github Actions CI][github-actions-ci-src]][github-actions-ci-href]
 6 | [![Codecov][codecov-src]][codecov-href]
 7 | [![License][license-src]][license-href]
 8 | 
 9 | > Track without being tracked on Nuxt 2 with [Ackee analytics](https://ackee.electerious.com)
10 | 
11 | - [✨ &nbsp;Release Notes](/CHANGELOG.md)
12 | - [📖 &nbsp;Read the documentation](https://ackee.nuxtjs.org)
13 | 
14 | ## Setup
15 | 
16 | 1. Add `@nuxtjs/ackee` dependency to your project
17 | 
18 | ```bash
19 | yarn add @nuxtjs/ackee # or npm install @nuxtjs/ackee
20 | ```
21 | 
22 | 2. Add `@nuxtjs/ackee` to the `buildModules` section of `nuxt.config.js`
23 | 
24 | ```js
25 | {
26 |   buildModules: [
27 |     '@nuxtjs/ackee',
28 |   ],
29 |   ackee: {
30 |     server: 'https://example.com',
31 |     domainId: 'xxx-xxx-xxx'
32 |     // see documentation for more!
33 |   }
34 | }
35 | ```
36 | 
37 | ## Development
38 | 
39 | 1. Clone this repository
40 | 2. Install dependencies using `yarn install`
41 | 3. Start development server using `yarn dev`
42 | 
43 | ## License
44 | 
45 | [MIT License](./LICENSE)
46 | 
47 | Thanks to [Sergey Bedritsky](https://github.com/bdrtsky) for the initial implementation and transfer to the community of [nuxt-ackee](https://github.com/bdrtsky/nuxt-ackee).
48 | 
49 | <!-- Badges -->
50 | 
51 | [npm-version-src]: https://img.shields.io/npm/v/@nuxtjs/ackee/latest.svg
52 | [npm-version-href]: https://npmjs.com/package/@nuxtjs/ackee
53 | [npm-downloads-src]: https://img.shields.io/npm/dm/@nuxtjs/ackee.svg
54 | [npm-downloads-href]: https://npmjs.com/package/@nuxtjs/ackee
55 | [github-actions-ci-src]: https://github.com/nuxt-community/ackee-module/workflows/ci/badge.svg
56 | [github-actions-ci-href]: https://github.com/nuxt-community/ackee-module/actions?query=workflow%3Aci
57 | [codecov-src]: https://img.shields.io/codecov/c/github/nuxt-community/ackee-module.svg
58 | [codecov-href]: https://codecov.io/gh/nuxt-community/ackee-module
59 | [license-src]: https://img.shields.io/npm/l/@nuxtjs/ackee.svg
60 | [license-href]: https://npmjs.com/package/@nuxtjs/ackee
61 | 


--------------------------------------------------------------------------------
/docs/public/logo-dark.svg:
--------------------------------------------------------------------------------
 1 | <svg width="200" height="40" viewBox="0 0 200 40" fill="none" xmlns="http://www.w3.org/2000/svg">
 2 | <g clip-path="url(#clip0)">
 3 | <path d="M47.82 30V16.112H50.984L51.264 18.464C51.6933 17.6427 52.3093 16.9893 53.112 16.504C53.9333 16.0187 54.8947 15.776 55.996 15.776C57.7133 15.776 59.048 16.3173 60 17.4C60.952 18.4827 61.428 20.0693 61.428 22.16V30H57.844V22.496C57.844 21.3013 57.6013 20.3867 57.116 19.752C56.6307 19.1173 55.8747 18.8 54.848 18.8C53.84 18.8 53.0093 19.1547 52.356 19.864C51.7213 20.5733 51.404 21.5627 51.404 22.832V30H47.82ZM70.0632 30.336C68.3272 30.336 66.9832 29.7947 66.0312 28.712C65.0978 27.6293 64.6312 26.0427 64.6312 23.952V16.112H68.1872V23.616C68.1872 24.8107 68.4298 25.7253 68.9152 26.36C69.4005 26.9947 70.1658 27.312 71.2112 27.312C72.2005 27.312 73.0125 26.9573 73.6472 26.248C74.3005 25.5387 74.6272 24.5493 74.6272 23.28V16.112H78.2112V30H75.0472L74.7672 27.648C74.3378 28.4693 73.7125 29.1227 72.8912 29.608C72.0885 30.0933 71.1458 30.336 70.0632 30.336ZM80.5743 30L85.6143 23.056L80.5743 16.112H84.4103L87.9383 21.04L91.4383 16.112H95.3023L90.2343 23.056L95.3023 30H91.4383L87.9383 25.072L84.4103 30H80.5743ZM103.774 30C102.318 30 101.151 29.6453 100.274 28.936C99.3963 28.2267 98.9576 26.9667 98.9576 25.156V19.108H96.5776V16.112H98.9576L99.3776 12.388H102.542V16.112H106.294V19.108H102.542V25.184C102.542 25.856 102.682 26.3227 102.962 26.584C103.26 26.8267 103.764 26.948 104.474 26.948H106.21V30H103.774ZM108.195 33.108L115.195 8.244H118.695L111.667 33.108H108.195Z" fill="white"/>
 4 | <path d="M125.944 30.336C124.749 30.336 123.769 30.1493 123.004 29.776C122.239 29.384 121.669 28.8707 121.296 28.236C120.923 27.6013 120.736 26.9013 120.736 26.136C120.736 24.848 121.24 23.8027 122.248 23C123.256 22.1973 124.768 21.796 126.784 21.796H130.312V21.46C130.312 20.508 130.041 19.808 129.5 19.36C128.959 18.912 128.287 18.688 127.484 18.688C126.756 18.688 126.121 18.8653 125.58 19.22C125.039 19.556 124.703 20.06 124.572 20.732H121.072C121.165 19.724 121.501 18.8467 122.08 18.1C122.677 17.3533 123.443 16.784 124.376 16.392C125.309 15.9813 126.355 15.776 127.512 15.776C129.491 15.776 131.049 16.2707 132.188 17.26C133.327 18.2493 133.896 19.6493 133.896 21.46V30H130.844L130.508 27.76C130.097 28.5067 129.519 29.1227 128.772 29.608C128.044 30.0933 127.101 30.336 125.944 30.336ZM126.756 27.536C127.783 27.536 128.576 27.2 129.136 26.528C129.715 25.856 130.079 25.0253 130.228 24.036H127.176C126.224 24.036 125.543 24.2133 125.132 24.568C124.721 24.904 124.516 25.324 124.516 25.828C124.516 26.3693 124.721 26.7893 125.132 27.088C125.543 27.3867 126.084 27.536 126.756 27.536ZM144.12 30.336C142.701 30.336 141.451 30.028 140.368 29.412C139.285 28.796 138.427 27.9373 137.792 26.836C137.176 25.7347 136.868 24.4747 136.868 23.056C136.868 21.6373 137.176 20.3773 137.792 19.276C138.427 18.1747 139.285 17.316 140.368 16.7C141.451 16.084 142.701 15.776 144.12 15.776C145.893 15.776 147.387 16.2427 148.6 17.176C149.813 18.0907 150.588 19.36 150.924 20.984H147.144C146.957 20.312 146.584 19.7893 146.024 19.416C145.483 19.024 144.839 18.828 144.092 18.828C143.103 18.828 142.263 19.2013 141.572 19.948C140.881 20.6947 140.536 21.7307 140.536 23.056C140.536 24.3813 140.881 25.4173 141.572 26.164C142.263 26.9107 143.103 27.284 144.092 27.284C144.839 27.284 145.483 27.0973 146.024 26.724C146.584 26.3507 146.957 25.8187 147.144 25.128H150.924C150.588 26.696 149.813 27.956 148.6 28.908C147.387 29.86 145.893 30.336 144.12 30.336ZM154.105 30V9.84H157.689V21.74L162.617 16.112H166.873L161.189 22.44L167.797 30H163.317L157.689 23.028V30H154.105ZM175.619 30.336C174.219 30.336 172.977 30.0373 171.895 29.44C170.812 28.8427 169.963 28.0027 169.347 26.92C168.731 25.8373 168.423 24.5867 168.423 23.168C168.423 21.7307 168.721 20.452 169.319 19.332C169.935 18.212 170.775 17.344 171.839 16.728C172.921 16.0933 174.191 15.776 175.647 15.776C177.009 15.776 178.213 16.0747 179.259 16.672C180.304 17.2693 181.116 18.0907 181.695 19.136C182.292 20.1627 182.591 21.3107 182.591 22.58C182.591 22.7853 182.581 23 182.563 23.224C182.563 23.448 182.553 23.6813 182.535 23.924H171.979C172.053 25.0067 172.427 25.856 173.099 26.472C173.789 27.088 174.62 27.396 175.591 27.396C176.319 27.396 176.925 27.2373 177.411 26.92C177.915 26.584 178.288 26.1547 178.531 25.632H182.171C181.909 26.5093 181.471 27.312 180.855 28.04C180.257 28.7493 179.511 29.3093 178.615 29.72C177.737 30.1307 176.739 30.336 175.619 30.336ZM175.647 18.688C174.769 18.688 173.995 18.94 173.323 19.444C172.651 19.9293 172.221 20.676 172.035 21.684H178.951C178.895 20.7693 178.559 20.0413 177.943 19.5C177.327 18.9587 176.561 18.688 175.647 18.688ZM192.353 30.336C190.953 30.336 189.712 30.0373 188.629 29.44C187.546 28.8427 186.697 28.0027 186.081 26.92C185.465 25.8373 185.157 24.5867 185.157 23.168C185.157 21.7307 185.456 20.452 186.053 19.332C186.669 18.212 187.509 17.344 188.573 16.728C189.656 16.0933 190.925 15.776 192.381 15.776C193.744 15.776 194.948 16.0747 195.993 16.672C197.038 17.2693 197.85 18.0907 198.429 19.136C199.026 20.1627 199.325 21.3107 199.325 22.58C199.325 22.7853 199.316 23 199.297 23.224C199.297 23.448 199.288 23.6813 199.269 23.924H188.713C188.788 25.0067 189.161 25.856 189.833 26.472C190.524 27.088 191.354 27.396 192.325 27.396C193.053 27.396 193.66 27.2373 194.145 26.92C194.649 26.584 195.022 26.1547 195.265 25.632H198.905C198.644 26.5093 198.205 27.312 197.589 28.04C196.992 28.7493 196.245 29.3093 195.349 29.72C194.472 30.1307 193.473 30.336 192.353 30.336ZM192.381 18.688C191.504 18.688 190.729 18.94 190.057 19.444C189.385 19.9293 188.956 20.676 188.769 21.684H195.685C195.629 20.7693 195.293 20.0413 194.677 19.5C194.061 18.9587 193.296 18.688 192.381 18.688Z" fill="#73FAC8"/>
 5 | <circle cx="17" cy="20" r="17" fill="url(#paint0_linear)"/>
 6 | </g>
 7 | <defs>
 8 | <linearGradient id="paint0_linear" x1="0" y1="3" x2="34" y2="37" gradientUnits="userSpaceOnUse">
 9 | <stop stop-color="#73FAC8"/>
10 | <stop offset="1" stop-color="#00BEE1"/>
11 | </linearGradient>
12 | <clipPath id="clip0">
13 | <rect width="200" height="40" fill="white"/>
14 | </clipPath>
15 | </defs>
16 | </svg>
17 | 


--------------------------------------------------------------------------------
/docs/public/logo-light.svg:
--------------------------------------------------------------------------------
 1 | <svg width="200" height="40" viewBox="0 0 200 40" fill="none" xmlns="http://www.w3.org/2000/svg">
 2 | <g clip-path="url(#clip0)">
 3 | <path d="M47.82 30V16.112H50.984L51.264 18.464C51.6933 17.6427 52.3093 16.9893 53.112 16.504C53.9333 16.0187 54.8947 15.776 55.996 15.776C57.7133 15.776 59.048 16.3173 60 17.4C60.952 18.4827 61.428 20.0693 61.428 22.16V30H57.844V22.496C57.844 21.3013 57.6013 20.3867 57.116 19.752C56.6307 19.1173 55.8747 18.8 54.848 18.8C53.84 18.8 53.0093 19.1547 52.356 19.864C51.7213 20.5733 51.404 21.5627 51.404 22.832V30H47.82ZM70.0632 30.336C68.3272 30.336 66.9832 29.7947 66.0312 28.712C65.0978 27.6293 64.6312 26.0427 64.6312 23.952V16.112H68.1872V23.616C68.1872 24.8107 68.4298 25.7253 68.9152 26.36C69.4005 26.9947 70.1658 27.312 71.2112 27.312C72.2005 27.312 73.0125 26.9573 73.6472 26.248C74.3005 25.5387 74.6272 24.5493 74.6272 23.28V16.112H78.2112V30H75.0472L74.7672 27.648C74.3378 28.4693 73.7125 29.1227 72.8912 29.608C72.0885 30.0933 71.1458 30.336 70.0632 30.336ZM80.5743 30L85.6143 23.056L80.5743 16.112H84.4103L87.9383 21.04L91.4383 16.112H95.3023L90.2343 23.056L95.3023 30H91.4383L87.9383 25.072L84.4103 30H80.5743ZM103.774 30C102.318 30 101.151 29.6453 100.274 28.936C99.3963 28.2267 98.9576 26.9667 98.9576 25.156V19.108H96.5776V16.112H98.9576L99.3776 12.388H102.542V16.112H106.294V19.108H102.542V25.184C102.542 25.856 102.682 26.3227 102.962 26.584C103.26 26.8267 103.764 26.948 104.474 26.948H106.21V30H103.774ZM108.195 33.108L115.195 8.244H118.695L111.667 33.108H108.195Z" fill="#003C3C"/>
 4 | <path d="M125.944 30.336C124.749 30.336 123.769 30.1493 123.004 29.776C122.239 29.384 121.669 28.8707 121.296 28.236C120.923 27.6013 120.736 26.9013 120.736 26.136C120.736 24.848 121.24 23.8027 122.248 23C123.256 22.1973 124.768 21.796 126.784 21.796H130.312V21.46C130.312 20.508 130.041 19.808 129.5 19.36C128.959 18.912 128.287 18.688 127.484 18.688C126.756 18.688 126.121 18.8653 125.58 19.22C125.039 19.556 124.703 20.06 124.572 20.732H121.072C121.165 19.724 121.501 18.8467 122.08 18.1C122.677 17.3533 123.443 16.784 124.376 16.392C125.309 15.9813 126.355 15.776 127.512 15.776C129.491 15.776 131.049 16.2707 132.188 17.26C133.327 18.2493 133.896 19.6493 133.896 21.46V30H130.844L130.508 27.76C130.097 28.5067 129.519 29.1227 128.772 29.608C128.044 30.0933 127.101 30.336 125.944 30.336ZM126.756 27.536C127.783 27.536 128.576 27.2 129.136 26.528C129.715 25.856 130.079 25.0253 130.228 24.036H127.176C126.224 24.036 125.543 24.2133 125.132 24.568C124.721 24.904 124.516 25.324 124.516 25.828C124.516 26.3693 124.721 26.7893 125.132 27.088C125.543 27.3867 126.084 27.536 126.756 27.536ZM144.12 30.336C142.701 30.336 141.451 30.028 140.368 29.412C139.285 28.796 138.427 27.9373 137.792 26.836C137.176 25.7347 136.868 24.4747 136.868 23.056C136.868 21.6373 137.176 20.3773 137.792 19.276C138.427 18.1747 139.285 17.316 140.368 16.7C141.451 16.084 142.701 15.776 144.12 15.776C145.893 15.776 147.387 16.2427 148.6 17.176C149.813 18.0907 150.588 19.36 150.924 20.984H147.144C146.957 20.312 146.584 19.7893 146.024 19.416C145.483 19.024 144.839 18.828 144.092 18.828C143.103 18.828 142.263 19.2013 141.572 19.948C140.881 20.6947 140.536 21.7307 140.536 23.056C140.536 24.3813 140.881 25.4173 141.572 26.164C142.263 26.9107 143.103 27.284 144.092 27.284C144.839 27.284 145.483 27.0973 146.024 26.724C146.584 26.3507 146.957 25.8187 147.144 25.128H150.924C150.588 26.696 149.813 27.956 148.6 28.908C147.387 29.86 145.893 30.336 144.12 30.336ZM154.105 30V9.84H157.689V21.74L162.617 16.112H166.873L161.189 22.44L167.797 30H163.317L157.689 23.028V30H154.105ZM175.619 30.336C174.219 30.336 172.977 30.0373 171.895 29.44C170.812 28.8427 169.963 28.0027 169.347 26.92C168.731 25.8373 168.423 24.5867 168.423 23.168C168.423 21.7307 168.721 20.452 169.319 19.332C169.935 18.212 170.775 17.344 171.839 16.728C172.921 16.0933 174.191 15.776 175.647 15.776C177.009 15.776 178.213 16.0747 179.259 16.672C180.304 17.2693 181.116 18.0907 181.695 19.136C182.292 20.1627 182.591 21.3107 182.591 22.58C182.591 22.7853 182.581 23 182.563 23.224C182.563 23.448 182.553 23.6813 182.535 23.924H171.979C172.053 25.0067 172.427 25.856 173.099 26.472C173.789 27.088 174.62 27.396 175.591 27.396C176.319 27.396 176.925 27.2373 177.411 26.92C177.915 26.584 178.288 26.1547 178.531 25.632H182.171C181.909 26.5093 181.471 27.312 180.855 28.04C180.257 28.7493 179.511 29.3093 178.615 29.72C177.737 30.1307 176.739 30.336 175.619 30.336ZM175.647 18.688C174.769 18.688 173.995 18.94 173.323 19.444C172.651 19.9293 172.221 20.676 172.035 21.684H178.951C178.895 20.7693 178.559 20.0413 177.943 19.5C177.327 18.9587 176.561 18.688 175.647 18.688ZM192.353 30.336C190.953 30.336 189.712 30.0373 188.629 29.44C187.546 28.8427 186.697 28.0027 186.081 26.92C185.465 25.8373 185.157 24.5867 185.157 23.168C185.157 21.7307 185.456 20.452 186.053 19.332C186.669 18.212 187.509 17.344 188.573 16.728C189.656 16.0933 190.925 15.776 192.381 15.776C193.744 15.776 194.948 16.0747 195.993 16.672C197.038 17.2693 197.85 18.0907 198.429 19.136C199.026 20.1627 199.325 21.3107 199.325 22.58C199.325 22.7853 199.316 23 199.297 23.224C199.297 23.448 199.288 23.6813 199.269 23.924H188.713C188.788 25.0067 189.161 25.856 189.833 26.472C190.524 27.088 191.354 27.396 192.325 27.396C193.053 27.396 193.66 27.2373 194.145 26.92C194.649 26.584 195.022 26.1547 195.265 25.632H198.905C198.644 26.5093 198.205 27.312 197.589 28.04C196.992 28.7493 196.245 29.3093 195.349 29.72C194.472 30.1307 193.473 30.336 192.353 30.336ZM192.381 18.688C191.504 18.688 190.729 18.94 190.057 19.444C189.385 19.9293 188.956 20.676 188.769 21.684H195.685C195.629 20.7693 195.293 20.0413 194.677 19.5C194.061 18.9587 193.296 18.688 192.381 18.688Z" fill="#65DEB1"/>
 5 | <circle cx="17" cy="20" r="17" fill="url(#paint0_linear)"/>
 6 | </g>
 7 | <defs>
 8 | <linearGradient id="paint0_linear" x1="0" y1="3" x2="34" y2="37" gradientUnits="userSpaceOnUse">
 9 | <stop stop-color="#73FAC8"/>
10 | <stop offset="1" stop-color="#00BEE1"/>
11 | </linearGradient>
12 | <clipPath id="clip0">
13 | <rect width="200" height="40" fill="white"/>
14 | </clipPath>
15 | </defs>
16 | </svg>
17 | 


--------------------------------------------------------------------------------
/docs/components/Logo.vue:
--------------------------------------------------------------------------------
 1 | <template>
 2 |   <svg width="200" height="40" viewBox="0 0 200 40" fill="none" xmlns="http://www.w3.org/2000/svg">
 3 |     <g clip-path="url(#clip0)">
 4 |       <path
 5 |         d="M47.82 30V16.112H50.984L51.264 18.464C51.6933 17.6427 52.3093 16.9893 53.112 16.504C53.9333 16.0187 54.8947 15.776 55.996 15.776C57.7133 15.776 59.048 16.3173 60 17.4C60.952 18.4827 61.428 20.0693 61.428 22.16V30H57.844V22.496C57.844 21.3013 57.6013 20.3867 57.116 19.752C56.6307 19.1173 55.8747 18.8 54.848 18.8C53.84 18.8 53.0093 19.1547 52.356 19.864C51.7213 20.5733 51.404 21.5627 51.404 22.832V30H47.82ZM70.0632 30.336C68.3272 30.336 66.9832 29.7947 66.0312 28.712C65.0978 27.6293 64.6312 26.0427 64.6312 23.952V16.112H68.1872V23.616C68.1872 24.8107 68.4298 25.7253 68.9152 26.36C69.4005 26.9947 70.1658 27.312 71.2112 27.312C72.2005 27.312 73.0125 26.9573 73.6472 26.248C74.3005 25.5387 74.6272 24.5493 74.6272 23.28V16.112H78.2112V30H75.0472L74.7672 27.648C74.3378 28.4693 73.7125 29.1227 72.8912 29.608C72.0885 30.0933 71.1458 30.336 70.0632 30.336ZM80.5743 30L85.6143 23.056L80.5743 16.112H84.4103L87.9383 21.04L91.4383 16.112H95.3023L90.2343 23.056L95.3023 30H91.4383L87.9383 25.072L84.4103 30H80.5743ZM103.774 30C102.318 30 101.151 29.6453 100.274 28.936C99.3963 28.2267 98.9576 26.9667 98.9576 25.156V19.108H96.5776V16.112H98.9576L99.3776 12.388H102.542V16.112H106.294V19.108H102.542V25.184C102.542 25.856 102.682 26.3227 102.962 26.584C103.26 26.8267 103.764 26.948 104.474 26.948H106.21V30H103.774ZM108.195 33.108L115.195 8.244H118.695L111.667 33.108H108.195Z"
 6 |         fill="var(--logo-fill-color)" />
 7 |       <path
 8 |         d="M125.944 30.336C124.749 30.336 123.769 30.1493 123.004 29.776C122.239 29.384 121.669 28.8707 121.296 28.236C120.923 27.6013 120.736 26.9013 120.736 26.136C120.736 24.848 121.24 23.8027 122.248 23C123.256 22.1973 124.768 21.796 126.784 21.796H130.312V21.46C130.312 20.508 130.041 19.808 129.5 19.36C128.959 18.912 128.287 18.688 127.484 18.688C126.756 18.688 126.121 18.8653 125.58 19.22C125.039 19.556 124.703 20.06 124.572 20.732H121.072C121.165 19.724 121.501 18.8467 122.08 18.1C122.677 17.3533 123.443 16.784 124.376 16.392C125.309 15.9813 126.355 15.776 127.512 15.776C129.491 15.776 131.049 16.2707 132.188 17.26C133.327 18.2493 133.896 19.6493 133.896 21.46V30H130.844L130.508 27.76C130.097 28.5067 129.519 29.1227 128.772 29.608C128.044 30.0933 127.101 30.336 125.944 30.336ZM126.756 27.536C127.783 27.536 128.576 27.2 129.136 26.528C129.715 25.856 130.079 25.0253 130.228 24.036H127.176C126.224 24.036 125.543 24.2133 125.132 24.568C124.721 24.904 124.516 25.324 124.516 25.828C124.516 26.3693 124.721 26.7893 125.132 27.088C125.543 27.3867 126.084 27.536 126.756 27.536ZM144.12 30.336C142.701 30.336 141.451 30.028 140.368 29.412C139.285 28.796 138.427 27.9373 137.792 26.836C137.176 25.7347 136.868 24.4747 136.868 23.056C136.868 21.6373 137.176 20.3773 137.792 19.276C138.427 18.1747 139.285 17.316 140.368 16.7C141.451 16.084 142.701 15.776 144.12 15.776C145.893 15.776 147.387 16.2427 148.6 17.176C149.813 18.0907 150.588 19.36 150.924 20.984H147.144C146.957 20.312 146.584 19.7893 146.024 19.416C145.483 19.024 144.839 18.828 144.092 18.828C143.103 18.828 142.263 19.2013 141.572 19.948C140.881 20.6947 140.536 21.7307 140.536 23.056C140.536 24.3813 140.881 25.4173 141.572 26.164C142.263 26.9107 143.103 27.284 144.092 27.284C144.839 27.284 145.483 27.0973 146.024 26.724C146.584 26.3507 146.957 25.8187 147.144 25.128H150.924C150.588 26.696 149.813 27.956 148.6 28.908C147.387 29.86 145.893 30.336 144.12 30.336ZM154.105 30V9.84H157.689V21.74L162.617 16.112H166.873L161.189 22.44L167.797 30H163.317L157.689 23.028V30H154.105ZM175.619 30.336C174.219 30.336 172.977 30.0373 171.895 29.44C170.812 28.8427 169.963 28.0027 169.347 26.92C168.731 25.8373 168.423 24.5867 168.423 23.168C168.423 21.7307 168.721 20.452 169.319 19.332C169.935 18.212 170.775 17.344 171.839 16.728C172.921 16.0933 174.191 15.776 175.647 15.776C177.009 15.776 178.213 16.0747 179.259 16.672C180.304 17.2693 181.116 18.0907 181.695 19.136C182.292 20.1627 182.591 21.3107 182.591 22.58C182.591 22.7853 182.581 23 182.563 23.224C182.563 23.448 182.553 23.6813 182.535 23.924H171.979C172.053 25.0067 172.427 25.856 173.099 26.472C173.789 27.088 174.62 27.396 175.591 27.396C176.319 27.396 176.925 27.2373 177.411 26.92C177.915 26.584 178.288 26.1547 178.531 25.632H182.171C181.909 26.5093 181.471 27.312 180.855 28.04C180.257 28.7493 179.511 29.3093 178.615 29.72C177.737 30.1307 176.739 30.336 175.619 30.336ZM175.647 18.688C174.769 18.688 173.995 18.94 173.323 19.444C172.651 19.9293 172.221 20.676 172.035 21.684H178.951C178.895 20.7693 178.559 20.0413 177.943 19.5C177.327 18.9587 176.561 18.688 175.647 18.688ZM192.353 30.336C190.953 30.336 189.712 30.0373 188.629 29.44C187.546 28.8427 186.697 28.0027 186.081 26.92C185.465 25.8373 185.157 24.5867 185.157 23.168C185.157 21.7307 185.456 20.452 186.053 19.332C186.669 18.212 187.509 17.344 188.573 16.728C189.656 16.0933 190.925 15.776 192.381 15.776C193.744 15.776 194.948 16.0747 195.993 16.672C197.038 17.2693 197.85 18.0907 198.429 19.136C199.026 20.1627 199.325 21.3107 199.325 22.58C199.325 22.7853 199.316 23 199.297 23.224C199.297 23.448 199.288 23.6813 199.269 23.924H188.713C188.788 25.0067 189.161 25.856 189.833 26.472C190.524 27.088 191.354 27.396 192.325 27.396C193.053 27.396 193.66 27.2373 194.145 26.92C194.649 26.584 195.022 26.1547 195.265 25.632H198.905C198.644 26.5093 198.205 27.312 197.589 28.04C196.992 28.7493 196.245 29.3093 195.349 29.72C194.472 30.1307 193.473 30.336 192.353 30.336ZM192.381 18.688C191.504 18.688 190.729 18.94 190.057 19.444C189.385 19.9293 188.956 20.676 188.769 21.684H195.685C195.629 20.7693 195.293 20.0413 194.677 19.5C194.061 18.9587 193.296 18.688 192.381 18.688Z"
 9 |         fill="#73FAC8" />
10 |       <circle cx="17" cy="20" r="17" fill="url(#paint0_linear)" />
11 |     </g>
12 |     <defs>
13 |       <linearGradient id="paint0_linear" x1="0" y1="3" x2="34" y2="37" gradientUnits="userSpaceOnUse">
14 |         <stop stop-color="#73FAC8" />
15 |         <stop offset="1" stop-color="#00BEE1" />
16 |       </linearGradient>
17 |       <clipPath id="clip0">
18 |         <rect width="200" height="40" fill="white" />
19 |       </clipPath>
20 |     </defs>
21 |   </svg>
22 | 
23 | </template>
24 | 
25 | <style scoped lang="ts">
26 | css({
27 |   svg: {
28 |     '--logo-fill-color': '#003C3C',
29 | 
30 |     '@dark': {
31 |       '--logo-fill-color': 'white'
32 |     }
33 |   }
34 | })
35 | </style>
36 | 


--------------------------------------------------------------------------------
/docs/content/index.md:
--------------------------------------------------------------------------------
  1 | ---
  2 | title: "Documentation"
  3 | description: "Track without being tracked on Nuxt with Ackee analytics."
  4 | layout: "default"
  5 | aside: false
  6 | ---
  7 | 
  8 | # Documentation
  9 | 
 10 | Track without being tracked on Nuxt with Ackee analytics.
 11 | 
 12 | ---
 13 | 
 14 | ::list
 15 |   - Add Ackee to your Nuxt app in seconds
 16 |   - Ask for user consent easily
 17 |   - Automatic script loading
 18 |   - Automatic page tracking
 19 |   - Access to tracker with $ackee
 20 | ::
 21 | 
 22 | [Check Release Notes](https://github.com/nuxt-community/ackee-module/blob/main/CHANGELOG.md)
 23 | 
 24 | ## Ackee?
 25 | 
 26 | [Ackee analytics](https://ackee.electerious.com) is a self-hosted, Node.js based analytics tool that has an incentive on privacy.
 27 | 
 28 | You can set up your own Ackee instance pretty easily on [Heroku](https://docs.ackee.electerious.com/#/docs/Get%20started#with-heroku), [Netlify](https://docs.ackee.electerious.com/#/docs/Get%20started#with-netlify), [Vercel](https://docs.ackee.electerious.com/#/docs/Get%20started#with-vercel), and [many more](https://docs.ackee.electerious.com/#/docs/Get%20started). [MongoDB Atlas](https://www.mongodb.com/pricing) can also provide you with a cloud-based Mongo database.
 29 | 
 30 | This module allows you to plug easily your Nuxt website to a domain on your Ackee installation!
 31 | 
 32 | ## Setup
 33 | 
 34 | Add `@nuxtjs/ackee` dependency to your project:
 35 | 
 36 | ::code-group
 37 | <!-- prettier-ignore -->
 38 | ```bash [Yarn]
 39 | yarn add --dev @nuxtjs/ackee
 40 | ```
 41 | <!-- prettier-ignore -->
 42 | ```bash [NPM]
 43 | npm install --save-dev @nuxtjs/ackee
 44 | ```
 45 | ::
 46 | 
 47 | Then add `@nuxtjs/ackee` to the `buildModule` section of `nuxt.config.js` and configure your Ackee `server` and `domainId`:
 48 | 
 49 | <!-- prettier-ignore -->
 50 | ```javascript[nuxt.config.js]
 51 | {
 52 |   buildModules: [
 53 |     '@nuxtjs/ackee'
 54 |   ],
 55 |   ackee: {
 56 |     server: 'https://example.com',
 57 |     domainId: 'aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee'
 58 |     /* see configuration for more */
 59 |   }
 60 | }
 61 | ```
 62 | 
 63 | ::alert
 64 | Use the `modules` property instead of `buildModules` if you are using `nuxt < 2.9.0`
 65 | ::
 66 | 
 67 | Voilà! Your Nuxt application is ready to report to your Ackee domain~
 68 | 
 69 | ## Usage
 70 | 
 71 | This module injects `$ackee` into your application. It contains an [`ackee-tracker` instance](https://github.com/electerious/ackee-tracker#%EF%B8%8F-instance-api) (but not only, see [asking for consent](#asking-for-consent)). You can use it to create and update new records, actions, and more.
 72 | 
 73 | ::alert
 74 | This module already takes care of creating a new record on every page navigation. That's why in most cases you don't need to get beyond the above setup!
 75 | ::
 76 | 
 77 | ### Sending Events
 78 | 
 79 | <!-- prettier-ignore -->
 80 | ```vue[pages/contact.vue]
 81 | <template>
 82 |   <form @submit="onSubmit"><!-- ... --></form>
 83 | </template>
 84 | 
 85 | <script>
 86 | export default {
 87 |   methods: {
 88 |     onSubmit(e) {
 89 |       this.$ackee.action(
 90 |         'ffffffff-gggg-hhhh-iiii-jjjjjjjjjjjj', // actionId
 91 |         {
 92 |           key: 'Contact Form Submit',
 93 |           value: 1
 94 |         }
 95 |       )
 96 |     }
 97 |   }
 98 | }
 99 | </script>
100 | ```
101 | 
102 | <alert>
103 | 
104 | Ackee recommends to ask user for consent before sending events. For that purpose you can leverage this module's injected [`details.value`](#detailsvalue) property when using the `detailed` option, see [asking for consent](#asking-for-consent) below. More about events on [Ackee documentation](https://docs.ackee.electerious.com/#/docs/Events).
105 | 
106 | </alert>
107 | 
108 | ### Asking for Consent
109 | 
110 | The [detailed option](#detailed) allows you to gather personal data from your visitors. [Ackee recommends](https://docs.ackee.electerious.com/#/docs/Anonymization#personal-data) asking for user consent before enabling this option. To get started, set the `detailed` option in your Ackee configuration:
111 | 
112 | <!-- prettier-ignore -->
113 | ```javascript[nuxt.config.js]
114 | ackee: {
115 |   // do not gather detailed data unless user gives permission
116 |   detailed: 'opt-in'
117 | }
118 | ```
119 | 
120 | > An `opt-out` mode exists, working the other way around. Consider it if you were using `detailed: true`, it's better than nothing~
121 | >
122 | > See all [available values](#detailed).
123 | 
124 | From now on, a new object will be available at the key `details` in the injected `$ackee` object with the following methods and reactive properties:
125 | 
126 | - `optIn()`: opt-in current user from sharing detailed data;
127 | - `optOut()`: opt-out current user from sharing detailed data;
128 | - `value`: can be used to know if Ackee is allowed to send data;
129 | - `preference`: contains the user's preference if any;
130 | - `unknown`: since user opt status is detected on client-side we cannot know it when on server side. Use this property to prevent showing your banner there.
131 | 
132 | **Example:**
133 | 
134 | <!-- prettier-ignore -->
135 | ```vue[components/ConsentBanner.vue]
136 | <!-- assuming `detailed: 'opt-in'` -->
137 | <template>
138 |   <div v-if="!$ackee.details.unknown && !$ackee.details.preference">
139 |     Allow website to gather data for improvement? (language, browser, screen
140 |     width, etc.)
141 |     <button @click="$ackee.details.optIn">Sure!</button>
142 |     <button @click="$ackee.details.optOut">No thank you!</button>
143 |   </div>
144 | </template>
145 | ```
146 | 
147 | ## Configuration
148 | 
149 | You can configure `@nuxtjs/ackee` with the `ackee` property in your `nuxt.config.js` or directly when registering the module in the `buildModules` array by using the array syntax.
150 | 
151 | ::code-group
152 | <!-- prettier-ignore -->
153 | ```javascript [ackee key]
154 | export default {
155 |   ackee: {
156 |     /* configuration */
157 |   }
158 | }
159 | ```
160 | 
161 | <!-- prettier-ignore -->
162 | ```javascript [buildModules array]
163 | export default {
164 |   buildModules: {
165 |     ['@nuxtjs/ackee', {
166 |       /* configuration */
167 |     }]
168 |   }
169 | }
170 | ```
171 | ::
172 | 
173 | ### Properties
174 | 
175 | #### server
176 | 
177 | - Type: `String`
178 | - `required`
179 | 
180 | An URL that points to your [Ackee](https://github.com/electerious/Ackee) installation. The `server` property must not end with a slash.
181 | 
182 | <!-- prettier-ignore -->
183 | ```javascript[nuxt.config.js]
184 | ackee: {
185 |   // Nuxt.js private Ackee server example
186 |   server: 'https://ackee.nuxtjs.com'
187 | }
188 | ```
189 | 
190 | #### domainId
191 | 
192 | - Type: `String`
193 | - `required`
194 | 
195 | Id of the desired domain to target.
196 | 
197 | <!-- prettier-ignore -->
198 | ```javascript[nuxt.config.js]
199 | ackee: {
200 |   // example domain id
201 |   domainId: 'aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee'
202 | }
203 | ```
204 | 
205 | #### detailed
206 | 
207 | - Type: `Boolean|String`
208 | - Default: `false`
209 | 
210 | Enable or disable tracking of personal data. Possible values are:
211 | 
212 | - `false`, never collect detailed data;
213 | - `true`, always collect detailed data;
214 | - `'opt-in'`, do not gather detailed data unless user gives permission;
215 | - `'opt-out'`, gather detailed data unless user ask not to.
216 | 
217 | <!-- prettier-ignore -->
218 | ```javascript[nuxt.config.js]
219 | ackee: {
220 |   // tells Ackee to gather detailed data only with user's permission
221 |   detailed: 'opt-in'
222 | }
223 | ```
224 | 
225 | > See [Ackee's recommendations](https://docs.ackee.electerious.com/#/docs/Anonymization#personal-data) regarding this feature.
226 | 
227 | #### ignoreLocalhost
228 | 
229 | - Type: `Boolean`
230 | - Default: `true`
231 | 
232 | Enable or disable tracking when on localhost.
233 | 
234 | <!-- prettier-ignore -->
235 | ```javascript[nuxt.config.js]
236 | ackee: {
237 |   // also tracks when on localhost
238 |   ignoreLocalhost: false
239 | }
240 | ```
241 | 
242 | #### ignoreOwnVisits
243 | 
244 | - Type: `Boolean`
245 | - Default: `true`
246 | 
247 | Enable or disable the tracking of your own visits.
248 | 
249 | <!-- prettier-ignore -->
250 | ```javascript[nuxt.config.js]
251 | ackee: {
252 |   // also tracks your own visits
253 |   ignoreOwnVisits: false
254 | }
255 | ```
256 | 
257 | ::alert{type="warning"}
258 | For this feature to work you need to set up an `Access-Control-Allow-Credentials` header on your Ackee installation, [more info](https://docs.ackee.electerious.com/#/docs/CORS%20headers#credentials).
259 | ::
260 | 
261 | ::alert{type="warning"}
262 | This feature should be turned off when using a wildcard `Access-Control-Allow-Origin` header, [more info](https://docs.ackee.electerious.com/#/docs/Options#cors-headers).
263 | ::
264 | 
265 | #### storageKey
266 | 
267 | - Type: `String`
268 | - Default: `nuxt-ackee`
269 | 
270 | When using `'opt-in'` or `'opt-out'` with the [detailed](#detailed) option, used to determine the local storage key used to save user's preference.
271 | 
272 | <!-- prettier-ignore -->
273 | ```javascript[nuxt.config.js]
274 | ackee: {
275 |   // store user's preference at `custom-key` inside their local storage
276 |   storageKey: 'custom-key'
277 | }
278 | ```
279 | 
280 | ### Defaults
281 | 
282 | Default configuration only expects you to provide your [Ackee server](#server) and [domain ID](#domainid).
283 | 
284 | <!-- prettier-ignore -->
285 | ```javascript[nuxt.config.js]
286 | export default {
287 |   ackee: {
288 |     server: '',
289 |     domainId: '',
290 |     detailed: false,
291 |     ignoreLocalhost: true,
292 |     ignoreOwnVisits: true,
293 |     storageKey: 'nuxt-ackee'
294 |   }
295 | }
296 | ```
297 | 
298 | ## \$ackee object
299 | 
300 | This module globally injects a `$ackee` object, meaning that you can access it anywhere using `this.$ackee`. For plugins, `asyncData`, `nuxtServerInit` and middlewares, you can access it from `context.$ackee`.
301 | 
302 | ::alert{type="warning"}
303 | `details.*` methods and properties are only available when using `'opt-in'` or `'opt-out'` with the [detailed](#detailed) option.
304 | ::
305 | 
306 | ### Methods
307 | 
308 | #### record(), updateRecord(), action(), updateAction()
309 | 
310 | Those methods are directly forwarded from [`ackee-tracker` instance API](https://github.com/electerious/ackee-tracker#%EF%B8%8F-instance-api).
311 | 
312 | #### details.optIn()
313 | 
314 | Opt-in current user from sharing detailed data.
315 | 
316 | #### details.optOut()
317 | 
318 | Opt-out current user from sharing detailed data.
319 | 
320 | ### Properties
321 | 
322 | #### details.value
323 | 
324 | - Type: `Boolean`
325 | - Value: `true` when Ackee is allowed to send detailed data.
326 | 
327 | #### details.preference
328 | 
329 | - Type: `String`
330 | - Values: `null` when no preference has been set, `'opted-in'`, `'opted-out'`
331 | 
332 | #### details.unknown
333 | 
334 | - Type: `Boolean`
335 | - Value: `true` when opt status is not yet detected, before client-side.
336 | 
337 | ## Contributing
338 | 
339 | You're welcome to contribute to this module!
340 | 
341 | 1. Clone this repository
342 | 2. Install dependencies using `yarn install` or `npm install`
343 | 3. Start development server using `yarn dev` or `npm run dev`
344 | 
345 | ## License
346 | 
347 | [MIT License](https://github.com/nuxt-community/ackee-module/blob/main/LICENSE)
348 | 
349 | Thanks to [Sergey Bedritsky](https://github.com/bdrtsky) for the initial implementation and transfer to the community of [nuxt-ackee](https://github.com/bdrtsky/nuxt-ackee).
350 | 


--------------------------------------------------------------------------------