@redocly/openapi-core 1.0.0-beta.61 → 1.0.0-beta.65

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 (47) hide show
  1. package/__tests__/lint.test.ts +17 -0
  2. package/__tests__/resolve.test.ts +10 -2
  3. package/__tests__/utils.ts +3 -5
  4. package/lib/benchmark/utils.js +2 -2
  5. package/lib/config/config.d.ts +1 -0
  6. package/lib/config/config.js +3 -3
  7. package/lib/index.d.ts +1 -0
  8. package/lib/index.js +4 -1
  9. package/lib/js-yaml/index.d.ts +3 -0
  10. package/lib/js-yaml/index.js +19 -0
  11. package/lib/oas-types.js +3 -0
  12. package/lib/resolve.d.ts +1 -1
  13. package/lib/resolve.js +3 -4
  14. package/lib/rules/builtin.d.ts +6 -0
  15. package/lib/rules/common/info-description-override.d.ts +2 -0
  16. package/lib/rules/common/info-description-override.js +24 -0
  17. package/lib/rules/common/operation-description-override.d.ts +2 -0
  18. package/lib/rules/common/operation-description-override.js +29 -0
  19. package/lib/rules/common/tag-description-override.d.ts +2 -0
  20. package/lib/rules/common/tag-description-override.js +25 -0
  21. package/lib/rules/oas2/index.d.ts +3 -0
  22. package/lib/rules/oas2/index.js +6 -0
  23. package/lib/rules/oas3/index.d.ts +3 -0
  24. package/lib/rules/oas3/index.js +7 -1
  25. package/lib/types/redocly-yaml.js +332 -21
  26. package/lib/utils.d.ts +5 -1
  27. package/lib/utils.js +18 -3
  28. package/package.json +3 -3
  29. package/src/__tests__/js-yaml.test.ts +47 -0
  30. package/src/__tests__/lint.test.ts +13 -0
  31. package/src/__tests__/utils.test.ts +56 -0
  32. package/src/benchmark/utils.ts +2 -2
  33. package/src/config/config.ts +4 -3
  34. package/src/index.ts +2 -0
  35. package/src/js-yaml/index.ts +19 -0
  36. package/src/oas-types.ts +4 -0
  37. package/src/resolve.ts +5 -5
  38. package/src/rules/__tests__/no-unresolved-refs.test.ts +2 -2
  39. package/src/rules/common/info-description-override.ts +24 -0
  40. package/src/rules/common/operation-description-override.ts +30 -0
  41. package/src/rules/common/tag-description-override.ts +25 -0
  42. package/src/rules/oas2/index.ts +6 -0
  43. package/src/rules/oas3/index.ts +8 -3
  44. package/src/types/redocly-yaml.ts +434 -22
  45. package/src/typings/swagger.ts +0 -1
  46. package/src/utils.ts +27 -3
  47. package/tsconfig.tsbuildinfo +1 -1
@@ -2,12 +2,13 @@
2
2
  Object.defineProperty(exports, "__esModule", { value: true });
3
3
  exports.ConfigTypes = void 0;
4
4
  const _1 = require(".");
