@azerion/bunosaurus-plugin-vercel-analytics 0.0.0-stage → 4.0.0

package/README.md

@@ -1,3 +1,7 @@
-# Temporary Holding Version
+# `@docusaurus/plugin-vercel-analytics`
 
-This version is a temporary placeholder for this package. An operational version to replace this has been submitted for review and is awaiting a staged release.
+[Vercel analytics](https://vercel.com/docs/analytics) plugin for Docusaurus.
+
+## Usage
+
+See [plugin-vercel-analytics documentation](https://docusaurus.io/docs/api/plugins/@docusaurus/plugin-vercel-analytics).

package/lib/analytics.d.ts

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

package/lib/analytics.js

@@ -0,0 +1,14 @@
+/**
+ * Copyright (c) Facebook, Inc. and its affiliates.
+ *
+ * This source code is licensed under the MIT license found in the
+ * LICENSE file in the root directory of this source tree.
+ */
+import { inject } from '@vercel/analytics';
+import globalData from '@generated/globalData';
+const { debug, mode } = globalData['docusaurus-plugin-vercel-analytics']
+    ?.default;
+inject({
+    mode,
+    debug,
+});

package/lib/index.d.ts

@@ -0,0 +1,11 @@
+/**
+ * Copyright (c) Facebook, Inc. and its affiliates.
+ *
+ * This source code is licensed under the MIT license found in the
+ * LICENSE file in the root directory of this source tree.
+ */
+import type { LoadContext, Plugin } from '@docusaurus/types';
+import type { PluginOptions, Options } from './options';
+export default function pluginVercelAnalytics(context: LoadContext, options: PluginOptions): Plugin | null;
+export { validateOptions } from './options';
+export type { PluginOptions, Options };

package/lib/index.js

@@ -0,0 +1,26 @@
+"use strict";
+/**
+ * Copyright (c) Facebook, Inc. and its affiliates.
+ *
+ * This source code is licensed under the MIT license found in the
+ * LICENSE file in the root directory of this source tree.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.validateOptions = void 0;
+exports.default = pluginVercelAnalytics;
+function pluginVercelAnalytics(context, options) {
+    if (process.env.NODE_ENV !== 'production') {
+        return null;
+    }
+    return {
+        name: 'docusaurus-plugin-vercel-analytics',
+        getClientModules() {
+            return ['./analytics'];
+        },
+        contentLoaded({ actions }) {
+            actions.setGlobalData(options);
+        },
+    };
+}
+var options_1 = require("./options");
+Object.defineProperty(exports, "validateOptions", { enumerable: true, get: function () { return options_1.validateOptions; } });

package/lib/options.d.ts

@@ -0,0 +1,8 @@
+import type { OptionValidationContext } from '@docusaurus/types';
+export type PluginOptions = {
+    id: string;
+    mode: 'auto' | 'production' | 'development' | undefined;
+    debug: boolean | undefined;
+};
+export type Options = Partial<PluginOptions>;
+export declare function validateOptions({ validate, options, }: OptionValidationContext<Options, PluginOptions>): PluginOptions;

package/lib/options.js

@@ -0,0 +1,25 @@
+/**
+ * Copyright (c) Facebook, Inc. and its affiliates.
+ *
+ * This source code is licensed under the MIT license found in the
+ * LICENSE file in the root directory of this source tree.
+ */
+import { DEFAULT_PLUGIN_ID } from '@docusaurus/utils';
+import logger from '@docusaurus/logger';
+import { Joi } from '@docusaurus/utils-validation';
+const pluginOptionsSchema = Joi.object({
+    mode: Joi.string().valid('auto', 'production', 'development').optional(),
+    debug: Joi.boolean().optional(),
+});
+// We can't validate this through the schema
+// Docusaurus core auto registers the id field to the schema already
+function ensureNoMultiInstance(options) {
+    if (options?.id && options.id !== DEFAULT_PLUGIN_ID) {
+        throw new Error(logger.interpolate `You site uses the Vercel Analytics plugin with a custom plugin id (name=${options.id}).
+      But this plugin is only supposed to be used at most once per site. Therefore providing a custom plugin id is unsupported.`);
+    }
+}
+export function validateOptions({ validate, options, }) {
+    ensureNoMultiInstance(options);
+    return validate(pluginOptionsSchema, options);
+}

package/package.json

@@ -1,6 +1,37 @@
 {
   "name": "@azerion/bunosaurus-plugin-vercel-analytics",
-  "version": "0.0.0-stage",
-  "stub": true,
-  "description": "Temporary package placeholder for staged publishing"
-}
+  "version": "4.0.0",
+  "description": "Global vercel analytics plugin for Docusaurus.",
+  "main": "lib/index.js",
+  "types": "lib/index.d.ts",
+  "publishConfig": {
+    "access": "public"
+  },
+  "scripts": {
+    "build": "tsc --build",
+    "watch": "tsc --build --watch"
+  },
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/azerion/bunosaurus.git",
+    "directory": "packages/docusaurus-plugin-vercel-analytics"
+  },
+  "license": "MIT",
+  "dependencies": {
+    "@docusaurus/core": "npm:@azerion/bunosaurus-core@4.0.0",
+    "@docusaurus/logger": "npm:@azerion/bunosaurus-logger@4.0.0",
+    "@docusaurus/module-type-aliases": "npm:@azerion/bunosaurus-module-type-aliases@4.0.0",
+    "@docusaurus/types": "npm:@azerion/bunosaurus-types@4.0.0",
+    "@docusaurus/utils": "npm:@azerion/bunosaurus-utils@4.0.0",
+    "@docusaurus/utils-validation": "npm:@azerion/bunosaurus-utils-validation@4.0.0",
+    "@vercel/analytics": "^2.0.1",
+    "tslib": "^2.8.1"
+  },
+  "peerDependencies": {
+    "react": "^19.3.0",
+    "react-dom": "^19.3.0"
+  },
+  "engines": {
+    "bun": ">=1.4.1"
+  }
+}

