@deephaven-enterprise/jsapi-types 1.20240723.174-beta → 1.20240723.176-beta

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@deephaven-enterprise/jsapi-types",
-  "version": "1.20240723.174-beta",
+  "version": "1.20240723.176-beta",
   "description": "Deephaven Enterprise Jsapi Types",
   "author": "Deephaven Data Labs LLC",
   "license": "SEE LICENSE IN LICENSE.md",
@@ -22,5 +22,5 @@
   "publishConfig": {
     "access": "public"
   },
-  "gitHead": "abad5387954ad4651365ab7b309a65316725a3d5"
+  "gitHead": "cce92dcf36d542350e6e82b1d33f3430ddb36f8d"
 }

package/types/Iris.d.ts

@@ -132,6 +132,8 @@ export interface ReplicaStatus {
   websocketPort: number | null;
   workerPort: number | null;
   initStartTime: DhType.DateWrapper | null;
+  dispatcherHost: string | null;
+  dispatcherPort: number | null;
   processInfoId: string | null;
   createWorkspaceData(data: {
     id?: string;
@@ -335,11 +337,6 @@ export interface EnterpriseClient {
     listener: (event: ClientListenerEvent<T>) => void
   ): void;
   disconnect(): void;
-  getDispatcher(
-    serverGroup: string,
-    heapSizeMB: number,
-    engine: string
-  ): Promise<ConsoleServerAddress>;
   saveQuery(query: EditableQueryInfo, doRestart: boolean): Promise<void>;
   createQuery(query: EditableQueryInfo): Promise<string>;
   createAuthToken(key: string): Promise<string>;
@@ -454,27 +451,17 @@ export interface EnterpriseClientConstructor {
   new (websocketUrl: string): EnterpriseClient;
 }
 
+/**
+ * @deprecated should be replaced with `EditableQueryInfo`
+ */
 export interface ConsoleConfigConstructor {
   new (): ConsoleConfig;
 }
 
-export interface DhcConnectionDetails {
-  readonly envoyPrefix: string | null;
-  readonly grpcUrl: string;
-  readonly ideUrl: string;
-  readonly jsApiUrl: string;
-  readonly serviceId: string;
-  readonly processInfoId: string;
-  readonly workerName: string;
-
-  close(): void;
-  addEventListener: (
-    name: string,
-    callback: (event: CustomEvent) => void
-  ) => () => void;
-  removeEventListener(type: string, listener: () => void): void;
-}
-
+/**
+ * @deprecated use the `EditableQueryInfo` going forward, which can be used to represent the PersistentQuery backing a
+ * Code Studio without an intermediate stage
+ */
 export interface ConsoleConfig {
   dispatcherHost?: string;
   dispatcherPort?: number;
@@ -496,8 +483,6 @@ export interface IdeConstructor {
 }
 
 export interface Ide {
-  createConsole(config: ConsoleConfig): CancelablePromise<IdeConnection>;
-  startWorker(config: ConsoleConfig): CancelablePromise<DhcConnectionDetails>;
   getQueryConnection(queryInfo: QueryInfo): Promise<IdeConnection>;
 }
 
@@ -630,6 +615,9 @@ export type EnterpriseDhType = typeof DhType & {
   VariableType: typeof VariableType;
   ConsoleServerAddress: ConsoleServerAddress;
   Ide: IdeConstructor;
+  /**
+   * @deprecated instead of washing the Code Studio configuration through an old object, directly use an `EditableQueryInfo`
+   */
   ConsoleConfig: ConsoleConfigConstructor;
   QueryInfo: QueryInfoStatic;
   ImportSourceType: typeof ImportSourceType;