@xyo-network/core 2.47.9 → 2.48.0

package/dist/esm/lib/Base.js

@@ -0,0 +1,11 @@
+export class Base {
+    params;
+    static defaultLogger;
+    constructor(params) {
+        this.params = params;
+    }
+    get log() {
+        return this.params?.logger ?? Base.defaultLogger ?? console;
+    }
+}
+//# sourceMappingURL=Base.js.map

package/dist/esm/lib/Base.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"Base.js","sourceRoot":"","sources":["../../../src/lib/Base.ts"],"names":[],"mappings":"AAwBA,MAAM,OAAgB,IAAI;IAGO;IAF/B,MAAM,CAAC,aAAa,CAAS;IAE7B,YAA+B,MAAe;QAAf,WAAM,GAAN,MAAM,CAAS;IAAG,CAAC;IAElD,IAAc,GAAG;QACf,OAAO,IAAI,CAAC,MAAM,EAAE,MAAM,IAAI,IAAI,CAAC,aAAa,IAAI,OAAO,CAAA;IAC7D,CAAC;CACF"}

package/dist/esm/lib/index.js

@@ -1,4 +1,5 @@
 export * from './AnyObject';
+export * from './Base';
 export * from './dumpErrors';
 export * from './EmptyObject';
 export * from './isBrowser';

package/dist/esm/lib/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/lib/index.ts"],"names":[],"mappings":"AAAA,cAAc,aAAa,CAAA;AAC3B,cAAc,cAAc,CAAA;AAC5B,cAAc,eAAe,CAAA;AAC7B,cAAc,aAAa,CAAA;AAC3B,cAAc,iBAAiB,CAAA;AAC/B,cAAc,mBAAmB,CAAA;AACjC,cAAc,QAAQ,CAAA;AACtB,cAAc,aAAa,CAAA"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/lib/index.ts"],"names":[],"mappings":"AAAA,cAAc,aAAa,CAAA;AAC3B,cAAc,QAAQ,CAAA;AACtB,cAAc,cAAc,CAAA;AAC5B,cAAc,eAAe,CAAA;AAC7B,cAAc,aAAa,CAAA;AAC3B,cAAc,iBAAiB,CAAA;AAC/B,cAAc,mBAAmB,CAAA;AACjC,cAAc,QAAQ,CAAA;AACtB,cAAc,aAAa,CAAA"}

package/dist/types/lib/Base.d.ts

@@ -0,0 +1,25 @@
+/// <reference types="node" />
+import { AnyObject } from './AnyObject';
+export type LogFunction = (message?: unknown) => void;
+/**
+ * Interface to handle overlap between Winston &
+ * `console` with as much congruency as possible.
+ */
+export interface Logger {
+    debug: LogFunction;
+    error: LogFunction;
+    info: LogFunction;
+    log: LogFunction;
+    warn: LogFunction;
+}
+export type BaseParamsFields = {
+    logger?: Logger;
+};
+export type BaseParams<TAdditionalParams extends AnyObject | undefined = undefined> = TAdditionalParams extends AnyObject ? BaseParamsFields & TAdditionalParams : BaseParamsFields;
+export declare abstract class Base<TParams extends BaseParams = BaseParams> {
+    protected readonly params: TParams;
+    static defaultLogger?: Logger;
+    constructor(params: TParams);
+    protected get log(): Logger | Console;
+}
+//# sourceMappingURL=Base.d.ts.map

package/dist/types/lib/Base.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"Base.d.ts","sourceRoot":"","sources":["../../../src/lib/Base.ts"],"names":[],"mappings":";AAAA,OAAO,EAAE,SAAS,EAAE,MAAM,aAAa,CAAA;AAEvC,MAAM,MAAM,WAAW,GAAG,CAAC,OAAO,CAAC,EAAE,OAAO,KAAK,IAAI,CAAA;AAErD;;;GAGG;AACH,MAAM,WAAW,MAAM;IACrB,KAAK,EAAE,WAAW,CAAA;IAClB,KAAK,EAAE,WAAW,CAAA;IAClB,IAAI,EAAE,WAAW,CAAA;IACjB,GAAG,EAAE,WAAW,CAAA;IAChB,IAAI,EAAE,WAAW,CAAA;CAClB;AAED,MAAM,MAAM,gBAAgB,GAAG;IAC7B,MAAM,CAAC,EAAE,MAAM,CAAA;CAChB,CAAA;AAED,MAAM,MAAM,UAAU,CAAC,iBAAiB,SAAS,SAAS,GAAG,SAAS,GAAG,SAAS,IAAI,iBAAiB,SAAS,SAAS,GACrH,gBAAgB,GAAG,iBAAiB,GACpC,gBAAgB,CAAA;AAEpB,8BAAsB,IAAI,CAAC,OAAO,SAAS,UAAU,GAAG,UAAU;IAGpD,SAAS,CAAC,QAAQ,CAAC,MAAM,EAAE,OAAO;IAF9C,MAAM,CAAC,aAAa,CAAC,EAAE,MAAM,CAAA;gBAEE,MAAM,EAAE,OAAO;IAE9C,SAAS,KAAK,GAAG,qBAEhB;CACF"}

package/dist/types/lib/index.d.ts

@@ -1,4 +1,5 @@
 export * from './AnyObject';
