nanoid 3.3.17: urlAlphabet

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 nanoid.urlAlphabet in pkg:npm/nanoid@3.3.17
Kind: HOW

Use EXACTLY these public packages and versions:
  - pkg:npm/nanoid@3.3.17
Demonstrate these symbols/APIs:
  - nanoid.urlAlphabet

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:26b4a85d96249f2576d330b626be6bd8f2d726c7eb797acc0f56069ea5e0d3ac","contract":["urlAlphabet is an exported 64-character string containing URL-safe characters","urlAlphabet contains 64 unique characters with numbers, lowercase letters, uppercase letters, hyphen, and underscore","urlAlphabet characters all conform to URL-safe ASCII character set","urlAlphabet is exported both from the root nanoid package and from the url-alphabet subpath","urlAlphabet can be used with customAlphabet to generate URL-safe identifiers"],"goal":"verify nanoid.urlAlphabet in pkg:npm/nanoid@3.3.17","kind":"HOW","packages":["pkg:npm/nanoid@3.3.17"],"schemaVersion":1,"symbols":["nanoid.urlAlphabet"]},"contractCommand":["node","test/contract.cjs"],"environment":{"arch":"x64","distro":"ubuntu","ecosystem":"npm","executionContext":"node","language":"javascript","libc":"glibc","libcVersion":"2.39","moduleSystem":"cjs","os":"linux","osVersionBucket":"24","packageManager":"npm","packageManagerVersion":"10.9.8","runtime":"node","runtimeVersion":"22.23.2","schemaVersion":1},"license":"MIT-0","packages":["pkg:npm/nanoid@3.3.17"],"schemaVersion":1,"subject":"pkg:npm/nanoid@3.3.17","symbols":["nanoid.urlAlphabet"],"verifierAdapter":"node-typescript@1"}

'use strict';

const { urlAlphabet } = require('nanoid');

/**
 * Returns the default URL-safe alphabet string used by Nano ID.
 * @returns {string} The 64-character URL-safe alphabet.
 */
function getUrlAlphabet() {
  return urlAlphabet;
}

/**
 * Validates whether all characters in a given string belong to nanoid.urlAlphabet.
 * @param {string} str - String to validate.
 * @returns {boolean} True if all characters are in urlAlphabet, false otherwise.
 */
function isUrlSafeString(str) {
  if (typeof str !== 'string') {
    return false;
  }
  for (let i = 0; i < str.length; i++) {
    if (!urlAlphabet.includes(str[i])) {
      return false;
    }
  }
  return true;
}

module.exports = {
  urlAlphabet,
  getUrlAlphabet,
  isUrlSafeString
};

{
  "name": "sample-nanoid-urlalphabet",
  "version": "1.0.0",
  "lockfileVersion": 3,
  "requires": true,
  "packages": {
    "": {
      "name": "sample-nanoid-urlalphabet",
      "version": "1.0.0",
      "license": "MIT-0",
      "dependencies": {
        "nanoid": "3.3.17"
      }
    },
    "node_modules/nanoid": {
      "version": "3.3.17",
      "resolved": "https://registry.npmjs.org/nanoid/-/nanoid-3.3.17.tgz",
      "integrity": "sha512-xQLf0A3HOMlgHq0n247/LRuAOYmB7dXJ/DvAxGvsSBij45XtBSmQycu+F8ODbHwns/XyFZagyL1+J0Offw1E0g==",
      "funding": [
        {
          "type": "github",
          "url": "https://github.com/sponsors/ai"
        }
      ],
      "license": "MIT",
      "bin": {
        "nanoid": "bin/nanoid.cjs"
      },
      "engines": {
        "node": "^10 || ^12 || ^13.7 || ^14 || >=15.0.1"
      }
    }
  }
}

