@xylabs/sdk-js 2.5.5 → 2.5.6

package/dist/shared/Log.js

@@ -1,60 +1,60 @@
-import Rollbar from 'rollbar';
-class Log {
-    constructor(config) {
-        var _a;
-        this.devMode = (_a = config.devMode) !== null && _a !== void 0 ? _a : false;
-        if (config.rollbarToken) {
-            this.rollbar = new Rollbar({
-                accessToken: config.rollbarToken,
-                captureUncaught: true,
-                captureUnhandledRejections: true,
-                codeVersion: config.commitHash,
-                code_version: config.commitHash,
-                payload: Object.assign({ client: {
-                        javascript: {
-                            code_version: config.commitHash,
-                            guess_uncaught_frames: true,
-                            source_map_enabled: true,
-                        },
-                    }, codeVersion: config.commitHash, code_version: config.commitHash, environment: this.devMode ? 'development' : 'production' }, config.payload),
-                sendConfig: true,
-            });
-        }
-    }
-    // eslint-disable-next-line @typescript-eslint/no-explicit-any
-    error(...params) {
-        var _a;
-        console.error(params);
-        if (!this.devMode) {
-            (_a = this.rollbar) === null || _a === void 0 ? void 0 : _a.error(params);
-        }
-    }
-    // eslint-disable-next-line @typescript-eslint/no-explicit-any
-    warn(...params) {
-        var _a;
-        console.warn(params);
-        if (!this.devMode) {
-            (_a = this.rollbar) === null || _a === void 0 ? void 0 : _a.warn(params);
-        }
-    }
-    // eslint-disable-next-line @typescript-eslint/no-explicit-any
-    info(...params) {
-        if (this.devMode) {
-            console.info(params);
-        }
-    }
-    // eslint-disable-next-line @typescript-eslint/no-explicit-any
-    debug(...params) {
-        if (this.devMode) {
-            console.debug(params);
-        }
-    }
-    // eslint-disable-next-line @typescript-eslint/no-explicit-any
-    log(...params) {
-        if (this.devMode) {
-            console.log(params);
-        }
-    }
-}
-export { Log };
+import Rollbar from 'rollbar';
+class Log {
+    constructor(config) {
+        var _a;
+        this.devMode = (_a = config.devMode) !== null && _a !== void 0 ? _a : false;
+        if (config.rollbarToken) {
+            this.rollbar = new Rollbar({
+                accessToken: config.rollbarToken,
+                captureUncaught: true,
+                captureUnhandledRejections: true,
+                codeVersion: config.commitHash,
+                code_version: config.commitHash,
+                payload: Object.assign({ client: {
+                        javascript: {
+                            code_version: config.commitHash,
+                            guess_uncaught_frames: true,
+                            source_map_enabled: true,
+                        },
+                    }, codeVersion: config.commitHash, code_version: config.commitHash, environment: this.devMode ? 'development' : 'production' }, config.payload),
+                sendConfig: true,
+            });
+        }
+    }
+    // eslint-disable-next-line @typescript-eslint/no-explicit-any
+    error(...params) {
+        var _a;
+        console.error(params);
+        if (!this.devMode) {
+            (_a = this.rollbar) === null || _a === void 0 ? void 0 : _a.error(params);
+        }
+    }
+    // eslint-disable-next-line @typescript-eslint/no-explicit-any
+    warn(...params) {
+        var _a;
+        console.warn(params);
+        if (!this.devMode) {
+            (_a = this.rollbar) === null || _a === void 0 ? void 0 : _a.warn(params);
+        }
+    }
+    // eslint-disable-next-line @typescript-eslint/no-explicit-any
+    info(...params) {
+        if (this.devMode) {
+            console.info(params);
+        }
+    }
+    // eslint-disable-next-line @typescript-eslint/no-explicit-any
+    debug(...params) {
+        if (this.devMode) {
+            console.debug(params);
+        }
+    }
+    // eslint-disable-next-line @typescript-eslint/no-explicit-any
+    log(...params) {
+        if (this.devMode) {
+            console.log(params);
+        }
+    }
+}
+export { Log };
 //# sourceMappingURL=Log.js.map

package/dist/shared/Override.d.ts

@@ -1,2 +1,2 @@
-declare type Override<T1, T2> = Omit<T1, keyof T2> & T2;
-export type { Override };
+declare type Override<T1, T2> = Omit<T1, keyof T2> & T2;
+export type { Override };

