@redocly/openapi-core 1.9.0 → 1.10.0

package/lib/types/theme-config.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.ScorecardStatus = exports.productThemeOverrideSchema = exports.themeConfigSchema = void 0;
+exports.productThemeOverrideSchema = exports.themeConfigSchema = void 0;
 const logoConfigSchema = {
     type: 'object',
     properties: {
@@ -67,13 +67,18 @@ const markdownConfigSchema = {
             items: { type: 'string' },
             default: ['image', 'links'],
         },
+        partialsFolders: {
+            type: 'array',
+            items: { type: 'string' },
+            default: ['_partials'],
+        },
         lastUpdatedBlock: {
             type: 'object',
             properties: Object.assign({ format: {
                     type: 'string',
                     enum: ['timeago', 'iso', 'long', 'short'],
                     default: 'timeago',
-                }, locale: { type: 'string', default: 'en-US' } }, hideConfigSchema.properties),
+                }, locale: { type: 'string' } }, hideConfigSchema.properties),
             additionalProperties: false,
             default: {},
         },
@@ -168,6 +173,19 @@ const gtmAnalyticsConfigSchema = {
     additionalProperties: false,
     required: ['trackingId'],
 };
+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'],
+};
 const googleAnalyticsConfigSchema = {
     type: 'object',
     properties: {
@@ -181,6 +199,11 @@ const googleAnalyticsConfigSchema = {
         optimizeId: { type: 'string' },
         anonymizeIp: { type: 'boolean' },
         cookieExpires: { type: 'number' },
+        // All enabled tracking configs
+        trackers: {
+            type: 'object',
+            additionalProperties: productGoogleAnalyticsConfigSchema,
+        },
     },
     additionalProperties: false,
     required: ['trackingId'],
@@ -200,6 +223,7 @@ const navItemSchema = {
     properties: {
         page: { type: 'string' },
         directory: { type: 'string' },
+        disconnect: { type: 'boolean', default: false },
         group: { type: 'string' },
         label: { type: 'string' },
         separator: { type: 'string' },
@@ -232,7 +256,7 @@ const productConfigSchema = {
         folder: { type: 'string' },
     },
     additionalProperties: false,
-    required: ['name', 'icon', 'folder'],
+    required: ['name', 'folder'],
 };
 const suggestedPageSchema = {
     type: 'object',
@@ -253,6 +277,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' } },
@@ -261,9 +286,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: {
@@ -279,11 +304,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' }],
                         },
                     },
                 },
@@ -370,12 +396,6 @@ exports.themeConfigSchema = {
                 } }, hideConfigSchema.properties),
             additionalProperties: false,
         },
