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

package/README.md

@@ -0,0 +1,102 @@
+# @arkyn/shared
+
+The `@arkyn/server` package provides utilities and services to facilitate backend application development. It includes API configurations, HTTP error handlers, and useful services for file manipulation.
+
+## Installation
+
+```bash
+npm install @arkyn/server
+```
+
+## Features
+
+### Settings
+
+`ApiInstance`
+Instance configured for API calls.
+
+`InboxFlowInstanceØ`
+Instance configured 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 called the method.
+
+`getScopedParams(request: Request): URLSearchParams`
+Returns the scope parameters of 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.
+
+## License
+
+MIT

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@arkyn/server",
-  "version": "2.0.1-beta.13",
+  "version": "2.0.1-beta.14",
   "main": "./dist/bundle.js",
   "module": "./src/index.ts",
   "type": "module",