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

package/src/http/badResponses/unauthorized.ts

@@ -1,63 +0,0 @@
-import { httpDebug } from "../../services/httpDebug";
-
-/**
- * Represents an HTTP error response with a status code of 401 (Unauthorized).
- * This class is used to standardize the structure of an "Unauthorized" error response,
- * including the response body, headers, status, and status text.
- */
-
-class Unauthorized {
-  body: any;
-  cause?: any;
-  status: number = 401;
-  statusText: string;
-
-  /**
-   * Creates an instance of the `Unauthorized` class.
-   *
-   * @param message - A descriptive message explaining why the request is unauthorized.
-   * @param cause - Optional additional information about the cause of the error.
-   */
-
-  constructor(message: string, cause?: any) {
-    this.body = { name: "Unauthorized", message: message };
-    this.statusText = message;
-    this.cause = cause ? JSON.stringify(cause) : undefined;
-    httpDebug("Unauthorized", this.body, this.cause);
-  }
-
-  /**
-   * Converts the `Unauthorized` instance into a `Response` object with a JSON body.
-   * This method ensures the response has the appropriate headers, status, and status text.
-   *
-   * @returns A `Response` object with the serialized JSON body and response metadata.
-   */
-
-  toResponse(): Response {
-    const responseInit: ResponseInit = {
-      headers: { "Content-Type": "application/json" },
-      status: this.status,
-      statusText: this.statusText,
-    };
-
-    return new Response(JSON.stringify(this.body), responseInit);
-  }
-
-  /**
-   * Converts the `Unauthorized` instance into a `Response` object using the `Response.json` method.
-   * This method is an alternative to `toResponse` for generating JSON error responses.
-   *
-   * @returns A `Response` object with the JSON body and response metadata.
-   */
-
-  toJson(): Response {
-    const responseInit: ResponseInit = {
-      status: this.status,
-      statusText: this.statusText,
-    };
-
-    return Response.json(this.body, responseInit);
-  }
-}
-
-export { Unauthorized };

package/src/http/badResponses/unprocessableEntity.ts

@@ -1,79 +0,0 @@
-import { httpDebug } from "../../services/httpDebug";
-
-type UnprocessableEntityProps = {
-  data?: any;
-  fieldErrors?: Record<string, string>;
-  fields?: Record<string, string>;
-  message?: string;
-};
-
-/**
- * Represents an HTTP error response with a status code of 422 (Unprocessable Entity).
- * This class is used to standardize the structure of an "Unprocessable Entity" error response,
- * including the response body, headers, status, and status text.
- */
-
-class UnprocessableEntity {
-  body: any;
-  status: number = 422;
-  statusText: string;
-
-  /**
-   * Creates an instance of the `UnprocessableEntity` class.
-   *
-   * @param props - An object containing details about the error, such as:
-   *   - `data`: Additional data related to the error.
-   *   - `fieldErrors`: A record of field-specific error messages.
-   *   - `fields`: A record of field values that caused the error.
-   *   - `message`: A descriptive message explaining the error.
-   * @param enableDebug - A boolean indicating whether to enable debug logging for this error.
-   */
-
-  constructor(props: UnprocessableEntityProps, enableDebug = false) {
-    this.statusText = props.message || "Unprocessable Entity";
-    this.body = {
-      name: "UnprocessableEntity",
-      message: props.message || null,
-      data: props.data,
-      fieldErrors: props.fieldErrors,
-      fields: props.fields,
-    };
-
-    enableDebug && httpDebug("UnprocessableEntity", this.body);
-  }
-
-  /**
-   * Converts the `UnprocessableEntity` instance into a `Response` object with a JSON body.
-   * This method ensures the response has the appropriate headers, status, and status text.
-   *
-   * @returns A `Response` object with the serialized JSON body and response metadata.
-   */
-
-  toResponse(): Response {
-    const responseInit: ResponseInit = {
-      headers: { "Content-Type": "application/json" },
-      status: this.status,
-      statusText: this.statusText,
-    };
-
-    return new Response(JSON.stringify(this.body), responseInit);
-  }
-
-  /**
-   * Converts the `UnprocessableEntity` instance into a `Response` object using the `Response.json` method.
-   * This method is an alternative to `toResponse` for generating JSON error responses.
-   *
-   * @returns A `Response` object with the JSON body and response metadata.
-   */
-
-  toJson(): Response {
-    const responseInit: ResponseInit = {
-      status: this.status,
-      statusText: this.statusText,
-    };
-
-    return Response.json(this.body, responseInit);
-  }
-}
-
-export { UnprocessableEntity };

