@arkyn/server 3.0.1-beta.3 → 3.0.1-beta.30

package/src/services/errorHandler.ts

@@ -1,99 +0,0 @@
-import { BadGateway } from "../http/badResponses/badGateway";
-import { BadRequest } from "../http/badResponses/badRequest";
-import { Conflict } from "../http/badResponses/conflict";
-import { Forbidden } from "../http/badResponses/forbidden";
-import { NotFound } from "../http/badResponses/notFound";
-import { NotImplemented } from "../http/badResponses/notImplemented";
-import { ServerError } from "../http/badResponses/serverError";
-import { Unauthorized } from "../http/badResponses/unauthorized";
-import { UnprocessableEntity } from "../http/badResponses/unprocessableEntity";
-
-import { Created } from "../http/successResponses/created";
-import { Found } from "../http/successResponses/found";
-import { NoContent } from "../http/successResponses/noContent";
-import { Success } from "../http/successResponses/success";
-import { Updated } from "../http/successResponses/updated";
-
-/**
- * Handles errors and converts them into appropriate HTTP responses.
- *
- * This function takes an error object and determines its type to return
- * the corresponding HTTP response. It supports both success and error
- * response types, converting them into a standardized format using the
- * `toResponse` method when applicable.
- *
- * @param error - The error object to handle. It can be an instance of various
- * HTTP response classes or a generic error.
- *
- * @returns The corresponding HTTP response object if the error matches a known
- * type, or `undefined` if no match is found.
- *
- * ### Supported Success Responses:
- * - `Found`
- * - `Created`
- * - `Updated`
- * - `Success`
- * - `NoContent`
- *
- * ### Supported Error Responses:
- * - `BadGateway`
- * - `BadRequest`
- * - `Conflict`
- * - `Forbidden`
- * - `NotFound`
- * - `NotImplemented`
- * - `ServerError`
- * - `Unauthorized`
- * - `UnprocessableEntity`
- *
- * ### Example Usage:
- * ```typescript
- * try {
- *   // Some operation that might throw an error
- * } catch (error) {
- *   return errorHandler(error);
- * }
- * ```
- */
-
-function errorHandler(error: any): Response {
-  switch (true) {
-    case error instanceof Response:
-      return error;
-    case error instanceof Found:
-      return error.toResponse();
-    case error instanceof Created:
-      return error.toResponse();
-    case error instanceof Updated:
-      return error.toResponse();
-    case error instanceof Success:
-      return error.toResponse();
-    case error instanceof NoContent:
-      return error.toResponse();
-  }
-
-  switch (true) {
-    case error instanceof BadGateway:
-      return error.toResponse();
-    case error instanceof BadRequest:
-      return error.toResponse();
-    case error instanceof Conflict:
-      return error.toResponse();
-    case error instanceof Forbidden:
-      return error.toResponse();
-    case error instanceof NotFound:
-      return error.toResponse();
-    case error instanceof NotImplemented:
-      return error.toResponse();
-    case error instanceof ServerError:
-      return error.toResponse();
-    case error instanceof Unauthorized:
-      return error.toResponse();
-    case error instanceof UnprocessableEntity:
-      return error.toResponse();
-  }
-
-  return new ServerError("Server error", error).toResponse();
-}
-
-export { errorHandler };

package/src/services/formParse.ts

