@redocly/theme 0.18.3 → 0.18.4-patch.1

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: {};
@@ -202,15 +195,18 @@ declare const googleAnalyticsConfigSchema: {
         readonly trackingId: {
             readonly type: "string";
         };
+        readonly conversionId: {
+            readonly type: "string";
+        };
+        readonly floodlightId: {
+            readonly type: "string";
+        };
         readonly head: {
             readonly type: "boolean";
         };
         readonly respectDNT: {
             readonly type: "boolean";
         };
-        readonly anonymize: {
-            readonly type: "boolean";
-        };
         readonly exclude: {
             readonly type: "array";
             readonly items: {
@@ -220,78 +216,12 @@ declare const googleAnalyticsConfigSchema: {
         readonly optimizeId: {
             readonly type: "string";
         };
-        readonly experimentId: {
-            readonly type: "string";
-        };
-        readonly variationId: {
-            readonly type: "string";
-        };
-        readonly enableWebVitalsTracking: {
-            readonly type: "boolean";
-        };
-        readonly defer: {
-            readonly type: "boolean";
-        };
-        readonly sampleRate: {
-            readonly type: "number";
-        };
-        readonly name: {
-            readonly type: "string";
-        };
-        readonly clientId: {
-            readonly type: "string";
-        };
-        readonly siteSpeedSampleRate: {
-            readonly type: "number";
-        };
-        readonly alwaysSendReferrer: {
-            readonly type: "boolean";
-        };
-        readonly allowAnchor: {
+        readonly anonymizeIp: {
             readonly type: "boolean";
         };
-        readonly cookieName: {
-            readonly type: "string";
-        };
-        readonly cookieFlags: {
-            readonly type: "string";
-        };
-        readonly cookieDomain: {
-            readonly type: "string";
-        };
         readonly cookieExpires: {
             readonly type: "number";
         };
-        readonly storeGac: {
-            readonly type: "boolean";
-        };
-        readonly legacyCookieDomain: {
-            readonly type: "string";
-        };
-        readonly legacyHistoryImport: {
-            readonly type: "boolean";
-        };
-        readonly allowLinker: {
-            readonly type: "boolean";
-        };
-        readonly storage: {
-            readonly type: "string";
-        };
-        readonly allowAdFeatures: {
-            readonly type: "boolean";
-        };
-        readonly dataSource: {
-            readonly type: "string";
-        };
-        readonly queueTime: {
-            readonly type: "number";
-        };
-        readonly forceSSL: {
-            readonly type: "boolean";
-        };
-        readonly transport: {
-            readonly type: "string";
-        };
     };
     readonly additionalProperties: false;
     readonly required: readonly ["trackingId"];
@@ -356,6 +286,20 @@ declare const scorecardConfigSchema: {
             readonly type: "boolean";
             readonly default: false;
         };
+        readonly teamMetadataProperty: {
+            readonly type: "object";
+            readonly properties: {
+                readonly property: {
+                    readonly type: "string";
+                };
+                readonly label: {
+                    readonly type: "string";
+                };
+                readonly default: {
+                    readonly type: "string";
+                };
+            };
+        };
         readonly levels: {
             readonly type: "array";
             readonly items: {
@@ -458,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: {
@@ -485,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";
                                 };
@@ -529,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";
                     };
@@ -592,6 +550,9 @@ export declare const themeConfigSchema: {
                 readonly image: {
                     readonly type: "string";
                 };
+                readonly srcSet: {
+                    readonly type: "string";
+                };
                 readonly altText: {
                     readonly type: "string";
                 };
@@ -637,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";
                                         };
@@ -681,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";
                             };
@@ -763,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";
                                         };
@@ -807,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";
                             };
@@ -837,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;
         };
@@ -846,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;
         };
