@mongodb-js/compass-web 0.26.0 → 0.26.2
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
CHANGED
|
@@ -253,10 +253,11 @@ 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 */
|
|
259
|
-
export declare const CompassWeb: ({ appName, orgId, projectId, darkMode, initialAutoconnectId, initialWorkspace, onActiveWorkspaceTabChange, initialPreferences, onLog, onDebug, onTrack, onOpenConnectViaModal, onFailToLoadConnections, }: CompassWebProps) => React_2.JSX.Element;
|
|
260
|
+
export declare const CompassWeb: ({ appName, orgId, projectId, darkMode, initialAutoconnectId, initialWorkspace, onActiveWorkspaceTabChange, initialPreferences, onLog, onDebug, onTrack, onOpenConnectViaModal, onFailToLoadConnections, onBeforeUnloadCallbackRequest, }: CompassWebProps) => React_2.JSX.Element;
|
|
260
261
|
|
|
261
262
|
/** @public */
|
|
262
263
|
export declare type CompassWebProps = {
|
|
@@ -296,9 +297,9 @@ export declare type CompassWebProps = {
|
|
|
296
297
|
* communicate current workspace back to the parent component for example to
|
|
297
298
|
* sync router with the current active workspace
|
|
298
299
|
*/
|
|
299
|
-
onActiveWorkspaceTabChange<WS extends WorkspaceTab>(ws: WS | null, collectionInfo: WS extends {
|
|
300
|
+
onActiveWorkspaceTabChange: <WS extends WorkspaceTab>(ws: WS | null, collectionInfo: WS extends {
|
|
300
301
|
type: 'Collection';
|
|
301
|
-
} ? CollectionTabInfo | null : never)
|
|
302
|
+
} ? CollectionTabInfo | null : never) => void;
|
|
302
303
|
/**
|
|
303
304
|
* Set of initial preferences to override default values
|
|
304
305
|
*/
|
|
@@ -326,6 +327,12 @@ export declare type CompassWebProps = {
|
|
|
326
327
|
* Callback prop called when connections fail to load
|
|
327
328
|
*/
|
|
328
329
|
onFailToLoadConnections: (err: Error) => void;
|
|
330
|
+
/**
|
|
331
|
+
* Callback that will get passed another callback function that, when called,
|
|
332
|
+
* would return back true or false depending on whether or not tabs can be
|
|
333
|
+
* safely closed without losing any important unsaved changes
|
|
334
|
+
*/
|
|
335
|
+
onBeforeUnloadCallbackRequest?: (canCloseCallback: () => boolean) => void;
|
|
329
336
|
};
|
|
330
337
|
|
|
331
338
|
/**
|
|
@@ -943,12 +950,15 @@ declare type ExperimentSDKProviderProps<T extends TypeData> = React.PropsWithChi
|
|
|
943
950
|
|
|
944
951
|
export declare enum ExperimentTestGroup {
|
|
945
952
|
mockDataGeneratorVariant = "mockDataGeneratorVariant",
|
|
946
|
-
mockDataGeneratorControl = "mockDataGeneratorControl"
|
|
953
|
+
mockDataGeneratorControl = "mockDataGeneratorControl",
|
|
954
|
+
atlasSkillsVariant = "atlasSkillsVariant",
|
|
955
|
+
atlasSkillsControl = "atlasSkillsControl"
|
|
947
956
|
}
|
|
948
957
|
|
|
949
958
|
export declare enum ExperimentTestName {
|
|
950
959
|
earlyJourneyIndexesGuidance = "EARLY_JOURNEY_INDEXES_GUIDANCE_20250328",
|
|
951
|
-
mockDataGenerator = "MOCK_DATA_GENERATOR_20251001"
|
|
960
|
+
mockDataGenerator = "MOCK_DATA_GENERATOR_20251001",
|
|
961
|
+
atlasSkills = "ATLAS_SKILLS_EXPERIMENT_20251007"
|
|
952
962
|
}
|
|
953
963
|
|
|
954
964
|
declare enum ExperimentViewedEventName {
|
|
@@ -1048,6 +1058,14 @@ declare type InternalUserPreferences = {
|
|
|
1048
1058
|
enableConnectInNewWindow: boolean;
|
|
1049
1059
|
showEndOfLifeConnectionModal: boolean;
|
|
1050
1060
|
zoomLevel?: number;
|
|
1061
|
+
windowBounds?: {
|
|
1062
|
+
x?: number;
|
|
1063
|
+
y?: number;
|
|
1064
|
+
width?: number;
|
|
1065
|
+
height?: number;
|
|
1066
|
+
isMaximized?: boolean;
|
|
1067
|
+
isFullScreen?: boolean;
|
|
1068
|
+
};
|
|
1051
1069
|
};
|
|
1052
1070
|
|
|
1053
1071
|
/**
|
|
@@ -1616,10 +1634,13 @@ declare interface Tracker<ExperimentViewedProps> {
|
|
|
1616
1634
|
enableProxySupport: boolean;
|
|
1617
1635
|
proxy: string;
|
|
1618
1636
|
inferNamespacesFromPrivileges?: boolean;
|
|
1637
|
+
maxTimeMSEnvLimit?: number;
|
|
1619
1638
|
};
|
|
1620
1639
|
|
|
1621
1640
|
declare type UserPreferences = UserConfigurablePreferences & InternalUserPreferences & AtlasOrgPreferences & AtlasProjectPreferences;
|
|
1622
1641
|
|
|
1642
|
+
declare type UseTrackInSampleHook = (experimentName: ExperimentTestName, shouldFireEvent?: boolean, customProperties?: types.TypeData['experimentViewedProps'], team?: types.TypeData['loggerTeam']) => typesReact.BasicHookResponse;
|
|
1643
|
+
|
|
1623
1644
|
/**
|
|
1624
1645
|
* Config object passed into the {@link useTrackIsInSample} hook.
|
|
1625
1646
|
*/
|