@arkyn/server 2.0.1-beta.1 → 2.0.1-beta.3

package/dist/http/successResponses/updated.js

@@ -0,0 +1,29 @@
+class Updated {
+    body;
+    headers;
+    status;
+    statusText;
+    constructor(body, init) {
+        this.body = body;
+        this.headers = init?.headers || {};
+        this.status = init?.status || 200;
+        this.statusText = init?.statusText || "Resource updated successfully";
+    }
+    toResponse() {
+        const responseInit = {
+            headers: { "Content-Type": "application/json", ...this.headers },
+            status: this.status,
+            statusText: this.statusText,
+        };
+        return new Response(JSON.stringify(this.body), responseInit);
+    }
+    toJson() {
+        const responseInit = {
+            headers: this.headers,
+            status: this.status,
+            statusText: this.statusText,
+        };
+        return Response.json(this.body, responseInit);
+    }
+}
+export { Updated };

package/dist/index.d.ts

@@ -1,16 +1,19 @@
-export { BadRequestError } from "./httpBadResponses/badRequest";
-export { ConflictError } from "./httpBadResponses/conflict";
-export { ForbiddenError } from "./httpBadResponses/forbidden";
-export { NotFoundError } from "./httpBadResponses/notFound";
-export { ServerError } from "./httpBadResponses/serverError";
-export { UnauthorizedError } from "./httpBadResponses/unauthorized";
-export { UnprocessableEntityError } from "./httpBadResponses/unprocessableEntity";
-export { Created } from "./httpResponses/created";
-export { NoContent } from "./httpResponses/noContent";
-export { Success } from "./httpResponses/success";
-export { Updated } from "./httpResponses/updated";
-export { globalErrorHandler } from "./helpers/globalErrorHandler";
-export { extractJsonFromRequest } from "./services/extractJsonFromRequest";
+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";
+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";
+export { decodeRequestBody } from "./services/decodeRequestBody";
+export { errorHandler } from "./services/errorHandler";
 export { formParse } from "./services/formParse";
 export { getScopedParams } from "./services/getScopedParams";
 export { sendFileToS3 } from "./services/sendFileToS3";

package/dist/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,eAAe,EAAE,MAAM,+BAA+B,CAAC;AAChE,OAAO,EAAE,aAAa,EAAE,MAAM,6BAA6B,CAAC;AAC5D,OAAO,EAAE,cAAc,EAAE,MAAM,8BAA8B,CAAC;AAC9D,OAAO,EAAE,aAAa,EAAE,MAAM,6BAA6B,CAAC;AAC5D,OAAO,EAAE,WAAW,EAAE,MAAM,gCAAgC,CAAC;AAC7D,OAAO,EAAE,iBAAiB,EAAE,MAAM,iCAAiC,CAAC;AACpE,OAAO,EAAE,wBAAwB,EAAE,MAAM,wCAAwC,CAAC;AAGlF,OAAO,EAAE,OAAO,EAAE,MAAM,yBAAyB,CAAC;AAClD,OAAO,EAAE,SAAS,EAAE,MAAM,2BAA2B,CAAC;AACtD,OAAO,EAAE,OAAO,EAAE,MAAM,yBAAyB,CAAC;AAClD,OAAO,EAAE,OAAO,EAAE,MAAM,yBAAyB,CAAC;AAGlD,OAAO,EAAE,kBAAkB,EAAE,MAAM,8BAA8B,CAAC;AAGlE,OAAO,EAAE,sBAAsB,EAAE,MAAM,mCAAmC,CAAC;AAC3E,OAAO,EAAE,SAAS,EAAE,MAAM,sBAAsB,CAAC;AACjD,OAAO,EAAE,eAAe,EAAE,MAAM,4BAA4B,CAAC;AAC7D,OAAO,EAAE,YAAY,EAAE,MAAM,yBAAyB,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,MAAM,gCAAgC,CAAC;AAC5D,OAAO,EAAE,UAAU,EAAE,MAAM,gCAAgC,CAAC;AAC5D,OAAO,EAAE,QAAQ,EAAE,MAAM,8BAA8B,CAAC;AACxD,OAAO,EAAE,SAAS,EAAE,MAAM,+BAA+B,CAAC;AAC1D,OAAO,EAAE,QAAQ,EAAE,MAAM,8BAA8B,CAAC;AACxD,OAAO,EAAE,cAAc,EAAE,MAAM,oCAAoC,CAAC;AACpE,OAAO,EAAE,WAAW,EAAE,MAAM,iCAAiC,CAAC;AAC9D,OAAO,EAAE,YAAY,EAAE,MAAM,kCAAkC,CAAC;AAChE,OAAO,EAAE,mBAAmB,EAAE,MAAM,yCAAyC,CAAC;AAE9E,OAAO,EAAE,OAAO,EAAE,MAAM,iCAAiC,CAAC;AAC1D,OAAO,EAAE,KAAK,EAAE,MAAM,+BAA+B,CAAC;AACtD,OAAO,EAAE,SAAS,EAAE,MAAM,mCAAmC,CAAC;AAC9D,OAAO,EAAE,OAAO,EAAE,MAAM,iCAAiC,CAAC;AAC1D,OAAO,EAAE,OAAO,EAAE,MAAM,iCAAiC,CAAC;AAE1D,OAAO,EAAE,iBAAiB,EAAE,MAAM,8BAA8B,CAAC;AACjE,OAAO,EAAE,YAAY,EAAE,MAAM,yBAAyB,CAAC;AACvD,OAAO,EAAE,SAAS,EAAE,MAAM,sBAAsB,CAAC;AACjD,OAAO,EAAE,eAAe,EAAE,MAAM,4BAA4B,CAAC;AAC7D,OAAO,EAAE,YAAY,EAAE,MAAM,yBAAyB,CAAC"}

