@pezkuwi/dev-test 0.84.2 → 0.84.3

package/env/jest.js

@@ -0,0 +1,53 @@
+import { mock } from 'node:test';
+import { enhanceObj, stubObj, warnObj } from '../util.js';
+const JEST_KEYS_STUB = ['advanceTimersByTime', 'advanceTimersToNextTimer', 'autoMockOff', 'autoMockOn', 'clearAllMocks', 'clearAllTimers', 'createMockFromModule', 'deepUnmock', 'disableAutomock', 'doMock', 'dontMock', 'enableAutomock', 'fn', 'genMockFromModule', 'getRealSystemTime', 'getSeed', 'getTimerCount', 'isEnvironmentTornDown', 'isMockFunction', 'isolateModules', 'isolateModulesAsync', 'mock', 'mocked', 'now', 'replaceProperty', 'requireActual', 'requireMock', 'resetAllMocks', 'resetModules', 'restoreAllMocks', 'retryTimes', 'runAllImmediates', 'runAllTicks', 'runAllTimers', 'runOnlyPendingTimers', 'setMock', 'setSystemTime', 'setTimeout', 'spyOn', 'unmock', 'unstable_mockModule', 'useFakeTimers', 'useRealTimers'];
+const JEST_KEYS_WARN = ['setTimeout'];
+const MOCK_KEYS_STUB = ['_isMockFunction', 'getMockImplementation', 'getMockName', 'mock', 'mockClear', 'mockImplementation', 'mockImplementationOnce', 'mockName', 'mockRejectedValue', 'mockRejectedValueOnce', 'mockReset', 'mockResolvedValue', 'mockResolvedValueOnce', 'mockRestore', 'mockReturnThis', 'mockReturnValue', 'mockReturnValueOnce', 'withImplementation'];
+const jestStub = stubObj('jest', JEST_KEYS_STUB);
+const jestWarn = warnObj('jest', JEST_KEYS_WARN);
+const mockStub = stubObj('jest.fn()', MOCK_KEYS_STUB);
+/**
+ * @internal
+ *
+ * This adds the mockReset and mockRestore functionality to any
+ * spy or mock function
+ **/
+function extendMock(mocked) {
+    // We use the node:test mock here for casting below - however we
+    // don't want this in any method signature since this is a private
+    // types export, which could get us in "some" trouble
+    //
+    // Effectively the casts below ensure that our WithMock<*> aligns
+    // on a high-level to what we use via private type...
+    const spy = mocked;
+    return enhanceObj(enhanceObj(mocked, {
+        mockImplementation: (fn) => {
+            spy.mock.mockImplementation(fn);
+        },
+        mockImplementationOnce: (fn) => {
+            spy.mock.mockImplementationOnce(fn);
+        },
+        mockReset: () => {
+            spy.mock.resetCalls();
+        },
+        mockRestore: () => {
+            spy.mock.restore();
+        }
+    }), mockStub);
+}
+/**
+ * Sets up the jest object. This is certainly not extensive, and probably
+ * not quite meant to be (never say never). Rather this adds the functionality
+ * that we use in the polkadot-js projects.
+ **/
+export function jest() {
+    return {
+        jest: enhanceObj(enhanceObj({
+            fn: (fn) => extendMock(mock.fn(fn)),
+            restoreAllMocks: () => {
+                mock.reset();
+            },
+            spyOn: (obj, key) => extendMock(mock.method(obj, key))
+        }, jestWarn), jestStub)
+    };
+}

package/env/lifecycle.d.ts

@@ -0,0 +1,12 @@
+import { after, afterEach, before, beforeEach } from 'node:test';
+/**
+ * This ensures that the before/after functions are exposed
+ **/
+export declare function lifecycle(): {
+    after: typeof after;
+    afterAll: typeof after;
+    afterEach: typeof afterEach;
+    before: typeof before;
+    beforeAll: typeof before;
+    beforeEach: typeof beforeEach;
+};

package/env/lifecycle.js

@@ -0,0 +1,14 @@
+import { after, afterEach, before, beforeEach } from 'node:test';
+/**
+ * This ensures that the before/after functions are exposed
+ **/
+export function lifecycle() {
+    return {
+        after,
+        afterAll: after,
+        afterEach,
+        before,
+        beforeAll: before,
+        beforeEach
+    };
+}

