@pezkuwi/dev-test 0.84.3 → 0.85.0

package/cjs/env/jest.js

@@ -1,56 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.jest = jest;
-const node_test_1 = require("node:test");
-const util_js_1 = require("../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 = (0, util_js_1.stubObj)('jest', JEST_KEYS_STUB);
-const jestWarn = (0, util_js_1.warnObj)('jest', JEST_KEYS_WARN);
-const mockStub = (0, util_js_1.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 (0, util_js_1.enhanceObj)((0, util_js_1.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.
- **/
-function jest() {
-    return {
-        jest: (0, util_js_1.enhanceObj)((0, util_js_1.enhanceObj)({
-            fn: (fn) => extendMock(node_test_1.mock.fn(fn)),
-            restoreAllMocks: () => {
-                node_test_1.mock.reset();
-            },
-            spyOn: (obj, key) => extendMock(node_test_1.mock.method(obj, key))
-        }, jestWarn), jestStub)
-    };
-}

package/cjs/env/lifecycle.d.ts

@@ -1,12 +0,0 @@
-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/cjs/env/lifecycle.js

@@ -1,17 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.lifecycle = lifecycle;
-const node_test_1 = require("node:test");
-/**
- * This ensures that the before/after functions are exposed
- **/
-function lifecycle() {
-    return {
-        after: node_test_1.after,
-        afterAll: node_test_1.after,
-        afterEach: node_test_1.afterEach,
-        before: node_test_1.before,
-        beforeAll: node_test_1.before,
-        beforeEach: node_test_1.beforeEach
-    };
-}

package/cjs/env/suite.d.ts

@@ -1,16 +0,0 @@
-/**
- * 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/cjs/env/suite.js

@@ -1,35 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.suite = suite;
-const node_test_1 = require("node:test");
-const util_js_1 = require("../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 (0, util_js_1.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)
- **/
-function suite() {
-    return {
-        describe: createWrapper(node_test_1.describe, 60 * MINUTE),
-        it: createWrapper(node_test_1.it, 2 * MINUTE)
-    };
-}

package/cjs/index.d.ts

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

package/cjs/index.js

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

package/cjs/node.d.ts

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

package/cjs/node.js

@@ -1,4 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-const index_js_1 = require("./env/index.js");
-(0, index_js_1.exposeEnv)(false);

package/cjs/package.json

@@ -1,3 +0,0 @@
-{
-  "type": "commonjs"
-}

package/cjs/packageInfo.d.ts

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

package/cjs/packageInfo.js

@@ -1,4 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.packageInfo = void 0;
-exports.packageInfo = { name: '@pezkuwi/dev-test', path: typeof __dirname === 'string' ? __dirname : 'auto', type: 'cjs', version: '0.83.3' };

package/cjs/root.d.ts

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

package/cjs/root.js

@@ -1,6 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.TEST_PURE = void 0;
-const tslib_1 = require("tslib");
-tslib_1.__exportStar(require("./rootJs/index.js"), exports);
-exports.TEST_PURE = 'testRoot';

package/cjs/rootJs/Clazz.d.ts

@@ -1,18 +0,0 @@
-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/cjs/rootJs/Clazz.js

@@ -1,36 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.Clazz = void 0;
-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}`;
-    }
-}
-exports.Clazz = Clazz;

package/cjs/rootJs/Jsx.d.ts

@@ -1,5 +0,0 @@
-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/cjs/rootJs/Jsx.js

@@ -1,16 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-const tslib_1 = require("tslib");
-const jsx_runtime_1 = require("react/jsx-runtime");
-const react_1 = tslib_1.__importStar(require("react"));
-const styled_components_1 = require("styled-components");
-const JsxChild_js_1 = tslib_1.__importDefault(require("./JsxChild.js"));
-function Hidden({ children, className }) {
-    const [isMessageVisible, setMessageVisibility] = (0, react_1.useState)(false);
-    const onShow = (0, react_1.useCallback)((e) => setMessageVisibility(e.target.checked), []);
-    return ((0, jsx_runtime_1.jsxs)(StyledDiv, { className: className, children: [(0, jsx_runtime_1.jsx)("label", { htmlFor: 'toggle', children: "Show Message" }), (0, jsx_runtime_1.jsx)("input", { checked: isMessageVisible, id: 'toggle', onChange: onShow, type: 'checkbox' }), isMessageVisible && ((0, jsx_runtime_1.jsxs)(jsx_runtime_1.Fragment, { children: [children, (0, jsx_runtime_1.jsx)(JsxChild_js_1.default, { label: 'hello' })] }))] }));
-}
-const StyledDiv = styled_components_1.styled.div `
-  background: red;
-`;
-exports.default = react_1.default.memo(Hidden);

package/cjs/rootJs/JsxChild.d.ts

@@ -1,9 +0,0 @@
-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/cjs/rootJs/JsxChild.js

@@ -1,9 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-const tslib_1 = require("tslib");
-const jsx_runtime_1 = require("react/jsx-runtime");
-const react_1 = tslib_1.__importDefault(require("react"));
-function Child({ children, className, label }) {
-    return ((0, jsx_runtime_1.jsxs)("div", { className: className, children: [label || '', children] }));
-}
-exports.default = react_1.default.memo(Child);

package/cjs/rootJs/augmented.d.ts

@@ -1,8 +0,0 @@
-/** 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/cjs/rootJs/augmented.js

@@ -1,3 +0,0 @@
-"use strict";
-/* eslint-disable */
-Object.defineProperty(exports, "__esModule", { value: true });

package/cjs/rootJs/index.d.ts

@@ -1,19 +0,0 @@
-/** 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/cjs/rootJs/index.js

@@ -1,51 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.fooD = exports.fooC = exports.fooB = exports.fooA = exports.pureOpExp = exports.Clazz = void 0;
-exports.bigIntExp = bigIntExp;
-exports.dynamic = dynamic;
-exports.json = json;
-exports.jsOpExp = jsOpExp;
-const tslib_1 = require("tslib");
-/** This should appear as-is in the output with: 1. extension added, 2. augmented.d.ts correct */
-require("./augmented.js");
-/** This import should appear as-in in the ouput (cjs without asserts) */
-const testJson_json_1 = tslib_1.__importDefault(require("@pezkuwi/dev/rootJs/testJson.json"));
-/** Double double work, i.e. re-exports */
-var Clazz_js_1 = require("./Clazz.js");
-Object.defineProperty(exports, "Clazz", { enumerable: true, get: function () { return Clazz_js_1.Clazz; } });
-/** Function to ensure that BigInt does not have the Babel Math.pow() transform */
-function bigIntExp() {
-    // 123_456n * 137_858_491_849n
-    return 123456789n * (13n ** 10n);
-}
-/** Function to ensure that dynamic imports work */
-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 */
-function json() {
-    return testJson_json_1.default.test.json;
-}
-/** Check support for the ?? operator */
-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 */
-exports.pureOpExp = jsOpExp();
-const fooA = 1;
-exports.fooA = fooA;
-const fooB = 2;
-exports.fooB = fooB;
-const fooC = 3;
-exports.fooC = fooC;
-const fooD = 4;
-exports.fooD = fooD;

package/cjs/rootTests.d.ts

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

package/cjs/rootTests.js

@@ -1,44 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.runTests = runTests;
-function runTests({ Clazz, TEST_PURE, bigIntExp, dynamic, jsOpExp, json }) {
-    describe('Clazz', () => {
-        it('has staticProperty', () => {
-            expect(Clazz.staticProperty).toBe('foobar');
-        });
-        it('creates an instance with get/set', () => {
-            const c = new Clazz(456);
-            expect(c.something).toBe(123_456_789 & 456);
-            c.setSomething(123);
-            expect(c.something).toBe(123 & 456);
-        });
-    });
-    describe('TEST_PURE', () => {
-        it('should have the correct value', () => {
-            expect(TEST_PURE).toBe('testRoot');
-        });
-    });
-    describe('dynamic()', () => {
-        it('should allow dynamic import usage', async () => {
-            expect(await dynamic(5, 37)).toBe(42);
-        });
-    });
-    describe('bigIntExp()', () => {
-        it('should return the correct value', () => {
-            expect(bigIntExp()).toBe(123456789n * 137858491849n);
-        });
-    });
-    describe('jsOpExp', () => {
-        it('handles 0 ?? 42 correctly', () => {
-            expect(jsOpExp(0)).toBe(0);
-        });
-        it('handles undefined ?? 42 correctly', () => {
-            expect(jsOpExp()).toBe(42);
-        });
-    });
-    describe('json()', () => {
-        it('should return the correct value', () => {
-            expect(json()).toBe('works');
-        });
-    });
-}

package/cjs/sample.d.ts

@@ -1 +0,0 @@
-export let foo: string;

package/cjs/sample.js

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

package/cjs/types.d.ts

@@ -1,15 +0,0 @@
-export type AnyFn = (...args: any[]) => any;
-export type BaseObj = Record<string, unknown>;
-export type BaseFn = Function;
-export type StubFn = (...args: unknown[]) => unknown;
-export type WithMock<F extends AnyFn> = F & {
-    mock: {
-        calls: {
-            arguments: unknown[];
-        }[];
-        mockImplementation: (fn: AnyFn) => void;
-        mockImplementationOnce: (fn: AnyFn) => void;
-        resetCalls: () => void;
-        restore: () => void;
-    };
-};

package/cjs/types.js

@@ -1,2 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });

package/cjs/util.d.ts

@@ -1,20 +0,0 @@
-import type { BaseFn, BaseObj, StubFn } from './types.js';
-/**
- * Extends an existing object with the additional function if they
- * are not already existing.
- */
-export declare function enhanceObj<T extends BaseObj | BaseFn, X>(obj: T, extra: X): T & Omit<X, keyof T>;
-/**
- * Extends a given object with the named functions if they do not
- * already exist on the object.
- *
- * @type {StubObjFn}
- */
-export declare function stubObj<N extends readonly string[]>(objName: string, keys: N, alts?: Record<string, string>): { [K in N[number]]: StubFn; };
-/**
- * Extends a given object with the named functions if they do not
- * already exist on the object.
- *
- * @type {StubObjFn}
- */
-export declare function warnObj<N extends readonly string[]>(objName: string, keys: N): { [K in N[number]]: StubFn; };

package/cjs/util.js

@@ -1,51 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.enhanceObj = enhanceObj;
-exports.stubObj = stubObj;
-exports.warnObj = warnObj;
-/**
- * Extends an existing object with the additional function if they
- * are not already existing.
- */
-function enhanceObj(obj, extra) {
-    Object
-        .entries(extra)
-        .forEach(([key, value]) => {
-        obj[key] ??= value;
-    });
-    return obj;
-}
-/**
- * @internal
- *
- * A helper to create a stub object based wite the stub creator supplied
- */
-function createStub(keys, creator) {
-    return keys.reduce((obj, key) => {
-        obj[key] ??= creator(key);
-        return obj;
-    }, {});
-}
-/**
- * Extends a given object with the named functions if they do not
- * already exist on the object.
- *
- * @type {StubObjFn}
- */
-function stubObj(objName, keys, alts) {
-    return createStub(keys, (key) => () => {
-        const alt = alts?.[key];
-        throw new Error(`${objName}.${key} has not been implemented${alt ? ` (Use ${alt} instead)` : ''}`);
-    });
-}
-/**
- * Extends a given object with the named functions if they do not
- * already exist on the object.
- *
- * @type {StubObjFn}
- */
-function warnObj(objName, keys) {
-    return createStub(keys, (key) => () => {
-        console.warn(`${objName}.${key} has been implemented as a noop`);
-    });
-}