core-3nweb-client-lib 0.30.5 → 0.31.0

package/build/core-ipc/json-ipc-wrapping/json-n-binary.js

@@ -0,0 +1,216 @@
+"use strict";
+/*
+ Copyright (C) 2022 - 2023 3NSoft Inc.
+ 
+ This program is free software: you can redistribute it and/or modify it under
+ the terms of the GNU General Public License as published by the Free Software
+ Foundation, either version 3 of the License, or (at your option) any later
+ version.
+ 
+ This program is distributed in the hope that it will be useful, but
+ WITHOUT ANY WARRANTY; without even the implied warranty of
+ MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
+ See the GNU General Public License for more details.
+ 
+ You should have received a copy of the GNU General Public License along with
+ this program. If not, see <http://www.gnu.org/licenses/>.
+*/
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.serializeArgs = serializeArgs;
+exports.deserializeArgs = deserializeArgs;
+const protobuf_type_1 = require("../../lib-client/protobuf-type");
+const json_utils_1 = require("../../lib-common/json-utils");
+const json_ipc_proto_1 = require("../../protos/json-ipc.proto");
+const valuesType = protobuf_type_1.ProtoType.for(json_ipc_proto_1.json_ipc.ValuesSequence);
+function serializeArgs(args) {
+    const { seq, passedByReference } = argsToValuesSequence(args);
+    return { bytes: valuesType.pack(seq), passedByReference };
+}
+function argsToValuesSequence(args) {
+    const seq = { values: [] };
+    const passedByReference = [];
+    for (const arg of args) {
+        if (arg && (typeof arg === 'object')) {
+            if (ArrayBuffer.isView(arg)) {
+                seq.values.push({
+                    arr: { arr: arg, objLocation: [] }
+                });
+            }
+            else if (arg._isObjectFromCore) {
+                const indexInPassed = addToArray(passedByReference, arg);
+                seq.values.push({
+                    transferred: { indexInPassed, objLocation: [] }
+                });
+            }
+            else {
+                seq.values.push(turnToJsonExtractingBinaryAndTransferable(arg, passedByReference));
+            }
+        }
+        else {
+            seq.values.push({
+                json: JSON.stringify(arg)
+            });
+        }
+    }
+    return {
+        seq,
+        passedByReference: ((passedByReference.length > 0) ?
+            passedByReference : undefined)
+    };
+}
+function addToArray(arr, o) {
+    let foundIndex = arr.indexOf(o);
+    if (foundIndex < 0) {
+        arr.push(o);
+        return arr.length - 1;
+    }
+    else {
+        return foundIndex;
+    }
+}
+function turnToJsonExtractingBinaryAndTransferable(arg, passedByReference) {
+    const parts = extractNonJsonableFrom(arg, passedByReference);
+    if (parts) {
+        const { copy, binaryInJson, transferredInJson } = parts;
+        return {
+            json: JSON.stringify(copy),
+            binaryInJson: ((binaryInJson.length > 0) ? binaryInJson : undefined),
+            transferredInJson: ((transferredInJson.length > 0) ?
+                transferredInJson : undefined)
+        };
+    }
+    else {
+        return { json: JSON.stringify(arg) };
+    }
+}
+function extractNonJsonableFrom(arg, passedByReference) {
+    const nonJsonLocations = findAllNonJsonable(arg);
+    if (!nonJsonLocations) {
+        return;
+    }
+    const copy = (0, json_utils_1.copy)(arg);
+    const binaryInJson = [];
+    const transferredInJson = [];
+    for (const objLocation of nonJsonLocations) {
+        const nonJson = getValueAtObjLocation(arg, objLocation);
+        setNewValueAtObjLocation(copy, objLocation, null);
+        if (nonJson._isObjectFromCore) {
+            const indexInPassed = addToArray(passedByReference, nonJson);
+            transferredInJson.push({ indexInPassed, objLocation });
+        }
+        else {
+            binaryInJson.push({ arr: nonJson, objLocation });
+        }
+    }
+    return { copy, binaryInJson, transferredInJson };
+}
+function findAllNonJsonable(o) {
+    const foundObjLocations = [];
+    if (ArrayBuffer.isView(o)
+        || o._isObjectFromCore) {
+        return [[]];
+    }
+    if (Array.isArray(o)) {
+        for (let i = 0; i < o.length; i += 1) {
+            const child = o[i];
+            if (child && (typeof child === 'object')) {
+                const inChild = findAllNonJsonable(child);
+                if (inChild) {
+                    for (const objLocation of inChild) {
+                        foundObjLocations.push([`${i}`, ...objLocation]);
+                    }
+                }
+            }
+        }
+    }
+    else {
+        for (const [field, child] of Object.entries(o)) {
+            if (child && (typeof child === 'object')) {
+                const inChild = findAllNonJsonable(child);
+                if (inChild) {
+                    for (const objLocation of inChild) {
+                        foundObjLocations.push([field, ...objLocation]);
+                    }
+                }
+            }
+        }
+    }
+    return ((foundObjLocations.length > 0) ? foundObjLocations : undefined);
+}
+function getValueAtObjLocation(o, objLocation) {
+    const value = o[objLocation[0]];
+    if (objLocation.length > 1) {
+        return getValueAtObjLocation(value, objLocation.slice(1));
+    }
+    else {
+        return value;
+    }
+}
+function setNewValueAtObjLocation(o, objLocation, newValue) {
+    const value = o[objLocation[0]];
+    if (objLocation.length > 1) {
+        setNewValueAtObjLocation(value, objLocation.slice(1), newValue);
+    }
+    else {
+        o[objLocation[0]] = newValue;
+    }
+}
+function getInitAndSetNewValueAt(o, objLocation, newValue) {
+    const value = o[objLocation[0]];
+    if (objLocation.length > 1) {
+        return getInitAndSetNewValueAt(value, objLocation.slice(1), newValue);
+    }
+    else {
+        o[objLocation[0]] = newValue;
+        return value;
+    }
+}
+function deserializeArgs(bytes, passedByReference) {
+    const values = valuesType.unpack(bytes);
+    const args = [];
+    for (const val of values.values) {
+        const { json, binaryInJson, transferredInJson, arr, transferred } = val;
+        if (arr) {
+            args.push(arr.arr);
+        }
+        else if (transferred) {
+            args.push(getTransferred(transferred.indexInPassed, passedByReference));
+        }
+        else if ((typeof json === 'string') && (json.length > 0)) {
+            const arg = JSON.parse(json);
+            if (binaryInJson) {
+                attachBinaryArrays(arg, binaryInJson);
+            }
+            if (transferredInJson) {
+                attachTransferred(arg, transferredInJson, passedByReference);
+            }
+            args.push(arg);
+        }
+        else {
+            // XXX throw error here
+        }
+    }
+    return args;
+}
+function attachBinaryArrays(arg, binaryInJson) {
+    for (const { arr, objLocation } of binaryInJson) {
+        setNewValueAtObjLocation(arg, objLocation, arr);
+    }
+}
+function getTransferred(indexInPassed, passedByReference) {
+    if (!passedByReference) {
+        // XXX throw error here
+        throw new Error(`need better error`);
+    }
+    const o = passedByReference[indexInPassed];
+    if (!o || !o._isObjectFromCore) {
+        // XXX throw error here
+        throw new Error(`need better error`);
+    }
+    return o;
+}
+function attachTransferred(arg, transferredInJson, passedByReference) {
+    for (const { indexInPassed, objLocation } of transferredInJson) {
+        setNewValueAtObjLocation(arg, objLocation, getTransferred(indexInPassed, passedByReference));
+    }
+}

