@mintlify/common 1.0.323 → 1.0.325

package/dist/asyncapi/getAsyncApiChannelMetadata.d.ts

@@ -0,0 +1,2 @@
+import type { AsyncAPIFile, ParsedAsyncApiPageMetadata } from '../types/asyncapi.js';
+export declare const getAsyncApiChannelMetadata: (asyncApiMetaField: string, asyncApiFiles: AsyncAPIFile[]) => ParsedAsyncApiPageMetadata;

package/dist/asyncapi/getAsyncApiChannelMetadata.js

@@ -0,0 +1,30 @@
+import { parseAsyncApiString } from './parseAsyncApiString.js';
+export const getAsyncApiChannelMetadata = (asyncApiMetaField, asyncApiFiles) => {
+    var _a, _b;
+    const potentiallyParsedAsyncApiString = parseAsyncApiString(asyncApiMetaField);
+    if (potentiallyParsedAsyncApiString == undefined) {
+        return undefined;
+    }
+    const { channelId, filename } = potentiallyParsedAsyncApiString;
+    let asyncApiFile = undefined;
+    for (const file of asyncApiFiles) {
+        const asyncApiSpec = file.spec;
+        const hasAsyncApiChannel = asyncApiSpec.allChannels().has(channelId);
+        const filenameMatches = !filename || filename === file.filename || filename === file.originalFileLocation;
+        if (hasAsyncApiChannel && filenameMatches) {
+            asyncApiFile = file;
+        }
+    }
+    if (asyncApiFile == null) {
+        return undefined;
+    }
+    const channelInterface = asyncApiFile.spec.channels().get(channelId);
+    const channelTitle = (_a = channelInterface.title()) !== null && _a !== void 0 ? _a : '';
+    const channelDescription = (_b = channelInterface.description()) !== null && _b !== void 0 ? _b : '';
+    return {
+        channelId,
+        filename: asyncApiFile.filename,
+        title: channelTitle,
+        description: channelDescription,
+    };
+};

package/dist/asyncapi/parseAsyncApiString.d.ts

@@ -0,0 +1,2 @@
+import type { ParsedAsyncApiPageMetadata } from '../types/asyncapi.js';
+export declare const parseAsyncApiString: (str: string) => ParsedAsyncApiPageMetadata;

package/dist/asyncapi/parseAsyncApiString.js

@@ -0,0 +1,21 @@
+export const parseAsyncApiString = (str) => {
+    const components = str.trim().split(/\s+/);
+    let filename;
+    let channelId;
+    if (components.length > 2) {
+        return undefined;
+    }
+    else if (components[0] && components[1]) {
+        [filename, channelId] = components;
+    }
+    else if (components[0]) {
+        channelId = components[0];
+    }
+    else {
+        return undefined;
+    }
+    return {
+        filename,
+        channelId,
+    };
+};

package/dist/asyncapi/prepAsyncApiFrontmatter.d.ts

@@ -0,0 +1 @@
+export declare function prepAsyncApiFrontmatter(currPath: string, asyncApiFrontmatter?: string): string | undefined;

package/dist/asyncapi/prepAsyncApiFrontmatter.js

@@ -0,0 +1,18 @@
+import { parse } from 'path';
+import { parseAsyncApiString } from '../asyncapi/parseAsyncApiString.js';
+import { normalizeRelativePath } from '../fs/normalizeRelativePath.js';
+import { schemaFileFrontmatterIsOriginalFileLocation } from '../schema/common.js';
+export function prepAsyncApiFrontmatter(currPath, asyncApiFrontmatter) {
+    if (!asyncApiFrontmatter)
+        return undefined;
+    const asyncApiObj = parseAsyncApiString(asyncApiFrontmatter);
+    if ((asyncApiObj === null || asyncApiObj === void 0 ? void 0 : asyncApiObj.filename) && schemaFileFrontmatterIsOriginalFileLocation(asyncApiObj.filename)) {
+        if (asyncApiObj.filename.startsWith('https://')) {
+            return `${asyncApiObj.filename} ${asyncApiObj.channelId}`;
+        }
+        const currDir = parse(currPath).dir;
+        const newAsyncApiFilename = normalizeRelativePath(currDir, asyncApiObj.filename);
+        return `${newAsyncApiFilename} ${asyncApiObj.channelId}`;
+    }
+    return asyncApiFrontmatter;
+}