package/dist/shared/Override.js

@@ -1,2 +1,2 @@
-export {};
+export {};
 //# sourceMappingURL=Override.js.map

package/dist/shared/assertEx.d.ts

@@ -1,11 +1,11 @@
-/**
- *
- * Intended for simple null/undefiend checks for variables
- *
- * @param expr - Expression to be evaluated for truthiness
- * @param message - Message in Error if expression is false
- * @throws AssertExError
- * @returns Value of expression
- */
-declare const assertEx: <T>(expr?: T | null | undefined, message?: string | undefined) => T;
-export { assertEx };
+/**
+ *
+ * Intended for simple null/undefiend checks for variables
+ *
+ * @param expr - Expression to be evaluated for truthiness
+ * @param message - Message in Error if expression is false
+ * @throws AssertExError
+ * @returns Value of expression
+ */
+declare const assertEx: <T>(expr?: T | null | undefined, message?: string) => T;
+export { assertEx };

package/dist/shared/assertEx.js

@@ -1,21 +1,21 @@
-/**
- * Error object thrown by assertEx
- */
-class AssertExError extends Error {
-}
-/**
- *
- * Intended for simple null/undefiend checks for variables
- *
- * @param expr - Expression to be evaluated for truthiness
- * @param message - Message in Error if expression is false
- * @throws AssertExError
- * @returns Value of expression
- */
-const assertEx = (expr, message) => {
-    if (expr)
-        return expr;
-    throw new AssertExError(message);
-};
-export { assertEx };
+/**
+ * Error object thrown by assertEx
+ */
+class AssertExError extends Error {
+}
+/**
+ *
+ * Intended for simple null/undefiend checks for variables
+ *
+ * @param expr - Expression to be evaluated for truthiness
+ * @param message - Message in Error if expression is false
+ * @throws AssertExError
+ * @returns Value of expression
+ */
+const assertEx = (expr, message) => {
+    if (expr)
+        return expr;
+    throw new AssertExError(message);
+};
+export { assertEx };
 //# sourceMappingURL=assertEx.js.map

package/dist/shared/delay.d.ts

@@ -1 +1 @@
-export declare const delay: (ms: number) => Promise<unknown>;
+export declare const delay: (ms: number) => Promise<unknown>;

package/dist/shared/delay.js

@@ -1,4 +1,4 @@
-export const delay = (ms) => {
-    return new Promise((resolve) => setTimeout(resolve, ms));
-};
+export const delay = (ms) => {
+    return new Promise((resolve) => setTimeout(resolve, ms));
+};
 //# sourceMappingURL=delay.js.map

package/dist/shared/ellipsize.d.ts

@@ -1 +1 @@
-export declare const ellipsize: (value: string, length?: number) => string;
+export declare const ellipsize: (value: string, length?: number) => string;

package/dist/shared/ellipsize.js

@@ -1,6 +1,6 @@
-export const ellipsize = (value, length = 2) => {
-    const part1 = value.slice(0, length);
-    const part2 = value.slice(value.length - length, value.length);
-    return `${part1}...${part2}`;
-};
+export const ellipsize = (value, length = 2) => {
+    const part1 = value.slice(0, length);
+    const part2 = value.slice(value.length - length, value.length);
+    return `${part1}...${part2}`;
+};
 //# sourceMappingURL=ellipsize.js.map

package/dist/shared/exists.d.ts

@@ -0,0 +1,9 @@
+/**
+ * Used to type narrow an object which is possibly undefined. Works well
+ * with functional Array methods. For example:
+ * @example
+ * const payloads: XyoPayload[] = boundWitness._payloads?.filter(exists) || []
+ * @param x The object which is potentially undefined
+ * @returns True if the object is defined, false otherwise
+ */
+export declare const exists: <T>(x: T | null | undefined) => x is T;

package/dist/shared/exists.js

@@ -0,0 +1,12 @@
+/**
+ * Used to type narrow an object which is possibly undefined. Works well
+ * with functional Array methods. For example:
+ * @example
+ * const payloads: XyoPayload[] = boundWitness._payloads?.filter(exists) || []
+ * @param x The object which is potentially undefined
+ * @returns True if the object is defined, false otherwise
+ */
+export const exists = (x) => {
+    return !!x;
+};
+//# sourceMappingURL=exists.js.map

