@xylabs/sdk-js 2.5.3 → 2.5.6

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",
@@ -63,13 +63,13 @@
     "esm"
   ],
   "license": "LGPL-3.0",
-  "main": "dist/node/index.js",
+  "main": "dist/bundle/node/index.js",
   "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.3",
+  "version": "2.5.6",
   "packageManager": "yarn@3.1.1"
 }

package/src/shared/Log.spec.ts

@@ -5,4 +5,37 @@ describe('Log', () => {
     const log = new Log({ devMode: false })
     expect(log).toBeDefined()
   })
+  test('rollbar error methods not to be called when in dev', () => {
+    jest.spyOn(global.console, 'error').mockImplementation()
+    const log = new Log({ devMode: true, rollbarToken: 'mock' })
+    const errorSpy = jest.spyOn((log as any).rollbar, 'error')
+    log.error(['ERROR'])
+    //@ts-ignore
+    expect(errorSpy).toBeCalledTimes(0)
+  })
+  test('rollbar error methods to be called when not in dev', () => {
+    jest.spyOn(global.console, 'error').mockImplementation()
+    const log = new Log({ devMode: false, rollbarToken: 'mock' })
+    const errorSpy = jest.spyOn((log as any).rollbar, 'error')
+    log.error(['ERROR'])
+    //@ts-ignore
+    expect(errorSpy).toHaveBeenCalled()
+  })
+  test('rollbar warn methods not to be called when in dev', () => {
+    jest.spyOn(global.console, 'warn').mockImplementation()
+    const log = new Log({ devMode: true, rollbarToken: 'mock' })
+    const warnSpy = jest.spyOn((log as any).rollbar, 'warn')
+    log.warn(['WARNING'])
+    //@ts-ignore
+    expect(warnSpy).toBeCalledTimes(0)
+  })
+  test('rollbar warn methods to be called when not in dev', () => {
+    jest.spyOn(global.console, 'warn').mockImplementation()
+    const log = new Log({ devMode: false, rollbarToken: 'mock' })
+    const warnSpy = jest.spyOn((log as any).rollbar, 'error')
+    log.error(['WARNING'])
+    //@ts-ignore
+    expect(warnSpy).toHaveBeenCalled()
+  })
+
 })

package/src/shared/Log.ts

@@ -42,7 +42,7 @@ class Log {
   // eslint-disable-next-line @typescript-eslint/no-explicit-any
   public error(...params: any[]) {
     console.error(params)
-    if (this.devMode) {
+    if (!this.devMode) {
       this.rollbar?.error(params)
     }
   }
@@ -50,7 +50,7 @@ class Log {
   // eslint-disable-next-line @typescript-eslint/no-explicit-any
   public warn(...params: any[]) {
     console.warn(params)
-    if (this.devMode) {
+    if (!this.devMode) {
       this.rollbar?.warn(params)
     }
   }

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 })