@srfnstack/spliffy 1.2.5 → 1.2.6

package/LICENSE.txt

@@ -1,21 +1,21 @@
-MIT License
-
-Copyright (c) 2019 Robert Kempton
-
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in all
-copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. 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
+MIT License
+
+Copyright (c) 2019 Robert Kempton
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. 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.

package/README.md

@@ -1,43 +1,43 @@
-# Spliffy
-
-> directory based routing with js request handlers and static file serving
-
-## Getting started
-Create a directories for your app
-
-`mkdir -p ~/app/www`
-
-Install spliffy
-
-`cd ~/app && npm install spliffy`
-
-Create a handler for the desired route name 
-
-`vi ~/app/www/spliffy.js`
-```js
-module.exports = {
-    GET: () => ({hello: "spliffy"})
-}
-
-```
-Create the start script, ```vi ~/app/serve.js``` 
-```js
-require('spliffy')({routeDir: __dirname+ '/www'})
-```
-
-because the routeDir is ~/app/www, the filename `spliffy.js` creates the path `/spliffy`
-
-The object passed to spliffy is the config. See the [Config](#Config) section for more information.
-
-routeDir is the only required property and should be an absolute path.
-
-`10420` is the default port for http, and can be changed by setting the port in the config
-
-start the server
-`node ~/app/serve.js`
-
-Go to `localhost:10420/spliffy`
-
-# [Documentation](https://srfnstack.github.io/spliffy/)
-
-#### [Examples](https://github.com/narcolepticsnowman/spliffy/tree/master/example)
+# Spliffy
+
+> directory based routing with js request handlers and static file serving
+
+## Getting started
+Create a directories for your app
+
+`mkdir -p ~/app/www`
+
+Install spliffy
+
+`cd ~/app && npm install spliffy`
+
+Create a handler for the desired route name 
+
+`vi ~/app/www/spliffy.js`
+```js
+module.exports = {
+    GET: () => ({hello: "spliffy"})
+}
+
+```
+Create the start script, ```vi ~/app/serve.js``` 
+```js
+require('spliffy')({routeDir: __dirname+ '/www'})
+```
+
+because the routeDir is ~/app/www, the filename `spliffy.js` creates the path `/spliffy`
+
+The object passed to spliffy is the config. See the [Config](#Config) section for more information.
+
+routeDir is the only required property and should be an absolute path.
+
+`10420` is the default port for http, and can be changed by setting the port in the config
+
+start the server
+`node ~/app/serve.js`
+
+Go to `localhost:10420/spliffy`
+
+# [Documentation](https://srfnstack.github.io/spliffy/)
+
+#### [Examples](https://github.com/narcolepticsnowman/spliffy/tree/master/example)

package/package.json

@@ -1,44 +1,47 @@
-{
-  "name": "@srfnstack/spliffy",
-  "version": "1.2.5",
-  "author": "snowbldr",
-  "private": false,
-  "homepage": "https://github.com/SRFNStack/spliffy",
-  "license": "MIT",
-  "type": "module",
-  "files": [
-    "src/*",
-    "LICENSE.txt",
-    "README.md"
-  ],
-  "main": "src/index.mjs",
-  "repository": {
-    "type": "git",
-    "url": "git@github.com:SRFNStack/spliffy.git"
-  },
-  "scripts": {
-    "test": "npm run lint:fix && jest",
-    "lint": "standard --env jest src ./*js && standard --env jest --env browser --global Prism docs example",
-    "lint:fix": "standard --env jest --fix src ./*js && standard --env jest --env browser --global Prism --fix docs example"
-  },
-  "keywords": [
-    "node",
-    "http",
-    "server",
-    "web",
-    "framework",
-    "rest"
-  ],
-  "dependencies": {
-    "cookie": "^1.0.2",
-    "etag": "^1.8.1",
-    "uuid": "^8.3.2",
-    "uWebSockets.js": "github:uNetworking/uWebSockets.js#v20.51.0"
-  },
-  "devDependencies": {
-    "helmet": "^4.6.0",
-    "jest": "^27.3.1",
-    "node-fetch": "^2.6.7",
-    "standard": "^16.0.4"
-  }
-}
+{
+  "name": "@srfnstack/spliffy",
+  "version": "1.2.6",
+  "author": "snowbldr",
+  "private": false,
+  "homepage": "https://github.com/SRFNStack/spliffy",
+  "license": "MIT",
+  "type": "module",
+  "engines": {
+    "node": ">=16 <=20"
+  },
+  "files": [
+    "src/*",
+    "LICENSE.txt",
+    "README.md"
+  ],
+  "main": "src/index.mjs",
+  "repository": {
+    "type": "git",
+    "url": "git@github.com:SRFNStack/spliffy.git"
+  },
+  "scripts": {
+    "test": "npm run lint:fix && jest",
+    "lint": "standard --env jest src ./*js && standard --env jest --env browser --global Prism docs example",
+    "lint:fix": "standard --env jest --fix src ./*js && standard --env jest --env browser --global Prism --fix docs example"
+  },
+  "keywords": [
+    "node",
+    "http",
+    "server",
+    "web",
+    "framework",
+    "rest"
+  ],
+  "dependencies": {
+    "cookie": "^1.0.2",
+    "etag": "^1.8.1",
+    "uuid": "^11.1.0",
+    "uWebSockets.js": "github:uNetworking/uWebSockets.js#v20.74.0"
+  },
+  "devDependencies": {
+    "helmet": "^4.6.0",
+    "jest": "^27.3.1",
+    "node-fetch": "^2.6.7",
+    "standard": "^16.0.4"
+  }
+}

package/src/content.mjs

@@ -1,97 +1,97 @@
-import contentTypes from './content-types.mjs'
-import { parseQuery } from './url.mjs'
-
-const defaultHandler = {
-  deserialize: o => {
-    if (!o) return o
-    try {
-      return JSON.parse(o && o.toString())
-    } catch (e) {
-      return o
-    }
-  },
-  serialize: o => {
-    if (!o) return { data: o }
-    if (typeof o === 'string') {
-      return {
-        contentType: 'text/plain',
-        data: o
-      }
-    }
-    if (o instanceof Buffer) {
-      return {
-        contentType: 'application/octet-stream',
-        data: o
-      }
-    }
-    return {
-      contentType: 'application/json',
-      data: JSON.stringify(o)
-    }
-  }
-}
-
-const toFormData = (key, value) => {
-  if (Array.isArray(value)) {
-    return value.map(toFormData).flat()
-  } else if (typeof value === 'object') {
-    return Object.keys(value).map(k => toFormData(`${key}.${k}`, value[k])).flat()
-  } else {
-    return `${encodeURIComponent(key)}=${encodeURIComponent(value)}`
-  }
-}
-
-const contentHandlers = {
-  'application/json': {
-    deserialize: s => s && JSON.parse(s && s.toString()),
-    serialize: o => o && JSON.stringify(o)
-  },
-  'text/plain': {
-    deserialize: s => s && s.toString(),
-    serialize: o => o && o.toString()
-  },
-  'application/octet-stream': defaultHandler,
-  'application/x-www-form-urlencoded': {
-    deserialize: s => s && parseQuery(s.toString(), true),
-    serialize: o => o && Object.keys(o).map(toFormData).flat().join('&')
-  },
-  '*/*': defaultHandler
-}
-
-function getHandler (contentType, acceptsDefault) {
-  if (!contentType) return contentHandlers[acceptsDefault]
-  // content-type is singular https://greenbytes.de/tech/webdav/rfc2616.html#rfc.section.14.17
-  let handler = contentHandlers[contentType]
-  if (!handler && contentType.indexOf(';') > -1) {
-    handler = contentHandlers[contentType.split(';')[0].trim()]
-  }
-  if (handler && typeof handler) {
-    if (typeof handler.serialize !== 'function') {
-      throw new Error(`Content handlers must provide a serialize function. ${handler}`)
-    }
-    if (typeof handler.deserialize !== 'function') {
-      throw new Error(`Content handlers must provide a deserialize function. ${handler}`)
-    }
-    return handler
-  }
-  return contentHandlers[acceptsDefault]
-}
-
-export function getContentTypeByExtension (name, staticContentTypes) {
-  const extension = name.indexOf('.') > -1 ? name.slice(name.lastIndexOf('.')).toLowerCase() : 'default'
-  const contentType = staticContentTypes?.[extension] || null
-
-  return contentType || contentTypes[extension]
-}
-
-export function serializeBody (content, contentType, acceptsDefault) {
-  return getHandler(contentType && contentType.toLowerCase(), acceptsDefault).serialize(content)
-}
-
-export function deserializeBody (content, contentType, acceptsDefault) {
-  return getHandler(contentType && contentType.toLowerCase(), acceptsDefault).deserialize(content)
-}
-
-export function initContentHandlers (handlers) {
-  return Object.assign({}, contentHandlers, handlers)
-}
+import contentTypes from './content-types.mjs'
+import { parseQuery } from './url.mjs'
+
+const defaultHandler = {
+  deserialize: o => {
+    if (!o) return o
+    try {
+      return JSON.parse(o && o.toString())
+    } catch (e) {
+      return o
+    }
+  },
+  serialize: o => {
+    if (!o) return { data: o }
+    if (typeof o === 'string') {
+      return {
+        contentType: 'text/plain',
+        data: o
+      }
+    }
+    if (o instanceof Buffer) {
+      return {
+        contentType: 'application/octet-stream',
+        data: o
+      }
+    }
+    return {
+      contentType: 'application/json',
+      data: JSON.stringify(o)
+    }
+  }
+}
+
+const toFormData = (key, value) => {
+  if (Array.isArray(value)) {
+    return value.map(toFormData).flat()
+  } else if (typeof value === 'object') {
+    return Object.keys(value).map(k => toFormData(`${key}.${k}`, value[k])).flat()
+  } else {
+    return `${encodeURIComponent(key)}=${encodeURIComponent(value)}`
+  }
+}
+
+const contentHandlers = {
+  'application/json': {
+    deserialize: s => s && JSON.parse(s && s.toString()),
+    serialize: o => o && JSON.stringify(o)
+  },
+  'text/plain': {
+    deserialize: s => s && s.toString(),
+    serialize: o => o && o.toString()
+  },
+  'application/octet-stream': defaultHandler,
+  'application/x-www-form-urlencoded': {
+    deserialize: s => s && parseQuery(s.toString(), true),
+    serialize: o => o && Object.keys(o).map(toFormData).flat().join('&')
+  },
+  '*/*': defaultHandler
+}
+
+function getHandler (contentType, acceptsDefault) {
+  if (!contentType) return contentHandlers[acceptsDefault]
+  // content-type is singular https://greenbytes.de/tech/webdav/rfc2616.html#rfc.section.14.17
+  let handler = contentHandlers[contentType]
+  if (!handler && contentType.indexOf(';') > -1) {
+    handler = contentHandlers[contentType.split(';')[0].trim()]
+  }
+  if (handler && typeof handler) {
+    if (typeof handler.serialize !== 'function') {
+      throw new Error(`Content handlers must provide a serialize function. ${handler}`)
+    }
+    if (typeof handler.deserialize !== 'function') {
+      throw new Error(`Content handlers must provide a deserialize function. ${handler}`)
+    }
+    return handler
+  }
+  return contentHandlers[acceptsDefault]
+}
+
+export function getContentTypeByExtension (name, staticContentTypes) {
+  const extension = name.indexOf('.') > -1 ? name.slice(name.lastIndexOf('.')).toLowerCase() : 'default'
+  const contentType = staticContentTypes?.[extension] || null
+
+  return contentType || contentTypes[extension]
+}
+
+export function serializeBody (content, contentType, acceptsDefault) {
+  return getHandler(contentType && contentType.toLowerCase(), acceptsDefault).serialize(content)
+}
+
+export function deserializeBody (content, contentType, acceptsDefault) {
+  return getHandler(contentType && contentType.toLowerCase(), acceptsDefault).deserialize(content)
+}
+
+export function initContentHandlers (handlers) {
+  return Object.assign({}, contentHandlers, handlers)
+}