package/dist/shared/exists.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"exists.js","sourceRoot":"","sources":["../../src/shared/exists.ts"],"names":[],"mappings":"AAAA;;;;;;;GAOG;AACH,MAAM,CAAC,MAAM,MAAM,GAAG,CAAI,CAAuB,EAAU,EAAE;IAC3D,OAAO,CAAC,CAAC,CAAC,CAAA;AACZ,CAAC,CAAA"}

package/dist/shared/forget.d.ts

@@ -1,6 +1,6 @@
-interface ForgetTimeoutConfig {
-    delay: number;
-    cancel: () => void;
-}
-export declare const forget: (promise: Promise<unknown>, timeout?: ForgetTimeoutConfig | undefined) => void;
-export {};
+interface ForgetTimeoutConfig {
+    delay: number;
+    cancel: () => void;
+}
+export declare const forget: (promise: Promise<unknown>, timeout?: ForgetTimeoutConfig) => void;
+export {};

package/dist/shared/forget.js

@@ -1,37 +1,37 @@
-import { __awaiter } from "tslib";
-import { delay } from './delay';
-//used to explicitly launch an async funtion (or Promise) with awaiting it
-export const forget = (promise, timeout) => {
-    let completed = false;
-    const promiseWrapper = () => __awaiter(void 0, void 0, void 0, function* () {
-        yield promise
-            .then(() => {
-            completed = true;
-        })
-            .catch(() => {
-            completed = true;
-        });
-    });
-    const promises = [promiseWrapper()];
-    //if there is a timeout, add it to the race
-    if (timeout) {
-        const timeoutFunc = () => __awaiter(void 0, void 0, void 0, function* () {
-            var _a;
-            yield delay(timeout.delay);
-            if (!completed) {
-                console.log(`forget promise timeout out after ${timeout.delay}ms [Cancelling]`);
-                (_a = timeout.cancel) === null || _a === void 0 ? void 0 : _a.call(timeout);
-            }
-        });
-        promises.push(timeoutFunc());
-    }
-    const all = Promise.race(promises);
-    all
-        .then(() => {
-        return;
-    })
-        .catch(() => {
-        return;
-    });
-};
+import { __awaiter } from "tslib";
+import { delay } from './delay';
+//used to explicitly launch an async funtion (or Promise) with awaiting it
+export const forget = (promise, timeout) => {
+    let completed = false;
+    const promiseWrapper = () => __awaiter(void 0, void 0, void 0, function* () {
+        yield promise
+            .then(() => {
+            completed = true;
+        })
+            .catch(() => {
+            completed = true;
+        });
+    });
+    const promises = [promiseWrapper()];
+    //if there is a timeout, add it to the race
+    if (timeout) {
+        const timeoutFunc = () => __awaiter(void 0, void 0, void 0, function* () {
+            var _a;
+            yield delay(timeout.delay);
+            if (!completed) {
+                console.log(`forget promise timeout out after ${timeout.delay}ms [Cancelling]`);
+                (_a = timeout.cancel) === null || _a === void 0 ? void 0 : _a.call(timeout);
+            }
+        });
+        promises.push(timeoutFunc());
+    }
+    const all = Promise.race(promises);
+    all
+        .then(() => {
+        return;
+    })
+        .catch(() => {
+        return;
+    });
+};
 //# sourceMappingURL=forget.js.map

package/dist/shared/getApiStage.d.ts

@@ -1,3 +1,3 @@
-import { ApiStage } from './ApiStage';
-declare const getApiStage: (hostname: string) => ApiStage;
-export { getApiStage };
+import { ApiStage } from './ApiStage';
+declare const getApiStage: (hostname: string) => ApiStage;
+export { getApiStage };

package/dist/shared/getApiStage.js

@@ -1,14 +1,14 @@
-import { ApiStage } from './ApiStage';
-const getApiStage = (hostname) => {
-    if (hostname.startsWith('localhost')) {
-        return ApiStage.Local;
-    }
-    else if (hostname.startsWith('beta.')) {
-        return ApiStage.Beta;
-    }
-    else {
-        return ApiStage.Prod;
-    }
-};
-export { getApiStage };
+import { ApiStage } from './ApiStage';
+const getApiStage = (hostname) => {
+    if (hostname.startsWith('localhost')) {
+        return ApiStage.Local;
+    }
+    else if (hostname.startsWith('beta.')) {
+        return ApiStage.Beta;
+    }
+    else {
+        return ApiStage.Prod;
+    }
+};
+export { getApiStage };
 //# sourceMappingURL=getApiStage.js.map

