@arkyn/server 2.0.1-beta.12 → 2.0.1-beta.13

package/src/config/apiInstance.ts

@@ -0,0 +1,148 @@
+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 ApiAinstanceContructorProps = {
+  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 ApiInstance {
+  private baseUrl: string;
+  private baseHeaders?: HeadersInit;
+  private baseToken?: string;
+
+  /**
+   * Creates an instance of ApiInstance.
+   * @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: ApiAinstanceContructorProps) {
+    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 { ApiInstance };

package/src/config/inboxFlowInstance.ts

@@ -0,0 +1,65 @@
+type InboxConfigProps = {
+  inboxChannelId: string;
+  inboxUserToken: string;
+  inboxApiUrl: string;
+};
+
+type SetInboxConfigProps = {
+  inboxChannelId: string;
+  inboxUserToken: string;
+  inboxApiUrl?: string;
+};
+
+/**
+ * The `InboxFlowInstance` class manages the configuration for the inbox flow.
+ * It allows you to set and retrieve the inbox configuration, including the channel ID,
+ * user token, and API URL.
+ */
+
+class InboxFlowInstance {
+  private static inboxConfig?: InboxConfigProps;
+
+  /**
+   * Sets the configuration for the inbox. This method initializes the inbox configuration
+   * with the provided `inboxConfig` values. If the configuration has already been set,
+   * the method will return early without making any changes.
+   *
+   * @param inboxConfig - An object containing the inbox configuration properties.
+   * @param inboxConfig.inboxChannelId - The key used to identify the inbox.
+   * @param inboxConfig.inboxUserToken - The user token for authenticating with the inbox.
+   * @param inboxConfig.inboxApiUrl - (Optional) The API URL for the inbox. If not provided,
+   * a default URL will be used.
+   */
+
+  static setInboxConfig(inboxConfig: SetInboxConfigProps) {
+    const defaultInboxURL = `https://logs-inbox-flow-logs.vw6wo7.easypanel.host/api/call`;
+    if (!!this.inboxConfig) return;
+
+    this.inboxConfig = {
+      inboxChannelId: inboxConfig.inboxChannelId,
+      inboxUserToken: inboxConfig.inboxUserToken,
+      inboxApiUrl: inboxConfig.inboxApiUrl || defaultInboxURL,
+    };
+  }
+
+  /**
+   * Retrieves the current inbox configuration for the InboxFlowInstance.
+   *
+   * @returns {InboxConfigProps | undefined} The current inbox configuration if set,
+   * or `undefined` if no configuration has been initialized.
+   */
+  static getInboxConfig(): InboxConfigProps | undefined {
+    return this.inboxConfig;
+  }
+
+  /**
+   * Resets the inbox configuration to `undefined`.
+   * This method can be used to clear the current configuration.
+   */
+
+  static resetInboxConfig() {
+    this.inboxConfig = undefined;
+  }
+}
+
+export { InboxFlowInstance };

package/src/index.ts

@@ -1,5 +1,8 @@
-export { ArkynInstance } from "./config/arkynInstance";
+// config
+export { ApiInstance } from "./config/apiInstance";
+export { InboxFlowInstance } from "./config/inboxFlowInstance";
 
+// http bad responses
 export { BadGateway } from "./http/badResponses/badGateway";
 export { BadRequest } from "./http/badResponses/badRequest";
 export { Conflict } from "./http/badResponses/conflict";
@@ -10,12 +13,15 @@ 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";

package/src/services/decodeErrorMessageFromRequest.ts

@@ -0,0 +1,36 @@
+/**
+ * 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/httpDebug.ts

@@ -1,4 +1,4 @@
-import { ArkynInstance } from "../config/arkynInstance";
+import { InboxFlowInstance } from "../config/inboxFlowInstance";
 import { getCaller } from "../services/getCaller";
 
 /**
@@ -56,7 +56,7 @@ function httpDebug(name: string, body: any, cause?: any) {
     }
 
     console.log(consoleData);
-    const arkynKeys = ArkynInstance.getInboxKeys();
+    const arkynKeys = InboxFlowInstance.getInboxConfig();
     if (arkynKeys) console.log(arkynKeys);
   }
 }

package/dist/config/arkynInstance.d.ts

@@ -1,28 +0,0 @@
-type InboxKeysProps = {
-    inboxKey: string;
-    inboxUserToken: string;
-};
-/**
- * The `ArkynInstance` class is a singleton-like utility designed to manage and provide access
- * to inbox configuration keys (`InboxKeysProps`) within the application. It ensures that the
- * inbox keys are set before they can be retrieved, throwing an error if they are accessed
- * without being initialized.
- *
- * @example
- * ```typescript
- * // Setting the inbox keys
- * ArkynInstance.setInboxKeys({ key1: "value1", key2: "value2" });
- *
- * // Retrieving the inbox keys
- * const inboxKeys = ArkynInstance.getInboxKeys();
- * console.log(inboxKeys);
- * ```
- */
-declare class ArkynInstance {
-    static inboxKeys?: InboxKeysProps;
-    constructor();
-    static setInboxKeys(arkynConfig: InboxKeysProps): void;
-    static getInboxKeys(): InboxKeysProps | undefined;
-}
-export { ArkynInstance };
-//# sourceMappingURL=arkynInstance.d.ts.map

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

@@ -1 +0,0 @@
-{"version":3,"file":"arkynInstance.d.ts","sourceRoot":"","sources":["../../src/config/arkynInstance.ts"],"names":[],"mappings":"AAAA,KAAK,cAAc,GAAG;IACpB,QAAQ,EAAE,MAAM,CAAC;IACjB,cAAc,EAAE,MAAM,CAAC;CACxB,CAAC;AAEF;;;;;;;;;;;;;;;GAeG;AAEH,cAAM,aAAa;IACjB,MAAM,CAAC,SAAS,CAAC,EAAE,cAAc,CAAC;;IAIlC,MAAM,CAAC,YAAY,CAAC,WAAW,EAAE,cAAc;IAI/C,MAAM,CAAC,YAAY;CAGpB;AAED,OAAO,EAAE,aAAa,EAAE,CAAC"}

package/dist/config/arkynInstance.js

@@ -1,28 +0,0 @@
-/**
- * The `ArkynInstance` class is a singleton-like utility designed to manage and provide access
- * to inbox configuration keys (`InboxKeysProps`) within the application. It ensures that the
- * inbox keys are set before they can be retrieved, throwing an error if they are accessed
- * without being initialized.
- *
- * @example
- * ```typescript
- * // Setting the inbox keys
- * ArkynInstance.setInboxKeys({ key1: "value1", key2: "value2" });
- *
- * // Retrieving the inbox keys
- * const inboxKeys = ArkynInstance.getInboxKeys();
- * console.log(inboxKeys);
- * ```
- */
-class ArkynInstance {
-    static inboxKeys;
-    constructor() { }
-    static setInboxKeys(arkynConfig) {
-        if (!this.inboxKeys)
-            this.inboxKeys = arkynConfig;
-    }
-    static getInboxKeys() {
-        return this.inboxKeys;
-    }
-}
-export { ArkynInstance };

package/src/config/arkynInstance.ts

@@ -1,37 +0,0 @@
-type InboxKeysProps = {
-  inboxKey: string;
-  inboxUserToken: string;
-};
-
-/**
- * The `ArkynInstance` class is a singleton-like utility designed to manage and provide access
- * to inbox configuration keys (`InboxKeysProps`) within the application. It ensures that the
- * inbox keys are set before they can be retrieved, throwing an error if they are accessed
- * without being initialized.
- *
- * @example
- * ```typescript
- * // Setting the inbox keys
- * ArkynInstance.setInboxKeys({ key1: "value1", key2: "value2" });
- *
- * // Retrieving the inbox keys
- * const inboxKeys = ArkynInstance.getInboxKeys();
- * console.log(inboxKeys);
- * ```
- */
-
-class ArkynInstance {
-  static inboxKeys?: InboxKeysProps;
-
-  constructor() {}
-
-  static setInboxKeys(arkynConfig: InboxKeysProps) {
-    if (!this.inboxKeys) this.inboxKeys = arkynConfig;
-  }
-
-  static getInboxKeys() {
-    return this.inboxKeys;
-  }
-}
-
-export { ArkynInstance };