package/build/core-ipc/json-ipc-wrapping/service-side-wrap.d.ts

@@ -0,0 +1,16 @@
+import { ExposedFn } from "../../ipc-via-protobuf/connector";
+type Observer<T> = web3n.Observer<T>;
+interface PassedDatum {
+    bytes?: Uint8Array;
+    passedByReference?: any[];
+}
+export type HandleObservingCall<TEvent> = (obs: Observer<TEvent>, ...requestArgs: any[]) => (() => void);
+export type HandleReqReplyCall = (...requestArgs: any[]) => Promise<any>;
+export interface TransformOpts {
+    unpackRequest?: ((req: PassedDatum | undefined) => any[]) | 'noop';
+    packReply?: ((reply: any) => PassedDatum | undefined) | 'noop';
+}
+export declare function wrapReqReplySrvMethod<T extends object, M extends keyof T>(srv: T, method: M, transforms?: TransformOpts): ExposedFn;
+export declare function wrapReqReplyFunc(srv: object | undefined, func: HandleReqReplyCall, transforms?: TransformOpts): ExposedFn;
+export declare function wrapObservingFunc<TEvent>(srv: object | undefined, func: HandleObservingCall<TEvent>, transforms?: TransformOpts): ExposedFn;
+export {};

package/build/core-ipc/json-ipc-wrapping/service-side-wrap.js

