13233305537

Committed 10 Feb 2025 04:04AM UTC coverage: 81.553% (+0.4%) from 81.188%

Build # 13233305537

Build Type

push

github

Committed by

thimovss

Commit Message

document_type can now also be a single DocumentType, rather than always requiring an array

Run Details

39 of 53 branches covered (73.58%)

Branch coverage included in aggregate %.

3 of 3 new or added lines in 1 file covered. (100.0%)

129 of 153 relevant lines covered (84.31%)

21.7 hits per line

Source File
Press 'n' to go to next uncovered line, 'b' for previous

97.3

/src/HTTP.ts

import { createHmac } from 'node:crypto';

import Client, { SIError } from './index';

export default class HTTP {
    _client: Client;

    constructor(client: Client) {
        this._client = client;
    }

    private async generateHMAC(request: Request, requestBody?: RequestInit['body']): Promise<[string, string]> {
        const timestamp: string = new Date().toISOString();
        const hmac = createHmac('sha256', this._client.clientSecret);
        hmac.update(`${this._client.clientId}${request.method}${request.url}${timestamp}`);
        if (requestBody) {
            hmac.update(requestBody.toString());
        }
        return [hmac.digest('hex'), timestamp];
    }

    /**
     * Makes an authenticated HTTP request to the Smooth Integration API.
     * @param url {string} endpoint path, @example '/cdc'
     * @param input {RequestInit} any additional request options you want to pass to the request.
     *  Required headers like Content-Type and all HMAC Auth headers do not need to be passed.
     */
    public async fetch<T>(url: string, input?: RequestInit): Promise<T> {
        const request: Request = new Request(this._client.apiUrl + url, input);

        // Sign the request with HMAC signature, Timestamp, and Organisation ID
        const [hmac, timestamp] = await this.generateHMAC(request, input?.body);
        request.headers.set('X-Signature', hmac);
        request.headers.set('X-Organisation', this._client.clientId);
        request.headers.set('X-Timestamp', timestamp);
        request.headers.set('Content-Type', 'application/json; charset=utf-8');

        let response: Response;
        try {
            response = await fetch(request);
            // eslint-disable-next-line @typescript-eslint/no-explicit-any
        } catch (error: any) {
            throw new SIError(error.message || 'Network Error', error);
        }

        let body;
        try {
            body = await response.json();
        } catch (error: unknown) {
            throw new SIError('Invalid JSON Received', error);
        }

        if (!response.ok) {
            if (response.status >= 500) {
                throw new SIError(response.statusText);
            } else {
                // TODO: check for error code, could be we receive errors like 400 from the external system when users make proxy requests, which we do not want to throw as an SIError
                throw new SIError(response.statusText + ': ' + body.message);
            }
        }

        return body;
    }
}

1	import { createHmac } from 'node:crypto';	14✔
2
3	import Client, { SIError } from './index';	14✔
4
5	export default class HTTP {	14✔
6	_client: Client;
7
8	constructor(client: Client) {
9	this._client = client;	62✔
10	}
11
12	private async generateHMAC(request: Request, requestBody?: RequestInit['body']): Promise<[string, string]> {
13	const timestamp: string = new Date().toISOString();	61✔
14	const hmac = createHmac('sha256', this._client.clientSecret);	61✔
15	hmac.update(`${this._client.clientId}${request.method}${request.url}${timestamp}`);	61✔
16	if (requestBody) {	61✔
17	hmac.update(requestBody.toString());	8✔
18	}
19	return [hmac.digest('hex'), timestamp];	61✔
20	}
21
22	/**
23	* Makes an authenticated HTTP request to the Smooth Integration API.
24	* @param url {string} endpoint path, @example '/cdc'
25	* @param input {RequestInit} any additional request options you want to pass to the request.
26	* Required headers like Content-Type and all HMAC Auth headers do not need to be passed.
27	*/
28	public async fetch<T>(url: string, input?: RequestInit): Promise<T> {
29	const request: Request = new Request(this._client.apiUrl + url, input);	61✔
30
31	// Sign the request with HMAC signature, Timestamp, and Organisation ID
32	const [hmac, timestamp] = await this.generateHMAC(request, input?.body);	61✔
33	request.headers.set('X-Signature', hmac);	61✔
34	request.headers.set('X-Organisation', this._client.clientId);	61✔
35	request.headers.set('X-Timestamp', timestamp);	61✔
36	request.headers.set('Content-Type', 'application/json; charset=utf-8');	61✔
37
38	let response: Response;
39	try {	61✔
40	response = await fetch(request);	61✔
41	// eslint-disable-next-line @typescript-eslint/no-explicit-any
42	} catch (error: any) {
43	throw new SIError(error.message \|\| 'Network Error', error);	1!
44	}
45
46	let body;
47	try {	60✔
48	body = await response.json();	60✔
49	} catch (error: unknown) {
50	throw new SIError('Invalid JSON Received', error);	1✔
51	}
52
53	if (!response.ok) {	59✔
54	if (response.status >= 500) {	27✔
55	throw new SIError(response.statusText);	9✔
56	} else {
57	// TODO: check for error code, could be we receive errors like 400 from the external system when users make proxy requests, which we do not want to throw as an SIError
58	throw new SIError(response.statusText + ': ' + body.message);	18✔
59	}
60	}
61
62	return body;	32✔
63	}
64	}

SmoothIntegration / sdk-node / 13233305537

Source File Press 'n' to go to next uncovered line, 'b' for previous

Source File
Press 'n' to go to next uncovered line, 'b' for previous