@redocly/openapi-core 1.0.2 → 1.2.0

package/lib/types/{config-external-schemas.js → theme-config.js}

@@ -1,242 +1,11 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.productThemeOverrideSchema = exports.themeConfigSchema = exports.mockServerConfigSchema = exports.i18nConfigSchema = exports.responseHeaderSchema = exports.devOnboardingConfigSchema = exports.seoConfigSchema = exports.redirectConfigSchema = exports.ssoConfigSchema = exports.rbacConfigSchema = void 0;
-const config_1 = require("../config");
-const oidcIssuerMetadataSchema = {
-    type: 'object',
-    properties: {
-        end_session_endpoint: { type: 'string' },
-        token_endpoint: { type: 'string' },
-        authorization_endpoint: { type: 'string' },
-    },
-    required: ['token_endpoint', 'authorization_endpoint'],
-    additionalProperties: true,
-};
-const oidcProviderConfigSchema = {
-    type: 'object',
-    properties: {
-        type: { type: 'string', const: config_1.AuthProviderType.OIDC },
-        title: { type: 'string' },
-        configurationUrl: { type: 'string', minLength: 1 },
-        configuration: oidcIssuerMetadataSchema,
-        clientId: { type: 'string', minLength: 1 },
-        clientSecret: { type: 'string', minLength: 1 },
-        teamsClaimName: { type: 'string' },
-        defaultTeams: { type: 'array', items: { type: 'string' } },
-        scopes: { type: 'array', items: { type: 'string' } },
-        tokenExpirationTime: { type: 'number' },
-        authorizationRequestCustomParams: { type: 'object', additionalProperties: { type: 'string' } },
-        tokenRequestCustomParams: { type: 'object', additionalProperties: { type: 'string' } },
-    },
-    required: ['type', 'clientId', 'clientSecret'],
-    oneOf: [{ required: ['configurationUrl'] }, { required: ['configuration'] }],
-    additionalProperties: false,
-};
-const saml2ProviderConfigSchema = {
-    type: 'object',
-    properties: {
-        type: { type: 'string', const: config_1.AuthProviderType.SAML2 },
-        title: { type: 'string' },
-        issuerId: { type: 'string' },
-        entityId: { type: 'string' },
-        ssoUrl: { type: 'string' },
-        x509PublicCert: { type: 'string' },
-        teamsAttributeName: { type: 'string', default: config_1.DEFAULT_TEAM_CLAIM_NAME },
-        teamsAttributeMap: { type: 'object', additionalProperties: { type: 'string' } },
-        defaultTeams: { type: 'array', items: { type: 'string' } },
-    },
-    additionalProperties: false,
-    required: ['type', 'issuerId', 'ssoUrl', 'x509PublicCert'],
-};
-const basicAuthProviderConfigSchema = {
-    type: 'object',
-    properties: {
-        type: { type: 'string', const: config_1.AuthProviderType.BASIC },
-        title: { type: 'string' },
-        credentials: {
-            type: 'array',
-            items: {
-                type: 'object',
-                properties: {
-                    username: { type: 'string' },
-                    password: { type: 'string' },
-                    passwordHash: { type: 'string' },
-                    teams: { type: 'array', items: { type: 'string' } },
-                },
-                required: ['username'],
-                additionalProperties: false,
-            },
-        },
-    },
-    required: ['type', 'credentials'],
-    additionalProperties: false,
-};
-const authProviderConfigSchema = {
-    oneOf: [oidcProviderConfigSchema, saml2ProviderConfigSchema, basicAuthProviderConfigSchema],
-    discriminator: { propertyName: 'type' },
-};
-const rbacScopeItemsSchema = { type: 'object', additionalProperties: { type: 'string' } };
-exports.rbacConfigSchema = {
-    type: 'object',
-    properties: {
-        defaults: rbacScopeItemsSchema,
-    },
-    additionalProperties: rbacScopeItemsSchema,
-};
-exports.ssoConfigSchema = {
-    type: 'object',
-    additionalProperties: authProviderConfigSchema,
-};
-exports.redirectConfigSchema = {
-    type: 'object',
-    properties: {
-        to: { type: 'string' },
-        type: { type: 'number', default: 301 },
-    },
-    required: ['to'],
-    additionalProperties: false,
-};
-exports.seoConfigSchema = {
-    type: 'object',
-    properties: {
-        title: { type: 'string' },
-        description: { type: 'string' },
-        siteUrl: { type: 'string' },
-        image: { type: 'string' },
-        keywords: { type: 'array', items: { type: 'string' } },
-        lang: { type: 'string' },
-        jsonLd: { type: 'object' },
-        meta: {
-            type: 'array',
-            items: {
-                type: 'object',
-                properties: {
-                    name: { type: 'string' },
-                    content: { type: 'string' },
-                },
-                required: ['name', 'content'],
-                additionalProperties: false,
-            },
-        },
-    },
-    additionalProperties: false,
-};
-const apigeeAdapterAuthOauth2Schema = {
-    type: 'object',
-    properties: {
-        type: { type: 'string', const: config_1.ApigeeDevOnboardingIntegrationAuthType.OAUTH2 },
-        tokenEndpoint: { type: 'string' },
-        clientId: { type: 'string' },
-        clientSecret: { type: 'string' },
-    },
-    additionalProperties: false,
-    required: ['type', 'tokenEndpoint', 'clientId', 'clientSecret'],
-};
-const apigeeAdapterAuthServiceAccountSchema = {
-    type: 'object',
-    properties: {
-        type: { type: 'string', const: config_1.ApigeeDevOnboardingIntegrationAuthType.SERVICE_ACCOUNT },
-        serviceAccountEmail: { type: 'string' },
-        serviceAccountPrivateKey: { type: 'string' },
-    },
-    additionalProperties: false,
-    required: ['type', 'serviceAccountEmail', 'serviceAccountPrivateKey'],
-};
-const apigeeXAdapterConfigSchema = {
-    type: 'object',
-    properties: {
-        type: { type: 'string', const: 'APIGEE_X' },
-        apiUrl: { type: 'string' },
-        stage: { type: 'string', default: 'non-production' },
-        organizationName: { type: 'string' },
-        ignoreApiProducts: { type: 'array', items: { type: 'string' } },
-        allowApiProductsOutsideCatalog: { type: 'boolean', default: false },
-        auth: {
-            type: 'object',
-            oneOf: [apigeeAdapterAuthOauth2Schema, apigeeAdapterAuthServiceAccountSchema],
-            discriminator: { propertyName: 'type' },
-        },
-    },
-    additionalProperties: false,
-    required: ['type', 'organizationName', 'auth'],
-};
-const apigeeEdgeAdapterConfigSchema = Object.assign(Object.assign({}, apigeeXAdapterConfigSchema), { properties: Object.assign(Object.assign({}, apigeeXAdapterConfigSchema.properties), { type: { type: 'string', const: 'APIGEE_EDGE' } }) });
-const graviteeAdapterConfigSchema = {
-    type: 'object',
-    properties: {
-        type: { type: 'string', const: 'GRAVITEE' },
-        apiBaseUrl: { type: 'string' },
-        env: { type: 'string' },
-        allowApiProductsOutsideCatalog: { type: 'boolean', default: false },
-        stage: { type: 'string', default: 'non-production' },
-        auth: { type: 'object', properties: { static: { type: 'string' } } },
-    },
-    additionalProperties: false,
-    required: ['type', 'apiBaseUrl'],
-};
-const devOnboardingAdapterConfigSchema = {
-    type: 'object',
-    oneOf: [apigeeXAdapterConfigSchema, apigeeEdgeAdapterConfigSchema, graviteeAdapterConfigSchema],
-    discriminator: { propertyName: 'type' },
-};
-exports.devOnboardingConfigSchema = {
-    type: 'object',
-    required: ['adapters'],
-    additionalProperties: false,
-    properties: {
-        adapters: {
-            type: 'array',
-            items: devOnboardingAdapterConfigSchema,
-        },
-    },
-};
-exports.responseHeaderSchema = {
-    type: 'object',
-    properties: {
-        name: { type: 'string' },
-        value: { type: 'string' },
-    },
-    additionalProperties: false,
-    required: ['name', 'value'],
-};
-exports.i18nConfigSchema = {
-    type: 'object',
-    properties: {
-        defaultLocale: {
-            type: 'string',
-        },
-        locales: {
-            type: 'array',
-            items: {
-                type: 'object',
-                properties: {
-                    code: {
-                        type: 'string',
-                    },
-                    name: {
-                        type: 'string',
-                    },
-                },
-                required: ['code'],
-            },
-        },
-    },
-    required: ['defaultLocale', 'locales'],
-};
-exports.mockServerConfigSchema = {
-    type: 'object',
-    properties: {
-        off: { type: 'boolean', default: false },
-        position: { type: 'string', enum: ['first', 'last', 'replace', 'off'], default: 'first' },
-        strictExamples: { type: 'boolean', default: false },
-        errorIfForcedExampleNotFound: { type: 'boolean', default: false },
-        description: { type: 'string' },
-    },
-};
+exports.ScorecardStatus = exports.productThemeOverrideSchema = exports.themeConfigSchema = void 0;
 const logoConfigSchema = {
     type: 'object',
     properties: {
         image: { type: 'string' },
+        srcSet: { type: 'string' },
         altText: { type: 'string' },
         link: { type: 'string' },
         favicon: { type: 'string' },
@@ -316,7 +85,7 @@ const markdownConfigSchema = {
         },
         editPage: {
             type: 'object',
-            properties: Object.assign({ baseUrl: { type: 'string' }, icon: { type: 'string' }, text: { type: 'string', default: 'Edit this page' } }, hideConfigSchema.properties),
+            properties: Object.assign({ baseUrl: { type: 'string' } }, hideConfigSchema.properties),
             additionalProperties: false,
             default: {},
         },
@@ -404,35 +173,14 @@ const googleAnalyticsConfigSchema = {
     properties: {
         includeInDevelopment: { type: 'boolean' },
         trackingId: { type: 'string' },
+        conversionId: { type: 'string' },
+        floodlightId: { type: 'string' },
         head: { type: 'boolean' },
         respectDNT: { type: 'boolean' },
-        anonymize: { type: 'boolean' },
         exclude: { type: 'array', items: { type: 'string' } },
         optimizeId: { type: 'string' },
-        experimentId: { type: 'string' },
-        variationId: { type: 'string' },
-        enableWebVitalsTracking: { type: 'boolean' },
-        defer: { type: 'boolean' },
-        sampleRate: { type: 'number' },
-        name: { type: 'string' },
-        clientId: { type: 'string' },
-        siteSpeedSampleRate: { type: 'number' },
-        alwaysSendReferrer: { type: 'boolean' },
-        allowAnchor: { type: 'boolean' },
-        cookieName: { type: 'string' },
-        cookieFlags: { type: 'string' },
-        cookieDomain: { type: 'string' },
+        anonymizeIp: { type: 'boolean' },
         cookieExpires: { type: 'number' },
-        storeGac: { type: 'boolean' },
-        legacyCookieDomain: { type: 'string' },
-        legacyHistoryImport: { type: 'boolean' },
-        allowLinker: { type: 'boolean' },
-        storage: { type: 'string' },
-        allowAdFeatures: { type: 'boolean' },
-        dataSource: { type: 'string' },
-        queueTime: { type: 'number' },
-        forceSSL: { type: 'boolean' },
-        transport: { type: 'string' },
     },
     additionalProperties: false,
     required: ['trackingId'],
@@ -456,6 +204,11 @@ const navItemSchema = {
         label: { type: 'string' },
         separator: { type: 'string' },
         separatorLine: { type: 'boolean' },
+        linePosition: {
+            type: 'string',
+            enum: ['top', 'bottom'],
+            default: 'top',
+        },
         version: { type: 'string' },
         menuStyle: { type: 'string', enum: ['drilldown'] },
         expanded: { type: 'string', const: 'always' },
@@ -511,6 +264,14 @@ const scorecardConfigSchema = {
     required: ['levels'],
     properties: {
         failBuildIfBelowMinimum: { type: 'boolean', default: false },
+        teamMetadataProperty: {
+            type: 'object',
+            properties: {
+                property: { type: 'string' },
+                label: { type: 'string' },
+                default: { type: 'string' },
+            },
+        },
         levels: {
             type: 'array',
             items: {
@@ -553,11 +314,15 @@ const scorecardConfigSchema = {
 const catalogSchema = {
     type: 'object',
     additionalProperties: true,
-    required: ['slug', 'filters', 'groupByFirstFilter', 'items'],
+    required: ['slug', 'items'],
     properties: {
         slug: { type: 'string' },
         filters: { type: 'array', items: catalogFilterSchema },
         groupByFirstFilter: { type: 'boolean' },
+        filterValuesCasing: {
+            type: 'string',
+            enum: ['sentence', 'original', 'lowercase', 'uppercase'],
+        },
         items: navItemsSchema,
         requiredPermission: { type: 'string' },
         separateVersions: { type: 'boolean' },
@@ -593,10 +358,24 @@ exports.themeConfigSchema = {
         },
         footer: {
             type: 'object',
-            properties: Object.assign({ items: navItemsSchema, copyrightText: { type: 'string' } }, hideConfigSchema.properties),
+            properties: Object.assign({ items: navItemsSchema, copyrightText: { type: 'string' }, logo: hideConfigSchema }, hideConfigSchema.properties),
             additionalProperties: false,
         },
-        sidebar: hideConfigSchema,
+        sidebar: {
+            type: 'object',
+            properties: Object.assign({ separatorLine: { type: 'boolean' }, linePosition: {
+                    type: 'string',
+                    enum: ['top', 'bottom'],
+                    default: 'bottom',
+                } }, hideConfigSchema.properties),
+            additionalProperties: false,
+        },
+        seo: {
+            type: 'object',
+            properties: {
+                title: { type: 'string' },
+            },
+        },
         scripts: {
             type: 'object',
             properties: {
@@ -762,6 +541,15 @@ exports.themeConfigSchema = {
             additionalProperties: false,
             default: {},
         },
+        versionPicker: {
+            type: 'object',
+            properties: {
+                hide: { type: 'boolean' },
+                showForUnversioned: {
+                    type: 'boolean',
+                },
+            },
+        },
         breadcrumbs: {
             type: 'object',
             properties: {
@@ -803,3 +591,9 @@ exports.productThemeOverrideSchema = {
     additionalProperties: true,
     default: {},
 };
+var ScorecardStatus;
+(function (ScorecardStatus) {
+    ScorecardStatus["BelowMinimum"] = "Below minimum";
+    ScorecardStatus["Highest"] = "Highest";
+    ScorecardStatus["Minimum"] = "Minimum";
+})(ScorecardStatus = exports.ScorecardStatus || (exports.ScorecardStatus = {}));

package/lib/typings/asyncapi.d.ts

@@ -0,0 +1,21 @@
+export interface Async2Definition {
+    asyncapi: string;
+    info?: Async2Info;
+}
+export interface Async2Info {
+    title: string;
+    version: string;
+    description?: string;
+    termsOfService?: string;
+    contact?: Async2Contact;
+    license?: Async2License;
+}
+export interface Async2Contact {
+    name?: string;
+    url?: string;
+    email?: string;
+}
+export interface Async2License {
+    name: string;
+    url?: string;
+}

package/lib/typings/asyncapi.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/lib/visitors.d.ts

@@ -4,6 +4,7 @@ import { NormalizedNodeType } from './types';
 import type { Stack } from './utils';
 import type { UserContext, ResolveResult, ProblemSeverity } from './walk';
 import type { Location } from './ref-utils';
+import { Async2Definition } from './typings/asyncapi';
 export declare type SkipFunctionContext = Pick<UserContext, 'location' | 'rawNode' | 'resolve' | 'rawLocation'>;
 export declare type VisitFunction<T> = (node: T, ctx: UserContext & {
     ignoreNextVisitorsOnNode: () => void;
@@ -134,16 +135,24 @@ declare type Oas2FlatVisitor = {
     SecurityScheme?: VisitFunctionOrObject<Oas2SecurityScheme>;
     SpecExtension?: VisitFunctionOrObject<unknown>;
 };
+declare type Async2FlatVisitor = {
+    Root?: VisitFunctionOrObject<Async2Definition>;
+};
 declare type Oas3NestedVisitor = {
     [T in keyof Oas3FlatVisitor]: Oas3FlatVisitor[T] extends Function ? Oas3FlatVisitor[T] : Oas3FlatVisitor[T] & NestedVisitor<Oas3NestedVisitor>;
 };
 declare type Oas2NestedVisitor = {
     [T in keyof Oas2FlatVisitor]: Oas2FlatVisitor[T] extends Function ? Oas2FlatVisitor[T] : Oas2FlatVisitor[T] & NestedVisitor<Oas2NestedVisitor>;
 };
+declare type Async2NestedVisitor = {
+    [T in keyof Async2FlatVisitor]: Async2FlatVisitor[T] extends Function ? Async2FlatVisitor[T] : Async2FlatVisitor[T] & NestedVisitor<Async2NestedVisitor>;
+};
 export declare type Oas3Visitor = BaseVisitor & Oas3NestedVisitor & Record<string, VisitFunction<any> | NestedVisitObject<any, Oas3NestedVisitor>>;
 export declare type Oas2Visitor = BaseVisitor & Oas2NestedVisitor & Record<string, VisitFunction<any> | NestedVisitObject<any, Oas2NestedVisitor>>;
+export declare type Async2Visitor = BaseVisitor & Async2NestedVisitor & Record<string, VisitFunction<any> | NestedVisitObject<any, Async2NestedVisitor>>;
 export declare type Oas3TransformVisitor = BaseVisitor & Oas3FlatVisitor & Record<string, VisitFunction<any> | VisitObject<any>>;
 export declare type Oas2TransformVisitor = BaseVisitor & Oas2FlatVisitor & Record<string, VisitFunction<any> | VisitObject<any>>;
+export declare type Async2TransformVisitor = BaseVisitor & Async2FlatVisitor & Record<string, VisitFunction<any> | VisitObject<any>>;
 export declare type NestedVisitor<T> = Exclude<T, 'any' | 'ref' | 'Root'>;
 export declare type NormalizedOasVisitors<T extends BaseVisitor> = {
     [V in keyof T]-?: {
@@ -162,10 +171,13 @@ export declare type NormalizedOasVisitors<T extends BaseVisitor> = {
 };
 export declare type Oas3Rule = (options: Record<string, any>) => Oas3Visitor | Oas3Visitor[];
 export declare type Oas2Rule = (options: Record<string, any>) => Oas2Visitor | Oas2Visitor[];
+export declare type Async2Rule = (options: Record<string, any>) => Async2Visitor | Async2Visitor[];
 export declare type Oas3Preprocessor = (options: Record<string, any>) => Oas3TransformVisitor;
 export declare type Oas2Preprocessor = (options: Record<string, any>) => Oas2TransformVisitor;
+export declare type Async2Preprocessor = (options: Record<string, any>) => Async2TransformVisitor;
 export declare type Oas3Decorator = (options: Record<string, any>) => Oas3TransformVisitor;
 export declare type Oas2Decorator = (options: Record<string, any>) => Oas2TransformVisitor;
+export declare type Async2Decorator = (options: Record<string, any>) => Async2TransformVisitor;
 export declare type OasRule = Oas3Rule;
 export declare type OasPreprocessor = Oas3Preprocessor;
 export declare type OasDecorator = Oas3Decorator;

package/lib/walk.d.ts

@@ -5,7 +5,7 @@ import type { NormalizedNodeType } from './types';
 import type { RuleSeverity } from './config';
 import { Location } from './ref-utils';
 import { ResolveError, YamlParseError, Source } from './resolve';
-import { OasVersion } from './oas-types';
+import { SpecVersion } from './oas-types';
 declare type NonUndefined = string | number | boolean | symbol | bigint | object | Record<string, any>;
 export declare type ResolveResult<T extends NonUndefined> = {
     node: T;
@@ -27,7 +27,7 @@ export declare type UserContext = {
     type: NormalizedNodeType;
     key: string | number;
     parent: any;
-    oasVersion: OasVersion;
+    oasVersion: SpecVersion;
     getVisitorData: () => Record<string, unknown>;
 };
 export declare type Loc = {
@@ -65,7 +65,7 @@ export declare type NormalizedProblem = {
 };
 export declare type WalkContext = {
     problems: NormalizedProblem[];
-    oasVersion: OasVersion;
+    oasVersion: SpecVersion;
     visitorsData: Record<string, Record<string, unknown>>;
     refTypes?: Map<string, NormalizedNodeType>;
 };

package/package.json

@@ -1,10 +1,10 @@
 {
   "name": "@redocly/openapi-core",
-  "version": "1.0.2",
+  "version": "1.2.0",
   "description": "",
   "main": "lib/index.js",
   "engines": {
-    "node": ">=12.0.0"
+    "node": ">=14.0.0"
   },
   "engineStrict": true,
   "license": "MIT",
@@ -26,6 +26,7 @@
     "Swagger",
     "OpenAPI linter",
     "Swagger linter",
+    "AsyncAPI linter",
     "oas"
   ],
   "contributors": [

package/src/__tests__/lint.test.ts

@@ -5,7 +5,7 @@ import { lintFromString, lintConfig, lintDocument } from '../lint';
 import { BaseResolver } from '../resolve';
 import { loadConfig } from '../config/load';
 import { parseYamlToDocument, replaceSourceWithRef, makeConfig } from '../../__tests__/utils';
-import { detectOpenAPI } from '../oas-types';
+import { detectSpec } from '../oas-types';
 
 describe('lint', () => {
   it('lintFromString should work', async () => {
@@ -61,12 +61,12 @@ describe('lint', () => {
           path-http-verbs-order: error
           boolean-parameter-prefixes: off
           rule/operation-summary-length:
-            subject: 
+            subject:
               type: Operation
               property: summary
             message: Operation summary should start with an active verb
             assertions:
-              local/checkWordsCount: 
+              local/checkWordsCount:
                 min: 3
       theme:
         openapi:
@@ -111,6 +111,7 @@ describe('lint', () => {
           "severity": "error",
           "suggest": Array [
             "theme",
+            "env",
             "seo",
             "sso",
           ],
@@ -178,6 +179,7 @@ describe('lint', () => {
             "apis",
             "seo",
             "sso",
+            "env",
           ],
         },
       ]
@@ -187,8 +189,8 @@ describe('lint', () => {
   it('lintConfig should work with legacy fields - referenceDocs', async () => {
     const document = parseYamlToDocument(
       outdent`
-        apis: 
-          entry: 
+        apis:
+          entry:
             root: ./file.yaml
         rules:
           operation-2xx-response: warn
@@ -302,11 +304,41 @@ describe('lint', () => {
       `,
       ''
     );
-    expect(() => detectOpenAPI(testDocument.parsed)).toThrow(
+    expect(() => detectSpec(testDocument.parsed)).toThrow(
       `Invalid OpenAPI version: should be a string but got "number"`
     );
   });
 
+  it('detect unsupported OpenAPI version', () => {
+    const testDocument = parseYamlToDocument(
+      outdent`
+        openapi: 1.0.4
+      `,
+      ''
+    );
+    expect(() => detectSpec(testDocument.parsed)).toThrow(`Unsupported OpenAPI version: 1.0.4`);
+  });
+
+  it('detect unsupported AsyncAPI version', () => {
+    const testDocument = parseYamlToDocument(
+      outdent`
+        asyncapi: 1.0.4
+      `,
+      ''
+    );
+    expect(() => detectSpec(testDocument.parsed)).toThrow(`Unsupported AsyncAPI version: 1.0.4`);
+  });
+
+  it('detect unsupported spec format', () => {
+    const testDocument = parseYamlToDocument(
+      outdent`
+        notapi: 3.1.0
+      `,
+      ''
+    );
+    expect(() => detectSpec(testDocument.parsed)).toThrow(`Unsupported specification`);
+  });
+
   it("spec rule shouldn't throw an error for named callback", async () => {
     const document = parseYamlToDocument(
       outdent`