@redocly/config 0.43.0 → 0.44.1

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

@@ -0,0 +1,300 @@
+export declare const asyncapiConfigSchema: {
+    readonly type: "object";
+    readonly properties: {
+        readonly downloadUrls: {
+            readonly type: "array";
+            readonly items: {
+                readonly type: "object";
+                readonly properties: {
+                    readonly title: {
+                        readonly type: "string";
+                    };
+                    readonly url: {
+                        readonly type: "string";
+                    };
+                };
+                readonly required: readonly ["url"];
+                readonly additionalProperties: false;
+            };
+        };
+        readonly apiLogo: {
+            readonly type: "object";
+            readonly properties: {
+                readonly imageUrl: {
+                    readonly type: "string";
+                };
+                readonly href: {
+                    readonly type: "string";
+                };
+                readonly altText: {
+                    readonly type: "string";
+                };
+                readonly backgroundColor: {
+                    readonly type: "string";
+                };
+            };
+        };
+        readonly jsonSamplesDepth: {
+            readonly type: "number";
+        };
+        readonly samplesMaxInlineArgs: {
+            readonly type: "number";
+        };
+        readonly fieldExpandLevel: {
+            readonly type: "number";
+        };
+        readonly baseUrlPath: {
+            readonly type: "string";
+        };
+        readonly metadata: {
+            readonly type: "object";
+            readonly properties: {
+                readonly apiId: {
+                    readonly type: "string";
+                };
+            };
+            readonly additionalProperties: true;
+        };
+        readonly feedback: {
+            readonly type: "object";
+            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 settings: {
+                    readonly type: "object";
+                    readonly properties: {
+                        readonly label: {
+                            readonly type: "string";
+                        };
+                        readonly submitText: {
+                            readonly type: "string";
+                        };
+                        readonly buttonText: {
+                            readonly type: "string";
+                        };
+                        readonly component: {
+                            readonly type: "string";
+                            readonly enum: readonly ["radio", "checkbox"];
+                            readonly default: "checkbox";
+                        };
+                        readonly items: {
+                            readonly type: "array";
+                            readonly items: {
+                                readonly type: "string";
+                            };
+                            readonly minItems: 1;
+                        };
+                        readonly leftScaleLabel: {
+                            readonly type: "string";
+                        };
+                        readonly rightScaleLabel: {
+                            readonly type: "string";
+                        };
+                        readonly reasons: {
+                            readonly type: "object";
+                            readonly properties: {
+                                readonly like: {
+                                    readonly type: "object";
+                                    readonly properties: {
+                                        readonly hide: {
+                                            readonly type: "boolean";
+                                            readonly default: false;
+                                        };
+                                        readonly component: {
+                                            readonly type: "string";
+                                            readonly enum: readonly ["radio", "checkbox"];
+                                            readonly default: "checkbox";
+                                        };
+                                        readonly label: {
+                                            readonly type: "string";
+                                        };
+                                        readonly items: {
+                                            readonly type: "array";
+                                            readonly items: {
+                                                readonly type: "string";
+                                            };
+                                        };
+                                    };
+                                    readonly additionalProperties: false;
+                                };
+                                readonly dislike: {
+                                    readonly type: "object";
+                                    readonly properties: {
+                                        readonly hide: {
+                                            readonly type: "boolean";
+                                            readonly default: false;
+                                        };
+                                        readonly component: {
+                                            readonly type: "string";
+                                            readonly enum: readonly ["radio", "checkbox"];
+                                            readonly default: "checkbox";
+                                        };
+                                        readonly label: {
+                                            readonly type: "string";
+                                        };
+                                        readonly items: {
+                                            readonly type: "array";
+                                            readonly items: {
+                                                readonly type: "string";
+                                            };
+                                        };
+                                    };
+                                    readonly additionalProperties: false;
+                                };
+                                readonly satisfied: {
+                                    readonly type: "object";
+                                    readonly properties: {
+                                        readonly hide: {
+                                            readonly type: "boolean";
+                                            readonly default: false;
+                                        };
+                                        readonly component: {
+                                            readonly type: "string";
+                                            readonly enum: readonly ["radio", "checkbox"];
+                                            readonly default: "checkbox";
+                                        };
+                                        readonly label: {
+                                            readonly type: "string";
+                                        };
+                                        readonly items: {
+                                            readonly type: "array";
+                                            readonly items: {
+                                                readonly type: "string";
+                                            };
+                                        };
+                                    };
+                                    readonly additionalProperties: false;
+                                };
+                                readonly neutral: {
+                                    readonly type: "object";
+                                    readonly properties: {
+                                        readonly hide: {
+                                            readonly type: "boolean";
+                                            readonly default: false;
+                                        };
+                                        readonly component: {
+                                            readonly type: "string";
+                                            readonly enum: readonly ["radio", "checkbox"];
+                                            readonly default: "checkbox";
+                                        };
+                                        readonly label: {
+                                            readonly type: "string";
+                                        };
+                                        readonly items: {
+                                            readonly type: "array";
+                                            readonly items: {
+                                                readonly type: "string";
+                                            };
+                                        };
+                                    };
+                                    readonly additionalProperties: false;
+                                };
+                                readonly dissatisfied: {
+                                    readonly type: "object";
+                                    readonly properties: {
+                                        readonly hide: {
+                                            readonly type: "boolean";
+                                            readonly default: false;
+                                        };
+                                        readonly component: {
+                                            readonly type: "string";
+                                            readonly enum: readonly ["radio", "checkbox"];
+                                            readonly default: "checkbox";
+                                        };
+                                        readonly label: {
+                                            readonly type: "string";
+                                        };
+                                        readonly items: {
+                                            readonly type: "array";
+                                            readonly items: {
+                                                readonly type: "string";
+                                            };
+                                        };
+                                    };
+                                    readonly additionalProperties: false;
+                                };
+                                readonly hide: {
+                                    readonly type: "boolean";
+                                    readonly default: false;
+                                };
+                                readonly component: {
+                                    readonly type: "string";
+                                    readonly enum: readonly ["radio", "checkbox"];
+                                    readonly default: "checkbox";
+                                };
+                                readonly label: {
+                                    readonly type: "string";
+                                };
+                                readonly items: {
+                                    readonly type: "array";
+                                    readonly items: {
+                                        readonly type: "string";
+                                    };
+                                };
+                            };
+                            readonly additionalProperties: false;
+                        };
+                        readonly comment: {
+                            readonly type: "object";
+                            readonly properties: {
+                                readonly hide: {
+                                    readonly type: "boolean";
+                                    readonly default: false;
+                                };
+                                readonly label: {
+                                    readonly type: "string";
+                                };
+                                readonly likeLabel: {
+                                    readonly type: "string";
+                                };
+                                readonly dislikeLabel: {
+                                    readonly type: "string";
+                                };
+                                readonly satisfiedLabel: {
+                                    readonly type: "string";
+                                };
+                                readonly neutralLabel: {
+                                    readonly type: "string";
+                                };
+                                readonly dissatisfiedLabel: {
+                                    readonly type: "string";
+                                };
+                            };
+                            readonly additionalProperties: false;
+                        };
+                        readonly optionalEmail: {
+                            readonly type: "object";
+                            readonly properties: {
+                                readonly hide: {
+                                    readonly type: "boolean";
+                                    readonly default: false;
+                                };
+                                readonly label: {
+                                    readonly type: "string";
+                                };
+                                readonly placeholder: {
+                                    readonly type: "string";
+                                };
+                            };
+                            readonly additionalProperties: false;
+                        };
+                    };
+                    readonly additionalProperties: false;
+                };
+            };
+            readonly additionalProperties: false;
+        };
+        readonly layout: {
+            readonly type: "string";
+            readonly enum: readonly ["stacked", "three-panel"];
+        };
+    };
+    readonly additionalProperties: false;
+};

