@graphql-markdown/docusaurus 1.27.0 → 1.29.0

package/dist/index.d.ts

@@ -1,3 +1,3 @@
 import type { LoadContext, Plugin, PluginOptions } from "@docusaurus/types";
-import type { ConfigOptions, ExperimentalConfigOptions } from "@graphql-markdown/types";
-export default function pluginGraphQLDocGenerator(_: LoadContext, options: ConfigOptions & ExperimentalConfigOptions & Partial<PluginOptions>): Promise<Plugin>;
+import type { GraphQLMarkdownCliOptions } from "@graphql-markdown/types";
+export default function pluginGraphQLDocGenerator(_: LoadContext, options: GraphQLMarkdownCliOptions & Partial<PluginOptions>): Promise<Plugin>;

package/dist/index.js

@@ -5,68 +5,29 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.default = pluginGraphQLDocGenerator;
 const utils_1 = require("@docusaurus/utils");
-const core_1 = require("@graphql-markdown/core");
+const cli_1 = require("@graphql-markdown/cli");
 const logger_1 = __importDefault(require("@graphql-markdown/logger"));
 const NAME = "docusaurus-graphql-doc-generator";
-const COMMAND = "graphql-to-doc";
-const DESCRIPTION = "Generate GraphQL Schema Documentation";
-const DEFAULT_ID = "default";
 const LOGGER_MODULE = "@docusaurus/logger";
+const MDX_PACKAGE = "@graphql-markdown/docusaurus/mdx";
 async function pluginGraphQLDocGenerator(_, options) {
     await (0, logger_1.default)(LOGGER_MODULE);
-    const isDefaultId = options.id === DEFAULT_ID;
-    const command = isDefaultId ? COMMAND : `${COMMAND}:${options.id}`;
-    const description = isDefaultId
-        ? DESCRIPTION
-        : `${DESCRIPTION} for configuration with id ${options.id}`;
     return {
         name: NAME,
         async loadContent() {
             if (options.runOnBuild !== true) {
                 return;
             }
-            const config = await (0, core_1.buildConfig)(options, {}, options.id);
-            await (0, core_1.generateDocFromSchema)({
-                ...config,
-                loggerModule: LOGGER_MODULE,
-            });
+            await (0, cli_1.runGraphQLMarkdown)(options, {}, LOGGER_MODULE);
         },
         extendCli(cli) {
-            cli
-                .command(command)
-                .description(description)
-                .option("-s, --schema <schema>", "Schema location")
-                .option("-r, --root <rootPath>", "Root folder for doc generation")
-                .option("-b, --base <baseURL>", "Base URL to be used by Docusaurus")
-                .option("-l, --link <linkRoot>", "Root for links in documentation")
-                .option("-h, --homepage <homepage>", "File location for doc landing page")
-                .option("--hierarchy <hierarchy>", "Schema entity hierarchy: `api`, `entity`, `flat`")
-                .option("--noCode", "Disable code section for types")
-                .option("--noExample", "Disable example section for types")
-                .option("--noParentType", "Disable parent type name as field prefix")
-                .option("--noRelatedType", "Disable related types sections")
-                .option("--noTypeBadges", "Disable badges for types")
-                .option("--index", "Enable generated index for categories")
-                .option("-f, --force", "Force document generation")
-                .option("-d, --diff <diffMethod>", "Set diff method")
-                .option("-t, --tmp <tmpDir>", "Set temp dir for schema diff")
-                .option("-gbd, --groupByDirective <@directive(field|=fallback)>", "Group documentation by directive")
-                .option("--only <@directive...>", "Only print types with matching directive")
-                .option("--skip <@directive...>", "Skip types with matching directive")
-                .option("--deprecated <option>", "Option for printing deprecated entities: `default`, `group` or `skip`")
-                .option("--pretty", "Prettify generated files")
-                .action(async (cliOptions) => {
-                const config = await (0, core_1.buildConfig)(options, cliOptions, options.id);
-                await (0, core_1.generateDocFromSchema)({
-                    ...config,
-                    docOptions: {
-                        ...config.docOptions,
-                        generatorFrameworkName: "docusaurus",
-                        generatorFrameworkVersion: utils_1.DOCUSAURUS_VERSION,
-                    },
-                    loggerModule: LOGGER_MODULE,
-                });
-            });
+            cli.addCommand((0, cli_1.getGraphQLMarkdownCli)({
+                ...options,
+                docOptions: {
+                    generatorFrameworkName: "docusaurus",
+                    generatorFrameworkVersion: utils_1.DOCUSAURUS_VERSION,
+                },
+            }, LOGGER_MODULE, MDX_PACKAGE));
         },
     };
 }