package/dist/shared/index.d.ts

@@ -1,15 +1,15 @@
-import { ApiClient } from './ApiClient';
-import { ApiConfig } from './ApiConfig';
-import { ApiEndpoint } from './ApiEndpoint';
-import { ApiStage } from './ApiStage';
-import { assertEx } from './assertEx';
-import { BigNumber } from './BigNumber';
-import { delay } from './delay';
-import { EthAddress, isEthAddress } from './EthAddress';
-import { getApiStage } from './getApiStage';
-import { Log } from './Log';
-import { Override } from './Override';
-export * from './ellipsize';
-export * from './forget';
-export { ApiClient, ApiEndpoint, ApiStage, assertEx, BigNumber, delay, EthAddress, getApiStage, isEthAddress, Log };
-export type { ApiConfig, Override };
+import { ApiClient } from './ApiClient';
+import { ApiConfig } from './ApiConfig';
+import { ApiEndpoint } from './ApiEndpoint';
+import { ApiStage } from './ApiStage';
+import { assertEx } from './assertEx';
+import { BigNumber } from './BigNumber';
+import { delay } from './delay';
+import { EthAddress, isEthAddress } from './EthAddress';
+import { getApiStage } from './getApiStage';
+import { Log } from './Log';
+import { Override } from './Override';
+export * from './ellipsize';
+export * from './forget';
+export { ApiClient, ApiEndpoint, ApiStage, assertEx, BigNumber, delay, EthAddress, getApiStage, isEthAddress, Log };
+export type { ApiConfig, Override };

package/dist/shared/index.js

@@ -1,13 +1,13 @@
-import { ApiClient } from './ApiClient';
-import { ApiEndpoint } from './ApiEndpoint';
-import { ApiStage } from './ApiStage';
-import { assertEx } from './assertEx';
-import { BigNumber } from './BigNumber';
-import { delay } from './delay';
-import { EthAddress, isEthAddress } from './EthAddress';
-import { getApiStage } from './getApiStage';
-import { Log } from './Log';
-export * from './ellipsize';
-export * from './forget';
-export { ApiClient, ApiEndpoint, ApiStage, assertEx, BigNumber, delay, EthAddress, getApiStage, isEthAddress, Log };
+import { ApiClient } from './ApiClient';
+import { ApiEndpoint } from './ApiEndpoint';
+import { ApiStage } from './ApiStage';
+import { assertEx } from './assertEx';
+import { BigNumber } from './BigNumber';
+import { delay } from './delay';
+import { EthAddress, isEthAddress } from './EthAddress';
+import { getApiStage } from './getApiStage';
+import { Log } from './Log';
+export * from './ellipsize';
+export * from './forget';
+export { ApiClient, ApiEndpoint, ApiStage, assertEx, BigNumber, delay, EthAddress, getApiStage, isEthAddress, Log };
 //# sourceMappingURL=index.js.map

package/dist/shared/padHex.d.ts

@@ -1,2 +1,2 @@
-declare const padHex: (hex: string, byteCount?: number | undefined) => string;
-export { padHex };
+declare const padHex: (hex: string, byteCount?: number) => string;
+export { padHex };

package/dist/shared/padHex.js

@@ -1,14 +1,14 @@
-const padHex = (hex, byteCount) => {
-    let result = hex;
-    if (hex.length % 2 !== 0) {
-        result = `0${hex}`;
-    }
-    if (byteCount) {
-        while (result.length / 2 < byteCount) {
-            result = `00${result}`;
-        }
-    }
-    return result;
-};
-export { padHex };
+const padHex = (hex, byteCount) => {
+    let result = hex;
+    if (hex.length % 2 !== 0) {
+        result = `0${hex}`;
+    }
+    if (byteCount) {
+        while (result.length / 2 < byteCount) {
+            result = `00${result}`;
+        }
+    }
+    return result;
+};
+export { padHex };
 //# sourceMappingURL=padHex.js.map

package/package.json

