@arkyn/server 3.0.1-beta.55 → 3.0.1-beta.56

package/src/services/apiService.ts

@@ -1,148 +0,0 @@
-import { deleteRequest } from "../api/deleteRequest";
-import { getRequest } from "../api/getRequest";
-import { patchRequest } from "../api/patchRequest";
-import { postRequest } from "../api/postRequest";
-import { putRequest } from "../api/putRequest";
-
-type ApiServiceConstructorProps = {
-  baseUrl: string;
-  baseHeaders?: HeadersInit;
-  baseToken?: string | null;
-};
-
-type ApiRequestDataWithoutBodyProps = {
-  headers?: HeadersInit;
-  token?: string;
-};
-
-type ApiRequestDataWithBodyProps = {
-  body?: any;
-  headers?: HeadersInit;
-  token?: string;
-};
-
-/**
- * Class representing an API instance to handle HTTP requests with base configurations.
- */
-
-class ApiService {
-  private baseUrl: string;
-  private baseHeaders?: HeadersInit;
-  private baseToken?: string;
-
-  /**
-   * 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: ApiServiceConstructorProps) {
-    this.baseUrl = props.baseUrl;
-    this.baseHeaders = props.baseHeaders || undefined;
-    this.baseToken = props.baseToken || undefined;
-  }
-
-  /**
-   * Generates the full URL by appending the route to the base URL.
-   * @param route - The route to append to the base URL.
-   * @returns The full URL as a string.
-   */
-
-  private generateURL(route: string) {
-    return this.baseUrl + route;
-  }
-
-  /**
-   * Generates the headers for a request by merging base headers, provided headers, and tokens.
-   * @param initHeaders - Initial headers to include in the request.
-   * @param token - Optional token to override the base token.
-   * @returns The merged headers as a HeadersInit object.
-   */
-
-  private generateHeaders(
-    initHeaders: HeadersInit,
-    token?: string
-  ): HeadersInit {
-    let headers: HeadersInit = {};
-    if (this.baseToken) headers = { Authorization: `Bearer ${this.baseToken}` };
-    if (this.baseHeaders) headers = { ...headers, ...this.baseHeaders };
-
-    if (initHeaders) headers = { ...headers, ...initHeaders };
-    if (token) headers = { ...headers, Authorization: `Bearer ${token}` };
-
-    return headers;
-  }
-
-  /**
-   * 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) {
-    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.
-   * @param data - The request data, including body, optional headers, and token.
-   * @returns The API response data.
-   */
-
-  async post(route: string, data?: ApiRequestDataWithBodyProps) {
-    const url = this.generateURL(route);
-    const headers = this.generateHeaders(data?.headers || {}, data?.token);
-    const body = data?.body;
-    return await postRequest(url, headers, body);
-  }
-
-  /**
-   * 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) {
-    const url = this.generateURL(route);
-    const headers = this.generateHeaders(data?.headers || {}, data?.token);
-    const body = data?.body;
-    return await putRequest(url, headers, body);
-  }
-
-  /**
-   * 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) {
-    const url = this.generateURL(route);
-    const headers = this.generateHeaders(data?.headers || {}, data?.token);
-    const body = data?.body;
-    return await patchRequest(url, headers, body);
-  }
-
-  /**
-   * 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) {
-    const url = this.generateURL(route);
-    const headers = this.generateHeaders(data?.headers || {}, data?.token);
-    const body = data?.body;
-    return await deleteRequest(url, headers, body);
-  }
-}
-
-export { ApiService };

package/src/services/arkynLogService.ts

@@ -1,70 +0,0 @@
-type ArkynConfigProps = {
-  arkynTrafficSourceId: string;
-  arkynUserToken: string;
-  arkynApiUrl: string;
-};
-
-type SetArkynConfigProps = {
-  arkynTrafficSourceId: string;
-  arkynUserToken: string;
-  arkynLogBaseApiUrl?: string;
-};
-
-/**
- * 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 ArkynLogService {
-  private static arkynConfig?: ArkynConfigProps;
-
-  /**
-   * Sets the configuration for the arkyn. This method initializes the arkyn configuration
-   * with the provided `arkynConfig` values. If the configuration has already been set,
-   * the method will return early without making any changes.
-   *
-   * @param arkynConfig - An object containing the arkyn configuration properties.
-   * @param arkynConfig.arkynTrafficSourceId - The key used to identify the arkyn.
-   * @param arkynConfig.arkynUserToken - The user token for authenticating with the arkyn.
-   * @param arkynConfig.arkynLogBaseApiUrl - (Optional) The API URL for the arkyn. If not provided,
-   * a default URL will be used.
-   */
-
-  static setArkynConfig(arkynConfig: SetArkynConfigProps) {
-    if (!!this.arkynConfig) return;
-
-    let defaultArkynURL = `https://logs-arkyn-flow-logs.vw6wo7.easypanel.host`;
-    let arkynLogBaseApiUrl = arkynConfig.arkynLogBaseApiUrl || defaultArkynURL;
-
-    arkynLogBaseApiUrl =
-      arkynLogBaseApiUrl + "/http-traffic-records/:trafficSourceId";
-
-    this.arkynConfig = {
-      arkynTrafficSourceId: arkynConfig.arkynTrafficSourceId,
-      arkynUserToken: arkynConfig.arkynUserToken,
-      arkynApiUrl: arkynLogBaseApiUrl,
-    };
-  }
-
-  /**
-   * 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.
-   */
-  static getArkynConfig(): ArkynConfigProps | undefined {
-    return this.arkynConfig;
-  }
-
-  /**
-   * Resets the arkyn configuration to `undefined`.
-   * This method can be used to clear the current configuration.
-   */
-
-  static resetArkynConfig() {
-    this.arkynConfig = undefined;
-  }
-}
-
-export { ArkynLogService };

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 };

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,86 +0,0 @@
-import type { ZodType } from "zod";
-
-type SuccessResponse<T extends FormParseProps> = {
-  success: true;
-  data: T[1] extends ZodType<infer U> ? U : never;
-};
-
-type ErrorResponse = {
-  success: false;
-  fields: { [x: string]: string };
-  fieldErrors: { [x: string]: string };
-};
-
-type FormParseProps = [formData: { [k: string]: any }, schema: ZodType];
-
-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.issues.map((item) => {
-        console.log(item);
-        return [item.path.join("."), item.message];
-      })
-    );
-
-    return {
-      success: zodResponse.success,
-      fieldErrors: errorsObject,
-      fields: formData,
-    };
-  } else {
-    return {
-      success: zodResponse.success,
-      data: zodResponse.data as T[1] extends ZodType<infer U> ? U : never,
-    };
-  }
-}
-
-export { formParse };