package/src/http/successResponses/created.ts

@@ -1,64 +0,0 @@
-/**
- * Represents a successful HTTP response with a status code of 201 (Created).
- * This class is used to standardize the structure of a "Created" response,
- * including the response body, headers, status, and status text.
- *
- * @template T - The type of the response body.
- */
-
-class Created<T> {
-  body: T;
-  headers: ResponseInit["headers"];
-  status: number;
-  statusText: string;
-
-  /**
-   * Creates an instance of the `Created` class.
-   *
-   * @param body - The response body to be included in the HTTP response.
-   * @param init - Optional initialization object for customizing headers, status, and status text.
-   */
-
-  constructor(body: T, init?: ResponseInit) {
-    this.body = body;
-    this.headers = init?.headers || {};
-    this.status = init?.status || 201;
-    this.statusText = init?.statusText || "Resource created successfully";
-  }
-
-  /**
-   * Converts the `Created` instance into a `Response` object with a JSON body.
-   * This method ensures the response has the appropriate headers, status, and status text.
-   *
-   * @returns A `Response` object with the serialized JSON body and response metadata.
-   */
-
-  toResponse(): Response {
-    const responseInit: ResponseInit = {
-      headers: { "Content-Type": "application/json", ...this.headers },
-      status: this.status,
-      statusText: this.statusText,
-    };
-
-    return new Response(JSON.stringify(this.body), responseInit);
-  }
-
-  /**
-   * Converts the `Created` instance into a `Response` object using the `Response.json` method.
-   * This method is an alternative to `toResponse` for generating JSON responses.
-   *
-   * @returns A `Response` object with the JSON body and response metadata.
-   */
-
-  toJson(): Response {
-    const responseInit: ResponseInit = {
-      headers: this.headers,
-      status: this.status,
-      statusText: this.statusText,
-    };
-
-    return Response.json(this.body, responseInit);
-  }
-}
-
-export { Created };

package/src/http/successResponses/found.ts

@@ -1,67 +0,0 @@
-/**
- * Represents an HTTP 302 Found response.
- * This class is used to create a standardized HTTP response with a status of 302 (Found),
- * including optional headers and a response body.
- *
- * @template T - The type of the response body.
- */
-
-class Found<T> {
-  body: T;
-  headers: ResponseInit["headers"];
-  status: number;
-  statusText: string;
-
-  /**
-   * Creates an instance of the `Found` class.
-   *
-   * @param body - The body of the response.
-   * @param init - Optional initialization object to set headers, status, and statusText.
-   *   - `headers`: Additional headers to include in the response.
-   *   - `status`: HTTP status code (default is 302).
-   *   - `statusText`: HTTP status text (default is "Found").
-   */
-
-  constructor(body: T, init?: ResponseInit) {
-    this.body = body;
-    this.headers = init?.headers || {};
-    this.status = init?.status || 302;
-    this.statusText = init?.statusText || "Found";
-  }
-
-  /**
-   * Converts the `Found` instance into a `Response` object.
-   * This method serializes the response body as JSON and includes the appropriate headers.
-   *
-   * @returns A `Response` object with the serialized JSON body and the specified headers, status, and statusText.
-   */
-
-  toResponse() {
-    const responseInit: ResponseInit = {
-      headers: { "Content-Type": "application/json", ...this.headers },
-      status: this.status,
-      statusText: this.statusText,
-    };
-
-    return new Response(JSON.stringify(this.body), responseInit);
-  }
-
-  /**
-   * Converts the `Found` instance into a JSON response using `Response.json`.
-   * This method is an alternative to `toResponse` for creating JSON responses.
-   *
-   * @returns A `Response` object with the JSON body and the specified headers, status, and statusText.
-   */
-
-  toJson() {
-    const responseInit: ResponseInit = {
-      headers: this.headers,
-      status: this.status,
-      statusText: this.statusText,
-    };
-
-    return Response.json(this.body, responseInit);
-  }
-}
-
-export { Found };