{
  "name": "sample-nanoid-urlalphabet",
  "version": "1.0.0",
  "private": true,
  "description": "verify nanoid.urlAlphabet in pkg:npm/nanoid@3.3.17",
  "main": "index.js",
  "scripts": {
    "test": "node test/contract.cjs"
  },
  "dependencies": {
    "nanoid": "3.3.17"
  },
  "license": "MIT-0"
}

{
  "schemaVersion": 1,
  "goal": "verify nanoid.urlAlphabet in pkg:npm/nanoid@3.3.17",
  "kind": "HOW",
  "packages": [
    "pkg:npm/nanoid@3.3.17"
  ],
  "symbols": [
    "nanoid.urlAlphabet"
  ]
}

'use strict';

const assert = require('node:assert');
const { urlAlphabet: rootAlphabet, customAlphabet } = require('nanoid');
const { urlAlphabet: subAlphabet } = require('nanoid/url-alphabet');
const { urlAlphabet, getUrlAlphabet, isUrlSafeString } = require('../index.js');

function testAlphabetStructure() {
  // 1. urlAlphabet is an exported 64-character string containing URL-safe characters
  assert.strictEqual(typeof urlAlphabet, 'string', 'urlAlphabet must be a string');
  assert.strictEqual(urlAlphabet.length, 64, 'urlAlphabet must have length 64');
  assert.strictEqual(getUrlAlphabet(), urlAlphabet, 'getUrlAlphabet helper must return urlAlphabet');

  // 2. urlAlphabet contains 64 unique characters with numbers, lowercase letters, uppercase letters, hyphen, and underscore
  const charSet = new Set(urlAlphabet);
  assert.strictEqual(charSet.size, 64, 'urlAlphabet must contain 64 unique characters');

  for (let c = 65; c <= 90; c++) {
    assert.ok(charSet.has(String.fromCharCode(c)), `Must contain uppercase letter ${String.fromCharCode(c)}`);
  }
  for (let c = 97; c <= 122; c++) {
    assert.ok(charSet.has(String.fromCharCode(c)), `Must contain lowercase letter ${String.fromCharCode(c)}`);
  }
  for (let c = 48; c <= 57; c++) {
    assert.ok(charSet.has(String.fromCharCode(c)), `Must contain digit ${String.fromCharCode(c)}`);
  }
  assert.ok(charSet.has('-'), 'Must contain hyphen (-) character');
  assert.ok(charSet.has('_'), 'Must contain underscore (_) character');

  // 3. urlAlphabet characters all conform to URL-safe ASCII character set
  assert.match(urlAlphabet, /^[A-Za-z0-9_-]{64}$/, 'urlAlphabet characters must all be URL-safe ASCII');
  assert.strictEqual(isUrlSafeString(urlAlphabet), true, 'urlAlphabet must pass isUrlSafeString check');
  assert.strictEqual(isUrlSafeString('hello-world_123'), true);
  assert.strictEqual(isUrlSafeString('hello world!'), false);
  assert.strictEqual(isUrlSafeString(null), false);

  // 4. urlAlphabet is exported both from the root nanoid package and from the url-alphabet subpath
  assert.strictEqual(rootAlphabet, urlAlphabet, 'root export must match urlAlphabet');
  assert.strictEqual(subAlphabet, urlAlphabet, 'subpath export must match urlAlphabet');

  // 5. urlAlphabet can be used with customAlphabet to generate URL-safe identifiers
  const generate = customAlphabet(urlAlphabet, 21);
  assert.strictEqual(typeof generate, 'function', 'customAlphabet should return a generator');
  const id = generate();
  assert.strictEqual(typeof id, 'string', 'Generated ID must be a string');
  assert.strictEqual(id.length, 21, 'Generated ID length must match configured size');
  assert.strictEqual(isUrlSafeString(id), true, 'Generated ID characters must all belong to urlAlphabet');
}

function runAll() {
  testAlphabetStructure();
  console.log('Contract verification finished successfully.');
}

try {
  runAll();
  process.exit(0);
} catch (err) {
  console.error('Contract verification failed:', err);
  process.exit(1);
}