feat(plugin-vercel-analytics): add new vercel analytics plugin

packages/docusaurus-plugin-vercel-analytics/package.json

@@ -22,7 +22,6 @@
     "@docusaurus/types": "3.0.0",
     "@docusaurus/utils-validation": "3.0.0",
     "@vercel/analytics": "^1.1.1",
-    "webpack": "^5.88.1",
     "tslib": "^2.6.0"
   },
   "peerDependencies": {

packages/docusaurus-plugin-vercel-analytics/src/analytics.ts

@@ -7,12 +7,6 @@
 import {inject} from '@vercel/analytics';
 import globalData from '@generated/globalData';
 import type {PluginOptions} from '@docusaurus/plugin-vercel-analytics';
-// import {Joi} from '@docusaurus/utils-validation';
-// import type {
-//   OptionValidationContext,
-//   ThemeConfig,
-//   ThemeConfigValidationContext,
-// } from '@docusaurus/types';
 
 const {debug, mode} = globalData['docusaurus-plugin-vercel-analytics']
   ?.default as PluginOptions;
@@ -21,43 +15,3 @@ inject({
   mode,
   debug,
 });
-
-// export type Options = {
-//   trackingID: string | [string, ...string[]];
-//   anonymizeIP?: boolean;
-// };
-
-// export const DEFAULT_OPTIONS: Partial<PluginOptions> = {
-//   anonymizeIP: false,
-// };
-
-// const pluginOptionsSchema = Joi.object<PluginOptions>({
-//   // We normalize trackingID as a string[]
-//   trackingID: Joi.alternatives()
-//     .try(
-//       Joi.alternatives().conditional(Joi.string().required(), {
-//         then: Joi.custom((val: boolean) => [val]),
-//       }),
-//       Joi.array().items(Joi.string().required()),
-//     )
-//     .required(),
-//   anonymizeIP: Joi.boolean().default(DEFAULT_OPTIONS.anonymizeIP),
-// });
-
-// export function validateOptions({
-//   validate,
-//   options,
-// }: OptionValidationContext<Options, PluginOptions>): PluginOptions {
-//   return validate(pluginOptionsSchema, options);
-// }
-
-// export function validateThemeConfig({
-//   themeConfig,
-// }: ThemeConfigValidationContext<ThemeConfig>): ThemeConfig {
-//   if ('gtag' in themeConfig) {
-//     throw new Error(
-//       'The "gtag" field in themeConfig should now be specified as option for plugin-google-gtag. More information at https://github.com/facebook/docusaurus/pull/5832.',
-//     );
-//   }
-//   return themeConfig;
-// }

packages/docusaurus-plugin-vercel-analytics/src/index.ts

@@ -5,24 +5,51 @@
  * LICENSE file in the root directory of this source tree.
  */
 
-import type {LoadContext, Plugin} from '@docusaurus/types';
-import type {PluginOptions} from '@docusaurus/plugin-vercel-analytics';
+import {Joi} from '@docusaurus/utils-validation';
+import type {
+  LoadContext,
+  Plugin,
+  OptionValidationContext,
+} from '@docusaurus/types';
+import type {PluginOptions, Options} from './options';
 
 export default function pluginVercelAnalytics(
   context: LoadContext,
   options: PluginOptions,
 ): Plugin {
-  const isProd = process.env.NODE_ENV === 'production';
+  // const isProd = process.env.NODE_ENV === 'production';
 
   return {
     name: 'docusaurus-plugin-vercel-analytics',
 
     getClientModules() {
-      return isProd ? ['./analytics'] : [];
+      // return isProd ? ['./analytics'] : [];
+      return ['./analytics'];
     },
 
     contentLoaded({actions}) {
       actions.setGlobalData(options);
     },
   };
 }
+
+export const DEFAULT_OPTIONS: Partial<PluginOptions> = {
+  mode: 'production',
+  debug: false,
+};
+
+const pluginOptionsSchema = Joi.object<PluginOptions>({
+  mode: Joi.string()
+    .valid('auto', 'production', 'development')
+    .default(DEFAULT_OPTIONS.mode),
+  debug: Joi.boolean().default(DEFAULT_OPTIONS.debug),
+});
+
+export function validateOptions({
+  validate,
+  options,
+}: OptionValidationContext<Options, PluginOptions>): PluginOptions {
+  return validate(pluginOptionsSchema, options);
+}
+
+export type {PluginOptions, Options};

packages/docusaurus-plugin-vercel-analytics/src/options.ts

@@ -4,3 +4,10 @@
  * This source code is licensed under the MIT license found in the
  * LICENSE file in the root directory of this source tree.
  */
+
+export type PluginOptions = {
+  mode: 'auto' | 'production' | 'development';
+  debug: boolean;
+};
+
+export type Options = Partial<PluginOptions>;