@deephaven-enterprise/jsapi-types 1.20250219.131-beta → 1.20250219.133-beta

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@deephaven-enterprise/jsapi-types",
-  "version": "1.20250219.131-beta",
+  "version": "1.20250219.133-beta",
   "description": "Deephaven Enterprise Jsapi Types",
   "author": "Deephaven Data Labs LLC",
   "license": "SEE LICENSE IN LICENSE.md",

package/types/Iris.d.ts

@@ -257,6 +257,8 @@ export interface ReplicaStatus {
   objects: readonly DhType.ide.VariableDefinition[];
   status: string | null;
   fullStackTrace: string | null;
+  errorMessage: string | null;
+  shortCauses: string | null;
   envoyPrefix: string | null;
   grpcUrl: string;
   jsApiUrl: string;
@@ -270,9 +272,12 @@ export interface ReplicaStatus {
   websocketPort: number | null;
   workerPort: number | null;
   initStartTime: DhType.DateWrapper | null;
+  initEndTime: DhType.DateWrapper | null;
   dispatcherHost: string | null;
   dispatcherPort: number | null;
   processInfoId: string | null;
+  lastModifiedByAuthenticated: string | null;
+  lastUpdateTime: DhType.DateWrapper | null;
   createWorkspaceData(data: {
     id?: string;
     data: string;
@@ -349,13 +354,22 @@ export interface QueryInfo extends BaseQueryInfoReadonly {
    * @deprecated Use `designated.initStartTime` instead
    */
   initStartTime: DhType.DateWrapper | null;
+  /**
+   * @deprecated Use `designated.initEndType` instead
+   */
   initEndTime: DhType.DateWrapper | null;
+  /**
+   * @deprecated Use `designated.lastUpdateTime` instead
+   */
   lastUpdateTime: DhType.DateWrapper | null;
   /**
    * @deprecated Use `designated.processInfoId` instead
    */
   processInfoId: string | null;
   lastModifiedTime: DhType.DateWrapper | null;
+  /**
+   * @deprecated Use `designated.lastModifiedByAuthenticated` instead
+   */
   lastModifiedByAuthenticated: string | null;
   schedulingStartTime: string | null;
   schedulingEndTime: string | null;
@@ -439,6 +453,9 @@ export interface QuerySelectionPermissions {
   readOnlyUser: boolean;
 }
 
+/**
+ * @deprecated use CustomEvent instead
+ */
 export interface ClientListenerEvent<TDetail = unknown> {
   detail: TDetail;
 }
@@ -465,6 +482,16 @@ export interface RefreshToken {
   get authenticatedUser(): string;
 }
 
+export interface ServerStatus {
+  state: 'Unknown' | 'Connected' | 'Disconnected';
+}
+
+export type ClientConnectionState = {
+  'connection.json': ServerStatus;
+  'Authentication Server': ServerStatus;
+  'Controller Server': ServerStatus;
+};
+
 export interface EnterpriseClient {
   /**
    * Get available assignment policy types.
@@ -478,13 +505,13 @@ export interface EnterpriseClient {
   ): Promise<QuerySelectionPermissions>;
   getEditableQuery(serialId: string): Promise<EditableQueryInfo>;
   getKnownConfigs(): QueryInfo[];
-  addEventListener(
+  addEventListener<T>(
     type: string,
-    listener: (event: CustomEvent) => void
+    listener: (event: CustomEvent<T>) => void
   ): () => void;
   removeEventListener<T>(
     type: string,
-    listener: (event: ClientListenerEvent<T>) => void
+    listener: (event: CustomEvent<T>) => void
   ): void;
   disconnect(fireEvents?: boolean): void;
   saveQuery(query: PlainEditableQueryInfo, doRestart: boolean): Promise<void>;
@@ -551,13 +578,15 @@ export interface EnterpriseClient {
    * algorithm used to generate the keypair.
    * @param username Username to authenticate as.
    * @param operateAs Optional username to operate as. Defaults to `username`.
+   * @param ipAddress IP address returned by `getChallengeNonce`.
    * @returns null if successful. Throws if authentication fails.
    */
   challengeResponse: (
     base64SignedNonce: string,
     publicKeyWithSentinel: string,
     username: string,
-    operateAs: string
+    operateAs: string | null,
+    ipAddress: string
   ) => Promise<null>;
 
   /** True if the client is currently connected */
@@ -568,11 +597,16 @@ export interface EnterpriseClient {
    * `challengeResponse()` for private / public key authentication.
    */
   getChallengeNonce(): Promise<ChallengeNonce>;
+
+  /**
+   * Get the current connection state to all servers.
+   */
+  readonly connectionState: ClientConnectionState;
 }
 
 export interface ChallengeNonce {
-  algorithm: 'SHA256withDSA';
   nonce: string;
+  ipAddress: string;
 }
 
 export interface LoginCredentials {
@@ -604,9 +638,22 @@ export type QueryConstants = {
 };
 
 export interface EnterpriseClientConstructor {
-  new (websocketUrl: string): EnterpriseClient;
+  new (websocketUrl: string, connectOptions?: ConnectOptions): EnterpriseClient;
 }
 
+export interface ConnectOptions {
+  /**
+   * The transport factory to use for creating gRPC streams.
+   * <p>
+   * Defaults to null, indicating that the JS API should determine the appropriate transport to use.
+   */
+  transportFactory?: GrpcTransportFactory | null;
+}
+
+export type GrpcTransport = DhType.grpc.GrpcTransport;
+export type GrpcTransportFactory = DhType.grpc.GrpcTransportFactory;
+export type GrpcTransportOptions = DhType.grpc.GrpcTransportOptions;
+
 export interface IdeConstructor {
   new (client: EnterpriseClient): Ide;
 }
@@ -634,7 +681,14 @@ export type QueryInfoStatic = {
 
 export type EnterpriseClientStatic = {
   EVENT_CONNECT: 'connect';
+  EVENT_CONNECTION_STATUS_CHANGED: 'connectionstatuschanged';
+  /**
+   * @deprecated use EVENT_CONNECTION_STATUS_CHANGED and the dh.Client.connectionStatus field instead
+   */
   EVENT_DISCONNECT: 'disconnect';
+  /**
+   * @deprecated use EVENT_CONNECTION_STATUS_CHANGED and the dh.Client.connectionStatus field instead
+   */
   EVENT_RECONNECT: 'reconnect';
   EVENT_RECONNECT_AUTH_FAILED: 'reconnectauthfailed';
   EVENT_CONFIG_ADDED: 'configadded';