package/src/http/successResponses/noContent.ts

@@ -1,42 +0,0 @@
-/**
- * Represents a successful HTTP response with a status code of 204 (No Content).
- * This class is used to standardize the structure of a "No Content" response,
- * including headers, status, and status text.
- */
-
-class NoContent {
-  headers: ResponseInit["headers"];
-  status: number;
-  statusText: string;
-
-  /**
-   * Creates an instance of the `NoContent` class.
-   *
-   * @param init - Optional initialization object for customizing headers, status, and status text.
-   */
-
-  constructor(init?: ResponseInit) {
-    this.headers = init?.headers || {};
-    this.status = init?.status || 204;
-    this.statusText = init?.statusText ?? "No content";
-  }
-
-  /**
-   * Converts the `NoContent` instance into a `Response` object.
-   * This method ensures the response has the appropriate headers, status, and status text.
-   *
-   * @returns A `Response` object with no body and response metadata.
-   */
-
-  toResponse(): Response {
-    const responseInit: ResponseInit = {
-      headers: this.headers,
-      status: this.status,
-      statusText: this.statusText,
-    };
-
-    return new Response(null, responseInit);
-  }
-}
-
-export { NoContent };

package/src/http/successResponses/success.ts

@@ -1,64 +0,0 @@
-/**
- * Represents a successful HTTP response with a status code of 200 (OK).
- * This class is used to standardize the structure of a "Success" response,
- * including the response body, headers, status, and status text.
- *
- * @template T - The type of the response body.
- */
-
-class Success<T> {
-  body: T;
-  headers: ResponseInit["headers"];
-  status: number;
-  statusText: string;
-
-  /**
-   * Creates an instance of the `Success` class.
-   *
-   * @param body - The response body to be included in the HTTP response.
-   * @param init - Optional initialization object for customizing headers, status, and status text.
-   */
-
-  constructor(body: T, init?: ResponseInit) {
-    this.body = body;
-    this.headers = init?.headers || {};
-    this.status = init?.status || 200;
-    this.statusText = init?.statusText ?? "OK";
-  }
-
-  /**
-   * Converts the `Success` instance into a `Response` object with a JSON body.
-   * This method ensures the response has the appropriate headers, status, and status text.
-   *
-   * @returns A `Response` object with the serialized JSON body and response metadata.
-   */
-
-  toResponse(): Response {
-    const responseInit: ResponseInit = {
-      headers: { "Content-Type": "application/json", ...this.headers },
-      status: this.status,
-      statusText: this.statusText,
-    };
-
-    return new Response(JSON.stringify(this.body), responseInit);
-  }
-
-  /**
-   * Converts the `Success` instance into a `Response` object using the `Response.json` method.
-   * This method is an alternative to `toResponse` for generating JSON responses.
-   *
-   * @returns A `Response` object with the JSON body and response metadata.
-   */
-
-  toJson(): Response {
-    const responseInit: ResponseInit = {
-      headers: this.headers,
-      status: this.status,
-      statusText: this.statusText,
-    };
-
-    return Response.json(this.body, responseInit);
-  }
-}
-
-export { Success };

package/src/http/successResponses/updated.ts

