@papillonarts/setup 0.39.0 → 0.41.0

package/build/jest/index.d.ts

@@ -1,3 +1,4 @@
 export { getJestSetup } from './config';
 export { runJestSetup } from './setup';
+export { renderSnapshot, renderSnapshotAsync, createMockStore, waitFor } from './utility';
 //# sourceMappingURL=index.d.ts.map

package/build/jest/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/jest/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,MAAM,UAAU,CAAA;AACvC,OAAO,EAAE,YAAY,EAAE,MAAM,SAAS,CAAA"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/jest/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,MAAM,UAAU,CAAA;AACvC,OAAO,EAAE,YAAY,EAAE,MAAM,SAAS,CAAA;AACtC,OAAO,EAAE,cAAc,EAAE,mBAAmB,EAAE,eAAe,EAAE,OAAO,EAAE,MAAM,WAAW,CAAA"}

package/build/jest/index.js

@@ -3,17 +3,42 @@
 Object.defineProperty(exports, "__esModule", {
   value: true
 });
+Object.defineProperty(exports, "createMockStore", {
+  enumerable: true,
+  get: function get() {
+    return _utility.createMockStore;
+  }
+});
 Object.defineProperty(exports, "getJestSetup", {
   enumerable: true,
   get: function get() {
     return _config.getJestSetup;
   }
 });
+Object.defineProperty(exports, "renderSnapshot", {
+  enumerable: true,
+  get: function get() {
+    return _utility.renderSnapshot;
+  }
+});
+Object.defineProperty(exports, "renderSnapshotAsync", {
+  enumerable: true,
+  get: function get() {
+    return _utility.renderSnapshotAsync;
+  }
+});
 Object.defineProperty(exports, "runJestSetup", {
   enumerable: true,
   get: function get() {
     return _setup.runJestSetup;
   }
 });
+Object.defineProperty(exports, "waitFor", {
+  enumerable: true,
+  get: function get() {
+    return _utility.waitFor;
+  }
+});
 var _config = require("./config");
-var _setup = require("./setup");
+var _setup = require("./setup");
+var _utility = require("./utility");

package/build/jest/setup.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"setup.d.ts","sourceRoot":"","sources":["../../src/jest/setup.ts"],"names":[],"mappings":"AAGA,OAAO,uBAAuB,CAAA;AAG9B,wBAAgB,YAAY,SAS3B"}
+{"version":3,"file":"setup.d.ts","sourceRoot":"","sources":["../../src/jest/setup.ts"],"names":[],"mappings":"AAGA,OAAO,uBAAuB,CAAA;AAG9B,wBAAgB,YAAY,SAmG3B"}

package/build/jest/setup.js

