@electron/windows-sign 1.2.2: sign

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 sign in pkg:npm/%40electron/windows-sign@1.2.2
Kind: HOW

Use EXACTLY these public packages and versions:
  - pkg:npm/%40electron/windows-sign@1.2.2
Demonstrate these symbols/APIs:
  - sign

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:ee8610ec125ba238f393d16ae4e3eaa9f4935fb169355445371ebf8c05fa891c","constraints":{"executionContext":"node"},"contract":["sign executes custom hookFunction asynchronously for each specified file path in files option","sign recursively discovers Windows executable and installer files from appDirectory when files option is omitted","sign discovers JavaScript files when signJavaScript option is enabled","sign loads custom hook module from hookModulePath when hookFunction is not directly provided"],"goal":"verify sign in pkg:npm/%40electron/windows-sign@1.2.2","kind":"HOW","packages":["pkg:npm/%40electron/windows-sign@1.2.2"],"schemaVersion":1,"symbols":["sign"]},"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/%40electron/windows-sign@1.2.2"],"schemaVersion":1,"subject":"pkg:npm/%40electron/windows-sign@1.2.2","symbols":["sign"],"verifierAdapter":"node-typescript@1"}

'use strict';

const { sign } = require('@electron/windows-sign');

async function signFilesWithHook(files, hookFunction) {
  return await sign({
    files,
    hookFunction
  });
}

async function signDirectoryWithHook(appDirectory, hookFunction, options = {}) {
  return await sign({
    appDirectory,
    hookFunction,
    ...options
  });
}

module.exports = {
  sign,
  signFilesWithHook,
  signDirectoryWithHook
};

