@vuepress/plugin-umami-analytics 2.0.0-rc.27

package/LICENSE

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

package/lib/client/composables/index.d.ts

@@ -0,0 +1 @@
+export * from './useUmamiAnalytics.js';

package/lib/client/composables/index.js

@@ -0,0 +1 @@
+export * from './useUmamiAnalytics.js';

package/lib/client/composables/useUmamiAnalytics.d.ts

@@ -0,0 +1,19 @@
+import type { UmamiOptions } from '../../shared/index.js';
+declare global {
+    interface Window {
+        umami: {
+            track: {
+                (payload?: Record<any, any>): void;
+                (name: string, data?: Record<any, any>): void;
+            };
+        };
+    }
+}
+/**
+ * Add umami analytics to the site
+ *
+ * @see https://tongji.umami.com/
+ * @see https://tongji.umami.com/holmes/Analytics/%E7%99%BE%E5%BA%A6%E7%BB%9F%E8%AE%A1%E4%BD%BF%E7%94%A8%E6%89%8B%E5%86%8C
+ * @see https://tongji.umami.com/holmes/Analytics/%E6%8A%80%E6%9C%AF%E6%8E%A5%E5%85%A5%E6%8C%87%E5%8D%97/JS%20API/JS%20API%E6%8A%80%E6%9C%AF%E6%96%87%E6%A1%A3/_trackPageview
+ */
+export declare const useUmamiAnalytics: ({ link, id, domains, autoTrack, cache, hostUrl, }: UmamiOptions) => void;

package/lib/client/composables/useUmamiAnalytics.js

@@ -0,0 +1,25 @@
+/**
+ * Add umami analytics to the site
+ *
+ * @see https://tongji.umami.com/
+ * @see https://tongji.umami.com/holmes/Analytics/%E7%99%BE%E5%BA%A6%E7%BB%9F%E8%AE%A1%E4%BD%BF%E7%94%A8%E6%89%8B%E5%86%8C
+ * @see https://tongji.umami.com/holmes/Analytics/%E6%8A%80%E6%9C%AF%E6%8E%A5%E5%85%A5%E6%8C%87%E5%8D%97/JS%20API/JS%20API%E6%8A%80%E6%9C%AF%E6%96%87%E6%A1%A3/_trackPageview
+ */
+export const useUmamiAnalytics = ({ link = 'https://us.umami.is/script.js', id, domains, autoTrack, cache, hostUrl, }) => {
+    // avoid duplicated import
+    if (window.umami)
+        return;
+    const script = document.createElement('script');
+    script.src = link;
+    script.async = true;
+    script.setAttribute('data-website-id', id);
+    if (autoTrack === false)
+        script.setAttribute('data-auto-track', 'false');
+    if (cache)
+        script.setAttribute('data-cache', 'true');
+    if (domains)
+        script.setAttribute('data-domains', domains.join(','));
+    if (hostUrl)
+        script.setAttribute('data-hostUrl', hostUrl);
+    document.head.appendChild(script);
+};

package/lib/client/config.d.ts

@@ -0,0 +1,3 @@
+import type { ClientConfig } from 'vuepress/client';
+declare const _default: ClientConfig;
+export default _default;

package/lib/client/config.js

@@ -0,0 +1,9 @@
+import { defineClientConfig } from 'vuepress/client';
+import { useUmamiAnalytics } from './composables/index.js';
+export default defineClientConfig({
+    setup() {
+        if (__VUEPRESS_SSR__)
+            return;
+        useUmamiAnalytics(__UMM_OPTIONS__);
+    },
+});

package/lib/client/index.d.ts

@@ -0,0 +1 @@
+export * from './composables/index.js';

package/lib/client/index.js

@@ -0,0 +1 @@
+export * from './composables/index.js';

package/lib/node/index.d.ts

@@ -0,0 +1,2 @@
+export * from './umamiAnalyticsPlugin.js';
+export type { UmamiOptions as UmamiPluginOptions } from '../shared/index.js';

package/lib/node/index.js

@@ -0,0 +1 @@
+export * from './umamiAnalyticsPlugin.js';

package/lib/node/umamiAnalyticsPlugin.d.ts

@@ -0,0 +1,3 @@
+import type { Plugin } from 'vuepress/core';
+import type { UmamiOptions } from '../shared/index.js';
+export declare const umamiAnalyticsPlugin: ({ id, ...options }: UmamiOptions) => Plugin;