package/env/suite.d.ts

@@ -0,0 +1,16 @@
+/**
+ * This ensures that the describe and it functions match our actual usages.
+ * This includes .only, .skip and .todo helpers (.each is not applied)
+ **/
+export declare function suite(): {
+    describe: ((name: string, exec: () => void | Promise<void>, timeout?: number) => void) & Omit<{
+        only: (name: string, exec: () => void | Promise<void>, timeout?: number) => void;
+        skip: (name: string, exec: () => void | Promise<void>, timeout?: number) => void;
+        todo: (name: string, exec: () => void | Promise<void>, timeout?: number) => void;
+    }, never>;
+    it: ((name: string, exec: () => void | Promise<void>, timeout?: number) => void) & Omit<{
+        only: (name: string, exec: () => void | Promise<void>, timeout?: number) => void;
+        skip: (name: string, exec: () => void | Promise<void>, timeout?: number) => void;
+        todo: (name: string, exec: () => void | Promise<void>, timeout?: number) => void;
+    }, never>;
+};

package/env/suite.js

@@ -0,0 +1,32 @@
+import { describe, it } from 'node:test';
+import { enhanceObj } from '../util.js';
+const MINUTE = 60 * 1000;
+/**
+ * @internal
+ *
+ * Wraps either describe or it with relevant .only, .skip, .todo & .each helpers,
+ * shimming it into a Jest-compatible environment.
+ *
+ * @param {} fn
+ */
+function createWrapper(fn, defaultTimeout) {
+    const wrap = (opts) => (name, exec, timeout) => fn(name, { ...opts, timeout: (timeout || defaultTimeout) }, exec);
+    // Ensure that we have consistent helpers on the function. These are not consistently
+    // applied accross all node:test versions, latest has all, so always apply ours.
+    // Instead of node:test options for e.g. timeout, we provide a Jest-compatible signature
+    return enhanceObj(wrap({}), {
+        only: wrap({ only: true }),
+        skip: wrap({ skip: true }),
+        todo: wrap({ todo: true })
+    });
+}
+/**
+ * This ensures that the describe and it functions match our actual usages.
+ * This includes .only, .skip and .todo helpers (.each is not applied)
+ **/
+export function suite() {
+    return {
+        describe: createWrapper(describe, 60 * MINUTE),
+        it: createWrapper(it, 2 * MINUTE)
+    };
+}

package/globals.cjs

@@ -0,0 +1,4 @@
+// Copyright 2017-2025 @polkadot/dev-test authors & contributors
+// SPDX-License-Identifier: Apache-2.0
+
+module.exports = {};

package/globals.d.cts

@@ -0,0 +1 @@
+export {};

package/globals.d.ts

@@ -0,0 +1,32 @@
+// Copyright 2017-2025 @polkadot/dev-test authors & contributors
+// SPDX-License-Identifier: Apache-2.0
+
+/* eslint-disable no-var */
+
+import type { expect } from './env/expect.js';
+import type { jest } from './env/jest.js';
+import type { lifecycle } from './env/lifecycle.js';
+import type { suite } from './env/suite.js';
+
+type Expect = ReturnType<typeof expect>;
+
+type Jest = ReturnType<typeof jest>;
+
+type Lifecycle = ReturnType<typeof lifecycle>;
+
+type Suite = ReturnType<typeof suite>;
+
+declare global {
+  var after: Lifecycle['after'];
+  var afterAll: Lifecycle['afterAll'];
+  var afterEach: Lifecycle['afterEach'];
+  var before: Lifecycle['before'];
+  var beforeAll: Lifecycle['beforeAll'];
+  var beforeEach: Lifecycle['beforeEach'];
+  var describe: Suite['describe'];
+  var expect: Expect['expect'];
+  var it: Suite['it'];
+  var jest: Jest['jest'];
+}
+
+export {};

package/index.d.ts

@@ -0,0 +1 @@
+export {};

package/index.js

@@ -0,0 +1 @@
+throw new Error('Use node --require @pezkuwi/dev-test/{node, browser} depending on the required environment');

package/node.d.ts

@@ -0,0 +1 @@
+export {};

package/node.js

