@hpcc-js/comms 3.17.8 → 3.18.0

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@hpcc-js/comms",
-    "version": "3.17.8",
+    "version": "3.18.0",
     "description": "hpcc-js - Communications",
     "type": "module",
     "main": "./dist/node/index.cjs",
@@ -76,13 +76,13 @@
         "wsdl-all": "npm-run-all --aggregate-output -c --serial build --parallel wsdl-*"
     },
     "dependencies": {
-        "@hpcc-js/util": "^3.6.8",
+        "@hpcc-js/util": "^3.6.9",
         "@xmldom/xmldom": "0.9.10",
         "undici": "8.10.0"
     },
     "devDependencies": {
-        "@hpcc-js/ddl-shim": "^3.4.8",
-        "@hpcc-js/esbuild-plugins": "^1.10.0",
+        "@hpcc-js/ddl-shim": "^3.4.9",
+        "@hpcc-js/esbuild-plugins": "^1.11.0",
         "@kubernetes/client-node": "1.4.0",
         "@types/d3-request": "1.0.9",
         "@types/d3-time-format": "2.3.4",
@@ -112,5 +112,5 @@
         "esp",
         "HPCC-Platform"
     ],
-    "gitHead": "ac7ae6ce5cb17eb6d4dff831fa1aeeeca75cf77f"
+    "gitHead": "f25ae6319d1eb8cd83789674cdc00851af2b850c"
 }

package/src/connection.ts

@@ -3,7 +3,7 @@ import { join, promiseTimeout, root, scopedLogger, utf8ToBase64 } from "@hpcc-js
 const logger = scopedLogger("comms/connection.ts");
 
 export type RequestType = "post" | "get" | "jsonp";
-export type ResponseType = "json" | "text";
+export type ResponseType = "json" | "text" | "arraybuffer";
 
 export type IOptionsSend = (options: IOptions, action: string, request: any, responseType: ResponseType, defaultSend: SendFunc, header?: any) => Promise<any>;
 export interface IOptions {
@@ -163,9 +163,17 @@ function doFetch(opts: IOptions, action: string, requestInit: RequestInit, heade
         }
     }
 
