docusaurus-plugin-glossary 3.1.0 → 3.3.0

package/dist/index.cjs.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../src/index.ts","../src/remark/glossary-terms.js","../src/validation.ts"],"sourcesContent":["// @ts-ignore\nimport path from 'path';\n// @ts-ignore\nimport { fileURLToPath } from 'url';\nimport fs from 'fs-extra';\nimport type { LoadContext, Plugin } from '@docusaurus/types';\nimport validatePeerDependencies from 'validate-peer-dependencies';\nimport remarkGlossaryTerms from './remark/glossary-terms.js';\nimport { validateGlossaryData, GlossaryValidationError } from './validation.js';\n\n// Standard ES module directory resolution\nconst currentFilePath = fileURLToPath(import.meta.url);\nconst currentDir = path.dirname(currentFilePath);\n\n// Validate peer dependencies at module load time\nvalidatePeerDependencies(currentDir);\n\nexport interface GlossaryPluginOptions {\n  glossaryPath?: string;\n  routePath?: string;\n  autoLinkTerms?: boolean;\n}\n\nexport interface GlossaryTerm {\n  term: string;\n  definition: string;\n  abbreviation?: string;\n  relatedTerms?: string[];\n  id?: string;\n  autoLink?: boolean;\n  aliases?: string[];\n}\n\nexport interface GlossaryData {\n  title?: string;\n  description?: string;\n  terms: GlossaryTerm[];\n}\n\n/**\n * Docusaurus Glossary Plugin\n *\n * A plugin that provides glossary functionality with:\n * - Glossary terms defined in a JSON file\n * - Auto-generated glossary page with term definitions\n * - GlossaryTerm component for inline definitions with interactive tooltips\n * - Automatic client-side initialization via getClientModules() (no manual imports needed)\n * - Optional automatic glossary term detection in markdown files via remark plugin\n *\n * ## Basic Usage (Manual Term Markup)\n *\n * Just install the plugin - the GlossaryTerm component is automatically available:\n * ```javascript\n * module.exports = {\n *   plugins: [\n *     ['docusaurus-plugin-glossary', {\n *       glossaryPath: 'glossary/glossary.json',\n *       routePath: '/glossary',\n *     }],\n *   ],\n * };\n * ```\n *\n * Then use `<GlossaryTerm>` in your MDX files without importing:\n * ```mdx\n * <GlossaryTerm term=\"API\">API</GlossaryTerm>\n * ```\n *\n * ## Advanced Usage (Automatic Term Detection)\n *\n * To automatically detect and link glossary terms in markdown, add the remark plugin:\n * ```javascript\n * const glossaryPlugin = require('docusaurus-plugin-glossary');\n *\n * module.exports = {\n *   presets: [\n *     ['@docusaurus/preset-classic', {\n *       docs: {\n *         remarkPlugins: [\n *           glossaryPlugin.getRemarkPlugin({\n *             glossaryPath: 'glossary/glossary.json',\n *             routePath: '/glossary',\n *           }, { siteDir: __dirname }),\n *         ],\n *       },\n *     }],\n *   ],\n *   plugins: [\n *     ['docusaurus-plugin-glossary', {\n *       glossaryPath: 'glossary/glossary.json',\n *       routePath: '/glossary',\n *     }],\n *   ],\n * };\n * ```\n *\n * @param context - Docusaurus context\n * @param options - Plugin options\n * @param options.glossaryPath - Path to glossary JSON file (default: 'glossary/glossary.json')\n * @param options.routePath - Route path for glossary page (default: '/glossary')\n * @param options.autoLinkTerms - Legacy option, kept for compatibility but no longer used (configure remark plugin manually instead)\n * @returns Plugin object\n */\nexport default function glossaryPlugin(\n  context: LoadContext,\n  options: GlossaryPluginOptions = {}\n): Plugin {\n  const { glossaryPath = 'glossary/glossary.json', routePath = '/glossary' } = options;\n\n  return {\n    name: 'docusaurus-plugin-glossary',\n\n    getClientModules() {\n      return [path.resolve(currentDir, './client/index.js')];\n    },\n\n    async loadContent() {\n      // Load glossary terms from JSON file\n      const glossaryFilePath = path.resolve(context.siteDir, glossaryPath);\n\n      if (await fs.pathExists(glossaryFilePath)) {\n        try {\n          const rawData = await fs.readJson(glossaryFilePath);\n\n          // Validate glossary data structure\n          const validationResult = validateGlossaryData(rawData, { throwOnError: false });\n\n          if (!validationResult.valid) {\n            console.warn(\n              `[glossary-plugin] Glossary file has validation errors at ${glossaryFilePath}:`\n            );\n            validationResult.errors.forEach(err => {\n              console.warn(`  - [${err.field}] ${err.message}`);\n            });\n            console.warn('[glossary-plugin] Proceeding with valid terms only.');\n          }\n\n          return validationResult.data;\n        } catch (error) {\n          if (error instanceof GlossaryValidationError) {\n            throw error;\n          }\n          // JSON parsing error\n          throw new Error(\n            `Failed to parse glossary file at ${glossaryFilePath}: ${error instanceof Error ? error.message : String(error)}`\n          );\n        }\n      }\n\n      console.warn(`Glossary file not found at ${glossaryFilePath}. Using empty glossary.`);\n      return { terms: [] };\n    },\n\n    async contentLoaded({ content, actions }) {\n      const { createData, addRoute, setGlobalData } = actions;\n      const glossaryContent = content as GlossaryData;\n\n      // Create data file that can be imported by components\n      const glossaryDataPath = await createData(\n        'glossary-data.json',\n        JSON.stringify(glossaryContent)\n      );\n\n      // Create a data file for the remark plugin to access glossary terms\n      await createData(\n        'remark-glossary-data.json',\n        JSON.stringify({\n          terms: glossaryContent.terms || [],\n          routePath: routePath,\n        })\n      );\n\n      // Add glossary page route\n      addRoute({\n        path: routePath,\n        component: path.join(currentDir, 'components/GlossaryPage.js'),\n        exact: true,\n        modules: {\n          glossaryData: glossaryDataPath,\n        },\n      });\n\n      // Expose global data for runtime lookups (used by GlossaryTerm)\n      setGlobalData({\n        terms: glossaryContent.terms || [],\n        routePath,\n      });\n    },\n\n    getThemePath() {\n      return path.resolve(currentDir, './theme');\n    },\n\n    getPathsToWatch() {\n      return [path.resolve(context.siteDir, glossaryPath)];\n    },\n\n    async postBuild() {\n      // You can add any post-build steps here if needed\n      console.log('Glossary plugin: Build completed');\n    },\n  };\n}\n\n// Export remark plugin factory for use in markdown configuration\nexport const remarkPlugin = remarkGlossaryTerms;\n\n// Export cache clearing utility\nexport { clearGlossaryCache } from './remark/glossary-terms.js';\n\n// Export validation utilities\nexport {\n  validateGlossaryData,\n  GlossaryValidationError,\n  formatValidationErrors,\n  type ValidationError,\n  type ValidationResult,\n} from './validation.js';\n\n/**\n * Helper function to get the configured remark plugin\n * This can be used in docusaurus.config.js markdown configuration\n *\n * @param pluginOptions - Plugin options from docusaurus.config.js\n * @param context - Context with siteDir\n * @returns Configured remark plugin\n */\nexport function getRemarkPlugin(\n  pluginOptions: GlossaryPluginOptions,\n  context?: { siteDir?: string }\n): [typeof remarkGlossaryTerms, { glossaryPath: string; routePath: string; siteDir?: string }] {\n  const { glossaryPath = 'glossary/glossary.json', routePath = '/glossary' } = pluginOptions;\n\n  const siteDir = context?.siteDir;\n\n  return [\n    remarkGlossaryTerms,\n    {\n      glossaryPath,\n      routePath,\n      siteDir,\n    },\n  ];\n}\n","import { visit } from 'unist-util-visit';\nimport path from 'path';\nimport fs from 'fs';\n\n/**\n * Simple validation for glossary terms loaded from file\n * Returns only valid terms with required fields\n *\n * @param {unknown} data - The parsed JSON data\n * @param {string} filePath - Path to the file (for error messages)\n * @returns {{ terms: Array<{term: string, definition: string}>, errors: string[] }}\n */\nfunction validateGlossaryTerms(data, _filePath) {\n  const errors = [];\n  const validTerms = [];\n\n  if (data === null || data === undefined) {\n    errors.push(`Glossary data is null or undefined`);\n    return { terms: [], errors };\n  }\n\n  if (typeof data !== 'object') {\n    errors.push(`Glossary data must be an object, got ${typeof data}`);\n    return { terms: [], errors };\n  }\n\n  if (!('terms' in data)) {\n    errors.push(`Glossary data must contain a \"terms\" array`);\n    return { terms: [], errors };\n  }\n\n  if (!Array.isArray(data.terms)) {\n    errors.push(`Field \"terms\" must be an array, got ${typeof data.terms}`);\n    return { terms: [], errors };\n  }\n\n  data.terms.forEach((term, index) => {\n    if (term === null || term === undefined || typeof term !== 'object') {\n      errors.push(`terms[${index}]: Term must be an object`);\n      return;\n    }\n\n    if (typeof term.term !== 'string' || term.term.trim() === '') {\n      errors.push(`terms[${index}]: Missing or invalid \"term\" field`);\n      return;\n    }\n\n    if (typeof term.definition !== 'string') {\n      errors.push(`terms[${index}]: Missing or invalid \"definition\" field`);\n      return;\n    }\n\n    validTerms.push(term);\n  });\n\n  return { terms: validTerms, errors };\n}\n\n// Cache for glossary data to avoid repeated synchronous file reads\n// Key: absolute file path, Value: { terms, loadedAt }\nconst glossaryCache = new Map();\nconst CACHE_TTL = 5000; // 5 seconds TTL to allow for file changes during dev\n\n/**\n * Creates a remark plugin that automatically detects and replaces glossary terms in markdown\n *\n * This plugin transforms plain text terms into <GlossaryTerm> JSX elements.\n * The GlossaryTerm component is globally available via the MDXComponents theme wrapper,\n * so no import injection is needed - MDX files can use it without explicit imports.\n *\n * @param {object} options - Plugin options\n * @param {Array} options.terms - Array of glossary term objects with {term, definition}\n * @param {string} options.glossaryPath - Path to glossary JSON file (optional, if terms not provided)\n * @param {string} options.routePath - Route path to glossary page (default: '/glossary')\n * @param {string} options.siteDir - Docusaurus site directory (required if using glossaryPath)\n * @returns {function} Remark plugin function\n */\nexport default function remarkGlossaryTerms({\n  terms = [],\n  glossaryPath = null,\n  routePath = '/glossary',\n  siteDir = null,\n} = {}) {\n  let glossaryTerms = terms;\n\n  // If terms not provided, try to load from glossaryPath with caching\n  if (!glossaryTerms.length && glossaryPath && siteDir) {\n    try {\n      const glossaryFilePath = path.resolve(siteDir, glossaryPath);\n      const now = Date.now();\n\n      // Check cache first to avoid repeated file reads\n      const cached = glossaryCache.get(glossaryFilePath);\n      if (cached && now - cached.loadedAt < CACHE_TTL) {\n        glossaryTerms = cached.terms;\n      } else {\n        // Cache miss or expired - load from file synchronously\n        // Note: This is synchronous I/O which can block the build process\n        // Consider passing terms directly to avoid this\n        if (fs.existsSync(glossaryFilePath)) {\n          const fileContent = fs.readFileSync(glossaryFilePath, 'utf8');\n          let glossaryData;\n          try {\n            glossaryData = JSON.parse(fileContent);\n          } catch (parseError) {\n            console.error(\n              `[glossary-plugin] Failed to parse glossary JSON at ${glossaryPath}:`,\n              parseError.message\n            );\n            glossaryCache.set(glossaryFilePath, {\n              terms: [],\n              loadedAt: now,\n            });\n            return tree => tree;\n          }\n\n          // Validate glossary data\n          const { terms: validTerms, errors } = validateGlossaryTerms(glossaryData, glossaryPath);\n\n          if (errors.length > 0) {\n            console.warn(`[glossary-plugin] Glossary validation errors in ${glossaryPath}:`);\n            errors.forEach(err => console.warn(`  - ${err}`));\n            if (validTerms.length > 0) {\n              console.warn(`[glossary-plugin] Proceeding with ${validTerms.length} valid term(s).`);\n            }\n          }\n\n          glossaryTerms = validTerms;\n\n          // Update cache\n          glossaryCache.set(glossaryFilePath, {\n            terms: glossaryTerms,\n            loadedAt: now,\n          });\n\n          // Log only once per file (when cache is first populated)\n          if (!cached && process.env.NODE_ENV !== 'production') {\n            console.log(\n              `[glossary-plugin] Loaded ${glossaryTerms.length} terms from ${glossaryPath}`\n            );\n          }\n        } else {\n          // File doesn't exist - cache empty result to avoid repeated checks\n          glossaryCache.set(glossaryFilePath, {\n            terms: [],\n            loadedAt: now,\n          });\n          if (process.env.NODE_ENV !== 'production') {\n            console.warn(`[glossary-plugin] Glossary file not found: ${glossaryPath}`);\n          }\n        }\n      }\n    } catch (error) {\n      console.warn(\n        `[glossary-plugin] Failed to load glossary from ${glossaryPath}:`,\n        error.message\n      );\n      // Cache the error to avoid repeated attempts\n      if (glossaryPath && siteDir) {\n        const glossaryFilePath = path.resolve(siteDir, glossaryPath);\n        glossaryCache.set(glossaryFilePath, {\n          terms: [],\n          loadedAt: Date.now(),\n        });\n      }\n    }\n  }\n\n  // Build a map of terms for efficient lookup, skipping terms with autoLink: false.\n  // Each entry in the map represents a matchable phrase (canonical term or alias)\n  // and points back to the canonical term object so tooltip/href always use the canonical form.\n  // Key: lowercase phrase, Value: { termObj, matchText } where matchText is what we matched in source\n  const termMap = new Map();\n  glossaryTerms.forEach(termObj => {\n    if (!termObj.term || termObj.autoLink === false) return;\n\n    const register = phrase => {\n      if (typeof phrase !== 'string' || phrase.trim() === '') return;\n      const key = phrase.toLowerCase();\n      if (!termMap.has(key)) {\n        termMap.set(key, { termObj, matchText: phrase });\n      }\n    };\n\n    register(termObj.term);\n    if (Array.isArray(termObj.aliases)) {\n      termObj.aliases.forEach(register);\n    }\n  });\n\n  // Sort terms by length (longest first) to avoid partial matches\n  // e.g., \"Application Programming Interface\" should match before \"API\"\n  const sortedTerms = Array.from(termMap.entries()).sort((a, b) => b[0].length - a[0].length);\n\n  // If no terms, return a no-op transformer\n  if (sortedTerms.length === 0) {\n    return tree => tree;\n  }\n\n  /**\n   * Recursively replace glossary terms in text\n   * Returns an array of text nodes and MDX components\n   */\n  function replaceTermsInText(text) {\n    if (!text || !sortedTerms.length) {\n      return [{ type: 'text', value: text }];\n    }\n\n    const result = [];\n    let lastIndex = 0;\n    const textLower = text.toLowerCase();\n\n    // Find all matches\n    const matches = [];\n    for (const [lowerPhrase, { termObj }] of sortedTerms) {\n      let searchIndex = 0;\n\n      while (searchIndex < textLower.length) {\n        const index = textLower.indexOf(lowerPhrase, searchIndex);\n        if (index === -1) break;\n\n        // Check if it's a whole word match, with simple plural tolerance ('s' or 'es')\n        const beforeChar = index > 0 ? textLower[index - 1] : ' ';\n        const afterIndex = index + lowerPhrase.length;\n        const afterChar = afterIndex < textLower.length ? textLower[afterIndex] : ' ';\n\n        let matchLength = lowerPhrase.length;\n        let isWordBoundary = !/\\w/.test(beforeChar) && !/\\w/.test(afterChar);\n\n        // Allow trailing 's' plural (e.g., webhook -> webhooks)\n        if (!isWordBoundary && afterChar === 's') {\n          const nextChar = afterIndex + 1 < textLower.length ? textLower[afterIndex + 1] : ' ';\n          if (!/\\w/.test(nextChar)) {\n            isWordBoundary = true;\n            matchLength = lowerPhrase.length + 1;\n          }\n        }\n\n        // Allow trailing 'es' plural (e.g., API -> APIs, box -> boxes)\n        if (\n          !isWordBoundary &&\n          afterChar === 'e' &&\n          afterIndex + 1 < textLower.length &&\n          textLower[afterIndex + 1] === 's'\n        ) {\n          const nextChar = afterIndex + 2 < textLower.length ? textLower[afterIndex + 2] : ' ';\n          if (!/\\w/.test(nextChar)) {\n            isWordBoundary = true;\n            matchLength = lowerPhrase.length + 2;\n          }\n        }\n\n        if (isWordBoundary) {\n          matches.push({\n            index,\n            length: matchLength,\n            termObj: termObj,\n            // Store original case from the text (what the reader actually wrote)\n            originalText: text.substring(index, index + matchLength),\n          });\n        }\n\n        searchIndex = index + 1;\n      }\n    }\n\n    // Sort matches by index\n    matches.sort((a, b) => a.index - b.index);\n\n    // Remove overlapping matches (keep the first one)\n    const nonOverlappingMatches = [];\n    let lastMatchEnd = 0;\n    for (const match of matches) {\n      if (match.index >= lastMatchEnd) {\n        nonOverlappingMatches.push(match);\n        lastMatchEnd = match.index + match.length;\n      }\n    }\n\n    // Build result array\n    for (const match of nonOverlappingMatches) {\n      // Add text before match\n      if (match.index > lastIndex) {\n        result.push({\n          type: 'text',\n          value: text.substring(lastIndex, match.index),\n        });\n      }\n\n      // Add MDX component for glossary term\n      result.push({\n        type: 'mdxJsxFlowElement',\n        name: 'GlossaryTerm',\n        attributes: [\n          {\n            type: 'mdxJsxAttribute',\n            name: 'term',\n            value: match.termObj.term,\n          },\n          {\n            type: 'mdxJsxAttribute',\n            name: 'definition',\n            value: match.termObj.definition || '',\n          },\n          {\n            type: 'mdxJsxAttribute',\n            name: 'routePath',\n            value: routePath,\n          },\n        ],\n        children: [\n          {\n            type: 'text',\n            value: match.originalText,\n          },\n        ],\n      });\n\n      lastIndex = match.index + match.length;\n    }\n\n    // Add remaining text\n    if (lastIndex < text.length) {\n      result.push({\n        type: 'text',\n        value: text.substring(lastIndex),\n      });\n    }\n\n    return result.length > 0 ? result : [{ type: 'text', value: text }];\n  }\n\n  // Collect text nodes that live inside a heading (h1-h6) so we can skip them.\n  // Headings are excluded from auto-linking because glossary anchors inside\n  // headings clash with the heading's own link/anchor behavior and are noisy.\n  function collectHeadingTextNodes(tree) {\n    const skip = new WeakSet();\n    visit(tree, 'heading', headingNode => {\n      visit(headingNode, 'text', textNode => {\n        skip.add(textNode);\n      });\n    });\n    return skip;\n  }\n\n  // Return the transformer function\n  const transformer = tree => {\n    let usedGlossaryTerm = false;\n    const textNodesInHeadings = collectHeadingTextNodes(tree);\n    visit(tree, 'text', (node, index, parent) => {\n      // Skip text nodes inside code blocks, links, or existing MDX components\n      if (\n        parent.type === 'code' ||\n        parent.type === 'inlineCode' ||\n        parent.type === 'link' ||\n        parent.type === 'mdxJsxFlowElement' ||\n        parent.type === 'mdxJsxTextElement'\n      ) {\n        return;\n      }\n\n      // Skip text nodes that are descendants of a heading (h1-h6)\n      if (textNodesInHeadings.has(node)) {\n        return;\n      }\n\n      // Replace terms in text node\n      const replacements = replaceTermsInText(node.value);\n\n      // If we have replacements, replace the single text node with multiple nodes\n      if (\n        replacements.length > 1 ||\n        (replacements.length === 1 && replacements[0].type !== 'text')\n      ) {\n        // Convert to text elements for paragraph context if needed\n        const newNodes = replacements.map(replacement => {\n          if (replacement.type === 'mdxJsxFlowElement') {\n            // In paragraph context, we need mdxJsxTextElement instead\n            if (parent.type === 'paragraph') {\n              usedGlossaryTerm = true;\n              return {\n                type: 'mdxJsxTextElement',\n                name: replacement.name,\n                attributes: replacement.attributes,\n                children: replacement.children,\n              };\n            }\n            usedGlossaryTerm = true;\n          }\n          return replacement;\n        });\n\n        // Replace the single node with multiple nodes\n        parent.children.splice(index, 1, ...newNodes);\n        return index + newNodes.length - 1; // Return new index to continue\n      }\n    });\n\n    // Inject MDX import for GlossaryTerm if we used it\n    // The component is available via theme path, so we just need to import it\n    if (usedGlossaryTerm) {\n      const importNode = {\n        type: 'mdxjsEsm',\n        value: 'import GlossaryTerm from \"@theme/GlossaryTerm\";',\n        data: {\n          estree: {\n            type: 'Program',\n            sourceType: 'module',\n            body: [\n              {\n                type: 'ImportDeclaration',\n                specifiers: [\n                  {\n                    type: 'ImportDefaultSpecifier',\n                    local: { type: 'Identifier', name: 'GlossaryTerm' },\n                  },\n                ],\n                source: {\n                  type: 'Literal',\n                  value: '@theme/GlossaryTerm',\n                  raw: '\"@theme/GlossaryTerm\"',\n                },\n              },\n            ],\n          },\n        },\n      };\n\n      // Check for existing import\n      const hasImport =\n        Array.isArray(tree.children) &&\n        tree.children.some(\n          n =>\n            n.type === 'mdxjsEsm' &&\n            (n.value?.includes('@theme/GlossaryTerm') ||\n              n.data?.estree?.body?.some(s => s.source?.value === '@theme/GlossaryTerm'))\n        );\n\n      if (!hasImport) {\n        if (!Array.isArray(tree.children)) tree.children = [];\n        let insertIndex = 0;\n        for (let i = 0; i < tree.children.length; i++) {\n          const node = tree.children[i];\n          if (node.type === 'yaml' || node.type === 'toml') {\n            insertIndex = i + 1;\n          } else {\n            break;\n          }\n        }\n        tree.children.splice(insertIndex, 0, importNode);\n      }\n    }\n  };\n\n  return transformer;\n}\n\n/**\n * Clears the glossary cache\n * Useful for testing or when you want to force a reload of glossary data\n *\n * @param {string} [filePath] - Optional specific file path to clear. If not provided, clears entire cache.\n */\nexport function clearGlossaryCache(filePath) {\n  if (filePath) {\n    glossaryCache.delete(filePath);\n  } else {\n    glossaryCache.clear();\n  }\n}\n","import type { GlossaryData, GlossaryTerm } from './index.js';\n\nexport interface ValidationError {\n  field: string;\n  message: string;\n  value?: unknown;\n}\n\nexport interface ValidationResult {\n  valid: boolean;\n  errors: ValidationError[];\n  data: GlossaryData;\n}\n\n/**\n * Validates a single glossary term object\n *\n * @param term - The term object to validate\n * @param index - The index in the terms array (for error messages)\n * @returns Array of validation errors (empty if valid)\n */\nfunction validateTerm(term: unknown, index: number): ValidationError[] {\n  const errors: ValidationError[] = [];\n  const prefix = `terms[${index}]`;\n\n  if (term === null || term === undefined) {\n    errors.push({\n      field: prefix,\n      message: 'Term cannot be null or undefined',\n      value: term,\n    });\n    return errors;\n  }\n\n  if (typeof term !== 'object') {\n    errors.push({\n      field: prefix,\n      message: `Term must be an object, got ${typeof term}`,\n      value: term,\n    });\n    return errors;\n  }\n\n  const termObj = term as Record<string, unknown>;\n\n  // Required: term (string)\n  if (!('term' in termObj)) {\n    errors.push({\n      field: `${prefix}.term`,\n      message: 'Missing required field \"term\"',\n    });\n  } else if (typeof termObj.term !== 'string') {\n    errors.push({\n      field: `${prefix}.term`,\n      message: `Field \"term\" must be a string, got ${typeof termObj.term}`,\n      value: termObj.term,\n    });\n  } else if (termObj.term.trim() === '') {\n    errors.push({\n      field: `${prefix}.term`,\n      message: 'Field \"term\" cannot be empty',\n      value: termObj.term,\n    });\n  }\n\n  // Required: definition (string)\n  if (!('definition' in termObj)) {\n    errors.push({\n      field: `${prefix}.definition`,\n      message: 'Missing required field \"definition\"',\n    });\n  } else if (typeof termObj.definition !== 'string') {\n    errors.push({\n      field: `${prefix}.definition`,\n      message: `Field \"definition\" must be a string, got ${typeof termObj.definition}`,\n      value: termObj.definition,\n    });\n  }\n\n  // Optional: abbreviation (string)\n  if ('abbreviation' in termObj && termObj.abbreviation !== undefined) {\n    if (typeof termObj.abbreviation !== 'string') {\n      errors.push({\n        field: `${prefix}.abbreviation`,\n        message: `Field \"abbreviation\" must be a string, got ${typeof termObj.abbreviation}`,\n        value: termObj.abbreviation,\n      });\n    }\n  }\n\n  // Optional: relatedTerms (string[])\n  if ('relatedTerms' in termObj && termObj.relatedTerms !== undefined) {\n    if (!Array.isArray(termObj.relatedTerms)) {\n      errors.push({\n        field: `${prefix}.relatedTerms`,\n        message: `Field \"relatedTerms\" must be an array, got ${typeof termObj.relatedTerms}`,\n        value: termObj.relatedTerms,\n      });\n    } else {\n      termObj.relatedTerms.forEach((relatedTerm, relatedIndex) => {\n        if (typeof relatedTerm !== 'string') {\n          errors.push({\n            field: `${prefix}.relatedTerms[${relatedIndex}]`,\n            message: `Related term must be a string, got ${typeof relatedTerm}`,\n            value: relatedTerm,\n          });\n        }\n      });\n    }\n  }\n\n  // Optional: id (string)\n  if ('id' in termObj && termObj.id !== undefined) {\n    if (typeof termObj.id !== 'string') {\n      errors.push({\n        field: `${prefix}.id`,\n        message: `Field \"id\" must be a string, got ${typeof termObj.id}`,\n        value: termObj.id,\n      });\n    }\n  }\n\n  // Optional: autoLink (boolean)\n  if ('autoLink' in termObj && termObj.autoLink !== undefined) {\n    if (typeof termObj.autoLink !== 'boolean') {\n      errors.push({\n        field: `${prefix}.autoLink`,\n        message: `Field \"autoLink\" must be a boolean, got ${typeof termObj.autoLink}`,\n        value: termObj.autoLink,\n      });\n    }\n  }\n\n  // Optional: aliases (string[])\n  if ('aliases' in termObj && termObj.aliases !== undefined) {\n    if (!Array.isArray(termObj.aliases)) {\n      errors.push({\n        field: `${prefix}.aliases`,\n        message: `Field \"aliases\" must be an array, got ${typeof termObj.aliases}`,\n        value: termObj.aliases,\n      });\n    } else {\n      termObj.aliases.forEach((alias, aliasIndex) => {\n        if (typeof alias !== 'string') {\n          errors.push({\n            field: `${prefix}.aliases[${aliasIndex}]`,\n            message: `Alias must be a string, got ${typeof alias}`,\n            value: alias,\n          });\n        } else if (alias.trim() === '') {\n          errors.push({\n            field: `${prefix}.aliases[${aliasIndex}]`,\n            message: 'Alias cannot be empty',\n            value: alias,\n          });\n        }\n      });\n    }\n  }\n\n  return errors;\n}\n\n/**\n * Validates glossary data structure\n *\n * Ensures the glossary data conforms to the expected schema:\n * - Must be an object with a \"terms\" array\n * - Each term must have \"term\" (string) and \"definition\" (string)\n * - Optional fields: abbreviation (string), relatedTerms (string[]), id (string)\n *\n * @param data - The data to validate\n * @param options - Validation options\n * @param options.throwOnError - If true, throws an error on validation failure (default: true)\n * @returns Validation result with errors and sanitized data\n * @throws Error if data is invalid and throwOnError is true\n */\nexport function validateGlossaryData(\n  data: unknown,\n  options: { throwOnError?: boolean } = {}\n): ValidationResult {\n  const { throwOnError = true } = options;\n  const errors: ValidationError[] = [];\n\n  // Check if data is null or undefined\n  if (data === null || data === undefined) {\n    errors.push({\n      field: 'root',\n      message: 'Glossary data cannot be null or undefined',\n      value: data,\n    });\n\n    if (throwOnError && errors.length > 0) {\n      throw new GlossaryValidationError(errors);\n    }\n\n    return { valid: false, errors, data: { terms: [] } };\n  }\n\n  // Check if data is an object\n  if (typeof data !== 'object') {\n    errors.push({\n      field: 'root',\n      message: `Glossary data must be an object, got ${typeof data}`,\n      value: data,\n    });\n\n    if (throwOnError && errors.length > 0) {\n      throw new GlossaryValidationError(errors);\n    }\n\n    return { valid: false, errors, data: { terms: [] } };\n  }\n\n  const glossaryData = data as Record<string, unknown>;\n\n  //Check for title\n  if ('title' in glossaryData && typeof glossaryData.title !== 'string') {\n    errors.push({\n      field: 'title',\n      message: 'The title property in the GlossaryData must be a string.',\n    });\n\n    if (throwOnError && errors.length > 0) {\n      throw new GlossaryValidationError(errors);\n    }\n  }\n  const validTitle = glossaryData.title as string;\n\n  if ('description' in glossaryData && typeof glossaryData.description !== 'string') {\n    errors.push({\n      field: 'description',\n      message: 'The description property in the GlossaryData must be a string.',\n    });\n\n    if (throwOnError && errors.length > 0) {\n      throw new GlossaryValidationError(errors);\n    }\n  }\n\n  const validDescription = glossaryData.description as string;\n\n  if (!('terms' in glossaryData)) {\n    // Check for terms array\n    errors.push({\n      field: 'terms',\n      message: 'Glossary data must contain a \"terms\" array',\n    });\n\n    if (throwOnError && errors.length > 0) {\n      throw new GlossaryValidationError(errors);\n    }\n\n    return { valid: false, errors, data: { terms: [] } };\n  }\n\n  if (!Array.isArray(glossaryData.terms)) {\n    errors.push({\n      field: 'terms',\n      message: `Field \"terms\" must be an array, got ${typeof glossaryData.terms}`,\n      value: glossaryData.terms,\n    });\n\n    if (throwOnError && errors.length > 0) {\n      throw new GlossaryValidationError(errors);\n    }\n\n    return { valid: false, errors, data: { terms: [] } };\n  }\n\n  // Validate each term\n  const validTerms: GlossaryTerm[] = [];\n  glossaryData.terms.forEach((term, index) => {\n    const termErrors = validateTerm(term, index);\n    if (termErrors.length > 0) {\n      errors.push(...termErrors);\n    } else {\n      // Term is valid, add to valid terms\n      validTerms.push(term as GlossaryTerm);\n    }\n  });\n\n  // Check for duplicate terms\n  const termNames = new Map<string, number>();\n  validTerms.forEach((term, index) => {\n    const lowerName = term.term.toLowerCase();\n    if (termNames.has(lowerName)) {\n      errors.push({\n        field: `terms[${index}].term`,\n        message: `Duplicate term \"${term.term}\" (first occurrence at index ${termNames.get(lowerName)})`,\n        value: term.term,\n      });\n    } else {\n      termNames.set(lowerName, index);\n    }\n  });\n\n  if (throwOnError && errors.length > 0) {\n    throw new GlossaryValidationError(errors);\n  }\n\n  return {\n    valid: errors.length === 0,\n    errors,\n    data: { title: validTitle, description: validDescription, terms: validTerms },\n  };\n}\n\n/**\n * Custom error class for glossary validation errors\n * Provides detailed error messages for debugging\n */\nexport class GlossaryValidationError extends Error {\n  public readonly errors: ValidationError[];\n\n  constructor(errors: ValidationError[]) {\n    const message = formatValidationErrors(errors);\n    super(message);\n    this.name = 'GlossaryValidationError';\n    this.errors = errors;\n\n    // Maintains proper stack trace for where error was thrown (V8 engines)\n    // @ts-ignore\n    if (Error.captureStackTrace) {\n      // @ts-ignore\n      Error.captureStackTrace(this, GlossaryValidationError);\n    }\n  }\n}\n\n/**\n * Formats validation errors into a readable string\n *\n * @param errors - Array of validation errors\n * @returns Formatted error message\n */\nexport function formatValidationErrors(errors: ValidationError[]): string {\n  if (errors.length === 0) {\n    return 'No validation errors';\n  }\n\n  const header = `Glossary validation failed with ${errors.length} error${errors.length > 1 ? 's' : ''}:`;\n  const errorList = errors\n    .map((err, index) => {\n      let msg = `  ${index + 1}. [${err.field}] ${err.message}`;\n      if (err.value !== undefined) {\n        const valueStr =\n          typeof err.value === 'object' ? JSON.stringify(err.value) : String(err.value);\n        // Truncate long values\n        const truncated = valueStr.length > 50 ? valueStr.substring(0, 50) + '...' : valueStr;\n        msg += ` (got: ${truncated})`;\n      }\n      return msg;\n    })\n    .join('\\n');\n\n  return `${header}\\n${errorList}`;\n}\n"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AACA,IAAAA,eAAiB;AAEjB,iBAA8B;AAC9B,sBAAe;AAEf,wCAAqC;;;ACNrC,8BAAsB;AACtB,kBAAiB;AACjB,gBAAe;AAUf,SAAS,sBAAsB,MAAM,WAAW;AAC9C,QAAM,SAAS,CAAC;AAChB,QAAM,aAAa,CAAC;AAEpB,MAAI,SAAS,QAAQ,SAAS,QAAW;AACvC,WAAO,KAAK,oCAAoC;AAChD,WAAO,EAAE,OAAO,CAAC,GAAG,OAAO;AAAA,EAC7B;AAEA,MAAI,OAAO,SAAS,UAAU;AAC5B,WAAO,KAAK,wCAAwC,OAAO,IAAI,EAAE;AACjE,WAAO,EAAE,OAAO,CAAC,GAAG,OAAO;AAAA,EAC7B;AAEA,MAAI,EAAE,WAAW,OAAO;AACtB,WAAO,KAAK,4CAA4C;AACxD,WAAO,EAAE,OAAO,CAAC,GAAG,OAAO;AAAA,EAC7B;AAEA,MAAI,CAAC,MAAM,QAAQ,KAAK,KAAK,GAAG;AAC9B,WAAO,KAAK,uCAAuC,OAAO,KAAK,KAAK,EAAE;AACtE,WAAO,EAAE,OAAO,CAAC,GAAG,OAAO;AAAA,EAC7B;AAEA,OAAK,MAAM,QAAQ,CAAC,MAAM,UAAU;AAClC,QAAI,SAAS,QAAQ,SAAS,UAAa,OAAO,SAAS,UAAU;AACnE,aAAO,KAAK,SAAS,KAAK,2BAA2B;AACrD;AAAA,IACF;AAEA,QAAI,OAAO,KAAK,SAAS,YAAY,KAAK,KAAK,KAAK,MAAM,IAAI;AAC5D,aAAO,KAAK,SAAS,KAAK,oCAAoC;AAC9D;AAAA,IACF;AAEA,QAAI,OAAO,KAAK,eAAe,UAAU;AACvC,aAAO,KAAK,SAAS,KAAK,0CAA0C;AACpE;AAAA,IACF;AAEA,eAAW,KAAK,IAAI;AAAA,EACtB,CAAC;AAED,SAAO,EAAE,OAAO,YAAY,OAAO;AACrC;AAIA,IAAM,gBAAgB,oBAAI,IAAI;AAC9B,IAAM,YAAY;AAgBH,SAAR,oBAAqC;AAAA,EAC1C,QAAQ,CAAC;AAAA,EACT,eAAe;AAAA,EACf,YAAY;AAAA,EACZ,UAAU;AACZ,IAAI,CAAC,GAAG;AACN,MAAI,gBAAgB;AAGpB,MAAI,CAAC,cAAc,UAAU,gBAAgB,SAAS;AACpD,QAAI;AACF,YAAM,mBAAmB,YAAAC,QAAK,QAAQ,SAAS,YAAY;AAC3D,YAAM,MAAM,KAAK,IAAI;AAGrB,YAAM,SAAS,cAAc,IAAI,gBAAgB;AACjD,UAAI,UAAU,MAAM,OAAO,WAAW,WAAW;AAC/C,wBAAgB,OAAO;AAAA,MACzB,OAAO;AAIL,YAAI,UAAAC,QAAG,WAAW,gBAAgB,GAAG;AACnC,gBAAM,cAAc,UAAAA,QAAG,aAAa,kBAAkB,MAAM;AAC5D,cAAI;AACJ,cAAI;AACF,2BAAe,KAAK,MAAM,WAAW;AAAA,UACvC,SAAS,YAAY;AACnB,oBAAQ;AAAA,cACN,sDAAsD,YAAY;AAAA,cAClE,WAAW;AAAA,YACb;AACA,0BAAc,IAAI,kBAAkB;AAAA,cAClC,OAAO,CAAC;AAAA,cACR,UAAU;AAAA,YACZ,CAAC;AACD,mBAAO,UAAQ;AAAA,UACjB;AAGA,gBAAM,EAAE,OAAO,YAAY,OAAO,IAAI,sBAAsB,cAAc,YAAY;AAEtF,cAAI,OAAO,SAAS,GAAG;AACrB,oBAAQ,KAAK,mDAAmD,YAAY,GAAG;AAC/E,mBAAO,QAAQ,SAAO,QAAQ,KAAK,OAAO,GAAG,EAAE,CAAC;AAChD,gBAAI,WAAW,SAAS,GAAG;AACzB,sBAAQ,KAAK,qCAAqC,WAAW,MAAM,iBAAiB;AAAA,YACtF;AAAA,UACF;AAEA,0BAAgB;AAGhB,wBAAc,IAAI,kBAAkB;AAAA,YAClC,OAAO;AAAA,YACP,UAAU;AAAA,UACZ,CAAC;AAGD,cAAI,CAAC,UAAU,QAAQ,IAAI,aAAa,cAAc;AACpD,oBAAQ;AAAA,cACN,4BAA4B,cAAc,MAAM,eAAe,YAAY;AAAA,YAC7E;AAAA,UACF;AAAA,QACF,OAAO;AAEL,wBAAc,IAAI,kBAAkB;AAAA,YAClC,OAAO,CAAC;AAAA,YACR,UAAU;AAAA,UACZ,CAAC;AACD,cAAI,QAAQ,IAAI,aAAa,cAAc;AACzC,oBAAQ,KAAK,8CAA8C,YAAY,EAAE;AAAA,UAC3E;AAAA,QACF;AAAA,MACF;AAAA,IACF,SAAS,OAAO;AACd,cAAQ;AAAA,QACN,kDAAkD,YAAY;AAAA,QAC9D,MAAM;AAAA,MACR;AAEA,UAAI,gBAAgB,SAAS;AAC3B,cAAM,mBAAmB,YAAAD,QAAK,QAAQ,SAAS,YAAY;AAC3D,sBAAc,IAAI,kBAAkB;AAAA,UAClC,OAAO,CAAC;AAAA,UACR,UAAU,KAAK,IAAI;AAAA,QACrB,CAAC;AAAA,MACH;AAAA,IACF;AAAA,EACF;AAMA,QAAM,UAAU,oBAAI,IAAI;AACxB,gBAAc,QAAQ,aAAW;AAC/B,QAAI,CAAC,QAAQ,QAAQ,QAAQ,aAAa,MAAO;AAEjD,UAAM,WAAW,YAAU;AACzB,UAAI,OAAO,WAAW,YAAY,OAAO,KAAK,MAAM,GAAI;AACxD,YAAM,MAAM,OAAO,YAAY;AAC/B,UAAI,CAAC,QAAQ,IAAI,GAAG,GAAG;AACrB,gBAAQ,IAAI,KAAK,EAAE,SAAS,WAAW,OAAO,CAAC;AAAA,MACjD;AAAA,IACF;AAEA,aAAS,QAAQ,IAAI;AACrB,QAAI,MAAM,QAAQ,QAAQ,OAAO,GAAG;AAClC,cAAQ,QAAQ,QAAQ,QAAQ;AAAA,IAClC;AAAA,EACF,CAAC;AAID,QAAM,cAAc,MAAM,KAAK,QAAQ,QAAQ,CAAC,EAAE,KAAK,CAAC,GAAG,MAAM,EAAE,CAAC,EAAE,SAAS,EAAE,CAAC,EAAE,MAAM;AAG1F,MAAI,YAAY,WAAW,GAAG;AAC5B,WAAO,UAAQ;AAAA,EACjB;AAMA,WAAS,mBAAmB,MAAM;AAChC,QAAI,CAAC,QAAQ,CAAC,YAAY,QAAQ;AAChC,aAAO,CAAC,EAAE,MAAM,QAAQ,OAAO,KAAK,CAAC;AAAA,IACvC;AAEA,UAAM,SAAS,CAAC;AAChB,QAAI,YAAY;AAChB,UAAM,YAAY,KAAK,YAAY;AAGnC,UAAM,UAAU,CAAC;AACjB,eAAW,CAAC,aAAa,EAAE,QAAQ,CAAC,KAAK,aAAa;AACpD,UAAI,cAAc;AAElB,aAAO,cAAc,UAAU,QAAQ;AACrC,cAAM,QAAQ,UAAU,QAAQ,aAAa,WAAW;AACxD,YAAI,UAAU,GAAI;AAGlB,cAAM,aAAa,QAAQ,IAAI,UAAU,QAAQ,CAAC,IAAI;AACtD,cAAM,aAAa,QAAQ,YAAY;AACvC,cAAM,YAAY,aAAa,UAAU,SAAS,UAAU,UAAU,IAAI;AAE1E,YAAI,cAAc,YAAY;AAC9B,YAAI,iBAAiB,CAAC,KAAK,KAAK,UAAU,KAAK,CAAC,KAAK,KAAK,SAAS;AAGnE,YAAI,CAAC,kBAAkB,cAAc,KAAK;AACxC,gBAAM,WAAW,aAAa,IAAI,UAAU,SAAS,UAAU,aAAa,CAAC,IAAI;AACjF,cAAI,CAAC,KAAK,KAAK,QAAQ,GAAG;AACxB,6BAAiB;AACjB,0BAAc,YAAY,SAAS;AAAA,UACrC;AAAA,QACF;AAGA,YACE,CAAC,kBACD,cAAc,OACd,aAAa,IAAI,UAAU,UAC3B,UAAU,aAAa,CAAC,MAAM,KAC9B;AACA,gBAAM,WAAW,aAAa,IAAI,UAAU,SAAS,UAAU,aAAa,CAAC,IAAI;AACjF,cAAI,CAAC,KAAK,KAAK,QAAQ,GAAG;AACxB,6BAAiB;AACjB,0BAAc,YAAY,SAAS;AAAA,UACrC;AAAA,QACF;AAEA,YAAI,gBAAgB;AAClB,kBAAQ,KAAK;AAAA,YACX;AAAA,YACA,QAAQ;AAAA,YACR;AAAA;AAAA,YAEA,cAAc,KAAK,UAAU,OAAO,QAAQ,WAAW;AAAA,UACzD,CAAC;AAAA,QACH;AAEA,sBAAc,QAAQ;AAAA,MACxB;AAAA,IACF;AAGA,YAAQ,KAAK,CAAC,GAAG,MAAM,EAAE,QAAQ,EAAE,KAAK;AAGxC,UAAM,wBAAwB,CAAC;AAC/B,QAAI,eAAe;AACnB,eAAW,SAAS,SAAS;AAC3B,UAAI,MAAM,SAAS,cAAc;AAC/B,8BAAsB,KAAK,KAAK;AAChC,uBAAe,MAAM,QAAQ,MAAM;AAAA,MACrC;AAAA,IACF;AAGA,eAAW,SAAS,uBAAuB;AAEzC,UAAI,MAAM,QAAQ,WAAW;AAC3B,eAAO,KAAK;AAAA,UACV,MAAM;AAAA,UACN,OAAO,KAAK,UAAU,WAAW,MAAM,KAAK;AAAA,QAC9C,CAAC;AAAA,MACH;AAGA,aAAO,KAAK;AAAA,QACV,MAAM;AAAA,QACN,MAAM;AAAA,QACN,YAAY;AAAA,UACV;AAAA,YACE,MAAM;AAAA,YACN,MAAM;AAAA,YACN,OAAO,MAAM,QAAQ;AAAA,UACvB;AAAA,UACA;AAAA,YACE,MAAM;AAAA,YACN,MAAM;AAAA,YACN,OAAO,MAAM,QAAQ,cAAc;AAAA,UACrC;AAAA,UACA;AAAA,YACE,MAAM;AAAA,YACN,MAAM;AAAA,YACN,OAAO;AAAA,UACT;AAAA,QACF;AAAA,QACA,UAAU;AAAA,UACR;AAAA,YACE,MAAM;AAAA,YACN,OAAO,MAAM;AAAA,UACf;AAAA,QACF;AAAA,MACF,CAAC;AAED,kBAAY,MAAM,QAAQ,MAAM;AAAA,IAClC;AAGA,QAAI,YAAY,KAAK,QAAQ;AAC3B,aAAO,KAAK;AAAA,QACV,MAAM;AAAA,QACN,OAAO,KAAK,UAAU,SAAS;AAAA,MACjC,CAAC;AAAA,IACH;AAEA,WAAO,OAAO,SAAS,IAAI,SAAS,CAAC,EAAE,MAAM,QAAQ,OAAO,KAAK,CAAC;AAAA,EACpE;AAKA,WAAS,wBAAwB,MAAM;AACrC,UAAM,OAAO,oBAAI,QAAQ;AACzB,uCAAM,MAAM,WAAW,iBAAe;AACpC,yCAAM,aAAa,QAAQ,cAAY;AACrC,aAAK,IAAI,QAAQ;AAAA,MACnB,CAAC;AAAA,IACH,CAAC;AACD,WAAO;AAAA,EACT;AAGA,QAAM,cAAc,UAAQ;AAC1B,QAAI,mBAAmB;AACvB,UAAM,sBAAsB,wBAAwB,IAAI;AACxD,uCAAM,MAAM,QAAQ,CAAC,MAAM,OAAO,WAAW;AAE3C,UACE,OAAO,SAAS,UAChB,OAAO,SAAS,gBAChB,OAAO,SAAS,UAChB,OAAO,SAAS,uBAChB,OAAO,SAAS,qBAChB;AACA;AAAA,MACF;AAGA,UAAI,oBAAoB,IAAI,IAAI,GAAG;AACjC;AAAA,MACF;AAGA,YAAM,eAAe,mBAAmB,KAAK,KAAK;AAGlD,UACE,aAAa,SAAS,KACrB,aAAa,WAAW,KAAK,aAAa,CAAC,EAAE,SAAS,QACvD;AAEA,cAAM,WAAW,aAAa,IAAI,iBAAe;AAC/C,cAAI,YAAY,SAAS,qBAAqB;AAE5C,gBAAI,OAAO,SAAS,aAAa;AAC/B,iCAAmB;AACnB,qBAAO;AAAA,gBACL,MAAM;AAAA,gBACN,MAAM,YAAY;AAAA,gBAClB,YAAY,YAAY;AAAA,gBACxB,UAAU,YAAY;AAAA,cACxB;AAAA,YACF;AACA,+BAAmB;AAAA,UACrB;AACA,iBAAO;AAAA,QACT,CAAC;AAGD,eAAO,SAAS,OAAO,OAAO,GAAG,GAAG,QAAQ;AAC5C,eAAO,QAAQ,SAAS,SAAS;AAAA,MACnC;AAAA,IACF,CAAC;AAID,QAAI,kBAAkB;AACpB,YAAM,aAAa;AAAA,QACjB,MAAM;AAAA,QACN,OAAO;AAAA,QACP,MAAM;AAAA,UACJ,QAAQ;AAAA,YACN,MAAM;AAAA,YACN,YAAY;AAAA,YACZ,MAAM;AAAA,cACJ;AAAA,gBACE,MAAM;AAAA,gBACN,YAAY;AAAA,kBACV;AAAA,oBACE,MAAM;AAAA,oBACN,OAAO,EAAE,MAAM,cAAc,MAAM,eAAe;AAAA,kBACpD;AAAA,gBACF;AAAA,gBACA,QAAQ;AAAA,kBACN,MAAM;AAAA,kBACN,OAAO;AAAA,kBACP,KAAK;AAAA,gBACP;AAAA,cACF;AAAA,YACF;AAAA,UACF;AAAA,QACF;AAAA,MACF;AAGA,YAAM,YACJ,MAAM,QAAQ,KAAK,QAAQ,KAC3B,KAAK,SAAS;AAAA,QACZ,OACE,EAAE,SAAS,eACV,EAAE,OAAO,SAAS,qBAAqB,KACtC,EAAE,MAAM,QAAQ,MAAM,KAAK,OAAK,EAAE,QAAQ,UAAU,qBAAqB;AAAA,MAC/E;AAEF,UAAI,CAAC,WAAW;AACd,YAAI,CAAC,MAAM,QAAQ,KAAK,QAAQ,EAAG,MAAK,WAAW,CAAC;AACpD,YAAI,cAAc;AAClB,iBAAS,IAAI,GAAG,IAAI,KAAK,SAAS,QAAQ,KAAK;AAC7C,gBAAM,OAAO,KAAK,SAAS,CAAC;AAC5B,cAAI,KAAK,SAAS,UAAU,KAAK,SAAS,QAAQ;AAChD,0BAAc,IAAI;AAAA,UACpB,OAAO;AACL;AAAA,UACF;AAAA,QACF;AACA,aAAK,SAAS,OAAO,aAAa,GAAG,UAAU;AAAA,MACjD;AAAA,IACF;AAAA,EACF;AAEA,SAAO;AACT;AAQO,SAAS,mBAAmB,UAAU;AAC3C,MAAI,UAAU;AACZ,kBAAc,OAAO,QAAQ;AAAA,EAC/B,OAAO;AACL,kBAAc,MAAM;AAAA,EACtB;AACF;;;AChcA,SAAS,aAAa,MAAe,OAAkC;AACrE,QAAM,SAA4B,CAAC;AACnC,QAAM,SAAS,SAAS,KAAK;AAE7B,MAAI,SAAS,QAAQ,SAAS,QAAW;AACvC,WAAO,KAAK;AAAA,MACV,OAAO;AAAA,MACP,SAAS;AAAA,MACT,OAAO;AAAA,IACT,CAAC;AACD,WAAO;AAAA,EACT;AAEA,MAAI,OAAO,SAAS,UAAU;AAC5B,WAAO,KAAK;AAAA,MACV,OAAO;AAAA,MACP,SAAS,+BAA+B,OAAO,IAAI;AAAA,MACnD,OAAO;AAAA,IACT,CAAC;AACD,WAAO;AAAA,EACT;AAEA,QAAM,UAAU;AAGhB,MAAI,EAAE,UAAU,UAAU;AACxB,WAAO,KAAK;AAAA,MACV,OAAO,GAAG,MAAM;AAAA,MAChB,SAAS;AAAA,IACX,CAAC;AAAA,EACH,WAAW,OAAO,QAAQ,SAAS,UAAU;AAC3C,WAAO,KAAK;AAAA,MACV,OAAO,GAAG,MAAM;AAAA,MAChB,SAAS,sCAAsC,OAAO,QAAQ,IAAI;AAAA,MAClE,OAAO,QAAQ;AAAA,IACjB,CAAC;AAAA,EACH,WAAW,QAAQ,KAAK,KAAK,MAAM,IAAI;AACrC,WAAO,KAAK;AAAA,MACV,OAAO,GAAG,MAAM;AAAA,MAChB,SAAS;AAAA,MACT,OAAO,QAAQ;AAAA,IACjB,CAAC;AAAA,EACH;AAGA,MAAI,EAAE,gBAAgB,UAAU;AAC9B,WAAO,KAAK;AAAA,MACV,OAAO,GAAG,MAAM;AAAA,MAChB,SAAS;AAAA,IACX,CAAC;AAAA,EACH,WAAW,OAAO,QAAQ,eAAe,UAAU;AACjD,WAAO,KAAK;AAAA,MACV,OAAO,GAAG,MAAM;AAAA,MAChB,SAAS,4CAA4C,OAAO,QAAQ,UAAU;AAAA,MAC9E,OAAO,QAAQ;AAAA,IACjB,CAAC;AAAA,EACH;AAGA,MAAI,kBAAkB,WAAW,QAAQ,iBAAiB,QAAW;AACnE,QAAI,OAAO,QAAQ,iBAAiB,UAAU;AAC5C,aAAO,KAAK;AAAA,QACV,OAAO,GAAG,MAAM;AAAA,QAChB,SAAS,8CAA8C,OAAO,QAAQ,YAAY;AAAA,QAClF,OAAO,QAAQ;AAAA,MACjB,CAAC;AAAA,IACH;AAAA,EACF;AAGA,MAAI,kBAAkB,WAAW,QAAQ,iBAAiB,QAAW;AACnE,QAAI,CAAC,MAAM,QAAQ,QAAQ,YAAY,GAAG;AACxC,aAAO,KAAK;AAAA,QACV,OAAO,GAAG,MAAM;AAAA,QAChB,SAAS,8CAA8C,OAAO,QAAQ,YAAY;AAAA,QAClF,OAAO,QAAQ;AAAA,MACjB,CAAC;AAAA,IACH,OAAO;AACL,cAAQ,aAAa,QAAQ,CAAC,aAAa,iBAAiB;AAC1D,YAAI,OAAO,gBAAgB,UAAU;AACnC,iBAAO,KAAK;AAAA,YACV,OAAO,GAAG,MAAM,iBAAiB,YAAY;AAAA,YAC7C,SAAS,sCAAsC,OAAO,WAAW;AAAA,YACjE,OAAO;AAAA,UACT,CAAC;AAAA,QACH;AAAA,MACF,CAAC;AAAA,IACH;AAAA,EACF;AAGA,MAAI,QAAQ,WAAW,QAAQ,OAAO,QAAW;AAC/C,QAAI,OAAO,QAAQ,OAAO,UAAU;AAClC,aAAO,KAAK;AAAA,QACV,OAAO,GAAG,MAAM;AAAA,QAChB,SAAS,oCAAoC,OAAO,QAAQ,EAAE;AAAA,QAC9D,OAAO,QAAQ;AAAA,MACjB,CAAC;AAAA,IACH;AAAA,EACF;AAGA,MAAI,cAAc,WAAW,QAAQ,aAAa,QAAW;AAC3D,QAAI,OAAO,QAAQ,aAAa,WAAW;AACzC,aAAO,KAAK;AAAA,QACV,OAAO,GAAG,MAAM;AAAA,QAChB,SAAS,2CAA2C,OAAO,QAAQ,QAAQ;AAAA,QAC3E,OAAO,QAAQ;AAAA,MACjB,CAAC;AAAA,IACH;AAAA,EACF;AAGA,MAAI,aAAa,WAAW,QAAQ,YAAY,QAAW;AACzD,QAAI,CAAC,MAAM,QAAQ,QAAQ,OAAO,GAAG;AACnC,aAAO,KAAK;AAAA,QACV,OAAO,GAAG,MAAM;AAAA,QAChB,SAAS,yCAAyC,OAAO,QAAQ,OAAO;AAAA,QACxE,OAAO,QAAQ;AAAA,MACjB,CAAC;AAAA,IACH,OAAO;AACL,cAAQ,QAAQ,QAAQ,CAAC,OAAO,eAAe;AAC7C,YAAI,OAAO,UAAU,UAAU;AAC7B,iBAAO,KAAK;AAAA,YACV,OAAO,GAAG,MAAM,YAAY,UAAU;AAAA,YACtC,SAAS,+BAA+B,OAAO,KAAK;AAAA,YACpD,OAAO;AAAA,UACT,CAAC;AAAA,QACH,WAAW,MAAM,KAAK,MAAM,IAAI;AAC9B,iBAAO,KAAK;AAAA,YACV,OAAO,GAAG,MAAM,YAAY,UAAU;AAAA,YACtC,SAAS;AAAA,YACT,OAAO;AAAA,UACT,CAAC;AAAA,QACH;AAAA,MACF,CAAC;AAAA,IACH;AAAA,EACF;AAEA,SAAO;AACT;AAgBO,SAAS,qBACd,MACA,UAAsC,CAAC,GACrB;AAClB,QAAM,EAAE,eAAe,KAAK,IAAI;AAChC,QAAM,SAA4B,CAAC;AAGnC,MAAI,SAAS,QAAQ,SAAS,QAAW;AACvC,WAAO,KAAK;AAAA,MACV,OAAO;AAAA,MACP,SAAS;AAAA,MACT,OAAO;AAAA,IACT,CAAC;AAED,QAAI,gBAAgB,OAAO,SAAS,GAAG;AACrC,YAAM,IAAI,wBAAwB,MAAM;AAAA,IAC1C;AAEA,WAAO,EAAE,OAAO,OAAO,QAAQ,MAAM,EAAE,OAAO,CAAC,EAAE,EAAE;AAAA,EACrD;AAGA,MAAI,OAAO,SAAS,UAAU;AAC5B,WAAO,KAAK;AAAA,MACV,OAAO;AAAA,MACP,SAAS,wCAAwC,OAAO,IAAI;AAAA,MAC5D,OAAO;AAAA,IACT,CAAC;AAED,QAAI,gBAAgB,OAAO,SAAS,GAAG;AACrC,YAAM,IAAI,wBAAwB,MAAM;AAAA,IAC1C;AAEA,WAAO,EAAE,OAAO,OAAO,QAAQ,MAAM,EAAE,OAAO,CAAC,EAAE,EAAE;AAAA,EACrD;AAEA,QAAM,eAAe;AAGrB,MAAI,WAAW,gBAAgB,OAAO,aAAa,UAAU,UAAU;AACrE,WAAO,KAAK;AAAA,MACV,OAAO;AAAA,MACP,SAAS;AAAA,IACX,CAAC;AAED,QAAI,gBAAgB,OAAO,SAAS,GAAG;AACrC,YAAM,IAAI,wBAAwB,MAAM;AAAA,IAC1C;AAAA,EACF;AACA,QAAM,aAAa,aAAa;AAEhC,MAAI,iBAAiB,gBAAgB,OAAO,aAAa,gBAAgB,UAAU;AACjF,WAAO,KAAK;AAAA,MACV,OAAO;AAAA,MACP,SAAS;AAAA,IACX,CAAC;AAED,QAAI,gBAAgB,OAAO,SAAS,GAAG;AACrC,YAAM,IAAI,wBAAwB,MAAM;AAAA,IAC1C;AAAA,EACF;AAEA,QAAM,mBAAmB,aAAa;AAEtC,MAAI,EAAE,WAAW,eAAe;AAE9B,WAAO,KAAK;AAAA,MACV,OAAO;AAAA,MACP,SAAS;AAAA,IACX,CAAC;AAED,QAAI,gBAAgB,OAAO,SAAS,GAAG;AACrC,YAAM,IAAI,wBAAwB,MAAM;AAAA,IAC1C;AAEA,WAAO,EAAE,OAAO,OAAO,QAAQ,MAAM,EAAE,OAAO,CAAC,EAAE,EAAE;AAAA,EACrD;AAEA,MAAI,CAAC,MAAM,QAAQ,aAAa,KAAK,GAAG;AACtC,WAAO,KAAK;AAAA,MACV,OAAO;AAAA,MACP,SAAS,uCAAuC,OAAO,aAAa,KAAK;AAAA,MACzE,OAAO,aAAa;AAAA,IACtB,CAAC;AAED,QAAI,gBAAgB,OAAO,SAAS,GAAG;AACrC,YAAM,IAAI,wBAAwB,MAAM;AAAA,IAC1C;AAEA,WAAO,EAAE,OAAO,OAAO,QAAQ,MAAM,EAAE,OAAO,CAAC,EAAE,EAAE;AAAA,EACrD;AAGA,QAAM,aAA6B,CAAC;AACpC,eAAa,MAAM,QAAQ,CAAC,MAAM,UAAU;AAC1C,UAAM,aAAa,aAAa,MAAM,KAAK;AAC3C,QAAI,WAAW,SAAS,GAAG;AACzB,aAAO,KAAK,GAAG,UAAU;AAAA,IAC3B,OAAO;AAEL,iBAAW,KAAK,IAAoB;AAAA,IACtC;AAAA,EACF,CAAC;AAGD,QAAM,YAAY,oBAAI,IAAoB;AAC1C,aAAW,QAAQ,CAAC,MAAM,UAAU;AAClC,UAAM,YAAY,KAAK,KAAK,YAAY;AACxC,QAAI,UAAU,IAAI,SAAS,GAAG;AAC5B,aAAO,KAAK;AAAA,QACV,OAAO,SAAS,KAAK;AAAA,QACrB,SAAS,mBAAmB,KAAK,IAAI,gCAAgC,UAAU,IAAI,SAAS,CAAC;AAAA,QAC7F,OAAO,KAAK;AAAA,MACd,CAAC;AAAA,IACH,OAAO;AACL,gBAAU,IAAI,WAAW,KAAK;AAAA,IAChC;AAAA,EACF,CAAC;AAED,MAAI,gBAAgB,OAAO,SAAS,GAAG;AACrC,UAAM,IAAI,wBAAwB,MAAM;AAAA,EAC1C;AAEA,SAAO;AAAA,IACL,OAAO,OAAO,WAAW;AAAA,IACzB;AAAA,IACA,MAAM,EAAE,OAAO,YAAY,aAAa,kBAAkB,OAAO,WAAW;AAAA,EAC9E;AACF;AAMO,IAAM,0BAAN,MAAM,iCAAgC,MAAM;AAAA,EAGjD,YAAY,QAA2B;AACrC,UAAM,UAAU,uBAAuB,MAAM;AAC7C,UAAM,OAAO;AACb,SAAK,OAAO;AACZ,SAAK,SAAS;AAId,QAAI,MAAM,mBAAmB;AAE3B,YAAM,kBAAkB,MAAM,wBAAuB;AAAA,IACvD;AAAA,EACF;AACF;AAQO,SAAS,uBAAuB,QAAmC;AACxE,MAAI,OAAO,WAAW,GAAG;AACvB,WAAO;AAAA,EACT;AAEA,QAAM,SAAS,mCAAmC,OAAO,MAAM,SAAS,OAAO,SAAS,IAAI,MAAM,EAAE;AACpG,QAAM,YAAY,OACf,IAAI,CAAC,KAAK,UAAU;AACnB,QAAI,MAAM,KAAK,QAAQ,CAAC,MAAM,IAAI,KAAK,KAAK,IAAI,OAAO;AACvD,QAAI,IAAI,UAAU,QAAW;AAC3B,YAAM,WACJ,OAAO,IAAI,UAAU,WAAW,KAAK,UAAU,IAAI,KAAK,IAAI,OAAO,IAAI,KAAK;AAE9E,YAAM,YAAY,SAAS,SAAS,KAAK,SAAS,UAAU,GAAG,EAAE,IAAI,QAAQ;AAC7E,aAAO,UAAU,SAAS;AAAA,IAC5B;AACA,WAAO;AAAA,EACT,CAAC,EACA,KAAK,IAAI;AAEZ,SAAO,GAAG,MAAM;AAAA,EAAK,SAAS;AAChC;;;AFrWA;AAWA,IAAM,sBAAkB,0BAAc,YAAY,GAAG;AACrD,IAAM,aAAa,aAAAE,QAAK,QAAQ,eAAe;AAAA,IAG/C,kCAAAC,SAAyB,UAAU;AAwFpB,SAAR,eACL,SACA,UAAiC,CAAC,GAC1B;AACR,QAAM,EAAE,eAAe,0BAA0B,YAAY,YAAY,IAAI;AAE7E,SAAO;AAAA,IACL,MAAM;AAAA,IAEN,mBAAmB;AACjB,aAAO,CAAC,aAAAD,QAAK,QAAQ,YAAY,mBAAmB,CAAC;AAAA,IACvD;AAAA,IAEA,MAAM,cAAc;AAElB,YAAM,mBAAmB,aAAAA,QAAK,QAAQ,QAAQ,SAAS,YAAY;AAEnE,UAAI,MAAM,gBAAAE,QAAG,WAAW,gBAAgB,GAAG;AACzC,YAAI;AACF,gBAAM,UAAU,MAAM,gBAAAA,QAAG,SAAS,gBAAgB;AAGlD,gBAAM,mBAAmB,qBAAqB,SAAS,EAAE,cAAc,MAAM,CAAC;AAE9E,cAAI,CAAC,iBAAiB,OAAO;AAC3B,oBAAQ;AAAA,cACN,4DAA4D,gBAAgB;AAAA,YAC9E;AACA,6BAAiB,OAAO,QAAQ,SAAO;AACrC,sBAAQ,KAAK,QAAQ,IAAI,KAAK,KAAK,IAAI,OAAO,EAAE;AAAA,YAClD,CAAC;AACD,oBAAQ,KAAK,qDAAqD;AAAA,UACpE;AAEA,iBAAO,iBAAiB;AAAA,QAC1B,SAAS,OAAO;AACd,cAAI,iBAAiB,yBAAyB;AAC5C,kBAAM;AAAA,UACR;AAEA,gBAAM,IAAI;AAAA,YACR,oCAAoC,gBAAgB,KAAK,iBAAiB,QAAQ,MAAM,UAAU,OAAO,KAAK,CAAC;AAAA,UACjH;AAAA,QACF;AAAA,MACF;AAEA,cAAQ,KAAK,8BAA8B,gBAAgB,yBAAyB;AACpF,aAAO,EAAE,OAAO,CAAC,EAAE;AAAA,IACrB;AAAA,IAEA,MAAM,cAAc,EAAE,SAAS,QAAQ,GAAG;AACxC,YAAM,EAAE,YAAY,UAAU,cAAc,IAAI;AAChD,YAAM,kBAAkB;AAGxB,YAAM,mBAAmB,MAAM;AAAA,QAC7B;AAAA,QACA,KAAK,UAAU,eAAe;AAAA,MAChC;AAGA,YAAM;AAAA,QACJ;AAAA,QACA,KAAK,UAAU;AAAA,UACb,OAAO,gBAAgB,SAAS,CAAC;AAAA,UACjC;AAAA,QACF,CAAC;AAAA,MACH;AAGA,eAAS;AAAA,QACP,MAAM;AAAA,QACN,WAAW,aAAAF,QAAK,KAAK,YAAY,4BAA4B;AAAA,QAC7D,OAAO;AAAA,QACP,SAAS;AAAA,UACP,cAAc;AAAA,QAChB;AAAA,MACF,CAAC;AAGD,oBAAc;AAAA,QACZ,OAAO,gBAAgB,SAAS,CAAC;AAAA,QACjC;AAAA,MACF,CAAC;AAAA,IACH;AAAA,IAEA,eAAe;AACb,aAAO,aAAAA,QAAK,QAAQ,YAAY,SAAS;AAAA,IAC3C;AAAA,IAEA,kBAAkB;AAChB,aAAO,CAAC,aAAAA,QAAK,QAAQ,QAAQ,SAAS,YAAY,CAAC;AAAA,IACrD;AAAA,IAEA,MAAM,YAAY;AAEhB,cAAQ,IAAI,kCAAkC;AAAA,IAChD;AAAA,EACF;AACF;AAGO,IAAM,eAAe;AAsBrB,SAAS,gBACd,eACA,SAC6F;AAC7F,QAAM,EAAE,eAAe,0BAA0B,YAAY,YAAY,IAAI;AAE7E,QAAM,UAAU,SAAS;AAEzB,SAAO;AAAA,IACL;AAAA,IACA;AAAA,MACE;AAAA,MACA;AAAA,MACA;AAAA,IACF;AAAA,EACF;AACF;","names":["import_path","path","fs","path","validatePeerDependencies","fs"]}

