safe-stable-stringify 2.5.0: safe-stable-stringify

Clean-room public code sample — generation instructions

Write a brand-new, minimal, self-contained code sample in this clean-room directory.
Do not copy, paraphrase, or reference any existing project source. Work only from this spec.

A csx.json manifest scaffold already exists. Do not recreate it from memory. Preserve its case.goal, packages and symbols; fill its empty case.contract with exact assertions and correct its environment, commands and verifierAdapter for the files you generate.

Goal: verify safe-stable-stringify in pkg:npm/safe-stable-stringify@2.5.0
Kind: HOW

Use EXACTLY these public packages and versions:
  - pkg:npm/safe-stable-stringify@2.5.0
Demonstrate these symbols/APIs:
  - safe-stable-stringify

Rules:
  - One focused purpose; the smallest project that proves the goal.
  - Include a contract test (test/contract.*) that runs OFFLINE and exits 0 exactly when the goal behavior works.
  - Pin every dependency with a lockfile so resolution is reproducible.
  - No secrets, credentials, or tokens. No real URLs (only example.com or localhost). No absolute paths.
  - No personal names, emails, company names, or project identifiers of any kind.
  - No binaries and no generated output (node_modules, dist, target, venv, .git, .env).
  - Keep it under 200 files and 256KB packed.

{"case":{"caseId":"case:sha256:84fa4f024cc1dbc6e26836a9a10ccb9fc110746cb3c9c131b7759e96c952103c","contract":["stringify serializes objects deterministically with sorted keys","stringify safely handles circular references by replacing them with [Circular]","stringify serializes BigInt values as numbers by default","stringify respects custom replacer array and space indentation formatting","configure customizes circular reference behavior to custom strings","configure with strict mode throws when encountering non-serializable values"],"goal":"verify safe-stable-stringify in pkg:npm/safe-stable-stringify@2.5.0","kind":"HOW","packages":["pkg:npm/safe-stable-stringify@2.5.0"],"schemaVersion":1,"symbols":["safe-stable-stringify"]},"contractCommand":["node","test/contract.mjs"],"environment":{"arch":"x64","distro":"ubuntu","ecosystem":"npm","libc":"glibc","libcVersion":"2.39","os":"linux","osVersionBucket":"24","packageManager":"npm","schemaVersion":1},"license":"MIT-0","packages":["pkg:npm/safe-stable-stringify@2.5.0"],"schemaVersion":1,"subject":"pkg:npm/safe-stable-stringify@2.5.0","symbols":["safe-stable-stringify"],"verifierAdapter":"node-typescript@1"}

{
  "name": "safe-stable-stringify-sample",
  "version": "1.0.0",
  "lockfileVersion": 3,
  "requires": true,
  "packages": {
    "": {
      "name": "safe-stable-stringify-sample",
      "version": "1.0.0",
      "dependencies": {
        "safe-stable-stringify": "2.5.0"
      }
    },
    "node_modules/safe-stable-stringify": {
      "version": "2.5.0",
      "resolved": "https://registry.npmjs.org/safe-stable-stringify/-/safe-stable-stringify-2.5.0.tgz",
      "integrity": "sha512-b3rppTKm9T+PsVCBEOUR46GWI7fdOs00VKZ1+9c1EWDaDMvjQc6tUwuFyIprgGgTcWoVHSKrU8H31ZHA2e0RHA==",
      "license": "MIT",
      "engines": {
        "node": ">=10"
      }
    }
  }
}

{
  "name": "safe-stable-stringify-sample",
  "version": "1.0.0",
  "private": true,
  "description": "Clean-room verification for safe-stable-stringify",
  "type": "module",
  "dependencies": {
    "safe-stable-stringify": "2.5.0"
  }
}

{
  "schemaVersion": 1,
  "goal": "verify safe-stable-stringify in pkg:npm/safe-stable-stringify@2.5.0",
  "kind": "HOW",
  "packages": [
    "pkg:npm/safe-stable-stringify@2.5.0"
  ],
  "symbols": [
    "safe-stable-stringify"
  ]
}

import assert from 'node:assert';
import stringify, { configure } from 'safe-stable-stringify';

// 1. stringify serializes objects deterministically with sorted keys
const unordered = { z: 26, a: 1, m: 13 };
assert.strictEqual(stringify(unordered), '{"a":1,"m":13,"z":26}');

// 2. stringify safely handles circular references by replacing them with [Circular]
const circular = { name: 'root' };
circular.self = circular;
assert.strictEqual(stringify(circular), '{"name":"root","self":"[Circular]"}');

// 3. stringify serializes BigInt values as numbers by default
const withBigInt = { id: 100n, count: 42 };
assert.strictEqual(stringify(withBigInt), '{"count":42,"id":100}');

// 4. stringify respects custom replacer array and space indentation formatting
const complex = { b: 2, a: 1, c: 3 };
const formatted = stringify(complex, ['a', 'c'], 2);
assert.strictEqual(formatted, '{\n  "a": 1,\n  "c": 3\n}');

// 5. configure customizes circular reference behavior to custom strings
const customStringify = configure({
  circularValue: '[CustomRef]'
});
const customCircular = { node: 'parent' };
customCircular.child = customCircular;
assert.strictEqual(customStringify(customCircular), '{"child":"[CustomRef]","node":"parent"}');

// 6. configure with strict mode throws when encountering non-serializable values
const strictStringify = configure({ strict: true });
assert.throws(
  () => {
    strictStringify({ fn: () => {} });
  },
  (err) => {
    return err instanceof Error;
  }
);

console.log('Contract passed');