@vuepress/plugin-umami-analytics 2.0.0-rc.106 → 2.0.0-rc.108

package/lib/client/index.d.ts

@@ -1,45 +1,77 @@
 /**
  * Options for @vuepress/plugin-umami-analytics
+ *
+ * @vuepress/plugin-umami-analytics 插件选项
  */
 interface UmamiOptions {
     /**
-     * The website ID in umami Analytics
+     * Umami Analytics website ID
+     *
+     * Umami Analytics 网站 ID
+     *
+     * @description The website ID from your Umami Analytics dashboard
      *
-     * Umami 统计中的网站 ID。
+     * 从 Umami Analytics 仪表板获取的网站 ID
      */
     id: string;
     /**
-     * Link of umami analytics script
+     * Umami Analytics script URL
+     *
+     * Umami Analytics 脚本链接
+     *
+     * @description URL to the Umami tracking script
      *
-     * Umami 统计的脚本链接
+     * Umami 追踪脚本的 URL
      *
      * @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.
+     * Enable automatic tracking
      *
-     * 默认情况下，Umami 会自动跟踪所有页面浏览量和事件。你可以禁用此行为并使用追踪器功能自行追踪事件。
+     * 启用自动追踪
+     *
+     * @description When enabled, Umami automatically tracks pageviews and events.
+     * Set to `false` to use manual tracking with tracker functions.
+     *
+     * 启用时，Umami 会自动追踪页面浏览和事件。
+     * 设为 `false` 可使用手动追踪功能。
      *
      * @default true
      */
     autoTrack?: boolean;
     /**
-     * Cache data to improve the performance of the tracking script.
+     * Enable data caching
+     *
+     * 启用数据缓存
+     *
+     * @description Cache data to improve tracking script performance.
+     * Uses session storage and may require user notification.
      *
-     * 缓存数据以提高追踪脚本的性能。
+     * 缓存数据以提高追踪脚本性能。
+     * 使用会话存储，可能需要通知用户。
+     *
+     * @default false
      */
     cache?: boolean;
     /**
-     * Let the tracker only run on specific domains.
+     * Restrict tracking to specific domains
+     *
+     * 限制追踪到特定域名
+     *
+     * @description Array of domains where tracking should be active
      *
-     * 让跟踪器仅在特定的域名上运行。
+     * 限制追踪活跃的域名数组
      */
     domains?: string[];
     /**
-     * Location to send data
+     * Data collection endpoint
+     *
+     * 数据收集端点
+     *
+     * @description Custom URL for sending tracking data
      *
-     * 发送数据的位置
+     * 发送追踪数据的自定义 URL
      *
      * @default link
      */
@@ -57,10 +89,20 @@ declare global {
     }
 }
 /**
- * Add umami analytics to the site
+ * Initialize Umami Analytics tracking
+ *
+ * 初始化 Umami Analytics 追踪
+ *
+ * @param options - Umami Analytics options
+ *
+ * @description Injects Umami tracking script and configures tracking behavior.
+ * The global `umami.track()` function will be available for custom event tracking.
+ *
+ * 注入 Umami 追踪脚本并配置追踪行为。
+ * 全局 `umami.track()` 函数可用于自定义事件追踪。
  *
- * @see https://umami.is/docs/install
  * @see https://umami.is/docs/tracker-functions
+ * @see https://umami.is/docs/tracker-configuration
  */
 declare const useUmamiAnalytics: ({ link, id, domains, autoTrack, cache, hostUrl, }: UmamiOptions) => void;
 