@@ -0,0 +1,2 @@
+import { exposeEnv } from './env/index.js';
+exposeEnv(false);

package/package.json

@@ -1,30 +1,220 @@
 {
   "author": "Jaco Greeff <jacogr@gmail.com>",
-  "bugs": "https://github.com/pezkuwi/dev/issues",
+  "bugs": "https://github.com/polkadot-js/dev/issues",
   "description": "A basic test-functions-as-global library on top of node:test",
   "engines": {
     "node": ">=18.14"
   },
-  "homepage": "https://github.com/pezkuwi/dev/tree/master/packages/dev-test#readme",
+  "homepage": "https://github.com/polkadot-js/dev/tree/master/packages/dev-test#readme",
   "license": "Apache-2.0",
   "name": "@pezkuwi/dev-test",
   "repository": {
     "directory": "packages/dev-test",
     "type": "git",
-    "url": "https://github.com/pezkuwi/dev.git"
+    "url": "https://github.com/polkadot-js/dev.git"
   },
   "sideEffects": false,
   "type": "module",
-  "version": "0.84.2",
-  "main": "./index.js",
+  "version": "0.84.3",
+  "main": "./cjs/index.js",
+  "module": "./index.js",
+  "types": "./index.d.ts",
   "exports": {
-    "./globals.d.ts": "./src/globals.d.ts"
+    "./cjs/package.json": "./cjs/package.json",
+    "./cjs/*": "./cjs/*.js",
+    ".": {
+      "module": {
+        "types": "./index.d.ts",
+        "default": "./index.js"
+      },
+      "require": {
+        "types": "./cjs/index.d.ts",
+        "default": "./cjs/index.js"
+      },
+      "default": {
+        "types": "./index.d.ts",
+        "default": "./index.js"
+      }
+    },
+    "./browser": {
+      "module": {
+        "types": "./browser.d.ts",
+        "default": "./browser.js"
+      },
+      "require": {
+        "types": "./cjs/browser.d.ts",
+        "default": "./cjs/browser.js"
+      },
+      "default": {
+        "types": "./browser.d.ts",
+        "default": "./browser.js"
+      }
+    },
+    "./env": {
+      "module": {
+        "types": "./env/index.d.ts",
+        "default": "./env/index.js"
+      },
+      "require": {
+        "types": "./cjs/env/index.d.ts",
+        "default": "./cjs/env/index.js"
+      },
+      "default": {
+        "types": "./env/index.d.ts",
+        "default": "./env/index.js"
+      }
+    },
+    "./env/browser": {
+      "module": {
+        "types": "./env/browser.d.ts",
+        "default": "./env/browser.js"
+      },
+      "require": {
+        "types": "./cjs/env/browser.d.ts",
+        "default": "./cjs/env/browser.js"
+      },
+      "default": {
+        "types": "./env/browser.d.ts",
+        "default": "./env/browser.js"
+      }
+    },
+    "./env/expect": {
+      "module": {
+        "types": "./env/expect.d.ts",
+        "default": "./env/expect.js"
+      },
+      "require": {
+        "types": "./cjs/env/expect.d.ts",
+        "default": "./cjs/env/expect.js"
+      },
+      "default": {
+        "types": "./env/expect.d.ts",
+        "default": "./env/expect.js"
+      }
+    },
+    "./env/jest": {
+      "module": {
+        "types": "./env/jest.d.ts",
+        "default": "./env/jest.js"
+      },
+      "require": {
+        "types": "./cjs/env/jest.d.ts",
+        "default": "./cjs/env/jest.js"
+      },
+      "default": {
+        "types": "./env/jest.d.ts",
+        "default": "./env/jest.js"
+      }
+    },
+    "./env/lifecycle": {
+      "module": {
+        "types": "./env/lifecycle.d.ts",
+        "default": "./env/lifecycle.js"
+      },
+      "require": {
+        "types": "./cjs/env/lifecycle.d.ts",
+        "default": "./cjs/env/lifecycle.js"
+      },
+      "default": {
+        "types": "./env/lifecycle.d.ts",
+        "default": "./env/lifecycle.js"
+      }
+    },
+    "./env/suite": {
+      "module": {
+        "types": "./env/suite.d.ts",
+        "default": "./env/suite.js"
+      },
+      "require": {
+        "types": "./cjs/env/suite.d.ts",
+        "default": "./cjs/env/suite.js"
+      },
+      "default": {
+        "types": "./env/suite.d.ts",
+        "default": "./env/suite.js"
+      }
+    },
+    "./globals.cjs": "./globals.cjs",
+    "./globals": "./globals.cjs",
+    "./globals.d.cts": "./globals.d.cts",
+    "./globals.d.ts": "./globals.d.ts",
+    "./node": {
+      "module": {
+        "types": "./node.d.ts",
+        "default": "./node.js"
+      },
+      "require": {
+        "types": "./cjs/node.d.ts",
+        "default": "./cjs/node.js"
+      },
+      "default": {
+        "types": "./node.d.ts",
+        "default": "./node.js"
+      }
+    },
+    "./package.json": {
+      "require": "./cjs/package.json",
+      "default": "./package.json"
+    },
+    "./packageInfo.js": {
+      "module": {
+        "types": "./packageInfo.d.ts",
+        "default": "./packageInfo.js"
+      },
+      "require": {
+        "types": "./cjs/packageInfo.d.ts",
+        "default": "./cjs/packageInfo.js"
+      },
+      "default": {
+        "types": "./packageInfo.d.ts",
+        "default": "./packageInfo.js"
+      }
+    },
+    "./packageInfo": {
+      "module": {
+        "types": "./packageInfo.d.ts",
+        "default": "./packageInfo.js"
+      },
+      "require": {
+        "types": "./cjs/packageInfo.d.ts",
+        "default": "./cjs/packageInfo.js"
+      },
+      "default": {
+        "types": "./packageInfo.d.ts",
+        "default": "./packageInfo.js"
+      }
+    },
+    "./types": {
+      "module": {
+        "types": "./types.d.ts",
+        "default": "./types.js"
+      },
+      "require": {
+        "types": "./cjs/types.d.ts",
+        "default": "./cjs/types.js"
+      },
+      "default": {
+        "types": "./types.d.ts",
+        "default": "./types.js"
+      }
+    },
+    "./util": {
+      "module": {
+        "types": "./util.d.ts",
+        "default": "./util.js"
+      },
+      "require": {
+        "types": "./cjs/util.d.ts",
+        "default": "./cjs/util.js"
+      },
+      "default": {
+        "types": "./util.d.ts",
+        "default": "./util.js"
+      }
+    }
   },
   "dependencies": {
     "jsdom": "^24.0.0",
     "tslib": "^2.7.0"
-  },
-  "devDependencies": {
-    "@types/jsdom": "^21.1.6"
   }
 }

