normalize-url 6.1.0: normalizeUrl

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/normalize-url@6.1.0
Kind: HOW

Use EXACTLY these public packages and versions:
  - pkg:npm/normalize-url@6.1.0
Demonstrate these symbols/APIs:
  - normalizeUrl

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.

# verify pkg:npm/normalize-url@6.1.0

Clean-room sample demonstrating and verifying `normalizeUrl` API contract with `pkg:npm/normalize-url@6.1.0`.

{"case":{"caseId":"case:sha256:53905a933f79e3a702382f0e0624cff9b299d21cce31ca107579bef70b5cf17f","contract":["normalizeUrl(url) prepends default http: protocol and strips www. prefix","normalizeUrl(url) strips standard ports and resolves relative path segments","normalizeUrl(url) sorts query parameters alphabetically and strips default tracking parameters","normalizeUrl(url, { forceHttps: true }) converts http: protocol to https:","normalizeUrl(url, { removeSingleSlash: false }) preserves trailing slash for root URL","normalizeUrl(url, { stripHash: true }) removes URL hash fragments","normalizeUrl(url, { removeQueryParameters }) strips custom matched query parameters","normalizeUrl(url, { forceHttp: true, forceHttps: true }) throws an error when conflicting options are specified"],"goal":"verify pkg:npm/normalize-url@6.1.0","kind":"HOW","packages":["pkg:npm/normalize-url@6.1.0"],"schemaVersion":1,"symbols":["normalizeUrl"]},"contractCommand":["node","test/contract.js"],"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/normalize-url@6.1.0"],"schemaVersion":1,"subject":"pkg:npm/normalize-url@6.1.0","symbols":["normalizeUrl"],"verifierAdapter":"node-typescript@1"}

const normalizeUrl = require('normalize-url');

module.exports = {
  normalizeUrl
};

{
  "name": "sample-normalize-url",
  "version": "1.0.0",
  "lockfileVersion": 3,
  "requires": true,
  "packages": {
    "": {
      "name": "sample-normalize-url",
      "version": "1.0.0",
      "dependencies": {
        "normalize-url": "6.1.0"
      }
    },
    "node_modules/normalize-url": {
      "version": "6.1.0",
      "resolved": "https://registry.npmjs.org/normalize-url/-/normalize-url-6.1.0.tgz",
      "integrity": "sha512-DlL+XwOy3NxAQ8xuC0okPgK46iuVNAK01YN7RueYBqqFeGsBjV9XmCAzAdgt+667bCl5kPh9EqKKDwnaPG1I7A==",
      "license": "MIT",
      "engines": {
        "node": ">=10"
      },
      "funding": {
        "url": "https://github.com/sponsors/sindresorhus"
      }
    }
  }
}

{
  "name": "sample-normalize-url",
  "version": "1.0.0",
  "description": "verify pkg:npm/normalize-url@6.1.0",
  "main": "index.js",
  "scripts": {
    "test": "node test/contract.js"
  },
  "dependencies": {
    "normalize-url": "6.1.0"
  }
}

{
  "schemaVersion": 1,
  "goal": "verify pkg:npm/normalize-url@6.1.0",
  "kind": "HOW",
  "packages": [
    "pkg:npm/normalize-url@6.1.0"
  ],
  "symbols": [
    "normalizeUrl"
  ]
}

const assert = require('node:assert');
const { normalizeUrl } = require('../index.js');

// 1. normalizeUrl(url) prepends default http: protocol and strips www. prefix
assert.strictEqual(
  normalizeUrl('example.com'),
  'http://example.com',
  'normalizeUrl should prepend default http: protocol to bare hostnames'
);
assert.strictEqual(
  normalizeUrl('//example.com'),
  'http://example.com',
  'normalizeUrl should prepend default http: protocol to protocol-relative URLs'
);
assert.strictEqual(
  normalizeUrl('http://www.example.com'),
  'http://example.com',
  'normalizeUrl should strip leading www. prefix by default'
);

// 2. normalizeUrl(url) strips standard ports and resolves relative path segments
assert.strictEqual(
  normalizeUrl('http://example.com:80/path/../sub'),
  'http://example.com/sub',
  'normalizeUrl should strip default port 80 for http: and resolve path traversal'
);
assert.strictEqual(
  normalizeUrl('https://example.com:443/'),
  'https://example.com',
  'normalizeUrl should strip default port 443 for https: and remove trailing slash'
);

// 3. normalizeUrl(url) sorts query parameters alphabetically and strips default tracking parameters
assert.strictEqual(
  normalizeUrl('http://example.com/?z=3&a=1&utm_source=feed&b=2'),
  'http://example.com/?a=1&b=2&z=3',
  'normalizeUrl should sort query parameters and remove default utm_ tracking parameters'
);

// 4. normalizeUrl(url, { forceHttps: true }) converts http: protocol to https:
assert.strictEqual(
  normalizeUrl('http://example.com/api', { forceHttps: true }),
  'https://example.com/api',
  'normalizeUrl should convert http: to https: when forceHttps is enabled'
);

// 5. normalizeUrl(url, { removeSingleSlash: false }) preserves trailing slash for root URL
assert.strictEqual(
  normalizeUrl('https://example.com/', { removeSingleSlash: false }),
  'https://example.com/',
  'normalizeUrl should preserve root trailing slash when removeSingleSlash is false'
);
assert.strictEqual(
  normalizeUrl('https://example.com/', { removeSingleSlash: true }),
  'https://example.com',
  'normalizeUrl should remove root trailing slash when removeSingleSlash is true'
);

// 6. normalizeUrl(url, { stripHash: true }) removes URL hash fragments
assert.strictEqual(
  normalizeUrl('http://example.com/page#heading-1', { stripHash: true }),
  'http://example.com/page',
  'normalizeUrl should strip hash fragment when stripHash is true'
);

// 7. normalizeUrl(url, { removeQueryParameters }) strips custom matched query parameters
assert.strictEqual(
  normalizeUrl('http://example.com/?session=abc&filter=recent&token=xyz', {
    removeQueryParameters: ['session', /^token$/]
  }),
  'http://example.com/?filter=recent',
  'normalizeUrl should strip query parameters matching provided string names and regular expressions'
);

// 8. normalizeUrl(url, { forceHttp: true, forceHttps: true }) throws an error when conflicting options are specified
assert.throws(
  () => {
    normalizeUrl('http://example.com', { forceHttp: true, forceHttps: true });
  },
  /cannot be used together/,
  'normalizeUrl should throw Error when both forceHttp and forceHttps are specified'
);

console.log('All normalize-url contract assertions passed successfully.');