@electron/osx-sign 1.3.1: walkAsync

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 @electron/osx-sign.walkAsync in pkg:npm/%40electron/osx-sign@1.3.1
Kind: HOW

Use EXACTLY these public packages and versions:
  - pkg:npm/%40electron/osx-sign@1.3.1
Demonstrate these symbols/APIs:
  - @electron/osx-sign.walkAsync

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:1329cdfb4158b1e09e4ed09a11a1515f88abc9886e49be4e2b05ad303885a380","contract":["walkAsync is an exported async function","walkAsync rejects with an Error when target directory does not exist","walkAsync recursively traverses a directory structure and returns an array of binary file paths","walkAsync includes .framework and nested .app directories in discovered paths","walkAsync ignores non-binary plain text files","walkAsync deletes temporary .cstemp files encountered during directory traversal"],"goal":"verify @electron/osx-sign.walkAsync in pkg:npm/%40electron/osx-sign@1.3.1","kind":"HOW","packages":["pkg:npm/%40electron/osx-sign@1.3.1"],"schemaVersion":1,"symbols":["@electron/osx-sign.walkAsync"]},"contractCommand":["node","test/contract.cjs"],"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/%40electron/osx-sign@1.3.1"],"schemaVersion":1,"subject":"pkg:npm/%40electron/osx-sign@1.3.1","symbols":["@electron/osx-sign.walkAsync"],"verifierAdapter":"node-typescript@1"}

'use strict';

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

/**
 * Traverses an application bundle directory and discovers binary executables and frameworks.
 * @param {string} bundlePath - Path to application bundle or Contents directory.
 * @returns {Promise<string[]>} List of discovered binary and framework paths.
 */
async function discoverSigningTargets(bundlePath) {
  return await walkAsync(bundlePath);
}

module.exports = {
  walkAsync,
  discoverSigningTargets
};

