@deephaven-enterprise/query-utils 1.20240723.194-beta → 1.20250219.122-beta

package/dist/DraftQuery.d.ts

@@ -1,8 +1,11 @@
-import type { EditableQueryInfo, TypeSpecificFields } from '@deephaven-enterprise/jsapi-types';
+import type { EditableQueryInfo, PlainEditableQueryInfo, TypeSpecificFields } from '@deephaven-enterprise/jsapi-types';
 import QueryScheduler from './QueryScheduler';
 export type ScriptDraftQuery = IDraftQuery & {
     scriptLanguage: string;
 };
+export interface DefaultDraftQuery extends Omit<DraftQuery, 'id' | 'defaults'> {
+    id?: string;
+}
 /**
  * TypeScript `type` aliases have implicit index signatures, but `interface`
  * types do not. It is important that all of the types composed into `IDraftQuery`
@@ -10,11 +13,13 @@ export type ScriptDraftQuery = IDraftQuery & {
  * it causes issues upstream where `Record<string, unknown>` generics are expected.
  * e.g. `WorkspaceStorageItem<IDraftQuery>`
  */
-export type IDraftQuery = EditableQueryInfo & {
+export type IDraftQuery = PlainEditableQueryInfo & {
     isClientSide: boolean;
     draftOwner: string;
     initializationThreads?: string;
     updateThreads?: string;
+    defaults?: DefaultDraftQuery;
+    isModified: boolean;
 };
 export type DraftQueryConstructorObject = Partial<IDraftQuery> & Pick<IDraftQuery, 'name' | 'owner' | 'draftOwner' | 'dbServerName' | 'initializationThreads' | 'updateThreads'>;
 /**
@@ -62,6 +67,7 @@ export declare class DraftQuery implements IDraftQuery {
         readonly ASSIGNMENT_POLICY_PARAMS: "assignmentPolicyParams";
         readonly INITIALIZATION_THREADS: "initializationThreads";
         readonly UPDATE_THREADS: "updateThreads";
+        readonly DEFAULTS: "defaults";
     }>;
     /**
      * Checks if a serial id from the server is actually a draft id
@@ -75,7 +81,7 @@ export declare class DraftQuery implements IDraftQuery {
      * @param serial a serial that contains a draft id
      */
     static serialToDraftId(serial: string): string;
-    constructor({ isClientSide, draftOwner, serial, name, owner, type, enabled, enableGcLogs, envVars, heapSize, additionalMemory, dataMemoryRatio, jvmArgs, extraClasspaths, jvmProfile, dbServerName, scriptLanguage, scriptPath, scriptCode, scheduling, adminGroups, viewerGroups, restartUsers, timeout, workerKind, kubernetesControl, pythonControl, genericWorkerControl, typeSpecificFields, replicaCount, spareCount, assignmentPolicy, assignmentPolicyParams, initializationThreads, updateThreads, }: DraftQueryConstructorObject);
+    constructor({ isModified, isClientSide, draftOwner, serial, name, owner, type, enabled, enableGcLogs, envVars, heapSize, additionalMemory, dataMemoryRatio, jvmArgs, extraClasspaths, jvmProfile, dbServerName, scriptLanguage, scriptPath, scriptCode, scheduling, adminGroups, viewerGroups, restartUsers, timeout, workerKind, kubernetesControl, pythonControl, genericWorkerControl, typeSpecificFields, replicaCount, spareCount, assignmentPolicy, assignmentPolicyParams, initializationThreads, updateThreads, defaults, }: DraftQueryConstructorObject);
     id: string;
     isModified: boolean;
     isClientSide: boolean;
@@ -96,23 +102,23 @@ export declare class DraftQuery implements IDraftQuery {
     dbServerName: string;
     scriptLanguage: string | null;
     scriptPath: string | null;
-    scriptCode: string;
+    scriptCode: string | null;
     scheduling: readonly string[];
     adminGroups: readonly string[];
     viewerGroups: readonly string[];
     restartUsers: number;
     timeout: number;
     scheduler: QueryScheduler;
-    kubernetesControl?: string | null;
-    pythonControl?: string | null;
-    genericWorkerControl?: string | null;
+    kubernetesControl: string | null;
+    pythonControl: string | null;
+    genericWorkerControl: string | null;
     /**
      * Should be the name (not title) of the workerKind
      * The server gives null if it should be the default
      * Not sure if the value will be set if the PQ is from pre-vermilion and the customer upgrades
      * Treat both null and undefined as server default (not necessarily 1st option in the UI)
      */
-    workerKind: string | null | undefined;
+    workerKind: string | null;
     typeSpecificFields: TypeSpecificFields | null;
     replicaCount: number;
     spareCount: number;
@@ -126,6 +132,7 @@ export declare class DraftQuery implements IDraftQuery {
      */
     initializationThreads: string;
     updateThreads: string;
+    defaults?: DefaultDraftQuery;
     updateSchedule(): void;
     /**
      * Creates a deep copy of this draft query.
@@ -139,7 +146,7 @@ export declare class DraftQuery implements IDraftQuery {
      *
      * @param editableQuery the Editable Query from the Server
      */
-    saveDraftToQuery(editableQuery: Partial<EditableQueryInfo>): void;
+    saveDraftToQuery<T extends EditableQueryInfo>(editableQuery: Partial<T> & Pick<T, 'serial'>): T;
     /**
      * Updates the JVM args to include the thread count for initialization and update threads.
      * It is safe to call from saveDraftToQuery because the the thead counts will be set to
@@ -148,9 +155,10 @@ export declare class DraftQuery implements IDraftQuery {
      * manually in that case.
      */
     addThreadCountToJVMArgs(): void;
-    toEditableQueryInfo(): {
-        serial: string | null;
-    };
+    /**
+     * Get a PlainEditableQueryInfo object populated from this DraftQuery
+     */
+    toEditableQueryInfo(): PlainEditableQueryInfo;
     toRowMap(queryTypes: Map<string, string>): Map<string, string>;
     formatIdForSerialColumn(): string;
 }

package/dist/DraftQuery.js

@@ -26,11 +26,11 @@ export class DraftQuery {
         // Remove the 'Draft ID: ' marking
         return serial === null || serial === void 0 ? void 0 : serial.substring(DRAFT_SERIAL_PREFIX.length);
     }
-    constructor({ isClientSide = false, draftOwner, serial = DraftQuery.NO_SERIAL, name, owner, type = QueryType.SCRIPT, enabled = true, enableGcLogs = true, envVars = '', heapSize = 4.0, additionalMemory = 0.0, dataMemoryRatio = 0.25, jvmArgs = '', extraClasspaths = '', jvmProfile = 'Default', dbServerName, scriptLanguage = 'Groovy', scriptPath = null, scriptCode = '', scheduling, adminGroups = [], viewerGroups = [], restartUsers = DraftQuery.RESTART_MODE.ADMIN, timeout = 0, workerKind, kubernetesControl, pythonControl, genericWorkerControl, typeSpecificFields = null, replicaCount = 1, spareCount = 0, assignmentPolicy = null, assignmentPolicyParams = null, initializationThreads = undefined, updateThreads = undefined, }) {
+    constructor({ isModified = false, isClientSide = false, draftOwner, serial = DraftQuery.NO_SERIAL, name, owner, type = QueryType.SCRIPT, enabled = true, enableGcLogs = true, envVars = '', heapSize = 4.0, additionalMemory = 0.0, dataMemoryRatio = 0.25, jvmArgs = '', extraClasspaths = '', jvmProfile = 'Default', dbServerName, scriptLanguage = 'Groovy', scriptPath = null, scriptCode = '', scheduling, adminGroups = [], viewerGroups = [], restartUsers = DraftQuery.RESTART_MODE.ADMIN, timeout = 0, workerKind = null, kubernetesControl = null, pythonControl = null, genericWorkerControl = null, typeSpecificFields = null, replicaCount = 1, spareCount = 0, assignmentPolicy = null, assignmentPolicyParams = null, initializationThreads = undefined, updateThreads = undefined, defaults = undefined, }) {
         this.scheduling = [];
         // Meta Data
         this.id = shortid.generate();
-        this.isModified = false;
+        this.isModified = isModified;
         this.isClientSide = isClientSide;
         this.draftOwner = draftOwner;
         // Query Data
@@ -76,6 +76,9 @@ export class DraftQuery {
         this.scheduling = [];
         this.scheduler = new QueryScheduler(scheduling);
         this.typeSpecificFields = typeSpecificFields;
+        // A new draft should have null / undefined defaults
+        // A copy should have defaults that need to be instantiated as a new DraftQuery
+        this.defaults = defaults == null ? undefined : new DraftQuery(defaults);
     }
     updateSchedule() {
         if (this.scheduler != null) {
@@ -105,38 +108,43 @@ export class DraftQuery {
      * @param editableQuery the Editable Query from the Server
      */
     saveDraftToQuery(editableQuery) {
-        var _a, _b;
         this.addThreadCountToJVMArgs();
-        editableQuery.name = this.name;
-        editableQuery.owner = this.owner;
-        editableQuery.type = this.type;
-        editableQuery.enabled = this.enabled;
-        editableQuery.enableGcLogs = this.enableGcLogs;
-        editableQuery.envVars = this.envVars;
-        editableQuery.heapSize = this.heapSize;
-        editableQuery.dataMemoryRatio = this.dataMemoryRatio;
-        editableQuery.additionalMemory = this.additionalMemory;
-        editableQuery.jvmArgs = this.jvmArgs;
-        editableQuery.extraClasspaths = this.extraClasspaths;
-        editableQuery.jvmProfile = this.jvmProfile;
-        editableQuery.dbServerName = this.dbServerName;
-        editableQuery.scriptLanguage = this.scriptLanguage;
-        editableQuery.scriptPath = (_a = this.scriptPath) !== null && _a !== void 0 ? _a : undefined;
-        editableQuery.scriptCode = this.scriptCode;
-        editableQuery.scheduling = this.scheduler.toStringArray();
-        editableQuery.adminGroups = this.adminGroups;
-        editableQuery.viewerGroups = this.viewerGroups;
-        editableQuery.restartUsers = this.restartUsers;
-        editableQuery.timeout = this.timeout;
-        editableQuery.workerKind = (_b = this.workerKind) !== null && _b !== void 0 ? _b : undefined;
-        editableQuery.kubernetesControl = this.kubernetesControl;
-        editableQuery.pythonControl = this.pythonControl;
-        editableQuery.genericWorkerControl = this.genericWorkerControl;
-        editableQuery.typeSpecificFields = this.typeSpecificFields;
-        editableQuery.replicaCount = this.replicaCount;
-        editableQuery.spareCount = this.spareCount;
-        editableQuery.assignmentPolicy = this.assignmentPolicy;
-        editableQuery.assignmentPolicyParams = this.assignmentPolicyParams;
+        // Type check to make sure none of the required fields are missing
+        const completeQuery = {
+            serial: editableQuery.serial,
+            name: this.name,
+            owner: this.owner,
+            type: this.type,
+            enabled: this.enabled,
+            enableGcLogs: this.enableGcLogs,
+            envVars: this.envVars,
+            heapSize: this.heapSize,
+            dataMemoryRatio: this.dataMemoryRatio,
+            additionalMemory: this.additionalMemory,
+            jvmArgs: this.jvmArgs,
+            extraClasspaths: this.extraClasspaths,
+            jvmProfile: this.jvmProfile,
+            dbServerName: this.dbServerName,
+            scriptLanguage: this.scriptLanguage,
+            scriptPath: this.scriptPath,
+            scriptCode: this.scriptCode,
+            scheduling: this.scheduler.toStringArray(),
+            adminGroups: [...this.adminGroups],
+            viewerGroups: this.viewerGroups,
+            restartUsers: this.restartUsers,
+            timeout: this.timeout,
+            workerKind: this.workerKind,
+            kubernetesControl: this.kubernetesControl,
+            pythonControl: this.pythonControl,
+            genericWorkerControl: this.genericWorkerControl,
+            typeSpecificFields: this.typeSpecificFields,
+            replicaCount: this.replicaCount,
+            spareCount: this.spareCount,
+            assignmentPolicy: this.assignmentPolicy,
+            assignmentPolicyParams: this.assignmentPolicyParams,
+        };
+        Object.assign(editableQuery, completeQuery);
+        return editableQuery;
     }
     /**
      * Updates the JVM args to include the thread count for initialization and update threads.
@@ -149,10 +157,11 @@ export class DraftQuery {
         const { initializationThreads, updateThreads } = this;
         this.jvmArgs = WorkerThreadUtils.addArgs(this.jvmArgs, initializationThreads, updateThreads);
     }
+    /**
+     * Get a PlainEditableQueryInfo object populated from this DraftQuery
+     */
     toEditableQueryInfo() {
-        const editableQuery = { serial: this.serial };
-        this.saveDraftToQuery(editableQuery);
-        return editableQuery;
+        return this.saveDraftToQuery({ serial: this.serial });
     }
     toRowMap(queryTypes) {
         var _a, _b, _c, _d, _e, _f;
@@ -226,5 +235,6 @@ DraftQuery.FIELDS = Object.freeze({
     ASSIGNMENT_POLICY_PARAMS: `assignmentPolicyParams`,
     INITIALIZATION_THREADS: 'initializationThreads',
     UPDATE_THREADS: 'updateThreads',
+    DEFAULTS: 'defaults',
 });
 export default DraftQuery;

package/dist/QueryColumns.js

@@ -324,12 +324,12 @@ QueryColumns.ASSIGNMENT_POLICY_PARAMS = {
     type: NewTableColumnTypes.STRING,
 };
 QueryColumns.ID = {
-    name: '_Id_',
+    name: 'ID',
     displayName: 'Id',
     type: NewTableColumnTypes.STRING,
 };
 QueryColumns.PARENT_ID = {
-    name: '_Parent_',
+    name: 'Parent',
     displayName: 'Parent Id',
     type: NewTableColumnTypes.STRING,
 };

package/dist/QuerySchedulerValidation.js

@@ -55,7 +55,8 @@ export class QuerySchedulerValidation {
             return null;
         }
         const firstKey = errorMap.keys().next().value;
-        if (firstKey === QueryScheduler.FIELDS.MONTHS ||
+        if (firstKey == null ||
+            firstKey === QueryScheduler.FIELDS.MONTHS ||
             firstKey === QueryScheduler.FIELDS.SCHEDULING_DISABLED) {
             return null;
         }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@deephaven-enterprise/query-utils",
-  "version": "1.20240723.194-beta",
+  "version": "1.20250219.122-beta",
   "description": "Deephaven Enterprise Query Utils",
   "author": "Deephaven Data Labs LLC",
   "license": "SEE LICENSE IN LICENSE.md",
@@ -28,6 +28,5 @@
   },
   "publishConfig": {
     "access": "public"
-  },
-  "gitHead": "247d8b9028f57916d20d45d5c7d212c7db4c0f39"
+  }
 }