package/dist/mdx/category.d.ts

@@ -0,0 +1,2 @@
+import type { GenerateIndexMetafileType } from "@graphql-markdown/types";
+export declare const generateIndexMetafile: GenerateIndexMetafileType;

package/dist/mdx/category.js

@@ -0,0 +1,31 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.generateIndexMetafile = void 0;
+const node_path_1 = require("node:path");
+const utils_1 = require("@graphql-markdown/utils");
+const CATEGORY_YAML = "_category_.yml";
+var SidebarPosition;
+(function (SidebarPosition) {
+    SidebarPosition[SidebarPosition["FIRST"] = 1] = "FIRST";
+    SidebarPosition[SidebarPosition["LAST"] = 999] = "LAST";
+})(SidebarPosition || (SidebarPosition = {}));
+const generateIndexMetafile = async (dirPath, category, options) => {
+    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'`;
+    const className = typeof options?.styleClass === "string"
+        ? `className: ${options.styleClass}\n`
+        : "";
+    const position = typeof options?.sidebarPosition === "number"
+        ? options.sidebarPosition
+        : SidebarPosition.FIRST;
+    const content = `label: ${label}\nposition: ${position}\n${className}link: ${link}\ncollapsible: ${options?.collapsible ?? true}\ncollapsed: ${options?.collapsed ?? true}\n`;
+    await (0, utils_1.ensureDir)(dirPath);
+    await (0, utils_1.saveFile)(filePath, content);
+};
+exports.generateIndexMetafile = generateIndexMetafile;

package/dist/mdx/components.d.ts

@@ -0,0 +1,2 @@
+import type { MDXString } from "@graphql-markdown/types";
+export declare const mdxDeclaration: MDXString;

package/dist/mdx/components.js

@@ -0,0 +1,32 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.mdxDeclaration = void 0;
+exports.mdxDeclaration = `
+export const Bullet = () => <><span style={{ fontWeight: 'normal', fontSize: '.5em', color: 'var(--ifm-color-secondary-darkest)' }}>&nbsp;●&nbsp;</span></>
+
+export const SpecifiedBy = (props) => <>Specification<a className="link" style={{ fontSize:'1.5em', paddingLeft:'4px' }} target="_blank" href={props.url} title={'Specified by ' + props.url}>⎘</a></>
+
+export const Badge = (props) => <><span className={props.class}>{props.text}</span></>
+
+import { useState } from 'react';
+
+export const Details = ({ dataOpen, dataClose, children, startOpen = false }) => {
+  const [open, setOpen] = useState(startOpen);
+  return (
+    <details {...(open ? { open: true } : {})} className="details" style={{ border:'none', boxShadow:'none', background:'var(--ifm-background-color)' }}>
+      <summary
+        onClick={(e) => {
+          e.preventDefault();
+          setOpen((open) => !open);
+        }}
+        style={{ listStyle:'none' }}
+      >
+      {open ? dataOpen : dataClose}
+      </summary>
+      {open && children}
+    </details>
+  );
+};
+
+
+`;

package/dist/mdx/index.d.ts