@@ -1,83 +0,0 @@
-import type { Schema } from "zod";
-
-type SuccessResponse<T extends FormParseProps> = {
-  success: true;
-  data: T[1] extends Schema<infer U> ? U : never;
-};
-
-type ErrorResponse = {
-  success: false;
-  fields: { [x: string]: string };
-  fieldErrors: { [x: string]: string };
-};
-
-type FormParseProps = [formData: { [k: string]: any }, schema: Schema];
-
-type FormParseReturnType<T extends FormParseProps> =
-  | SuccessResponse<T>
-  | ErrorResponse;
-
-/**
- * Parses form data using a Zod schema and returns the result.
- *
- * @template T - A type that extends `FormParseProps`.
- *
- * @param {T} param0 - An array containing the form data and the Zod schema.
- * @param {T[0]} param0[0] - The form data to be validated.
- * @param {T[1]} param0[1] - The Zod schema used for validation.
- *
- * @returns {FormParseReturnType<T>} An object containing the validation result.
- * - If validation fails, it includes:
- *   - `success`: A boolean indicating the validation status (false).
- *   - `fieldErrors`: An object mapping field names to their respective error messages.
- *   - `fields`: The original form data.
- * - If validation succeeds, it includes:
- *   - `success`: A boolean indicating the validation status (true).
- *   - `data`: The parsed and validated data.
- *
- * @example
- * ```typescript
- * import { z } from "zod";
- *
- * const schema = z.object({
- *   name: z.string().min(1, "Name is required"),
- *   age: z.number().min(18, "Must be at least 18"),
- * });
- *
- * const formData = { name: "", age: 17 };
- *
- * const result = formParse([formData, schema]);
- *
- * if (!result.success) {
- *   console.log(result.fieldErrors); // { name: "Name is required", age: "Must be at least 18" }
- * } else {
- *   console.log(result.data); // Parsed data
- * }
- * ```
- */
-
-function formParse<T extends FormParseProps>([
-  formData,
-  schema,
-]: T): FormParseReturnType<T> {
-  const zodResponse = schema.safeParse(formData);
-
-  if (zodResponse.success === false) {
-    const errorsObject = Object.fromEntries(
-      zodResponse.error.errors.map((item) => [
-        item.path.join("."),
-        item.message,
-      ])
-    );
-
-    return {
-      success: zodResponse.success,
-      fieldErrors: errorsObject,
-      fields: formData,
-    };
-  } else {
-    return { success: zodResponse.success, data: zodResponse.data };
-  }
-}
-
-export { formParse };

package/src/services/getCaller.ts

@@ -1,82 +0,0 @@
-import path from "path";
-
-/**
- * Retrieves information about the caller of the current function.
- *
- * This function analyzes the stack trace to determine the file path and function name
- * of the caller. It excludes stack trace entries related to the `@arkyn/server` package
- * and attempts to resolve the file path relative to the project root directory.
- *
- * @returns An object containing:
- * - `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();
-
-  const err = new Error();
-  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
-  let callerIndex = 2;
-
-  // Ignore internal or infrastructure lines if necessary
-  while (
-    callerIndex < stackLines.length &&
-    (stackLines[callerIndex].includes("node:internal") ||
-      stackLines[callerIndex].includes("/node_modules/"))
-  ) {
-    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 {
-    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];
-      }
-    }
-  }
-
-  // Handles file paths
-  if (callerInfo.includes("(")) {
-    callerInfo = callerInfo.substring(
-      callerInfo.indexOf("(") + 1,
-      callerInfo.lastIndexOf(")")
-    );
-  }
-
-  // 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
-  }
-
-  return { functionName, callerInfo };
-}
-
-export { getCaller };

package/src/services/getScopedParams.ts

@@ -1,43 +0,0 @@
-type GetScopedParamsFunction = (
-  request: Request,
-  scope?: string
-) => URLSearchParams;
-/**
- * Extracts and returns scoped query parameters from a request URL.
- *
- * @param request - The incoming request object containing the URL.
- * @param scope - An optional string representing the scope prefix for filtering query parameters.
- *                If no scope is provided, all query parameters are returned.
- *
- * @returns A `URLSearchParams` object containing the scoped query parameters.
- *          If a scope is provided, only parameters with keys starting with the scope
- *          (e.g., `scope:key`) are included, and the scope prefix is removed from the keys.
- *          If no scope is provided, all query parameters are returned as-is.
- *
- * @example
- * // Example 1: No scope provided
- * const request = { url: "https://example.com?key1=value1&key2=value2" };
- * const params = getScopedParams(request);
- * console.log(params.toString()); // Output: "key1=value1&key2=value2"
- *
- * @example
- * // Example 2: Scope provided
- * const request = { url: "https://example.com?scope:key1=value1&scope:key2=value2&key3=value3" };
- * const params = getScopedParams(request, "scope");
- * console.log(params.toString()); // Output: "key1=value1&key2=value2"
- */
-
-const getScopedParams: GetScopedParamsFunction = (request, scope = "") => {
-  const url = new URL(request.url);
-  if (scope === "") return url.searchParams;
-
-  const scopedSearchParams: [string, string][] = Array.from(
-    url.searchParams.entries()
-  )
-    .filter(([key]) => key.startsWith(`${scope}:`))
-    .map(([key, value]) => [key.replace(`${scope}:`, ""), value]);
-
-  return new URLSearchParams(scopedSearchParams);
-};
-
-export { getScopedParams };

package/src/services/httpDebug.ts

