get-uri 6.0.5: getUri, isValidProtocol

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/get-uri@6.0.5
Kind: HOW

Use EXACTLY these public packages and versions:
  - pkg:npm/get-uri@6.0.5

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:d161b35701bf5155997ac0a3277bcba2a64ff5866717f811bb4128b490eec9ea","contract":["isValidProtocol returns true for built-in protocols and false for unsupported protocols","getUri reads data URIs into a Readable stream outputting the decoded payload","getUri throws ENOTMODIFIED error when passed a cached stream for an unchanged data URI","getUri reads local file URIs into a Readable stream outputting the file content","getUri throws ENOTMODIFIED error when passed a cached stream for an unchanged file URI","getUri throws TypeError when passed an empty URI","getUri throws TypeError when passed a URI with an unsupported protocol","getUri throws ENOTFOUND error when attempting to read a non-existent file URI"],"goal":"verify pkg:npm/get-uri@6.0.5","kind":"HOW","packages":["pkg:npm/get-uri@6.0.5"],"schemaVersion":1,"symbols":["getUri","isValidProtocol"]},"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/get-uri@6.0.5"],"schemaVersion":1,"subject":"pkg:npm/get-uri@6.0.5","symbols":["getUri","isValidProtocol"],"verifierAdapter":"node-typescript@1"}

{
  "name": "sample-get-uri",
  "version": "1.0.0",
  "lockfileVersion": 3,
  "requires": true,
  "packages": {
    "": {
      "name": "sample-get-uri",
      "version": "1.0.0",
      "dependencies": {
        "get-uri": "6.0.5"
      }
    },
    "node_modules/basic-ftp": {
      "version": "5.3.1",
      "resolved": "https://registry.npmjs.org/basic-ftp/-/basic-ftp-5.3.1.tgz",
      "integrity": "sha512-bopVNp6ugyA150DDuZfPFdt1KZ5a94ZDiwX4hMgZDzF+GttD80lEy8kj98kbyhLXnPvhtIo93mdnLIjpCAeeOw==",
      "license": "MIT",
      "engines": {
        "node": ">=10.0.0"
      }
    },
    "node_modules/data-uri-to-buffer": {
      "version": "6.0.2",
      "resolved": "https://registry.npmjs.org/data-uri-to-buffer/-/data-uri-to-buffer-6.0.2.tgz",
      "integrity": "sha512-7hvf7/GW8e86rW0ptuwS3OcBGDjIi6SZva7hCyWC0yYry2cOPmLIjXAUHI6DK2HsnwJd9ifmt57i8eV2n4YNpw==",
      "license": "MIT",
      "engines": {
        "node": ">= 14"
      }
    },
    "node_modules/debug": {
      "version": "4.4.3",
      "resolved": "https://registry.npmjs.org/debug/-/debug-4.4.3.tgz",
      "integrity": "sha512-RGwwWnwQvkVfavKVt22FGLw+xYSdzARwm0ru6DhTVA3umU5hZc28V3kO4stgYryrTlLpuvgI9GiijltAjNbcqA==",
      "license": "MIT",
      "dependencies": {
        "ms": "^2.1.3"
      },
      "engines": {
        "node": ">=6.0"
      },
      "peerDependenciesMeta": {
        "supports-color": {
          "optional": true
        }
      }
    },
    "node_modules/get-uri": {
      "version": "6.0.5",
      "resolved": "https://registry.npmjs.org/get-uri/-/get-uri-6.0.5.tgz",
      "integrity": "sha512-b1O07XYq8eRuVzBNgJLstU6FYc1tS6wnMtF1I1D9lE8LxZSOGZ7LhxN54yPP6mGw5f2CkXY2BQUL9Fx41qvcIg==",
      "license": "MIT",
      "dependencies": {
        "basic-ftp": "^5.0.2",
        "data-uri-to-buffer": "^6.0.2",
        "debug": "^4.3.4"
      },
      "engines": {
        "node": ">= 14"
      }
    },
    "node_modules/ms": {
      "version": "2.1.3",
      "resolved": "https://registry.npmjs.org/ms/-/ms-2.1.3.tgz",
      "integrity": "sha512-6FlzubTLZG3J2a/NVCAleEhjzq5oxgHyaCU9yYXvcLsvoVaHJq/s5xXI6/XXP6tz7R9xAOtHnSO/tXtF3WRTlA==",
      "license": "MIT"
    }
  }
}

