@laranex/myanmar-payments 4.0.0-dev.3 → 4.0.0-dev.5
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/CHANGELOG.md +10 -3
- package/dist/cjs/aya-pay/aya-pay.d.ts +12 -9
- package/dist/cjs/aya-pay/aya-pay.js +14 -11
- package/dist/cjs/core/amount.d.ts +4 -3
- package/dist/cjs/core/amount.js +13 -4
- package/dist/cjs/core/callback.d.ts +7 -2
- package/dist/cjs/core/callback.js +14 -7
- package/dist/cjs/core/crypto.d.ts +6 -1
- package/dist/cjs/core/crypto.js +17 -3
- package/dist/cjs/core/env.d.ts +5 -5
- package/dist/cjs/core/env.js +21 -12
- package/dist/cjs/core/errors.d.ts +8 -3
- package/dist/cjs/core/errors.js +11 -4
- package/dist/cjs/core/http.d.ts +10 -11
- package/dist/cjs/core/http.js +7 -9
- package/dist/cjs/core/index.d.ts +1 -1
- package/dist/cjs/core/index.js +1 -2
- package/dist/cjs/core/json.d.ts +2 -2
- package/dist/cjs/core/json.js +3 -3
- package/dist/cjs/core/values.d.ts +2 -0
- package/dist/cjs/core/values.js +5 -0
- package/dist/cjs/cyber-source/cyber-source.d.ts +10 -13
- package/dist/cjs/cyber-source/cyber-source.js +13 -14
- package/dist/cjs/kbz-pay/kbz-pay.d.ts +12 -9
- package/dist/cjs/kbz-pay/kbz-pay.js +11 -13
- package/dist/cjs/kbz-pay/signer.d.ts +4 -1
- package/dist/cjs/kbz-pay/signer.js +7 -2
- package/dist/cjs/wave-money/wave-money.d.ts +15 -13
- package/dist/cjs/wave-money/wave-money.js +18 -25
- package/dist/cjs/yoma-mmqr/yoma-mmqr.d.ts +16 -13
- package/dist/cjs/yoma-mmqr/yoma-mmqr.js +21 -19
- package/dist/esm/aya-pay/aya-pay.d.ts +12 -9
- package/dist/esm/aya-pay/aya-pay.js +16 -13
- package/dist/esm/core/amount.d.ts +4 -3
- package/dist/esm/core/amount.js +13 -4
- package/dist/esm/core/callback.d.ts +7 -2
- package/dist/esm/core/callback.js +14 -7
- package/dist/esm/core/crypto.d.ts +6 -1
- package/dist/esm/core/crypto.js +17 -3
- package/dist/esm/core/env.d.ts +5 -5
- package/dist/esm/core/env.js +19 -10
- package/dist/esm/core/errors.d.ts +8 -3
- package/dist/esm/core/errors.js +11 -4
- package/dist/esm/core/http.d.ts +10 -11
- package/dist/esm/core/http.js +6 -8
- package/dist/esm/core/index.d.ts +1 -1
- package/dist/esm/core/index.js +1 -1
- package/dist/esm/core/json.d.ts +2 -2
- package/dist/esm/core/json.js +3 -3
- package/dist/esm/core/values.d.ts +2 -0
- package/dist/esm/core/values.js +4 -0
- package/dist/esm/cyber-source/cyber-source.d.ts +10 -13
- package/dist/esm/cyber-source/cyber-source.js +14 -15
- package/dist/esm/kbz-pay/kbz-pay.d.ts +12 -9
- package/dist/esm/kbz-pay/kbz-pay.js +12 -14
- package/dist/esm/kbz-pay/signer.d.ts +4 -1
- package/dist/esm/kbz-pay/signer.js +8 -3
- package/dist/esm/wave-money/wave-money.d.ts +15 -13
- package/dist/esm/wave-money/wave-money.js +20 -27
- package/dist/esm/yoma-mmqr/yoma-mmqr.d.ts +16 -13
- package/dist/esm/yoma-mmqr/yoma-mmqr.js +23 -21
- package/package.json +1 -1
- package/skills/node-myanmar-payments/SKILL.md +24 -21
|
@@ -1,42 +1,41 @@
|
|
|
1
1
|
import {} from '../core/amount.js';
|
|
2
2
|
import { CallbackRequest, losslessInput, losslessQueryInput, PaymentCallback, PaymentStatusResult, } from '../core/callback.js';
|
|
3
3
|
import { decodeBase64, hmacSha256Hex, safeEqual } from '../core/crypto.js';
|
|
4
|
-
import { defaultEnv, envFirst,
|
|
4
|
+
import { defaultEnv, envFirst, HTTP_TIMEOUT_VARIABLE, optionalSetting, requireSeconds, requireSetting, trimUrl, } from '../core/env.js';
|
|
5
5
|
import { ApiError, SignatureVerificationError } from '../core/errors.js';
|
|
6
6
|
import { httpClientFrom, Transport, } from '../core/http.js';
|
|
7
7
|
import { isLosslessObject, parseJsonObject, toPlainObject, } from '../core/json.js';
|
|
8
8
|
import { FormPayment } from '../core/results.js';
|
|
9
9
|
import { resolveStatus } from '../core/status.js';
|
|
10
10
|
import { toAmount, Validator } from '../core/validate.js';
|
|
11
|
-
import { get, object, optional, scalarString, trimmed } from '../core/values.js';
|
|
11
|
+
import { get, isNested, object, optional, scalarString, trimmed } from '../core/values.js';
|
|
12
12
|
/**
|
|
13
|
-
* AYA Payment Gateway (APG) credentials and endpoints. A missing
|
|
14
|
-
* `ConfigurationError`.
|
|
13
|
+
* AYA Payment Gateway (APG) credentials and endpoints. A missing setting throws a
|
|
14
|
+
* `ConfigurationError`. The URL defaults to production.
|
|
15
15
|
*/
|
|
16
16
|
export class AyaPayConfig {
|
|
17
|
-
static SANDBOX_URL = 'https://uat-pgw.ayainnovation.com';
|
|
18
17
|
static PRODUCTION_URL = 'https://pgw.ayainnovation.com';
|
|
19
18
|
appKey;
|
|
20
19
|
appSecret;
|
|
21
|
-
|
|
20
|
+
/** Seconds before the default HTTP client gives up on a request. */
|
|
21
|
+
timeoutSeconds;
|
|
22
22
|
/** The base URL in use. */
|
|
23
23
|
baseUrl;
|
|
24
24
|
constructor(options) {
|
|
25
25
|
this.appKey = requireSetting('aya_pay', 'app_key', options.appKey);
|
|
26
26
|
this.appSecret = requireSetting('aya_pay', 'app_secret', options.appSecret);
|
|
27
|
-
this.
|
|
28
|
-
this.baseUrl = trimUrl(optionalSetting(options.baseUrl) ??
|
|
29
|
-
(this.sandbox ? AyaPayConfig.SANDBOX_URL : AyaPayConfig.PRODUCTION_URL));
|
|
27
|
+
this.timeoutSeconds = requireSeconds('aya_pay', 'timeout_in_seconds', options.timeoutSeconds);
|
|
28
|
+
this.baseUrl = trimUrl(optionalSetting(options.baseUrl) ?? AyaPayConfig.PRODUCTION_URL);
|
|
30
29
|
}
|
|
31
30
|
/**
|
|
32
|
-
* Reads `AYA_PAY_APP_KEY`, `AYA_PAY_APP_SECRET`, `
|
|
33
|
-
* back to the `AYA_PGW_*` names.
|
|
31
|
+
* Reads `AYA_PAY_APP_KEY`, `AYA_PAY_APP_SECRET`, `MYANMAR_PAYMENTS_HTTP_TIMEOUT` and
|
|
32
|
+
* `AYA_PAY_BASE_URL`, falling back to the `AYA_PGW_*` names.
|
|
34
33
|
*/
|
|
35
34
|
static fromEnv(env = defaultEnv()) {
|
|
36
35
|
return new AyaPayConfig({
|
|
37
36
|
appKey: envFirst(env, 'AYA_PAY_APP_KEY', 'AYA_PGW_APP_KEY'),
|
|
38
37
|
appSecret: envFirst(env, 'AYA_PAY_APP_SECRET', 'AYA_PGW_APP_SECRET'),
|
|
39
|
-
|
|
38
|
+
timeoutSeconds: envFirst(env, HTTP_TIMEOUT_VARIABLE),
|
|
40
39
|
baseUrl: envFirst(env, 'AYA_PAY_BASE_URL', 'AYA_PGW_BASE_URL'),
|
|
41
40
|
});
|
|
42
41
|
}
|
|
@@ -119,7 +118,7 @@ export class AyaPay {
|
|
|
119
118
|
transport;
|
|
120
119
|
constructor(config, options = {}) {
|
|
121
120
|
this.config = config instanceof AyaPayConfig ? config : new AyaPayConfig(config);
|
|
122
|
-
this.transport = new Transport(httpClientFrom(options));
|
|
121
|
+
this.transport = new Transport(httpClientFrom(options, this.config.timeoutSeconds));
|
|
123
122
|
}
|
|
124
123
|
/** A gateway configured from the `AYA_PAY_*` (or `AYA_PGW_*`) environment variables. */
|
|
125
124
|
static fromEnv(env = defaultEnv(), options = {}) {
|
|
@@ -252,6 +251,10 @@ export class AyaPay {
|
|
|
252
251
|
for (const field of PAYLOAD_FIELDS) {
|
|
253
252
|
const key = field === 'currencyCode' && 'currenyCode' in payload ? 'currenyCode' : field;
|
|
254
253
|
if (Object.prototype.hasOwnProperty.call(payload, key)) {
|
|
254
|
+
// A nested value is never signed, so a payload carrying one is rejected.
|
|
255
|
+
if (isNested(payload[key])) {
|
|
256
|
+
throw fail();
|
|
257
|
+
}
|
|
255
258
|
parts.push(scalarString(payload[key]) ?? '');
|
|
256
259
|
}
|
|
257
260
|
}
|
|
@@ -43,9 +43,10 @@ export declare class Amount {
|
|
|
43
43
|
/** Whether the amount is greater than zero. */
|
|
44
44
|
isPositive(): boolean;
|
|
45
45
|
/**
|
|
46
|
-
* Whether both amounts have the same value
|
|
47
|
-
* (`1000`, `
|
|
48
|
-
*
|
|
46
|
+
* Whether both amounts have the same value. Leading zeros of the whole part and trailing zeros of
|
|
47
|
+
* the fraction are ignored (`1000`, `01000` and `1000.00` are equal). Text must be plain digits
|
|
48
|
+
* with an optional fraction, so `1,000` or ` 1000` is never equal, and neither is `null` or
|
|
49
|
+
* `undefined` (a gateway amount that was not sent never matches).
|
|
49
50
|
*/
|
|
50
51
|
equals(other: Amount | string | null | undefined): boolean;
|
|
51
52
|
}
|
package/dist/esm/core/amount.js
CHANGED
|
@@ -85,19 +85,28 @@ export class Amount {
|
|
|
85
85
|
return !this.isZero();
|
|
86
86
|
}
|
|
87
87
|
/**
|
|
88
|
-
* Whether both amounts have the same value
|
|
89
|
-
* (`1000`, `
|
|
90
|
-
*
|
|
88
|
+
* Whether both amounts have the same value. Leading zeros of the whole part and trailing zeros of
|
|
89
|
+
* the fraction are ignored (`1000`, `01000` and `1000.00` are equal). Text must be plain digits
|
|
90
|
+
* with an optional fraction, so `1,000` or ` 1000` is never equal, and neither is `null` or
|
|
91
|
+
* `undefined` (a gateway amount that was not sent never matches).
|
|
91
92
|
*/
|
|
92
93
|
equals(other) {
|
|
93
94
|
if (other === undefined || other === null) {
|
|
94
95
|
return false;
|
|
95
96
|
}
|
|
96
|
-
const normalize = (value) => value.includes('.') ? value.replace(/0+$/, '').replace(/\.$/, '') : value;
|
|
97
97
|
const text = other instanceof Amount ? other.value : other;
|
|
98
|
+
if (typeof text !== 'string' || !PATTERN.test(text)) {
|
|
99
|
+
return false;
|
|
100
|
+
}
|
|
98
101
|
return normalize(this.value) === normalize(text);
|
|
99
102
|
}
|
|
100
103
|
}
|
|
104
|
+
function normalize(value) {
|
|
105
|
+
const [whole = '', fraction = ''] = value.split('.');
|
|
106
|
+
const trimmedWhole = whole.replace(/^0+/, '') || '0';
|
|
107
|
+
const trimmedFraction = fraction.replace(/0+$/, '');
|
|
108
|
+
return trimmedFraction === '' ? trimmedWhole : `${trimmedWhole}.${trimmedFraction}`;
|
|
109
|
+
}
|
|
101
110
|
function invalid(message) {
|
|
102
111
|
return new InvalidPaymentDataError({ amount: message });
|
|
103
112
|
}
|
|
@@ -42,8 +42,10 @@ export interface WebRequestLike {
|
|
|
42
42
|
* {@link CallbackRequest.fromNodeRequest} or {@link CallbackRequest.fromWebRequest}.
|
|
43
43
|
*/
|
|
44
44
|
export declare class CallbackRequest {
|
|
45
|
-
/** The
|
|
45
|
+
/** The request body as text: a string body as given, bytes decoded as UTF-8. */
|
|
46
46
|
readonly body: string;
|
|
47
|
+
/** The exact bytes received. A string body is encoded as UTF-8. */
|
|
48
|
+
readonly rawBody: Uint8Array;
|
|
47
49
|
/** The request headers, with lowercase names. Repeated headers are joined with `, `. */
|
|
48
50
|
readonly headers: Readonly<Record<string, string>>;
|
|
49
51
|
/** The query string parameters (the first value of each). */
|
|
@@ -71,7 +73,10 @@ export declare class CallbackRequest {
|
|
|
71
73
|
static fromWebRequest(request: WebRequestLike): Promise<CallbackRequest>;
|
|
72
74
|
/** The named header, matched case-insensitively, or `undefined`. */
|
|
73
75
|
header(name: string): string | undefined;
|
|
74
|
-
/**
|
|
76
|
+
/**
|
|
77
|
+
* The body decoded as JSON or as a urlencoded form. JSON numbers keep their exact text, as strings
|
|
78
|
+
* (`1000.50` stays `"1000.50"`).
|
|
79
|
+
*/
|
|
75
80
|
parsedBody(): Record<string, unknown>;
|
|
76
81
|
/** The parsed body merged over the query string. */
|
|
77
82
|
input(): Record<string, unknown>;
|
|
@@ -5,14 +5,17 @@ import { parseJsonObject, setKey, toPlainObject } from './json.js';
|
|
|
5
5
|
* {@link CallbackRequest.fromNodeRequest} or {@link CallbackRequest.fromWebRequest}.
|
|
6
6
|
*/
|
|
7
7
|
export class CallbackRequest {
|
|
8
|
-
/** The
|
|
8
|
+
/** The request body as text: a string body as given, bytes decoded as UTF-8. */
|
|
9
9
|
body;
|
|
10
|
+
/** The exact bytes received. A string body is encoded as UTF-8. */
|
|
11
|
+
rawBody;
|
|
10
12
|
/** The request headers, with lowercase names. Repeated headers are joined with `, `. */
|
|
11
13
|
headers;
|
|
12
14
|
/** The query string parameters (the first value of each). */
|
|
13
15
|
query;
|
|
14
16
|
constructor(init = {}) {
|
|
15
|
-
this.
|
|
17
|
+
this.rawBody = bodyBytes(init.body);
|
|
18
|
+
this.body = typeof init.body === 'string' ? init.body : new TextDecoder().decode(this.rawBody);
|
|
16
19
|
this.headers = Object.freeze(normalizeHeaders(init.headers));
|
|
17
20
|
this.query = Object.freeze(normalizeQuery(init.query));
|
|
18
21
|
}
|
|
@@ -68,7 +71,10 @@ export class CallbackRequest {
|
|
|
68
71
|
header(name) {
|
|
69
72
|
return this.headers[name.toLowerCase()];
|
|
70
73
|
}
|
|
71
|
-
/**
|
|
74
|
+
/**
|
|
75
|
+
* The body decoded as JSON or as a urlencoded form. JSON numbers keep their exact text, as strings
|
|
76
|
+
* (`1000.50` stays `"1000.50"`).
|
|
77
|
+
*/
|
|
72
78
|
parsedBody() {
|
|
73
79
|
return toPlainObject(losslessBody(this));
|
|
74
80
|
}
|
|
@@ -207,14 +213,15 @@ export class PaymentStatusResult {
|
|
|
207
213
|
return this.status === 'successful';
|
|
208
214
|
}
|
|
209
215
|
}
|
|
210
|
-
function
|
|
216
|
+
function bodyBytes(body) {
|
|
211
217
|
if (body === undefined || body === null) {
|
|
212
|
-
return
|
|
218
|
+
return new Uint8Array();
|
|
213
219
|
}
|
|
214
220
|
if (typeof body === 'string') {
|
|
215
|
-
return body;
|
|
221
|
+
return new TextEncoder().encode(body);
|
|
216
222
|
}
|
|
217
|
-
|
|
223
|
+
// A copy, so later changes to the caller's buffer cannot alter what was verified.
|
|
224
|
+
return body instanceof ArrayBuffer ? new Uint8Array(body.slice(0)) : Uint8Array.from(body);
|
|
218
225
|
}
|
|
219
226
|
function rawBody(value) {
|
|
220
227
|
if (typeof value === 'string' || value instanceof Uint8Array || value instanceof ArrayBuffer) {
|
|
@@ -15,5 +15,10 @@ export declare function randomHex(bytes?: number): string;
|
|
|
15
15
|
* @internal
|
|
16
16
|
*/
|
|
17
17
|
export declare function queryEscape(value: string): string;
|
|
18
|
-
/**
|
|
18
|
+
/**
|
|
19
|
+
* Decodes standard base64 (`A-Z a-z 0-9 + /`), either correctly padded or without any padding, to
|
|
20
|
+
* UTF-8 text. Partial padding, other characters and bytes that are not UTF-8 return `undefined`.
|
|
21
|
+
*
|
|
22
|
+
* @internal
|
|
23
|
+
*/
|
|
19
24
|
export declare function decodeBase64(value: string): string | undefined;
|
package/dist/esm/core/crypto.js
CHANGED
|
@@ -32,10 +32,24 @@ export function queryEscape(value) {
|
|
|
32
32
|
.replace(/[!'()*]/g, (char) => `%${char.charCodeAt(0).toString(16).toUpperCase()}`)
|
|
33
33
|
.replace(/%20/g, '+');
|
|
34
34
|
}
|
|
35
|
-
|
|
35
|
+
const UTF8 = new TextDecoder('utf-8', { fatal: true });
|
|
36
|
+
/**
|
|
37
|
+
* Decodes standard base64 (`A-Z a-z 0-9 + /`), either correctly padded or without any padding, to
|
|
38
|
+
* UTF-8 text. Partial padding, other characters and bytes that are not UTF-8 return `undefined`.
|
|
39
|
+
*
|
|
40
|
+
* @internal
|
|
41
|
+
*/
|
|
36
42
|
export function decodeBase64(value) {
|
|
37
|
-
if (
|
|
43
|
+
if (!/^[A-Za-z0-9+/]+={0,2}$/.test(value)) {
|
|
44
|
+
return undefined;
|
|
45
|
+
}
|
|
46
|
+
if (value.includes('=') ? value.length % 4 !== 0 : value.length % 4 === 1) {
|
|
47
|
+
return undefined;
|
|
48
|
+
}
|
|
49
|
+
try {
|
|
50
|
+
return UTF8.decode(Buffer.from(value, 'base64'));
|
|
51
|
+
}
|
|
52
|
+
catch {
|
|
38
53
|
return undefined;
|
|
39
54
|
}
|
|
40
|
-
return Buffer.from(value, 'base64').toString('utf8');
|
|
41
55
|
}
|
package/dist/esm/core/env.d.ts
CHANGED
|
@@ -3,14 +3,14 @@ export type EnvSource = Readonly<Record<string, string | undefined>>;
|
|
|
3
3
|
/** The first non-empty value among `keys`, trimmed, or `''`. @internal */
|
|
4
4
|
export declare function envFirst(env: EnvSource, ...keys: string[]): string;
|
|
5
5
|
/**
|
|
6
|
-
*
|
|
7
|
-
*
|
|
6
|
+
* A required whole number of seconds: an integer greater than 0, or text such as `'300'`. Unset
|
|
7
|
+
* or blank throws the missing {@link ConfigurationError}; anything else throws the invalid one.
|
|
8
8
|
*
|
|
9
9
|
* @internal
|
|
10
10
|
*/
|
|
11
|
-
export declare function
|
|
12
|
-
/**
|
|
13
|
-
export declare
|
|
11
|
+
export declare function requireSeconds(gateway: string, key: string, value: unknown): number;
|
|
12
|
+
/** The variable holding the HTTP timeout of every gateway that calls an API. @internal */
|
|
13
|
+
export declare const HTTP_TIMEOUT_VARIABLE = "MYANMAR_PAYMENTS_HTTP_TIMEOUT";
|
|
14
14
|
/** The trimmed value, or throws a {@link ConfigurationError} naming `key`. @internal */
|
|
15
15
|
export declare function requireSetting(gateway: string, key: string, value: unknown): string;
|
|
16
16
|
/** A trimmed optional string, `undefined` when blank. @internal */
|
package/dist/esm/core/env.js
CHANGED
|
@@ -10,20 +10,29 @@ export function envFirst(env, ...keys) {
|
|
|
10
10
|
return '';
|
|
11
11
|
}
|
|
12
12
|
/**
|
|
13
|
-
*
|
|
14
|
-
*
|
|
13
|
+
* A required whole number of seconds: an integer greater than 0, or text such as `'300'`. Unset
|
|
14
|
+
* or blank throws the missing {@link ConfigurationError}; anything else throws the invalid one.
|
|
15
15
|
*
|
|
16
16
|
* @internal
|
|
17
17
|
*/
|
|
18
|
-
export function
|
|
19
|
-
|
|
20
|
-
|
|
21
|
-
}
|
|
22
|
-
|
|
23
|
-
|
|
24
|
-
|
|
25
|
-
|
|
18
|
+
export function requireSeconds(gateway, key, value) {
|
|
19
|
+
if (value === undefined || value === null || (typeof value === 'string' && value.trim() === '')) {
|
|
20
|
+
throw new ConfigurationError(gateway, key);
|
|
21
|
+
}
|
|
22
|
+
let seconds;
|
|
23
|
+
if (typeof value === 'number' && Number.isSafeInteger(value)) {
|
|
24
|
+
seconds = value;
|
|
25
|
+
}
|
|
26
|
+
else if (typeof value === 'string' && /^[+-]?\d+$/.test(value.trim())) {
|
|
27
|
+
seconds = Number.parseInt(value.trim(), 10);
|
|
28
|
+
}
|
|
29
|
+
if (seconds === undefined || !Number.isSafeInteger(seconds) || seconds <= 0) {
|
|
30
|
+
throw new ConfigurationError(gateway, key, true);
|
|
31
|
+
}
|
|
32
|
+
return seconds;
|
|
26
33
|
}
|
|
34
|
+
/** The variable holding the HTTP timeout of every gateway that calls an API. @internal */
|
|
35
|
+
export const HTTP_TIMEOUT_VARIABLE = 'MYANMAR_PAYMENTS_HTTP_TIMEOUT';
|
|
27
36
|
/** The trimmed value, or throws a {@link ConfigurationError} naming `key`. @internal */
|
|
28
37
|
export function requireSetting(gateway, key, value) {
|
|
29
38
|
if (typeof value !== 'string' || value.trim() === '') {
|
|
@@ -45,12 +45,17 @@ export declare class SignatureVerificationError extends PaymentError {
|
|
|
45
45
|
constructor(message: string, raw?: Record<string, unknown>);
|
|
46
46
|
}
|
|
47
47
|
/**
|
|
48
|
-
* Thrown when a gateway is missing a credential or setting it needs
|
|
48
|
+
* Thrown when a gateway is missing a credential or setting it needs, or a whole-number setting
|
|
49
|
+
* is not a whole number greater than 0.
|
|
49
50
|
*/
|
|
50
51
|
export declare class ConfigurationError extends PaymentError {
|
|
51
52
|
/** The gateway, e.g. `kbz_pay`. */
|
|
52
53
|
readonly gateway: string;
|
|
53
|
-
/** The missing setting, e.g. `app_key`. */
|
|
54
|
+
/** The missing or invalid setting, e.g. `app_key`. */
|
|
54
55
|
readonly key: string;
|
|
55
|
-
|
|
56
|
+
/**
|
|
57
|
+
* @param invalid `true` when the setting is set but is not a whole number greater than 0;
|
|
58
|
+
* `false` (the default) when it is missing.
|
|
59
|
+
*/
|
|
60
|
+
constructor(gateway: string, key: string, invalid?: boolean);
|
|
56
61
|
}
|
package/dist/esm/core/errors.js
CHANGED
|
@@ -55,15 +55,22 @@ export class SignatureVerificationError extends PaymentError {
|
|
|
55
55
|
}
|
|
56
56
|
}
|
|
57
57
|
/**
|
|
58
|
-
* Thrown when a gateway is missing a credential or setting it needs
|
|
58
|
+
* Thrown when a gateway is missing a credential or setting it needs, or a whole-number setting
|
|
59
|
+
* is not a whole number greater than 0.
|
|
59
60
|
*/
|
|
60
61
|
export class ConfigurationError extends PaymentError {
|
|
61
62
|
/** The gateway, e.g. `kbz_pay`. */
|
|
62
63
|
gateway;
|
|
63
|
-
/** The missing setting, e.g. `app_key`. */
|
|
64
|
+
/** The missing or invalid setting, e.g. `app_key`. */
|
|
64
65
|
key;
|
|
65
|
-
|
|
66
|
-
|
|
66
|
+
/**
|
|
67
|
+
* @param invalid `true` when the setting is set but is not a whole number greater than 0;
|
|
68
|
+
* `false` (the default) when it is missing.
|
|
69
|
+
*/
|
|
70
|
+
constructor(gateway, key, invalid = false) {
|
|
71
|
+
super(invalid
|
|
72
|
+
? `The ${gateway} configuration [${key}] must be a whole number greater than 0.`
|
|
73
|
+
: `The ${gateway} configuration is missing [${key}].`);
|
|
67
74
|
this.gateway = gateway;
|
|
68
75
|
this.key = key;
|
|
69
76
|
}
|
package/dist/esm/core/http.d.ts
CHANGED
|
@@ -27,29 +27,28 @@ export type FetchFunction = (input: string, init: RequestInit) => Promise<Respon
|
|
|
27
27
|
export interface FetchHttpClientOptions {
|
|
28
28
|
/** The `fetch` to call; defaults to the global `fetch`. */
|
|
29
29
|
fetch?: FetchFunction | undefined;
|
|
30
|
-
/** Milliseconds before a request is aborted
|
|
31
|
-
timeoutMs
|
|
30
|
+
/** Milliseconds before a request is aborted. `0` disables the timeout. */
|
|
31
|
+
timeoutMs: number;
|
|
32
32
|
}
|
|
33
|
-
/** The default request timeout: 30 seconds. */
|
|
34
|
-
export declare const DEFAULT_TIMEOUT_MS = 30000;
|
|
35
33
|
/**
|
|
36
|
-
* The default {@link HttpClient}: the global `fetch` (or the one you pass) with
|
|
37
|
-
*
|
|
34
|
+
* The default {@link HttpClient}: the global `fetch` (or the one you pass) with the timeout you
|
|
35
|
+
* give it. Gateways build one with their `timeoutSeconds` setting when you pass no client.
|
|
38
36
|
*/
|
|
39
37
|
export declare class FetchHttpClient implements HttpClient {
|
|
40
38
|
private readonly fetchFunction;
|
|
41
39
|
private readonly timeoutMs;
|
|
42
|
-
constructor(options
|
|
40
|
+
constructor(options: FetchHttpClientOptions);
|
|
43
41
|
send(request: HttpRequest): Promise<HttpResponse>;
|
|
44
42
|
}
|
|
45
43
|
/** Options every gateway that calls an API accepts. */
|
|
46
44
|
export interface GatewayOptions {
|
|
47
|
-
/**
|
|
45
|
+
/**
|
|
46
|
+
* Sends the requests, with its own timeout. Takes precedence over `fetch`. Without one, the
|
|
47
|
+
* gateway uses a {@link FetchHttpClient} with the config's `timeoutSeconds`.
|
|
48
|
+
*/
|
|
48
49
|
httpClient?: HttpClient | undefined;
|
|
49
50
|
/** The `fetch` the default client calls, e.g. a mocked one in tests. */
|
|
50
51
|
fetch?: FetchFunction | undefined;
|
|
51
|
-
/** Milliseconds before the default client aborts a request; defaults to 30000. */
|
|
52
|
-
timeoutMs?: number | undefined;
|
|
53
52
|
}
|
|
54
53
|
/** Per-call options of every network method. */
|
|
55
54
|
export interface RequestOptions {
|
|
@@ -57,7 +56,7 @@ export interface RequestOptions {
|
|
|
57
56
|
signal?: AbortSignal | undefined;
|
|
58
57
|
}
|
|
59
58
|
/** @internal */
|
|
60
|
-
export declare function httpClientFrom(options
|
|
59
|
+
export declare function httpClientFrom(options: GatewayOptions, timeoutSeconds: number): HttpClient;
|
|
61
60
|
/** A decoded gateway response. @internal */
|
|
62
61
|
export declare class GatewayResponse {
|
|
63
62
|
readonly status: number;
|
package/dist/esm/core/http.js
CHANGED
|
@@ -1,17 +1,15 @@
|
|
|
1
1
|
import { ApiError, PaymentError } from './errors.js';
|
|
2
2
|
import { parseJsonObject } from './json.js';
|
|
3
|
-
/** The default request timeout: 30 seconds. */
|
|
4
|
-
export const DEFAULT_TIMEOUT_MS = 30_000;
|
|
5
3
|
/**
|
|
6
|
-
* The default {@link HttpClient}: the global `fetch` (or the one you pass) with
|
|
7
|
-
*
|
|
4
|
+
* The default {@link HttpClient}: the global `fetch` (or the one you pass) with the timeout you
|
|
5
|
+
* give it. Gateways build one with their `timeoutSeconds` setting when you pass no client.
|
|
8
6
|
*/
|
|
9
7
|
export class FetchHttpClient {
|
|
10
8
|
fetchFunction;
|
|
11
9
|
timeoutMs;
|
|
12
|
-
constructor(options
|
|
10
|
+
constructor(options) {
|
|
13
11
|
this.fetchFunction = options.fetch;
|
|
14
|
-
this.timeoutMs = options.timeoutMs
|
|
12
|
+
this.timeoutMs = options.timeoutMs;
|
|
15
13
|
}
|
|
16
14
|
async send(request) {
|
|
17
15
|
const fetchFunction = this.fetchFunction ?? globalThis.fetch;
|
|
@@ -38,9 +36,9 @@ export class FetchHttpClient {
|
|
|
38
36
|
}
|
|
39
37
|
}
|
|
40
38
|
/** @internal */
|
|
41
|
-
export function httpClientFrom(options
|
|
39
|
+
export function httpClientFrom(options, timeoutSeconds) {
|
|
42
40
|
return (options.httpClient ??
|
|
43
|
-
new FetchHttpClient({ fetch: options.fetch, timeoutMs:
|
|
41
|
+
new FetchHttpClient({ fetch: options.fetch, timeoutMs: timeoutSeconds * 1000 }));
|
|
44
42
|
}
|
|
45
43
|
/** A decoded gateway response. @internal */
|
|
46
44
|
export class GatewayResponse {
|
package/dist/esm/core/index.d.ts
CHANGED
|
@@ -3,6 +3,6 @@ export { MemoryTokenCache, type TokenCache } from './cache.js';
|
|
|
3
3
|
export { Acknowledgement, CallbackRequest, PaymentCallback, PaymentStatusResult, type AcknowledgementInit, type BodyInput, type CallbackRequestInit, type HeadersInput, type NodeRequestLike, type PaymentCallbackInit, type PaymentStatusResultInit, type QueryInput, type ServerResponseLike, type WebRequestLike, } from './callback.js';
|
|
4
4
|
export type { EnvSource } from './env.js';
|
|
5
5
|
export { ApiError, ConfigurationError, InvalidPaymentDataError, PaymentError, SignatureVerificationError, } from './errors.js';
|
|
6
|
-
export {
|
|
6
|
+
export { FetchHttpClient, type FetchFunction, type FetchHttpClientOptions, type GatewayOptions, type HttpClient, type HttpRequest, type HttpResponse, type RequestOptions, } from './http.js';
|
|
7
7
|
export { AppPayment, FormPayment, QrPayment, RedirectPayment, type FormField, type PaymentResult, } from './results.js';
|
|
8
8
|
export { PaymentFlow, PaymentStatus, resolveStatus } from './status.js';
|
package/dist/esm/core/index.js
CHANGED
|
@@ -2,6 +2,6 @@ export { Amount } from './amount.js';
|
|
|
2
2
|
export { MemoryTokenCache } from './cache.js';
|
|
3
3
|
export { Acknowledgement, CallbackRequest, PaymentCallback, PaymentStatusResult, } from './callback.js';
|
|
4
4
|
export { ApiError, ConfigurationError, InvalidPaymentDataError, PaymentError, SignatureVerificationError, } from './errors.js';
|
|
5
|
-
export {
|
|
5
|
+
export { FetchHttpClient, } from './http.js';
|
|
6
6
|
export { AppPayment, FormPayment, QrPayment, RedirectPayment, } from './results.js';
|
|
7
7
|
export { PaymentFlow, PaymentStatus, resolveStatus } from './status.js';
|
package/dist/esm/core/json.d.ts
CHANGED
|
@@ -32,8 +32,8 @@ export declare function parseJsonObject(text: string): LosslessObject | undefine
|
|
|
32
32
|
/** @internal */
|
|
33
33
|
export declare function isLosslessObject(value: unknown): value is LosslessObject;
|
|
34
34
|
/**
|
|
35
|
-
* Converts a lossless value to plain JavaScript values
|
|
36
|
-
*
|
|
35
|
+
* Converts a lossless value to plain JavaScript values for the `raw` fields of results. Numbers
|
|
36
|
+
* become their exact text as a string (`1000.50` stays `"1000.50"`), so no precision is lost.
|
|
37
37
|
*
|
|
38
38
|
* @internal
|
|
39
39
|
*/
|
package/dist/esm/core/json.js
CHANGED
|
@@ -46,14 +46,14 @@ export function isLosslessObject(value) {
|
|
|
46
46
|
!(value instanceof JsonNumber));
|
|
47
47
|
}
|
|
48
48
|
/**
|
|
49
|
-
* Converts a lossless value to plain JavaScript values
|
|
50
|
-
*
|
|
49
|
+
* Converts a lossless value to plain JavaScript values for the `raw` fields of results. Numbers
|
|
50
|
+
* become their exact text as a string (`1000.50` stays `"1000.50"`), so no precision is lost.
|
|
51
51
|
*
|
|
52
52
|
* @internal
|
|
53
53
|
*/
|
|
54
54
|
export function toPlain(value) {
|
|
55
55
|
if (value instanceof JsonNumber) {
|
|
56
|
-
return
|
|
56
|
+
return value.text;
|
|
57
57
|
}
|
|
58
58
|
if (Array.isArray(value)) {
|
|
59
59
|
return value.map(toPlain);
|
|
@@ -14,3 +14,5 @@ export declare function optional(source: Record<string, unknown>, key: string):
|
|
|
14
14
|
export declare function trimmed(source: Record<string, unknown>, key: string): string;
|
|
15
15
|
/** The value at `key` when it is an object (not an array). @internal */
|
|
16
16
|
export declare function object(source: Record<string, unknown>, key: string): LosslessObject | undefined;
|
|
17
|
+
/** Whether `value` is an object or array, which a gateway never signs. @internal */
|
|
18
|
+
export declare function isNested(value: unknown): boolean;
|
package/dist/esm/core/values.js
CHANGED
|
@@ -36,3 +36,7 @@ export function object(source, key) {
|
|
|
36
36
|
const value = source[key];
|
|
37
37
|
return isLosslessObject(value) ? value : undefined;
|
|
38
38
|
}
|
|
39
|
+
/** Whether `value` is an object or array, which a gateway never signs. @internal */
|
|
40
|
+
export function isNested(value) {
|
|
41
|
+
return typeof value === 'object' && value !== null && !(value instanceof JsonNumber);
|
|
42
|
+
}
|
|
@@ -10,27 +10,24 @@ export interface CyberSourceConfigOptions {
|
|
|
10
10
|
accessKey: string;
|
|
11
11
|
/** The profile's secret key, which signs the fields. */
|
|
12
12
|
secretKey: string;
|
|
13
|
-
/**
|
|
14
|
-
sandbox?: boolean | undefined;
|
|
15
|
-
/** Overrides the Secure Acceptance base URL. */
|
|
13
|
+
/** Overrides the Secure Acceptance base URL, e.g. to point at the test environment. */
|
|
16
14
|
baseUrl?: string | undefined;
|
|
17
15
|
}
|
|
18
16
|
/**
|
|
19
|
-
* A CyberSource Secure Acceptance profile. A missing credential throws a `ConfigurationError`.
|
|
17
|
+
* A CyberSource Secure Acceptance profile. A missing credential throws a `ConfigurationError`. The
|
|
18
|
+
* URL defaults to production.
|
|
20
19
|
*/
|
|
21
20
|
export declare class CyberSourceConfig {
|
|
22
|
-
static readonly SANDBOX_URL = "https://testsecureacceptance.cybersource.com";
|
|
23
21
|
static readonly PRODUCTION_URL = "https://secureacceptance.cybersource.com";
|
|
24
22
|
readonly profileId: string;
|
|
25
23
|
readonly accessKey: string;
|
|
26
24
|
readonly secretKey: string;
|
|
27
|
-
readonly sandbox: boolean;
|
|
28
25
|
/** The base URL in use. */
|
|
29
26
|
readonly baseUrl: string;
|
|
30
27
|
constructor(options: CyberSourceConfigOptions);
|
|
31
28
|
/**
|
|
32
29
|
* Reads `CYBER_SOURCE_PROFILE_ID`, `CYBER_SOURCE_ACCESS_KEY`, `CYBER_SOURCE_SECRET_KEY`,
|
|
33
|
-
*
|
|
30
|
+
* and `CYBER_SOURCE_BASE_URL`.
|
|
34
31
|
*/
|
|
35
32
|
static fromEnv(env?: EnvSource): CyberSourceConfig;
|
|
36
33
|
}
|
|
@@ -61,12 +58,12 @@ export interface CyberSourcePaymentData {
|
|
|
61
58
|
returnUrl?: string | undefined;
|
|
62
59
|
/** The page shown on cancel (`override_custom_cancel_page`), at most 255 characters. */
|
|
63
60
|
cancelUrl?: string | undefined;
|
|
64
|
-
/** An ISO 4217 code
|
|
65
|
-
currency
|
|
66
|
-
/** What to do with the card
|
|
67
|
-
transactionType
|
|
68
|
-
/** The hosted page language, e.g. `en-us
|
|
69
|
-
locale
|
|
61
|
+
/** An ISO 4217 code, e.g. `MMK`. */
|
|
62
|
+
currency: string;
|
|
63
|
+
/** What to do with the card, e.g. `sale`. */
|
|
64
|
+
transactionType: CyberSourceTransactionType;
|
|
65
|
+
/** The hosted page language, e.g. `en-us`. */
|
|
66
|
+
locale: string;
|
|
70
67
|
}
|
|
71
68
|
/**
|
|
72
69
|
* CyberSource Secure Acceptance hosted checkout for card payments: signs the form and verifies the
|