package/lib/asyncapi-config-schema.js

@@ -0,0 +1,53 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.asyncapiConfigSchema = void 0;
+const feedback_config_schema_1 = require("./feedback-config-schema");
+const redoc_config_schema_1 = require("./redoc-config-schema");
+exports.asyncapiConfigSchema = {
+    type: 'object',
+    properties: {
+        downloadUrls: redoc_config_schema_1.downloadUrlsSchema,
+        apiLogo: {
+            type: 'object',
+            properties: {
+                imageUrl: {
+                    type: 'string',
+                },
+                href: {
+                    type: 'string',
+                },
+                altText: {
+                    type: 'string',
+                },
+                backgroundColor: {
+                    type: 'string',
+                },
+            },
+        },
+        jsonSamplesDepth: {
+            type: 'number',
+        },
+        samplesMaxInlineArgs: {
+            type: 'number',
+        },
+        fieldExpandLevel: {
+            type: 'number',
+        },
+        baseUrlPath: {
+            type: 'string',
+        },
+        metadata: {
+            type: 'object',
+            properties: {
+                apiId: {
+                    type: 'string',
+                },
+            },
+            additionalProperties: true,
+        },
+        feedback: feedback_config_schema_1.feedbackConfigSchema,
+        layout: { type: 'string', enum: ['stacked', 'three-panel'] },
+    },
+    additionalProperties: false,
+};
+//# sourceMappingURL=asyncapi-config-schema.js.map

package/lib/common.d.ts

@@ -1,28 +1,247 @@
-export declare const rulesSchema: {
-    readonly type: "object";
-    readonly additionalProperties: {
-        readonly oneOf: readonly [{
-            readonly type: "string";
-        }, {
-            readonly type: "object";
-        }];
-    };
-};
 export declare const ruleTypes: readonly ["rules", "oas2Rules", "oas3_0Rules", "oas3_1Rules", "oas3_2Rules", "async2Rules", "async3Rules", "arazzo1Rules", "overlay1Rules", "openrpc1Rules"];
 export type RuleTypes = (typeof ruleTypes)[number];
