@mintlify/scraping 4.0.228 → 4.0.229
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/bin/openapi/common.d.ts +6 -1
- package/bin/openapi/common.js +19 -14
- package/bin/openapi/common.js.map +1 -1
- package/bin/tsconfig.build.tsbuildinfo +1 -1
- package/package.json +4 -4
- package/src/openapi/common.ts +35 -28
package/bin/openapi/common.d.ts
CHANGED
|
@@ -4,7 +4,12 @@ export declare const getOpenApiDefinition: (pathOrDocumentOrUrl: string | OpenAP
|
|
|
4
4
|
document: OpenAPI.Document;
|
|
5
5
|
isUrl: boolean;
|
|
6
6
|
}>;
|
|
7
|
-
export declare const createOpenApiFrontmatter: (filename
|
|
7
|
+
export declare const createOpenApiFrontmatter: ({ filename, openApiMetaTag, version, deprecated, }: {
|
|
8
|
+
filename: string;
|
|
9
|
+
openApiMetaTag: string;
|
|
10
|
+
version?: string;
|
|
11
|
+
deprecated?: boolean;
|
|
12
|
+
}) => Promise<void>;
|
|
8
13
|
export type GenerateOpenApiPagesOptions = {
|
|
9
14
|
openApiFilePath?: string;
|
|
10
15
|
version?: string;
|
package/bin/openapi/common.js
CHANGED
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
import { getOpenApiTitleAndDescription, optionallyAddLeadingSlash, slugToTitle, } from '@mintlify/common';
|
|
1
|
+
import { getOpenApiTitleAndDescription, optionallyAddLeadingSlash, slugToTitle, buildOpenApiMetaTag, } from '@mintlify/common';
|
|
2
2
|
import { outputFile } from 'fs-extra';
|
|
3
3
|
import fse from 'fs-extra';
|
|
4
4
|
import fs from 'fs/promises';
|
|
@@ -34,9 +34,9 @@ export const getOpenApiDefinition = async (pathOrDocumentOrUrl) => {
|
|
|
34
34
|
}
|
|
35
35
|
return { document: pathOrDocumentOrUrl, isUrl };
|
|
36
36
|
};
|
|
37
|
-
export const createOpenApiFrontmatter = async (filename, openApiMetaTag, version) => {
|
|
37
|
+
export const createOpenApiFrontmatter = async ({ filename, openApiMetaTag, version, deprecated, }) => {
|
|
38
38
|
const data = `---
|
|
39
|
-
openapi: ${openApiMetaTag}${version ? `\nversion: ${version}` : ''}
|
|
39
|
+
openapi: ${openApiMetaTag}${version ? `\nversion: ${version}` : ''}${deprecated ? `\ndeprecated: ${deprecated}` : ''}
|
|
40
40
|
---`;
|
|
41
41
|
await outputFile(filename, data);
|
|
42
42
|
};
|
|
@@ -46,11 +46,6 @@ const isHiddenOperation = (operation) => {
|
|
|
46
46
|
const isExcludedOperation = (operation) => {
|
|
47
47
|
return operation['x-excluded'];
|
|
48
48
|
};
|
|
49
|
-
const buildOpenApiMetaTag = ({ openApiFilePathFromRoot, method, path, deprecated, }) => {
|
|
50
|
-
const filePath = openApiFilePathFromRoot ? `${openApiFilePathFromRoot} ` : '';
|
|
51
|
-
const label = deprecated ? ` deprecated` : '';
|
|
52
|
-
return `${filePath}${method} ${path}${label}`;
|
|
53
|
-
};
|
|
54
49
|
export function processOpenApiPath(path, pathItemObject, schema, nav, decoratedNav, writePromises, pagesAcc, options,
|
|
55
50
|
// eslint-disable-next-line @typescript-eslint/no-explicit-any
|
|
56
51
|
findNavGroup) {
|
|
@@ -72,10 +67,9 @@ findNavGroup) {
|
|
|
72
67
|
const decoratedNavGroup = findNavGroup(decoratedNav, groupName);
|
|
73
68
|
const filenameWithoutExtension = generateUniqueFilenameWithoutExtension(navGroup, base);
|
|
74
69
|
const openapiMetaTag = buildOpenApiMetaTag({
|
|
75
|
-
openApiFilePathFromRoot,
|
|
70
|
+
filePath: openApiFilePathFromRoot,
|
|
76
71
|
method,
|
|
77
72
|
path,
|
|
78
|
-
deprecated: operation?.deprecated ?? false,
|
|
79
73
|
});
|
|
80
74
|
const { title: titleTag, description } = getOpenApiTitleAndDescription([
|
|
81
75
|
{
|
|
@@ -91,6 +85,7 @@ findNavGroup) {
|
|
|
91
85
|
href: resolve('/', filenameWithoutExtension),
|
|
92
86
|
title: titleTag ?? slugToTitle(filenameWithoutExtension),
|
|
93
87
|
description,
|
|
88
|
+
deprecated: operation?.deprecated,
|
|
94
89
|
version: options.version,
|
|
95
90
|
};
|
|
96
91
|
if (!isHiddenOperation(operation)) {
|
|
@@ -102,7 +97,12 @@ findNavGroup) {
|
|
|
102
97
|
? join(options.outDirBasePath, `${filenameWithoutExtension}.mdx`)
|
|
103
98
|
: `${filenameWithoutExtension}.mdx`;
|
|
104
99
|
if (options.writeFiles && (!fse.pathExistsSync(targetPath) || options.overwrite)) {
|
|
105
|
-
writePromises.push(createOpenApiFrontmatter(
|
|
100
|
+
writePromises.push(createOpenApiFrontmatter({
|
|
101
|
+
filename: targetPath,
|
|
102
|
+
openApiMetaTag: openapiMetaTag,
|
|
103
|
+
version: options.version,
|
|
104
|
+
deprecated: operation?.deprecated,
|
|
105
|
+
}));
|
|
106
106
|
}
|
|
107
107
|
}
|
|
108
108
|
});
|
|
@@ -128,10 +128,9 @@ findNavGroup) {
|
|
|
128
128
|
const decoratedNavGroup = findNavGroup(decoratedNav, groupName);
|
|
129
129
|
const filenameWithoutExtension = generateUniqueFilenameWithoutExtension(navGroup, base);
|
|
130
130
|
const openapiMetaTag = buildOpenApiMetaTag({
|
|
131
|
-
openApiFilePathFromRoot,
|
|
131
|
+
filePath: openApiFilePathFromRoot,
|
|
132
132
|
method: 'webhook',
|
|
133
133
|
path: webhook,
|
|
134
|
-
deprecated: operation?.deprecated ?? false,
|
|
135
134
|
});
|
|
136
135
|
const description = operation?.description;
|
|
137
136
|
const page = {
|
|
@@ -140,6 +139,7 @@ findNavGroup) {
|
|
|
140
139
|
title: slugToTitle(filenameWithoutExtension),
|
|
141
140
|
description,
|
|
142
141
|
version: options.version,
|
|
142
|
+
deprecated: operation?.deprecated,
|
|
143
143
|
};
|
|
144
144
|
if (!isHiddenOperation(operation)) {
|
|
145
145
|
navGroup.push(filenameWithoutExtension);
|
|
@@ -150,7 +150,12 @@ findNavGroup) {
|
|
|
150
150
|
? join(options.outDirBasePath, `${filenameWithoutExtension}.mdx`)
|
|
151
151
|
: `${filenameWithoutExtension}.mdx`;
|
|
152
152
|
if (options.writeFiles && (!fse.pathExistsSync(targetPath) || options.overwrite)) {
|
|
153
|
-
writePromises.push(createOpenApiFrontmatter(
|
|
153
|
+
writePromises.push(createOpenApiFrontmatter({
|
|
154
|
+
filename: targetPath,
|
|
155
|
+
openApiMetaTag: openapiMetaTag,
|
|
156
|
+
version: options.version,
|
|
157
|
+
deprecated: operation?.deprecated,
|
|
158
|
+
}));
|
|
154
159
|
}
|
|
155
160
|
}
|
|
156
161
|
});
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"common.js","sourceRoot":"","sources":["../../src/openapi/common.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,6BAA6B,EAE7B,yBAAyB,EACzB,WAAW,
|
|
1
|
+
{"version":3,"file":"common.js","sourceRoot":"","sources":["../../src/openapi/common.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,6BAA6B,EAE7B,yBAAyB,EACzB,WAAW,EACX,mBAAmB,GACpB,MAAM,kBAAkB,CAAC;AAE1B,OAAO,EAAE,UAAU,EAAE,MAAM,UAAU,CAAC;AACtC,OAAO,GAAG,MAAM,UAAU,CAAC;AAC3B,OAAO,EAAE,MAAM,aAAa,CAAC;AAC7B,OAAO,IAAI,MAAM,SAAS,CAAC;AAC3B,OAAO,EAAW,SAAS,EAAE,MAAM,eAAe,CAAC;AACnD,OAAO,IAAI,EAAE,EAAE,IAAI,EAAE,KAAK,EAAE,OAAO,EAAE,MAAM,MAAM,CAAC;AAElD,OAAO,EACL,8BAA8B,EAC9B,sCAAsC,GACvC,MAAM,uBAAuB,CAAC;AAC/B,OAAO,EAAE,YAAY,EAAE,MAAM,qBAAqB,CAAC;AAEnD,MAAM,CAAC,MAAM,oBAAoB,GAAG,KAAK,EACvC,mBAAoD,EACK,EAAE;IAC3D,IAAI,OAAO,mBAAmB,KAAK,QAAQ,EAAE,CAAC;QAC5C,IAAI,mBAAmB,CAAC,UAAU,CAAC,SAAS,CAAC,EAAE,CAAC;YAC9C,yDAAyD;YACzD,MAAM,IAAI,KAAK,CAAC,4DAA4D,CAAC,CAAC;QAChF,CAAC;aAAM,CAAC;YACN,IAAI,CAAC;gBACH,MAAM,GAAG,GAAG,IAAI,GAAG,CAAC,mBAAmB,CAAC,CAAC;gBACzC,mBAAmB,GAAG,GAAG,CAAC;YAC5B,CAAC;YAAC,MAAM,CAAC;gBACP,MAAM,QAAQ,GAAG,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,GAAG,EAAE,EAAE,mBAAmB,CAAC,QAAQ,EAAE,CAAC,CAAC;gBAC1E,MAAM,IAAI,GAAG,MAAM,EAAE,CAAC,QAAQ,CAAC,QAAQ,EAAE,OAAO,CAAC,CAAC;gBAClD,mBAAmB,GAAG,IAAI,CAAC,IAAI,CAAC,IAAI,CAAqB,CAAC;YAC5D,CAAC;QACH,CAAC;IACH,CAAC;IACD,MAAM,KAAK,GAAG,mBAAmB,YAAY,GAAG,CAAC;IACjD,IAAI,mBAAmB,YAAY,GAAG,EAAE,CAAC;QACvC,IAAI,mBAAmB,CAAC,QAAQ,KAAK,QAAQ,EAAE,CAAC;YAC9C,MAAM,IAAI,KAAK,CAAC,4DAA4D,CAAC,CAAC;QAChF,CAAC;QACD,mBAAmB,GAAG,MAAM,YAAY,CAAC,mBAAmB,CAAC,CAAC;IAChE,CAAC;IAED,OAAO,EAAE,QAAQ,EAAE,mBAAmB,EAAE,KAAK,EAAE,CAAC;AAClD,CAAC,CAAC;AAEF,MAAM,CAAC,MAAM,wBAAwB,GAAG,KAAK,EAAE,EAC7C,QAAQ,EACR,cAAc,EACd,OAAO,EACP,UAAU,GAMX,EAAE,EAAE;IACH,MAAM,IAAI,GAAG;WACJ,cAAc,GAAG,OAAO,CAAC,CAAC,CAAC,cAAc,OAAO,EAAE,CAAC,CAAC,CAAC,EAAE,GAC9D,UAAU,CAAC,CAAC,CAAC,iBAAiB,UAAU,EAAE,CAAC,CAAC,CAAC,EAC/C;IACE,CAAC;IAEH,MAAM,UAAU,CAAC,QAAQ,EAAE,IAAI,CAAC,CAAC;AACnC,CAAC,CAAC;AAwBF,MAAM,iBAAiB,GAAG,CAAC,SAA6C,EAAE,EAAE;IAC1E,OAAO,SAAS,CAAC,UAAU,CAAC,CAAC;AAC/B,CAAC,CAAC;AAEF,MAAM,mBAAmB,GAAG,CAAC,SAA6C,EAAE,EAAE;IAC5E,OAAO,SAAS,CAAC,YAAY,CAAC,CAAC;AACjC,CAAC,CAAC;AAEF,MAAM,UAAU,kBAAkB,CAChC,IAAY,EACZ,cAAwC,EACxC,MAAwB,EACxB,GAAM,EACN,YAAgB,EAChB,aAA8B,EAC9B,QAAiD,EACjD,OAAoC;AACpC,8DAA8D;AAC9D,YAAmD;IAEnD,MAAM,uBAAuB,GAAG,OAAO,CAAC,eAAe;QACrD,CAAC,CAAC,yBAAyB,CAAC,OAAO,CAAC,eAAe,CAAC;QACpD,CAAC,CAAC,SAAS,CAAC;IAEd,MAAM,CAAC,MAAM,CAAC,SAAS,CAAC,WAAW,CAAC,CAAC,OAAO,CAAC,CAAC,MAAM,EAAE,EAAE;QACtD,IAAI,MAAM,IAAI,cAAc,EAAE,CAAC;YAC7B,MAAM,SAAS,GAAG,cAAc,CAAC,MAAM,CAAC,CAAC;YACzC,IAAI,mBAAmB,CAAC,SAA+C,CAAC,EAAE,CAAC;gBACzE,OAAO;YACT,CAAC;YACD,MAAM,SAAS,GAAG,SAAS,EAAE,IAAI,EAAE,CAAC,CAAC,CAAC,CAAC;YACvC,MAAM,KAAK,GACT,8BAA8B,CAAC,SAAS,EAAE,OAAO,CAAC;gBAClD,GAAG,MAAM,IAAI,8BAA8B,CAAC,IAAI,CAAC,EAAE,CAAC;YACtD,MAAM,MAAM,GAAG,8BAA8B,CAAC,SAAS,CAAC,IAAI,EAAE,CAAC;YAC/D,MAAM,IAAI,GAAG,IAAI,CAAC,OAAO,CAAC,MAAM,IAAI,EAAE,EAAE,MAAM,EAAE,KAAK,CAAC,CAAC;YAEvD,MAAM,QAAQ,GAAG,YAAY,CAAC,GAAG,EAAE,SAAS,CAAC,CAAC;YAC9C,MAAM,iBAAiB,GAAG,YAAY,CAAC,YAAY,EAAE,SAAS,CAAC,CAAC;YAEhE,MAAM,wBAAwB,GAAG,sCAAsC,CAAC,QAAQ,EAAE,IAAI,CAAC,CAAC;YACxF,MAAM,cAAc,GAAG,mBAAmB,CAAC;gBACzC,QAAQ,EAAE,uBAAuB;gBACjC,MAAM;gBACN,IAAI;aACL,CAAC,CAAC;YACH,MAAM,EAAE,KAAK,EAAE,QAAQ,EAAE,WAAW,EAAE,GAAG,6BAA6B,CACpE;gBACE;oBACE,QAAQ,EAAE,OAAO,CAAC,eAAe;wBAC/B,CAAC,CAAC,KAAK,CAAC,OAAO,CAAC,eAAe,CAAC,CAAC,IAAI;wBACrC,CAAC,CAAC,iBAAiB;oBACrB,IAAI,EAAE,MAAM;oBACZ,oBAAoB,EAAE,OAAO,CAAC,eAAe;iBAC9C;aACF,EACD,cAAc,CACf,CAAC;YACF,MAAM,IAAI,GAA4B;gBACpC,OAAO,EAAE,cAAc;gBACvB,IAAI,EAAE,OAAO,CAAC,GAAG,EAAE,wBAAwB,CAAC;gBAC5C,KAAK,EAAE,QAAQ,IAAI,WAAW,CAAC,wBAAwB,CAAC;gBACxD,WAAW;gBACX,UAAU,EAAE,SAAS,EAAE,UAAU;gBACjC,OAAO,EAAE,OAAO,CAAC,OAAO;aACzB,CAAC;YAEF,IAAI,CAAC,iBAAiB,CAAC,SAA+C,CAAC,EAAE,CAAC;gBACxE,QAAQ,CAAC,IAAI,CAAC,wBAAwB,CAAC,CAAC;gBACxC,iBAAiB,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;YAC/B,CAAC;YACD,QAAQ,CAAC,wBAAwB,CAAC,GAAG,IAAI,CAAC;YAC1C,MAAM,UAAU,GAAG,OAAO,CAAC,cAAc;gBACvC,CAAC,CAAC,IAAI,CAAC,OAAO,CAAC,cAAc,EAAE,GAAG,wBAAwB,MAAM,CAAC;gBACjE,CAAC,CAAC,GAAG,wBAAwB,MAAM,CAAC;YACtC,IAAI,OAAO,CAAC,UAAU,IAAI,CAAC,CAAC,GAAG,CAAC,cAAc,CAAC,UAAU,CAAC,IAAI,OAAO,CAAC,SAAS,CAAC,EAAE,CAAC;gBACjF,aAAa,CAAC,IAAI,CAChB,wBAAwB,CAAC;oBACvB,QAAQ,EAAE,UAAU;oBACpB,cAAc,EAAE,cAAc;oBAC9B,OAAO,EAAE,OAAO,CAAC,OAAO;oBACxB,UAAU,EAAE,SAAS,EAAE,UAAU;iBAClC,CAAC,CACH,CAAC;YACJ,CAAC;QACH,CAAC;IACH,CAAC,CAAC,CAAC;AACL,CAAC;AAED,MAAM,UAAU,qBAAqB,CACnC,OAAe,EACf,aAAuC,EACvC,OAAyB,EACzB,GAAM,EACN,YAAgB,EAChB,aAA8B,EAC9B,QAAiD,EACjD,OAAoC;AACpC,8DAA8D;AAC9D,YAAmD;IAEnD,MAAM,uBAAuB,GAAG,OAAO,CAAC,eAAe;QACrD,CAAC,CAAC,yBAAyB,CAAC,OAAO,CAAC,eAAe,CAAC;QACpD,CAAC,CAAC,SAAS,CAAC;IAEd,MAAM,CAAC,MAAM,CAAC,SAAS,CAAC,WAAW,CAAC,CAAC,OAAO,CAAC,CAAC,MAAM,EAAE,EAAE;QACtD,IAAI,MAAM,IAAI,aAAa,EAAE,CAAC;YAC5B,MAAM,SAAS,GAAG,aAAa,CAAC,MAAM,CAAC,CAAC;YACxC,IAAI,mBAAmB,CAAC,SAA+C,CAAC,EAAE,CAAC;gBACzE,OAAO;YACT,CAAC;YACD,MAAM,SAAS,GAAG,SAAS,EAAE,IAAI,EAAE,CAAC,CAAC,CAAC,CAAC;YACvC,MAAM,KAAK,GACT,8BAA8B,CAAC,SAAS,EAAE,OAAO,CAAC;gBAClD,GAAG,8BAA8B,CAAC,OAAO,CAAC,EAAE,CAAC;YAC/C,MAAM,MAAM,GAAG,8BAA8B,CAAC,SAAS,CAAC,IAAI,EAAE,CAAC;YAC/D,MAAM,IAAI,GAAG,IAAI,CAAC,OAAO,CAAC,MAAM,IAAI,EAAE,EAAE,MAAM,EAAE,KAAK,CAAC,CAAC;YAEvD,MAAM,QAAQ,GAAG,YAAY,CAAC,GAAG,EAAE,SAAS,CAAC,CAAC;YAC9C,MAAM,iBAAiB,GAAG,YAAY,CAAC,YAAY,EAAE,SAAS,CAAC,CAAC;YAEhE,MAAM,wBAAwB,GAAG,sCAAsC,CAAC,QAAQ,EAAE,IAAI,CAAC,CAAC;YAExF,MAAM,cAAc,GAAG,mBAAmB,CAAC;gBACzC,QAAQ,EAAE,uBAAuB;gBACjC,MAAM,EAAE,SAAS;gBACjB,IAAI,EAAE,OAAO;aACd,CAAC,CAAC;YAEH,MAAM,WAAW,GAAG,SAAS,EAAE,WAAW,CAAC;YAE3C,MAAM,IAAI,GAA4B;gBACpC,OAAO,EAAE,cAAc;gBACvB,IAAI,EAAE,OAAO,CAAC,GAAG,EAAE,wBAAwB,CAAC;gBAC5C,KAAK,EAAE,WAAW,CAAC,wBAAwB,CAAC;gBAC5C,WAAW;gBACX,OAAO,EAAE,OAAO,CAAC,OAAO;gBACxB,UAAU,EAAE,SAAS,EAAE,UAAU;aAClC,CAAC;YAEF,IAAI,CAAC,iBAAiB,CAAC,SAA+C,CAAC,EAAE,CAAC;gBACxE,QAAQ,CAAC,IAAI,CAAC,wBAAwB,CAAC,CAAC;gBACxC,iBAAiB,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;YAC/B,CAAC;YACD,QAAQ,CAAC,wBAAwB,CAAC,GAAG,IAAI,CAAC;YAC1C,MAAM,UAAU,GAAG,OAAO,CAAC,cAAc;gBACvC,CAAC,CAAC,IAAI,CAAC,OAAO,CAAC,cAAc,EAAE,GAAG,wBAAwB,MAAM,CAAC;gBACjE,CAAC,CAAC,GAAG,wBAAwB,MAAM,CAAC;YACtC,IAAI,OAAO,CAAC,UAAU,IAAI,CAAC,CAAC,GAAG,CAAC,cAAc,CAAC,UAAU,CAAC,IAAI,OAAO,CAAC,SAAS,CAAC,EAAE,CAAC;gBACjF,aAAa,CAAC,IAAI,CAChB,wBAAwB,CAAC;oBACvB,QAAQ,EAAE,UAAU;oBACpB,cAAc,EAAE,cAAc;oBAC9B,OAAO,EAAE,OAAO,CAAC,OAAO;oBACxB,UAAU,EAAE,SAAS,EAAE,UAAU;iBAClC,CAAC,CACH,CAAC;YACJ,CAAC;QACH,CAAC;IACH,CAAC,CAAC,CAAC;AACL,CAAC"}
|