@mintlify/scraping 4.0.137 → 4.0.139
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/__test__/fixtures/openapi.ts +358 -0
- package/__test__/generateOpenApiPages.test.ts +82 -0
- package/__test__/generateOpenApiPagesForDocsConfig.test.ts +41 -102
- package/bin/openapi/common.d.ts +2 -0
- package/bin/openapi/common.js +39 -0
- package/bin/openapi/common.js.map +1 -1
- package/bin/openapi/generateOpenApiPages.js +24 -8
- package/bin/openapi/generateOpenApiPages.js.map +1 -1
- package/bin/openapi/generateOpenApiPagesForDocsConfig.js +24 -8
- package/bin/openapi/generateOpenApiPagesForDocsConfig.js.map +1 -1
- package/bin/tsconfig.build.tsbuildinfo +1 -1
- package/package.json +4 -4
- package/src/openapi/common.ts +58 -0
- package/src/openapi/generateOpenApiPages.ts +49 -17
- package/src/openapi/generateOpenApiPagesForDocsConfig.ts +48 -17
|
@@ -1,21 +1,37 @@
|
|
|
1
1
|
import { validate } from '@mintlify/common';
|
|
2
|
-
import { getOpenApiDefinition, processOpenApiPath, DEFAULT_API_GROUP_NAME, } from './common.js';
|
|
2
|
+
import { getOpenApiDefinition, processOpenApiPath, DEFAULT_API_GROUP_NAME, processOpenApiWebhook, } from './common.js';
|
|
3
3
|
export async function generateOpenApiPages(pathOrDocumentOrUrl, opts) {
|
|
4
4
|
const { document, isUrl } = await getOpenApiDefinition(pathOrDocumentOrUrl);
|
|
5
5
|
const { schema } = await validate(document);
|
|
6
|
-
if (schema?.
|
|
6
|
+
if (schema?.openapi === '3.0.0' &&
|
|
7
|
+
(schema.paths === undefined || Object.keys(schema.paths).length === 0)) {
|
|
7
8
|
throw new Error('No paths defined.');
|
|
8
9
|
}
|
|
10
|
+
else if (schema?.openapi === '3.1.0' &&
|
|
11
|
+
(schema.paths === undefined || Object.keys(schema.paths).length === 0) &&
|
|
12
|
+
(schema.webhooks === undefined || Object.keys(schema.webhooks).length === 0)) {
|
|
13
|
+
throw new Error('No paths or webhooks defined.');
|
|
14
|
+
}
|
|
9
15
|
const nav = [];
|
|
10
16
|
const decoratedNav = [];
|
|
11
17
|
const writePromises = [];
|
|
12
18
|
const pagesAcc = {};
|
|
13
|
-
|
|
14
|
-
|
|
15
|
-
|
|
16
|
-
|
|
17
|
-
|
|
18
|
-
|
|
19
|
+
if (schema?.paths) {
|
|
20
|
+
Object.entries(schema.paths).forEach(([path, pathItemObject]) => {
|
|
21
|
+
if (!pathItemObject || typeof pathItemObject !== 'object') {
|
|
22
|
+
return;
|
|
23
|
+
}
|
|
24
|
+
processOpenApiPath(path, pathItemObject, schema, nav, decoratedNav, writePromises, pagesAcc, opts ?? {}, findNavGroup);
|
|
25
|
+
});
|
|
26
|
+
}
|
|
27
|
+
if (schema?.webhooks) {
|
|
28
|
+
Object.entries(schema.webhooks).forEach(([webhook, webhookObject]) => {
|
|
29
|
+
if (!webhookObject || typeof webhookObject !== 'object') {
|
|
30
|
+
return;
|
|
31
|
+
}
|
|
32
|
+
processOpenApiWebhook(webhook, webhookObject, schema, nav, decoratedNav, writePromises, pagesAcc, opts ?? {}, findNavGroup);
|
|
33
|
+
});
|
|
34
|
+
}
|
|
19
35
|
await Promise.all(writePromises);
|
|
20
36
|
return {
|
|
21
37
|
nav,
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"generateOpenApiPages.js","sourceRoot":"","sources":["../../src/openapi/generateOpenApiPages.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,EAAE,MAAM,kBAAkB,CAAC;AAU5C,OAAO,EACL,oBAAoB,EAGpB,kBAAkB,EAClB,sBAAsB,
|
|
1
|
+
{"version":3,"file":"generateOpenApiPages.js","sourceRoot":"","sources":["../../src/openapi/generateOpenApiPages.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,EAAE,MAAM,kBAAkB,CAAC;AAU5C,OAAO,EACL,oBAAoB,EAGpB,kBAAkB,EAClB,sBAAsB,EACtB,qBAAqB,GACtB,MAAM,aAAa,CAAC;AAErB,MAAM,CAAC,KAAK,UAAU,oBAAoB,CACxC,mBAAoD,EACpD,IAAkC;IAElC,MAAM,EAAE,QAAQ,EAAE,KAAK,EAAE,GAAG,MAAM,oBAAoB,CAAC,mBAAmB,CAAC,CAAC;IAC5E,MAAM,EAAE,MAAM,EAAE,GAAG,MAAM,QAAQ,CAAC,QAAQ,CAAC,CAAC;IAE5C,IACE,MAAM,EAAE,OAAO,KAAK,OAAO;QAC3B,CAAC,MAAM,CAAC,KAAK,KAAK,SAAS,IAAI,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,MAAM,KAAK,CAAC,CAAC,EACtE,CAAC;QACD,MAAM,IAAI,KAAK,CAAC,mBAAmB,CAAC,CAAC;IACvC,CAAC;SAAM,IACL,MAAM,EAAE,OAAO,KAAK,OAAO;QAC3B,CAAC,MAAM,CAAC,KAAK,KAAK,SAAS,IAAI,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,MAAM,KAAK,CAAC,CAAC;QACtE,CAAC,MAAM,CAAC,QAAQ,KAAK,SAAS,IAAI,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC,MAAM,KAAK,CAAC,CAAC,EAC5E,CAAC;QACD,MAAM,IAAI,KAAK,CAAC,+BAA+B,CAAC,CAAC;IACnD,CAAC;IAED,MAAM,GAAG,GAAe,EAAE,CAAC;IAC3B,MAAM,YAAY,GAAwB,EAAE,CAAC;IAC7C,MAAM,aAAa,GAAoB,EAAE,CAAC;IAC1C,MAAM,QAAQ,GAA4C,EAAE,CAAC;IAE7D,IAAI,MAAM,EAAE,KAAK,EAAE,CAAC;QAClB,MAAM,CAAC,OAAO,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,IAAI,EAAE,cAAc,CAAC,EAAE,EAAE;YAC9D,IAAI,CAAC,cAAc,IAAI,OAAO,cAAc,KAAK,QAAQ,EAAE,CAAC;gBAC1D,OAAO;YACT,CAAC;YACD,kBAAkB,CAChB,IAAI,EACJ,cAAc,EACd,MAA0B,EAC1B,GAAG,EACH,YAAY,EACZ,aAAa,EACb,QAAQ,EACR,IAAI,IAAI,EAAE,EACV,YAAY,CACb,CAAC;QACJ,CAAC,CAAC,CAAC;IACL,CAAC;IAED,IAAI,MAAM,EAAE,QAAQ,EAAE,CAAC;QACrB,MAAM,CAAC,OAAO,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,OAAO,EAAE,aAAa,CAAC,EAAE,EAAE;YACnE,IAAI,CAAC,aAAa,IAAI,OAAO,aAAa,KAAK,QAAQ,EAAE,CAAC;gBACxD,OAAO;YACT,CAAC;YACD,qBAAqB,CACnB,OAAO,EACP,aAAa,EACb,MAA0B,EAC1B,GAAG,EACH,YAAY,EACZ,aAAa,EACb,QAAQ,EACR,IAAI,IAAI,EAAE,EACV,YAAY,CACb,CAAC;QACJ,CAAC,CAAC,CAAC;IACL,CAAC;IAED,MAAM,OAAO,CAAC,GAAG,CAAC,aAAa,CAAC,CAAC;IAEjC,OAAO;QACL,GAAG;QACH,YAAY;QACZ,IAAI,EAAE,MAA0B;QAChC,QAAQ;QACR,KAAK;KACN,CAAC;AACJ,CAAC;AAED,MAAM,YAAY,GAAG,CACnB,GAAyB,EACzB,YAAoB,sBAAsB,EACpB,EAAE;IACxB,MAAM,KAAK,GAAG,GAAG,CAAC,IAAI,CACpB,CAAC,WAAW,EAAE,EAAE,CACd,OAAO,WAAW,KAAK,QAAQ,IAAI,OAAO,IAAI,WAAW,IAAI,WAAW,CAAC,KAAK,KAAK,SAAS,CAC9E,CAAC;IACnB,IAAI,KAAK,KAAK,SAAS,EAAE,CAAC;QACxB,MAAM,QAAQ,GAAG;YACf,KAAK,EAAE,SAAS;YAChB,KAAK,EAAE,EAAE;SACV,CAAC;QACF,GAAG,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;QACnB,OAAO,QAAQ,CAAC,KAAK,CAAC;IACxB,CAAC;SAAM,CAAC;QACN,OAAO,KAAK,CAAC,KAAK,CAAC;IACrB,CAAC;AACH,CAAC,CAAC"}
|
|
@@ -1,21 +1,37 @@
|
|
|
1
1
|
import { validate } from '@mintlify/common';
|
|
2
|
-
import { getOpenApiDefinition, processOpenApiPath, DEFAULT_API_GROUP_NAME, } from './common.js';
|
|
2
|
+
import { getOpenApiDefinition, processOpenApiPath, DEFAULT_API_GROUP_NAME, processOpenApiWebhook, } from './common.js';
|
|
3
3
|
export async function generateOpenApiPagesForDocsConfig(pathOrDocumentOrUrl, opts) {
|
|
4
4
|
const { document, isUrl } = await getOpenApiDefinition(pathOrDocumentOrUrl);
|
|
5
5
|
const { schema } = await validate(document);
|
|
6
|
-
if (schema?.
|
|
6
|
+
if (schema?.openapi === '3.0.0' &&
|
|
7
|
+
(schema.paths === undefined || Object.keys(schema.paths).length === 0)) {
|
|
7
8
|
throw new Error('No paths defined.');
|
|
8
9
|
}
|
|
10
|
+
else if (schema?.openapi === '3.1.0' &&
|
|
11
|
+
(schema.paths === undefined || Object.keys(schema.paths).length === 0) &&
|
|
12
|
+
(schema.webhooks === undefined || Object.keys(schema.webhooks).length === 0)) {
|
|
13
|
+
throw new Error('No paths or webhooks defined.');
|
|
14
|
+
}
|
|
9
15
|
const nav = [];
|
|
10
16
|
const decoratedNav = [];
|
|
11
17
|
const writePromises = [];
|
|
12
18
|
const pagesAcc = {};
|
|
13
|
-
|
|
14
|
-
|
|
15
|
-
|
|
16
|
-
|
|
17
|
-
|
|
18
|
-
|
|
19
|
+
if (schema?.paths) {
|
|
20
|
+
Object.entries(schema.paths).forEach(([path, pathItemObject]) => {
|
|
21
|
+
if (!pathItemObject || typeof pathItemObject !== 'object') {
|
|
22
|
+
return;
|
|
23
|
+
}
|
|
24
|
+
processOpenApiPath(path, pathItemObject, schema, nav, decoratedNav, writePromises, pagesAcc, opts ?? {}, findNavGroup);
|
|
25
|
+
});
|
|
26
|
+
}
|
|
27
|
+
if (schema?.webhooks) {
|
|
28
|
+
Object.entries(schema.webhooks).forEach(([webhook, webhookObject]) => {
|
|
29
|
+
if (!webhookObject || typeof webhookObject !== 'object') {
|
|
30
|
+
return;
|
|
31
|
+
}
|
|
32
|
+
processOpenApiWebhook(webhook, webhookObject, schema, nav, decoratedNav, writePromises, pagesAcc, opts ?? {}, findNavGroup);
|
|
33
|
+
});
|
|
34
|
+
}
|
|
19
35
|
await Promise.all(writePromises);
|
|
20
36
|
return {
|
|
21
37
|
nav,
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"generateOpenApiPagesForDocsConfig.js","sourceRoot":"","sources":["../../src/openapi/generateOpenApiPagesForDocsConfig.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,EAAE,MAAM,kBAAkB,CAAC;AAU5C,OAAO,EACL,oBAAoB,EAGpB,kBAAkB,EAClB,sBAAsB,
|
|
1
|
+
{"version":3,"file":"generateOpenApiPagesForDocsConfig.js","sourceRoot":"","sources":["../../src/openapi/generateOpenApiPagesForDocsConfig.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,EAAE,MAAM,kBAAkB,CAAC;AAU5C,OAAO,EACL,oBAAoB,EAGpB,kBAAkB,EAClB,sBAAsB,EACtB,qBAAqB,GACtB,MAAM,aAAa,CAAC;AAErB,MAAM,CAAC,KAAK,UAAU,iCAAiC,CACrD,mBAAoD,EACpD,IAAkC;IAElC,MAAM,EAAE,QAAQ,EAAE,KAAK,EAAE,GAAG,MAAM,oBAAoB,CAAC,mBAAmB,CAAC,CAAC;IAC5E,MAAM,EAAE,MAAM,EAAE,GAAG,MAAM,QAAQ,CAAC,QAAQ,CAAC,CAAC;IAE5C,IACE,MAAM,EAAE,OAAO,KAAK,OAAO;QAC3B,CAAC,MAAM,CAAC,KAAK,KAAK,SAAS,IAAI,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,MAAM,KAAK,CAAC,CAAC,EACtE,CAAC;QACD,MAAM,IAAI,KAAK,CAAC,mBAAmB,CAAC,CAAC;IACvC,CAAC;SAAM,IACL,MAAM,EAAE,OAAO,KAAK,OAAO;QAC3B,CAAC,MAAM,CAAC,KAAK,KAAK,SAAS,IAAI,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,MAAM,KAAK,CAAC,CAAC;QACtE,CAAC,MAAM,CAAC,QAAQ,KAAK,SAAS,IAAI,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC,MAAM,KAAK,CAAC,CAAC,EAC5E,CAAC;QACD,MAAM,IAAI,KAAK,CAAC,+BAA+B,CAAC,CAAC;IACnD,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,IAAI,MAAM,EAAE,KAAK,EAAE,CAAC;QAClB,MAAM,CAAC,OAAO,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,IAAI,EAAE,cAAc,CAAC,EAAE,EAAE;YAC9D,IAAI,CAAC,cAAc,IAAI,OAAO,cAAc,KAAK,QAAQ,EAAE,CAAC;gBAC1D,OAAO;YACT,CAAC;YACD,kBAAkB,CAChB,IAAI,EACJ,cAAc,EACd,MAA0B,EAC1B,GAAG,EACH,YAAY,EACZ,aAAa,EACb,QAAQ,EACR,IAAI,IAAI,EAAE,EACV,YAAY,CACb,CAAC;QACJ,CAAC,CAAC,CAAC;IACL,CAAC;IAED,IAAI,MAAM,EAAE,QAAQ,EAAE,CAAC;QACrB,MAAM,CAAC,OAAO,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,OAAO,EAAE,aAAa,CAAC,EAAE,EAAE;YACnE,IAAI,CAAC,aAAa,IAAI,OAAO,aAAa,KAAK,QAAQ,EAAE,CAAC;gBACxD,OAAO;YACT,CAAC;YACD,qBAAqB,CACnB,OAAO,EACP,aAAa,EACb,MAA0B,EAC1B,GAAG,EACH,YAAY,EACZ,aAAa,EACb,QAAQ,EACR,IAAI,IAAI,EAAE,EACV,YAAY,CACb,CAAC;QACJ,CAAC,CAAC,CAAC;IACL,CAAC;IAED,MAAM,OAAO,CAAC,GAAG,CAAC,aAAa,CAAC,CAAC;IAEjC,OAAO;QACL,GAAG;QACH,YAAY;QACZ,IAAI,EAAE,MAA0B;QAChC,QAAQ;QACR,KAAK;KACN,CAAC;AACJ,CAAC;AAED,MAAM,YAAY,GAAG,CACnB,GAAyC,EACzC,YAAoB,sBAAsB,EACN,EAAE;IACtC,MAAM,KAAK,GAAG,GAAG,CAAC,IAAI,CACpB,CAAC,WAAW,EAAE,EAAE,CACd,OAAO,WAAW,KAAK,QAAQ,IAAI,OAAO,IAAI,WAAW,IAAI,WAAW,CAAC,KAAK,KAAK,SAAS,CAC/F,CAAC;IACF,IAAI,KAAK,KAAK,SAAS,IAAI,CAAC,CAAC,OAAO,IAAI,KAAK,CAAC,EAAE,CAAC;QAC/C,MAAM,QAAQ,GAAG;YACf,KAAK,EAAE,SAAS;YAChB,KAAK,EAAE,EAAE;SACV,CAAC;QACF,GAAG,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;QACnB,OAAO,QAAQ,CAAC,KAAK,CAAC;IACxB,CAAC;SAAM,CAAC;QACN,OAAO,KAAK,CAAC,KAAK,CAAC;IACrB,CAAC;AACH,CAAC,CAAC"}
|