package/packageInfo.d.ts

@@ -0,0 +1,6 @@
+export declare const packageInfo: {
+    name: string;
+    path: string;
+    type: string;
+    version: string;
+};

package/packageInfo.js

@@ -0,0 +1 @@
+export const packageInfo = { name: '@pezkuwi/dev-test', path: (import.meta && import.meta.url) ? new URL(import.meta.url).pathname.substring(0, new URL(import.meta.url).pathname.lastIndexOf('/') + 1) : 'auto', type: 'esm', version: '0.83.3' };

package/root.d.ts

@@ -0,0 +1,2 @@
+export * from './rootJs/index.js';
+export declare const TEST_PURE = "testRoot";

package/root.js

@@ -0,0 +1,2 @@
+export * from './rootJs/index.js';
+export const TEST_PURE = /*#__PURE__*/ 'testRoot';

package/rootJs/Clazz.d.ts

@@ -0,0 +1,18 @@
+export declare class Clazz {
+    #private;
+    readonly and: number;
+    static staticProperty: string;
+    static staticFunction: () => string | null;
+    /**
+     * @param and the number we should and with
+     */
+    constructor(and: number);
+    get something(): number;
+    doAsync(): Promise<boolean>;
+    /**
+     * @description Sets something to something
+     * @param something The addition
+     */
+    setSomething: (something?: number) => number;
+    toString(): string;
+}

package/rootJs/Clazz.js

