Adds plugin analytics to docusaurus v3

packages/plugin-docusaurus-v3/package.json

@@ -28,8 +28,9 @@
     "@docusaurus/theme-common": "^3.0.1",
     "@orama/highlight": "^0.1.2",
     "@orama/orama": "workspace:*",
+    "@orama/plugin-analytics": "workspace:*",
     "@orama/plugin-parsedoc": "workspace:*",
-    "@orama/searchbox": "1.0.0-beta.12",
+    "@orama/searchbox": "1.0.0-beta.13",
     "github-slugger": "^2.0.0",
     "gray-matter": "^4.0.3",
     "jsdom": "^23.0.1",

packages/plugin-docusaurus-v3/src/index.ts

@@ -12,7 +12,15 @@ import MarkdownIt from 'markdown-it'
 import matter from 'gray-matter'
 import { LoadedContent, type LoadedVersion } from '@docusaurus/plugin-content-docs'
 
-export default function OramaPluginDocusaurus(ctx: { siteDir: any; generatedFilesDir: any }): Plugin {
+type PluginOptions = {
+  analytics?: {
+    enabled: boolean
+    apiKey: string
+    indexId: string
+  }
+}
+
+export default function OramaPluginDocusaurus(ctx: { siteDir: any; generatedFilesDir: any }, options: PluginOptions): Plugin {
   let versions: any[] = []
 
   return {
@@ -42,6 +50,7 @@ export default function OramaPluginDocusaurus(ctx: { siteDir: any; generatedFile
 
       if (isDevelopment) {
         actions.setGlobalData({
+          analytics: options.analytics,
           searchData: Object.fromEntries(
             await Promise.all(
               versions.map(async (version) => {

packages/plugin-docusaurus-v3/src/theme/SearchBar/index.tsx

@@ -17,7 +17,7 @@ export function OramaSearch() {
   const activeVersion = useActiveVersion(undefined)
   const versions = useVersions(undefined)
   const { preferredVersion } = useDocsPreferredVersion()
-  const { searchData } = usePluginData('@orama/plugin-docusaurus-v3')
+  const { searchData, analytics } = usePluginData('@orama/plugin-docusaurus-v3')
   const { colorMode } = useColorMode()
 
   const version = useMemo(() => {
@@ -90,7 +90,8 @@ export function OramaSearch() {
           oramaInstance,
           preset: presets.docs.name,
           show: false,
-          colorScheme: colorMode
+          colorScheme: colorMode,
+          analytics
         })
       }
     }

packages/plugin-docusaurus/package.json

@@ -48,8 +48,10 @@
     "@algolia/autocomplete-js": "^1.7.2",
     "@algolia/autocomplete-theme-classic": "^1.7.3",
     "@docusaurus/theme-common": "^2.4.3",
+    "@docusaurus/plugin-content-docs": "^2.4.3",
     "@orama/highlight": "^0.1.2",
     "@orama/orama": "workspace:*",
+    "@orama/plugin-analytics": "workspace:*",
     "@orama/plugin-parsedoc": "workspace:*",
     "github-slugger": "^2.0.0",
     "pako": "^2.1.0",

packages/plugin-docusaurus/src/client/theme/SearchBar/index.tsx

@@ -8,7 +8,8 @@ import useBaseUrl from '@docusaurus/useBaseUrl'
 import useDocusaurusContext from '@docusaurus/useDocusaurusContext'
 import { usePluginData } from '@docusaurus/useGlobalData'
 import useIsBrowser from '@docusaurus/useIsBrowser'
-import { AnyDocument, create, load, Orama, RawData, search as oramaSearch } from '@orama/orama'
+import { AnyDocument, OramaPlugin, create, load, Orama, RawData, search as oramaSearch } from '@orama/orama'
+import { pluginAnalytics, PluginAnalyticsParams } from '@orama/plugin-analytics'
 import { Highlight } from '@orama/highlight'
 import { ungzip } from 'pako'
 import { createElement, Fragment, useCallback, useEffect, useMemo, useRef, useState } from 'react'
@@ -31,7 +32,7 @@ export default function SearchBar(): JSX.Element {
   const { siteConfig } = useDocusaurusContext()
   const containerRef = useRef<HTMLDivElement>(null)
   const { colorMode } = useColorMode()
-  const { searchData } = usePluginData(PLUGIN_NAME) as PluginData
+  const { searchData, analytics } = usePluginData(PLUGIN_NAME) as PluginData & { analytics: PluginAnalyticsParams }
   const [database, setDatabase] = useState<Orama<AnyDocument>>()
   const searchBaseUrl = useBaseUrl(INDEX_FILE)
   const versions = useVersions(undefined)
@@ -161,7 +162,13 @@ export default function SearchBar(): JSX.Element {
       const deflated = ungzip(buffer, { to: 'string' })
       const data: RawData = JSON.parse(deflated)
 
-      const _db = await create({ schema })
+      const pluginAnalyticsConfig =
+        analytics ? pluginAnalytics(analytics) : ({} as OramaPlugin)
+
+      const _db = await create({
+        schema,
+        plugins: [pluginAnalyticsConfig]
+      })
 
       await load(_db, data)
 

packages/plugin-docusaurus/src/server/index.ts

@@ -201,6 +201,7 @@ function docusaurusOramaPlugin(context: LoadContext, options: PluginOptions): Pl
 
       if (isDevelopment) {
         actions.setGlobalData({
+          analytics: options.analytics,
           searchData: Object.fromEntries(
             await Promise.all(
               versions.map(async (version) => {

packages/plugin-docusaurus/src/server/types.ts

@@ -19,8 +19,13 @@ export interface SectionSchema extends AnyDocument {
 
 export type RawDataWithPositions = RawData & { positions: Record<string, Record<string, Record<string, Position[]>>> }
 
-// eslint-disable-next-line @typescript-eslint/no-empty-interface
-export interface PluginOptions {}
+export interface PluginOptions {
+  analytics?: {
+    enabled: boolean
+    apiKey: string
+    indexId: string
+  }
+}
 
 export interface PluginData {
   searchData: Record<string, { data: ArrayBuffer }>