@scalar/oas-utils 0.2.82 → 0.2.84

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 (8) hide show
  1. package/CHANGELOG.md +17 -0
  2. package/dist/helpers/httpStatusCodes.d.ts +1 -0
  3. package/dist/helpers/httpStatusCodes.d.ts.map +1 -1
  4. package/dist/helpers/httpStatusCodes.js +63 -0
  5. package/dist/helpers/isLocalUrl.d.ts.map +1 -1
  6. package/dist/helpers/isLocalUrl.js +11 -3
  7. package/dist/transforms/import-spec.js +1 -1
  8. package/package.json +5 -5
package/CHANGELOG.md CHANGED
@@ -1,5 +1,22 @@
1
1
  # @scalar/oas-utils
2
2
 
3
+ ## 0.2.84
4
+
5
+ ### Patch Changes
6
+
7
+ - 9b4f85d: fix: allow to pass relative file names
8
+
9
+ ## 0.2.83
10
+
11
+ ### Patch Changes
12
+
13
+ - f524411: feat: adds response status color
14
+ - 10c9016: fix: updates find variables import
15
+ - b11294c: fix: add bit of safety to tag name parsing
16
+ - Updated dependencies [c2f5f08]
17
+ - @scalar/types@0.0.23
18
+ - @scalar/themes@0.9.54
19
+
3
20
  ## 0.2.82
4
21
 
5
22
  ### Patch Changes
package/dist/helpers/httpStatusCodes.d.ts CHANGED
@@ -1,6 +1,7 @@
1
1
  export type HttpStatusCode = {
2
2
  name: string;
3
3
  url: string;
4
+ color: string;
4
5
  };
5
6
  export type HttpStatusCodes = Record<string, HttpStatusCode>;
6
7
  export declare const httpStatusCodes: HttpStatusCodes;
