@deephaven-enterprise/jsapi-types 1.20240723.195-beta → 1.20250219.122-beta

package/package.json

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

package/types/CommonTypes.d.ts

@@ -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 & {

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,
+  type Parameterized,
+  type ParameterizedQueryVariableType,
 } from './parameterizedQueryTypes.js';
-import { ControllerQueryConstants, WorkerKind } from './CommonTypes.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 & {
     /**
@@ -98,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.
@@ -108,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[];
@@ -294,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> {
@@ -315,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.
@@ -336,19 +483,22 @@ export interface EnterpriseClient {
     type: string,
     listener: (event: ClientListenerEvent<T>) => void
   ): void;
-  disconnect(): void;
-  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[]>;
@@ -359,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[][]>;
@@ -407,6 +557,9 @@ export interface EnterpriseClient {
     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.
@@ -568,6 +721,10 @@ export interface ServerConfigValues {
   ruffSettings: Record<string, unknown> | null;
   ruffEnabled: boolean;
   ruffEditable: boolean;
+  showEmptyStrings: boolean;
+  showEmptyStringsEditable: boolean;
+  showNullStrings: boolean;
+  showNullStringsEditable: boolean;
 }
 
 export interface ApplyParametersResult {