@deephaven-enterprise/jsapi-types 1.20240723.53-beta-alpha-npm-test.1 → 1.20240723.536-alpha-npm-publish.23386

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@deephaven-enterprise/jsapi-types",
-  "version": "1.20240723.53-beta-alpha-npm-test.1",
+  "version": "1.20240723.536-alpha-npm-publish.23386+75966764aa",
   "description": "Deephaven Enterprise Jsapi Types",
   "author": "Deephaven Data Labs LLC",
   "license": "SEE LICENSE IN LICENSE.md",
@@ -21,5 +21,6 @@
   },
   "publishConfig": {
     "access": "public"
-  }
+  },
+  "gitHead": "75966764aad5efa8cbcf8358c9034dc8c3572116"
 }

package/types/Iris.d.ts

@@ -27,24 +27,16 @@ export interface TreeTable extends DhType.TreeTable {
   restoreExpandedState: (state: string) => void;
 }
 
-export interface BaseQueryInfo {
+export type BaseQueryInfo = {
   adminGroups: readonly string[];
 
-  /**
-   * @deprecated use `type` instead
-   */
-  configurationType: string;
-  configVersion: string;
   dataMemoryRatio: number;
   dbServerName: string;
   enabled: boolean;
   enableGcLogs: boolean;
   envVars: string;
   extraClasspaths: string;
-  /**
-   * @deprecated use `designated.grpcUrl` instead
-   */
-  grpcUrl: string;
+
   heapSize: number;
   additionalMemory: number;
   jvmArgs: string;
@@ -52,33 +44,73 @@ export interface BaseQueryInfo {
   name: string;
   owner: string;
   restartUsers: number;
-  /**
-   * @deprecated use `designated.runningVersion` instead
-   */
-  runningVersion: string;
+
   scheduling: readonly string[];
   scriptLanguage: string | null;
   scriptPath: string | null;
-  serial: string;
-  status: string;
+
   timeout: number;
   type: string;
-  typeSpecificFields: Record<string, { value: unknown }> | null;
+  typeSpecificFields: TypeSpecificFields | null;
   viewerGroups: readonly string[];
-  workerKind: string;
-
-  /**
-   * JSON encoded string of the kubernetes, python and generic controls
-   */
-  kubernetesControl: string;
-  pythonControl: string;
-  genericWorkerControl: string;
 
   replicaCount: number;
   spareCount: number;
   assignmentPolicy: string | null;
   assignmentPolicyParams: string | null;
-}
+};
+
+export type BaseQueryInfoReadonly = Readonly<
+  BaseQueryInfo & {
+    /**
+     * @deprecated use `type` instead
+     */
+    configurationType: string;
+    configVersion: string;
+
+    /**
+     * @deprecated use `designated.grpcUrl` instead
+     */
+    grpcUrl: string;
+
+    genericWorkerControl: string;
+    /**
+     * JSON encoded string of the kubernetes, python and generic controls
+     */
+    kubernetesControl: string;
+    pythonControl: string;
+
+    /**
+     * @deprecated use `designated.runningVersion` instead
+     */
+    runningVersion: string;
+    serial: string;
+    status: string;
+    workerKind: string;
+  }
+>;
+
+export type TypeSpecificFields<T extends string = string> = Record<
+  T,
+  { value: unknown; type: string }
+>;
+
+export type EditableQueryInfo = BaseQueryInfo & {
+  scriptCode: string;
+  serial: string | null;
+
+  /**
+   * Store the Kubernetes, Python, and Generic Worker Control values as string.
+   * We get the value from the server as a JSON encoded string, and we don't
+   * 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;
+
+  workerKind?: string | null;
+};
 
 export interface ReplicaStatus {
   objects: readonly DhType.ide.VariableDefinition[];
@@ -112,7 +144,7 @@ export interface ReplicaStatus {
   ): Promise<DhType.Table>;
 }
 
-export interface QueryInfo extends Readonly<BaseQueryInfo> {
+export interface QueryInfo extends BaseQueryInfoReadonly {
   designated?: ReplicaStatus;
   displayable: boolean;
   /**
@@ -444,34 +476,6 @@ export type QueryInfoStatic = {
   EVENT_PING: string;
 };
 
-export type EditableQueryInfo = Omit<
-  BaseQueryInfo,
-  | 'configurationType'
-  | 'configVersion'
-  | 'grpcUrl'
-  | 'status'
-  | 'runningVersion'
-  | 'serial'
-  | 'createWorkspaceData'
-  | 'getTreeTable'
-  | 'getTable'
-  | 'getObject'
-  | 'getFigure'
-  | 'kubernetesControl'
-  | 'genericWorkerControl'
-  | 'pythonControl'
-  | 'saveWorkspaceData'
-  | 'workerKind'
-> & {
-  scriptCode: string;
-  serial: string | null;
-} & {
-  kubernetesControl?: string | null;
-  genericWorkerControl?: string | null;
-  pythonControl?: string | null;
-  workerKind?: string | null;
-};
-
 export type EnterpriseClientStatic = {
   EVENT_CONNECT: 'connect';
   EVENT_DISCONNECT: 'disconnect';