Improve error for incompatible card data type in createToken (stripe#19)

hofman-stripe · web-flow · commit ce6e1826482b · 2020-03-17T11:45:52.000-07:00
Switch order of `createToken` overload.
Add test for expected typescript error.
diff --git a/package.json b/package.json
@@ -9,7 +9,7 @@
   "scripts": {
     "test": "jest",
     "test:versions": "./tests/versions/scripts/test.sh",
-    "test:types": "tsc -p ./tests/types",
+    "test:types": "tsc -p ./tests/types && jest --roots '<rootDir>/tests/types'",
     "lint": "eslint '{src,types}/**/*.{ts,js}' && yarn prettier-list-different",
     "typecheck": "tsc",
     "build": "yarn clean && yarn rollup -c",
@@ -55,4 +55,4 @@
     "ts-jest": "^24.3.0",
     "typescript": "^3.7.4"
   }
-}
+}
diff --git a/tests/types/errors.test.ts b/tests/types/errors.test.ts
@@ -0,0 +1,32 @@
+import * as path from 'path';
+import {readFileSync} from 'fs';
+
+import * as ts from 'typescript';
+
+const parsedCommandLine = ts.getParsedCommandLineOfConfigFile(
+  path.resolve(__dirname, 'tsconfig.json'),
+  {},
+  {
+    ...ts.sys,
+    getCurrentDirectory: () => __dirname,
+    onUnRecoverableConfigFileDiagnostic: () => {},
+  }
+)!;
+
+const getError = function(fileName: string) {
+  const program = ts.createProgram([fileName], parsedCommandLine.options);
+  const diagnostics = ts.getPreEmitDiagnostics(program);
+
+  return ts.flattenDiagnosticMessageText(diagnostics[0].messageText, '\n');
+};
+
+describe('Typescript errors', () => {
+  test.each([['createCardTokenExtraPropertyError', 'extra_property']])(
+    '%s',
+    (fileName, expectedError) => {
+      expect(
+        getError(path.resolve(__dirname, `./fixtures/${fileName}.ts`))
+      ).toMatch(expectedError);
+    }
+  );
+});
diff --git a/tests/types/fixtures/createCardTokenExtraPropertyError.ts b/tests/types/fixtures/createCardTokenExtraPropertyError.ts
@@ -0,0 +1,15 @@
+///<reference path='../../../types/index.d.ts' />
+
+import {Stripe, StripeElements, StripeCardElement} from '@stripe/stripe-js';
+
+declare const stripe: Stripe;
+
+const elements: StripeElements = stripe.elements();
+
+const cardElement: StripeCardElement = elements.create('card');
+
+stripe.createToken(cardElement, {
+  currency: '',
+  name: '',
+  extra_property: '',
+});
diff --git a/tests/types/fixtures/createIbanTokenExtraPropertyError.ts b/tests/types/fixtures/createIbanTokenExtraPropertyError.ts
@@ -0,0 +1,15 @@
+///<reference path='../../../types/index.d.ts' />
+
+import {Stripe, StripeElements, StripeIbanElement} from '@stripe/stripe-js';
+
+declare const stripe: Stripe;
+
+const elements: StripeElements = stripe.elements();
+
+const ibanElement: StripeIbanElement = elements.create('iban');
+
+stripe.createToken(ibanElement, {
+  currency: '',
+  account_holder_name: '',
+  extra_property: '',
+});
diff --git a/types/stripe-js/index.d.ts b/types/stripe-js/index.d.ts
@@ -252,23 +252,23 @@ declare module '@stripe/stripe-js' {
     /////////////////////////////
 
     /**
-     * Use `stripe.createToken` to convert information collected by card elements into a single-use [Token](https://stripe.com/docs/api#tokens) that you safely pass to your server to use in an API call.
+     * Use `stripe.createToken` to convert information collected by an `IbanElement` into a single-use [Token](https://stripe.com/docs/api#tokens) that you safely pass to your server to use in an API call.
      *
-     * @docs https://stripe.com/docs/js/tokens_sources/create_token?type=cardElement
+     * @docs https://stripe.com/docs/js/tokens_sources/create_token?type=ibanElement
      */
     createToken(
-      tokenType: StripeCardElement | StripeCardNumberElement,
-      data?: CreateTokenCardData
+      tokenType: StripeIbanElement,
+      data: CreateTokenIbanData
     ): Promise<{token?: Token; error?: StripeError}>;
 
     /**
-     * Use `stripe.createToken` to convert information collected by an `IbanElement` into a single-use [Token](https://stripe.com/docs/api#tokens) that you safely pass to your server to use in an API call.
+     * Use `stripe.createToken` to convert information collected by card elements into a single-use [Token](https://stripe.com/docs/api#tokens) that you safely pass to your server to use in an API call.
      *
-     * @docs https://stripe.com/docs/js/tokens_sources/create_token?type=ibanElement
+     * @docs https://stripe.com/docs/js/tokens_sources/create_token?type=cardElement
      */
     createToken(
-      tokenType: StripeIbanElement,
-      data: CreateTokenIbanData
+      tokenType: StripeCardElement | StripeCardNumberElement,
+      data?: CreateTokenCardData
     ): Promise<{token?: Token; error?: StripeError}>;
 
     /**
