json-schema-traverse 0.4.1

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 pkg:npm/json-schema-traverse@0.4.1
Kind: HOW

Use EXACTLY these public packages and versions:
  - pkg:npm/json-schema-traverse@0.4.1
Constraints:
  - executionContext: node
Required runtime conditions:
  - ecosystem: npm
  - language: javascript
  - moduleSystem: cjs
  - runtime: node@22.23.2

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:de337d8dfccbe8ab0b31b36fd529914264b5818f5c8b9f0a54bc220d6152f6ee","constraints":{"executionContext":"node"},"contract":["assert traverse visits root schema and nested subschemas in properties and definitions with correct jsonPtr","assert traverse visits subschemas inside array keywords including allOf and items array with index in jsonPtr","assert traverse supports pre and post hooks to execute callbacks before and after child traversal","assert traverse properly escapes tilde and slash characters in jsonPtr segments according to RFC 6901","assert traverse visits custom keywords when allKeys option is enabled while ignoring skipKeywords"],"goal":"verify pkg:npm/json-schema-traverse@0.4.1","kind":"HOW","packages":["pkg:npm/json-schema-traverse@0.4.1"],"schemaVersion":1},"contractCommand":["node","test/contract.mjs"],"environment":{"arch":"x64","distro":"ubuntu","ecosystem":"npm","executionContext":"node","language":"javascript","libc":"glibc","libcVersion":"2.39","moduleSystem":"cjs","os":"linux","osVersionBucket":"24","packageManager":"npm","runtime":"node","runtimeVersion":"22.23.2","schemaVersion":1},"license":"MIT-0","packages":["pkg:npm/json-schema-traverse@0.4.1"],"schemaVersion":1,"subject":"pkg:npm/json-schema-traverse@0.4.1","verifierAdapter":"node-typescript@1"}

{
  "name": "sample-json-schema-traverse",
  "version": "1.0.0",
  "lockfileVersion": 3,
  "requires": true,
  "packages": {
    "": {
      "name": "sample-json-schema-traverse",
      "version": "1.0.0",
      "license": "MIT-0",
      "dependencies": {
        "json-schema-traverse": "0.4.1"
      }
    },
    "node_modules/json-schema-traverse": {
      "version": "0.4.1",
      "resolved": "https://registry.npmjs.org/json-schema-traverse/-/json-schema-traverse-0.4.1.tgz",
      "integrity": "sha512-xbbCH5dCYU5T8LcEhhuh7HJ88HXuW3qsI3Y0zOZFKfZEHcpWiHU/Jxzk629Brsab/mMiHQti9wMP+845RPe3Vg==",
      "license": "MIT"
    }
  }
}

{
  "name": "sample-json-schema-traverse",
  "version": "1.0.0",
  "type": "module",
  "license": "MIT-0",
  "dependencies": {
    "json-schema-traverse": "0.4.1"
  }
}

{
  "schemaVersion": 1,
  "goal": "verify pkg:npm/json-schema-traverse@0.4.1",
  "kind": "HOW",
  "packages": [
    "pkg:npm/json-schema-traverse@0.4.1"
  ],
  "constraints": {
    "executionContext": "node"
  },
  "runtimeConditions": {
    "ecosystem": "npm",
    "language": "javascript",
    "moduleSystem": "cjs",
    "runtime": "node@22.23.2"
  }
}

import assert from 'node:assert/strict';
import { createRequire } from 'node:module';

const require = createRequire(import.meta.url);
const traverse = require('json-schema-traverse');

// 1. Visit root schema and nested subschemas in properties and definitions with correct jsonPtr
{
  const schema = {
    type: 'object',
    properties: {
      user: {
        type: 'object',
        properties: {
          name: { type: 'string' }
        }
      }
    },
    definitions: {
      address: { type: 'string' }
    }
  };

  const visited = [];
  traverse(schema, (subschema, jsonPtr, rootSchema, parentJsonPtr, parentKeyword, parentSchema, keyIndex) => {
    visited.push({ jsonPtr, parentKeyword, keyIndex });
  });

  assert.deepEqual(visited, [
    { jsonPtr: '', parentKeyword: undefined, keyIndex: undefined },
    { jsonPtr: '/properties/user', parentKeyword: 'properties', keyIndex: 'user' },
    { jsonPtr: '/properties/user/properties/name', parentKeyword: 'properties', keyIndex: 'name' },
    { jsonPtr: '/definitions/address', parentKeyword: 'definitions', keyIndex: 'address' }
  ]);
}

// 2. Visit subschemas inside array keywords including allOf and items array with index in jsonPtr
{
  const schema = {
    allOf: [
      { type: 'number', minimum: 0 },
      { type: 'number', maximum: 100 }
    ],
    items: [
      { type: 'string' },
      { type: 'boolean' }
    ]
  };

  const visitedPtrs = [];
  traverse(schema, (subschema, jsonPtr) => {
    visitedPtrs.push(jsonPtr);
  });

  assert.deepEqual(visitedPtrs, [
    '',
    '/allOf/0',
    '/allOf/1',
    '/items/0',
    '/items/1'
  ]);
}

// 3. Support pre and post hooks to execute callbacks before and after child traversal
{
  const schema = {
    properties: {
      a: { type: 'string' }
    }
  };

  const events = [];
  traverse(schema, {
    cb: {
      pre: (subschema, jsonPtr) => {
        events.push(`pre:${jsonPtr}`);
      },
      post: (subschema, jsonPtr) => {
        events.push(`post:${jsonPtr}`);
      }
    }
  });

  assert.deepEqual(events, [
    'pre:',
    'pre:/properties/a',
    'post:/properties/a',
    'post:'
  ]);
}

// 4. Properly escape tilde and slash characters in jsonPtr segments according to RFC 6901
{
  const schema = {
    properties: {
      'foo/bar': { type: 'string' },
      'foo~bar': { type: 'number' }
    }
  };

  const visitedPtrs = [];
  traverse(schema, (subschema, jsonPtr) => {
    visitedPtrs.push(jsonPtr);
  });

  assert.deepEqual(visitedPtrs, [
    '',
    '/properties/foo~1bar',
    '/properties/foo~0bar'
  ]);
}

// 5. Visit custom keywords when allKeys option is enabled while ignoring skipKeywords
{
  const schema = {
    type: 'object',
    required: ['id'],
    customSubschema: {
      type: 'string'
    }
  };

  const visitedPtrs = [];
  traverse(schema, { allKeys: true }, (subschema, jsonPtr) => {
    visitedPtrs.push(jsonPtr);
  });

  assert.deepEqual(visitedPtrs, [
    '',
    '/customSubschema'
  ]);
}