@digitaldefiance/express-suite-test-utils 1.0.6 → 1.0.8

package/README.md

@@ -2,6 +2,8 @@
 
 Test utilities for Digital Defiance Express Suite projects.
 
+Part of [Express Suite](https://github.com/Digital-Defiance/express-suite)
+
 ## Installation
 
 ```bash
@@ -12,6 +14,37 @@ yarn add @digitaldefiance/express-suite-test-utils
 
 ## Usage
 
+### Importing Test Utilities from Express Suite Packages
+
+Test helpers and mocks are available via separate `/testing` entry points:
+
+```typescript
+// node-express-suite test helpers
+import { 
+  createApplicationMock,
+  setupTestEnv
+} from '@digitaldefiance/node-express-suite/testing';
+
+// node-ecies-lib test mocks
+import { mockBackendMember } from '@digitaldefiance/node-ecies-lib/testing';
+
+// ecies-lib test mocks
+import { mockFrontendMember } from '@digitaldefiance/ecies-lib/testing';
+
+// Use in your tests
+beforeAll(async () => {
+  await setupTestEnv();
+});
+```
+
+**Note:** All `/testing` entry points require `@faker-js/faker` as a peer dependency:
+
+```bash
+npm install -D @faker-js/faker
+# or
+yarn add -D @faker-js/faker
+```
+
 ### toThrowType Matcher
 
 Custom Jest matcher for testing error types with optional validation:
@@ -70,6 +103,10 @@ MIT
 
 ## ChangeLog
 
+### v1.0.8
+
+- Add directLog mocks
+
 ### v1.0.6
 
 - Add react mocks

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@digitaldefiance/express-suite-test-utils",
-  "version": "1.0.6",
+  "version": "1.0.8",
   "description": "Test utilities for Digital Defiance Express Suite",
   "main": "src/index.js",
   "types": "src/index.d.ts",

package/src/index.d.ts

@@ -1,5 +1,6 @@
 export * from './lib/to-throw-type';
 export * from './lib/console';
+export * from './lib/direct-log';
 export * from './lib/localStorage-mock';
 export * from './lib/bson-mock';
 export * from './lib/react-mocks';

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;AAC9B,cAAc,yBAAyB,CAAC;AACxC,cAAc,iBAAiB,CAAC;AAChC,cAAc,mBAAmB,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,kBAAkB,CAAC;AACjC,cAAc,yBAAyB,CAAC;AACxC,cAAc,iBAAiB,CAAC;AAChC,cAAc,mBAAmB,CAAC"}

package/src/index.js

@@ -3,6 +3,7 @@ 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/direct-log"), exports);
 tslib_1.__exportStar(require("./lib/localStorage-mock"), exports);
 tslib_1.__exportStar(require("./lib/bson-mock"), exports);
 tslib_1.__exportStar(require("./lib/react-mocks"), exports);

package/src/lib/direct-log.d.ts

@@ -0,0 +1,36 @@
+/**
+ * Spies returned from withDirectLogMocks
+ */
+export interface DirectLogSpies {
+    writeSync: jest.SpyInstance;
+}
+/**
+ * Options for withDirectLogMocks
+ */
+export interface WithDirectLogOptions {
+    /**
+     * If false, do not mute the output (let it pass through).
+     * By default (true), mutes output.
+     */
+    mute?: boolean;
+}
+/**
+ * Wrap a test body with fs.writeSync spy for directLog testing.
+ * By default mutes output (does nothing on write).
+ * The spy will capture calls with file descriptor and buffer.
+ */
+export declare function withDirectLogMocks<T = unknown>(options: WithDirectLogOptions, fn: (spies: DirectLogSpies) => Promise<T> | T): Promise<T>;
+/**
+ * Helper to check if writeSync was called with a specific file descriptor and message.
+ * @param spy The writeSync spy
+ * @param fd The file descriptor (1 for stdout, 2 for stderr)
+ * @param needles Substrings to search for in the buffer content
+ */
+export declare function directLogContains(spy: jest.SpyInstance, fd: number, ...needles: string[]): boolean;
+/**
+ * Get all messages written to a specific file descriptor.
+ * @param spy The writeSync spy
+ * @param fd The file descriptor (1 for stdout, 2 for stderr)
+ */
+export declare function getDirectLogMessages(spy: jest.SpyInstance, fd: number): string[];
+//# sourceMappingURL=direct-log.d.ts.map

package/src/lib/direct-log.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"direct-log.d.ts","sourceRoot":"","sources":["../../../../../packages/digitaldefiance-express-suite-test-utils/src/lib/direct-log.ts"],"names":[],"mappings":"AAEA;;GAEG;AACH,MAAM,WAAW,cAAc;IAC7B,SAAS,EAAE,IAAI,CAAC,WAAW,CAAC;CAC7B;AAED;;GAEG;AACH,MAAM,WAAW,oBAAoB;IACnC;;;OAGG;IACH,IAAI,CAAC,EAAE,OAAO,CAAC;CAChB;AAED;;;;GAIG;AACH,wBAAsB,kBAAkB,CAAC,CAAC,GAAG,OAAO,EAClD,OAAO,EAAE,oBAAoB,EAC7B,EAAE,EAAE,CAAC,KAAK,EAAE,cAAc,KAAK,OAAO,CAAC,CAAC,CAAC,GAAG,CAAC,GAC5C,OAAO,CAAC,CAAC,CAAC,CAoBZ;AAED;;;;;GAKG;AACH,wBAAgB,iBAAiB,CAC/B,GAAG,EAAE,IAAI,CAAC,WAAW,EACrB,EAAE,EAAE,MAAM,EACV,GAAG,OAAO,EAAE,MAAM,EAAE,GACnB,OAAO,CAWT;AAED;;;;GAIG;AACH,wBAAgB,oBAAoB,CAClC,GAAG,EAAE,IAAI,CAAC,WAAW,EACrB,EAAE,EAAE,MAAM,GACT,MAAM,EAAE,CASV"}

package/src/lib/direct-log.js

@@ -0,0 +1,61 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.withDirectLogMocks = withDirectLogMocks;
+exports.directLogContains = directLogContains;
+exports.getDirectLogMessages = getDirectLogMessages;
+const tslib_1 = require("tslib");
+const fs = tslib_1.__importStar(require("fs"));
+/**
+ * Wrap a test body with fs.writeSync spy for directLog testing.
+ * By default mutes output (does nothing on write).
+ * The spy will capture calls with file descriptor and buffer.
+ */
+async function withDirectLogMocks(options, fn) {
+    const mute = options?.mute !== false; // default true
+    const noop = () => undefined;
+    const originalWriteSync = fs.writeSync;
+    const writeSync = jest
+        .spyOn(fs, 'writeSync')
+        .mockImplementation(mute
+        ? noop
+        : originalWriteSync);
+    const spies = { writeSync };
+    try {
+        return await fn(spies);
+    }
+    finally {
+        writeSync.mockRestore();
+    }
+}
+/**
+ * Helper to check if writeSync was called with a specific file descriptor and message.
+ * @param spy The writeSync spy
+ * @param fd The file descriptor (1 for stdout, 2 for stderr)
+ * @param needles Substrings to search for in the buffer content
+ */
+function directLogContains(spy, fd, ...needles) {
+    return spy.mock.calls.some((args) => {
+        const [calledFd, buffer] = args;
+        if (calledFd !== fd)
+            return false;
+        const text = buffer instanceof Buffer
+            ? buffer.toString('utf8')
+            : String(buffer);
+        return needles.every((n) => text.includes(n));
+    });
+}
+/**
+ * Get all messages written to a specific file descriptor.
+ * @param spy The writeSync spy
+ * @param fd The file descriptor (1 for stdout, 2 for stderr)
+ */
+function getDirectLogMessages(spy, fd) {
+    return spy.mock.calls
+        .filter((args) => args[0] === fd)
+        .map((args) => {
+        const buffer = args[1];
+        return buffer instanceof Buffer
+            ? buffer.toString('utf8')
+            : String(buffer);
+    });
+}