@mintlify/previewing 3.1.56 → 3.1.57

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.
Files changed (34) hide show
  1. package/LICENSE +93 -0
  2. package/README.md +17 -17
  3. package/dist/constants.d.ts +9 -9
  4. package/dist/constants.js +31 -31
  5. package/dist/downloadImage.d.ts +4 -4
  6. package/dist/downloadImage.js +139 -139
  7. package/dist/index.d.ts +3 -3
  8. package/dist/index.js +3 -3
  9. package/dist/local-preview/helper-commands/installDepsCommand.d.ts +2 -2
  10. package/dist/local-preview/helper-commands/installDepsCommand.js +51 -51
  11. package/dist/local-preview/index.d.ts +3 -3
  12. package/dist/local-preview/index.js +212 -212
  13. package/dist/local-preview/listener/categorize.d.ts +8 -8
  14. package/dist/local-preview/listener/categorize.js +193 -193
  15. package/dist/local-preview/listener/generate.d.ts +1 -1
  16. package/dist/local-preview/listener/generate.js +137 -137
  17. package/dist/local-preview/listener/index.d.ts +2 -2
  18. package/dist/local-preview/listener/index.js +317 -317
  19. package/dist/local-preview/listener/update.d.ts +2 -2
  20. package/dist/local-preview/listener/update.js +79 -79
  21. package/dist/local-preview/listener/utils/createPage.d.ts +10 -10
  22. package/dist/local-preview/listener/utils/createPage.js +210 -210
  23. package/dist/local-preview/listener/utils/getOpenApiContext.d.ts +21 -21
  24. package/dist/local-preview/listener/utils/getOpenApiContext.js +55 -55
  25. package/dist/local-preview/listener/utils/mintConfigFile.d.ts +2 -2
  26. package/dist/local-preview/listener/utils/mintConfigFile.js +74 -74
  27. package/dist/local-preview/listener/utils/types.d.ts +2 -2
  28. package/dist/local-preview/listener/utils/types.js +1 -1
  29. package/dist/local-preview/listener/utils.d.ts +13 -13
  30. package/dist/local-preview/listener/utils.js +112 -112
  31. package/dist/tsconfig.tsbuildinfo +1 -1
  32. package/dist/util.d.ts +4 -4
  33. package/dist/util.js +20 -20
  34. package/package.json +88 -87
