@graphql-markdown/docusaurus 1.30.3 → 1.31.1

package/dist/index.d.ts

@@ -4,3 +4,5 @@ import type { GraphQLMarkdownCliOptions } from "@graphql-markdown/types";
  *
  */
 export default function pluginGraphQLDocGenerator(_: LoadContext, options: GraphQLMarkdownCliOptions & Partial<PluginOptions>): Promise<Plugin>;
+export { createMDXFormatter } from "./mdx";
+//# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -0,0 +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"}

package/dist/index.js

@@ -3,6 +3,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.createMDXFormatter = void 0;
 exports.default = pluginGraphQLDocGenerator;
 const utils_1 = require("@docusaurus/utils");
 const cli_1 = require("@graphql-markdown/cli");
@@ -46,3 +47,5 @@ async function pluginGraphQLDocGenerator(_, options) {
         },
     };
 }
+const mdx_1 = require("./mdx");
+Object.defineProperty(exports, "createMDXFormatter", { enumerable: true, get: function () { return mdx_1.createMDXFormatter; } });

package/dist/mdx/category.d.ts

@@ -2,5 +2,11 @@
  * @module mdx
  * This module provides utilities for generating MDX index files in Docusaurus format.
  */
-import type { GenerateIndexMetafileType } from "@graphql-markdown/types";
-export declare const generateIndexMetafile: GenerateIndexMetafileType;
+export declare const beforeGenerateIndexMetafileHook: (event: {
+    data: {
+        dirPath: string;
+        category: string;
+        options?: Record<string, unknown> | undefined;
+    };
+}) => Promise<void>;
+//# sourceMappingURL=category.d.ts.map

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

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

package/dist/mdx/category.js

@@ -4,7 +4,7 @@
  * This module provides utilities for generating MDX index files in Docusaurus format.
  */
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.generateIndexMetafile = void 0;
+exports.beforeGenerateIndexMetafileHook = void 0;
 const node_path_1 = require("node:path");
 const utils_1 = require("@graphql-markdown/utils");
 const CATEGORY_YAML = "_category_.yml";
@@ -13,15 +13,18 @@ var SidebarPosition;
     SidebarPosition[SidebarPosition["FIRST"] = 1] = "FIRST";
     SidebarPosition[SidebarPosition["LAST"] = 999] = "LAST";
 })(SidebarPosition || (SidebarPosition = {}));
