@acala-network/chopsticks-testing 1.2.0 → 1.2.1

package/dist/cjs/check.d.ts

@@ -26,6 +26,12 @@ export type RedactOptions = {
     removeKeys?: RegExp;
     /** Regex pattern for keys that should not be redacted */
     noRedactKeys?: RegExp;
+    /** Redact options for specific keys */
+    overrides?: Record<string, RedactOptions>;
+    noRedact?: false;
+} | {
+    /** Do not redact any values */
+    noRedact: true;
 };
 /**
  * Function type for test assertions
@@ -107,6 +113,31 @@ export declare class Checker {
      */
     toMatchObject(value: any, msg?: string): Promise<void>;
 }
+/**
+ * Creates a set of checking utilities with provided options
+ * @param options - Options for setting up checks
+ * @returns Object containing various checking utilities
+ */
+export declare const setupCheck: (options: {
+    expectFn: ExpectFn;
+    redactOptions?: RedactOptions;
+    extraCheck?: (value: any) => Promise<void> | void;
+}) => {
+    check: (value: any, msg?: string) => Checker;
+    checkEvents: ({ events }: {
+        events: Promise<Codec[] | Codec>;
+    }, ...filters: EventFilter[]) => Checker;
+    checkSystemEvents: ({ api }: {
+        api: ApiPromise;
+    }, ...filters: EventFilter[]) => Checker;
+    checkUmp: ({ api }: {
+        api: ApiPromise;
+    }) => Checker;
+    checkHrmp: ({ api }: {
+        api: ApiPromise;
+    }) => Checker;
+    checkHex: (value: any, msg?: string) => Checker;
+};
 /**
  * Creates a set of checking utilities with a provided assertion function
  * @param expectFn - Function for making test assertions

package/dist/cjs/check.js

@@ -12,6 +12,9 @@ _export(exports, {
     get Checker () {
         return Checker;
     },
+    get setupCheck () {
+        return setupCheck;
+    },
     get withExpect () {
         return withExpect;
     }
@@ -84,7 +87,7 @@ function _class_private_method_init(obj, privateSet) {
  * Converts Codec data to JSON format
  * @param codec - Codec data to convert
  */ const toJson = (codec)=>processCodecOrArray(codec, (c)=>c?.toJSON?.() ?? c);
