@arkyn/server 2.0.1-beta.9 → 2.0.2

package/LICENSE.txt

@@ -0,0 +1,24 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   Copyright 2025 Lucas Gonçalves
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.
+
+---
+
+For more information or to contribute, visit:
+https://github.com/Lucas-Eduardo-Goncalves

package/README.md

@@ -0,0 +1,116 @@
+The `@arkyn/server` package provides utilities and services to streamline backend application development. It includes API configurations, HTTP error handlers, and various services for file manipulation.
+
+---
+
+## Installation
+
+Install the package using npm:
+
+```bash
+npm install @arkyn/server
+```
+
+---
+
+## Features
+
+### Settings
+
+- **`ApiInstance`**  
+  Pre-configured instance for API calls.
+
+- **`InboxFlowInstance`**  
+  Pre-configured instance for integration with Inbox Flow.
+
+---
+
+### HTTP Responses - Errors
+
+- **`BadGateway(message: string): Error`**  
+  Represents an HTTP 502 error.
+
+- **`BadRequest(message: string): Error`**  
+  Represents an HTTP 400 error.
+
+- **`Conflict(message: string): Error`**  
+  Represents an HTTP 409 error.
+
+- **`Forbidden(message: string): Error`**  
+  Represents an HTTP 403 error.
+
+- **`NotFound(message: string): Error`**  
+  Represents an HTTP 404 error.
+
+- **`NotImplemented(message: string): Error`**  
+  Represents an HTTP 501 error.
+
+- **`ServerError(message: string): Error`**  
+  Represents an HTTP 500 error.
+
+- **`Unauthorized(message: string): Error`**  
+  Represents an HTTP 401 error.
+
+- **`UnprocessableEntity(message: string): Error`**  
+  Represents an HTTP 422 error.
+
+---
+
+### HTTP Responses - Success
+
+- **`Created(data: any): Response`**  
+  Represents an HTTP 201 response.
+
+- **`Found(data: any): Response`**  
+  Represents an HTTP 302 response.
+
+- **`NoContent(): Response`**  
+  Represents an HTTP 204 response.
+
+- **`Success(data: any): Response`**  
+  Represents an HTTP 200 response.
+
+- **`Updated(data: any): Response`**  
+  Represents an HTTP 200 response for updates.
+
+---
+
+### Services
+
+- **`decodeErrorMessageFromRequest(request: Request): string`**  
+  Decodes error messages from a request.
+
+- **`decodeRequestBody(request: Request): any`**  
+  Decodes the body of a request.
+
+- **`errorHandler(error: Error): Response`**  
+  Handles errors and returns an appropriate response.
+
+- **`formParse(request: Request): FormData`**  
+  Parses form data.
+
+- **`getCaller(): string`**  
+  Returns the name of the function that invoked the method.
+
+- **`getScopedParams(request: Request): URLSearchParams`**  
+  Retrieves scoped parameters from a request.
+
+- **`httpDebug(request: Request): void`**  
+  Displays debug information for an HTTP request.
+
+- **`SchemaValidator(schema: any, data: any): boolean`**  
+  Validates data against a schema.
+
+- **`sendFileToS3(file: File, config: AwsConfig): Promise<{ url: string }>`**  
+  Uploads a file to AWS S3.
+
+---
+
+## Contribution
+
+Contributions are welcome! Feel free to open issues or submit pull requests to improve the project.
+
+---
+
+## License
+
+This project is licensed under the Apache 2.0 License. See the `LICENSE` file for more details.

package/dist/api/deleteRequest.d.ts

@@ -0,0 +1,13 @@
+import type { ApiResponseDTO } from "@arkyn/types";
+/**
+ * Sends a DELETE request to the specified URL with optional headers and body.
+ *
+ * @template T - The expected type of the response data.
+ * @param {string} url - The URL to send the DELETE request to.
+ * @param {HeadersInit} [headers={}] - Optional headers to include in the request.
+ * @param {any} [body] - Optional body to include in the request.
+ * @returns {Promise<ApiResponseDTO<T>>} A promise that resolves to the API response.
+ */
+declare function deleteRequest<T = any>(url: string, headers?: HeadersInit, body?: any): Promise<ApiResponseDTO<T>>;
+export { deleteRequest };
+//# sourceMappingURL=deleteRequest.d.ts.map