5
+ const utils_1 = require("../utils");
5
6
  const ConfigRoot = {
6
7
  properties: {
7
8
  apiDefinitions: {
8
9
  type: 'object',
9
10
  properties: {},
10
- additionalProperties: { properties: { type: 'string' } }
11
+ additionalProperties: { properties: { type: 'string' } },
11
12
  },
12
13
  lint: 'ConfigLint',
13
14
  referenceDocs: 'ConfigReferenceDocs',
@@ -87,25 +88,297 @@ const ConfigSidebarLinks = {
87
88
  target: { type: 'string' },
88
89
  },
89
90
  };
91
+ const CommonThemeColors = {
92
+ properties: {
93
+ main: { type: 'string' },
94
+ light: { type: 'string' },
95
+ dark: { type: 'string' },
96
+ contrastText: { type: 'string' },
97
+ },
98
+ };
99
+ const CommonColorProps = {
100
+ properties: {
101
+ backgroundColor: { type: 'string' },
102
+ borderColor: { type: 'string' },
103
+ color: { type: 'string' },
104
+ tabTextColor: { type: 'string' },
105
+ },
106
+ };
107
+ const BorderThemeColors = {
108
+ properties: utils_1.pickObjectProps(CommonThemeColors.properties, ['light', 'dark']),
109
+ };
110
+ const HttpColors = {
111
+ properties: {
112
+ basic: { type: 'string' },
113
+ delete: { type: 'string' },
114
+ get: { type: 'string' },
115
+ head: { type: 'string' },
116
+ link: { type: 'string' },
117
+ options: { type: 'string' },
118
+ patch: { type: 'string' },
119
+ post: { type: 'string' },
120
+ put: { type: 'string' },
121
+ },
122
+ };
123
+ const ResponseColors = {
124
+ properties: {
125
+ errors: 'CommonColorProps',
126
+ info: 'CommonColorProps',
127
+ redirect: 'CommonColorProps',
128
+ success: 'CommonColorProps',
129
+ },
130
+ };
131
+ const SecondaryColors = {
132
+ properties: utils_1.omitObjectProps(CommonThemeColors.properties, ['dark']),
133
+ };
134
+ const TextThemeColors = {
135
+ properties: {
136
+ primary: { type: 'string' },
137
+ secondary: { type: 'string' },
138
+ light: { type: 'string' },
139
+ },
140
+ };
141
+ const ThemeColors = {
142
+ properties: {
143
+ accent: 'CommonThemeColors',
144
+ border: 'BorderThemeColors',
145
+ error: 'CommonThemeColors',
146
+ http: 'HttpColors',
147
+ primary: 'CommonThemeColors',
148
+ responses: 'ResponseColors',
149
+ secondary: 'SecondaryColors',
150
+ success: 'CommonThemeColors',
151
+ text: 'TextThemeColors',
152
+ tonalOffset: { type: 'number' },
153
+ warning: 'CommonThemeColors',
154
+ },
155
+ };
156
+ const SizeProps = {
157
+ properties: {
158
+ fontSize: { type: 'string' },
159
+ padding: { type: 'string' },
160
+ minWidth: { type: 'string' },
161
+ },
162
+ };
163
+ const Sizes = {
164
+ properties: {
165
+ small: 'SizeProps',
166
+ medium: 'SizeProps',
167
+ large: 'SizeProps',
168
+ xlarge: 'SizeProps',
169
+ },
170
+ };
171
+ const FontConfig = {
172
+ properties: {
173
+ fontFamily: { type: 'string' },
174
+ fontSize: { type: 'string' },
175
+ fontWeight: { type: 'string' },
176
+ lineHeight: { type: 'string' },
177
+ },
178
+ };
179
+ const ButtonsConfig = {
180
+ properties: Object.assign(Object.assign({}, utils_1.omitObjectProps(FontConfig.properties, ['fontSize', 'lineHeight'])), { borderRadius: { type: 'string' }, hoverStyle: { type: 'string' }, boxShadow: { type: 'string' }, hoverBoxShadow: { type: 'string' }, sizes: 'Sizes' }),
181
+ };
182
+ const BadgeFontConfig = {
183
+ properties: utils_1.pickObjectProps(FontConfig.properties, ['fontSize', 'lineHeight']),
184
+ };
185
+ const BadgeSizes = {
186
+ properties: {
187
+ medium: 'BadgeFontConfig',
188
+ small: 'BadgeFontConfig',
189
+ },
190
+ };
191
+ const HttpBadgesConfig = {
192
+ properties: Object.assign(Object.assign({}, utils_1.omitObjectProps(FontConfig.properties, ['fontSize', 'lineHeight'])), { borderRadius: { type: 'string' }, color: { type: 'string' }, sizes: 'BadgeSizes' }),
193
+ };
194
+ const LabelControls = {
195
+ properties: {
196
+ top: { type: 'string' },
197
+ },
198
+ };
199
+ const Panels = {
200
+ properties: {
201
+ borderRadius: { type: 'string' },
202
+ },
203
+ };
204
+ const TryItButton = {
205
+ properties: {
206
+ fullWidth: { type: 'boolean' },
207
+ },
208
+ };
209
+ const Components = {
210
+ properties: {
211
+ buttons: 'ButtonsConfig',
212
+ httpBadges: 'HttpBadgesConfig',
213
+ layoutControls: 'LabelControls',
214
+ panels: 'Panels',
215
+ tryItButton: 'TryItButton',
216
+ tryItSendButton: 'TryItButton',
217
+ },
218
+ };
219
+ const Breakpoints = {
220
+ properties: {
221
+ small: { type: 'string' },
222
+ medium: { type: 'string' },
223
+ large: { type: 'string' },
224
+ },
225
+ };
226
+ const StackedConfig = {
227
+ properties: {
228
+ maxWidth: 'Breakpoints',
229
+ },
230
+ };
231
+ const ThreePanelConfig = {
232
+ properties: {
233
+ maxWidth: 'Breakpoints',
234
+ },
235
+ };
236
+ const Layout = {
237
+ properties: {
238
+ showDarkRightPanel: { type: 'boolean' },
239
+ stacked: 'StackedConfig',
240
+ 'three-panel': 'ThreePanelConfig',
241
+ },
242
+ };
243
+ const SchemaColorsConfig = {
244
+ properties: {
245
+ backgroundColor: { type: 'string' },
246
+ border: { type: 'string' },
247
+ },
248
+ };
249
+ const Schema = {
250
+ properties: {
251
+ breakFieldNames: { type: 'boolean' },
252
+ caretColor: { type: 'string' },
253
+ caretSize: { type: 'string' },
254
+ constraints: 'SchemaColorsConfig',
255
+ defaultDetailsWidth: { type: 'string' },
256
+ examples: 'SchemaColorsConfig',
257
+ labelsTextSize: { type: 'string' },
258
+ linesColor: { type: 'string' },
259
+ nestedBackground: { type: 'string' },
260
+ nestingSpacing: { type: 'string' },
261
+ requireLabelColor: { type: 'string' },
262
+ typeNameColor: { type: 'string' },
263
+ typeTitleColor: { type: 'string' },
264
+ },
265
+ };
266
+ const GroupItemsConfig = {
267
+ properties: {
268
+ subItemsColor: { type: 'string' },
269
+ textTransform: { type: 'string' },
270
+ fontWeight: { type: 'string' },
271
+ },
272
+ };
273
+ const Level1Items = {
274
+ properties: utils_1.pickObjectProps(GroupItemsConfig.properties, ['textTransform']),
275
+ };
276
+ const SpacingConfig = {
277
+ properties: {
278
+ unit: { type: 'number' },
279
+ paddingHorizontal: { type: 'string' },
280
+ paddingVertical: { type: 'string' },
281
+ offsetTop: { type: 'string' },
282
+ offsetLeft: { type: 'string' },
283
+ offsetNesting: { type: 'string' },
284
+ },
285
+ };
286
+ const Sidebar = {
287
+ properties: Object.assign(Object.assign({}, utils_1.omitObjectProps(FontConfig.properties, ['fontWeight', 'lineHeight'])), { activeBgColor: { type: 'string' }, activeTextColor: { type: 'string' }, backgroundColor: { type: 'string' }, borderRadius: { type: 'string' }, breakPath: { type: 'boolean' }, caretColor: { type: 'string' }, caretSize: { type: 'string' }, groupItems: 'GroupItemsConfig', level1items: 'Level1Items', rightLineColor: { type: 'string' }, separatorLabelColor: { type: 'string' }, showAtBreakpoint: { type: 'string' }, spacing: 'SpacingConfig', textColor: { type: 'string' }, width: { type: 'string' } }),
288
+ };
289
+ const Heading = {
290
+ properties: Object.assign(Object.assign({}, FontConfig.properties), { color: { type: 'string' }, transform: { type: 'string' } }),
291
+ };
292
+ const CodeConfig = {
293
+ properties: Object.assign(Object.assign({}, FontConfig.properties), { backgroundColor: { type: 'string' }, color: { type: 'string' }, wordBreak: { type: 'string' }, wrap: { type: 'boolean' } }),
294
+ };
295
+ const HeadingsConfig = {
296
+ properties: utils_1.omitObjectProps(FontConfig.properties, ['fontSize']),
297
+ };
298
+ const LinksConfig = {
299
+ properties: {
300
+ color: { type: 'string' },
301
+ hover: { type: 'string' },
302
+ textDecoration: { type: 'string' },
303
+ visited: { type: 'string' },
304
+ },
305
+ };
306
+ const Typography = {
307
+ properties: Object.assign(Object.assign({ code: 'CodeConfig', fieldName: 'FontConfig' }, utils_1.pickObjectProps(FontConfig.properties, ['fontSize', 'fontFamily'])), { fontWeightBold: { type: 'string' }, fontWeightLight: { type: 'string' }, fontWeightRegular: { type: 'string' }, heading1: 'Heading', heading2: 'Heading', heading3: 'Heading', headings: 'HeadingsConfig', lineHeight: { type: 'string' }, links: 'LinksConfig', optimizeSpeed: { type: 'boolean' }, rightPanelHeading: 'Heading', smoothing: { type: 'string' } }),
308
+ };
309
+ const TokenProps = {
310
+ properties: Object.assign({ color: { type: 'string' } }, utils_1.omitObjectProps(FontConfig.properties, ['fontWeight'])),
311
+ };
312
+ const CodeBlock = {
313
+ properties: {
314
+ backgroundColor: { type: 'string' },
315
+ borderRadius: { type: 'string' },
316
+ tokens: 'TokenProps',
317
+ },
318
+ };
319
+ const Logo = {
320
+ properties: {
321
+ gutter: { type: 'string' },
322
+ maxHeight: { type: 'string' },
323
+ maxWidth: { type: 'string' },
324
+ },
325
+ };
326
+ const ButtonOverrides = {
327
+ properties: {
328
+ custom: { type: 'string' },
329
+ },
330
+ };
331
+ const Overrides = {
332
+ properties: {
333
+ DownloadButton: 'ButtonOverrides',
334
+ NextSectionButton: 'ButtonOverrides',
335
+ },
336
+ };
337
+ const RightPanel = {
338
+ properties: {
339
+ backgroundColor: { type: 'string' },
340
+ panelBackgroundColor: { type: 'string' },
341
+ panelControlsBackgroundColor: { type: 'string' },
342
+ showAtBreakpoint: { type: 'string' },
343
+ textColor: { type: 'string' },
344
+ width: { type: 'string' },
345
+ },
346
+ };
347
+ const Shape = {
348
+ properties: { borderRadius: { type: 'string' } },
349
+ };
350
+ const ThemeSpacing = {
351
+ properties: {
352
+ sectionHorizontal: { type: 'number' },
353
+ sectionVertical: { type: 'number' },
354
+ unit: { type: 'number' },
355
+ },
356
+ };
90
357
  const ConfigTheme = {
91
358
  properties: {
92
- breakpoints: { type: 'object', additionalProperties: { type: 'string' } },
93
- codeBlock: { type: 'object', additionalProperties: { type: 'string' } },
94
- colors: { type: 'object', additionalProperties: { type: 'string' } },
95
- components: { type: 'object', additionalProperties: { type: 'string' } },
96
- layout: { type: 'object', additionalProperties: { type: 'string' } },
97
- logo: { type: 'object', additionalProperties: { type: 'string' } },
98
- overrides: { type: 'object', additionalProperties: { type: 'string' } },
99
- rightPanel: { type: 'object', additionalProperties: { type: 'string' } },
100
- schema: { type: 'object', additionalProperties: { type: 'string' } },
101
- shape: { type: 'object', additionalProperties: { type: 'string' } },
102
- sidebar: { type: 'object', additionalProperties: { type: 'string' } },
103
- spacing: { type: 'object', additionalProperties: { type: 'string' } },
104
- typography: { type: 'object', additionalProperties: { type: 'string' } },
359
+ breakpoints: 'Breakpoints',
360
+ codeBlock: 'CodeBlock',
361
+ colors: 'ThemeColors',
362
+ components: 'Components',
363
+ layout: 'Layout',
364
+ logo: 'Logo',
365
+ overrides: 'Overrides',
366
+ rightPanel: 'RightPanel',
367
+ schema: 'Schema',
368
+ shape: 'Shape',
369
+ sidebar: 'Sidebar',
370
+ spacing: 'ThemeSpacing',
371
+ typography: 'Typography',
105
372
  links: { properties: { color: { type: 'string' } } },
106
373
  codeSample: { properties: { backgroundColor: { type: 'string' } } },
107
374
  },
108
375
  };
376
+ const GenerateCodeSamples = {
377
+ properties: {
378
+ skipOptionalParameters: { type: 'boolean' },
379
+ languages: _1.listOf('ConfigLanguage'),
380
+ },
381
+ };
109
382
  const ConfigReferenceDocs = {
110
383
  properties: {
111
384
  theme: 'ConfigTheme',
@@ -119,12 +392,7 @@ const ConfigReferenceDocs = {
119
392
  expandDefaultServerVariables: { type: 'boolean' },
120
393
  expandResponses: { type: 'string' },
121
394
  expandSingleSchemaField: { type: 'boolean' },
122
- generateCodeSamples: {
123
- properties: {
124
- skipOptionalParameters: { type: 'boolean' },
125
- languages: _1.listOf('ConfigLanguage'),
126
- },
127
- },
395
+ generateCodeSamples: 'GenerateCodeSamples',
128
396
  generatedPayloadSamplesMaxDepth: { type: 'number' },
129
397
  hideDownloadButton: { type: 'boolean' },
130
398
  hideHostname: { type: 'boolean' },
@@ -138,7 +406,7 @@ const ConfigReferenceDocs = {
138
406
  htmlTemplate: { type: 'string' },
139
407
  jsonSampleExpandLevel: { type: 'string' },
140
408
  labels: 'ConfigLabels',
141
- layout: { type: 'object' },
409
+ layout: { type: 'string' },
142
410
  maxDisplayedEnumValues: { type: 'number' },
143
411
  menuToggle: { type: 'boolean' },
144
412
  nativeScrollbars: { type: 'boolean' },
@@ -186,4 +454,47 @@ exports.ConfigTypes = {
186
454
  ConfigLabels,
187
455
  ConfigSidebarLinks,
188
456
  ConfigTheme,
457
+ ThemeColors,
458
+ CommonThemeColors,
459
+ BorderThemeColors,
460
+ HttpColors,
461
+ ResponseColors,
462
+ SecondaryColors,
463
+ TextThemeColors,
464
+ Sizes,
465
+ ButtonsConfig,
466
+ CommonColorProps,
467
+ BadgeFontConfig,
468
+ BadgeSizes,
469
+ HttpBadgesConfig,
470
+ LabelControls,
471
+ Panels,
472
+ TryItButton,
473
+ Breakpoints,
474
+ StackedConfig,
475
+ ThreePanelConfig,
476
+ SchemaColorsConfig,
477
+ SizeProps,
478
+ Level1Items,
479
+ SpacingConfig,
480
+ FontConfig,
481
+ CodeConfig,
482
+ HeadingsConfig,
483
+ LinksConfig,
484
+ TokenProps,
485
+ CodeBlock,
486
+ Logo,
487
+ ButtonOverrides,
488
+ Overrides,
489
+ RightPanel,
490
+ Shape,
491
+ ThemeSpacing,
492
+ GenerateCodeSamples,
493
+ GroupItemsConfig,
494
+ Components,
495
+ Layout,
496
+ Schema,
497
+ Sidebar,
498
+ Heading,
499
+ Typography,
189
500
  };
package/lib/utils.d.ts CHANGED
@@ -1,4 +1,5 @@
1
1
  import { HttpResolveConfig } from './config/config';
2
+ export { parseYaml, stringifyYaml } from './js-yaml';
2
3
  export declare type StackFrame<T> = {
3
4
  prev: StackFrame<T> | null;
4
5
  value: T;
@@ -11,7 +12,7 @@ export declare function pushStack<T, P extends Stack<T> = Stack<T>>(head: P, val
11
12
  };
12
13
  export declare function popStack<T, P extends Stack<T>>(head: P): StackFrame<T> | null;
13
14
  export declare type BundleOutputFormat = 'json' | 'yml' | 'yaml';
14
- export declare function loadYaml(filename: string): Promise<string | object | undefined>;
15
+ export declare function loadYaml(filename: string): Promise<unknown>;
15
16
  export declare function notUndefined<T>(x: T | undefined): x is T;
16
17
  export declare function isPlainObject(value: any): value is object;
17
18
  export declare function readFileFromUrl(url: string, config: HttpResolveConfig): Promise<{
@@ -19,3 +20,6 @@ export declare function readFileFromUrl(url: string, config: HttpResolveConfig):
19
20
  mimeType: any;
20
21
  }>;
21
22
  export declare function match(url: string, pattern: string): boolean;
23
+ export declare function pickObjectProps<T extends Record<string, unknown>>(object: T, keys: Array<string>): T;
24
+ export declare function omitObjectProps<T extends Record<string, unknown>>(object: T, keys: Array<string>): T;
25
+ export declare function readFileAsStringSync(filePath: string): string;
package/lib/utils.js CHANGED
@@ -9,11 +9,14 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
9
9
  });
10
10
  };
11
11
  Object.defineProperty(exports, "__esModule", { value: true });
12
- exports.match = exports.readFileFromUrl = exports.isPlainObject = exports.notUndefined = exports.loadYaml = exports.popStack = exports.pushStack = void 0;
13
- const yaml = require("js-yaml");
12
+ exports.readFileAsStringSync = exports.omitObjectProps = exports.pickObjectProps = exports.match = exports.readFileFromUrl = exports.isPlainObject = exports.notUndefined = exports.loadYaml = exports.popStack = exports.pushStack = exports.stringifyYaml = exports.parseYaml = void 0;
14
13
  const fs = require("fs");
15
14
  const minimatch = require("minimatch");
16
15
  const node_fetch_1 = require("node-fetch");
16
+ const js_yaml_1 = require("./js-yaml");
17
+ var js_yaml_2 = require("./js-yaml");
18
+ Object.defineProperty(exports, "parseYaml", { enumerable: true, get: function () { return js_yaml_2.parseYaml; } });
19
+ Object.defineProperty(exports, "stringifyYaml", { enumerable: true, get: function () { return js_yaml_2.stringifyYaml; } });
17
20
  function pushStack(head, value) {
18
21
  return { prev: head, value };
19
22
  }
@@ -26,7 +29,7 @@ exports.popStack = popStack;
26
29
  function loadYaml(filename) {
27
30
  return __awaiter(this, void 0, void 0, function* () {
28
31
  const contents = yield fs.promises.readFile(filename, 'utf-8');
29
- return yaml.safeLoad(contents);
32
+ return js_yaml_1.parseYaml(contents);
30
33
  });
31
34
  }
32
35
  exports.loadYaml = loadYaml;
@@ -65,3 +68,15 @@ function match(url, pattern) {
65
68
  return minimatch(url, pattern);
66
69
  }
67
70
  exports.match = match;
71
+ function pickObjectProps(object, keys) {
72
+ return Object.fromEntries(keys.filter((key) => key in object).map((key) => [key, object[key]]));
73
+ }
74
+ exports.pickObjectProps = pickObjectProps;
75
+ function omitObjectProps(object, keys) {
76
+ return Object.fromEntries(Object.entries(object).filter(([key]) => !keys.includes(key)));
77
+ }
78
+ exports.omitObjectProps = omitObjectProps;
79
+ function readFileAsStringSync(filePath) {
80
+ return fs.readFileSync(filePath, 'utf-8');
81
+ }
82
+ exports.readFileAsStringSync = readFileAsStringSync;
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@redocly/openapi-core",
3
- "version": "1.0.0-beta.61",
3
+ "version": "1.0.0-beta.65",
4
4
  "description": "",
5
5
  "main": "lib/index.js",
6
6
  "engines": {
@@ -34,7 +34,7 @@
34
34
  "@types/node": "^14.11.8",
35
35
  "colorette": "^1.2.0",
36
36
  "js-levenshtein": "^1.1.6",
37
- "js-yaml": "^3.14.1",
37
+ "js-yaml": "^4.1.0",
38
38
  "lodash.isequal": "^4.5.0",
39
39
  "minimatch": "^3.0.4",
40
40
  "node-fetch": "^2.6.1",
@@ -42,7 +42,7 @@
42
42
  },
43
43
  "devDependencies": {
44
44
  "@types/js-levenshtein": "^1.1.0",
45
- "@types/js-yaml": "^3.12.4",
45
+ "@types/js-yaml": "^4.0.3",
46
46
  "@types/lodash.isequal": "^4.5.5",
47
47
  "@types/minimatch": "^3.0.3",
48
48
  "@types/node-fetch": "^2.5.7",
@@ -0,0 +1,47 @@
1
+ import { parseYaml, stringifyYaml } from '../js-yaml';
2
+
3
+ const yaml = `
4
+ emptyValue:
5
+ spaces in keys: spaces in keys
6
+ numberString: '0123456789'
7
+ number: 1000
8
+ decimal: 12.34
9
+ boolean: true
10
+ date: 2020-01-01
11
+ array:
12
+ - 1
13
+ - 2
14
+ object:
15
+ key1: 1
16
+ key2: 2
17
+ `;
18
+
19
+ const jsObject = {
20
+ emptyValue: null,
21
+ 'spaces in keys': 'spaces in keys',
22
+ numberString: '0123456789',
23
+ number: 1000,
24
+ decimal: 12.34,
25
+ boolean: true,
26
+ date: '2020-01-01',
27
+ array: [1, 2],
28
+ object: { key1: 1, key2: 2 },
29
+ };
30
+
31
+ describe('js-yaml', () => {
32
+ test('parseYaml', () => {
33
+ expect(parseYaml(yaml)).toEqual(jsObject);
34
+ });
35
+
36
+ test('parse and stringify', () => {
37
+ expect(parseYaml(stringifyYaml(jsObject))).toEqual(jsObject);
38
+ });
39
+
40
+ test('should throw an error for unsupported types', () => {
41
+ expect(() => stringifyYaml({ date: new Date() }))
42
+ .toThrow('unacceptable kind of an object to dump [object Date]');
43
+
44
+ expect(() => stringifyYaml({ foo: () => {} }))
45
+ .toThrow('unacceptable kind of an object to dump [object Function]');
46
+ });
47
+ });
@@ -87,6 +87,19 @@ describe('lint', () => {
87
87
  "severity": "error",
88
88
  "suggest": Array [],
89
89
  },
90
+ Object {
91
+ "location": Array [
92
+ Object {
93
+ "pointer": "#/referenceDocs/layout",
94
+ "reportOnKey": false,
95
+ "source": "",
96
+ },
97
+ ],
98
+ "message": "Expected type \`string\` but got \`object\`.",
99
+ "ruleId": "spec",
100
+ "severity": "error",
101
+ "suggest": Array [],
102
+ },
90
103
  ]
91
104
  `);
92
105
  });
@@ -0,0 +1,56 @@
1
+ import { pickObjectProps, omitObjectProps } from '../utils';
2
+
3
+ describe('utils', () => {
4
+ const testObject = {
5
+ a: 'value a',
6
+ b: 'value b',
7
+ c: 'value c',
8
+ d: 'value d',
9
+ e: 'value e',
10
+ };
11
+
12
+ describe('pickObjectProps', () => {
13
+ it('returns correct object result', () => {
14
+ expect(pickObjectProps(testObject, ['a', 'b'])).toStrictEqual({ a: 'value a', b: 'value b' });
15
+ });
16
+
17
+ it('returns correct object if passed non existing key', () => {
18
+ expect(pickObjectProps(testObject, ['a', 'b', 'nonExisting'])).toStrictEqual({
19
+ a: 'value a',
20
+ b: 'value b',
21
+ });
22
+ });
23
+
24
+ it('returns an empty object if no keys are passed', () => {
25
+ expect(pickObjectProps(testObject, [])).toStrictEqual({});
26
+ });
27
+
28
+ it('returns an empty object if empty target obj passed', () => {
29
+ expect(pickObjectProps({}, ['d', 'e'])).toStrictEqual({});
30
+ });
31
+ });
32
+
33
+ describe('omitObjectProps', () => {
34
+ it('returns correct object result', () => {
35
+ expect(omitObjectProps(testObject, ['a', 'b', 'c'])).toStrictEqual({
36
+ d: 'value d',
37
+ e: 'value e',
38
+ });
39
+ });
40
+
41
+ it('returns correct object if passed non existing key', () => {
42
+ expect(omitObjectProps(testObject, ['a', 'b', 'c', 'nonExisting'])).toStrictEqual({
43
+ d: 'value d',
44
+ e: 'value e',
45
+ });
46
+ });
47
+
48
+ it('returns full object if no keys are passed', () => {
49
+ expect(omitObjectProps(testObject, [])).toStrictEqual(testObject);
50
+ });
51
+
52
+ it('returns an empty object if empty target obj passed', () => {
53
+ expect(omitObjectProps({}, ['d', 'e'])).toStrictEqual({});
54
+ });
55
+ });
56
+ });
@@ -1,4 +1,4 @@
1
- import * as yaml from 'js-yaml';
1
+ import { parseYaml } from '../js-yaml';
2
2
  import { Document, Source } from '../resolve';
3
3
  import { Oas3RuleSet } from '../oas-types';
4
4
  import { RuleConfig, LintConfig, Plugin } from '../config/config';
@@ -6,7 +6,7 @@ import { RuleConfig, LintConfig, Plugin } from '../config/config';
6
6
  export function parseYamlToDocument(body: string, absoluteRef: string = ''): Document {
7
7
  return {
8
8
  source: new Source(absoluteRef, body),
9
- parsed: yaml.safeLoad(body, { filename: absoluteRef }),
9
+ parsed: parseYaml(body, { filename: absoluteRef }),
10
10
  };
11
11
  }
12
12
 
@@ -1,9 +1,9 @@
1
1
  import * as fs from 'fs';
2
2
  import * as path from 'path';
3
- import * as yaml from 'js-yaml';
4
3
  import { dirname } from 'path';
5
4
  import { red, blue } from 'colorette';
6
5
 
6
+ import { parseYaml, stringifyYaml } from '../js-yaml';
7
7
  import { notUndefined } from '../utils';
8
8
 
9
9
  import {
@@ -190,7 +190,7 @@ export class LintConfig {
190
190
  if (fs.hasOwnProperty('existsSync') && fs.existsSync(ignoreFile)) {
191
191
  // TODO: parse errors
192
192
  this.ignore =
193
- (yaml.safeLoad(fs.readFileSync(ignoreFile, 'utf-8')) as Record<
193
+ (parseYaml(fs.readFileSync(ignoreFile, 'utf-8')) as Record<
194
194
  string,
195
195
  Record<string, Set<string>>
196
196
  >) || {};
@@ -216,7 +216,7 @@ export class LintConfig {
216
216
  ignoredRules[ruleId] = Array.from(ignoredRules[ruleId]) as any;
217
217
  }
218
218
  }
219
- fs.writeFileSync(ignoreFile, IGNORE_BANNER + yaml.safeDump(mapped));
219
+ fs.writeFileSync(ignoreFile, IGNORE_BANNER + stringifyYaml(mapped));
220
220
  }
221
221
 
222
222
  addIgnore(problem: NormalizedProblem) {
@@ -384,6 +384,7 @@ export class Config {
384
384
  apiDefinitions: Record<string, string>;
385
385
  lint: LintConfig;
386
386
  resolve: ResolveConfig;
387
+ licenseKey?: string;
387
388
  constructor(public rawConfig: RawConfig, public configFile?: string) {
388
389
  this.apiDefinitions = rawConfig.apiDefinitions || {};
389
390
  this.lint = new LintConfig(rawConfig.lint || {}, configFile);
package/src/index.ts CHANGED
@@ -29,9 +29,11 @@ export {
29
29
  YamlParseError,
30
30
  makeDocumentFromString,
31
31
  } from './resolve';
32
+ export { parseYaml, stringifyYaml } from './js-yaml';
32
33
  export { unescapePointer } from './ref-utils';
33
34
  export { detectOpenAPI, OasMajorVersion, openAPIMajor, OasVersion } from './oas-types';
34
35
  export { normalizeVisitors } from './visitors';
36
+
35
37
  export {
36
38
  WalkContext,
37
39
  walkDocument,