package/dist/index.js

@@ -1,20 +1,19 @@
-// http bad responses
-export { BadRequestError } from "./httpBadResponses/badRequest";
-export { ConflictError } from "./httpBadResponses/conflict";
-export { ForbiddenError } from "./httpBadResponses/forbidden";
-export { NotFoundError } from "./httpBadResponses/notFound";
-export { ServerError } from "./httpBadResponses/serverError";
-export { UnauthorizedError } from "./httpBadResponses/unauthorized";
-export { UnprocessableEntityError } from "./httpBadResponses/unprocessableEntity";
-// http responses
-export { Created } from "./httpResponses/created";
-export { NoContent } from "./httpResponses/noContent";
-export { Success } from "./httpResponses/success";
-export { Updated } from "./httpResponses/updated";
-// helpers
-export { globalErrorHandler } from "./helpers/globalErrorHandler";
-// services
-export { extractJsonFromRequest } from "./services/extractJsonFromRequest";
+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";
+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";
+export { decodeRequestBody } from "./services/decodeRequestBody";
+export { errorHandler } from "./services/errorHandler";
 export { formParse } from "./services/formParse";
 export { getScopedParams } from "./services/getScopedParams";
 export { sendFileToS3 } from "./services/sendFileToS3";

package/dist/services/decodeRequestBody.d.ts

@@ -0,0 +1,17 @@
+import type { DecodeRequestBodyFunction } from "@arkyn/types";
+/**
+ * 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.
+ */
+declare const decodeRequestBody: DecodeRequestBodyFunction;
+export { decodeRequestBody };
+//# sourceMappingURL=decodeRequestBody.d.ts.map

package/dist/services/decodeRequestBody.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"decodeRequestBody.d.ts","sourceRoot":"","sources":["../../src/services/decodeRequestBody.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,yBAAyB,EAAE,MAAM,cAAc,CAAC;AAE9D;;;;;;;;;;;;GAYG;AAEH,QAAA,MAAM,iBAAiB,EAAE,yBA2BxB,CAAC;AAEF,OAAO,EAAE,iBAAiB,EAAE,CAAC"}

package/dist/services/{extractJsonFromRequest.js → decodeRequestBody.js}

