@mongodb-js/compass-web 0.26.2 → 0.27.0

package/dist/compass-web.d.ts

@@ -966,26 +966,141 @@ declare enum ExperimentViewedEventName {
     EXPERIMENT_GHOSTVIEWED = "Experiment GhostViewed"
 }
 
-declare type FeatureFlags = {
-    enableOidc: boolean;
-    newExplainPlan: boolean;
-    showInsights: boolean;
-    enableExportSchema: boolean;
-    enableRenameCollectionModal: boolean;
-    enableProxySupport: boolean;
-    enableRollingIndexes: boolean;
-    showDisabledConnections: boolean;
-    enableGlobalWrites: boolean;
-    enableDataModeling: boolean;
-    enableIndexesGuidanceExp: boolean;
-    showIndexesGuidanceVariant: boolean;
-    enableContextMenus: boolean;
-    enableSearchActivationProgramP1: boolean;
-    enableUnauthenticatedGenAI: boolean;
-    enableAIAssistant: boolean;
-    enablePerformanceInsightsEntrypoints: boolean;
-    enableAutomaticRelationshipInference: boolean;
-};
+declare const FEATURE_FLAG_DEFINITIONS: readonly [{
+    readonly name: "enableOidc";
+    readonly stage: "released";
+    readonly atlasCloudFeatureFlagName: null;
+    readonly description: {
+        readonly short: "Enable OIDC Authentication";
+    };
+}, {
+    readonly name: "newExplainPlan";
+    readonly stage: "released";
+    readonly atlasCloudFeatureFlagName: null;
+    readonly description: {
+        readonly short: "Access explain plan from query bar";
+        readonly long: "Explain plan is now accessible right from the query bar. To view a query’s execution plan, click “Explain” as you would on an aggregation pipeline.";
+    };
+}, {
+    readonly name: "showInsights";
+    readonly stage: "released";
+    readonly atlasCloudFeatureFlagName: null;
+    readonly description: {
+        readonly short: "Show performance insights";
+        readonly long: "Surface visual signals in the Compass interface to highlight potential performance issues and anti-patterns.";
+    };
+}, {
+    readonly name: "enableRenameCollectionModal";
+    readonly stage: "released";
+    readonly atlasCloudFeatureFlagName: null;
+    readonly description: {
+        readonly short: "Enables renaming a collection";
+        readonly long: "Allows users to rename a collection from the sidebar";
+    };
+}, {
+    readonly name: "enableProxySupport";
+    readonly stage: "released";
+    readonly atlasCloudFeatureFlagName: null;
+    readonly description: {
+        readonly short: "Enables support for explicit proxy configuration.";
+        readonly long: "Allows users to specify proxy configuration for the entire Compass application.";
+    };
+}, {
+    readonly name: "showDisabledConnections";
+    readonly stage: "released";
+    readonly atlasCloudFeatureFlagName: null;
+    readonly description: {
+        readonly short: "Show clusters that are not in a \"connectable\" state in Atlas Cloud";
+    };
+}, {
+    readonly name: "enableRollingIndexes";
+    readonly stage: "released";
+    readonly atlasCloudFeatureFlagName: null;
+    readonly description: {
+        readonly short: "Enable creating indexes with the rolling build in Atlas Cloud";
+    };
+}, {
+    readonly name: "enableGlobalWrites";
+    readonly stage: "released";
+    readonly atlasCloudFeatureFlagName: null;
+    readonly description: {
+        readonly short: "Enable Global Writes tab in Atlas Cloud";
+    };
+}, {
+    readonly name: "enableExportSchema";
+    readonly stage: "released";
+    readonly atlasCloudFeatureFlagName: null;
+    readonly description: {
+        readonly short: "Enable schema export";
+    };
+}, {
+    readonly name: "enableDataModeling";
+    readonly stage: "development";
+    readonly atlasCloudFeatureFlagName: "DATA_EXPLORER_COMPASS_WEB_ENABLE_DATA_MODELING";
+    readonly description: {
+        readonly short: "Design, Visualize, and Evolve your Data Model";
+    };
+}, {
+    readonly name: "enableIndexesGuidanceExp";
+    readonly stage: "development";
+    readonly atlasCloudFeatureFlagName: null;
+    readonly description: {
+        readonly short: "Enable Indexes Guidance Experiment";
+    };
+}, {
+    readonly name: "showIndexesGuidanceVariant";
+    readonly stage: "development";
+    readonly atlasCloudFeatureFlagName: null;
+    readonly description: {
+        readonly short: "Used to check if user is in the Indexes Guidance Experiment Variant";
+    };
+}, {
+    readonly name: "enableContextMenus";
+    readonly stage: "released";
+    readonly atlasCloudFeatureFlagName: null;
+    readonly description: {
+        readonly short: "Enable context (right-click) menus";
+    };
+}, {
+    readonly name: "enableUnauthenticatedGenAI";
+    readonly stage: "released";
+    readonly atlasCloudFeatureFlagName: null;
+    readonly description: {
+        readonly short: "Enable GenAI for unauthenticated users";
+    };
+}, {
+    readonly name: "enableSearchActivationProgramP1";
+    readonly stage: "development";
+    readonly atlasCloudFeatureFlagName: null;
+    readonly description: {
+        readonly short: "Enable interface to view and modify search indexes";
+    };
+}, {
+    readonly name: "enableAIAssistant";
+    readonly stage: "released";
+    readonly atlasCloudFeatureFlagName: null;
+    readonly description: {
+        readonly short: "Enable AI Assistant";
+    };
+}, {
+    readonly name: "enablePerformanceInsightsEntrypoints";
+    readonly stage: "development";
+    readonly atlasCloudFeatureFlagName: null;
+    readonly description: {
+        readonly short: "Enable the performance insights AI Assistant entrypoints";
+    };
+}, {
+    readonly name: "enableAutomaticRelationshipInference";
+    readonly stage: "released";
+    readonly atlasCloudFeatureFlagName: null;
+    readonly description: {
+        readonly short: "Enable automatic relationship inference during data model generation";
+    };
+}];
+
+declare type FeatureFlagDefinitions = typeof FEATURE_FLAG_DEFINITIONS;
+
+declare type FeatureFlags = Record<FeatureFlagDefinitions[number]['name'], boolean>;
 
 declare type GetAssignmentFn = (experimentName: ExperimentTestName, trackIsInSample: boolean, options?: types.GetAssignmentOptions<types.TypeData>) => Promise<types.SDKAssignment<ExperimentTestName, string> | null>;