@@ -0,0 +1,10 @@
+import type { AdmonitionType, Badge, CollapsibleOption, Maybe, MDXString, MetaOptions, TypeLink } from "@graphql-markdown/types";
+export { mdxDeclaration } from "./components";
+export { generateIndexMetafile } from "./category";
+export declare const formatMDXBadge: ({ text, classname }: Badge) => MDXString;
+export declare const formatMDXAdmonition: ({ text, title, type }: AdmonitionType, meta: Maybe<MetaOptions>) => MDXString;
+export declare const formatMDXBullet: (text?: string) => MDXString;
+export declare const formatMDXDetails: ({ dataOpen, dataClose, }: CollapsibleOption) => MDXString;
+export declare const formatMDXSpecifiedByLink: (url: string) => MDXString;
+export declare const formatMDXNameEntity: (name: string, parentType?: Maybe<string>) => MDXString;
+export declare const formatMDXLink: ({ text, url }: TypeLink) => TypeLink;

package/dist/mdx/index.js

@@ -0,0 +1,49 @@
+"use strict";
+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;
+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");
+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 formatMDXBadge = ({ text, classname }) => {
+    const style = typeof classname === "string" ? `badge--${classname.toLowerCase()}` : "";
+    return `<Badge class="badge ${DEFAULT_CSS_CLASSNAME} ${style}" text="${text}"/>`;
+};
+exports.formatMDXBadge = formatMDXBadge;
+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 `${MARKDOWN_EOP}:::${type}[${title}]${text}:::`;
+};
+exports.formatMDXAdmonition = formatMDXAdmonition;
+const formatMDXBullet = (text = "") => {
+    return `<Bullet />${text}`;
+};
+exports.formatMDXBullet = formatMDXBullet;
+const formatMDXDetails = ({ dataOpen, dataClose, }) => {
+    return `${MARKDOWN_EOP}<Details dataOpen="Hide ${dataOpen}" dataClose="Show ${dataClose}">${MARKDOWN_EOP}\r${MARKDOWN_EOP}</Details>${MARKDOWN_EOP}`;
+};
+exports.formatMDXDetails = formatMDXDetails;
+const formatMDXSpecifiedByLink = (url) => {
+    return `<SpecifiedBy url="${url}"/>`;
+};
+exports.formatMDXSpecifiedByLink = formatMDXSpecifiedByLink;
+const formatMDXNameEntity = (name, parentType) => {
+    const parentName = parentType ? `${parentType}.` : "";
+    return `<code style={{ fontWeight: 'normal' }}>${parentName}<b>${name}</b></code>`;
+};
+exports.formatMDXNameEntity = formatMDXNameEntity;
+const formatMDXLink = ({ text, url }) => {
+    return {
+        text,
+        url: `${url}${LINK_MDX_EXTENSION}`,
+    };
+};
+exports.formatMDXLink = formatMDXLink;

package/package.json

@@ -5,7 +5,7 @@
   "bugs": {
     "url": "https://github.com/graphql-markdown/graphql-markdown/issues"
   },
-  "version": "1.27.0",
+  "version": "1.29.0",
   "license": "MIT",
   "repository": {
     "type": "git",
@@ -41,6 +41,20 @@
         "default": "./dist/index.js"
       }
     },
+    "./mdx": {
+      "require": {
+        "types": "./dist/mdx/index.d.ts",
+        "default": "./dist/mdx/index.js"
+      },
+      "import": {
+        "types": "./dist/mdx/index.d.ts",
+        "default": "./dist/mdx/index.js"
+      },
+      "default": {
+        "types": "./dist/mdx/index.d.ts",
+        "default": "./dist/mdx/index.js"
+      }
+    },
     "./package.json": "./package.json"
   },
   "scripts": {
@@ -51,14 +65,14 @@
     "docs": "typedoc"
   },
   "dependencies": {
-    "@docusaurus/utils": ">=3.2.0",
-    "@graphql-markdown/core": "^1.13.0",
+    "@graphql-markdown/cli": "^0.3.0",
     "@graphql-markdown/logger": "^1.0.5",
-    "@graphql-markdown/printer-legacy": "^1.10.0"
+    "@graphql-markdown/utils": "^1.8.0",
+    "@docusaurus/utils": ">=3.2.0"
   },
   "devDependencies": {
-    "@docusaurus/types": "^3.5.0",
-    "@graphql-markdown/types": "^1.5.0"
+    "@docusaurus/types": "^3.7.0",
+    "@graphql-markdown/types": "^1.7.0"
   },
   "peerDependencies": {
     "@docusaurus/logger": "*"