@@ -0,0 +1,32 @@
+export class Clazz {
+    #something = 123_456_789;
+    and;
+    static staticProperty = 'foobar';
+    static staticFunction = () => Clazz.staticProperty;
+    /**
+     * @param and the number we should and with
+     */
+    constructor(and) {
+        this.and = and;
+        this.#something = this.#something & and;
+    }
+    get something() {
+        return this.#something;
+    }
+    async doAsync() {
+        const res = await new Promise((resolve) => resolve(true));
+        console.log(res);
+        return res;
+    }
+    /**
+     * @description Sets something to something
+     * @param something The addition
+     */
+    setSomething = (something) => {
+        this.#something = (something ?? 123_456) & this.and;
+        return this.#something;
+    };
+    toString() {
+        return `something=${this.#something}`;
+    }
+}

package/rootJs/Jsx.d.ts

@@ -0,0 +1,5 @@
+import type { Props } from './JsxChild.js';
+import React from 'react';
+declare function Hidden({ children, className }: Props): React.ReactElement<Props>;
+declare const _default: React.MemoExoticComponent<typeof Hidden>;
+export default _default;

package/rootJs/Jsx.js

@@ -0,0 +1,13 @@
+import { jsx as _jsx, Fragment as _Fragment, jsxs as _jsxs } from "react/jsx-runtime";
+import React, { useCallback, useState } from 'react';
+import { styled } from 'styled-components';
+import Child from './JsxChild.js';
+function Hidden({ children, className }) {
+    const [isMessageVisible, setMessageVisibility] = useState(false);
+    const onShow = useCallback((e) => setMessageVisibility(e.target.checked), []);
+    return (_jsxs(StyledDiv, { className: className, children: [_jsx("label", { htmlFor: 'toggle', children: "Show Message" }), _jsx("input", { checked: isMessageVisible, id: 'toggle', onChange: onShow, type: 'checkbox' }), isMessageVisible && (_jsxs(_Fragment, { children: [children, _jsx(Child, { label: 'hello' })] }))] }));
+}
+const StyledDiv = styled.div `
+  background: red;
+`;
+export default React.memo(Hidden);

package/rootJs/JsxChild.d.ts

@@ -0,0 +1,9 @@
+import React from 'react';
+export interface Props {
+    children?: React.ReactNode;
+    className?: string;
+    label?: string;
+}
+declare function Child({ children, className, label }: Props): React.ReactElement<Props>;
+declare const _default: React.MemoExoticComponent<typeof Child>;
+export default _default;

package/rootJs/JsxChild.js

@@ -0,0 +1,6 @@
+import { jsxs as _jsxs } from "react/jsx-runtime";
+import React from 'react';
+function Child({ children, className, label }) {
+    return (_jsxs("div", { className: className, children: [label || '', children] }));
+}
+export default React.memo(Child);

package/rootJs/augmented.d.ts

@@ -0,0 +1,8 @@
+/** This tests augmentation outputs, e.g. as used in the polkadot-js/api  */
+export interface Something {
+    bar: string;
+    foo: string;
+}
+declare module '@polkadot/dev/types' {
+    const blah: string;
+}

package/rootJs/augmented.js

@@ -0,0 +1,2 @@
+/* eslint-disable */
+export {};

package/rootJs/dynamic.d.mts

@@ -0,0 +1,8 @@
+/**
+ * Returns the sum of 2 numbers
+ *
+ * @param {number} a
+ * @param {number} b
+ * @returns {number}
+ */
+export function sum(a: number, b: number): number;

package/rootJs/dynamic.mjs

@@ -0,0 +1,13 @@
+// Copyright 2017-2025 @pezkuwi/dev authors & contributors
+// SPDX-License-Identifier: Apache-2.0
+
+/**
+ * Returns the sum of 2 numbers
+ *
+ * @param {number} a
+ * @param {number} b
+ * @returns {number}
+ */
+export function sum (a, b) {
+  return a + b;
+}

package/rootJs/index.d.ts

