@electron/notarize 2.5.0: validateAuthorizationArgs

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/notarize.validateAuthorizationArgs in pkg:npm/%40electron/notarize@2.5.0
Kind: HOW

Use EXACTLY these public packages and versions:
  - pkg:npm/%40electron/notarize@2.5.0
Demonstrate these symbols/APIs:
  - @electron/notarize.validateAuthorizationArgs

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:f2d775f98a5d2d0c64f70534ee2726216edc7f458ea3abf633950762af2b1fb8","contract":["validateAuthorizationArgs is an exported function","validateAuthorizationArgs throws an Error if no authentication credentials are provided","validateAuthorizationArgs throws an Error if multiple credential types are mixed","validateAuthorizationArgs throws an Error if password credentials are missing required fields","validateAuthorizationArgs returns the credentials object when password credentials are valid","validateAuthorizationArgs throws an Error if API key credentials are missing required fields","validateAuthorizationArgs returns the credentials object when API key credentials are valid","validateAuthorizationArgs throws an Error if keychain credentials are missing keychainProfile","validateAuthorizationArgs returns the credentials object when keychain credentials are valid"],"goal":"verify @electron/notarize.validateAuthorizationArgs in pkg:npm/%40electron/notarize@2.5.0","kind":"HOW","packages":["pkg:npm/%40electron/notarize@2.5.0"],"schemaVersion":1,"symbols":["@electron/notarize.validateAuthorizationArgs"]},"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/notarize@2.5.0"],"schemaVersion":1,"subject":"pkg:npm/%40electron/notarize@2.5.0","symbols":["@electron/notarize.validateAuthorizationArgs"],"verifierAdapter":"node-typescript@1"}

'use strict';

const { validateAuthorizationArgs } = require('@electron/notarize');

/**
 * Validates authentication arguments for notarization.
 * Supports password credentials, API key credentials, or keychain credentials.
 *
 * @param {Object} opts - Credentials options
 * @returns {Object} The validated credentials
 */
function checkAuthArgs(opts) {
  return validateAuthorizationArgs(opts);
}

module.exports = {
  validateAuthorizationArgs,
  checkAuthArgs
};

