@eggjs/multipart 5.0.0-beta.20 → 5.0.0-beta.21

package/dist/context-CLeGGj9o.js

@@ -1,199 +0,0 @@
-import { humanizeBytes } from "./utils-BwL2JNe7.js";
-import { LimitError } from "./LimitError-BZqeZJ5w.js";
-import { MultipartFileTooLargeError } from "./MultipartFileTooLargeError-CFG577Bz.js";
-import path from "node:path";
-import assert from "node:assert";
-import { randomUUID } from "node:crypto";
-import fs from "node:fs/promises";
-import { createWriteStream } from "node:fs";
-import { PassThrough, Readable } from "node:stream";
-import { pipeline } from "node:stream/promises";
-import parse from "co-busboy";
-import dayjs from "dayjs";
-import { Context } from "egg";
-
-//#region src/app/extend/context.ts
-const HAS_CONSUMED = Symbol("Context#multipartHasConsumed");
-var MultipartContext = class 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 = {}) {
-		const ctx = this;
-		if (!ctx.is("multipart")) ctx.throw(400, "Content-Type must be multipart/*");
-		assert(!ctx[HAS_CONSUMED], "the multipart request can't be consumed twice");
-		ctx[HAS_CONSUMED] = true;
-		const { autoFields, defaultCharset, defaultParamCharset, checkFile } = ctx.app.config.multipart;
-		const { fieldNameSize, fieldSize, fields, fileSize, files } = ctx.app.config.multipart;
-		options = extractOptions(options);
-		const parseOptions = Object.assign({
-			autoFields,
-			defCharset: defaultCharset,
-			defParamCharset: defaultParamCharset,
-			checkFile
-		}, options);
-		parseOptions.limits = Object.assign({
-			fieldNameSize,
-			fieldSize,
-			fields,
-			fileSize,
-			files
-		}, options.limits);
-		const parts = parse(this, parseOptions);
-		parts[Symbol.asyncIterator] = async function* () {
-			let part;
-			do {
-				part = await parts();
-				if (!part) continue;
-				if (Array.isArray(part)) {
-					if (part[3]) throw new LimitError("Request_fieldSize_limit", "Reach fieldSize limit");
-				} else {
-					if (!part.filename) {
-						ctx.coreLogger.debug("[egg-multipart] file field `%s` is upload without file stream, will drop it.", part.fieldname);
-						await pipeline(part, new PassThrough());
-						continue;
-					}
-					if (part.truncated) throw new LimitError("Request_fileSize_limit", "Reach fileSize limit");
-					else part.once("limit", function() {
-						this.emit("error", new LimitError("Request_fileSize_limit", "Reach fileSize limit"));
-						this.resume();
-					});
-				}
-				yield part;
-			} while (part !== void 0);
-		};
-		return parts;
-	}
-	/**
-	* save request multipart data and files to `ctx.request`
-	* @function Context#saveRequestFiles
-	* @param {Object} options - { limits, checkFile, ... }
-	*/
-	async saveRequestFiles(options = {}) {
-		const ctx = this;
-		const allowArrayField = ctx.app.config.multipart.allowArrayField;
-		let storeDir;
-		const requestBody = {};
-		const requestFiles = [];
-		options.autoFields = false;
-		const parts = ctx.multipart(options);
-		try {
-			for await (const part of parts) if (Array.isArray(part)) {
-				const [fieldName, fieldValue] = part;
-				if (!allowArrayField) requestBody[fieldName] = fieldValue;
-				else if (!requestBody[fieldName]) requestBody[fieldName] = fieldValue;
-				else if (!Array.isArray(requestBody[fieldName])) requestBody[fieldName] = [requestBody[fieldName], fieldValue];
-				else requestBody[fieldName].push(fieldValue);
-			} else {
-				const { filename, fieldname, encoding, mime } = part;
-				if (!storeDir) {
-					storeDir = path.join(ctx.app.config.multipart.tmpdir, dayjs().format("YYYY/MM/DD/HH"));
-					await fs.mkdir(storeDir, { recursive: true });
-				}
-				const filepath = path.join(storeDir, randomUUID() + path.extname(filename));
-				const target = createWriteStream(filepath);
-				await pipeline(part, target);
-				const meta = {
-					filepath,
-					field: fieldname,
-					filename,
-					encoding,
-					mime,
-					fieldname,
-					transferEncoding: encoding,
-					mimeType: mime
-				};
-				requestFiles.push(meta);
-			}
-		} catch (err) {
-			await ctx.cleanupRequestFiles(requestFiles);
-			throw err;
-		}
-		ctx.request.body = requestBody;
-		ctx.request.files = requestFiles;
-	}
-	/**
-	* 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
-	*/
-	async getFileStream(options = {}) {
-		options.autoFields = true;
-		const parts = this.multipart(options);
-		let stream = await parts();
-		if (options.requireFile !== false) {
-			if (!stream || !stream.filename) this.throw(400, "Can't found upload file");
-		}
-		if (!stream) stream = Readable.from([]);
-		if (stream.truncated) throw new LimitError("Request_fileSize_limit", "Request file too large, please check multipart config");
-		stream.fields = parts.field;
-		stream.once("limit", () => {
-			const err = new MultipartFileTooLargeError("Request file too large, please check multipart config", stream.fields, stream.filename);
-			if (stream.listenerCount("error") > 0) {
-				stream.emit("error", err);
-				this.coreLogger.warn(err);
-			} else {
-				this.coreLogger.error(err);
-				stream.on("error", () => {});
-			}
-			stream.resume();
-		});
-		return stream;
-	}
-	/**
-	* clean up request tmp files helper
-	* @function Context#cleanupRequestFiles
-	* @param {Array<String>} [files] - file paths need to cleanup, default is `ctx.request.files`.
-	*/
-	async cleanupRequestFiles(files) {
-		if (!files || !files.length) files = this.request.files;
-		if (Array.isArray(files)) for (const file of files) try {
-			await fs.rm(file.filepath, {
-				force: true,
-				recursive: true
-			});
-		} catch (err) {
-			this.coreLogger.warn("[egg-multipart-cleanupRequestFiles-error] file: %j, error: %s", file, err);
-		}
-	}
-};
-function extractOptions(options = {}) {
-	const opts = {};
-	if (typeof options.autoFields === "boolean") opts.autoFields = options.autoFields;
-	if (options.limits) opts.limits = options.limits;
-	if (options.checkFile) opts.checkFile = options.checkFile;
-	if (options.defCharset) opts.defCharset = options.defCharset;
-	if (options.defParamCharset) opts.defParamCharset = options.defParamCharset;
-	if (options.defaultCharset) opts.defCharset = options.defaultCharset;
-	if (options.defaultParamCharset) opts.defParamCharset = options.defaultParamCharset;
-	if (options.limits) {
-		const limits = opts.limits = { ...options.limits };
-		for (const key in limits) if (key.endsWith("Size") && limits[key]) limits[key] = humanizeBytes(limits[key]);
-	}
-	return opts;
-}
-
-//#endregion
-export { MultipartContext };

package/dist/context-COfddVcC.d.ts

@@ -1,101 +0,0 @@
-import { Readable } from "node:stream";
-import { Context } from "egg";
-
-//#region src/app/extend/context.d.ts
-interface EggFile {
-  field: string;
-  filename: string;
-  encoding: string;
-  mime: string;
-  filepath: string;
-}
-interface MultipartFileStream extends Readable {
-  fields: Record<string, any>;
-  filename: string;
-  fieldname: string;
-  mime: string;
-  mimeType: string;
-  transferEncoding: string;
-  encoding: string;
-  truncated: boolean;
-}
-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;
-}
-declare 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>;
-}
-//#endregion
-export { EggFile, MultipartContext, MultipartFileStream, MultipartOptions };

package/dist/types-BsuPrIpu.js

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

package/dist/types-DNLuS6JZ.d.ts

@@ -1,24 +0,0 @@
-import { EggFile, MultipartFileStream, MultipartOptions } from "./context-COfddVcC.js";
-import { MultipartConfig } from "./config.default-CPo4ogXL.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/utils-BwL2JNe7.js

@@ -1,71 +0,0 @@
-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 };