@dynamic-labs/utils 0.19.0-alpha.2 → 0.19.0-alpha.21

package/src/CancellablePromise/CancellablePromise.js

@@ -1,29 +1,131 @@
-class CancellablePromise extends Promise {
-    constructor(executor) {
-        super((resolve, reject) => {
-            executor((val) => {
-                if (this.isCancelled)
-                    return;
-                resolve(val);
-            }, (err) => {
-                if (this.isCancelled)
-                    return;
-                reject(err);
-            });
-        });
-        this._controller = new AbortController();
-    }
-    get isCancelled() {
-        return this._controller.signal.aborted;
-    }
-    cancel() {
-        this._controller.abort();
-    }
-    static fromPromise(promise) {
-        return new CancellablePromise((resolve, reject) => {
-            promise.then(resolve).catch(reject);
-        });
-    }
+import { logger } from '../logger/logger.js';
+
+/* eslint-disable multiline-comment-style */
+const defaultCancel = () => {
+    logger.error("Tried to cancel CancellablePromise without ever assigning it's '_cancel' method");
+};
+/** An extension of Promise that allows you to explicitly cancel a promise with an external reference to it.
+ * Cancelling CancellablePromise causes it to reject with reason set to the parameter passed to the cancel method.
+ * When CancellablePromise rejects, it provides a boolean to indicate whether it was cancelled, alongside the reason.
+ *
+ * @example
+ * // Cancelling this promise
+ * const promise = new CancellablePromise(() => {}).onCancel(console.log)
+ * promise.cancel('User cancelled')
+ *
+ * // Setting up listeners for resolve, cancel and reject
+ * // (notice calling catch after onCancel prevents catch from being called by cancellation)
+ * new CancellablePromise(() => {})
+ *  .then(() => console.log('Promise resolved'))
+ *  .onCancel(() => console.log('Promise was cancelled'))
+ *  .catch(() => console.log('Promise was rejected but NOT cancelled'))
+ *
+ * // Telling whether catch was cause of cancel or not
+ * new CancellablePromise(() => {})
+ *  .then(() => console.log('Promise resolved'))
+ *  .catch(({ reason, wasCancelled }) => console.log('Promise was rejected. Cancelled: ' + wasCancelled))
+ */
+class CancellablePromise extends Promise {
+    // eslint-disable-next-line @typescript-eslint/no-unused-vars
+    internalCancel(reason) {
+        defaultCancel();
+    }
+    constructor(executor) {
+        let superReject = defaultCancel;
+        let superResolve = () => { };
+        super((resolve, reject) => {
+            superReject = reject;
+            superResolve = resolve;
+        });
+        this.internalIsCancelled = false;
+        this.isSettled = false;
+        executor((value) => {
+            if (!this.isCancelled && !this.isSettled)
+                superResolve(value);
+            this.isSettled = true;
+        }, (reason) => {
+            if (!this.isCancelled && !this.isSettled)
+                superReject(reason);
+            this.isSettled = true;
+        });
+        this.internalCancel = superReject;
+    }
+    /** Whether this CancellablePromise was cancelled. */
+    get isCancelled() {
+        return this.internalIsCancelled;
+    }
+    /** Cancels the promise. This causes the promise to reject with { wasCancelled: true, reason: reason }
+     * where the reason is the provided argument.
+     * @returns The cancelled promise.
+     */
+    cancel(reason) {
+        if (this.isSettled)
+            return this;
+        this.internalIsCancelled = true;
+        this.internalCancel(reason);
+        this.isSettled = true;
+        return this;
+    }
+    internalOnCancel(listener, options) {
+        const newPromise = new CancellablePromise((resolve, reject) => {
+            this.internalThen(resolve, ({ wasCancelled, reason }) => {
+                if (wasCancelled)
+                    resolve(listener(reason));
+                else
+                    reject(reason);
+            }, { ignoreOnCancel: true });
+        });
+        /** Tie the new promise's cancel to this promise's cancel */
+        if (!(options === null || options === void 0 ? void 0 : options.ignoreOnCancel)) {
+            newPromise.internalOnCancel((reason) => {
+                this.cancel(reason);
+            }, { ignoreOnCancel: true });
+        }
+        return newPromise;
+    }
+    /** Allows reacting to this CancellablePromise being cancelled  */
+    onCancel(listener) {
+        return this.internalOnCancel(listener);
+    }
+    internalThen(onFulfilled, onRejected, options) {
+        /** Create a catch handler that is undefined if the received callback is undefined */
+        const catchHandler = onRejected
+            ? (reason) => onRejected({ reason, wasCancelled: this.isCancelled })
+            : onRejected;
+        // /** Create the CancellablePromise we will returned, associated to the then promise */
+        const newPromise = CancellablePromise.fromPromise(super.then(onFulfilled, catchHandler));
+        /** Tie the new promise's cancel to this promise's cancel */
+        if (!(options === null || options === void 0 ? void 0 : options.ignoreOnCancel)) {
+            newPromise.internalOnCancel((reason) => {
+                this.cancel(reason);
+            }, { ignoreOnCancel: true });
+        }
+        return newPromise;
+    }
+    then(onFulfilled, onRejected) {
+        return this.internalThen(onFulfilled, onRejected);
+    }
+    catch(onRejected) {
+        return this.then(undefined, onRejected);
+    }
+    finally(onFinally) {
+        return this.then((value) => {
+            onFinally === null || onFinally === void 0 ? void 0 : onFinally();
+            return value;
+        }, (reason) => {
+            onFinally === null || onFinally === void 0 ? void 0 : onFinally();
+            throw reason;
+        });
+    }
+    /** Generates a CancellablePromise from a Promise. If a CancellablePromise is passed, it's returned unscathed.
+     * WARNING: unless you attach a method to reject the original Promise with the "onCancel" param.
+     * cancelling the resulting CancellablePromise does NOT affect the original Promise. */
+    static fromPromise(promise) {
+        if ('internalIsCancelled' in promise)
+            return promise;
+        const newPromise = new CancellablePromise((resolve, reject) => promise.then(resolve, reject));
+        return newPromise;
+    }
 }
 
 export { CancellablePromise };

package/src/CancellablePromise/index.d.ts

@@ -1 +1 @@
-export { CancellablePromise } from './CancellablePromise';
+export { CancellablePromise } from './CancellablePromise';

package/src/bigIntToHex/bigIntToHex.cjs

@@ -0,0 +1,15 @@
+'use strict';
+
+Object.defineProperty(exports, '__esModule', { value: true });
+
+const bigIntToHex = (value) => {
+    if (typeof value !== 'bigint') {
+        throw new TypeError('Input must be of type BigInt');
+    }
+    if (value < 0) {
+        throw new RangeError('Negative BigInt values are not supported');
+    }
+    return `0x${value.toString(16)}`;
+};
+
+exports.bigIntToHex = bigIntToHex;

package/src/bigIntToHex/bigIntToHex.d.ts

@@ -0,0 +1 @@
+export declare const bigIntToHex: (value: bigint) => `0x${string}`;

package/src/bigIntToHex/bigIntToHex.js

@@ -0,0 +1,11 @@
+const bigIntToHex = (value) => {
+    if (typeof value !== 'bigint') {
+        throw new TypeError('Input must be of type BigInt');
+    }
+    if (value < 0) {
+        throw new RangeError('Negative BigInt values are not supported');
+    }
+    return `0x${value.toString(16)}`;
+};
+
+export { bigIntToHex };

package/src/bigIntToHex/index.d.ts

@@ -0,0 +1 @@
+export { bigIntToHex } from './bigIntToHex';

package/src/bufferToBase64.cjs

@@ -2,11 +2,11 @@
 
 Object.defineProperty(exports, '__esModule', { value: true });
 
-const bufferToBase64 = (buf) => {
-    const binstr = Array.prototype.map
-        .call(buf, (ch) => String.fromCharCode(ch))
-        .join('');
-    return Buffer.from(binstr, 'binary').toString('base64');
+const bufferToBase64 = (buf) => {
+    const binstr = Array.prototype.map
+        .call(buf, (ch) => String.fromCharCode(ch))
+        .join('');
+    return Buffer.from(binstr, 'binary').toString('base64');
 };
 
 exports.bufferToBase64 = bufferToBase64;

package/src/bufferToBase64.d.ts

@@ -1 +1 @@
-export declare const bufferToBase64: (buf: Uint8Array) => string;
+export declare const bufferToBase64: (buf: Uint8Array) => string;

package/src/bufferToBase64.js

@@ -1,8 +1,8 @@
-const bufferToBase64 = (buf) => {
-    const binstr = Array.prototype.map
-        .call(buf, (ch) => String.fromCharCode(ch))
-        .join('');
-    return Buffer.from(binstr, 'binary').toString('base64');
+const bufferToBase64 = (buf) => {
+    const binstr = Array.prototype.map
+        .call(buf, (ch) => String.fromCharCode(ch))
+        .join('');
+    return Buffer.from(binstr, 'binary').toString('base64');
 };
 
 export { bufferToBase64 };

package/src/errors/AccountExistsError.cjs

@@ -4,12 +4,12 @@ Object.defineProperty(exports, '__esModule', { value: true });
 
 var DynamicError = require('./DynamicError.cjs');
 
-class AccountExistsError extends DynamicError.DynamicError {
-    constructor(errorMessage, errorPayload) {
-        super(errorMessage);
-        this.errorMessage = errorMessage;
-        this.errorPayload = errorPayload;
-    }
+class AccountExistsError extends DynamicError.DynamicError {
+    constructor(errorMessage, errorPayload) {
+        super(errorMessage);
+        this.errorMessage = errorMessage;
+        this.errorPayload = errorPayload;
+    }
 }
 
 exports.AccountExistsError = AccountExistsError;

package/src/errors/AccountExistsError.d.ts

@@ -1,13 +1,13 @@
-import { DynamicError } from './DynamicError';
-type AccountExistsPayload = {
-    email: string;
-    embeddedSocialSigninProvider: string;
-    embeddedWalletName: string;
-    loginProvider: string;
-};
-export declare class AccountExistsError extends DynamicError {
-    errorMessage: string;
-    errorPayload: AccountExistsPayload;
-    constructor(errorMessage: string, errorPayload: AccountExistsPayload);
-}
-export {};
+import { DynamicError } from './DynamicError';
+type AccountExistsPayload = {
+    email: string;
+    embeddedSocialSigninProvider: string;
+    embeddedWalletName: string;
+    loginProvider: string;
+};
+export declare class AccountExistsError extends DynamicError {
+    errorMessage: string;
+    errorPayload: AccountExistsPayload;
+    constructor(errorMessage: string, errorPayload: AccountExistsPayload);
+}
+export {};

package/src/errors/AccountExistsError.js

@@ -1,11 +1,11 @@
 import { DynamicError } from './DynamicError.js';
 
-class AccountExistsError extends DynamicError {
-    constructor(errorMessage, errorPayload) {
-        super(errorMessage);
-        this.errorMessage = errorMessage;
-        this.errorPayload = errorPayload;
-    }
+class AccountExistsError extends DynamicError {
+    constructor(errorMessage, errorPayload) {
+        super(errorMessage);
+        this.errorMessage = errorMessage;
+        this.errorPayload = errorPayload;
+    }
 }
 
 export { AccountExistsError };

package/src/errors/ChainalysisError.cjs

@@ -4,11 +4,11 @@ Object.defineProperty(exports, '__esModule', { value: true });
 
 var DynamicError = require('./DynamicError.cjs');
 
-class ChainalysisError extends DynamicError.DynamicError {
-    constructor(walletPublicKey) {
-        super('This address is not approved for access');
-        this.walletPublicKey = walletPublicKey;
-    }
+class ChainalysisError extends DynamicError.DynamicError {
+    constructor(walletPublicKey) {
+        super('This address is not approved for access');
+        this.walletPublicKey = walletPublicKey;
+    }
 }
 
 exports.ChainalysisError = ChainalysisError;

package/src/errors/ChainalysisError.d.ts

@@ -1,5 +1,5 @@
-import { DynamicError } from './DynamicError';
-export declare class ChainalysisError extends DynamicError {
-    walletPublicKey: string | undefined;
-    constructor(walletPublicKey: string);
-}
+import { DynamicError } from './DynamicError';
+export declare class ChainalysisError extends DynamicError {
+    walletPublicKey: string | undefined;
+    constructor(walletPublicKey: string);
+}

package/src/errors/ChainalysisError.js

@@ -1,10 +1,10 @@
 import { DynamicError } from './DynamicError.js';
 
-class ChainalysisError extends DynamicError {
-    constructor(walletPublicKey) {
-        super('This address is not approved for access');
-        this.walletPublicKey = walletPublicKey;
-    }
+class ChainalysisError extends DynamicError {
+    constructor(walletPublicKey) {
+        super('This address is not approved for access');
+        this.walletPublicKey = walletPublicKey;
+    }
 }
 
 export { ChainalysisError };

package/src/errors/CustomError.cjs

@@ -2,22 +2,22 @@
 
 Object.defineProperty(exports, '__esModule', { value: true });
 
-/**
- * Extend this class to allow usage of instanceof
- */
-class CustomError extends Error {
-    constructor(message, code) {
-        super(message);
-        this.code = undefined;
-        this.code = code;
-        Object.setPrototypeOf(this, this.constructor.prototype);
-    }
-    toJSON() {
-        return {
-            code: this.code,
-            error: this.message,
-        };
-    }
+/**
+ * Extend this class to allow usage of instanceof
+ */
+class CustomError extends Error {
+    constructor(message, code) {
+        super(message);
+        this.code = undefined;
+        this.code = code;
+        Object.setPrototypeOf(this, this.constructor.prototype);
+    }
+    toJSON() {
+        return {
+            code: this.code,
+            error: this.message,
+        };
+    }
 }
 
 exports.CustomError = CustomError;

package/src/errors/CustomError.d.ts

@@ -1,11 +1,11 @@
-/**
- * Extend this class to allow usage of instanceof
- */
-export declare class CustomError extends Error {
-    code: string | undefined;
-    constructor(message?: string | undefined, code?: string);
-    toJSON(): {
-        code: string | undefined;
-        error: string;
-    };
-}
+/**
+ * Extend this class to allow usage of instanceof
+ */
+export declare class CustomError extends Error {
+    code: string | undefined;
+    constructor(message?: string | undefined, code?: string);
+    toJSON(): {
+        code: string | undefined;
+        error: string;
+    };
+}

package/src/errors/CustomError.js

@@ -1,19 +1,19 @@
-/**
- * Extend this class to allow usage of instanceof
- */
-class CustomError extends Error {
-    constructor(message, code) {
-        super(message);
-        this.code = undefined;
-        this.code = code;
-        Object.setPrototypeOf(this, this.constructor.prototype);
-    }
-    toJSON() {
-        return {
-            code: this.code,
-            error: this.message,
-        };
-    }
+/**
+ * Extend this class to allow usage of instanceof
+ */
+class CustomError extends Error {
+    constructor(message, code) {
+        super(message);
+        this.code = undefined;
+        this.code = code;
+        Object.setPrototypeOf(this, this.constructor.prototype);
+    }
+    toJSON() {
+        return {
+            code: this.code,
+            error: this.message,
+        };
+    }
 }
 
 export { CustomError };

package/src/errors/DynamicError.cjs

@@ -4,7 +4,7 @@ Object.defineProperty(exports, '__esModule', { value: true });
 
 var CustomError = require('./CustomError.cjs');
 
-class DynamicError extends CustomError.CustomError {
+class DynamicError extends CustomError.CustomError {
 }
 
 exports.DynamicError = DynamicError;

package/src/errors/DynamicError.d.ts

@@ -1,3 +1,3 @@
-import { CustomError } from './CustomError';
-export declare class DynamicError extends CustomError {
-}
+import { CustomError } from './CustomError';
+export declare class DynamicError extends CustomError {
+}

package/src/errors/DynamicError.js

@@ -1,6 +1,6 @@
 import { CustomError } from './CustomError.js';
 
-class DynamicError extends CustomError {
+class DynamicError extends CustomError {
 }
 
 export { DynamicError };

package/src/errors/EmailAlreadyExistsError.cjs

@@ -4,10 +4,10 @@ Object.defineProperty(exports, '__esModule', { value: true });
 
 var DynamicError = require('./DynamicError.cjs');
 
-class EmailAlreadyExistsError extends DynamicError.DynamicError {
-    constructor() {
-        super('Email already exists');
-    }
+class EmailAlreadyExistsError extends DynamicError.DynamicError {
+    constructor() {
+        super('Email already exists');
+    }
 }
 
 exports.EmailAlreadyExistsError = EmailAlreadyExistsError;

package/src/errors/EmailAlreadyExistsError.d.ts

@@ -1,4 +1,4 @@
-import { DynamicError } from './DynamicError';
-export declare class EmailAlreadyExistsError extends DynamicError {
-    constructor();
-}
+import { DynamicError } from './DynamicError';
+export declare class EmailAlreadyExistsError extends DynamicError {
+    constructor();
+}

package/src/errors/EmailAlreadyExistsError.js

@@ -1,9 +1,9 @@
 import { DynamicError } from './DynamicError.js';
 
-class EmailAlreadyExistsError extends DynamicError {
-    constructor() {
-        super('Email already exists');
-    }
+class EmailAlreadyExistsError extends DynamicError {
+    constructor() {
+        super('Email already exists');
+    }
 }
 
 export { EmailAlreadyExistsError };

package/src/errors/EmailProviderError.cjs

@@ -4,10 +4,10 @@ Object.defineProperty(exports, '__esModule', { value: true });
 
 var DynamicError = require('./DynamicError.cjs');
 
-class EmailProviderError extends DynamicError.DynamicError {
-    constructor(code) {
-        super('EmailProviderError', code);
-    }
+class EmailProviderError extends DynamicError.DynamicError {
+    constructor(code) {
+        super('EmailProviderError', code);
+    }
 }
 
 exports.EmailProviderError = EmailProviderError;

package/src/errors/EmailProviderError.d.ts

@@ -1,4 +1,4 @@
-import { DynamicError } from './DynamicError';
-export declare class EmailProviderError extends DynamicError {
-    constructor(code: string);
-}
+import { DynamicError } from './DynamicError';
+export declare class EmailProviderError extends DynamicError {
+    constructor(code: string);
+}

package/src/errors/EmailProviderError.js

@@ -1,9 +1,9 @@
 import { DynamicError } from './DynamicError.js';
 
-class EmailProviderError extends DynamicError {
-    constructor(code) {
-        super('EmailProviderError', code);
-    }
+class EmailProviderError extends DynamicError {
+    constructor(code) {
+        super('EmailProviderError', code);
+    }
 }
 
 export { EmailProviderError };

package/src/errors/EmailVerificationError.cjs

@@ -4,10 +4,10 @@ Object.defineProperty(exports, '__esModule', { value: true });
 
 var DynamicError = require('./DynamicError.cjs');
 
-class EmailVerificationError extends DynamicError.DynamicError {
-    constructor(code) {
-        super('EmailVerificationError', code);
-    }
+class EmailVerificationError extends DynamicError.DynamicError {
+    constructor(code) {
+        super('EmailVerificationError', code);
+    }
 }
 
 exports.EmailVerificationError = EmailVerificationError;

package/src/errors/EmailVerificationError.d.ts

@@ -1,4 +1,4 @@
-import { DynamicError } from './DynamicError';
-export declare class EmailVerificationError extends DynamicError {
-    constructor(code: string);
-}
+import { DynamicError } from './DynamicError';
+export declare class EmailVerificationError extends DynamicError {
+    constructor(code: string);
+}

package/src/errors/EmailVerificationError.js

@@ -1,9 +1,9 @@
 import { DynamicError } from './DynamicError.js';
 
-class EmailVerificationError extends DynamicError {
-    constructor(code) {
-        super('EmailVerificationError', code);
-    }
+class EmailVerificationError extends DynamicError {
+    constructor(code) {
+        super('EmailVerificationError', code);
+    }
 }
 
 export { EmailVerificationError };

package/src/errors/GateBlockedError.cjs

@@ -4,11 +4,11 @@ Object.defineProperty(exports, '__esModule', { value: true });
 
 var DynamicError = require('./DynamicError.cjs');
 
-class GateBlockedError extends DynamicError.DynamicError {
-    constructor(walletPublicKey) {
-        super('This address is blocked by the gate');
-        this.walletPublicKey = walletPublicKey;
-    }
+class GateBlockedError extends DynamicError.DynamicError {
+    constructor(walletPublicKey) {
+        super('This address is blocked by the gate');
+        this.walletPublicKey = walletPublicKey;
+    }
 }
 
 exports.GateBlockedError = GateBlockedError;

package/src/errors/GateBlockedError.d.ts

@@ -1,5 +1,5 @@
-import { DynamicError } from './DynamicError';
-export declare class GateBlockedError extends DynamicError {
-    walletPublicKey: string | undefined;
-    constructor(walletPublicKey: string);
-}
+import { DynamicError } from './DynamicError';
+export declare class GateBlockedError extends DynamicError {
+    walletPublicKey: string | undefined;
+    constructor(walletPublicKey: string);
+}

package/src/errors/GateBlockedError.js

@@ -1,10 +1,10 @@
 import { DynamicError } from './DynamicError.js';
 
-class GateBlockedError extends DynamicError {
-    constructor(walletPublicKey) {
-        super('This address is blocked by the gate');
-        this.walletPublicKey = walletPublicKey;
-    }
+class GateBlockedError extends DynamicError {
+    constructor(walletPublicKey) {
+        super('This address is blocked by the gate');
+        this.walletPublicKey = walletPublicKey;
+    }
 }
 
 export { GateBlockedError };