@cronn/lib-file-snapshots 1.1.1 → 1.2.0

package/dist/index.d.mts

@@ -22,6 +22,10 @@ declare class Table<TRow extends TableRow = TableRow> implements TableData<TRow>
   static fromRecords<TRow extends TableRowRecord>(rows: Array<TRow>): Table;
 }
 //#endregion
+//#region src/types/normalizer.d.ts
+type Normalizer<TValue> = (value: TValue) => TValue;
+type NormalizerWithContext<TValue, TContext> = (value: TValue, context: TContext) => TValue;
+//#endregion
 //#region src/types/serializer.d.ts
 interface SnapshotSerializer<TValue> {
   /**
@@ -57,7 +61,7 @@ interface JsonSerializerOptions {
    */
   indentSize?: number;
 }
-type JsonNormalizer = (value: unknown, context: JsonNormalizerContext) => unknown;
+type JsonNormalizer = NormalizerWithContext<unknown, JsonNormalizerContext>;
 interface JsonNormalizerContext {
   key?: string;
   index?: number;
@@ -88,7 +92,7 @@ interface MarkdownTableSerializerOptions {
    */
   normalizers?: Array<MarkdownTableNormalizer>;
 }
-type MarkdownTableNormalizer = (value: TableCell) => TableCell;
+type MarkdownTableNormalizer = Normalizer<TableCell>;
 declare class MarkdownTableSerializer implements SnapshotSerializer<TableData> {
   readonly fileExtension = "md";
   private readonly normalizers;
@@ -111,7 +115,7 @@ interface TextSerializerOptions {
    */
   fileExtension?: string;
 }
-type TextNormalizer = (value: string) => string;
+type TextNormalizer = Normalizer<string>;
 declare class TextSerializer implements SnapshotSerializer<string> {
   readonly fileExtension: string;
   private readonly normalizers;
@@ -184,6 +188,36 @@ declare class ValidationFileMatcher<TValue> {
 declare function resolveNameAsFile(params: FilePathResolverParams): string;
 declare function resolveNameAsFileSuffix(params: FilePathResolverParams): string;
 //#endregion
+//#region src/normalizers/string-normalizer.d.ts
+/**
+ * Creates a guarded normalizer that only applies the given normalizer if the value is a string
+ *
+ * @example stringNormalizer((value) => value.trim())
+ */
+declare function stringNormalizer<TValue>(normalizer: Normalizer<string>): Normalizer<TValue>;
+//#endregion
+//#region src/normalizers/mask-pattern.d.ts
+/**
+ * Returns a normalizer that finds every distinct match of `searchPattern` and replaces it with `maskValue(index)`
+ *
+ * @param searchPattern The pattern to be masked (requires global flag to find all matches)
+ * @param maskValue The function returning the masked value to replace a matched value with
+ *
+ * @example maskPattern(/[\d{4}-\d{2}-\d{2}/g, (index) => `<DATE_${index}>`)
+ */
+declare function maskPattern(searchPattern: RegExp, maskValue: (index: number) => string): Normalizer<string>;
+//#endregion
+//#region src/normalizers/mask-string.d.ts
+/**
+ * Returns a normalizer that replaces every occurrence of `searchValue` with `maskedValue`.
+ *
+ * @param searchValue The value to be masked
+ * @param maskedValue The masked value to replace the `searchValue` with
+ *
+ * @example maskString("https://example.com", "<BASE_URL>")
+ */
+declare function maskString(searchValue: string, maskedValue: string): Normalizer<string>;
+//#endregion
 //#region src/utils/file.d.ts
 declare function normalizeFileName(testName: string): string;
 //#endregion
@@ -193,4 +227,4 @@ declare function isArray(value: unknown): value is Array<unknown>;
 type PlainObject = Record<PropertyKey, unknown>;
 declare function isPlainObject(value: unknown): value is PlainObject;
 //#endregion
-export { type FilePathResolver, type FilePathResolverParams, type JsonNormalizer, type JsonNormalizerContext, JsonSerializer, type MarkdownTableNormalizer, MarkdownTableSerializer, type PlainObject, type SnapshotSerializer, Table, type TableCell, type TableData, type TableRow, type TextNormalizer, TextSerializer, type UpdateSnapshotsType, ValidationFileMatcher, type ValidationFileMatcherResult, isArray, isPlainObject, isString, normalizeFileName, resolveNameAsFile, resolveNameAsFileSuffix };
+export { type FilePathResolver, type FilePathResolverParams, type JsonNormalizer, type JsonNormalizerContext, JsonSerializer, type MarkdownTableNormalizer, MarkdownTableSerializer, type Normalizer, type NormalizerWithContext, type PlainObject, type SnapshotSerializer, Table, type TableCell, type TableData, type TableRow, type TextNormalizer, TextSerializer, type UpdateSnapshotsType, ValidationFileMatcher, type ValidationFileMatcherResult, isArray, isPlainObject, isString, maskPattern, maskString, normalizeFileName, resolveNameAsFile, resolveNameAsFileSuffix, stringNormalizer };

package/dist/index.mjs

@@ -300,4 +300,60 @@ function resolveFilePath(params, resolveNamedFilePath) {
 	});
 }
 //#endregion
-export { JsonSerializer, MarkdownTableSerializer, Table, TextSerializer, ValidationFileMatcher, isArray, isPlainObject, isString, normalizeFileName, resolveNameAsFile, resolveNameAsFileSuffix };
+//#region src/normalizers/string-normalizer.ts
+/**
+* Creates a guarded normalizer that only applies the given normalizer if the value is a string
+*
+* @example stringNormalizer((value) => value.trim())
+*/
+function stringNormalizer(normalizer) {
+	return guardedNormalizers(isString, normalizer);
+}
+function guardedNormalizers(guard, normalizer) {
+	return function conditionalNormalizer(value) {
+		if (!guard(value)) return value;
+		return normalizer(value);
+	};
+}
+//#endregion
+//#region src/normalizers/mask-pattern.ts
+/**
+* Returns a normalizer that finds every distinct match of `searchPattern` and replaces it with `maskValue(index)`
+*
+* @param searchPattern The pattern to be masked (requires global flag to find all matches)
+* @param maskValue The function returning the masked value to replace a matched value with
+*
+* @example maskPattern(/[\d{4}-\d{2}-\d{2}/g, (index) => `<DATE_${index}>`)
+*/
+function maskPattern(searchPattern, maskValue) {
+	const distinctValues = /* @__PURE__ */ new Set();
+	return function normalizer(value) {
+		let match;
+		while ((match = searchPattern.exec(value)) !== null) {
+			const matchedValue = match[0];
+			if (!distinctValues.has(matchedValue)) distinctValues.add(matchedValue);
+		}
+		let maskedValue = value;
+		Array.from(distinctValues.values()).forEach((matchedValue, index) => {
+			maskedValue = maskedValue.replaceAll(matchedValue, maskValue(index));
+		});
+		return maskedValue;
+	};
+}
+//#endregion
+//#region src/normalizers/mask-string.ts
+/**
+* Returns a normalizer that replaces every occurrence of `searchValue` with `maskedValue`.
+*
+* @param searchValue The value to be masked
+* @param maskedValue The masked value to replace the `searchValue` with
+*
+* @example maskString("https://example.com", "<BASE_URL>")
+*/
+function maskString(searchValue, maskedValue) {
+	return function normalizer(value) {
+		return value.replaceAll(searchValue, maskedValue);
+	};
+}
+//#endregion
+export { JsonSerializer, MarkdownTableSerializer, Table, TextSerializer, ValidationFileMatcher, isArray, isPlainObject, isString, maskPattern, maskString, normalizeFileName, resolveNameAsFile, resolveNameAsFileSuffix, stringNormalizer };

package/package.json

@@ -1,36 +1,24 @@
 {
   "name": "@cronn/lib-file-snapshots",
-  "version": "1.1.1",
+  "version": "1.2.0",
   "description": "The library agnostic core for testing file snapshots",
   "keywords": [
     "file snapshots"
   ],
+  "homepage": "https://github.com/cronn/file-snapshots",
   "bugs": {
     "url": "https://github.com/cronn/file-snapshots/issues"
   },
-  "author": "cronn",
   "license": "Apache-2.0",
+  "author": "cronn",
   "repository": {
     "type": "git",
     "url": "git+https://github.com/cronn/file-snapshots.git",
     "directory": "packages/lib-file-snapshots"
   },
-  "homepage": "https://github.com/cronn/file-snapshots",
-  "engines": {
-    "node": "^20 || ^22 || >=24"
-  },
-  "devEngines": {
-    "runtime": {
-      "name": "node",
-      "version": ">=24.14.1 <25",
-      "onFail": "error"
-    },
-    "packageManager": {
-      "name": "pnpm",
-      "version": ">=10.33.0 <11",
-      "onFail": "error"
-    }
-  },
+  "files": [
+    "dist"
+  ],
   "type": "module",
   "exports": {
     "./package.json": "./package.json",
@@ -39,37 +27,48 @@
       "default": "./dist/index.mjs"
     }
   },
-  "files": [
-    "dist"
-  ],
   "dependencies": {
     "markdown-table": "3.0.4"
   },
   "devDependencies": {
     "@arethetypeswrong/core": "0.18.2",
-    "@trivago/prettier-plugin-sort-imports": "6.0.2",
-    "@types/node": "24.12.2",
-    "@typescript/native-preview": "7.0.0-dev.20260413.1",
-    "@vitest/coverage-v8": "4.1.4",
-    "eslint": "10.2.0",
+    "@types/node": "24.12.4",
+    "@typescript/native-preview": "7.0.0-dev.20260518.1",
+    "@vitest/coverage-v8": "4.1.6",
+    "eslint": "10.4.0",
     "eslint-config-prettier": "10.1.8",
     "eslint-plugin-check-file": "3.3.1",
     "eslint-plugin-unused-imports": "4.4.1",
-    "prettier": "3.8.2",
-    "publint": "0.3.18",
+    "publint": "0.3.21",
     "rimraf": "6.1.3",
-    "tsdown": "0.21.7",
-    "typescript-eslint": "8.58.1",
-    "vitest": "4.1.4",
+    "tsdown": "0.22.0",
+    "typescript-eslint": "8.59.4",
+    "vitest": "4.1.6",
+    "node": "runtime:>=24.14.1 <25",
     "@cronn/shared-configs": "0.0.0"
   },
+  "devEngines": {
+    "packageManager": {
+      "name": "pnpm",
+      "version": "11.3.0",
+      "onFail": "download"
+    },
+    "runtime": {
+      "name": "node",
+      "version": ">=24.14.1 <25",
+      "onFail": "download"
+    }
+  },
+  "engines": {
+    "node": "^20 || ^22 || >=24"
+  },
   "scripts": {
+    "build": "tsdown",
+    "clean": "rimraf .turbo dist coverage",
+    "compile": "tsgo",
     "lint:check": "eslint src/ --max-warnings=0",
     "lint:fix": "eslint src/ --max-warnings=0 --fix",
     "test": "vitest run",
-    "test:coverage": "vitest run --coverage",
-    "compile": "tsgo",
-    "build": "tsdown",
-    "clean": "rimraf .turbo dist coverage"
+    "test:coverage": "vitest run --coverage"
   }
 }