@mintlify/scraping 4.0.175 → 4.0.177

package/bin/asyncapi/generateAsyncApiPagesForDocsConfig.js

@@ -0,0 +1,54 @@
+import { validateAsyncApi, } from '@mintlify/common/asyncapi';
+import { findNavGroup } from '../apiPages/common.js';
+import { getAsyncApiDefinition } from './getAsyncApiDefinition.js';
+import { processAsyncApiChannel } from './processAsyncApiChannel.js';
+export async function generateAsyncApiPagesForDocsConfig(spec, opts) {
+    let document = undefined;
+    let isUrl;
+    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 = [];
+    const decoratedNav = [];
+    const writePromises = [];
+    const pagesAcc = {};
+    channels.all().forEach((channel) => {
+        processAsyncApiChannel({
+            channel: channel,
+            nav,
+            decoratedNav,
+            writePromises,
+            pagesAcc,
+            opts,
+            findNavGroup,
+        });
+    });
+    await Promise.all(writePromises);
+    return {
+        nav,
+        decoratedNav,
+        spec: document,
+        pagesAcc,
+        isUrl,
+    };
+}
+//# sourceMappingURL=generateAsyncApiPagesForDocsConfig.js.map

package/bin/asyncapi/generateAsyncApiPagesForDocsConfig.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"generateAsyncApiPagesForDocsConfig.js","sourceRoot":"","sources":["../../src/asyncapi/generateAsyncApiPagesForDocsConfig.ts"],"names":[],"mappings":"AAAA,OAAO,EAGL,gBAAgB,GACjB,MAAM,2BAA2B,CAAC;AAInC,OAAO,EAAE,YAAY,EAAE,MAAM,uBAAuB,CAAC;AACrD,OAAO,EAAE,qBAAqB,EAAE,MAAM,4BAA4B,CAAC;AACnE,OAAO,EAAE,sBAAsB,EAAE,MAAM,6BAA6B,CAAC;AAmBrE,MAAM,CAAC,KAAK,UAAU,kCAAkC,CACtD,IAA8C,EAC9C,IAAmC;IAEnC,IAAI,QAAQ,GAA0C,SAAS,CAAC;IAChE,IAAI,KAAc,CAAC;IACnB,IAAI,OAAO,IAAI,KAAK,QAAQ,IAAI,IAAI,YAAY,GAAG,EAAE,CAAC;QACpD,MAAM,EAAE,QAAQ,EAAE,gBAAgB,EAAE,KAAK,EAAE,mBAAmB,EAAE,GAC9D,MAAM,qBAAqB,CAAC,IAAI,CAAC,CAAC;QACpC,IAAI,gBAAgB,EAAE,CAAC;YACrB,QAAQ,GAAG,gBAAgB,CAAC;QAC9B,CAAC;QACD,KAAK,GAAG,mBAAmB,CAAC;IAC9B,CAAC;SAAM,CAAC;QACN,MAAM,EAAE,KAAK,EAAE,YAAY,EAAE,QAAQ,EAAE,gBAAgB,EAAE,GAAG,MAAM,gBAAgB,CAAC,IAAI,CAAC,CAAC;QACzF,IAAI,CAAC,KAAK,IAAI,YAAY,EAAE,CAAC;YAC3B,MAAM,IAAI,KAAK,CAAC,YAAY,CAAC,CAAC;QAChC,CAAC;QACD,QAAQ,GAAG,gBAAgB,CAAC;QAC5B,KAAK,GAAG,KAAK,CAAC;IAChB,CAAC;IAED,IAAI,CAAC,QAAQ,EAAE,CAAC;QACd,MAAM,IAAI,KAAK,CAAC,qBAAqB,CAAC,CAAC;IACzC,CAAC;IAED,MAAM,QAAQ,GAAG,QAAQ,CAAC,QAAQ,EAAE,CAAC;IAErC,IAAI,QAAQ,CAAC,OAAO,EAAE,EAAE,CAAC;QACvB,MAAM,IAAI,KAAK,CAAC,qBAAqB,CAAC,CAAC;IACzC,CAAC;IAED,MAAM,GAAG,GAAiB,EAAE,CAAC;IAC7B,MAAM,YAAY,GAA0B,EAAE,CAAC;IAC/C,MAAM,aAAa,GAAoB,EAAE,CAAC;IAC1C,MAAM,QAAQ,GAA4C,EAAE,CAAC;IAE7D,QAAQ,CAAC,GAAG,EAAE,CAAC,OAAO,CAAC,CAAC,OAAO,EAAE,EAAE;QACjC,sBAAsB,CAAC;YACrB,OAAO,EAAE,OAA0B;YACnC,GAAG;YACH,YAAY;YACZ,aAAa;YACb,QAAQ;YACR,IAAI;YACJ,YAAY;SACb,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;IAEH,MAAM,OAAO,CAAC,GAAG,CAAC,aAAa,CAAC,CAAC;IAEjC,OAAO;QACL,GAAG;QACH,YAAY;QACZ,IAAI,EAAE,QAAQ;QACd,QAAQ;QACR,KAAK;KACN,CAAC;AACJ,CAAC"}