package/dist/index.d.cts

@@ -0,0 +1,176 @@
+import { LoadContext, Plugin } from '@docusaurus/types';
+
+/**
+ * Creates a remark plugin that automatically detects and replaces glossary terms in markdown
+ *
+ * This plugin transforms plain text terms into <GlossaryTerm> JSX elements.
+ * The GlossaryTerm component is globally available via the MDXComponents theme wrapper,
+ * so no import injection is needed - MDX files can use it without explicit imports.
+ *
+ * @param {object} options - Plugin options
+ * @param {Array} options.terms - Array of glossary term objects with {term, definition}
+ * @param {string} options.glossaryPath - Path to glossary JSON file (optional, if terms not provided)
+ * @param {string} options.routePath - Route path to glossary page (default: '/glossary')
+ * @param {string} options.siteDir - Docusaurus site directory (required if using glossaryPath)
+ * @returns {function} Remark plugin function
+ */
+declare function remarkGlossaryTerms({ terms, glossaryPath, routePath, siteDir, }?: {
+    terms: any[];
+    glossaryPath: string;
+    routePath: string;
+    siteDir: string;
+}): Function;
+/**
+ * Clears the glossary cache
+ * Useful for testing or when you want to force a reload of glossary data
+ *
+ * @param {string} [filePath] - Optional specific file path to clear. If not provided, clears entire cache.
+ */
+declare function clearGlossaryCache(filePath?: string): void;
+
+interface ValidationError {
+    field: string;
+    message: string;
+    value?: unknown;
+}
+interface ValidationResult {
+    valid: boolean;
+    errors: ValidationError[];
+    data: GlossaryData;
+}
+/**
+ * Validates glossary data structure
+ *
+ * Ensures the glossary data conforms to the expected schema:
+ * - Must be an object with a "terms" array
+ * - Each term must have "term" (string) and "definition" (string)
+ * - Optional fields: abbreviation (string), relatedTerms (string[]), id (string)
+ *
+ * @param data - The data to validate
+ * @param options - Validation options
+ * @param options.throwOnError - If true, throws an error on validation failure (default: true)
+ * @returns Validation result with errors and sanitized data
+ * @throws Error if data is invalid and throwOnError is true
+ */
+declare function validateGlossaryData(data: unknown, options?: {
+    throwOnError?: boolean;
+}): ValidationResult;
+/**
+ * Custom error class for glossary validation errors
+ * Provides detailed error messages for debugging
+ */
+declare class GlossaryValidationError extends Error {
+    readonly errors: ValidationError[];
+    constructor(errors: ValidationError[]);
+}
+/**
+ * Formats validation errors into a readable string
+ *
+ * @param errors - Array of validation errors
+ * @returns Formatted error message
+ */
+declare function formatValidationErrors(errors: ValidationError[]): string;
+
+interface GlossaryPluginOptions {
+    glossaryPath?: string;
+    routePath?: string;
+    autoLinkTerms?: boolean;
+}
+interface GlossaryTerm {
+    term: string;
+    definition: string;
+    abbreviation?: string;
+    relatedTerms?: string[];
+    id?: string;
+    autoLink?: boolean;
+    aliases?: string[];
+}
+interface GlossaryData {
+    title?: string;
+    description?: string;
+    terms: GlossaryTerm[];
+}
+/**
+ * Docusaurus Glossary Plugin
+ *
+ * A plugin that provides glossary functionality with:
+ * - Glossary terms defined in a JSON file
+ * - Auto-generated glossary page with term definitions
+ * - GlossaryTerm component for inline definitions with interactive tooltips
+ * - Automatic client-side initialization via getClientModules() (no manual imports needed)
+ * - Optional automatic glossary term detection in markdown files via remark plugin
+ *
+ * ## Basic Usage (Manual Term Markup)
+ *
+ * Just install the plugin - the GlossaryTerm component is automatically available:
+ * ```javascript
+ * module.exports = {
+ *   plugins: [
+ *     ['docusaurus-plugin-glossary', {
+ *       glossaryPath: 'glossary/glossary.json',
+ *       routePath: '/glossary',
+ *     }],
+ *   ],
+ * };
+ * ```
+ *
+ * Then use `<GlossaryTerm>` in your MDX files without importing:
+ * ```mdx
+ * <GlossaryTerm term="API">API</GlossaryTerm>
+ * ```
+ *
+ * ## Advanced Usage (Automatic Term Detection)
+ *
+ * To automatically detect and link glossary terms in markdown, add the remark plugin:
+ * ```javascript
+ * const glossaryPlugin = require('docusaurus-plugin-glossary');
+ *
+ * module.exports = {
+ *   presets: [
+ *     ['@docusaurus/preset-classic', {
+ *       docs: {
+ *         remarkPlugins: [
+ *           glossaryPlugin.getRemarkPlugin({
+ *             glossaryPath: 'glossary/glossary.json',
+ *             routePath: '/glossary',
+ *           }, { siteDir: __dirname }),
+ *         ],
+ *       },
+ *     }],
+ *   ],
+ *   plugins: [
+ *     ['docusaurus-plugin-glossary', {
+ *       glossaryPath: 'glossary/glossary.json',
+ *       routePath: '/glossary',
+ *     }],
+ *   ],
+ * };
+ * ```
+ *
+ * @param context - Docusaurus context
+ * @param options - Plugin options
+ * @param options.glossaryPath - Path to glossary JSON file (default: 'glossary/glossary.json')
+ * @param options.routePath - Route path for glossary page (default: '/glossary')
+ * @param options.autoLinkTerms - Legacy option, kept for compatibility but no longer used (configure remark plugin manually instead)
+ * @returns Plugin object
+ */
+declare function glossaryPlugin(context: LoadContext, options?: GlossaryPluginOptions): Plugin;
+declare const remarkPlugin: typeof remarkGlossaryTerms;
+
+/**
+ * Helper function to get the configured remark plugin
+ * This can be used in docusaurus.config.js markdown configuration
+ *
+ * @param pluginOptions - Plugin options from docusaurus.config.js
+ * @param context - Context with siteDir
+ * @returns Configured remark plugin
+ */
+declare function getRemarkPlugin(pluginOptions: GlossaryPluginOptions, context?: {
+    siteDir?: string;
+}): [typeof remarkGlossaryTerms, {
+    glossaryPath: string;
+    routePath: string;
+    siteDir?: string;
+}];
+
+export { type GlossaryData, type GlossaryPluginOptions, type GlossaryTerm, GlossaryValidationError, type ValidationError, type ValidationResult, clearGlossaryCache, glossaryPlugin as default, formatValidationErrors, getRemarkPlugin, remarkPlugin, validateGlossaryData };

