@redocly/openapi-core 1.0.2 → 1.1.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/package.json

@@ -1,10 +1,10 @@
 {
   "name": "@redocly/openapi-core",
-  "version": "1.0.2",
+  "version": "1.1.0",
   "description": "",
   "main": "lib/index.js",
   "engines": {
-    "node": ">=12.0.0"
+    "node": ">=14.0.0"
   },
   "engineStrict": true,
   "license": "MIT",

package/src/__tests__/lint.test.ts

@@ -111,6 +111,7 @@ describe('lint', () => {
           "severity": "error",
           "suggest": Array [
             "theme",
+            "env",
             "seo",
             "sso",
           ],
@@ -178,6 +179,7 @@ describe('lint', () => {
             "apis",
             "seo",
             "sso",
+            "env",
           ],
         },
       ]

package/src/rules/common/__tests__/no-path-trailing-slash.test.ts

@@ -41,6 +41,47 @@ describe('no-path-trailing-slash', () => {
     `);
   });
 
+  it('should report on trailing slash in path on key when referencing', async () => {
+    const document = parseYamlToDocument(
+      outdent`
+        openapi: 3.0.0
+        paths:
+          '/bad/':
+            $ref: '#/components/pathItems/MyItem'
+        components:
+          pathItems:
+            MyItem:
+              get:
+                summary: List all pets
+        `,
+      'foobar.yaml'
+    );
+
+    const results = await lintDocument({
+      externalRefResolver: new BaseResolver(),
+      document,
+      config: await makeConfig({ 'no-path-trailing-slash': 'error' }),
+    });
+
+    expect(replaceSourceWithRef(results)).toMatchInlineSnapshot(`
+      Array [
+        Object {
+          "location": Array [
+            Object {
+              "pointer": "#/paths/~1bad~1",
+              "reportOnKey": true,
+              "source": "foobar.yaml",
+            },
+          ],
+          "message": "\`/bad/\` should not have a trailing slash.",
+          "ruleId": "no-path-trailing-slash",
+          "severity": "error",
+          "suggest": Array [],
+        },
+      ]
+    `);
+  });
+
   it('should not report on if no trailing slash in path', async () => {
     const document = parseYamlToDocument(
       outdent`

package/src/rules/common/__tests__/tags-alphabetical.test.ts

@@ -61,4 +61,62 @@ describe('Oas3 tags-alphabetical', () => {
 
     expect(replaceSourceWithRef(results)).toMatchInlineSnapshot(`Array []`);
   });
+
+  it('should report on tags object if not sorted alphabetically not ignoring case', async () => {
+    const document = parseYamlToDocument(
+      outdent`
+          openapi: 3.0.0
+          paths: {}
+          tags:
+            - name: a
+            - name: B
+        `,
+      'foobar.yaml'
+    );
+
+    const results = await lintDocument({
+      externalRefResolver: new BaseResolver(),
+      document,
+      config: await makeConfig({ 'tags-alphabetical': 'error' }),
+    });
+
+    expect(replaceSourceWithRef(results)).toMatchInlineSnapshot(`
+      Array [
+        Object {
+          "location": Array [
+            Object {
+              "pointer": "#/tags/0",
+              "reportOnKey": false,
+              "source": "foobar.yaml",
+            },
+          ],
+          "message": "The \`tags\` array should be in alphabetical order.",
+          "ruleId": "tags-alphabetical",
+          "severity": "error",
+          "suggest": Array [],
+        },
+      ]
+    `);
+  });
+
+  it('should not report on tags object if sorted alphabetically ignoring case', async () => {
+    const document = parseYamlToDocument(
+      outdent`
+      openapi: 3.0.0
+      paths: {}
+      tags:
+        - name: a
+        - name: B
+        `,
+      'foobar.yaml'
+    );
+
+    const results = await lintDocument({
+      externalRefResolver: new BaseResolver(),
+      document,
+      config: await makeConfig({ 'tags-alphabetical': { severity: 'error', ignoreCase: true } }),
+    });
+
+    expect(replaceSourceWithRef(results)).toMatchInlineSnapshot(`Array []`);
+  });
 });

package/src/rules/common/no-path-trailing-slash.ts

@@ -3,11 +3,11 @@ import { UserContext } from '../../walk';
 
 export const NoPathTrailingSlash: Oas3Rule | Oas2Rule = () => {
   return {
-    PathItem(_path: any, { report, key, location }: UserContext) {
+    PathItem(_path: any, { report, key, rawLocation }: UserContext) {
       if ((key as string).endsWith('/') && key !== '/') {
         report({
           message: `\`${key}\` should not have a trailing slash.`,
-          location: location.key(),
+          location: rawLocation.key(),
         });
       }
     },

package/src/rules/common/tags-alphabetical.ts

@@ -1,14 +1,14 @@
 import { Oas3Rule, Oas2Rule } from '../../visitors';
-import { Oas2Definition } from '../../typings/swagger';
-import { Oas3Definition } from '../../typings/openapi';
+import { Oas2Definition, Oas2Tag } from '../../typings/swagger';
+import { Oas3Definition, Oas3Tag } from '../../typings/openapi';
 import { UserContext } from '../../walk';
 
-export const TagsAlphabetical: Oas3Rule | Oas2Rule = () => {
+export const TagsAlphabetical: Oas3Rule | Oas2Rule = ({ ignoreCase = false }) => {
   return {
     Root(root: Oas2Definition | Oas3Definition, { report, location }: UserContext) {
       if (!root.tags) return;
       for (let i = 0; i < root.tags.length - 1; i++) {
-        if (root.tags[i].name > root.tags[i + 1].name) {
+        if (getTagName(root.tags[i], ignoreCase) > getTagName(root.tags[i + 1], ignoreCase)) {
           report({
             message: 'The `tags` array should be in alphabetical order.',
             location: location.child(['tags', i]),
@@ -18,3 +18,7 @@ export const TagsAlphabetical: Oas3Rule | Oas2Rule = () => {
     },
   };
 };
+
+function getTagName(tag: Oas2Tag | Oas3Tag, ignoreCase: boolean): string {
+  return ignoreCase ? tag.name.toLowerCase() : tag.name;
+}