@redocly/config 0.50.1 → 0.52.0

package/lib/asyncapi-config-schema.d.ts

@@ -13,7 +13,7 @@ export declare const asyncapiConfigSchema: {
                         readonly type: 'string';
                     };
                 };
-                readonly required: readonly ['url'];
+                readonly required: readonly ["url"];
                 readonly additionalProperties: false;
             };
         };
@@ -60,12 +60,10 @@ export declare const asyncapiConfigSchema: {
             readonly properties: {
                 readonly hide: {
                     readonly type: 'boolean';
-                    readonly default: false;
                 };
                 readonly type: {
                     readonly type: 'string';
-                    readonly enum: readonly ['rating', 'sentiment', 'comment', 'reasons', 'mood', 'scale'];
-                    readonly default: 'sentiment';
+                    readonly enum: readonly ["rating", "sentiment", "comment", "reasons", "mood", "scale"];
                 };
                 readonly settings: {
                     readonly type: 'object';
@@ -81,8 +79,7 @@ export declare const asyncapiConfigSchema: {
                         };
                         readonly component: {
                             readonly type: 'string';
-                            readonly enum: readonly ['radio', 'checkbox'];
-                            readonly default: 'checkbox';
+                            readonly enum: readonly ["radio", "checkbox"];
                         };
                         readonly items: {
                             readonly type: 'array';
@@ -102,12 +99,10 @@ export declare const asyncapiConfigSchema: {
                             readonly properties: {
                                 readonly hide: {
                                     readonly type: 'boolean';
-                                    readonly default: false;
                                 };
                                 readonly component: {
                                     readonly type: 'string';
-                                    readonly enum: readonly ['radio', 'checkbox'];
-                                    readonly default: 'checkbox';
+                                    readonly enum: readonly ["radio", "checkbox"];
                                 };
                                 readonly label: {
                                     readonly type: 'string';
@@ -123,12 +118,10 @@ export declare const asyncapiConfigSchema: {
                                     readonly properties: {
                                         readonly hide: {
                                             readonly type: 'boolean';
-                                            readonly default: false;
                                         };
                                         readonly component: {
                                             readonly type: 'string';
-                                            readonly enum: readonly ['radio', 'checkbox'];
-                                            readonly default: 'checkbox';
+                                            readonly enum: readonly ["radio", "checkbox"];
                                         };
                                         readonly label: {
                                             readonly type: 'string';
@@ -147,12 +140,10 @@ export declare const asyncapiConfigSchema: {
                                     readonly properties: {
                                         readonly hide: {
                                             readonly type: 'boolean';
-                                            readonly default: false;
                                         };
                                         readonly component: {
                                             readonly type: 'string';
-                                            readonly enum: readonly ['radio', 'checkbox'];
-                                            readonly default: 'checkbox';
+                                            readonly enum: readonly ["radio", "checkbox"];
                                         };
                                         readonly label: {
                                             readonly type: 'string';
@@ -171,12 +162,10 @@ export declare const asyncapiConfigSchema: {
                                     readonly properties: {
                                         readonly hide: {
                                             readonly type: 'boolean';
-                                            readonly default: false;
                                         };
                                         readonly component: {
                                             readonly type: 'string';
-                                            readonly enum: readonly ['radio', 'checkbox'];
-                                            readonly default: 'checkbox';
+                                            readonly enum: readonly ["radio", "checkbox"];
                                         };
                                         readonly label: {
                                             readonly type: 'string';
@@ -195,12 +184,10 @@ export declare const asyncapiConfigSchema: {
                                     readonly properties: {
                                         readonly hide: {
                                             readonly type: 'boolean';
-                                            readonly default: false;
                                         };
                                         readonly component: {
                                             readonly type: 'string';
-                                            readonly enum: readonly ['radio', 'checkbox'];
-                                            readonly default: 'checkbox';
+                                            readonly enum: readonly ["radio", "checkbox"];
                                         };
                                         readonly label: {
                                             readonly type: 'string';
@@ -219,12 +206,10 @@ export declare const asyncapiConfigSchema: {
                                     readonly properties: {
                                         readonly hide: {
                                             readonly type: 'boolean';
-                                            readonly default: false;
                                         };
                                         readonly component: {
                                             readonly type: 'string';
-                                            readonly enum: readonly ['radio', 'checkbox'];
-                                            readonly default: 'checkbox';
+                                            readonly enum: readonly ["radio", "checkbox"];
                                         };
                                         readonly label: {
                                             readonly type: 'string';
@@ -246,7 +231,6 @@ export declare const asyncapiConfigSchema: {
                             readonly properties: {
                                 readonly hide: {
                                     readonly type: 'boolean';
-                                    readonly default: false;
                                 };
                                 readonly label: {
                                     readonly type: 'string';
@@ -274,7 +258,6 @@ export declare const asyncapiConfigSchema: {
                             readonly properties: {
                                 readonly hide: {
                                     readonly type: 'boolean';
-                                    readonly default: false;
                                 };
                                 readonly label: {
                                     readonly type: 'string';
@@ -293,7 +276,7 @@ export declare const asyncapiConfigSchema: {
         };
         readonly layout: {
             readonly type: 'string';
-            readonly enum: readonly ['stacked', 'three-panel'];
+            readonly enum: readonly ["stacked", "three-panel"];
         };
     };
     readonly additionalProperties: false;

package/lib/common.d.ts

@@ -5,26 +5,7 @@ export type PreprocessorTypes = (typeof preprocessorTypes)[number];
 export declare const decoratorTypes: readonly ['decorators', 'oas2Decorators', 'oas3_0Decorators', 'oas3_1Decorators', 'oas3_2Decorators', 'async2Decorators', 'async3Decorators', 'arazzo1Decorators', 'arazzo1_1Decorators', 'overlay1Decorators', 'openrpc1Decorators'];
 export type DecoratorTypes = (typeof decoratorTypes)[number];
 export declare const configGovernanceSchema: {
-    extends: {
-        readonly nodeTypeName: undefined;
-        readonly type: 'array';
-        readonly items: {
-            readonly type: 'string';
-        };
-        readonly description: 'Use extends to inherit rules and their configurations from other rulesets.';
-        readonly documentationLink: 'https://redocly.com/docs/cli/configuration/reference/extends';
-    };
-    arazzo1Decorators: {
-        readonly nodeTypeName: undefined;
-        readonly type: 'object';
-        readonly additionalProperties: true;
-    };
-    arazzo1Preprocessors: {
-        readonly nodeTypeName: undefined;
-        readonly type: 'object';
-        readonly additionalProperties: true;
-    };
-    arazzo1Rules: {
+    readonly rules: {
         readonly nodeTypeName: undefined;
         readonly type: 'object';
         readonly additionalProperties: {
@@ -37,17 +18,33 @@ export declare const configGovernanceSchema: {
         readonly description: 'The rules configuration blocks set up linting rules and their severity. You can configure built-in rules, add configurable rules, and rules from plugins.';
         readonly documentationLink: 'https://redocly.com/docs/cli/configuration/reference/rules#rules';
     };
-    arazzo1_1Decorators: {
+    readonly oas2Rules: {
         readonly nodeTypeName: undefined;
         readonly type: 'object';
-        readonly additionalProperties: true;
+        readonly additionalProperties: {
+            readonly oneOf: readonly [{
+                readonly type: 'string';
+            }, {
+                readonly type: 'object';
+            }];
+        };
+        readonly description: 'The rules configuration blocks set up linting rules and their severity. You can configure built-in rules, add configurable rules, and rules from plugins.';
+        readonly documentationLink: 'https://redocly.com/docs/cli/configuration/reference/rules#rules';
     };
-    arazzo1_1Preprocessors: {
+    readonly oas3_0Rules: {
         readonly nodeTypeName: undefined;
         readonly type: 'object';
-        readonly additionalProperties: true;
+        readonly additionalProperties: {
+            readonly oneOf: readonly [{
+                readonly type: 'string';
+            }, {
+                readonly type: 'object';
+            }];
+        };
+        readonly description: 'The rules configuration blocks set up linting rules and their severity. You can configure built-in rules, add configurable rules, and rules from plugins.';
+        readonly documentationLink: 'https://redocly.com/docs/cli/configuration/reference/rules#rules';
     };
-    arazzo1_1Rules: {
+    readonly oas3_1Rules: {
         readonly nodeTypeName: undefined;
         readonly type: 'object';
         readonly additionalProperties: {
@@ -60,17 +57,33 @@ export declare const configGovernanceSchema: {
         readonly description: 'The rules configuration blocks set up linting rules and their severity. You can configure built-in rules, add configurable rules, and rules from plugins.';
         readonly documentationLink: 'https://redocly.com/docs/cli/configuration/reference/rules#rules';
     };
-    async2Decorators: {
+    readonly oas3_2Rules: {
         readonly nodeTypeName: undefined;
         readonly type: 'object';
-        readonly additionalProperties: true;
+        readonly additionalProperties: {
+            readonly oneOf: readonly [{
+                readonly type: 'string';
+            }, {
+                readonly type: 'object';
+            }];
+        };
+        readonly description: 'The rules configuration blocks set up linting rules and their severity. You can configure built-in rules, add configurable rules, and rules from plugins.';
+        readonly documentationLink: 'https://redocly.com/docs/cli/configuration/reference/rules#rules';
     };
-    async2Preprocessors: {
+    readonly async2Rules: {
         readonly nodeTypeName: undefined;
         readonly type: 'object';
-        readonly additionalProperties: true;
+        readonly additionalProperties: {
+            readonly oneOf: readonly [{
+                readonly type: 'string';
+            }, {
+                readonly type: 'object';
+            }];
+        };
+        readonly description: 'The rules configuration blocks set up linting rules and their severity. You can configure built-in rules, add configurable rules, and rules from plugins.';
+        readonly documentationLink: 'https://redocly.com/docs/cli/configuration/reference/rules#rules';
     };
-    async2Rules: {
+    readonly async3Rules: {
         readonly nodeTypeName: undefined;
         readonly type: 'object';
         readonly additionalProperties: {
@@ -83,17 +96,33 @@ export declare const configGovernanceSchema: {
         readonly description: 'The rules configuration blocks set up linting rules and their severity. You can configure built-in rules, add configurable rules, and rules from plugins.';
         readonly documentationLink: 'https://redocly.com/docs/cli/configuration/reference/rules#rules';
     };
-    async3Decorators: {
+    readonly arazzo1Rules: {
         readonly nodeTypeName: undefined;
         readonly type: 'object';
-        readonly additionalProperties: true;
+        readonly additionalProperties: {
+            readonly oneOf: readonly [{
+                readonly type: 'string';
+            }, {
+                readonly type: 'object';
+            }];
+        };
+        readonly description: 'The rules configuration blocks set up linting rules and their severity. You can configure built-in rules, add configurable rules, and rules from plugins.';
+        readonly documentationLink: 'https://redocly.com/docs/cli/configuration/reference/rules#rules';
     };
-    async3Preprocessors: {
+    readonly arazzo1_1Rules: {
         readonly nodeTypeName: undefined;
         readonly type: 'object';
-        readonly additionalProperties: true;
+        readonly additionalProperties: {
+            readonly oneOf: readonly [{
+                readonly type: 'string';
+            }, {
+                readonly type: 'object';
+            }];
+        };
+        readonly description: 'The rules configuration blocks set up linting rules and their severity. You can configure built-in rules, add configurable rules, and rules from plugins.';
+        readonly documentationLink: 'https://redocly.com/docs/cli/configuration/reference/rules#rules';
     };
-    async3Rules: {
+    readonly overlay1Rules: {
         readonly nodeTypeName: undefined;
         readonly type: 'object';
         readonly additionalProperties: {
@@ -106,12 +135,20 @@ export declare const configGovernanceSchema: {
         readonly description: 'The rules configuration blocks set up linting rules and their severity. You can configure built-in rules, add configurable rules, and rules from plugins.';
         readonly documentationLink: 'https://redocly.com/docs/cli/configuration/reference/rules#rules';
     };
-    decorators: {
+    readonly openrpc1Rules: {
         readonly nodeTypeName: undefined;
         readonly type: 'object';
-        readonly additionalProperties: true;
+        readonly additionalProperties: {
+            readonly oneOf: readonly [{
+                readonly type: 'string';
+            }, {
+                readonly type: 'object';
+            }];
+        };
+        readonly description: 'The rules configuration blocks set up linting rules and their severity. You can configure built-in rules, add configurable rules, and rules from plugins.';
+        readonly documentationLink: 'https://redocly.com/docs/cli/configuration/reference/rules#rules';
     };
-    graphqlRules: {
+    readonly graphqlRules: {
         readonly nodeTypeName: undefined;
         readonly type: 'object';
         readonly additionalProperties: {
@@ -124,160 +161,123 @@ export declare const configGovernanceSchema: {
         readonly description: 'The rules configuration blocks set up linting rules and their severity. You can configure built-in rules, add configurable rules, and rules from plugins.';
         readonly documentationLink: 'https://redocly.com/docs/cli/configuration/reference/rules#rules';
     };
-    oas2Decorators: {
+    readonly preprocessors: {
         readonly nodeTypeName: undefined;
         readonly type: 'object';
         readonly additionalProperties: true;
     };
-    oas2Preprocessors: {
+    readonly oas2Preprocessors: {
         readonly nodeTypeName: undefined;
         readonly type: 'object';
         readonly additionalProperties: true;
     };
-    oas2Rules: {
+    readonly oas3_0Preprocessors: {
         readonly nodeTypeName: undefined;
         readonly type: 'object';
-        readonly additionalProperties: {
-            readonly oneOf: readonly [{
-                readonly type: 'string';
-            }, {
-                readonly type: 'object';
-            }];
-        };
-        readonly description: 'The rules configuration blocks set up linting rules and their severity. You can configure built-in rules, add configurable rules, and rules from plugins.';
-        readonly documentationLink: 'https://redocly.com/docs/cli/configuration/reference/rules#rules';
+        readonly additionalProperties: true;
     };
-    oas3_0Decorators: {
+    readonly oas3_1Preprocessors: {
         readonly nodeTypeName: undefined;
         readonly type: 'object';
         readonly additionalProperties: true;
     };
-    oas3_0Preprocessors: {
+    readonly oas3_2Preprocessors: {
         readonly nodeTypeName: undefined;
         readonly type: 'object';
         readonly additionalProperties: true;
     };
-    oas3_0Rules: {
+    readonly async2Preprocessors: {
         readonly nodeTypeName: undefined;
         readonly type: 'object';
-        readonly additionalProperties: {
-            readonly oneOf: readonly [{
-                readonly type: 'string';
-            }, {
-                readonly type: 'object';
-            }];
-        };
-        readonly description: 'The rules configuration blocks set up linting rules and their severity. You can configure built-in rules, add configurable rules, and rules from plugins.';
-        readonly documentationLink: 'https://redocly.com/docs/cli/configuration/reference/rules#rules';
+        readonly additionalProperties: true;
     };
-    oas3_1Decorators: {
+    readonly async3Preprocessors: {
         readonly nodeTypeName: undefined;
         readonly type: 'object';
         readonly additionalProperties: true;
     };
-    oas3_1Preprocessors: {
+    readonly arazzo1Preprocessors: {
         readonly nodeTypeName: undefined;
         readonly type: 'object';
         readonly additionalProperties: true;
     };
-    oas3_1Rules: {
+    readonly arazzo1_1Preprocessors: {
         readonly nodeTypeName: undefined;
         readonly type: 'object';
-        readonly additionalProperties: {
-            readonly oneOf: readonly [{
-                readonly type: 'string';
-            }, {
-                readonly type: 'object';
-            }];
-        };
-        readonly description: 'The rules configuration blocks set up linting rules and their severity. You can configure built-in rules, add configurable rules, and rules from plugins.';
-        readonly documentationLink: 'https://redocly.com/docs/cli/configuration/reference/rules#rules';
+        readonly additionalProperties: true;
     };
-    oas3_2Decorators: {
+    readonly overlay1Preprocessors: {
         readonly nodeTypeName: undefined;
         readonly type: 'object';
         readonly additionalProperties: true;
     };
-    oas3_2Preprocessors: {
+    readonly openrpc1Preprocessors: {
         readonly nodeTypeName: undefined;
         readonly type: 'object';
         readonly additionalProperties: true;
     };
-    oas3_2Rules: {
+    readonly decorators: {
         readonly nodeTypeName: undefined;
         readonly type: 'object';
-        readonly additionalProperties: {
-            readonly oneOf: readonly [{
-                readonly type: 'string';
-            }, {
-                readonly type: 'object';
-            }];
-        };
-        readonly description: 'The rules configuration blocks set up linting rules and their severity. You can configure built-in rules, add configurable rules, and rules from plugins.';
-        readonly documentationLink: 'https://redocly.com/docs/cli/configuration/reference/rules#rules';
+        readonly additionalProperties: true;
     };
-    openrpc1Decorators: {
+    readonly oas2Decorators: {
         readonly nodeTypeName: undefined;
         readonly type: 'object';
         readonly additionalProperties: true;
     };
-    openrpc1Preprocessors: {
+    readonly oas3_0Decorators: {
         readonly nodeTypeName: undefined;
         readonly type: 'object';
         readonly additionalProperties: true;
     };
-    openrpc1Rules: {
+    readonly oas3_1Decorators: {
         readonly nodeTypeName: undefined;
         readonly type: 'object';
-        readonly additionalProperties: {
-            readonly oneOf: readonly [{
-                readonly type: 'string';
-            }, {
-                readonly type: 'object';
-            }];
-        };
-        readonly description: 'The rules configuration blocks set up linting rules and their severity. You can configure built-in rules, add configurable rules, and rules from plugins.';
-        readonly documentationLink: 'https://redocly.com/docs/cli/configuration/reference/rules#rules';
+        readonly additionalProperties: true;
     };
-    overlay1Decorators: {
+    readonly oas3_2Decorators: {
         readonly nodeTypeName: undefined;
         readonly type: 'object';
         readonly additionalProperties: true;
     };
-    overlay1Preprocessors: {
+    readonly async2Decorators: {
         readonly nodeTypeName: undefined;
         readonly type: 'object';
         readonly additionalProperties: true;
     };
-    overlay1Rules: {
+    readonly async3Decorators: {
         readonly nodeTypeName: undefined;
         readonly type: 'object';
-        readonly additionalProperties: {
-            readonly oneOf: readonly [{
-                readonly type: 'string';
-            }, {
-                readonly type: 'object';
-            }];
-        };
-        readonly description: 'The rules configuration blocks set up linting rules and their severity. You can configure built-in rules, add configurable rules, and rules from plugins.';
-        readonly documentationLink: 'https://redocly.com/docs/cli/configuration/reference/rules#rules';
+        readonly additionalProperties: true;
     };
-    preprocessors: {
+    readonly arazzo1Decorators: {
         readonly nodeTypeName: undefined;
         readonly type: 'object';
         readonly additionalProperties: true;
     };
-    rules: {
+    readonly arazzo1_1Decorators: {
         readonly nodeTypeName: undefined;
         readonly type: 'object';
-        readonly additionalProperties: {
-            readonly oneOf: readonly [{
-                readonly type: 'string';
-            }, {
-                readonly type: 'object';
-            }];
+        readonly additionalProperties: true;
+    };
+    readonly overlay1Decorators: {
+        readonly nodeTypeName: undefined;
+        readonly type: 'object';
+        readonly additionalProperties: true;
+    };
+    readonly openrpc1Decorators: {
+        readonly nodeTypeName: undefined;
+        readonly type: 'object';
+        readonly additionalProperties: true;
+    };
+    readonly extends: {
+        readonly nodeTypeName: undefined;
+        readonly type: 'array';
+        readonly items: {
+            readonly type: 'string';
         };
-        readonly description: 'The rules configuration blocks set up linting rules and their severity. You can configure built-in rules, add configurable rules, and rules from plugins.';
-        readonly documentationLink: 'https://redocly.com/docs/cli/configuration/reference/rules#rules';
+        readonly description: 'Use extends to inherit rules and their configurations from other rulesets.';
+        readonly documentationLink: 'https://redocly.com/docs/cli/configuration/reference/extends';
     };
 };

package/lib/constants/identity-provider-slug.d.ts

@@ -3,6 +3,7 @@ export declare const IDENTITY_PROVIDER_SLUG_REGEX: RegExp;
 export declare const IDENTITY_PROVIDER_SLUG_MESSAGE = "Unique ID must be lowercase letters, numbers, and hyphens only";
 export declare const IDENTITY_PROVIDER_SLUG_MAX_LENGTH = 63;
 export declare const IDENTITY_PROVIDER_SLUG_MAX_LENGTH_MESSAGE = "Unique ID cannot exceed 63 characters";
-export declare const IDENTITY_PROVIDER_RESERVED_SLUGS: readonly ['redocly', 'corporate', 'guest'];
+export declare const REDOCLY_IDP_SLUG = "redocly";
+export declare const IDENTITY_PROVIDER_RESERVED_SLUGS: readonly ["redocly", 'corporate', 'guest'];
 export declare const IDENTITY_PROVIDER_RESERVED_MESSAGE: string;
 export declare const SSO_LOGIN_TYPES: readonly ['REDOCLY', 'CORPORATE', 'GUEST'];

package/lib/constants/shared.d.ts

@@ -13,3 +13,4 @@ export declare enum LayoutVariant {
     STACKED = "stacked",
     THREE_PANEL = "three-panel"
 }
+export declare const DEFAULT_SEARCH_ENGINE = "flexsearch";