@antelopejs/interface-payment 0.2.0 → 0.2.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +2 -0
- package/dist/tests/support.js +33 -14
- package/dist/tests/support.js.map +1 -1
- package/package.json +8 -4
package/README.md
CHANGED
|
@@ -12,6 +12,8 @@ refund them, save payment methods, and react to settlement events without naming
|
|
|
12
12
|
a provider. To change provider, you swap the module that implements the
|
|
13
13
|
interface.
|
|
14
14
|
|
|
15
|
+
Part of [AntelopeJS](https://github.com/AntelopeJS/antelopejs), the TypeScript framework where modules depend on contracts and the application chooses the provider. Built by the team behind [AntelopeJS DMS](https://github.com/AntelopeJS/dms).
|
|
16
|
+
|
|
15
17
|
## Installation
|
|
16
18
|
|
|
17
19
|
```bash
|
package/dist/tests/support.js
CHANGED
|
@@ -22,6 +22,7 @@ const index_1 = require("../index");
|
|
|
22
22
|
exports.SUITE_TIMEOUT = 60_000;
|
|
23
23
|
const SETTLE_TIMEOUT = 30_000;
|
|
24
24
|
const SETTLE_INTERVAL = 1_000;
|
|
25
|
+
const SETTLE_FIRST_POLL = 50;
|
|
25
26
|
exports.CHARGE_VALUE = 2500;
|
|
26
27
|
exports.PARTIAL_VALUE = 1000;
|
|
27
28
|
exports.REFUND_VALUE = 700;
|
|
@@ -99,6 +100,36 @@ function assertPaymentContract(payment, expected) {
|
|
|
99
100
|
strict_1.default.equal(payment.redirectUrl !== undefined, payment.status === "requires_action", "redirectUrl is present exactly when the payer must act");
|
|
100
101
|
strict_1.default.equal(payment.failure !== undefined, payment.status === "failed", "failure is present exactly when the payment failed");
|
|
101
102
|
}
|
|
103
|
+
/**
|
|
104
|
+
* Reads the payment until `done` holds or the settle deadline passes.
|
|
105
|
+
*
|
|
106
|
+
* A fixed poll reads one second after each read ends, and so does this one.
|
|
107
|
+
* Most payments settle within milliseconds, so extra reads come after the
|
|
108
|
+
* previous read ends, 50 ms first and twice as long each time, whenever one
|
|
109
|
+
* fits, at the last read's latency, before the next one-second read. With a
|
|
110
|
+
* steady read latency, a payment is never seen later than the fixed poll would
|
|
111
|
+
* have seen it.
|
|
112
|
+
*/
|
|
113
|
+
async function pollPayment(id, done) {
|
|
114
|
+
const deadline = Date.now() + SETTLE_TIMEOUT;
|
|
115
|
+
let gap = SETTLE_FIRST_POLL;
|
|
116
|
+
let readStart = Date.now();
|
|
117
|
+
let payment = await (0, index_1.GetPayment)(id);
|
|
118
|
+
let readEnd = Date.now();
|
|
119
|
+
let intervalReadAt = readEnd + SETTLE_INTERVAL;
|
|
120
|
+
while (!done(payment) && Date.now() < deadline) {
|
|
121
|
+
const earlyAt = readEnd + gap;
|
|
122
|
+
const isEarly = earlyAt + (readEnd - readStart) <= intervalReadAt;
|
|
123
|
+
gap *= 2;
|
|
124
|
+
await (0, promises_1.setTimeout)(Math.max(0, (isEarly ? earlyAt : intervalReadAt) - Date.now()));
|
|
125
|
+
readStart = Date.now();
|
|
126
|
+
payment = await (0, index_1.GetPayment)(id);
|
|
127
|
+
readEnd = Date.now();
|
|
128
|
+
if (!isEarly)
|
|
129
|
+
intervalReadAt = readEnd + SETTLE_INTERVAL;
|
|
130
|
+
}
|
|
131
|
+
return payment;
|
|
132
|
+
}
|
|
102
133
|
/**
|
|
103
134
|
* Polls until the payment leaves the states it can leave on its own.
|
|
104
135
|
*
|
|
@@ -107,14 +138,7 @@ function assertPaymentContract(payment, expected) {
|
|
|
107
138
|
* promises a terminal state is reachable without payer action for these flows.
|
|
108
139
|
*/
|
|
109
140
|
async function settle(id, expected) {
|
|
110
|
-
const
|
|
111
|
-
let payment = await (0, index_1.GetPayment)(id);
|
|
112
|
-
while (payment.status !== expected &&
|
|
113
|
-
!(0, index_1.isTerminalPaymentStatus)(payment.status) &&
|
|
114
|
-
Date.now() < deadline) {
|
|
115
|
-
await (0, promises_1.setTimeout)(SETTLE_INTERVAL);
|
|
116
|
-
payment = await (0, index_1.GetPayment)(id);
|
|
117
|
-
}
|
|
141
|
+
const payment = await pollPayment(id, (read) => read.status === expected || (0, index_1.isTerminalPaymentStatus)(read.status));
|
|
118
142
|
strict_1.default.equal(payment.status, expected, `payment ${id} reached ${payment.status}, not ${expected}`);
|
|
119
143
|
return payment;
|
|
120
144
|
}
|
|
@@ -146,12 +170,7 @@ async function charge() {
|
|
|
146
170
|
* the deadline is the failure this exists to catch.
|
|
147
171
|
*/
|
|
148
172
|
async function settleRefundedTotal(id) {
|
|
149
|
-
const
|
|
150
|
-
let payment = await (0, index_1.GetPayment)(id);
|
|
151
|
-
while (payment.amountRefunded.value === 0 && Date.now() < deadline) {
|
|
152
|
-
await (0, promises_1.setTimeout)(SETTLE_INTERVAL);
|
|
153
|
-
payment = await (0, index_1.GetPayment)(id);
|
|
154
|
-
}
|
|
173
|
+
const payment = await pollPayment(id, (read) => read.amountRefunded.value !== 0);
|
|
155
174
|
strict_1.default.notEqual(payment.amountRefunded.value, 0, `payment ${id} still reports nothing refunded after a settled refund`);
|
|
156
175
|
return payment.amountRefunded;
|
|
157
176
|
}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"support.js","sourceRoot":"","sources":["../../src/tests/support.ts"],"names":[],"mappings":";;;;;;
|
|
1
|
+
{"version":3,"file":"support.js","sourceRoot":"","sources":["../../src/tests/support.ts"],"names":[],"mappings":";;;;;;AAyDA,wBAEC;AAED,kBAEC;AAED,8BAEC;AAaD,8CASC;AAED,oCAQC;AAWD,sDAiCC;AA0CD,wBAcC;AAUD,sBAGC;AAED,kCAOC;AAED,wBAUC;AAUD,kDAWC;AA9PD,gEAAwC;AACxC,6CAAyC;AACzC,mDAA2D;AAE3D,oCAWkB;AAEL,QAAA,aAAa,GAAG,MAAM,CAAC;AACpC,MAAM,cAAc,GAAG,MAAM,CAAC;AAC9B,MAAM,eAAe,GAAG,KAAK,CAAC;AAC9B,MAAM,iBAAiB,GAAG,EAAE,CAAC;AAChB,QAAA,YAAY,GAAG,IAAI,CAAC;AACpB,QAAA,aAAa,GAAG,IAAI,CAAC;AACrB,QAAA,YAAY,GAAG,GAAG,CAAC;AACnB,QAAA,WAAW,GAAG,yCAAyC,CAAC;AACxD,QAAA,UAAU,GAAG,wCAAwC,CAAC;AACtD,QAAA,iBAAiB,GAC5B,iDAAiD,CAAC;AAEpD;;;;;;GAMG;AACU,QAAA,SAAS,GAAG,mBAAmB,GAAG,CAAC,MAAM,CAAC,EAAE,CAAC,EAAE,CAAC;AAE7D;;;;;;;GAOG;AACU,QAAA,WAAW,GAAG,OAAO,CAAC,GAAG,CAAC,4BAA4B,CAAC;AAEpE,iEAAiE;AACpD,QAAA,oBAAoB,GAC/B,OAAO,CAAC,GAAG,CAAC,qCAAqC,CAAC;AAEpD,MAAM,QAAQ,GAAG,OAAO,CAAC,GAAG,CAAC,8BAA8B,IAAI,KAAK,CAAC;AAExD,QAAA,UAAU,GAAG,uCAAuC,CAAC;AACrD,QAAA,UAAU,GAAG,gDAAgD,CAAC;AAE3E,SAAgB,MAAM,CAAC,KAAa;IAClC,OAAO,EAAE,KAAK,EAAE,QAAQ,EAAE,QAAQ,EAAE,CAAC;AACvC,CAAC;AAED,SAAgB,GAAG;IACjB,OAAO,wBAAwB,IAAA,wBAAU,GAAE,EAAE,CAAC;AAChD,CAAC;AAED,SAAgB,SAAS;IACvB,OAAO,eAAe,IAAA,wBAAU,GAAE,EAAE,CAAC;AACvC,CAAC;AAED,MAAM,kBAAkB,GAAG,IAAI,CAAC,GAAG,CAAC,IAAI,EAAE,CAAC,EAAE,CAAC,CAAC,CAAC;AAChD,MAAM,oBAAoB,GAAG,CAAC,GAAG,EAAE,GAAG,IAAI,CAAC;AAE3C;;;;;;;GAOG;AACH,SAAgB,iBAAiB,CAAC,KAAa,EAAE,KAAa;IAC5D,gBAAM,CAAC,EAAE,CACP,KAAK,GAAG,kBAAkB,EAC1B,GAAG,KAAK,OAAO,KAAK,uDAAuD,CAC5E,CAAC;IACF,gBAAM,CAAC,EAAE,CACP,KAAK,GAAG,IAAI,CAAC,GAAG,EAAE,GAAG,oBAAoB,EACzC,GAAG,KAAK,OAAO,KAAK,0BAA0B,CAC/C,CAAC;AACJ,CAAC;AAED,SAAgB,YAAY,CAC1B,MAAc,EACd,QAAgB,EAChB,KAAa;IAEb,gBAAM,CAAC,EAAE,CAAC,MAAM,CAAC,SAAS,CAAC,MAAM,CAAC,KAAK,CAAC,EAAE,GAAG,KAAK,sBAAsB,CAAC,CAAC;IAC1E,gBAAM,CAAC,KAAK,CAAC,MAAM,CAAC,KAAK,EAAE,QAAQ,CAAC,KAAK,EAAE,GAAG,KAAK,QAAQ,CAAC,CAAC;IAC7D,gBAAM,CAAC,KAAK,CAAC,MAAM,CAAC,QAAQ,EAAE,QAAQ,CAAC,QAAQ,EAAE,GAAG,KAAK,WAAW,CAAC,CAAC;AACxE,CAAC;AAED;;;;;;;;GAQG;AACH,SAAgB,qBAAqB,CACnC,OAAgB,EAChB,QAAgB;IAEhB,gBAAM,CAAC,EAAE,CAAC,OAAO,CAAC,EAAE,CAAC,MAAM,GAAG,CAAC,EAAE,8BAA8B,CAAC,CAAC;IACjE,gBAAM,CAAC,EAAE,CACP,wBAAgB,CAAC,QAAQ,CAAC,OAAO,CAAC,MAAM,CAAC,EACzC,UAAU,OAAO,CAAC,MAAM,0BAA0B,CACnD,CAAC;IACF,YAAY,CAAC,OAAO,CAAC,MAAM,EAAE,QAAQ,EAAE,gBAAgB,CAAC,CAAC;IACzD,gBAAM,CAAC,KAAK,CACV,OAAO,CAAC,cAAc,CAAC,QAAQ,EAC/B,OAAO,CAAC,MAAM,CAAC,QAAQ,EACvB,iDAAiD,CAClD,CAAC;IACF,gBAAM,CAAC,KAAK,CACV,OAAO,CAAC,cAAc,CAAC,QAAQ,EAC/B,OAAO,CAAC,MAAM,CAAC,QAAQ,EACvB,iDAAiD,CAClD,CAAC;IACF,gBAAM,CAAC,EAAE,CAAC,MAAM,CAAC,SAAS,CAAC,OAAO,CAAC,cAAc,CAAC,KAAK,CAAC,CAAC,CAAC;IAC1D,gBAAM,CAAC,EAAE,CAAC,MAAM,CAAC,SAAS,CAAC,OAAO,CAAC,cAAc,CAAC,KAAK,CAAC,CAAC,CAAC;IAC1D,iBAAiB,CAAC,OAAO,CAAC,SAAS,EAAE,mBAAmB,CAAC,CAAC;IAC1D,gBAAM,CAAC,KAAK,CACV,OAAO,CAAC,WAAW,KAAK,SAAS,EACjC,OAAO,CAAC,MAAM,KAAK,iBAAiB,EACpC,wDAAwD,CACzD,CAAC;IACF,gBAAM,CAAC,KAAK,CACV,OAAO,CAAC,OAAO,KAAK,SAAS,EAC7B,OAAO,CAAC,MAAM,KAAK,QAAQ,EAC3B,oDAAoD,CACrD,CAAC;AACJ,CAAC;AAED;;;;;;;;;GASG;AACH,KAAK,UAAU,WAAW,CACxB,EAAU,EACV,IAAmC;IAEnC,MAAM,QAAQ,GAAG,IAAI,CAAC,GAAG,EAAE,GAAG,cAAc,CAAC;IAC7C,IAAI,GAAG,GAAG,iBAAiB,CAAC;IAC5B,IAAI,SAAS,GAAG,IAAI,CAAC,GAAG,EAAE,CAAC;IAC3B,IAAI,OAAO,GAAG,MAAM,IAAA,kBAAU,EAAC,EAAE,CAAC,CAAC;IACnC,IAAI,OAAO,GAAG,IAAI,CAAC,GAAG,EAAE,CAAC;IACzB,IAAI,cAAc,GAAG,OAAO,GAAG,eAAe,CAAC;IAC/C,OAAO,CAAC,IAAI,CAAC,OAAO,CAAC,IAAI,IAAI,CAAC,GAAG,EAAE,GAAG,QAAQ,EAAE,CAAC;QAC/C,MAAM,OAAO,GAAG,OAAO,GAAG,GAAG,CAAC;QAC9B,MAAM,OAAO,GAAG,OAAO,GAAG,CAAC,OAAO,GAAG,SAAS,CAAC,IAAI,cAAc,CAAC;QAClE,GAAG,IAAI,CAAC,CAAC;QACT,MAAM,IAAA,qBAAK,EAAC,IAAI,CAAC,GAAG,CAAC,CAAC,EAAE,CAAC,OAAO,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,cAAc,CAAC,GAAG,IAAI,CAAC,GAAG,EAAE,CAAC,CAAC,CAAC;QAC5E,SAAS,GAAG,IAAI,CAAC,GAAG,EAAE,CAAC;QACvB,OAAO,GAAG,MAAM,IAAA,kBAAU,EAAC,EAAE,CAAC,CAAC;QAC/B,OAAO,GAAG,IAAI,CAAC,GAAG,EAAE,CAAC;QACrB,IAAI,CAAC,OAAO;YAAE,cAAc,GAAG,OAAO,GAAG,eAAe,CAAC;IAC3D,CAAC;IACD,OAAO,OAAO,CAAC;AACjB,CAAC;AAED;;;;;;GAMG;AACI,KAAK,UAAU,MAAM,CAC1B,EAAU,EACV,QAAuB;IAEvB,MAAM,OAAO,GAAG,MAAM,WAAW,CAC/B,EAAE,EACF,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,MAAM,KAAK,QAAQ,IAAI,IAAA,+BAAuB,EAAC,IAAI,CAAC,MAAM,CAAC,CAC3E,CAAC;IACF,gBAAM,CAAC,KAAK,CACV,OAAO,CAAC,MAAM,EACd,QAAQ,EACR,WAAW,EAAE,YAAY,OAAO,CAAC,MAAM,SAAS,QAAQ,EAAE,CAC3D,CAAC;IACF,OAAO,OAAO,CAAC;AACjB,CAAC;AAED,MAAM,SAAS,GAAa,EAAE,CAAC;AAE/B,KAAK,CAAC,KAAK,IAAI,EAAE;IACf,MAAM,OAAO,CAAC,GAAG,CACf,SAAS,CAAC,GAAG,CAAC,CAAC,EAAE,EAAE,EAAE,CAAC,IAAA,sBAAc,EAAC,EAAE,EAAE,GAAG,EAAE,CAAC,CAAC,KAAK,CAAC,GAAG,EAAE,CAAC,SAAS,CAAC,CAAC,CACxE,CAAC;AACJ,CAAC,CAAC,CAAC;AAEH,SAAgB,KAAK,CAAC,QAAkB;IACtC,SAAS,CAAC,IAAI,CAAC,QAAQ,CAAC,EAAE,CAAC,CAAC;IAC5B,OAAO,QAAQ,CAAC;AAClB,CAAC;AAEM,KAAK,UAAU,WAAW;IAC/B,OAAO,KAAK,CACV,MAAM,IAAA,sBAAc,EAClB,EAAE,KAAK,EAAE,GAAG,IAAA,wBAAU,GAAE,mBAAmB,EAAE,IAAI,EAAE,mBAAmB,EAAE,EACxE,GAAG,EAAE,CACN,CACF,CAAC;AACJ,CAAC;AAEM,KAAK,UAAU,MAAM;IAC1B,OAAO,IAAA,qBAAa,EAClB;QACE,MAAM,EAAE,MAAM,CAAC,oBAAY,CAAC;QAC5B,SAAS,EAAE,SAAS,EAAE;QACtB,aAAa,EAAE,mBAAW;QAC1B,UAAU,EAAE,IAAI;KACjB,EACD,GAAG,EAAE,CACN,CAAC;AACJ,CAAC;AAED;;;;;;;GAOG;AACI,KAAK,UAAU,mBAAmB,CAAC,EAAU;IAClD,MAAM,OAAO,GAAG,MAAM,WAAW,CAC/B,EAAE,EACF,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,cAAc,CAAC,KAAK,KAAK,CAAC,CAC1C,CAAC;IACF,gBAAM,CAAC,QAAQ,CACb,OAAO,CAAC,cAAc,CAAC,KAAK,EAC5B,CAAC,EACD,WAAW,EAAE,wDAAwD,CACtE,CAAC;IACF,OAAO,OAAO,CAAC,cAAc,CAAC;AAChC,CAAC"}
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@antelopejs/interface-payment",
|
|
3
|
-
"version": "0.2.
|
|
3
|
+
"version": "0.2.1",
|
|
4
4
|
"description": "Provider-agnostic AntelopeJS payment interface: hosted checkout, direct payments with auth/capture, refunds, saved payment methods, and normalised webhook events",
|
|
5
5
|
"keywords": [
|
|
6
6
|
"antelopejs",
|
|
@@ -30,6 +30,10 @@
|
|
|
30
30
|
"#built": {
|
|
31
31
|
"types": "./src/index.ts",
|
|
32
32
|
"default": "./dist/index.js"
|
|
33
|
+
},
|
|
34
|
+
"#built/tests/*": {
|
|
35
|
+
"types": "./src/tests/*.ts",
|
|
36
|
+
"default": "./dist/tests/*.js"
|
|
33
37
|
}
|
|
34
38
|
},
|
|
35
39
|
"exports": {
|
|
@@ -57,7 +61,7 @@
|
|
|
57
61
|
"release": "pnpm run lint && pnpm run test && pnpm run prepack && release-it",
|
|
58
62
|
"format:check": "oxfmt --check .",
|
|
59
63
|
"knip": "knip",
|
|
60
|
-
"prepare": "if
|
|
64
|
+
"prepare": "if [ -e .git ] && command -v git >/dev/null 2>&1 && command -v lefthook >/dev/null 2>&1 && GIT_DIR=.git GIT_WORK_TREE=. git rev-parse --git-dir >/dev/null 2>&1; then GIT_DIR=.git GIT_WORK_TREE=. lefthook install; fi",
|
|
61
65
|
"checks": "antelopejs-checks",
|
|
62
66
|
"size": "antelopejs-check-size",
|
|
63
67
|
"sync": "antelopejs-sync",
|
|
@@ -67,9 +71,9 @@
|
|
|
67
71
|
"suppressions:update": "antelopejs-suppressions --update"
|
|
68
72
|
},
|
|
69
73
|
"devDependencies": {
|
|
70
|
-
"@antelopejs/core": "1.
|
|
74
|
+
"@antelopejs/core": "1.21.0",
|
|
71
75
|
"@antelopejs/interface-core": ">=0.0.3 <1.0.0",
|
|
72
|
-
"@antelopejs/tooling-configs": "^0.
|
|
76
|
+
"@antelopejs/tooling-configs": "^0.4.0",
|
|
73
77
|
"@types/mocha": "^10.0.10",
|
|
74
78
|
"@types/node": "^22.19.15",
|
|
75
79
|
"eslint-plugin-perfectionist": "^5.11.0",
|