@arkyn/server 3.0.1-beta.6 → 3.0.1-beta.60

package/src/config/arkynLogInstance.ts

@@ -1,75 +0,0 @@
-type ArkynConfigProps = {
-  arkynTrafficSourceId: string;
-  arkynUserToken: string;
-  arkynApiUrl: string;
-};
-
-type SetArkynConfigProps = {
-  arkynTrafficSourceId: string;
-  arkynUserToken: string;
-  arkynLogBaseApiUrl?: string;
-};
-
-/**
- * The `ArkynLogInstance` 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 {
-  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";
-
-    arkynLogBaseApiUrl.replace(
-      ":trafficSourceId",
-      arkynConfig.arkynTrafficSourceId
-    );
-
-    this.arkynConfig = {
-      arkynTrafficSourceId: arkynConfig.arkynTrafficSourceId,
-      arkynUserToken: arkynConfig.arkynUserToken,
-      arkynApiUrl: arkynLogBaseApiUrl,
-    };
-  }
-
-  /**
-   * Retrieves the current arkyn configuration for the ArkynLogInstance.
-   *
-   * @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 { ArkynLogInstance };

package/src/http/badResponses/badGateway.ts

@@ -1,63 +0,0 @@
-import { httpDebug } from "../../services/httpDebug";
-
-/**
- * Represents an HTTP error response with a status code of 502 (Bad Gateway).
- * This class is used to standardize the structure of a "Bad Gateway" error response,
- * including the response body, headers, status, and status text.
- */
-
-class BadGateway {
-  body: any;
-  cause?: any;
-  status: number = 502;
-  statusText: string;
-
-  /**
-   * Creates an instance of the `BadGateway` class.
-   *
-   * @param message - A descriptive message explaining the cause of the error.
-   * @param cause - Optional additional information about the cause of the error.
-   */
-
-  constructor(message: string, cause?: any) {
-    this.body = { name: "BadGateway", message: message };
-    this.statusText = message;
-    this.cause = cause ? JSON.stringify(cause) : undefined;
-    httpDebug("BadGateway", this.body, this.cause);
-  }
-
-  /**
-   * Converts the `BadGateway` 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 `BadGateway` 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 { BadGateway };

package/src/http/badResponses/badRequest.ts

@@ -1,63 +0,0 @@
-import { httpDebug } from "../../services/httpDebug";
-
-/**
- * Represents an HTTP error response with a status code of 400 (Bad Request).
- * This class is used to standardize the structure of a "Bad Request" error response,
- * including the response body, headers, status, and status text.
- */
-
-class BadRequest {
-  body: any;
-  cause?: any;
-  status: number = 400;
-  statusText: string;
-
-  /**
-   * Creates an instance of the `BadRequest` class.
-   *
-   * @param message - A descriptive message explaining the cause of the error.
-   * @param cause - Optional additional information about the cause of the error.
-   */
-
-  constructor(message: string, cause?: any) {
-    this.body = { name: "BadRequest", message: message };
-    this.statusText = message;
-    this.cause = cause ? JSON.stringify(cause) : undefined;
-    httpDebug("BadRequest", this.body, this.cause);
-  }
-
-  /**
-   * Converts the `BadRequest` 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 `BadRequest` 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 { BadRequest };

package/src/http/badResponses/conflict.ts

@@ -1,63 +0,0 @@
-import { httpDebug } from "../../services/httpDebug";
-
-/**
- * Represents an HTTP error response with a status code of 409 (Conflict).
- * This class is used to standardize the structure of a "Conflict" error response,
- * including the response body, headers, status, and status text.
- */
-
-class Conflict {
-  body: any;
-  cause?: any;
-  status: number = 409;
-  statusText: string;
-
-  /**
-   * Creates an instance of the `Conflict` class.
-   *
-   * @param message - A descriptive message explaining the cause of the conflict.
-   * @param cause - Optional additional information about the cause of the conflict.
-   */
-
-  constructor(message: string, cause?: any) {
-    this.body = { name: "Conflict", message: message };
-    this.statusText = message;
-    this.cause = cause ? JSON.stringify(cause) : undefined;
-    httpDebug("Conflict", this.body, this.cause);
-  }
-
-  /**
-   * Converts the `Conflict` 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 `Conflict` 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 { Conflict };

package/src/http/badResponses/forbidden.ts

@@ -1,63 +0,0 @@
-import { httpDebug } from "../../services/httpDebug";
-
-/**
- * Represents an HTTP error response with a status code of 403 (Forbidden).
- * This class is used to standardize the structure of a "Forbidden" error response,
- * including the response body, headers, status, and status text.
- */
-
-class Forbidden {
-  body: any;
-  cause?: any;
-  status: number = 403;
-  statusText: string;
-
-  /**
-   * Creates an instance of the `Forbidden` class.
-   *
-   * @param message - A descriptive message explaining why access is forbidden.
-   * @param cause - Optional additional information about the cause of the error.
-   */
-
-  constructor(message: string, cause?: any) {
-    this.body = { name: "Forbidden", message: message };
-    this.statusText = message;
-    this.cause = cause ? JSON.stringify(cause) : undefined;
-    httpDebug("Forbidden", this.body, this.cause);
-  }
-
-  /**
-   * Converts the `Forbidden` 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 `Forbidden` 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 { Forbidden };

package/src/http/badResponses/notFound.ts

@@ -1,63 +0,0 @@
-import { httpDebug } from "../../services/httpDebug";
-
-/**
- * Represents an HTTP error response with a status code of 404 (Not Found).
- * This class is used to standardize the structure of a "Not Found" error response,
- * including the response body, headers, status, and status text.
- */
-
-class NotFound {
-  body: any;
-  cause?: any;
-  status: number = 404;
-  statusText: string;
-
-  /**
-   * Creates an instance of the `NotFound` class.
-   *
-   * @param message - A descriptive message explaining the reason the resource was not found.
-   * @param cause - Optional additional information about the cause of the error.
-   */
-
-  constructor(message: string, cause?: any) {
-    this.body = { name: "NotFound", message: message };
-    this.statusText = message;
-    this.cause = cause ? JSON.stringify(cause) : undefined;
-    httpDebug("NotFound", this.body, this.cause);
-  }
-
-  /**
-   * Converts the `NotFound` 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 `NotFound` 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 { NotFound };

package/src/http/badResponses/notImplemented.ts

@@ -1,63 +0,0 @@
-import { httpDebug } from "../../services/httpDebug";
-
-/**
- * Represents an HTTP error response with a status code of 501 (Not Implemented).
- * This class is used to standardize the structure of a "Not Implemented" error response,
- * including the response body, headers, status, and status text.
- */
-
-class NotImplemented {
-  body: any;
-  cause?: any;
-  status: number = 501;
-  statusText: string;
-
-  /**
-   * Creates an instance of the `NotImplemented` class.
-   *
-   * @param message - A descriptive message explaining why the functionality is not implemented.
-   * @param cause - Optional additional information about the cause of the error.
-   */
-
-  constructor(message: string, cause?: any) {
-    this.body = { name: "NotImplemented", message: message };
-    this.statusText = message;
-    this.cause = cause ? JSON.stringify(cause) : undefined;
-    httpDebug("NotImplemented", this.body, this.cause);
-  }
-
-  /**
-   * Converts the `NotImplemented` 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 `NotImplemented` 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 { NotImplemented };

package/src/http/badResponses/serverError.ts

@@ -1,63 +0,0 @@
-import { httpDebug } from "../../services/httpDebug";
-
-/**
- * Represents an HTTP error response with a status code of 500 (Internal Server Error).
- * This class is used to standardize the structure of a "Server Error" response,
- * including the response body, headers, status, and status text.
- */
-
-class ServerError {
-  body: any;
-  cause?: any;
-  status: number = 500;
-  statusText: string;
-
-  /**
-   * Creates an instance of the `ServerError` class.
-   *
-   * @param message - A descriptive message explaining the cause of the server error.
-   * @param cause - Optional additional information about the cause of the error.
-   */
-
-  constructor(message: string, cause?: any) {
-    this.body = { name: "ServerError", message: message };
-    this.statusText = message;
-    this.cause = cause ? JSON.stringify(cause) : undefined;
-    httpDebug("ServerError", this.body, this.cause);
-  }
-
-  /**
-   * Converts the `ServerError` 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 `ServerError` 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 { ServerError };

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