@@ -1,64 +0,0 @@
-/**
- * Represents a successful HTTP response with a status code of 200 (OK) or other custom status codes.
- * This class is used to standardize the structure of an "Updated" response,
- * including the response body, headers, status, and status text.
- *
- * @template T - The type of the response body.
- */
-
-class Updated<T> {
-  body: T;
-  headers: ResponseInit["headers"];
-  status: number;
-  statusText: string;
-
-  /**
-   * Creates an instance of the `Updated` class.
-   *
-   * @param body - The response body to be included in the HTTP response.
-   * @param init - Optional initialization object for customizing headers, status, and status text.
-   */
-
-  constructor(body: T, init?: ResponseInit) {
-    this.body = body;
-    this.headers = init?.headers || {};
-    this.status = init?.status || 200;
-    this.statusText = init?.statusText || "Resource updated successfully";
-  }
-
-  /**
-   * Converts the `Updated` instance into a `Response` object with a JSON body.
-   * This method ensures the response has the appropriate headers, status, and status text.
-   *
-   * @returns A `Response` object with the serialized JSON body and response metadata.
-   */
-
-  toResponse(): Response {
-    const responseInit: ResponseInit = {
-      headers: { "Content-Type": "application/json", ...this.headers },
-      status: this.status,
-      statusText: this.statusText,
-    };
-
-    return new Response(JSON.stringify(this.body), responseInit);
-  }
-
-  /**
-   * Converts the `Updated` instance into a `Response` object using the `Response.json` method.
-   * This method is an alternative to `toResponse` for generating JSON responses.
-   *
-   * @returns A `Response` object with the JSON body and response metadata.
-   */
-
-  toJson(): Response {
-    const responseInit: ResponseInit = {
-      headers: this.headers,
-      status: this.status,
-      statusText: this.statusText,
-    };
-
-    return Response.json(this.body, responseInit);
-  }
-}
-
-export { Updated };

package/src/index.ts

@@ -1,31 +0,0 @@
-// 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";
-export { Conflict } from "./http/badResponses/conflict";
-export { Forbidden } from "./http/badResponses/forbidden";
-export { NotFound } from "./http/badResponses/notFound";
-export { NotImplemented } from "./http/badResponses/notImplemented";
-export { ServerError } from "./http/badResponses/serverError";
-export { Unauthorized } from "./http/badResponses/unauthorized";
-export { UnprocessableEntity } from "./http/badResponses/unprocessableEntity";
-
-// http success responses
-export { Created } from "./http/successResponses/created";
-export { Found } from "./http/successResponses/found";
-export { NoContent } from "./http/successResponses/noContent";
-export { Success } from "./http/successResponses/success";
-export { Updated } from "./http/successResponses/updated";
-
-// services
-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 { SchemaValidator } from "./services/schemaValidator";

package/src/mapper/arkynLogRequestMapper.ts

