feat: adding high order function to wrap as validator

.gitignore

@@ -1,2 +1,2 @@
 node_modules/
-dist/
+dist/

src/functions/create-auction.ts

@@ -2,8 +2,9 @@ import { apis, baseURL } from "../constants/apis.constant";
 import type { AuctionResult, TopsortAuction } from "../interfaces/auctions.interface";
 import type { Config } from "../interfaces/shared.interface";
 import APIClient from "../lib/api-client";
+import { withValidation } from "../lib/with-validation";
 
-export async function createAuction(body: TopsortAuction, config: Config): Promise<AuctionResult> {
+async function handler(config: Config, body: TopsortAuction): Promise<AuctionResult> {
   let url: URL;
   try {
     url = new URL(`${config.host || baseURL}/${apis.auctions}`);
@@ -14,3 +15,5 @@ export async function createAuction(body: TopsortAuction, config: Config): Promi
   const result = await APIClient.post(url.toString(), body, config);
   return result as AuctionResult;
 }
+
+export const createAuction = withValidation(handler);

src/functions/report-event.ts

@@ -2,23 +2,24 @@ import { apis, baseURL } from "../constants/apis.constant";
 import type { TopsortEvent } from "../interfaces/events.interface";
 import type { Config } from "../interfaces/shared.interface";
 import APIClient from "../lib/api-client";
+import { withValidation } from "../lib/with-validation";
 
 /**
  * Reports an event to the Topsort API.
  *
  * @example
  * ```js
  * const event = { eventType: "test", eventData: {} };
- * const config = { token: "my-token" };
+ * const config = { apiKey: "api-key" };
  * const result = await reportEvent(event, config);
- * console.log(result); // { "ok": true, "retry": false }
+ * console.log(result); // { "ok": true }
  * ```
  *
  * @param event - The event to report.
- * @param config - The configuration object containing URL and token.
- * @returns {Promise<{ok: boolean}>} The result of the report, indicating success and if a retry is needed.
+ * @param config - The configuration object containing the API Key and optionally, the Host.
+ * @returns {Promise<{ok: boolean}>} The result of the report, indicating success.
  */
-export async function reportEvent(event: TopsortEvent, config: Config): Promise<{ ok: boolean }> {
+async function handler(config: Config, event: TopsortEvent): Promise<{ ok: boolean }> {
   let url: URL;
   try {
     url = new URL(`${config.host || baseURL}/${apis.events}`);
@@ -32,3 +33,5 @@ export async function reportEvent(event: TopsortEvent, config: Config): Promise<
     ok: true,
   };
 }
+
+export const reportEvent = withValidation(handler);

src/index.ts

@@ -1,3 +1,3 @@
-export * from "./functions/report-event";
-export * from "./functions/create-auction";
+export { reportEvent } from "./functions/report-event";
+export { createAuction } from "./functions/create-auction";
 export * from "./interfaces/events.interface";

src/lib/validate-config.ts

@@ -0,0 +1,8 @@
+import type { Config } from "../interfaces/shared.interface";
+import AppError from "./app-error";
+
+export function validateConfig(config: Config): void {
+  if (!config.apiKey) {
+    throw new AppError(401, "API Key is required.", {});
+  }
+}

src/lib/with-validation.ts

@@ -0,0 +1,11 @@
+import type { Config } from "../interfaces/shared.interface";
+import { validateConfig } from "./validate-config";
+
+export function withValidation<T extends Config, U, Args extends unknown[]>(
+  fn: (config: T, ...args: Args) => Promise<U>,
+): (config: T, ...args: Args) => Promise<U> {
+  return async (config: T, ...args: Args): Promise<U> => {
+    validateConfig(config);
+    return fn(config, ...args);
+  };
+}

src/tests/report-event.test.ts

@@ -15,7 +15,7 @@ describe("reportEvent", () => {
   it("should handle permanent error", async () => {
     returnStatus(400, server, `${baseURL}/${apis.events}`);
 
-    await expect(reportEvent({} as TopsortEvent, { apiKey: "apiKey" })).rejects.toEqual({
+    await expect(reportEvent({ apiKey: "apiKey" }, {} as TopsortEvent)).rejects.toEqual({
       status: 400,
       statusText: "",
       body: {},
@@ -24,7 +24,7 @@ describe("reportEvent", () => {
 
   it("should handle authentication error", async () => {
     returnStatus(401, server, `${baseURL}/${apis.events}`);
-    await expect(reportEvent({} as TopsortEvent, { apiKey: "apiKey" })).rejects.toEqual({
+    await expect(reportEvent({ apiKey: "apiKey" }, {} as TopsortEvent)).rejects.toEqual({
       status: 401,
       statusText: "",
       body: {},
@@ -33,7 +33,7 @@ describe("reportEvent", () => {
 
   it("should handle retryable error", async () => {
     returnStatus(429, server, `${baseURL}/${apis.events}`);
-    await expect(reportEvent({} as TopsortEvent, { apiKey: "apiKey" })).rejects.toEqual({
+    await expect(reportEvent({ apiKey: "apiKey" }, {} as TopsortEvent)).rejects.toEqual({
       status: 429,
       statusText: "",
       body: {},
@@ -42,7 +42,7 @@ describe("reportEvent", () => {
 
   it("should handle server error", async () => {
     returnStatus(500, server, `${baseURL}/${apis.events}`);
-    await expect(reportEvent({} as TopsortEvent, { apiKey: "apiKey" })).rejects.toEqual({
+    await expect(reportEvent({ apiKey: "apiKey" }, {} as TopsortEvent)).rejects.toEqual({
       status: 500,
       statusText: "",
       body: {},
@@ -52,10 +52,13 @@ describe("reportEvent", () => {
   it("should handle custom url", async () => {
     returnStatus(200, server, `https://demo.api.topsort.com/${apis.events}`);
     await expect(
-      reportEvent({} as TopsortEvent, {
-        apiKey: "apiKey",
-        host: "https://demo.api.topsort.com",
-      }),
+      reportEvent(
+        {
+          apiKey: "apiKey",
+          host: "https://demo.api.topsort.com",
+        },
+        {} as TopsortEvent,
+      ),
     ).resolves.toEqual({ ok: true });
   });
 });