package/lib/client/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sources":["../../src/client/composables/useUmamiAnalytics.ts"],"sourcesContent":["import type { UmamiOptions } from '../../shared/index.js'\n\ndeclare global {\n  interface Window {\n    umami: {\n      track: {\n        (payload?: Record<string, unknown>): void\n        (name: string, data?: Record<string, unknown>): void\n      }\n    }\n  }\n}\n\n/**\n * Add umami analytics to the site\n *\n * @see https://umami.is/docs/install\n * @see https://umami.is/docs/tracker-functions\n */\nexport const useUmamiAnalytics = ({\n  link = 'https://us.umami.is/script.js',\n  id,\n  domains,\n  autoTrack,\n  cache,\n  hostUrl,\n}: UmamiOptions): void => {\n  // avoid duplicated import\n  if ('umami' in window) return\n\n  const script = document.createElement('script')\n  script.src = link!\n  script.async = true\n  script.setAttribute('data-website-id', id)\n\n  if (autoTrack === false) script.setAttribute('data-auto-track', 'false')\n  if (cache) script.setAttribute('data-cache', 'true')\n  if (domains) script.setAttribute('data-domains', domains.join(','))\n  if (hostUrl) script.setAttribute('data-hostUrl', hostUrl)\n\n  document.head.appendChild(script)\n}\n"],"names":["useUmamiAnalytics","link","id","domains","autoTrack","cache","hostUrl","script"],"mappings":"AAmBO,MAAMA,EAAoB,CAAC,CAChC,KAAAC,EAAO,gCACP,GAAAC,EACA,QAAAC,EACA,UAAAC,EACA,MAAAC,EACA,QAAAC,CACF,IAA0B,CAExB,GAAI,UAAW,OAAQ,OAEvB,MAAMC,EAAS,SAAS,cAAc,QAAQ,EAC9CA,EAAO,IAAMN,EACbM,EAAO,MAAQ,GACfA,EAAO,aAAa,kBAAmBL,CAAE,EAErCE,IAAc,IAAOG,EAAO,aAAa,kBAAmB,OAAO,EACnEF,GAAOE,EAAO,aAAa,aAAc,MAAM,EAC/CJ,GAASI,EAAO,aAAa,eAAgBJ,EAAQ,KAAK,GAAG,CAAC,EAC9DG,GAASC,EAAO,aAAa,eAAgBD,CAAO,EAExD,SAAS,KAAK,YAAYC,CAAM,CAClC"}
+{"version":3,"file":"index.js","sources":["../../src/client/composables/useUmamiAnalytics.ts"],"sourcesContent":["import type { UmamiOptions } from '../../shared/index.js'\n\ndeclare global {\n  interface Window {\n    umami: {\n      track: {\n        (payload?: Record<string, unknown>): void\n        (name: string, data?: Record<string, unknown>): void\n      }\n    }\n  }\n}\n\n/**\n * Initialize Umami Analytics tracking\n *\n * 初始化 Umami Analytics 追踪\n *\n * @param options - Umami Analytics options\n *\n * @description Injects Umami tracking script and configures tracking behavior.\n * The global `umami.track()` function will be available for custom event tracking.\n *\n * 注入 Umami 追踪脚本并配置追踪行为。\n * 全局 `umami.track()` 函数可用于自定义事件追踪。\n *\n * @see https://umami.is/docs/tracker-functions\n * @see https://umami.is/docs/tracker-configuration\n */\nexport const useUmamiAnalytics = ({\n  link = 'https://us.umami.is/script.js',\n  id,\n  domains,\n  autoTrack,\n  cache,\n  hostUrl,\n}: UmamiOptions): void => {\n  // avoid duplicated import\n  if ('umami' in window) return\n\n  const script = document.createElement('script')\n  script.src = link!\n  script.async = true\n  script.setAttribute('data-website-id', id)\n\n  if (autoTrack === false) script.setAttribute('data-auto-track', 'false')\n  if (cache) script.setAttribute('data-cache', 'true')\n  if (domains) script.setAttribute('data-domains', domains.join(','))\n  if (hostUrl) script.setAttribute('data-hostUrl', hostUrl)\n\n  document.head.appendChild(script)\n}\n"],"names":["useUmamiAnalytics","link","id","domains","autoTrack","cache","hostUrl","script"],"mappings":"AA6BO,MAAMA,EAAoB,CAAC,CAChC,KAAAC,EAAO,gCACP,GAAAC,EACA,QAAAC,EACA,UAAAC,EACA,MAAAC,EACA,QAAAC,CACF,IAA0B,CAExB,GAAI,UAAW,OAAQ,OAEvB,MAAMC,EAAS,SAAS,cAAc,QAAQ,EAC9CA,EAAO,IAAMN,EACbM,EAAO,MAAQ,GACfA,EAAO,aAAa,kBAAmBL,CAAE,EAErCE,IAAc,IAAOG,EAAO,aAAa,kBAAmB,OAAO,EACnEF,GAAOE,EAAO,aAAa,aAAc,MAAM,EAC/CJ,GAASI,EAAO,aAAa,eAAgBJ,EAAQ,KAAK,GAAG,CAAC,EAC9DG,GAASC,EAAO,aAAa,eAAgBD,CAAO,EAExD,SAAS,KAAK,YAAYC,CAAM,CAClC"}

package/lib/node/index.d.ts

@@ -2,52 +2,112 @@ import { Plugin } from 'vuepress/core';
 
 /**
  * Options for @vuepress/plugin-umami-analytics
+ *
+ * @vuepress/plugin-umami-analytics 插件选项
  */
 interface UmamiOptions {
     /**
-     * The website ID in umami Analytics
+     * Umami Analytics website ID
      *
-     * Umami 统计中的网站 ID。
+     * Umami Analytics 网站 ID
+     *
+     * @description The website ID from your Umami Analytics dashboard
+     *
+     * 从 Umami Analytics 仪表板获取的网站 ID
      */
     id: string;
     /**
-     * Link of umami analytics script
+     * Umami Analytics script URL
+     *
+     * Umami Analytics 脚本链接
+     *
+     * @description URL to the Umami tracking script
      *
-     * Umami 统计的脚本链接
+     * Umami 追踪脚本的 URL
      *
      * @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.
+     * Enable automatic tracking
      *
-     * 默认情况下，Umami 会自动跟踪所有页面浏览量和事件。你可以禁用此行为并使用追踪器功能自行追踪事件。
+     * 启用自动追踪
+     *
+     * @description When enabled, Umami automatically tracks pageviews and events.
+     * Set to `false` to use manual tracking with tracker functions.
+     *
+     * 启用时，Umami 会自动追踪页面浏览和事件。
+     * 设为 `false` 可使用手动追踪功能。
      *
      * @default true
      */
     autoTrack?: boolean;
     /**
-     * Cache data to improve the performance of the tracking script.
+     * Enable data caching
+     *
+     * 启用数据缓存
+     *
+     * @description Cache data to improve tracking script performance.
+     * Uses session storage and may require user notification.
      *
-     * 缓存数据以提高追踪脚本的性能。
+     * 缓存数据以提高追踪脚本性能。
+     * 使用会话存储，可能需要通知用户。
+     *
+     * @default false
      */
     cache?: boolean;
     /**
-     * Let the tracker only run on specific domains.
+     * Restrict tracking to specific domains
+     *
+     * 限制追踪到特定域名
      *
-     * 让跟踪器仅在特定的域名上运行。
+     * @description Array of domains where tracking should be active
+     *
+     * 限制追踪活跃的域名数组
      */
     domains?: string[];
     /**
-     * Location to send data
+     * Data collection endpoint
+     *
+     * 数据收集端点
      *
-     * 发送数据的位置
+     * @description Custom URL for sending tracking data
+     *
+     * 发送追踪数据的自定义 URL
      *
      * @default link
      */
     hostUrl?: string;
 }
 
+/**
+ * Umami Analytics plugin for VuePress
+ *
+ * VuePress 的 Umami Analytics 插件
+ *
+ * @param options - Plugin options
+ * @returns VuePress plugin
+ *
+ * @description Integrates Umami Analytics tracking into VuePress applications.
+ * Only active in production builds when a valid website ID is provided.
+ *
+ * 集成 Umami Analytics 追踪到 VuePress 应用中。
+ * 仅在生产构建且提供有效网站 ID 时启用。
+ *
+ * @example
+ * ```ts
+ * import { umamiAnalyticsPlugin } from '@vuepress/plugin-umami-analytics'
+ *
+ * export default {
+ *   plugins: [
+ *     umamiAnalyticsPlugin({
+ *       id: 'your-website-id',
+ *       link: 'https://your-umami-instance.com/script.js'
+ *     })
+ *   ]
+ * }
+ * ```
+ */
 declare const umamiAnalyticsPlugin: ({ id, ...options }: UmamiOptions) => Plugin;
 
 export { umamiAnalyticsPlugin };

package/lib/node/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sources":["../../src/node/umamiAnalyticsPlugin.ts"],"sourcesContent":["import { Logger } from '@vuepress/helper'\nimport type { Plugin, PluginObject } from 'vuepress/core'\nimport { colors, getDirname, path } from 'vuepress/utils'\nimport type { UmamiOptions } from '../shared/index.js'\n\nconst __dirname = import.meta.dirname || getDirname(import.meta.url)\n\nconst PLUGIN_NAME = '@vuepress/plugin-umami-analytics'\n\nconst logger = new Logger(PLUGIN_NAME)\n\nexport const umamiAnalyticsPlugin =\n  ({ id, ...options }: UmamiOptions): Plugin =>\n  (app) => {\n    const plugin: PluginObject = {\n      name: PLUGIN_NAME,\n    }\n\n    if (!id) {\n      logger.warn(`${colors.cyan('id')} is required!`)\n\n      return plugin\n    }\n\n    // returns an empty plugin in dev mode when debug mode is not enabled\n    if (app.env.isDev) {\n      return plugin\n    }\n\n    return {\n      ...plugin,\n\n      define: {\n        __UMM_OPTIONS__: { id, ...options },\n      },\n\n      clientConfigFile: path.resolve(__dirname, '../client/config.js'),\n    }\n  }\n"],"names":["__dirname","getDirname","PLUGIN_NAME","logger","Logger","umamiAnalyticsPlugin","id","options","app","plugin","path","colors"],"mappings":"4GAKA,MAAMA,EAAY,YAAY,SAAWC,EAAW,YAAY,GAAG,EAE7DC,EAAc,mCAEdC,EAAS,IAAIC,EAAOF,CAAW,EAExBG,EACX,CAAC,CAAE,GAAAC,EAAI,GAAGC,CAAQ,IACjBC,GAAQ,CACP,MAAMC,EAAuB,CAC3B,KAAMP,CACR,EAEA,OAAKI,EAODE,EAAI,IAAI,MACHC,EAGF,CACL,GAAGA,EAEH,OAAQ,CACN,gBAAiB,CAAE,GAAAH,EAAI,GAAGC,CAAQ,CACpC,EAEA,iBAAkBG,EAAK,QAAQV,EAAW,qBAAqB,CACjE,GAlBEG,EAAO,KAAK,GAAGQ,EAAO,KAAK,IAAI,CAAC,eAAe,EAExCF,EAiBX"}
+{"version":3,"file":"index.js","sources":["../../src/node/umamiAnalyticsPlugin.ts"],"sourcesContent":["import { Logger } from '@vuepress/helper'\nimport type { Plugin, PluginObject } from 'vuepress/core'\nimport { colors, getDirname, path } from 'vuepress/utils'\nimport type { UmamiOptions } from '../shared/index.js'\n\nconst __dirname = import.meta.dirname || getDirname(import.meta.url)\n\nconst PLUGIN_NAME = '@vuepress/plugin-umami-analytics'\n\nconst logger = new Logger(PLUGIN_NAME)\n\n/**\n * Umami Analytics plugin for VuePress\n *\n * VuePress 的 Umami Analytics 插件\n *\n * @param options - Plugin options\n * @returns VuePress plugin\n *\n * @description Integrates Umami Analytics tracking into VuePress applications.\n * Only active in production builds when a valid website ID is provided.\n *\n * 集成 Umami Analytics 追踪到 VuePress 应用中。\n * 仅在生产构建且提供有效网站 ID 时启用。\n *\n * @example\n * ```ts\n * import { umamiAnalyticsPlugin } from '@vuepress/plugin-umami-analytics'\n *\n * export default {\n *   plugins: [\n *     umamiAnalyticsPlugin({\n *       id: 'your-website-id',\n *       link: 'https://your-umami-instance.com/script.js'\n *     })\n *   ]\n * }\n * ```\n */\nexport const umamiAnalyticsPlugin =\n  ({ id, ...options }: UmamiOptions): Plugin =>\n  (app) => {\n    const plugin: PluginObject = {\n      name: PLUGIN_NAME,\n    }\n\n    if (!id) {\n      logger.warn(`${colors.cyan('id')} is required!`)\n\n      return plugin\n    }\n\n    // returns an empty plugin in dev mode when debug mode is not enabled\n    if (app.env.isDev) {\n      return plugin\n    }\n\n    return {\n      ...plugin,\n\n      define: {\n        __UMM_OPTIONS__: { id, ...options },\n      },\n\n      clientConfigFile: path.resolve(__dirname, '../client/config.js'),\n    }\n  }\n"],"names":["__dirname","getDirname","PLUGIN_NAME","logger","Logger","umamiAnalyticsPlugin","id","options","app","plugin","path","colors"],"mappings":"4GAKA,MAAMA,EAAY,YAAY,SAAWC,EAAW,YAAY,GAAG,EAE7DC,EAAc,mCAEdC,EAAS,IAAIC,EAAOF,CAAW,EA8BxBG,EACX,CAAC,CAAE,GAAAC,EAAI,GAAGC,CAAQ,IACjBC,GAAQ,CACP,MAAMC,EAAuB,CAC3B,KAAMP,CACR,EAEA,OAAKI,EAODE,EAAI,IAAI,MACHC,EAGF,CACL,GAAGA,EAEH,OAAQ,CACN,gBAAiB,CAAE,GAAAH,EAAI,GAAGC,CAAQ,CACpC,EAEA,iBAAkBG,EAAK,QAAQV,EAAW,qBAAqB,CACjE,GAlBEG,EAAO,KAAK,GAAGQ,EAAO,KAAK,IAAI,CAAC,eAAe,EAExCF,EAiBX"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@vuepress/plugin-umami-analytics",
-  "version": "2.0.0-rc.106",
+  "version": "2.0.0-rc.108",
   "description": "VuePress plugin - umami-analytics",
   "keywords": [
     "vuepress-plugin",
@@ -36,8 +36,8 @@
     "lib"
   ],
   "dependencies": {
-    "@vuepress/helper": "2.0.0-rc.106",
-    "vue": "^3.5.14"
+    "@vuepress/helper": "2.0.0-rc.108",
+    "vue": "^3.5.16"
   },
   "peerDependencies": {
     "vuepress": "2.0.0-rc.23"
@@ -45,5 +45,5 @@
   "publishConfig": {
     "access": "public"
   },
-  "gitHead": "fecc1ed177a2294e8dfe3c24f949073a638a6e90"
+  "gitHead": "784e7ede72095dc9d3dd47ed387e1f77d49c0cd7"
 }

package/LICENSE

@@ -1,21 +0,0 @@
-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.