@deephaven/jsapi-utils 1.12.1 → 1.16.0

package/dist/ConnectionUtils.d.ts

@@ -2,11 +2,26 @@ import type { dh } from '@deephaven/jsapi-types';
 /** Default timeout for fetching a variable definition */
 export declare const FETCH_TIMEOUT = 10000;
 /**
- * Fetch the definition for a variable given a connection. Subscribes to field updates and triggers when the variable is found.
+ * Fetch the definition for a variable given a connection. Waits for the next
+ * field update event and resolves if the variable is found in the created
+ * variables.
  * @param connection Connection to get the variable from
  * @param name Name of the definition to fetch
  * @param timeout Timeout for the fetch
- * @returns Promise the resolves to the variable definition if found, or rejects if there's an error or the timeout has exceeded
+ * @returns Promise that resolves to the variable definition if found in the next field update,
+ *          or rejects if the variable is not found in that update or if the timeout is exceeded
  */
 export declare function fetchVariableDefinition(connection: dh.IdeConnection, name: string, timeout?: number): Promise<dh.ide.VariableDefinition>;
+/**
+ * Fetch the definition for a variable given a connection. Waits for the next
+ * field update event and resolves if a variable matching the predicate is found
+ * in the created variables.
+ * @param connection Connection to get the variable from
+ * @param predicate Predicate function to test each variable definition
+ * @param timeout Timeout for the fetch
+ * @param errorMessage Optional error message for timeout and not found errors
+ * @returns Promise that resolves to the variable definition if found in the next field update,
+ *          or rejects if no matching variable is found in that update or if the timeout is exceeded
+ */
+export declare function fetchVariableDefinitionByPredicate(connection: dh.IdeConnection, predicate: (definition: dh.ide.VariableDefinition) => boolean, timeout?: number, errorMessage?: string): Promise<dh.ide.VariableDefinition>;
 //# sourceMappingURL=ConnectionUtils.d.ts.map