package/dist/api/deleteRequest.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"deleteRequest.d.ts","sourceRoot":"","sources":["../../src/api/deleteRequest.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,cAAc,CAAC;AAGnD;;;;;;;;GAQG;AAEH,iBAAe,aAAa,CAAC,CAAC,GAAG,GAAG,EAClC,GAAG,EAAE,MAAM,EACX,OAAO,GAAE,WAAgB,EACzB,IAAI,CAAC,EAAE,GAAG,GACT,OAAO,CAAC,cAAc,CAAC,CAAC,CAAC,CAAC,CAE5B;AAED,OAAO,EAAE,aAAa,EAAE,CAAC"}

package/dist/api/deleteRequest.js

@@ -0,0 +1,14 @@
+import { makeRequest } from "./makeRequest";
+/**
+ * Sends a DELETE request to the specified URL with optional headers and body.
+ *
+ * @template T - The expected type of the response data.
+ * @param {string} url - The URL to send the DELETE request to.
+ * @param {HeadersInit} [headers={}] - Optional headers to include in the request.
+ * @param {any} [body] - Optional body to include in the request.
+ * @returns {Promise<ApiResponseDTO<T>>} A promise that resolves to the API response.
+ */
+async function deleteRequest(url, headers = {}, body) {
+    return makeRequest("DELETE", url, headers, body);
+}
+export { deleteRequest };

package/dist/api/getRequest.d.ts

@@ -0,0 +1,12 @@
+import type { ApiResponseDTO } from "@arkyn/types";
+/**
+ * Sends a GET request to the specified URL with optional headers.
+ *
+ * @template T - The expected type of the response data.
+ * @param {string} url - The URL to send the GET request to.
+ * @param {HeadersInit} [headers={}] - Optional headers to include in the request.
+ * @returns {Promise<ApiResponseDTO<T>>} A promise that resolves to the API response.
+ */
+declare function getRequest<T = any>(url: string, headers?: HeadersInit): Promise<ApiResponseDTO<T>>;
+export { getRequest };
+//# sourceMappingURL=getRequest.d.ts.map

package/dist/api/getRequest.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"getRequest.d.ts","sourceRoot":"","sources":["../../src/api/getRequest.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,cAAc,CAAC;AAGnD;;;;;;;GAOG;AAEH,iBAAe,UAAU,CAAC,CAAC,GAAG,GAAG,EAC/B,GAAG,EAAE,MAAM,EACX,OAAO,GAAE,WAAgB,GACxB,OAAO,CAAC,cAAc,CAAC,CAAC,CAAC,CAAC,CAE5B;AAED,OAAO,EAAE,UAAU,EAAE,CAAC"}

package/dist/api/getRequest.js

@@ -0,0 +1,13 @@
+import { makeRequest } from "./makeRequest";
+/**
+ * Sends a GET request to the specified URL with optional headers.
+ *
+ * @template T - The expected type of the response data.
+ * @param {string} url - The URL to send the GET request to.
+ * @param {HeadersInit} [headers={}] - Optional headers to include in the request.
+ * @returns {Promise<ApiResponseDTO<T>>} A promise that resolves to the API response.
+ */
+async function getRequest(url, headers = {}) {
+    return makeRequest("GET", url, headers);
+}
+export { getRequest };

package/dist/api/inboxFlowRequest.d.ts