package/dist/camelToSentenceCase.d.ts

@@ -0,0 +1 @@
+export declare const camelToSentenceCase: (str: string) => string;

package/dist/camelToSentenceCase.js

@@ -0,0 +1,8 @@
+export const camelToSentenceCase = (str) => {
+    // Split on capital letters and convert to lowercase
+    const words = str.split(/(?=[A-Z])/).map((word) => word.toLowerCase());
+    // Capitalize first word and join with spaces
+    return words
+        .map((word, index) => (index === 0 ? word.charAt(0).toUpperCase() + word.slice(1) : word))
+        .join(' ');
+};

package/dist/index.d.ts

@@ -13,3 +13,5 @@ export * from './isWildcardRedirect.js';
 export * from './isDocsConfig.js';
 export * from './divisions/index.js';
 export * from './title.js';
+export * from './schema/common.js';
+export * from './camelToSentenceCase.js';

package/dist/index.js

@@ -13,3 +13,5 @@ export * from './isWildcardRedirect.js';
 export * from './isDocsConfig.js';
 export * from './divisions/index.js';
 export * from './title.js';
+export * from './schema/common.js';
+export * from './camelToSentenceCase.js';

package/dist/openapi/index.d.ts

@@ -6,4 +6,3 @@ export { getOpenApiTitleAndDescription } from './getOpenApiTitleAndDescription.j
 export { validate, safeValidate } from './validate.js';
 export { getOpenApiDocumentFromUrl } from './getOpenApiDocumentFromUrl.js';
 export { prepOpenApiFrontmatter } from './prepOpenApiFrontmatter.js';
-export { openApiFrontmatterIsOriginalFileLocation } from './openApiFrontmatterIsOriginalFileLocation.js';

package/dist/openapi/index.js

@@ -6,4 +6,3 @@ export { getOpenApiTitleAndDescription } from './getOpenApiTitleAndDescription.j
 export { validate, safeValidate } from './validate.js';
 export { getOpenApiDocumentFromUrl } from './getOpenApiDocumentFromUrl.js';
 export { prepOpenApiFrontmatter } from './prepOpenApiFrontmatter.js';
-export { openApiFrontmatterIsOriginalFileLocation } from './openApiFrontmatterIsOriginalFileLocation.js';

package/dist/openapi/prepOpenApiFrontmatter.js

@@ -1,13 +1,13 @@
 import { parse, isAbsolute } from 'path';
 import { normalizeRelativePath } from '../fs/normalizeRelativePath.js';
