chore(add): koa-better-body

packages/koa-better-body/.codeclimate.yml

@@ -0,0 +1,4 @@
+languages:
+  JavaScript: true
+exclude_paths:
+- "test/**.js"

packages/koa-better-body/.editorconfig

@@ -0,0 +1,12 @@
+root = true
+
+[*]
+indent_style = space
+indent_size = 2
+charset = utf-8
+trim_trailing_whitespace = true
+insert_final_newline = true
+
+[*.md]
+trim_trailing_whitespace = false
+insert_final_newline = false

packages/koa-better-body/.eslintrc.json

@@ -0,0 +1,29 @@
+{
+  "extends": "standard",
+  "rules": {
+    "generator-star-spacing": ["error", { "before": true, "after": true }],
+    "computed-property-spacing": ["error", "never"],
+    "object-curly-spacing": ["error", "always"],
+    "space-before-function-paren": ["error", "always"],
+    "arrow-parens": ["error", "always"],
+    "max-params": "error",
+    "max-nested-callbacks": [
+      "error",
+      {
+        "max": 5
+      }
+    ],
+    "max-depth": [
+      "error",
+      {
+        "max": 5
+      }
+    ],
+    "no-empty": [
+      "error",
+      {
+        "allowEmptyCatch": true
+      }
+    ]
+  }
+}

packages/koa-better-body/.gitignore

@@ -0,0 +1,73 @@
+# Always-ignore dirs #
+# ####################
+_gh_pages
+node_modules
+jspm_packages
+bower_components
+components
+vendor
+build
+dest
+dist
+src
+lib-cov
+coverage
+nbproject
+cache
+temp
+tmp
+koa-better-body
+
+# Packages #
+# ##########
+*.7z
+*.dmg
+*.gz
+*.iso
+*.jar
+*.rar
+*.tar
+*.zip
+
+# OS, Logs and databases #
+# #########################
+logs
+*.pid
+*.dat
+*.log
+*.sql
+*.sqlite
+*~
+~*
+
+# Another files #
+# ###############
+Icon?
+.DS_Store*
+Thumbs.db
+ehthumbs.db
+Desktop.ini
+npm-debug.log
+.directory
+._*
+lcov.info
+
+# Runtime data
+pids
+*.pid
+*.seed
+*.pid.lock
+
+
+# nyc test coverage
+.nyc_output
+
+# Grunt intermediate storage
+# see here: http://gruntjs.com/creating-plugins#storing-task-files
+.grunt
+
+# Optional npm cache directory
+.npm
+
+# Optional REPL history
+.node_repl_history

packages/koa-better-body/.travis.yml

@@ -0,0 +1,10 @@
+sudo: false
+language: node_js
+
+node_js:
+  - "node"
+  - "6"
+
+
+notifications:
+  email: false

packages/koa-better-body/.verb.md