{
  "name": "sample-electron-notarize-validate-auth-args",
  "version": "1.0.0",
  "lockfileVersion": 3,
  "requires": true,
  "packages": {
    "": {
      "name": "sample-electron-notarize-validate-auth-args",
      "version": "1.0.0",
      "license": "MIT-0",
      "dependencies": {
        "@electron/notarize": "2.5.0"
      }
    },
    "node_modules/@electron/notarize": {
      "version": "2.5.0",
      "resolved": "https://registry.npmjs.org/@electron/notarize/-/notarize-2.5.0.tgz",
      "integrity": "sha512-jNT8nwH1f9X5GEITXaQ8IF/KdskvIkOFfB2CvwumsveVidzpSc+mvhhTMdAGSYF3O+Nq49lJ7y+ssODRXu06+A==",
      "license": "MIT",
      "dependencies": {
        "debug": "^4.1.1",
        "fs-extra": "^9.0.1",
        "promise-retry": "^2.0.1"
      },
      "engines": {
        "node": ">= 10.0.0"
      }
    },
    "node_modules/at-least-node": {
      "version": "1.0.0",
      "resolved": "https://registry.npmjs.org/at-least-node/-/at-least-node-1.0.0.tgz",
      "integrity": "sha512-+q/t7Ekv1EDY2l6Gda6LLiX14rU9TV20Wa3ofeQmwPFZbOMo9DXrLbOjFaaclkXKWidIaopwAObQDqwWtGUjqg==",
      "license": "ISC",
      "engines": {
        "node": ">= 4.0.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/err-code": {
      "version": "2.0.3",
      "resolved": "https://registry.npmjs.org/err-code/-/err-code-2.0.3.tgz",
      "integrity": "sha512-2bmlRpNKBxT/CRmPOlyISQpNj+qSeYvcym/uT0Jx2bMOlKLtSy1ZmLuVxSEKKyor/N5yhvp/ZiG1oE3DEYMSFA==",
      "license": "MIT"
    },
    "node_modules/fs-extra": {
      "version": "9.1.0",
      "resolved": "https://registry.npmjs.org/fs-extra/-/fs-extra-9.1.0.tgz",
      "integrity": "sha512-hcg3ZmepS30/7BSFqRvoo3DOMQu7IjqxO5nCDt+zM9XWjb33Wg7ziNT+Qvqbuc3+gWpzO02JubVyk2G4Zvo1OQ==",
      "license": "MIT",
      "dependencies": {
        "at-least-node": "^1.0.0",
        "graceful-fs": "^4.2.0",
        "jsonfile": "^6.0.1",
        "universalify": "^2.0.0"
      },
      "engines": {
        "node": ">=10"
      }
    },
    "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/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/promise-retry": {
      "version": "2.0.1",
      "resolved": "https://registry.npmjs.org/promise-retry/-/promise-retry-2.0.1.tgz",
      "integrity": "sha512-y+WKFlBR8BGXnsNlIHFGPZmyDf3DFMoLhaflAnyZgV6rG6xu+JwesTo2Q9R6XwYmtmwAFCkAk3e35jEdoeh/3g==",
      "license": "MIT",
      "dependencies": {
        "err-code": "^2.0.2",
        "retry": "^0.12.0"
      },
      "engines": {
        "node": ">=10"
      }
    },
    "node_modules/retry": {
      "version": "0.12.0",
      "resolved": "https://registry.npmjs.org/retry/-/retry-0.12.0.tgz",
      "integrity": "sha512-9LkiTwjUh6rT555DtE9rTX+BKByPfrMzEAtnlEtdEwr3Nkffwiihqe2bWADg+OQRjt9gl6ICdmB/ZFDCGAtSow==",
      "license": "MIT",
      "engines": {
        "node": ">= 4"
      }
    },
    "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-notarize-validate-auth-args",
  "version": "1.0.0",
  "private": true,
  "description": "verify @electron/notarize.validateAuthorizationArgs in pkg:npm/%40electron/notarize@2.5.0",
  "main": "index.js",
  "scripts": {
    "test": "node test/contract.cjs"
  },
  "dependencies": {
    "@electron/notarize": "2.5.0"
  },
  "license": "MIT-0"
}

{
  "schemaVersion": 1,
  "goal": "verify @electron/notarize.validateAuthorizationArgs in pkg:npm/%40electron/notarize@2.5.0",
  "kind": "HOW",
  "packages": [
    "pkg:npm/%40electron/notarize@2.5.0"
  ],
  "symbols": [
    "@electron/notarize.validateAuthorizationArgs"
  ]
}

'use strict';

const assert = require('assert');
const { validateAuthorizationArgs, checkAuthArgs } = require('../index.js');

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

  // 2. validateAuthorizationArgs throws an Error if no authentication credentials are provided
  assert.throws(
    () => {
      validateAuthorizationArgs({});
    },
    /No authentication properties provided/,
    'Should throw when no credentials are provided'
  );

  // 3. validateAuthorizationArgs throws an Error if multiple credential types are mixed
  assert.throws(
    () => {
      validateAuthorizationArgs({
        appleId: 'developer@example.com',
        appleIdPassword: 'secret-password',
        teamId: 'TEAM123456',
        appleApiKey: 'path/to/key.p8'
      });
    },
    /Cannot use password credentials, API key credentials and keychain credentials at once/,
    'Should throw when mixing password and API key credentials'
  );

  assert.throws(
    () => {
      validateAuthorizationArgs({
        appleId: 'developer@example.com',
        appleIdPassword: 'secret-password',
        teamId: 'TEAM123456',
        keychainProfile: 'my-profile'
      });
    },
    /Cannot use password credentials, API key credentials and keychain credentials at once/,
    'Should throw when mixing password and keychain credentials'
  );

  // 4. validateAuthorizationArgs throws an Error if password credentials are missing required fields
  assert.throws(
    () => {
      validateAuthorizationArgs({
        appleId: 'developer@example.com'
      });
    },
    /The appleIdPassword property is required when using notarization with password credentials/,
    'Should throw when appleIdPassword is missing'
  );

  assert.throws(
    () => {
      validateAuthorizationArgs({
        appleId: 'developer@example.com',
        appleIdPassword: 'secret-password'
      });
    },
    /The teamId property is required when using notarization with password credentials/,
    'Should throw when teamId is missing'
  );

  assert.throws(
    () => {
      validateAuthorizationArgs({
        appleIdPassword: 'secret-password',
        teamId: 'TEAM123456'
      });
    },
    /The appleId property is required when using notarization with password credentials/,
    'Should throw when appleId is missing'
  );

  // 5. validateAuthorizationArgs returns the credentials object when password credentials are valid
  const passwordOpts = {
    appleId: 'developer@example.com',
    appleIdPassword: 'secret-password',
    teamId: 'TEAM123456'
  };
  const validatedPassword = validateAuthorizationArgs(passwordOpts);
  assert.strictEqual(validatedPassword, passwordOpts);
  assert.strictEqual(checkAuthArgs(passwordOpts), passwordOpts);

  // 6. validateAuthorizationArgs throws an Error if API key credentials are missing required fields
  assert.throws(
    () => {
      validateAuthorizationArgs({
        appleApiKey: 'path/to/key.p8'
      });
    },
    /The appleApiIssuer property is required when using notarization with ASC credentials/,
    'Should throw when appleApiIssuer is missing'
  );

  assert.throws(
    () => {
      validateAuthorizationArgs({
        appleApiKey: 'path/to/key.p8',
        appleApiIssuer: 'issuer-uuid'
      });
    },
    /The appleApiKeyId property is required when using notarization with ASC credentials/,
    'Should throw when appleApiKeyId is missing'
  );

  assert.throws(
    () => {
      validateAuthorizationArgs({
        appleApiIssuer: 'issuer-uuid',
        appleApiKeyId: 'KEY123456'
      });
    },
    /The appleApiKey property is required when using notarization with ASC credentials/,
    'Should throw when appleApiKey is missing'
  );

  // 7. validateAuthorizationArgs returns the credentials object when API key credentials are valid
  const apiKeyOpts = {
    appleApiKey: 'path/to/key.p8',
    appleApiIssuer: 'issuer-uuid',
    appleApiKeyId: 'KEY123456'
  };
  const validatedApiKey = validateAuthorizationArgs(apiKeyOpts);
  assert.strictEqual(validatedApiKey, apiKeyOpts);
  assert.strictEqual(checkAuthArgs(apiKeyOpts), apiKeyOpts);

  // 8. validateAuthorizationArgs throws an Error if keychain credentials are missing keychainProfile
  assert.throws(
    () => {
      validateAuthorizationArgs({
        keychain: 'path/to/keychain'
      });
    },
    /The keychainProfile property is required when using notarization with keychain credentials/,
    'Should throw when keychainProfile is missing'
  );

  // 9. validateAuthorizationArgs returns the credentials object when keychain credentials are valid
  const keychainOpts = {
    keychainProfile: 'AC_PASSWORD'
  };
  const validatedKeychain = validateAuthorizationArgs(keychainOpts);
  assert.strictEqual(validatedKeychain, keychainOpts);
  assert.strictEqual(checkAuthArgs(keychainOpts), keychainOpts);

  console.log('Contract tests passed successfully.');
}

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