@eggjs/multipart 4.0.0 → 5.0.0-beta.17

package/dist/config/config.default.js

@@ -0,0 +1,28 @@
+import path from "node:path";
+import os from "node:os";
+
+//#region src/config/config.default.ts
+var config_default_default = (appInfo) => {
+	return { multipart: {
+		mode: "stream",
+		autoFields: false,
+		defaultCharset: "utf8",
+		defaultParamCharset: "utf8",
+		fieldNameSize: 100,
+		fieldSize: "100kb",
+		fields: 10,
+		fileSize: "10mb",
+		files: 10,
+		fileExtensions: [],
+		whitelist: null,
+		allowArrayField: false,
+		tmpdir: path.join(os.tmpdir(), "egg-multipart-tmp", appInfo.name),
+		cleanSchedule: {
+			cron: "0 30 4 * * *",
+			disable: false
+		}
+	} };
+};
+
+//#endregion
+export { config_default_default as default };

package/dist/index.d.ts

@@ -0,0 +1 @@
+export { };

package/dist/index.js

@@ -0,0 +1,3 @@
+import "./app/extend/context.js";
+
+export {  };

package/dist/lib/LimitError.d.ts

@@ -0,0 +1,8 @@
+//#region src/lib/LimitError.d.ts
+declare class LimitError extends Error {
+  code: string;
+  status: number;
+  constructor(code: string, message: string);
+}
+//#endregion
+export { LimitError };

package/dist/lib/LimitError.js

@@ -0,0 +1,15 @@
+//#region src/lib/LimitError.ts
+var LimitError = class extends Error {
+	code;
+	status;
+	constructor(code, message) {
+		super(message);
+		this.code = code;
+		this.status = 413;
+		this.name = this.constructor.name;
+		Error.captureStackTrace(this, this.constructor);
+	}
+};
+
+//#endregion
+export { LimitError };

package/dist/lib/MultipartFileTooLargeError.d.ts

@@ -0,0 +1,9 @@
+//#region src/lib/MultipartFileTooLargeError.d.ts
+declare class MultipartFileTooLargeError extends Error {
+  status: number;
+  fields: Record<string, any>;
+  filename: string;
+  constructor(message: string, fields: Record<string, any>, filename: string);
+}
+//#endregion
+export { MultipartFileTooLargeError };

package/dist/lib/MultipartFileTooLargeError.js

@@ -0,0 +1,17 @@
+//#region src/lib/MultipartFileTooLargeError.ts
+var MultipartFileTooLargeError = class extends Error {
+	status;
+	fields;
+	filename;
+	constructor(message, fields, filename) {
+		super(message);
+		this.name = this.constructor.name;
+		this.status = 413;
+		this.fields = fields;
+		this.filename = filename;
+		Error.captureStackTrace(this, this.constructor);
+	}
+};
+
+//#endregion
+export { MultipartFileTooLargeError };

package/dist/lib/utils.d.ts

@@ -0,0 +1,8 @@
+import { MultipartConfig } from "../config/config.default.js";
+
+//#region src/lib/utils.d.ts
+declare const whitelist: string[];
+declare function humanizeBytes(size: number | string): number;
+declare function normalizeOptions(options: MultipartConfig): MultipartConfig;
+//#endregion
+export { humanizeBytes, normalizeOptions, whitelist };

package/dist/lib/utils.js