@@ -0,0 +1,87 @@
+"use strict";
+/*
+ Copyright (C) 2022 - 2024 3NSoft Inc.
+ 
+ This program is free software: you can redistribute it and/or modify it under
+ the terms of the GNU General Public License as published by the Free Software
+ Foundation, either version 3 of the License, or (at your option) any later
+ version.
+ 
+ This program is distributed in the hope that it will be useful, but
+ WITHOUT ANY WARRANTY; without even the implied warranty of
+ MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
+ See the GNU General Public License for more details.
+ 
+ You should have received a copy of the GNU General Public License along with
+ this program. If not, see <http://www.gnu.org/licenses/>.
+*/
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.wrapReqReplySrvMethod = wrapReqReplySrvMethod;
+exports.wrapReqReplyFunc = wrapReqReplyFunc;
+exports.wrapObservingFunc = wrapObservingFunc;
+const rxjs_1 = require("rxjs");
+const json_n_binary_1 = require("./json-n-binary");
+function wrapReqReplySrvMethod(srv, method, transforms) {
+    return wrapReqReplyFunc(srv, srv[method], transforms);
+}
+function wrapReqReplyFunc(srv, func, transforms) {
+    return buf => {
+        const args = argsFromBuffer(buf, transforms);
+        const promise = (args ?
+            func.call(srv, ...args) :
+            func.call(srv)).then(result => resultToBuffer(result, transforms));
+        return { promise };
+    };
+}
+function argsFromBuffer(buf, transforms) {
+    return argsFromPassedDatum({ bytes: buf }, transforms === null || transforms === void 0 ? void 0 : transforms.unpackRequest);
+}
+function resultToBuffer(data, transforms) {
+    const sequencePack = toPassedDatum(data, transforms === null || transforms === void 0 ? void 0 : transforms.packReply);
+    return sequencePack === null || sequencePack === void 0 ? void 0 : sequencePack.bytes;
+}
+function argsFromPassedDatum(data, unpack) {
+    if (!data) {
+        return;
+    }
+    if (unpack) {
+        if (unpack === 'noop') {
+            return [data.bytes];
+        }
+        else {
+            return unpack(data);
+        }
+    }
+    else {
+        const { bytes, passedByReference } = data;
+        return (bytes ? (0, json_n_binary_1.deserializeArgs)(bytes, passedByReference) : undefined);
+    }
+}
+function toPassedDatum(data, pack) {
+    if (data === undefined) {
+        return;
+    }
+    if (pack) {
+        if (pack === 'noop') {
+            if (!ArrayBuffer.isView(data)) {
+                throw new Error(`Method returned non-binary, while no serialization is set`);
+            }
+            return { bytes: data };
+        }
+        return pack(data);
+    }
+    else {
+        return (0, json_n_binary_1.serializeArgs)([data]);
+    }
+}
+function wrapObservingFunc(srv, func, transforms) {
+    return buf => {
+        const args = argsFromBuffer(buf, transforms);
+        const s = new rxjs_1.Subject();
+        const obs = s.asObservable().pipe((0, rxjs_1.map)(ev => resultToBuffer(ev, transforms)));
+        const onCancel = (args ?
+            func.call(srv, s, ...args) :
+            func.call(srv, s));
+        return { obs, onCancel };
+    };
+}

package/build/core-ipc/log-cap.js

