-
Notifications
You must be signed in to change notification settings - Fork 138
/
recurly.js
403 lines (356 loc) · 10.5 KB
/
recurly.js
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
/*jshint -W058 */
import clone from 'component-clone';
import Emitter from 'component-emitter';
import pick from 'lodash.pick';
import uuid from 'uuid/v4';
import errors from './recurly/errors';
import { bankAccount } from './recurly/bank-account';
import coupon from './recurly/coupon';
import giftcard from './recurly/giftcard';
import plan from './recurly/plan';
import tax from './recurly/tax';
import version from './recurly/version';
import { request, cachedRequest, pipedRequest } from './recurly/request';
import { token } from './recurly/token';
import { factory as Adyen } from './recurly/adyen';
import { factory as ApplePay } from './recurly/apple-pay';
import { factory as Frame } from './recurly/frame';
import { factory as PayPal } from './recurly/paypal';
import { factory as Risk } from './recurly/risk';
import { deprecated as deprecatedPaypal } from './recurly/paypal/strategy/direct';
import { Bus } from './recurly/bus';
import { Reporter } from './recurly/reporter';
import { Fraud } from './recurly/fraud';
import { HostedFields, FIELD_TYPES } from './recurly/hosted-fields';
import { Request } from './recurly/request';
import { fetch as storageFetch, set as storageSet } from './util/web-storage';
import CheckoutPricing from './recurly/pricing/checkout';
import SubscriptionPricing from './recurly/pricing/subscription';
import deepAssign from './util/deep-assign';
const debug = require('debug')('recurly');
/**
* Default configuration values.
*
* currency: ISO 4217
* timeout: API request timeout in ms
* publicKey: Recurly site public key
* cors: Whether to use XHR2/XDR+CORS over jsonp for API requests
* fraud: fraud configuration
* api: URL of API
* fields: field behavior and styling configuration
*
* @private
* @type {Object}
*/
const DEFAULTS = {
currency: 'USD',
timeout: 60000,
publicKey: '',
parent: true,
parentVersion: version,
cors: true,
fraud: {
kount: { dataCollector: false },
litle: { sessionId: undefined },
braintree: { deviceData: undefined }
},
api: 'https://api.recurly.com/js/v1',
fields: {
all: {
style: {}
},
number: {
selector: '[data-recurly=number]',
style: {}
},
month: {
selector: '[data-recurly=month]',
style: {}
},
year: {
selector: '[data-recurly=year]',
style: {}
},
cvv: {
selector: '[data-recurly=cvv]',
style: {}
},
card: {
selector: '[data-recurly=card]',
style: {}
}
}
};
/**
* Initialize defaults.
*
* @param {Object} options
* @constructor
* @public
*/
export class Recurly extends Emitter {
Risk = Risk;
constructor (options) {
super();
this.id = uuid();
this.version = version;
this.configured = false;
this.readyState = 0;
this.config = deepAssign({}, DEFAULTS);
if (options) this.configure(options);
this.bankAccount = {
token: bankAccount.token.bind(this),
bankInfo: bankAccount.bankInfo.bind(this)
};
this.reporter = new Reporter({ recurly: this });
this.request = new Request({ recurly: this });
this.Pricing = () => new SubscriptionPricing(this); // deprecated
this.Pricing.Checkout = () => new CheckoutPricing(this);
this.Pricing.Subscription = () => new SubscriptionPricing(this);
this.once('ready', () => this.report('ready'));
this.bindReporting();
}
/**
* Expose the class through its common name
*/
get Recurly () {
return this.constructor;
}
/**
* Whether this instance is considered a parent
*
* @return {Boolean}
*/
get isParent () {
return !!this.config.parent;
}
get deviceId () {
return storageFetch({ key: 'deviceId', otherwise: uuid() });
}
set deviceId (id) {
return storageSet({ key: 'deviceId', value: id });
}
get sessionId () {
return storageFetch({ scope: 'session', key: 'sessionId', otherwise: uuid() });
}
set sessionId (id) {
return storageSet({ scope: 'session', key: 'sessionId', value: id });
}
/**
* Assembles the API endpoint
*
* @return {String} route
*/
url (route) {
return this.config.api + route;
}
/**
* Queues or immediately invokes a callback when the instance is
* in the ready state
*
* @param {Function} done callback
*/
ready (done) {
if (this.readyState > 1) done();
else this.once('ready', done);
}
/**
* Configure settings.
*
* @param {String|Object} options Either publicKey or object containing
* publicKey and other optional members
* @param {String} options.publicKey
* @param {String} [options.currency] sets a default currency
* @param {String} [options.api]
* @param {Boolean} [options.cors] Enables data transmission over XHR+CORS
* @param {Array} [options.required] Adds additional field requirements for
* tokenization. ex: ['cvv']
* @public
*/
configure (options) {
debug('configure');
options = clone(options);
if (typeof options === 'string') options = { publicKey: options };
options = normalizeOptions(options)
if (options.publicKey) {
this.config.publicKey = options.publicKey;
} else if (!this.config.publicKey) {
throw errors('config-missing-public-key');
}
if (options.api) {
this.config.api = options.api;
}
if (options.currency) {
this.config.currency = options.currency;
}
if ('cors' in options) {
this.config.cors = options.cors;
}
if ('fraud' in options) {
deepAssign(this.config.fraud, options.fraud);
}
if ('parent' in options) {
this.config.parent = options.parent;
}
if (typeof options.fields === 'object') {
deepAssign(this.config.fields, options.fields);
}
this.config.required = options.required || this.config.required || [];
// Begin parent role configuration and setup
if (this.config.parent) {
this.parent();
} else {
if (options.parentVersion) this.config.parentVersion = options.parentVersion;
}
if (!this.configured) {
this.configured = true;
this.emit('configured');
this.report('configured');
}
}
/**
* Disables a recurly.js instance
*
* - Removes all listeners
* - Propagates a destroy call to the bus
* - Stops the bus
* - Removes external references
*
* TODO:
* - destroy pricing instances, or let them live on? Currently they
* may live on since their associated recurly instances remain configured
* for API requests.
*/
destroy () {
debug('destroying Recurly instance', this.id);
this.off();
if (this.bus) {
this.bus.send('destroy');
this.bus.destroy();
}
if (this.fraud) {
this.fraud.destroy();
}
if (this.reporter) {
this.reporter.destroy();
delete this.reporter;
}
}
/**
* Initialize the parent recurly instance concerns: hosted fields and message bus
*
* TODO: readyState is not a good pattern
*
* sets this.readyState
* 0: unconfigured
* 1: begun intializing hosted fields
* 2: done initializing hosted fields
* 3: done initializing (no hosted fields)
*
* @private
*/
parent () {
let reset = false;
if (this.hostedFields) {
// Check integrity of hostedFields. If fields are dead or do not match chosen selectors, reset
if (this.readyState > 1 && !this.hostedFields.integrityCheck(this.config.fields)) reset = true;
}
if (reset) {
this.readyState = 0;
this.hostedFields.reset();
}
if (this.readyState > 0) {
this.bus.send('hostedFields:configure', { recurlyConfig: this.config });
return;
}
if (!this.fraud) this.fraud = new Fraud(this);
if (this.bus) this.bus.destroy();
this.bus = new Bus({ api: this.config.api });
this.bus.add(this);
if (!this.hostedFields || reset) {
this.hostedFields = new HostedFields({ recurly: this });
}
if (this.hostedFields.errors.length === 0) {
this.bus.add(this.hostedFields);
this.once('hostedFields:ready', body => {
this.readyState = 2;
this.emit('ready');
});
this.on('hostedFields:state:change', body => this.emit('change', { fields: body }));
this.on('hostedField:submit', () => this.emit('field:submit'));
this.readyState = 1;
} else {
this.readyState = 3;
this.emit('ready');
}
}
/**
* Reports an event to the Reporter if it is available
*
* @private
*/
report (...args) {
if (!this.reporter) return;
this.reporter.send(...args);
}
/**
* Binds important events to the EventDispatcher
*
* @private
*/
bindReporting () {
if (!this.isParent) return;
['focus', 'blur'].forEach(eventName => {
this.on(`hostedField:${eventName}`, ({ type }) => {
const state = this.hostedFields.state[type];
let meta = pick(state, ['type', 'valid', 'empty']);
if (state.brand) meta.brand = state.brand;
this.report(`hosted-field:${eventName}`, meta);
});
});
}
}
Recurly.prototype.Adyen = Adyen;
Recurly.prototype.ApplePay = ApplePay;
Recurly.prototype.coupon = coupon;
Recurly.prototype.Frame = Frame;
Recurly.prototype.giftCard = giftcard;
Recurly.prototype.giftcard = giftcard; // DEPRECATED
Recurly.prototype.PayPal = PayPal;
Recurly.prototype.paypal = deprecatedPaypal;
Recurly.prototype.plan = plan;
Recurly.prototype.tax = tax;
Recurly.prototype.token = token;
Recurly.prototype.validate = require('./recurly/validate').publicMethods;
/**
* Standardizes old configuration structure to current
*
* 1. options.fields.[field] {String} -> options.fields.[field].selector {String}
* 2. options.style.[field] {Object} -> options.fields.[field].style {Object}
* 3. options.style.all {Object} -> options.fields.all.style {Object}
*
* @param {Object} options
* @return {Object}
*/
function normalizeOptions (options) {
const baseStyleConfig = options.style || {};
delete options.style;
FIELD_TYPES.forEach(type => {
// 1
if (options.fields && typeof options.fields[type] === 'string') {
options.fields[type] = { selector: options.fields[type] };
}
// 2
if (baseStyleConfig[type]) {
options.fields = options.fields || {};
options.fields[type] = options.fields[type] || {};
options.fields[type].style = deepAssign({}, baseStyleConfig[type], options.fields[type].style);
}
});
// 3
if (baseStyleConfig.all) {
options.fields = options.fields || {};
options.fields.all = { style: baseStyleConfig.all };
}
return options;
}