@graphql-markdown/docusaurus 1.31.2 → 1.33.0

package/dist/index.d.ts

@@ -1,7 +1,18 @@
+/**
+ * Docusaurus integration for running GraphQL-Markdown and wiring CLI commands.
+ *
+ * @packageDocumentation
+ */
 import type { LoadContext, Plugin, PluginOptions } from "@docusaurus/types";
 import type { GraphQLMarkdownCliOptions } from "@graphql-markdown/types";
 /**
+ * Docusaurus plugin wrapper that wires GraphQL-Markdown into the build,
+ * optionally running the CLI during `docusaurus build` and registering
+ * the `graphql-to-doc` command on the local CLI.
  *
+ * @param _ - Load context (unused).
+ * @param options - GraphQL-Markdown CLI options plus Docusaurus plugin options.
+ * @returns A configured Docusaurus plugin instance.
  */
 export default function pluginGraphQLDocGenerator(_: LoadContext, options: GraphQLMarkdownCliOptions & Partial<PluginOptions>): Promise<Plugin>;
 export { createMDXFormatter } from "./mdx";

package/dist/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,EAAE,aAAa,EAAE,MAAM,mBAAmB,CAAC;AAC5E,OAAO,KAAK,EAAE,yBAAyB,EAAE,MAAM,yBAAyB,CAAC;AAczE;;GAEG;AACH,wBAA8B,yBAAyB,CACrD,CAAC,EAAE,WAAW,EACd,OAAO,EAAE,yBAAyB,GAAG,OAAO,CAAC,aAAa,CAAC,GAC1D,OAAO,CAAC,MAAM,CAAC,CAyCjB;AAED,OAAO,EAAE,kBAAkB,EAAE,MAAM,OAAO,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAEH,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,EAAE,aAAa,EAAE,MAAM,mBAAmB,CAAC;AAC5E,OAAO,KAAK,EAAE,yBAAyB,EAAE,MAAM,yBAAyB,CAAC;AAczE;;;;;;;;GAQG;AACH,wBAA8B,yBAAyB,CACrD,CAAC,EAAE,WAAW,EACd,OAAO,EAAE,yBAAyB,GAAG,OAAO,CAAC,aAAa,CAAC,GAC1D,OAAO,CAAC,MAAM,CAAC,CAyCjB;AAED,OAAO,EAAE,kBAAkB,EAAE,MAAM,OAAO,CAAC"}

package/dist/index.js

@@ -12,7 +12,13 @@ const NAME = "docusaurus-graphql-doc-generator";
 const LOGGER_MODULE = "@docusaurus/logger";
 const MDX_PACKAGE = "@graphql-markdown/docusaurus/mdx";
 /**
+ * Docusaurus plugin wrapper that wires GraphQL-Markdown into the build,
+ * optionally running the CLI during `docusaurus build` and registering
+ * the `graphql-to-doc` command on the local CLI.
  *
+ * @param _ - Load context (unused).
+ * @param options - GraphQL-Markdown CLI options plus Docusaurus plugin options.
+ * @returns A configured Docusaurus plugin instance.
  */
 async function pluginGraphQLDocGenerator(_, options) {
     await (0, logger_1.default)(LOGGER_MODULE);
@@ -43,7 +49,7 @@ async function pluginGraphQLDocGenerator(_, options) {
                     generatorFrameworkVersion: utils_1.DOCUSAURUS_VERSION,
                     ...options.docOptions,
                 },
-            }, LOGGER_MODULE, MDX_PACKAGE));
+            }, LOGGER_MODULE, options.mdxParser ?? MDX_PACKAGE));
         },
     };
 }

package/dist/mdx/category.d.ts

