-
Notifications
You must be signed in to change notification settings - Fork 743
/
stripe.core.ts
483 lines (414 loc) · 13.5 KB
/
stripe.core.ts
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
import * as _Error from './Error.js';
import {ApiVersion} from './apiVersion.js';
import * as resources from './resources.js';
import {HttpClient, HttpClientResponse} from './net/HttpClient.js';
import {
determineProcessUserAgentProperties,
pascalToCamelCase,
validateInteger,
} from './utils.js';
import {CryptoProvider} from './crypto/CryptoProvider.js';
import {PlatformFunctions} from './platform/PlatformFunctions.js';
import {RequestSender} from './RequestSender.js';
import {StripeResource} from './StripeResource.js';
import {WebhookObject, createWebhooks} from './Webhooks.js';
import {
StripeObject,
AppInfo,
UserProvidedConfig,
RequestOptions,
RequestData,
} from './Types.js';
const DEFAULT_HOST = 'api.stripe.com';
const DEFAULT_PORT = '443';
const DEFAULT_BASE_PATH = '/v1/';
const DEFAULT_API_VERSION = ApiVersion;
const DEFAULT_TIMEOUT = 80000;
const MAX_NETWORK_RETRY_DELAY_SEC = 2;
const INITIAL_NETWORK_RETRY_DELAY_SEC = 0.5;
const APP_INFO_PROPERTIES = ['name', 'version', 'url', 'partner_id'];
const ALLOWED_CONFIG_PROPERTIES = [
'apiVersion',
'typescript',
'maxNetworkRetries',
'httpAgent',
'httpClient',
'timeout',
'host',
'port',
'protocol',
'telemetry',
'appInfo',
'stripeAccount',
];
type RequestSenderFactory = (stripe: StripeObject) => RequestSender;
const defaultRequestSenderFactory: RequestSenderFactory = (stripe) =>
new RequestSender(stripe, StripeResource.MAX_BUFFERED_REQUEST_METRICS);
export function createStripe(
platformFunctions: PlatformFunctions,
requestSender: RequestSenderFactory = defaultRequestSenderFactory
): typeof Stripe {
Stripe.PACKAGE_VERSION = '15.5.0-beta.1';
Stripe.USER_AGENT = {
bindings_version: Stripe.PACKAGE_VERSION,
lang: 'node',
publisher: 'stripe',
uname: null,
typescript: false,
...determineProcessUserAgentProperties(),
};
Stripe.StripeResource = StripeResource;
Stripe.resources = resources;
Stripe.HttpClient = HttpClient;
Stripe.HttpClientResponse = HttpClientResponse;
Stripe.CryptoProvider = CryptoProvider;
// Previously Stripe.webhooks was just the createWebhooks() factory function
// however going forward it will be a WebhookObject instance. To maintain
// backwards compatibility it is currently a factory function that also
// complies to the WebhookObject signature. The factory function signature
// will be removed as a breaking change in the next major release.
// See https://github.com/stripe/stripe-node/issues/1956
function createWebhooksDefault(fns = platformFunctions): WebhookObject {
return createWebhooks(fns);
}
Stripe.webhooks = Object.assign(
createWebhooksDefault,
createWebhooks(platformFunctions)
);
function Stripe(
this: StripeObject,
key: string,
config: Record<string, unknown> = {}
): void {
if (!(this instanceof Stripe)) {
return new (Stripe as any)(key, config);
}
const props = this._getPropsFromConfig(config);
this._platformFunctions = platformFunctions;
Object.defineProperty(this, '_emitter', {
value: this._platformFunctions.createEmitter(),
enumerable: false,
configurable: false,
writable: false,
});
this.VERSION = Stripe.PACKAGE_VERSION;
this.on = this._emitter.on.bind(this._emitter);
this.once = this._emitter.once.bind(this._emitter);
this.off = this._emitter.removeListener.bind(this._emitter);
const agent = props.httpAgent || null;
this._api = {
auth: null,
host: props.host || DEFAULT_HOST,
port: props.port || DEFAULT_PORT,
protocol: props.protocol || 'https',
basePath: DEFAULT_BASE_PATH,
version: props.apiVersion || DEFAULT_API_VERSION,
timeout: validateInteger('timeout', props.timeout, DEFAULT_TIMEOUT),
maxNetworkRetries: validateInteger(
'maxNetworkRetries',
props.maxNetworkRetries,
1
),
agent: agent,
httpClient:
props.httpClient ||
(agent
? this._platformFunctions.createNodeHttpClient(agent)
: this._platformFunctions.createDefaultHttpClient()),
dev: false,
stripeAccount: props.stripeAccount || null,
};
const typescript = props.typescript || false;
if (typescript !== Stripe.USER_AGENT.typescript) {
// The mutation here is uncomfortable, but likely fastest;
// serializing the user agent involves shelling out to the system,
// and given some users may instantiate the library many times without switching between TS and non-TS,
// we only want to incur the performance hit when that actually happens.
Stripe.USER_AGENT.typescript = typescript;
}
if (props.appInfo) {
this._setAppInfo(props.appInfo);
}
this._prepResources();
this._setApiKey(key);
this.errors = _Error;
// Once Stripe.webhooks looses the factory function signature in a future release
// then this should become this.webhooks = Stripe.webhooks
this.webhooks = createWebhooksDefault();
this._prevRequestMetrics = [];
this._enableTelemetry = props.telemetry !== false;
this._requestSender = requestSender(this);
// Expose StripeResource on the instance too
// @ts-ignore
this.StripeResource = Stripe.StripeResource;
}
Stripe.errors = _Error;
Stripe.createNodeHttpClient = platformFunctions.createNodeHttpClient;
/**
* Creates an HTTP client for issuing Stripe API requests which uses the Web
* Fetch API.
*
* A fetch function can optionally be passed in as a parameter. If none is
* passed, will default to the default `fetch` function in the global scope.
*/
Stripe.createFetchHttpClient = platformFunctions.createFetchHttpClient;
/**
* Create a CryptoProvider which uses the built-in Node crypto libraries for
* its crypto operations.
*/
Stripe.createNodeCryptoProvider = platformFunctions.createNodeCryptoProvider;
/**
* Creates a CryptoProvider which uses the Subtle Crypto API from the Web
* Crypto API spec for its crypto operations.
*
* A SubtleCrypto interface can optionally be passed in as a parameter. If none
* is passed, will default to the default `crypto.subtle` object in the global
* scope.
*/
Stripe.createSubtleCryptoProvider =
platformFunctions.createSubtleCryptoProvider;
Stripe.prototype = {
// Properties are set in the constructor above
_appInfo: undefined!,
on: null!,
off: null!,
once: null!,
VERSION: null!,
StripeResource: null!,
webhooks: null!,
errors: null!,
_api: null!,
_prevRequestMetrics: null!,
_emitter: null!,
_enableTelemetry: null!,
_requestSender: null!,
_platformFunctions: null!,
rawRequest(
method: string,
path: string,
params?: RequestData,
options?: RequestOptions
): Promise<any> {
return this._requestSender._rawRequest(method, path, params, options);
},
/**
* @private
*/
_setApiKey(key: string): void {
if (key) {
this._setApiField('auth', `Bearer ${key}`);
}
},
/**
* @private
* This may be removed in the future.
*/
_setAppInfo(info: AppInfo): void {
if (info && typeof info !== 'object') {
throw new Error('AppInfo must be an object.');
}
if (info && !info.name) {
throw new Error('AppInfo.name is required');
}
info = info || {};
this._appInfo = APP_INFO_PROPERTIES.reduce<Record<string, any>>(
(accum: Record<string, any>, prop) => {
if (typeof info[prop] == 'string') {
accum = accum || {};
accum[prop] = info[prop];
}
return accum;
},
// @ts-ignore
undefined
);
},
/**
* @private
* This may be removed in the future.
*/
_setApiField<K extends keyof StripeObject['_api']>(
key: K,
value: StripeObject['_api'][K]
): void {
this._api[key] = value;
},
/**
* @private
* Please open or upvote an issue at github.com/stripe/stripe-node
* if you use this, detailing your use-case.
*
* It may be deprecated and removed in the future.
*/
getApiField<K extends keyof StripeObject['_api']>(
key: K
): StripeObject['_api'][K] {
return this._api[key];
},
setClientId(clientId: string): void {
this._clientId = clientId;
},
getClientId(): string | undefined {
return this._clientId;
},
/**
* @private
* Please open or upvote an issue at github.com/stripe/stripe-node
* if you use this, detailing your use-case.
*
* It may be deprecated and removed in the future.
*/
getConstant: (c: string): unknown => {
switch (c) {
case 'DEFAULT_HOST':
return DEFAULT_HOST;
case 'DEFAULT_PORT':
return DEFAULT_PORT;
case 'DEFAULT_BASE_PATH':
return DEFAULT_BASE_PATH;
case 'DEFAULT_API_VERSION':
return DEFAULT_API_VERSION;
case 'DEFAULT_TIMEOUT':
return DEFAULT_TIMEOUT;
case 'MAX_NETWORK_RETRY_DELAY_SEC':
return MAX_NETWORK_RETRY_DELAY_SEC;
case 'INITIAL_NETWORK_RETRY_DELAY_SEC':
return INITIAL_NETWORK_RETRY_DELAY_SEC;
}
return ((Stripe as unknown) as Record<string, unknown>)[c];
},
getMaxNetworkRetries(): number {
return this.getApiField('maxNetworkRetries');
},
/**
* @private
* This may be removed in the future.
*/
_setApiNumberField(
prop: keyof StripeObject['_api'],
n: number,
defaultVal?: number
): void {
const val = validateInteger(prop, n, defaultVal);
this._setApiField(prop, val);
},
getMaxNetworkRetryDelay(): number {
return MAX_NETWORK_RETRY_DELAY_SEC;
},
getInitialNetworkRetryDelay(): number {
return INITIAL_NETWORK_RETRY_DELAY_SEC;
},
/**
* @private
* Please open or upvote an issue at github.com/stripe/stripe-node
* if you use this, detailing your use-case.
*
* It may be deprecated and removed in the future.
*
* Gets a JSON version of a User-Agent and uses a cached version for a slight
* speed advantage.
*/
getClientUserAgent(cb: (userAgent: string) => void): void {
return this.getClientUserAgentSeeded(Stripe.USER_AGENT, cb);
},
/**
* @private
* Please open or upvote an issue at github.com/stripe/stripe-node
* if you use this, detailing your use-case.
*
* It may be deprecated and removed in the future.
*
* Gets a JSON version of a User-Agent by encoding a seeded object and
* fetching a uname from the system.
*/
getClientUserAgentSeeded(
seed: Record<string, string | boolean | null>,
cb: (userAgent: string) => void
): void {
this._platformFunctions.getUname().then((uname: string | null) => {
const userAgent: Record<string, string> = {};
for (const field in seed) {
userAgent[field] = encodeURIComponent(seed[field] ?? 'null');
}
// URI-encode in case there are unusual characters in the system's uname.
userAgent.uname = encodeURIComponent(uname || 'UNKNOWN');
const client = this.getApiField('httpClient');
if (client) {
userAgent.httplib = encodeURIComponent(client.getClientName());
}
if (this._appInfo) {
userAgent.application = this._appInfo;
}
cb(JSON.stringify(userAgent));
});
},
/**
* @private
* Please open or upvote an issue at github.com/stripe/stripe-node
* if you use this, detailing your use-case.
*
* It may be deprecated and removed in the future.
*/
getAppInfoAsString(): string {
if (!this._appInfo) {
return '';
}
let formatted = this._appInfo.name;
if (this._appInfo.version) {
formatted += `/${this._appInfo.version}`;
}
if (this._appInfo.url) {
formatted += ` (${this._appInfo.url})`;
}
return formatted;
},
getTelemetryEnabled(): boolean {
return this._enableTelemetry;
},
/**
* @private
* This may be removed in the future.
*/
_prepResources(): void {
for (const name in resources) {
// @ts-ignore
this[pascalToCamelCase(name)] = new resources[name](this);
}
},
/**
* @private
* This may be removed in the future.
*/
_getPropsFromConfig(config: Record<string, unknown>): UserProvidedConfig {
// If config is null or undefined, just bail early with no props
if (!config) {
return {};
}
// config can be an object or a string
const isString = typeof config === 'string';
const isObject = config === Object(config) && !Array.isArray(config);
if (!isObject && !isString) {
throw new Error('Config must either be an object or a string');
}
// If config is a string, we assume the old behavior of passing in a string representation of the api version
if (isString) {
return {
apiVersion: config,
};
}
// If config is an object, we assume the new behavior and make sure it doesn't contain any unexpected values
const values = Object.keys(config).filter(
(value) => !ALLOWED_CONFIG_PROPERTIES.includes(value)
);
if (values.length > 0) {
throw new Error(
`Config object may only contain the following: ${ALLOWED_CONFIG_PROPERTIES.join(
', '
)}`
);
}
return config;
},
} as StripeObject;
return Stripe;
}