-    function handleResponse(response: Response): Promise<any> {
+    function handleResponse(response: Response): Promise<any | ArrayBuffer | string> {
         if (response.ok) {
-            return responseType === "json" ? response.json() : response.text();
+            switch (responseType) {
+                case "json":
+                    return response.json();
+                case "arraybuffer":
+                    return response.arrayBuffer();
+                case "text":
+                default:
+                    return response.text();
+            }
         }
         throw new Error(response.statusText);
     }

package/src/ecl/workunit.ts

@@ -2,7 +2,7 @@ import { Cache, deepMixinT, IEvent, RecursivePartial, scopedLogger, StateCallbac
 import { format as d3Format } from "d3-format";
 import { utcFormat, utcParse } from "d3-time-format";
 import { IConnection, IOptions } from "../connection.ts";
-import { ESPExceptions } from "../espConnection.ts";
+import { ESPExceptions, ESPResponseType } from "../espConnection.ts";
 import { WsSMC } from "../services/wsSMC.ts";
 import * as WsTopology from "../services/wsTopology.ts";
 import { WsWorkunits, WUStateID, WorkunitsService, WorkunitsServiceEx, WUUpdate } from "../services/wsWorkunits.ts";
@@ -676,8 +676,24 @@ export class Workunit extends StateObject<UWorkunitState, IWorkunitState> implem
         return this.WUDetailsMeta(request);
     }
 
-    fetchDetailsRaw(request: RecursivePartial<WsWorkunits.WUDetails> = {}): Promise<WsWorkunits.Scope[]> {
-        return this.WUDetails(request).then(response => response.Scopes.Scope);
+    fetchDetailsRaw(request: RecursivePartial<WsWorkunits.WUDetails>, abortSignal?: AbortSignal, espResponseType?: ESPResponseType): Promise<WsWorkunits.Scope[]>;
+    fetchDetailsRaw(request: RecursivePartial<WsWorkunits.WUDetails>, abortSignal: AbortSignal | undefined, espResponseType: "json"): Promise<WsWorkunits.Scope[]>;
+    fetchDetailsRaw(request: RecursivePartial<WsWorkunits.WUDetails>, abortSignal: AbortSignal | undefined, espResponseType: "arraybuffer"): Promise<ArrayBuffer>;
+    fetchDetailsRaw(request: RecursivePartial<WsWorkunits.WUDetails>, abortSignal: AbortSignal | undefined, espResponseType: "text"): Promise<string>;
+    fetchDetailsRaw(request: RecursivePartial<WsWorkunits.WUDetails>, abortSignal: AbortSignal | undefined, espResponseType: "xsd"): Promise<string>;
+    fetchDetailsRaw(request: RecursivePartial<WsWorkunits.WUDetails> = {}, abortSignal?: AbortSignal, espResponseType?: ESPResponseType): Promise<WsWorkunits.Scope[] | ArrayBuffer | string> {
+        return this.WUDetails(request, abortSignal, espResponseType).then(response => {
+            switch (espResponseType) {
+                case "arraybuffer":
+                    return response as ArrayBuffer;
+                case "text":
+                case "xsd":
+                    return response as string;
+                case "json":
+                default:
+                    return response.Scopes.Scope;
+            }
+        });
     }
 
     normalizeDetails(meta: WsWorkunits.WUDetailsMetaResponse, scopes: WsWorkunits.Scope[]): { meta: WsWorkunits.WUDetailsMetaResponse, columns: { [id: string]: any }, data: IScope[] } {
@@ -833,11 +849,25 @@ export class Workunit extends StateObject<UWorkunitState, IWorkunitState> implem
         return this.WUInfo(request);
     }
 
-    fetchDetails(request: RecursivePartial<WsWorkunits.WUDetails> = {}): Promise<Scope[]> {
-        return this.WUDetails(request).then((response) => {
-            return response.Scopes.Scope.map((rawScope) => {
-                return new Scope(this, rawScope);
-            });
+    fetchDetails(request: RecursivePartial<WsWorkunits.WUDetails>, abortSignal?: AbortSignal, espResponseType?: ESPResponseType): Promise<Scope[]>;
+    fetchDetails(request: RecursivePartial<WsWorkunits.WUDetails>, abortSignal: AbortSignal | undefined, espResponseType: "json"): Promise<Scope[]>;
+    fetchDetails(request: RecursivePartial<WsWorkunits.WUDetails>, abortSignal: AbortSignal | undefined, espResponseType: "arraybuffer"): Promise<ArrayBuffer>;
+    fetchDetails(request: RecursivePartial<WsWorkunits.WUDetails>, abortSignal: AbortSignal | undefined, espResponseType: "text"): Promise<string>;
+    fetchDetails(request: RecursivePartial<WsWorkunits.WUDetails>, abortSignal: AbortSignal | undefined, espResponseType: "xsd"): Promise<string>;
+    fetchDetails(request: RecursivePartial<WsWorkunits.WUDetails> = {}, abortSignal?: AbortSignal, espResponseType?: ESPResponseType): Promise<Scope[] | ArrayBuffer | string> {
+        return this.WUDetails(request, abortSignal, espResponseType).then((response) => {
+            switch (espResponseType) {
+                case "arraybuffer":
+                    return response as ArrayBuffer;
+                case "text":
+                case "xsd":
+                    return response as string;
+                case "json":
+                default:
+                    return response.Scopes.Scope.map((rawScope) => {
+                        return new Scope(this, rawScope);
+                    });
+            }
         });
     }
 
@@ -1117,8 +1147,13 @@ export class Workunit extends StateObject<UWorkunitState, IWorkunitState> implem
         return this.connection.WUDetailsMeta(request);
     }
 
-    protected WUDetails(request: RecursivePartial<WsWorkunits.WUDetails>): Promise<WsWorkunits.WUDetailsResponse> {
-        return this.connection.WUDetails(deepMixinT<WsWorkunits.WUDetails>({
+    protected WUDetails(request: RecursivePartial<WsWorkunits.WUDetails>, abortSignal?: AbortSignal, espResponseType?: ESPResponseType): Promise<WsWorkunits.WUDetailsResponse>;
+    protected WUDetails(request: RecursivePartial<WsWorkunits.WUDetails>, abortSignal: AbortSignal | undefined, espResponseType: "json"): Promise<WsWorkunits.WUDetailsResponse>;
+    protected WUDetails(request: RecursivePartial<WsWorkunits.WUDetails>, abortSignal: AbortSignal | undefined, espResponseType: "arraybuffer"): Promise<ArrayBuffer>;
+    protected WUDetails(request: RecursivePartial<WsWorkunits.WUDetails>, abortSignal: AbortSignal | undefined, espResponseType: "text"): Promise<string>;
+    protected WUDetails(request: RecursivePartial<WsWorkunits.WUDetails>, abortSignal: AbortSignal | undefined, espResponseType: "xsd"): Promise<string>;
+    protected WUDetails(request: RecursivePartial<WsWorkunits.WUDetails>, abortSignal?: AbortSignal, espResponseType?: ESPResponseType): Promise<WsWorkunits.WUDetailsResponse | ArrayBuffer | string> {
+        return this.connection.WUDetailsEx(deepMixinT<WsWorkunits.WUDetails>({
             ScopeFilter: {
                 MaxDepth: 9999
             },
@@ -1136,12 +1171,23 @@ export class Workunit extends StateObject<UWorkunitState, IWorkunitState> implem
                 IncludeCreator: false,
                 IncludeCreatorType: false
             }
-        }, request, { WUID: this.Wuid })).then((response) => {
-            return deepMixinT<WsWorkunits.WUDetailsResponse>({
-                Scopes: {
-                    Scope: []
-                }
-            }, response);
+        }, request, { WUID: this.Wuid }), abortSignal, espResponseType).then((response) => {
+            switch (espResponseType) {
+                case "arraybuffer":
+                case "text":
+                case "xsd":
+                    return response;
+                case "json":
+                default:
+                    if (response.Scopes === undefined) {
+                        response.Scopes = {
+                            Scope: []
+                        };
+                    } else if (response.Scopes.Scope === undefined) {
+                        response.Scopes.Scope = [];
+                    }
+                    return response;
+            }
         });
     }
 

package/src/espConnection.ts

@@ -108,6 +108,10 @@ export class ESPConnection implements IConnection {
                 serviceAction = join(this._service, action);
                 responseType = "text";
                 break;
+            case "arraybuffer":
+                serviceAction = join(this._service, action + ".json");
+                responseType = "arraybuffer";
+                break;
             case "xsd":
                 serviceAction = join(this._service, action + ".xsd");
                 responseType = "text";
@@ -118,6 +122,7 @@ export class ESPConnection implements IConnection {
                 const actionParts = action.split("/");
                 action = actionParts.pop()!;
                 break;
+            case "json":
             default:
                 serviceAction = join(this._service, action + ".json");
         }

package/src/services/wsWorkunits.ts

@@ -1,6 +1,7 @@
 import { deepMixin, xml2json, XMLNode } from "@hpcc-js/util";
 import { WsWorkunits, WorkunitsServiceBase } from "./wsdl/WsWorkunits/v2.10/WsWorkunits.ts";
 import { IConnection, IOptions } from "../connection.ts";
+import { type ESPResponseType } from "../espConnection.ts";
 
 export {
     WsWorkunits
@@ -132,6 +133,15 @@ export class WorkunitsService extends WorkunitsServiceBase {
         return this._WUDetailsMetaPromise;
     }
 
+    WUDetailsEx(request: WsWorkunits.WUDetails, abortSignal?: AbortSignal, espResponseType?: ESPResponseType): Promise<WsWorkunits.WUDetailsResponse>;
+    WUDetailsEx(request: WsWorkunits.WUDetails, abortSignal: AbortSignal | undefined, espResponseType: "json"): Promise<WsWorkunits.WUDetailsResponse>;
+    WUDetailsEx(request: WsWorkunits.WUDetails, abortSignal: AbortSignal | undefined, espResponseType: "arraybuffer"): Promise<ArrayBuffer>;
+    WUDetailsEx(request: WsWorkunits.WUDetails, abortSignal: AbortSignal | undefined, espResponseType: "text"): Promise<string>;
+    WUDetailsEx(request: WsWorkunits.WUDetails, abortSignal: AbortSignal | undefined, espResponseType: "xsd"): Promise<string>;
+    WUDetailsEx(request: WsWorkunits.WUDetails, abortSignal?: AbortSignal, espResponseType?: ESPResponseType): Promise<WsWorkunits.WUDetailsResponse | ArrayBuffer | string> {
+        return this._connection.send("WUDetails", request, espResponseType, false, abortSignal, "WUDetailsResponse");
+    }
+
     WUCDebugEx(request: WsWorkunits.WUCDebug): Promise<XMLNode | null> {
         return this._connection.send("WUCDebug", request, undefined, undefined, undefined, "WUDebug").then((response) => {
             const retVal = xml2json(response.Result);

package/types/connection.d.ts

@@ -1,5 +1,5 @@
 export type RequestType = "post" | "get" | "jsonp";
-export type ResponseType = "json" | "text";
+export type ResponseType = "json" | "text" | "arraybuffer";
 export type IOptionsSend = (options: IOptions, action: string, request: any, responseType: ResponseType, defaultSend: SendFunc, header?: any) => Promise<any>;
 export interface IOptions {
     baseUrl: string;

package/types/ecl/workunit.d.ts

@@ -1,5 +1,6 @@
 import { Cache, RecursivePartial, StateCallback, StateEvents, StateObject, StatePropCallback, StringAnyMap, XMLNode } from "@hpcc-js/util";
 import { IConnection, IOptions } from "../connection.ts";
+import { ESPResponseType } from "../espConnection.ts";
 import { WsSMC } from "../services/wsSMC.ts";
 import * as WsTopology from "../services/wsTopology.ts";
 import { WsWorkunits, WUStateID, WorkunitsService, WUUpdate } from "../services/wsWorkunits.ts";
@@ -221,7 +222,11 @@ export declare class Workunit extends StateObject<UWorkunitState, IWorkunitState
     fetchTotalClusterTime(): Promise<string>;
     fetchServiceNames(): Promise<string[]>;
     fetchDetailsMeta(request?: RecursivePartial<WsWorkunits.WUDetailsMeta>): Promise<WsWorkunits.WUDetailsMetaResponse>;
-    fetchDetailsRaw(request?: RecursivePartial<WsWorkunits.WUDetails>): Promise<WsWorkunits.Scope[]>;
+    fetchDetailsRaw(request: RecursivePartial<WsWorkunits.WUDetails>, abortSignal?: AbortSignal, espResponseType?: ESPResponseType): Promise<WsWorkunits.Scope[]>;
+    fetchDetailsRaw(request: RecursivePartial<WsWorkunits.WUDetails>, abortSignal: AbortSignal | undefined, espResponseType: "json"): Promise<WsWorkunits.Scope[]>;
+    fetchDetailsRaw(request: RecursivePartial<WsWorkunits.WUDetails>, abortSignal: AbortSignal | undefined, espResponseType: "arraybuffer"): Promise<ArrayBuffer>;
+    fetchDetailsRaw(request: RecursivePartial<WsWorkunits.WUDetails>, abortSignal: AbortSignal | undefined, espResponseType: "text"): Promise<string>;
+    fetchDetailsRaw(request: RecursivePartial<WsWorkunits.WUDetails>, abortSignal: AbortSignal | undefined, espResponseType: "xsd"): Promise<string>;
     normalizeDetails(meta: WsWorkunits.WUDetailsMetaResponse, scopes: WsWorkunits.Scope[]): {
         meta: WsWorkunits.WUDetailsMetaResponse;
         columns: {
@@ -237,7 +242,11 @@ export declare class Workunit extends StateObject<UWorkunitState, IWorkunitState
         data: IScope[];
     }>;
     fetchInfo(request?: Partial<WsWorkunits.WUInfo>): Promise<WsWorkunits.WUInfoResponse>;
-    fetchDetails(request?: RecursivePartial<WsWorkunits.WUDetails>): Promise<Scope[]>;
+    fetchDetails(request: RecursivePartial<WsWorkunits.WUDetails>, abortSignal?: AbortSignal, espResponseType?: ESPResponseType): Promise<Scope[]>;
+    fetchDetails(request: RecursivePartial<WsWorkunits.WUDetails>, abortSignal: AbortSignal | undefined, espResponseType: "json"): Promise<Scope[]>;
+    fetchDetails(request: RecursivePartial<WsWorkunits.WUDetails>, abortSignal: AbortSignal | undefined, espResponseType: "arraybuffer"): Promise<ArrayBuffer>;
+    fetchDetails(request: RecursivePartial<WsWorkunits.WUDetails>, abortSignal: AbortSignal | undefined, espResponseType: "text"): Promise<string>;
+    fetchDetails(request: RecursivePartial<WsWorkunits.WUDetails>, abortSignal: AbortSignal | undefined, espResponseType: "xsd"): Promise<string>;
     fetchDetailsHierarchy(request?: Partial<WsWorkunits.WUDetails>): Promise<Scope[]>;
     fetchGraphDetails(graphIDs: string[], rootTypes: string[]): Promise<BaseScope[]>;
     fetchScopeGraphs(graphIDs?: string[]): Promise<ScopeGraph>;
@@ -252,7 +261,11 @@ export declare class Workunit extends StateObject<UWorkunitState, IWorkunitState
     protected WUInfo(_request?: Partial<WsWorkunits.WUInfo>): Promise<WsWorkunits.WUInfoResponse>;
     protected WUResubmit(request: Partial<WsWorkunits.WUResubmit>): Promise<WsWorkunits.WUResubmitResponse>;
     protected WUDetailsMeta(request: Partial<WsWorkunits.WUDetailsMeta>): Promise<WsWorkunits.WUDetailsMetaResponse>;
-    protected WUDetails(request: RecursivePartial<WsWorkunits.WUDetails>): Promise<WsWorkunits.WUDetailsResponse>;
+    protected WUDetails(request: RecursivePartial<WsWorkunits.WUDetails>, abortSignal?: AbortSignal, espResponseType?: ESPResponseType): Promise<WsWorkunits.WUDetailsResponse>;
+    protected WUDetails(request: RecursivePartial<WsWorkunits.WUDetails>, abortSignal: AbortSignal | undefined, espResponseType: "json"): Promise<WsWorkunits.WUDetailsResponse>;
+    protected WUDetails(request: RecursivePartial<WsWorkunits.WUDetails>, abortSignal: AbortSignal | undefined, espResponseType: "arraybuffer"): Promise<ArrayBuffer>;
+    protected WUDetails(request: RecursivePartial<WsWorkunits.WUDetails>, abortSignal: AbortSignal | undefined, espResponseType: "text"): Promise<string>;
+    protected WUDetails(request: RecursivePartial<WsWorkunits.WUDetails>, abortSignal: AbortSignal | undefined, espResponseType: "xsd"): Promise<string>;
     protected WUAction(actionType: WsWorkunits.ECLWUActions): Promise<WsWorkunits.WUActionResponse>;
     publish(name?: string): Promise<WsWorkunits.WUPublishWorkunitResponse>;
     publishEx(request: Partial<WsWorkunits.WUPublishWorkunit>): Promise<WsWorkunits.WUPublishWorkunitResponse>;

package/types/services/wsWorkunits.d.ts

@@ -1,6 +1,7 @@
 import { XMLNode } from "@hpcc-js/util";
 import { WsWorkunits, WorkunitsServiceBase } from "./wsdl/WsWorkunits/v2.10/WsWorkunits.ts";
 import { IConnection, IOptions } from "../connection.ts";
+import { type ESPResponseType } from "../espConnection.ts";
 export { WsWorkunits };
 export declare enum WUStateID {
     Unknown = 0,
@@ -53,6 +54,11 @@ export declare class WorkunitsService extends WorkunitsServiceBase {
     WUFileEx(request: Partial<WsWorkunits.WUFile>): Promise<string>;
     private _WUDetailsMetaPromise;
     WUDetailsMeta(request: WsWorkunits.WUDetailsMeta): Promise<WsWorkunits.WUDetailsMetaResponse>;
+    WUDetailsEx(request: WsWorkunits.WUDetails, abortSignal?: AbortSignal, espResponseType?: ESPResponseType): Promise<WsWorkunits.WUDetailsResponse>;
+    WUDetailsEx(request: WsWorkunits.WUDetails, abortSignal: AbortSignal | undefined, espResponseType: "json"): Promise<WsWorkunits.WUDetailsResponse>;
+    WUDetailsEx(request: WsWorkunits.WUDetails, abortSignal: AbortSignal | undefined, espResponseType: "arraybuffer"): Promise<ArrayBuffer>;
+    WUDetailsEx(request: WsWorkunits.WUDetails, abortSignal: AbortSignal | undefined, espResponseType: "text"): Promise<string>;
+    WUDetailsEx(request: WsWorkunits.WUDetails, abortSignal: AbortSignal | undefined, espResponseType: "xsd"): Promise<string>;
     WUCDebugEx(request: WsWorkunits.WUCDebug): Promise<XMLNode | null>;
 }
 export declare class WorkunitsServiceEx extends WorkunitsServiceBase {