globalthis 1.0.4: shim

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 shim in pkg:npm/globalthis@1.0.4
Kind: HOW

Use EXACTLY these public packages and versions:
  - pkg:npm/globalthis@1.0.4
Demonstrate these symbols/APIs:
  - shim
Constraints:
  - executionContext: node
Required runtime conditions:
  - ecosystem: npm
  - language: javascript
  - moduleSystem: cjs
  - packageManager: npm@10.9.8
  - 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:10c52c03668e3d88fee866c4344e0b424e1fcd2919a4cb2d17d0d6c189e73211","constraints":{"executionContext":"node"},"contract":["shim export is a function that returns the global this object","shim installs globalThis property referencing the global object","shim returns the same reference as the runtime global object","shim is idempotent across multiple invocations","shimmed global object contains standard ECMAScript built-in globals","globalthis shim property matches the shim subpath export"],"goal":"verify shim in pkg:npm/globalthis@1.0.4","kind":"HOW","packages":["pkg:npm/globalthis@1.0.4"],"schemaVersion":1,"symbols":["shim"]},"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","packageManagerVersion":"10.9.8","runtime":"node","runtimeVersion":"22.23.2","schemaVersion":1},"license":"MIT-0","packages":["pkg:npm/globalthis@1.0.4"],"schemaVersion":1,"subject":"pkg:npm/globalthis@1.0.4","symbols":["shim"],"verifierAdapter":"node-typescript@1"}

{
  "name": "sample-globalthis-shim",
  "version": "1.0.0",
  "lockfileVersion": 3,
  "requires": true,
  "packages": {
    "": {
      "name": "sample-globalthis-shim",
      "version": "1.0.0",
      "dependencies": {
        "globalthis": "1.0.4"
      }
    },
    "node_modules/define-data-property": {
      "version": "1.1.4",
      "resolved": "https://registry.npmjs.org/define-data-property/-/define-data-property-1.1.4.tgz",
      "integrity": "sha512-rBMvIzlpA8v6E+SJZoo++HAYqsLrkg7MSfIinMPFhmkorw7X+dOXVJQs+QT69zGkzMyfDnIMN2Wid1+NbL3T+A==",
      "license": "MIT",
      "dependencies": {
        "es-define-property": "^1.0.0",
        "es-errors": "^1.3.0",
        "gopd": "^1.0.1"
      },
      "engines": {
        "node": ">= 0.4"
      },
      "funding": {
        "url": "https://github.com/sponsors/ljharb"
      }
    },
    "node_modules/define-properties": {
      "version": "1.2.1",
      "resolved": "https://registry.npmjs.org/define-properties/-/define-properties-1.2.1.tgz",
      "integrity": "sha512-8QmQKqEASLd5nx0U1B1okLElbUuuttJ/AnYmRXbbbGDWh6uS208EjD4Xqq/I9wK7u0v6O08XhTWnt5XtEbR6Dg==",
      "license": "MIT",
      "dependencies": {
        "define-data-property": "^1.0.1",
        "has-property-descriptors": "^1.0.0",
        "object-keys": "^1.1.1"
      },
      "engines": {
        "node": ">= 0.4"
      },
      "funding": {
        "url": "https://github.com/sponsors/ljharb"
      }
    },
    "node_modules/es-define-property": {
      "version": "1.0.1",
      "resolved": "https://registry.npmjs.org/es-define-property/-/es-define-property-1.0.1.tgz",
      "integrity": "sha512-e3nRfgfUZ4rNGL232gUgX06QNyyez04KdjFrF+LTRoOXmrOgFKDg4BCdsjW8EnT69eqdYGmRpJwiPVYNrCaW3g==",
      "license": "MIT",
      "engines": {
        "node": ">= 0.4"
      }
    },
    "node_modules/es-errors": {
      "version": "1.3.0",
      "resolved": "https://registry.npmjs.org/es-errors/-/es-errors-1.3.0.tgz",
      "integrity": "sha512-Zf5H2Kxt2xjTvbJvP2ZWLEICxA6j+hAmMzIlypy4xcBg1vKVnx89Wy0GbS+kf5cwCVFFzdCFh2XSCFNULS6csw==",
      "license": "MIT",
      "engines": {
        "node": ">= 0.4"
      }
    },
    "node_modules/globalthis": {
      "version": "1.0.4",
      "resolved": "https://registry.npmjs.org/globalthis/-/globalthis-1.0.4.tgz",
      "integrity": "sha512-DpLKbNU4WylpxJykQujfCcwYWiV/Jhm50Goo0wrVILAv5jOr9d+H+UR3PhSCD2rCCEIg0uc+G+muBTwD54JhDQ==",
      "license": "MIT",
      "dependencies": {
        "define-properties": "^1.2.1",
        "gopd": "^1.0.1"
      },
      "engines": {
        "node": ">= 0.4"
      },
      "funding": {
        "url": "https://github.com/sponsors/ljharb"
      }
    },
    "node_modules/gopd": {
      "version": "1.2.0",
      "resolved": "https://registry.npmjs.org/gopd/-/gopd-1.2.0.tgz",
      "integrity": "sha512-ZUKRh6/kUFoAiTAtTYPZJ3hw9wNxx+BIBOijnlG9PnrJsCcSjs1wyyD6vJpaYtgnzDrKYRSqf3OO6Rfa93xsRg==",
      "license": "MIT",
      "engines": {
        "node": ">= 0.4"
      },
      "funding": {
        "url": "https://github.com/sponsors/ljharb"
      }
    },
    "node_modules/has-property-descriptors": {
      "version": "1.0.2",
      "resolved": "https://registry.npmjs.org/has-property-descriptors/-/has-property-descriptors-1.0.2.tgz",
      "integrity": "sha512-55JNKuIW+vq4Ke1BjOTjM2YctQIvCT7GFzHwmfZPGo5wnrgkid0YQtnAleFSqumZm4az3n2BS+erby5ipJdgrg==",
      "license": "MIT",
      "dependencies": {
        "es-define-property": "^1.0.0"
      },
      "funding": {
        "url": "https://github.com/sponsors/ljharb"
      }
    },
    "node_modules/object-keys": {
      "version": "1.1.1",
      "resolved": "https://registry.npmjs.org/object-keys/-/object-keys-1.1.1.tgz",
      "integrity": "sha512-NuAESUOUMrlIXOfHKzD6bpPu3tYt3xvjNdRIQ+FeT0lNb4K8WR70CaDxhuNguS2XG+GjkyMwOzsN5ZktImfhLA==",
      "license": "MIT",
      "engines": {
        "node": ">= 0.4"
      }
    }
  }
}

