@jnode/request 2.0.0 → 2.1.0

package/CONTRIBUTING.md

@@ -0,0 +1,13 @@
+# Contributing to JNode packages
+
+Hello there! Welcome to the contributing guildlines!
+
+I was a bit surprised to see you here, especially since we’re not as well-known right now, and our packages are quite straightforward, mainly designed for specific projects.
+
+If you’re here, perhaps you’ve spotted some bugs, security issues, or have an idea for something new. We’re happy to welcome any contributions!
+
+- **Bugs**: If you find any bugs, please let us know.
+- **Security Problems**: If a bug affects the package’s security, please reach out to JustApple via [email](mailto:ja@justapple.tw) or Discord!
+- **Docs and Tutorials**: This is the part I’m most excited about. The docs are mostly generated by Gemini, so they might not be perfectly clear. Feel free to update them while maintaining the Node.js official doc style.
+
+For new features, please always create an issue and wait for our response. Also, please remember to keep the package simple and free from third-party dependencies.

package/README.md

@@ -45,18 +45,23 @@ request('POST', 'https://example.com/', [
 - `url` [\<string\>](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#string_type) | [\<URL\>](https://nodejs.org/docs/latest/api/url.html#the-whatwg-url-api) The target URL to request, support both `http` and `https`.
 - `body` [\<string\>](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#string_type) | [\<Buffer\>](https://nodejs.org/docs/latest/api/buffer.html#class-buffer) | [\<Uint8Array\>](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Uint8Array) | [\<stream.Readable\>](https://nodejs.org/docs/latest/api/stream.html#class-streamreadable) | [\<URLSearchParams\>](https://nodejs.org/docs/latest/api/url.html#class-urlsearchparams) | [\<request.FormPart[]\>](#class-requestformpart) | [\<Object[]\>](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object) The request body. Using [\<URLSearchParams\>](https://nodejs.org/docs/latest/api/url.html#class-urlsearchparams) will send a `application/x-www-form-urlencoded` request; using [\<request.FormPart[]\>](#class-requestformpart) or  [\<Object[]\>](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object) will send a `multipart/form-body` request.
 - `headers` [\<Object\>](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object) An object containing request headers. `Content-Length` is automatically calculated for [\<string\>](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#string_type), [\<Buffer\>](https://nodejs.org/docs/latest/api/buffer.html#class-buffer), [\<Uint8Array\>](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Uint8Array), or [\<URLSearchParams\>](https://nodejs.org/docs/latest/api/url.html#class-urlsearchparams) body. And `Content-Type` will be force replaced while sending a `multipart/form-body` request with  [\<FormPart[]\>](#class-requestformpart) or [\<Object[]\>](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object) body.
-- `options` [\<Object\>](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object) `options` in [`http.request()`](https://nodejs.org/docs/latest/api/http.html#httprequestoptions-callback).
+- `options` [\<Object\>](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)
+  - `multipart` [\<string\>](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#string_type) Multipart type. **Default**: `'form-body'`.
+  - `options` in [`http.request()`](https://nodejs.org/docs/latest/api/http.html#httprequestoptions-callback).
 - Returns: [\<request.RequestResponse\>](#class-requestrequestresponse)
 
 Make a HTTP(S) request.
 
 ## Class: `request.FormPart`
 
-### `new request.FormPart(name, body[, headers])`
+### `new request.FormPart(name, body[, headers, options])`
 
 - `name` [\<string\>](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#string_type) Name of the part.
 - `body` [\<string\>](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#string_type) | [\<Buffer\>](https://nodejs.org/docs/latest/api/buffer.html#class-buffer) | [\<Uint8Array\>](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Uint8Array) | [\<stream.Readable\>](https://nodejs.org/docs/latest/api/stream.html#class-streamreadable) | [\<URLSearchParams\>](https://nodejs.org/docs/latest/api/url.html#class-urlsearchparams) The body of the part. Using [\<URLSearchParams\>](https://nodejs.org/docs/latest/api/url.html#class-urlsearchparams) will create a `application/x-www-form-urlencoded` part.
 - `headers` [\<Object\>](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object) An object containing part headers. There is a special `filename` field, will be added to `Content-Disposition`.
+- `options` [\<Object\>](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)
+  - `filename` [\<string\>](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#string_type) File name.
+  - `disposition` [\<string\>](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#string_type) Part disposition. **Default**: `'form-data'`.
 
 ## Class: `request.RequestResponse`
 
@@ -84,7 +89,7 @@ The response HTTP headers.
 
 - Type: [\<Buffer\>](https://nodejs.org/docs/latest/api/buffer.html#class-buffer)
 
-> **Notice**: You should avoid reading this property directly, use [`requestRespond.buffer()`](#requestrespondbuffer) instead.
+> **Notice**: You should avoid reading this property directly, use [`requestRespond.buffer()`](#requestresponsebuffer) instead.
 
 ### `requestResponse.buffer()`
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@jnode/request",
-  "version": "2.0.0",
+  "version": "2.1.0",
   "description": "Simple HTTP(s) requesting package for Node.js.",
   "main": "src/index.js",
   "scripts": {

package/src/index.js

@@ -30,7 +30,7 @@ function request(method = 'GET', url = '', body, headers = {}, options = {}) {
 		});
 
 		// write headers and body
-		if (typeof body === 'string' || Buffer.isBuffer(body) || body instanceof Uint8Array) { // static body
+		if (typeof body === 'string' || body instanceof Uint8Array) { // static body
 			req.setHeader('Content-Length', Buffer.byteLength(body));
 			req.end(body);
 		} else if (body instanceof stream.Readable) { // stream
@@ -38,7 +38,7 @@ function request(method = 'GET', url = '', body, headers = {}, options = {}) {
 		} else if (Array.isArray(body)) { // multipart/form-body
 			// generate boundary
 			const boundary = `----WebKitFormBoundary${Date.now().toString(16)}${crypto.randomUUID()}`;
-			req.setHeader('Content-Type', `multipart/form-data; boundary=${boundary}`);
+			req.setHeader('Content-Type', `multipart/${options.multipart || 'form-data'}; boundary=${boundary}`);
 
 			// write every parts
 			for (const part of body) {
@@ -48,12 +48,12 @@ function request(method = 'GET', url = '', body, headers = {}, options = {}) {
 				const partHeaders = part.headers || {};
 
 				// set Content-Disposition header
-				if (!partHeaders['Content-Disposition']) {
-					partHeaders['Content-Disposition'] = `form-data; name="${part.name}"${part.filename ? `; filename="${part.filename}"` : ''}`;
+				if (!req.getHeader('content-disposition') && (part.name || part.filename || part.disposition)) {
+					partHeaders['Content-Disposition'] = (part.disposition || 'form-data') + (part.name ? `; name="${part.name}"` : '') + (part.filename ? `; filename="${part.filename}"` : '');
 				}
 
 				// write headers and body
-				if (typeof part.body === 'string' || Buffer.isBuffer(part.body) || part.body instanceof Uint8Array) { // static body
+				if (typeof part.body === 'string' || part.body instanceof Uint8Array) { // static body
 					for (const [key, value] of Object.entries(partHeaders)) {
 						req.write(`${key}: ${value}\r\n`);
 					}
@@ -107,10 +107,12 @@ function request(method = 'GET', url = '', body, headers = {}, options = {}) {
 
 // form part
 class FormPart {
-	constructor(name = '', body, headers = {}) {
+	constructor(name = '', body, headers = {}, options = {}) {
 		this.name = name;
 		this.body = body;
 		this.headers = headers;
+		this.filename = options.filename;
+		this.disposition = options.disposition;
 	}
 }