package/dist/index.d.ts

@@ -1,19 +1,93 @@
-import type { LoadContext, Plugin } from '@docusaurus/types';
-import remarkGlossaryTerms from './remark/glossary-terms.js';
-export interface GlossaryPluginOptions {
+import { LoadContext, Plugin } from '@docusaurus/types';
+
+/**
+ * Creates a remark plugin that automatically detects and replaces glossary terms in markdown
+ *
+ * This plugin transforms plain text terms into <GlossaryTerm> JSX elements.
+ * The GlossaryTerm component is globally available via the MDXComponents theme wrapper,
+ * so no import injection is needed - MDX files can use it without explicit imports.
+ *
+ * @param {object} options - Plugin options
+ * @param {Array} options.terms - Array of glossary term objects with {term, definition}
+ * @param {string} options.glossaryPath - Path to glossary JSON file (optional, if terms not provided)
+ * @param {string} options.routePath - Route path to glossary page (default: '/glossary')
+ * @param {string} options.siteDir - Docusaurus site directory (required if using glossaryPath)
+ * @returns {function} Remark plugin function
+ */
+declare function remarkGlossaryTerms({ terms, glossaryPath, routePath, siteDir, }?: {
+    terms: any[];
+    glossaryPath: string;
+    routePath: string;
+    siteDir: string;
+}): Function;
+/**
+ * Clears the glossary cache
+ * Useful for testing or when you want to force a reload of glossary data
+ *
+ * @param {string} [filePath] - Optional specific file path to clear. If not provided, clears entire cache.
+ */
+declare function clearGlossaryCache(filePath?: string): void;
+
+interface ValidationError {
+    field: string;
+    message: string;
+    value?: unknown;
+}
+interface ValidationResult {
+    valid: boolean;
+    errors: ValidationError[];
+    data: GlossaryData;
+}
+/**
+ * Validates glossary data structure
+ *
+ * Ensures the glossary data conforms to the expected schema:
+ * - Must be an object with a "terms" array
+ * - Each term must have "term" (string) and "definition" (string)
+ * - Optional fields: abbreviation (string), relatedTerms (string[]), id (string)
+ *
+ * @param data - The data to validate
+ * @param options - Validation options
+ * @param options.throwOnError - If true, throws an error on validation failure (default: true)
+ * @returns Validation result with errors and sanitized data
+ * @throws Error if data is invalid and throwOnError is true
+ */
+declare function validateGlossaryData(data: unknown, options?: {
+    throwOnError?: boolean;
+}): ValidationResult;
+/**
+ * Custom error class for glossary validation errors
+ * Provides detailed error messages for debugging
+ */
+declare class GlossaryValidationError extends Error {
+    readonly errors: ValidationError[];
+    constructor(errors: ValidationError[]);
+}
+/**
+ * Formats validation errors into a readable string
+ *
+ * @param errors - Array of validation errors
+ * @returns Formatted error message
+ */
+declare function formatValidationErrors(errors: ValidationError[]): string;
+
+interface GlossaryPluginOptions {
     glossaryPath?: string;
     routePath?: string;
     autoLinkTerms?: boolean;
 }
-export interface GlossaryTerm {
+interface GlossaryTerm {
     term: string;
     definition: string;
     abbreviation?: string;
     relatedTerms?: string[];
     id?: string;
     autoLink?: boolean;
+    aliases?: string[];
 }
-export interface GlossaryData {
+interface GlossaryData {
+    title?: string;
+    description?: string;
     terms: GlossaryTerm[];
 }
 /**
@@ -80,10 +154,9 @@ export interface GlossaryData {
  * @param options.autoLinkTerms - Legacy option, kept for compatibility but no longer used (configure remark plugin manually instead)
  * @returns Plugin object
  */
-export default function glossaryPlugin(context: LoadContext, options?: GlossaryPluginOptions): Plugin;
-export declare const remarkPlugin: typeof remarkGlossaryTerms;
-export { clearGlossaryCache } from './remark/glossary-terms.js';
-export { validateGlossaryData, GlossaryValidationError, formatValidationErrors, type ValidationError, type ValidationResult, } from './validation.js';
+declare function glossaryPlugin(context: LoadContext, options?: GlossaryPluginOptions): Plugin;
+declare const remarkPlugin: typeof remarkGlossaryTerms;
+
 /**
  * Helper function to get the configured remark plugin
  * This can be used in docusaurus.config.js markdown configuration
@@ -92,11 +165,12 @@ export { validateGlossaryData, GlossaryValidationError, formatValidationErrors,
  * @param context - Context with siteDir
  * @returns Configured remark plugin
  */
-export declare function getRemarkPlugin(pluginOptions: GlossaryPluginOptions, context?: {
+declare function getRemarkPlugin(pluginOptions: GlossaryPluginOptions, context?: {
     siteDir?: string;
 }): [typeof remarkGlossaryTerms, {
     glossaryPath: string;
     routePath: string;
     siteDir?: string;
 }];
-//# sourceMappingURL=index.d.ts.map
+
+export { type GlossaryData, type GlossaryPluginOptions, type GlossaryTerm, GlossaryValidationError, type ValidationError, type ValidationResult, clearGlossaryCache, glossaryPlugin as default, formatValidationErrors, getRemarkPlugin, remarkPlugin, validateGlossaryData };

package/dist/index.js

@@ -1,173 +1,23 @@
-import path from 'path';
-import { fileURLToPath } from 'url';
-import fs from 'fs-extra';
-import validatePeerDependencies from 'validate-peer-dependencies';
-import remarkGlossaryTerms from './remark/glossary-terms.js';
-import { validateGlossaryData, GlossaryValidationError } from './validation.js';
-// Standard ES module directory resolution
-const currentFilePath = fileURLToPath(import.meta.url);
-const currentDir = path.dirname(currentFilePath);
-// Validate peer dependencies at module load time
-validatePeerDependencies(currentDir);
-/**
- * Docusaurus Glossary Plugin
- *
- * A plugin that provides glossary functionality with:
- * - Glossary terms defined in a JSON file
- * - Auto-generated glossary page with term definitions
- * - GlossaryTerm component for inline definitions with interactive tooltips
- * - Automatic client-side initialization via getClientModules() (no manual imports needed)
- * - Optional automatic glossary term detection in markdown files via remark plugin
- *
- * ## Basic Usage (Manual Term Markup)
- *
- * Just install the plugin - the GlossaryTerm component is automatically available:
- * ```javascript
- * module.exports = {
- *   plugins: [
- *     ['docusaurus-plugin-glossary', {
- *       glossaryPath: 'glossary/glossary.json',
- *       routePath: '/glossary',
- *     }],
- *   ],
- * };
- * ```
- *
- * Then use `<GlossaryTerm>` in your MDX files without importing:
- * ```mdx
- * <GlossaryTerm term="API">API</GlossaryTerm>
- * ```
- *
- * ## Advanced Usage (Automatic Term Detection)
- *
- * To automatically detect and link glossary terms in markdown, add the remark plugin:
- * ```javascript
- * const glossaryPlugin = require('docusaurus-plugin-glossary');
- *
- * module.exports = {
- *   presets: [
- *     ['@docusaurus/preset-classic', {
- *       docs: {
- *         remarkPlugins: [
- *           glossaryPlugin.getRemarkPlugin({
- *             glossaryPath: 'glossary/glossary.json',
- *             routePath: '/glossary',
- *           }, { siteDir: __dirname }),
- *         ],
- *       },
- *     }],
- *   ],
- *   plugins: [
- *     ['docusaurus-plugin-glossary', {
- *       glossaryPath: 'glossary/glossary.json',
- *       routePath: '/glossary',
- *     }],
- *   ],
- * };
- * ```
- *
- * @param context - Docusaurus context
- * @param options - Plugin options
- * @param options.glossaryPath - Path to glossary JSON file (default: 'glossary/glossary.json')
- * @param options.routePath - Route path for glossary page (default: '/glossary')
- * @param options.autoLinkTerms - Legacy option, kept for compatibility but no longer used (configure remark plugin manually instead)
- * @returns Plugin object
- */
-export default function glossaryPlugin(context, options = {}) {
-    const { glossaryPath = 'glossary/glossary.json', routePath = '/glossary' } = options;
-    return {
-        name: 'docusaurus-plugin-glossary',
-        getClientModules() {
-            return [path.resolve(currentDir, './client/index.js')];
-        },
-        async loadContent() {
-            // Load glossary terms from JSON file
-            const glossaryFilePath = path.resolve(context.siteDir, glossaryPath);
-            if (await fs.pathExists(glossaryFilePath)) {
-                try {
-                    const rawData = await fs.readJson(glossaryFilePath);
-                    // Validate glossary data structure
-                    const validationResult = validateGlossaryData(rawData, { throwOnError: false });
-                    if (!validationResult.valid) {
-                        console.warn(`[glossary-plugin] Glossary file has validation errors at ${glossaryFilePath}:`);
-                        validationResult.errors.forEach(err => {
-                            console.warn(`  - [${err.field}] ${err.message}`);
-                        });
-                        console.warn('[glossary-plugin] Proceeding with valid terms only.');
-                    }
-                    return validationResult.data;
-                }
-                catch (error) {
-                    if (error instanceof GlossaryValidationError) {
-                        throw error;
-                    }
-                    // JSON parsing error
-                    throw new Error(`Failed to parse glossary file at ${glossaryFilePath}: ${error instanceof Error ? error.message : String(error)}`);
-                }
-            }
-            console.warn(`Glossary file not found at ${glossaryFilePath}. Using empty glossary.`);
-            return { terms: [] };
-        },
-        async contentLoaded({ content, actions }) {
-            const { createData, addRoute, setGlobalData } = actions;
-            const glossaryContent = content;
-            // Create data file that can be imported by components
-            const glossaryDataPath = await createData('glossary-data.json', JSON.stringify(glossaryContent));
-            // Create a data file for the remark plugin to access glossary terms
-            await createData('remark-glossary-data.json', JSON.stringify({
-                terms: glossaryContent.terms || [],
-                routePath: routePath,
-            }));
-            // Add glossary page route
-            addRoute({
-                path: routePath,
-                component: path.join(currentDir, 'components/GlossaryPage.js'),
-                exact: true,
-                modules: {
-                    glossaryData: glossaryDataPath,
-                },
-            });
-            // Expose global data for runtime lookups (used by GlossaryTerm)
-            setGlobalData({
-                terms: glossaryContent.terms || [],
-                routePath,
-            });
-        },
-        getThemePath() {
-            return path.resolve(currentDir, './theme');
-        },
-        getPathsToWatch() {
-            return [path.resolve(context.siteDir, glossaryPath)];
-        },
-        async postBuild() {
-            // You can add any post-build steps here if needed
-            console.log('Glossary plugin: Build completed');
-        },
-    };
-}
-// Export remark plugin factory for use in markdown configuration
-export const remarkPlugin = remarkGlossaryTerms;
-// Export cache clearing utility
-export { clearGlossaryCache } from './remark/glossary-terms.js';
-// Export validation utilities
-export { validateGlossaryData, GlossaryValidationError, formatValidationErrors, } from './validation.js';
-/**
- * Helper function to get the configured remark plugin
- * This can be used in docusaurus.config.js markdown configuration
- *
- * @param pluginOptions - Plugin options from docusaurus.config.js
- * @param context - Context with siteDir
- * @returns Configured remark plugin
- */
-export function getRemarkPlugin(pluginOptions, context) {
-    const { glossaryPath = 'glossary/glossary.json', routePath = '/glossary' } = pluginOptions;
-    const siteDir = context === null || context === void 0 ? void 0 : context.siteDir;
-    return [
-        remarkGlossaryTerms,
-        {
-            glossaryPath,
-            routePath,
-            siteDir,
-        },
-    ];
-}
+import {
+  getRemarkPlugin,
+  glossaryPlugin,
+  remarkPlugin
+} from "./chunk-22LFZL7L.js";
+import {
+  GlossaryValidationError,
+  formatValidationErrors,
+  validateGlossaryData
+} from "./chunk-7Z37JEHW.js";
+import {
+  clearGlossaryCache
+} from "./chunk-WYKSBP3X.js";
+export {
+  GlossaryValidationError,
+  clearGlossaryCache,
+  glossaryPlugin as default,
+  formatValidationErrors,
+  getRemarkPlugin,
+  remarkPlugin,
+  validateGlossaryData
+};
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":[],"sourcesContent":[],"mappings":"","names":[]}