@@ -1,6 +1,6 @@
 "use strict";
 /*
- Copyright (C) 2020, 2022 3NSoft Inc.
+ Copyright (C) 2020, 2022, 2024 3NSoft Inc.
  
  This program is free software: you can redistribute it and/or modify it under
  the terms of the GNU General Public License as published by the Free Software
@@ -18,26 +18,14 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.exposeLogger = exposeLogger;
 exports.makeLogCaller = makeLogCaller;
-const protobuf_msg_1 = require("../ipc-via-protobuf/protobuf-msg");
-const protobuf_type_1 = require("../lib-client/protobuf-type");
-const logger_proto_1 = require("../protos/logger.proto");
-const logReqType = protobuf_type_1.ProtoType.for(logger_proto_1.logger.LogRequestBody);
+const error_1 = require("../lib-common/exceptions/error");
+const caller_side_wrap_1 = require("./json-ipc-wrapping/caller-side-wrap");
+const service_side_wrap_1 = require("./json-ipc-wrapping/service-side-wrap");
 function exposeLogger(fn) {
-    return buf => {
-        const { logType, msg, err } = logReqType.unpack(buf);
-        const promise = (err ?
-            fn(logType, msg, (0, protobuf_msg_1.errFromMsg)(err)) :
-            fn(logType, msg));
-        return { promise };
-    };
+    return (0, service_side_wrap_1.wrapReqReplyFunc)(undefined, fn);
 }
 function makeLogCaller(caller, path) {
-    return (type, msg, err) => {
-        const req = { logType: type, msg };
-        if (err) {
-            req.err = (0, protobuf_msg_1.errToMsg)(err);
-        }
-        return caller.startPromiseCall(path, logReqType.pack(req));
-    };
+    const log = (0, caller_side_wrap_1.makeReqRepFuncCaller)(caller, path);
+    return (type, msg, err) => log(type, msg, (0, error_1.stringifyErr)(err));
 }
 Object.freeze(exports);

package/build/ipc.d.ts

@@ -5,3 +5,5 @@ export { FileMsg, makeFileCaller, exposeFileService } from "./core-ipc/file";
 export { FSMsg, makeFSCaller, exposeFSService } from "./core-ipc/fs";
 export { makeSinkCaller, exposeSinkService, makeSrcCaller, exposeSrcService } from "./core-ipc/bytes";
 export { makeLogCaller, exposeLogger } from "./core-ipc/log-cap";
+export * as callerSideJSONWrap from "./core-ipc/json-ipc-wrapping/caller-side-wrap";
+export * as serviceSideJSONWrap from "./core-ipc/json-ipc-wrapping/service-side-wrap";

package/build/ipc.js

@@ -1,6 +1,6 @@
 "use strict";
 /*
- Copyright (C) 2020 - 2021 3NSoft Inc.
+ Copyright (C) 2020 - 2021, 2024 3NSoft Inc.
 
  This program is free software: you can redistribute it and/or modify it under
  the terms of the GNU General Public License as published by the Free Software
@@ -30,7 +30,7 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
     for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.exposeLogger = exports.makeLogCaller = exports.exposeSrcService = exports.makeSrcCaller = exports.exposeSinkService = exports.makeSinkCaller = exports.exposeFSService = exports.makeFSCaller = exports.exposeFileService = exports.makeFileCaller = void 0;
+exports.serviceSideJSONWrap = exports.callerSideJSONWrap = exports.exposeLogger = exports.makeLogCaller = exports.exposeSrcService = exports.makeSrcCaller = exports.exposeSinkService = exports.makeSinkCaller = exports.exposeFSService = exports.makeFSCaller = exports.exposeFileService = exports.makeFileCaller = void 0;
 __exportStar(require("./core-ipc/common-caps"), exports);
 __exportStar(require("./core-ipc/startup-caps"), exports);
 __exportStar(require("./ipc-via-protobuf/connector"), exports);
@@ -48,4 +48,6 @@ Object.defineProperty(exports, "exposeSrcService", { enumerable: true, get: func
 var log_cap_1 = require("./core-ipc/log-cap");
 Object.defineProperty(exports, "makeLogCaller", { enumerable: true, get: function () { return log_cap_1.makeLogCaller; } });
 Object.defineProperty(exports, "exposeLogger", { enumerable: true, get: function () { return log_cap_1.exposeLogger; } });
+exports.callerSideJSONWrap = require("./core-ipc/json-ipc-wrapping/caller-side-wrap");
+exports.serviceSideJSONWrap = require("./core-ipc/json-ipc-wrapping/service-side-wrap");
 Object.freeze(exports);