@@ -1294,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: {};
@@ -1491,15 +1482,18 @@ export declare const themeConfigSchema: {
                         readonly trackingId: {
                             readonly type: "string";
                         };
+                        readonly conversionId: {
+                            readonly type: "string";
+                        };
+                        readonly floodlightId: {
+                            readonly type: "string";
+                        };
                         readonly head: {
                             readonly type: "boolean";
                         };
                         readonly respectDNT: {
                             readonly type: "boolean";
                         };
-                        readonly anonymize: {
-                            readonly type: "boolean";
-                        };
                         readonly exclude: {
                             readonly type: "array";
                             readonly items: {
@@ -1509,78 +1503,12 @@ export declare const themeConfigSchema: {
                         readonly optimizeId: {
                             readonly type: "string";
                         };
-                        readonly experimentId: {
-                            readonly type: "string";
-                        };
-                        readonly variationId: {
-                            readonly type: "string";
-                        };
-                        readonly enableWebVitalsTracking: {
+                        readonly anonymizeIp: {
                             readonly type: "boolean";
                         };
-                        readonly defer: {
-                            readonly type: "boolean";
-                        };
-                        readonly sampleRate: {
-                            readonly type: "number";
-                        };
-                        readonly name: {
-                            readonly type: "string";
-                        };
-                        readonly clientId: {
-                            readonly type: "string";
-                        };
-                        readonly siteSpeedSampleRate: {
-                            readonly type: "number";
-                        };
-                        readonly alwaysSendReferrer: {
-                            readonly type: "boolean";
-                        };
-                        readonly allowAnchor: {
-                            readonly type: "boolean";
-                        };
-                        readonly cookieName: {
-                            readonly type: "string";
-                        };
-                        readonly cookieFlags: {
-                            readonly type: "string";
-                        };
-                        readonly cookieDomain: {
-                            readonly type: "string";
-                        };
                         readonly cookieExpires: {
                             readonly type: "number";
                         };
-                        readonly storeGac: {
-                            readonly type: "boolean";
-                        };
-                        readonly legacyCookieDomain: {
-                            readonly type: "string";
-                        };
-                        readonly legacyHistoryImport: {
-                            readonly type: "boolean";
-                        };
-                        readonly allowLinker: {
-                            readonly type: "boolean";
-                        };
-                        readonly storage: {
-                            readonly type: "string";
-                        };
-                        readonly allowAdFeatures: {
-                            readonly type: "boolean";
-                        };
-                        readonly dataSource: {
-                            readonly type: "string";
-                        };
-                        readonly queueTime: {
-                            readonly type: "number";
-                        };
-                        readonly forceSSL: {
-                            readonly type: "boolean";
-                        };
-                        readonly transport: {
-                            readonly type: "string";
-                        };
                     };
                     readonly additionalProperties: false;
                     readonly required: readonly ["trackingId"];
@@ -1708,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: {
@@ -1735,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";
                                                 };
@@ -1779,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";
                                     };
@@ -1837,6 +1779,20 @@ export declare const themeConfigSchema: {
                     readonly type: "boolean";
                     readonly default: false;
                 };
+                readonly teamMetadataProperty: {
+                    readonly type: "object";
+                    readonly properties: {
+                        readonly property: {
+                            readonly type: "string";
+                        };
+                        readonly label: {
+                            readonly type: "string";
+                        };
+                        readonly default: {
+                            readonly type: "string";
+                        };
+                    };
+                };
                 readonly levels: {
                     readonly type: "array";
                     readonly items: {
@@ -1903,6 +1859,9 @@ export declare const productThemeOverrideSchema: {
                 readonly image: {
                     readonly type: "string";
                 };
+                readonly srcSet: {
+                    readonly type: "string";
+                };
                 readonly altText: {
                     readonly type: "string";
                 };
@@ -1948,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";
                                         };
@@ -1992,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";
                             };
@@ -2055,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";
                                         };
@@ -2099,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";
                             };
@@ -2129,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;
         };
@@ -2138,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;
         };
@@ -2312,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: {},
         },
@@ -172,35 +173,14 @@ const googleAnalyticsConfigSchema = {
     properties: {
         includeInDevelopment: { type: 'boolean' },
         trackingId: { type: 'string' },
+        conversionId: { type: 'string' },
+        floodlightId: { type: 'string' },
         head: { type: 'boolean' },
         respectDNT: { type: 'boolean' },
-        anonymize: { type: 'boolean' },
         exclude: { type: 'array', items: { type: 'string' } },
         optimizeId: { type: 'string' },
-        experimentId: { type: 'string' },
-        variationId: { type: 'string' },
-        enableWebVitalsTracking: { type: 'boolean' },
-        defer: { type: 'boolean' },
-        sampleRate: { type: 'number' },
-        name: { type: 'string' },
-        clientId: { type: 'string' },
-        siteSpeedSampleRate: { type: 'number' },
-        alwaysSendReferrer: { type: 'boolean' },
-        allowAnchor: { type: 'boolean' },
-        cookieName: { type: 'string' },
-        cookieFlags: { type: 'string' },
-        cookieDomain: { type: 'string' },
+        anonymizeIp: { type: 'boolean' },
         cookieExpires: { type: 'number' },
-        storeGac: { type: 'boolean' },
-        legacyCookieDomain: { type: 'string' },
-        legacyHistoryImport: { type: 'boolean' },
-        allowLinker: { type: 'boolean' },
-        storage: { type: 'string' },
-        allowAdFeatures: { type: 'boolean' },
-        dataSource: { type: 'string' },
-        queueTime: { type: 'number' },
-        forceSSL: { type: 'boolean' },
-        transport: { type: 'string' },
     },
     additionalProperties: false,
     required: ['trackingId'],
@@ -224,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' },
@@ -279,6 +264,14 @@ const scorecardConfigSchema = {
     required: ['levels'],
     properties: {
         failBuildIfBelowMinimum: { type: 'boolean', default: false },
+        teamMetadataProperty: {
+            type: 'object',
+            properties: {
+                property: { type: 'string' },
+                label: { type: 'string' },
+                default: { type: 'string' },
+            },
+        },
         levels: {
             type: 'array',
             items: {
@@ -326,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' },
@@ -361,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: {
@@ -571,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