@@ -0,0 +1,19 @@
+/** This should appear as-is in the output with: 1. extension added, 2. augmented.d.ts correct */
+import './augmented.js';
+/** Double double work, i.e. re-exports */
+export { Clazz } from './Clazz.js';
+/** Function to ensure that BigInt does not have the Babel Math.pow() transform */
+export declare function bigIntExp(): bigint;
+/** Function to ensure that dynamic imports work */
+export declare function dynamic(a: number, b: number): Promise<number>;
+/** Function to ensure we have json correctly imported */
+export declare function json(): string;
+/** Check support for the ?? operator */
+export declare function jsOpExp(a?: number): number;
+/** This is an actual check to ensure PURE is all-happy */
+export declare const pureOpExp: number;
+declare const fooA = 1;
+declare const fooB = 2;
+declare const fooC = 3;
+declare const fooD = 4;
+export { fooA, fooB, fooC, fooD };

package/rootJs/index.js

@@ -0,0 +1,39 @@
+/** This should appear as-is in the output with: 1. extension added, 2. augmented.d.ts correct */
+import './augmented.js';
+/** This import should appear as-in in the ouput (cjs without asserts) */
+import testJson from '@pezkuwi/dev/rootJs/testJson.json' assert { type: 'json' };
+/** Double double work, i.e. re-exports */
+export { Clazz } from './Clazz.js';
+/** Function to ensure that BigInt does not have the Babel Math.pow() transform */
+export function bigIntExp() {
+    // 123_456n * 137_858_491_849n
+    return 123456789n * (13n ** 10n);
+}
+/** Function to ensure that dynamic imports work */
+export async function dynamic(a, b) {
+    // NOTE we go via this path so it points to the same location in both ESM
+    // and CJS output (a './dynamic' import would be different otherwise)
+    const { sum } = await import('@pezkuwi/dev/rootJs/dynamic.mjs');
+    // eslint-disable-next-line @typescript-eslint/no-unsafe-return
+    return sum(a, b);
+}
+/** Function to ensure we have json correctly imported */
+export function json() {
+    return testJson.test.json;
+}
+/** Check support for the ?? operator */
+export function jsOpExp(a) {
+    const defaults = {
+        a: 42,
+        b: 43,
+        c: 44
+    };
+    return a ?? defaults.a;
+}
+/** This is an actual check to ensure PURE is all-happy */
+export const pureOpExp = /*#__PURE__*/ jsOpExp();
+const fooA = 1;
+const fooB = 2;
+const fooC = 3;
+const fooD = 4;
+export { fooA, fooB, fooC, fooD };

package/rootJs/testJson.json

@@ -0,0 +1,5 @@
+{
+  "test": {
+    "json": "works"
+  }
+}

package/rootStatic/kusama.svg

@@ -0,0 +1 @@
+<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 441 441"><defs><style>.cls-1{stroke:#000;stroke-miterlimit:10;}.cls-2{fill:#fff;}</style></defs><title>kusama-ksm-logo</title><g id="Layer_2" data-name="Layer 2"><g id="Layer_1-2" data-name="Layer 1"><rect class="cls-1" x="0.5" y="0.5" width="440" height="440"/><path class="cls-2" d="M373.6,127.4c-5.2-4.1-11.4-9.7-22.7-11.1-10.6-1.4-21.4,5.7-28.7,10.4s-21.1,18.5-26.8,22.7-20.3,8.1-43.8,22.2-115.7,73.3-115.7,73.3l24,.3-107,55.1H63.6L48.2,312s13.6,3.6,25-3.6v3.3s127.4-50.2,152-37.2l-15,4.4c1.3,0,25.5,1.6,25.5,1.6a34.34,34.34,0,0,0,15.4,24.8c14.6,9.6,14.9,14.9,14.9,14.9s-7.6,3.1-7.6,7c0,0,11.2-3.4,21.6-3.1a82.64,82.64,0,0,1,19.5,3.1s-.8-4.2-10.9-7-20.1-13.8-25-19.8a28,28,0,0,1-4.1-27.4c3.5-9.1,15.7-14.1,40.9-27.1,29.7-15.4,36.5-26.8,40.7-35.7s10.4-26.6,13.9-34.9c4.4-10.7,9.8-16.4,14.3-19.8s24.5-10.9,24.5-10.9S378.5,131.3,373.6,127.4Z"/></g></g></svg>

package/rootTests.d.ts

@@ -0,0 +1,2 @@
+import type * as testRoot from './root.js';
+export declare function runTests({ Clazz, TEST_PURE, bigIntExp, dynamic, jsOpExp, json }: typeof testRoot): void;