@redocly/theme 0.18.6 → 0.19.0

package/lib/config.d.ts

@@ -58,13 +58,6 @@ declare const markdownConfigSchema: {
                 readonly baseUrl: {
                     readonly type: "string";
                 };
-                readonly icon: {
-                    readonly type: "string";
-                };
-                readonly text: {
-                    readonly type: "string";
-                    readonly default: "Edit this page";
-                };
             };
             readonly additionalProperties: false;
             readonly default: {};
@@ -409,6 +402,10 @@ declare const catalogSchema: {
         readonly groupByFirstFilter: {
             readonly type: "boolean";
         };
+        readonly filterValuesCasing: {
+            readonly type: "string";
+            readonly enum: readonly ["sentence", "original", "lowercase", "uppercase"];
+        };
         readonly items: {
             readonly type: "array";
             readonly items: {
@@ -436,6 +433,11 @@ declare const catalogSchema: {
                                 readonly separatorLine: {
                                     readonly type: "boolean";
                                 };
+                                readonly linePosition: {
+                                    readonly type: "string";
+                                    readonly enum: readonly ["top", "bottom"];
+                                    readonly default: "top";
+                                };
                                 readonly version: {
                                     readonly type: "string";
                                 };
@@ -480,6 +482,11 @@ declare const catalogSchema: {
                     readonly separatorLine: {
                         readonly type: "boolean";
                     };
+                    readonly linePosition: {
+                        readonly type: "string";
+                        readonly enum: readonly ["top", "bottom"];
+                        readonly default: "top";
+                    };
                     readonly version: {
                         readonly type: "string";
                     };
@@ -543,6 +550,9 @@ export declare const themeConfigSchema: {
                 readonly image: {
                     readonly type: "string";
                 };
+                readonly srcSet: {
+                    readonly type: "string";
+                };
                 readonly altText: {
                     readonly type: "string";
                 };
@@ -588,6 +598,11 @@ export declare const themeConfigSchema: {
                                         readonly separatorLine: {
                                             readonly type: "boolean";
                                         };
+                                        readonly linePosition: {
+                                            readonly type: "string";
+                                            readonly enum: readonly ["top", "bottom"];
+                                            readonly default: "top";
+                                        };
                                         readonly version: {
                                             readonly type: "string";
                                         };
@@ -632,6 +647,11 @@ export declare const themeConfigSchema: {
                             readonly separatorLine: {
                                 readonly type: "boolean";
                             };
+                            readonly linePosition: {
+                                readonly type: "string";
+                                readonly enum: readonly ["top", "bottom"];
+                                readonly default: "top";
+                            };
                             readonly version: {
                                 readonly type: "string";
                             };
@@ -714,6 +734,11 @@ export declare const themeConfigSchema: {
                                         readonly separatorLine: {
                                             readonly type: "boolean";
                                         };
+                                        readonly linePosition: {
+                                            readonly type: "string";
+                                            readonly enum: readonly ["top", "bottom"];
+                                            readonly default: "top";
+                                        };
                                         readonly version: {
                                             readonly type: "string";
                                         };
@@ -758,6 +783,11 @@ export declare const themeConfigSchema: {
                             readonly separatorLine: {
                                 readonly type: "boolean";
                             };
+                            readonly linePosition: {
+                                readonly type: "string";
+                                readonly enum: readonly ["top", "bottom"];
+                                readonly default: "top";
+                            };
                             readonly version: {
                                 readonly type: "string";
                             };
@@ -788,6 +818,15 @@ export declare const themeConfigSchema: {
                 readonly copyrightText: {
                     readonly type: "string";
                 };
+                readonly logo: {
+                    readonly type: "object";
+                    readonly properties: {
+                        readonly hide: {
+                            readonly type: "boolean";
+                        };
+                    };
+                    readonly additionalProperties: false;
+                };
             };
             readonly additionalProperties: false;
         };
@@ -797,6 +836,14 @@ export declare const themeConfigSchema: {
                 readonly hide: {
                     readonly type: "boolean";
                 };
+                readonly separatorLine: {
+                    readonly type: "boolean";
+                };
+                readonly linePosition: {
+                    readonly type: "string";
+                    readonly enum: readonly ["top", "bottom"];
+                    readonly default: "bottom";
+                };
             };
             readonly additionalProperties: false;
         };
@@ -1245,13 +1292,6 @@ export declare const themeConfigSchema: {
                         readonly baseUrl: {
                             readonly type: "string";
                         };
-                        readonly icon: {
-                            readonly type: "string";
-                        };
-                        readonly text: {
-                            readonly type: "string";
-                            readonly default: "Edit this page";
-                        };
                     };
                     readonly additionalProperties: false;
                     readonly default: {};
@@ -1596,6 +1636,10 @@ export declare const themeConfigSchema: {
                         readonly groupByFirstFilter: {
                             readonly type: "boolean";
                         };
+                        readonly filterValuesCasing: {
+                            readonly type: "string";
+                            readonly enum: readonly ["sentence", "original", "lowercase", "uppercase"];
+                        };
                         readonly items: {
                             readonly type: "array";
                             readonly items: {
@@ -1623,6 +1667,11 @@ export declare const themeConfigSchema: {
                                                 readonly separatorLine: {
                                                     readonly type: "boolean";
                                                 };
+                                                readonly linePosition: {
+                                                    readonly type: "string";
+                                                    readonly enum: readonly ["top", "bottom"];
+                                                    readonly default: "top";
+                                                };
                                                 readonly version: {
                                                     readonly type: "string";
                                                 };
@@ -1667,6 +1716,11 @@ export declare const themeConfigSchema: {
                                     readonly separatorLine: {
                                         readonly type: "boolean";
                                     };
+                                    readonly linePosition: {
+                                        readonly type: "string";
+                                        readonly enum: readonly ["top", "bottom"];
+                                        readonly default: "top";
+                                    };
                                     readonly version: {
                                         readonly type: "string";
                                     };
@@ -1805,6 +1859,9 @@ export declare const productThemeOverrideSchema: {
                 readonly image: {
                     readonly type: "string";
                 };
+                readonly srcSet: {
+                    readonly type: "string";
+                };
                 readonly altText: {
                     readonly type: "string";
                 };
@@ -1850,6 +1907,11 @@ export declare const productThemeOverrideSchema: {
                                         readonly separatorLine: {
                                             readonly type: "boolean";
                                         };
+                                        readonly linePosition: {
+                                            readonly type: "string";
+                                            readonly enum: readonly ["top", "bottom"];
+                                            readonly default: "top";
+                                        };
                                         readonly version: {
                                             readonly type: "string";
                                         };
@@ -1894,6 +1956,11 @@ export declare const productThemeOverrideSchema: {
                             readonly separatorLine: {
                                 readonly type: "boolean";
                             };
+                            readonly linePosition: {
+                                readonly type: "string";
+                                readonly enum: readonly ["top", "bottom"];
+                                readonly default: "top";
+                            };
                             readonly version: {
                                 readonly type: "string";
                             };
@@ -1957,6 +2024,11 @@ export declare const productThemeOverrideSchema: {
                                         readonly separatorLine: {
                                             readonly type: "boolean";
                                         };
+                                        readonly linePosition: {
+                                            readonly type: "string";
+                                            readonly enum: readonly ["top", "bottom"];
+                                            readonly default: "top";
+                                        };
                                         readonly version: {
                                             readonly type: "string";
                                         };
@@ -2001,6 +2073,11 @@ export declare const productThemeOverrideSchema: {
                             readonly separatorLine: {
                                 readonly type: "boolean";
                             };
+                            readonly linePosition: {
+                                readonly type: "string";
+                                readonly enum: readonly ["top", "bottom"];
+                                readonly default: "top";
+                            };
                             readonly version: {
                                 readonly type: "string";
                             };
@@ -2031,6 +2108,15 @@ export declare const productThemeOverrideSchema: {
                 readonly copyrightText: {
                     readonly type: "string";
                 };
+                readonly logo: {
+                    readonly type: "object";
+                    readonly properties: {
+                        readonly hide: {
+                            readonly type: "boolean";
+                        };
+                    };
+                    readonly additionalProperties: false;
+                };
             };
             readonly additionalProperties: false;
         };
@@ -2040,6 +2126,14 @@ export declare const productThemeOverrideSchema: {
                 readonly hide: {
                     readonly type: "boolean";
                 };
+                readonly separatorLine: {
+                    readonly type: "boolean";
+                };
+                readonly linePosition: {
+                    readonly type: "string";
+                    readonly enum: readonly ["top", "bottom"];
+                    readonly default: "bottom";
+                };
             };
             readonly additionalProperties: false;
         };
@@ -2214,4 +2308,9 @@ export type GoogleAnalyticsConfig = FromSchema<typeof googleAnalyticsConfigSchem
 export type CatalogConfig = FromSchema<typeof catalogSchema>;
 export type CatalogFilterConfig = FromSchema<typeof catalogFilterSchema>;
 export type ScorecardConfig = FromSchema<typeof scorecardConfigSchema>;
+export declare enum ScorecardStatus {
+    BelowMinimum = "Below minimum",
+    Highest = "Highest",
+    Minimum = "Minimum"
+}
 export {};

package/lib/config.js

@@ -1,10 +1,11 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.productThemeOverrideSchema = exports.themeConfigSchema = void 0;
+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' },
@@ -84,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: {},
         },
@@ -203,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' },
@@ -313,6 +319,10 @@ const catalogSchema = {
         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' },
@@ -348,10 +358,18 @@ 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: {
+            type: 'object',
+            properties: Object.assign({ separatorLine: { type: 'boolean' }, linePosition: {
+                    type: 'string',
+                    enum: ['top', 'bottom'],
+                    default: 'bottom',
+                } }, hideConfigSchema.properties),
             additionalProperties: false,
         },
-        sidebar: hideConfigSchema,
         scripts: {
             type: 'object',
             properties: {
@@ -558,4 +576,10 @@ exports.productThemeOverrideSchema = {
     additionalProperties: true,
     default: {},
 };
+var ScorecardStatus;
+(function (ScorecardStatus) {
+    ScorecardStatus["BelowMinimum"] = "Below minimum";
+    ScorecardStatus["Highest"] = "Highest";
+    ScorecardStatus["Minimum"] = "Minimum";
+})(ScorecardStatus = exports.ScorecardStatus || (exports.ScorecardStatus = {}));
 //# sourceMappingURL=config.js.map