@arkyn/server 3.0.1-beta.4 → 3.0.1-beta.41

package/src/api/arkynLogRequest.ts

@@ -1,4 +1,4 @@
-import { ArkynLogInstance } from "../config/arkynLogInstance";
+import { ArkynLogService } from "../services/arkynLogService";
 import { httpDebug } from "../services/httpDebug";
 
 type ConfigProps = {
@@ -30,7 +30,7 @@ type ConfigProps = {
  * @param config.responseBody - The body of the response received.
  *
  * @remarks
- * - This function retrieves the inbox flow configuration using `InboxFlowInstance.getInboxConfig()`.
+ * - This function retrieves the inbox flow configuration using `InboxFlowService.getInboxConfig()`.
  * - If the configuration is not available, the function will return early without performing any action.
  * - In a development environment (`NODE_ENV === "development"`), the function will also return early.
  * - The request is sent as a POST request to the inbox API URL with the provided configuration details.
@@ -56,10 +56,10 @@ type ConfigProps = {
  */
 
 async function arkynLogRequest(config: ConfigProps) {
-  const arkynInstance = ArkynLogInstance.getArkynConfig();
-  if (!arkynInstance) return;
+  const arkynService = ArkynLogService.getArkynConfig();
+  if (!arkynService) return;
 
-  const { arkynApiUrl, arkynUserToken } = arkynInstance;
+  const { arkynUserToken, arkynApiUrl } = arkynService;
 
   const {
     elapsedTime,
@@ -74,7 +74,7 @@ async function arkynLogRequest(config: ConfigProps) {
     rawUrl,
   } = config;
 
-  if (process.env.NODE_ENV === "development") return;
+  // if (process.env.NODE_ENV === "development") return;
 
   try {
     const url = new URL(rawUrl);
@@ -96,14 +96,20 @@ async function arkynLogRequest(config: ConfigProps) {
       responseBody,
     });
 
-    await fetch(arkynApiUrl, {
-      method: "POST",
-      body,
-      headers: {
-        "Content-Type": "application/json",
-        Authorization: `Bearer ${arkynUserToken}`,
-      },
-    });
+    await fetch(
+      arkynApiUrl.replace(
+        ":trafficSourceId",
+        arkynService.arkynTrafficSourceId
+      ),
+      {
+        method: "POST",
+        body,
+        headers: {
+          "Content-Type": "application/json",
+          Authorization: `Bearer ${arkynUserToken}`,
+        },
+      }
+    );
   } catch (err) {
     httpDebug("arkyn log error", "Error sending request", err);
   }

package/src/api/makeRequest.ts

@@ -41,7 +41,7 @@ import { arkynLogRequest } from "./arkynLogRequest";
 async function makeRequest<T = any>(
   method: "POST" | "PUT" | "DELETE" | "PATCH" | "GET",
   url: string,
-  headers: HeadersInit = {},
+  rawHeaders: HeadersInit = {},
   body?: any
 ): Promise<ApiResponseDTO<T>> {
   const successMessage = {
@@ -55,12 +55,10 @@ async function makeRequest<T = any>(
   try {
     const startTime = performance.now();
 
+    const headers = { ...rawHeaders, "Content-Type": "application/json" };
     const response = await fetch(url, {
       method,
-      headers: {
-        ...headers,
-        "Content-Type": "application/json",
-      },
+      headers,
       body: body ? JSON.stringify(body) : undefined,
     });
 

package/src/index.ts

@@ -1,7 +1,3 @@
-// config
-export { ApiInstance } from "./config/apiInstance";
-export { ArkynLogInstance } from "./config/arkynLogInstance";
-
 // http bad responses
 export { BadGateway } from "./http/badResponses/badGateway";
 export { BadRequest } from "./http/badResponses/badRequest";
@@ -21,11 +17,13 @@ export { Success } from "./http/successResponses/success";
 export { Updated } from "./http/successResponses/updated";
 
 // services
+export { ApiService } from "./services/apiService";
+export { ArkynLogService } from "./services/arkynLogService";
 export { decodeErrorMessageFromRequest } from "./services/decodeErrorMessageFromRequest";
 export { decodeRequestBody } from "./services/decodeRequestBody";
 export { errorHandler } from "./services/errorHandler";
 export { formParse } from "./services/formParse";
 export { getCaller } from "./services/getCaller";
 export { getScopedParams } from "./services/getScopedParams";
-export { httpDebug } from "./services/httpDebug";
+export { httpDebug, HttpDebugService } from "./services/httpDebug";
 export { SchemaValidator } from "./services/schemaValidator";

package/src/mapper/arkynLogRequestMapper.ts

@@ -62,10 +62,10 @@ class ArkynLogRequestMapper {
       token: null,
       elapsedTime: props.elapsedTime,
       requestHeaders: this.mapHeaders(props.requestHeaders),
-      requestBody: props.requestBody,
+      requestBody: props.requestBody || null,
       queryParams: this.mapQueryParams(props.queryParams),
       responseHeaders: this.mapHeaders(props.responseHeaders),
-      responseBody: props.responseBody,
+      responseBody: props.responseBody || null,
     };
   }
 }

package/src/{config/apiInstance.ts → services/apiService.ts}

@@ -4,7 +4,7 @@ import { patchRequest } from "../api/patchRequest";
 import { postRequest } from "../api/postRequest";
 import { putRequest } from "../api/putRequest";
 
-type ApiInstanceContructorProps = {
+type ApiServiceConstructorProps = {
   baseUrl: string;
   baseHeaders?: HeadersInit;
   baseToken?: string | null;
@@ -25,20 +25,20 @@ type ApiRequestDataWithBodyProps = {
  * Class representing an API instance to handle HTTP requests with base configurations.
  */
 
-class ApiInstance {
+class ApiService {
   private baseUrl: string;
   private baseHeaders?: HeadersInit;
   private baseToken?: string;
 
   /**
-   * Creates an instance of ApiInstance.
+   * Creates an instance of ApiService.
    * @param props - The configuration properties for the API instance.
    * @param props.baseUrl - The base URL for the API.
    * @param props.baseHeaders - Optional base headers to include in all requests.
    * @param props.baseToken - Optional base token for authorization.
    */
 
-  constructor(props: ApiInstanceContructorProps) {
+  constructor(props: ApiServiceConstructorProps) {
     this.baseUrl = props.baseUrl;
     this.baseHeaders = props.baseHeaders || undefined;
     this.baseToken = props.baseToken || undefined;
@@ -76,26 +76,26 @@ class ApiInstance {
   }
 
   /**
-   * Sends a GET request to the specified route.
-   * @param route - The API route to send the GET request to.
+   * Sends a get request to the specified route.
+   * @param route - The API route to send the get request to.
    * @param data - The request data, including optional headers and token.
    * @returns The API response data.
    */
 
-  async GET(route: string, data?: ApiRequestDataWithoutBodyProps) {
+  async get(route: string, data?: ApiRequestDataWithoutBodyProps) {
     const url = this.generateURL(route);
     const headers = this.generateHeaders(data?.headers || {}, data?.token);
     return await getRequest(url, headers);
   }
 
   /**
-   * Sends a POST request to the specified route.
-   * @param route - The API route to send the POST request to.
+   * Sends a post request to the specified route.
+   * @param route - The API route to send the post request to.
    * @param data - The request data, including body, optional headers, and token.
    * @returns The API response data.
    */
 
-  async POST(route: string, data?: ApiRequestDataWithBodyProps) {
+  async post(route: string, data?: ApiRequestDataWithBodyProps) {
     const url = this.generateURL(route);
     const headers = this.generateHeaders(data?.headers || {}, data?.token);
     const body = data?.body;
@@ -103,13 +103,13 @@ class ApiInstance {
   }
 
   /**
-   * Sends a PUT request to the specified route.
-   * @param route - The API route to send the PUT request to.
+   * Sends a put request to the specified route.
+   * @param route - The API route to send the put request to.
    * @param data - The request data, including body, optional headers, and token.
    * @returns The API response data.
    */
 
-  async PUT(route: string, data?: ApiRequestDataWithBodyProps) {
+  async put(route: string, data?: ApiRequestDataWithBodyProps) {
     const url = this.generateURL(route);
     const headers = this.generateHeaders(data?.headers || {}, data?.token);
     const body = data?.body;
@@ -117,13 +117,13 @@ class ApiInstance {
   }
 
   /**
-   * Sends a PATCH request to the specified route.
-   * @param route - The API route to send the PATCH request to.
+   * Sends a patch request to the specified route.
+   * @param route - The API route to send the patch request to.
    * @param data - The request data, including body, optional headers, and token.
    * @returns The API response data.
    */
 
-  async PATCH(route: string, data?: ApiRequestDataWithBodyProps) {
+  async patch(route: string, data?: ApiRequestDataWithBodyProps) {
     const url = this.generateURL(route);
     const headers = this.generateHeaders(data?.headers || {}, data?.token);
     const body = data?.body;
@@ -131,13 +131,13 @@ class ApiInstance {
   }
 
   /**
-   * Sends a DELETE request to the specified route.
-   * @param route - The API route to send the DELETE request to.
+   * Sends a delete request to the specified route.
+   * @param route - The API route to send the delete request to.
    * @param data - The request data, including body, optional headers, and token.
    * @returns The API response data.
    */
 
-  async DELETE(route: string, data?: ApiRequestDataWithBodyProps) {
+  async delete(route: string, data?: ApiRequestDataWithBodyProps) {
     const url = this.generateURL(route);
     const headers = this.generateHeaders(data?.headers || {}, data?.token);
     const body = data?.body;
@@ -145,4 +145,4 @@ class ApiInstance {
   }
 }
 
-export { ApiInstance };
+export { ApiService };

package/src/{config/arkynLogInstance.ts → services/arkynLogService.ts}

@@ -11,12 +11,12 @@ type SetArkynConfigProps = {
 };
 
 /**
- * The `ArkynLogInstance` class manages the configuration for the arkyn flow.
+ * The `ArkynLogService` class manages the configuration for the arkyn flow.
  * It allows you to set and retrieve the arkyn configuration, including the traffic source ID,
  * user token, and API URL.
  */
 
-class ArkynLogInstance {
+class ArkynLogService {
   private static arkynConfig?: ArkynConfigProps;
 
   /**
@@ -40,11 +40,6 @@ class ArkynLogInstance {
     arkynLogBaseApiUrl =
       arkynLogBaseApiUrl + "/http-traffic-records/:trafficSourceId";
 
-    arkynLogBaseApiUrl.replace(
-      ":trafficSourceId",
-      arkynConfig.arkynTrafficSourceId
-    );
-
     this.arkynConfig = {
       arkynTrafficSourceId: arkynConfig.arkynTrafficSourceId,
       arkynUserToken: arkynConfig.arkynUserToken,
@@ -53,7 +48,7 @@ class ArkynLogInstance {
   }
 
   /**
-   * Retrieves the current arkyn configuration for the ArkynLogInstance.
+   * Retrieves the current arkyn configuration for the ArkynLogService.
    *
    * @returns {ArkynConfigProps | undefined} The current arkyn configuration if set,
    * or `undefined` if no configuration has been initialized.
@@ -72,4 +67,4 @@ class ArkynLogInstance {
   }
 }
 
-export { ArkynLogInstance };
+export { ArkynLogService };

package/src/services/formParse.ts

@@ -1,8 +1,8 @@
-import type { Schema } from "zod";
+import type { ZodType } from "zod";
 
 type SuccessResponse<T extends FormParseProps> = {
   success: true;
-  data: T[1] extends Schema<infer U> ? U : never;
+  data: T[1] extends ZodType<infer U> ? U : never;
 };
 
 type ErrorResponse = {
@@ -11,7 +11,7 @@ type ErrorResponse = {
   fieldErrors: { [x: string]: string };
 };
 
-type FormParseProps = [formData: { [k: string]: any }, schema: Schema];
+type FormParseProps = [formData: { [k: string]: any }, schema: ZodType];
 
 type FormParseReturnType<T extends FormParseProps> =
   | SuccessResponse<T>
@@ -64,10 +64,10 @@ function formParse<T extends FormParseProps>([
 
   if (zodResponse.success === false) {
     const errorsObject = Object.fromEntries(
-      zodResponse.error.errors.map((item) => [
-        item.path.join("."),
-        item.message,
-      ])
+      zodResponse.error.issues.map((item) => {
+        console.log(item);
+        return [item.path.join("."), item.message];
+      })
     );
 
     return {
@@ -76,7 +76,10 @@ function formParse<T extends FormParseProps>([
       fields: formData,
     };
   } else {
-    return { success: zodResponse.success, data: zodResponse.data };
+    return {
+      success: zodResponse.success,
+      data: zodResponse.data as T[1] extends ZodType<infer U> ? U : never,
+    };
   }
 }
 

package/src/services/getCaller.ts

@@ -1,4 +1,5 @@
 import path from "path";
+import { HttpDebugService } from "./httpDebug";
 
 /**
  * Retrieves information about the caller of the current function.
@@ -11,6 +12,7 @@ import path from "path";
  * - `functionName`: The name of the function that called the current function, or "Unknown function" if it cannot be determined.
  * - `callerInfo`: The file path of the caller relative to the project root, or "Unknown caller" if it cannot be determined.
  */
+
 function getCaller() {
   const projectRoot = process.cwd();
 
@@ -18,13 +20,10 @@ function getCaller() {
   const stack = err.stack || "";
   const stackLines = stack.split("\n").map((line) => line.trim());
 
-  // The first line is the error message
-  // The second line is this function (getCaller)
-  // The third line should be the direct caller
-  // We start from 2 because indexes are zero-based
+  const ignoreFile = HttpDebugService.ignoreFile;
+
   let callerIndex = 2;
 
-  // Ignore internal or infrastructure lines if necessary
   while (
     callerIndex < stackLines.length &&
     (stackLines[callerIndex].includes("node:internal") ||
@@ -33,24 +32,29 @@ function getCaller() {
     callerIndex++;
   }
 
+  if (ignoreFile) {
+    while (
+      callerIndex < stackLines.length &&
+      stackLines[callerIndex].includes(ignoreFile)
+    ) {
+      callerIndex++;
+    }
+  }
+
   const callerLine = stackLines[callerIndex] || "";
 
   let functionName = "Unknown function";
   let callerInfo = "Unknown caller";
 
-  // Default for named functions: "at functionName (file:line:column)"
   const namedFunctionMatch = callerLine.match(/at\s+([^(\s]+)\s+\(([^)]+)\)/);
   if (namedFunctionMatch) {
     functionName = namedFunctionMatch[1];
     callerInfo = namedFunctionMatch[2];
-  }
-  // Default for anonymous functions or methods: "at file:line:column"
-  else {
+  } else {
     const anonymousFunctionMatch = callerLine.match(/at\s+(.+)/);
     if (anonymousFunctionMatch) {
       callerInfo = anonymousFunctionMatch[1];
 
-      // Tenta extrair nome da função de padrões como Object.method ou Class.method
       const objectMethodMatch = callerInfo.match(/at\s+([^(\s]+)\s+/);
       if (objectMethodMatch && objectMethodMatch[1] !== "new") {
         functionName = objectMethodMatch[1];
@@ -58,7 +62,6 @@ function getCaller() {
     }
   }
 
-  // Handles file paths
   if (callerInfo.includes("(")) {
     callerInfo = callerInfo.substring(
       callerInfo.indexOf("(") + 1,
@@ -66,15 +69,11 @@ function getCaller() {
     );
   }
 
-  // Remove the line:column part of the file path
   callerInfo = callerInfo.split(":").slice(0, -2).join(":");
 
-  // Make the path relative to the project
   try {
     callerInfo = path.relative(projectRoot, callerInfo);
-  } catch (e) {
-    // If it fails to relativize, use the original path
-  }
+  } catch (e) {}
 
   return { functionName, callerInfo };
 }

package/src/services/httpDebug.ts

@@ -1,5 +1,48 @@
 import { getCaller } from "../services/getCaller";
 
+/**
+ * Service for managing HTTP debug configuration and behavior.
+ *
+ * This service provides functionality to configure how the `getCaller` function
+ * identifies the actual caller in the stack trace by allowing specific files
+ * to be ignored during stack trace analysis.
+ *
+ * @example
+ * ```typescript
+ * // Configure to ignore httpAdapter.ts in stack traces
+ * HttpDebugService.setIgnoreFile("httpAdapter.ts");
+ *
+ * // Now when httpDebug is called from within httpAdapter.ts,
+ * // it will show the actual caller (e.g., cart.ts) instead
+ * ```
+ */
+class HttpDebugService {
+  /**
+   * The name of the file to ignore when analyzing the stack trace.
+   * When set, the `getCaller` function will skip stack frames containing this file name.
+   */
+  static ignoreFile?: string;
+
+  /**
+   * Sets the file name to be ignored during stack trace analysis.
+   *
+   * This method configures the debug service to skip specific files when
+   * determining the actual caller of a function. This is useful when you have
+   * adapter or wrapper functions that you want to be transparent in the debug output.
+   *
+   * @param file - The name of the file to ignore in stack traces (e.g., "httpAdapter.ts")
+   *
+   * @example
+   * ```typescript
+   * // Ignore the HTTP adapter file so debug shows the actual business logic caller
+   * HttpDebugService.setIgnoreFile("httpAdapter.ts");
+   * ```
+   */
+  static setIgnoreFile(file: string) {
+    this.ignoreFile = file;
+  }
+}
+
 /**
  * Logs debug information to the console when in development mode or when the
  * `SHOW_ERRORS_IN_CONSOLE` environment variable is set to "true".
@@ -58,4 +101,4 @@ function httpDebug(name: string, body: any, cause?: any) {
   }
 }
 
-export { httpDebug };
+export { httpDebug, HttpDebugService };

package/src/services/measureRouteExecution.ts

@@ -0,0 +1,31 @@
+function measureRouteExecution<T = unknown>(
+  handler: (props: any) => Promise<T>
+) {
+  return async function measuredHandler(props: any): Promise<T> {
+    const startTime = performance.now();
+
+    try {
+      const result = await handler(props);
+
+      const url = new URL(props.request.url);
+      const endTime = performance.now();
+
+      const duration = (endTime - startTime).toFixed(2);
+
+      console.log({
+        domain: url.hostname,
+        pathname: url.pathname,
+        method: props.request.method,
+        duration,
+      });
+
+      return result as T;
+    } catch (error) {
+      const endTime = performance.now();
+      console.error("");
+      throw error;
+    }
+  };
+}
+
+export { measureRouteExecution };

package/src/services/schemaValidator.ts

@@ -1,4 +1,4 @@
-import { Schema, z } from "zod";
+import { ZodType, z } from "zod";
 
 import { ServerError } from "../http/badResponses/serverError";
 import { UnprocessableEntity } from "../http/badResponses/unprocessableEntity";
@@ -15,7 +15,7 @@ function formatErrorMessage(error: z.ZodError) {
   return [title, ...lines].join("\n");
 }
 
-class SchemaValidator<T extends Schema> {
+class SchemaValidator<T extends ZodType> {
   functionName: string;
   callerInfo: string;
 
@@ -29,7 +29,7 @@ class SchemaValidator<T extends Schema> {
     return this.schema.safeParse(data).success;
   }
 
-  safeValidate(data: any): z.SafeParseReturnType<z.infer<T>, z.infer<T>> {
+  safeValidate(data: any): z.ZodSafeParseResult<z.infer<T>> {
     return this.schema.safeParse(data);
   }
 
@@ -59,7 +59,7 @@ class SchemaValidator<T extends Schema> {
       );
     }
 
-    return formParsed.data;
+    return formParsed.data as z.infer<T>;
   }
 }
 

package/dist/config/arkynLogInstance.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"arkynLogInstance.d.ts","sourceRoot":"","sources":["../../src/config/arkynLogInstance.ts"],"names":[],"mappings":"AAAA,KAAK,gBAAgB,GAAG;IACtB,oBAAoB,EAAE,MAAM,CAAC;IAC7B,cAAc,EAAE,MAAM,CAAC;IACvB,WAAW,EAAE,MAAM,CAAC;CACrB,CAAC;AAEF,KAAK,mBAAmB,GAAG;IACzB,oBAAoB,EAAE,MAAM,CAAC;IAC7B,cAAc,EAAE,MAAM,CAAC;IACvB,kBAAkB,CAAC,EAAE,MAAM,CAAC;CAC7B,CAAC;AAEF;;;;GAIG;AAEH,cAAM,gBAAgB;IACpB,OAAO,CAAC,MAAM,CAAC,WAAW,CAAC,CAAmB;IAE9C;;;;;;;;;;OAUG;IAEH,MAAM,CAAC,cAAc,CAAC,WAAW,EAAE,mBAAmB;IAqBtD;;;;;OAKG;IACH,MAAM,CAAC,cAAc,IAAI,gBAAgB,GAAG,SAAS;IAIrD;;;OAGG;IAEH,MAAM,CAAC,gBAAgB;CAGxB;AAED,OAAO,EAAE,gBAAgB,EAAE,CAAC"}

package/tsconfig.json

@@ -1,21 +0,0 @@
-{
-  "compilerOptions": {
-    "allowSyntheticDefaultImports": true,
-    "declaration": true,
-    "declarationDir": "./dist",
-    "declarationMap": true,
-    "isolatedModules": true,
-    "lib": ["DOM", "DOM.Iterable", "ES2022"],
-    "module": "ESNext",
-    "moduleResolution": "node",
-    "outDir": "./dist",
-    "preserveWatchOutput": true,
-    "skipLibCheck": true,
-    "strict": true,
-    "target": "ESNext",
-    "types": ["bun-types"],
-    "verbatimModuleSyntax": true
-  },
-  "exclude": ["node_modules", "dist"],
-  "include": ["src/**/*.ts"]
-}

package/vitest.config.ts

@@ -1,5 +0,0 @@
-import { defineConfig } from "vite";
-
-export default defineConfig({
-  resolve: { mainFields: ["module"] },
-});