@@ -0,0 +1,40 @@
+type ConfigProps = {
+    status: number;
+    method: "POST" | "GET" | "PUT" | "DELETE" | "PATCH" | "ERROR";
+    request: string;
+    response: string;
+    token: string;
+};
+/**
+ * Sends a request to the inbox flow API with the provided configuration.
+ *
+ * @param config - The configuration object for the request.
+ * @param config.status - The HTTP status code associated with the request.
+ * @param config.method - The HTTP method used for the request. Can be "POST", "GET", "PUT", "DELETE", "PATCH", or "ERROR".
+ * @param config.request - The request payload or details as a string.
+ * @param config.response - The response payload or details as a string.
+ * @param config.token - The token associated with the request for authentication or identification.
+ *
+ * @remarks
+ * - This function retrieves the inbox flow configuration using `InboxFlowInstance.getInboxConfig()`.
+ * - If the configuration is not available, the function will return early without performing any action.
+ * - In a development environment (`NODE_ENV === "development"`), the function will also return early.
+ * - The request is sent as a POST request to the inbox API URL with the provided configuration details.
+ * - If an error occurs during the request, it will be logged using the `httpDebug` service.
+ *
+ * @example
+ * ```typescript
+ * const config = {
+ *   status: 200,
+ *   method: "POST",
+ *   request: JSON.stringify({ key: "value" }),
+ *   response: JSON.stringify({ success: true }),
+ *   token: "example-token",
+ * };
+ *
+ * await inboxFlowRequest(config);
+ * ```
+ */
+declare function inboxFlowRequest(config: ConfigProps): Promise<void>;
+export { inboxFlowRequest };
+//# sourceMappingURL=inboxFlowRequest.d.ts.map

package/dist/api/inboxFlowRequest.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"inboxFlowRequest.d.ts","sourceRoot":"","sources":["../../src/api/inboxFlowRequest.ts"],"names":[],"mappings":"AAGA,KAAK,WAAW,GAAG;IACjB,MAAM,EAAE,MAAM,CAAC;IACf,MAAM,EAAE,MAAM,GAAG,KAAK,GAAG,KAAK,GAAG,QAAQ,GAAG,OAAO,GAAG,OAAO,CAAC;IAC9D,OAAO,EAAE,MAAM,CAAC;IAChB,QAAQ,EAAE,MAAM,CAAC;IACjB,KAAK,EAAE,MAAM,CAAC;CACf,CAAC;AAEF;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA6BG;AAEH,iBAAe,gBAAgB,CAAC,MAAM,EAAE,WAAW,iBA+BlD;AAED,OAAO,EAAE,gBAAgB,EAAE,CAAC"}

package/dist/api/inboxFlowRequest.js

@@ -0,0 +1,63 @@
+import { InboxFlowInstance } from "../config/inboxFlowInstance";
+import { httpDebug } from "../services/httpDebug";
+/**
+ * Sends a request to the inbox flow API with the provided configuration.
+ *
+ * @param config - The configuration object for the request.
+ * @param config.status - The HTTP status code associated with the request.
+ * @param config.method - The HTTP method used for the request. Can be "POST", "GET", "PUT", "DELETE", "PATCH", or "ERROR".
+ * @param config.request - The request payload or details as a string.
+ * @param config.response - The response payload or details as a string.
+ * @param config.token - The token associated with the request for authentication or identification.
+ *
+ * @remarks
+ * - This function retrieves the inbox flow configuration using `InboxFlowInstance.getInboxConfig()`.
+ * - If the configuration is not available, the function will return early without performing any action.
+ * - In a development environment (`NODE_ENV === "development"`), the function will also return early.
+ * - The request is sent as a POST request to the inbox API URL with the provided configuration details.
+ * - If an error occurs during the request, it will be logged using the `httpDebug` service.
+ *
+ * @example
+ * ```typescript
+ * const config = {
+ *   status: 200,
+ *   method: "POST",
+ *   request: JSON.stringify({ key: "value" }),
+ *   response: JSON.stringify({ success: true }),
+ *   token: "example-token",
+ * };
+ *
+ * await inboxFlowRequest(config);
+ * ```
+ */
+async function inboxFlowRequest(config) {
+    const inboxFlowInstance = InboxFlowInstance.getInboxConfig();
+    if (!inboxFlowInstance)
+        return;
+    const { inboxChannelId, inboxUserToken, inboxApiUrl } = inboxFlowInstance;
+    const { status, method, request, response, token } = config;
+    if (process.env.NODE_ENV === "development")
+        return;
+    try {
+        const body = JSON.stringify({
+            status,
+            channelId: inboxChannelId,
+            method,
+            token,
+            request,
+            response,
+        });
+        await fetch(inboxApiUrl, {
+            method: "POST",
+            body,
+            headers: {
+                "Content-Type": "application/json",
+                Authorization: `Bearer ${inboxUserToken}`,
+            },
+        });
+    }
+    catch (err) {
+        httpDebug("inboxFlowRequest", "Error sending inbox flow request", err);
+    }
+}
+export { inboxFlowRequest };

