@liflig/cdk-snapshot 0.0.1

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Liflig
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,131 @@
+# @liflig/cdk-snapshot
+
+[![npm](https://img.shields.io/npm/v/@liflig/cdk-snapshot.svg)](https://www.npmjs.com/package/@liflig/cdk-snapshot)
+[![ci](https://github.com/capralifecycle/cdk-snapshot/actions/workflows/ci.yml/badge.svg)](https://github.com/capralifecycle/cdk-snapshot/actions/workflows/ci.yml)
+[![license](https://img.shields.io/npm/l/@liflig/cdk-snapshot.svg)](LICENSE)
+
+Normalizes synthesized AWS CDK stacks for snapshot testing by stripping values such as asset hashes, bootstrap parameters, Lambda version suffixes and more, in order to produce more stable and usable snapshot files.
+
+The library provides a generic implementation with a thin adapter per test runner: `node:test`, Bun, Vitest and Jest. Everything is built around one pure function, `cdkTemplate`, which turns a stack into a normalized template object; each adapter wraps that function in whatever the runner's own snapshot assertion looks like. All four write the same snapshot bodies — only the file header differs — so the same `.snap` files stay valid if a project switches runner.
+
+## Install
+
+```sh
+bun add -d @liflig/cdk-snapshot
+```
+
+`aws-cdk-lib` and `constructs` are peer dependencies. The package is ESM; CommonJS test files can `require()` it on Node 22.12 or later.
+
+## Usage
+
+Import the entry point for your runner. Jest, Vitest and Bun get a `toMatchCdkSnapshot` matcher; `node:test` has no `expect` at the time of writing, so it calls `cdkTemplate` directly.
+
+### node:test
+
+`configureCdkSnapshots()` points `node:test` at `__snapshots__/*.snap` and the shared serializer. Call it once, before any test runs. It replaces the default serializer for _every_ snapshot in the run, not just CDK ones, so snapshots taken elsewhere in the same project will be reformatted.
+
+```js
+import test from "node:test";
+import { cdkTemplate, configureCdkSnapshots } from "@liflig/cdk-snapshot/node";
+
+configureCdkSnapshots();
+
+test("my stack", (t) => {
+  t.assert.snapshot(cdkTemplate(stack, { ignoreAssets: true }));
+});
+```
+
+Write snapshots with `node --test --test-update-snapshots`.
+
+### Bun
+
+```js
+import { expect, test } from "bun:test";
+import "@liflig/cdk-snapshot/bun";
+
+test("my stack", () => {
+  expect(stack).toMatchCdkSnapshot({ ignoreAssets: true });
+});
+```
+
+### Vitest
+
+```js
+import { expect, test } from "vitest";
+import "@liflig/cdk-snapshot/vitest";
+
+test("my stack", () => {
+  expect(stack).toMatchCdkSnapshot({ ignoreAssets: true });
+});
+```
+
+### Jest
+
+```js
+import "@liflig/cdk-snapshot/jest";
+
+test("my stack", () => {
+  expect(stack).toMatchCdkSnapshot({ ignoreAssets: true });
+});
+```
+
+The Jest entry point uses the global `expect`, so it throws on import if Jest is configured with `injectGlobals: false`.
+
+The matcher also accepts `propertyMatchers`, forwarded to the runner's own snapshot assertion for values the normalizations do not cover:
+
+```js
+expect(stack).toMatchCdkSnapshot({
+  propertyMatchers: { Resources: expect.any(Object) },
+});
+```
+
+Every entry point also exports `cdkTemplate(stack, options)`. Reach for it to assert on the template without a snapshot. It leaves the stack untouched, so one stack can be synthesized repeatedly with different options.
+
+`toMatchCdkSnapshot` cannot be negated; `.not` throws rather than silently passing.
+
+## Options
+
+| Option                   | Default       | Effect                                                                              |
+| ------------------------ | ------------- | ----------------------------------------------------------------------------------- |
+| `ignoreAssets`           | `false`       | Replaces Lambda `Code`, container `Image` and the whole `Parameters` block with `Any<Object>` |
+| `ignoreBootstrapVersion` | `true`        | Drops the `BootstrapVersion` parameter and its check rule                            |
+| `ignoreCurrentVersion`   | `false`       | Masks the content hash on Lambda `CurrentVersion` logical IDs                        |
+| `ignoreMetadata`         | `false`       | Drops template and resource `Metadata`                                               |
+| `ignoreTags`             | `false`       | Drops `Tags` from resource properties                                                |
+| `ignorePipelineAssets`   | `false`       | Masks asset paths and IDs in CDK Pipelines `cdk-assets` commands                     |
+| `subsetResourceTypes`    | —             | Keeps only resources of these CloudFormation types                                   |
+| `subsetResourceKeys`     | —             | Keeps only resources with these logical IDs                                          |
+| `assetPlaceholder`       | `anyObject`   | Token substituted for asset-derived values                                           |
+| `propertyMatchers`       | —             | Matchers forwarded to the runner's snapshot assertion (matcher only)                 |
+
+`subsetResourceTypes` and `subsetResourceKeys` intersect: given both, a resource is kept only if it matches both.
+
+`ignoreAssets` replaces the entire `Parameters` block rather than the individual asset parameters, matching what jest-cdk-snapshot does.
+
+`anyObject` is exported from the package root. It is an asymmetric matcher that serializes as `Any<Object>` and matches any non-null object. The Bun entry point substitutes `expect.any(Object)` instead, because Bun's serializer only recognizes matchers built by its own `expect`.
+
+## Development
+
+```sh
+make build   # install, format, typecheck, refresh snapshots, test
+make ci      # what the CI workflow runs: refuses a stale lockfile, fails on an uncommitted snapshot change
+```
+
+`make snapshots` regenerates the unit snapshots plus the shared fixture under all four runners, which `test/compat.test.ts` then compares against each other.
+
+## Migrating from jest-cdk-snapshot
+
+Change the import. Call sites and `.snap` files stay as they are, since the options, their defaults and the serialization all match.
+
+```diff
+-import "jest-cdk-snapshot"
++import "@liflig/cdk-snapshot/jest"
+```
+
+Verified against liflig-cdk (64 snapshots) and cdk-cloudfront-auth: every snapshot passes under `jest --ci`, and a forced `--updateSnapshot` rewrites nothing.
+
+Two of its options are gone. `yaml` is not supported, so a project snapshotting YAML has to regenerate as JSON. The no-op synthesis options it inherited from `StageSynthesisOptions` — `skipValidation`, `validateOnSynthesis`, `force` — are rejected by the type checker instead of warned about at runtime; delete them.
+
+## License
+
+MIT, see [LICENSE](LICENSE).

package/package.json

@@ -0,0 +1,101 @@
+{
+  "name": "@liflig/cdk-snapshot",
+  "version": "0.0.1",
+  "description": "Normalizes synthesized AWS CDK stacks for snapshot testing",
+  "type": "module",
+  "license": "MIT",
+  "author": "Liflig",
+  "engines": {
+    "node": ">=22.12.0"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/capralifecycle/cdk-snapshot.git"
+  },
+  "homepage": "https://github.com/capralifecycle/cdk-snapshot#readme",
+  "bugs": {
+    "url": "https://github.com/capralifecycle/cdk-snapshot/issues"
+  },
+  "keywords": [
+    "aws",
+    "cdk",
+    "cloudformation",
+    "snapshot",
+    "snapshot-testing",
+    "testing",
+    "jest",
+    "vitest",
+    "bun",
+    "node-test"
+  ],
+  "main": "./lib/index.js",
+  "types": "./lib/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./lib/index.d.ts",
+      "import": "./lib/index.js",
+      "default": "./lib/index.js"
+    },
+    "./bun": {
+      "types": "./lib/bun.d.ts",
+      "import": "./lib/bun.js",
+      "default": "./lib/bun.js"
+    },
+    "./jest": {
+      "types": "./lib/jest.d.ts",
+      "import": "./lib/jest.js",
+      "default": "./lib/jest.js"
+    },
+    "./node": {
+      "types": "./lib/node.d.ts",
+      "import": "./lib/node.js",
+      "default": "./lib/node.js"
+    },
+    "./vitest": {
+      "types": "./lib/vitest.d.ts",
+      "import": "./lib/vitest.js",
+      "default": "./lib/vitest.js"
+    },
+    "./package.json": "./package.json"
+  },
+  "files": [
+    "lib/**/*"
+  ],
+  "scripts": {
+    "build": "tsc",
+    "test": "bun test ./test",
+    "snapshots": "bun test ./test --update-snapshots",
+    "typecheck": "tsc -p tsconfig.check.json",
+    "check": "biome ci && bun run typecheck",
+    "fix": "biome check --write",
+    "semantic-release": "semantic-release"
+  },
+  "peerDependencies": {
+    "aws-cdk-lib": "^2.0.0",
+    "constructs": "^10.0.0",
+    "vitest": ">=4"
+  },
+  "peerDependenciesMeta": {
+    "vitest": {
+      "optional": true
+    }
+  },
+  "dependencies": {
+    "pretty-format": "^29.7.0"
+  },
+  "devDependencies": {
+    "@biomejs/biome": "2.5.10",
+    "@types/bun": "1.4.0",
+    "@types/jest": "30.0.0",
+    "@types/node": "24.13.3",
+    "aws-cdk-lib": "2.266.0",
+    "constructs": "10.8.1",
+    "jest": "30.4.2",
+    "semantic-release": "25.0.9",
+    "typescript": "7.0.2",
+    "vitest": "4.1.11"
+  },
+  "publishConfig": {
+    "access": "public"
+  }
+}