@mongodb-js/compass-web 0.7.0 → 0.8.1

package/dist/connection-storage.d.ts

@@ -10,12 +10,13 @@ type RegionConfig = {
 type ReplicationSpec = {
     regionConfigs: RegionConfig[];
 };
+type ClusterType = 'REPLICASET' | 'SHARDED' | 'GEOSHARDED';
 type ClusterDescription = {
     '@provider': string;
     uniqueId: string;
     groupId: string;
     name: string;
-    clusterType: string;
+    clusterType: ClusterType;
     srvAddress: string;
     state: string;
     deploymentItemName: string;
@@ -55,14 +56,21 @@ export declare function buildConnectionInfoFromClusterDescription(driverProxyEnd
     };
     atlasMetadata: {
         instanceSize: string | undefined;
-        clusterId: string;
-        clusterType: "serverless" | "replicaSet" | "cluster";
+        clusterType: ClusterType;
+        metricsId: string;
+        metricsType: "serverless" | "replicaSet" | "cluster";
         orgId: string;
         projectId: string;
+        clusterUniqueId: string;
         clusterName: string;
         regionalBaseUrl: string;
     };
 };
+/**
+ * Only used in the sandbox to provide connection info when connecting to the
+ * non-Atlas deployment
+ * @internal
+ */
 export declare const SandboxConnectionStorageProviver: React.Provider<ConnectionStorage | null>;
 export declare const AtlasCloudConnectionStorageProvider: ({ orgId, projectId, children, }: {
     orgId: string;

package/dist/connection-storage.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"connection-storage.d.ts","sourceRoot":"","sources":["../src/connection-storage.tsx"],"names":[],"mappings":"AAAA,OAAO,KAA6B,MAAM,OAAO,CAAC;AAClD,OAAO,KAAK,EACV,iBAAiB,EAElB,MAAM,yCAAyC,CAAC;AAUjD,KAAK,cAAc,GAAG;IACpB,YAAY,CAAC,EAAE,MAAM,CAAC;CACvB,CAAC;AAEF,KAAK,YAAY,GAAG;IAClB,QAAQ,EAAE,MAAM,CAAC;IACjB,cAAc,EAAE,cAAc,CAAC;CAChC,CAAC;AAEF,KAAK,eAAe,GAAG;IACrB,aAAa,EAAE,YAAY,EAAE,CAAC;CAC/B,CAAC;AAEF,KAAK,kBAAkB,GAAG;IACxB,WAAW,EAAE,MAAM,CAAC;IACpB,QAAQ,EAAE,MAAM,CAAC;IACjB,OAAO,EAAE,MAAM,CAAC;IAChB,IAAI,EAAE,MAAM,CAAC;IACb,WAAW,EAAE,MAAM,CAAC;IACpB,UAAU,EAAE,MAAM,CAAC;IACnB,KAAK,EAAE,MAAM,CAAC;IACd,kBAAkB,EAAE,MAAM,CAAC;IAC3B,mBAAmB,CAAC,EAAE,eAAe,EAAE,CAAC;CACzC,CAAC;AAEF,MAAM,MAAM,0CAA0C,GAAG,kBAAkB,GAAG;IAC5E,oBAAoB,EAAE;QAAE,WAAW,EAAE,MAAM,CAAA;KAAE,CAAC;CAC/C,CAAC;AAEF,KAAK,wBAAwB,GAAG;IAC9B,GAAG,EAAE,MAAM,CAAC;IACZ,KAAK,EAAE;QACL,SAAS,EAAE,MAAM,CAAC;KACnB,CAAC;CACH,CAAC;AAEF,KAAK,sBAAsB,GAAG;IAC5B,IAAI,EAAE,MAAM,CAAC;IACb,KAAK,EAAE;QACL,SAAS,EAAE,MAAM,CAAC;KACnB,CAAC;CACH,CAAC;AAEF,KAAK,UAAU,GAAG;IAChB,WAAW,CAAC,EAAE,wBAAwB,EAAE,CAAC;IACzC,QAAQ,CAAC,EAAE,sBAAsB,EAAE,CAAC;CACrC,CAAC;AAsFF,wBAAgB,yCAAyC,CACvD,mBAAmB,EAAE,MAAM,EAC3B,KAAK,EAAE,MAAM,EACb,SAAS,EAAE,MAAM,EACjB,WAAW,EAAE,0CAA0C,EACvD,UAAU,EAAE,UAAU;;;;;;;;;;;;;;;;;;;;EAiDvB;AA8FD,eAAO,MAAM,gCAAgC,0CACH,CAAC;AAE3C,eAAO,MAAM,mCAAmC;WAMrC,MAAM;eACF,MAAM;cACP,MAAM,UAAU;iBAiB7B,CAAC"}
+{"version":3,"file":"connection-storage.d.ts","sourceRoot":"","sources":["../src/connection-storage.tsx"],"names":[],"mappings":"AAAA,OAAO,KAA6B,MAAM,OAAO,CAAC;AAClD,OAAO,KAAK,EACV,iBAAiB,EAElB,MAAM,yCAAyC,CAAC;AAUjD,KAAK,cAAc,GAAG;IACpB,YAAY,CAAC,EAAE,MAAM,CAAC;CACvB,CAAC;AAEF,KAAK,YAAY,GAAG;IAClB,QAAQ,EAAE,MAAM,CAAC;IACjB,cAAc,EAAE,cAAc,CAAC;CAChC,CAAC;AAEF,KAAK,eAAe,GAAG;IACrB,aAAa,EAAE,YAAY,EAAE,CAAC;CAC/B,CAAC;AAEF,KAAK,WAAW,GAAG,YAAY,GAAG,SAAS,GAAG,YAAY,CAAC;AAE3D,KAAK,kBAAkB,GAAG;IACxB,WAAW,EAAE,MAAM,CAAC;IACpB,QAAQ,EAAE,MAAM,CAAC;IACjB,OAAO,EAAE,MAAM,CAAC;IAChB,IAAI,EAAE,MAAM,CAAC;IACb,WAAW,EAAE,WAAW,CAAC;IACzB,UAAU,EAAE,MAAM,CAAC;IACnB,KAAK,EAAE,MAAM,CAAC;IACd,kBAAkB,EAAE,MAAM,CAAC;IAC3B,mBAAmB,CAAC,EAAE,eAAe,EAAE,CAAC;CACzC,CAAC;AAEF,MAAM,MAAM,0CAA0C,GAAG,kBAAkB,GAAG;IAC5E,oBAAoB,EAAE;QAAE,WAAW,EAAE,MAAM,CAAA;KAAE,CAAC;CAC/C,CAAC;AAEF,KAAK,wBAAwB,GAAG;IAC9B,GAAG,EAAE,MAAM,CAAC;IACZ,KAAK,EAAE;QACL,SAAS,EAAE,MAAM,CAAC;KACnB,CAAC;CACH,CAAC;AAEF,KAAK,sBAAsB,GAAG;IAC5B,IAAI,EAAE,MAAM,CAAC;IACb,KAAK,EAAE;QACL,SAAS,EAAE,MAAM,CAAC;KACnB,CAAC;CACH,CAAC;AAEF,KAAK,UAAU,GAAG;IAChB,WAAW,CAAC,EAAE,wBAAwB,EAAE,CAAC;IACzC,QAAQ,CAAC,EAAE,sBAAsB,EAAE,CAAC;CACrC,CAAC;AAqFF,wBAAgB,yCAAyC,CACvD,mBAAmB,EAAE,MAAM,EAC3B,KAAK,EAAE,MAAM,EACb,SAAS,EAAE,MAAM,EACjB,WAAW,EAAE,0CAA0C,EACvD,UAAU,EAAE,UAAU;;;;;;;;;;;;;;;;;;;;;;EAmDvB;AA6FD;;;;GAIG;AACH,eAAO,MAAM,gCAAgC,0CACH,CAAC;AAE3C,eAAO,MAAM,mCAAmC;WAMrC,MAAM;eACF,MAAM;cACP,MAAM,UAAU;iBAiB7B,CAAC"}

package/dist/entrypoint.d.ts

@@ -5,17 +5,65 @@ import WorkspacesPlugin from '@mongodb-js/compass-workspaces';
 import type { AllPreferences } from 'compass-preferences-model/provider';
 import type { TrackFunction, LogFunction, DebugFunction } from './logger-and-telemetry';
 type CompassWebProps = {
+    /**
+     * App name to be passed with the connection string when connection to a
+     * cluster (default: "Compass Web")
+     */
     appName?: string;
+    /**
+     * Atlas Cloud organization id
+     */
     orgId: string;
+    /**
+     * Atlas Cloud project id (sometimes called group id)
+     */
     projectId: string;
+    /**
+     * Whether or not darkMode should be active for the app
+     */
     darkMode?: boolean;
+    /**
+     * Optional. If passed, compass-web will try to find connection info with that
+     * id in connection storage and pass it as autoconnect info to the
+     * compass-connections
+     */
     initialAutoconnectId?: string;
+    /**
+     * Optional. If passed, compass-web will open provided workspace right away.
+     * If workspace requires active connection, the connectionId from the
+     * workspace will be used for the autoconnect info getter. In that case
+     * connectionId from the workspace takes precedence over
+     * `initialAutoconnectId`
+     */
     initialWorkspace?: OpenWorkspaceOptions;
+    /**
+     * Callback prop called when current active workspace changes. Can be used to
+     * communicate current workspace back to the parent component for example to
+     * sync router with the current active workspace
+     */
     onActiveWorkspaceTabChange: React.ComponentProps<typeof WorkspacesPlugin>['onActiveWorkspaceTabChange'];
+    /**
+     * Set of initial preferences to override default values
+     */
     initialPreferences?: Partial<AllPreferences>;
+    /**
+     * Callback prop called every time any code inside Compass logs something
+     */
     onLog?: LogFunction;
+    /**
+     * Callback prop called every time any code inside Compass prints a debug
+     * statement
+     */
     onDebug?: DebugFunction;
+    /**
+     * Callback prop called for every track event inside Compass
+     */
     onTrack?: TrackFunction;
+    /**
+     * Callback prop that will be called with atlas metadata for a certain cluster
+     * when the action is selected from the sidebar actions. Should be used to
+     * show the Atlas Cloud "Connect" modal
+     */
     onOpenConnectViaModal?: (atlasMetadata: ConnectionInfo['atlasMetadata']) => void;
 };
 declare const CompassWeb: ({ appName, orgId, projectId, darkMode, initialAutoconnectId, initialWorkspace, onActiveWorkspaceTabChange, initialPreferences, onLog, onDebug, onTrack, onOpenConnectViaModal, }: CompassWebProps) => JSX.Element;

package/dist/entrypoint.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"entrypoint.d.ts","sourceRoot":"","sources":["../src/entrypoint.tsx"],"names":[],"mappings":"AAAA,OAAO,KAA4B,MAAM,OAAO,CAAC;AAKjD,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,0CAA0C,CAAC;AAG/E,OAAO,KAAK,EAAE,oBAAoB,EAAE,MAAM,gCAAgC,CAAC;AAC3E,OAAO,gBAEN,MAAM,gCAAgC,CAAC;AAmCxC,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,oCAAoC,CAAC;AASzE,OAAO,KAAK,EACV,aAAa,EACb,WAAW,EACX,aAAa,EACd,MAAM,wBAAwB,CAAC;AAwBhC,KAAK,eAAe,GAAG;IAKrB,OAAO,CAAC,EAAE,MAAM,CAAC;IAKjB,KAAK,EAAE,MAAM,CAAC;IAId,SAAS,EAAE,MAAM,CAAC;IAKlB,QAAQ,CAAC,EAAE,OAAO,CAAC;IAOnB,oBAAoB,CAAC,EAAE,MAAM,CAAC;IAQ9B,gBAAgB,CAAC,EAAE,oBAAoB,CAAC;IAMxC,0BAA0B,EAAE,KAAK,CAAC,cAAc,CAC9C,OAAO,gBAAgB,CACxB,CAAC,4BAA4B,CAAC,CAAC;IAKhC,kBAAkB,CAAC,EAAE,OAAO,CAAC,cAAc,CAAC,CAAC;IAK7C,KAAK,CAAC,EAAE,WAAW,CAAC;IAKpB,OAAO,CAAC,EAAE,aAAa,CAAC;IAIxB,OAAO,CAAC,EAAE,aAAa,CAAC;IAOxB,qBAAqB,CAAC,EAAE,CACtB,aAAa,EAAE,cAAc,CAAC,eAAe,CAAC,KAC3C,IAAI,CAAC;CACX,CAAC;AA2FF,QAAA,MAAM,UAAU,qLAab,eAAe,gBA4HjB,CAAC;AAEF,OAAO,EAAE,UAAU,EAAE,CAAC"}
+{"version":3,"file":"entrypoint.d.ts","sourceRoot":"","sources":["../src/entrypoint.tsx"],"names":[],"mappings":"AAAA,OAAO,KAA4B,MAAM,OAAO,CAAC;AAKjD,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,0CAA0C,CAAC;AAG/E,OAAO,KAAK,EAAE,oBAAoB,EAAE,MAAM,gCAAgC,CAAC;AAC3E,OAAO,gBAEN,MAAM,gCAAgC,CAAC;AAgCxC,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,oCAAoC,CAAC;AASzE,OAAO,KAAK,EACV,aAAa,EACb,WAAW,EACX,aAAa,EACd,MAAM,wBAAwB,CAAC;AAwBhC,KAAK,eAAe,GAAG;IACrB;;;OAGG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;IAEjB;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;IACd;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,QAAQ,CAAC,EAAE,OAAO,CAAC;IAEnB;;;;OAIG;IACH,oBAAoB,CAAC,EAAE,MAAM,CAAC;IAC9B;;;;;;OAMG;IACH,gBAAgB,CAAC,EAAE,oBAAoB,CAAC;IACxC;;;;OAIG;IACH,0BAA0B,EAAE,KAAK,CAAC,cAAc,CAC9C,OAAO,gBAAgB,CACxB,CAAC,4BAA4B,CAAC,CAAC;IAEhC;;OAEG;IACH,kBAAkB,CAAC,EAAE,OAAO,CAAC,cAAc,CAAC,CAAC;IAE7C;;OAEG;IACH,KAAK,CAAC,EAAE,WAAW,CAAC;IACpB;;;OAGG;IACH,OAAO,CAAC,EAAE,aAAa,CAAC;IACxB;;OAEG;IACH,OAAO,CAAC,EAAE,aAAa,CAAC;IAExB;;;;OAIG;IACH,qBAAqB,CAAC,EAAE,CACtB,aAAa,EAAE,cAAc,CAAC,eAAe,CAAC,KAC3C,IAAI,CAAC;CACX,CAAC;AA0FF,QAAA,MAAM,UAAU,qLAab,eAAe,gBA6HjB,CAAC;AAEF,OAAO,EAAE,UAAU,EAAE,CAAC"}