package/lib/node/umamiAnalyticsPlugin.js

@@ -0,0 +1,25 @@
+import { Logger } from '@vuepress/helper';
+import { colors, getDirname, path } from 'vuepress/utils';
+const __dirname = getDirname(import.meta.url);
+const PLUGIN_NAME = '@vuepress/plugin-umami-analytics';
+const logger = new Logger(PLUGIN_NAME);
+export const umamiAnalyticsPlugin = ({ id, ...options }) => (app) => {
+    const plugin = {
+        name: PLUGIN_NAME,
+    };
+    if (!id) {
+        logger.warn(`${colors.cyan('id')} is required!`);
+        return plugin;
+    }
+    // returns an empty plugin in dev mode when debug mode is not enabled
+    if (app.env.isDev) {
+        return plugin;
+    }
+    return {
+        ...plugin,
+        define: {
+            __UMM_OPTIONS__: { id, ...options },
+        },
+        clientConfigFile: path.resolve(__dirname, '../client/config.js'),
+    };
+};

package/lib/shared/index.d.ts

@@ -0,0 +1 @@
+export * from './options.js';

package/lib/shared/index.js

@@ -0,0 +1 @@
+export * from './options.js';

package/lib/shared/options.d.ts

@@ -0,0 +1,47 @@
+/**
+ * Options for @vuepress/plugin-umami-analytics
+ */
+export interface UmamiOptions {
+    /**
+     * The website ID in umami Analytics
+     *
+     * Umami 统计中的网站 ID。
+     */
+    id: string;
+    /**
+     * Link of umami analytics script
+     *
+     * Umami 统计的脚本链接
+     *
+     * @default 'https://us.umami.is/script.js'
+     */
+    link?: string;
+    /**
+     * By default, Umami tracks all pageviews and events for you automatically. You can disable this behavior and track events yourself using the tracker functions.
+     *
+     * 默认情况下，Umami 会自动跟踪所有页面浏览量和事件。你可以禁用此行为并使用追踪器功能自行追踪事件。
+     *
+     * @default true
+     */
+    autoTrack?: boolean;
+    /**
+     * Cache data to improve the performance of the tracking script.
+     *
+     * 缓存数据以提高追踪脚本的性能。
+     */
+    cache?: boolean;
+    /**
+     * Let the tracker only run on specific domains.
+     *
+     * 让跟踪器仅在特定的域名上运行。
+     */
+    domains?: string[];
+    /**
+     * Location to send data
+     *
+     * 发送数据的位置
+     *
+     * @default link
+     */
+    hostUrl?: string;
+}

package/lib/shared/options.js

@@ -0,0 +1 @@
+export {};

package/package.json

@@ -0,0 +1,53 @@
+{
+  "name": "@vuepress/plugin-umami-analytics",
+  "version": "2.0.0-rc.27",
+  "description": "VuePress plugin - umami-analytics",
+  "keywords": [
+    "vuepress-plugin",
+    "vuepress",
+    "plugin",
+    "umami",
+    "analytics"
+  ],
+  "homepage": "https://ecosystem.vuejs.press/plugins/umami-analytics.html",
+  "bugs": {
+    "url": "https://github.com/vuepress/ecosystem/issues"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/vuepress/ecosystem.git",
+    "directory": "plugins/plugin-umami-analytics"
+  },
+  "license": "MIT",
+  "author": {
+    "name": "Mr.Hope",
+    "email": "mister-hope@outlook.com",
+    "url": "https://mister-hope.com"
+  },
+  "type": "module",
+  "exports": {
+    ".": "./lib/node/index.js",
+    "./client": "./lib/client/index.js",
+    "./package.json": "./package.json"
+  },
+  "main": "./lib/node/index.js",
+  "types": "./lib/node/index.d.ts",
+  "files": [
+    "lib"
+  ],
+  "scripts": {
+    "build": "tsc -b tsconfig.build.json",
+    "clean": "rimraf --glob ./lib ./*.tsbuildinfo"
+  },
+  "dependencies": {
+    "@vuepress/helper": "~2.0.0-rc.27",
+    "vue": "^3.4.26"
+  },
+  "peerDependencies": {
+    "vuepress": "2.0.0-rc.9"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "gitHead": "146dd05c696c2287eba9498ee8ec7476fabccb0b"
+}