@mintlify/scraping 4.0.163 → 4.0.165

package/bin/utils/log.js

@@ -89,7 +89,7 @@ export function log(message, statusOrColor = undefined, opts = {}) {
         ? 'error'
         : statusOrColor === 'warn' || statusOrColor === 'warning'
             ? 'warn'
-            : 'log'](`${color}${icon} ${statusMsg}${activeColors.default}${separator}${typeof message === 'string' ||
+            : 'log'](`${color}${icon}${icon ? ' ' : ''}${statusMsg}${activeColors.default}${separator}${typeof message === 'string' ||
         typeof message === 'bigint' ||
         typeof message === 'number' ||
         typeof message === 'boolean'

package/bin/utils/log.js.map

@@ -1 +1 @@
-{"version":3,"file":"log.js","sourceRoot":"","sources":["../../src/utils/log.ts"],"names":[],"mappings":"AAAA,MAAM,CAAC,MAAM,MAAM,GAAG;IACpB,GAAG,EAAE,UAAU;IACf,KAAK,EAAE,UAAU;IACjB,MAAM,EAAE,UAAU;IAClB,IAAI,EAAE,UAAU;IAChB,OAAO,EAAE,UAAU;IACnB,IAAI,EAAE,UAAU;IAChB,IAAI,EAAE,UAAU;IAChB,OAAO,EAAE,SAAS;IAClB,IAAI,EAAE,SAAS;IACf,GAAG,EAAE,SAAS;IACd,MAAM,EAAE,SAAS;CACT,CAAC;AAEX,MAAM,QAAQ,GAAG;IACf,GAAG,EAAE,EAAE;IACP,KAAK,EAAE,EAAE;IACT,MAAM,EAAE,EAAE;IACV,IAAI,EAAE,EAAE;IACR,OAAO,EAAE,EAAE;IACX,IAAI,EAAE,EAAE;IACR,IAAI,EAAE,EAAE;IACR,OAAO,EAAE,EAAE;IACX,IAAI,EAAE,EAAE;IACR,GAAG,EAAE,EAAE;IACP,MAAM,EAAE,EAAE;CACF,CAAC;AAEX,MAAM,QAAQ,GAAG,CAAC,SAAS,EAAE,SAAS,EAAE,OAAO,EAAE,MAAM,EAAE,SAAS,EAAE,MAAM,CAAU,CAAC;AAErF,MAAM,CAAC,MAAM,YAAY,GACvB,QAAQ,IAAI,OAAO,IAAI,WAAW,IAAI,OAAO,CAAC,MAAM,IAAI,OAAO,CAAC,MAAM,CAAC,SAAS,EAAE;IAChF,CAAC,CAAC,MAAM;IACR,CAAC,CAAC,QAAQ,CAAC;AAKf,MAAM,CAAC,MAAM,SAAS,GAAG,IAAa,CAAC;AACvC,MAAM,CAAC,MAAM,KAAK,GAAG,IAAa,CAAC;AACnC,MAAM,CAAC,MAAM,QAAQ,GAAG,IAAa,CAAC;AACtC,MAAM,CAAC,MAAM,WAAW,GAAG,IAAa,CAAC;AAEzC,MAAM,UAAU,GAAG,CACjB,OAAyB,EACzB,gBAAoC,SAAS,EAC7C,OAKI,EAAE;IAEN,IAAI,KAAK,GAAiC,YAAY,CAAC,IAAI,CAAC;IAC5D,IAAI,SAAS,GAAW,MAAM,CAAC;IAC/B,IAAI,IAAI,GAAW,QAAQ,CAAC;IAE5B,MAAM,GAAG,GAAG,OAAO,OAAO,KAAK,QAAQ,CAAC,CAAC,CAAC,OAAO,CAAC,WAAW,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;IACrE,IAAI,CAAC,aAAa,EAAE,CAAC;QACnB,aAAa;YACX,GAAG,CAAC,QAAQ,CAAC,MAAM,CAAC;gBACpB,GAAG,CAAC,QAAQ,CAAC,OAAO,CAAC;gBACrB,GAAG,CAAC,QAAQ,CAAC,WAAW,CAAC;gBACzB,GAAG,CAAC,QAAQ,CAAC,UAAU,CAAC;gBACxB,GAAG,CAAC,QAAQ,CAAC,SAAS,CAAC;gBACvB,GAAG,CAAC,QAAQ,CAAC,SAAS,CAAC;gBACvB,GAAG,CAAC,QAAQ,CAAC,QAAQ,CAAC;gBACpB,CAAC,CAAC,OAAO;gBACT,CAAC,CAAC,GAAG,CAAC,QAAQ,CAAC,SAAS,CAAC;oBACrB,GAAG,CAAC,QAAQ,CAAC,YAAY,CAAC;oBAC1B,GAAG,CAAC,QAAQ,CAAC,SAAS,CAAC;oBACvB,GAAG,CAAC,QAAQ,CAAC,OAAO,CAAC;oBACvB,CAAC,CAAC,SAAS;oBACX,CAAC,CAAC,GAAG,CAAC,QAAQ,CAAC,MAAM,CAAC;wBACpB,CAAC,CAAC,MAAM;wBACR,CAAC,CAAC,SAAS,CAAC;IACtB,CAAC;IAED,QAAQ,aAAa,EAAE,CAAC;QACtB,KAAK,SAAS,CAAC;QACf,KAAK,MAAM;YACT,MAAM;QAER,KAAK,SAAS;YACZ,KAAK,GAAG,YAAY,CAAC,KAAK,CAAC;YAC3B,SAAS,GAAG,SAAS,CAAC;YACtB,IAAI,GAAG,SAAS,CAAC;YACjB,MAAM;QAER,KAAK,MAAM,CAAC;QACZ,KAAK,SAAS;YACZ,KAAK,GAAG,YAAY,CAAC,MAAM,CAAC;YAC5B,SAAS,GAAG,SAAS,CAAC;YACtB,IAAI,GAAG,WAAW,CAAC;YACnB,MAAM;QAER,KAAK,SAAS,CAAC;QACf,KAAK,OAAO;YACV,KAAK,GAAG,YAAY,CAAC,GAAG,CAAC;YACzB,SAAS,GAAG,OAAO,CAAC;YACpB,IAAI,GAAG,KAAK,CAAC;YACb,MAAM;IACV,CAAC;IAED,IAAI,IAAI,CAAC,QAAQ;QAAE,IAAI,GAAG,EAAE,CAAC;IAC7B,IAAI,IAAI,CAAC,iBAAiB;QAAE,SAAS,GAAG,EAAE,CAAC;IAC3C,MAAM,SAAS,GAAG,IAAI,CAAC,iBAAiB,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE,CAAC;IAE5E,IAAI,IAAI,CAAC,cAAc;QAAE,OAAO,CAAC,GAAG,EAAE,CAAC;IACvC,OAAO,CACL,aAAa,KAAK,OAAO,IAAI,aAAa,KAAK,SAAS;QACtD,CAAC,CAAC,OAAO;QACT,CAAC,CAAC,aAAa,KAAK,MAAM,IAAI,aAAa,KAAK,SAAS;YACvD,CAAC,CAAC,MAAM;YACR,CAAC,CAAC,KAAK,CACZ,CACC,GAAG,KAAK,GAAG,IAAI,IAAI,SAAS,GAAG,YAAY,CAAC,OAAO,GAAG,SAAS,GAC7D,OAAO,OAAO,KAAK,QAAQ;QAC3B,OAAO,OAAO,KAAK,QAAQ;QAC3B,OAAO,OAAO,KAAK,QAAQ;QAC3B,OAAO,OAAO,KAAK,SAAS;QAC1B,CAAC,CAAC,OAAO;QACT,CAAC,CAAC,IAAI,CAAC,SAAS,CAAC,OAAO,EAAE,SAAS,EAAE,CAAC,CAC1C,EAAE,CACH,CAAC;IACF,IAAI,IAAI,CAAC,eAAe;QAAE,OAAO,CAAC,GAAG,EAAE,CAAC;AAC1C,CAAC"}
+{"version":3,"file":"log.js","sourceRoot":"","sources":["../../src/utils/log.ts"],"names":[],"mappings":"AAAA,MAAM,CAAC,MAAM,MAAM,GAAG;IACpB,GAAG,EAAE,UAAU;IACf,KAAK,EAAE,UAAU;IACjB,MAAM,EAAE,UAAU;IAClB,IAAI,EAAE,UAAU;IAChB,OAAO,EAAE,UAAU;IACnB,IAAI,EAAE,UAAU;IAChB,IAAI,EAAE,UAAU;IAChB,OAAO,EAAE,SAAS;IAClB,IAAI,EAAE,SAAS;IACf,GAAG,EAAE,SAAS;IACd,MAAM,EAAE,SAAS;CACT,CAAC;AAEX,MAAM,QAAQ,GAAG;IACf,GAAG,EAAE,EAAE;IACP,KAAK,EAAE,EAAE;IACT,MAAM,EAAE,EAAE;IACV,IAAI,EAAE,EAAE;IACR,OAAO,EAAE,EAAE;IACX,IAAI,EAAE,EAAE;IACR,IAAI,EAAE,EAAE;IACR,OAAO,EAAE,EAAE;IACX,IAAI,EAAE,EAAE;IACR,GAAG,EAAE,EAAE;IACP,MAAM,EAAE,EAAE;CACF,CAAC;AAEX,MAAM,QAAQ,GAAG,CAAC,SAAS,EAAE,SAAS,EAAE,OAAO,EAAE,MAAM,EAAE,SAAS,EAAE,MAAM,CAAU,CAAC;AAErF,MAAM,CAAC,MAAM,YAAY,GACvB,QAAQ,IAAI,OAAO,IAAI,WAAW,IAAI,OAAO,CAAC,MAAM,IAAI,OAAO,CAAC,MAAM,CAAC,SAAS,EAAE;IAChF,CAAC,CAAC,MAAM;IACR,CAAC,CAAC,QAAQ,CAAC;AAKf,MAAM,CAAC,MAAM,SAAS,GAAG,IAAa,CAAC;AACvC,MAAM,CAAC,MAAM,KAAK,GAAG,IAAa,CAAC;AACnC,MAAM,CAAC,MAAM,QAAQ,GAAG,IAAa,CAAC;AACtC,MAAM,CAAC,MAAM,WAAW,GAAG,IAAa,CAAC;AAEzC,MAAM,UAAU,GAAG,CACjB,OAAyB,EACzB,gBAAoC,SAAS,EAC7C,OAKI,EAAE;IAEN,IAAI,KAAK,GAAiC,YAAY,CAAC,IAAI,CAAC;IAC5D,IAAI,SAAS,GAAW,MAAM,CAAC;IAC/B,IAAI,IAAI,GAAW,QAAQ,CAAC;IAE5B,MAAM,GAAG,GAAG,OAAO,OAAO,KAAK,QAAQ,CAAC,CAAC,CAAC,OAAO,CAAC,WAAW,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;IACrE,IAAI,CAAC,aAAa,EAAE,CAAC;QACnB,aAAa;YACX,GAAG,CAAC,QAAQ,CAAC,MAAM,CAAC;gBACpB,GAAG,CAAC,QAAQ,CAAC,OAAO,CAAC;gBACrB,GAAG,CAAC,QAAQ,CAAC,WAAW,CAAC;gBACzB,GAAG,CAAC,QAAQ,CAAC,UAAU,CAAC;gBACxB,GAAG,CAAC,QAAQ,CAAC,SAAS,CAAC;gBACvB,GAAG,CAAC,QAAQ,CAAC,SAAS,CAAC;gBACvB,GAAG,CAAC,QAAQ,CAAC,QAAQ,CAAC;gBACpB,CAAC,CAAC,OAAO;gBACT,CAAC,CAAC,GAAG,CAAC,QAAQ,CAAC,SAAS,CAAC;oBACrB,GAAG,CAAC,QAAQ,CAAC,YAAY,CAAC;oBAC1B,GAAG,CAAC,QAAQ,CAAC,SAAS,CAAC;oBACvB,GAAG,CAAC,QAAQ,CAAC,OAAO,CAAC;oBACvB,CAAC,CAAC,SAAS;oBACX,CAAC,CAAC,GAAG,CAAC,QAAQ,CAAC,MAAM,CAAC;wBACpB,CAAC,CAAC,MAAM;wBACR,CAAC,CAAC,SAAS,CAAC;IACtB,CAAC;IAED,QAAQ,aAAa,EAAE,CAAC;QACtB,KAAK,SAAS,CAAC;QACf,KAAK,MAAM;YACT,MAAM;QAER,KAAK,SAAS;YACZ,KAAK,GAAG,YAAY,CAAC,KAAK,CAAC;YAC3B,SAAS,GAAG,SAAS,CAAC;YACtB,IAAI,GAAG,SAAS,CAAC;YACjB,MAAM;QAER,KAAK,MAAM,CAAC;QACZ,KAAK,SAAS;YACZ,KAAK,GAAG,YAAY,CAAC,MAAM,CAAC;YAC5B,SAAS,GAAG,SAAS,CAAC;YACtB,IAAI,GAAG,WAAW,CAAC;YACnB,MAAM;QAER,KAAK,SAAS,CAAC;QACf,KAAK,OAAO;YACV,KAAK,GAAG,YAAY,CAAC,GAAG,CAAC;YACzB,SAAS,GAAG,OAAO,CAAC;YACpB,IAAI,GAAG,KAAK,CAAC;YACb,MAAM;IACV,CAAC;IAED,IAAI,IAAI,CAAC,QAAQ;QAAE,IAAI,GAAG,EAAE,CAAC;IAC7B,IAAI,IAAI,CAAC,iBAAiB;QAAE,SAAS,GAAG,EAAE,CAAC;IAC3C,MAAM,SAAS,GAAG,IAAI,CAAC,iBAAiB,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE,CAAC;IAE5E,IAAI,IAAI,CAAC,cAAc;QAAE,OAAO,CAAC,GAAG,EAAE,CAAC;IACvC,OAAO,CACL,aAAa,KAAK,OAAO,IAAI,aAAa,KAAK,SAAS;QACtD,CAAC,CAAC,OAAO;QACT,CAAC,CAAC,aAAa,KAAK,MAAM,IAAI,aAAa,KAAK,SAAS;YACvD,CAAC,CAAC,MAAM;YACR,CAAC,CAAC,KAAK,CACZ,CACC,GAAG,KAAK,GAAG,IAAI,GAAG,IAAI,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,GAAG,SAAS,GAAG,YAAY,CAAC,OAAO,GAAG,SAAS,GAC9E,OAAO,OAAO,KAAK,QAAQ;QAC3B,OAAO,OAAO,KAAK,QAAQ;QAC3B,OAAO,OAAO,KAAK,QAAQ;QAC3B,OAAO,OAAO,KAAK,SAAS;QAC1B,CAAC,CAAC,OAAO;QACT,CAAC,CAAC,IAAI,CAAC,SAAS,CAAC,OAAO,EAAE,SAAS,EAAE,CAAC,CAC1C,EAAE,CACH,CAAC;IACF,IAAI,IAAI,CAAC,eAAe;QAAE,OAAO,CAAC,GAAG,EAAE,CAAC;AAC1C,CAAC"}

package/bin/utils/network.d.ts

@@ -1,4 +1,4 @@
-import { AsyncAPIDocument } from '@mintlify/common/asyncapi';
+import { AsyncAPIDocumentInterface } from '@mintlify/common/asyncapi';
 import { OpenAPI } from 'openapi-types';
 import { Browser } from 'puppeteer';
 export declare function startPuppeteer(): Promise<Browser | undefined>;
@@ -6,4 +6,4 @@ export declare function getHtmlWithPuppeteer(browser: Browser, url: string | URL
 export declare function fetchPageHtml(url: string | URL, browser?: Browser | undefined): Promise<string>;
 export declare function fetchImage(url: string): Promise<NodeJS.TypedArray>;
 export declare function fetchOpenApi(url: URL): Promise<OpenAPI.Document>;
-export declare function fetchAsyncApi(url: URL): Promise<AsyncAPIDocument>;
+export declare function fetchAsyncApi(url: URL): Promise<AsyncAPIDocumentInterface>;

package/bin/utils/network.js

@@ -1,3 +1,4 @@
+import { validateAsyncApi } from '@mintlify/common/asyncapi';
 import yaml from 'js-yaml';
 import { launch } from 'puppeteer';
 import { framework } from './detectFramework.js';
@@ -154,7 +155,11 @@ export async function fetchAsyncApi(url) {
             throw new Error(`${res.status} ${res.statusText}`);
         }
         const file = await res.text();
-        return yaml.load(file);
+        const { document, errorMessage } = await validateAsyncApi(file);
+        if (!document) {
+            throw new Error(`${url} - this document is not a valid AsyncAPI document - ${errorMessage}`);
+        }
+        return document;
     }
     catch (error) {
         const errorMessage = getErrorMessage(error);

package/bin/utils/network.js.map

@@ -1 +1 @@
-{"version":3,"file":"network.js","sourceRoot":"","sources":["../../src/utils/network.ts"],"names":[],"mappings":"AACA,OAAO,IAAI,MAAM,SAAS,CAAC;AAE3B,OAAO,EAAW,MAAM,EAAE,MAAM,WAAW,CAAC;AAE5C,OAAO,EAAE,SAAS,EAAE,MAAM,sBAAsB,CAAC;AACjD,OAAO,EAAE,eAAe,EAAE,MAAM,aAAa,CAAC;AAC9C,OAAO,EAAE,GAAG,EAAE,MAAM,UAAU,CAAC;AAE/B,MAAM,UAAU,GAAG;IACjB,uHAAuH;IACvH,uHAAuH;IACvH,uHAAuH;IACvH,uHAAuH;IACvH,uHAAuH;CAC/G,CAAC;AAEX,MAAM,OAAO,GAAG;IACd,iBAAiB,EAAE,gBAAgB;IACnC,MAAM,EACJ,yIAAyI;IAC3I,YAAY,EACV,uHAAuH;IACzH,iBAAiB,EAAE,yBAAyB;IAC5C,UAAU,EAAE,YAAY;CAChB,CAAC;AAEX,KAAK,UAAU,kBAAkB,CAC/B,SAA2B,EAC3B,UAAkB,CAAC,EACnB,QAAgB,IAAI,EACpB,SAAiB,CAAC;IAElB,IAAI,CAAC;QACH,OAAO,MAAM,SAAS,EAAE,CAAC;IAC3B,CAAC;IAAC,OAAO,KAAK,EAAE,CAAC;QACf,IAAI,OAAO,GAAG,CAAC,EAAE,CAAC;YAChB,MAAM,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC,UAAU,CAAC,OAAO,EAAE,KAAK,CAAC,CAAC,CAAC;YAC3D,OAAO,kBAAkB,CAAC,SAAS,EAAE,OAAO,GAAG,CAAC,EAAE,KAAK,GAAG,MAAM,EAAE,MAAM,CAAC,CAAC;QAC5E,CAAC;aAAM,CAAC;YACN,MAAM,KAAK,CAAC;QACd,CAAC;IACH,CAAC;AACH,CAAC;AAED,MAAM,CAAC,KAAK,UAAU,cAAc;IAClC,IAAI,CAAC;QACH,OAAO,MAAM,MAAM,CAAC;YAClB,QAAQ,EAAE,IAAI;YACd,iBAAiB,EAAE,IAAI;SACxB,CAAC,CAAC;IACL,CAAC;IAAC,OAAO,KAAK,EAAE,CAAC;QACf,IAAI,KAAK,YAAY,KAAK,EAAE,CAAC;YAC3B,GAAG,CAAC,wCAAwC,KAAK,CAAC,OAAO,EAAE,CAAC,CAAC;QAC/D,CAAC;IACH,CAAC;AACH,CAAC;AAED,MAAM,CAAC,KAAK,UAAU,oBAAoB,CACxC,OAAgB,EAChB,GAAiB;IAEjB,IAAI,CAAC;QACH,MAAM,IAAI,GAAG,MAAM,OAAO,CAAC,OAAO,EAAE,CAAC;QAErC,MAAM,IAAI,CAAC,WAAW,CAAC;YACrB,KAAK,EAAE,IAAI;YACX,MAAM,EAAE,IAAI;YACZ,iBAAiB,EAAE,CAAC;YACpB,QAAQ,EAAE,KAAK;YACf,QAAQ,EAAE,KAAK;YACf,WAAW,EAAE,IAAI;SAClB,CAAC,CAAC;QACH,MAAM,IAAI,CAAC,mBAAmB,CAAC,OAAO,CAAC,CAAC;QACxC,MAAM,IAAI,CAAC,YAAY,CACrB,UAAU,CAAC,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,MAAM,EAAE,GAAG,UAAU,CAAC,MAAM,CAAC,CAAC,IAAI,UAAU,CAAC,CAAC,CAAC,CAC3E,CAAC;QACF,MAAM,IAAI,CAAC,oBAAoB,CAAC,IAAI,CAAC,CAAC;QAEtC,MAAM,kBAAkB,CAAC,GAAG,EAAE,CAC5B,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,QAAQ,EAAE,EAAE;YACxB,SAAS,EAAE,cAAc;YACzB,OAAO,EAAE,KAAK;SACf,CAAC,CACH,CAAC;QAEF,IAAI,SAAS,CAAC,MAAM,KAAK,YAAY,EAAE,CAAC;YACtC,MAAM,IAAI,CAAC,QAAQ,CAAC,GAAG,EAAE;gBACvB,QAAQ,CAAC,gBAAgB,CACvB,OAAO,EACP,CAAC,CAAC,EAAE,EAAE;oBACJ,IAAI,CAAC,CAAC,MAAM,YAAY,OAAO,IAAI,CAAC,CAAC,MAAM,CAAC,SAAS,CAAC,QAAQ,CAAC,qBAAqB,CAAC;wBACnF,CAAC,CAAC,cAAc,EAAE,CAAC;gBACvB,CAAC,EACD,IAAI,CACL,CAAC;gBAEF,SAAS,UAAU,CAAC,EAA0B;oBAC5C,MAAM,SAAS,GAAG,EAAE,CAAC,sBAAsB,CACzC,qBAAqB,CACW,CAAC;oBACnC,KAAK,MAAM,IAAI,IAAI,SAAS,EAAE,CAAC;wBAC7B,IAAI,CAAC,KAAK,EAAE,CAAC;wBACb,UAAU,CAAC,IAAI,CAAC,CAAC;oBACnB,CAAC;gBACH,CAAC;gBACD,UAAU,CAAC,QAAQ,CAAC,CAAC;YACvB,CAAC,CAAC,CAAC;QACL,CAAC;QAED,MAAM,OAAO,GAAG,MAAM,kBAAkB,CAAC,GAAG,EAAE,CAAC,IAAI,CAAC,OAAO,EAAE,CAAC,CAAC;QAC/D,MAAM,IAAI,CAAC,KAAK,EAAE,CAAC;QACnB,OAAO,OAAO,CAAC;IACjB,CAAC;IAAC,OAAO,KAAK,EAAE,CAAC;QACf,MAAM,YAAY,GAAG,eAAe,CAAC,KAAK,CAAC,CAAC;QAC5C,MAAM,IAAI,KAAK,CAAC,yCAAyC,YAAY,EAAE,CAAC,CAAC;IAC3E,CAAC;AACH,CAAC;AAED,KAAK,UAAU,iBAAiB,CAAC,GAAiB;IAChD,IAAI,CAAC;QACH,MAAM,GAAG,GAAG,MAAM,KAAK,CAAC,GAAG,CAAC,CAAC;QAC7B,IAAI,CAAC,GAAG,CAAC,EAAE,EAAE,CAAC;YACZ,MAAM,IAAI,KAAK,CAAC,GAAG,GAAG,CAAC,MAAM,IAAI,GAAG,CAAC,UAAU,EAAE,CAAC,CAAC;QACrD,CAAC;QACD,OAAO,MAAM,GAAG,CAAC,IAAI,EAAE,CAAC;IAC1B,CAAC;IAAC,OAAO,KAAK,EAAE,CAAC;QACf,MAAM,YAAY,GAAG,eAAe,CAAC,KAAK,CAAC,CAAC;QAC5C,MAAM,IAAI,KAAK,CAAC,mCAAmC,YAAY,EAAE,CAAC,CAAC;IACrE,CAAC;AACH,CAAC;AAED,MAAM,CAAC,KAAK,UAAU,aAAa,CACjC,GAAiB,EACjB,UAA+B,SAAS;IAExC,IAAI,CAAC;QACH,IAAI,GAAG,GAAuB,SAAS,CAAC;QACxC,IAAI,OAAO,EAAE,CAAC;YACZ,GAAG,GAAG,MAAM,oBAAoB,CAAC,OAAO,EAAE,GAAG,CAAC,CAAC;QACjD,CAAC;aAAM,CAAC;YACN,GAAG,GAAG,MAAM,kBAAkB,CAAC,GAAG,EAAE,CAAC,iBAAiB,CAAC,GAAG,CAAC,CAAC,CAAC;QAC/D,CAAC;QACD,IAAI,GAAG;YAAE,OAAO,GAAG,CAAC;QACpB,MAAM,IAAI,KAAK,CAAC,2BAA2B,CAAC,CAAC;IAC/C,CAAC;IAAC,OAAO,KAAK,EAAE,CAAC;QACf,MAAM,YAAY,GAAG,eAAe,CAAC,KAAK,CAAC,CAAC;QAC5C,MAAM,IAAI,KAAK,CAAC,6BAA6B,GAAG,CAAC,QAAQ,EAAE,GAAG,YAAY,EAAE,CAAC,CAAC;IAChF,CAAC;AACH,CAAC;AAED,MAAM,CAAC,KAAK,UAAU,UAAU,CAAC,GAAW;IAC1C,IAAI,CAAC;QACH,MAAM,GAAG,GAAG,MAAM,kBAAkB,CAAC,GAAG,EAAE,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC;QACvD,IAAI,CAAC,GAAG,CAAC,EAAE,EAAE,CAAC;YACZ,MAAM,IAAI,KAAK,CAAC,GAAG,GAAG,CAAC,MAAM,IAAI,GAAG,CAAC,UAAU,EAAE,CAAC,CAAC;QACrD,CAAC;QAED,MAAM,WAAW,GAAG,MAAM,GAAG,CAAC,WAAW,EAAE,CAAC;QAC5C,MAAM,SAAS,GAAG,IAAI,UAAU,CAAC,WAAW,CAAC,CAAC;QAE9C,OAAO,SAAS,CAAC;IACnB,CAAC;IAAC,OAAO,KAAK,EAAE,CAAC;QACf,MAAM,YAAY,GAAG,eAAe,CAAC,KAAK,CAAC,CAAC;QAC5C,MAAM,IAAI,KAAK,CAAC,GAAG,GAAG,0CAA0C,YAAY,EAAE,CAAC,CAAC;IAClF,CAAC;AACH,CAAC;AAED,MAAM,CAAC,KAAK,UAAU,YAAY,CAAC,GAAQ;IACzC,IAAI,CAAC;QACH,MAAM,GAAG,GAAG,MAAM,KAAK,CAAC,GAAG,CAAC,CAAC;QAC7B,IAAI,CAAC,GAAG,CAAC,EAAE,EAAE,CAAC;YACZ,MAAM,IAAI,KAAK,CAAC,GAAG,GAAG,CAAC,MAAM,IAAI,GAAG,CAAC,UAAU,EAAE,CAAC,CAAC;QACrD,CAAC;QACD,MAAM,IAAI,GAAG,MAAM,GAAG,CAAC,IAAI,EAAE,CAAC;QAC9B,OAAO,IAAI,CAAC,IAAI,CAAC,IAAI,CAAqB,CAAC;IAC7C,CAAC;IAAC,OAAO,KAAK,EAAE,CAAC;QACf,MAAM,YAAY,GAAG,eAAe,CAAC,KAAK,CAAC,CAAC;QAC5C,MAAM,IAAI,KAAK,CAAC,GAAG,GAAG,iDAAiD,YAAY,EAAE,CAAC,CAAC;IACzF,CAAC;AACH,CAAC;AAED,MAAM,CAAC,KAAK,UAAU,aAAa,CAAC,GAAQ;IAC1C,IAAI,CAAC;QACH,MAAM,GAAG,GAAG,MAAM,KAAK,CAAC,GAAG,CAAC,CAAC;QAC7B,IAAI,CAAC,GAAG,CAAC,EAAE,EAAE,CAAC;YACZ,MAAM,IAAI,KAAK,CAAC,GAAG,GAAG,CAAC,MAAM,IAAI,GAAG,CAAC,UAAU,EAAE,CAAC,CAAC;QACrD,CAAC;QACD,MAAM,IAAI,GAAG,MAAM,GAAG,CAAC,IAAI,EAAE,CAAC;QAC9B,OAAO,IAAI,CAAC,IAAI,CAAC,IAAI,CAAqB,CAAC;IAC7C,CAAC;IAAC,OAAO,KAAK,EAAE,CAAC;QACf,MAAM,YAAY,GAAG,eAAe,CAAC,KAAK,CAAC,CAAC;QAC5C,MAAM,IAAI,KAAK,CAAC,GAAG,GAAG,qDAAqD,YAAY,EAAE,CAAC,CAAC;IAC7F,CAAC;AACH,CAAC"}
+{"version":3,"file":"network.js","sourceRoot":"","sources":["../../src/utils/network.ts"],"names":[],"mappings":"AAAA,OAAO,EAA6B,gBAAgB,EAAE,MAAM,2BAA2B,CAAC;AACxF,OAAO,IAAI,MAAM,SAAS,CAAC;AAE3B,OAAO,EAAW,MAAM,EAAE,MAAM,WAAW,CAAC;AAE5C,OAAO,EAAE,SAAS,EAAE,MAAM,sBAAsB,CAAC;AACjD,OAAO,EAAE,eAAe,EAAE,MAAM,aAAa,CAAC;AAC9C,OAAO,EAAE,GAAG,EAAE,MAAM,UAAU,CAAC;AAE/B,MAAM,UAAU,GAAG;IACjB,uHAAuH;IACvH,uHAAuH;IACvH,uHAAuH;IACvH,uHAAuH;IACvH,uHAAuH;CAC/G,CAAC;AAEX,MAAM,OAAO,GAAG;IACd,iBAAiB,EAAE,gBAAgB;IACnC,MAAM,EACJ,yIAAyI;IAC3I,YAAY,EACV,uHAAuH;IACzH,iBAAiB,EAAE,yBAAyB;IAC5C,UAAU,EAAE,YAAY;CAChB,CAAC;AAEX,KAAK,UAAU,kBAAkB,CAC/B,SAA2B,EAC3B,UAAkB,CAAC,EACnB,QAAgB,IAAI,EACpB,SAAiB,CAAC;IAElB,IAAI,CAAC;QACH,OAAO,MAAM,SAAS,EAAE,CAAC;IAC3B,CAAC;IAAC,OAAO,KAAK,EAAE,CAAC;QACf,IAAI,OAAO,GAAG,CAAC,EAAE,CAAC;YAChB,MAAM,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC,UAAU,CAAC,OAAO,EAAE,KAAK,CAAC,CAAC,CAAC;YAC3D,OAAO,kBAAkB,CAAC,SAAS,EAAE,OAAO,GAAG,CAAC,EAAE,KAAK,GAAG,MAAM,EAAE,MAAM,CAAC,CAAC;QAC5E,CAAC;aAAM,CAAC;YACN,MAAM,KAAK,CAAC;QACd,CAAC;IACH,CAAC;AACH,CAAC;AAED,MAAM,CAAC,KAAK,UAAU,cAAc;IAClC,IAAI,CAAC;QACH,OAAO,MAAM,MAAM,CAAC;YAClB,QAAQ,EAAE,IAAI;YACd,iBAAiB,EAAE,IAAI;SACxB,CAAC,CAAC;IACL,CAAC;IAAC,OAAO,KAAK,EAAE,CAAC;QACf,IAAI,KAAK,YAAY,KAAK,EAAE,CAAC;YAC3B,GAAG,CAAC,wCAAwC,KAAK,CAAC,OAAO,EAAE,CAAC,CAAC;QAC/D,CAAC;IACH,CAAC;AACH,CAAC;AAED,MAAM,CAAC,KAAK,UAAU,oBAAoB,CACxC,OAAgB,EAChB,GAAiB;IAEjB,IAAI,CAAC;QACH,MAAM,IAAI,GAAG,MAAM,OAAO,CAAC,OAAO,EAAE,CAAC;QAErC,MAAM,IAAI,CAAC,WAAW,CAAC;YACrB,KAAK,EAAE,IAAI;YACX,MAAM,EAAE,IAAI;YACZ,iBAAiB,EAAE,CAAC;YACpB,QAAQ,EAAE,KAAK;YACf,QAAQ,EAAE,KAAK;YACf,WAAW,EAAE,IAAI;SAClB,CAAC,CAAC;QACH,MAAM,IAAI,CAAC,mBAAmB,CAAC,OAAO,CAAC,CAAC;QACxC,MAAM,IAAI,CAAC,YAAY,CACrB,UAAU,CAAC,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,MAAM,EAAE,GAAG,UAAU,CAAC,MAAM,CAAC,CAAC,IAAI,UAAU,CAAC,CAAC,CAAC,CAC3E,CAAC;QACF,MAAM,IAAI,CAAC,oBAAoB,CAAC,IAAI,CAAC,CAAC;QAEtC,MAAM,kBAAkB,CAAC,GAAG,EAAE,CAC5B,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,QAAQ,EAAE,EAAE;YACxB,SAAS,EAAE,cAAc;YACzB,OAAO,EAAE,KAAK;SACf,CAAC,CACH,CAAC;QAEF,IAAI,SAAS,CAAC,MAAM,KAAK,YAAY,EAAE,CAAC;YACtC,MAAM,IAAI,CAAC,QAAQ,CAAC,GAAG,EAAE;gBACvB,QAAQ,CAAC,gBAAgB,CACvB,OAAO,EACP,CAAC,CAAC,EAAE,EAAE;oBACJ,IAAI,CAAC,CAAC,MAAM,YAAY,OAAO,IAAI,CAAC,CAAC,MAAM,CAAC,SAAS,CAAC,QAAQ,CAAC,qBAAqB,CAAC;wBACnF,CAAC,CAAC,cAAc,EAAE,CAAC;gBACvB,CAAC,EACD,IAAI,CACL,CAAC;gBAEF,SAAS,UAAU,CAAC,EAA0B;oBAC5C,MAAM,SAAS,GAAG,EAAE,CAAC,sBAAsB,CACzC,qBAAqB,CACW,CAAC;oBACnC,KAAK,MAAM,IAAI,IAAI,SAAS,EAAE,CAAC;wBAC7B,IAAI,CAAC,KAAK,EAAE,CAAC;wBACb,UAAU,CAAC,IAAI,CAAC,CAAC;oBACnB,CAAC;gBACH,CAAC;gBACD,UAAU,CAAC,QAAQ,CAAC,CAAC;YACvB,CAAC,CAAC,CAAC;QACL,CAAC;QAED,MAAM,OAAO,GAAG,MAAM,kBAAkB,CAAC,GAAG,EAAE,CAAC,IAAI,CAAC,OAAO,EAAE,CAAC,CAAC;QAC/D,MAAM,IAAI,CAAC,KAAK,EAAE,CAAC;QACnB,OAAO,OAAO,CAAC;IACjB,CAAC;IAAC,OAAO,KAAK,EAAE,CAAC;QACf,MAAM,YAAY,GAAG,eAAe,CAAC,KAAK,CAAC,CAAC;QAC5C,MAAM,IAAI,KAAK,CAAC,yCAAyC,YAAY,EAAE,CAAC,CAAC;IAC3E,CAAC;AACH,CAAC;AAED,KAAK,UAAU,iBAAiB,CAAC,GAAiB;IAChD,IAAI,CAAC;QACH,MAAM,GAAG,GAAG,MAAM,KAAK,CAAC,GAAG,CAAC,CAAC;QAC7B,IAAI,CAAC,GAAG,CAAC,EAAE,EAAE,CAAC;YACZ,MAAM,IAAI,KAAK,CAAC,GAAG,GAAG,CAAC,MAAM,IAAI,GAAG,CAAC,UAAU,EAAE,CAAC,CAAC;QACrD,CAAC;QACD,OAAO,MAAM,GAAG,CAAC,IAAI,EAAE,CAAC;IAC1B,CAAC;IAAC,OAAO,KAAK,EAAE,CAAC;QACf,MAAM,YAAY,GAAG,eAAe,CAAC,KAAK,CAAC,CAAC;QAC5C,MAAM,IAAI,KAAK,CAAC,mCAAmC,YAAY,EAAE,CAAC,CAAC;IACrE,CAAC;AACH,CAAC;AAED,MAAM,CAAC,KAAK,UAAU,aAAa,CACjC,GAAiB,EACjB,UAA+B,SAAS;IAExC,IAAI,CAAC;QACH,IAAI,GAAG,GAAuB,SAAS,CAAC;QACxC,IAAI,OAAO,EAAE,CAAC;YACZ,GAAG,GAAG,MAAM,oBAAoB,CAAC,OAAO,EAAE,GAAG,CAAC,CAAC;QACjD,CAAC;aAAM,CAAC;YACN,GAAG,GAAG,MAAM,kBAAkB,CAAC,GAAG,EAAE,CAAC,iBAAiB,CAAC,GAAG,CAAC,CAAC,CAAC;QAC/D,CAAC;QACD,IAAI,GAAG;YAAE,OAAO,GAAG,CAAC;QACpB,MAAM,IAAI,KAAK,CAAC,2BAA2B,CAAC,CAAC;IAC/C,CAAC;IAAC,OAAO,KAAK,EAAE,CAAC;QACf,MAAM,YAAY,GAAG,eAAe,CAAC,KAAK,CAAC,CAAC;QAC5C,MAAM,IAAI,KAAK,CAAC,6BAA6B,GAAG,CAAC,QAAQ,EAAE,GAAG,YAAY,EAAE,CAAC,CAAC;IAChF,CAAC;AACH,CAAC;AAED,MAAM,CAAC,KAAK,UAAU,UAAU,CAAC,GAAW;IAC1C,IAAI,CAAC;QACH,MAAM,GAAG,GAAG,MAAM,kBAAkB,CAAC,GAAG,EAAE,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC;QACvD,IAAI,CAAC,GAAG,CAAC,EAAE,EAAE,CAAC;YACZ,MAAM,IAAI,KAAK,CAAC,GAAG,GAAG,CAAC,MAAM,IAAI,GAAG,CAAC,UAAU,EAAE,CAAC,CAAC;QACrD,CAAC;QAED,MAAM,WAAW,GAAG,MAAM,GAAG,CAAC,WAAW,EAAE,CAAC;QAC5C,MAAM,SAAS,GAAG,IAAI,UAAU,CAAC,WAAW,CAAC,CAAC;QAE9C,OAAO,SAAS,CAAC;IACnB,CAAC;IAAC,OAAO,KAAK,EAAE,CAAC;QACf,MAAM,YAAY,GAAG,eAAe,CAAC,KAAK,CAAC,CAAC;QAC5C,MAAM,IAAI,KAAK,CAAC,GAAG,GAAG,0CAA0C,YAAY,EAAE,CAAC,CAAC;IAClF,CAAC;AACH,CAAC;AAED,MAAM,CAAC,KAAK,UAAU,YAAY,CAAC,GAAQ;IACzC,IAAI,CAAC;QACH,MAAM,GAAG,GAAG,MAAM,KAAK,CAAC,GAAG,CAAC,CAAC;QAC7B,IAAI,CAAC,GAAG,CAAC,EAAE,EAAE,CAAC;YACZ,MAAM,IAAI,KAAK,CAAC,GAAG,GAAG,CAAC,MAAM,IAAI,GAAG,CAAC,UAAU,EAAE,CAAC,CAAC;QACrD,CAAC;QACD,MAAM,IAAI,GAAG,MAAM,GAAG,CAAC,IAAI,EAAE,CAAC;QAC9B,OAAO,IAAI,CAAC,IAAI,CAAC,IAAI,CAAqB,CAAC;IAC7C,CAAC;IAAC,OAAO,KAAK,EAAE,CAAC;QACf,MAAM,YAAY,GAAG,eAAe,CAAC,KAAK,CAAC,CAAC;QAC5C,MAAM,IAAI,KAAK,CAAC,GAAG,GAAG,iDAAiD,YAAY,EAAE,CAAC,CAAC;IACzF,CAAC;AACH,CAAC;AAED,MAAM,CAAC,KAAK,UAAU,aAAa,CAAC,GAAQ;IAC1C,IAAI,CAAC;QACH,MAAM,GAAG,GAAG,MAAM,KAAK,CAAC,GAAG,CAAC,CAAC;QAC7B,IAAI,CAAC,GAAG,CAAC,EAAE,EAAE,CAAC;YACZ,MAAM,IAAI,KAAK,CAAC,GAAG,GAAG,CAAC,MAAM,IAAI,GAAG,CAAC,UAAU,EAAE,CAAC,CAAC;QACrD,CAAC;QACD,MAAM,IAAI,GAAG,MAAM,GAAG,CAAC,IAAI,EAAE,CAAC;QAC9B,MAAM,EAAE,QAAQ,EAAE,YAAY,EAAE,GAAG,MAAM,gBAAgB,CAAC,IAAI,CAAC,CAAC;QAChE,IAAI,CAAC,QAAQ,EAAE,CAAC;YACd,MAAM,IAAI,KAAK,CAAC,GAAG,GAAG,uDAAuD,YAAY,EAAE,CAAC,CAAC;QAC/F,CAAC;QACD,OAAO,QAAQ,CAAC;IAClB,CAAC;IAAC,OAAO,KAAK,EAAE,CAAC;QACf,MAAM,YAAY,GAAG,eAAe,CAAC,KAAK,CAAC,CAAC;QAC5C,MAAM,IAAI,KAAK,CAAC,GAAG,GAAG,qDAAqD,YAAY,EAAE,CAAC,CAAC;IAC7F,CAAC;AACH,CAAC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@mintlify/scraping",
-  "version": "4.0.163",
+  "version": "4.0.165",
   "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.313",
+    "@mintlify/common": "1.0.314",
     "@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": "80ca70a57da4c2ee4db8430fb977ad46a8f9c78b"
+  "gitHead": "5f1fad60cd8625ceeaeb5e06fcd5aae5c65b2573"
 }

package/src/apiPages/common.ts

@@ -0,0 +1,61 @@
+// Functions used for both OpenAPI and AsyncAPI page generation
+import { NavigationEntry } from '@mintlify/models';
+import {
+  DecoratedGroupsConfig,
+  DecoratedPagesConfig,
+  GroupsConfig,
+  PagesConfig,
+} from '@mintlify/validation';
+
+export const DEFAULT_API_GROUP_NAME = 'API Reference';
+export const DEFAULT_WEBHOOK_GROUP_NAME = 'Webhooks';
+export const DEFAULT_WEBSOCKETS_GROUP_NAME = 'Websockets';
+
+export const findNavGroup = (
+  nav: GroupsConfig | DecoratedGroupsConfig,
+  groupName: string = DEFAULT_API_GROUP_NAME
+): PagesConfig | DecoratedPagesConfig => {
+  const group = nav.find(
+    (fileOrGroup) =>
+      typeof fileOrGroup === 'object' && 'group' in fileOrGroup && fileOrGroup.group === groupName
+  );
+  if (group === undefined || !('pages' in group)) {
+    const newGroup = {
+      group: groupName,
+      pages: [],
+    };
+    nav.push(newGroup);
+    return newGroup.pages;
+  } else {
+    return group.pages;
+  }
+};
+
+export const prepareStringToBeValidFilename = (str?: string) =>
+  str
+    ? str
+        .replaceAll(' ', '-')
+        .replace(/\{.*?\}/g, '-') // remove path parameters
+        .replace(/^-/, '')
+        .replace(/-$/, '')
+        .replace(/[{}(),.'\n\/]/g, '') // remove special characters
+        .replaceAll(/--/g, '-') // replace double hyphens
+        .toLowerCase()
+    : undefined;
+
+// returns a filename that is unique within the given array of pages
+export const generateUniqueFilenameWithoutExtension = (
+  pages: NavigationEntry[],
+  base: string
+): string => {
+  let filename = base;
+  if (pages.includes(filename)) {
+    let extension = 1;
+    filename = `${base}-${extension}`;
+    while (pages.includes(filename)) {
+      extension += 1;
+      filename = `${base}-${extension}`;
+    }
+  }
+  return filename;
+};

package/src/asyncapi/getAsyncApiDefinition.ts

@@ -1,13 +1,13 @@
-import { AsyncAPISchema } from '@mintlify/common/asyncapi';
+import { AsyncAPIDocumentInterface, validateAsyncApi } from '@mintlify/common/asyncapi';
 import * as fs from 'fs/promises';
-import yaml from 'js-yaml';
 import * as path from 'path';
 
 import { fetchAsyncApi } from '../utils/network.js';
 
 export const getAsyncApiDefinition = async (
-  pathOrDocumentOrUrl: string | AsyncAPISchema | URL
-): Promise<{ document: AsyncAPISchema; isUrl: boolean }> => {
+  pathOrDocumentOrUrl: string | URL
+): Promise<{ document: AsyncAPIDocumentInterface | undefined; isUrl: boolean }> => {
+  let document: AsyncAPIDocumentInterface | undefined = undefined;
   if (typeof pathOrDocumentOrUrl === 'string') {
     if (pathOrDocumentOrUrl.startsWith('http://')) {
       // This is an invalid location either for a file or a URL
@@ -18,8 +18,18 @@ export const getAsyncApiDefinition = async (
         pathOrDocumentOrUrl = url;
       } catch {
         const pathname = path.join(process.cwd(), pathOrDocumentOrUrl.toString());
-        const file = await fs.readFile(pathname, 'utf-8');
-        pathOrDocumentOrUrl = yaml.load(file) as AsyncAPISchema;
+        try {
+          const file = await fs.readFile(pathname, 'utf-8');
+          const { document: asyncApiDocument, errorMessage } = await validateAsyncApi(file);
+          if (!asyncApiDocument) {
+            throw new Error(
+              `${pathname} - this document is not a valid AsyncAPI document - ${errorMessage}`
+            );
+          }
+          document = asyncApiDocument;
+        } catch (error) {
+          throw new Error(`Failed to read file ${pathname} - ${error}`);
+        }
       }
     }
   }
@@ -28,8 +38,8 @@ export const getAsyncApiDefinition = async (
     if (pathOrDocumentOrUrl.protocol !== 'https:') {
       throw new Error('Only HTTPS URLs are supported. Please provide an HTTPS URL');
     }
-    pathOrDocumentOrUrl = await fetchAsyncApi(pathOrDocumentOrUrl);
+    document = await fetchAsyncApi(pathOrDocumentOrUrl);
   }
 
-  return { document: pathOrDocumentOrUrl, isUrl };
+  return { document, isUrl };
 };

package/src/asyncapi/processAsyncApiChannel.ts

@@ -0,0 +1,104 @@
+import { optionallyAddLeadingSlash } from '@mintlify/common';
+import { AsyncAPIChannel } from '@mintlify/common/asyncapi';
+import { DecoratedNavigationPage } from '@mintlify/models';
+import {
+  DecoratedGroupsConfig,
+  DecoratedPagesConfig,
+  GroupsConfig,
+  PagesConfig,
+} from '@mintlify/validation';
+import fse from 'fs-extra';
+import { outputFile } from 'fs-extra';
+import { join, resolve } from 'path';
+
+import {
+  DEFAULT_WEBSOCKETS_GROUP_NAME,
+  prepareStringToBeValidFilename,
+  generateUniqueFilenameWithoutExtension,
+} from '../apiPages/common.js';
+
+type GenerateAsyncApiPagesOptions = {
+  asyncApiFilePath?: string;
+  version?: string;
+  writeFiles?: boolean;
+  outDir?: string;
+  outDirBasePath?: string;
+  overwrite?: boolean;
+};
+
+type ProcessAsyncApiChannelArgs = {
+  channel: AsyncAPIChannel;
+  nav: GroupsConfig;
+  decoratedNav: DecoratedGroupsConfig;
+  writePromises: Promise<void>[];
+  pagesAcc: Record<string, DecoratedNavigationPage>;
+  opts?: GenerateAsyncApiPagesOptions;
+  findNavGroup: (
+    nav: GroupsConfig | DecoratedGroupsConfig,
+    groupName: string
+  ) => PagesConfig | DecoratedPagesConfig;
+};
+
+export const processAsyncApiChannel = ({
+  channel,
+  nav,
+  decoratedNav,
+  writePromises,
+  pagesAcc,
+  opts,
+  findNavGroup,
+}: ProcessAsyncApiChannelArgs) => {
+  const asyncApiFilePathFromRoot = 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 description = channel.description() ?? channel.summary() ?? '';
+
+  const folder = prepareStringToBeValidFilename(groupName) ?? '';
+  const base = join(opts?.outDir ?? '', folder, title);
+
+  const navGroup = findNavGroup(nav, groupName);
+  const decoratedNavGroup = findNavGroup(decoratedNav, groupName);
+
+  const filenameWithoutExtension = generateUniqueFilenameWithoutExtension(navGroup, base);
+
+  const asyncApiMetaTag = `${
+    asyncApiFilePathFromRoot ? `${asyncApiFilePathFromRoot} ` : ''
+  }${operation} ${channelId}`;
+
+  navGroup.push(filenameWithoutExtension);
+
+  const page: DecoratedNavigationPage = {
+    asyncapi: asyncApiMetaTag,
+    href: resolve('/', filenameWithoutExtension),
+    title: title,
+    description,
+    version: opts?.version,
+  };
+  decoratedNavGroup.push(page);
+  pagesAcc[filenameWithoutExtension] = page;
+
+  const targetPath = opts?.outDirBasePath
+    ? join(opts.outDirBasePath, `${filenameWithoutExtension}.mdx`)
+    : `${filenameWithoutExtension}.mdx`;
+  if (opts?.writeFiles && (!fse.pathExistsSync(targetPath) || opts.overwrite)) {
+    writePromises.push(createAsyncApiFrontmatter(targetPath, asyncApiMetaTag, opts.version));
+  }
+};
+
+const createAsyncApiFrontmatter = async (
+  filename: string,
+  asyncApiMetaTag: string,
+  version?: string
+) => {
+  const data = `---
+asyncapi: ${asyncApiMetaTag}${version ? `\nversion: ${version}` : ''}
+---`;
+
+  await outputFile(filename, data);
+};

package/src/openapi/common.ts

@@ -3,7 +3,7 @@ import {
   optionallyAddLeadingSlash,
   slugToTitle,
 } from '@mintlify/common';
-import type { DecoratedNavigationPage, NavigationEntry } from '@mintlify/models';
+import type { DecoratedNavigationPage } from '@mintlify/models';
 import { outputFile } from 'fs-extra';
 import fse from 'fs-extra';
 import fs from 'fs/promises';
@@ -11,6 +11,11 @@ import yaml from 'js-yaml';
 import { OpenAPI, OpenAPIV3 } from 'openapi-types';
 import path, { join, parse, resolve } from 'path';
 
+import {
+  DEFAULT_WEBHOOK_GROUP_NAME,
+  prepareStringToBeValidFilename,
+  generateUniqueFilenameWithoutExtension,
+} from '../apiPages/common.js';
 import { fetchOpenApi } from '../utils/network.js';
 
 export const getOpenApiDefinition = async (
@@ -42,23 +47,6 @@ export const getOpenApiDefinition = async (
   return { document: pathOrDocumentOrUrl, isUrl };
 };
 
-// returns a filename that is unique within the given array of pages
-export const generateUniqueFilenameWithoutExtension = (
-  pages: NavigationEntry[],
-  base: string
-): string => {
-  let filename = base;
-  if (pages.includes(filename)) {
-    let extension = 1;
-    filename = `${base}-${extension}`;
-    while (pages.includes(filename)) {
-      extension += 1;
-      filename = `${base}-${extension}`;
-    }
-  }
-  return filename;
-};
-
 export const createOpenApiFrontmatter = async (
   filename: string,
   openApiMetaTag: string,
@@ -71,18 +59,6 @@ openapi: ${openApiMetaTag}${version ? `\nversion: ${version}` : ''}
   await outputFile(filename, data);
 };
 
-export const prepareStringToBeValidFilename = (str?: string) =>
-  str
-    ? str
-        .replaceAll(' ', '-')
-        .replace(/\{.*?\}/g, '-') // remove path parameters
-        .replace(/^-/, '')
-        .replace(/-$/, '')
-        .replace(/[{}(),.'\n\/]/g, '') // remove special characters
-        .replaceAll(/--/g, '-') // replace double hyphens
-        .toLowerCase()
-    : undefined;
-
 export type GenerateOpenApiPagesOptions = {
   openApiFilePath?: string;
   version?: string;
@@ -165,9 +141,6 @@ export function processOpenApiPath<N, DN>(
   });
 }
 
-export const DEFAULT_API_GROUP_NAME = 'API Reference';
-export const DEFAULT_WEBHOOK_GROUP_NAME = 'Webhooks';
-
 export function processOpenApiWebhook<N, DN>(
   webhook: string,
   webhookObject: OpenAPIV3.PathItemObject,

package/src/openapi/generateOpenApiPages.ts

@@ -8,12 +8,12 @@ import type {
 } from '@mintlify/models';
 import { OpenAPI } from 'openapi-types';
 
+import { DEFAULT_API_GROUP_NAME } from '../apiPages/common.js';
 import {
   getOpenApiDefinition,
   GenerateOpenApiPagesOptions,
   OpenApiPageGenerationResult,
   processOpenApiPath,
-  DEFAULT_API_GROUP_NAME,
   processOpenApiWebhook,
 } from './common.js';
 

package/src/openapi/generateOpenApiPagesForDocsConfig.ts

@@ -1,19 +1,14 @@
 import { validate } from '@mintlify/common';
 import { DecoratedNavigationPage } from '@mintlify/models';
-import {
-  DecoratedGroupsConfig,
-  GroupsConfig,
-  PagesConfig,
-  DecoratedPagesConfig,
-} from '@mintlify/validation';
+import { DecoratedGroupsConfig, GroupsConfig } from '@mintlify/validation';
 import { OpenAPI } from 'openapi-types';
 
+import { findNavGroup } from '../apiPages/common.js';
 import {
   getOpenApiDefinition,
   GenerateOpenApiPagesOptions,
   OpenApiPageGenerationResult,
   processOpenApiPath,
-  DEFAULT_API_GROUP_NAME,
   processOpenApiWebhook,
 } from './common.js';
 
@@ -90,23 +85,3 @@ export async function generateOpenApiPagesForDocsConfig(
     isUrl,
   };
 }
-
-const findNavGroup = (
-  nav: GroupsConfig | DecoratedGroupsConfig,
-  groupName: string = DEFAULT_API_GROUP_NAME
-): PagesConfig | DecoratedPagesConfig => {
-  const group = nav.find(
-    (fileOrGroup) =>
-      typeof fileOrGroup === 'object' && 'group' in fileOrGroup && fileOrGroup.group === groupName
-  );
-  if (group === undefined || !('pages' in group)) {
-    const newGroup = {
-      group: groupName,
-      pages: [],
-    };
-    nav.push(newGroup);
-    return newGroup.pages;
-  } else {
-    return group.pages;
-  }
-};

package/src/utils/log.ts

@@ -114,7 +114,7 @@ export function log(
         ? 'warn'
         : 'log'
   ](
-    `${color}${icon} ${statusMsg}${activeColors.default}${separator}${
+    `${color}${icon}${icon ? ' ' : ''}${statusMsg}${activeColors.default}${separator}${
       typeof message === 'string' ||
       typeof message === 'bigint' ||
       typeof message === 'number' ||

package/src/utils/network.ts

@@ -1,4 +1,4 @@
-import { AsyncAPIDocument } from '@mintlify/common/asyncapi';
+import { AsyncAPIDocumentInterface, validateAsyncApi } from '@mintlify/common/asyncapi';
 import yaml from 'js-yaml';
 import { OpenAPI } from 'openapi-types';
 import { Browser, launch } from 'puppeteer';
@@ -180,14 +180,18 @@ export async function fetchOpenApi(url: URL): Promise<OpenAPI.Document> {
   }
 }
 
-export async function fetchAsyncApi(url: URL): Promise<AsyncAPIDocument> {
+export async function fetchAsyncApi(url: URL): Promise<AsyncAPIDocumentInterface> {
   try {
     const res = await fetch(url);
     if (!res.ok) {
       throw new Error(`${res.status} ${res.statusText}`);
     }
     const file = await res.text();
-    return yaml.load(file) as AsyncAPIDocument;
+    const { document, errorMessage } = await validateAsyncApi(file);
+    if (!document) {
+      throw new Error(`${url} - this document is not a valid AsyncAPI document - ${errorMessage}`);
+    }
+    return document;
   } catch (error) {
     const errorMessage = getErrorMessage(error);
     throw new Error(`${url} - failed to retrieve AsyncAPI file from source - ${errorMessage}`);