@@ -1,4 +1,17 @@
-async function extractJsonFromRequest(req) {
+/**
+ * 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 = async (req) => {
     let data;
     try {
         const arrayBuffer = await req.arrayBuffer();
@@ -25,5 +38,5 @@ async function extractJsonFromRequest(req) {
         data = {};
     }
     return data;
-}
-export { extractJsonFromRequest };
+};
+export { decodeRequestBody };

package/dist/services/errorHandler.d.ts

@@ -0,0 +1,3 @@
+declare function errorHandler(error: any): Response | undefined;
+export { errorHandler };
+//# sourceMappingURL=errorHandler.d.ts.map

package/dist/services/errorHandler.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"errorHandler.d.ts","sourceRoot":"","sources":["../../src/services/errorHandler.ts"],"names":[],"mappings":"AAgBA,iBAAS,YAAY,CAAC,KAAK,EAAE,GAAG,wBAoC/B;AAED,OAAO,EAAE,YAAY,EAAE,CAAC"}

package/dist/services/errorHandler.js

@@ -0,0 +1,51 @@
+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";
+function errorHandler(error) {
+    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();
+    }
+}
+export { errorHandler };

package/dist/services/formParse.d.ts

@@ -1,3 +1,42 @@
 import type { FormParseProps, FormParseReturnType } from "@arkyn/types";
-export declare function formParse<T extends FormParseProps>([formData, schema,]: T): FormParseReturnType<T>;
+/**
+ * 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
+ * }
+ * ```
+ */
+declare function formParse<T extends FormParseProps>([formData, schema,]: T): FormParseReturnType<T>;
+export { formParse };
 //# sourceMappingURL=formParse.d.ts.map

package/dist/services/formParse.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"formParse.d.ts","sourceRoot":"","sources":["../../src/services/formParse.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,cAAc,EAAE,mBAAmB,EAAE,MAAM,cAAc,CAAC;AAExE,wBAAgB,SAAS,CAAC,CAAC,SAAS,cAAc,EAAE,CAClD,QAAQ,EACR,MAAM,EACP,EAAE,CAAC,GAAG,mBAAmB,CAAC,CAAC,CAAC,CAoB5B"}
+{"version":3,"file":"formParse.d.ts","sourceRoot":"","sources":["../../src/services/formParse.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,cAAc,EAAE,mBAAmB,EAAE,MAAM,cAAc,CAAC;AAExE;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAqCG;AAEH,iBAAS,SAAS,CAAC,CAAC,SAAS,cAAc,EAAE,CAC3C,QAAQ,EACR,MAAM,EACP,EAAE,CAAC,GAAG,mBAAmB,CAAC,CAAC,CAAC,CAoB5B;AAED,OAAO,EAAE,SAAS,EAAE,CAAC"}

package/dist/services/formParse.js

@@ -1,4 +1,42 @@
-export function formParse([formData, schema,]) {
+/**
+ * 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([formData, schema,]) {
     const zodResponse = schema.safeParse(formData);
     if (zodResponse.success === false) {
         const errorsArray = Object.entries(zodResponse.error.formErrors.fieldErrors);
@@ -13,3 +51,4 @@ export function formParse([formData, schema,]) {
         return { success: zodResponse.success, data: zodResponse.data };
     }
 }
+export { formParse };

package/dist/services/getScopedParams.d.ts

@@ -1,3 +1,28 @@
-declare function getScopedParams(request: Request, scope?: string): URLSearchParams;
+import type { GetScopedParamsFunction } from "@arkyn/types";
+/**
+ * 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"
+ */
+declare const getScopedParams: GetScopedParamsFunction;
 export { getScopedParams };
 //# sourceMappingURL=getScopedParams.d.ts.map

package/dist/services/getScopedParams.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"getScopedParams.d.ts","sourceRoot":"","sources":["../../src/services/getScopedParams.ts"],"names":[],"mappings":"AAAA,iBAAS,eAAe,CAAC,OAAO,EAAE,OAAO,EAAE,KAAK,GAAE,MAAW,mBAW5D;AAED,OAAO,EAAE,eAAe,EAAE,CAAC"}
+{"version":3,"file":"getScopedParams.d.ts","sourceRoot":"","sources":["../../src/services/getScopedParams.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,uBAAuB,EAAE,MAAM,cAAc,CAAC;AAE5D;;;;;;;;;;;;;;;;;;;;;;;GAuBG;AAEH,QAAA,MAAM,eAAe,EAAE,uBAWtB,CAAC;AAEF,OAAO,EAAE,eAAe,EAAE,CAAC"}

package/dist/services/getScopedParams.js

@@ -1,4 +1,28 @@
-function getScopedParams(request, scope = "") {
+/**
+ * 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 = (request, scope = "") => {
     const url = new URL(request.url);
     if (scope === "")
         return url.searchParams;
@@ -6,5 +30,5 @@ function getScopedParams(request, scope = "") {
         .filter(([key]) => key.startsWith(`${scope}:`))
         .map(([key, value]) => [key.replace(`${scope}:`, ""), value]);
     return new URLSearchParams(scopedSearchParams);
-}
+};
 export { getScopedParams };

package/dist/services/sendFileToS3.d.ts

@@ -1,20 +1,52 @@
-import { type ActionFunctionArgs } from "@remix-run/node";
-type AWSConfig = {
-    AWS_REGION: string;
-    AWS_ACCESS_KEY_ID: string;
-    AWS_SECRET_ACCESS_KEY: string;
-    AWS_S3_BUCKET: string;
-};
-type Config = {
-    maxPartSize?: number;
-    fileName?: string;
-};
-declare function sendFileToS3(props: ActionFunctionArgs, awsS3Config: AWSConfig, config?: Config): Promise<{
-    error: string;
-    url?: undefined;
-} | {
-    url: string;
-    error?: undefined;
-}>;
+import type { SendFileToS3Function } from "@arkyn/types";
+/**
+ * Handles file uploads to an AWS S3 bucket. This function processes a file
+ * from a multipart form request, validates and optionally compresses the file,
+ * and uploads it to S3. It supports image-specific operations such as resizing
+ * validation and quality reduction.
+ *
+ * @param request - The HTTP request containing the multipart form data.
+ * @param awsS3Config - Configuration object for AWS S3, including bucket name,
+ * region, and credentials.
+ * @param config - Optional configuration object for file handling.
+ *
+ * @param config.fileName - The name of the form field containing the file. Defaults to `"file"`.
+ * @param config.maxPartSize - The maximum size (in bytes) for each part of the file. Defaults to `5_000_000`.
+ * @param config.reduceImageQuality - The quality percentage for image compression. Defaults to `100`.
+ * @param config.validateImageSize - Whether to validate the image dimensions. Defaults to `false`.
+ * @param config.validateImageMessage - The error message template for invalid image dimensions.
+ * Defaults to `"Invalid dimensions {{width}}px x {{height}}px"`.
+ *
+ * @returns A promise that resolves to an object containing the uploaded file's URL
+ * or an error message if validation fails.
+ *
+ * @throws {BadRequest} If no file is uploaded.
+ *
+ * @example
+ * ```typescript
+ * const awsS3Config = {
+ *   AWS_S3_BUCKET: "my-bucket",
+ *   AWS_REGION: "us-east-1",
+ *   AWS_ACCESS_KEY_ID: "my-access-key",
+ *   AWS_SECRET_ACCESS_KEY: "my-secret-key",
+ * };
+ *
+ * const config = {
+ *   fileName: "upload",
+ *   maxPartSize: 10_000_000,
+ *   reduceImageQuality: 80,
+ *   validateImageSize: true,
+ *   validateImageMessage: "Invalid dimensions {{width}}px x {{height}}px",
+ * };
+ *
+ * const response = await sendFileToS3(request, awsS3Config, config);
+ * if (response.error) {
+ *   console.error(response.error);
+ * } else {
+ *   console.log("File uploaded to:", response.url);
+ * }
+ * ```
+ */
+declare const sendFileToS3: SendFileToS3Function;
 export { sendFileToS3 };
 //# sourceMappingURL=sendFileToS3.d.ts.map

package/dist/services/sendFileToS3.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"sendFileToS3.d.ts","sourceRoot":"","sources":["../../src/services/sendFileToS3.ts"],"names":[],"mappings":"AACA,OAAO,EAIL,KAAK,kBAAkB,EAExB,MAAM,iBAAiB,CAAC;AAOzB,KAAK,SAAS,GAAG;IACf,UAAU,EAAE,MAAM,CAAC;IACnB,iBAAiB,EAAE,MAAM,CAAC;IAC1B,qBAAqB,EAAE,MAAM,CAAC;IAC9B,aAAa,EAAE,MAAM,CAAC;CACvB,CAAC;AAEF,KAAK,MAAM,GAAG;IACZ,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,QAAQ,CAAC,EAAE,MAAM,CAAC;CACnB,CAAC;AAmDF,iBAAe,YAAY,CACzB,KAAK,EAAE,kBAAkB,EACzB,WAAW,EAAE,SAAS,EACtB,MAAM,GAAE,MAGP;;;;;;GAwEF;AAED,OAAO,EAAE,YAAY,EAAE,CAAC"}
+{"version":3,"file":"sendFileToS3.d.ts","sourceRoot":"","sources":["../../src/services/sendFileToS3.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAa,oBAAoB,EAAE,MAAM,cAAc,CAAC;AA8CpE;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA+CG;AAEH,QAAA,MAAM,YAAY,EAAE,oBAkFnB,CAAC;AAEF,OAAO,EAAE,YAAY,EAAE,CAAC"}

package/dist/services/sendFileToS3.js

@@ -1,31 +1,22 @@
+import { generateId } from "@arkyn/shared";
 import { PutObjectCommand, S3Client } from "@aws-sdk/client-s3";
 import { unstable_composeUploadHandlers as composeUploadHandlers, unstable_createFileUploadHandler as createFileUploadHandler, unstable_parseMultipartFormData as parseMultipartFormData, } from "@remix-run/node";
-import { randomUUID } from "crypto";
 import fs from "fs";
 import sharp from "sharp";
-import { BadRequestError } from "../httpBadResponses/badRequest";
+import { BadRequest } from "../http/badResponses/badRequest";
 import { getScopedParams } from "./getScopedParams";
-async function s3_upload(fileStream, contentType, awsS3Config) {
-    const { AWS_ACCESS_KEY_ID, AWS_REGION, AWS_S3_BUCKET, AWS_SECRET_ACCESS_KEY, } = awsS3Config;
-    const filePath = fileStream.path;
-    let fileName = "";
-    if (typeof filePath === "string") {
-        fileName = filePath.split("/").pop() || "";
-    }
-    else {
-        fileName = randomUUID();
-    }
+async function s3Upload(fileStream, contentType, awsConfig) {
     const uploadParams = {
-        Bucket: AWS_S3_BUCKET,
-        Key: `uploads/${Date.now()}-${fileName.split(" ").join("-")}`,
+        Bucket: awsConfig.AWS_S3_BUCKET,
+        Key: `uploads/${generateId("text", "v4")}`,
         Body: fileStream,
         ContentType: contentType,
     };
     const s3Client = new S3Client({
-        region: AWS_REGION,
+        region: awsConfig.AWS_REGION,
         credentials: {
-            accessKeyId: AWS_ACCESS_KEY_ID,
-            secretAccessKey: AWS_SECRET_ACCESS_KEY,
+            accessKeyId: awsConfig.AWS_ACCESS_KEY_ID,
+            secretAccessKey: awsConfig.AWS_SECRET_ACCESS_KEY,
         },
     });
     const command = new PutObjectCommand(uploadParams);
@@ -36,15 +27,64 @@ async function s3_upload(fileStream, contentType, awsS3Config) {
         console.error(error);
     }
     return {
-        location: `https://${AWS_S3_BUCKET}.s3.amazonaws.com/${uploadParams.Key}`,
+        location: `https://${awsConfig.AWS_S3_BUCKET}.s3.amazonaws.com/${uploadParams.Key}`,
     };
 }
-async function sendFileToS3(props, awsS3Config, config = {
-    maxPartSize: 5_000_000,
-    fileName: "file",
-}) {
-    const { fileName = "file", maxPartSize = 5_000_000 } = config;
-    const { request } = props;
+/**
+ * Handles file uploads to an AWS S3 bucket. This function processes a file
+ * from a multipart form request, validates and optionally compresses the file,
+ * and uploads it to S3. It supports image-specific operations such as resizing
+ * validation and quality reduction.
+ *
+ * @param request - The HTTP request containing the multipart form data.
+ * @param awsS3Config - Configuration object for AWS S3, including bucket name,
+ * region, and credentials.
+ * @param config - Optional configuration object for file handling.
+ *
+ * @param config.fileName - The name of the form field containing the file. Defaults to `"file"`.
+ * @param config.maxPartSize - The maximum size (in bytes) for each part of the file. Defaults to `5_000_000`.
+ * @param config.reduceImageQuality - The quality percentage for image compression. Defaults to `100`.
+ * @param config.validateImageSize - Whether to validate the image dimensions. Defaults to `false`.
+ * @param config.validateImageMessage - The error message template for invalid image dimensions.
+ * Defaults to `"Invalid dimensions {{width}}px x {{height}}px"`.
+ *
+ * @returns A promise that resolves to an object containing the uploaded file's URL
+ * or an error message if validation fails.
+ *
+ * @throws {BadRequest} If no file is uploaded.
+ *
+ * @example
+ * ```typescript
+ * const awsS3Config = {
+ *   AWS_S3_BUCKET: "my-bucket",
+ *   AWS_REGION: "us-east-1",
+ *   AWS_ACCESS_KEY_ID: "my-access-key",
+ *   AWS_SECRET_ACCESS_KEY: "my-secret-key",
+ * };
+ *
+ * const config = {
+ *   fileName: "upload",
+ *   maxPartSize: 10_000_000,
+ *   reduceImageQuality: 80,
+ *   validateImageSize: true,
+ *   validateImageMessage: "Invalid dimensions {{width}}px x {{height}}px",
+ * };
+ *
+ * const response = await sendFileToS3(request, awsS3Config, config);
+ * if (response.error) {
+ *   console.error(response.error);
+ * } else {
+ *   console.log("File uploaded to:", response.url);
+ * }
+ * ```
+ */
+const sendFileToS3 = async (request, awsS3Config, config) => {
+    const fileName = config?.fileName || "file";
+    const maxPartSize = config?.maxPartSize || 5_000_000;
+    const reduceImageQuality = config?.reduceImageQuality || 100;
+    const validateImageSize = config?.validateImageSize || false;
+    const validateImageMessage = config?.validateImageMessage ||
+        "Invalid dimensions {{width}}px x {{height}}px";
     const uploadHandler = composeUploadHandlers(createFileUploadHandler({
         maxPartSize,
         file: ({ filename }) => filename,
@@ -52,14 +92,14 @@ async function sendFileToS3(props, awsS3Config, config = {
     const formData = await parseMultipartFormData(request, uploadHandler);
     const file = formData.get(fileName);
     if (!file)
-        throw new BadRequestError("No file uploaded");
+        throw new BadRequest("No file uploaded");
     const filterParams = getScopedParams(request);
     const width = filterParams.get("w");
     const height = filterParams.get("h");
     const reduceQuality = filterParams.get("reduceQuality");
-    const quality = reduceQuality ? +reduceQuality : 100;
+    const quality = reduceQuality ? +reduceQuality : reduceImageQuality;
     const isImage = file.type.startsWith("image");
-    if (isImage && width && height) {
+    if (isImage && width && height && validateImageSize) {
         const image = sharp(file.getFilePath());
         const metadata = await image.metadata();
         if (metadata.width && metadata.height) {
@@ -67,7 +107,9 @@ async function sendFileToS3(props, awsS3Config, config = {
             const heightDiff = Math.abs(metadata.height - +height);
             if (widthDiff > 10 || heightDiff > 10) {
                 return {
-                    error: `Formato inválido ${metadata.width}px x ${metadata.height}px`,
+                    error: validateImageMessage
+                        .replace("{{width}}", width)
+                        .replace("{{height}}", height),
                 };
             }
         }
@@ -87,7 +129,7 @@ async function sendFileToS3(props, awsS3Config, config = {
         await image.toFile(compressedFilePath);
         file.getFilePath = () => compressedFilePath;
         const streamFile = fs.createReadStream(file.getFilePath());
-        const apiResponse = await s3_upload(streamFile, file.type, awsS3Config);
+        const apiResponse = await s3Upload(streamFile, file.type, awsS3Config);
         fs.unlink(compressedFilePath, (err) => {
             if (err)
                 console.error(`Delete image error: ${err}`);
@@ -95,7 +137,7 @@ async function sendFileToS3(props, awsS3Config, config = {
         return { url: apiResponse.location };
     }
     const streamFile = fs.createReadStream(file.getFilePath());
-    const apiResponse = await s3_upload(streamFile, file.type, awsS3Config);
+    const apiResponse = await s3Upload(streamFile, file.type, awsS3Config);
     return { url: apiResponse.location };
-}
+};
 export { sendFileToS3 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@arkyn/server",
-  "version": "2.0.1-beta.1",
+  "version": "2.0.1-beta.3",
   "main": "./dist/bundle.js",
   "module": "./src/index.ts",
   "type": "module",
@@ -12,6 +12,7 @@
   },
   "dependencies": {
     "@arkyn/server": "*",
+    "@arkyn/shared": "*",
     "@aws-sdk/client-s3": "^3.775.0",
     "@remix-run/node": "^2.16.2",
     "sharp": "^0.33.5"