package/dist/api/makeRequest.d.ts

@@ -0,0 +1,38 @@
+import type { ApiResponseDTO } from "@arkyn/types";
+/**
+ * Makes an HTTP request using the Fetch API and returns a standardized response.
+ *
+ * @template T - The expected type of the response data.
+ * @param method - The HTTP method to use for the request. Supported methods are:
+ *   - "POST": Create a new resource.
+ *   - "PUT": Update an existing resource.
+ *   - "DELETE": Remove a resource.
+ *   - "PATCH": Partially update a resource.
+ *   - "GET": Retrieve a resource.
+ * @param url - The URL to which the request is sent.
+ * @param headers - Optional headers to include in the request. Defaults to an empty object.
+ * @param body - Optional body to include in the request. Should be serializable to JSON.
+ * @returns A promise that resolves to an `ApiResponseDTO<T>` object containing:
+ *   - `success`: A boolean indicating whether the request was successful.
+ *   - `status`: The HTTP status code of the response.
+ *   - `message`: A message describing the result of the request.
+ *   - `response`: The parsed JSON response data, or `null` if parsing fails.
+ *   - `cause`: Additional error information, if applicable.
+ *
+ * @example
+ * ```typescript
+ * import { makeRequest } from "./makeRequest";
+ *
+ * async function fetchData() {
+ *   const response = await makeRequest("GET", "https://api.example.com/data");
+ *   if (response.success) {
+ *     console.log("Data:", response.response);
+ *   } else {
+ *     console.error("Error:", response.message);
+ *   }
+ * }
+ * ```
+ */
+declare function makeRequest<T = any>(method: "POST" | "PUT" | "DELETE" | "PATCH" | "GET", url: string, headers?: HeadersInit, body?: any): Promise<ApiResponseDTO<T>>;
+export { makeRequest };
+//# sourceMappingURL=makeRequest.d.ts.map

package/dist/api/makeRequest.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"makeRequest.d.ts","sourceRoot":"","sources":["../../src/api/makeRequest.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,cAAc,CAAC;AAInD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAiCG;AAEH,iBAAe,WAAW,CAAC,CAAC,GAAG,GAAG,EAChC,MAAM,EAAE,MAAM,GAAG,KAAK,GAAG,QAAQ,GAAG,OAAO,GAAG,KAAK,EACnD,GAAG,EAAE,MAAM,EACX,OAAO,GAAE,WAAgB,EACzB,IAAI,CAAC,EAAE,GAAG,GACT,OAAO,CAAC,cAAc,CAAC,CAAC,CAAC,CAAC,CAsE5B;AAED,OAAO,EAAE,WAAW,EAAE,CAAC"}

package/dist/api/makeRequest.js

