@opengovsg/refx-ts-sdk 0.0.65 → 0.0.70

package/core/fetcher/APIResponse.d.ts

@@ -1,10 +1,20 @@
+import type { RawResponse } from "./RawResponse";
+/**
+ * The response of an API call.
+ * It is a successful response or a failed response.
+ */
 export type APIResponse<Success, Failure> = SuccessfulResponse<Success> | FailedResponse<Failure>;
 export interface SuccessfulResponse<T> {
     ok: true;
     body: T;
+    /**
+     * @deprecated Use `rawResponse` instead
+     */
     headers?: Record<string, any>;
+    rawResponse: RawResponse;
 }
 export interface FailedResponse<T> {
     ok: false;
     error: T;
+    rawResponse: RawResponse;
 }

package/core/fetcher/BinaryResponse.d.ts

@@ -0,0 +1,19 @@
+export type BinaryResponse = {
+    /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/Request/bodyUsed) */
+    bodyUsed: Response["bodyUsed"];
+    /**
+     * Returns a ReadableStream of the response body.
+     * [MDN Reference](https://developer.mozilla.org/docs/Web/API/Request/body)
+     */
+    stream: () => Response["body"];
+    /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/Request/arrayBuffer) */
+    arrayBuffer: () => ReturnType<Response["arrayBuffer"]>;
+    /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/Request/blob) */
+    blob: () => ReturnType<Response["blob"]>;
+    /**
+     * [MDN Reference](https://developer.mozilla.org/docs/Web/API/Request/bytes)
+     * Some versions of the Fetch API may not support this method.
+     */
+    bytes?(): Promise<Uint8Array>;
+};
+export declare function getBinaryResponse(response: Response): BinaryResponse;

package/core/fetcher/BinaryResponse.js

@@ -0,0 +1,17 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getBinaryResponse = getBinaryResponse;
+function getBinaryResponse(response) {
+    const binaryResponse = {
+        get bodyUsed() {
+            return response.bodyUsed;
+        },
+        stream: () => response.body,
+        arrayBuffer: response.arrayBuffer.bind(response),
+        blob: response.blob.bind(response),
+    };
+    if ("bytes" in response && typeof response.bytes === "function") {
+        binaryResponse.bytes = response.bytes.bind(response);
+    }
+    return binaryResponse;
+}

package/core/fetcher/EndpointMetadata.d.ts

@@ -0,0 +1,13 @@
+export type SecuritySchemeKey = string;
+/**
+ * A collection of security schemes, where the key is the name of the security scheme and the value is the list of scopes required for that scheme.
+ * All schemes in the collection must be satisfied for authentication to be successful.
+ */
+export type SecuritySchemeCollection = Record<SecuritySchemeKey, AuthScope[]>;
+export type AuthScope = string;
+export type EndpointMetadata = {
+    /**
+     * An array of security scheme collections. Each collection represents an alternative way to authenticate.
+     */
+    security?: SecuritySchemeCollection[];
+};

package/core/fetcher/EndpointSupplier.d.ts

@@ -0,0 +1,12 @@
+import type { EndpointMetadata } from "./EndpointMetadata";
+import type { Supplier } from "./Supplier";
+type EndpointSupplierFn<T> = (arg: {
+    endpointMetadata?: EndpointMetadata;
+}) => T | Promise<T>;
+export type EndpointSupplier<T> = Supplier<T> | EndpointSupplierFn<T>;
+export declare const EndpointSupplier: {
+    get: <T>(supplier: EndpointSupplier<T>, arg: {
+        endpointMetadata?: EndpointMetadata;
+    }) => Promise<T>;
+};
+export {};

package/{dist/core/fetcher/Supplier.js → core/fetcher/EndpointSupplier.js}