@@ -1,6 +1,15 @@
 /**
  * @module mdx
  * This module provides utilities for generating MDX index files in Docusaurus format.
+ *
+ * @packageDocumentation
+ */
+/**
+ * Hook that materializes a `_category_.yml` file before Docusaurus indexes
+ * a directory, ensuring generated bundles have labels, ordering, and
+ * optional generated-index metadata even when the folder was produced by the CLI.
+ *
+ * @param event - Hook payload containing the target directory, category name, and generator options.
  */
 export declare const beforeGenerateIndexMetafileHook: (event: {
     data: {

package/dist/mdx/category.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"category.d.ts","sourceRoot":"","sources":["../../src/mdx/category.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAkBH,eAAO,MAAM,+BAA+B;;;;;;mBAiC3C,CAAC"}
+{"version":3,"file":"category.d.ts","sourceRoot":"","sources":["../../src/mdx/category.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAkBH;;;;;;GAMG;AACH,eAAO,MAAM,+BAA+B;;;;;;mBAiC3C,CAAC"}

package/dist/mdx/category.js

@@ -2,6 +2,8 @@
 /**
  * @module mdx
  * This module provides utilities for generating MDX index files in Docusaurus format.
+ *
+ * @packageDocumentation
  */
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.beforeGenerateIndexMetafileHook = void 0;
@@ -13,6 +15,13 @@ var SidebarPosition;
     SidebarPosition[SidebarPosition["FIRST"] = 1] = "FIRST";
     SidebarPosition[SidebarPosition["LAST"] = 999] = "LAST";
 })(SidebarPosition || (SidebarPosition = {}));
+/**
+ * Hook that materializes a `_category_.yml` file before Docusaurus indexes
+ * a directory, ensuring generated bundles have labels, ordering, and
+ * optional generated-index metadata even when the folder was produced by the CLI.
+ *
+ * @param event - Hook payload containing the target directory, category name, and generator options.
+ */
 const beforeGenerateIndexMetafileHook = async (event) => {
     const { dirPath, category, options } = event.data;
     const filePath = (0, node_path_1.join)(dirPath, CATEGORY_YAML);

package/dist/mdx/components.d.ts

@@ -3,5 +3,16 @@
  * This module provides MDX React components.
  */
 import type { MDXString } from "@graphql-markdown/types";
+/**
+ * MDX helper components injected into generated documents so Docusaurus
+ * can render badges, bullets, details, and SpecifiedBy links without
+ * requiring manual component registration in every project.
+ *
+ * @packageDocumentation
+ */
+/**
+ * String literal that declares the React helpers (`Bullet`, `SpecifiedBy`, etc.)
+ * which GraphQL-Markdown prepends to every generated MDX file.
+ */
 export declare const mdxDeclaration: MDXString;
 //# sourceMappingURL=components.d.ts.map

package/dist/mdx/components.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"components.d.ts","sourceRoot":"","sources":["../../src/mdx/components.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,yBAAyB,CAAC;AAEzD,eAAO,MAAM,cAAc,EAAE,SA4Bf,CAAC"}
+{"version":3,"file":"components.d.ts","sourceRoot":"","sources":["../../src/mdx/components.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,yBAAyB,CAAC;AAEzD;;;;;;GAMG;AAEH;;;GAGG;AACH,eAAO,MAAM,cAAc,EAAE,SA4Bf,CAAC"}

package/dist/mdx/components.js

@@ -5,6 +5,17 @@
  */
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.mdxDeclaration = void 0;
+/**
+ * MDX helper components injected into generated documents so Docusaurus
+ * can render badges, bullets, details, and SpecifiedBy links without
+ * requiring manual component registration in every project.
+ *
+ * @packageDocumentation
+ */
+/**
+ * String literal that declares the React helpers (`Bullet`, `SpecifiedBy`, etc.)
+ * which GraphQL-Markdown prepends to every generated MDX file.
+ */
 exports.mdxDeclaration = `
 export const Bullet = () => <><span style={{ fontWeight: 'normal', fontSize: '.5em', color: 'var(--ifm-color-secondary-darkest)' }}>&nbsp;●&nbsp;</span></>
 

package/dist/mdx/index.d.ts

@@ -5,6 +5,7 @@
  * specification links, and other MDX-specific formatting for GraphQL documentation.
  *
  * @primaryExport
+ * @packageDocumentation
  */
 import type { AdmonitionType, Badge, CollapsibleOption, Formatter, FrontMatterOptions, Maybe, MDXString, MetaInfo, TypeLink } from "@graphql-markdown/types";
 export { mdxDeclaration } from "./components";

package/dist/mdx/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/mdx/index.ts"],"names":[],"mappings":"AAAA;;;;;;;GAOG;AAEH,OAAO,KAAK,EACV,cAAc,EACd,KAAK,EACL,iBAAiB,EACjB,SAAS,EACT,kBAAkB,EAClB,KAAK,EACL,SAAS,EACT,QAAQ,EACR,QAAQ,EACT,MAAM,yBAAyB,CAAC;AAWjC,OAAO,EAAE,cAAc,EAAE,MAAM,cAAc,CAAC;AAC9C,OAAO,EAAE,+BAA+B,EAAE,MAAM,YAAY,CAAC;AAE7D;;;;GAIG;AACH,eAAO,MAAM,cAAc,2CAI1B,CAAC;AAEF;;;;;GAKG;AACH,eAAO,MAAM,mBAAmB,6EAU/B,CAAC;AAEF;;;;GAIG;AACH,eAAO,MAAM,eAAe,8BAE3B,CAAC;AAEF;;;;GAIG;AACH,eAAO,MAAM,gBAAgB,4DAK5B,CAAC;AAEF;;;;GAIG;AACH,eAAO,MAAM,wBAAwB,4BAEpC,CAAC;AAEF;;;;;GAKG;AACH,eAAO,MAAM,mBAAmB,yDAM/B,CAAC;AAEF;;;;GAIG;AACH,eAAO,MAAM,aAAa,uCAKzB,CAAC;AAEF;;;;;;GAMG;AACH,eAAO,MAAM,oBAAoB,8EAShC,CAAC;AAEF;;;;;;;;;;;;;;;;;;GAkBG;AACH,eAAO,MAAM,kBAAkB,uCAU7B,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/mdx/index.ts"],"names":[],"mappings":"AAAA;;;;;;;;GAQG;AAEH,OAAO,KAAK,EACV,cAAc,EACd,KAAK,EACL,iBAAiB,EACjB,SAAS,EACT,kBAAkB,EAClB,KAAK,EACL,SAAS,EACT,QAAQ,EACR,QAAQ,EACT,MAAM,yBAAyB,CAAC;AAWjC,OAAO,EAAE,cAAc,EAAE,MAAM,cAAc,CAAC;AAC9C,OAAO,EAAE,+BAA+B,EAAE,MAAM,YAAY,CAAC;AAE7D;;;;GAIG;AACH,eAAO,MAAM,cAAc,2CAI1B,CAAC;AAEF;;;;;GAKG;AACH,eAAO,MAAM,mBAAmB,6EAU/B,CAAC;AAEF;;;;GAIG;AACH,eAAO,MAAM,eAAe,8BAE3B,CAAC;AAEF;;;;GAIG;AACH,eAAO,MAAM,gBAAgB,4DAK5B,CAAC;AAEF;;;;GAIG;AACH,eAAO,MAAM,wBAAwB,4BAEpC,CAAC;AAEF;;;;;GAKG;AACH,eAAO,MAAM,mBAAmB,yDAM/B,CAAC;AAEF;;;;GAIG;AACH,eAAO,MAAM,aAAa,uCAKzB,CAAC;AAEF;;;;;;GAMG;AACH,eAAO,MAAM,oBAAoB,8EAShC,CAAC;AAEF;;;;;;;;;;;;;;;;;;GAkBG;AACH,eAAO,MAAM,kBAAkB,uCAU7B,CAAC"}

package/dist/mdx/index.js

@@ -6,6 +6,7 @@
  * specification links, and other MDX-specific formatting for GraphQL documentation.
  *
  * @primaryExport
+ * @packageDocumentation
  */
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.createMDXFormatter = exports.formatMDXFrontmatter = exports.formatMDXLink = exports.formatMDXNameEntity = exports.formatMDXSpecifiedByLink = exports.formatMDXDetails = exports.formatMDXBullet = exports.formatMDXAdmonition = exports.formatMDXBadge = exports.beforeGenerateIndexMetafileHook = exports.mdxDeclaration = void 0;

package/package.json

@@ -5,7 +5,7 @@
   "bugs": {
     "url": "https://github.com/graphql-markdown/graphql-markdown/issues"
   },
-  "version": "1.31.2",
+  "version": "1.33.0",
   "license": "MIT",
   "repository": {
     "type": "git",
@@ -64,14 +64,14 @@
     "build": "tsgo --build"
   },
   "dependencies": {
-    "@graphql-markdown/cli": "^0.5.0",
+    "@graphql-markdown/cli": "^0.6.1",
     "@graphql-markdown/logger": "^1.0.5",
-    "@graphql-markdown/utils": "^1.9.1",
+    "@graphql-markdown/utils": "^1.9.2",
     "@docusaurus/utils": ">=3.9.2"
   },
   "devDependencies": {
     "@docusaurus/types": "^3.7.0",
-    "@graphql-markdown/types": "^1.9.0"
+    "@graphql-markdown/types": "^1.10.1"
   },
   "peerDependencies": {
     "@docusaurus/logger": "*"
@@ -83,9 +83,7 @@
     "node": ">=20"
   },
   "publishConfig": {
-    "directory": "dist",
-    "access": "public",
-    "scripts": {}
+    "access": "public"
   },
   "typescript": {
     "definition": "dist/index.d.ts"