@@ -0,0 +1,103 @@
+import { InboxFlowInstance } from "../config/inboxFlowInstance";
+import { inboxFlowRequest } from "./inboxFlowRequest";
+/**
+ * Makes an HTTP request using the Fetch API and returns a standardized response.
+ *
+ * @template T - The expected type of the response data.
+ * @param method - The HTTP method to use for the request. Supported methods are:
+ *   - "POST": Create a new resource.
+ *   - "PUT": Update an existing resource.
+ *   - "DELETE": Remove a resource.
+ *   - "PATCH": Partially update a resource.
+ *   - "GET": Retrieve a resource.
+ * @param url - The URL to which the request is sent.
+ * @param headers - Optional headers to include in the request. Defaults to an empty object.
+ * @param body - Optional body to include in the request. Should be serializable to JSON.
+ * @returns A promise that resolves to an `ApiResponseDTO<T>` object containing:
+ *   - `success`: A boolean indicating whether the request was successful.
+ *   - `status`: The HTTP status code of the response.
+ *   - `message`: A message describing the result of the request.
+ *   - `response`: The parsed JSON response data, or `null` if parsing fails.
+ *   - `cause`: Additional error information, if applicable.
+ *
+ * @example
+ * ```typescript
+ * import { makeRequest } from "./makeRequest";
+ *
+ * async function fetchData() {
+ *   const response = await makeRequest("GET", "https://api.example.com/data");
+ *   if (response.success) {
+ *     console.log("Data:", response.response);
+ *   } else {
+ *     console.error("Error:", response.message);
+ *   }
+ * }
+ * ```
+ */
+async function makeRequest(method, url, headers = {}, body) {
+    const successMessage = {
+        POST: "Resource created successfully",
+        PUT: "Resource updated successfully",
+        DELETE: "Resource deleted successfully",
+        PATCH: "Resource patched successfully",
+        GET: "Request successful",
+    };
+    try {
+        const response = await fetch(url, {
+            method,
+            headers: {
+                ...headers,
+                "Content-Type": "application/json",
+            },
+            body: body ? JSON.stringify(body) : undefined,
+        });
+        const status = response.status;
+        let data = null;
+        try {
+            data = await response.json();
+        }
+        catch {
+            data = null;
+        }
+        inboxFlowRequest({
+            method,
+            status,
+            request: JSON.stringify(response.headers),
+            response: JSON.stringify(data),
+            token: headers?.Authorization || "TOKEN_NOT_FOUND",
+        });
+        if (!response.ok) {
+            return {
+                success: false,
+                status,
+                message: data?.message || response.statusText || "Request failed",
+                response: data,
+                cause: null,
+            };
+        }
+        return {
+            success: true,
+            status,
+            message: data?.message || successMessage[method],
+            response: data,
+            cause: null,
+        };
+    }
+    catch (err) {
+        inboxFlowRequest({
+            method,
+            request: JSON.stringify(headers),
+            response: String(err),
+            status: 500,
+            token: "TOKEN_NOT_FOUND",
+        });
+        return {
+            success: false,
+            status: 0,
+            message: "Network error or request failed",
+            response: null,
+            cause: err instanceof Error ? err.message : String(err),
+        };
+    }
+}
+export { makeRequest };

package/dist/api/patchRequest.d.ts

@@ -0,0 +1,13 @@
+import type { ApiResponseDTO } from "@arkyn/types";
+/**
+ * Sends a PATCH request to the specified URL with optional headers and body.
+ *
+ * @template T - The expected type of the response data.
+ * @param {string} url - The URL to send the PATCH request to.
+ * @param {HeadersInit} [headers={}] - Optional headers to include in the request.
+ * @param {any} body - The body to include in the request.
+ * @returns {Promise<ApiResponseDTO<T>>} A promise that resolves to the API response.
+ */
+declare function patchRequest<T = any>(url: string, headers: HeadersInit | undefined, body: any): Promise<ApiResponseDTO<T>>;
+export { patchRequest };
+//# sourceMappingURL=patchRequest.d.ts.map

package/dist/api/patchRequest.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"patchRequest.d.ts","sourceRoot":"","sources":["../../src/api/patchRequest.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,cAAc,CAAC;AAGnD;;;;;;;;GAQG;AAEH,iBAAe,YAAY,CAAC,CAAC,GAAG,GAAG,EACjC,GAAG,EAAE,MAAM,EACX,OAAO,EAAE,WAAW,YAAK,EACzB,IAAI,EAAE,GAAG,GACR,OAAO,CAAC,cAAc,CAAC,CAAC,CAAC,CAAC,CAE5B;AAED,OAAO,EAAE,YAAY,EAAE,CAAC"}

package/dist/api/patchRequest.js

@@ -0,0 +1,14 @@
+import { makeRequest } from "./makeRequest";
+/**
+ * Sends a PATCH request to the specified URL with optional headers and body.
+ *
+ * @template T - The expected type of the response data.
+ * @param {string} url - The URL to send the PATCH request to.
+ * @param {HeadersInit} [headers={}] - Optional headers to include in the request.
+ * @param {any} body - The body to include in the request.
+ * @returns {Promise<ApiResponseDTO<T>>} A promise that resolves to the API response.
+ */
+async function patchRequest(url, headers = {}, body) {
+    return makeRequest("PATCH", url, headers, body);
+}
+export { patchRequest };