-        seo: {
-            type: 'object',
-            properties: {
-                title: { type: 'string' },
-            },
-        },
         scripts: {
             type: 'object',
             properties: {
@@ -394,21 +414,33 @@ exports.themeConfigSchema = {
                 },
                 type: {
                     type: 'string',
-                    enum: ['rating', 'sentiment', 'comment', 'reasons'],
+                    enum: ['rating', 'sentiment', 'comment', 'reasons', 'mood', 'scale'],
                     default: 'sentiment',
                 },
                 settings: Object.assign({ type: 'object', 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' } },
                             },
@@ -417,10 +449,16 @@ exports.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,
                         },
@@ -460,13 +498,13 @@ exports.themeConfigSchema = {
             properties: {
                 nextButton: {
                     type: 'object',
-                    properties: Object.assign({ text: { type: 'string', default: 'Next to {label}' } }, hideConfigSchema.properties),
+                    properties: Object.assign({ text: { type: 'string', default: 'Next to {{label}}' } }, hideConfigSchema.properties),
                     additionalProperties: false,
                     default: {},
                 },
                 previousButton: {
                     type: 'object',
-                    properties: Object.assign({ text: { type: 'string', default: 'Back to {label}' } }, hideConfigSchema.properties),
+                    properties: Object.assign({ text: { type: 'string', default: 'Back to {{label}}' } }, hideConfigSchema.properties),
                     additionalProperties: false,
                     default: {},
                 },
@@ -477,7 +515,7 @@ exports.themeConfigSchema = {
         codeSnippet: {
             type: 'object',
             properties: {
-                controlsStyle: { type: 'string', default: 'icon' },
+                elementFormat: { type: 'string', default: 'icon' },
                 copy: {
                     type: 'object',
                     properties: Object.assign({}, hideConfigSchema.properties),
@@ -486,9 +524,9 @@ exports.themeConfigSchema = {
                 },
                 report: {
                     type: 'object',
-                    properties: Object.assign({}, hideConfigSchema.properties),
+                    properties: Object.assign({ tooltipText: { type: 'string' }, buttonText: { type: 'string' }, label: { type: 'string' } }, hideConfigSchema.properties),
                     additionalProperties: false,
-                    default: { hide: true },
+                    default: { hide: false },
                 },
                 expand: {
                     type: 'object',
@@ -587,13 +625,13 @@ exports.productThemeOverrideSchema = {
         search: exports.themeConfigSchema.properties.search,
         codeSnippet: exports.themeConfigSchema.properties.codeSnippet,
         breadcrumbs: exports.themeConfigSchema.properties.breadcrumbs,
+        analytics: {
+            type: 'object',
+            properties: {
+                ga: productGoogleAnalyticsConfigSchema,
+            },
+        },
     },
     additionalProperties: true,
     default: {},
 };
-var ScorecardStatus;
-(function (ScorecardStatus) {
-    ScorecardStatus["BelowMinimum"] = "Below minimum";
-    ScorecardStatus["Highest"] = "Highest";
-    ScorecardStatus["Minimum"] = "Minimum";
-})(ScorecardStatus || (exports.ScorecardStatus = ScorecardStatus = {}));

package/lib/utils.d.ts

@@ -1,5 +1,6 @@
 import { UserContext } from './walk';
 import { HttpResolveConfig } from './config';
+import { HttpsProxyAgent } from 'https-proxy-agent';
 export { parseYaml, stringifyYaml } from './js-yaml';
 export type StackFrame<T> = {
     prev: StackFrame<T> | null;
@@ -15,8 +16,8 @@ export declare function popStack<T, P extends Stack<T>>(head: P): StackFrame<T>
 export type BundleOutputFormat = 'json' | 'yml' | 'yaml';
 export declare function loadYaml<T>(filename: string): Promise<T>;
 export declare function isDefined<T>(x: T | undefined): x is T;
-export declare function isPlainObject(value: any): value is object;
-export declare function isEmptyObject(value: any): value is object;
+export declare function isPlainObject(value: any): value is Record<string, unknown>;
+export declare function isEmptyObject(value: any): value is Record<string, unknown>;
 export declare function isEmptyArray(value: any): boolean;
 export declare function readFileFromUrl(url: string, config: HttpResolveConfig): Promise<{
     body: any;
@@ -50,3 +51,4 @@ export declare function identity<T>(value: T): T;
 export declare function keysOf<T>(obj: T): (keyof T)[];
 export declare function pickDefined<T extends Record<string, unknown>>(obj?: T): Record<string, unknown> | undefined;
 export declare function nextTick(): void;
+export declare function getProxyAgent(): HttpsProxyAgent<string> | undefined;

package/lib/utils.js

@@ -9,7 +9,7 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
     });
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.nextTick = exports.pickDefined = exports.keysOf = exports.identity = exports.isTruthy = exports.showErrorForDeprecatedField = exports.showWarningForDeprecatedField = exports.doesYamlFileExist = exports.isCustomRuleId = exports.getMatchingStatusCodeRange = exports.assignExisting = exports.isNotString = exports.isString = exports.isNotEmptyObject = exports.slash = exports.isPathParameter = exports.yamlAndJsonSyncReader = exports.readFileAsStringSync = exports.isSingular = exports.validateMimeTypeOAS3 = exports.validateMimeType = exports.splitCamelCaseIntoWords = exports.omitObjectProps = exports.pickObjectProps = exports.readFileFromUrl = exports.isEmptyArray = exports.isEmptyObject = exports.isPlainObject = exports.isDefined = exports.loadYaml = exports.popStack = exports.pushStack = exports.stringifyYaml = exports.parseYaml = void 0;
+exports.getProxyAgent = exports.nextTick = exports.pickDefined = exports.keysOf = exports.identity = exports.isTruthy = exports.showErrorForDeprecatedField = exports.showWarningForDeprecatedField = exports.doesYamlFileExist = exports.isCustomRuleId = exports.getMatchingStatusCodeRange = exports.assignExisting = exports.isNotString = exports.isString = exports.isNotEmptyObject = exports.slash = exports.isPathParameter = exports.yamlAndJsonSyncReader = exports.readFileAsStringSync = exports.isSingular = exports.validateMimeTypeOAS3 = exports.validateMimeType = exports.splitCamelCaseIntoWords = exports.omitObjectProps = exports.pickObjectProps = exports.readFileFromUrl = exports.isEmptyArray = exports.isEmptyObject = exports.isPlainObject = exports.isDefined = exports.loadYaml = exports.popStack = exports.pushStack = exports.stringifyYaml = exports.parseYaml = void 0;
 const fs = require("fs");
 const path_1 = require("path");
 const minimatch = require("minimatch");
@@ -18,6 +18,7 @@ const pluralize = require("pluralize");
 const js_yaml_1 = require("./js-yaml");
 const env_1 = require("./env");
 const logger_1 = require("./logger");
+const https_proxy_agent_1 = require("https-proxy-agent");
 var js_yaml_2 = require("./js-yaml");
 Object.defineProperty(exports, "parseYaml", { enumerable: true, get: function () { return js_yaml_2.parseYaml; } });
 Object.defineProperty(exports, "stringifyYaml", { enumerable: true, get: function () { return js_yaml_2.stringifyYaml; } });
@@ -239,3 +240,8 @@ exports.nextTick = nextTick;
 function getUpdatedFieldName(updatedField, updatedObject) {
     return `${typeof updatedObject !== 'undefined' ? `${updatedObject}.` : ''}${updatedField}`;
 }
+function getProxyAgent() {
+    const proxy = process.env.HTTPS_PROXY || process.env.HTTP_PROXY;
+    return proxy ? new https_proxy_agent_1.HttpsProxyAgent(proxy) : undefined;
+}
+exports.getProxyAgent = getProxyAgent;

package/lib/visitors.js

@@ -61,7 +61,7 @@ function normalizeVisitors(visitorsConfig, types) {
                 possibleChildren.add(from.additionalProperties);
             }
         }
-        if (from.items) {
+        if (from.items && typeof from.items !== 'function') {
             if (from.items === to) {
                 addWeakFromStack(ruleConf, stack);
             }

package/lib/walk.js

@@ -140,8 +140,14 @@ function walkDocument(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 ((0, types_1.isNamedType)(itemType)) {
+                                walkNode(resolvedNode[i], itemType, resolvedLocation.child([i]), resolvedNode, i);
+                            }
                         }
                     }
                 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@redocly/openapi-core",
-  "version": "1.9.0",
+  "version": "1.10.0",
   "description": "",
   "main": "lib/index.js",
   "engines": {
@@ -36,6 +36,7 @@
   "dependencies": {
     "@redocly/ajv": "^8.11.0",
     "colorette": "^1.2.0",
+    "https-proxy-agent": "^7.0.4",
     "js-levenshtein": "^1.1.6",
     "js-yaml": "^4.1.0",
     "lodash.isequal": "^4.5.0",