@workos-inc/node 7.4.0 → 7.5.0-beta.node-compatibility
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 +4 -0
- package/lib/common/crypto/CryptoProvider.d.ts +32 -0
- package/lib/common/crypto/CryptoProvider.js +13 -0
- package/lib/common/crypto/NodeCryptoProvider.d.ts +12 -0
- package/lib/common/crypto/NodeCryptoProvider.js +73 -0
- package/lib/common/crypto/SubtleCryptoProvider.d.ts +15 -0
- package/lib/common/crypto/SubtleCryptoProvider.js +75 -0
- package/lib/common/crypto/index.d.ts +3 -0
- package/lib/common/crypto/index.js +19 -0
- package/lib/common/interfaces/event.interface.d.ts +1 -1
- package/lib/common/interfaces/http-client.interface.d.ts +20 -0
- package/lib/common/interfaces/index.d.ts +1 -0
- package/lib/common/interfaces/index.js +1 -0
- package/lib/common/interfaces/workos-options.interface.d.ts +1 -0
- package/lib/common/net/fetch-client.d.ts +22 -0
- package/lib/common/net/fetch-client.js +112 -0
- package/lib/common/net/http-client.d.ts +39 -0
- package/lib/common/net/http-client.js +76 -0
- package/lib/common/net/index.d.ts +5 -0
- package/lib/common/net/index.js +31 -0
- package/lib/common/net/node-client.d.ts +23 -0
- package/lib/common/net/node-client.js +155 -0
- package/lib/directory-sync/directory-sync.spec.js +61 -0
- package/lib/directory-sync/interfaces/directory-user.interface.d.ts +3 -0
- package/lib/directory-sync/serializers/directory-user.serializer.js +2 -0
- package/lib/events/events.spec.js +88 -0
- package/lib/roles/interfaces/index.d.ts +1 -0
- package/lib/roles/interfaces/index.js +17 -0
- package/lib/roles/interfaces/role.interface.js +2 -0
- package/lib/user-management/fixtures/deactivate-organization-membership.json +12 -0
- package/lib/user-management/interfaces/index.d.ts +0 -2
- package/lib/user-management/interfaces/index.js +0 -2
- package/lib/user-management/interfaces/list-organization-memberships-options.interface.d.ts +3 -0
- package/lib/user-management/interfaces/organization-membership.interface.d.ts +4 -3
- package/lib/user-management/serializers/list-organization-memberships-options.serializer.js +12 -8
- package/lib/user-management/serializers/role.serializer.d.ts +1 -1
- package/lib/user-management/user-management.d.ts +2 -0
- package/lib/user-management/user-management.js +12 -0
- package/lib/user-management/user-management.spec.js +40 -5
- package/lib/webhooks/webhooks.d.ts +2 -2
- package/lib/webhooks/webhooks.js +11 -37
- package/lib/webhooks/webhooks.spec.js +29 -0
- package/lib/workos.d.ts +1 -1
- package/lib/workos.js +18 -12
- package/lib/workos.spec.js +56 -3
- package/package.json +2 -3
- package/lib/common/utils/fetch-client.d.ts +0 -31
- package/lib/common/utils/fetch-client.js +0 -108
- /package/lib/{user-management/interfaces/role.interface.js → common/interfaces/http-client.interface.js} +0 -0
- /package/lib/{user-management → roles}/interfaces/role.interface.d.ts +0 -0
package/README.md
CHANGED
|
@@ -9,6 +9,10 @@ The WorkOS library for Node.js provides convenient access to the WorkOS API from
|
|
|
9
9
|
|
|
10
10
|
See the [API Reference](https://workos.com/docs/reference/client-libraries) for Node.js usage examples.
|
|
11
11
|
|
|
12
|
+
## Requirements
|
|
13
|
+
|
|
14
|
+
Node 16 or higher.
|
|
15
|
+
|
|
12
16
|
## Installation
|
|
13
17
|
|
|
14
18
|
Install the package with:
|
|
@@ -0,0 +1,32 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Interface encapsulating the various crypto computations used by the library,
|
|
3
|
+
* allowing pluggable underlying crypto implementations.
|
|
4
|
+
*/
|
|
5
|
+
export declare abstract class CryptoProvider {
|
|
6
|
+
encoder: TextEncoder;
|
|
7
|
+
/**
|
|
8
|
+
* Computes a SHA-256 HMAC given a secret and a payload (encoded in UTF-8).
|
|
9
|
+
* The output HMAC should be encoded in hexadecimal.
|
|
10
|
+
*
|
|
11
|
+
* Sample values for implementations:
|
|
12
|
+
* - computeHMACSignature('', 'test_secret') => 'f7f9bd47fb987337b5796fdc1fdb9ba221d0d5396814bfcaf9521f43fd8927fd'
|
|
13
|
+
* - computeHMACSignature('\ud83d\ude00', 'test_secret') => '837da296d05c4fe31f61d5d7ead035099d9585a5bcde87de952012a78f0b0c43
|
|
14
|
+
*/
|
|
15
|
+
abstract computeHMACSignature(payload: string, secret: string): string;
|
|
16
|
+
/**
|
|
17
|
+
* Asynchronous version of `computeHMACSignature`. Some implementations may
|
|
18
|
+
* only allow support async signature computation.
|
|
19
|
+
*
|
|
20
|
+
* Computes a SHA-256 HMAC given a secret and a payload (encoded in UTF-8).
|
|
21
|
+
* The output HMAC should be encoded in hexadecimal.
|
|
22
|
+
*
|
|
23
|
+
* Sample values for implementations:
|
|
24
|
+
* - computeHMACSignature('', 'test_secret') => 'f7f9bd47fb987337b5796fdc1fdb9ba221d0d5396814bfcaf9521f43fd8927fd'
|
|
25
|
+
* - computeHMACSignature('\ud83d\ude00', 'test_secret') => '837da296d05c4fe31f61d5d7ead035099d9585a5bcde87de952012a78f0b0c43
|
|
26
|
+
*/
|
|
27
|
+
abstract computeHMACSignatureAsync(payload: string, secret: string): Promise<string>;
|
|
28
|
+
/**
|
|
29
|
+
* Cryptographically determine whether two signatures are equal
|
|
30
|
+
*/
|
|
31
|
+
abstract secureCompare(stringA: string, stringB: string): Promise<boolean>;
|
|
32
|
+
}
|
|
@@ -0,0 +1,13 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
+
exports.CryptoProvider = void 0;
|
|
4
|
+
/**
|
|
5
|
+
* Interface encapsulating the various crypto computations used by the library,
|
|
6
|
+
* allowing pluggable underlying crypto implementations.
|
|
7
|
+
*/
|
|
8
|
+
class CryptoProvider {
|
|
9
|
+
constructor() {
|
|
10
|
+
this.encoder = new TextEncoder();
|
|
11
|
+
}
|
|
12
|
+
}
|
|
13
|
+
exports.CryptoProvider = CryptoProvider;
|
|
@@ -0,0 +1,12 @@
|
|
|
1
|
+
import { CryptoProvider } from './CryptoProvider';
|
|
2
|
+
/**
|
|
3
|
+
* `CryptoProvider which uses the Node `crypto` package for its computations.
|
|
4
|
+
*/
|
|
5
|
+
export declare class NodeCryptoProvider extends CryptoProvider {
|
|
6
|
+
/** @override */
|
|
7
|
+
computeHMACSignature(payload: string, secret: string): string;
|
|
8
|
+
/** @override */
|
|
9
|
+
computeHMACSignatureAsync(payload: string, secret: string): Promise<string>;
|
|
10
|
+
/** @override */
|
|
11
|
+
secureCompare(stringA: string, stringB: string): Promise<boolean>;
|
|
12
|
+
}
|
|
@@ -0,0 +1,73 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
|
|
3
|
+
if (k2 === undefined) k2 = k;
|
|
4
|
+
var desc = Object.getOwnPropertyDescriptor(m, k);
|
|
5
|
+
if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
|
|
6
|
+
desc = { enumerable: true, get: function() { return m[k]; } };
|
|
7
|
+
}
|
|
8
|
+
Object.defineProperty(o, k2, desc);
|
|
9
|
+
}) : (function(o, m, k, k2) {
|
|
10
|
+
if (k2 === undefined) k2 = k;
|
|
11
|
+
o[k2] = m[k];
|
|
12
|
+
}));
|
|
13
|
+
var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
|
|
14
|
+
Object.defineProperty(o, "default", { enumerable: true, value: v });
|
|
15
|
+
}) : function(o, v) {
|
|
16
|
+
o["default"] = v;
|
|
17
|
+
});
|
|
18
|
+
var __importStar = (this && this.__importStar) || function (mod) {
|
|
19
|
+
if (mod && mod.__esModule) return mod;
|
|
20
|
+
var result = {};
|
|
21
|
+
if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
|
|
22
|
+
__setModuleDefault(result, mod);
|
|
23
|
+
return result;
|
|
24
|
+
};
|
|
25
|
+
var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
|
|
26
|
+
function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
|
|
27
|
+
return new (P || (P = Promise))(function (resolve, reject) {
|
|
28
|
+
function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
|
|
29
|
+
function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
|
|
30
|
+
function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
|
|
31
|
+
step((generator = generator.apply(thisArg, _arguments || [])).next());
|
|
32
|
+
});
|
|
33
|
+
};
|
|
34
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
35
|
+
exports.NodeCryptoProvider = void 0;
|
|
36
|
+
const crypto = __importStar(require("crypto"));
|
|
37
|
+
const CryptoProvider_1 = require("./CryptoProvider");
|
|
38
|
+
/**
|
|
39
|
+
* `CryptoProvider which uses the Node `crypto` package for its computations.
|
|
40
|
+
*/
|
|
41
|
+
class NodeCryptoProvider extends CryptoProvider_1.CryptoProvider {
|
|
42
|
+
/** @override */
|
|
43
|
+
computeHMACSignature(payload, secret) {
|
|
44
|
+
return crypto
|
|
45
|
+
.createHmac('sha256', secret)
|
|
46
|
+
.update(payload, 'utf8')
|
|
47
|
+
.digest('hex');
|
|
48
|
+
}
|
|
49
|
+
/** @override */
|
|
50
|
+
computeHMACSignatureAsync(payload, secret) {
|
|
51
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
52
|
+
const signature = yield this.computeHMACSignature(payload, secret);
|
|
53
|
+
return signature;
|
|
54
|
+
});
|
|
55
|
+
}
|
|
56
|
+
/** @override */
|
|
57
|
+
secureCompare(stringA, stringB) {
|
|
58
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
59
|
+
const bufferA = this.encoder.encode(stringA);
|
|
60
|
+
const bufferB = this.encoder.encode(stringB);
|
|
61
|
+
if (bufferA.length !== bufferB.length) {
|
|
62
|
+
return false;
|
|
63
|
+
}
|
|
64
|
+
// Generate a random key for HMAC
|
|
65
|
+
const key = crypto.randomBytes(32); // Generates a 256-bit key
|
|
66
|
+
const hmacA = crypto.createHmac('sha256', key).update(bufferA).digest();
|
|
67
|
+
const hmacB = crypto.createHmac('sha256', key).update(bufferB).digest();
|
|
68
|
+
// Perform a constant time comparison
|
|
69
|
+
return crypto.timingSafeEqual(hmacA, hmacB);
|
|
70
|
+
});
|
|
71
|
+
}
|
|
72
|
+
}
|
|
73
|
+
exports.NodeCryptoProvider = NodeCryptoProvider;
|
|
@@ -0,0 +1,15 @@
|
|
|
1
|
+
import { CryptoProvider } from './CryptoProvider';
|
|
2
|
+
/**
|
|
3
|
+
* `CryptoProvider which uses the SubtleCrypto interface of the Web Crypto API.
|
|
4
|
+
*
|
|
5
|
+
* This only supports asynchronous operations.
|
|
6
|
+
*/
|
|
7
|
+
export declare class SubtleCryptoProvider extends CryptoProvider {
|
|
8
|
+
subtleCrypto: SubtleCrypto;
|
|
9
|
+
constructor(subtleCrypto?: SubtleCrypto);
|
|
10
|
+
computeHMACSignature(_payload: string, _secret: string): string;
|
|
11
|
+
/** @override */
|
|
12
|
+
computeHMACSignatureAsync(payload: string, secret: string): Promise<string>;
|
|
13
|
+
/** @override */
|
|
14
|
+
secureCompare(stringA: string, stringB: string): Promise<boolean>;
|
|
15
|
+
}
|
|
@@ -0,0 +1,75 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
|
|
3
|
+
function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
|
|
4
|
+
return new (P || (P = Promise))(function (resolve, reject) {
|
|
5
|
+
function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
|
|
6
|
+
function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
|
|
7
|
+
function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
|
|
8
|
+
step((generator = generator.apply(thisArg, _arguments || [])).next());
|
|
9
|
+
});
|
|
10
|
+
};
|
|
11
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
12
|
+
exports.SubtleCryptoProvider = void 0;
|
|
13
|
+
const CryptoProvider_1 = require("./CryptoProvider");
|
|
14
|
+
/**
|
|
15
|
+
* `CryptoProvider which uses the SubtleCrypto interface of the Web Crypto API.
|
|
16
|
+
*
|
|
17
|
+
* This only supports asynchronous operations.
|
|
18
|
+
*/
|
|
19
|
+
class SubtleCryptoProvider extends CryptoProvider_1.CryptoProvider {
|
|
20
|
+
constructor(subtleCrypto) {
|
|
21
|
+
super();
|
|
22
|
+
// If no subtle crypto is interface, default to the global namespace. This
|
|
23
|
+
// is to allow custom interfaces (eg. using the Node webcrypto interface in
|
|
24
|
+
// tests).
|
|
25
|
+
this.subtleCrypto = subtleCrypto || crypto.subtle;
|
|
26
|
+
}
|
|
27
|
+
computeHMACSignature(_payload, _secret) {
|
|
28
|
+
throw new Error('SubleCryptoProvider cannot be used in a synchronous context.');
|
|
29
|
+
}
|
|
30
|
+
/** @override */
|
|
31
|
+
computeHMACSignatureAsync(payload, secret) {
|
|
32
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
33
|
+
const encoder = new TextEncoder();
|
|
34
|
+
const key = yield this.subtleCrypto.importKey('raw', encoder.encode(secret), {
|
|
35
|
+
name: 'HMAC',
|
|
36
|
+
hash: { name: 'SHA-256' },
|
|
37
|
+
}, false, ['sign']);
|
|
38
|
+
const signatureBuffer = yield this.subtleCrypto.sign('hmac', key, encoder.encode(payload));
|
|
39
|
+
// crypto.subtle returns the signature in base64 format. This must be
|
|
40
|
+
// encoded in hex to match the CryptoProvider contract. We map each byte in
|
|
41
|
+
// the buffer to its corresponding hex octet and then combine into a string.
|
|
42
|
+
const signatureBytes = new Uint8Array(signatureBuffer);
|
|
43
|
+
const signatureHexCodes = new Array(signatureBytes.length);
|
|
44
|
+
for (let i = 0; i < signatureBytes.length; i++) {
|
|
45
|
+
signatureHexCodes[i] = byteHexMapping[signatureBytes[i]];
|
|
46
|
+
}
|
|
47
|
+
return signatureHexCodes.join('');
|
|
48
|
+
});
|
|
49
|
+
}
|
|
50
|
+
/** @override */
|
|
51
|
+
secureCompare(stringA, stringB) {
|
|
52
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
53
|
+
const bufferA = this.encoder.encode(stringA);
|
|
54
|
+
const bufferB = this.encoder.encode(stringB);
|
|
55
|
+
if (bufferA.length !== bufferB.length) {
|
|
56
|
+
return false;
|
|
57
|
+
}
|
|
58
|
+
const algorithm = { name: 'HMAC', hash: 'SHA-256' };
|
|
59
|
+
const key = (yield crypto.subtle.generateKey(algorithm, false, [
|
|
60
|
+
'sign',
|
|
61
|
+
'verify',
|
|
62
|
+
]));
|
|
63
|
+
const hmac = yield crypto.subtle.sign(algorithm, key, bufferA);
|
|
64
|
+
const equal = yield crypto.subtle.verify(algorithm, key, hmac, bufferB);
|
|
65
|
+
return equal;
|
|
66
|
+
});
|
|
67
|
+
}
|
|
68
|
+
}
|
|
69
|
+
exports.SubtleCryptoProvider = SubtleCryptoProvider;
|
|
70
|
+
// Cached mapping of byte to hex representation. We do this once to avoid re-
|
|
71
|
+
// computing every time we need to convert the result of a signature to hex.
|
|
72
|
+
const byteHexMapping = new Array(256);
|
|
73
|
+
for (let i = 0; i < byteHexMapping.length; i++) {
|
|
74
|
+
byteHexMapping[i] = i.toString(16).padStart(2, '0');
|
|
75
|
+
}
|
|
@@ -0,0 +1,19 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
|
|
3
|
+
if (k2 === undefined) k2 = k;
|
|
4
|
+
var desc = Object.getOwnPropertyDescriptor(m, k);
|
|
5
|
+
if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
|
|
6
|
+
desc = { enumerable: true, get: function() { return m[k]; } };
|
|
7
|
+
}
|
|
8
|
+
Object.defineProperty(o, k2, desc);
|
|
9
|
+
}) : (function(o, m, k, k2) {
|
|
10
|
+
if (k2 === undefined) k2 = k;
|
|
11
|
+
o[k2] = m[k];
|
|
12
|
+
}));
|
|
13
|
+
var __exportStar = (this && this.__exportStar) || function(m, exports) {
|
|
14
|
+
for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
|
|
15
|
+
};
|
|
16
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
17
|
+
__exportStar(require("./NodeCryptoProvider"), exports);
|
|
18
|
+
__exportStar(require("./SubtleCryptoProvider"), exports);
|
|
19
|
+
__exportStar(require("./CryptoProvider"), exports);
|
|
@@ -3,7 +3,7 @@ import { Organization, OrganizationResponse } from '../../organizations/interfac
|
|
|
3
3
|
import { Connection, ConnectionResponse } from '../../sso/interfaces';
|
|
4
4
|
import { InvitationEvent, InvitationEventResponse, MagicAuthEvent, MagicAuthEventResponse, Session, SessionResponse, User, UserResponse } from '../../user-management/interfaces';
|
|
5
5
|
import { OrganizationMembership, OrganizationMembershipResponse } from '../../user-management/interfaces/organization-membership.interface';
|
|
6
|
-
import { RoleEvent, RoleEventResponse } from '../../
|
|
6
|
+
import { RoleEvent, RoleEventResponse } from '../../roles/interfaces/role.interface';
|
|
7
7
|
export interface EventBase {
|
|
8
8
|
id: string;
|
|
9
9
|
createdAt: string;
|
|
@@ -0,0 +1,20 @@
|
|
|
1
|
+
export type RequestHeaders = Record<string, string | number | string[]>;
|
|
2
|
+
export type RequestOptions = {
|
|
3
|
+
params?: Record<string, any>;
|
|
4
|
+
headers?: RequestHeaders;
|
|
5
|
+
};
|
|
6
|
+
export type ResponseHeaderValue = string | string[];
|
|
7
|
+
export type ResponseHeaders = Record<string, ResponseHeaderValue>;
|
|
8
|
+
export interface HttpClientInterface {
|
|
9
|
+
getClientName: () => string;
|
|
10
|
+
get(path: string, options: RequestOptions): any;
|
|
11
|
+
post<Entity = any>(path: string, entity: Entity, options: RequestOptions): any;
|
|
12
|
+
put<Entity = any>(path: string, entity: Entity, options: RequestOptions): any;
|
|
13
|
+
delete(path: string, options: RequestOptions): any;
|
|
14
|
+
}
|
|
15
|
+
export interface HttpClientResponseInterface {
|
|
16
|
+
getStatusCode: () => number;
|
|
17
|
+
getHeaders: () => ResponseHeaders;
|
|
18
|
+
getRawResponse: () => unknown;
|
|
19
|
+
toJSON: () => Promise<any> | null;
|
|
20
|
+
}
|
|
@@ -23,3 +23,4 @@ __exportStar(require("./unprocessable-entity-error.interface"), exports);
|
|
|
23
23
|
__exportStar(require("./workos-options.interface"), exports);
|
|
24
24
|
__exportStar(require("./workos-response-error.interface"), exports);
|
|
25
25
|
__exportStar(require("./pagination-options.interface"), exports);
|
|
26
|
+
__exportStar(require("./http-client.interface"), exports);
|
|
@@ -0,0 +1,22 @@
|
|
|
1
|
+
import { HttpClientInterface, HttpClientResponseInterface, RequestOptions, ResponseHeaders } from '../interfaces/http-client.interface';
|
|
2
|
+
import { HttpClient, HttpClientResponse } from './http-client';
|
|
3
|
+
export declare class FetchHttpClient extends HttpClient implements HttpClientInterface {
|
|
4
|
+
readonly baseURL: string;
|
|
5
|
+
readonly options?: RequestInit | undefined;
|
|
6
|
+
private readonly _fetchFn;
|
|
7
|
+
constructor(baseURL: string, options?: RequestInit | undefined, fetchFn?: typeof fetch);
|
|
8
|
+
/** @override */
|
|
9
|
+
getClientName(): string;
|
|
10
|
+
get(path: string, options: RequestOptions): Promise<HttpClientResponseInterface>;
|
|
11
|
+
post<Entity = any>(path: string, entity: Entity, options: RequestOptions): Promise<HttpClientResponseInterface>;
|
|
12
|
+
put<Entity = any>(path: string, entity: Entity, options: RequestOptions): Promise<HttpClientResponseInterface>;
|
|
13
|
+
delete(path: string, options: RequestOptions): Promise<HttpClientResponseInterface>;
|
|
14
|
+
private fetchRequest;
|
|
15
|
+
}
|
|
16
|
+
export declare class FetchHttpClientResponse extends HttpClientResponse implements HttpClientResponseInterface {
|
|
17
|
+
_res: Response;
|
|
18
|
+
constructor(res: Response);
|
|
19
|
+
getRawResponse(): Response;
|
|
20
|
+
toJSON(): Promise<any> | null;
|
|
21
|
+
static _transformHeadersToObject(headers: Headers): ResponseHeaders;
|
|
22
|
+
}
|
|
@@ -0,0 +1,112 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
|
|
3
|
+
function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
|
|
4
|
+
return new (P || (P = Promise))(function (resolve, reject) {
|
|
5
|
+
function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
|
|
6
|
+
function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
|
|
7
|
+
function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
|
|
8
|
+
step((generator = generator.apply(thisArg, _arguments || [])).next());
|
|
9
|
+
});
|
|
10
|
+
};
|
|
11
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
12
|
+
exports.FetchHttpClientResponse = exports.FetchHttpClient = void 0;
|
|
13
|
+
const http_client_1 = require("./http-client");
|
|
14
|
+
class FetchHttpClient extends http_client_1.HttpClient {
|
|
15
|
+
constructor(baseURL, options, fetchFn) {
|
|
16
|
+
super(baseURL, options);
|
|
17
|
+
this.baseURL = baseURL;
|
|
18
|
+
this.options = options;
|
|
19
|
+
// Default to global fetch if available
|
|
20
|
+
if (!fetchFn) {
|
|
21
|
+
if (!globalThis.fetch) {
|
|
22
|
+
throw new Error('Fetch function not defined in the global scope and no replacement was provided.');
|
|
23
|
+
}
|
|
24
|
+
fetchFn = globalThis.fetch;
|
|
25
|
+
}
|
|
26
|
+
this._fetchFn = fetchFn;
|
|
27
|
+
}
|
|
28
|
+
/** @override */
|
|
29
|
+
getClientName() {
|
|
30
|
+
return 'fetch';
|
|
31
|
+
}
|
|
32
|
+
get(path, options) {
|
|
33
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
34
|
+
const resourceURL = http_client_1.HttpClient.getResourceURL(this.baseURL, path, options.params);
|
|
35
|
+
return yield this.fetchRequest(resourceURL, 'GET', null, options.headers);
|
|
36
|
+
});
|
|
37
|
+
}
|
|
38
|
+
post(path, entity, options) {
|
|
39
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
40
|
+
const resourceURL = http_client_1.HttpClient.getResourceURL(this.baseURL, path, options.params);
|
|
41
|
+
return yield this.fetchRequest(resourceURL, 'POST', http_client_1.HttpClient.getBody(entity), Object.assign(Object.assign({}, http_client_1.HttpClient.getContentTypeHeader(entity)), options.headers));
|
|
42
|
+
});
|
|
43
|
+
}
|
|
44
|
+
put(path, entity, options) {
|
|
45
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
46
|
+
const resourceURL = http_client_1.HttpClient.getResourceURL(this.baseURL, path, options.params);
|
|
47
|
+
return yield this.fetchRequest(resourceURL, 'PUT', http_client_1.HttpClient.getBody(entity), Object.assign(Object.assign({}, http_client_1.HttpClient.getContentTypeHeader(entity)), options.headers));
|
|
48
|
+
});
|
|
49
|
+
}
|
|
50
|
+
delete(path, options) {
|
|
51
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
52
|
+
const resourceURL = http_client_1.HttpClient.getResourceURL(this.baseURL, path, options.params);
|
|
53
|
+
return yield this.fetchRequest(resourceURL, 'DELETE', null, options.headers);
|
|
54
|
+
});
|
|
55
|
+
}
|
|
56
|
+
fetchRequest(url, method, body, headers) {
|
|
57
|
+
var _a, _b;
|
|
58
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
59
|
+
// For methods which expect payloads, we should always pass a body value
|
|
60
|
+
// even when it is empty. Without this, some JS runtimes (eg. Deno) will
|
|
61
|
+
// inject a second Content-Length header.
|
|
62
|
+
const methodHasPayload = method === 'POST' || method === 'PUT' || method === 'PATCH';
|
|
63
|
+
const requestBody = body || (methodHasPayload ? '' : undefined);
|
|
64
|
+
const { 'User-Agent': userAgent } = (_a = this.options) === null || _a === void 0 ? void 0 : _a.headers;
|
|
65
|
+
const res = yield this._fetchFn(url, {
|
|
66
|
+
method,
|
|
67
|
+
headers: Object.assign(Object.assign(Object.assign({ Accept: 'application/json, text/plain, */*', 'Content-Type': 'application/json' }, (_b = this.options) === null || _b === void 0 ? void 0 : _b.headers), headers), { 'User-Agent': this.addClientToUserAgent(userAgent.toString()) }),
|
|
68
|
+
body: requestBody,
|
|
69
|
+
});
|
|
70
|
+
if (!res.ok) {
|
|
71
|
+
throw new http_client_1.HttpClientError({
|
|
72
|
+
message: res.statusText,
|
|
73
|
+
response: {
|
|
74
|
+
status: res.status,
|
|
75
|
+
headers: res.headers,
|
|
76
|
+
data: yield res.json(),
|
|
77
|
+
},
|
|
78
|
+
});
|
|
79
|
+
}
|
|
80
|
+
return new FetchHttpClientResponse(res);
|
|
81
|
+
});
|
|
82
|
+
}
|
|
83
|
+
}
|
|
84
|
+
exports.FetchHttpClient = FetchHttpClient;
|
|
85
|
+
// tslint:disable-next-line
|
|
86
|
+
class FetchHttpClientResponse extends http_client_1.HttpClientResponse {
|
|
87
|
+
constructor(res) {
|
|
88
|
+
super(res.status, FetchHttpClientResponse._transformHeadersToObject(res.headers));
|
|
89
|
+
this._res = res;
|
|
90
|
+
}
|
|
91
|
+
getRawResponse() {
|
|
92
|
+
return this._res;
|
|
93
|
+
}
|
|
94
|
+
toJSON() {
|
|
95
|
+
const contentType = this._res.headers.get('content-type');
|
|
96
|
+
const isJsonResponse = contentType === null || contentType === void 0 ? void 0 : contentType.includes('application/json');
|
|
97
|
+
return isJsonResponse ? this._res.json() : null;
|
|
98
|
+
}
|
|
99
|
+
static _transformHeadersToObject(headers) {
|
|
100
|
+
// Fetch uses a Headers instance so this must be converted to a barebones
|
|
101
|
+
// JS object to meet the HttpClient interface.
|
|
102
|
+
const headersObj = {};
|
|
103
|
+
for (const entry of Object.entries(headers)) {
|
|
104
|
+
if (!Array.isArray(entry) || entry.length !== 2) {
|
|
105
|
+
throw new Error('Response objects produced by the fetch function given to FetchHttpClient do not have an iterable headers map. Response#headers should be an iterable object.');
|
|
106
|
+
}
|
|
107
|
+
headersObj[entry[0]] = entry[1];
|
|
108
|
+
}
|
|
109
|
+
return headersObj;
|
|
110
|
+
}
|
|
111
|
+
}
|
|
112
|
+
exports.FetchHttpClientResponse = FetchHttpClientResponse;
|
|
@@ -0,0 +1,39 @@
|
|
|
1
|
+
import { HttpClientInterface, HttpClientResponseInterface, RequestHeaders, RequestOptions, ResponseHeaders } from '../interfaces/http-client.interface';
|
|
2
|
+
export declare abstract class HttpClient implements HttpClientInterface {
|
|
3
|
+
readonly baseURL: string;
|
|
4
|
+
readonly options?: RequestInit | undefined;
|
|
5
|
+
constructor(baseURL: string, options?: RequestInit | undefined);
|
|
6
|
+
/** The HTTP client name used for diagnotics */
|
|
7
|
+
getClientName(): string;
|
|
8
|
+
abstract get(path: string, options: RequestOptions): Promise<HttpClientResponseInterface>;
|
|
9
|
+
abstract post<Entity = any>(path: string, entity: Entity, options: RequestOptions): Promise<HttpClientResponseInterface>;
|
|
10
|
+
abstract put<Entity = any>(path: string, entity: Entity, options: RequestOptions): Promise<HttpClientResponseInterface>;
|
|
11
|
+
abstract delete(path: string, options: RequestOptions): Promise<HttpClientResponseInterface>;
|
|
12
|
+
addClientToUserAgent(userAgent: string): string;
|
|
13
|
+
static getResourceURL(baseURL: string, path: string, params?: Record<string, any>): string;
|
|
14
|
+
static getQueryString(queryObj?: Record<string, any>): string | undefined;
|
|
15
|
+
static getContentTypeHeader(entity: any): RequestHeaders | undefined;
|
|
16
|
+
static getBody(entity: any): BodyInit | null | undefined;
|
|
17
|
+
}
|
|
18
|
+
export declare abstract class HttpClientResponse implements HttpClientResponseInterface {
|
|
19
|
+
_statusCode: number;
|
|
20
|
+
_headers: ResponseHeaders;
|
|
21
|
+
constructor(statusCode: number, headers: ResponseHeaders);
|
|
22
|
+
getStatusCode(): number;
|
|
23
|
+
getHeaders(): ResponseHeaders;
|
|
24
|
+
abstract getRawResponse(): unknown;
|
|
25
|
+
abstract toJSON(): any | null;
|
|
26
|
+
}
|
|
27
|
+
export declare class HttpClientError<T> extends Error {
|
|
28
|
+
readonly name: string;
|
|
29
|
+
readonly message: string;
|
|
30
|
+
readonly response: {
|
|
31
|
+
status: number;
|
|
32
|
+
headers: any;
|
|
33
|
+
data: T;
|
|
34
|
+
};
|
|
35
|
+
constructor({ message, response, }: {
|
|
36
|
+
message: string;
|
|
37
|
+
readonly response: HttpClientError<T>['response'];
|
|
38
|
+
});
|
|
39
|
+
}
|
|
@@ -0,0 +1,76 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
+
exports.HttpClientError = exports.HttpClientResponse = exports.HttpClient = void 0;
|
|
4
|
+
class HttpClient {
|
|
5
|
+
constructor(baseURL, options) {
|
|
6
|
+
this.baseURL = baseURL;
|
|
7
|
+
this.options = options;
|
|
8
|
+
}
|
|
9
|
+
/** The HTTP client name used for diagnotics */
|
|
10
|
+
getClientName() {
|
|
11
|
+
throw new Error('getClientName not implemented');
|
|
12
|
+
}
|
|
13
|
+
addClientToUserAgent(userAgent) {
|
|
14
|
+
if (userAgent.indexOf(' ') > -1) {
|
|
15
|
+
return userAgent.replace(/\b\s/, `/${this.getClientName()} `);
|
|
16
|
+
}
|
|
17
|
+
else {
|
|
18
|
+
return (userAgent += `/${this.getClientName()}`);
|
|
19
|
+
}
|
|
20
|
+
}
|
|
21
|
+
static getResourceURL(baseURL, path, params) {
|
|
22
|
+
const queryString = HttpClient.getQueryString(params);
|
|
23
|
+
const url = new URL([path, queryString].filter(Boolean).join('?'), baseURL);
|
|
24
|
+
return url.toString();
|
|
25
|
+
}
|
|
26
|
+
static getQueryString(queryObj) {
|
|
27
|
+
if (!queryObj)
|
|
28
|
+
return undefined;
|
|
29
|
+
const sanitizedQueryObj = {};
|
|
30
|
+
Object.entries(queryObj).forEach(([param, value]) => {
|
|
31
|
+
if (value !== '' && value !== undefined)
|
|
32
|
+
sanitizedQueryObj[param] = value;
|
|
33
|
+
});
|
|
34
|
+
return new URLSearchParams(sanitizedQueryObj).toString();
|
|
35
|
+
}
|
|
36
|
+
static getContentTypeHeader(entity) {
|
|
37
|
+
if (entity instanceof URLSearchParams) {
|
|
38
|
+
return {
|
|
39
|
+
'Content-Type': 'application/x-www-form-urlencoded;charset=utf-8',
|
|
40
|
+
};
|
|
41
|
+
}
|
|
42
|
+
return undefined;
|
|
43
|
+
}
|
|
44
|
+
static getBody(entity) {
|
|
45
|
+
if (entity === null || entity instanceof URLSearchParams) {
|
|
46
|
+
return entity;
|
|
47
|
+
}
|
|
48
|
+
return JSON.stringify(entity);
|
|
49
|
+
}
|
|
50
|
+
}
|
|
51
|
+
exports.HttpClient = HttpClient;
|
|
52
|
+
// tslint:disable-next-line
|
|
53
|
+
class HttpClientResponse {
|
|
54
|
+
constructor(statusCode, headers) {
|
|
55
|
+
this._statusCode = statusCode;
|
|
56
|
+
this._headers = headers;
|
|
57
|
+
}
|
|
58
|
+
getStatusCode() {
|
|
59
|
+
return this._statusCode;
|
|
60
|
+
}
|
|
61
|
+
getHeaders() {
|
|
62
|
+
return this._headers;
|
|
63
|
+
}
|
|
64
|
+
}
|
|
65
|
+
exports.HttpClientResponse = HttpClientResponse;
|
|
66
|
+
// tslint:disable-next-line
|
|
67
|
+
class HttpClientError extends Error {
|
|
68
|
+
constructor({ message, response, }) {
|
|
69
|
+
super(message);
|
|
70
|
+
this.name = 'HttpClientError';
|
|
71
|
+
this.message = 'The request could not be completed.';
|
|
72
|
+
this.message = message;
|
|
73
|
+
this.response = response;
|
|
74
|
+
}
|
|
75
|
+
}
|
|
76
|
+
exports.HttpClientError = HttpClientError;
|
|
@@ -0,0 +1,31 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
|
|
3
|
+
if (k2 === undefined) k2 = k;
|
|
4
|
+
var desc = Object.getOwnPropertyDescriptor(m, k);
|
|
5
|
+
if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
|
|
6
|
+
desc = { enumerable: true, get: function() { return m[k]; } };
|
|
7
|
+
}
|
|
8
|
+
Object.defineProperty(o, k2, desc);
|
|
9
|
+
}) : (function(o, m, k, k2) {
|
|
10
|
+
if (k2 === undefined) k2 = k;
|
|
11
|
+
o[k2] = m[k];
|
|
12
|
+
}));
|
|
13
|
+
var __exportStar = (this && this.__exportStar) || function(m, exports) {
|
|
14
|
+
for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
|
|
15
|
+
};
|
|
16
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
17
|
+
exports.createHttpClient = void 0;
|
|
18
|
+
const fetch_client_1 = require("./fetch-client");
|
|
19
|
+
const node_client_1 = require("./node-client");
|
|
20
|
+
function createHttpClient(baseURL, options, fetchFn) {
|
|
21
|
+
if (typeof fetch !== 'undefined' || typeof fetchFn !== 'undefined') {
|
|
22
|
+
return new fetch_client_1.FetchHttpClient(baseURL, options, fetchFn);
|
|
23
|
+
}
|
|
24
|
+
else {
|
|
25
|
+
return new node_client_1.NodeHttpClient(baseURL, options);
|
|
26
|
+
}
|
|
27
|
+
}
|
|
28
|
+
exports.createHttpClient = createHttpClient;
|
|
29
|
+
__exportStar(require("./fetch-client"), exports);
|
|
30
|
+
__exportStar(require("./node-client"), exports);
|
|
31
|
+
__exportStar(require("./http-client"), exports);
|
|
@@ -0,0 +1,23 @@
|
|
|
1
|
+
/// <reference types="node" />
|
|
2
|
+
import { HttpClient, HttpClientResponse } from './http-client';
|
|
3
|
+
import { HttpClientInterface, HttpClientResponseInterface, RequestOptions } from '../interfaces/http-client.interface';
|
|
4
|
+
import * as http_ from 'http';
|
|
5
|
+
export declare class NodeHttpClient extends HttpClient implements HttpClientInterface {
|
|
6
|
+
readonly baseURL: string;
|
|
7
|
+
readonly options?: RequestInit | undefined;
|
|
8
|
+
private httpAgent;
|
|
9
|
+
private httpsAgent;
|
|
10
|
+
constructor(baseURL: string, options?: RequestInit | undefined);
|
|
11
|
+
getClientName(): string;
|
|
12
|
+
get(path: string, options: RequestOptions): Promise<HttpClientResponseInterface>;
|
|
13
|
+
post<Entity = any>(path: string, entity: Entity, options: RequestOptions): Promise<HttpClientResponseInterface>;
|
|
14
|
+
put<Entity = any>(path: string, entity: Entity, options: RequestOptions): Promise<HttpClientResponseInterface>;
|
|
15
|
+
delete(path: string, options: RequestOptions): Promise<HttpClientResponseInterface>;
|
|
16
|
+
private nodeRequest;
|
|
17
|
+
}
|
|
18
|
+
export declare class NodeHttpClientResponse extends HttpClientResponse implements HttpClientResponseInterface {
|
|
19
|
+
_res: http_.IncomingMessage;
|
|
20
|
+
constructor(res: http_.IncomingMessage);
|
|
21
|
+
getRawResponse(): http_.IncomingMessage;
|
|
22
|
+
toJSON(): Promise<any> | any;
|
|
23
|
+
}
|