package/dist/helpers/httpStatusCodes.d.ts.map CHANGED
@@ -1 +1 @@
1
- {"version":3,"file":"httpStatusCodes.d.ts","sourceRoot":"","sources":["../../src/helpers/httpStatusCodes.ts"],"names":[],"mappings":"AAAA,MAAM,MAAM,cAAc,GAAG;IAC3B,IAAI,EAAE,MAAM,CAAA;IACZ,GAAG,EAAE,MAAM,CAAA;CACZ,CAAA;AAED,MAAM,MAAM,eAAe,GAAG,MAAM,CAAC,MAAM,EAAE,cAAc,CAAC,CAAA;AAE5D,eAAO,MAAM,eAAe,EAAE,eA6P7B,CAAA"}
1
+ {"version":3,"file":"httpStatusCodes.d.ts","sourceRoot":"","sources":["../../src/helpers/httpStatusCodes.ts"],"names":[],"mappings":"AAAA,MAAM,MAAM,cAAc,GAAG;IAC3B,IAAI,EAAE,MAAM,CAAA;IACZ,GAAG,EAAE,MAAM,CAAA;IACX,KAAK,EAAE,MAAM,CAAA;CACd,CAAA;AAED,MAAM,MAAM,eAAe,GAAG,MAAM,CAAC,MAAM,EAAE,cAAc,CAAC,CAAA;AAE5D,eAAO,MAAM,eAAe,EAAE,eA4T7B,CAAA"}
package/dist/helpers/httpStatusCodes.js CHANGED
@@ -2,254 +2,317 @@ const httpStatusCodes = {
2
2
  100: {
3
3
  name: 'Continue',
4
4
  url: 'https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/100',
5
+ color: 'var(--scalar-color-blue)',
5
6
  },
6
7
  101: {
7
8
  name: 'Switching Protocols',
8
9
  url: 'https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/101',
10
+ color: 'var(--scalar-color-blue)',
9
11
  },
10
12
  102: {
11
13
  name: 'Processing',
12
14
  url: 'https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/102',
15
+ color: 'var(--scalar-color-blue)',
13
16
  },
14
17
  103: {
15
18
  name: 'Early Hints',
16
19
  url: 'https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/103',
20
+ color: 'var(--scalar-color-blue)',
17
21
  },
18
22
  200: {
19
23
  name: 'OK',
20
24
  url: 'https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/200',
25
+ color: 'var(--scalar-color-green)',
21
26
  },
22
27
  201: {
23
28
  name: 'Created',
24
29
  url: 'https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/201',
30
+ color: 'var(--scalar-color-green)',
25
31
  },
26
32
  202: {
27
33
  name: 'Accepted',
28
34
  url: 'https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/202',
35
+ color: 'var(--scalar-color-green)',
29
36
  },
30
37
  203: {
31
38
  name: 'Non-Authoritative Information',
32
39
  url: 'https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/203',
40
+ color: 'var(--scalar-color-green)',
33
41
  },
34
42
  204: {
35
43
  name: 'No Content',
36
44
  url: 'https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/204',
45
+ color: 'var(--scalar-color-green)',
37
46
  },
38
47
  205: {
39
48
  name: 'Reset Content',
40
49
  url: 'https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/205',
50
+ color: 'var(--scalar-color-green)',
41
51
  },
42
52
  206: {
43
53
  name: 'Partial Content',
44
54
  url: 'https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/206',
55
+ color: 'var(--scalar-color-green)',
45
56
  },
46
57
  207: {
47
58
  name: 'Multi-Status',
48
59
  url: 'https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/207',
60
+ color: 'var(--scalar-color-green)',
49
61
  },
50
62
  208: {
51
63
  name: 'Already Reported',
52
64
  url: 'https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/208',
65
+ color: 'var(--scalar-color-green)',
53
66
  },
54
67
  226: {
55
68
  name: 'IM Used',
56
69
  url: 'https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/226',
70
+ color: 'var(--scalar-color-green)',
57
71
  },
58
72
  300: {
59
73
  name: 'Multiple Choices',
60
74
  url: 'https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/300',
75
+ color: 'var(--scalar-color-yellow)',
61
76
  },
62
77
  301: {
63
78
  name: 'Moved Permanently',
64
79
  url: 'https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/301',
80
+ color: 'var(--scalar-color-yellow)',
65
81
  },
66
82
  302: {
67
83
  name: 'Found',
68
84
  url: 'https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/302',
85
+ color: 'var(--scalar-color-yellow)',
69
86
  },
70
87
  303: {
71
88
  name: 'See Other',
72
89
  url: 'https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/303',
90
+ color: 'var(--scalar-color-yellow)',
73
91
  },
74
92
  304: {
75
93
  name: 'Not Modified',
76
94
  url: 'https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/304',
95
+ color: 'var(--scalar-color-yellow)',
77
96
  },
78
97
  305: {
79
98
  name: 'Use Proxy',
80
99
  url: 'https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/305',
100
+ color: 'var(--scalar-color-yellow)',
81
101
  },
82
102
  306: {
83
103
  name: '(Unused)',
84
104
  url: 'https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/306',
105
+ color: 'var(--scalar-color-yellow)',
85
106
  },
86
107
  307: {
87
108
  name: 'Temporary Redirect',
88
109
  url: 'https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/307',
110
+ color: 'var(--scalar-color-yellow)',
89
111
  },
90
112
  308: {
91
113
  name: 'Permanent Redirect',
92
114
  url: 'https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/308',
115
+ color: 'var(--scalar-color-yellow)',
93
116
  },
94
117
  400: {
95
118
  name: 'Bad Request',
96
119
  url: 'https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/400',
120
+ color: 'var(--scalar-color-red)',
97
121
  },
98
122
  401: {
99
123
  name: 'Unauthorized',
100
124
  url: 'https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/401',
125
+ color: 'var(--scalar-color-red)',
101
126
  },
102
127
  402: {
103
128
  name: 'Payment Required',
104
129
  url: 'https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/402',
130
+ color: 'var(--scalar-color-red)',
105
131
  },
106
132
  403: {
107
133
  name: 'Forbidden',
108
134
  url: 'https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/403',
135
+ color: 'var(--scalar-color-red)',
109
136
  },
110
137
  404: {
111
138
  name: 'Not Found',
112
139
  url: 'https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/404',
140
+ color: 'var(--scalar-color-red)',
113
141
  },
114
142
  405: {
115
143
  name: 'Method Not Allowed',
116
144
  url: 'https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/405',
145
+ color: 'var(--scalar-color-red)',
117
146
  },
118
147
  406: {
119
148
  name: 'Not Acceptable',
120
149
  url: 'https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/406',
150
+ color: 'var(--scalar-color-red)',
121
151
  },
122
152
  407: {
123
153
  name: 'Proxy Authentication Required',
124
154
  url: 'https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/407',
155
+ color: 'var(--scalar-color-red)',
125
156
  },
126
157
  408: {
127
158
  name: 'Request Timeout',
128
159
  url: 'https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/408',
160
+ color: 'var(--scalar-color-red)',
129
161
  },
130
162
  409: {
131
163
  name: 'Conflict',
132
164
  url: 'https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/409',
165
+ color: 'var(--scalar-color-red)',
133
166
  },
134
167
  410: {
135
168
  name: 'Gone',
136
169
  url: 'https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/410',
170
+ color: 'var(--scalar-color-red)',
137
171
  },
138
172
  411: {
139
173
  name: 'Length Required',
140
174
  url: 'https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/411',
175
+ color: 'var(--scalar-color-red)',
141
176
  },
142
177
  412: {
143
178
  name: 'Precondition Failed',
144
179
  url: 'https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/412',
180
+ color: 'var(--scalar-color-red)',
145
181
  },
146
182
  413: {
147
183
  name: 'Content Too Large',
148
184
  url: 'https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/413',
185
+ color: 'var(--scalar-color-red)',
149
186
  },
150
187
  414: {
151
188
  name: 'URI Too Long',
152
189
  url: 'https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/414',
190
+ color: 'var(--scalar-color-red)',
153
191
  },
154
192
  415: {
155
193
  name: 'Unsupported Media Type',
156
194
  url: 'https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/415',
195
+ color: 'var(--scalar-color-red)',
157
196
  },
158
197
  416: {
159
198
  name: 'Range Not Satisfiable',
160
199
  url: 'https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/416',
200
+ color: 'var(--scalar-color-red)',
161
201
  },
162
202
  417: {
163
203
  name: 'Expectation Failed',
164
204
  url: 'https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/417',
205
+ color: 'var(--scalar-color-red)',
165
206
  },
166
207
  418: {
167
208
  name: "I'm a teapot",
168
209
  url: 'https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/418',
210
+ color: 'var(--scalar-color-red)',
169
211
  },
170
212
  421: {
171
213
  name: 'Misdirected Request',
172
214
  url: 'https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/421',
215
+ color: 'var(--scalar-color-red)',
173
216
  },
174
217
  422: {
175
218
  name: 'Unprocessable Content',
176
219
  url: 'https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/422',
220
+ color: 'var(--scalar-color-red)',
177
221
  },
178
222
  423: {
179
223
  name: 'Locked',
180
224
  url: 'https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/423',
225
+ color: 'var(--scalar-color-red)',
181
226
  },
182
227
  424: {
183
228
  name: 'Failed Dependency',
184
229
  url: 'https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/424',
230
+ color: 'var(--scalar-color-red)',
185
231
  },
186
232
  425: {
187
233
  name: 'Too Early',
188
234
  url: 'https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/425',
235
+ color: 'var(--scalar-color-red)',
189
236
  },
190
237
  426: {
191
238
  name: 'Upgrade Required',
192
239
  url: 'https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/426',
240
+ color: 'var(--scalar-color-red)',
193
241
  },
194
242
  428: {
195
243
  name: 'Precondition Required',
196
244
  url: 'https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/428',
245
+ color: 'var(--scalar-color-red)',
197
246
  },
198
247
  429: {
199
248
  name: 'Too Many Requests',
200
249
  url: 'https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/429',
250
+ color: 'var(--scalar-color-red)',
201
251
  },
202
252
  431: {
203
253
  name: 'Request Header Fields Too Large',
204
254
  url: 'https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/431',
255
+ color: 'var(--scalar-color-red)',
205
256
  },
206
257
  451: {
207
258
  name: 'Unavailable For Legal Reasons',
208
259
  url: 'https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/451',
260
+ color: 'var(--scalar-color-red)',
209
261
  },
210
262
  500: {
211
263
  name: 'Internal Server Error',
212
264
  url: 'https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/500',
265
+ color: 'var(--scalar-color-red)',
213
266
  },
214
267
  501: {
215
268
  name: 'Not Implemented',
216
269
  url: 'https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/501',
270
+ color: 'var(--scalar-color-red)',
217
271
  },
218
272
  502: {
219
273
  name: 'Bad Gateway',
220
274
  url: 'https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/502',
275
+ color: 'var(--scalar-color-red)',
221
276
  },
222
277
  503: {
223
278
  name: 'Service Unavailable',
224
279
  url: 'https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/503',
280
+ color: 'var(--scalar-color-red)',
225
281
  },
226
282
  504: {
227
283
  name: 'Gateway Timeout',
228
284
  url: 'https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/504',
285
+ color: 'var(--scalar-color-red)',
229
286
  },
230
287
  505: {
231
288
  name: 'HTTP Version Not Supported',
232
289
  url: 'https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/505',
290
+ color: 'var(--scalar-color-red)',
233
291
  },
234
292
  506: {
235
293
  name: 'Variant Also Negotiates',
236
294
  url: 'https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/506',
295
+ color: 'var(--scalar-color-red)',
237
296
  },
238
297
  507: {
239
298
  name: 'Insufficient Storage',
240
299
  url: 'https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/507',
300
+ color: 'var(--scalar-color-red)',
241
301
  },
242
302
  508: {
243
303
  name: 'Loop Detected',
244
304
  url: 'https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/508',
305
+ color: 'var(--scalar-color-red)',
245
306
  },
246
307
  510: {
247
308
  name: 'Not Extended',
248
309
  url: 'https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/510',
310
+ color: 'var(--scalar-color-red)',
249
311
  },
250
312
  511: {
251
313
  name: 'Network Authentication Required',
252
314
  url: 'https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/511',
315
+ color: 'var(--scalar-color-red)',
253
316
  },
254
317
  };
