https://github.com/hviana/Upload-middleware-for-Oak-Deno-framework

This middleware automatically organizes uploads to avoid file system problems and create dirs if not exists, perform validations and optimizes ram usage when uploading big files using Deno standard libraries!
https://github.com/hviana/Upload-middleware-for-Oak-Deno-framework

Last synced: about 2 months ago
JSON representation

This middleware automatically organizes uploads to avoid file system problems and create dirs if not exists, perform validations and optimizes ram usage when uploading big files using Deno standard libraries!

• Host: GitHub
• URL: https://github.com/hviana/Upload-middleware-for-Oak-Deno-framework
• Owner: hviana
• License: mit
• Created: 2020-05-28T20:09:33.000Z (over 4 years ago)
• Default Branch: master
• Last Pushed: 2022-02-28T20:25:26.000Z (over 2 years ago)
• Last Synced: 2024-05-08T16:32:59.340Z (5 months ago)
• Language: TypeScript
• Homepage:
• Size: 171 KB
• Stars: 26
• Watchers: 4
• Forks: 13
• Open Issues: 4
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Upload middleware for Oak Deno framework

This middleware automatically organizes uploads to avoid file system problems and create dirs if not exists, perform validations and optimizes ram usage when uploading large files using Deno standard libraries!

## Usage: 

Ex: 

```javascript

.post("/upload", upload('uploads'), async (context: any, next: any) => { ...

.post("/upload", upload('uploads', { extensions: ['jpg', 'png'], maxSizeBytes: 20000000, maxFileSizeBytes: 10000000, saveFile: true, readFile: false, useCurrentDir: true, useDateTimeSubDir: true }), async (context: any, next: any) => { ...

.post("/upload", upload('uploads', { extensions: ['jpg', 'png'], useDateTimeSubDir: false }), async (context: any, next: any) => { ...

```

Uploads will be in context.uploadedFiles;

upload(

path,

extensions: optional ex: ['jpg', 'png'], default allow all - [].

maxSizeBytes: optional, max total size in bytes for all files in form, default unlimited - Number.MAX_SAFE_INTEGER.

maxFileSizeBytes: optional, max size in bytes for each file in form, default unlimited - Number.MAX_SAFE_INTEGER.

saveFile: optional, if false the file will not be saved in the file system, and a temporary file generated by Deno std will returned in 'tempfile' field, default true.

readFile: optional, if true the file will be fully loaded on the ram and a Uint8Array will be returned in the 'data' field, default false.

useCurrentDir: optional, if true the path is relative to current Deno working directory, default true.

useDateTimeSubDir: optional, if true the file path will be prefixed with /year/month/day/hour/minute/second/uuid/filename e.g. `/2020/4/4/20/0/28/1350065e-7053-429b-869b-08008a098b23/test.jpg`, default true.

), next middlewares ...

Request must contains a body with form type "multipart/form-data", and inputs with type="file". 

Ex: 

```javascript

.post("/pre_upload", preUploadValidate(["jpg", "png"], 20000000, 10000000), async (context: any, next: any) => { ...

```

preUploadValidate(

extensions: optional ex: ['jpg', 'png'], default allow all - [], 

maxSizeBytes: optional, max total size in bytes for all files in form, default unlimited - Number.MAX_SAFE_INTEGER, 

maxFileSizeBytes: optional, max size in bytes for each file in form, default unlimited - Number.MAX_SAFE_INTEGER

), next middlewares ...

This middleware does a pre-validation before sending the form, for optimizations. To use it, send a JSON containing the objects "file". Use a different route than the upload route. Returns a validation message with all errors and status 422 (if there are errors).

## Examples:

Below an example to work with AJAX, also accepting type="file" multiple:

```javascript

var files = document.querySelector('#yourFormId input[type=file]').files

var name = document.querySelector('#yourFormId input[type=file]').getAttribute('name');

var form = new FormData();

for(var i=0;iresponse.json())

console.log(res)

//VALIDATIONS --------------

var validationData = {}

for(var i=0;iresponse.json())

console.log(validations)

```

In Deno:

```javascript

import { upload, preUploadValidate} from "https://deno.land/x/upload_middleware_for_oak_framework/mod.ts";

  .post("/upload", upload('uploads', { extensions: ['jpg', 'png'], maxSizeBytes: 20000000, maxFileSizeBytes: 10000000 }),

    async (context: any, next: any) => {

      context.response.body = context.uploadedFiles;

    },

  )

  .post("/pre_upload", preUploadValidate(["jpg", "png"], 20000000, 10000000),

    async (context: any, next: any) => {

      context.response.body = { msg: "Pass upload validations." };

    },

  )

  .get("/", async (context: any, next: any) => {

    context.response.body = `

            

              


              

            

    `;

  })

  //This will return something like:

{

	"file1_0":{

		"filename":"test.jpg",

		"type":"image/jpeg",

		"size":16980,

		"id":"2020/4/4/20/0/28/1350065e-7053-429b-869b-08008a098b23",

		"url":"uploads/2020/4/4/20/0/28/1350065e-7053-429b-869b-08008a098b23/test.jpg",

		"uri":"C:\\Users\\Engenharia\\Documents\\base\\uploads\\2020\\4\\4\\20\\0\\28\\1350065e-7053-429b-869b-08008a098b23\\test.jpg"

	},

	"file1_1":{

		"filename":"download.png",

		"type":"image/png",

		"size":2623,

		"id":"2020/4/4/20/0/28/46698b10-d319-4bbb-af64-fc8b2b991b54",

		"url":"uploads/2020/4/4/20/0/28/46698b10-d319-4bbb-af64-fc8b2b991b54/download.png",

		"uri":"C:\\Users\\Engenharia\\Documents\\base\\uploads\\2020\\4\\4\\20\\0\\28\\46698b10-d319-4bbb-af64-fc8b2b991b54\\download.png"

	}

}

```

If you want, you can delete a file sent using:

```javascript

await Deno.remove(context.uploadedFiles['file2']['uri']);

```

Or (if not save file):

```javascript

await Deno.remove(context.uploadedFiles['file2']['tempfile']);

```

Remember that you need permissions:

```sh

deno run --allow-net --allow-read --allow-write ./server.ts

```