@electron/osx-sign 1.3.1: flat

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.flat 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.flat

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:2d2bf73b100b2332756cfcadb1a5727151104f3295f5a622c2ac3d13ead5e94b","contract":["flat is an exported function that accepts options and a callback","flat invokes callback with an Error if app path is not specified","flat invokes callback with an Error if app path does not end with .app","flat invokes callback with an Error if the target application bundle does not exist on disk","flat invokes callback with an Error if pkg option is not a string","flat invokes callback with an Error if pkg option does not end with .pkg","flat invokes callback with an Error if install option is not a string"],"goal":"verify @electron/osx-sign.flat 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.flat"]},"contractCommand":["node","test/contract.cjs"],"environment":{"arch":"x64","distro":"ubuntu","ecosystem":"npm","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/osx-sign@1.3.1"],"schemaVersion":1,"subject":"pkg:npm/%40electron/osx-sign@1.3.1","symbols":["@electron/osx-sign.flat"],"verifierAdapter":"node-typescript@1"}

'use strict';

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

/**
 * Wraps the callback-based flat API from @electron/osx-sign into a Promise.
 * @param {Object} opts - Flat packaging options
 * @returns {Promise<void>}
 */
function flatPromise(opts) {
  return new Promise((resolve, reject) => {
    flat(opts, (err) => {
      if (err) {
        return reject(err);
      }
      resolve();
    });
  });
}

module.exports = {
  flat,
  flatPromise
};

{
  "name": "sample-electron-osx-flat",
  "version": "1.0.0",
  "lockfileVersion": 3,
  "requires": true,
  "packages": {
    "": {
      "name": "sample-electron-osx-flat",
      "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-flat",
  "version": "1.0.0",
  "private": true,
  "description": "verify @electron/osx-sign.flat 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.flat in pkg:npm/%40electron/osx-sign@1.3.1",
  "kind": "HOW",
  "packages": [
    "pkg:npm/%40electron/osx-sign@1.3.1"
  ],
  "symbols": [
    "@electron/osx-sign.flat"
  ]
}

'use strict';

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

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

  try {
    // 1. flat is an exported function that accepts options and a callback
    assert.strictEqual(typeof flat, 'function', 'flat must be an exported function');

    // 2. flat invokes callback with an Error if app path is not specified
    await new Promise((resolve, reject) => {
      flat({}, (err) => {
        try {
          assert(err instanceof Error, 'Expected err to be an instance of Error');
          assert.match(
            err.message,
            /Path to application must be specified/,
            'Expected error message to indicate missing app path'
          );
          resolve();
        } catch (assertionErr) {
          reject(assertionErr);
        }
      });
    });

    // 3. flat invokes callback with an Error if app path does not end with .app
    await new Promise((resolve, reject) => {
      flat({ app: 'InvalidAppPath.txt' }, (err) => {
        try {
          assert(err instanceof Error, 'Expected err to be an instance of Error');
          assert.match(
            err.message,
            /Extension of application must be `\.app`/,
            'Expected error message to indicate invalid app extension'
          );
          resolve();
        } catch (assertionErr) {
          reject(assertionErr);
        }
      });
    });

    // 4. flat invokes callback with an Error if the target application bundle does not exist on disk
    const nonExistentApp = path.join(tmpDir, 'NonExistent.app');
    await new Promise((resolve, reject) => {
      flat({ app: nonExistentApp }, (err) => {
        try {
          assert(err instanceof Error, 'Expected err to be an instance of Error');
          assert.match(
            err.message,
            /could not be found/,
            'Expected error message to indicate missing app on disk'
          );
          resolve();
        } catch (assertionErr) {
          reject(assertionErr);
        }
      });
    });

    // Create a dummy valid application directory for subsequent option validation tests
    const dummyApp = path.join(tmpDir, 'ValidBundle.app');
    fs.mkdirSync(dummyApp, { recursive: true });

    // 5. flat invokes callback with an Error if pkg option is not a string
    await new Promise((resolve, reject) => {
      flat({ app: dummyApp, pkg: 12345 }, (err) => {
        try {
          assert(err instanceof Error, 'Expected err to be an instance of Error');
          assert.match(
            err.message,
            /`pkg` must be a string/,
            'Expected error message to indicate pkg must be a string'
          );
          resolve();
        } catch (assertionErr) {
          reject(assertionErr);
        }
      });
    });

    // 6. flat invokes callback with an Error if pkg option does not end with .pkg
    await new Promise((resolve, reject) => {
      flat({ app: dummyApp, pkg: 'output-package.zip' }, (err) => {
        try {
          assert(err instanceof Error, 'Expected err to be an instance of Error');
          assert.match(
            err.message,
            /Extension of output package must be `\.pkg`/,
            'Expected error message to indicate pkg extension must be .pkg'
          );
          resolve();
        } catch (assertionErr) {
          reject(assertionErr);
        }
      });
    });

    // 7. flat invokes callback with an Error if install option is not a string
    await new Promise((resolve, reject) => {
      flat({ app: dummyApp, install: 12345 }, (err) => {
        try {
          assert(err instanceof Error, 'Expected err to be an instance of Error');
          assert.match(
            err.message,
            /`install` must be a string/,
            'Expected error message to indicate install must be a string'
          );
          resolve();
        } catch (assertionErr) {
          reject(assertionErr);
        }
      });
    });

    // flatPromise wrapper propagates validation errors
    assert.strictEqual(typeof flatPromise, 'function', 'flatPromise must be a function');
    await assert.rejects(
      async () => {
        await flatPromise({});
      },
      /Path to application must be specified/,
      'flatPromise must reject when options are invalid'
    );

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