package/dist/api/postRequest.d.ts

@@ -0,0 +1,13 @@
+import type { ApiResponseDTO } from "@arkyn/types";
+/**
+ * Sends a PATCH request to the specified URL with optional headers and body.
+ *
+ * @template T - The expected type of the response data.
+ * @param {string} url - The URL to send the PATCH request to.
+ * @param {HeadersInit} [headers={}] - Optional headers to include in the request.
+ * @param {any} body - The body to include in the request.
+ * @returns {Promise<ApiResponseDTO<T>>} A promise that resolves to the API response.
+ */
+declare function postRequest<T = any>(url: string, headers: HeadersInit | undefined, body: any): Promise<ApiResponseDTO<T>>;
+export { postRequest };
+//# sourceMappingURL=postRequest.d.ts.map

package/dist/api/postRequest.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"postRequest.d.ts","sourceRoot":"","sources":["../../src/api/postRequest.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,cAAc,CAAC;AAGnD;;;;;;;;GAQG;AAEH,iBAAe,WAAW,CAAC,CAAC,GAAG,GAAG,EAChC,GAAG,EAAE,MAAM,EACX,OAAO,EAAE,WAAW,YAAK,EACzB,IAAI,EAAE,GAAG,GACR,OAAO,CAAC,cAAc,CAAC,CAAC,CAAC,CAAC,CAE5B;AAED,OAAO,EAAE,WAAW,EAAE,CAAC"}

package/dist/api/postRequest.js

@@ -0,0 +1,14 @@
+import { makeRequest } from "./makeRequest";
+/**
+ * Sends a PATCH request to the specified URL with optional headers and body.
+ *
+ * @template T - The expected type of the response data.
+ * @param {string} url - The URL to send the PATCH request to.
+ * @param {HeadersInit} [headers={}] - Optional headers to include in the request.
+ * @param {any} body - The body to include in the request.
+ * @returns {Promise<ApiResponseDTO<T>>} A promise that resolves to the API response.
+ */
+async function postRequest(url, headers = {}, body) {
+    return makeRequest("POST", url, headers, body);
+}
+export { postRequest };

package/dist/api/putRequest.d.ts

@@ -0,0 +1,13 @@
+import type { ApiResponseDTO } from "@arkyn/types";
+/**
+ * Sends a PATCH request to the specified URL with optional headers and body.
+ *
+ * @template T - The expected type of the response data.
+ * @param {string} url - The URL to send the PATCH request to.
+ * @param {HeadersInit} [headers={}] - Optional headers to include in the request.
+ * @param {any} body - The body to include in the request.
+ * @returns {Promise<ApiResponseDTO<T>>} A promise that resolves to the API response.
+ */
+declare function putRequest<T = any>(url: string, headers: HeadersInit | undefined, body: any): Promise<ApiResponseDTO<T>>;
+export { putRequest };
+//# sourceMappingURL=putRequest.d.ts.map

package/dist/api/putRequest.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"putRequest.d.ts","sourceRoot":"","sources":["../../src/api/putRequest.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,cAAc,CAAC;AAGnD;;;;;;;;GAQG;AAEH,iBAAe,UAAU,CAAC,CAAC,GAAG,GAAG,EAC/B,GAAG,EAAE,MAAM,EACX,OAAO,EAAE,WAAW,YAAK,EACzB,IAAI,EAAE,GAAG,GACR,OAAO,CAAC,cAAc,CAAC,CAAC,CAAC,CAAC,CAE5B;AAED,OAAO,EAAE,UAAU,EAAE,CAAC"}

package/dist/api/putRequest.js