{
  "name": "sample-electron-windows-sign",
  "version": "1.0.0",
  "lockfileVersion": 3,
  "requires": true,
  "packages": {
    "": {
      "name": "sample-electron-windows-sign",
      "version": "1.0.0",
      "license": "MIT-0",
      "dependencies": {
        "@electron/windows-sign": "1.2.2"
      }
    },
    "node_modules/@electron/windows-sign": {
      "version": "1.2.2",
      "resolved": "https://registry.npmjs.org/@electron/windows-sign/-/windows-sign-1.2.2.tgz",
      "integrity": "sha512-dfZeox66AvdPtb2lD8OsIIQh12Tp0GNCRUDfBHIKGpbmopZto2/A8nSpYYLoedPIHpqkeblZ/k8OV0Gy7PYuyQ==",
      "license": "BSD-2-Clause",
      "dependencies": {
        "cross-dirname": "^0.1.0",
        "debug": "^4.3.4",
        "fs-extra": "^11.1.1",
        "minimist": "^1.2.8",
        "postject": "^1.0.0-alpha.6"
      },
      "bin": {
        "electron-windows-sign": "bin/electron-windows-sign.js"
      },
      "engines": {
        "node": ">=14.14"
      }
    },
    "node_modules/commander": {
      "version": "9.5.0",
      "resolved": "https://registry.npmjs.org/commander/-/commander-9.5.0.tgz",
      "integrity": "sha512-KRs7WVDKg86PWiuAqhDrAQnTXZKraVcCc6vFdL14qrZ/DcWwuRo7VoiYXalXO7S5GKpqYiVEwCbgFDfxNHKJBQ==",
      "license": "MIT",
      "engines": {
        "node": "^12.20.0 || >=14"
      }
    },
    "node_modules/cross-dirname": {
      "version": "0.1.0",
      "resolved": "https://registry.npmjs.org/cross-dirname/-/cross-dirname-0.1.0.tgz",
      "integrity": "sha512-+R08/oI0nl3vfPcqftZRpytksBXDzOUveBq/NBVx0sUp1axwzPQrKinNx5yd5sxPu8j1wIy8AfnVQ+5eFdha6Q==",
      "license": "MIT"
    },
    "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/fs-extra": {
      "version": "11.4.0",
      "resolved": "https://registry.npmjs.org/fs-extra/-/fs-extra-11.4.0.tgz",
      "integrity": "sha512-EQsFzMUJkCKGr1ePqlYADkIUmHW1s3ZXr5Yqy6wbGrfUCphpl2maM/kyOIRA2HpP3AaFQTZXD4ldjek+nccddA==",
      "license": "MIT",
      "dependencies": {
        "graceful-fs": "^4.2.0",
        "jsonfile": "^6.0.1",
        "universalify": "^2.0.0"
      },
      "engines": {
        "node": ">=14.14"
      }
    },
    "node_modules/graceful-fs": {
      "version": "4.2.11",
      "resolved": "https://registry.npmjs.org/graceful-fs/-/graceful-fs-4.2.11.tgz",
      "integrity": "sha512-RbJ5/jmFcNNCcDV5o9eTnBLJ/HszWV0P73bc+Ff4nS/rJj+YaS6IGyiOL0VoBYX+l1Wrl3k63h/KrH+nhJ0XvQ==",
      "license": "ISC"
    },
    "node_modules/jsonfile": {
      "version": "6.2.1",
      "resolved": "https://registry.npmjs.org/jsonfile/-/jsonfile-6.2.1.tgz",
      "integrity": "sha512-zwOTdL3rFQ/lRdBnntKVOX6k5cKJwEc1HdilT71BWEu7J41gXIB2MRp+vxduPSwZJPWBxEzv4yH1wYLJGUHX4Q==",
      "license": "MIT",
      "dependencies": {
        "universalify": "^2.0.0"
      },
      "optionalDependencies": {
        "graceful-fs": "^4.1.6"
      }
    },
    "node_modules/minimist": {
      "version": "1.2.8",
      "resolved": "https://registry.npmjs.org/minimist/-/minimist-1.2.8.tgz",
      "integrity": "sha512-2yyAR8qBkN3YuheJanUpWC5U3bb5osDywNB8RzDVlDwDHbocAJveqqj1u8+SVD7jkWT4yvsHCpWqqWqAxb0zCA==",
      "license": "MIT",
      "funding": {
        "url": "https://github.com/sponsors/ljharb"
      }
    },
    "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"
    },
    "node_modules/postject": {
      "version": "1.0.0-alpha.6",
      "resolved": "https://registry.npmjs.org/postject/-/postject-1.0.0-alpha.6.tgz",
      "integrity": "sha512-b9Eb8h2eVqNE8edvKdwqkrY6O7kAwmI8kcnBv1NScolYJbo59XUF0noFq+lxbC1yN20bmC0WBEbDC5H/7ASb0A==",
      "license": "MIT",
      "dependencies": {
        "commander": "^9.4.0"
      },
      "bin": {
        "postject": "dist/cli.js"
      },
      "engines": {
        "node": ">=14.0.0"
      }
    },
    "node_modules/universalify": {
      "version": "2.0.1",
      "resolved": "https://registry.npmjs.org/universalify/-/universalify-2.0.1.tgz",
      "integrity": "sha512-gptHNQghINnc/vTGIk0SOFGFNXw7JVrlRUtConJRlvaw6DuX0wO5Jeko9sWrMBhh+PsYAZ7oXAiOnf/UKogyiw==",
      "license": "MIT",
      "engines": {
        "node": ">= 10.0.0"
      }
    }
  }
}

{
  "name": "sample-electron-windows-sign",
  "version": "1.0.0",
  "private": true,
  "description": "verify sign in pkg:npm/%40electron/windows-sign@1.2.2",
  "main": "index.js",
  "scripts": {
    "test": "node test/contract.cjs"
  },
  "dependencies": {
    "@electron/windows-sign": "1.2.2"
  },
  "license": "MIT-0"
}

{
  "schemaVersion": 1,
  "goal": "verify sign in pkg:npm/%40electron/windows-sign@1.2.2",
  "kind": "HOW",
  "packages": [
    "pkg:npm/%40electron/windows-sign@1.2.2"
  ],
  "symbols": [
    "sign"
  ]
}

'use strict';

const assert = require('assert');
const path = require('path');
const fs = require('fs');
const os = require('os');
const { sign, signFilesWithHook, signDirectoryWithHook } = require('../index.js');