package/dist/ConnectionUtils.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"ConnectionUtils.d.ts","sourceRoot":"","sources":["../src/ConnectionUtils.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,EAAE,EAAE,MAAM,wBAAwB,CAAC;AAGjD,yDAAyD;AACzD,eAAO,MAAM,aAAa,QAAS,CAAC;AAEpC;;;;;;GAMG;AACH,wBAAgB,uBAAuB,CACrC,UAAU,EAAE,EAAE,CAAC,aAAa,EAC5B,IAAI,EAAE,MAAM,EACZ,OAAO,SAAgB,GACtB,OAAO,CAAC,EAAE,CAAC,GAAG,CAAC,kBAAkB,CAAC,CA0BpC"}
+{"version":3,"file":"ConnectionUtils.d.ts","sourceRoot":"","sources":["../src/ConnectionUtils.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,EAAE,EAAE,MAAM,wBAAwB,CAAC;AAGjD,yDAAyD;AACzD,eAAO,MAAM,aAAa,QAAS,CAAC;AAEpC;;;;;;;;;GASG;AACH,wBAAgB,uBAAuB,CACrC,UAAU,EAAE,EAAE,CAAC,aAAa,EAC5B,IAAI,EAAE,MAAM,EACZ,OAAO,SAAgB,GACtB,OAAO,CAAC,EAAE,CAAC,GAAG,CAAC,kBAAkB,CAAC,CAOpC;AAED;;;;;;;;;;GAUG;AACH,wBAAgB,kCAAkC,CAChD,UAAU,EAAE,EAAE,CAAC,aAAa,EAC5B,SAAS,EAAE,CAAC,UAAU,EAAE,EAAE,CAAC,GAAG,CAAC,kBAAkB,KAAK,OAAO,EAC7D,OAAO,SAAgB,EACvB,YAAY,SAAuB,GAClC,OAAO,CAAC,EAAE,CAAC,GAAG,CAAC,kBAAkB,CAAC,CA0BpC"}

package/dist/ConnectionUtils.js

@@ -4,35 +4,55 @@ import { TimeoutError } from '@deephaven/utils';
 export var FETCH_TIMEOUT = 10000;
 
 /**
- * Fetch the definition for a variable given a connection. Subscribes to field updates and triggers when the variable is found.
+ * Fetch the definition for a variable given a connection. Waits for the next
+ * field update event and resolves if the variable is found in the created
+ * variables.
  * @param connection Connection to get the variable from
  * @param name Name of the definition to fetch
  * @param timeout Timeout for the fetch
- * @returns Promise the resolves to the variable definition if found, or rejects if there's an error or the timeout has exceeded
+ * @returns Promise that resolves to the variable definition if found in the next field update,
+ *          or rejects if the variable is not found in that update or if the timeout is exceeded
  */
 export function fetchVariableDefinition(connection, name) {
   var timeout = arguments.length > 2 && arguments[2] !== undefined ? arguments[2] : FETCH_TIMEOUT;
+  return fetchVariableDefinitionByPredicate(connection, def => def.title === name, timeout, "Variable ".concat(name, " not found"));
+}
+
+/**
+ * Fetch the definition for a variable given a connection. Waits for the next
+ * field update event and resolves if a variable matching the predicate is found
+ * in the created variables.
+ * @param connection Connection to get the variable from
+ * @param predicate Predicate function to test each variable definition
+ * @param timeout Timeout for the fetch
+ * @param errorMessage Optional error message for timeout and not found errors
+ * @returns Promise that resolves to the variable definition if found in the next field update,
+ *          or rejects if no matching variable is found in that update or if the timeout is exceeded
+ */
+export function fetchVariableDefinitionByPredicate(connection, predicate) {
+  var timeout = arguments.length > 2 && arguments[2] !== undefined ? arguments[2] : FETCH_TIMEOUT;
+  var errorMessage = arguments.length > 3 && arguments[3] !== undefined ? arguments[3] : 'Variable not found';
   return new Promise((resolve, reject) => {
     var removeListener;
     var timeoutId = setTimeout(() => {
       var _removeListener;
       (_removeListener = removeListener) === null || _removeListener === void 0 || _removeListener();
-      reject(new TimeoutError("Timeout looking for variable ".concat(name)));
+      reject(new TimeoutError("Timeout: ".concat(errorMessage)));
     }, timeout);
 
     /**
-     * Checks if the variable we're looking for is in the changes, and resolves the promise if it does
+     * Checks if a variable matching the predicate is in the changes, and resolves the promise if it does
      * @param changes Variables changes that have occurred
      */
     function handleFieldUpdates(changes) {
       var _removeListener2;
-      var definition = changes.created.find(def => def.title === name);
+      var definition = changes.created.find(predicate);
       clearTimeout(timeoutId);
       (_removeListener2 = removeListener) === null || _removeListener2 === void 0 || _removeListener2();
       if (definition != null) {
         resolve(definition);
       } else {
-        reject(new Error("Variable ".concat(name, " not found")));
+        reject(new Error(errorMessage));
       }
     }
     removeListener = connection.subscribeToFieldUpdates(handleFieldUpdates);

package/dist/ConnectionUtils.js.map

@@ -1 +1 @@
-{"version":3,"file":"ConnectionUtils.js","names":["TimeoutError","FETCH_TIMEOUT","fetchVariableDefinition","connection","name","timeout","arguments","length","undefined","Promise","resolve","reject","removeListener","timeoutId","setTimeout","_removeListener","concat","handleFieldUpdates","changes","_removeListener2","definition","created","find","def","title","clearTimeout","Error","subscribeToFieldUpdates"],"sources":["../src/ConnectionUtils.ts"],"sourcesContent":["import type { dh } from '@deephaven/jsapi-types';\nimport { TimeoutError } from '@deephaven/utils';\n\n/** Default timeout for fetching a variable definition */\nexport const FETCH_TIMEOUT = 10_000;\n\n/**\n * Fetch the definition for a variable given a connection. Subscribes to field updates and triggers when the variable is found.\n * @param connection Connection to get the variable from\n * @param name Name of the definition to fetch\n * @param timeout Timeout for the fetch\n * @returns Promise the resolves to the variable definition if found, or rejects if there's an error or the timeout has exceeded\n */\nexport function fetchVariableDefinition(\n  connection: dh.IdeConnection,\n  name: string,\n  timeout = FETCH_TIMEOUT\n): Promise<dh.ide.VariableDefinition> {\n  return new Promise<dh.ide.VariableDefinition>((resolve, reject) => {\n    let removeListener: () => void;\n\n    const timeoutId = setTimeout(() => {\n      removeListener?.();\n      reject(new TimeoutError(`Timeout looking for variable ${name}`));\n    }, timeout);\n\n    /**\n     * Checks if the variable we're looking for is in the changes, and resolves the promise if it does\n     * @param changes Variables changes that have occurred\n     */\n    function handleFieldUpdates(changes: dh.ide.VariableChanges): void {\n      const definition = changes.created.find(def => def.title === name);\n      clearTimeout(timeoutId);\n      removeListener?.();\n      if (definition != null) {\n        resolve(definition);\n      } else {\n        reject(new Error(`Variable ${name} not found`));\n      }\n    }\n\n    removeListener = connection.subscribeToFieldUpdates(handleFieldUpdates);\n  });\n}\n"],"mappings":"AACA,SAASA,YAAY,QAAQ,kBAAkB;;AAE/C;AACA,OAAO,IAAMC,aAAa,GAAG,KAAM;;AAEnC;AACA;AACA;AACA;AACA;AACA;AACA;AACA,OAAO,SAASC,uBAAuBA,CACrCC,UAA4B,EAC5BC,IAAY,EAEwB;EAAA,IADpCC,OAAO,GAAAC,SAAA,CAAAC,MAAA,QAAAD,SAAA,QAAAE,SAAA,GAAAF,SAAA,MAAGL,aAAa;EAEvB,OAAO,IAAIQ,OAAO,CAA4B,CAACC,OAAO,EAAEC,MAAM,KAAK;IACjE,IAAIC,cAA0B;IAE9B,IAAMC,SAAS,GAAGC,UAAU,CAAC,MAAM;MAAA,IAAAC,eAAA;MACjC,CAAAA,eAAA,GAAAH,cAAc,cAAAG,eAAA,eAAdA,eAAA,CAAiB,CAAC;MAClBJ,MAAM,CAAC,IAAIX,YAAY,iCAAAgB,MAAA,CAAiCZ,IAAI,CAAE,CAAC,CAAC;IAClE,CAAC,EAAEC,OAAO,CAAC;;IAEX;AACJ;AACA;AACA;IACI,SAASY,kBAAkBA,CAACC,OAA+B,EAAQ;MAAA,IAAAC,gBAAA;MACjE,IAAMC,UAAU,GAAGF,OAAO,CAACG,OAAO,CAACC,IAAI,CAACC,GAAG,IAAIA,GAAG,CAACC,KAAK,KAAKpB,IAAI,CAAC;MAClEqB,YAAY,CAACZ,SAAS,CAAC;MACvB,CAAAM,gBAAA,GAAAP,cAAc,cAAAO,gBAAA,eAAdA,gBAAA,CAAiB,CAAC;MAClB,IAAIC,UAAU,IAAI,IAAI,EAAE;QACtBV,OAAO,CAACU,UAAU,CAAC;MACrB,CAAC,MAAM;QACLT,MAAM,CAAC,IAAIe,KAAK,aAAAV,MAAA,CAAaZ,IAAI,eAAY,CAAC,CAAC;MACjD;IACF;IAEAQ,cAAc,GAAGT,UAAU,CAACwB,uBAAuB,CAACV,kBAAkB,CAAC;EACzE,CAAC,CAAC;AACJ","ignoreList":[]}
+{"version":3,"file":"ConnectionUtils.js","names":["TimeoutError","FETCH_TIMEOUT","fetchVariableDefinition","connection","name","timeout","arguments","length","undefined","fetchVariableDefinitionByPredicate","def","title","concat","predicate","errorMessage","Promise","resolve","reject","removeListener","timeoutId","setTimeout","_removeListener","handleFieldUpdates","changes","_removeListener2","definition","created","find","clearTimeout","Error","subscribeToFieldUpdates"],"sources":["../src/ConnectionUtils.ts"],"sourcesContent":["import type { dh } from '@deephaven/jsapi-types';\nimport { TimeoutError } from '@deephaven/utils';\n\n/** Default timeout for fetching a variable definition */\nexport const FETCH_TIMEOUT = 10_000;\n\n/**\n * Fetch the definition for a variable given a connection. Waits for the next\n * field update event and resolves if the variable is found in the created\n * variables.\n * @param connection Connection to get the variable from\n * @param name Name of the definition to fetch\n * @param timeout Timeout for the fetch\n * @returns Promise that resolves to the variable definition if found in the next field update,\n *          or rejects if the variable is not found in that update or if the timeout is exceeded\n */\nexport function fetchVariableDefinition(\n  connection: dh.IdeConnection,\n  name: string,\n  timeout = FETCH_TIMEOUT\n): Promise<dh.ide.VariableDefinition> {\n  return fetchVariableDefinitionByPredicate(\n    connection,\n    def => def.title === name,\n    timeout,\n    `Variable ${name} not found`\n  );\n}\n\n/**\n * Fetch the definition for a variable given a connection. Waits for the next\n * field update event and resolves if a variable matching the predicate is found\n * in the created variables.\n * @param connection Connection to get the variable from\n * @param predicate Predicate function to test each variable definition\n * @param timeout Timeout for the fetch\n * @param errorMessage Optional error message for timeout and not found errors\n * @returns Promise that resolves to the variable definition if found in the next field update,\n *          or rejects if no matching variable is found in that update or if the timeout is exceeded\n */\nexport function fetchVariableDefinitionByPredicate(\n  connection: dh.IdeConnection,\n  predicate: (definition: dh.ide.VariableDefinition) => boolean,\n  timeout = FETCH_TIMEOUT,\n  errorMessage = 'Variable not found'\n): Promise<dh.ide.VariableDefinition> {\n  return new Promise<dh.ide.VariableDefinition>((resolve, reject) => {\n    let removeListener: () => void;\n\n    const timeoutId = setTimeout(() => {\n      removeListener?.();\n      reject(new TimeoutError(`Timeout: ${errorMessage}`));\n    }, timeout);\n\n    /**\n     * Checks if a variable matching the predicate is in the changes, and resolves the promise if it does\n     * @param changes Variables changes that have occurred\n     */\n    function handleFieldUpdates(changes: dh.ide.VariableChanges): void {\n      const definition = changes.created.find(predicate);\n      clearTimeout(timeoutId);\n      removeListener?.();\n      if (definition != null) {\n        resolve(definition);\n      } else {\n        reject(new Error(errorMessage));\n      }\n    }\n\n    removeListener = connection.subscribeToFieldUpdates(handleFieldUpdates);\n  });\n}\n"],"mappings":"AACA,SAASA,YAAY,QAAQ,kBAAkB;;AAE/C;AACA,OAAO,IAAMC,aAAa,GAAG,KAAM;;AAEnC;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA,OAAO,SAASC,uBAAuBA,CACrCC,UAA4B,EAC5BC,IAAY,EAEwB;EAAA,IADpCC,OAAO,GAAAC,SAAA,CAAAC,MAAA,QAAAD,SAAA,QAAAE,SAAA,GAAAF,SAAA,MAAGL,aAAa;EAEvB,OAAOQ,kCAAkC,CACvCN,UAAU,EACVO,GAAG,IAAIA,GAAG,CAACC,KAAK,KAAKP,IAAI,EACzBC,OAAO,cAAAO,MAAA,CACKR,IAAI,eAClB,CAAC;AACH;;AAEA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA,OAAO,SAASK,kCAAkCA,CAChDN,UAA4B,EAC5BU,SAA6D,EAGzB;EAAA,IAFpCR,OAAO,GAAAC,SAAA,CAAAC,MAAA,QAAAD,SAAA,QAAAE,SAAA,GAAAF,SAAA,MAAGL,aAAa;EAAA,IACvBa,YAAY,GAAAR,SAAA,CAAAC,MAAA,QAAAD,SAAA,QAAAE,SAAA,GAAAF,SAAA,MAAG,oBAAoB;EAEnC,OAAO,IAAIS,OAAO,CAA4B,CAACC,OAAO,EAAEC,MAAM,KAAK;IACjE,IAAIC,cAA0B;IAE9B,IAAMC,SAAS,GAAGC,UAAU,CAAC,MAAM;MAAA,IAAAC,eAAA;MACjC,CAAAA,eAAA,GAAAH,cAAc,cAAAG,eAAA,eAAdA,eAAA,CAAiB,CAAC;MAClBJ,MAAM,CAAC,IAAIjB,YAAY,aAAAY,MAAA,CAAaE,YAAY,CAAE,CAAC,CAAC;IACtD,CAAC,EAAET,OAAO,CAAC;;IAEX;AACJ;AACA;AACA;IACI,SAASiB,kBAAkBA,CAACC,OAA+B,EAAQ;MAAA,IAAAC,gBAAA;MACjE,IAAMC,UAAU,GAAGF,OAAO,CAACG,OAAO,CAACC,IAAI,CAACd,SAAS,CAAC;MAClDe,YAAY,CAACT,SAAS,CAAC;MACvB,CAAAK,gBAAA,GAAAN,cAAc,cAAAM,gBAAA,eAAdA,gBAAA,CAAiB,CAAC;MAClB,IAAIC,UAAU,IAAI,IAAI,EAAE;QACtBT,OAAO,CAACS,UAAU,CAAC;MACrB,CAAC,MAAM;QACLR,MAAM,CAAC,IAAIY,KAAK,CAACf,YAAY,CAAC,CAAC;MACjC;IACF;IAEAI,cAAc,GAAGf,UAAU,CAAC2B,uBAAuB,CAACR,kBAAkB,CAAC;EACzE,CAAC,CAAC;AACJ","ignoreList":[]}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@deephaven/jsapi-utils",
-  "version": "1.12.1",
+  "version": "1.16.0",
   "description": "Deephaven JSAPI Utils",
   "author": "Deephaven Data Labs LLC",
   "license": "Apache-2.0",
@@ -39,5 +39,5 @@
   "publishConfig": {
     "access": "public"
   },
-  "gitHead": "596cbf468ab8d8222872bf620493f12dc75e7d0a"
+  "gitHead": "33a489fbfa08dd8000983267ddae69217db90224"
 }