@redocly/theme 0.16.0 → 0.17.1

package/lib/config.d.ts

@@ -72,6 +72,229 @@ declare const markdownConfigSchema: {
     readonly additionalProperties: false;
     readonly default: {};
 };
+declare const amplitudeAnalyticsConfigSchema: {
+    readonly type: "object";
+    readonly properties: {
+        readonly includeInDevelopment: {
+            readonly type: "boolean";
+        };
+        readonly apiKey: {
+            readonly type: "string";
+        };
+        readonly head: {
+            readonly type: "boolean";
+        };
+        readonly respectDNT: {
+            readonly type: "boolean";
+        };
+        readonly exclude: {
+            readonly type: "array";
+            readonly items: {
+                readonly type: "string";
+            };
+        };
+        readonly outboundClickEventName: {
+            readonly type: "string";
+        };
+        readonly pageViewEventName: {
+            readonly type: "string";
+        };
+        readonly amplitudeConfig: {
+            readonly type: "object";
+            readonly additionalProperties: true;
+        };
+    };
+    readonly additionalProperties: false;
+    readonly required: readonly ["apiKey"];
+};
+declare const rudderstackAnalyticsConfigSchema: {
+    readonly type: "object";
+    readonly properties: {
+        readonly includeInDevelopment: {
+            readonly type: "boolean";
+        };
+        readonly writeKey: {
+            readonly type: "string";
+            readonly minLength: 10;
+        };
+        readonly trackPage: {
+            readonly type: "boolean";
+        };
+        readonly dataPlaneUrl: {
+            readonly type: "string";
+        };
+        readonly controlPlaneUrl: {
+            readonly type: "string";
+        };
+        readonly sdkUrl: {
+            readonly type: "string";
+        };
+        readonly loadOptions: {
+            readonly type: "object";
+            readonly additionalProperties: true;
+        };
+    };
+    readonly additionalProperties: false;
+    readonly required: readonly ["writeKey"];
+};
+declare const segmentAnalyticsConfigSchema: {
+    readonly type: "object";
+    readonly properties: {
+        readonly includeInDevelopment: {
+            readonly type: "boolean";
+        };
+        readonly writeKey: {
+            readonly type: "string";
+            readonly minLength: 10;
+        };
+        readonly trackPage: {
+            readonly type: "boolean";
+        };
+        readonly includeTitleInPageCall: {
+            readonly type: "boolean";
+        };
+        readonly host: {
+            readonly type: "string";
+        };
+    };
+    readonly additionalProperties: false;
+    readonly required: readonly ["writeKey"];
+};
+declare const gtmAnalyticsConfigSchema: {
+    readonly type: "object";
+    readonly properties: {
+        readonly includeInDevelopment: {
+            readonly type: "boolean";
+        };
+        readonly trackingId: {
+            readonly type: "string";
+        };
+        readonly gtmAuth: {
+            readonly type: "string";
+        };
+        readonly gtmPreview: {
+            readonly type: "string";
+        };
+        readonly defaultDataLayer: {};
+        readonly dataLayerName: {
+            readonly type: "string";
+        };
+        readonly enableWebVitalsTracking: {
+            readonly type: "boolean";
+        };
+        readonly selfHostedOrigin: {
+            readonly type: "string";
+        };
+        readonly pageViewEventName: {
+            readonly type: "string";
+        };
+    };
+    readonly additionalProperties: false;
+    readonly required: readonly ["trackingId"];
+};
+declare const googleAnalyticsConfigSchema: {
+    readonly type: "object";
+    readonly properties: {
+        readonly includeInDevelopment: {
+            readonly type: "boolean";
+        };
+        readonly trackingId: {
+            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: {
+                readonly type: "string";
+            };
+        };
+        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 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"];
+};
 export declare const themeConfigSchema: {
     readonly type: "object";
     readonly properties: {
@@ -658,31 +881,21 @@ export declare const themeConfigSchema: {
         readonly codeSnippet: {
             readonly type: "object";
             readonly properties: {
+                readonly controlsStyle: {
+                    readonly type: "string";
+                    readonly default: "icon";
+                };
                 readonly copy: {
                     readonly type: "object";
                     readonly properties: {
                         readonly hide: {
                             readonly type: "boolean";
                         };
-                        readonly buttonText: {
-                            readonly type: "string";
-                            readonly default: "Copy";
-                        };
-                        readonly tooltipText: {
-                            readonly type: "string";
-                            readonly default: "Copy to clipboard";
-                        };
-                        readonly toasterText: {
-                            readonly type: "string";
-                            readonly default: "Copied!";
-                        };
-                        readonly toasterDuration: {
-                            readonly type: "number";
-                            readonly default: 1500;
-                        };
                     };
                     readonly additionalProperties: false;
-                    readonly default: {};
+                    readonly default: {
+                        readonly hide: false;
+                    };
                 };
                 readonly report: {
                     readonly type: "object";
@@ -690,17 +903,34 @@ export declare const themeConfigSchema: {
                         readonly hide: {
                             readonly type: "boolean";
                         };
-                        readonly tooltipText: {
-                            readonly type: "string";
-                            readonly default: "Report a problem";
+                    };
+                    readonly additionalProperties: false;
+                    readonly default: {
+                        readonly hide: true;
+                    };
+                };
+                readonly expand: {
+                    readonly type: "object";
+                    readonly properties: {
+                        readonly hide: {
+                            readonly type: "boolean";
                         };
-                        readonly label: {
-                            readonly type: "string";
+                    };
+                    readonly additionalProperties: false;
+                    readonly default: {
+                        readonly hide: false;
+                    };
+                };
+                readonly collapse: {
+                    readonly type: "object";
+                    readonly properties: {
+                        readonly hide: {
+                            readonly type: "boolean";
                         };
                     };
                     readonly additionalProperties: false;
                     readonly default: {
-                        readonly hide: true;
+                        readonly hide: false;
                     };
                 };
             };
@@ -787,7 +1017,274 @@ export declare const themeConfigSchema: {
             readonly additionalProperties: true;
         };
         readonly analytics: {
-            readonly type: readonly ["array", "boolean", "number", "object", "string"];
+            readonly type: "object";
+            readonly properties: {
+                readonly adobe: {
+                    readonly type: "object";
+                    readonly properties: {
+                        readonly includeInDevelopment: {
+                            readonly type: "boolean";
+                        };
+                        readonly scriptUrl: {
+                            readonly type: "string";
+                        };
+                        readonly pageViewEventName: {
+                            readonly type: "string";
+                        };
+                    };
+                    readonly additionalProperties: false;
+                    readonly required: readonly ["scriptUrl"];
+                };
+                readonly amplitude: {
+                    readonly type: "object";
+                    readonly properties: {
+                        readonly includeInDevelopment: {
+                            readonly type: "boolean";
+                        };
+                        readonly apiKey: {
+                            readonly type: "string";
+                        };
+                        readonly head: {
+                            readonly type: "boolean";
+                        };
+                        readonly respectDNT: {
+                            readonly type: "boolean";
+                        };
+                        readonly exclude: {
+                            readonly type: "array";
+                            readonly items: {
+                                readonly type: "string";
+                            };
+                        };
+                        readonly outboundClickEventName: {
+                            readonly type: "string";
+                        };
+                        readonly pageViewEventName: {
+                            readonly type: "string";
+                        };
+                        readonly amplitudeConfig: {
+                            readonly type: "object";
+                            readonly additionalProperties: true;
+                        };
+                    };
+                    readonly additionalProperties: false;
+                    readonly required: readonly ["apiKey"];
+                };
+                readonly fullstory: {
+                    readonly type: "object";
+                    readonly properties: {
+                        readonly includeInDevelopment: {
+                            readonly type: "boolean";
+                        };
+                        readonly orgId: {
+                            readonly type: "string";
+                        };
+                    };
+                    readonly additionalProperties: false;
+                    readonly required: readonly ["orgId"];
+                };
+                readonly heap: {
+                    readonly type: "object";
+                    readonly properties: {
+                        readonly includeInDevelopment: {
+                            readonly type: "boolean";
+                        };
+                        readonly appId: {
+                            readonly type: "string";
+                        };
+                    };
+                    readonly additionalProperties: false;
+                    readonly required: readonly ["appId"];
+                };
+                readonly rudderstack: {
+                    readonly type: "object";
+                    readonly properties: {
+                        readonly includeInDevelopment: {
+                            readonly type: "boolean";
+                        };
+                        readonly writeKey: {
+                            readonly type: "string";
+                            readonly minLength: 10;
+                        };
+                        readonly trackPage: {
+                            readonly type: "boolean";
+                        };
+                        readonly dataPlaneUrl: {
+                            readonly type: "string";
+                        };
+                        readonly controlPlaneUrl: {
+                            readonly type: "string";
+                        };
+                        readonly sdkUrl: {
+                            readonly type: "string";
+                        };
+                        readonly loadOptions: {
+                            readonly type: "object";
+                            readonly additionalProperties: true;
+                        };
+                    };
+                    readonly additionalProperties: false;
+                    readonly required: readonly ["writeKey"];
+                };
+                readonly segment: {
+                    readonly type: "object";
+                    readonly properties: {
+                        readonly includeInDevelopment: {
+                            readonly type: "boolean";
+                        };
+                        readonly writeKey: {
+                            readonly type: "string";
+                            readonly minLength: 10;
+                        };
+                        readonly trackPage: {
+                            readonly type: "boolean";
+                        };
+                        readonly includeTitleInPageCall: {
+                            readonly type: "boolean";
+                        };
+                        readonly host: {
+                            readonly type: "string";
+                        };
+                    };
+                    readonly additionalProperties: false;
+                    readonly required: readonly ["writeKey"];
+                };
+                readonly gtm: {
+                    readonly type: "object";
+                    readonly properties: {
+                        readonly includeInDevelopment: {
+                            readonly type: "boolean";
+                        };
+                        readonly trackingId: {
+                            readonly type: "string";
+                        };
+                        readonly gtmAuth: {
+                            readonly type: "string";
+                        };
+                        readonly gtmPreview: {
+                            readonly type: "string";
+                        };
+                        readonly defaultDataLayer: {};
+                        readonly dataLayerName: {
+                            readonly type: "string";
+                        };
+                        readonly enableWebVitalsTracking: {
+                            readonly type: "boolean";
+                        };
+                        readonly selfHostedOrigin: {
+                            readonly type: "string";
+                        };
+                        readonly pageViewEventName: {
+                            readonly type: "string";
+                        };
+                    };
+                    readonly additionalProperties: false;
+                    readonly required: readonly ["trackingId"];
+                };
+                readonly ga: {
+                    readonly type: "object";
+                    readonly properties: {
+                        readonly includeInDevelopment: {
+                            readonly type: "boolean";
+                        };
+                        readonly trackingId: {
+                            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: {
+                                readonly type: "string";
+                            };
+                        };
+                        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 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"];
+                };
+            };
         };
         readonly userProfile: {
             readonly type: "object";
@@ -883,4 +1380,9 @@ export type ThemeUIConfig = ThemeConfig & {
     };
 };
 export type MarkdownConfig = FromSchema<typeof markdownConfigSchema>;
+export type AmplitudeAnalyticsConfig = FromSchema<typeof amplitudeAnalyticsConfigSchema>;
+export type RudderstackAnalyticsConfig = FromSchema<typeof rudderstackAnalyticsConfigSchema>;
+export type SegmentAnalyticsConfig = FromSchema<typeof segmentAnalyticsConfigSchema>;
+export type GtmAnalyticsConfig = FromSchema<typeof gtmAnalyticsConfigSchema>;
+export type GoogleAnalyticsConfig = FromSchema<typeof googleAnalyticsConfigSchema>;
 export {};