{
  "name": "sample-globalthis-shim",
  "version": "1.0.0",
  "private": true,
  "dependencies": {
    "globalthis": "1.0.4"
  }
}

{
  "schemaVersion": 1,
  "goal": "verify shim in pkg:npm/globalthis@1.0.4",
  "kind": "HOW",
  "packages": [
    "pkg:npm/globalthis@1.0.4"
  ],
  "symbols": [
    "shim"
  ],
  "constraints": {
    "executionContext": "node"
  },
  "runtimeConditions": {
    "ecosystem": "npm",
    "language": "javascript",
    "moduleSystem": "cjs",
    "packageManager": "npm@10.9.8",
    "runtime": "node@22.23.2"
  }
}

'use strict';

const shim = require('globalthis/shim');
const globalThisPkg = require('globalthis');

/**
 * Invokes the shim to ensure globalThis is installed and returns the global object.
 * @returns {object} The global object.
 */
function getShimmedGlobal() {
  return shim();
}

/**
 * Invokes the shim via the main package property.
 * @returns {object} The global object.
 */
function ensureGlobalThis() {
  return globalThisPkg.shim();
}

/**
 * Checks whether the globalThis property is defined on the global scope.
 * @returns {boolean} True if globalThis is defined.
 */
function isGlobalThisDefined() {
  const g = shim();
  return typeof g.globalThis === 'object' && g.globalThis !== null;
}

/**
 * Verifies standard built-in objects are accessible on the shimmed global object.
 * @returns {boolean} True if all checked built-ins exist.
 */
function verifyGlobalBuiltins() {
  const g = shim();
  return (
    typeof g.Object === 'function' &&
    typeof g.Array === 'function' &&
    typeof g.Function === 'function' &&
    typeof g.Promise === 'function' &&
    typeof g.Math === 'object' &&
    typeof g.JSON === 'object'
  );
}

/**
 * Verifies that multiple calls to shim return the identical object reference.
 * @returns {boolean} True if repeated shim invocations return the same reference.
 */
function isShimIdempotent() {
  const first = shim();
  const second = shim();
  return first === second;
}

module.exports = {
  shim,
  getShimmedGlobal,
  ensureGlobalThis,
  isGlobalThisDefined,
  verifyGlobalBuiltins,
  isShimIdempotent,
};

'use strict';

const assert = require('node:assert/strict');
const {
  shim,
  getShimmedGlobal,
  ensureGlobalThis,
  isGlobalThisDefined,
  verifyGlobalBuiltins,
  isShimIdempotent,
} = require('../src/index.js');
const globalThisPkg = require('globalthis');

function runContract() {
  // 1. shim export is a function that returns the global this object
  assert.equal(typeof shim, 'function');
  const globalObj = getShimmedGlobal();
  assert.equal(typeof globalObj, 'object');
  assert.notEqual(globalObj, null);

  // 2. shim installs globalThis property referencing the global object
  assert.equal(isGlobalThisDefined(), true);
  assert.equal(globalObj.globalThis, globalObj);

  // 3. shim returns the same reference as the runtime global object
  assert.equal(globalObj, global);

  // 4. shim is idempotent across multiple invocations
  assert.equal(isShimIdempotent(), true);
  const secondCall = shim();
  assert.equal(secondCall, globalObj);

  // 5. shimmed global object contains standard ECMAScript built-in globals
  assert.equal(verifyGlobalBuiltins(), true);
  assert.equal(globalObj.Array, Array);
  assert.equal(globalObj.Object, Object);
  assert.equal(globalObj.Math, Math);
  assert.equal(globalObj.JSON, JSON);
  assert.equal(globalObj.Date, Date);
  assert.equal(globalObj.Promise, Promise);

  // 6. globalthis shim property matches the shim subpath export
  assert.equal(globalThisPkg.shim, shim);
  const ensured = ensureGlobalThis();
  assert.equal(ensured, globalObj);

  console.log('All shim contract assertions passed successfully.');
}

runContract();