@mongodb-js/compass-web 0.28.1 → 0.29.0

package/dist/compass-web.d.ts

@@ -1,4 +1,5 @@
 import { default as React_2 } from 'react';
+import { z } from '@mongodb-js/compass-user-data';
 
 /**
  * Valid statuses for activeOrLaunchedExperimentsToStatus
@@ -88,7 +89,7 @@ declare interface AsyncStatus {
     message?: string;
 }
 
-declare const ATLAS_CLOUD_FEATURE_FLAGS: "DATA_EXPLORER_COMPASS_WEB_ENABLE_DATA_MODELING"[];
+declare const ATLAS_CLOUD_FEATURE_FLAGS: NonNullable<"DATA_EXPLORER_COMPASS_WEB_ENABLE_DATA_MODELING" | "DATA_EXPLORER_COMPASS_WEB_ENABLE_RESTORE_WORKSPACES" | null>[];
 
 export declare type AtlasCloudFeatureFlags = Record<(typeof ATLAS_CLOUD_FEATURE_FLAGS)[number], boolean>;
 
@@ -174,6 +175,11 @@ export declare interface AtlasClusterMetadata {
          */
         rollingIndexes: boolean;
     };
+    /**
+     * User-friendly connection string for the Atlas cluster, which uses the SRV address if available.
+     * Otherwise, will default to <your-cluster> as a placeholder.
+     */
+    userConnectionString: string;
 }
 
 declare type AtlasOrgPreferences = {
@@ -222,14 +228,28 @@ declare type CliOnlyPreferences = {
     trustedConnectionString?: boolean;
 };
 
-declare type CollectionSubtab = 'Documents' | 'Aggregations' | 'Schema' | 'Indexes' | 'Validation' | 'GlobalWrites';
+declare type CollectionSubtab = z.output<typeof CollectionSubtabSchema>;
+
+declare const CollectionSubtabSchema: z.ZodEnum<["Documents", "Aggregations", "Schema", "Indexes", "Validation", "GlobalWrites"]>;
+
+declare type CollectionsWorkspace = z.output<typeof CollectionsWorkspaceSchema>;
 
-declare type CollectionsWorkspace = {
-    type: 'Collections';
+declare const CollectionsWorkspaceSchema: z.ZodObject<{
+    type: z.ZodLiteral<"Collections">;
+    connectionId: z.ZodString;
+    namespace: z.ZodString;
+    inferredFromPrivileges: z.ZodOptional<z.ZodBoolean>;
+}, "strip", z.ZodTypeAny, {
+    type: "Collections";
     connectionId: string;
     namespace: string;
-    inferredFromPrivileges?: boolean;
-};
+    inferredFromPrivileges?: boolean | undefined;
+}, {
+    type: "Collections";
+    connectionId: string;
+    namespace: string;
+    inferredFromPrivileges?: boolean | undefined;
+}>;
 
 export declare type CollectionTabInfo = {
     isTimeSeries: boolean;
@@ -238,19 +258,44 @@ export declare type CollectionTabInfo = {
     inferredFromPrivileges: boolean;
 };
 
-declare type CollectionWorkspace = {
+declare type CollectionWorkspace = z.output<typeof CollectionWorkspaceSchema> & {
     tabId: string;
-    type: 'Collection';
+};
+
+declare const CollectionWorkspaceSchema: z.ZodObject<{
+    type: z.ZodLiteral<"Collection">;
+    subTab: z.ZodEnum<["Documents", "Aggregations", "Schema", "Indexes", "Validation", "GlobalWrites"]>;
+    initialQuery: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodAny>>;
+    initialPipeline: z.ZodOptional<z.ZodArray<z.ZodUnknown, "many">>;
+    initialPipelineText: z.ZodOptional<z.ZodString>;
+    initialAggregation: z.ZodOptional<z.ZodUnknown>;
+    editViewName: z.ZodOptional<z.ZodString>;
+    connectionId: z.ZodString;
+    namespace: z.ZodString;
+    inferredFromPrivileges: z.ZodOptional<z.ZodBoolean>;
+}, "strip", z.ZodTypeAny, {
+    type: "Collection";
     connectionId: string;
     namespace: string;
-    subTab: CollectionSubtab;
-    initialQuery?: unknown;
-    initialPipeline?: unknown[];
-    initialPipelineText?: string;
+    subTab: "Documents" | "Aggregations" | "Schema" | "Indexes" | "Validation" | "GlobalWrites";
+    inferredFromPrivileges?: boolean | undefined;
+    initialQuery?: Record<string, any> | undefined;
+    initialPipeline?: unknown[] | undefined;
+    initialPipelineText?: string | undefined;
     initialAggregation?: unknown;
-    editViewName?: string;
-    inferredFromPrivileges?: boolean;
-};
+    editViewName?: string | undefined;
+}, {
+    type: "Collection";
+    connectionId: string;
+    namespace: string;
+    subTab: "Documents" | "Aggregations" | "Schema" | "Indexes" | "Validation" | "GlobalWrites";
+    inferredFromPrivileges?: boolean | undefined;
+    initialQuery?: Record<string, any> | undefined;
+    initialPipeline?: unknown[] | undefined;
+    initialPipelineText?: string | undefined;
+    initialAggregation?: unknown;
+    editViewName?: string | undefined;
+}>;
 
 export declare const CompassExperimentationProvider: React_2.FC<{
     children: React_2.ReactNode;
@@ -359,14 +404,28 @@ declare interface ConstructorOptions<T extends TypeData> {
     trackerOptions?: TrackerOptions<T['experimentViewedProps']>;
 }
 
-declare type DatabasesWorkspace = {
-    type: 'Databases';
+declare type DatabasesWorkspace = z.output<typeof DatabasesWorkspaceSchema>;
+
+declare const DatabasesWorkspaceSchema: z.ZodObject<{
+    type: z.ZodLiteral<"Databases">;
+    connectionId: z.ZodString;
+}, "strip", z.ZodTypeAny, {
+    type: "Databases";
     connectionId: string;
-};
+}, {
+    type: "Databases";
+    connectionId: string;
+}>;
 
-declare type DataModelingWorkspace = {
-    type: 'Data Modeling';
-};
+declare type DataModelingWorkspace = z.output<typeof DataModelingWorkspaceSchema>;
+
+declare const DataModelingWorkspaceSchema: z.ZodObject<{
+    type: z.ZodLiteral<"Data Modeling">;
+}, "strip", z.ZodTypeAny, {
+    type: "Data Modeling";
+}, {
+    type: "Data Modeling";
+}>;
 
 /** @public */
 export declare type DebugFunction = (...args: any[]) => void;
@@ -1045,7 +1104,7 @@ declare const FEATURE_FLAG_DEFINITIONS: readonly [{
     };
 }, {
     readonly name: "enableDataModeling";
-    readonly stage: "development";
+    readonly stage: "released";
     readonly atlasCloudFeatureFlagName: "DATA_EXPLORER_COMPASS_WEB_ENABLE_DATA_MODELING";
     readonly description: {
         readonly short: "Design, Visualize, and Evolve your Data Model";
@@ -1099,6 +1158,13 @@ declare const FEATURE_FLAG_DEFINITIONS: readonly [{
     readonly description: {
         readonly short: "Enable the performance insights AI Assistant entrypoints";
     };
+}, {
+    readonly name: "enableRestoreWorkspaces";
+    readonly stage: "development";
+    readonly atlasCloudFeatureFlagName: "DATA_EXPLORER_COMPASS_WEB_ENABLE_RESTORE_WORKSPACES";
+    readonly description: {
+        readonly short: "Enable restoring previous workspace tabs on startup";
+    };
 }, {
     readonly name: "enableAutomaticRelationshipInference";
     readonly stage: "released";
@@ -1257,9 +1323,15 @@ export declare type LogMessage = {
     attr?: any;
 };
 
-declare type MyQueriesWorkspace = {
-    type: 'My Queries';
-};
+declare type MyQueriesWorkspace = z.output<typeof MyQueriesWorkspaceSchema>;
+
+declare const MyQueriesWorkspaceSchema: z.ZodObject<{
+    type: z.ZodLiteral<"My Queries">;
+}, "strip", z.ZodTypeAny, {
+    type: "My Queries";
+}, {
+    type: "My Queries";
+}>;
 
 declare type NonUserPreferences = {
     ignoreAdditionalCommandLineFlags?: boolean;
@@ -1450,10 +1522,18 @@ declare interface ServerGhostAssignment<ExperimentName, ExperimentVariantName> e
     linkedHoldoutTestName: string;
 }
 
-declare type ServerStatsWorkspace = {
-    type: 'Performance';
+declare type ServerStatsWorkspace = z.output<typeof ServerStatsWorkspaceSchema>;
+
+declare const ServerStatsWorkspaceSchema: z.ZodObject<{
+    type: z.ZodLiteral<"Performance">;
+    connectionId: z.ZodString;
+}, "strip", z.ZodTypeAny, {
+    type: "Performance";
     connectionId: string;
-};
+}, {
+    type: "Performance";
+    connectionId: string;
+}>;
 
 /**
  * The different values of severity for logging
@@ -1464,12 +1544,24 @@ declare enum Severity {
     ERROR = "error"
 }
 
-declare type ShellWorkspace = {
-    type: 'Shell';
+declare type ShellWorkspace = z.output<typeof ShellWorkspaceSchema>;
+
+declare const ShellWorkspaceSchema: z.ZodObject<{
+    type: z.ZodLiteral<"Shell">;
+    connectionId: z.ZodString;
+    initialEvaluate: z.ZodOptional<z.ZodUnion<[z.ZodString, z.ZodArray<z.ZodString, "many">]>>;
+    initialInput: z.ZodOptional<z.ZodString>;
+}, "strip", z.ZodTypeAny, {
+    type: "Shell";
     connectionId: string;
-    initialEvaluate?: string | string[];
-    initialInput?: string;
-};
+    initialEvaluate?: string | string[] | undefined;
+    initialInput?: string | undefined;
+}, {
+    type: "Shell";
+    connectionId: string;
+    initialEvaluate?: string | string[] | undefined;
+    initialInput?: string | undefined;
+}>;
 
 declare const SORT_ORDER_VALUES: readonly ["", "{ _id: 1 }", "{ _id: -1 }", "{ $natural: -1 }"];
 
@@ -1742,7 +1834,7 @@ declare interface Tracker<ExperimentViewedProps> {
         maxTimeMS?: number;
         installURLHandlers: boolean;
         protectConnectionStringsForNewConnections: boolean;
-        atlasServiceBackendPreset: 'atlas-local' | 'atlas-dev' | 'atlas-qa' | 'atlas' | 'web-sandbox-atlas-local' | 'web-sandbox-atlas-dev' | 'web-sandbox-atlas-qa' | 'web-sandbox-atlas';
+        atlasServiceBackendPreset: 'atlas-local' | 'atlas-dev' | 'atlas-qa' | 'atlas-staging' | 'atlas' | 'web-sandbox-atlas-local' | 'web-sandbox-atlas-dev' | 'web-sandbox-atlas-qa' | 'web-sandbox-atlas';
         optInGenAIFeatures: boolean;
         enableExplainPlan: boolean;
         enableAtlasSearchIndexes: boolean;
@@ -1776,20 +1868,127 @@ declare interface Tracker<ExperimentViewedProps> {
         team?: LoggerTeam;
     }
 
-    declare type WelcomeWorkspace = {
-        type: 'Welcome';
-    };
+    declare type WelcomeWorkspace = z.output<typeof WelcomeWorkspaceSchema>;
+
+    declare const WelcomeWorkspaceSchema: z.ZodObject<{
+        type: z.ZodLiteral<"Welcome">;
+    }, "strip", z.ZodTypeAny, {
+        type: "Welcome";
+    }, {
+        type: "Welcome";
+    }>;
 
     declare type Workspace<T extends AnyWorkspace['type']> = Extract<AnyWorkspace, {
         type: T;
     }>;
 
-    export declare type WorkspaceTab = {
+    export declare type WorkspaceTab = z.output<typeof WorkspaceTabSchema>;
+
+    declare const WorkspaceTabSchema: z.ZodIntersection<z.ZodDiscriminatedUnion<"type", [z.ZodObject<{
+        type: z.ZodLiteral<"Welcome">;
+    }, "strip", z.ZodTypeAny, {
+        type: "Welcome";
+    }, {
+        type: "Welcome";
+    }>, z.ZodObject<{
+        type: z.ZodLiteral<"My Queries">;
+    }, "strip", z.ZodTypeAny, {
+        type: "My Queries";
+    }, {
+        type: "My Queries";
+    }>, z.ZodObject<{
+        type: z.ZodLiteral<"Data Modeling">;
+    }, "strip", z.ZodTypeAny, {
+        type: "Data Modeling";
+    }, {
+        type: "Data Modeling";
+    }>, z.ZodObject<{
+        type: z.ZodLiteral<"Databases">;
+        connectionId: z.ZodString;
+    }, "strip", z.ZodTypeAny, {
+        type: "Databases";
+        connectionId: string;
+    }, {
+        type: "Databases";
+        connectionId: string;
+    }>, z.ZodObject<{
+        type: z.ZodLiteral<"Performance">;
+        connectionId: z.ZodString;
+    }, "strip", z.ZodTypeAny, {
+        type: "Performance";
+        connectionId: string;
+    }, {
+        type: "Performance";
+        connectionId: string;
+    }>, z.ZodObject<{
+        type: z.ZodLiteral<"Shell">;
+        connectionId: z.ZodString;
+        initialEvaluate: z.ZodOptional<z.ZodUnion<[z.ZodString, z.ZodArray<z.ZodString, "many">]>>;
+        initialInput: z.ZodOptional<z.ZodString>;
+    }, "strip", z.ZodTypeAny, {
+        type: "Shell";
+        connectionId: string;
+        initialEvaluate?: string | string[] | undefined;
+        initialInput?: string | undefined;
+    }, {
+        type: "Shell";
+        connectionId: string;
+        initialEvaluate?: string | string[] | undefined;
+        initialInput?: string | undefined;
+    }>, z.ZodObject<{
+        type: z.ZodLiteral<"Collections">;
+        connectionId: z.ZodString;
+        namespace: z.ZodString;
+        inferredFromPrivileges: z.ZodOptional<z.ZodBoolean>;
+    }, "strip", z.ZodTypeAny, {
+        type: "Collections";
+        connectionId: string;
+        namespace: string;
+        inferredFromPrivileges?: boolean | undefined;
+    }, {
+        type: "Collections";
+        connectionId: string;
+        namespace: string;
+        inferredFromPrivileges?: boolean | undefined;
+    }>, z.ZodObject<{
+        type: z.ZodLiteral<"Collection">;
+        subTab: z.ZodEnum<["Documents", "Aggregations", "Schema", "Indexes", "Validation", "GlobalWrites"]>;
+        initialQuery: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodAny>>;
+        initialPipeline: z.ZodOptional<z.ZodArray<z.ZodUnknown, "many">>;
+        initialPipelineText: z.ZodOptional<z.ZodString>;
+        initialAggregation: z.ZodOptional<z.ZodUnknown>;
+        editViewName: z.ZodOptional<z.ZodString>;
+        connectionId: z.ZodString;
+        namespace: z.ZodString;
+        inferredFromPrivileges: z.ZodOptional<z.ZodBoolean>;
+    }, "strip", z.ZodTypeAny, {
+        type: "Collection";
+        connectionId: string;
+        namespace: string;
+        subTab: "Documents" | "Aggregations" | "Schema" | "Indexes" | "Validation" | "GlobalWrites";
+        inferredFromPrivileges?: boolean | undefined;
+        initialQuery?: Record<string, any> | undefined;
+        initialPipeline?: unknown[] | undefined;
+        initialPipelineText?: string | undefined;
+        initialAggregation?: unknown;
+        editViewName?: string | undefined;
+    }, {
+        type: "Collection";
+        connectionId: string;
+        namespace: string;
+        subTab: "Documents" | "Aggregations" | "Schema" | "Indexes" | "Validation" | "GlobalWrites";
+        inferredFromPrivileges?: boolean | undefined;
+        initialQuery?: Record<string, any> | undefined;
+        initialPipeline?: unknown[] | undefined;
+        initialPipelineText?: string | undefined;
+        initialAggregation?: unknown;
+        editViewName?: string | undefined;
+    }>]>, z.ZodObject<{
+        id: z.ZodString;
+    }, "strip", z.ZodTypeAny, {
         id: string;
-    } & WorkspaceTabProps;
-
-    declare type WorkspaceTabProps = WelcomeWorkspace | MyQueriesWorkspace | DataModelingWorkspace | ShellWorkspace | ServerStatsWorkspace | DatabasesWorkspace | CollectionsWorkspace | (Omit<CollectionWorkspace, 'tabId'> & {
-        subTab: CollectionSubtab;
-    });
+    }, {
+        id: string;
+    }>>;
 
     export { }