@dvsa/appdev-api-common 0.7.0 → 0.8.1

package/http/decorators.d.ts

@@ -0,0 +1,42 @@
+import type { Logger } from "@aws-lambda-powertools/logger";
+/**
+ * Decorator to log the duration of a method execution by passing in an accessor function to retrieve the logger.
+ * @param getLogger - A function that takes the class instance and returns the logger instance.
+ * @param {string} label - Optional label for the log message.
+ *
+ * Note: If you are already using a logger as a class property, you can use the `Timed` decorator instead.
+ *
+ * @constructor
+ *
+ * Example usage:
+ * class MyClass {
+ *  @TimedWithAccessor(() => Container.get(LOGGER))
+ * 	async findAll() {} // The log name here will be [findAll]
+ * }
+ */
+export declare function TimedWithAccessor<T extends {
+    logger: Logger;
+}>(getLogger: (self: T) => Logger, label?: string): (_target: unknown, propertyKey: string, descriptor: PropertyDescriptor) => PropertyDescriptor;
+/**
+ * Decorator to log the duration of a method execution.
+ * @param {string} label - Optional label for the log message.
+ *
+ * Note: This decorator can be used on any class method that has a `logger` property.
+ * This method will throw an error if the `logger` property is not found on the class instance.
+ * If you are not using logger as a class property, you can use `LogDurationWithAccessor` instead.
+ * @constructor
+ *
+ * Example usage:
+ * class MyClass {
+ * 	private readonly logger = Container.get(Logger);
+ *
+ * 	@Timed()
+ * 	myMethod() {} // The log name here will be [myMethod]
+ *
+ * 	@Timed('MyClass.myMethod')
+ * 	myMethodWithOptName() {} // The log name here will be [MyClass.myMethod]
+ * }
+ */
+export declare function Timed<T extends {
+    logger: Logger;
+}>(label?: string): (_target: unknown, propertyKey: string, descriptor: PropertyDescriptor) => PropertyDescriptor;

package/http/decorators.js

@@ -0,0 +1,86 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.TimedWithAccessor = TimedWithAccessor;
+exports.Timed = Timed;
+const node_perf_hooks_1 = require("node:perf_hooks");
+/**
+ * Decorator to log the duration of a method execution by passing in an accessor function to retrieve the logger.
+ * @param getLogger - A function that takes the class instance and returns the logger instance.
+ * @param {string} label - Optional label for the log message.
+ *
+ * Note: If you are already using a logger as a class property, you can use the `Timed` decorator instead.
+ *
+ * @constructor
+ *
+ * Example usage:
+ * class MyClass {
+ *  @TimedWithAccessor(() => Container.get(LOGGER))
+ * 	async findAll() {} // The log name here will be [findAll]
+ * }
+ */
+function TimedWithAccessor(getLogger, label) {
+    return (_target, propertyKey, descriptor) => {
+        const originalMethod = descriptor.value;
+        // biome-ignore lint/suspicious/noExplicitAny: "any" is correct for this context
+        descriptor.value = function (...args) {
+            const logger = getLogger(this);
+            const labelToUse = label || propertyKey;
+            const start = node_perf_hooks_1.performance.now();
+            try {
+                const result = originalMethod.apply(this, args);
+                // async route, if it's a Promise.
+                if (result instanceof Promise) {
+                    return result
+                        .then((res) => {
+                        const duration = (node_perf_hooks_1.performance.now() - start).toFixed(2);
+                        logger.debug(`[${labelToUse}] took ${duration}ms`);
+                        return res;
+                    })
+                        .catch((err) => {
+                        const duration = (node_perf_hooks_1.performance.now() - start).toFixed(2);
+                        logger.debug(`[${labelToUse}] failed after ${duration}ms`);
+                        throw err;
+                    });
+                }
+                // Otherwise, sync method: log and return
+                const duration = (node_perf_hooks_1.performance.now() - start).toFixed(2);
+                logger.debug(`[${labelToUse}] took ${duration}ms`);
+                return result;
+            }
+            catch (err) {
+                const duration = (node_perf_hooks_1.performance.now() - start).toFixed(2);
+                logger.debug(`[${labelToUse}] failed after ${duration}ms`);
+                throw err;
+            }
+        };
+        return descriptor;
+    };
+}
+/**
+ * Decorator to log the duration of a method execution.
+ * @param {string} label - Optional label for the log message.
+ *
+ * Note: This decorator can be used on any class method that has a `logger` property.
+ * This method will throw an error if the `logger` property is not found on the class instance.
+ * If you are not using logger as a class property, you can use `LogDurationWithAccessor` instead.
+ * @constructor
+ *
+ * Example usage:
+ * class MyClass {
+ * 	private readonly logger = Container.get(Logger);
+ *
+ * 	@Timed()
+ * 	myMethod() {} // The log name here will be [myMethod]
+ *
+ * 	@Timed('MyClass.myMethod')
+ * 	myMethodWithOptName() {} // The log name here will be [MyClass.myMethod]
+ * }
+ */
+function Timed(label) {
+    return TimedWithAccessor((cls) => {
+        if (!cls.logger) {
+            throw new Error(`[${label}] Logger not found on decorated class.`);
+        }
+        return cls.logger;
+    }, label);
+}