255
318
 
package/dist/helpers/isLocalUrl.d.ts.map CHANGED
@@ -1 +1 @@
1
- {"version":3,"file":"isLocalUrl.d.ts","sourceRoot":"","sources":["../../src/helpers/isLocalUrl.ts"],"names":[],"mappings":"AAAA;;GAEG;AACH,wBAAgB,UAAU,CAAC,GAAG,EAAE,MAAM,WAIrC"}
1
+ {"version":3,"file":"isLocalUrl.d.ts","sourceRoot":"","sources":["../../src/helpers/isLocalUrl.ts"],"names":[],"mappings":"AAGA;;GAEG;AACH,wBAAgB,UAAU,CAAC,GAAG,EAAE,MAAM,WAUrC"}
package/dist/helpers/isLocalUrl.js CHANGED
@@ -1,10 +1,18 @@
1
+ /** Obviously local hostnames */
2
+ const LOCAL_HOSTNAMES = ['localhost', '127.0.0.1', '[::1]', '0.0.0.0'];
1
3
  /**
2
4
  * Detect requests to localhost
3
5
  */
4
6
  function isLocalUrl(url) {
5
- const { hostname } = new URL(url);
6
- const listOfLocalUrls = ['localhost', '127.0.0.1', '[::1]', '0.0.0.0'];
7
- return listOfLocalUrls.includes(hostname);
7
+ try {
8
+ const { hostname } = new URL(url);
9
+ return LOCAL_HOSTNAMES.includes(hostname);
10
+ }
11
+ catch {
12
+ // If it’s not a valid URL, we can’t use the proxy anyway,
13
+ // but it also covers cases like relative URLs (e.g. `openapi.json`).
14
+ return true;
15
+ }
8
16
  }