package/bin/asyncapi/processAsyncApiChannel.js

@@ -1,29 +1,31 @@
-import { optionallyAddLeadingSlash } from '@mintlify/common';
+import { optionallyAddLeadingSlash, camelToSentenceCase } from '@mintlify/common';
 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';
 export const processAsyncApiChannel = ({ channel, nav, decoratedNav, writePromises, pagesAcc, opts, findNavGroup, }) => {
     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);
     const filenameWithoutExtension = generateUniqueFilenameWithoutExtension(navGroup, base);
-    const asyncApiMetaTag = `${asyncApiFilePathFromRoot ? `${asyncApiFilePathFromRoot} ` : ''}${operation} ${channelId}`;
+    const asyncApiMetaTag = `${asyncApiFilePathFromRoot ? `${asyncApiFilePathFromRoot} ` : ''}${channelId}`;
     navGroup.push(filenameWithoutExtension);
     const page = {
         asyncapi: asyncApiMetaTag,
         href: resolve('/', filenameWithoutExtension),
-        title: title,
+        title: title === channelId ? camelToSentenceCase(title) : title,
         description,
         version: opts?.version,
     };

package/bin/asyncapi/processAsyncApiChannel.js.map

@@ -1 +1 @@
-{"version":3,"file":"processAsyncApiChannel.js","sourceRoot":"","sources":["../../src/asyncapi/processAsyncApiChannel.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,yBAAyB,EAAE,MAAM,kBAAkB,CAAC;AAS7D,OAAO,GAAG,MAAM,UAAU,CAAC;AAC3B,OAAO,EAAE,UAAU,EAAE,MAAM,UAAU,CAAC;AACtC,OAAO,EAAE,IAAI,EAAE,OAAO,EAAE,MAAM,MAAM,CAAC;AAErC,OAAO,EACL,6BAA6B,EAC7B,8BAA8B,EAC9B,sCAAsC,GACvC,MAAM,uBAAuB,CAAC;AAwB/B,MAAM,CAAC,MAAM,sBAAsB,GAAG,CAAC,EACrC,OAAO,EACP,GAAG,EACH,YAAY,EACZ,aAAa,EACb,QAAQ,EACR,IAAI,EACJ,YAAY,GACe,EAAE,EAAE;IAC/B,MAAM,wBAAwB,GAAG,IAAI,EAAE,gBAAgB;QACrD,CAAC,CAAC,yBAAyB,CAAC,IAAI,CAAC,gBAAgB,CAAC;QAClD,CAAC,CAAC,SAAS,CAAC;IAEd,MAAM,SAAS,GAAG,WAAW,CAAC;IAC9B,MAAM,IAAI,GAAG,OAAO,CAAC,IAAI,EAAE,CAAC,GAAG,EAAE,CAAC;IAClC,MAAM,SAAS,GAAG,IAAI,CAAC,CAAC,CAAC,EAAE,IAAI,EAAE,IAAI,6BAA6B,CAAC;IACnE,MAAM,SAAS,GAAG,OAAO,CAAC,EAAE,EAAE,CAAC;IAC/B,MAAM,KAAK,GAAG,OAAO,CAAC,KAAK,EAAE,IAAI,SAAS,CAAC;IAC3C,MAAM,WAAW,GAAG,OAAO,CAAC,WAAW,EAAE,IAAI,OAAO,CAAC,OAAO,EAAE,IAAI,EAAE,CAAC;IAErE,MAAM,MAAM,GAAG,8BAA8B,CAAC,SAAS,CAAC,IAAI,EAAE,CAAC;IAC/D,MAAM,IAAI,GAAG,IAAI,CAAC,IAAI,EAAE,MAAM,IAAI,EAAE,EAAE,MAAM,EAAE,KAAK,CAAC,CAAC;IAErD,MAAM,QAAQ,GAAG,YAAY,CAAC,GAAG,EAAE,SAAS,CAAC,CAAC;IAC9C,MAAM,iBAAiB,GAAG,YAAY,CAAC,YAAY,EAAE,SAAS,CAAC,CAAC;IAEhE,MAAM,wBAAwB,GAAG,sCAAsC,CAAC,QAAQ,EAAE,IAAI,CAAC,CAAC;IAExF,MAAM,eAAe,GAAG,GACtB,wBAAwB,CAAC,CAAC,CAAC,GAAG,wBAAwB,GAAG,CAAC,CAAC,CAAC,EAC9D,GAAG,SAAS,IAAI,SAAS,EAAE,CAAC;IAE5B,QAAQ,CAAC,IAAI,CAAC,wBAAwB,CAAC,CAAC;IAExC,MAAM,IAAI,GAA4B;QACpC,QAAQ,EAAE,eAAe;QACzB,IAAI,EAAE,OAAO,CAAC,GAAG,EAAE,wBAAwB,CAAC;QAC5C,KAAK,EAAE,KAAK;QACZ,WAAW;QACX,OAAO,EAAE,IAAI,EAAE,OAAO;KACvB,CAAC;IACF,iBAAiB,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;IAC7B,QAAQ,CAAC,wBAAwB,CAAC,GAAG,IAAI,CAAC;IAE1C,MAAM,UAAU,GAAG,IAAI,EAAE,cAAc;QACrC,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,cAAc,EAAE,GAAG,wBAAwB,MAAM,CAAC;QAC9D,CAAC,CAAC,GAAG,wBAAwB,MAAM,CAAC;IACtC,IAAI,IAAI,EAAE,UAAU,IAAI,CAAC,CAAC,GAAG,CAAC,cAAc,CAAC,UAAU,CAAC,IAAI,IAAI,CAAC,SAAS,CAAC,EAAE,CAAC;QAC5E,aAAa,CAAC,IAAI,CAAC,yBAAyB,CAAC,UAAU,EAAE,eAAe,EAAE,IAAI,CAAC,OAAO,CAAC,CAAC,CAAC;IAC3F,CAAC;AACH,CAAC,CAAC;AAEF,MAAM,yBAAyB,GAAG,KAAK,EACrC,QAAgB,EAChB,eAAuB,EACvB,OAAgB,EAChB,EAAE;IACF,MAAM,IAAI,GAAG;YACH,eAAe,GAAG,OAAO,CAAC,CAAC,CAAC,cAAc,OAAO,EAAE,CAAC,CAAC,CAAC,EAAE;IAChE,CAAC;IAEH,MAAM,UAAU,CAAC,QAAQ,EAAE,IAAI,CAAC,CAAC;AACnC,CAAC,CAAC"}
+{"version":3,"file":"processAsyncApiChannel.js","sourceRoot":"","sources":["../../src/asyncapi/processAsyncApiChannel.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,yBAAyB,EAAE,mBAAmB,EAAE,MAAM,kBAAkB,CAAC;AASlF,OAAO,GAAG,MAAM,UAAU,CAAC;AAC3B,OAAO,EAAE,UAAU,EAAE,MAAM,UAAU,CAAC;AACtC,OAAO,EAAE,IAAI,EAAE,OAAO,EAAE,MAAM,MAAM,CAAC;AAErC,OAAO,EACL,6BAA6B,EAC7B,8BAA8B,EAC9B,sCAAsC,GACvC,MAAM,uBAAuB,CAAC;AAwB/B,MAAM,CAAC,MAAM,sBAAsB,GAAG,CAAC,EACrC,OAAO,EACP,GAAG,EACH,YAAY,EACZ,aAAa,EACb,QAAQ,EACR,IAAI,EACJ,YAAY,GACe,EAAE,EAAE;IAC/B,MAAM,wBAAwB,GAAG,IAAI,EAAE,gBAAgB;QACrD,CAAC,CAAC,IAAI,CAAC,gBAAgB,CAAC,UAAU,CAAC,UAAU,CAAC;YAC5C,CAAC,CAAC,IAAI,CAAC,gBAAgB;YACvB,CAAC,CAAC,yBAAyB,CAAC,IAAI,CAAC,gBAAgB,CAAC;QACpD,CAAC,CAAC,SAAS,CAAC;IAEd,MAAM,IAAI,GAAG,OAAO,CAAC,IAAI,EAAE,CAAC,GAAG,EAAE,CAAC;IAClC,MAAM,SAAS,GAAG,IAAI,CAAC,CAAC,CAAC,EAAE,IAAI,EAAE,IAAI,6BAA6B,CAAC;IACnE,MAAM,SAAS,GAAG,OAAO,CAAC,EAAE,EAAE,CAAC;IAC/B,MAAM,KAAK,GAAG,OAAO,CAAC,KAAK,EAAE,IAAI,SAAS,CAAC;IAC3C,MAAM,QAAQ,GAAG,8BAA8B,CAAC,KAAK,CAAC,IAAI,EAAE,CAAC;IAC7D,MAAM,WAAW,GAAG,OAAO,CAAC,WAAW,EAAE,IAAI,OAAO,CAAC,OAAO,EAAE,IAAI,EAAE,CAAC;IAErE,MAAM,MAAM,GAAG,8BAA8B,CAAC,SAAS,CAAC,IAAI,EAAE,CAAC;IAC/D,MAAM,IAAI,GAAG,IAAI,CAAC,IAAI,EAAE,MAAM,IAAI,EAAE,EAAE,MAAM,EAAE,QAAQ,CAAC,CAAC;IAExD,MAAM,QAAQ,GAAG,YAAY,CAAC,GAAG,EAAE,SAAS,CAAC,CAAC;IAC9C,MAAM,iBAAiB,GAAG,YAAY,CAAC,YAAY,EAAE,SAAS,CAAC,CAAC;IAEhE,MAAM,wBAAwB,GAAG,sCAAsC,CAAC,QAAQ,EAAE,IAAI,CAAC,CAAC;IAExF,MAAM,eAAe,GAAG,GACtB,wBAAwB,CAAC,CAAC,CAAC,GAAG,wBAAwB,GAAG,CAAC,CAAC,CAAC,EAC9D,GAAG,SAAS,EAAE,CAAC;IAEf,QAAQ,CAAC,IAAI,CAAC,wBAAwB,CAAC,CAAC;IAExC,MAAM,IAAI,GAA4B;QACpC,QAAQ,EAAE,eAAe;QACzB,IAAI,EAAE,OAAO,CAAC,GAAG,EAAE,wBAAwB,CAAC;QAC5C,KAAK,EAAE,KAAK,KAAK,SAAS,CAAC,CAAC,CAAC,mBAAmB,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,KAAK;QAC/D,WAAW;QACX,OAAO,EAAE,IAAI,EAAE,OAAO;KACvB,CAAC;IACF,iBAAiB,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;IAC7B,QAAQ,CAAC,wBAAwB,CAAC,GAAG,IAAI,CAAC;IAE1C,MAAM,UAAU,GAAG,IAAI,EAAE,cAAc;QACrC,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,cAAc,EAAE,GAAG,wBAAwB,MAAM,CAAC;QAC9D,CAAC,CAAC,GAAG,wBAAwB,MAAM,CAAC;IACtC,IAAI,IAAI,EAAE,UAAU,IAAI,CAAC,CAAC,GAAG,CAAC,cAAc,CAAC,UAAU,CAAC,IAAI,IAAI,CAAC,SAAS,CAAC,EAAE,CAAC;QAC5E,aAAa,CAAC,IAAI,CAAC,yBAAyB,CAAC,UAAU,EAAE,eAAe,EAAE,IAAI,CAAC,OAAO,CAAC,CAAC,CAAC;IAC3F,CAAC;AACH,CAAC,CAAC;AAEF,MAAM,yBAAyB,GAAG,KAAK,EACrC,QAAgB,EAChB,eAAuB,EACvB,OAAgB,EAChB,EAAE;IACF,MAAM,IAAI,GAAG;YACH,eAAe,GAAG,OAAO,CAAC,CAAC,CAAC,cAAc,OAAO,EAAE,CAAC,CAAC,CAAC,EAAE;IAChE,CAAC;IAEH,MAAM,UAAU,CAAC,QAAQ,EAAE,IAAI,CAAC,CAAC;AACnC,CAAC,CAAC"}

package/bin/index.d.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';

package/bin/index.js

@@ -1,4 +1,5 @@
 export { generateOpenApiPages } from './openapi/generateOpenApiPages.js';
 export { generateOpenApiPagesForDocsConfig } from './openapi/generateOpenApiPagesForDocsConfig.js';
 export * from './utils/log.js';
+export { generateAsyncApiPagesForDocsConfig } from './asyncapi/generateAsyncApiPagesForDocsConfig.js';
 //# sourceMappingURL=index.js.map

package/bin/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,oBAAoB,EAAE,MAAM,mCAAmC,CAAC;AACzE,OAAO,EAAE,iCAAiC,EAAE,MAAM,gDAAgD,CAAC;AACnG,cAAc,gBAAgB,CAAC"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,oBAAoB,EAAE,MAAM,mCAAmC,CAAC;AACzE,OAAO,EAAE,iCAAiC,EAAE,MAAM,gDAAgD,CAAC;AACnG,cAAc,gBAAgB,CAAC;AAC/B,OAAO,EAAE,kCAAkC,EAAE,MAAM,kDAAkD,CAAC"}