package/http/index.d.ts

@@ -0,0 +1,36 @@
+export declare class HTTPError extends Error {
+    response: Response;
+    constructor(message: string, response: Response);
+}
+export declare class HTTP {
+    /**
+     * Performs an HTTP GET request.
+     * Note: This method will throw an HTTPError if the response is not ok (status code 200-299) to emulate Axios behaviour.
+     * @param url
+     * @param options
+     */
+    static get(url: string, options?: RequestInit): Promise<Response>;
+    /**
+     * Performs an HTTP POST request.
+     * Note: This method will throw an HTTPError if the response is not ok (status code 200-299) to emulate Axios behaviour.
+     * @param url
+     * @param body
+     * @param options
+     */
+    static post<T>(url: string, body: T, options?: RequestInit): Promise<Response>;
+    /**
+     * Performs an HTTP PUT request.
+     * Note: This method will throw an HTTPError if the response is not ok (status code 200-299) to emulate Axios behaviour.
+     * @param url
+     * @param body
+     * @param options
+     */
+    static put<T>(url: string, body: T, options?: RequestInit): Promise<Response>;
+    /**
+     * Performs an HTTP DELETE request.
+     * Note: This method will throw an HTTPError if the response is not ok (status code 200-299) to emulate Axios behaviour.
+     * @param url
+     * @param options
+     */
+    static delete(url: string, options?: RequestInit): Promise<Response>;
+}

package/http/index.js

@@ -0,0 +1,81 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.HTTP = exports.HTTPError = void 0;
+class HTTPError extends Error {
+    response;
+    constructor(message, response) {
+        super(message);
+        this.response = response;
+        this.name = "HTTPError";
+        this.response = response;
+    }
+}
+exports.HTTPError = HTTPError;
+// biome-ignore lint/complexity/noStaticOnlyClass: makes sense for an HTTP utility to encompass all methods
+class HTTP {
+    /**
+     * Performs an HTTP GET request.
+     * Note: This method will throw an HTTPError if the response is not ok (status code 200-299) to emulate Axios behaviour.
+     * @param url
+     * @param options
+     */
+    static async get(url, options) {
+        const response = await fetch(url, { method: "GET", ...options });
+        if (!response.ok) {
+            throw new HTTPError(`HTTP GET request failed with status ${response.status}`, response);
+        }
+        return response;
+    }
+    /**
+     * Performs an HTTP POST request.
+     * Note: This method will throw an HTTPError if the response is not ok (status code 200-299) to emulate Axios behaviour.
+     * @param url
+     * @param body
+     * @param options
+     */
+    static async post(url, body, options) {
+        const response = await fetch(url, {
+            method: "POST",
+            headers: { "Content-Type": "application/json", ...options?.headers },
+            body: JSON.stringify(body),
+            ...options,
+        });
+        if (!response.ok) {
+            throw new HTTPError(`HTTP POST request failed with status ${response.status}`, response);
+        }
+        return response;
+    }
+    /**
+     * Performs an HTTP PUT request.
+     * Note: This method will throw an HTTPError if the response is not ok (status code 200-299) to emulate Axios behaviour.
+     * @param url
+     * @param body
+     * @param options
+     */
+    static async put(url, body, options) {
+        const response = await fetch(url, {
+            method: "PUT",
+            headers: { "Content-Type": "application/json", ...options?.headers },
+            body: JSON.stringify(body),
+            ...options,
+        });
+        if (!response.ok) {
+            throw new HTTPError(`HTTP PUT request failed with status ${response.status}`, response);
+        }
+        return response;
+    }
+    /**
+     * Performs an HTTP DELETE request.
+     * Note: This method will throw an HTTPError if the response is not ok (status code 200-299) to emulate Axios behaviour.
+     * @param url
+     * @param options
+     */
+    static async delete(url, options) {
+        const response = await fetch(url, { method: "DELETE", ...options });
+        if (!response.ok) {
+            throw new HTTPError(`HTTP DELETE request failed with status ${response.status}`, response);
+        }
+        return response;
+    }
+}
+exports.HTTP = HTTP;

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@dvsa/appdev-api-common",
-	"version": "0.7.0",
+	"version": "0.8.1",
 	"keywords": ["dvsa", "nodejs", "typescript"],
 	"author": "DVSA",
 	"description": "Utils library for common API functionality",
@@ -29,6 +29,7 @@
 		"jose": "^5.9.6"
 	},
 	"devDependencies": {
+		"@aws-lambda-powertools/logger": "^2.22.0",
 		"@biomejs/biome": "1.9.3",
 		"@dvsa/biome-config": "0.3.0",
 		"@types/aws-lambda": "^8.10.145",