@@ -9,11 +9,11 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
     });
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.Supplier = void 0;
-exports.Supplier = {
-    get: (supplier) => __awaiter(void 0, void 0, void 0, function* () {
+exports.EndpointSupplier = void 0;
+exports.EndpointSupplier = {
+    get: (supplier, arg) => __awaiter(void 0, void 0, void 0, function* () {
         if (typeof supplier === "function") {
-            return supplier();
+            return supplier(arg);
         }
         else {
             return supplier;

package/core/fetcher/Fetcher.d.ts

@@ -1,22 +1,33 @@
-import { APIResponse } from "./APIResponse";
+import { type LogConfig, type Logger } from "../logging/logger";
+import type { APIResponse } from "./APIResponse";
+import type { EndpointMetadata } from "./EndpointMetadata";
 export type FetchFunction = <R = unknown>(args: Fetcher.Args) => Promise<APIResponse<R, Fetcher.Error>>;
 export declare namespace Fetcher {
     interface Args {
         url: string;
         method: string;
         contentType?: string;
-        headers?: Record<string, string | undefined>;
-        queryParameters?: Record<string, string | string[] | object | object[] | null>;
+        headers?: Record<string, unknown>;
+        /**
+         * @deprecated Prefer `queryString` (produced by `core.url.queryBuilder()`).
+         * Retained for backwards compatibility with custom fetchers and callers that
+         * still construct request args with a query-parameter object.
+         */
+        queryParameters?: Record<string, unknown>;
+        queryString?: string;
         body?: unknown;
         timeoutMs?: number;
         maxRetries?: number;
         withCredentials?: boolean;
         abortSignal?: AbortSignal;
-        requestType?: "json" | "file" | "bytes";
-        responseType?: "json" | "blob" | "sse" | "streaming" | "text" | "arrayBuffer";
+        requestType?: "json" | "file" | "bytes" | "form" | "other";
+        responseType?: "json" | "blob" | "sse" | "streaming" | "text" | "arrayBuffer" | "binary-response";
         duplex?: "half";
+        endpointMetadata?: EndpointMetadata;
+        fetchFn?: typeof fetch;
+        logging?: LogConfig | Logger;
     }
-    type Error = FailedStatusCodeError | NonJsonError | TimeoutError | UnknownError;
+    type Error = FailedStatusCodeError | NonJsonError | BodyIsNullError | TimeoutError | UnknownError;
     interface FailedStatusCodeError {
         reason: "status-code";
         statusCode: number;
@@ -27,12 +38,18 @@ export declare namespace Fetcher {
         statusCode: number;
         rawBody: string;
     }
+    interface BodyIsNullError {
+        reason: "body-is-null";
+        statusCode: number;
+    }
     interface TimeoutError {
         reason: "timeout";
+        cause?: unknown;
     }
     interface UnknownError {
         reason: "unknown";
         errorMessage: string;
+        cause?: unknown;
     }
 }
 export declare function fetcherImpl<R = unknown>(args: Fetcher.Args): Promise<APIResponse<R, Fetcher.Error>>;

package/core/fetcher/Fetcher.js

@@ -12,87 +12,314 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.fetcher = void 0;
 exports.fetcherImpl = fetcherImpl;
 const json_1 = require("../json");
+const logger_1 = require("../logging/logger");
 const createRequestUrl_1 = require("./createRequestUrl");
+const EndpointSupplier_1 = require("./EndpointSupplier");
+const getErrorResponseBody_1 = require("./getErrorResponseBody");
 const getFetchFn_1 = require("./getFetchFn");
 const getRequestBody_1 = require("./getRequestBody");
 const getResponseBody_1 = require("./getResponseBody");
+const Headers_1 = require("./Headers");
 const makeRequest_1 = require("./makeRequest");
+const RawResponse_1 = require("./RawResponse");
 const requestWithRetries_1 = require("./requestWithRetries");
-function fetcherImpl(args) {
+const SENSITIVE_HEADERS = new Set([
+    "authorization",
+    "www-authenticate",
+    "x-api-key",
+    "api-key",
+    "apikey",
+    "x-api-token",
+    "x-auth-token",
+    "auth-token",
+    "cookie",
+    "set-cookie",
+    "proxy-authorization",
+    "proxy-authenticate",
+    "x-csrf-token",
+    "x-xsrf-token",
+    "x-session-token",
+    "x-access-token",
+]);
+function redactHeaders(headers) {
+    const filtered = {};
+    for (const [key, value] of headers instanceof Headers_1.Headers ? headers.entries() : Object.entries(headers)) {
+        if (SENSITIVE_HEADERS.has(key.toLowerCase())) {
+            filtered[key] = "[REDACTED]";
+        }
+        else {
+            filtered[key] = value;
+        }
+    }
+    return filtered;
+}
+const SENSITIVE_QUERY_PARAMS = new Set([
+    "api_key",
+    "api-key",
+    "apikey",
+    "token",
+    "access_token",
+    "access-token",
+    "auth_token",
+    "auth-token",
+    "password",
+    "passwd",
+    "secret",
+    "api_secret",
+    "api-secret",
+    "apisecret",
+    "key",
+    "session",
+    "session_id",
+    "session-id",
+]);
+function redactQueryParameters(queryParameters) {
+    if (queryParameters == null) {
+        return undefined;
+    }
+    const redacted = {};
+    for (const [key, value] of Object.entries(queryParameters)) {
+        redacted[key] = SENSITIVE_QUERY_PARAMS.has(key.toLowerCase()) ? "[REDACTED]" : value;
+    }
+    return redacted;
+}
+function redactUrl(url) {
+    const protocolIndex = url.indexOf("://");
+    if (protocolIndex === -1)
+        return url;
+    const afterProtocol = protocolIndex + 3;
+    // Find the first delimiter that marks the end of the authority section
+    const pathStart = url.indexOf("/", afterProtocol);
+    let queryStart = url.indexOf("?", afterProtocol);
+    let fragmentStart = url.indexOf("#", afterProtocol);
+    const firstDelimiter = Math.min(pathStart === -1 ? url.length : pathStart, queryStart === -1 ? url.length : queryStart, fragmentStart === -1 ? url.length : fragmentStart);
+    // Find the LAST @ before the delimiter (handles multiple @ in credentials)
+    let atIndex = -1;
+    for (let i = afterProtocol; i < firstDelimiter; i++) {
+        if (url[i] === "@") {
+            atIndex = i;
+        }
+    }
+    if (atIndex !== -1) {
+        url = `${url.slice(0, afterProtocol)}[REDACTED]@${url.slice(atIndex + 1)}`;
+    }
+    // Recalculate queryStart since url might have changed
+    queryStart = url.indexOf("?");
+    if (queryStart === -1)
+        return url;
+    fragmentStart = url.indexOf("#", queryStart);
+    const queryEnd = fragmentStart !== -1 ? fragmentStart : url.length;
+    const queryString = url.slice(queryStart + 1, queryEnd);
+    if (queryString.length === 0)
+        return url;
+    // FAST PATH: Quick check if any sensitive keywords present
+    // Using indexOf is faster than regex for simple substring matching
+    const lower = queryString.toLowerCase();
+    const hasSensitive = lower.includes("token") ||
+        lower.includes("key") ||
+        lower.includes("password") ||
+        lower.includes("passwd") ||
+        lower.includes("secret") ||
+        lower.includes("session") ||
+        lower.includes("auth");
+    if (!hasSensitive) {
+        return url;
+    }
+    // SLOW PATH: Parse and redact
+    const redactedParams = [];
+    const params = queryString.split("&");
+    for (const param of params) {
+        const equalIndex = param.indexOf("=");
+        if (equalIndex === -1) {
+            redactedParams.push(param);
+            continue;
+        }
+        const key = param.slice(0, equalIndex);
+        let shouldRedact = SENSITIVE_QUERY_PARAMS.has(key.toLowerCase());
+        if (!shouldRedact && key.includes("%")) {
+            try {
+                const decodedKey = decodeURIComponent(key);
+                shouldRedact = SENSITIVE_QUERY_PARAMS.has(decodedKey.toLowerCase());
+            }
+            catch (_a) { }
+        }
+        redactedParams.push(shouldRedact ? `${key}=[REDACTED]` : param);
+    }
+    return url.slice(0, queryStart + 1) + redactedParams.join("&") + url.slice(queryEnd);
+}
+function getHeaders(args) {
     return __awaiter(this, void 0, void 0, function* () {
-        const headers = {};
+        var _a;
+        const newHeaders = new Headers_1.Headers();
+        newHeaders.set("Accept", args.responseType === "json"
+            ? "application/json"
+            : args.responseType === "text"
+                ? "text/plain"
+                : args.responseType === "sse"
+                    ? "text/event-stream"
+                    : "*/*");
         if (args.body !== undefined && args.contentType != null) {
-            headers["Content-Type"] = args.contentType;
+            newHeaders.set("Content-Type", args.contentType);
         }
-        if (args.headers != null) {
-            for (const [key, value] of Object.entries(args.headers)) {
-                if (value != null) {
-                    headers[key] = value;
-                }
+        if (args.headers == null) {
+            return newHeaders;
+        }
+        for (const [key, value] of Object.entries(args.headers)) {
+            const result = yield EndpointSupplier_1.EndpointSupplier.get(value, { endpointMetadata: (_a = args.endpointMetadata) !== null && _a !== void 0 ? _a : {} });
+            if (typeof result === "string") {
+                newHeaders.set(key, result);
+                continue;
             }
+            if (result == null) {
+                continue;
+            }
+            newHeaders.set(key, `${result}`);
+        }
+        return newHeaders;
+    });
+}
+function fetcherImpl(args) {
+    return __awaiter(this, void 0, void 0, function* () {
+        var _a, _b, _c;
+        let url = args.url;
+        if (args.queryString != null && args.queryString.length > 0) {
+            url = `${url}?${args.queryString}`;
+        }
+        else {
+            url = (0, createRequestUrl_1.createRequestUrl)(args.url, args.queryParameters);
         }
-        const url = (0, createRequestUrl_1.createRequestUrl)(args.url, args.queryParameters);
         const requestBody = yield (0, getRequestBody_1.getRequestBody)({
             body: args.body,
-            type: args.requestType === "json" ? "json" : "other",
+            type: (_a = args.requestType) !== null && _a !== void 0 ? _a : "other",
         });
-        const fetchFn = yield (0, getFetchFn_1.getFetchFn)();
+        const fetchFn = (_b = args.fetchFn) !== null && _b !== void 0 ? _b : (yield (0, getFetchFn_1.getFetchFn)());
+        const headers = yield getHeaders(args);
+        const logger = (0, logger_1.createLogger)(args.logging);
+        if (logger.isDebug()) {
+            const metadata = {
+                method: args.method,
+                url: redactUrl(url),
+                headers: redactHeaders(headers),
+                queryParameters: redactQueryParameters(args.queryParameters),
+                hasBody: requestBody != null,
+            };
+            logger.debug("Making HTTP request", metadata);
+        }
         try {
             const response = yield (0, requestWithRetries_1.requestWithRetries)(() => __awaiter(this, void 0, void 0, function* () {
-                return (0, makeRequest_1.makeRequest)(fetchFn, url, args.method, headers, requestBody, args.timeoutMs, args.abortSignal, args.withCredentials, args.duplex);
+                return (0, makeRequest_1.makeRequest)(fetchFn, url, args.method, headers, requestBody, args.timeoutMs, args.abortSignal, args.withCredentials, args.duplex, args.responseType === "streaming" || args.responseType === "sse");
             }), args.maxRetries);
-            const responseBody = yield (0, getResponseBody_1.getResponseBody)(response, args.responseType);
             if (response.status >= 200 && response.status < 400) {
+                if (logger.isDebug()) {
+                    const metadata = {
+                        method: args.method,
+                        url: redactUrl(url),
+                        statusCode: response.status,
+                        responseHeaders: redactHeaders(response.headers),
+                    };
+                    logger.debug("HTTP request succeeded", metadata);
+                }
+                const body = yield (0, getResponseBody_1.getResponseBody)(response, args.responseType);
                 return {
                     ok: true,
-                    body: responseBody,
+                    body: body,
                     headers: response.headers,
+                    rawResponse: (0, RawResponse_1.toRawResponse)(response),
                 };
             }
             else {
+                if (logger.isError()) {
+                    const metadata = {
+                        method: args.method,
+                        url: redactUrl(url),
+                        statusCode: response.status,
+                        responseHeaders: redactHeaders(Object.fromEntries(response.headers.entries())),
+                    };
+                    logger.error("HTTP request failed with error status", metadata);
+                }
                 return {
                     ok: false,
                     error: {
                         reason: "status-code",
                         statusCode: response.status,
-                        body: responseBody,
+                        body: yield (0, getErrorResponseBody_1.getErrorResponseBody)(response),
                     },
+                    rawResponse: (0, RawResponse_1.toRawResponse)(response),
                 };
             }
         }
         catch (error) {
-            if (args.abortSignal != null && args.abortSignal.aborted) {
+            if ((_c = args.abortSignal) === null || _c === void 0 ? void 0 : _c.aborted) {
+                if (logger.isError()) {
+                    const metadata = {
+                        method: args.method,
+                        url: redactUrl(url),
+                    };
+                    logger.error("HTTP request was aborted", metadata);
+                }
                 return {
                     ok: false,
                     error: {
                         reason: "unknown",
                         errorMessage: "The user aborted a request",
+                        cause: error,
                     },
+                    rawResponse: RawResponse_1.abortRawResponse,
                 };
             }
             else if (error instanceof Error && error.name === "AbortError") {
+                if (logger.isError()) {
+                    const metadata = {
+                        method: args.method,
+                        url: redactUrl(url),
+                        timeoutMs: args.timeoutMs,
+                    };
+                    logger.error("HTTP request timed out", metadata);
+                }
                 return {
                     ok: false,
                     error: {
                         reason: "timeout",
+                        cause: error,
                     },
+                    rawResponse: RawResponse_1.abortRawResponse,
                 };
             }
             else if (error instanceof Error) {
+                if (logger.isError()) {
+                    const metadata = {
+                        method: args.method,
+                        url: redactUrl(url),
+                        errorMessage: error.message,
+                    };
+                    logger.error("HTTP request failed with error", metadata);
+                }
                 return {
                     ok: false,
                     error: {
                         reason: "unknown",
                         errorMessage: error.message,
+                        cause: error,
                     },
+                    rawResponse: RawResponse_1.unknownRawResponse,
+                };
+            }
+            if (logger.isError()) {
+                const metadata = {
+                    method: args.method,
+                    url: redactUrl(url),
+                    error: (0, json_1.toJson)(error),
                 };
+                logger.error("HTTP request failed with unknown error", metadata);
             }
             return {
                 ok: false,
                 error: {
                     reason: "unknown",
                     errorMessage: (0, json_1.toJson)(error),
+                    cause: error,
                 },
+                rawResponse: RawResponse_1.unknownRawResponse,
             };
         }
     });

package/core/fetcher/Headers.d.ts

@@ -0,0 +1,2 @@
+declare let Headers: typeof globalThis.Headers;
+export { Headers };

package/core/fetcher/Headers.js

@@ -0,0 +1,84 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Headers = void 0;
+let Headers;
+if (typeof globalThis.Headers !== "undefined") {
+    exports.Headers = Headers = globalThis.Headers;
+}
+else {
+    exports.Headers = Headers = class Headers {
+        constructor(init) {
+            this.headers = new Map();
+            if (init) {
+                if (init instanceof Headers) {
+                    init.forEach((value, key) => this.append(key, value));
+                }
+                else if (Array.isArray(init)) {
+                    for (const [key, value] of init) {
+                        if (typeof key === "string" && typeof value === "string") {
+                            this.append(key, value);
+                        }
+                        else {
+                            throw new TypeError("Each header entry must be a [string, string] tuple");
+                        }
+                    }
+                }
+                else {
+                    for (const [key, value] of Object.entries(init)) {
+                        if (typeof value === "string") {
+                            this.append(key, value);
+                        }
+                        else {
+                            throw new TypeError("Header values must be strings");
+                        }
+                    }
+                }
+            }
+        }
+        append(name, value) {
+            const key = name.toLowerCase();
+            const existing = this.headers.get(key) || [];
+            this.headers.set(key, [...existing, value]);
+        }
+        delete(name) {
+            const key = name.toLowerCase();
+            this.headers.delete(key);
+        }
+        get(name) {
+            const key = name.toLowerCase();
+            const values = this.headers.get(key);
+            return values ? values.join(", ") : null;
+        }
+        has(name) {
+            const key = name.toLowerCase();
+            return this.headers.has(key);
+        }
+        set(name, value) {
+            const key = name.toLowerCase();
+            this.headers.set(key, [value]);
+        }
+        forEach(callbackfn, thisArg) {
+            const boundCallback = thisArg ? callbackfn.bind(thisArg) : callbackfn;
+            this.headers.forEach((values, key) => boundCallback(values.join(", "), key, this));
+        }
+        getSetCookie() {
+            return this.headers.get("set-cookie") || [];
+        }
+        *entries() {
+            for (const [key, values] of this.headers.entries()) {
+                yield [key, values.join(", ")];
+            }
+        }
+        *keys() {
+            yield* this.headers.keys();
+        }
+        *values() {
+            for (const values of this.headers.values()) {
+                yield values.join(", ");
+            }
+        }
+        [Symbol.iterator]() {
+            return this.entries();
+        }
+    };
+}

package/core/fetcher/HttpResponsePromise.d.ts

@@ -0,0 +1,58 @@
+import type { WithRawResponse } from "./RawResponse";
+/**
+ * A promise that returns the parsed response and lets you retrieve the raw response too.
+ */
+export declare class HttpResponsePromise<T> extends Promise<T> {
+    private innerPromise;
+    private unwrappedPromise;
+    private constructor();
+    /**
+     * Creates an `HttpResponsePromise` from a function that returns a promise.
+     *
+     * @param fn - A function that returns a promise resolving to a `WithRawResponse` object.
+     * @param args - Arguments to pass to the function.
+     * @returns An `HttpResponsePromise` instance.
+     */
+    static fromFunction<F extends (...args: never[]) => Promise<WithRawResponse<T>>, T>(fn: F, ...args: Parameters<F>): HttpResponsePromise<T>;
+    /**
+     * Creates a function that returns an `HttpResponsePromise` from a function that returns a promise.
+     *
+     * @param fn - A function that returns a promise resolving to a `WithRawResponse` object.
+     * @returns A function that returns an `HttpResponsePromise` instance.
+     */
+    static interceptFunction<F extends (...args: never[]) => Promise<WithRawResponse<T>>, T = Awaited<ReturnType<F>>["data"]>(fn: F): (...args: Parameters<F>) => HttpResponsePromise<T>;
+    /**
+     * Creates an `HttpResponsePromise` from an existing promise.
+     *
+     * @param promise - A promise resolving to a `WithRawResponse` object.
+     * @returns An `HttpResponsePromise` instance.
+     */
+    static fromPromise<T>(promise: Promise<WithRawResponse<T>>): HttpResponsePromise<T>;
+    /**
+     * Creates an `HttpResponsePromise` from an executor function.
+     *
+     * @param executor - A function that takes resolve and reject callbacks to create a promise.
+     * @returns An `HttpResponsePromise` instance.
+     */
+    static fromExecutor<T>(executor: (resolve: (value: WithRawResponse<T>) => void, reject: (reason?: unknown) => void) => void): HttpResponsePromise<T>;
+    /**
+     * Creates an `HttpResponsePromise` from a resolved result.
+     *
+     * @param result - A `WithRawResponse` object to resolve immediately.
+     * @returns An `HttpResponsePromise` instance.
+     */
+    static fromResult<T>(result: WithRawResponse<T>): HttpResponsePromise<T>;
+    private unwrap;
+    /** @inheritdoc */
+    then<TResult1 = T, TResult2 = never>(onfulfilled?: ((value: T) => TResult1 | PromiseLike<TResult1>) | null, onrejected?: ((reason: unknown) => TResult2 | PromiseLike<TResult2>) | null): Promise<TResult1 | TResult2>;
+    /** @inheritdoc */
+    catch<TResult = never>(onrejected?: ((reason: unknown) => TResult | PromiseLike<TResult>) | null): Promise<T | TResult>;
+    /** @inheritdoc */
+    finally(onfinally?: (() => void) | null): Promise<T>;
+    /**
+     * Retrieves the data and raw response.
+     *
+     * @returns A promise resolving to a `WithRawResponse` object.
+     */
+    withRawResponse(): Promise<WithRawResponse<T>>;
+}