@@ -0,0 +1,241 @@
+# [{%= name %}][author-www-url] [![npmjs.com][npmjs-img]][npmjs-url] [![The MIT License][license-img]][license-url] [![npm downloads][downloads-img]][downloads-url] 
+
+> {%= description %}
+
+[![code climate][codeclimate-img]][codeclimate-url] [![standard code style][standard-img]][standard-url] [![travis build status][travis-img]][travis-url] [![coverage status][coveralls-img]][coveralls-url] [![dependency status][david-img]][david-url]
+
+You might also be interested in our [recipes](./recipes) - working examples, answers, tips & tricks. [Contribute a recipe?](#contributing-recipes)
+
+## Install
+```
+npm i {%= name %} --save
+```
+
+## Features
+- Work for `koa@1` and `koa@2` (with deprecation messages), will also work in `koa@3` with [koa-convert][]
+- Totally flexible through `options` and absolutely lightweight using [lazy-cache][]
+- Accept few JSON types
+- Accept [JSON Patch [RFC6902]](https://tools.ietf.org/html/rfc6902) ([koajs/bodyparser#8](https://github.com/koajs/bodyparser/pull/8))
+- Accept [JSON API v1](http://jsonapi.org/) ([koajs/bodyparser#7](https://github.com/koajs/bodyparser/pull/7))
+- Accept [JSON csp-report](https://mathiasbynens.be/notes/csp-reports) ([#3](https://github.com/tunnckoCore/koa-better-body/issues/3))
+- Accept text and buffer bodies
+- Accept urlencoded and forms bodies
+- Accept multipart form data files and fields
+- Can parse correctly array data from forms - e.g. multiple fields to have same name - [dlau/koa-body#15](https://github.com/dlau/koa-body/pull/15)
+- Can parse correctly forms that accept multiple files - see [#26](https://github.com/tunnckoCore/koa-better-body/issues/26) and [dlau/koa-body#15](https://github.com/dlau/koa-body/pull/15)
+- Strict mode by default - see why on [IETF Message Semantics: Section 6.1](https://tools.ietf.org/html/draft-ietf-httpbis-p2-semantics-19#section-6.1)
+- Custom JSON request detect function - [koajs/bodyparser#f6a5ff](https://github.com/koajs/bodyparser/commit/f6a5ff7ef6162702540b101de5dde71ee5ad19cd)
+- Custom error handling function - [koajs/bodyparser#19418129](https://github.com/koajs/bodyparser/commit/194181298fe3bffce6b5fcf3cfebc35b8cda6c89)
+- Extending types of request that your app can accept - [koajs/bodyparser#ba7479b](https://github.com/koajs/bodyparser/commit/ba7479baf893fc3391fcdb88d3d8173ac4df05e7)
+- Using awesome [formidable][] package - [„battle-tested against hundreds of GB of file uploads“](https://github.com/felixge/node-formidable#current-status)
+- Passing a custom `formidable.IncomingForm` instance, allowing awesome customization
+- Passing all options to `formidable.IncomingForm`, allowing awesome control
+
+
+## Usage
+> For more use-cases see the [tests](./test.js)
+
+```js
+const {%= varname %} = require('{%= name %}')
+```
+
+## Working with [koa-router][]
+
+```js
+'use strict'
+
+var app = require('koa')()
+var body = require('{%= name %}')
+var router = require('koa-router')()
+
+router.post('/upload', body(), function * (next) {
+  console.log(this.request.files)
+  console.log(this.request.fields)
+
+  // there's no `.body` when `multipart`,
+  // `urlencoded` or `json` request
+  console.log(this.request.body)
+
+  // print it to the API requester
+  this.body = JSON.stringify({
+    fields: this.request.fields,
+    files: this.request.files,
+    body: this.request.body || null
+  }, null, 2)
+
+  yield next
+})
+
+app.use(router.routes())
+app.listen(4292)
+
+var format = require('util').format
+var host = 'http://localhost:4292'
+var cmd = 'curl -i %s/upload -F "source=@%s/.editorconfig"'
+
+console.log('Try it out with below CURL for `{%= name %}` repository.')
+console.log(format(cmd, host, __dirname))
+```
+
+{%= apidocs('index.js') %}
+
+## Options
+Sane defaults. :sparkles:
+
+Accepts JSON, [JSON API v1](http://jsonapi.org/), text, buffer, [csp-report](https://mathiasbynens.be/notes/csp-reports), multipart and urlencoded/form bodies. If you want to disallow accepting and parsing multipart body you should pass `multipart: false`. Most of the defaults you can see at [utils.defaultOptions and utils.defaultTypes](./utils.js). **All `options` are also been passed to [formidable][].IncomingForm!** Even you can pass IncomingForm instance to be able to handle the different formidable events.
+
+- `fields` **{Boolean|String}**: Default `false`, which means it will set fields on `this.request.fields`. If you pass a string, for example `'foo'`, you will have fields on `this.request.foo`.
+- `files` **{Boolean|String}**: Default `false`, which means it will set files on `this.request.files`. If you pass a string, for example `'bar'`, you will have files on `this.request.bar`.
+- `multipart` **{Boolean}**: Default `true`. If you pass `false` it won't accept/parse multipart bodies.
+- `textLimit` **{String}**: Default `'100kb'`. Passed to [bytes][].parse method.
+- `formLimit` **{String}**: Default `'100kb'`. Passed to [bytes][].parse method.
+- `urlencodedLimit` **{String}**: Default `'100kb'`. Alias of `opts.formLimit`.
+- `jsonLimit` **{String}**: Default `'100kb'`. Passed to [bytes][].parse method.
+- `bufferLimit` **{String}**: Default `'1mb'`. Passed to [bytes][].parse method.
+- `jsonStrict` **{Boolean}**: Default `true`. When set to true, JSON parser will only accept arrays and objects.
+- `detectJSON` **{Function}**: Custom JSON request detect function - `detectJSON(ctx)`.
+- `strict` **{Boolean}**: Default `true`. Pass `false` if you want to allow parsing GET, DELETE and HEAD requests.
+- `onerror` **{Function}**: Custom error handle, if throw an error, you can customize the response - `onerror(err, ctx)`.
+- `extendTypes` **{Object}**: Default accepting types can find on [utils.defaultTypes function](./utils.js#L83-L104). Allowing you to extend what your app can accept. By default works for JSON, [JSON API v1](http://jsonapi.org/), multipart, text, urlencoded and [csp-report](https://mathiasbynens.be/notes/csp-reports).
+- `IncomingForm` **{IncomingForm}**: Pass an instance of `formidable.IncomingForm` to be able to handle formidable events.
+- `handler` **{GeneratorFunction}**: Works with `options.extendTypes.custom` to handle custom types of content-type - `handler(ctx, options, next)`. More info below.
+- `querystring` **{Object}**: Querystring module to be used. By default builtin [`querystring`](https://nodejs.org/api/querystring.html). More info below.
+- `qs` **{Object}**: Alias of `opts.querystring`. All `opts` are also passed to [qs][] or [querystring module](https://nodejs.org/api/querystring.html).
+- `delimiter` **{String}**: Default is `&`. Delimiter of key/value pairs, passed to querystring lib
+- `sep` **{String}**: alias of `opts.delimiter`
+- `buffer` **{Boolean}**: Default `false`, pass `true` if you want to get body as buffer.
+
+## Note about `options.extendTypes`
+
+ExandTypes option gives you a flexible way to handle different content-types and modify the defaults which can be found [at utils.defaultTypes function](./utils.js#L83-L104). In addition you can pass combination of `options.extendTypes.custom` and `options.handler`. When the request has some of the "custom" content type, this middleware will call the `handler` **generator** function with `ctx, options, next`. You can see more at [issue #52](https://github.com/tunnckoCore/koa-better-body/issues/52).
+
+For example manually handle such content types `foo/bar-x`, `text/quix`:
+
+```js
+const app = require('koa')()
+const body = require('koa-better-body')
+
+app.use(body({
+  textLimit: '300kb'
+  extendTypes: {
+    custom: [
+      'foo/bar-x',
+      'text/quix'
+    ]
+  },
+  handler: function * (ctx, opts) {
+    // `ctx` is equal to `this` and `app`
+    // `opts` is current options object
+    // passed to `{%= name %}`
+    ctx.body = yield this.request.text(opts.textLimit)
+  }
+}))
+app.use(function * showBody () {
+  // `this.body` is text
+  console.log(this.body)
+})
+```
+
+
+## Note about advanced `querystring` parsing
+Because this middleware is fully based and integrated with [koa-body-parsers][], by default it uses Node's built-in module for that thing [querystring](https://nodejs.org/api/querystring.html). So if you have some issues with forms, think to add custom querystring module like [qs][] to `options.querystring` or `app.querystring`. Related to this is [issue #45](https://github.com/tunnckoCore/koa-better-body/issues/45).
+
+**Example**
+
+```js
+const app = require('koa')()
+const body = require('koa-better-body')
+
+app.use(body({
+  multipart: false
+  querystring: require('qs')
+}))
+```
+
+It's intentional that it's not included in the deps by default. In `v2` it was also working by passing it to `app.querystring`, because [koa-body-parsers][] works [that way (index.js#L53)](https://github.com/koajs/body-parsers/blob/master/index.js#L53).
+
+
+## Note about `strict` mode
+We are trying to follow standards. :cat2:
+
+You can pass `strict:false`, but see [IETF HTTP/1.1 Message Semantics: Section 6.1](https://tools.ietf.org/html/draft-ietf-httpbis-p2-semantics-19#section-6.1) to understand why we stay to _"strict mode"_ by default. GET, HEAD, and DELETE requests have no defined semantics for the request body, but this doesn't mean they may not be valid in certain use cases. Last two tests at [test/options.js](./test/options.js) are showing usage on non-strict and strict mode. 
+
+
+{% if (verb.related && verb.related.list && verb.related.list.length) { %}
+## Related
+You might also be interested in these packages:
+{%= related(verb.related.list, {words: 14}) %}
+{% } %}
+
+## Contributing
+Pull requests and stars are always welcome. For bugs and feature requests, [please create an issue](https://github.com/{%= repository %}/issues/new).  
+But before doing anything, please read the [CONTRIBUTING.md](./CONTRIBUTING.md) guidelines.
+
+### Contributing Recipes
+Recipes are just different use cases, written in form of README in human language. Showing some "Pro Tips" and tricks, answering common questions and so on. They look like [tests](./test.js), but in more readable and understandable way for humans - mostly for beginners that not reads or understand enough the README or API and tests.
+
+- They are in form of folders in the root [`recipes/`](./recipes) folder: for example `recipes/[short-meaningful-recipe-name]/`.
+- In recipe folder should exist `README.md` file: see [recipes/multipart/README.md](./recipes/multipart/README.md).
+- The examples from the recipe README.md should also exist as separate `.js` files.
+- Examples in recipe folder also should be working and actual.
+
+It would be great if you follow these steps when you want to _fix, update or create_ a recipes. :sunglasses:
+
+- Title for recipe idea should start with `[recipe]`: for example`[recipe] my awesome recipe`
+- Title for new recipe (PR) should also start with `[recipe]`.
+- Titles of Pull Requests or Issues for fixing/updating some existing recipes should start with `[recipe-fix]`.
+
+It will help a lot, thanks in advance! :yum:
+
+## [Charlike Make Reagent](http://j.mp/1stW47C) [![new message to charlike][new-message-img]][new-message-url] [![freenode #charlike][freenode-img]][freenode-url]
+
+[![{%= author.username %}.tk][author-www-img]][author-www-url] [![keybase {%= author.username %}][keybase-img]][keybase-url] [![{%= author.username %} npm][author-npm-img]][author-npm-url] [![{%= author.username %} twitter][author-twitter-img]][author-twitter-url] [![{%= author.username %} github][author-github-img]][author-github-url]
+
+{%= reflinks(verb.reflinks) %}
+
+[npmjs-url]: https://www.npmjs.com/package/{%= name %}
+[npmjs-img]: https://img.shields.io/npm/v/{%= name %}.svg?label={%= name %}
+
+[license-url]: https://github.com/{%= repository %}/blob/master/LICENSE
+[license-img]: https://img.shields.io/npm/l/{%= name %}.svg
+
+[downloads-url]: https://www.npmjs.com/package/{%= name %}
+[downloads-img]: https://img.shields.io/npm/dm/{%= name %}.svg
+
+
+[codeclimate-url]: https://codeclimate.com/github/{%= repository %}
+[codeclimate-img]: https://img.shields.io/codeclimate/github/{%= repository %}.svg
+
+[travis-url]: https://travis-ci.org/{%= repository %}
+[travis-img]: https://img.shields.io/travis/{%= repository %}/master.svg
+
+[coveralls-url]: https://coveralls.io/r/{%= repository %}
+[coveralls-img]: https://img.shields.io/coveralls/{%= repository %}.svg
+
+[david-url]: https://david-dm.org/{%= repository %}
+[david-img]: https://img.shields.io/david/{%= repository %}.svg
+
+[standard-url]: https://github.com/feross/standard
+[standard-img]: https://img.shields.io/badge/code%20style-standard-brightgreen.svg
+
+
+[author-www-url]: http://www.{%= author.username.toLowerCase() %}.tk
+[author-www-img]: https://img.shields.io/badge/www-{%= author.username.toLowerCase() %}.tk-fe7d37.svg
+
+[keybase-url]: https://keybase.io/{%= author.username.toLowerCase() %}
+[keybase-img]: https://img.shields.io/badge/keybase-{%= author.username.toLowerCase() %}-8a7967.svg
+
+[author-npm-url]: https://www.npmjs.com/~{%= author.username.toLowerCase() %}
+[author-npm-img]: https://img.shields.io/badge/npm-~{%= author.username.toLowerCase() %}-cb3837.svg
+
+[author-twitter-url]: https://twitter.com/{%= author.username %}
+[author-twitter-img]: https://img.shields.io/badge/twitter-@{%= author.username %}-55acee.svg
+
+[author-github-url]: https://github.com/{%= author.username %}
+[author-github-img]: https://img.shields.io/badge/github-@{%= author.username %}-4183c4.svg
+
+[freenode-url]: http://webchat.freenode.net/?channels=charlike
+[freenode-img]: https://img.shields.io/badge/freenode-%23charlike-5654a4.svg
+
+[new-message-url]: https://github.com/{%= author.username %}/ama
+[new-message-img]: https://img.shields.io/badge/ask%20me-anything-green.svg