@@ -1,73 +0,0 @@
-type InputProps = {
-  status: number;
-  url: string;
-  method: "GET" | "POST" | "PUT" | "DELETE" | "PATCH";
-  requestHeaders: HeadersInit;
-  responseHeaders: HeadersInit;
-  requestBody: any;
-  elapsedTime: number;
-  responseBody: any;
-  queryParams: URLSearchParams;
-};
-
-type OutputProps = {
-  rawUrl: string;
-  status: number;
-  method: "GET" | "POST" | "PUT" | "DELETE" | "PATCH";
-  token: string | null;
-  elapsedTime: number;
-  requestHeaders: Record<string, string>;
-  requestBody: Record<string, string>;
-  queryParams: Record<string, string>;
-  responseHeaders: Record<string, string>;
-  responseBody: any;
-};
-
-class ArkynLogRequestMapper {
-  private static mapHeaders(headers: HeadersInit): Record<string, string> {
-    if (headers instanceof Headers) {
-      return Object.fromEntries(headers.entries());
-    } else if (typeof headers === "object") {
-      return Object.entries(headers).reduce((acc, [key, value]) => {
-        if (typeof value === "string") {
-          acc[key] = value;
-        } else if (Array.isArray(value)) {
-          acc[key] = value.join(", ");
-        } else {
-          acc[key] = JSON.stringify(value);
-        }
-        return acc;
-      }, {} as Record<string, string>);
-    }
-    return {};
-  }
-
-  private static mapQueryParams(
-    queryParams: URLSearchParams
-  ): Record<string, string> {
-    const params: Record<string, string> = {};
-
-    queryParams.forEach((value, key) => {
-      params[key] = value;
-    });
-
-    return params;
-  }
-
-  static handle(props: InputProps): OutputProps {
-    return {
-      rawUrl: props.url,
-      status: props.status,
-      method: props.method,
-      token: null,
-      elapsedTime: props.elapsedTime,
-      requestHeaders: this.mapHeaders(props.requestHeaders),
-      requestBody: props.requestBody,
-      queryParams: this.mapQueryParams(props.queryParams),
-      responseHeaders: this.mapHeaders(props.responseHeaders),
-      responseBody: props.responseBody,
-    };
-  }
-}
-
-export { ArkynLogRequestMapper };

package/src/services/decodeErrorMessageFromRequest.ts

@@ -1,36 +0,0 @@
-/**
- * Decodes an error message from a given request data object or response object.
- *
- * This function attempts to extract a meaningful error message from the provided
- * `data` or `response` objects by checking various properties in a specific order.
- * If no valid error message is found, it returns a default message: "Missing error message".
- *
- * @param data - The data object that may contain error information. It can have properties
- * such as `message`, `error`, or `error.message` that are checked for a string value.
- * @param response - The response object that may contain a `statusText` property
- * representing the HTTP status text.
- * @returns A string representing the decoded error message, or a default message
- * if no error message is found.
- */
-
-function decodeErrorMessageFromRequest(data: any, response: Response): string {
-  if (data?.message && typeof data?.message === "string") {
-    return data?.message;
-  }
-
-  if (data?.error && typeof data?.error === "string") {
-    return data?.error;
-  }
-
-  if (data?.error?.message && typeof data?.error?.message === "string") {
-    return data?.error?.message;
-  }
-
-  if (response?.statusText && typeof response?.statusText === "string") {
-    return response?.statusText;
-  }
-
-  return "Missing error message";
-}
-
-export { decodeErrorMessageFromRequest };

package/src/services/decodeRequestBody.ts

@@ -1,43 +0,0 @@
-import { BadRequest } from "../http/badResponses/badRequest";
-
-type DecodeRequestBodyFunction = (request: Request) => Promise<any>;
-
-/**
- * Decodes the body of an incoming request into a JavaScript object.
- *
- * This function attempts to parse the request body in the following order:
- * 1. Tries to parse the body as JSON.
- * 2. If JSON parsing fails, attempts to parse the body as URL-encoded form data.
- * 3. If both parsing attempts fail, logs the errors and returns an empty object.
- *
- * @param req - The incoming request object containing the body to decode.
- * @returns A promise that resolves to the decoded data as a JavaScript object.
- *
- * @throws Logs errors to the console if the request body cannot be read or parsed.
- */
-
-const decodeRequestBody: DecodeRequestBodyFunction = async (req) => {
-  let data: any;
-
-  const arrayBuffer = await req.arrayBuffer();
-  const text = new TextDecoder().decode(arrayBuffer);
-
-  try {
-    data = JSON.parse(text);
-  } catch (jsonError) {
-    try {
-      if (text.includes("=")) {
-        const formData = new URLSearchParams(text);
-        data = Object.fromEntries(formData.entries());
-      } else {
-        throw new BadRequest("Invalid URLSearchParams format");
-      }
-    } catch (formDataError) {
-      throw new BadRequest("Failed to extract data from request");
-    }
-  }
-
-  return data;
-};
-
-export { decodeRequestBody };