@digitaldefiance/express-suite-test-utils 1.0.0

package/README.md

@@ -0,0 +1,75 @@
+# @digitaldefiance/express-suite-test-utils
+
+Test utilities for Digital Defiance Express Suite projects.
+
+## Installation
+
+```bash
+npm install @digitaldefiance/express-suite-test-utils
+# or
+yarn add @digitaldefiance/express-suite-test-utils
+```
+
+## Usage
+
+### toThrowType Matcher
+
+Custom Jest matcher for testing error types with optional validation:
+
+```typescript
+import '@digitaldefiance/express-suite-test-utils';
+
+class CustomError extends Error {
+  constructor(public code: number) {
+    super('Custom error');
+  }
+}
+
+// Basic usage
+expect(() => {
+  throw new CustomError(404);
+}).toThrowType(CustomError);
+
+// With validator
+expect(() => {
+  throw new CustomError(404);
+}).toThrowType(CustomError, (error) => {
+  expect(error.code).toBe(404);
+});
+```
+
+### ErrorClass Type
+
+```typescript
+import { ErrorClass } from '@digitaldefiance/express-suite-test-utils';
+
+function testError<E extends Error>(ErrorType: ErrorClass<E>) {
+  // Use ErrorType constructor
+}
+```
+
+### Console Mocks
+
+Mock console methods in tests:
+
+```typescript
+import { withConsoleMocks, spyContains } from '@digitaldefiance/express-suite-test-utils';
+
+it('should log message', async () => {
+  await withConsoleMocks({ mute: true }, async (spies) => {
+    console.log('test message');
+    expect(spies.log).toHaveBeenCalledWith('test message');
+    expect(spyContains(spies.log, 'test', 'message')).toBe(true);
+  });
+});
+```
+
+## License
+
+MIT
+
+## ChangeLog
+
+### v1.0.0
+
+- Initial Release

package/package.json

@@ -0,0 +1,46 @@
+{
+  "name": "@digitaldefiance/express-suite-test-utils",
+  "version": "1.0.0",
+  "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: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",
+    "test:stream": "npx nx test --outputStyle=stream digitaldefiance-express-suite-test-utils",
+    "test:logged": "npx nx test --outputStyle=stream digitaldefiance-express-suite-test-utils 2>&1 | ansifilter -o test.log",
+    "test:coverage": "npx jest --coverage --testPathPattern=digitaldefiance-express-suite-test-utils --coverageReporters=text",
+    "lint": "npx nx lint digitaldefiance-express-suite-test-utils",
+    "lint:fix": "npx nx lint digitaldefiance-express-suite-test-utils --fix",
+    "prettier:check": "prettier --check 'src/**/*.{ts,tsx}'",
+    "prettier:fix": "prettier --write 'src/**/*.{ts,tsx}'",
+    "format": "npx nx format:write --projects=digitaldefiance-express-suite-test-utils",
+    "format:check": "npx nx format:check --projects=digitaldefiance-express-suite-test-utils",
+    "prepublishOnly": "npx nx build digitaldefiance-express-suite-test-utils",
+    "publish:public": "npm publish --access public"
+  },
+  "files": [
+    "src",
+    "README.md"
+  ],
+  "keywords": [
+    "test",
+    "jest",
+    "typescript",
+    "utilities"
+  ],
+  "author": "Digital Defiance, Jessica Mulein",
+  "license": "MIT",
+  "packageManager": "yarn@4.10.3",
+  "dependencies": {
+    "@jest/globals": "^30.0.5",
+    "@types/jest": "^30.0.0",
+    "expect": "^30.0.5"
+  },
+  "devDependencies": {
+    "@types/node": "^22.0.0"
+  },
+  "type": "commonjs"
+}

package/src/index.d.ts

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

package/src/index.d.ts.map

@@ -0,0 +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"}

package/src/lib/console.d.ts

@@ -0,0 +1,20 @@
+export type ConsoleSpies = {
+    log: jest.SpyInstance;
+    info: jest.SpyInstance;
+    warn: jest.SpyInstance;
+    error: jest.SpyInstance;
+    debug: jest.SpyInstance;
+};
+export interface WithConsoleOptions {
+    mute?: boolean;
+}
+/**
+ * Wrap a test body with console spies that are always restored.
+ * By default mutes console output to keep test logs clean.
+ */
+export declare function withConsoleMocks<T = unknown>(options: WithConsoleOptions, fn: (spies: ConsoleSpies) => Promise<T> | T): Promise<T>;
+/**
+ * True if any call to the spy contains all provided substrings, in order-agnostic check.
+ */
+export declare function spyContains(spy: jest.SpyInstance, ...needles: string[]): boolean;
+//# sourceMappingURL=console.d.ts.map

