formflux 0.2.18 → 0.2.20

package/README.md

@@ -119,6 +119,16 @@ Here are some of the features of FormFlux:
 8. **Error Handling**
     - Provides error handling through error class FormfluxError which also provides statuscodes. Similar to Multer error class.
 
+## TypeScript: Enabling `req.file` and `req.files`
+
+Formflux augments the Express `Request` object with `file` and `files`.
+
+To enable typing if not bale to access files or file from Request object, add this line to a global type declaration file in your project (e.g., `src/types/formflux.d.ts` or any `.d.ts` file included in `tsconfig.json`):
+
+```ts
+import "formflux";
+```
+
 ## Limitation
 
 Due to its custom implementation (not using `busboy`), the recommended **maximum file size is 200MB**. Going beyond that may lead to performance issues or high memory usage.

package/dist/cjs/index.d.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.js","names":[],"sources":["../../src/index.d.ts"],"sourcesContent":["export {};\r\n\r\nimport type { File } from \"./FormFlux.Types\";\r\n\r\ndeclare module \"express-serve-static-core\" {\r\n  interface Request {\r\n    file?: File;\r\n    files?: File[] | { [fieldname: string]: File[] };\r\n  }\r\n}"],"mappings":"","ignoreList":[]}
+{"version":3,"file":"index.d.js","names":[],"sources":["../../src/index.d.ts"],"sourcesContent":["export {};\ndeclare module \"express-serve-static-core\" {\n  interface Request {\n    file?: {\n      mimetype: string,\n      originalname: string,\n      filesize: number,\n      filename: string,\n      fieldname: string,\n      filepath?: string,\n      buffer?: Buffer\n    };\n    files?: Array<{\n      mimetype: string,\n      originalname: string,\n      filesize: number,\n      filename: string,\n      fieldname: string,\n      filepath?: string,\n      buffer?: Buffer\n    }> | {\n      [fieldname: string]: Array<{\n        mimetype: string,\n        originalname: string,\n        filename: string,\n        filesize: number,\n        fieldname: string,\n        filepath?: string,\n        buffer?: Buffer\n      }>\n    };\n  }\n}"],"mappings":"","ignoreList":[]}

package/dist/esm/index.d.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.js","names":[],"sources":["../../src/index.d.ts"],"sourcesContent":["export {};\r\n\r\nimport type { File } from \"./FormFlux.Types\";\r\n\r\ndeclare module \"express-serve-static-core\" {\r\n  interface Request {\r\n    file?: File;\r\n    files?: File[] | { [fieldname: string]: File[] };\r\n  }\r\n}"],"mappings":"AAAA","ignoreList":[]}
+{"version":3,"file":"index.d.js","names":[],"sources":["../../src/index.d.ts"],"sourcesContent":["export {};\ndeclare module \"express-serve-static-core\" {\n  interface Request {\n    file?: {\n      mimetype: string,\n      originalname: string,\n      filesize: number,\n      filename: string,\n      fieldname: string,\n      filepath?: string,\n      buffer?: Buffer\n    };\n    files?: Array<{\n      mimetype: string,\n      originalname: string,\n      filesize: number,\n      filename: string,\n      fieldname: string,\n      filepath?: string,\n      buffer?: Buffer\n    }> | {\n      [fieldname: string]: Array<{\n        mimetype: string,\n        originalname: string,\n        filename: string,\n        filesize: number,\n        fieldname: string,\n        filepath?: string,\n        buffer?: Buffer\n      }>\n    };\n  }\n}"],"mappings":"AAAA","ignoreList":[]}

package/dist/package.json

@@ -1,6 +1,6 @@
 {
   "name": "formflux",
-  "version": "0.2.18",
+  "version": "0.2.20",
   "description": "A package to upload files to a server and parsing multipart-formData requests",
   "main": "./dist/cjs/FormFlux.js",
   "module": "./dist/esm/FormFlux.js",
@@ -24,6 +24,13 @@
     "build:types": "tsc --emitDeclarationOnly --outDir dist/types",
     "copy-types": "copyfiles -u 1 src/index.d.ts dist/types"
   },
+  "typesVersions": {
+    "*": {
+      "*": [
+        "dist/types/*"
+      ]
+    }
+  },
   "keywords": [
     "FormFlux",
     "formflux",
@@ -72,4 +79,4 @@
   "files": [
     "dist"
   ]
-}
+}

package/dist/types/index.d.ts

@@ -1,10 +1,33 @@
-export {};
-
-import type { File } from "./FormFlux.Types";
-
-declare module "express-serve-static-core" {
-  interface Request {
-    file?: File;
-    files?: File[] | { [fieldname: string]: File[] };
-  }
+export {};
+declare module "express-serve-static-core" {
+  interface Request {
+    file?: {
+      mimetype: string,
+      originalname: string,
+      filesize: number,
+      filename: string,
+      fieldname: string,
+      filepath?: string,
+      buffer?: Buffer
+    };
+    files?: Array<{
+      mimetype: string,
+      originalname: string,
+      filesize: number,
+      filename: string,
+      fieldname: string,
+      filepath?: string,
+      buffer?: Buffer
+    }> | {
+      [fieldname: string]: Array<{
+        mimetype: string,
+        originalname: string,
+        filename: string,
+        filesize: number,
+        fieldname: string,
+        filepath?: string,
+        buffer?: Buffer
+      }>
+    };
+  }
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "formflux",
-  "version": "0.2.18",
+  "version": "0.2.20",
   "description": "A package to upload files to a server and parsing multipart-formData requests",
   "main": "./dist/cjs/FormFlux.js",
   "module": "./dist/esm/FormFlux.js",
@@ -24,6 +24,13 @@
     "build:types": "tsc --emitDeclarationOnly --outDir dist/types",
     "copy-types": "copyfiles -u 1 src/index.d.ts dist/types"
   },
+  "typesVersions": {
+    "*": {
+      "*": [
+        "dist/types/*"
+      ]
+    }
+  },
   "keywords": [
     "FormFlux",
     "formflux",
@@ -72,4 +79,4 @@
   "files": [
     "dist"
   ]
-}
+}