@@ -1,61 +0,0 @@
-import { getCaller } from "../services/getCaller";
-
-/**
- * Logs debug information to the console when in development mode or when the
- * `SHOW_ERRORS_IN_CONSOLE` environment variable is set to "true".
- *
- * This function provides detailed information about the caller function,
- * its location, and the provided body and cause, if any.
- *
- * @param name - A string representing the name or context of the debug log.
- * @param body - The main content or data to be logged.
- * @param cause - (Optional) Additional information or error cause to be logged.
- *
- * @remarks
- * The debug logs are only displayed when the application is running in
- * development mode (`NODE_ENV === "development"`) or when the
- * `SHOW_ERRORS_IN_CONSOLE` environment variable is explicitly set to "true".
- *
- * The logs include:
- * - The name of the debug context.
- * - The caller function name and its location.
- * - The provided body content.
- * - The optional cause, if provided.
- *
- * @example
- * ```typescript
- * httpDebug("FetchUserData", { userId: 123 });
- * ```
- *
- * @example
- * ```typescript
- * httpDebug("FetchUserDataError", { userId: 123 }, new Error("User not found"));
- * ```
- */
-
-function httpDebug(name: string, body: any, cause?: any) {
-  const isDebugMode =
-    process.env.NODE_ENV === "development" ||
-    process.env?.SHOW_ERRORS_IN_CONSOLE === "true";
-
-  if (isDebugMode) {
-    const reset = "\x1b[0m";
-    const cyan = "\x1b[36m";
-
-    const debugName = `${cyan}[ARKYN-DEBUG]${reset}`;
-    const { callerInfo, functionName } = getCaller();
-
-    let consoleData = `${debugName} ${name} initialized\n`;
-    consoleData += `${debugName} Caller Function: ${functionName}\n`;
-    consoleData += `${debugName} Caller Location: ${callerInfo}\n`;
-    consoleData += `${debugName} Body: ${JSON.stringify(body, null, 2)}\n`;
-
-    if (cause) {
-      consoleData += `${debugName} Cause: ${JSON.stringify(cause, null, 2)}\n`;
-    }
-
-    console.log(consoleData);
-  }
-}
-
-export { httpDebug };

package/src/services/schemaValidator.ts

@@ -1,66 +0,0 @@
-import { Schema, z } from "zod";
-
-import { ServerError } from "../http/badResponses/serverError";
-import { UnprocessableEntity } from "../http/badResponses/unprocessableEntity";
-import { formParse } from "./formParse";
-import { getCaller } from "./getCaller";
-import { httpDebug } from "./httpDebug";
-
-function formatErrorMessage(error: z.ZodError) {
-  const title = "Error validating:";
-  const lines = error.issues.map(
-    ({ path, message }) => `-> ${path.join(".")}: ${message}`
-  );
-
-  return [title, ...lines].join("\n");
-}
-
-class SchemaValidator<T extends Schema> {
-  functionName: string;
-  callerInfo: string;
-
-  constructor(readonly schema: T) {
-    const { callerInfo, functionName } = getCaller();
-    this.callerInfo = callerInfo;
-    this.functionName = functionName;
-  }
-
-  isValid(data: any): boolean {
-    return this.schema.safeParse(data).success;
-  }
-
-  safeValidate(data: any): z.SafeParseReturnType<z.infer<T>, z.infer<T>> {
-    return this.schema.safeParse(data);
-  }
-
-  validate(data: any): z.infer<T> {
-    try {
-      return this.schema.parse(data);
-    } catch (error: any) {
-      throw new ServerError(formatErrorMessage(error));
-    }
-  }
-
-  formValidate(data: any, message?: string): z.infer<T> {
-    const formParsed = formParse([data, this.schema]);
-
-    if (!formParsed.success) {
-      httpDebug("UnprocessableEntity", formParsed);
-      const firstErrorKey = Object.keys(formParsed.fieldErrors)[0];
-
-      throw new UnprocessableEntity(
-        {
-          fields: formParsed.fields,
-          fieldErrors: formParsed.fieldErrors,
-          data: { scrollTo: firstErrorKey },
-          message,
-        },
-        false
-      );
-    }
-
-    return formParsed.data;
-  }
-}
-
-export { SchemaValidator };

package/src/types/ApiResponseDTO.ts

@@ -1,19 +0,0 @@
-type ApiSuccessResponse<T = any> = {
-  success: true;
-  status: number;
-  message: string;
-  response: T;
-  cause: null;
-};
-
-type ApiFailedResponse = {
-  success: false;
-  status: number;
-  message: string;
-  response: any;
-  cause: string | Error | null;
-};
-
-type ApiResponseDTO<T = any> = ApiSuccessResponse<T> | ApiFailedResponse;
-
-export type { ApiResponseDTO };

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"] },
-});