async function run() {
  const tmpDir = fs.mkdtempSync(path.join(os.tmpdir(), 'csx-winsign-contract-'));

  try {
    // Contract assertion 1: sign executes custom hookFunction asynchronously for each specified file path in files option
    const file1 = path.join(tmpDir, 'bin1.exe');
    const file2 = path.join(tmpDir, 'bin2.dll');
    fs.writeFileSync(file1, 'binary 1 content');
    fs.writeFileSync(file2, 'binary 2 content');

    const signedFiles = [];
    await sign({
      files: [file1, file2],
      hookFunction: async (filePath) => {
        signedFiles.push(filePath);
      }
    });

    assert.strictEqual(signedFiles.length, 2, 'hookFunction should be called for each file');
    assert.strictEqual(signedFiles[0], file1, 'first file should match');
    assert.strictEqual(signedFiles[1], file2, 'second file should match');

    // Helper export test: signFilesWithHook
    const helperSigned = [];
    await signFilesWithHook([file1], async (f) => { helperSigned.push(f); });
    assert.strictEqual(helperSigned.length, 1);
    assert.strictEqual(helperSigned[0], file1);

    // Contract assertion 2: sign recursively discovers Windows executable and installer files from appDirectory when files option is omitted
    const subDir = path.join(tmpDir, 'nested');
    fs.mkdirSync(subDir, { recursive: true });
    const subExe = path.join(subDir, 'nested.msi');
    const txtFile = path.join(tmpDir, 'notes.txt');
    const jsFile = path.join(tmpDir, 'script.js');
    fs.writeFileSync(subExe, 'installer');
    fs.writeFileSync(txtFile, 'text');
    fs.writeFileSync(jsFile, 'console.log()');

    const discoveredFiles = [];
    await sign({
      appDirectory: tmpDir,
      hookFunction: async (filePath) => {
        discoveredFiles.push(filePath);
      }
    });

    assert(discoveredFiles.includes(file1), 'discovered files should include bin1.exe');
    assert(discoveredFiles.includes(file2), 'discovered files should include bin2.dll');
    assert(discoveredFiles.includes(subExe), 'discovered files should recursively include nested.msi');
    assert(!discoveredFiles.includes(txtFile), 'discovered files should not include notes.txt');
    assert(!discoveredFiles.includes(jsFile), 'discovered files should not include script.js without signJavaScript');

    // Helper export test: signDirectoryWithHook
    const helperDiscovered = [];
    await signDirectoryWithHook(subDir, async (f) => { helperDiscovered.push(f); });
    assert.strictEqual(helperDiscovered.length, 1);
    assert.strictEqual(helperDiscovered[0], subExe);

    // Contract assertion 3: sign discovers JavaScript files when signJavaScript option is enabled
    const jsDiscovered = [];
    await sign({
      appDirectory: tmpDir,
      signJavaScript: true,
      hookFunction: async (filePath) => {
        jsDiscovered.push(filePath);
      }
    });
    assert(jsDiscovered.includes(jsFile), 'discovered files should include script.js when signJavaScript is true');

    // Contract assertion 4: sign loads custom hook module from hookModulePath when hookFunction is not directly provided
    const hookModulePath = path.join(tmpDir, 'hook-loader.js');
    const markerPath = path.join(tmpDir, 'hook-executed.marker');
    fs.writeFileSync(hookModulePath, `
      module.exports = async function(filePath) {
        require('fs').writeFileSync(${JSON.stringify(markerPath)}, filePath);
      };
    `);

    await sign({
      files: [file1],
      hookModulePath: hookModulePath
    });
    assert(fs.existsSync(markerPath), 'hookModulePath hook should have been executed');
    assert.strictEqual(fs.readFileSync(markerPath, 'utf8'), file1);

    console.log('Contract tests passed successfully.');
    process.exit(0);
  } finally {
    try {
      if (fs.existsSync(tmpDir)) {
        fs.rmSync(tmpDir, { recursive: true, force: true });
      }
    } catch (e) {
      // Ignore cleanup error
    }
  }
}

run().catch((err) => {
  console.error('Contract test failed:', err);
  process.exit(1);
});