@@ -0,0 +1,14 @@
+import { makeRequest } from "./makeRequest";
+/**
+ * Sends a PATCH request to the specified URL with optional headers and body.
+ *
+ * @template T - The expected type of the response data.
+ * @param {string} url - The URL to send the PATCH request to.
+ * @param {HeadersInit} [headers={}] - Optional headers to include in the request.
+ * @param {any} body - The body to include in the request.
+ * @returns {Promise<ApiResponseDTO<T>>} A promise that resolves to the API response.
+ */
+async function putRequest(url, headers = {}, body) {
+    return makeRequest("PUT", url, headers, body);
+}
+export { putRequest };

package/dist/config/apiInstance.d.ts

@@ -0,0 +1,80 @@
+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.
+ */
+declare class ApiInstance {
+    private baseUrl;
+    private baseHeaders?;
+    private baseToken?;
+    /**
+     * 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);
+    /**
+     * 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;
+    /**
+     * 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;
+    /**
+     * 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.
+     */
+    GET(route: string, data?: ApiRequestDataWithoutBodyProps): Promise<import("@arkyn/types").ApiResponseDTO<any>>;
+    /**
+     * 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.
+     */
+    POST(route: string, data?: ApiRequestDataWithBodyProps): Promise<import("@arkyn/types").ApiResponseDTO<any>>;
+    /**
+     * 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.
+     */
+    PUT(route: string, data?: ApiRequestDataWithBodyProps): Promise<import("@arkyn/types").ApiResponseDTO<any>>;
+    /**
+     * 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.
+     */
+    PATCH(route: string, data?: ApiRequestDataWithBodyProps): Promise<import("@arkyn/types").ApiResponseDTO<any>>;
+    /**
+     * 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.
+     */
+    DELETE(route: string, data?: ApiRequestDataWithBodyProps): Promise<import("@arkyn/types").ApiResponseDTO<any>>;
+}
+export { ApiInstance };
+//# sourceMappingURL=apiInstance.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"apiInstance.d.ts","sourceRoot":"","sources":["../../src/config/apiInstance.ts"],"names":[],"mappings":"AAMA,KAAK,2BAA2B,GAAG;IACjC,OAAO,EAAE,MAAM,CAAC;IAChB,WAAW,CAAC,EAAE,WAAW,CAAC;IAC1B,SAAS,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CAC3B,CAAC;AAEF,KAAK,8BAA8B,GAAG;IACpC,OAAO,CAAC,EAAE,WAAW,CAAC;IACtB,KAAK,CAAC,EAAE,MAAM,CAAC;CAChB,CAAC;AAEF,KAAK,2BAA2B,GAAG;IACjC,IAAI,CAAC,EAAE,GAAG,CAAC;IACX,OAAO,CAAC,EAAE,WAAW,CAAC;IACtB,KAAK,CAAC,EAAE,MAAM,CAAC;CAChB,CAAC;AAEF;;GAEG;AAEH,cAAM,WAAW;IACf,OAAO,CAAC,OAAO,CAAS;IACxB,OAAO,CAAC,WAAW,CAAC,CAAc;IAClC,OAAO,CAAC,SAAS,CAAC,CAAS;IAE3B;;;;;;OAMG;gBAES,KAAK,EAAE,2BAA2B;IAM9C;;;;OAIG;IAEH,OAAO,CAAC,WAAW;IAInB;;;;;OAKG;IAEH,OAAO,CAAC,eAAe;IAcvB;;;;;OAKG;IAEG,GAAG,CAAC,KAAK,EAAE,MAAM,EAAE,IAAI,CAAC,EAAE,8BAA8B;IAM9D;;;;;OAKG;IAEG,IAAI,CAAC,KAAK,EAAE,MAAM,EAAE,IAAI,CAAC,EAAE,2BAA2B;IAO5D;;;;;OAKG;IAEG,GAAG,CAAC,KAAK,EAAE,MAAM,EAAE,IAAI,CAAC,EAAE,2BAA2B;IAO3D;;;;;OAKG;IAEG,KAAK,CAAC,KAAK,EAAE,MAAM,EAAE,IAAI,CAAC,EAAE,2BAA2B;IAO7D;;;;;OAKG;IAEG,MAAM,CAAC,KAAK,EAAE,MAAM,EAAE,IAAI,CAAC,EAAE,2BAA2B;CAM/D;AAED,OAAO,EAAE,WAAW,EAAE,CAAC"}