Migrate other Stripe infrastructure to TS

stripe · Sep 26, 2022 · 28d35cf · 28d35cf
1 parent fffee63
commit 28d35cf
Show file tree

Hide file tree

Showing 17 changed files with 97 additions and 41 deletions.
diff --git a/lib/Webhooks.js b/lib/Webhooks.js
diff --git a/lib/crypto/SubtleCryptoProvider.js b/lib/crypto/SubtleCryptoProvider.js
diff --git a/lib/multipart.js b/lib/multipart.js
diff --git a/lib/net/FetchHttpClient.js b/lib/net/FetchHttpClient.js
diff --git a/lib/net/NodeHttpClient.js b/lib/net/NodeHttpClient.js
diff --git a/lib/utils.js b/lib/utils.js
diff --git a/src/Error.ts b/src/Error.ts
@@ -18,7 +18,7 @@ type StripeRawError = {
   doc_url?: string;
   decline_code?: string;
   param?: string;
-  detail?: string;
+  detail?: any;
   charge?: string;
   payment_method_type?: string;
 
@@ -44,7 +44,7 @@ class StripeError extends Error {
   readonly code?: string;
   readonly doc_url?: string;
   readonly param?: string;
-  readonly detail?: string;
+  readonly detail?: any;
   readonly statusCode?: number;
   readonly charge?: string;
   readonly decline_code?: string;

diff --git a/src/ResourceNamespace.js → src/ResourceNamespace.ts b/src/ResourceNamespace.js → src/ResourceNamespace.ts
diff --git a/src/Webhooks.js → src/Webhooks.ts b/src/Webhooks.js → src/Webhooks.ts
@@ -1,10 +1,12 @@
 'use strict';
 
-const utils = require('./utils');
-const {StripeError, StripeSignatureVerificationError} = require('./Error');
+import utils = require('./utils');
+import _Error = require('./Error');
+const {StripeError, StripeSignatureVerificationError} = _Error;
 
 const Webhook = {
   DEFAULT_TOLERANCE: 300, // 5 minutes
+  signature: null,
 
   constructEvent(payload, header, secret, tolerance, cryptoProvider) {
     this.signature.verifyHeader(
@@ -242,7 +244,7 @@ function parseHeader(header, scheme) {
       const kv = item.split('=');
 
       if (kv[0] === 't') {
-        accum.timestamp = kv[1];
+        accum.timestamp = parseInt(kv[1], 10);
       }
 
       if (kv[0] === scheme) {
@@ -274,4 +276,4 @@ function getNodeCryptoProvider() {
 
 Webhook.signature = signature;
 
-module.exports = Webhook;
+export = Webhook;
diff --git a/src/crypto/CryptoProvider.js → src/crypto/CryptoProvider.ts b/src/crypto/CryptoProvider.js → src/crypto/CryptoProvider.ts
@@ -13,7 +13,7 @@ class CryptoProvider {
    * - computeHMACSignature('', 'test_secret') => 'f7f9bd47fb987337b5796fdc1fdb9ba221d0d5396814bfcaf9521f43fd8927fd'
    * - computeHMACSignature('\ud83d\ude00', 'test_secret') => '837da296d05c4fe31f61d5d7ead035099d9585a5bcde87de952012a78f0b0c43
    */
-  computeHMACSignature(payload, secret) {
+  computeHMACSignature(payload: string, secret: string): string {
     throw new Error('computeHMACSignature not implemented.');
   }
 
@@ -28,9 +28,9 @@ class CryptoProvider {
    * - computeHMACSignature('', 'test_secret') => 'f7f9bd47fb987337b5796fdc1fdb9ba221d0d5396814bfcaf9521f43fd8927fd'
    * - computeHMACSignature('\ud83d\ude00', 'test_secret') => '837da296d05c4fe31f61d5d7ead035099d9585a5bcde87de952012a78f0b0c43
    */
-  computeHMACSignatureAsync(payload, secret) {
+  computeHMACSignatureAsync(payload: string, secret: string): Promise<string> {
     throw new Error('computeHMACSignatureAsync not implemented.');
   }
 }
 
-module.exports = CryptoProvider;
+export = CryptoProvider;
diff --git a/src/crypto/NodeCryptoProvider.js → src/crypto/NodeCryptoProvider.ts b/src/crypto/NodeCryptoProvider.js → src/crypto/NodeCryptoProvider.ts
@@ -1,26 +1,29 @@
 'use strict';
 
-const crypto = require('crypto');
+import crypto = require('crypto');
 
-const CryptoProvider = require('./CryptoProvider');
+import CryptoProvider = require('./CryptoProvider');
 
 /**
  * `CryptoProvider which uses the Node `crypto` package for its computations.
  */
 class NodeCryptoProvider extends CryptoProvider {
   /** @override */
-  computeHMACSignature(payload, secret) {
+  computeHMACSignature(payload: string, secret: string): string {
     return crypto
       .createHmac('sha256', secret)
       .update(payload, 'utf8')
       .digest('hex');
   }
 
   /** @override */
-  async computeHMACSignatureAsync(payload, secret) {
+  async computeHMACSignatureAsync(
+    payload: string,
+    secret: string
+  ): Promise<string> {
     const signature = await this.computeHMACSignature(payload, secret);
     return signature;
   }
 }
 
-module.exports = NodeCryptoProvider;
+export = NodeCryptoProvider;
diff --git a/src/crypto/SubtleCryptoProvider.js → src/crypto/SubtleCryptoProvider.ts b/src/crypto/SubtleCryptoProvider.js → src/crypto/SubtleCryptoProvider.ts
@@ -1,13 +1,15 @@
 'use strict';
 
-const CryptoProvider = require('./CryptoProvider');
+import CryptoProvider = require('./CryptoProvider');
 
 /**
  * `CryptoProvider which uses the SubtleCrypto interface of the Web Crypto API.
  *
  * This only supports asynchronous operations.
  */
 class SubtleCryptoProvider extends CryptoProvider {
+  subtleCrypto: any;
+
   constructor(subtleCrypto) {
     super();
 
@@ -18,15 +20,15 @@ class SubtleCryptoProvider extends CryptoProvider {
   }
 
   /** @override */
-  computeHMACSignature(payload, secret) {
+  computeHMACSignature(payload: string, secret: string): string {
     throw new Error(
       'SubtleCryptoProvider cannot be used in a synchronous context.'
     );
   }
 
   /** @override */
   async computeHMACSignatureAsync(payload, secret) {
-    const encoder = new TextEncoder('utf-8');
+    const encoder = new TextEncoder();
 
     const key = await this.subtleCrypto.importKey(
       'raw',
@@ -66,4 +68,4 @@ for (let i = 0; i < byteHexMapping.length; i++) {
   byteHexMapping[i] = i.toString(16).padStart(2, '0');
 }
 
-module.exports = SubtleCryptoProvider;
+export = SubtleCryptoProvider;
diff --git a/src/multipart.js → src/multipart.ts b/src/multipart.js → src/multipart.ts
@@ -1,7 +1,8 @@
 'use strict';
 
-const utils = require('./utils');
-const {StripeError} = require('./Error');
+import utils = require('./utils');
+import _Error = require('./Error');
+const {StripeError} = _Error;
 
 class StreamProcessingError extends StripeError {}
 
@@ -93,4 +94,6 @@ const multipartRequestDataProcessor = (method, data, headers, callback) => {
   return callback(null, buffer);
 };
 
-module.exports.multipartRequestDataProcessor = multipartRequestDataProcessor;
+export = {
+  multipartRequestDataProcessor: multipartRequestDataProcessor,
+};
diff --git a/src/net/FetchHttpClient.js → src/net/FetchHttpClient.ts b/src/net/FetchHttpClient.js → src/net/FetchHttpClient.ts
@@ -1,6 +1,7 @@
 'use strict';
 
-const {HttpClient, HttpClientResponse} = require('./HttpClient');
+import _HttpClient = require('./HttpClient');
+const {HttpClient, HttpClientResponse} = _HttpClient;
 
 /**
  * HTTP client which uses a `fetch` function to issue requests.
@@ -11,6 +12,9 @@ const {HttpClient, HttpClientResponse} = require('./HttpClient');
  * node-fetch package (https://github.com/node-fetch/node-fetch).
  */
 class FetchHttpClient extends HttpClient {
+  _fetchFn: any;
+  _res: any;
+
   constructor(fetchFn) {
     super();
     this._fetchFn = fetchFn;
@@ -88,6 +92,8 @@ class FetchHttpClient extends HttpClient {
 }
 
 class FetchHttpClientResponse extends HttpClientResponse {
+  _res: any;
+
   constructor(res) {
     super(
       res.status,
@@ -135,4 +141,4 @@ class FetchHttpClientResponse extends HttpClientResponse {
   }
 }
 
-module.exports = {FetchHttpClient, FetchHttpClientResponse};
+export = {FetchHttpClient, FetchHttpClientResponse};
diff --git a/src/net/HttpClient.js → src/net/HttpClient.ts b/src/net/HttpClient.js → src/net/HttpClient.ts
@@ -1,5 +1,7 @@
 'use strict';
 
+type TimeoutError = TypeError & {code?: string};
+
 /**
  * Encapsulates the logic for issuing a request to the Stripe API.
  *
@@ -10,6 +12,9 @@
  *    returning their own response class when making requests.
  */
 class HttpClient {
+  static CONNECTION_CLOSED_ERROR_CODES: string[];
+  static TIMEOUT_ERROR_CODE: string;
+
   /** The client name used for diagnostics. */
   getClientName() {
     throw new Error('getClientName not implemented.');
@@ -30,7 +35,9 @@ class HttpClient {
 
   /** Helper to make a consistent timeout error across implementations. */
   static makeTimeoutError() {
-    const timeoutErr = new TypeError(HttpClient.TIMEOUT_ERROR_CODE);
+    const timeoutErr: TimeoutError = new TypeError(
+      HttpClient.TIMEOUT_ERROR_CODE
+    );
     timeoutErr.code = HttpClient.TIMEOUT_ERROR_CODE;
     return timeoutErr;
   }
@@ -40,6 +47,9 @@ HttpClient.CONNECTION_CLOSED_ERROR_CODES = ['ECONNRESET', 'EPIPE'];
 HttpClient.TIMEOUT_ERROR_CODE = 'ETIMEDOUT';
 
 class HttpClientResponse {
+  _statusCode: number;
+  _headers: object;
+
   constructor(statusCode, headers) {
     this._statusCode = statusCode;
     this._headers = headers;
@@ -66,4 +76,4 @@ class HttpClientResponse {
   }
 }
 
-module.exports = {HttpClient, HttpClientResponse};
+export = {HttpClient, HttpClientResponse};
diff --git a/src/net/NodeHttpClient.js → src/net/NodeHttpClient.ts b/src/net/NodeHttpClient.js → src/net/NodeHttpClient.ts
@@ -3,7 +3,8 @@
 const http = require('http');
 const https = require('https');
 
-const {HttpClient, HttpClientResponse} = require('./HttpClient');
+import _HttpClient = require('./HttpClient');
+const {HttpClient, HttpClientResponse} = _HttpClient;
 
 const defaultHttpAgent = new http.Agent({keepAlive: true});
 const defaultHttpsAgent = new https.Agent({keepAlive: true});
@@ -13,6 +14,8 @@ const defaultHttpsAgent = new https.Agent({keepAlive: true});
  * requests.`
  */
 class NodeHttpClient extends HttpClient {
+  _agent: any;
+
   constructor(agent) {
     super();
     this._agent = agent;
@@ -86,6 +89,8 @@ class NodeHttpClient extends HttpClient {
 }
 
 class NodeHttpClientResponse extends HttpClientResponse {
+  _res: any;
+
   constructor(res) {
     super(res.statusCode, res.headers || {});
     this._res = res;
@@ -122,4 +127,4 @@ class NodeHttpClientResponse extends HttpClientResponse {
   }
 }
 
-module.exports = {NodeHttpClient, NodeHttpClientResponse};
+export = {NodeHttpClient, NodeHttpClientResponse};