{
  "name": "sample-electron-osx-sign",
  "version": "1.0.0",
  "lockfileVersion": 3,
  "requires": true,
  "packages": {
    "": {
      "name": "sample-electron-osx-sign",
      "version": "1.0.0",
      "license": "MIT-0",
      "dependencies": {
        "@electron/osx-sign": "1.3.1"
      }
    },
    "node_modules/@electron/osx-sign": {
      "version": "1.3.1",
      "resolved": "https://registry.npmjs.org/@electron/osx-sign/-/osx-sign-1.3.1.tgz",
      "integrity": "sha512-BAfviURMHpmb1Yb50YbCxnOY0wfwaLXH5KJ4+80zS0gUkzDX3ec23naTlEqKsN+PwYn+a1cCzM7BJ4Wcd3sGzw==",
      "license": "BSD-2-Clause",
      "dependencies": {
        "compare-version": "^0.1.2",
        "debug": "^4.3.4",
        "fs-extra": "^10.0.0",
        "isbinaryfile": "^4.0.8",
        "minimist": "^1.2.6",
        "plist": "^3.0.5"
      },
      "bin": {
        "electron-osx-flat": "bin/electron-osx-flat.js",
        "electron-osx-sign": "bin/electron-osx-sign.js"
      },
      "engines": {
        "node": ">=12.0.0"
      }
    },
    "node_modules/@xmldom/xmldom": {
      "version": "0.9.12",
      "resolved": "https://registry.npmjs.org/@xmldom/xmldom/-/xmldom-0.9.12.tgz",
      "integrity": "sha512-5AXjrcMClTryPe9LgZrygpB1lj7s0S9E0+W+AHaVKAVyHanafK86iPSvG5xHVSp/jC+VH1UXu0TAEmY279xH7A==",
      "license": "MIT",
      "engines": {
        "node": ">=14.6"
      }
    },
    "node_modules/base64-js": {
      "version": "1.5.1",
      "resolved": "https://registry.npmjs.org/base64-js/-/base64-js-1.5.1.tgz",
      "integrity": "sha512-AKpaYlHn8t4SVbOHCy+b5+KKgvR4vrsD8vbvrbiQJps7fKDTkjkDry6ji0rUJjC0kzbNePLwzxq8iypo41qeWA==",
      "funding": [
        {
          "type": "github",
          "url": "https://github.com/sponsors/feross"
        },
        {
          "type": "patreon",
          "url": "https://www.patreon.com/feross"
        },
        {
          "type": "consulting",
          "url": "https://feross.org/support"
        }
      ],
      "license": "MIT"
    },
    "node_modules/compare-version": {
      "version": "0.1.2",
      "resolved": "https://registry.npmjs.org/compare-version/-/compare-version-0.1.2.tgz",
      "integrity": "sha512-pJDh5/4wrEnXX/VWRZvruAGHkzKdr46z11OlTPN+VrATlWWhSKewNCJ1futCO5C7eJB3nPMFZA1LeYtcFboZ2A==",
      "license": "MIT",
      "engines": {
        "node": ">=0.10.0"
      }
    },
    "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": "10.1.0",
      "resolved": "https://registry.npmjs.org/fs-extra/-/fs-extra-10.1.0.tgz",
      "integrity": "sha512-oRXApq54ETRj4eMiFzGnHWGy+zo5raudjuxN0b8H7s/RU2oW0Wvsx9O0ACRN/kRq9E8Vu/ReskGB5o3ji+FzHQ==",
      "license": "MIT",
      "dependencies": {
        "graceful-fs": "^4.2.0",
        "jsonfile": "^6.0.1",
        "universalify": "^2.0.0"
      },
      "engines": {
        "node": ">=12"
      }
    },
    "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/isbinaryfile": {
      "version": "4.0.10",
      "resolved": "https://registry.npmjs.org/isbinaryfile/-/isbinaryfile-4.0.10.tgz",
      "integrity": "sha512-iHrqe5shvBUcFbmZq9zOQHBoeOhZJu6RQGrDpBgenUm/Am+F3JM2MgQj+rK3Z601fzrL5gLZWtAPH2OBaSVcyw==",
      "license": "MIT",
      "engines": {
        "node": ">= 8.0.0"
      },
      "funding": {
        "url": "https://github.com/sponsors/gjtorikian/"
      }
    },
    "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/plist": {
      "version": "3.1.1",
      "resolved": "https://registry.npmjs.org/plist/-/plist-3.1.1.tgz",
      "integrity": "sha512-ZIfcLJC+7E7FBFnDxm9MPmt7D+DidyQ26lewieO75AdhA2ayMtsJSES0iWzqJQbcVRSrTufQoy0DR94xHue0oA==",
      "license": "MIT",
      "dependencies": {
        "@xmldom/xmldom": "^0.9.10",
        "base64-js": "^1.5.1",
        "xmlbuilder": "^15.1.1"
      },
      "engines": {
        "node": ">=10.4.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"
      }
    },
    "node_modules/xmlbuilder": {
      "version": "15.1.1",
      "resolved": "https://registry.npmjs.org/xmlbuilder/-/xmlbuilder-15.1.1.tgz",
      "integrity": "sha512-yMqGBqtXyeN1e3TGYvgNgDVZ3j84W4cwkOXQswghol6APgZWaff9lnbvN7MHYJOiXsvGPXtjTYJEiC9J2wv9Eg==",
      "license": "MIT",
      "engines": {
        "node": ">=8.0"
      }
    }
  }
}

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

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

'use strict';