@@ -1,193 +1,193 @@
1
- var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
2
- function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
3
- return new (P || (P = Promise))(function (resolve, reject) {
4
- function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
5
- function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
6
- function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
7
- step((generator = generator.apply(thisArg, _arguments || [])).next());
8
- });
9
- };
10
- var __generator = (this && this.__generator) || function (thisArg, body) {
11
- var _ = { label: 0, sent: function() { if (t[0] & 1) throw t[1]; return t[1]; }, trys: [], ops: [] }, f, y, t, g;
12
- return g = { next: verb(0), "throw": verb(1), "return": verb(2) }, typeof Symbol === "function" && (g[Symbol.iterator] = function() { return this; }), g;
13
- function verb(n) { return function (v) { return step([n, v]); }; }
14
- function step(op) {
15
- if (f) throw new TypeError("Generator is already executing.");
16
- while (g && (g = 0, op[0] && (_ = 0)), _) try {
17
- if (f = 1, y && (t = op[0] & 2 ? y["return"] : op[0] ? y["throw"] || ((t = y["return"]) && t.call(y), 0) : y.next) && !(t = t.call(y, op[1])).done) return t;
18
- if (y = 0, t) op = [op[0] & 2, t.value];
19
- switch (op[0]) {
20
- case 0: case 1: t = op; break;
21
- case 4: _.label++; return { value: op[1], done: false };
22
- case 5: _.label++; y = op[1]; op = [0]; continue;
23
- case 7: op = _.ops.pop(); _.trys.pop(); continue;
24
- default:
25
- if (!(t = _.trys, t = t.length > 0 && t[t.length - 1]) && (op[0] === 6 || op[0] === 2)) { _ = 0; continue; }
26
- if (op[0] === 3 && (!t || (op[1] > t[0] && op[1] < t[3]))) { _.label = op[1]; break; }
27
- if (op[0] === 6 && _.label < t[1]) { _.label = t[1]; t = op; break; }
28
- if (t && _.label < t[2]) { _.label = t[2]; _.ops.push(op); break; }
29
- if (t[2]) _.ops.pop();
30
- _.trys.pop(); continue;
31
- }
32
- op = body.call(thisArg, _);
33
- } catch (e) { op = [6, e]; y = 0; } finally { f = t = 0; }
34
- if (op[0] & 5) throw op[1]; return { value: op[0] ? op[1] : void 0, done: true };
35
- }
36
- };
37
- var __asyncValues = (this && this.__asyncValues) || function (o) {
38
- if (!Symbol.asyncIterator) throw new TypeError("Symbol.asyncIterator is not defined.");
39
- var m = o[Symbol.asyncIterator], i;
40
- return m ? m.call(o) : (o = typeof __values === "function" ? __values(o) : o[Symbol.iterator](), i = {}, verb("next"), verb("throw"), verb("return"), i[Symbol.asyncIterator] = function () { return this; }, i);
41
- function verb(n) { i[n] = o[n] && function (v) { return new Promise(function (resolve, reject) { v = o[n](v), settle(resolve, reject, v.done, v.value); }); }; }
42
- function settle(resolve, reject, d, v) { Promise.resolve(v).then(function(v) { resolve({ value: v, done: d }); }, reject); }
43
- };
44
- // TODO - put in prebuild package
45
- import { getFileList } from '@mintlify/prebuild';
46
- import path from 'path';
47
- import { getFileExtension, openApiCheck } from './utils.js';
48
- export var categorizeFiles = function (contentDirectoryPath) { return __awaiter(void 0, void 0, void 0, function () {
49
- var contentFilenames, staticFilenames, promises, openApiFiles, snippets, _loop_1, _a, _b, _c, e_1_1;
50
- var _d, e_1, _e, _f;
51
- return __generator(this, function (_g) {
52
- switch (_g.label) {
53
- case 0:
54
- contentFilenames = [];
55
- staticFilenames = [];
56
- promises = [];
57
- openApiFiles = [];
58
- snippets = [];
59
- _g.label = 1;
60
- case 1:
61
- _g.trys.push([1, 6, 7, 12]);
62
- _loop_1 = function () {
63
- _f = _c.value;
64
- _a = false;
65
- try {
66
- var filename = _f;
67
- promises.push((function () { return __awaiter(void 0, void 0, void 0, function () {
68
- var extension, isOpenApi, openApiInfo, fileName;
69
- return __generator(this, function (_a) {
70
- switch (_a.label) {
71
- case 0:
72
- extension = getFileExtension(filename);
73
- isOpenApi = false;
74
- if (!(extension && (extension === 'mdx' || extension === 'md'))) return [3 /*break*/, 1];
75
- if (filename.startsWith('/_snippets')) {
76
- snippets.push(filename);
77
- }
78
- else {
79
- contentFilenames.push(filename);
80
- }
81
- return [3 /*break*/, 4];
82
- case 1:
83
- if (!(extension &&
84
- (extension === 'json' || extension === 'yaml' || extension === 'yml'))) return [3 /*break*/, 3];
85
- return [4 /*yield*/, openApiCheck(path.join(contentDirectoryPath, filename))];
86
- case 2:
87
- openApiInfo = _a.sent();
88
- isOpenApi = openApiInfo.isOpenApi;
89
- if (isOpenApi) {
90
- fileName = path.parse(filename).base;
91
- openApiFiles.push({
92
- filename: fileName.substring(0, fileName.lastIndexOf('.')),
93
- spec: openApiInfo.spec,
94
- });
95
- }
96
- return [3 /*break*/, 4];
97
- case 3:
98
- if (!filename.endsWith('mint.json') && !isOpenApi) {
99
- // all other files
100
- staticFilenames.push(filename);
101
- }
102
- _a.label = 4;
103
- case 4: return [2 /*return*/];
104
- }
105
- });
106
- }); })());
107
- }
108
- finally {
109
- _a = true;
110
- }
111
- };
112
- _a = true, _b = __asyncValues(getFileList(contentDirectoryPath));
113
- _g.label = 2;
114
- case 2: return [4 /*yield*/, _b.next()];
115
- case 3:
116
- if (!(_c = _g.sent(), _d = _c.done, !_d)) return [3 /*break*/, 5];
117
- _loop_1();
118
- _g.label = 4;
119
- case 4: return [3 /*break*/, 2];
120
- case 5: return [3 /*break*/, 12];
121
- case 6:
122
- e_1_1 = _g.sent();
123
- e_1 = { error: e_1_1 };
124
- return [3 /*break*/, 12];
125
- case 7:
126
- _g.trys.push([7, , 10, 11]);
127
- if (!(!_a && !_d && (_e = _b.return))) return [3 /*break*/, 9];
128
- return [4 /*yield*/, _e.call(_b)];
129
- case 8:
130
- _g.sent();
131
- _g.label = 9;
132
- case 9: return [3 /*break*/, 11];
133
- case 10:
134
- if (e_1) throw e_1.error;
135
- return [7 /*endfinally*/];
136
- case 11: return [7 /*endfinally*/];
137
- case 12: return [4 /*yield*/, Promise.all(promises)];
138
- case 13:
139
- _g.sent();
140
- return [2 /*return*/, { contentFilenames: contentFilenames, staticFilenames: staticFilenames, openApiFiles: openApiFiles, snippets: snippets }];
141
- }
142
- });
143
- }); };
144
- var excludedMdFiles = ['readme', 'license', 'contributing', 'contribute'];
145
- var supportedStaticFileExtensions = [
146
- '.jpeg',
147
- '.jpg',
148
- '.jfif',
149
- '.pjpeg',
150
- '.pjp',
151
- '.png',
152
- '.svg',
153
- '.svgz',
154
- '.ico',
155
- '.webp',
156
- '.gif',
157
- '.apng',
158
- '.avif',
159
- '.bmp',
160
- '.mp4',
161
- ];
162
- export var getCategory = function (filePath) {
163
- filePath = filePath.toLowerCase();
164
- var parsed = path.parse(filePath);
165
- if (parsed.base === 'mint.json') {
166
- return 'mintConfig';
167
- }
168
- var fileName = parsed.name;
169
- var extension = parsed.ext;
170
- if (filePath.startsWith('_snippets') && (extension === '.mdx' || extension === '.md')) {
171
- return 'snippet';
172
- }
173
- else if (extension === '.mdx') {
174
- return 'page';
175
- }
176
- else if (extension === '.md') {
177
- // Exclude common markdown files people don't want on their docs website
178
- if (excludedMdFiles.includes(fileName)) {
179
- throw new Error('Excluded Md File');
180
- }
181
- return 'page';
182
- }
183
- else if (extension === '.yaml' || extension === '.yml') {
184
- return 'potentialYamlOpenApiSpec';
185
- }
186
- else if (extension === '.json') {
187
- return 'potentialJsonOpenApiSpec';
188
- }
189
- else if (supportedStaticFileExtensions.includes(extension)) {
190
- return 'staticFile';
191
- }
192
- throw new Error('Unsupported File Type, No change enacted');
193
- };
1
+ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
2
+ function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
3
+ return new (P || (P = Promise))(function (resolve, reject) {
4
+ function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
5
+ function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
6
+ function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
7
+ step((generator = generator.apply(thisArg, _arguments || [])).next());
8
+ });
9
+ };
10
+ var __generator = (this && this.__generator) || function (thisArg, body) {
11
+ var _ = { label: 0, sent: function() { if (t[0] & 1) throw t[1]; return t[1]; }, trys: [], ops: [] }, f, y, t, g;
12
+ return g = { next: verb(0), "throw": verb(1), "return": verb(2) }, typeof Symbol === "function" && (g[Symbol.iterator] = function() { return this; }), g;
13
+ function verb(n) { return function (v) { return step([n, v]); }; }
14
+ function step(op) {
15
+ if (f) throw new TypeError("Generator is already executing.");
16
+ while (g && (g = 0, op[0] && (_ = 0)), _) try {
17
+ if (f = 1, y && (t = op[0] & 2 ? y["return"] : op[0] ? y["throw"] || ((t = y["return"]) && t.call(y), 0) : y.next) && !(t = t.call(y, op[1])).done) return t;
18
+ if (y = 0, t) op = [op[0] & 2, t.value];
19
+ switch (op[0]) {
20
+ case 0: case 1: t = op; break;
21
+ case 4: _.label++; return { value: op[1], done: false };
22
+ case 5: _.label++; y = op[1]; op = [0]; continue;
23
+ case 7: op = _.ops.pop(); _.trys.pop(); continue;
24
+ default:
25
+ if (!(t = _.trys, t = t.length > 0 && t[t.length - 1]) && (op[0] === 6 || op[0] === 2)) { _ = 0; continue; }
26
+ if (op[0] === 3 && (!t || (op[1] > t[0] && op[1] < t[3]))) { _.label = op[1]; break; }
27
+ if (op[0] === 6 && _.label < t[1]) { _.label = t[1]; t = op; break; }
28
+ if (t && _.label < t[2]) { _.label = t[2]; _.ops.push(op); break; }
29
+ if (t[2]) _.ops.pop();
30
+ _.trys.pop(); continue;
31
+ }
32
+ op = body.call(thisArg, _);
33
+ } catch (e) { op = [6, e]; y = 0; } finally { f = t = 0; }
34
+ if (op[0] & 5) throw op[1]; return { value: op[0] ? op[1] : void 0, done: true };
35
+ }
36
+ };
37
+ var __asyncValues = (this && this.__asyncValues) || function (o) {
38
+ if (!Symbol.asyncIterator) throw new TypeError("Symbol.asyncIterator is not defined.");
39
+ var m = o[Symbol.asyncIterator], i;
40
+ return m ? m.call(o) : (o = typeof __values === "function" ? __values(o) : o[Symbol.iterator](), i = {}, verb("next"), verb("throw"), verb("return"), i[Symbol.asyncIterator] = function () { return this; }, i);
41
+ function verb(n) { i[n] = o[n] && function (v) { return new Promise(function (resolve, reject) { v = o[n](v), settle(resolve, reject, v.done, v.value); }); }; }
42
+ function settle(resolve, reject, d, v) { Promise.resolve(v).then(function(v) { resolve({ value: v, done: d }); }, reject); }
43
+ };
44
+ // TODO - put in prebuild package
45
+ import { getFileList } from '@mintlify/prebuild';
46
+ import path from 'path';
47
+ import { getFileExtension, openApiCheck } from './utils.js';
48
+ export var categorizeFiles = function (contentDirectoryPath) { return __awaiter(void 0, void 0, void 0, function () {
49
+ var contentFilenames, staticFilenames, promises, openApiFiles, snippets, _loop_1, _a, _b, _c, e_1_1;
50
+ var _d, e_1, _e, _f;
51
+ return __generator(this, function (_g) {
52
+ switch (_g.label) {
53
+ case 0:
54
+ contentFilenames = [];
55
+ staticFilenames = [];
56
+ promises = [];
57
+ openApiFiles = [];
58
+ snippets = [];
59
+ _g.label = 1;
60
+ case 1:
61
+ _g.trys.push([1, 6, 7, 12]);
62
+ _loop_1 = function () {
63
+ _f = _c.value;
64
+ _a = false;
65
+ try {
66
+ var filename = _f;
67
+ promises.push((function () { return __awaiter(void 0, void 0, void 0, function () {
68
+ var extension, isOpenApi, openApiInfo, fileName;
69
+ return __generator(this, function (_a) {
70
+ switch (_a.label) {
71
+ case 0:
72
+ extension = getFileExtension(filename);
73
+ isOpenApi = false;
74
+ if (!(extension && (extension === 'mdx' || extension === 'md'))) return [3 /*break*/, 1];
75
+ if (filename.startsWith('/_snippets')) {
76
+ snippets.push(filename);
77
+ }
78
+ else {
79
+ contentFilenames.push(filename);
80
+ }
81
+ return [3 /*break*/, 4];
82
+ case 1:
83
+ if (!(extension &&
84
+ (extension === 'json' || extension === 'yaml' || extension === 'yml'))) return [3 /*break*/, 3];
85
+ return [4 /*yield*/, openApiCheck(path.join(contentDirectoryPath, filename))];
86
+ case 2:
87
+ openApiInfo = _a.sent();
88
+ isOpenApi = openApiInfo.isOpenApi;
89
+ if (isOpenApi) {
90
+ fileName = path.parse(filename).base;
91
+ openApiFiles.push({
92
+ filename: fileName.substring(0, fileName.lastIndexOf('.')),
93
+ spec: openApiInfo.spec,
94
+ });
95
+ }
96
+ return [3 /*break*/, 4];
97
+ case 3:
98
+ if (!filename.endsWith('mint.json') && !isOpenApi) {
99
+ // all other files
100
+ staticFilenames.push(filename);
101
+ }
102
+ _a.label = 4;
103
+ case 4: return [2 /*return*/];
104
+ }
105
+ });
106
+ }); })());
107
+ }
108
+ finally {
109
+ _a = true;
110
+ }
111
+ };
112
+ _a = true, _b = __asyncValues(getFileList(contentDirectoryPath));
113
+ _g.label = 2;
114
+ case 2: return [4 /*yield*/, _b.next()];
115
+ case 3:
116
+ if (!(_c = _g.sent(), _d = _c.done, !_d)) return [3 /*break*/, 5];
117
+ _loop_1();
118
+ _g.label = 4;
119
+ case 4: return [3 /*break*/, 2];
120
+ case 5: return [3 /*break*/, 12];
121
+ case 6:
122
+ e_1_1 = _g.sent();
123
+ e_1 = { error: e_1_1 };
124
+ return [3 /*break*/, 12];
125
+ case 7:
126
+ _g.trys.push([7, , 10, 11]);
127
+ if (!(!_a && !_d && (_e = _b.return))) return [3 /*break*/, 9];
128
+ return [4 /*yield*/, _e.call(_b)];
129
+ case 8:
130
+ _g.sent();
131
+ _g.label = 9;
132
+ case 9: return [3 /*break*/, 11];
133
+ case 10:
134
+ if (e_1) throw e_1.error;
135
+ return [7 /*endfinally*/];
136
+ case 11: return [7 /*endfinally*/];
137
+ case 12: return [4 /*yield*/, Promise.all(promises)];
138
+ case 13:
139
+ _g.sent();
140
+ return [2 /*return*/, { contentFilenames: contentFilenames, staticFilenames: staticFilenames, openApiFiles: openApiFiles, snippets: snippets }];
141
+ }
142
+ });
143
+ }); };
144
+ var excludedMdFiles = ['readme', 'license', 'contributing', 'contribute'];
145
+ var supportedStaticFileExtensions = [
146
+ '.jpeg',
147
+ '.jpg',
148
+ '.jfif',
149
+ '.pjpeg',
150
+ '.pjp',
151
+ '.png',
152
+ '.svg',
153
+ '.svgz',
154
+ '.ico',
155
+ '.webp',
156
+ '.gif',
157
+ '.apng',
158
+ '.avif',
159
+ '.bmp',
160
+ '.mp4',
161
+ ];
162
+ export var getCategory = function (filePath) {
163
+ filePath = filePath.toLowerCase();
164
+ var parsed = path.parse(filePath);
165
+ if (parsed.base === 'mint.json') {
166
+ return 'mintConfig';
167
+ }
168
+ var fileName = parsed.name;
169
+ var extension = parsed.ext;
170
+ if (filePath.startsWith('_snippets') && (extension === '.mdx' || extension === '.md')) {
171
+ return 'snippet';
172
+ }
173
+ else if (extension === '.mdx') {
174
+ return 'page';
175
+ }
176
+ else if (extension === '.md') {
177
+ // Exclude common markdown files people don't want on their docs website
178
+ if (excludedMdFiles.includes(fileName)) {
179
+ throw new Error('Excluded Md File');
180
+ }
181
+ return 'page';
182
+ }
183
+ else if (extension === '.yaml' || extension === '.yml') {
184
+ return 'potentialYamlOpenApiSpec';
185
+ }
186
+ else if (extension === '.json') {
187
+ return 'potentialJsonOpenApiSpec';
188
+ }
189
+ else if (supportedStaticFileExtensions.includes(extension)) {
190
+ return 'staticFile';
191
+ }
192
+ throw new Error('Unsupported File Type, No change enacted');
193
+ };
@@ -1 +1 @@
1
- export declare const generateNav: () => Promise<DecoratedMintNavigation>;
1
+ export declare const generateNav: () => Promise<DecoratedMintNavigation>;