9
17
 
10
18
  export { isLocalUrl };
package/dist/transforms/import-spec.js CHANGED
@@ -241,7 +241,7 @@ async function importSpecToWorkspace(spec, { authentication, baseServerURL, docu
241
241
  // Delete any tag names that already have a definition
242
242
  tags.forEach((t) => tagNames.delete(t.name));
243
243
  // Add an entry for any tags that are used but do not have a definition
244
- tagNames.forEach((name) => tags.push(tagSchema.parse({ name })));
244
+ tagNames.forEach((name) => name && tags.push(tagSchema.parse({ name })));
245
245
  // Tag name to UID map
246
246
  const tagMap = {};
247
247
  tags.forEach((t) => {
package/package.json CHANGED
@@ -16,7 +16,7 @@
16
16
  "specification",
17
17
  "yaml"
18
18
  ],
19
- "version": "0.2.82",
19
+ "version": "0.2.84",
20
20
  "engines": {
21
21
  "node": ">=18"
22
22
  },
@@ -112,9 +112,9 @@
112
112
  "yaml": "^2.4.5",
113
113
  "zod": "^3.23.8",
114
114
  "@scalar/object-utils": "1.1.12",
115
+ "@scalar/themes": "0.9.54",
115
116
  "@scalar/openapi-types": "0.1.5",
116
- "@scalar/themes": "0.9.53",
117
- "@scalar/types": "0.0.22"
117
+ "@scalar/types": "0.0.23"
118
118
  },
119
119
  "devDependencies": {
120
120
  "type-fest": "^4.20.0",
@@ -122,8 +122,8 @@
122
122
  "vitest": "^1.6.0",
123
123
  "zod-to-ts": "github:amritk/zod-to-ts#build",
124
124
  "@scalar/build-tooling": "0.1.12",
125
- "@scalar/openapi-types": "0.1.5",
126
- "@scalar/openapi-parser": "0.8.10"
125
+ "@scalar/openapi-parser": "0.8.10",
126
+ "@scalar/openapi-types": "0.1.5"
127
127
  },
128
128
  "scripts": {
129
129
  "build": "scalar-build-rollup",