-export declare const ruleSchemas: Record<RuleTypes, typeof rulesSchema>;
 export declare const preprocessorTypes: readonly ["preprocessors", "oas2Preprocessors", "oas3_0Preprocessors", "oas3_1Preprocessors", "oas3_2Preprocessors", "async2Preprocessors", "async3Preprocessors", "arazzo1Preprocessors", "overlay1Preprocessors", "openrpc1Preprocessors"];
 export type PreprocessorTypes = (typeof preprocessorTypes)[number];
-declare const preprocessorSchema: {
-    readonly type: "object";
-    readonly additionalProperties: true;
-};
-export declare const preprocessorSchemas: Record<PreprocessorTypes, typeof preprocessorSchema>;
-export declare const decoratorsSchema: {
-    readonly type: "object";
-    readonly additionalProperties: true;
-};
 export declare const decoratorTypes: readonly ["decorators", "oas2Decorators", "oas3_0Decorators", "oas3_1Decorators", "oas3_2Decorators", "async2Decorators", "async3Decorators", "arazzo1Decorators", "overlay1Decorators", "openrpc1Decorators"];
 export type DecoratorTypes = (typeof decoratorTypes)[number];
-export declare const decoratorsSchemas: Record<DecoratorTypes, typeof decoratorsSchema>;
-export {};
+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";
+    };
+    preprocessors: {
+        readonly nodeTypeName: undefined;
+        readonly type: "object";
+        readonly additionalProperties: true;
+    };
+    oas2Preprocessors: {
+        readonly nodeTypeName: undefined;
+        readonly type: "object";
+        readonly additionalProperties: true;
+    };
+    oas3_0Preprocessors: {
+        readonly nodeTypeName: undefined;
+        readonly type: "object";
+        readonly additionalProperties: true;
+    };
+    oas3_1Preprocessors: {
+        readonly nodeTypeName: undefined;
+        readonly type: "object";
+        readonly additionalProperties: true;
+    };
+    oas3_2Preprocessors: {
+        readonly nodeTypeName: undefined;
+        readonly type: "object";
+        readonly additionalProperties: true;
+    };
+    async2Preprocessors: {
+        readonly nodeTypeName: undefined;
+        readonly type: "object";
+        readonly additionalProperties: true;
+    };
+    async3Preprocessors: {
+        readonly nodeTypeName: undefined;
+        readonly type: "object";
+        readonly additionalProperties: true;
+    };
+    arazzo1Preprocessors: {
+        readonly nodeTypeName: undefined;
+        readonly type: "object";
+        readonly additionalProperties: true;
+    };
+    overlay1Preprocessors: {
+        readonly nodeTypeName: undefined;
+        readonly type: "object";
+        readonly additionalProperties: true;
+    };
+    openrpc1Preprocessors: {
+        readonly nodeTypeName: undefined;
+        readonly type: "object";
+        readonly additionalProperties: true;
+    };
+    decorators: {
+        readonly nodeTypeName: undefined;
+        readonly type: "object";
+        readonly additionalProperties: true;
+    };
+    oas2Decorators: {
+        readonly nodeTypeName: undefined;
+        readonly type: "object";
+        readonly additionalProperties: true;
+    };
+    oas3_0Decorators: {
+        readonly nodeTypeName: undefined;
+        readonly type: "object";
+        readonly additionalProperties: true;
+    };
+    oas3_1Decorators: {
+        readonly nodeTypeName: undefined;
+        readonly type: "object";
+        readonly additionalProperties: true;
+    };
+    oas3_2Decorators: {
+        readonly nodeTypeName: undefined;
+        readonly type: "object";
+        readonly additionalProperties: true;
+    };
+    async2Decorators: {
+        readonly nodeTypeName: undefined;
+        readonly type: "object";
+        readonly additionalProperties: true;
+    };
+    async3Decorators: {
+        readonly nodeTypeName: undefined;
+        readonly type: "object";
+        readonly additionalProperties: true;
+    };
+    arazzo1Decorators: {
+        readonly nodeTypeName: undefined;
+        readonly type: "object";
+        readonly additionalProperties: true;
+    };
+    overlay1Decorators: {
+        readonly nodeTypeName: undefined;
+        readonly type: "object";
+        readonly additionalProperties: true;
+    };
+    openrpc1Decorators: {
+        readonly nodeTypeName: undefined;
+        readonly type: "object";
+        readonly additionalProperties: true;
+    };
+    rules: {
+        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";
+    };
+    oas2Rules: {
+        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";
+    };
+    oas3_0Rules: {
+        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";
+    };
+    oas3_1Rules: {
+        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";
+    };
+    oas3_2Rules: {
+        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";
+    };
+    async2Rules: {
+        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";
+    };
+    async3Rules: {
+        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";
+    };
+    arazzo1Rules: {
+        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";
+    };
+    overlay1Rules: {
+        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";
+    };
+    openrpc1Rules: {
+        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";
+    };
+};