core-3nweb-client-lib 0.20.3 → 0.20.7

package/build/api-defs/asmail.d.ts

@@ -254,7 +254,7 @@ declare namespace web3n.asmail {
 	
 	interface InboxException extends RuntimeException {
 		type: "inbox";
-		msgId?: string;
+		msgId: string;
 		msgNotFound?: true;
 		objNotFound?: true;
 		objId?: string;

package/build/core-ipc/common-caps.d.ts

@@ -1,11 +1,6 @@
-import { ExposedObj, Caller, ExposedServices, ExposedFn } from "../ipc-via-protobuf/connector";
+import { Caller, ExposedServices } from "../ipc-via-protobuf/connector";
+import { ClientCAPsWraps, CAPsExposures, TypeDifference } from "./generic";
 declare type W3N = web3n.caps.common.W3N;
-export declare type CapExposer = (cap: any, coreSide: ExposedServices) => ExposedObj<any> | ExposedFn;
-export declare type MakeCapClient = (clientSide: Caller, objPath: string[]) => any;
-export declare function exposeW3N<T extends W3N>(coreSide: ExposedServices, w3n: T, extraCAPs?: {
-    [cap in keyof T]: CapExposer;
-}): void;
-export declare function makeW3Nclient<T extends W3N>(clientSide: Caller, extraCAPs?: {
-    [cap in keyof T]: MakeCapClient;
-}): T;
+export declare function exposeW3N<T extends W3N>(coreSide: ExposedServices, w3n: T, extraCAPs?: CAPsExposures<TypeDifference<T, W3N>>): void;
+export declare function makeW3Nclient<T extends W3N>(clientSide: Caller, extraCAPs?: ClientCAPsWraps<TypeDifference<T, W3N>>): T;
 export {};

package/build/core-ipc/common-caps.js

@@ -22,58 +22,28 @@ const log_cap_1 = require("../ipc-via-protobuf/log-cap");
 const asmail_cap_1 = require("../ipc-via-protobuf/asmail-cap");
 const storage_cap_1 = require("../ipc-via-protobuf/storage-cap");
 const mailerid_1 = require("../ipc-via-protobuf/mailerid");
-const assert_1 = require("../lib-common/assert");
+const generic_1 = require("./generic");
 function exposeW3N(coreSide, w3n, extraCAPs) {
-    const expW3N = {};
-    if (w3n.log) {
-        expW3N.log = log_cap_1.exposeLogger(w3n.log);
-    }
-    if (w3n.mailerid) {
-        expW3N.mailerid = mailerid_1.exposeMailerIdCAP(w3n.mailerid);
-    }
-    if (w3n.mail) {
-        expW3N.mail = asmail_cap_1.exposeASMailCAP(w3n.mail, coreSide);
-    }
-    if (w3n.storage) {
-        expW3N.storage = storage_cap_1.exposeStorageCAP(w3n.storage, coreSide);
-    }
-    if (extraCAPs) {
-        for (const [capName, expose] of Object.entries(extraCAPs)) {
-            assert_1.assert(typeof expose === 'function');
-            const cap = w3n[capName];
-            if (cap) {
-                expW3N[capName] = expose(cap, coreSide);
-            }
-        }
-    }
-    coreSide.exposeW3NService(expW3N);
+    const commonCAPsExposures = {
+        log: log_cap_1.exposeLogger,
+        mail: asmail_cap_1.exposeASMailCAP,
+        mailerid: mailerid_1.exposeMailerIdCAP,
+        storage: storage_cap_1.exposeStorageCAP,
+    };
+    generic_1.exposeCAPs(coreSide, w3n, commonCAPsExposures, extraCAPs);
 }
 exports.exposeW3N = exposeW3N;
+// This is not used, but it ensures that some require runs, providing function
+// for protobuf-something.
+const unused = connector_1.W3N_NAME;
 function makeW3Nclient(clientSide, extraCAPs) {
-    const objPath = [connector_1.W3N_NAME];
-    const lstOfCAPs = clientSide.listObj(objPath);
-    const w3n = {};
-    for (const cap of lstOfCAPs) {
-        const capObjPath = objPath.concat(cap);
-        if (cap === 'log') {
-            w3n.log = log_cap_1.makeLogCaller(clientSide, capObjPath);
-        }
-        else if (cap === 'mailerid') {
-            w3n.mailerid = mailerid_1.makeMailerIdCaller(clientSide, capObjPath);
-        }
-        else if (cap === 'mail') {
-            w3n.mail = asmail_cap_1.makeASMailCaller(clientSide, capObjPath);
-        }
-        else if (cap === 'storage') {
-            w3n.storage = storage_cap_1.makeStorageCaller(clientSide, capObjPath);
-        }
-        else if (extraCAPs && extraCAPs[cap]) {
-            const makeCap = extraCAPs[cap];
-            assert_1.assert(typeof makeCap === 'function');
-            w3n[cap] = makeCap(clientSide, capObjPath);
-        }
-    }
-    return w3n;
+    const mainCAPs = {
+        log: log_cap_1.makeLogCaller,
+        mail: asmail_cap_1.makeASMailCaller,
+        mailerid: mailerid_1.makeMailerIdCaller,
+        storage: storage_cap_1.makeStorageCaller,
+    };
+    return generic_1.makeClientSide(clientSide, mainCAPs, extraCAPs);
 }
 exports.makeW3Nclient = makeW3Nclient;
 Object.freeze(exports);

package/build/core-ipc/generic.d.ts

@@ -0,0 +1,13 @@
+import { ExposedObj, ExposedFn, ExposedServices, Caller } from "../ipc-via-protobuf/connector";
+export declare type CAPsExposures<T> = {
+    [cap in keyof Required<T>]: (cap: any, coreSide: ExposedServices) => ExposedObj<any> | ExposedFn;
+};
+export declare type TypeDifference<T extends TExc, TExc extends object> = {
+    [cap in Exclude<keyof T, keyof TExc>]: T[cap];
+};
+export declare function exposeCAPs<T extends W3N, W3N extends object>(coreSide: ExposedServices, w3n: T, mainCAPs: CAPsExposures<W3N>, extraCAPs: CAPsExposures<TypeDifference<T, W3N>> | undefined): void;
+export declare type MakeCapClient = (clientSide: Caller, objPath: string[]) => any;
+export declare type ClientCAPsWraps<T> = {
+    [cap in keyof Required<T>]: MakeCapClient;
+};
+export declare function makeClientSide<T extends W3N, W3N extends object>(clientSide: Caller, mainCAPs: ClientCAPsWraps<W3N>, extraCAPs: ClientCAPsWraps<TypeDifference<T, W3N>> | undefined): T;

package/build/core-ipc/generic.js

@@ -0,0 +1,63 @@
+"use strict";
+/*
+ Copyright (C) 2021 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.makeClientSide = exports.exposeCAPs = void 0;
+const connector_1 = require("../ipc-via-protobuf/connector");
+const assert_1 = require("../lib-common/assert");
+function exposeCAPs(coreSide, w3n, mainCAPs, extraCAPs) {
+    const expW3N = {};
+    addCAPsInExposure(expW3N, coreSide, w3n, mainCAPs);
+    if (extraCAPs) {
+        addCAPsInExposure(expW3N, coreSide, w3n, extraCAPs);
+    }
+    coreSide.exposeW3NService(expW3N);
+}
+exports.exposeCAPs = exposeCAPs;
+function addCAPsInExposure(expW3N, coreSide, w3n, capExposures) {
+    for (const capName in capExposures) {
+        const expose = capExposures[capName];
+        assert_1.assert(typeof expose === 'function');
+        assert_1.assert(!expW3N[capName], `Capability ${capName} is already exposed, and we specifically have no shadowing.`);
+        const cap = w3n[capName];
+        if (cap) {
+            expW3N[capName] = expose(cap, coreSide);
+        }
+    }
+}
+function makeClientSide(clientSide, mainCAPs, extraCAPs) {
+    const objPath = [connector_1.W3N_NAME];
+    const lstOfCAPs = clientSide.listObj(objPath);
+    const w3n = {};
+    for (const cap of lstOfCAPs) {
+        const capObjPath = objPath.concat(cap);
+        if (mainCAPs[cap]) {
+            const makeCap = mainCAPs[cap];
+            assert_1.assert(typeof makeCap === 'function');
+            w3n[cap] = makeCap(clientSide, capObjPath);
+        }
+        else if (extraCAPs) {
+            assert_1.assert(!!exposeCAPs);
+            const makeCap = extraCAPs[cap];
+            assert_1.assert(typeof makeCap === 'function');
+            w3n[cap] = makeCap(clientSide, capObjPath);
+        }
+    }
+    return w3n;
+}
+exports.makeClientSide = makeClientSide;
+Object.freeze(exports);

package/build/core-ipc/startup-caps.d.ts

@@ -1,5 +1,6 @@
 import { ExposedServices, Caller } from "../ipc-via-protobuf/connector";
+import { ClientCAPsWraps, CAPsExposures, TypeDifference } from "./generic";
 declare type W3N = web3n.startup.W3N;
-export declare function exposeStartupW3N(coreSide: ExposedServices, w3n: W3N): void;
-export declare function makeStartupW3Nclient(clientSide: Caller): W3N;
+export declare function exposeStartupW3N<T extends W3N>(coreSide: ExposedServices, w3n: T, extraCAPs?: CAPsExposures<TypeDifference<T, W3N>>): void;
+export declare function makeStartupW3Nclient<T extends W3N>(clientSide: Caller, extraCAPs?: ClientCAPsWraps<TypeDifference<T, W3N>>): W3N;
 export {};

package/build/core-ipc/startup-caps.js

@@ -20,28 +20,26 @@ exports.makeStartupW3Nclient = exports.exposeStartupW3N = void 0;
 const connector_1 = require("../ipc-via-protobuf/connector");
 const log_cap_1 = require("../ipc-via-protobuf/log-cap");
 const startup_cap_1 = require("../ipc-via-protobuf/startup-cap");
-function exposeStartupW3N(coreSide, w3n) {
-    const expW3N = {
-        signIn: startup_cap_1.wrapSignInCAP(w3n.signIn),
-        signUp: startup_cap_1.wrapSignUpCAP(w3n.signUp)
+const generic_1 = require("./generic");
+function exposeStartupW3N(coreSide, w3n, extraCAPs) {
+    const startupCAPsExposures = {
+        signIn: startup_cap_1.wrapSignInCAP,
+        signUp: startup_cap_1.wrapSignUpCAP,
+        log: log_cap_1.exposeLogger,
     };
-    if (w3n.log) {
-        expW3N.log = log_cap_1.exposeLogger(w3n.log);
-    }
-    coreSide.exposeW3NService(expW3N);
+    generic_1.exposeCAPs(coreSide, w3n, startupCAPsExposures, extraCAPs);
 }
 exports.exposeStartupW3N = exposeStartupW3N;
-function makeStartupW3Nclient(clientSide) {
-    const objPath = [connector_1.W3N_NAME];
-    const lstOfCAPs = clientSide.listObj(objPath);
-    const w3n = {
-        signIn: startup_cap_1.makeSignInCaller(clientSide, objPath.concat('signIn')),
-        signUp: startup_cap_1.makeSignUpCaller(clientSide, objPath.concat('signUp'))
+// This is not used, but it ensures that some require runs, providing function
+// for protobuf-something.
+const unused = connector_1.W3N_NAME;
+function makeStartupW3Nclient(clientSide, extraCAPs) {
+    const mainCAPs = {
+        log: log_cap_1.makeLogCaller,
+        signIn: startup_cap_1.makeSignInCaller,
+        signUp: startup_cap_1.makeSignUpCaller,
     };
-    if (lstOfCAPs.includes('log')) {
-        w3n.log = log_cap_1.makeLogCaller(clientSide, objPath.concat('log'));
-    }
-    return w3n;
+    return generic_1.makeClientSide(clientSide, mainCAPs, extraCAPs);
 }
 exports.makeStartupW3Nclient = makeStartupW3Nclient;
 Object.freeze(exports);