@redocly/openapi-core 1.9.0 → 1.10.0

package/src/types/redocly-yaml.ts

@@ -1,8 +1,10 @@
-import { rootRedoclyConfigSchema, apiConfigSchema } from './portal-config-schema';
-import { themeConfigSchema } from './theme-config';
-import { NodeType, listOf } from '.';
+import { rootRedoclyConfigSchema } from './portal-config-schema';
+import { listOf } from '.';
 import { omitObjectProps, pickObjectProps, isCustomRuleId } from '../utils';
-import { PortalConfigNodeTypes } from './portal-config-schema';
+import { getNodeTypesFromJSONSchema } from './json-schema-adapter';
+
+import type { NodeType } from '.';
+import type { JSONSchema } from 'json-schema-to-ts';
 
 const builtInCommonRules = [
   'spec',
@@ -97,8 +99,49 @@ const builtInRules = [
 
 type BuiltInRuleId = typeof builtInRules[number];
 
-const nodeTypesList = [
-  'any',
+const oas2NodeTypesList = [
+  'Root',
+  'Tag',
+  'TagList',
+  'ExternalDocs',
+  'SecurityRequirement',
+  'SecurityRequirementList',
+  'Info',
+  'Contact',
+  'License',
+  'Paths',
+  'PathItem',
+  'Parameter',
+  'ParameterList',
+  'ParameterItems',
+  'Operation',
+  'Example',
+  'ExamplesMap',
+  'Examples',
+  'Header',
+  'Responses',
+  'Response',
+  'Schema',
+  'Xml',
+  'SchemaProperties',
+  'NamedSchemas',
+  'NamedResponses',
+  'NamedParameters',
+  'NamedSecuritySchemes',
+  'SecurityScheme',
+  'TagGroup',
+  'TagGroups',
+  'EnumDescriptions',
+  'Logo',
+  'XCodeSample',
+  'XCodeSampleList',
+  'XServer',
+  'XServerList',
+] as const;
+
+export type Oas2NodeType = typeof oas2NodeTypesList[number];
+
+const oas3NodeTypesList = [
   'Root',
   'Tag',
   'TagList',
@@ -153,12 +196,33 @@ const nodeTypesList = [
   'AuthorizationCode',
   'OAuth2Flows',
   'SecurityScheme',
+  'TagGroup',
+  'TagGroups',
+  'EnumDescriptions',
+  'Logo',
   'XCodeSample',
   'XCodeSampleList',
+  'XUsePkce',
   'WebhooksMap',
-  'SpecExtension',
-  'Message',
-];
+] as const;
+
+export type Oas3NodeType = typeof oas3NodeTypesList[number];
+
+const oas3_1NodeTypesList = [
+  'Root',
+  'Schema',
+  'SchemaProperties',
+  'Info',
+  'License',
+  'Components',
+  'NamedPathItems',
+  'SecurityScheme',
+  'Operation',
+] as const;
+
+export type Oas3_1NodeType = typeof oas3_1NodeTypesList[number];
+
+const asyncNodeTypesList = ['Message'] as const;
 
 const ConfigStyleguide: NodeType = {
   properties: {
@@ -186,22 +250,13 @@ const ConfigStyleguide: NodeType = {
   },
 };
 
-const RootConfigStyleguide: NodeType = {
+const createConfigRoot = (nodeTypes: Record<string, NodeType>): NodeType => ({
+  ...nodeTypes.rootRedoclyConfigSchema,
   properties: {
-    plugins: {
-      type: 'array',
-      items: { type: 'string' },
-    },
+    ...nodeTypes.rootRedoclyConfigSchema.properties,
     ...ConfigStyleguide.properties,
-  },
-};
-
-const ConfigRoot: NodeType = {
-  properties: {
-    ...rootRedoclyConfigSchema.properties,
-    ...RootConfigStyleguide.properties,
-    apis: 'ConfigApis',
-    theme: 'ConfigRootTheme',
+    apis: 'ConfigApis', // Override apis with internal format
+    theme: 'ConfigRootTheme', // Override theme with internal format
     'features.openapi': 'ConfigReferenceDocs', // deprecated
     'features.mockServer': 'ConfigMockServer', // deprecated
     organization: { type: 'string' },
@@ -220,17 +275,17 @@ const ConfigRoot: NodeType = {
       },
     },
   },
-};
+});
 
 const ConfigApis: NodeType = {
   properties: {},
   additionalProperties: 'ConfigApisProperties',
 };
 
-const ConfigApisProperties: NodeType = {
+const createConfigApisProperties = (nodeTypes: Record<string, NodeType>): NodeType => ({
+  ...nodeTypes['rootRedoclyConfigSchema.apis_additionalProperties'],
   properties: {
-    ...apiConfigSchema.properties,
-    root: { type: 'string' },
+    ...nodeTypes['rootRedoclyConfigSchema.apis_additionalProperties']?.properties,
     labels: {
       type: 'array',
       items: {
@@ -240,7 +295,6 @@ const ConfigApisProperties: NodeType = {
     ...ConfigStyleguide.properties,
     'features.openapi': 'ConfigReferenceDocs', // deprecated
     'features.mockServer': 'ConfigMockServer', // deprecated
-    theme: 'ConfigRootTheme',
     files: {
       type: 'array',
       items: {
@@ -248,8 +302,7 @@ const ConfigApisProperties: NodeType = {
       },
     },
   },
-  required: ['root'],
-};
+});
 
 const ConfigHTTP: NodeType = {
   properties: {
@@ -262,13 +315,13 @@ const ConfigHTTP: NodeType = {
   },
 };
 
-const ConfigRootTheme: NodeType = {
+const createConfigRootTheme = (nodeTypes: Record<string, NodeType>): NodeType => ({
+  ...nodeTypes['rootRedoclyConfigSchema.theme'],
   properties: {
-    ...themeConfigSchema.properties,
-    openapi: 'ConfigReferenceDocs',
-    mockServer: 'ConfigMockServer',
+    ...nodeTypes['rootRedoclyConfigSchema.theme']?.properties,
+    openapi: 'ConfigReferenceDocs', // Override theme.openapi with internal format
   },
-};
+});
 
 const Rules: NodeType = {
   properties: {},
@@ -302,7 +355,18 @@ const ObjectRule: NodeType = {
 
 const AssertionDefinitionSubject: NodeType = {
   properties: {
-    type: { enum: nodeTypesList },
+    type: {
+      enum: [
+        ...new Set([
+          'any',
+          ...oas2NodeTypesList,
+          ...oas3NodeTypesList,
+          ...oas3_1NodeTypesList,
+          ...asyncNodeTypesList,
+          'SpecExtension',
+        ]),
+      ],
+    },
     property: (value: unknown) => {
       if (Array.isArray(value)) {
         return { type: 'array', items: { type: 'string' } };
@@ -863,8 +927,9 @@ const GenerateCodeSamples: NodeType = {
 };
 
 const ConfigReferenceDocs: NodeType = {
+  // TODO: partially invalid @Viacheslav
   properties: {
-    theme: 'ConfigTheme',
+    theme: 'ConfigTheme', // TODO: deprecated @Viacheslav
     corsProxyUrl: { type: 'string' },
     ctrlFHijack: { type: 'boolean' },
     defaultSampleLanguage: { type: 'string' },
@@ -995,12 +1060,22 @@ const ConfigMockServer: NodeType = {
   },
 };
 
-export const ConfigTypes: Record<string, NodeType> = {
+export const createConfigTypes = (extraSchemas: JSONSchema) => {
+  // Create types based on external schemas
+  const nodeTypes = getNodeTypesFromJSONSchema('rootRedoclyConfigSchema', extraSchemas);
+
+  return {
+    ...CoreConfigTypes,
+    ConfigRoot: createConfigRoot(nodeTypes),
+    ConfigApisProperties: createConfigApisProperties(nodeTypes),
+    ConfigRootTheme: createConfigRootTheme(nodeTypes),
+    ...nodeTypes,
+  };
+};
+
+const CoreConfigTypes: Record<string, NodeType> = {
   Assert,
-  ConfigRoot,
   ConfigApis,
-  ConfigApisProperties,
-  RootConfigStyleguide,
   ConfigStyleguide,
   ConfigReferenceDocs,
   ConfigMockServer,
@@ -1010,7 +1085,6 @@ export const ConfigTypes: Record<string, NodeType> = {
   ConfigSidebarLinks,
   CommonConfigSidebarLinks,
   ConfigTheme,
-  ConfigRootTheme,
   AssertDefinition,
   ThemeColors,
   CommonThemeColors,
@@ -1060,5 +1134,6 @@ export const ConfigTypes: Record<string, NodeType> = {
   Typography,
   AssertionDefinitionAssertions,
   AssertionDefinitionSubject,
-  ...PortalConfigNodeTypes,
 };
+
+export const ConfigTypes: Record<string, NodeType> = createConfigTypes(rootRedoclyConfigSchema);

package/src/types/theme-config.ts

@@ -1,3 +1,5 @@
+import type { FromSchema } from 'json-schema-to-ts';
+
 const logoConfigSchema = {
   type: 'object',
   properties: {
@@ -68,6 +70,11 @@ const markdownConfigSchema = {
       items: { type: 'string' },
       default: ['image', 'links'],
     },
+    partialsFolders: {
+      type: 'array',
+      items: { type: 'string' },
+      default: ['_partials'],
+    },
     lastUpdatedBlock: {
       type: 'object',
       properties: {
@@ -76,7 +83,7 @@ const markdownConfigSchema = {
           enum: ['timeago', 'iso', 'long', 'short'],
           default: 'timeago',
         },
-        locale: { type: 'string', default: 'en-US' },
+        locale: { type: 'string' },
         ...hideConfigSchema.properties,
       },
       additionalProperties: false,
@@ -187,6 +194,21 @@ const gtmAnalyticsConfigSchema = {
   required: ['trackingId'],
 } as const;
 
+const productGoogleAnalyticsConfigSchema = {
+  type: 'object',
+  properties: {
+    includeInDevelopment: { type: 'boolean' },
+    trackingId: { type: 'string' },
+
+    conversionId: { type: 'string' },
+    floodlightId: { type: 'string' },
+    optimizeId: { type: 'string' },
+    exclude: { type: 'array', items: { type: 'string' } },
+  },
+  additionalProperties: false,
+  required: ['trackingId'],
+} as const;
+
 const googleAnalyticsConfigSchema = {
   type: 'object',
   properties: {
@@ -203,6 +225,12 @@ const googleAnalyticsConfigSchema = {
     optimizeId: { type: 'string' },
     anonymizeIp: { type: 'boolean' },
     cookieExpires: { type: 'number' },
+
+    // All enabled tracking configs
+    trackers: {
+      type: 'object',
+      additionalProperties: productGoogleAnalyticsConfigSchema,
+    },
   },
   additionalProperties: false,
   required: ['trackingId'],
@@ -224,6 +252,7 @@ const navItemSchema = {
   properties: {
     page: { type: 'string' },
     directory: { type: 'string' },
+    disconnect: { type: 'boolean', default: false },
     group: { type: 'string' },
     label: { type: 'string' },
     separator: { type: 'string' },
@@ -264,7 +293,7 @@ const productConfigSchema = {
     folder: { type: 'string' },
   },
   additionalProperties: false,
-  required: ['name', 'icon', 'folder'],
+  required: ['name', 'folder'],
 } as const;
 
 const suggestedPageSchema = {
@@ -287,6 +316,7 @@ const catalogFilterSchema = {
     titleTranslationKey: { type: 'string' },
     property: { type: 'string' },
     parentFilter: { type: 'string' },
+    valuesMapping: { type: 'object', additionalProperties: { type: 'string' } },
     missingCategoryName: { type: 'string' },
     missingCategoryNameTranslationKey: { type: 'string' },
     options: { type: 'array', items: { type: 'string' } },
@@ -296,9 +326,9 @@ const catalogFilterSchema = {
 const scorecardConfigSchema = {
   type: 'object',
   additionalProperties: true,
-  required: ['levels'],
+  required: [],
   properties: {
-    failBuildIfBelowMinimum: { type: 'boolean', default: false },
+    ignoreNonCompliant: { type: 'boolean', default: false },
     teamMetadataProperty: {
       type: 'object',
       properties: {
@@ -314,11 +344,12 @@ const scorecardConfigSchema = {
         required: ['name'],
         properties: {
           name: { type: 'string' },
+          color: { type: 'string' },
           extends: { type: 'array', items: { type: 'string' } },
           rules: {
             type: 'object',
             additionalProperties: {
-              type: ['object', 'string'],
+              oneOf: [{ type: 'string' }, { type: 'object' }],
             },
           },
         },
@@ -420,12 +451,6 @@ export const themeConfigSchema = {
       },
       additionalProperties: false,
     },
-    seo: {
-      type: 'object',
-      properties: {
-        title: { type: 'string' },
-      },
-    },
     scripts: {
       type: 'object',
       properties: {
@@ -444,7 +469,7 @@ export const themeConfigSchema = {
         },
         type: {
           type: 'string',
-          enum: ['rating', 'sentiment', 'comment', 'reasons'],
+          enum: ['rating', 'sentiment', 'comment', 'reasons', 'mood', 'scale'],
           default: 'sentiment',
         },
         settings: {
@@ -452,15 +477,27 @@ export const themeConfigSchema = {
           properties: {
             label: { type: 'string' },
             submitText: { type: 'string' },
-            max: { type: 'number' },
             buttonText: { type: 'string' },
-            multi: { type: 'boolean' },
+            component: {
+              type: 'string',
+              enum: ['radio', 'checkbox'],
+              default: 'checkbox',
+            },
             items: { type: 'array', items: { type: 'string' }, minItems: 1 },
+            leftScaleLabel: { type: 'string' },
+            rightScaleLabel: { type: 'string' },
             reasons: {
               type: 'object',
               properties: {
-                enable: { type: 'boolean', default: true },
-                multi: { type: 'boolean' },
+                hide: {
+                  type: 'boolean',
+                  default: false,
+                },
+                component: {
+                  type: 'string',
+                  enum: ['radio', 'checkbox'],
+                  default: 'checkbox',
+                },
                 label: { type: 'string' },
                 items: { type: 'array', items: { type: 'string' } },
               },
@@ -469,10 +506,16 @@ export const themeConfigSchema = {
             comment: {
               type: 'object',
               properties: {
-                enable: { type: 'boolean', default: true },
+                hide: {
+                  type: 'boolean',
+                  default: false,
+                },
                 label: { type: 'string' },
                 likeLabel: { type: 'string' },
                 dislikeLabel: { type: 'string' },
+                satisfiedLabel: { type: 'string' },
+                neutralLabel: { type: 'string' },
+                dissatisfiedLabel: { type: 'string' },
               },
               additionalProperties: false,
             },
@@ -525,7 +568,7 @@ export const themeConfigSchema = {
         nextButton: {
           type: 'object',
           properties: {
-            text: { type: 'string', default: 'Next to {label}' },
+            text: { type: 'string', default: 'Next to {{label}}' },
             ...hideConfigSchema.properties,
           },
           additionalProperties: false,
@@ -534,7 +577,7 @@ export const themeConfigSchema = {
         previousButton: {
           type: 'object',
           properties: {
-            text: { type: 'string', default: 'Back to {label}' },
+            text: { type: 'string', default: 'Back to {{label}}' },
             ...hideConfigSchema.properties,
           },
           additionalProperties: false,
@@ -547,7 +590,7 @@ export const themeConfigSchema = {
     codeSnippet: {
       type: 'object',
       properties: {
-        controlsStyle: { type: 'string', default: 'icon' },
+        elementFormat: { type: 'string', default: 'icon' },
         copy: {
           type: 'object',
           properties: {
@@ -559,10 +602,13 @@ export const themeConfigSchema = {
         report: {
           type: 'object',
           properties: {
+            tooltipText: { type: 'string' },
+            buttonText: { type: 'string' },
+            label: { type: 'string' },
             ...hideConfigSchema.properties,
           },
           additionalProperties: false,
-          default: { hide: true },
+          default: { hide: false },
         },
         expand: {
           type: 'object',
@@ -585,7 +631,7 @@ export const themeConfigSchema = {
       default: {},
     },
     markdown: markdownConfigSchema,
-    openapi: { type: 'object', additionalProperties: true },
+    openapi: { type: 'object', additionalProperties: true }, // TODO: put the real schema here @Viacheslav
     graphql: { type: 'object', additionalProperties: true },
     analytics: {
       type: 'object',
@@ -671,13 +717,65 @@ export const productThemeOverrideSchema = {
     search: themeConfigSchema.properties.search,
     codeSnippet: themeConfigSchema.properties.codeSnippet,
     breadcrumbs: themeConfigSchema.properties.breadcrumbs,
+    analytics: {
+      type: 'object',
+      properties: {
+        ga: productGoogleAnalyticsConfigSchema,
+      },
+    },
   },
   additionalProperties: true,
   default: {},
 } as const;
 
-export enum ScorecardStatus {
-  BelowMinimum = 'Below minimum',
-  Highest = 'Highest',
-  Minimum = 'Minimum',
-}
+export type ThemeConfig = FromSchema<typeof themeConfigSchema>;
+
+// TODO: cannot export  as it relies on external types
+// export type ThemeUIConfig = ThemeConfig & {
+//   auth?: {
+//     // used by portal dev login emulator
+//     idpsInfo?: {
+//       idpId: string;
+//       type: string; // AuthProviderType
+//       title: string | undefined;
+//     }[];
+//     devLogin?: boolean;
+//     loginUrls?: Record<string, string>;
+//   };
+//   search?: {
+//     shortcuts?: string[];
+//     suggestedPages?: any[];
+//   };
+//   breadcrumbs?: {
+//     prefixItems?: ResolvedNavLinkItem[];
+//   };
+//   products?: {
+//     [key: string]: ProductUiConfig;
+//   };
+// };
+
+export type ProductConfig = FromSchema<typeof productConfigSchema>;
+
+export type ProductGoogleAnalyticsConfig = FromSchema<typeof productGoogleAnalyticsConfigSchema>;
+// TODO: cannot export  as it relies on external types
+// export type ProductThemeOverrideConfig = Pick<
+//   ThemeUIConfig,
+//   'logo' | 'navbar' | 'footer' | 'sidebar' | 'search' | 'codeSnippet' | 'breadcrumbs'
+// > & { analytics?: { ga?: ProductGoogleAnalyticsConfig } };
+// export type ProductUiConfig = ProductConfig & {
+//   slug: string;
+//   link: string;
+//   [REDOCLY_TEAMS_RBAC]?: { [key: string]: string };
+//   themeOverride?: ProductThemeOverrideConfig;
+// };
+
+export type MarkdownConfig = FromSchema<typeof markdownConfigSchema>;
+
+export type AmplitudeAnalyticsConfig = FromSchema<typeof amplitudeAnalyticsConfigSchema>;
+export type RudderstackAnalyticsConfig = FromSchema<typeof rudderstackAnalyticsConfigSchema>;
+export type SegmentAnalyticsConfig = FromSchema<typeof segmentAnalyticsConfigSchema>;
+export type GtmAnalyticsConfig = FromSchema<typeof gtmAnalyticsConfigSchema>;
+export type GoogleAnalyticsConfig = FromSchema<typeof googleAnalyticsConfigSchema>;
+export type CatalogConfig = FromSchema<typeof catalogSchema>;
+export type CatalogFilterConfig = FromSchema<typeof catalogFilterSchema>;
+export type ScorecardConfig = FromSchema<typeof scorecardConfigSchema>;

package/src/utils.ts

@@ -5,9 +5,10 @@ import fetch from 'node-fetch';
 import * as pluralize from 'pluralize';
 import { parseYaml } from './js-yaml';
 import { UserContext } from './walk';
-import { HttpResolveConfig } from './config';
 import { env } from './env';
 import { logger, colorize } from './logger';
+import { HttpResolveConfig } from './config';
+import { HttpsProxyAgent } from 'https-proxy-agent';
 
 export { parseYaml, stringifyYaml } from './js-yaml';
 
@@ -37,11 +38,11 @@ export function isDefined<T>(x: T | undefined): x is T {
   return x !== undefined;
 }
 
-export function isPlainObject(value: any): value is object {
+export function isPlainObject(value: any): value is Record<string, unknown> {
   return value !== null && typeof value === 'object' && !Array.isArray(value);
 }
 
-export function isEmptyObject(value: any): value is object {
+export function isEmptyObject(value: any): value is Record<string, unknown> {
   return isPlainObject(value) && Object.keys(value).length === 0;
 }
 
@@ -274,3 +275,8 @@ export function nextTick() {
 function getUpdatedFieldName(updatedField: string, updatedObject?: string) {
   return `${typeof updatedObject !== 'undefined' ? `${updatedObject}.` : ''}${updatedField}`;
 }
+
+export function getProxyAgent() {
+  const proxy = process.env.HTTPS_PROXY || process.env.HTTP_PROXY;
+  return proxy ? new HttpsProxyAgent(proxy) : undefined;
+}

package/src/visitors.ts

@@ -359,7 +359,7 @@ export function normalizeVisitors<T extends BaseVisitor>(
         possibleChildren.add(from.additionalProperties);
       }
     }
-    if (from.items) {
+    if (from.items && typeof from.items !== 'function') {
       if (from.items === to) {
         addWeakFromStack(ruleConf, stack);
       } else if (from.items.name !== undefined) {

package/src/walk.ts

@@ -271,8 +271,14 @@ export function walkDocument<T extends BaseVisitor>(opts: {
         if (Array.isArray(resolvedNode)) {
           const itemsType = type.items;
           if (itemsType !== undefined) {
+            const isTypeAFunction = typeof itemsType === 'function';
             for (let i = 0; i < resolvedNode.length; i++) {
-              walkNode(resolvedNode[i], itemsType, resolvedLocation.child([i]), resolvedNode, i);
+              const itemType = isTypeAFunction
+                ? itemsType(resolvedNode[i], resolvedLocation.child([i]).absolutePointer)
+                : itemsType;
+              if (isNamedType(itemType)) {
+                walkNode(resolvedNode[i], itemType, resolvedLocation.child([i]), resolvedNode, i);
+              }
             }
           }
         } else if (typeof resolvedNode === 'object' && resolvedNode !== null) {