@@ -0,0 +1,71 @@
+import path from "node:path";
+import assert from "node:assert";
+import bytes from "bytes";
+
+//#region src/lib/utils.ts
+const whitelist = [
+	".jpg",
+	".jpeg",
+	".png",
+	".gif",
+	".bmp",
+	".wbmp",
+	".webp",
+	".tif",
+	".psd",
+	".svg",
+	".js",
+	".jsx",
+	".json",
+	".css",
+	".less",
+	".html",
+	".htm",
+	".xml",
+	".zip",
+	".gz",
+	".tgz",
+	".gzip",
+	".mp3",
+	".mp4",
+	".avi"
+];
+function humanizeBytes(size) {
+	if (typeof size === "number") return size;
+	return bytes(size);
+}
+function normalizeOptions(options) {
+	options.fileSize = humanizeBytes(options.fileSize);
+	options.fieldSize = humanizeBytes(options.fieldSize);
+	options.fieldNameSize = humanizeBytes(options.fieldNameSize);
+	options.mode = options.mode || "stream";
+	assert(["stream", "file"].includes(options.mode), `Expect mode to be 'stream' or 'file', but got '${options.mode}'`);
+	if (options.mode === "file") assert(!options.fileModeMatch, "`fileModeMatch` options only work on stream mode, please remove it");
+	if (Array.isArray(options.whitelist)) options.whitelist = options.whitelist.map((extname) => extname.toLowerCase());
+	if (Array.isArray(options.fileExtensions)) options.fileExtensions = options.fileExtensions.map((extname) => {
+		return extname.startsWith(".") || extname === "" ? extname.toLowerCase() : `.${extname.toLowerCase()}`;
+	});
+	function checkExt(fileName) {
+		if (typeof options.whitelist === "function") return options.whitelist(fileName);
+		const extname = path.extname(fileName).toLowerCase();
+		if (Array.isArray(options.whitelist)) return options.whitelist.includes(extname);
+		return whitelist.includes(extname) || options.fileExtensions.includes(extname);
+	}
+	options.checkFile = (_fieldName, fileStream, fileName) => {
+		if (!fileStream || !fileName) return;
+		try {
+			if (!checkExt(fileName)) {
+				const err = /* @__PURE__ */ new Error("Invalid filename: " + fileName);
+				Reflect.set(err, "status", 400);
+				return err;
+			}
+		} catch (err) {
+			err.status = 400;
+			return err;
+		}
+	};
+	return options;
+}
+
+//#endregion
+export { humanizeBytes, normalizeOptions, whitelist };

package/dist/types.d.ts

@@ -0,0 +1,24 @@
+import { EggFile, MultipartFileStream, MultipartOptions } from "./app/extend/context.js";
+import { MultipartConfig } from "./config/config.default.js";
+
+//#region src/types.d.ts
+declare module 'egg' {
+  interface EggAppConfig {
+    /**
+     * multipart parser options
+     * @member Config#multipart
+     */
+    multipart: MultipartConfig;
+  }
+  interface Request {
+    /**
+     * Files Object Array
+     */
+    files?: EggFile[];
+  }
+  interface Context {
+    saveRequestFiles(options?: MultipartOptions): Promise<void>;
+    getFileStream(options?: MultipartOptions): Promise<MultipartFileStream>;
+    cleanupRequestFiles(files?: EggFile[]): Promise<void>;
+  }
+}

package/dist/types.js

@@ -0,0 +1 @@
+export {  };

package/package.json

@@ -1,24 +1,12 @@
 {
   "name": "@eggjs/multipart",
-  "version": "4.0.0",
-  "publishConfig": {
-    "access": "public"
-  },
+  "version": "5.0.0-beta.17",
+  "description": "multipart plugin for egg",
   "eggPlugin": {
     "name": "multipart",
     "optionalDependencies": [
       "schedule"
-    ],
-    "exports": {
-      "import": "./dist/esm",
-      "require": "./dist/commonjs",
-      "typescript": "./src"
-    }
-  },
-  "description": "multipart plugin for egg",
-  "repository": {
-    "type": "git",
-    "url": "git+https://github.com/eggjs/multipart.git"
+    ]
   },
   "keywords": [
     "egg",
@@ -26,78 +14,71 @@
     "eggPlugin",
     "multipart"
   ],
-  "author": "gxcsoccer <gxcsoccer@126.com>",
-  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "git://github.com/eggjs/egg.git",
+    "directory": "plugins/multipart"
+  },
   "bugs": {
     "url": "https://github.com/eggjs/egg/issues"
   },
