@redocly/openapi-core 1.0.0-beta.79 → 1.0.0-beta.83

package/lib/types/oas3.js

@@ -28,23 +28,15 @@ const Tag = {
 };
 const ExternalDocs = {
     properties: {
-        description: {
-            type: 'string',
-        },
-        url: {
-            type: 'string',
-        },
+        description: { type: 'string' },
+        url: { type: 'string' },
     },
     required: ['url'],
 };
 const Server = {
     properties: {
-        url: {
-            type: 'string',
-        },
-        description: {
-            type: 'string',
-        },
+        url: { type: 'string' },
+        description: { type: 'string' },
         variables: _1.mapOf('ServerVariable'),
     },
     required: ['url'],
@@ -55,9 +47,7 @@ const ServerVariable = {
             type: 'array',
             items: { type: 'string' },
         },
-        default: {
-            type: 'string',
-        },
+        default: { type: 'string' },
         description: null,
     },
     required: ['default'],
@@ -68,18 +58,10 @@ const SecurityRequirement = {
 };
 const Info = {
     properties: {
-        title: {
-            type: 'string',
-        },
-        version: {
-            type: 'string',
-        },
-        description: {
-            type: 'string',
-        },
-        termsOfService: {
-            type: 'string',
-        },
+        title: { type: 'string' },
+        version: { type: 'string' },
+        description: { type: 'string' },
+        termsOfService: { type: 'string' },
         contact: 'Contact',
         license: 'License',
     },
@@ -87,25 +69,15 @@ const Info = {
 };
 const Contact = {
     properties: {
-        name: {
-            type: 'string',
-        },
-        url: {
-            type: 'string',
-        },
-        email: {
-            type: 'string',
-        },
+        name: { type: 'string' },
+        url: { type: 'string' },
+        email: { type: 'string' },
     },
 };
 const License = {
     properties: {
-        name: {
-            type: 'string',
-        },
-        url: {
-            type: 'string',
-        },
+        name: { type: 'string' },
+        url: { type: 'string' },
     },
     required: ['name'],
 };
@@ -122,12 +94,8 @@ const PathItem = {
         $ref: { type: 'string' },
         servers: _1.listOf('Server'),
         parameters: _1.listOf('Parameter'),
-        summary: {
-            type: 'string',
-        },
-        description: {
-            type: 'string',
-        },
+        summary: { type: 'string' },
+        description: { type: 'string' },
         get: 'Operation',
         put: 'Operation',
         post: 'Operation',
@@ -140,33 +108,17 @@ const PathItem = {
 };
 const Parameter = {
     properties: {
-        name: {
-            type: 'string',
-        },
-        in: {
-            enum: ['query', 'header', 'path', 'cookie'],
-        },
-        description: {
-            type: 'string',
-        },
-        required: {
-            type: 'boolean',
-        },
-        deprecated: {
-            type: 'boolean',
-        },
-        allowEmptyValue: {
-            type: 'boolean',
-        },
+        name: { type: 'string' },
+        in: { enum: ['query', 'header', 'path', 'cookie'] },
+        description: { type: 'string' },
+        required: { type: 'boolean' },
+        deprecated: { type: 'boolean' },
+        allowEmptyValue: { type: 'boolean' },
         style: {
             enum: ['form', 'simple', 'label', 'matrix', 'spaceDelimited', 'pipeDelimited', 'deepObject'],
         },
-        explode: {
-            type: 'boolean',
-        },
-        allowReserved: {
-            type: 'boolean',
-        },
+        explode: { type: 'boolean' },
+        allowReserved: { type: 'boolean' },
         schema: 'Schema',
         example: { isExample: true },
         examples: _1.mapOf('Example'),
@@ -193,9 +145,7 @@ const Operation = {
         servers: _1.listOf('Server'),
         requestBody: 'RequestBody',
         responses: 'ResponsesMap',
-        deprecated: {
-            type: 'boolean',
-        },
+        deprecated: { type: 'boolean' },
         callbacks: _1.mapOf('Callback'),
         'x-codeSamples': _1.listOf('XCodeSample'),
         'x-code-samples': _1.listOf('XCodeSample'), // deprecated
@@ -211,12 +161,8 @@ const XCodeSample = {
 };
 const RequestBody = {
     properties: {
-        description: {
-            type: 'string',
-        },
-        required: {
-            type: 'boolean',
-        },
+        description: { type: 'string' },
+        required: { type: 'boolean' },
         content: 'MediaTypeMap',
     },
     required: ['content'],
@@ -236,57 +182,33 @@ const MediaType = {
 const Example = {
     properties: {
         value: { isExample: true },
-        summary: {
-            type: 'string',
-        },
-        description: {
-            type: 'string',
-        },
-        externalValue: {
-            type: 'string',
-        },
+        summary: { type: 'string' },
+        description: { type: 'string' },
+        externalValue: { type: 'string' },
     },
 };
 const Encoding = {
     properties: {
-        contentType: {
-            type: 'string',
-        },
+        contentType: { type: 'string' },
         headers: _1.mapOf('Header'),
         style: {
             enum: ['form', 'simple', 'label', 'matrix', 'spaceDelimited', 'pipeDelimited', 'deepObject'],
         },
-        explode: {
-            type: 'boolean',
-        },
-        allowReserved: {
-            type: 'boolean',
-        },
+        explode: { type: 'boolean' },
+        allowReserved: { type: 'boolean' },
     },
 };
 const Header = {
     properties: {
-        description: {
-            type: 'string',
-        },
-        required: {
-            type: 'boolean',
-        },
-        deprecated: {
-            type: 'boolean',
-        },
-        allowEmptyValue: {
-            type: 'boolean',
-        },
+        description: { type: 'string' },
+        required: { type: 'boolean' },
+        deprecated: { type: 'boolean' },
+        allowEmptyValue: { type: 'boolean' },
         style: {
             enum: ['form', 'simple', 'label', 'matrix', 'spaceDelimited', 'pipeDelimited', 'deepObject'],
         },
-        explode: {
-            type: 'boolean',
-        },
-        allowReserved: {
-            type: 'boolean',
-        },
+        explode: { type: 'boolean' },
+        allowReserved: { type: 'boolean' },
         schema: 'Schema',
         example: { isExample: true },
         examples: _1.mapOf('Example'),
@@ -294,16 +216,12 @@ const Header = {
     },
 };
 const ResponsesMap = {
-    properties: {
-        default: 'Response',
-    },
+    properties: { default: 'Response' },
     additionalProperties: (_v, key) => responseCodeRegexp.test(key) ? 'Response' : undefined,
 };
 const Response = {
     properties: {
-        description: {
-            type: 'string',
-        },
+        description: { type: 'string' },
         headers: _1.mapOf('Header'),
         content: 'MediaTypeMap',
         links: _1.mapOf('Link'),
@@ -425,7 +343,7 @@ const ImplicitFlow = {
         scopes: { type: 'object', additionalProperties: { type: 'string' } },
         authorizationUrl: { type: 'string' },
     },
-    required: ['authorizationUrl', 'scopes'],
+    required: ['authorizationUrl', 'scopes']
 };
 const PasswordFlow = {
     properties: {
@@ -465,30 +383,41 @@ const SecurityScheme = {
         type: { enum: ['apiKey', 'http', 'oauth2', 'openIdConnect'] },
         description: { type: 'string' },
         name: { type: 'string' },
-        in: { type: 'string' },
+        in: { type: 'string', enum: ['query', 'header', 'cookie'] },
         scheme: { type: 'string' },
         bearerFormat: { type: 'string' },
         flows: 'SecuritySchemeFlows',
         openIdConnectUrl: { type: 'string' },
     },
     required(value) {
-        if (!(value === null || value === void 0 ? void 0 : value.type)) {
-            return ['type'];
+        switch (value === null || value === void 0 ? void 0 : value.type) {
+            case 'apiKey':
+                return ['type', 'name', 'in'];
+            case 'http':
+                return ['type', 'scheme'];
+            case 'oauth2':
+                return ['type', 'flows'];
+            case 'openIdConnect':
+                return ['type', 'openIdConnectUrl'];
+            default:
+                return ['type'];
         }
-        if (value.type === 'apiKey') {
-            return ['type', 'name', 'in'];
-        }
-        else if (value.type === 'http') {
-            return ['type', 'scheme'];
-        }
-        else if (value.type === 'oauth2') {
-            return ['type', 'flows'];
-        }
-        else if (value.type === 'openIdConnect') {
-            return ['type', 'openIdConnectUrl'];
+    },
+    allowed(value) {
+        switch (value === null || value === void 0 ? void 0 : value.type) {
+            case 'apiKey':
+                return ['type', 'name', 'in', 'description'];
+            case 'http':
+                return ['type', 'scheme', 'bearerFormat', 'description'];
+            case 'oauth2':
+                return ['type', 'flows', 'description'];
+            case 'openIdConnect':
+                return ['type', 'openIdConnectUrl', 'description'];
+            default:
+                return ['type', 'description'];
         }
-        return ['type'];
     },
+    extensionsPrefix: 'x-',
 };
 exports.Oas3Types = {
     DefinitionRoot,

package/lib/types/oas3_1.js

@@ -21,35 +21,19 @@ const DefinitionRoot = {
 };
 const License = {
     properties: {
-        name: {
-            type: 'string',
-        },
-        url: {
-            type: 'string',
-        },
-        identifier: {
-            type: 'string',
-        },
+        name: { type: 'string' },
+        url: { type: 'string' },
+        identifier: { type: 'string' },
     },
     required: ['name'],
 };
 const Info = {
     properties: {
-        title: {
-            type: 'string',
-        },
-        version: {
-            type: 'string',
-        },
-        description: {
-            type: 'string',
-        },
-        termsOfService: {
-            type: 'string',
-        },
-        summary: {
-            type: 'string',
-        },
+        title: { type: 'string' },
+        version: { type: 'string' },
+        description: { type: 'string' },
+        termsOfService: { type: 'string' },
+        summary: { type: 'string' },
         contact: 'Contact',
         license: 'License',
     },
@@ -84,9 +68,7 @@ const Operation = {
         servers: _1.listOf('Server'),
         requestBody: 'RequestBody',
         responses: 'ResponsesMap',
-        deprecated: {
-            type: 'boolean',
-        },
+        deprecated: { type: 'boolean' },
         callbacks: _1.mapOf('Callback'),
         'x-codeSamples': _1.listOf('XCodeSample'),
         'x-code-samples': _1.listOf('XCodeSample'), // deprecated
@@ -137,7 +119,7 @@ const Schema = {
         then: 'Schema',
         else: 'Schema',
         dependentSchemas: _1.listOf('Schema'),
-        prefixItems: { type: 'array' },
+        prefixItems: _1.listOf('Schema'),
         contains: 'Schema',
         patternProperties: { type: 'object' },
         propertyNames: 'Schema',
@@ -149,18 +131,16 @@ const Schema = {
             if (Array.isArray(value)) {
                 return _1.listOf('Schema');
             }
-            else {
-                return 'Schema';
-            }
-        },
-        additionalProperties: (value) => {
-            if (typeof value === 'boolean') {
+            else if (typeof value === 'boolean') {
                 return { type: 'boolean' };
             }
             else {
                 return 'Schema';
             }
         },
+        additionalProperties: (value) => {
+            return typeof value === 'boolean' ? { type: 'boolean' } : 'Schema';
+        },
         description: { type: 'string' },
         format: { type: 'string' },
         contentEncoding: { type: 'string' },
@@ -181,30 +161,53 @@ const SecurityScheme = {
         type: { enum: ['apiKey', 'http', 'oauth2', 'openIdConnect', 'mutualTLS'] },
         description: { type: 'string' },
         name: { type: 'string' },
-        in: { type: 'string' },
+        in: { type: 'string', enum: ['query', 'header', 'cookie'] },
         scheme: { type: 'string' },
         bearerFormat: { type: 'string' },
         flows: 'SecuritySchemeFlows',
         openIdConnectUrl: { type: 'string' },
     },
     required(value) {
-        if (!(value === null || value === void 0 ? void 0 : value.type)) {
-            return ['type'];
-        }
-        if (value.type === 'apiKey') {
-            return ['type', 'name', 'in'];
+        switch (value === null || value === void 0 ? void 0 : value.type) {
+            case 'apiKey':
+                return ['type', 'name', 'in'];
+            case 'http':
+                return ['type', 'scheme'];
+            case 'oauth2':
+                return ['type', 'flows'];
+            case 'openIdConnect':
+                return ['type', 'openIdConnectUrl'];
+            default:
+                return ['type'];
         }
-        else if (value.type === 'http') {
-            return ['type', 'scheme'];
-        }
-        else if (value.type === 'oauth2') {
-            return ['type', 'flows'];
-        }
-        else if (value.type === 'openIdConnect') {
-            return ['type', 'openIdConnectUrl'];
+    },
+    allowed(value) {
+        switch (value === null || value === void 0 ? void 0 : value.type) {
+            case 'apiKey':
+                return ['type', 'name', 'in', 'description'];
+            case 'http':
+                return ['type', 'scheme', 'bearerFormat', 'description'];
+            case 'oauth2':
+                switch (value === null || value === void 0 ? void 0 : value.flows) {
+                    case 'implicit':
+                        return ['type', 'flows', 'authorizationUrl', 'refreshUrl', 'description', 'scopes'];
+                    case 'password':
+                    case 'clientCredentials':
+                        return ['type', 'flows', 'tokenUrl', 'refreshUrl', 'description', 'scopes'];
+                    case 'authorizationCode':
+                        return ['type', 'flows', 'authorizationUrl', 'refreshUrl', 'tokenUrl', 'description', 'scopes'];
+                    default:
+                        return ['type', 'flows', 'authorizationUrl', 'refreshUrl', 'tokenUrl', 'description', 'scopes'];
+                }
+            case 'openIdConnect':
+                return ['type', 'openIdConnectUrl', 'description'];
+            case 'mutualTLS':
+                return ['type', 'description'];
+            default:
+                return ['type', 'description'];
         }
-        return ['type'];
     },
+    extensionsPrefix: 'x-',
 };
 exports.Oas3_1Types = Object.assign(Object.assign({}, oas3_1.Oas3Types), { Info,
     DefinitionRoot,

package/lib/typings/openapi.d.ts

@@ -7,6 +7,7 @@ export interface Oas3Definition {
     security?: Oas3SecurityRequirement[];
     tags?: Oas3Tag[];
     externalDocs?: Oas3ExternalDocs;
+    'x-webhooks'?: Oas3_1Webhooks;
 }
 export interface Oas3Info {
     title: string;
@@ -147,6 +148,12 @@ export interface Oas3Schema {
 export interface Oas3_1Schema extends Oas3Schema {
     examples?: any[];
 }
+export interface Oas3_1Definition extends Oas3Definition {
+    webhooks?: Oas3_1Webhooks;
+}
+export interface Oas3_1Webhooks {
+    [webhook: string]: Referenced<Oas3PathItem>;
+}
 export interface Oas3Discriminator {
     propertyName: string;
     mapping?: {

package/lib/utils.js

@@ -138,7 +138,7 @@ function readFileAsStringSync(filePath) {
 }
 exports.readFileAsStringSync = readFileAsStringSync;
 function isPathParameter(pathSegment) {
-    return pathSegment.startsWith('{') && pathSegment.endsWith('{');
+    return pathSegment.startsWith('{') && pathSegment.endsWith('}');
 }
 exports.isPathParameter = isPathParameter;
 /**

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@redocly/openapi-core",
-  "version": "1.0.0-beta.79",
+  "version": "1.0.0-beta.83",
   "description": "",
   "main": "lib/index.js",
   "engines": {

package/src/__tests__/js-yaml.test.ts

@@ -1,3 +1,4 @@
+import { outdent } from 'outdent';
 import { parseYaml, stringifyYaml } from '../js-yaml';
 
 const yaml = `
@@ -7,7 +8,8 @@ const yaml = `
   number: 1000
   decimal: 12.34
   boolean: true
-  date: 2020-01-01
+  dateWithoutQuotes: 2020-01-01
+  dateWithQuotes: '2020-01-01'
   array:
     - 1
     - 2
@@ -16,6 +18,16 @@ const yaml = `
     key2: 2
 `;
 
+const yamlToDump = outdent`
+  date: '2022-01-21T11:29:56.694Z'
+  dateWithoutQuotes: 2020-01-01
+  dateWithQuotes: '2020-01-01'
+  dateImplicit: !!str 2020-01-01
+  string: test
+  stringWithQuotes: 'test'
+  stringWithDoubleQuotes: "test"
+`;
+
 const jsObject = {
   emptyValue: null,
   'spaces in keys': 'spaces in keys',
@@ -23,7 +35,8 @@ const jsObject = {
   number: 1000,
   decimal: 12.34,
   boolean: true,
-  date: '2020-01-01',
+  dateWithoutQuotes: '2020-01-01',
+  dateWithQuotes: '2020-01-01',
   array: [1, 2],
   object: { key1: 1, key2: 2 },
 };
@@ -33,14 +46,25 @@ describe('js-yaml', () => {
     expect(parseYaml(yaml)).toEqual(jsObject);
   });
 
+  test('should correctly dump date and string', () => {
+    expect(stringifyYaml(parseYaml(yamlToDump))).toMatchInlineSnapshot(
+    `
+    "date: '2022-01-21T11:29:56.694Z'
+    dateWithoutQuotes: '2020-01-01'
+    dateWithQuotes: '2020-01-01'
+    dateImplicit: '2020-01-01'
+    string: test
+    stringWithQuotes: test
+    stringWithDoubleQuotes: test
+    "
+    `);
+  });
+
   test('parse and stringify', () => {
     expect(parseYaml(stringifyYaml(jsObject))).toEqual(jsObject);
   });
 
   test('should throw an error for unsupported types', () => {
-    expect(() => stringifyYaml({ date: new Date() }))
-      .toThrow('unacceptable kind of an object to dump [object Date]');
-
     expect(() => stringifyYaml({ foo: () => {} }))
       .toThrow('unacceptable kind of an object to dump [object Function]');
   });

package/src/__tests__/lint.test.ts

@@ -3,9 +3,7 @@ import { outdent } from 'outdent';
 import { lintFromString, lintConfig, lintDocument } from '../lint';
 import { BaseResolver } from '../resolve';
 import { loadConfig } from '../config/load';
-import { parseYamlToDocument, replaceSourceWithRef } from '../../__tests__/utils';
-// todo create general utils for tests and move this config.
-import { makeConfig } from '../rules/__tests__/config';
+import { parseYamlToDocument, replaceSourceWithRef, makeConfig } from '../../__tests__/utils';
 
 describe('lint', () => {
   it('lintFromString should work', async () => {

package/src/config/builtIn.ts

@@ -1,9 +1,13 @@
 import recommended from './recommended';
 import all from './all';
 import minimal from './minimal';
-import { LintRawConfig, Plugin } from './config';
-
-import * as builtinRules from '../rules/builtin';
+import { CustomRulesConfig, LintRawConfig, Plugin } from './config';
+import { rules as oas3Rules } from '../rules/oas3';
+import { rules as oas2Rules } from '../rules/oas2';
+import { preprocessors as oas3Preprocessors } from '../rules/oas3';
+import { preprocessors as oas2Preprocessors } from '../rules/oas2';
+import { decorators as oas3Decorators } from '../decorators/oas3';
+import { decorators as oas2Decorators } from '../decorators/oas2';
 
 export const builtInConfigs: Record<string, LintRawConfig> = {
   recommended,
@@ -16,8 +20,17 @@ export const builtInConfigs: Record<string, LintRawConfig> = {
 
 export const defaultPlugin: Plugin = {
   id: '', // default plugin doesn't have id
-  rules: builtinRules.rules,
-  preprocessors: builtinRules.preprocessors,
-  decorators: builtinRules.decorators,
+  rules: {
+    oas3: oas3Rules,
+    oas2: oas2Rules,
+  } as CustomRulesConfig,
+  preprocessors: {
+    oas3: oas3Preprocessors,
+    oas2: oas2Preprocessors,
+  },
+  decorators: {
+    oas3: oas3Decorators,
+    oas2: oas2Decorators,
+  },
   configs: builtInConfigs,
-}
+}

package/src/{rules/__tests__/hide-internals.test.ts → decorators/__tests__/remove-x-internal.test.ts}

@@ -1,8 +1,7 @@
 import { outdent } from 'outdent';
 import { bundleDocument } from '../../bundle';
 import { BaseResolver } from '../../resolve';
-import { parseYamlToDocument, yamlSerializer } from '../../../__tests__/utils';
-import { makeConfig } from './config';
+import { parseYamlToDocument, yamlSerializer, makeConfig } from '../../../__tests__/utils';
 
 describe('oas3 remove-x-internal', () => {
   expect.addSnapshotSerializer(yamlSerializer);