@mongodb-js/compass-web 0.26.1 → 0.27.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/compass-web.d.ts +152 -22
- package/dist/index.js +22 -311
- package/dist/index.js.LICENSE.txt +0 -17
- package/dist/mongodb-js__compass-components.js +341 -4
- package/dist/mongodb-js__compass-components.js.LICENSE.txt +20 -0
- package/dist/tsdoc-metadata.json +1 -1
- package/package.json +35 -35
package/dist/compass-web.d.ts
CHANGED
|
@@ -253,6 +253,7 @@ export declare const CompassExperimentationProvider: React_2.FC<{
|
|
|
253
253
|
useAssignment: UseAssignmentHook;
|
|
254
254
|
assignExperiment: AssignExperimentFn;
|
|
255
255
|
getAssignment: GetAssignmentFn;
|
|
256
|
+
useTrackInSample: UseTrackInSampleHook;
|
|
256
257
|
}>;
|
|
257
258
|
|
|
258
259
|
/** @public */
|
|
@@ -949,12 +950,15 @@ declare type ExperimentSDKProviderProps<T extends TypeData> = React.PropsWithChi
|
|
|
949
950
|
|
|
950
951
|
export declare enum ExperimentTestGroup {
|
|
951
952
|
mockDataGeneratorVariant = "mockDataGeneratorVariant",
|
|
952
|
-
mockDataGeneratorControl = "mockDataGeneratorControl"
|
|
953
|
+
mockDataGeneratorControl = "mockDataGeneratorControl",
|
|
954
|
+
atlasSkillsVariant = "atlasSkillsVariant",
|
|
955
|
+
atlasSkillsControl = "atlasSkillsControl"
|
|
953
956
|
}
|
|
954
957
|
|
|
955
958
|
export declare enum ExperimentTestName {
|
|
956
959
|
earlyJourneyIndexesGuidance = "EARLY_JOURNEY_INDEXES_GUIDANCE_20250328",
|
|
957
|
-
mockDataGenerator = "MOCK_DATA_GENERATOR_20251001"
|
|
960
|
+
mockDataGenerator = "MOCK_DATA_GENERATOR_20251001",
|
|
961
|
+
atlasSkills = "ATLAS_SKILLS_EXPERIMENT_20251007"
|
|
958
962
|
}
|
|
959
963
|
|
|
960
964
|
declare enum ExperimentViewedEventName {
|
|
@@ -962,26 +966,141 @@ declare enum ExperimentViewedEventName {
|
|
|
962
966
|
EXPERIMENT_GHOSTVIEWED = "Experiment GhostViewed"
|
|
963
967
|
}
|
|
964
968
|
|
|
965
|
-
declare
|
|
966
|
-
|
|
967
|
-
|
|
968
|
-
|
|
969
|
-
|
|
970
|
-
|
|
971
|
-
|
|
972
|
-
|
|
973
|
-
|
|
974
|
-
|
|
975
|
-
|
|
976
|
-
|
|
977
|
-
|
|
978
|
-
|
|
979
|
-
|
|
980
|
-
|
|
981
|
-
|
|
982
|
-
|
|
983
|
-
|
|
984
|
-
|
|
969
|
+
declare const FEATURE_FLAG_DEFINITIONS: readonly [{
|
|
970
|
+
readonly name: "enableOidc";
|
|
971
|
+
readonly stage: "released";
|
|
972
|
+
readonly atlasCloudFeatureFlagName: null;
|
|
973
|
+
readonly description: {
|
|
974
|
+
readonly short: "Enable OIDC Authentication";
|
|
975
|
+
};
|
|
976
|
+
}, {
|
|
977
|
+
readonly name: "newExplainPlan";
|
|
978
|
+
readonly stage: "released";
|
|
979
|
+
readonly atlasCloudFeatureFlagName: null;
|
|
980
|
+
readonly description: {
|
|
981
|
+
readonly short: "Access explain plan from query bar";
|
|
982
|
+
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.";
|
|
983
|
+
};
|
|
984
|
+
}, {
|
|
985
|
+
readonly name: "showInsights";
|
|
986
|
+
readonly stage: "released";
|
|
987
|
+
readonly atlasCloudFeatureFlagName: null;
|
|
988
|
+
readonly description: {
|
|
989
|
+
readonly short: "Show performance insights";
|
|
990
|
+
readonly long: "Surface visual signals in the Compass interface to highlight potential performance issues and anti-patterns.";
|
|
991
|
+
};
|
|
992
|
+
}, {
|
|
993
|
+
readonly name: "enableRenameCollectionModal";
|
|
994
|
+
readonly stage: "released";
|
|
995
|
+
readonly atlasCloudFeatureFlagName: null;
|
|
996
|
+
readonly description: {
|
|
997
|
+
readonly short: "Enables renaming a collection";
|
|
998
|
+
readonly long: "Allows users to rename a collection from the sidebar";
|
|
999
|
+
};
|
|
1000
|
+
}, {
|
|
1001
|
+
readonly name: "enableProxySupport";
|
|
1002
|
+
readonly stage: "released";
|
|
1003
|
+
readonly atlasCloudFeatureFlagName: null;
|
|
1004
|
+
readonly description: {
|
|
1005
|
+
readonly short: "Enables support for explicit proxy configuration.";
|
|
1006
|
+
readonly long: "Allows users to specify proxy configuration for the entire Compass application.";
|
|
1007
|
+
};
|
|
1008
|
+
}, {
|
|
1009
|
+
readonly name: "showDisabledConnections";
|
|
1010
|
+
readonly stage: "released";
|
|
1011
|
+
readonly atlasCloudFeatureFlagName: null;
|
|
1012
|
+
readonly description: {
|
|
1013
|
+
readonly short: "Show clusters that are not in a \"connectable\" state in Atlas Cloud";
|
|
1014
|
+
};
|
|
1015
|
+
}, {
|
|
1016
|
+
readonly name: "enableRollingIndexes";
|
|
1017
|
+
readonly stage: "released";
|
|
1018
|
+
readonly atlasCloudFeatureFlagName: null;
|
|
1019
|
+
readonly description: {
|
|
1020
|
+
readonly short: "Enable creating indexes with the rolling build in Atlas Cloud";
|
|
1021
|
+
};
|
|
1022
|
+
}, {
|
|
1023
|
+
readonly name: "enableGlobalWrites";
|
|
1024
|
+
readonly stage: "released";
|
|
1025
|
+
readonly atlasCloudFeatureFlagName: null;
|
|
1026
|
+
readonly description: {
|
|
1027
|
+
readonly short: "Enable Global Writes tab in Atlas Cloud";
|
|
1028
|
+
};
|
|
1029
|
+
}, {
|
|
1030
|
+
readonly name: "enableExportSchema";
|
|
1031
|
+
readonly stage: "released";
|
|
1032
|
+
readonly atlasCloudFeatureFlagName: null;
|
|
1033
|
+
readonly description: {
|
|
1034
|
+
readonly short: "Enable schema export";
|
|
1035
|
+
};
|
|
1036
|
+
}, {
|
|
1037
|
+
readonly name: "enableDataModeling";
|
|
1038
|
+
readonly stage: "development";
|
|
1039
|
+
readonly atlasCloudFeatureFlagName: "DATA_EXPLORER_COMPASS_WEB_ENABLE_DATA_MODELING";
|
|
1040
|
+
readonly description: {
|
|
1041
|
+
readonly short: "Design, Visualize, and Evolve your Data Model";
|
|
1042
|
+
};
|
|
1043
|
+
}, {
|
|
1044
|
+
readonly name: "enableIndexesGuidanceExp";
|
|
1045
|
+
readonly stage: "development";
|
|
1046
|
+
readonly atlasCloudFeatureFlagName: null;
|
|
1047
|
+
readonly description: {
|
|
1048
|
+
readonly short: "Enable Indexes Guidance Experiment";
|
|
1049
|
+
};
|
|
1050
|
+
}, {
|
|
1051
|
+
readonly name: "showIndexesGuidanceVariant";
|
|
1052
|
+
readonly stage: "development";
|
|
1053
|
+
readonly atlasCloudFeatureFlagName: null;
|
|
1054
|
+
readonly description: {
|
|
1055
|
+
readonly short: "Used to check if user is in the Indexes Guidance Experiment Variant";
|
|
1056
|
+
};
|
|
1057
|
+
}, {
|
|
1058
|
+
readonly name: "enableContextMenus";
|
|
1059
|
+
readonly stage: "released";
|
|
1060
|
+
readonly atlasCloudFeatureFlagName: null;
|
|
1061
|
+
readonly description: {
|
|
1062
|
+
readonly short: "Enable context (right-click) menus";
|
|
1063
|
+
};
|
|
1064
|
+
}, {
|
|
1065
|
+
readonly name: "enableUnauthenticatedGenAI";
|
|
1066
|
+
readonly stage: "released";
|
|
1067
|
+
readonly atlasCloudFeatureFlagName: null;
|
|
1068
|
+
readonly description: {
|
|
1069
|
+
readonly short: "Enable GenAI for unauthenticated users";
|
|
1070
|
+
};
|
|
1071
|
+
}, {
|
|
1072
|
+
readonly name: "enableSearchActivationProgramP1";
|
|
1073
|
+
readonly stage: "development";
|
|
1074
|
+
readonly atlasCloudFeatureFlagName: null;
|
|
1075
|
+
readonly description: {
|
|
1076
|
+
readonly short: "Enable interface to view and modify search indexes";
|
|
1077
|
+
};
|
|
1078
|
+
}, {
|
|
1079
|
+
readonly name: "enableAIAssistant";
|
|
1080
|
+
readonly stage: "released";
|
|
1081
|
+
readonly atlasCloudFeatureFlagName: null;
|
|
1082
|
+
readonly description: {
|
|
1083
|
+
readonly short: "Enable AI Assistant";
|
|
1084
|
+
};
|
|
1085
|
+
}, {
|
|
1086
|
+
readonly name: "enablePerformanceInsightsEntrypoints";
|
|
1087
|
+
readonly stage: "development";
|
|
1088
|
+
readonly atlasCloudFeatureFlagName: null;
|
|
1089
|
+
readonly description: {
|
|
1090
|
+
readonly short: "Enable the performance insights AI Assistant entrypoints";
|
|
1091
|
+
};
|
|
1092
|
+
}, {
|
|
1093
|
+
readonly name: "enableAutomaticRelationshipInference";
|
|
1094
|
+
readonly stage: "released";
|
|
1095
|
+
readonly atlasCloudFeatureFlagName: null;
|
|
1096
|
+
readonly description: {
|
|
1097
|
+
readonly short: "Enable automatic relationship inference during data model generation";
|
|
1098
|
+
};
|
|
1099
|
+
}];
|
|
1100
|
+
|
|
1101
|
+
declare type FeatureFlagDefinitions = typeof FEATURE_FLAG_DEFINITIONS;
|
|
1102
|
+
|
|
1103
|
+
declare type FeatureFlags = Record<FeatureFlagDefinitions[number]['name'], boolean>;
|
|
985
1104
|
|
|
986
1105
|
declare type GetAssignmentFn = (experimentName: ExperimentTestName, trackIsInSample: boolean, options?: types.GetAssignmentOptions<types.TypeData>) => Promise<types.SDKAssignment<ExperimentTestName, string> | null>;
|
|
987
1106
|
|
|
@@ -1054,6 +1173,14 @@ declare type InternalUserPreferences = {
|
|
|
1054
1173
|
enableConnectInNewWindow: boolean;
|
|
1055
1174
|
showEndOfLifeConnectionModal: boolean;
|
|
1056
1175
|
zoomLevel?: number;
|
|
1176
|
+
windowBounds?: {
|
|
1177
|
+
x?: number;
|
|
1178
|
+
y?: number;
|
|
1179
|
+
width?: number;
|
|
1180
|
+
height?: number;
|
|
1181
|
+
isMaximized?: boolean;
|
|
1182
|
+
isFullScreen?: boolean;
|
|
1183
|
+
};
|
|
1057
1184
|
};
|
|
1058
1185
|
|
|
1059
1186
|
/**
|
|
@@ -1622,10 +1749,13 @@ declare interface Tracker<ExperimentViewedProps> {
|
|
|
1622
1749
|
enableProxySupport: boolean;
|
|
1623
1750
|
proxy: string;
|
|
1624
1751
|
inferNamespacesFromPrivileges?: boolean;
|
|
1752
|
+
maxTimeMSEnvLimit?: number;
|
|
1625
1753
|
};
|
|
1626
1754
|
|
|
1627
1755
|
declare type UserPreferences = UserConfigurablePreferences & InternalUserPreferences & AtlasOrgPreferences & AtlasProjectPreferences;
|
|
1628
1756
|
|
|
1757
|
+
declare type UseTrackInSampleHook = (experimentName: ExperimentTestName, shouldFireEvent?: boolean, customProperties?: types.TypeData['experimentViewedProps'], team?: types.TypeData['loggerTeam']) => typesReact.BasicHookResponse;
|
|
1758
|
+
|
|
1629
1759
|
/**
|
|
1630
1760
|
* Config object passed into the {@link useTrackIsInSample} hook.
|
|
1631
1761
|
*/
|