-  "homepage": "https://github.com/eggjs/multipart#readme",
+  "homepage": "https://github.com/eggjs/egg/tree/next/plugins/multipart#readme",
+  "author": "gxcsoccer <gxcsoccer@126.com>",
+  "license": "MIT",
   "engines": {
-    "node": ">= 18.19.0"
+    "node": ">= 22.18.0"
+  },
+  "type": "module",
+  "exports": {
+    ".": "./dist/index.js",
+    "./app": "./dist/app.js",
+    "./app/extend/context": "./dist/app/extend/context.js",
+    "./app/middleware/multipart": "./dist/app/middleware/multipart.js",
+    "./app/schedule/clean_tmpdir": "./dist/app/schedule/clean_tmpdir.js",
+    "./config/config.default": "./dist/config/config.default.js",
+    "./lib/LimitError": "./dist/lib/LimitError.js",
+    "./lib/MultipartFileTooLargeError": "./dist/lib/MultipartFileTooLargeError.js",
+    "./lib/utils": "./dist/lib/utils.js",
+    "./types": "./dist/types.js",
+    "./package.json": "./package.json"
+  },
+  "publishConfig": {
+    "access": "public"
   },
   "dependencies": {
-    "@eggjs/core": "^6.3.1",
     "bytes": "^3.1.2",
     "co-busboy": "^2.0.1",
-    "dayjs": "^1.11.5",
-    "egg-path-matching": "^2.1.0"
+    "dayjs": "^1.11.13",
+    "egg-path-matching": "^2.0.0"
+  },
+  "peerDependencies": {
+    "egg": "4.1.0-beta.17"
   },
   "devDependencies": {
-    "@arethetypeswrong/cli": "^0.17.1",
-    "@eggjs/bin": "7",
-    "@eggjs/mock": "^6.0.5",
-    "@eggjs/tsconfig": "1",
     "@types/bytes": "^3.1.5",
-    "@types/mocha": "10",
-    "@types/node": "22",
-    "egg": "^4.0.6",
-    "eslint": "8",
-    "eslint-config-egg": "14",
+    "@types/node": "24.5.2",
     "formstream": "^1.5.1",
-    "is-type-of": "2",
-    "path-to-regexp-v8": "npm:path-to-regexp@8",
-    "rimraf": "6",
+    "is-type-of": "^2.2.0",
     "stream-wormhole": "^2.0.1",
-    "tshy": "3",
-    "tshy-after": "1",
-    "typescript": "5",
-    "urllib": "4"
-  },
-  "scripts": {
-    "lint": "eslint --cache src test --ext .ts",
-    "pretest": "npm run clean && npm run lint -- --fix",
-    "test": "egg-bin test",
-    "preci": "npm run clean &&  npm run lint",
-    "ci": "egg-bin cov",
-    "postci": "npm run prepublishOnly && npm run clean",
-    "clean": "rimraf dist",
-    "prepublishOnly": "tshy && tshy-after && attw --pack"
-  },
-  "type": "module",
-  "tshy": {
-    "exports": {
-      ".": "./src/index.ts",
-      "./package.json": "./package.json"
-    }
-  },
-  "exports": {
-    ".": {
-      "import": {
-        "types": "./dist/esm/index.d.ts",
-        "default": "./dist/esm/index.js"
-      },
-      "require": {
-        "types": "./dist/commonjs/index.d.ts",
-        "default": "./dist/commonjs/index.js"
-      }
-    },
-    "./package.json": "./package.json"
+    "tsdown": "^0.15.4",
+    "typescript": "5.9.2",
+    "urllib": "^4.8.2",
+    "vitest": "4.0.0-beta.13",
+    "@eggjs/mock": "7.0.0-beta.17",
+    "@eggjs/tsconfig": "3.1.0-beta.17",
+    "@eggjs/schedule": "6.0.0-beta.17"
   },
   "files": [
-    "dist",
-    "src"
+    "dist"
   ],