package/src/analytics.ts

@@ -0,0 +1,17 @@
+/**
+ * Copyright (c) Facebook, Inc. and its affiliates.
+ *
+ * This source code is licensed under the MIT license found in the
+ * LICENSE file in the root directory of this source tree.
+ */
+import {inject} from '@vercel/analytics';
+import globalData from '@generated/globalData';
+import type {PluginOptions} from './options';
+
+const {debug, mode} = globalData['docusaurus-plugin-vercel-analytics']
+  ?.default as PluginOptions;
+
+inject({
+  mode,
+  debug,
+});

package/src/index.ts

@@ -0,0 +1,33 @@
+/**
+ * Copyright (c) Facebook, Inc. and its affiliates.
+ *
+ * This source code is licensed under the MIT license found in the
+ * LICENSE file in the root directory of this source tree.
+ */
+
+import type {LoadContext, Plugin} from '@docusaurus/types';
+import type {PluginOptions, Options} from './options';
+
+export default function pluginVercelAnalytics(
+  context: LoadContext,
+  options: PluginOptions,
+): Plugin | null {
+  if (process.env.NODE_ENV !== 'production') {
+    return null;
+  }
+  return {
+    name: 'docusaurus-plugin-vercel-analytics',
+
+    getClientModules() {
+      return ['./analytics'];
+    },
+
+    contentLoaded({actions}) {
+      actions.setGlobalData(options);
+    },
+  };
+}
+
+export {validateOptions} from './options';
+
+export type {PluginOptions, Options};

package/src/options.ts

@@ -0,0 +1,42 @@
+/**
+ * Copyright (c) Facebook, Inc. and its affiliates.
+ *
+ * This source code is licensed under the MIT license found in the
+ * LICENSE file in the root directory of this source tree.
+ */
+import {DEFAULT_PLUGIN_ID} from '@docusaurus/utils';
+import logger from '@docusaurus/logger';
+import {Joi} from '@docusaurus/utils-validation';
+import type {OptionValidationContext} from '@docusaurus/types';
+
+export type PluginOptions = {
+  id: string;
+  mode: 'auto' | 'production' | 'development' | undefined;
+  debug: boolean | undefined;
+};
+
+export type Options = Partial<PluginOptions>;
+
+const pluginOptionsSchema = Joi.object<PluginOptions>({
+  mode: Joi.string().valid('auto', 'production', 'development').optional(),
+  debug: Joi.boolean().optional(),
+});
+
+// We can't validate this through the schema
+// Docusaurus core auto registers the id field to the schema already
+function ensureNoMultiInstance(options: Options) {
+  if (options?.id && options.id !== DEFAULT_PLUGIN_ID) {
+    throw new Error(
+      logger.interpolate`You site uses the Vercel Analytics plugin with a custom plugin id (name=${options.id}).
+      But this plugin is only supposed to be used at most once per site. Therefore providing a custom plugin id is unsupported.`,
+    );
+  }
+}
+
+export function validateOptions({
+  validate,
+  options,
+}: OptionValidationContext<Options, PluginOptions>): PluginOptions {
+  ensureNoMultiInstance(options);
+  return validate(pluginOptionsSchema, options);
+}

package/src/types.d.ts

@@ -0,0 +1,8 @@
+/**
+ * Copyright (c) Facebook, Inc. and its affiliates.
+ *
+ * This source code is licensed under the MIT license found in the
+ * LICENSE file in the root directory of this source tree.
+ */
+
+/// <reference types="@docusaurus/module-type-aliases" />