-import { openApiFrontmatterIsOriginalFileLocation } from './openApiFrontmatterIsOriginalFileLocation.js';
+import { schemaFileFrontmatterIsOriginalFileLocation } from '../schema/common.js';
 import { potentiallyParseOpenApiString } from './parseOpenApiString.js';
 export function prepOpenApiFrontmatter(currPath, openapiFrontmatter) {
     if (!openapiFrontmatter)
         return undefined;
     const openapiObj = potentiallyParseOpenApiString(openapiFrontmatter);
-    if ((openapiObj === null || openapiObj === void 0 ? void 0 : openapiObj.filename) && openApiFrontmatterIsOriginalFileLocation(openapiObj.filename)) {
-        if (openapiObj.filename.startsWith('http://') || openapiObj.filename.startsWith('https://')) {
+    if ((openapiObj === null || openapiObj === void 0 ? void 0 : openapiObj.filename) && schemaFileFrontmatterIsOriginalFileLocation(openapiObj.filename)) {
+        if (openapiObj.filename.startsWith('https://')) {
             return `${openapiObj.filename} ${openapiObj.method.toLowerCase()} ${openapiObj.endpoint}`;
         }
         const filenameIsAbsolute = isAbsolute(openapiObj.filename);

package/dist/schema/common.d.ts

@@ -0,0 +1 @@
+export declare const schemaFileFrontmatterIsOriginalFileLocation: (filenameFromFrontmatter: string) => boolean;

package/dist/schema/common.js

@@ -0,0 +1,6 @@
+// Functions used for both OpenAPI and AsyncAPI schemas
+export const schemaFileFrontmatterIsOriginalFileLocation = (filenameFromFrontmatter) => {
+    return (filenameFromFrontmatter.toLowerCase().endsWith('.json') ||
+        filenameFromFrontmatter.toLowerCase().endsWith('.yaml') ||
+        filenameFromFrontmatter.toLowerCase().endsWith('.yml'));
+};

package/dist/slug/getDecoratedNavPageAndSlug.d.ts

@@ -1,5 +1,6 @@
 import type { OpenApiFile, DecoratedNavigationPage } from '@mintlify/models';
-export declare const getDecoratedNavPageAndSlug: (pagePath: string, pageContent: string, openApiFiles: OpenApiFile[]) => {
+import { AsyncAPIFile } from '../types/asyncapi.js';
+export declare const getDecoratedNavPageAndSlug: (pagePath: string, pageContent: string, openApiFiles: OpenApiFile[], asyncApiFiles: AsyncAPIFile[]) => {
     pageMetadata: DecoratedNavigationPage;
     slug: string;
 };

package/dist/slug/getDecoratedNavPageAndSlug.js

@@ -1,10 +1,12 @@
 import matter from 'gray-matter';
+import { getAsyncApiChannelMetadata } from '../asyncapi/getAsyncApiChannelMetadata.js';
+import { prepAsyncApiFrontmatter } from '../asyncapi/prepAsyncApiFrontmatter.js';
 import { removeLeadingSlash, optionallyAddLeadingSlash } from '../fs/index.js';
 import { getOpenApiTitleAndDescription } from '../openapi/getOpenApiTitleAndDescription.js';
 import { prepOpenApiFrontmatter } from '../openapi/prepOpenApiFrontmatter.js';
 import { pagePathToSlug } from './pagePathToSlug.js';
 import { slugToTitle } from './slugToTitle.js';
-export const getDecoratedNavPageAndSlug = (pagePath, pageContent, openApiFiles) => {
+export const getDecoratedNavPageAndSlug = (pagePath, pageContent, openApiFiles, asyncApiFiles) => {
     let metadata = {};
     try {
         metadata = matter(pageContent).data;
@@ -26,16 +28,21 @@ export const getDecoratedNavPageAndSlug = (pagePath, pageContent, openApiFiles)
     }
     const slug = pagePathToSlug(pagePath);
     const defaultTitle = slugToTitle(slug);
-    // Append data from OpenAPI if it exists
-    let openApiTitle;
-    let openApiDescription;
+    let schemaTitle;
+    let schemaDescription;
     if (metadata.openapi) {
         metadata.openapi = prepOpenApiFrontmatter(pagePath, metadata.openapi);
-        const { title, description } = getOpenApiTitleAndDescription(openApiFiles, metadata.openapi);
-        openApiTitle = title;
-        openApiDescription = description;
+        const { title: openApiSchemaTitle, description: openApiSchemaDescription } = getOpenApiTitleAndDescription(openApiFiles, metadata.openapi);
+        schemaTitle = openApiSchemaTitle;
+        schemaDescription = openApiSchemaDescription;
     }
-    const pageMetadata = Object.assign(Object.assign({ title: openApiTitle !== null && openApiTitle !== void 0 ? openApiTitle : defaultTitle, description: openApiDescription }, metadata), { href: optionallyAddLeadingSlash(slug) });
+    if (metadata.asyncapi) {
+        metadata.asyncapi = prepAsyncApiFrontmatter(pagePath, metadata.asyncapi);
+        const parsedMetadata = getAsyncApiChannelMetadata(metadata.asyncapi, asyncApiFiles);
+        schemaTitle = parsedMetadata === null || parsedMetadata === void 0 ? void 0 : parsedMetadata.title;
+        schemaDescription = parsedMetadata === null || parsedMetadata === void 0 ? void 0 : parsedMetadata.description;
+    }
+    const pageMetadata = Object.assign(Object.assign({ title: schemaTitle !== null && schemaTitle !== void 0 ? schemaTitle : defaultTitle, description: schemaDescription }, metadata), { href: optionallyAddLeadingSlash(slug) });
     return {
         pageMetadata,
         slug: removeLeadingSlash(slug),