feat: add validation function for authorizationArgs (#35)

src/index.ts

@@ -3,9 +3,12 @@ import * as path from 'path';
 
 import { spawn } from './spawn';
 import { withTempDir, makeSecret, parseNotarizationInfo } from './helpers';
+import { validateAuthorizationArgs, isPasswordCredentials } from './validate-args';
 
 const d = debug('electron-notarize');
 
+export { validateAuthorizationArgs } from './validate-args';
+
 export interface NotarizePasswordCredentials {
   appleId: string;
   appleIdPassword: string;
@@ -36,8 +39,9 @@ export type NotarizeWaitOptions = NotarizeResult & NotarizeCredentials;
 export type NotarizeStapleOptions = Pick<NotarizeAppOptions, 'appPath'>;
 export type NotarizeOptions = NotarizeStartOptions;
 
-function authorizationArgs(opts: NotarizeCredentials): string[] {
-  if ('appleId' in opts) {
+function authorizationArgs(rawOpts: NotarizeCredentials): string[] {
+  const opts = validateAuthorizationArgs(rawOpts);
+  if (isPasswordCredentials(opts)) {
     return ['-u', makeSecret(opts.appleId), '-p', makeSecret(opts.appleIdPassword)];
   } else {
     return [

src/validate-args.ts

@@ -0,0 +1,52 @@
+import {
+  NotarizeApiKeyCredentials,
+  NotarizeCredentials,
+  NotarizePasswordCredentials,
+} from './index';
+
+export function isPasswordCredentials(
+  opts: NotarizeCredentials,
+): opts is NotarizePasswordCredentials {
+  const creds = opts as NotarizePasswordCredentials;
+  return creds.appleId !== undefined || creds.appleIdPassword !== undefined;
+}
+
+export function isApiKeyCredentials(opts: NotarizeCredentials): opts is NotarizeApiKeyCredentials {
+  const creds = opts as NotarizeApiKeyCredentials;
+  return creds.appleApiKey !== undefined || creds.appleApiIssuer !== undefined;
+}
+
+export function validateAuthorizationArgs(opts: NotarizeCredentials): NotarizeCredentials {
+  const isPassword = isPasswordCredentials(opts);
+  const isApiKey = isApiKeyCredentials(opts);
+  if (isPassword && isApiKey) {
+    throw new Error('Cannot use both password credentials and API key credentials at once');
+  }
+  if (isPassword) {
+    const passwordCreds = opts as NotarizePasswordCredentials;
+    if (!passwordCreds.appleId) {
+      throw new Error(
+        'The appleId property is required when using notarization with appleIdPassword',
+      );
+    } else if (!passwordCreds.appleIdPassword) {
+      throw new Error(
+        'The appleIdPassword property is required when using notarization with appleId',
+      );
+    }
+    return passwordCreds;
+  }
+  if (isApiKey) {
+    const apiKeyCreds = opts as NotarizeApiKeyCredentials;
+    if (!apiKeyCreds.appleApiKey) {
+      throw new Error(
+        'The appleApiKey property is required when using notarization with appleApiIssuer',
+      );
+    } else if (!apiKeyCreds.appleApiIssuer) {
+      throw new Error(
+        'The appleApiIssuer property is required when using notarization with appleApiKey',
+      );
+    }
+    return apiKeyCreds;
+  }
+  throw new Error('No authentication properties provided (e.g. appleId, appleApiKey)');
+}

test/validate-args.test.ts

@@ -0,0 +1,73 @@
+import {
+  NotarizeApiKeyCredentials,
+  NotarizeCredentials,
+  NotarizePasswordCredentials,
+} from '../src/index';
+import { validateAuthorizationArgs } from '../src/validate-args';
+
+describe('index', () => {
+  describe('validateAuthorizationArgs', () => {
+    test('password credentials provided', () => {
+      const opts = {
+        'appleId': 'fakeId',
+        'appleIdPassword': 'fakePassword',
+      } as NotarizePasswordCredentials;
+      expect(validateAuthorizationArgs(opts)).toEqual(opts);
+    });
+
+    test('API key credentials provided', () => {
+      const opts = {
+        'appleApiKey': 'fakeApiKey',
+        'appleApiIssuer': 'fakeApiIssuer',
+      } as NotarizeApiKeyCredentials;
+      expect(validateAuthorizationArgs(opts)).toEqual(opts);
+    });
+
+    test('credentials are required', () => {
+      const opts = {} as NotarizeCredentials;
+      expect(() => validateAuthorizationArgs(opts))
+        .toThrowError(new Error('No authentication properties provided (e.g. appleId, appleApiKey)'));
+    });
+
+    test('only one kind of credentials', () => {
+      const opts = {
+        'appleId': 'fakeId',
+        'appleApiKey': 'fakeApiKey',
+      } as any;
+      expect(() => validateAuthorizationArgs(opts))
+        .toThrowError(new Error('Cannot use both password credentials and API key credentials at once'));
+    });
+
+    test('missing appleId', () => {
+      const opts = {
+        'appleIdPassword': 'fakePassword',
+      } as any;
+      expect(() => validateAuthorizationArgs(opts))
+        .toThrowError(new Error('The appleId property is required when using notarization with appleIdPassword'));
+    });
+
+    test('missing appleIdPassword', () => {
+      const opts = {
+        'appleId': 'fakeId',
+      } as any;
+      expect(() => validateAuthorizationArgs(opts))
+        .toThrowError(new Error('The appleIdPassword property is required when using notarization with appleId'));
+    });
+
+    test('missing appleApiKey', () => {
+      const opts = {
+        'appleApiIssuer': 'fakeApiIssuer',
+      } as any;
+      expect(() => validateAuthorizationArgs(opts))
+        .toThrowError(new Error('The appleApiKey property is required when using notarization with appleApiIssuer'));
+    });
+
+    test('missing appleApiIssuer', () => {
+      const opts = {
+        'appleApiKey': 'fakeApiKey',
+      } as any;
+      expect(() => validateAuthorizationArgs(opts))
+        .toThrowError(new Error('The appleApiIssuer property is required when using notarization with appleApiKey'));
+    });
+  });
+});