feat: allow to set mimeType on field data (#25)

fengmk2 · web-flow · commit f3338f8accef · 2024-05-15T00:39:10.000+08:00
use on alipay openapi upload file see https://opendocs.alipay.com/open-v3/054oog#%E6%96%87%E4%BB%B6%E4%B8%8A%E4%BC%A0  ## Summary by CodeRabbit - **New Features** - Introduced `isFormStream` property in `FormStream` for enhanced data handling. - Updated `FormStream` field method to accept an additional `mimeType` parameter. - Added new script for contributors in `package.json`. - **Bug Fixes** - Updated Node.js CI and release workflows to use the latest configurations from a different repository. - **Documentation** - Updated `README.md` to remove outdated badges and add new contributor information. - Added a note about the project following the git-contributor spec. - **Tests** - Enhanced form stream tests to include new JSON data field validation. - **Chores** - Added `git-contributor` dependency for automated contributor updates.
diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml
@@ -3,16 +3,13 @@ name: CI
 on:
   push:
     branches: [ master ]
-
   pull_request:
     branches: [ master ]
 
-  workflow_dispatch: {}
-
 jobs:
   Job:
     name: Node.js
-    uses: artusjs/github-actions/.github/workflows/node-test.yml@v1
+    uses: node-modules/github-actions/.github/workflows/node-test.yml@master
     with:
       os: 'ubuntu-latest, macos-latest'
-      version: '14, 16, 18, 20'
+      version: '14, 16, 18, 20, 22'
diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml
@@ -4,14 +4,10 @@ on:
   push:
     branches: [ master ]
 
-  workflow_dispatch: {}
-
 jobs:
   release:
     name: Node.js
-    uses: artusjs/github-actions/.github/workflows/node-release.yml@v1
+    uses: node-modules/github-actions/.github/workflows/node-release.yml@master
     secrets:
       NPM_TOKEN: ${{ secrets.NPM_TOKEN }}
       GIT_TOKEN: ${{ secrets.GIT_TOKEN }}
-    with:
-      checkTest: false
diff --git a/AUTHORS b/AUTHORS
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -20,3 +20,89 @@
 ### Features
 
 * Porting from new Buffer() to Buffer.from() ([#22](https://github.com/node-modules/formstream/issues/22)) ([f268e86](https://github.com/node-modules/formstream/commit/f268e86e6b55d5b981bb7daf9c8662bdcd820f5c))
+
+---
+
+
+1.2.0 / 2023-03-17
+==================
+
+**features**
+  * [[`f268e86`](http://github.com/node-modules/formstream/commit/f268e86e6b55d5b981bb7daf9c8662bdcd820f5c)] - feat: Porting from new Buffer() to Buffer.from() (#22) (Matthew Speiser <<mattrspeiser@gmail.com>>)
+
+**others**
+  * [[`3c09f70`](http://github.com/node-modules/formstream/commit/3c09f700b2440b8f391650c939d91c2d5e4ae9b3)] - test: run on github action (#21) (fengmk2 <<fengmk2@gmail.com>>)
+  * [[`2d5ed81`](http://github.com/node-modules/formstream/commit/2d5ed81e95b4fde270b5db2720fff0e19effd2dc)] - test: run test on node 12, 14, 16 (#20) (fengmk2 <<fengmk2@gmail.com>>)
+
+1.1.1 / 2021-04-28
+==================
+
+**fixes**
+  * [[`c96ba5b`](http://github.com/node-modules/formstream/commit/c96ba5bace0e96bf39770769e43d9de4271971d8)] - fix: upgrade mime to fix wrong mime type (#19) (shaozj <<shaozj@users.noreply.github.com>>)
+
+**others**
+  * [[`21918e5`](http://github.com/node-modules/formstream/commit/21918e5fc37a4cea5aae82659d39587f099e805b)] - chore: upgrade devDeps express to latest version (#15) (fengmk2 <<fengmk2@gmail.com>>)
+
+1.1.0 / 2016-12-19
+==================
+
+  * deps: upgrade mime to latest version (#9)
+
+1.0.0 / 2014-11-04
+==================
+
+ * fix(field): support stream.field(String, Number)
+ * chore: fix links
+ * chore: use npm scripts instead of Makefile
+ * fix test case on node@0.8
+
+0.0.8 / 2014-01-17 
+==================
+
+  * destroy source stream when formstream destroy()
+  * add more test cases
+
+0.0.7 / 2013-07-25 
+==================
+
+  * feature: always try to infer `Content-Length` (@xingrz)
+  * doc improve
+
+0.0.6 / 2013-07-15 
+==================
+
+  * added test cases for chaining call (@xingrz)
+  * improved docs (@xingrz)
+  * added chaining support (@xingrz)
+  * api doc
+  * fixed test causes
+  * update dependencies version
+
+0.0.5 / 2012-11-06 
+==================
+
+  * fixed stream error not catch bug
+
+0.0.4 / 2012-11-06 
+==================
+
+  * fixed #2 support form.buffer()
+  * add doc for setTotalStreamSize()
+
+0.0.3 / 2012-11-06 
+==================
+
+  * support content-length use form.setTotalStreamSize(size)
+  * update readme
+
+0.0.2 / 2012-10-11 
+==================
+
+  * use buffer-concat support node < 0.8
+
+0.0.1 / 2012-10-11 
+==================
+
+  * support multi streams.
+  * add one stream support now.
+  * Initial commit
diff --git a/History.md b/History.md
diff --git a/README.md b/README.md
@@ -1,13 +1,10 @@
 # formstream
 
 [![NPM version][npm-image]][npm-url]
-[![Test coverage][coveralls-image]][coveralls-url]
 [![npm download][download-image]][download-url]
 
 [npm-image]: https://img.shields.io/npm/v/formstream.svg?style=flat-square
 [npm-url]: https://npmjs.org/package/formstream
-[coveralls-image]: https://img.shields.io/coveralls/node-modules/formstream.svg?style=flat-square
-[coveralls-url]: https://coveralls.io/r/node-modules/formstream?branch=master
 [download-image]: https://img.shields.io/npm/dm/formstream.svg?style=flat-square
 [download-url]: https://npmjs.org/package/formstream
 
@@ -178,7 +175,7 @@ See [Node.js Documentation](http://nodejs.org/api/stream.html#stream_event_end)
 
 (The MIT License)
 
-Copyright (c) 2012 - 2014 fengmk2 &lt;fengmk2@gmail.com&gt;
+Copyright (c) 2012 - 2014 fengmk2 <fengmk2@gmail.com>
 Copyright(c) node-modules and other contributors.
 
 Permission is hereby granted, free of charge, to any person obtaining
@@ -199,3 +196,14 @@ IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
 CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
 TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
 SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+<!-- GITCONTRIBUTOR_START -->
+
+## Contributors
+
+|[<img src="https://avatars.githubusercontent.com/u/156269?v=4" width="100px;"/><br/><sub><b>fengmk2</b></sub>](https://github.com/fengmk2)<br/>|[<img src="https://avatars.githubusercontent.com/u/288288?v=4" width="100px;"/><br/><sub><b>xingrz</b></sub>](https://github.com/xingrz)<br/>|[<img src="https://avatars.githubusercontent.com/u/32174276?v=4" width="100px;"/><br/><sub><b>semantic-release-bot</b></sub>](https://github.com/semantic-release-bot)<br/>|[<img src="https://avatars.githubusercontent.com/u/13151189?v=4" width="100px;"/><br/><sub><b>fjc0k</b></sub>](https://github.com/fjc0k)<br/>|[<img src="https://avatars.githubusercontent.com/u/18096247?v=4" width="100px;"/><br/><sub><b>mrspeiser</b></sub>](https://github.com/mrspeiser)<br/>|[<img src="https://avatars.githubusercontent.com/u/985607?v=4" width="100px;"/><br/><sub><b>dead-horse</b></sub>](https://github.com/dead-horse)<br/>|
+| :---: | :---: | :---: | :---: | :---: | :---: |
+[<img src="https://avatars.githubusercontent.com/u/7326406?v=4" width="100px;"/><br/><sub><b>shaozj</b></sub>](https://github.com/shaozj)<br/>
+
+This project follows the git-contributor [spec](https://github.com/xudafeng/git-contributor), auto updated at `Wed May 15 2024 00:34:12 GMT+0800`.
+
+<!-- GITCONTRIBUTOR_END -->
diff --git a/lib/formstream.js b/lib/formstream.js
@@ -1,12 +1,17 @@
 /**
- * Data format:
+ * Form Data format:
  *
 
 --FormStreamBoundary1349886663601\r\n
 Content-Disposition: form-data; name="foo"\r\n
 \r\n
 <FIELD-CONTENT>\r\n
 --FormStreamBoundary1349886663601\r\n
+Content-Disposition: form-data; name="data"\r\n
+Content-Type: application/json\r\n
+\r\n
+<JSON-FORMAT-CONTENT>\r\n
+--FormStreamBoundary1349886663601\r\n
 Content-Disposition: form-data; name="file"; filename="formstream.test.js"\r\n
 Content-Type: application/javascript\r\n
 \r\n
@@ -49,6 +54,8 @@ function FormStream() {
   this._contentLength = 0;
   this._isAllStreamSizeKnown = true;
   this._knownStreamSize = 0;
+
+  this.isFormStream = true;
 }
 
 util.inherits(FormStream, Stream);
@@ -128,9 +135,10 @@ FormStream.prototype.file = function (name, filepath, filename, filesize) {
  * Add a form field
  * @param  {String} name field name
  * @param  {String|Buffer} value field value
+ * @param  {String} [mimeType] field mimeType
  * @return {this}
  */
-FormStream.prototype.field = function (name, value) {
+FormStream.prototype.field = function (name, value, mimeType) {
   if (!Buffer.isBuffer(value)) {
     // field(String, Number)
     // https://github.com/qiniu/nodejs-sdk/issues/123
@@ -139,7 +147,7 @@ FormStream.prototype.field = function (name, value) {
     }
     value = Buffer.from(value);
   }
-  return this.buffer(name, value);
+  return this.buffer(name, value, null, mimeType);
 };
 
 FormStream.prototype.stream = function (name, stream, filename, mimeType, size) {
diff --git a/package.json b/package.json
@@ -13,7 +13,8 @@
     "cov": "egg-bin cov",
     "ci": "npm run lint && npm run tsd && npm run cov",
     "lint": "jshint .",
-    "tsd": "tsd"
+    "tsd": "tsd",
+    "contributor": "git-contributor"
   },
   "repository": {
     "type": "git",
@@ -38,6 +39,7 @@
     "connect-multiparty": "1",
     "egg-bin": "^5.6.1",
     "express": "^4.16.4",
+    "git-contributor": "^2.1.5",
     "jshint": "^2.13.6",
     "pedding": "1",
     "should": "4",
diff --git a/test/formstream.test.js b/test/formstream.test.js
@@ -81,12 +81,14 @@ describe('formstream.test.js', function () {
     done = pedding(2, done);
     var form = formstream();
     form.field('foo', 'bar');
+    form.field('data', JSON.stringify({ foo: 'bar' }), 'application/json');
     form.field('name', '中文名字');
     form.field('pwd', '哈哈pwd');
     form.on('destroy', done);
     post(port, '/post', form, function (err, data) {
       should.not.exist(err);
       data.body.should.eql({
+        data: '{"foo":"bar"}',
         foo: 'bar',
         name: '中文名字',
         pwd: '哈哈pwd'
diff --git a/types/formstream.d.ts b/types/formstream.d.ts
@@ -7,7 +7,7 @@ declare class FormStream extends Stream {
    * @param name Name of field
    * @param value Value of field
    */
-  field(name: string, value: string): this
+  field(name: string, value: string, contentType?: string): this
 
   /**
    * Add a local file to be uploaded to the form.
diff --git a/types/formstream.test-d.ts b/types/formstream.test-d.ts
@@ -16,6 +16,7 @@ fs.field('id')
 // @ts-expect-error
 fs.field('id', 1)
 fs.field('id', '1')
+fs.field('data', '{"foo":"bar"}', 'application/json')
 
 // @ts-expect-error
 fs.file('avatar')