@@ -10,31 +10,31 @@
   },
   "description": "Base functionality used throughout XY Labs TypeScript/JavaScript libraries",
   "devDependencies": {
-    "@babel/core": "7.17.9",
+    "@babel/core": "7.18.2",
     "@rollup/plugin-json": "^4.1.0",
     "@rollup/plugin-replace": "^4.0.0",
     "@rollup/plugin-strip": "^2.1.0",
     "@rollup/plugin-typescript": "^8.3.2",
     "@types/bn.js": "^5.1.0",
-    "@types/jest": "^27.4.1",
+    "@types/jest": "^27.5.1",
     "@types/mocha": "^9.1.1",
     "@xylabs/eslint-config": "2.3.22",
-    "@xylabs/rollup-config": "^1.1.15",
-    "@xylabs/ts-scripts": "^1.0.53",
+    "@xylabs/rollup-config": "^1.1.17",
+    "@xylabs/ts-scripts": "^1.0.66",
     "@xylabs/tsconfig": "^1.0.13",
-    "babel-jest": "^27.5.1",
+    "babel-jest": "^28.1.0",
     "copyfiles": "^2.4.1",
-    "eslint": "^8.14.0",
-    "jest": "^27.5.1",
+    "eslint": "^8.16.0",
+    "jest": "^28.1.0",
     "npm-package-json-lint": "^6.3.0",
     "npm-package-json-lint-config-default": "^5.0.0",
     "prettier": "^2.6.2",
     "rimraf": "^3.0.2",
-    "rollup": "^2.70.2",
-    "ts-jest": "^27.1.4",
-    "ts-node": "^10.7.0",
+    "rollup": "^2.75.4",
+    "ts-jest": "^28.0.3",
+    "ts-node": "^10.8.0",
     "tslib": "^2.4.0",
-    "typescript": "^4.6.3"
+    "typescript": "^4.7.2"
   },
   "browser": "dist/browserIndex.js",
   "docs": "dist/docs.json",
@@ -67,9 +67,9 @@
   "module": "dist/index.js",
   "name": "@xylabs/sdk-js",
   "dependencies": {
-    "@types/node": "^17.0.27",
-    "axios": "^0.26.1",
-    "bn.js": "^5.2.0",
+    "@types/node": "^17.0.38",
+    "axios": "^0.27.2",
+    "bn.js": "^5.2.1",
     "buffer": "^6.0.3",
     "rollbar": "^2.25.0"
   },
@@ -90,6 +90,6 @@
   },
   "sideEffects": false,
   "types": "dist/index.d.ts",
-  "version": "2.5.5",
+  "version": "2.5.6",
   "packageManager": "yarn@3.1.1"
 }

package/src/shared/exists.spec.ts

@@ -0,0 +1,28 @@
+import { exists } from './exists'
+
+const filterableValues = [undefined, null]
+const nonfilterableValue = {}
+
+describe('exists', () => {
+  describe.each(filterableValues)('with all %p', (value) => {
+    it('filters all', async () => {
+      const input = [value, value]
+      const actual = input.filter(exists)
+      expect(actual.length).toBe(0)
+    })
+  })
+  describe.each(filterableValues)('with mixed %p', (value) => {
+    it('filters some', async () => {
+      const input = [value, nonfilterableValue, value, nonfilterableValue]
+      const actual = input.filter(exists)
+      expect(actual.length).toBe(2)
+    })
+  })
+  describe.each(filterableValues)('with no %p', (value) => {
+    it('filters none', async () => {
+      const input = [nonfilterableValue, nonfilterableValue]
+      const actual = input.filter(exists)
+      expect(actual.length).toBe(input.length)
+    })
+  })
+})

package/src/shared/exists.ts

@@ -0,0 +1,11 @@
+/**
+ * Used to type narrow an object which is possibly undefined. Works well
+ * with functional Array methods. For example:
+ * @example
+ * const payloads: XyoPayload[] = boundWitness._payloads?.filter(exists) || []
+ * @param x The object which is potentially undefined
+ * @returns True if the object is defined, false otherwise
+ */
+export const exists = <T>(x: T | undefined | null): x is T => {
+  return !!x
+}

package/src/shared/forget.spec.ts

@@ -2,7 +2,7 @@ import { delay } from './delay'
 import { forget } from './forget'
 
 
-describe('foget', () => {
+describe('forget', () => {
   test('checking happy path', async () => {
     let cancelled = false
     forget(delay(100), {delay: 200, cancel: () => cancelled = true })