@mintlify/scraping 4.0.174 → 4.0.176

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@mintlify/scraping",
-  "version": "4.0.174",
+  "version": "4.0.176",
   "description": "Scrape documentation frameworks to Mintlify docs",
   "engines": {
     "node": ">=18.0.0"
@@ -38,7 +38,7 @@
     "format:check": "prettier . --check"
   },
   "dependencies": {
-    "@mintlify/common": "1.0.322",
+    "@mintlify/common": "1.0.324",
     "@mintlify/openapi-parser": "^0.0.7",
     "fs-extra": "^11.1.1",
     "hast-util-to-mdast": "^10.1.0",
@@ -78,5 +78,5 @@
     "typescript": "^5.5.3",
     "vitest": "^2.0.4"
   },
-  "gitHead": "f5c36ee6b12784c48d015dce256024d129a74e24"
+  "gitHead": "7c94b810d40ff3c70fbfbf1b280e1c85094da486"
 }

package/src/apiPages/common.ts

@@ -57,5 +57,5 @@ export const generateUniqueFilenameWithoutExtension = (
       filename = `${base}-${extension}`;
     }
   }
-  return filename;
+  return filename.toLowerCase();
 };

package/src/asyncapi/generateAsyncApiPagesForDocsConfig.ts

@@ -0,0 +1,88 @@
+import {
+  AsyncAPIDocumentInterface,
+  AsyncAPIChannel,
+  validateAsyncApi,
+} from '@mintlify/common/asyncapi';
+import { DecoratedNavigationPage } from '@mintlify/models';
+import { DecoratedGroupsConfig, GroupsConfig } from '@mintlify/validation';
+
+import { findNavGroup } from '../apiPages/common.js';
+import { getAsyncApiDefinition } from './getAsyncApiDefinition.js';
+import { processAsyncApiChannel } from './processAsyncApiChannel.js';
+
+type GenerateAsyncApiPagesOptions = {
+  asyncApiFilePath?: string;
+  version?: string;
+  writeFiles?: boolean;
+  outDir?: string;
+  outDirBasePath?: string;
+  overwrite?: boolean;
+};
+
+type AsyncApiPageGenerationResult = {
+  nav: GroupsConfig;
+  decoratedNav: DecoratedGroupsConfig;
+  spec: AsyncAPIDocumentInterface;
+  pagesAcc: Record<string, DecoratedNavigationPage>;
+  isUrl: boolean;
+};
+
+export async function generateAsyncApiPagesForDocsConfig(
+  spec: AsyncAPIDocumentInterface | string | URL,
+  opts?: GenerateAsyncApiPagesOptions
+): Promise<AsyncApiPageGenerationResult> {
+  let document: AsyncAPIDocumentInterface | undefined = undefined;
+  let isUrl: boolean;
+  if (typeof spec === 'string' || spec instanceof URL) {
+    const { document: asyncApiDocument, isUrl: isUrlFromDefinition } =
+      await getAsyncApiDefinition(spec);
+    if (asyncApiDocument) {
+      document = asyncApiDocument;
+    }
+    isUrl = isUrlFromDefinition;
+  } else {
+    const { valid, errorMessage, document: asyncApiDocument } = await validateAsyncApi(spec);
+    if (!valid && errorMessage) {
+      throw new Error(errorMessage);
+    }
+    document = asyncApiDocument;
+    isUrl = false;
+  }
+
+  if (!document) {
+    throw new Error('No document defined');
+  }
+
+  const channels = document.channels();
+
+  if (channels.isEmpty()) {
+    throw new Error('No channels defined');
+  }
+
+  const nav: GroupsConfig = [];
+  const decoratedNav: DecoratedGroupsConfig = [];
+  const writePromises: Promise<void>[] = [];
+  const pagesAcc: Record<string, DecoratedNavigationPage> = {};
+
+  channels.all().forEach((channel) => {
+    processAsyncApiChannel({
+      channel: channel as AsyncAPIChannel,
+      nav,
+      decoratedNav,
+      writePromises,
+      pagesAcc,
+      opts,
+      findNavGroup,
+    });
+  });
+
+  await Promise.all(writePromises);
+
+  return {
+    nav,
+    decoratedNav,
+    spec: document,
+    pagesAcc,
+    isUrl,
+  };
+}

package/src/asyncapi/processAsyncApiChannel.ts

@@ -1,4 +1,4 @@
-import { optionallyAddLeadingSlash } from '@mintlify/common';
+import { optionallyAddLeadingSlash, camelToSentenceCase } from '@mintlify/common';
 import { AsyncAPIChannel } from '@mintlify/common/asyncapi';
 import { DecoratedNavigationPage } from '@mintlify/models';
 import {
@@ -49,18 +49,20 @@ export const processAsyncApiChannel = ({
   findNavGroup,
 }: ProcessAsyncApiChannelArgs) => {
   const asyncApiFilePathFromRoot = opts?.asyncApiFilePath
-    ? optionallyAddLeadingSlash(opts.asyncApiFilePath)
+    ? opts.asyncApiFilePath.startsWith('https://')
+      ? opts.asyncApiFilePath
+      : optionallyAddLeadingSlash(opts.asyncApiFilePath)
     : undefined;
 
-  const operation = 'websocket';
   const tags = channel.tags().all();
   const groupName = tags[0]?.name() ?? DEFAULT_WEBSOCKETS_GROUP_NAME;
   const channelId = channel.id();
   const title = channel.title() ?? channelId;
+  const filename = prepareStringToBeValidFilename(title) ?? '';
   const description = channel.description() ?? channel.summary() ?? '';
 
   const folder = prepareStringToBeValidFilename(groupName) ?? '';
-  const base = join(opts?.outDir ?? '', folder, title);
+  const base = join(opts?.outDir ?? '', folder, filename);
 
   const navGroup = findNavGroup(nav, groupName);
   const decoratedNavGroup = findNavGroup(decoratedNav, groupName);
@@ -69,14 +71,14 @@ export const processAsyncApiChannel = ({
 
   const asyncApiMetaTag = `${
     asyncApiFilePathFromRoot ? `${asyncApiFilePathFromRoot} ` : ''
-  }${operation} ${channelId}`;
+  }${channelId}`;
 
   navGroup.push(filenameWithoutExtension);
 
   const page: DecoratedNavigationPage = {
     asyncapi: asyncApiMetaTag,
     href: resolve('/', filenameWithoutExtension),
-    title: title,
+    title: title === channelId ? camelToSentenceCase(title) : title,
     description,
     version: opts?.version,
   };

package/src/index.ts

@@ -1,3 +1,4 @@
 export { generateOpenApiPages } from './openapi/generateOpenApiPages.js';
 export { generateOpenApiPagesForDocsConfig } from './openapi/generateOpenApiPagesForDocsConfig.js';
 export * from './utils/log.js';
+export { generateAsyncApiPagesForDocsConfig } from './asyncapi/generateAsyncApiPagesForDocsConfig.js';