{
  "name": "sample-get-uri",
  "version": "1.0.0",
  "type": "module",
  "private": true,
  "dependencies": {
    "get-uri": "6.0.5"
  }
}

{
  "schemaVersion": 1,
  "goal": "verify pkg:npm/get-uri@6.0.5",
  "kind": "HOW",
  "packages": [
    "pkg:npm/get-uri@6.0.5"
  ]
}

import assert from 'node:assert/strict';
import { promises as fs } from 'node:fs';
import path from 'node:path';
import { pathToFileURL } from 'node:url';
import { getUri, isValidProtocol, protocols } from 'get-uri';

async function streamToBuffer(stream) {
  const chunks = [];
  for await (const chunk of stream) {
    chunks.push(typeof chunk === 'string' ? Buffer.from(chunk) : chunk);
  }
  return Buffer.concat(chunks);
}

// 1. isValidProtocol returns true for built-in protocols and false for unsupported protocols
assert.equal(isValidProtocol('data'), true);
assert.equal(isValidProtocol('file'), true);
assert.equal(isValidProtocol('ftp'), true);
assert.equal(isValidProtocol('http'), true);
assert.equal(isValidProtocol('https'), true);
assert.equal(isValidProtocol('unsupported'), false);
assert.ok(typeof protocols.data === 'function');
assert.ok(typeof protocols.file === 'function');

// 2. getUri reads data URIs into a Readable stream outputting the decoded payload
const dataUri = 'data:text/plain;charset=utf-8,Hello%20World';
const dataStream = await getUri(dataUri);
const dataPayload = await streamToBuffer(dataStream);
assert.equal(dataPayload.toString('utf8'), 'Hello World');

// 3. getUri throws ENOTMODIFIED error when passed a cached stream for an unchanged data URI
await assert.rejects(
  async () => {
    await getUri(dataUri, { cache: dataStream });
  },
  (err) => {
    assert.equal(err.code, 'ENOTMODIFIED');
    return true;
  }
);

// 4. getUri reads local file URIs into a Readable stream outputting the file content
const tempFilePath = path.resolve('test-temp.txt');
await fs.writeFile(tempFilePath, 'contract test content', 'utf8');

try {
  const fileUri = pathToFileURL(tempFilePath).href;
  const fileStream = await getUri(fileUri);
  const filePayload = await streamToBuffer(fileStream);
  assert.equal(filePayload.toString('utf8'), 'contract test content');

  // 5. getUri throws ENOTMODIFIED error when passed a cached stream for an unchanged file URI
  await assert.rejects(
    async () => {
      await getUri(fileUri, { cache: fileStream });
    },
    (err) => {
      assert.equal(err.code, 'ENOTMODIFIED');
      return true;
    }
  );
} finally {
  await fs.unlink(tempFilePath).catch(() => {});
}

// 6. getUri throws TypeError when passed an empty URI
await assert.rejects(
  async () => {
    await getUri('');
  },
  {
    name: 'TypeError',
    message: 'Must pass in a URI to "getUri()"'
  }
);

// 7. getUri throws TypeError when passed a URI with an unsupported protocol
await assert.rejects(
  async () => {
    await getUri('gopher://localhost/test');
  },
  {
    name: 'TypeError',
    message: 'Unsupported protocol "gopher" specified in URI: "gopher://localhost/test"'
  }
);

// 8. getUri throws ENOTFOUND error when attempting to read a non-existent file URI
const nonExistentUri = pathToFileURL(path.resolve('non-existent-contract-file.txt')).href;
await assert.rejects(
  async () => {
    await getUri(nonExistentUri);
  },
  (err) => {
    assert.equal(err.code, 'ENOTFOUND');
    return true;
  }
);