-  "types": "./dist/commonjs/index.d.ts",
-  "main": "./dist/commonjs/index.js",
-  "module": "./dist/esm/index.js"
-}
+  "main": "./dist/index.js",
+  "module": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "scripts": {
+    "build": "tsdown",
+    "typecheck": "tsc --noEmit",
+    "lint": "oxlint --type-aware",
+    "lint:fix": "npm run lint -- --fix",
+    "test": "npm run lint:fix && vitest"
+  }
+}

package/dist/commonjs/app/extend/context.d.ts

@@ -1,110 +0,0 @@
-import { Readable } from 'node:stream';
-import { Context } from '@eggjs/core';
-export interface EggFile {
-    field: string;
-    filename: string;
-    encoding: string;
-    mime: string;
-    filepath: string;
-}
-export interface MultipartFileStream extends Readable {
-    fields: Record<string, any>;
-    filename: string;
-    fieldname: string;
-    mime: string;
-    mimeType: string;
-    transferEncoding: string;
-    encoding: string;
-    truncated: boolean;
-}
-export interface MultipartOptions {
-    autoFields?: boolean;
-    /**
-     * required file submit, default is true
-     */
-    requireFile?: boolean;
-    /**
-     * default charset encoding
-     */
-    defaultCharset?: string;
-    /**
-     * compatible with defaultCharset
-     * @deprecated use `defaultCharset` instead
-     */
-    defCharset?: string;
-    defaultParamCharset?: string;
-    /**
-     * compatible with defaultParamCharset
-     * @deprecated use `defaultParamCharset` instead
-     */
-    defParamCharset?: string;
-    limits?: {
-        fieldNameSize?: number;
-        fieldSize?: number;
-        fields?: number;
-        fileSize?: number;
-        files?: number;
-        parts?: number;
-        headerPairs?: number;
-    };
-    checkFile?(fieldname: string, file: any, filename: string, encoding: string, mimetype: string): void | Error;
-}
-export default class MultipartContext extends Context {
-    /**
-     * create multipart.parts instance, to get separated files.
-     * @function Context#multipart
-     * @param {Object} [options] - override default multipart configurations
-     *  - {Boolean} options.autoFields
-     *  - {String} options.defaultCharset
-     *  - {String} options.defaultParamCharset
-     *  - {Object} options.limits
-     *  - {Function} options.checkFile
-     * @return {Yieldable | AsyncIterable<Yieldable>} parts
-     */
-    multipart(options?: MultipartOptions): AsyncIterable<MultipartFileStream>;
-    /**
-     * save request multipart data and files to `ctx.request`
-     * @function Context#saveRequestFiles
-     * @param {Object} options - { limits, checkFile, ... }
-     */
-    saveRequestFiles(options?: MultipartOptions): Promise<void>;
-    /**
-     * get upload file stream
-     * @example
-     * ```js
-     * const stream = await ctx.getFileStream();
-     * // get other fields
-     * console.log(stream.fields);
-     * ```
-     * @function Context#getFileStream
-     * @param {Object} options
-     *  - {Boolean} options.requireFile - required file submit, default is true
-     *  - {String} options.defaultCharset
-     *  - {String} options.defaultParamCharset
-     *  - {Object} options.limits
-     *  - {Function} options.checkFile
-     * @return {ReadStream} stream
-     * @since 1.0.0
-     * @deprecated Not safe enough, use `ctx.multipart()` instead
-     */
-    getFileStream(options?: MultipartOptions): Promise<MultipartFileStream>;
-    /**
-     * clean up request tmp files helper
-     * @function Context#cleanupRequestFiles
-     * @param {Array<String>} [files] - file paths need to cleanup, default is `ctx.request.files`.
-     */
-    cleanupRequestFiles(files?: EggFile[]): Promise<void>;
-}
-declare module '@eggjs/core' {
-    interface Request {
-        /**
-         * Files Object Array
-         */
-        files?: EggFile[];
-    }
-    interface Context {
-        saveRequestFiles(options?: MultipartOptions): Promise<void>;
-        getFileStream(options?: MultipartOptions): Promise<MultipartFileStream>;
-        cleanupRequestFiles(files?: EggFile[]): Promise<void>;
-    }
-}