package/src/lib/console.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"console.d.ts","sourceRoot":"","sources":["../../../../../packages/digitaldefiance-express-suite-test-utils/src/lib/console.ts"],"names":[],"mappings":"AAEA,MAAM,MAAM,YAAY,GAAG;IACzB,GAAG,EAAE,IAAI,CAAC,WAAW,CAAC;IACtB,IAAI,EAAE,IAAI,CAAC,WAAW,CAAC;IACvB,IAAI,EAAE,IAAI,CAAC,WAAW,CAAC;IACvB,KAAK,EAAE,IAAI,CAAC,WAAW,CAAC;IACxB,KAAK,EAAE,IAAI,CAAC,WAAW,CAAC;CACzB,CAAC;AAEF,MAAM,WAAW,kBAAkB;IACjC,IAAI,CAAC,EAAE,OAAO,CAAC;CAChB;AAED;;;GAGG;AACH,wBAAsB,gBAAgB,CAAC,CAAC,GAAG,OAAO,EAChD,OAAO,EAAE,kBAAkB,EAC3B,EAAE,EAAE,CAAC,KAAK,EAAE,YAAY,KAAK,OAAO,CAAC,CAAC,CAAC,GAAG,CAAC,GAC1C,OAAO,CAAC,CAAC,CAAC,CAkCZ;AAED;;GAEG;AACH,wBAAgB,WAAW,CACzB,GAAG,EAAE,IAAI,CAAC,WAAW,EACrB,GAAG,OAAO,EAAE,MAAM,EAAE,GACnB,OAAO,CAKT"}

package/src/lib/to-throw-type.d.ts

@@ -0,0 +1,7 @@
+import type { MatcherContext } from 'expect';
+export type ErrorClass<E extends Error> = new (...args: any[]) => E;
+export declare const toThrowType: <E extends Error>(this: MatcherContext, received: (() => unknown | Promise<unknown>) | Promise<unknown>, errorType: ErrorClass<E>, validator?: (error: E) => void) => Promise<{
+    pass: boolean;
+    message: () => string;
+}>;
+//# sourceMappingURL=to-throw-type.d.ts.map

package/src/lib/to-throw-type.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"to-throw-type.d.ts","sourceRoot":"","sources":["../../../../../packages/digitaldefiance-express-suite-test-utils/src/lib/to-throw-type.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,QAAQ,CAAC;AAI7C,MAAM,MAAM,UAAU,CAAC,CAAC,SAAS,KAAK,IAAI,KAAK,GAAG,IAAI,EAAE,GAAG,EAAE,KAAK,CAAC,CAAC;AAoDpE,eAAO,MAAM,WAAW,GAAmB,CAAC,SAAS,KAAK,EACxD,MAAM,cAAc,EACpB,UAAU,CAAC,MAAM,OAAO,GAAG,OAAO,CAAC,OAAO,CAAC,CAAC,GAAG,OAAO,CAAC,OAAO,CAAC,EAC/D,WAAW,UAAU,CAAC,CAAC,CAAC,EACxB,YAAY,CAAC,KAAK,EAAE,CAAC,KAAK,IAAI,KAC7B,OAAO,CAAC;IAAE,IAAI,EAAE,OAAO,CAAC;IAAC,OAAO,EAAE,MAAM,MAAM,CAAA;CAAE,CA4HlD,CAAC"}

package/src/lib/types.d.ts

@@ -0,0 +1,16 @@
+export {};
+declare global {
+    namespace jest {
+        interface Matchers<R> {
+            toThrowType<E extends Error, T extends new (...args: any[]) => E>(errorType: T, validator?: (error: E) => void): R;
+        }
+    }
+}
+declare module 'expect' {
+    interface ExpectExtendMap {
+        toThrowType: {
+            <E extends Error, T extends new (...args: any[]) => E>(this: jest.MatcherContext, received: () => unknown, errorType: T, validator?: (error: E) => void): jest.CustomMatcherResult;
+        };
+    }
+}
+//# sourceMappingURL=types.d.ts.map

package/src/lib/types.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../../../../packages/digitaldefiance-express-suite-test-utils/src/lib/types.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,CAAC;AAEV,OAAO,CAAC,MAAM,CAAC;IACb,UAAU,IAAI,CAAC;QACb,UAAU,QAAQ,CAAC,CAAC;YAElB,WAAW,CAAC,CAAC,SAAS,KAAK,EAAE,CAAC,SAAS,KAAK,GAAG,IAAI,EAAE,GAAG,EAAE,KAAK,CAAC,EAC9D,SAAS,EAAE,CAAC,EACZ,SAAS,CAAC,EAAE,CAAC,KAAK,EAAE,CAAC,KAAK,IAAI,GAC7B,CAAC,CAAC;SACN;KACF;CACF;AAED,OAAO,QAAQ,QAAQ,CAAC;IACtB,UAAU,eAAe;QACvB,WAAW,EAAE;YAEX,CAAC,CAAC,SAAS,KAAK,EAAE,CAAC,SAAS,KAAK,GAAG,IAAI,EAAE,GAAG,EAAE,KAAK,CAAC,EACnD,IAAI,EAAE,IAAI,CAAC,cAAc,EACzB,QAAQ,EAAE,MAAM,OAAO,EACvB,SAAS,EAAE,CAAC,EACZ,SAAS,CAAC,EAAE,CAAC,KAAK,EAAE,CAAC,KAAK,IAAI,GAC7B,IAAI,CAAC,mBAAmB,CAAC;SAC7B,CAAC;KACH;CACF"}