@pezkuwi/dev-test 0.85.3 → 0.85.7

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 pezkuwi-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,20 @@
+type TestFn = (name: string, exec: () => void | Promise<void>, timeout?: number) => void;
+export interface Describe extends TestFn {
+    only: TestFn;
+    skip: TestFn;
+    todo: TestFn;
+}
+export interface It extends TestFn {
+    only: TestFn;
+    skip: TestFn;
+    todo: TestFn;
+}
+/**
+ * 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: Describe;
+    it: It;
+};
+export {};

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-2026 @pezkuwi/dev-test authors & contributors
+// SPDX-License-Identifier: Apache-2.0
+
+module.exports = {};

package/globals.d.ts

@@ -0,0 +1,30 @@
+// Copyright 2017-2026 @pezkuwi/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 { Describe, It } from './env/suite.js';
+
+type Expect = ReturnType<typeof expect>;
+
+type Jest = ReturnType<typeof jest>;
+
+type Lifecycle = ReturnType<typeof lifecycle>;
+
+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: Describe;
+  var expect: Expect['expect'];
+  var it: 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,5 +1,5 @@
 {
-  "author": "Jaco Greeff <jacogr@gmail.com>",
+  "author": "Pezkuwi Team <team@pezkuwichain.app>",
   "bugs": "https://github.com/pezkuwichain/pezkuwi-dev/issues",
   "description": "A basic test-functions-as-global library on top of node:test",
   "engines": {
@@ -15,16 +15,205 @@
   },
   "sideEffects": false,
   "type": "module",
-  "version": "0.85.3",
-  "main": "./index.js",
+  "version": "0.85.7",
+  "main": "./cjs/index.js",
+  "module": "./cjs/index.js",
+  "types": "./cjs/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.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.85.4' };

package/types.d.ts

@@ -0,0 +1,15 @@
+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/types.js

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

package/util.d.ts

@@ -0,0 +1,20 @@
+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/util.js

@@ -0,0 +1,46 @@
+/**
+ * Extends an existing object with the additional function if they
+ * are not already existing.
+ */
+export 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}
+ */
+export 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}
+ */
+export function warnObj(objName, keys) {
+    return createStub(keys, (key) => () => {
+        console.warn(`${objName}.${key} has been implemented as a noop`);
+    });
+}

package/tsconfig.build.json

@@ -1,16 +0,0 @@
-{
-  "extends": "../../tsconfig.base.json",
-  "compilerOptions": {
-    "baseUrl": "..",
-    "outDir": "./build",
-    "rootDir": "./src"
-  },
-  "exclude": [
-    "**/mod.ts",
-    "src/**/*.spec.ts"
-  ],
-  "include": [
-    "src/**/*"
-  ],
-  "references": []
-}