Update typescript types to include consent settings (#900)

segmentio · Jul 16, 2023 · 9c8b609 · 9c8b609
1 parent 6789f9b
commit 9c8b609
Show file tree

Hide file tree

Showing 2 changed files with 28 additions and 0 deletions.
diff --git a/.changeset/nervous-seals-remain.md b/.changeset/nervous-seals-remain.md
@@ -0,0 +1,5 @@
+---
+'@segment/analytics-next': patch
+---
+
+Add consent info to typescript types
diff --git a/packages/browser/src/browser/index.ts b/packages/browser/src/browser/index.ts
@@ -39,6 +39,17 @@ export interface LegacyIntegrationConfiguration {
 
   bundlingStatus?: string
 
+  /**
+   * Consent settings for the integration
+   */
+  consentSettings?: {
+    /**
+     * Consent categories for the integration
+     * @example ["Analytics", "Advertising", "CAT001"]
+     */
+    categories: string[]
+  }
+
   // Segment.io specific
   retryQueue?: boolean
 
@@ -64,6 +75,18 @@ export interface LegacySettings {
   legacyVideoPluginsEnabled?: boolean
 
   remotePlugins?: RemotePlugin[]
+
+  /**
+   * Top level consent settings
+   */
+  consentSettings?: {
+    /**
+     * All unique consent categories.
+     * There can be categories in this array that are important for consent that are not included in any integration  (e.g. 2 cloud mode categories).
+     * @example ["Analytics", "Advertising", "CAT001"]
+     */
+    allCategories: string[]
+  }
 }
 
 export interface AnalyticsBrowserSettings extends AnalyticsSettings {