-var _expectFn = /*#__PURE__*/ new WeakMap(), _value = /*#__PURE__*/ new WeakMap(), _pipeline = /*#__PURE__*/ new WeakMap(), _extraChecks = /*#__PURE__*/ new WeakMap(), _format = /*#__PURE__*/ new WeakMap(), _message = /*#__PURE__*/ new WeakMap(), _redactOptions = /*#__PURE__*/ new WeakMap(), _redact = /*#__PURE__*/ new WeakSet();
+var _expectFn = /*#__PURE__*/ new WeakMap(), _value = /*#__PURE__*/ new WeakMap(), _pipeline = /*#__PURE__*/ new WeakMap(), _extraChecks = /*#__PURE__*/ new WeakMap(), _format = /*#__PURE__*/ new WeakMap(), _message = /*#__PURE__*/ new WeakMap(), _redactOptions = /*#__PURE__*/ new WeakMap(), _redact = /*#__PURE__*/ new WeakSet(), __redact = /*#__PURE__*/ new WeakSet();
 class Checker {
     /** Convert the checked value to human-readable format */ toHuman() {
         _class_private_field_set(this, _format, 'human');
@@ -136,10 +139,14 @@ class Checker {
         number: 2,
         hash: true
     }) {
-        _class_private_field_set(this, _redactOptions, {
-            ..._class_private_field_get(this, _redactOptions),
-            ...options
-        });
+        if (options.noRedact) {
+            _class_private_field_set(this, _redactOptions, undefined);
+        } else {
+            _class_private_field_set(this, _redactOptions, {
+                ..._class_private_field_get(this, _redactOptions),
+                ...options
+            });
+        }
         return this;
     }
     /**
@@ -214,6 +221,7 @@ class Checker {
    * @param message - Optional message for assertions
    */ constructor(expectFn, value, message){
         _class_private_method_init(this, _redact);
+        _class_private_method_init(this, __redact);
         _class_private_field_init(this, _expectFn, {
             writable: true,
             value: void 0
@@ -251,11 +259,23 @@ function redact(value) {
     if (!_class_private_field_get(this, _redactOptions)) {
         return value;
     }
-    const redactNumber = _class_private_field_get(this, _redactOptions).number === true || typeof _class_private_field_get(this, _redactOptions).number === 'number';
-    const precision = redactNumber ? typeof _class_private_field_get(this, _redactOptions).number === 'number' ? _class_private_field_get(this, _redactOptions).number : 0 : 0;
-    const redactHash = _class_private_field_get(this, _redactOptions).hash === true;
-    const redactHex = _class_private_field_get(this, _redactOptions).hex === true;
-    const redactAddress = _class_private_field_get(this, _redactOptions).address === true;
+    return _class_private_method_get(this, __redact, _redact).call(this, value, _class_private_field_get(this, _redactOptions), 50);
+}
+function _redact(obj, options, depth) {
+    if (depth <= 0) {
+        return obj;
+    }
+    if (obj == null) {
+        return obj;
+    }
+    if (options.noRedact) {
+        return obj;
+    }
+    const redactNumber = options.number === true || typeof options.number === 'number';
+    const precision = redactNumber ? typeof options.number === 'number' ? options.number : 0 : 0;
+    const redactHash = options.hash === true;
+    const redactHex = options.hex === true;
+    const redactAddress = options.address === true;
     const processNumber = (value)=>{
         if (precision > 0) {
             const rounded = Number.parseFloat(value.toPrecision(precision));
@@ -266,82 +286,89 @@ function redact(value) {
         }
         return '(number)';
     };
-    const process = (obj, depth)=>{
-        if (depth <= 0) {
-            return obj;
+    if (Array.isArray(obj)) {
+        return obj.map((x)=>_class_private_method_get(this, __redact, _redact).call(this, x, options, depth - 1));
+    }
+    if (redactNumber && typeof obj === 'number') {
+        return processNumber(obj);
+    }
+    if (typeof obj === 'string') {
+        if (redactNumber && obj.match(/0x000000[0-9a-f]{26}/)) {
+            // this is very likely u128 encoded in hex
+            const num = Number.parseInt(obj);
+            return processNumber(num);
         }
-        if (obj == null) {
-            return obj;
+        if (redactHash && obj.match(/0x[0-9a-f]{64}/)) {
+            return '(hash)';
         }
-        if (Array.isArray(obj)) {
-            return obj.map((x)=>process(x, depth - 1));
+        if (redactHex && obj.match(/0x[0-9a-f]+/)) {
+            return '(hex)';
         }
-        if (redactNumber && typeof obj === 'number') {
-            return processNumber(obj);
+        if (redactAddress && obj.match(/^[1-9A-HJ-NP-Za-km-z]{46,48}$/)) {
+            return '(address)';
         }
-        if (typeof obj === 'string') {
-            if (redactNumber && obj.match(/0x000000[0-9a-f]{26}/)) {
-                // this is very likely u128 encoded in hex
-                const num = Number.parseInt(obj);
-                return processNumber(num);
-            }
-            if (redactHash && obj.match(/0x[0-9a-f]{64}/)) {
-                return '(hash)';
-            }
-            if (redactHex && obj.match(/0x[0-9a-f]+/)) {
-                return '(hex)';
+        if (redactNumber && obj.match(/^-?[\d,]+$/)) {
+            const num = Number.parseInt(obj.replace(/,/g, ''));
+            return processNumber(num);
+        }
+        return obj;
+    }
+    if (typeof obj === 'object') {
+        return Object.fromEntries(Object.entries(obj).filter(([k])=>{
+            if (options.removeKeys?.test(k)) {
+                return false;
             }
-            if (redactAddress && obj.match(/^[1-9A-HJ-NP-Za-km-z]{46,48}$/)) {
-                return '(address)';
+            return true;
+        }).map(([k, v])=>{
+            if (options.noRedactKeys?.test(k)) {
+                return [
+                    k,
+                    v
+                ];
             }
-            if (redactNumber && obj.match(/^-?[\d,]+$/)) {
-                const num = Number.parseInt(obj.replace(/,/g, ''));
-                return processNumber(num);
+            if (options.overrides?.[k]) {
+                return [
+                    k,
+                    _class_private_method_get(this, __redact, _redact).call(this, v, options.overrides[k], depth - 1)
+                ];
             }
-            return obj;
-        }
-        if (typeof obj === 'object') {
-            return Object.fromEntries(Object.entries(obj).filter(([k])=>{
-                if (_class_private_field_get(this, _redactOptions)?.removeKeys?.test(k)) {
-                    return false;
-                }
-                return true;
-            }).map(([k, v])=>{
-                if (_class_private_field_get(this, _redactOptions)?.noRedactKeys?.test(k)) {
-                    return [
-                        k,
-                        v
-                    ];
-                }
-                if (_class_private_field_get(this, _redactOptions)?.redactKeys?.test(k)) {
-                    return [
-                        k,
-                        '(redacted)'
-                    ];
-                }
+            if (options.redactKeys?.test(k)) {
                 return [
                     k,
-                    process(v, depth - 1)
+                    '(redacted)'
                 ];
-            }));
-        }
-        return obj;
-    };
-    return process(value, 50);
+            }
+            return [
+                k,
+                _class_private_method_get(this, __redact, _redact).call(this, v, options, depth - 1)
+            ];
+        }));
+    }
+    return obj;
 }
-const withExpect = (expectFn)=>{
+const setupCheck = (options)=>{
+    const { expectFn, redactOptions, extraCheck } = options;
     /**
    * Create a new Checker instance
    * @param value - Value to check
    * @param msg - Optional message for assertions
    */ const check = (value, msg)=>{
+        let checker;
         if (value instanceof Checker) {
+            checker = value;
             if (msg) {
-                return value.message(msg);
+                checker = checker.message(msg);
             }
-            return value;
+        } else {
+            checker = new Checker(expectFn, value, msg);
+        }
+        if (redactOptions) {
+            checker = checker.redact(redactOptions);
         }
-        return new Checker(expectFn, value, msg);
+        if (extraCheck) {
+            checker = checker.check(extraCheck);
+        }
+        return checker;
     };
     /**
    * Check blockchain events with filtering and redaction
@@ -378,3 +405,8 @@ const withExpect = (expectFn)=>{
         checkHex
     };
 };
+const withExpect = (expectFn)=>{
+    return setupCheck({
+        expectFn
+    });
+};

package/dist/esm/check.d.ts

@@ -26,6 +26,12 @@ export type RedactOptions = {
     removeKeys?: RegExp;
     /** Regex pattern for keys that should not be redacted */
     noRedactKeys?: RegExp;
+    /** Redact options for specific keys */
+    overrides?: Record<string, RedactOptions>;
+    noRedact?: false;
+} | {
+    /** Do not redact any values */
+    noRedact: true;
 };
 /**
  * Function type for test assertions
@@ -107,6 +113,31 @@ export declare class Checker {
      */
     toMatchObject(value: any, msg?: string): Promise<void>;
 }
+/**
+ * Creates a set of checking utilities with provided options
+ * @param options - Options for setting up checks
+ * @returns Object containing various checking utilities
+ */
+export declare const setupCheck: (options: {
+    expectFn: ExpectFn;
+    redactOptions?: RedactOptions;
+    extraCheck?: (value: any) => Promise<void> | void;
+}) => {
+    check: (value: any, msg?: string) => Checker;
+    checkEvents: ({ events }: {
+        events: Promise<Codec[] | Codec>;
+    }, ...filters: EventFilter[]) => Checker;
+    checkSystemEvents: ({ api }: {
+        api: ApiPromise;
+    }, ...filters: EventFilter[]) => Checker;
+    checkUmp: ({ api }: {
+        api: ApiPromise;
+    }) => Checker;
+    checkHrmp: ({ api }: {
+        api: ApiPromise;
+    }) => Checker;
+    checkHex: (value: any, msg?: string) => Checker;
+};
 /**
  * Creates a set of checking utilities with a provided assertion function
  * @param expectFn - Function for making test assertions

package/dist/esm/check.js

@@ -87,21 +87,37 @@
         number: 2,
         hash: true
     }) {
-        this.#redactOptions = {
-            ...this.#redactOptions,
-            ...options
-        };
+        if (options.noRedact) {
+            this.#redactOptions = undefined;
+        } else {
+            this.#redactOptions = {
+                ...this.#redactOptions,
+                ...options
+            };
+        }
         return this;
     }
     #redact(value) {
         if (!this.#redactOptions) {
             return value;
         }
-        const redactNumber = this.#redactOptions.number === true || typeof this.#redactOptions.number === 'number';
-        const precision = redactNumber ? typeof this.#redactOptions.number === 'number' ? this.#redactOptions.number : 0 : 0;
-        const redactHash = this.#redactOptions.hash === true;
-        const redactHex = this.#redactOptions.hex === true;
-        const redactAddress = this.#redactOptions.address === true;
+        return this.#_redact(value, this.#redactOptions, 50);
+    }
+    #_redact(obj, options, depth) {
+        if (depth <= 0) {
+            return obj;
+        }
+        if (obj == null) {
+            return obj;
+        }
+        if (options.noRedact) {
+            return obj;
+        }
+        const redactNumber = options.number === true || typeof options.number === 'number';
+        const precision = redactNumber ? typeof options.number === 'number' ? options.number : 0 : 0;
+        const redactHash = options.hash === true;
+        const redactHex = options.hex === true;
+        const redactAddress = options.address === true;
         const processNumber = (value)=>{
             if (precision > 0) {
                 const rounded = Number.parseFloat(value.toPrecision(precision));
@@ -112,68 +128,65 @@
             }
             return '(number)';
         };
-        const process = (obj, depth)=>{
-            if (depth <= 0) {
-                return obj;
+        if (Array.isArray(obj)) {
+            return obj.map((x)=>this.#_redact(x, options, depth - 1));
+        }
+        if (redactNumber && typeof obj === 'number') {
+            return processNumber(obj);
+        }
+        if (typeof obj === 'string') {
+            if (redactNumber && obj.match(/0x000000[0-9a-f]{26}/)) {
+                // this is very likely u128 encoded in hex
+                const num = Number.parseInt(obj);
+                return processNumber(num);
             }
-            if (obj == null) {
-                return obj;
+            if (redactHash && obj.match(/0x[0-9a-f]{64}/)) {
+                return '(hash)';
             }
-            if (Array.isArray(obj)) {
-                return obj.map((x)=>process(x, depth - 1));
+            if (redactHex && obj.match(/0x[0-9a-f]+/)) {
+                return '(hex)';
             }
-            if (redactNumber && typeof obj === 'number') {
-                return processNumber(obj);
+            if (redactAddress && obj.match(/^[1-9A-HJ-NP-Za-km-z]{46,48}$/)) {
+                return '(address)';
             }
-            if (typeof obj === 'string') {
-                if (redactNumber && obj.match(/0x000000[0-9a-f]{26}/)) {
-                    // this is very likely u128 encoded in hex
-                    const num = Number.parseInt(obj);
-                    return processNumber(num);
-                }
-                if (redactHash && obj.match(/0x[0-9a-f]{64}/)) {
-                    return '(hash)';
-                }
-                if (redactHex && obj.match(/0x[0-9a-f]+/)) {
-                    return '(hex)';
+            if (redactNumber && obj.match(/^-?[\d,]+$/)) {
+                const num = Number.parseInt(obj.replace(/,/g, ''));
+                return processNumber(num);
+            }
+            return obj;
+        }
+        if (typeof obj === 'object') {
+            return Object.fromEntries(Object.entries(obj).filter(([k])=>{
+                if (options.removeKeys?.test(k)) {
+                    return false;
                 }
-                if (redactAddress && obj.match(/^[1-9A-HJ-NP-Za-km-z]{46,48}$/)) {
-                    return '(address)';
+                return true;
+            }).map(([k, v])=>{
+                if (options.noRedactKeys?.test(k)) {
+                    return [
+                        k,
+                        v
+                    ];
                 }
-                if (redactNumber && obj.match(/^-?[\d,]+$/)) {
-                    const num = Number.parseInt(obj.replace(/,/g, ''));
-                    return processNumber(num);
+                if (options.overrides?.[k]) {
+                    return [
+                        k,
+                        this.#_redact(v, options.overrides[k], depth - 1)
+                    ];
                 }
-                return obj;
-            }
-            if (typeof obj === 'object') {
-                return Object.fromEntries(Object.entries(obj).filter(([k])=>{
-                    if (this.#redactOptions?.removeKeys?.test(k)) {
-                        return false;
-                    }
-                    return true;
-                }).map(([k, v])=>{
-                    if (this.#redactOptions?.noRedactKeys?.test(k)) {
-                        return [
-                            k,
-                            v
-                        ];
-                    }
-                    if (this.#redactOptions?.redactKeys?.test(k)) {
-                        return [
-                            k,
-                            '(redacted)'
-                        ];
-                    }
+                if (options.redactKeys?.test(k)) {
                     return [
                         k,
-                        process(v, depth - 1)
+                        '(redacted)'
                     ];
-                }));
-            }
-            return obj;
-        };
-        return process(value, 50);
+                }
+                return [
+                    k,
+                    this.#_redact(v, options, depth - 1)
+                ];
+            }));
+        }
+        return obj;
     }
     /**
    * Add a transformation function to the processing pipeline
@@ -242,22 +255,32 @@
     }
 }
 /**
- * Creates a set of checking utilities with a provided assertion function
- * @param expectFn - Function for making test assertions
+ * Creates a set of checking utilities with provided options
+ * @param options - Options for setting up checks
  * @returns Object containing various checking utilities
- */ export const withExpect = (expectFn)=>{
+ */ export const setupCheck = (options)=>{
+    const { expectFn, redactOptions, extraCheck } = options;
     /**
    * Create a new Checker instance
    * @param value - Value to check
    * @param msg - Optional message for assertions
    */ const check = (value, msg)=>{
+        let checker;
         if (value instanceof Checker) {
+            checker = value;
             if (msg) {
-                return value.message(msg);
+                checker = checker.message(msg);
             }
-            return value;
+        } else {
+            checker = new Checker(expectFn, value, msg);
+        }
+        if (redactOptions) {
+            checker = checker.redact(redactOptions);
         }
-        return new Checker(expectFn, value, msg);
+        if (extraCheck) {
+            checker = checker.check(extraCheck);
+        }
+        return checker;
     };
     /**
    * Check blockchain events with filtering and redaction
@@ -294,3 +317,12 @@
         checkHex
     };
 };
+/**
+ * Creates a set of checking utilities with a provided assertion function
+ * @param expectFn - Function for making test assertions
+ * @returns Object containing various checking utilities
+ */ export const withExpect = (expectFn)=>{
+    return setupCheck({
+        expectFn
+    });
+};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@acala-network/chopsticks-testing",
-  "version": "1.2.0",
+  "version": "1.2.1",
   "author": "Acala Developers <hello@acala.network>",
   "license": "Apache-2.0",
   "type": "module",
@@ -13,13 +13,13 @@
     "depcheck": "npx depcheck"
   },
   "dependencies": {
-    "@acala-network/chopsticks-utils": "1.2.0",
+    "@acala-network/chopsticks-utils": "1.2.1",
     "@polkadot/api": "^16.4.1",
     "@polkadot/types": "^16.4.1"
   },
   "devDependencies": {
     "@swc/cli": "0.7.8",
-    "@swc/core": "^1.12.11",
+    "@swc/core": "^1.12.14",
     "typescript": "^5.8.3"
   },
   "files": [