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

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@deephaven-enterprise/jsapi-types",
-  "version": "1.20240723.536-alpha-npm-publish.23386+75966764aa",
+  "version": "1.20250219.123-beta",
   "description": "Deephaven Enterprise Jsapi Types",
   "author": "Deephaven Data Labs LLC",
   "license": "SEE LICENSE IN LICENSE.md",
@@ -17,10 +17,9 @@
   ],
   "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"
+  }
 }

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 {
@@ -43,6 +43,12 @@ export interface EnterpriseUserPermissions extends UserPermissions {
   /** Not allowed to use the web UI at all */
   isNonInteractive: boolean;
 
+  /** Can manage queries */
+  isQueryManager: boolean;
+
+  /** Can manage schemas */
+  isSchemaManager: boolean;
+
   /** Can create new dashboards */
   canCreateDashboard: boolean;
 
@@ -63,6 +69,9 @@ export interface EnterpriseUserPermissions extends UserPermissions {
 
   /** Can view the list of users a query is shared with for a query they are a viewer of */
   canViewQuerySharedUsers: boolean;
+
+  /** Can logout */
+  canLogout: boolean;
 }
 
 export type EnterpriseUser = User & {
@@ -80,7 +89,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

@@ -1,13 +1,17 @@
+/* eslint-disable max-classes-per-file */
 // The iris api script isn't packaged as a module (yet), and is just included in index.html, exported to the global namespace
 // This include file is simply a wrapper so that it behaves like a module, and can be mocked easily for unit tests.
 // https://github.com/facebook/create-react-app/blob/master/packages/react-scripts/template/README.md#using-global-variables
 import type { dh as DhType } from '@deephaven/jsapi-types';
 
 import {
-  Parameterized,
-  ParameterizedQueryVariableType,
-} from './parameterizedQueryTypes';
-import { ControllerQueryConstants, WorkerKind } from './CommonTypes';
+  type Parameterized,
+  type ParameterizedQueryVariableType,
+} from './parameterizedQueryTypes.js';
+import {
+  type ControllerQueryConstants,
+  type WorkerKind,
+} from './CommonTypes.js';
 
 export type CancelablePromise<T> = Promise<T> & { cancel: () => undefined };
 
@@ -60,6 +64,21 @@ export type BaseQueryInfo = {
   assignmentPolicyParams: string | null;
 };
 
+/**
+ * Plain object representing a query configuration
+ * with properties matching {@link EditableQueryInfo}
+ * Used as input for the `saveQuery` and `createQuery` methods.
+ */
+export type PlainEditableQueryInfo = BaseQueryInfo & {
+  scriptCode: string | null;
+  serial: string | null;
+
+  genericWorkerControl: string | null;
+  kubernetesControl: string | null;
+  pythonControl: string | null;
+  workerKind: string | null;
+};
+
 export type BaseQueryInfoReadonly = Readonly<
   BaseQueryInfo & {
     /**
@@ -85,6 +104,9 @@ export type BaseQueryInfoReadonly = Readonly<
      */
     runningVersion: string;
     serial: string;
+    /**
+     * @deprecated use `designated.status` instead
+     */
     status: string;
     workerKind: string;
   }
@@ -95,9 +117,118 @@ export type TypeSpecificFields<T extends string = string> = Record<
   { value: unknown; type: string }
 >;
 
-export type EditableQueryInfo = BaseQueryInfo & {
-  scriptCode: string;
-  serial: string | null;
+/**
+ * The EditableQueryInfo class uses getter and setter methods for accessing and modifying its properties.
+ * As a result, it cannot be directly used with the spread operator.
+ */
+export declare class EditableQueryInfo implements PlainEditableQueryInfo {
+  get adminGroups(): readonly string[];
+
+  set adminGroups(value: readonly string[]);
+
+  get dataMemoryRatio(): number;
+
+  set dataMemoryRatio(value: number);
+
+  get dbServerName(): string;
+
+  set dbServerName(value: string);
+
+  get enabled(): boolean;
+
+  set enabled(value: boolean);
+
+  get enableGcLogs(): boolean;
+
+  set enableGcLogs(value: boolean);
+
+  get envVars(): string;
+
+  set envVars(value: string);
+
+  get extraClasspaths(): string;
+
+  set extraClasspaths(value: string);
+
+  get heapSize(): number;
+
+  set heapSize(value: number);
+
+  get additionalMemory(): number;
+
+  set additionalMemory(value: number);
+
+  get jvmArgs(): string;
+
+  set jvmArgs(value: string);
+
+  get jvmProfile(): string;
+
+  set jvmProfile(value: string);
+
+  get name(): string;
+
+  set name(value: string);
+
+  get owner(): string;
+
+  set owner(value: string);
+
+  get restartUsers(): number;
+
+  set restartUsers(value: number);
+
+  get scheduling(): readonly string[];
+
+  set scheduling(value: readonly string[]);
+
+  get scriptLanguage(): string | null;
+
+  set scriptLanguage(value: string | null);
+
+  get scriptPath(): string | null;
+
+  set scriptPath(value: string | null);
+
+  get timeout(): number;
+
+  set timeout(value: number);
+
+  get type(): string;
+
+  set type(value: string);
+
+  get typeSpecificFields(): TypeSpecificFields | null;
+
+  set typeSpecificFields(value: TypeSpecificFields | null);
+
+  get viewerGroups(): readonly string[];
+
+  set viewerGroups(value: readonly string[]);
+
+  get replicaCount(): number;
+
+  set replicaCount(value: number);
+
+  get spareCount(): number;
+
+  set spareCount(value: number);
+
+  get assignmentPolicy(): string | null;
+
+  set assignmentPolicy(value: string | null);
+
+  get assignmentPolicyParams(): string | null;
+
+  set assignmentPolicyParams(value: string | null);
+
+  get scriptCode(): string | null;
+
+  set scriptCode(value: string | null);
+
+  get serial(): string | null;
+
+  set serial(value: string | null);
 
   /**
    * Store the Kubernetes, Python, and Generic Worker Control values as string.
@@ -105,12 +236,22 @@ export type EditableQueryInfo = BaseQueryInfo & {
    * want to lose any parameters that may have been set on the server that the
    * Web UI doesn't know about.
    */
-  kubernetesControl?: string | null;
-  genericWorkerControl?: string | null;
-  pythonControl?: string | null;
+  get kubernetesControl(): string | null;
 
-  workerKind?: string | null;
-};
+  set kubernetesControl(value: string | null);
+
+  get genericWorkerControl(): string | null;
+
+  set genericWorkerControl(value: string | null);
+
+  get pythonControl(): string | null;
+
+  set pythonControl(value: string | null);
+
+  get workerKind(): string | null;
+
+  set workerKind(value: string | null);
+}
 
 export interface ReplicaStatus {
   objects: readonly DhType.ide.VariableDefinition[];
@@ -129,8 +270,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>;
@@ -280,6 +432,13 @@ export interface QuerySelectionPermissions {
   allAdmin: boolean;
   allOwner: boolean;
   allRestartable: boolean;
+  allStoppable: boolean;
+  allStopped: boolean;
+  allDisabled: boolean;
+  allEnabled: boolean;
+  allTemporary: boolean;
+  allImportMerge: boolean;
+  readOnlyUser: boolean;
 }
 
 export interface ClientListenerEvent<TDetail = unknown> {
@@ -301,6 +460,8 @@ export interface AssignmentPolicyType {
 
 export type AssignmentPolicyTypes = Map<string, AssignmentPolicyType>;
 
+export type RefreshToken = DhType.RefreshToken;
+
 export interface EnterpriseClient {
   /**
    * Get available assignment policy types.
@@ -318,28 +479,26 @@ 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>;
+  disconnect(fireEvents?: boolean): void;
+  saveQuery(query: PlainEditableQueryInfo, doRestart: boolean): Promise<void>;
+  createQuery(query: PlainEditableQueryInfo): Promise<string>;
   createAuthToken(key: string): Promise<string>;
   /** Imports the XML string as queries, and returns the query info. Does _not_ actually create them, use `saveQueries()` to save them. */
   importQueries: (xml: string) => Promise<QueryInfo[]>;
   /** Returns a string containing the XML of all queries specified */
   exportQueries: (serialIds: string[]) => Promise<string>;
-  relogin(token: unknown): Promise<void>;
+  relogin(token: RefreshToken): Promise<void>;
   getAllGroups(): Promise<string[]>;
   getAllUsers(): Promise<string[]>;
   getTemporaryQueueNames(): Promise<string[]>;
   getScriptPaths(serialId: string | null, owner?: string): Promise<string[]>;
+  /**
+   * @deprecated
+   */
   getQuerySerialsForDependent(isTemporary: boolean): Promise<string[]>;
   getDbServersForType(type: string): Promise<ConsoleServerAddress[]>;
   getJdbcDriverWrappers(): Promise<DriverWrapper[]>;
@@ -350,7 +509,7 @@ export interface EnterpriseClient {
    * @param replaceExisting Whether to replace existing queries or create new ones. If a serial is specified on a query and it is saved and `replaceExisting` is false, it will throw an error if a query with that serial already exists.
    */
   saveQueries: (
-    queries: readonly EditableQueryInfo[],
+    queries: readonly PlainEditableQueryInfo[],
     replaceExisting: boolean
   ) => Promise<SaveQueriesResult>;
   getAuthConfigValues(): Promise<string[][]>;
@@ -379,6 +538,38 @@ 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>;
+
+  /** True if the client is currently connected */
+  readonly isConnected: boolean;
+
+  /**
+   * 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 +604,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 +636,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 +716,15 @@ export interface ServerConfigValues {
   kubernetes: boolean;
   webgl: boolean;
   webglEditable: boolean;
+  gridDensity: 'compact' | 'regular' | 'spacious';
+  gridDensityEditable: boolean;
+  ruffSettings: Record<string, unknown> | null;
+  ruffEnabled: boolean;
+  ruffEditable: boolean;
+  showEmptyStrings: boolean;
+  showEmptyStringsEditable: boolean;
+  showNullStrings: boolean;
+  showNullStringsEditable: boolean;
 }
 
 export interface ApplyParametersResult {
@@ -583,6 +772,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';