@@ -11,6 +11,88 @@ var _snapshotDiff = require("snapshot-diff");
 // https://github.com/jest-community/snapshot-diff
 
 function runJestSetup() {
+  /**
+   * Normalizes Date.prototype methods to output deterministic ISO-like UTC strings.
+   * This prevents snapshot churn across different environments/timezones.
+   *
+   * Format: yyyy-MM-ddTHH:mm:ssZ (24-hour, explicit UTC designator)
+   * Timezone: UTC (set via process.env.TZ)
+   *
+   * @example
+   * new Date('2020-07-05T19:04:15Z').toLocaleString() // "2020-07-05T19:04:15Z"
+   */
+
+  // Force deterministic date/time output in tests (avoids locale/timezone snapshot churn)
+  process.env.TZ = 'UTC';
+
+  /**
+   * Pads a number with leading zero if less than 10.
+   * @param {number} n - Number to pad
+   * @returns {string} Padded string
+   */
+  function pad2(n) {
+    return n < 10 ? "0".concat(n) : "".concat(n);
+  }
+
+  /**
+   * Formats a date-time as "yyyy-MM-ddTHH:mm:ssZ" in UTC.
+   * @param {Date} date - Date to format
+   * @returns {string} Formatted ISO-like date-time string
+   */
+  function formatAsISODateTime(date) {
+    var d = pad2(date.getUTCDate());
+    var m = pad2(date.getUTCMonth() + 1);
+    var y = date.getUTCFullYear();
+    var hh = pad2(date.getUTCHours());
+    var mm = pad2(date.getUTCMinutes());
+    var ss = pad2(date.getUTCSeconds());
+    return "".concat(y, "-").concat(m, "-").concat(d, "T").concat(hh, ":").concat(mm, ":").concat(ss, "Z");
+  }
+
+  /**
+   * Formats a date as "yyyy-MM-dd" in UTC.
+   * @param {Date} date - Date to format
+   * @returns {string} Formatted ISO-like date string
+   */
+  function formatAsISODate(date) {
+    var d = pad2(date.getUTCDate());
+    var m = pad2(date.getUTCMonth() + 1);
+    var y = date.getUTCFullYear();
+    return "".concat(y, "-").concat(m, "-").concat(d);
+  }
+
+  /**
+   * Formats a time as "HH:mm:ssZ" in UTC.
+   * @param {Date} date - Date to format
+   * @returns {string} Formatted ISO-like time string
+   */
+  function formatAsISOTime(date) {
+    var hh = pad2(date.getUTCHours());
+    var mm = pad2(date.getUTCMinutes());
+    var ss = pad2(date.getUTCSeconds());
+    return "".concat(hh, ":").concat(mm, ":").concat(ss, "Z");
+  }
+  var originalToLocaleString = Date.prototype.toLocaleString;
+  var originalToLocaleDateString = Date.prototype.toLocaleDateString;
+  var originalToLocaleTimeString = Date.prototype.toLocaleTimeString;
+  Date.prototype.toLocaleString = function toLocaleStringPatched(locale, options) {
+    if (!locale && !options) {
+      return formatAsISODateTime(this);
+    }
+    return originalToLocaleString.call(this, locale, options);
+  };
+  Date.prototype.toLocaleDateString = function toLocaleDateStringPatched(locale, options) {
+    if (!locale && !options) {
+      return formatAsISODate(this);
+    }
+    return originalToLocaleDateString.call(this, locale, options);
+  };
+  Date.prototype.toLocaleTimeString = function toLocaleTimeStringPatched(locale, options) {
+    if (!locale && !options) {
+      return formatAsISOTime(this);
+    }
+    return originalToLocaleTimeString.call(this, locale, options);
+  };
   global.act = _react.act;
   global.cleanup = _react.cleanup;
   global.fireEvent = _react.fireEvent;

package/build/jest/utility.d.ts

@@ -0,0 +1,73 @@
+/**
+ * Shared test utilities for reducing boilerplate in test files.
+ *
+ * These utilities wrap common testing patterns used across the codebase,
+ * particularly for snapshot testing with React components.
+ */
+/**
+ * Renders a component and matches it against a snapshot.
+ *
+ * @param component - JSX element to render
+ * @returns Snapshot matcher result
+ *
+ * @example
+ * ```typescript
+ * import { renderSnapshot } from '../__tests__/test-utils'
+ * import { defaults } from './Component.feature'
+ *
+ * test('must match defaults()', () => {
+ *   renderSnapshot(defaults())
+ * })
+ * ```
+ */
+import type { ReactElement } from 'react';
+export declare const renderSnapshot: (component: ReactElement) => void;
+/**
+ * Renders an async component and matches it against a snapshot.
+ * Wraps the render in React's act() to ensure all updates are flushed.
+ *
+ * @param component - JSX element to render (can be a Promise)
+ * @returns Promise that resolves to snapshot matcher result
+ *
+ * @example
+ * ```typescript
+ * import { renderSnapshotAsync } from '../__tests__/test-utils'
+ * import { async } from './Component.feature'
+ *
+ * test('must match async()', async () => {
+ *   await renderSnapshotAsync(async())
+ * })
+ * ```
+ */
+export declare const renderSnapshotAsync: (component: ReactElement | Promise<ReactElement>) => Promise<void>;
+/**
+ * Creates a mock store with default configuration.
+ * Useful for testing Redux-connected components.
+ *
+ * @param initialState - Optional initial state for the store
+ * @returns Mocked Redux store
+ *
+ * @example
+ * ```typescript
+ * import { createMockStore } from '../__tests__/test-utils'
+ *
+ * const store = createMockStore({ context: { cars: [] } })
+ * ```
+ */
+export declare const createMockStore: (initialState?: {}) => {};
+/**
+ * Waits for a condition to be true with timeout.
+ * Useful for testing async state updates.
+ *
+ * @param condition - Function that returns true when condition is met
+ * @param timeout - Maximum time to wait in milliseconds (default: 1000)
+ * @param interval - Check interval in milliseconds (default: 50)
+ * @returns Promise that resolves when condition is true
+ *
+ * @example
+ * ```typescript
+ * await waitFor(() => element.textContent === 'Loaded', 2000)
+ * ```
+ */
+export declare const waitFor: (condition: () => boolean, timeout?: number, interval?: number) => Promise<void>;
+//# sourceMappingURL=utility.d.ts.map

package/build/jest/utility.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"utility.d.ts","sourceRoot":"","sources":["../../src/jest/utility.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAEH;;;;;;;;;;;;;;;GAeG;AACH,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,OAAO,CAAA;AAEzC,eAAO,MAAM,cAAc,GAAI,WAAW,YAAY,SAA6D,CAAA;AAEnH;;;;;;;;;;;;;;;;GAgBG;AACH,eAAO,MAAM,mBAAmB,GAAU,WAAW,YAAY,GAAG,OAAO,CAAC,YAAY,CAAC,kBACW,CAAA;AAEpG;;;;;;;;;;;;;GAaG;AACH,eAAO,MAAM,eAAe,GAAI,iBAAiB,OAIhD,CAAA;AAED;;;;;;;;;;;;;GAaG;AACH,eAAO,MAAM,OAAO,GAAU,WAAW,MAAM,OAAO,EAAE,gBAAc,EAAE,iBAAa,KAAG,OAAO,CAAC,IAAI,CASnG,CAAA"}

package/build/jest/utility.js

@@ -0,0 +1,169 @@
+"use strict";
+
+var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.waitFor = exports.renderSnapshotAsync = exports.renderSnapshot = exports.createMockStore = void 0;
+var _regenerator = _interopRequireDefault(require("@babel/runtime/regenerator"));
+var _asyncToGenerator2 = _interopRequireDefault(require("@babel/runtime/helpers/asyncToGenerator"));
+/**
+ * Shared test utilities for reducing boilerplate in test files.
+ *
+ * These utilities wrap common testing patterns used across the codebase,
+ * particularly for snapshot testing with React components.
+ */
+
+/**
+ * Renders a component and matches it against a snapshot.
+ *
+ * @param component - JSX element to render
+ * @returns Snapshot matcher result
+ *
+ * @example
+ * ```typescript
+ * import { renderSnapshot } from '../__tests__/test-utils'
+ * import { defaults } from './Component.feature'
+ *
+ * test('must match defaults()', () => {
+ *   renderSnapshot(defaults())
+ * })
+ * ```
+ */
+
+var renderSnapshot = exports.renderSnapshot = function renderSnapshot(component) {
+  return expect(global.renderToJSON(component)).toMatchSnapshot();
+};
+
+/**
+ * Renders an async component and matches it against a snapshot.
+ * Wraps the render in React's act() to ensure all updates are flushed.
+ *
+ * @param component - JSX element to render (can be a Promise)
+ * @returns Promise that resolves to snapshot matcher result
+ *
+ * @example
+ * ```typescript
+ * import { renderSnapshotAsync } from '../__tests__/test-utils'
+ * import { async } from './Component.feature'
+ *
+ * test('must match async()', async () => {
+ *   await renderSnapshotAsync(async())
+ * })
+ * ```
+ */
+var renderSnapshotAsync = exports.renderSnapshotAsync = /*#__PURE__*/function () {
+  var _ref = (0, _asyncToGenerator2["default"])(/*#__PURE__*/_regenerator["default"].mark(function _callee2(component) {
+    var _t2;
+    return _regenerator["default"].wrap(function (_context2) {
+      while (1) switch (_context2.prev = _context2.next) {
+        case 0:
+          _t2 = expect;
+          _context2.next = 1;
+          return global.act(/*#__PURE__*/(0, _asyncToGenerator2["default"])(/*#__PURE__*/_regenerator["default"].mark(function _callee() {
+            var _t;
+            return _regenerator["default"].wrap(function (_context) {
+              while (1) switch (_context.prev = _context.next) {
+                case 0:
+                  _t = global;
+                  _context.next = 1;
+                  return component;
+                case 1:
+                  return _context.abrupt("return", _t.renderToJSON.call(_t, _context.sent));
+                case 2:
+                case "end":
+                  return _context.stop();
+              }
+            }, _callee);
+          })));
+        case 1:
+          _context2.next = 2;
+          return _t2(_context2.sent).toMatchSnapshot();
+        case 2:
+          return _context2.abrupt("return", _context2.sent);
+        case 3:
+        case "end":
+          return _context2.stop();
+      }
+    }, _callee2);
+  }));
+  return function renderSnapshotAsync(_x) {
+    return _ref.apply(this, arguments);
+  };
+}();
+
+/**
+ * Creates a mock store with default configuration.
+ * Useful for testing Redux-connected components.
+ *
+ * @param initialState - Optional initial state for the store
+ * @returns Mocked Redux store
+ *
+ * @example
+ * ```typescript
+ * import { createMockStore } from '../__tests__/test-utils'
+ *
+ * const store = createMockStore({ context: { cars: [] } })
+ * ```
+ */
+var createMockStore = exports.createMockStore = function createMockStore() {
+  var initialState = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : {};
+  // This is a placeholder - implement based on your store configuration
+  // You may need to import from redux-mock-store or similar
+  return initialState;
+};
+
+/**
+ * Waits for a condition to be true with timeout.
+ * Useful for testing async state updates.
+ *
+ * @param condition - Function that returns true when condition is met
+ * @param timeout - Maximum time to wait in milliseconds (default: 1000)
+ * @param interval - Check interval in milliseconds (default: 50)
+ * @returns Promise that resolves when condition is true
+ *
+ * @example
+ * ```typescript
+ * await waitFor(() => element.textContent === 'Loaded', 2000)
+ * ```
+ */
+var waitFor = exports.waitFor = /*#__PURE__*/function () {
+  var _ref3 = (0, _asyncToGenerator2["default"])(/*#__PURE__*/_regenerator["default"].mark(function _callee3(condition) {
+    var timeout,
+      interval,
+      startTime,
+      _args3 = arguments;
+    return _regenerator["default"].wrap(function (_context3) {
+      while (1) switch (_context3.prev = _context3.next) {
+        case 0:
+          timeout = _args3.length > 1 && _args3[1] !== undefined ? _args3[1] : 1000;
+          interval = _args3.length > 2 && _args3[2] !== undefined ? _args3[2] : 50;
+          startTime = Date.now();
+        case 1:
+          if (condition()) {
+            _context3.next = 4;
+            break;
+          }
+          if (!(Date.now() - startTime > timeout)) {
+            _context3.next = 2;
+            break;
+          }
+          throw new Error("Timeout waiting for condition after ".concat(timeout, "ms"));
+        case 2:
+          _context3.next = 3;
+          return new Promise(function (resolve) {
+            return setTimeout(resolve, interval);
+          });
+        case 3:
+          _context3.next = 1;
+          break;
+        case 4:
+        case "end":
+          return _context3.stop();
+      }
+    }, _callee3);
+  }));
+  return function waitFor(_x2) {
+    return _ref3.apply(this, arguments);
+  };
+}();

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@papillonarts/setup",
-  "version": "0.39.0",
+  "version": "0.41.0",
   "description": "Papillon Arts Setup",
   "homepage": "https://github.com/papillonarts/papillonarts/tree/master/packages/setup",
   "repository": {
@@ -37,5 +37,5 @@
     "build-acceptance": "npm run build",
     "build-release": "npm run build"
   },
-  "gitHead": "b8f07f71414d7133bc1cfa967ecf30ebca383ef7"
+  "gitHead": "38632df415e9a45e174ea18880ce31b17f8ae2e5"
 }