package/src/services/getCaller.ts

@@ -1,81 +0,0 @@
-import path from "path";
-import { HttpDebugService } from "./httpDebug";
-
-/**
- * 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());
-
-  const ignoreFile = HttpDebugService.ignoreFile;
-
-  let callerIndex = 2;
-
-  while (
-    callerIndex < stackLines.length &&
-    (stackLines[callerIndex].includes("node:internal") ||
-      stackLines[callerIndex].includes("/node_modules/"))
-  ) {
-    callerIndex++;
-  }
-
-  if (ignoreFile) {
-    while (
-      callerIndex < stackLines.length &&
-      stackLines[callerIndex].includes(ignoreFile)
-    ) {
-      callerIndex++;
-    }
-  }
-
-  const callerLine = stackLines[callerIndex] || "";
-
-  let functionName = "Unknown function";
-  let callerInfo = "Unknown caller";
-
-  const namedFunctionMatch = callerLine.match(/at\s+([^(\s]+)\s+\(([^)]+)\)/);
-  if (namedFunctionMatch) {
-    functionName = namedFunctionMatch[1];
-    callerInfo = namedFunctionMatch[2];
-  } else {
-    const anonymousFunctionMatch = callerLine.match(/at\s+(.+)/);
-    if (anonymousFunctionMatch) {
-      callerInfo = anonymousFunctionMatch[1];
-
-      const objectMethodMatch = callerInfo.match(/at\s+([^(\s]+)\s+/);
-      if (objectMethodMatch && objectMethodMatch[1] !== "new") {
-        functionName = objectMethodMatch[1];
-      }
-    }
-  }
-
-  if (callerInfo.includes("(")) {
-    callerInfo = callerInfo.substring(
-      callerInfo.indexOf("(") + 1,
-      callerInfo.lastIndexOf(")")
-    );
-  }
-
-  callerInfo = callerInfo.split(":").slice(0, -2).join(":");
-
-  try {
-    callerInfo = path.relative(projectRoot, callerInfo);
-  } catch (e) {}
-
-  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 };