core-3nweb-client-lib 0.41.4 → 0.41.6

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

@@ -1,12 +1,11 @@
-import { Caller } from "../../ipc-via-protobuf/connector";
+import { Caller, EnvelopeBody } from "../../ipc-via-protobuf/connector";
+import { FindObjectRef, FindReferencedObj } from "./json-n-binary";
 type Observer<T> = web3n.Observer<T>;
-interface PassedDatum {
-    bytes?: Uint8Array;
-    passedByReference?: any[];
-}
 export interface TransformOpts {
-    unpackReply?: ((reply: PassedDatum | undefined) => any) | 'noop';
-    packRequest?: ((args: any[]) => PassedDatum | undefined) | 'noop';
+    unpackReply?: ((reply: EnvelopeBody) => any) | 'noop';
+    packRequest?: ((args: any[]) => EnvelopeBody) | 'noop';
+    findRefOf?: FindObjectRef;
+    findReferencedObj?: FindReferencedObj;
 }
 export declare function makeReqRepFuncCaller<F extends Function>(clientSide: Caller, path: string[], transforms?: TransformOpts): F;
 export declare function makeReqRepObjCaller<T, M extends keyof T>(clientSide: Caller, objPath: string[], method: M, transforms?: TransformOpts): T[M];

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

@@ -1,6 +1,6 @@
 "use strict";
 /*
- Copyright (C) 2022 - 2024 3NSoft Inc.
+ Copyright (C) 2022 - 2025 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
@@ -21,50 +21,44 @@ exports.makeReqRepObjCaller = makeReqRepObjCaller;
 exports.makeObservableFuncCaller = makeObservableFuncCaller;
 const rxjs_1 = require("rxjs");
 const json_n_binary_1 = require("./json-n-binary");
-function replyFromPassedDatum(data, unpack) {
-    if (!data) {
+function replyFromPassedDatum(bytes, transforms) {
+    if (!bytes) {
         return;
     }
-    if (unpack) {
-        if (unpack === 'noop') {
-            return [data.bytes];
+    if (transforms === null || transforms === void 0 ? void 0 : transforms.unpackReply) {
+        if (transforms.unpackReply === 'noop') {
+            return [bytes];
         }
         else {
-            return unpack(data);
+            return transforms.unpackReply(bytes);
         }
     }
     else {
-        const { bytes, passedByReference } = data;
-        return (bytes ? (0, json_n_binary_1.deserializeArgs)(bytes, passedByReference)[0] : undefined);
+        return (bytes ? (0, json_n_binary_1.deserializeArgs)(bytes, transforms === null || transforms === void 0 ? void 0 : transforms.findReferencedObj)[0] : undefined);
     }
 }
-function argsToPassedDatum(args, pack) {
+function argsToPassedDatum(args, transforms) {
     if (args === undefined) {
         return;
     }
-    if (pack) {
-        if (pack === 'noop') {
+    if (transforms === null || transforms === void 0 ? void 0 : transforms.packRequest) {
+        if (transforms.packRequest === 'noop') {
             if (!ArrayBuffer.isView(args[0])) {
                 throw new Error(`Method returned non-binary, while no serialization is set`);
             }
-            return { bytes: args[0] };
+            return args[0];
         }
-        return pack(args);
+        return transforms.packRequest(args);
     }
     else {
-        return (0, json_n_binary_1.serializeArgs)(args);
+        return (0, json_n_binary_1.serializeArgs)(args, transforms === null || transforms === void 0 ? void 0 : transforms.findRefOf);
     }
 }
 function makeReqRepFuncCaller(clientSide, path, transforms) {
     return (async (...args) => {
-        const req = argsToPassedDatum(args, transforms === null || transforms === void 0 ? void 0 : transforms.packRequest);
-        if (req === null || req === void 0 ? void 0 : req.passedByReference) {
-            throw new Error(`Passing by reference is notimplemented, yet.`);
-        }
-        const reply = await clientSide.startPromiseCall(path, req === null || req === void 0 ? void 0 : req.bytes);
-        return replyFromPassedDatum({
-            bytes: reply
-        }, transforms === null || transforms === void 0 ? void 0 : transforms.unpackReply);
+        const bytes = argsToPassedDatum(args, transforms);
+        const reply = await clientSide.startPromiseCall(path, bytes);
+        return replyFromPassedDatum(reply, transforms);
     });
 }
 function makeReqRepObjCaller(clientSide, objPath, method, transforms) {
@@ -72,15 +66,15 @@ function makeReqRepObjCaller(clientSide, objPath, method, transforms) {
 }
 function makeObservableFuncCaller(clientSide, path, transforms) {
     return (obs, ...args) => {
-        const req = argsToPassedDatum(args, transforms === null || transforms === void 0 ? void 0 : transforms.packRequest);
+        const bytes = argsToPassedDatum(args, transforms);
         const s = new rxjs_1.Subject();
-        const unsub = clientSide.startObservableCall(path, req === null || req === void 0 ? void 0 : req.bytes, s);
+        const unsub = clientSide.startObservableCall(path, bytes, s);
         s.subscribe({
             next: data => {
                 if (!obs.next) {
                     return;
                 }
-                const ev = replyFromPassedDatum({ bytes: data }, transforms === null || transforms === void 0 ? void 0 : transforms.unpackReply);
+                const ev = replyFromPassedDatum(data, transforms);
                 obs.next(ev);
             },
             complete: () => { var _a; return (_a = obs.complete) === null || _a === void 0 ? void 0 : _a.call(obs); },

package/build/core-ipc/json-ipc-wrapping/json-n-binary.d.ts

@@ -1,5 +1,5 @@
-export declare function serializeArgs(args: any[]): {
-    bytes: Uint8Array;
-    passedByReference?: any[];
-};
-export declare function deserializeArgs(bytes: Uint8Array, passedByReference: any[] | undefined): any[];
+import { ObjectReference } from '../../ipc-via-protobuf/protobuf-msg';
+export type FindObjectRef = (o: any) => ObjectReference<any> | undefined;
+export type FindReferencedObj = (ref: ObjectReference<any>) => any;
+export declare function serializeArgs(args: any[], findRefOf?: FindObjectRef): Buffer;
+export declare function deserializeArgs(bytes: Uint8Array, findReferencedObj?: FindReferencedObj): any[];

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

@@ -1,6 +1,6 @@
 "use strict";
 /*
- Copyright (C) 2022 - 2023 3NSoft Inc.
+ Copyright (C) 2022 - 2023, 2025 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
@@ -22,13 +22,12 @@ 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 serializeArgs(args, findRefOf) {
+    const seq = argsToValuesSequence(args, findRefOf);
+    return valuesType.pack(seq);
 }
-function argsToValuesSequence(args) {
+function argsToValuesSequence(args, findRefOf) {
     const seq = { values: [] };
-    const passedByReference = [];
     for (const arg of args) {
         if (arg && (typeof arg === 'object')) {
             if (ArrayBuffer.isView(arg)) {
@@ -37,13 +36,19 @@ function argsToValuesSequence(args) {
                 });
             }
             else if (arg._isObjectFromCore) {
-                const indexInPassed = addToArray(passedByReference, arg);
+                if (!findRefOf) {
+                    throw new Error(`Function to find reference for object from core is not given`);
+                }
+                const objRef = findRefOf(arg);
+                if (!objRef) {
+                    throw new Error(`Reference for object from core wasn't found`);
+                }
                 seq.values.push({
-                    transferred: { indexInPassed, objLocation: [] }
+                    transferred: { objLocation: [], objRef }
                 });
             }
             else {
-                seq.values.push(turnToJsonExtractingBinaryAndTransferable(arg, passedByReference));
+                seq.values.push(turnToJsonExtractingBinaryAndTransferable(arg, findRefOf));
             }
         }
         else {
@@ -52,24 +57,10 @@ function argsToValuesSequence(args) {
             });
         }
     }
-    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;
-    }
+    return seq;
 }
-function turnToJsonExtractingBinaryAndTransferable(arg, passedByReference) {
-    const parts = extractNonJsonableFrom(arg, passedByReference);
+function turnToJsonExtractingBinaryAndTransferable(arg, findRefOf) {
+    const parts = extractNonJsonableFrom(arg, findRefOf);
     if (parts) {
         const { copy, binaryInJson, transferredInJson } = parts;
         return {
@@ -83,7 +74,7 @@ function turnToJsonExtractingBinaryAndTransferable(arg, passedByReference) {
         return { json: JSON.stringify(arg) };
     }
 }
-function extractNonJsonableFrom(arg, passedByReference) {
+function extractNonJsonableFrom(arg, findRefOf) {
     const nonJsonLocations = findAllNonJsonable(arg);
     if (!nonJsonLocations) {
         return;
@@ -95,8 +86,14 @@ function extractNonJsonableFrom(arg, passedByReference) {
         const nonJson = getValueAtObjLocation(arg, objLocation);
         setNewValueAtObjLocation(copy, objLocation, null);
         if (nonJson._isObjectFromCore) {
-            const indexInPassed = addToArray(passedByReference, nonJson);
-            transferredInJson.push({ indexInPassed, objLocation });
+            if (!findRefOf) {
+                throw new Error(`Function to find reference for object from core is not given`);
+            }
+            const objRef = findRefOf(arg);
+            if (!objRef) {
+                throw new Error(`Reference for object from core wasn't found`);
+            }
+            transferredInJson.push({ objLocation, objRef });
         }
         else {
             binaryInJson.push({ arr: nonJson, objLocation });
@@ -155,17 +152,7 @@ function setNewValueAtObjLocation(o, objLocation, newValue) {
         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) {
+function deserializeArgs(bytes, findReferencedObj) {
     const values = valuesType.unpack(bytes);
     const args = [];
     for (const val of values.values) {
@@ -174,15 +161,21 @@ function deserializeArgs(bytes, passedByReference) {
             args.push(arr.arr);
         }
         else if (transferred) {
-            args.push(getTransferred(transferred.indexInPassed, passedByReference));
+            if (!findReferencedObj) {
+                throw new Error(`Function to find referenced object is not given`);
+            }
+            args.push(findReferencedObj(transferred.objRef));
         }
         else if ((typeof json === 'string') && (json.length > 0)) {
             const arg = JSON.parse(json);
             if (binaryInJson) {
                 attachBinaryArrays(arg, binaryInJson);
             }
-            if (transferredInJson) {
-                attachTransferred(arg, transferredInJson, passedByReference);
+            if (Array.isArray(transferredInJson) && (transferredInJson.length > 0)) {
+                if (!findReferencedObj) {
+                    throw new Error(`Function to find referenced object is not given`);
+                }
+                attachTransferred(arg, transferredInJson, findReferencedObj);
             }
             args.push(arg);
         }
@@ -197,20 +190,8 @@ function attachBinaryArrays(arg, 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));
+function attachTransferred(arg, transferredInJson, findReferencedObj) {
+    for (const { objRef, objLocation } of transferredInJson) {
+        setNewValueAtObjLocation(arg, objLocation, findReferencedObj(objRef));
     }
 }

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

@@ -1,14 +1,13 @@
-import { ExposedFn } from "../../ipc-via-protobuf/connector";
+import { EnvelopeBody, ExposedFn } from "../../ipc-via-protobuf/connector";
+import { FindObjectRef, FindReferencedObj } from "./json-n-binary";
 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';
+    unpackRequest?: ((req: EnvelopeBody) => any[]) | 'noop';
+    packReply?: ((reply: any) => EnvelopeBody) | 'noop';
+    findRefOf?: FindObjectRef;
+    findReferencedObj?: FindReferencedObj;
 }
 export declare function wrapReqReplySrvMethod<T extends object, M extends keyof T>(srv: T, method: M, transforms?: TransformOpts): ExposedFn;
 export declare function wrapReqReplyFunc(srv: object, func: HandleReqReplyCall, transforms?: TransformOpts): ExposedFn;

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

@@ -1,6 +1,6 @@
 "use strict";
 /*
- Copyright (C) 2022 - 2024 3NSoft Inc.
+ Copyright (C) 2022 - 2025 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
@@ -37,7 +37,7 @@ function wrapReqReplyFunc(srvOrFn, funcOrTransforms, transforms) {
         func = funcOrTransforms;
     }
     return buf => {
-        const args = argsFromBuffer(buf, transforms);
+        const args = argsFromPassedDatum(buf, transforms);
         let promise = (args ?
             func.call(srv, ...args) :
             func.call(srv));
@@ -53,42 +53,34 @@ function wrapReqReplyFunc(srvOrFn, funcOrTransforms, 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) {
+function argsFromPassedDatum(bytes, transforms) {
+    if (!bytes) {
         return;
     }
-    if (unpack) {
-        if (unpack === 'noop') {
-            return [data.bytes];
+    if (transforms === null || transforms === void 0 ? void 0 : transforms.unpackRequest) {
+        if (transforms.unpackRequest === 'noop') {
+            return [bytes];
         }
         else {
-            return unpack(data);
+            return transforms.unpackRequest(bytes);
         }
     }
     else {
-        const { bytes, passedByReference } = data;
-        return (bytes ? (0, json_n_binary_1.deserializeArgs)(bytes, passedByReference) : undefined);
+        return (bytes ? (0, json_n_binary_1.deserializeArgs)(bytes) : undefined);
     }
 }
-function toPassedDatum(data, pack) {
+function resultToBuffer(data, transforms) {
     if (data === undefined) {
         return;
     }
-    if (pack) {
-        if (pack === 'noop') {
+    if (transforms === null || transforms === void 0 ? void 0 : transforms.packReply) {
+        if (transforms.packReply === 'noop') {
             if (!ArrayBuffer.isView(data)) {
                 throw new Error(`Method returned non-binary, while no serialization is set`);
             }
-            return { bytes: data };
+            return data;
         }
-        return pack(data);
+        return transforms.packReply(data);
     }
     else {
         return (0, json_n_binary_1.serializeArgs)([data]);
@@ -107,7 +99,7 @@ function wrapObservingFunc(srvOrFn, funcOrTransforms, transforms) {
         func = funcOrTransforms;
     }
     return buf => {
-        const args = argsFromBuffer(buf, transforms);
+        const args = argsFromPassedDatum(buf, transforms);
         const s = new rxjs_1.Subject();
         const obs = s.asObservable().pipe((0, rxjs_1.map)(ev => resultToBuffer(ev, transforms)));
         const onCancel = (args ?

package/build/lib-client/local-files/device-fs.d.ts

@@ -38,6 +38,7 @@ export declare class DeviceFS implements WritableFS, Linkable {
     static makeWritable(root: string, create?: boolean, exclusive?: boolean): Promise<WritableFS>;
     private static makeAndWrapWrFS;
     private static makeAndWrapRoFS;
+    static pathOf(item: FS | File): string | undefined;
     static makeReadonly(root: string): Promise<ReadonlyFS>;
     readonlySubRoot(folder: string): Promise<ReadonlyFS>;
     writableSubRoot(folder: string, flags?: web3n.files.FileFlags): Promise<WritableFS>;

package/build/lib-client/local-files/device-fs.js

@@ -153,6 +153,7 @@ const WRITE_NONEXCL_FLAGS = {
     exclusive: false,
     truncate: true
 };
+const itemToPathMap = new WeakMap();
 class DeviceFS {
     constructor(root, writable, name = '') {
         this.root = root;
@@ -243,12 +244,17 @@ class DeviceFS {
     }
     static makeAndWrapWrFS(root, name) {
         const wrFS = (0, files_1.wrapWritableFS)(new DeviceFS(root, true, name));
+        itemToPathMap.set(wrFS, root);
         return wrFS;
     }
     static makeAndWrapRoFS(root, name) {
         const roFS = (0, files_1.wrapReadonlyFS)(new DeviceFS(root, false, name));
+        itemToPathMap.set(roFS, root);
         return roFS;
     }
+    static pathOf(item) {
+        return itemToPathMap.get(item);
+    }
     static async makeReadonly(root) {
         await checkFolderPresence(root);
         const folderName = pathMod.basename(root);
@@ -693,7 +699,9 @@ class DeviceFS {
     }
     async readonlyFile(path) {
         await this.checkFilePresence(path, true);
-        return (0, files_1.wrapReadonlyFile)(new FileObject(this, path, true, false));
+        const roFile = (0, files_1.wrapReadonlyFile)(new FileObject(this, path, true, false));
+        itemToPathMap.set(roFile, this.fullPath(path));
+        return roFile;
     }
     async writableFile(path, flags = WRITE_NONEXCL_FLAGS) {
         const exists = await this.checkFilePresence(path);
@@ -703,7 +711,9 @@ class DeviceFS {
         if (!exists && !flags.create) {
             throw (0, file_1.makeFileException)('notFound', path);
         }
-        return (0, files_1.wrapWritableFile)(new FileObject(this, path, exists, true));
+        const wrFile = (0, files_1.wrapWritableFile)(new FileObject(this, path, exists, true));
+        itemToPathMap.set(wrFile, this.fullPath(path));
+        return wrFile;
     }
     watchFolder(path, observer) {
         const fullFolderPath = this.fullPath(path, true);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "core-3nweb-client-lib",
-  "version": "0.41.4",
+  "version": "0.41.6",
   "description": "3NWeb client core library, embeddable into different environments",
   "main": "build/lib-index.js",
   "types": "build/lib-index.d.ts",