@mintlify/common 1.0.1335 → 1.0.1336

package/dist/graphql/index.d.ts

@@ -1,3 +1,4 @@
 export * from './parseGraphqlSelector.js';
 export * from './pickGraphqlReferenceData.js';
+export * from './renderGraphqlReferenceAsMarkdown.js';
 export * from './resolveGraphqlOperation.js';

package/dist/graphql/index.js

@@ -1,3 +1,4 @@
 export * from './parseGraphqlSelector.js';
 export * from './pickGraphqlReferenceData.js';
+export * from './renderGraphqlReferenceAsMarkdown.js';
 export * from './resolveGraphqlOperation.js';

package/dist/graphql/renderGraphqlReferenceAsMarkdown.d.ts

@@ -0,0 +1,2 @@
+import type { GraphqlReferenceData } from '@mintlify/models';
+export declare const renderGraphqlReferenceAsMarkdown: (data: GraphqlReferenceData) => string;

package/dist/graphql/renderGraphqlReferenceAsMarkdown.js

@@ -0,0 +1,118 @@
+import { getNamedGraphqlType, resolveGraphqlOperation } from './resolveGraphqlOperation.js';
+const printTypeRef = (type) => {
+    if (type.kind === 'named')
+        return type.name;
+    if (type.kind === 'list')
+        return `[${printTypeRef(type.ofType)}]`;
+    return `${printTypeRef(type.ofType)}!`;
+};
+const isRequired = (value) => value.type.kind === 'nonNull' && value.defaultValue === undefined;
+const renderInputValue = (value) => {
+    const req = isRequired(value) ? ' (required)' : '';
+    const def = value.defaultValueLiteral !== undefined ? ` = ${value.defaultValueLiteral}` : '';
+    let md = `**\`${value.name}\`**: \`${printTypeRef(value.type)}\`${def}${req}`;
+    if (value.description)
+        md += `\n\n${value.description}`;
+    if (value.deprecationReason)
+        md += `\n\n> Deprecated: ${value.deprecationReason}`;
+    return md;
+};
+const renderField = (field) => {
+    let md = `**\`${field.name}\`**: \`${printTypeRef(field.type)}\``;
+    if (field.description)
+        md += `\n\n${field.description}`;
+    if (field.deprecationReason)
+        md += `\n\n> Deprecated: ${field.deprecationReason}`;
+    if (field.arguments.length > 0) {
+        md +=
+            '\n\n**Arguments:**\n\n' +
+                field.arguments
+                    .map((arg) => {
+                    const def = arg.defaultValueLiteral !== undefined ? ` = ${arg.defaultValueLiteral}` : '';
+                    return `- \`${arg.name}\`: \`${printTypeRef(arg.type)}\`${def}${arg.description ? ` — ${arg.description}` : ''}`;
+                })
+                    .join('\n');
+    }
+    return md;
+};
+const renderEnumValue = (value) => {
+    let md = `**\`${value.name}\`**`;
+    if (value.description)
+        md += ` — ${value.description}`;
+    if (value.deprecationReason)
+        md += `\n\n> Deprecated: ${value.deprecationReason}`;
+    return md;
+};
+const SEPARATOR = '\n\n---\n\n';
+const renderNamedType = (type) => {
+    let md = `**Kind**: \`${type.kind}\`\n\n`;
+    if (type.kind === 'object' || type.kind === 'interface') {
+        if (type.interfaces.length > 0) {
+            md += `## Implements\n\n${type.interfaces.map((name) => `- \`${name}\``).join('\n')}\n\n`;
+        }
+        if (type.fields.length > 0) {
+            md += `## Fields\n\n${type.fields.map(renderField).join(SEPARATOR)}\n\n`;
+        }
+        if (type.kind === 'interface' && type.possibleTypes.length > 0) {
+            md += `## Possible types\n\n${type.possibleTypes.map((name) => `- \`${name}\``).join('\n')}\n\n`;
+        }
+    }
+    else if (type.kind === 'input') {
+        if (type.fields.length > 0) {
+            md += `## Fields\n\n${type.fields.map(renderInputValue).join(SEPARATOR)}\n\n`;
+        }
+    }
+    else if (type.kind === 'enum') {
+        if (type.values.length > 0) {
+            md += `## Values\n\n${type.values.map(renderEnumValue).join('\n\n')}\n\n`;
+        }
+    }
+    else if (type.kind === 'union') {
+        if (type.possibleTypes.length > 0) {
+            md += `## Possible types\n\n${type.possibleTypes.map((name) => `- \`${name}\``).join('\n')}\n\n`;
+        }
+    }
+    return md;
+};
+const fieldCall = (field) => {
+    const args = field.arguments.map((arg) => `${arg.name}: ${printTypeRef(arg.type)}`).join(', ');
+    return `${field.name}${args ? `(${args})` : ''}`;
+};
+const renderOperation = (data) => {
+    const { reference, target } = data;
+    const resolved = resolveGraphqlOperation(reference, target);
+    if (!resolved)
+        return '';
+    const { field, parents } = resolved;
+    const returnTypeName = getNamedGraphqlType(field.type);
+    const returnType = reference.types.find((t) => t.name === returnTypeName);
+    const returnFields = (returnType === null || returnType === void 0 ? void 0 : returnType.kind) === 'object' || (returnType === null || returnType === void 0 ? void 0 : returnType.kind) === 'interface' ? returnType.fields : [];
+    const sig = `${[...parents, field].map(fieldCall).join('.')}: ${printTypeRef(field.type)}`;
+    let md = `**${target.kind}** \`${sig}\`\n\n`;
+    if (field.deprecationReason) {
+        md += `> Deprecated: ${field.deprecationReason}\n\n`;
+    }
+    if (field.arguments.length > 0) {
+        md += `## Arguments\n\n${field.arguments.map(renderInputValue).join(SEPARATOR)}\n\n`;
+    }
+    for (const parent of parents) {
+        if (parent.arguments.length > 0) {
+            md += `## ${parent.name} arguments\n\n${parent.arguments.map(renderInputValue).join(SEPARATOR)}\n\n`;
+        }
+    }
+    md += `## Returns\n\n\`${printTypeRef(field.type)}\`\n\n`;
+    if (returnFields.length > 0) {
+        md += returnFields.map(renderField).join(SEPARATOR) + '\n\n';
+    }
+    return md;
+};
+export const renderGraphqlReferenceAsMarkdown = (data) => {
+    const { reference, target } = data;
+    if (target.kind === 'type') {
+        const type = reference.types.find((t) => t.name === target.name);
+        if (!type)
+            return '';
+        return renderNamedType(type);
+    }
+    return renderOperation(data);
+};