const assert = require('assert');
const fs = require('fs');
const path = require('path');
const os = require('os');
const { walkAsync, discoverSigningTargets } = require('../index.js');

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

  try {
    // 1. walkAsync is an exported async function
    assert.strictEqual(typeof walkAsync, 'function', 'walkAsync must be a function');

    // 2. walkAsync rejects with an Error when target directory does not exist
    const nonExistent = path.join(tmpDir, 'does-not-exist');
    await assert.rejects(
      async () => {
        await walkAsync(nonExistent);
      },
      (err) => {
        assert(err instanceof Error, 'Expected err to be an Error');
        return true;
      },
      'walkAsync must reject if directory does not exist'
    );

    // Create a mock directory hierarchy representing an Electron app structure
    const bundleDir = path.join(tmpDir, 'App.app');
    const contentsDir = path.join(bundleDir, 'Contents');
    const macOSDir = path.join(contentsDir, 'MacOS');
    const frameworksDir = path.join(contentsDir, 'Frameworks');
    const helperFwDir = path.join(frameworksDir, 'Helper.framework');
    const nestedAppDir = path.join(frameworksDir, 'Helper.app');
    const resourcesDir = path.join(contentsDir, 'Resources');

    fs.mkdirSync(macOSDir, { recursive: true });
    fs.mkdirSync(helperFwDir, { recursive: true });
    fs.mkdirSync(nestedAppDir, { recursive: true });
    fs.mkdirSync(resourcesDir, { recursive: true });

    // Binary files (contain null bytes for isbinaryfile)
    const mainBinary = path.join(macOSDir, 'AppExecutable');
    fs.writeFileSync(mainBinary, Buffer.from([0x7f, 0x45, 0x4c, 0x46, 0x02, 0x01, 0x01, 0x00]));

    const fwBinary = path.join(helperFwDir, 'Helper');
    fs.writeFileSync(fwBinary, Buffer.from([0xcf, 0xfa, 0xed, 0xfe, 0x07, 0x00, 0x00, 0x01]));

    const nestedAppBinary = path.join(nestedAppDir, 'HelperBinary');
    fs.writeFileSync(nestedAppBinary, Buffer.from([0xca, 0xfe, 0xba, 0xbe, 0x00, 0x00, 0x00, 0x02]));

    // Non-binary files (plain text)
    const infoPlist = path.join(contentsDir, 'Info.plist');
    fs.writeFileSync(infoPlist, '<plist version="1.0"><dict></dict></plist>', 'utf8');

    const resourceTxt = path.join(resourcesDir, 'readme.txt');
    fs.writeFileSync(resourceTxt, 'This is a text resource file.', 'utf8');

    // Temporary .cstemp file
    const cstempFile = path.join(resourcesDir, 'signing-temp.cstemp');
    fs.writeFileSync(cstempFile, 'leftover signing temp file', 'utf8');
    assert(fs.existsSync(cstempFile), '.cstemp file must exist before walkAsync');

    // 3. walkAsync recursively traverses a directory structure and returns an array of binary file paths
    const result = await walkAsync(contentsDir);
    assert(Array.isArray(result), 'walkAsync must return an array');

    // 4. walkAsync includes .framework and nested .app directories in discovered paths
    assert(result.includes(mainBinary), 'walkAsync must discover main executable');
    assert(result.includes(fwBinary), 'walkAsync must discover framework binary');
    assert(result.includes(nestedAppBinary), 'walkAsync must discover nested app binary');
    assert(result.includes(helperFwDir), 'walkAsync must include .framework directory path');
    assert(result.includes(nestedAppDir), 'walkAsync must include nested .app directory path');

    // 5. walkAsync ignores non-binary plain text files
    assert(!result.includes(infoPlist), 'walkAsync must not include text Info.plist');
    assert(!result.includes(resourceTxt), 'walkAsync must not include text file');

    // 6. walkAsync deletes temporary .cstemp files encountered during directory traversal
    assert(!result.includes(cstempFile), 'walkAsync must not include .cstemp file');
    assert(!fs.existsSync(cstempFile), 'walkAsync must delete .cstemp file from disk');

    // 7. discoverSigningTargets wrapper matches walkAsync result
    const helperResult = await discoverSigningTargets(contentsDir);
    assert.deepStrictEqual(helperResult, result, 'discoverSigningTargets must return the same paths as walkAsync');

    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);
});