core-3nweb-client-lib 0.46.0 → 0.46.1

package/README.md

@@ -6,18 +6,36 @@
 ## Development and testing
 
 After repository clone, bring down all NodeJS modules, by running in project's folder:
-```
+```bash
 npm ci
 ```
 
 Tests have some unit and integrated components. Integration test uses 3NWeb spec server. Integrated tests use server and dns mocking from `spec-3nweb-server`.
 
 Build is done with
-```
+```bash
 npm run build
 ```
 
 Test is done with (after build)
-```
+```bash
 npm run test
 ```
+
+
+## Reuse on non-Node and injecting implementation
+
+To reuse this library in non-Node environments, like Android's jsengine and browser, we need to provide different implementations for access to network, files.
+
+Some of these functions are explicitly passed in setup phases, like naming functionality that may either use DNS of DoH. Switch between these may even be done based on same platform, but depending on user prefernces.
+
+Other functions, like access to device's file system, depend only on environment. For these we use a bit cheaper injection approach. We articulate types that should be implemented. And modules expect to get implementation from `globalThis`. Hence, environments that use core should inject respective implementations at some early stage.
+
+Note that import of implementations of injected for node should be done directly, placing it before other imports that need injected global value(s). Do something like:
+```typescript
+import { makePlatformDeviceFS } from 'core-3nweb-client-lib/build/injected-globals/inject-on-node';
+globalThis.platform = {
+	device_fs: makePlatformDeviceFS()
+};
+import ... // other modules
+```

package/build/lib-common/async-fs-node.js

@@ -16,6 +16,7 @@
  this program. If not, see <http://www.gnu.org/licenses/>.
 */
 var _a;
+var _b;
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.copyFile = exports.writeFile = exports.unlink = exports.truncate = exports.symlink = exports.stat = exports.rmdir = exports.rename = exports.readlink = exports.readdir = exports.readFile = exports.open = exports.mkdir = exports.lstat = exports.appendFile = void 0;
 exports.readToBuf = readToBuf;
@@ -37,6 +38,9 @@ const deferred_1 = require("./processes/deferred");
 const bytes_fifo_buffer_1 = require("./byte-streaming/bytes-fifo-buffer");
 const buffer_utils_1 = require("./buffer-utils");
 function noop() { }
+if (!((_b = globalThis.platform) === null || _b === void 0 ? void 0 : _b.device_fs)) {
+    throw new Error(`Expected globally injected object globalThis.platform?.device_fs is missing`);
+}
 /**
  * fs functions follow node's type, and are injected via global object to allow injection in
  * non-node environments, like Android or browser.

package/build/lib-index.d.ts

@@ -14,4 +14,3 @@ export { makeLogger } from './lib-client/logging/log-to-file';
 export declare const SYSTEM_DOMAIN = "3nweb.computer";
 export { checkServicesStartingFromSignup } from './lib-client/service-checks';
 export { dohAt } from './lib-client/doh';
-export * as injectOnNode from './injected-globals/inject-on-node';

package/build/lib-index.js

@@ -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.injectOnNode = exports.dohAt = exports.checkServicesStartingFromSignup = exports.SYSTEM_DOMAIN = exports.makeLogger = exports.DeviceFS = exports.sysFolders = exports.appDirs = exports.makeNetClient = exports.makeServiceLocator = exports.ASMail = exports.SignIn = exports.reverseDomain = exports.Storages = exports.IdManager = exports.SignUp = void 0;
+exports.dohAt = exports.checkServicesStartingFromSignup = exports.SYSTEM_DOMAIN = exports.makeLogger = exports.DeviceFS = exports.sysFolders = exports.appDirs = exports.makeNetClient = exports.makeServiceLocator = exports.ASMail = exports.SignIn = exports.reverseDomain = exports.Storages = exports.IdManager = exports.SignUp = void 0;
 __exportStar(require("./core"), exports);
 var sign_up_1 = require("./core/startup/sign-up");
 Object.defineProperty(exports, "SignUp", { enumerable: true, get: function () { return sign_up_1.SignUp; } });
@@ -60,5 +60,4 @@ var service_checks_1 = require("./lib-client/service-checks");
 Object.defineProperty(exports, "checkServicesStartingFromSignup", { enumerable: true, get: function () { return service_checks_1.checkServicesStartingFromSignup; } });
 var doh_1 = require("./lib-client/doh");
 Object.defineProperty(exports, "dohAt", { enumerable: true, get: function () { return doh_1.dohAt; } });
-exports.injectOnNode = require("./injected-globals/inject-on-node");
 Object.freeze(exports);

package/package.json

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