sqids 0.3.0: defaultOptions

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 sqids.defaultOptions in pkg:npm/sqids@0.3.0
Kind: HOW

Use EXACTLY these public packages and versions:
  - pkg:npm/sqids@0.3.0
Demonstrate these symbols/APIs:
  - sqids.defaultOptions

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:ea0b5f4127b189fd9dd87a74bf3a16c3becfc24815ccfa94552cea3aed703943","contract":["assert sqids.defaultOptions provides default alphabet, minLength, and blocklist","assert sqids.defaultOptions alphabet contains 62 unique alphanumeric characters","assert sqids.defaultOptions minLength equals 0","assert sqids.defaultOptions blocklist is a Set containing default blocked words","assert Sqids uses defaultOptions properties when initialized without configuration","assert Sqids allows overriding individual defaultOptions properties"],"goal":"verify sqids.defaultOptions in pkg:npm/sqids@0.3.0","kind":"HOW","packages":["pkg:npm/sqids@0.3.0"],"schemaVersion":1,"symbols":["sqids.defaultOptions"]},"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","packageManagerVersion":"10.9.8","runtime":"node","runtimeVersion":"22.23.2","schemaVersion":1},"license":"MIT-0","packages":["pkg:npm/sqids@0.3.0"],"schemaVersion":1,"subject":"pkg:npm/sqids@0.3.0","symbols":["sqids.defaultOptions"],"verifierAdapter":"node-typescript@1"}

const sqidsModule = require('sqids');
const Sqids = sqidsModule.default || sqidsModule;
const defaultOptions = sqidsModule.defaultOptions || Sqids.defaultOptions;

/**
 * Returns the default configuration options for Sqids.
 *
 * @returns {{ alphabet: string, minLength: number, blocklist: Set<string> }} The default options object.
 */
function getDefaultOptions() {
  return defaultOptions;
}

/**
 * Creates a new Sqids instance with optional configuration overrides.
 *
 * @param {Object} [options] - Configuration overrides.
 * @returns {Sqids} A new Sqids instance.
 */
function createSqidsWithDefaults(options) {
  return new Sqids(options);
}

module.exports = {
  getDefaultOptions,
  createSqidsWithDefaults,
  defaultOptions,
  Sqids,
};

{
  "name": "sample-sqids-defaultoptions",
  "version": "1.0.0",
  "lockfileVersion": 3,
  "requires": true,
  "packages": {
    "": {
      "name": "sample-sqids-defaultoptions",
      "version": "1.0.0",
      "license": "MIT-0",
      "dependencies": {
        "sqids": "0.3.0"
      }
    },
    "node_modules/sqids": {
      "version": "0.3.0",
      "resolved": "https://registry.npmjs.org/sqids/-/sqids-0.3.0.tgz",
      "integrity": "sha512-lOQK1ucVg+W6n3FhRwwSeUijxe93b51Bfz5PMRMihVf1iVkl82ePQG7V5vwrhzB11v0NtsR25PSZRGiSomJaJw==",
      "license": "MIT"
    }
  }
}

{
  "name": "sample-sqids-defaultoptions",
  "version": "1.0.0",
  "description": "Clean-room sample verifying sqids.defaultOptions in pkg:npm/sqids@0.3.0",
  "main": "index.js",
  "license": "MIT-0",
  "dependencies": {
    "sqids": "0.3.0"
  }
}

{
  "schemaVersion": 1,
  "goal": "verify sqids.defaultOptions in pkg:npm/sqids@0.3.0",
  "kind": "HOW",
  "packages": [
    "pkg:npm/sqids@0.3.0"
  ],
  "symbols": [
    "sqids.defaultOptions"
  ]
}

import assert from 'node:assert';
import Sqids, { defaultOptions } from 'sqids';
import { getDefaultOptions, createSqidsWithDefaults } from '../index.js';

// 1. defaultOptions provides default alphabet, minLength, and blocklist
assert.ok(defaultOptions, 'defaultOptions must be defined');
assert.strictEqual(typeof defaultOptions, 'object', 'defaultOptions must be an object');
assert.deepStrictEqual(
  getDefaultOptions(),
  defaultOptions,
  'helper getDefaultOptions() must return the same defaultOptions'
);

// 2. Alphabet property contains 62 unique alphanumeric characters
assert.strictEqual(typeof defaultOptions.alphabet, 'string', 'alphabet must be a string');
assert.strictEqual(defaultOptions.alphabet.length, 62, 'alphabet length must be 62');
assert.strictEqual(
  defaultOptions.alphabet,
  'abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789',
  'alphabet must match standard 62-character alphanumeric set'
);
assert.strictEqual(
  new Set(defaultOptions.alphabet).size,
  62,
  'alphabet must have 62 unique characters'
);

// 3. minLength property equals 0
assert.strictEqual(typeof defaultOptions.minLength, 'number', 'minLength must be a number');
assert.strictEqual(defaultOptions.minLength, 0, 'default minLength must be 0');

// 4. blocklist property is a Set containing default blocked words
assert.ok(defaultOptions.blocklist instanceof Set, 'blocklist must be an instance of Set');
assert.ok(defaultOptions.blocklist.size > 0, 'blocklist must not be empty');
assert.strictEqual(defaultOptions.blocklist.size, 560, 'default blocklist contains 560 blocked words');
assert.ok(defaultOptions.blocklist.has('anal'), 'blocklist should contain standard blocked words');
assert.ok(defaultOptions.blocklist.has('bitch'), 'blocklist should contain standard blocked words');

// 5. Sqids uses defaultOptions properties when initialized without configuration
const defaultSqids = new Sqids();
const encodedWithDefaults = defaultSqids.encode([1, 2, 3]);
assert.strictEqual(typeof encodedWithDefaults, 'string', 'encode with defaults returns string');
assert.strictEqual(encodedWithDefaults, '86Rf07', 'encoding [1, 2, 3] with default options yields 86Rf07');
assert.deepStrictEqual(
  defaultSqids.decode(encodedWithDefaults),
  [1, 2, 3],
  'decode should restore [1, 2, 3]'
);

// 6. Overriding individual defaultOptions properties
const helperSqids = createSqidsWithDefaults({ minLength: 8 });
const encodedMin = helperSqids.encode([1, 2, 3]);
assert.ok(encodedMin.length >= 8, 'custom minLength override must be respected');
assert.deepStrictEqual(
  helperSqids.decode(encodedMin),
  [1, 2, 3],
  'decode should restore [1, 2, 3] with custom minLength'
);

console.log('All contract assertions passed.');