+export * from './Base';
 export * from './dumpErrors';
 export * from './EmptyObject';
 export * from './isBrowser';

package/dist/types/lib/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/lib/index.ts"],"names":[],"mappings":"AAAA,cAAc,aAAa,CAAA;AAC3B,cAAc,cAAc,CAAA;AAC5B,cAAc,eAAe,CAAA;AAC7B,cAAc,aAAa,CAAA;AAC3B,cAAc,iBAAiB,CAAA;AAC/B,cAAc,mBAAmB,CAAA;AACjC,cAAc,QAAQ,CAAA;AACtB,cAAc,aAAa,CAAA"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/lib/index.ts"],"names":[],"mappings":"AAAA,cAAc,aAAa,CAAA;AAC3B,cAAc,QAAQ,CAAA;AACtB,cAAc,cAAc,CAAA;AAC5B,cAAc,eAAe,CAAA;AAC7B,cAAc,aAAa,CAAA;AAC3B,cAAc,iBAAiB,CAAA;AAC/B,cAAc,mBAAmB,CAAA;AACjC,cAAc,QAAQ,CAAA;AACtB,cAAc,aAAa,CAAA"}

package/package.json

@@ -11,10 +11,10 @@
   },
   "dependencies": {
     "@scure/base": "^1.1.1",
-    "@xylabs/assert": "^2.7.1",
-    "@xylabs/bignumber": "^2.7.1",
-    "@xylabs/buffer": "^2.7.1",
-    "@xyo-network/typeof": "^2.47.9",
+    "@xylabs/assert": "^2.7.4",
+    "@xylabs/bignumber": "^2.7.4",
+    "@xylabs/buffer": "^2.7.4",
+    "@xyo-network/typeof": "^2.48.0",
     "keccak256": "^1.0.6",
     "lodash": "^4.17.21",
     "sha.js": "^2.4.11",
@@ -62,5 +62,5 @@
   },
   "sideEffects": false,
   "types": "dist/types/index.d.ts",
-  "version": "2.47.9"
+  "version": "2.48.0"
 }

package/src/lib/Base.ts

@@ -0,0 +1,33 @@
+import { AnyObject } from './AnyObject'
+
+export type LogFunction = (message?: unknown) => void
+
+/**
+ * Interface to handle overlap between Winston &
+ * `console` with as much congruency as possible.
+ */
+export interface Logger {
+  debug: LogFunction
+  error: LogFunction
+  info: LogFunction
+  log: LogFunction
+  warn: LogFunction
+}
+
+export type BaseParamsFields = {
+  logger?: Logger
+}
+
+export type BaseParams<TAdditionalParams extends AnyObject | undefined = undefined> = TAdditionalParams extends AnyObject
+  ? BaseParamsFields & TAdditionalParams
+  : BaseParamsFields
+
+export abstract class Base<TParams extends BaseParams = BaseParams> {
+  static defaultLogger?: Logger
+
+  constructor(protected readonly params: TParams) {}
+
+  protected get log() {
+    return this.params?.logger ?? Base.defaultLogger ?? console
+  }
+}

package/src/lib/index.ts

@@ -1,4 +1,5 @@
 export * from './AnyObject'
+export * from './Base'
 export * from './dumpErrors'
 export * from './EmptyObject'
 export * from './isBrowser'

package/src/Data/spec/toUint8Array.spec.ts

@@ -1,25 +0,0 @@
-import { base58 } from '@scure/base'
-import { Buffer } from 'buffer'
-
-import { toUint8Array } from '../toUint8Array'
-
-describe('toUint8Array', () => {
-  test('Uint8Array Round Trip', () => {
-    const testArray = Uint8Array.from([0, 1, 2, 3])
-    const testArrayPrime = toUint8Array(testArray)
-    expect(testArray.length).toBe(testArrayPrime.length)
-    for (let i = 0; i < testArray.length; i++) {
-      expect(testArray[i]).toBe(testArrayPrime[i])
-    }
-  })
-  test('Hex Round Trip', () => {
-    const testHex = '1a2b3c'
-    const testHexPrime = Buffer.from(toUint8Array(testHex)).toString('hex')
-    expect(testHex).toBe(testHexPrime)
-  })
-  test('Base58 Round Trip', () => {
-    const testBase58 = '1a2FZb3caz'
-    const testBase58Prime = base58.encode(Buffer.from(toUint8Array(testBase58, undefined, 58)))
-    expect(testBase58).toBe(testBase58Prime)
-  })
-})

package/src/Hasher/spec/removeEmptyFields.spec.ts

@@ -1,23 +0,0 @@
-import { removeEmptyFields } from '../removeEmptyFields'
-
-describe('removeEmptyFields', () => {
-  test('deep', () => {
-    const testObject = {
-      testArray: [1, 2, 3],
-      testBoolean: true,
-      testNull: null,
-      testNullObject: { t: null, x: undefined },
-      testNumber: 5,
-      testObject: { t: 1 },
-      testSomeNullObject: { s: 1, t: null, x: undefined },
-      testString: 'hi',
-      testUndefined: undefined,
-    }
-
-    const result = removeEmptyFields(testObject)
-
-    expect(Object.keys(result).length).toBe(8)
-    expect(Object.keys(result.testSomeNullObject as object).length).toBe(2)
-    expect(Object.keys(result.testNullObject as object).length).toBe(1)
-  })
-})