@digitaldefiance/express-suite-test-utils 1.0.0 → 1.0.2

package/README.md

@@ -70,6 +70,14 @@ MIT
 
 ## ChangeLog
 
+### v1.0.2
+
+- Add LocalStorageMock
+
+### v1.0.1
+
+- Bugfix release, fixing lack of js files in tarball
+
 ### v1.0.0
 
 - Initial Release

package/package.json

@@ -1,11 +1,11 @@
 {
   "name": "@digitaldefiance/express-suite-test-utils",
-  "version": "1.0.0",
+  "version": "1.0.2",
   "description": "Test utilities for Digital Defiance Express Suite",
   "main": "src/index.js",
   "types": "src/index.d.ts",
   "scripts": {
-    "build": "npx nx build digitaldefiance-express-suite-test-utils",
+    "build": "npx nx build digitaldefiance-express-suite-test-utils && npx nx run digitaldefiance-express-suite-test-utils:postbuild",
     "build:stream": "npx nx build --outputStyle=stream digitaldefiance-express-suite-test-utils",
     "build:logged": "npx nx build --outputStyle=stream digitaldefiance-express-suite-test-utils 2>&1 | ansifilter -o build.log",
     "test": "npx nx test digitaldefiance-express-suite-test-utils",

package/src/index.d.ts

@@ -1,3 +1,5 @@
 export * from './lib/to-throw-type';
 export * from './lib/console';
+export * from './lib/localStorage-mock';
+export * from './lib/localStorage-mock';
 //# sourceMappingURL=index.d.ts.map

package/src/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../packages/digitaldefiance-express-suite-test-utils/src/index.ts"],"names":[],"mappings":"AAAA,cAAc,qBAAqB,CAAC;AACpC,cAAc,eAAe,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../packages/digitaldefiance-express-suite-test-utils/src/index.ts"],"names":[],"mappings":"AAAA,cAAc,qBAAqB,CAAC;AACpC,cAAc,eAAe,CAAC;AAC9B,cAAc,yBAAyB,CAAC;AACxC,cAAc,yBAAyB,CAAA"}

package/src/index.js

@@ -0,0 +1,7 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const tslib_1 = require("tslib");
+tslib_1.__exportStar(require("./lib/to-throw-type"), exports);
+tslib_1.__exportStar(require("./lib/console"), exports);
+tslib_1.__exportStar(require("./lib/localStorage-mock"), exports);
+tslib_1.__exportStar(require("./lib/localStorage-mock"), exports);

package/src/lib/console.js

@@ -0,0 +1,52 @@
+"use strict";
+/* Reusable console mock helpers for e2e tests */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.withConsoleMocks = withConsoleMocks;
+exports.spyContains = spyContains;
+/**
+ * Wrap a test body with console spies that are always restored.
+ * By default mutes console output to keep test logs clean.
+ */
+async function withConsoleMocks(options, fn) {
+    const mute = options?.mute !== false; // default true
+    const noop = () => undefined;
+    const spies = {
+        log: jest
+            .spyOn(console, 'log')
+            .mockImplementation(mute ? noop : console.log),
+        info: jest
+            .spyOn(console, 'info')
+            .mockImplementation(mute ? noop : console.info),
+        warn: jest
+            .spyOn(console, 'warn')
+            .mockImplementation(mute ? noop : console.warn),
+        error: jest
+            .spyOn(console, 'error')
+            .mockImplementation(mute ? noop : console.error),
+        debug: jest
+            .spyOn(console, 'debug')
+            .mockImplementation(mute
+            ? noop
+            : console.debug ??
+                noop),
+    };
+    try {
+        return await fn(spies);
+    }
+    finally {
+        spies.log.mockRestore();
+        spies.info.mockRestore();
+        spies.warn.mockRestore();
+        spies.error.mockRestore();
+        spies.debug.mockRestore();
+    }
+}
+/**
+ * True if any call to the spy contains all provided substrings, in order-agnostic check.
+ */
+function spyContains(spy, ...needles) {
+    return spy.mock.calls.some((args) => {
+        const text = args.map((a) => (typeof a === 'string' ? a : '')).join(' ');
+        return needles.every((n) => text.includes(n));
+    });
+}

package/src/lib/localStorage-mock.d.ts

@@ -0,0 +1,13 @@
+/**
+ * Simple localStorage mock for Node.js test environment
+ */
+export declare class LocalStorageMock implements Storage {
+    private store;
+    get length(): number;
+    clear(): void;
+    getItem(key: string): string | null;
+    key(index: number): string | null;
+    removeItem(key: string): void;
+    setItem(key: string, value: string): void;
+}
+//# sourceMappingURL=localStorage-mock.d.ts.map

package/src/lib/localStorage-mock.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"localStorage-mock.d.ts","sourceRoot":"","sources":["../../../../../packages/digitaldefiance-express-suite-test-utils/src/lib/localStorage-mock.ts"],"names":[],"mappings":"AAAA;;GAEG;AACH,qBAAa,gBAAiB,YAAW,OAAO;IAC9C,OAAO,CAAC,KAAK,CAAkC;IAE/C,IAAI,MAAM,IAAI,MAAM,CAEnB;IAED,KAAK,IAAI,IAAI;IAIb,OAAO,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,GAAG,IAAI;IAInC,GAAG,CAAC,KAAK,EAAE,MAAM,GAAG,MAAM,GAAG,IAAI;IAKjC,UAAU,CAAC,GAAG,EAAE,MAAM,GAAG,IAAI;IAI7B,OAAO,CAAC,GAAG,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,GAAG,IAAI;CAG1C"}

package/src/lib/localStorage-mock.js

@@ -0,0 +1,37 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.LocalStorageMock = void 0;
+/**
+ * Simple localStorage mock for Node.js test environment
+ */
+class LocalStorageMock {
+    store = new Map();
+    get length() {
+        return this.store.size;
+    }
+    clear() {
+        this.store.clear();
+    }
+    getItem(key) {
+        return this.store.get(key) ?? null;
+    }
+    key(index) {
+        const keys = Array.from(this.store.keys());
+        return keys[index] ?? null;
+    }
+    removeItem(key) {
+        this.store.delete(key);
+    }
+    setItem(key, value) {
+        this.store.set(key, value);
+    }
+}
+exports.LocalStorageMock = LocalStorageMock;
+// Set up global localStorage mock
+if (typeof globalThis.localStorage === 'undefined') {
+    Object.defineProperty(globalThis, 'localStorage', {
+        value: new LocalStorageMock(),
+        writable: true,
+        configurable: true,
+    });
+}

package/src/lib/to-throw-type.js

@@ -0,0 +1,134 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.toThrowType = void 0;
+const globals_1 = require("@jest/globals");
+const fs_1 = require("fs");
+function isMatcherError(error) {
+    return error instanceof Error && 'matcherResult' in error;
+}
+function extractTestInfo(stackTrace) {
+    const stackLines = stackTrace.split('\n');
+    const anonymousLine = stackLines.find((line) => line.includes('Object.<anonymous>'));
+    const match = anonymousLine?.match(/\((.+?\.spec\.ts):(\d+):(\d+)\)/);
+    if (!match) {
+        return { testHierarchy: ['Unknown Test'], location: '' };
+    }
+    const fullTestPath = match[1];
+    const lineNumber = parseInt(match[2]);
+    const testFile = fullTestPath.split('/').pop() || '';
+    try {
+        const fileContent = (0, fs_1.readFileSync)(fullTestPath, 'utf8');
+        const lines = fileContent.split('\n');
+        const testLineContent = lines[lineNumber - 1];
+        const testNameMatch = testLineContent.match(/it\(['"](.+?)['"]/);
+        const testName = testNameMatch?.[1];
+        const testHierarchy = ['Test'];
+        if (testName) {
+            testHierarchy.push(testName);
+        }
+        return {
+            testHierarchy,
+            location: ` (${testFile}:${lineNumber})`,
+        };
+    }
+    catch {
+        return {
+            testHierarchy: ['Test'],
+            location: ` (${testFile}:${lineNumber})`,
+        };
+    }
+}
+const toThrowType = async function (received, errorType, validator) {
+    const matcherName = 'toThrowType';
+    const options = {
+        isNot: this.isNot,
+        promise: this.promise,
+    };
+    let error;
+    let pass = false;
+    try {
+        if (this.promise) {
+            try {
+                await received;
+                pass = false;
+            }
+            catch (e) {
+                error = e;
+                if (error instanceof Error &&
+                    (error instanceof errorType || error.constructor === errorType)) {
+                    pass = true;
+                    if (validator) {
+                        await validator(error);
+                    }
+                }
+            }
+        }
+        else {
+            if (typeof received !== 'function') {
+                throw new Error(this.utils.matcherHint(matcherName, undefined, undefined, options) +
+                    '\n\n' +
+                    'Received value must be a function');
+            }
+            try {
+                await received();
+                pass = false;
+            }
+            catch (e) {
+                error = e;
+                if (error instanceof Error &&
+                    (error instanceof errorType || error.constructor === errorType)) {
+                    pass = true;
+                    if (validator) {
+                        await validator(error);
+                    }
+                }
+            }
+        }
+    }
+    catch (validatorError) {
+        const error = validatorError instanceof Error
+            ? validatorError
+            : new Error(String(validatorError));
+        const message = error.message;
+        const stack = error.stack || '';
+        let diffString;
+        if (isMatcherError(error) && error.matcherResult) {
+            diffString =
+                this.utils.diff(error.matcherResult.expected, error.matcherResult.received) || '';
+        }
+        else {
+            diffString = this.utils.diff('Error to match assertions', message) || '';
+        }
+        const { testHierarchy, location } = extractTestInfo(stack);
+        return {
+            pass: false,
+            message: () => `\n\n${this.utils.RECEIVED_COLOR(`● ${testHierarchy.join(' › ')}${location ? ` ${location}` : ''}`)}\n\n` +
+                this.utils.matcherHint(matcherName, undefined, undefined, options) +
+                '\n\n' +
+                diffString +
+                '\n\n' +
+                (stack
+                    ? this.utils.RECEIVED_COLOR(stack.split('\n').slice(1).join('\n'))
+                    : ''),
+        };
+    }
+    const testHeader = error instanceof Error && error.stack
+        ? (() => {
+            const { testHierarchy, location } = extractTestInfo(error.stack);
+            return `\n\n${this.utils.RECEIVED_COLOR(`● ${testHierarchy.join(' › ')}${location}`)}\n\n`;
+        })()
+        : '\n';
+    return {
+        pass,
+        message: () => testHeader +
+            this.utils.matcherHint(matcherName, undefined, undefined, options) +
+            '\n\n' +
+            (pass
+                ? `Expected function not to throw ${this.utils.printExpected(errorType.name)}`
+                : this.promise
+                    ? this.utils.matcherErrorMessage(this.utils.matcherHint(matcherName, undefined, undefined, options), 'Expected promise to reject', 'Promise resolved successfully')
+                    : this.utils.matcherErrorMessage(this.utils.matcherHint(matcherName, undefined, undefined, options), `Expected function to throw ${this.utils.printExpected(errorType.name)}`, `Received: ${this.utils.printReceived(error instanceof Error ? error.constructor.name : typeof error)}`)),
+    };
+};
+exports.toThrowType = toThrowType;
+globals_1.expect.extend({ toThrowType: exports.toThrowType });

package/src/lib/types.js

@@ -0,0 +1,3 @@
+"use strict";
+/// <reference types="jest" />
+Object.defineProperty(exports, "__esModule", { value: true });