-const generateIndexMetafile = async (dirPath, category, options) => {
+const beforeGenerateIndexMetafileHook = async (event) => {
+    const { dirPath, category, options } = event.data;
     const filePath = (0, node_path_1.join)(dirPath, CATEGORY_YAML);
     if (await (0, utils_1.fileExists)(filePath)) {
         return;
     }
     const label = (0, utils_1.startCase)(category);
-    const link = options?.index !== true
-        ? "null"
-        : `\n  type: generated-index\n  title: '${label} overview'`;
+    // Docusaurus 3.x uses the directory name as the id automatically
+    // No need to explicitly set id field in _category_.yml
+    const link = options?.index === true
+        ? `\n  type: generated-index\n  title: '${label} overview'`
+        : "null";
     const className = typeof options?.styleClass === "string"
         ? `className: ${options.styleClass}\n`
         : "";
@@ -32,4 +35,4 @@ const generateIndexMetafile = async (dirPath, category, options) => {
     await (0, utils_1.ensureDir)(dirPath);
     await (0, utils_1.saveFile)(filePath, content);
 };
-exports.generateIndexMetafile = generateIndexMetafile;
+exports.beforeGenerateIndexMetafileHook = beforeGenerateIndexMetafileHook;

package/dist/mdx/components.d.ts

@@ -4,3 +4,4 @@
  */
 import type { MDXString } from "@graphql-markdown/types";
 export declare const mdxDeclaration: MDXString;
+//# sourceMappingURL=components.d.ts.map

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

@@ -0,0 +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"}

package/dist/mdx/index.d.ts

@@ -6,9 +6,14 @@
  *
  * @primaryExport
  */
-import type { AdmonitionType, Badge, CollapsibleOption, Maybe, MDXString, MetaOptions, TypeLink } from "@graphql-markdown/types";
+import type { AdmonitionType, Badge, CollapsibleOption, Formatter, FrontMatterOptions, Maybe, MDXString, MetaInfo, TypeLink } from "@graphql-markdown/types";
 export { mdxDeclaration } from "./components";
-export { generateIndexMetafile } from "./category";
+export { beforeGenerateIndexMetafileHook } from "./category";
+/**
+ * Formats a Badge inline-block in MDX format
+ * @param param - The badge configuration object
+ * @returns Formatted MDX string for the badge
+ */
 export declare const formatMDXBadge: ({ text, classname }: Badge) => MDXString;
 /**
  * Formats an admonition block in MDX format
@@ -16,7 +21,7 @@ export declare const formatMDXBadge: ({ text, classname }: Badge) => MDXString;
  * @param meta - Optional metadata for generator configuration
  * @returns Formatted MDX string for the admonition
  */
-export declare const formatMDXAdmonition: ({ text, title, type }: AdmonitionType, meta: Maybe<MetaOptions>) => MDXString;
+export declare const formatMDXAdmonition: ({ text, title, type }: AdmonitionType, meta: Maybe<MetaInfo>) => MDXString;
 /**
  * Creates a bullet point element in MDX format
  * @param text - Optional text to append after the bullet point
@@ -42,4 +47,38 @@ export declare const formatMDXSpecifiedByLink: (url: string) => MDXString;
  * @returns Formatted MDX string for the name entity
  */
 export declare const formatMDXNameEntity: (name: string, parentType?: Maybe<string>) => MDXString;
+/**
+ * Formats a link in MDX format
+ * @param param - The link configuration object
+ * @returns Formatted MDX link object
+ */
 export declare const formatMDXLink: ({ text, url }: TypeLink) => TypeLink;
+/**
+ * Default frontmatter formatter for MDX.
+ *
+ * @param _props - The front matter options (unused)
+ * @param formatted - The formatted front matter as an array of strings
+ * @returns Formatted MDX string for the front matter
+ */
+export declare const formatMDXFrontmatter: (_props: Maybe<FrontMatterOptions>, formatted: Maybe<string[]>) => MDXString;
+/**
+ * Creates an MDX formatter for Docusaurus documentation.
+ *
+ * The MDX formatter produces React component-based markup compatible
+ * with Docusaurus MDX rendering. It uses components like `<Badge>`,
+ * `<Bullet>`, `<Details>`, and `<SpecifiedBy>`.
+ *
+ * @param meta - Optional metadata for framework-specific formatting
+ * @returns A complete Formatter implementation for MDX output
+ *
+ * @example
+ * ```typescript
+ * import { createMDXFormatter } from '@graphql-markdown/docusaurus';
+ *
+ * const formatter = createMDXFormatter({ generatorFrameworkName: 'docusaurus' });
+ * const badge = formatter.formatMDXBadge({ text: 'Required' });
+ * // '<Badge class="badge badge--secondary " text="Required"/>'
+ * ```
+ */
+export declare const createMDXFormatter: (meta?: Maybe<MetaInfo>) => Formatter;
+//# sourceMappingURL=index.d.ts.map

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

@@ -0,0 +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"}

package/dist/mdx/index.js

@@ -8,16 +8,19 @@
  * @primaryExport
  */
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.formatMDXLink = exports.formatMDXNameEntity = exports.formatMDXSpecifiedByLink = exports.formatMDXDetails = exports.formatMDXBullet = exports.formatMDXAdmonition = exports.formatMDXBadge = exports.generateIndexMetafile = exports.mdxDeclaration = void 0;
+exports.createMDXFormatter = exports.formatMDXFrontmatter = exports.formatMDXLink = exports.formatMDXNameEntity = exports.formatMDXSpecifiedByLink = exports.formatMDXDetails = exports.formatMDXBullet = exports.formatMDXAdmonition = exports.formatMDXBadge = exports.beforeGenerateIndexMetafileHook = exports.mdxDeclaration = void 0;
 const utils_1 = require("@graphql-markdown/utils");
-const MARKDOWN_EOL = "\n";
-const MARKDOWN_EOP = `${MARKDOWN_EOL.repeat(2)}`;
 const LINK_MDX_EXTENSION = ".mdx";
 const DEFAULT_CSS_CLASSNAME = "badge--secondary";
-var components_1 = require("./components");
+const components_1 = require("./components");
 Object.defineProperty(exports, "mdxDeclaration", { enumerable: true, get: function () { return components_1.mdxDeclaration; } });
-var category_1 = require("./category");
-Object.defineProperty(exports, "generateIndexMetafile", { enumerable: true, get: function () { return category_1.generateIndexMetafile; } });
+const category_1 = require("./category");
+Object.defineProperty(exports, "beforeGenerateIndexMetafileHook", { enumerable: true, get: function () { return category_1.beforeGenerateIndexMetafileHook; } });
+/**
+ * Formats a Badge inline-block in MDX format
+ * @param param - The badge configuration object
+ * @returns Formatted MDX string for the badge
+ */
 const formatMDXBadge = ({ text, classname }) => {
     const style = typeof classname === "string" ? `badge--${classname.toLowerCase()}` : "";
     return `<Badge class="badge ${DEFAULT_CSS_CLASSNAME} ${style}" text="${text}"/>`;
@@ -33,9 +36,9 @@ const formatMDXAdmonition = ({ text, title, type }, meta) => {
     const isDocusaurus = meta?.generatorFrameworkName === "docusaurus";
     if (isDocusaurus && meta.generatorFrameworkVersion?.startsWith("2")) {
         const oldType = type === "warning" ? "caution" : type;
-        return `${MARKDOWN_EOP}:::${oldType} ${title}${text}:::`;
+        return `${utils_1.MARKDOWN_EOP}:::${oldType} ${title}${text}:::`;
     }
-    return `${MARKDOWN_EOP}:::${type}[${title}]${text}:::`;
+    return `${utils_1.MARKDOWN_EOP}:::${type}[${title}]${text}:::`;
 };
 exports.formatMDXAdmonition = formatMDXAdmonition;
 /**
@@ -53,7 +56,7 @@ exports.formatMDXBullet = formatMDXBullet;
  * @returns Formatted MDX string for the collapsible section
  */
 const formatMDXDetails = ({ dataOpen, dataClose, }) => {
-    return `${MARKDOWN_EOP}<Details dataOpen="Hide ${dataOpen}" dataClose="Show ${dataClose}">${MARKDOWN_EOP}\r${MARKDOWN_EOP}</Details>${MARKDOWN_EOP}`;
+    return `${utils_1.MARKDOWN_EOP}<Details dataOpen="Hide ${dataOpen}" dataClose="Show ${dataClose}">${utils_1.MARKDOWN_EOP}\r${utils_1.MARKDOWN_EOP}</Details>${utils_1.MARKDOWN_EOP}`;
 };
 exports.formatMDXDetails = formatMDXDetails;
 /**
@@ -76,6 +79,11 @@ const formatMDXNameEntity = (name, parentType) => {
     return `<code style={{ fontWeight: 'normal' }}>${(0, utils_1.escapeMDX)(parentName)}<b>${(0, utils_1.escapeMDX)(name)}</b></code>`;
 };
 exports.formatMDXNameEntity = formatMDXNameEntity;
+/**
+ * Formats a link in MDX format
+ * @param param - The link configuration object
+ * @returns Formatted MDX link object
+ */
 const formatMDXLink = ({ text, url }) => {
     return {
         text,
@@ -83,3 +91,46 @@ const formatMDXLink = ({ text, url }) => {
     };
 };
 exports.formatMDXLink = formatMDXLink;
+/**
+ * Default frontmatter formatter for MDX.
+ *
+ * @param _props - The front matter options (unused)
+ * @param formatted - The formatted front matter as an array of strings
+ * @returns Formatted MDX string for the front matter
+ */
+const formatMDXFrontmatter = (_props, formatted) => {
+    return formatted
+        ? [utils_1.FRONT_MATTER_DELIMITER, ...formatted, utils_1.FRONT_MATTER_DELIMITER].join(utils_1.MARKDOWN_EOL)
+        : "";
+};
+exports.formatMDXFrontmatter = formatMDXFrontmatter;
+/**
+ * Creates an MDX formatter for Docusaurus documentation.
+ *
+ * The MDX formatter produces React component-based markup compatible
+ * with Docusaurus MDX rendering. It uses components like `<Badge>`,
+ * `<Bullet>`, `<Details>`, and `<SpecifiedBy>`.
+ *
+ * @param meta - Optional metadata for framework-specific formatting
+ * @returns A complete Formatter implementation for MDX output
+ *
+ * @example
+ * ```typescript
+ * import { createMDXFormatter } from '@graphql-markdown/docusaurus';
+ *
+ * const formatter = createMDXFormatter({ generatorFrameworkName: 'docusaurus' });
+ * const badge = formatter.formatMDXBadge({ text: 'Required' });
+ * // '<Badge class="badge badge--secondary " text="Required"/>'
+ * ```
+ */
+const createMDXFormatter = (meta) => ({
+    formatMDXBadge: exports.formatMDXBadge,
+    formatMDXAdmonition: (admonition, _meta) => (0, exports.formatMDXAdmonition)(admonition, meta ?? _meta),
+    formatMDXBullet: exports.formatMDXBullet,
+    formatMDXDetails: exports.formatMDXDetails,
+    formatMDXFrontmatter: exports.formatMDXFrontmatter,
+    formatMDXLink: exports.formatMDXLink,
+    formatMDXNameEntity: exports.formatMDXNameEntity,
+    formatMDXSpecifiedByLink: exports.formatMDXSpecifiedByLink,
+});
+exports.createMDXFormatter = createMDXFormatter;

package/package.json

@@ -5,7 +5,7 @@
   "bugs": {
     "url": "https://github.com/graphql-markdown/graphql-markdown/issues"
   },
-  "version": "1.30.3",
+  "version": "1.31.1",
   "license": "MIT",
   "repository": {
     "type": "git",
@@ -58,21 +58,20 @@
     "./package.json": "./package.json"
   },
   "scripts": {
-    "prepack": "pinst --disable",
-    "postpack": "pinst --enable",
     "stryker": "stryker run",
-    "clean": "rm -rf ./dist",
-    "docs": "typedoc"
+    "clean": "tsgo --build --clean && rm -rf ./dist",
+    "docs": "typedoc",
+    "build": "tsgo --build"
   },
   "dependencies": {
-    "@graphql-markdown/cli": "^0.4.3",
+    "@graphql-markdown/cli": "^0.5.0",
     "@graphql-markdown/logger": "^1.0.5",
-    "@graphql-markdown/utils": "^1.9.0",
-    "@docusaurus/utils": ">=3.2.0"
+    "@graphql-markdown/utils": "^1.9.1",
+    "@docusaurus/utils": ">=3.9.2"
   },
   "devDependencies": {
     "@docusaurus/types": "^3.7.0",
-    "@graphql-markdown/types": "^1.8.0"
+    "@graphql-markdown/types": "^1.9.0"
   },
   "peerDependencies": {
     "@docusaurus/logger": "*"
@@ -81,11 +80,12 @@
     "test": "tests"
   },
   "engines": {
-    "node": ">=16.14"
+    "node": ">=20"
   },
   "publishConfig": {
     "directory": "dist",
-    "access": "public"
+    "access": "public",
+    "scripts": {}
   },
   "typescript": {
     "definition": "dist/index.d.ts"