@deephaven-enterprise/jsapi-types 1.20240723.536-alpha-npm-publish.23386 → 1.20250801.196-beta

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@deephaven-enterprise/jsapi-types",
-  "version": "1.20240723.536-alpha-npm-publish.23386+75966764aa",
+  "version": "1.20250801.196-beta",
   "description": "Deephaven Enterprise Jsapi Types",
   "author": "Deephaven Data Labs LLC",
   "license": "SEE LICENSE IN LICENSE.md",
@@ -17,10 +17,10 @@
   ],
   "sideEffects": false,
   "dependencies": {
-    "@deephaven/jsapi-types": "^1.0.0-dev0.34.3"
+    "@deephaven/jsapi-types": "^1.0.0-dev0.36.1"
   },
   "publishConfig": {
     "access": "public"
   },
-  "gitHead": "75966764aad5efa8cbcf8358c9034dc8c3572116"
+  "gitHead": "14f4afc7fd893e4e15485f7041f204500b80f4a2"
 }

package/types/CommonTypes.d.ts

@@ -3,7 +3,7 @@ import type {
   ConsoleServerAddress,
   QueryConfigurationType,
   QueryConstants,
-} from './Iris';
+} from './Iris.js';
 
 /** Copied from @deephaven/redux to avoid the dependency */
 export interface UserPermissions {
@@ -80,7 +80,7 @@ export type QueryVariableDescriptor = dh.ide.VariableDescriptor & {
  */
 export type LegacyQueryVariableDescriptor = {
   querySerial: string;
-  query: string;
+  query?: string;
 };
 
 /** In some cases such as a console panel, we may not have a descriptor but still want to fetch the deferred API. */

package/types/Iris.d.ts

@@ -6,8 +6,8 @@ import type { dh as DhType } from '@deephaven/jsapi-types';
 import {
   Parameterized,
   ParameterizedQueryVariableType,
-} from './parameterizedQueryTypes';
-import { ControllerQueryConstants, WorkerKind } from './CommonTypes';
+} from './parameterizedQueryTypes.js';
+import { ControllerQueryConstants, WorkerKind } from './CommonTypes.js';
 
 export type CancelablePromise<T> = Promise<T> & { cancel: () => undefined };
 
@@ -85,6 +85,9 @@ export type BaseQueryInfoReadonly = Readonly<
      */
     runningVersion: string;
     serial: string;
+    /**
+     * @deprecated use `designated.status` instead
+     */
     status: string;
     workerKind: string;
   }
@@ -129,8 +132,19 @@ 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; data: string }): Promise<string>;
+  createWorkspaceData(data: {
+    id?: string;
+    data: string;
+    version?: number;
+  }): Promise<string>;
+  saveWorkspaceData(data: {
+    id?: string;
+    data: string;
+    version?: number;
+  }): Promise<void>;
   getObject(
     object: DhType.ide.VariableDescriptor
   ): Promise<DhType.ide.VariableDefinition>;
@@ -318,16 +332,11 @@ export interface EnterpriseClient {
     type: string,
     listener: (event: CustomEvent) => void
   ): () => void;
-  removeEventListener(
+  removeEventListener<T>(
     type: string,
-    listener: (event: ClientListenerEvent) => void
+    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>;
@@ -379,6 +388,35 @@ export interface EnterpriseClient {
     table: string,
     type: ImportSourceTypeOption
   ): Promise<string[]>;
+
+  /**
+   * Authenticate a user using a signed nonce + public key.
+   * @param base64SignedNonce Nonce returned by `getChallengeNonce` and signed
+   * with a private key.
+   * @param publicKeyWithSentinel Public key corresponding to the private key
+   * used to sign the nonce. Includes a sentinel prefix that identifies the
+   * algorithm used to generate the keypair.
+   * @param username Username to authenticate as.
+   * @param operateAs Optional username to operate as. Defaults to `username`.
+   * @returns null if successful. Throws if authentication fails.
+   */
+  challengeResponse: (
+    base64SignedNonce: string,
+    publicKeyWithSentinel: string,
+    username: string,
+    operateAs: string
+  ) => Promise<null>;
+
+  /**
+   * Get a Base64 encoded challenge nonce for that can be signed and passed to
+   * `challengeResponse()` for private / public key authentication.
+   */
+  getChallengeNonce(): Promise<ChallengeNonce>;
+}
+
+export interface ChallengeNonce {
+  algorithm: 'SHA256withDSA';
+  nonce: string;
 }
 
 export interface LoginCredentials {
@@ -413,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;
@@ -455,8 +483,7 @@ export interface IdeConstructor {
 }
 
 export interface Ide {
-  createConsole(config: ConsoleConfig): CancelablePromise<IdeConnection>;
-  startWorker(config: ConsoleConfig): CancelablePromise<DhcConnectionDetails>;
+  getQueryConnection(queryInfo: QueryInfo): Promise<IdeConnection>;
 }
 
 export type ConsoleServerAddressType = {
@@ -536,6 +563,11 @@ export interface ServerConfigValues {
   kubernetes: boolean;
   webgl: boolean;
   webglEditable: boolean;
+  gridDensity: 'compact' | 'regular' | 'spacious';
+  gridDensityEditable: boolean;
+  ruffSettings: Record<string, unknown> | null;
+  ruffEnabled: boolean;
+  ruffEditable: boolean;
 }
 
 export interface ApplyParametersResult {
@@ -583,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;

package/types/index.d.ts

@@ -1,4 +1,4 @@
-export * from './CommonTypes';
-export * from './parameterizedQueryTypes';
-export * from './CommonTypes';
-export * from './Iris';
+export * from './CommonTypes.js';
+export * from './parameterizedQueryTypes.js';
+export * from './CommonTypes.js';
+export * from './Iris.js';