Support string uidType

.github/workflows/node.js.yml

@@ -0,0 +1,30 @@
+# This workflow will do a clean install of node dependencies, build the source code and run tests across different versions of node
+# For more information see: https://help.github.com/actions/language-and-framework-guides/using-nodejs-with-github-actions
+
+name: Node.js CI
+
+on:
+  push:
+    branches: [ master ]
+  pull_request:
+    branches: [ master ]
+
+jobs:
+  build:
+
+    runs-on: ubuntu-latest
+
+    strategy:
+      matrix:
+        node-version: [8.x]
+        # See supported Node.js release schedule at https://nodejs.org/en/about/releases/
+
+    steps:
+    - uses: actions/checkout@v2
+    - name: Use Node.js ${{ matrix.node-version }}
+      uses: actions/setup-node@v1
+      with:
+        node-version: ${{ matrix.node-version }}
+    - run: npm ci
+    - run: npm run build --if-present
+    - run: npm test

README.md

@@ -60,7 +60,7 @@ We instead use a different property `primaryKey`, whose possible values are
 \*In future there might be other types of primaryKeys if required.
 
 #### relationship key type is configurable
-When creating a field, you can state how to relate it
+When creating a field, you can state how to relate it. Supported are `uuid`, `autoincrement` and `string`
 
 ```javascript
 jsonApi.define({

example/server.js

@@ -7,7 +7,7 @@ const fs = require('fs')
 const path = require('path')
 const debug = require('debug')
 
-jsonApi.setConfig({
+const config = {
   graphiql: true,
   swagger: {
     title: 'Example JSON:API Server',
@@ -43,7 +43,9 @@ jsonApi.setConfig({
   meta: {
     description: 'This block shows up in the root node of every payload'
   }
-})
+}
+
+jsonApi.setConfig(config)
 
 jsonApi.authenticate((request, callback) => {
   // If a "blockMe" header is provided, block access.
@@ -79,4 +81,5 @@ if (typeof describe === 'undefined') {
 }
 server.start = jsonApi.start
 server.close = jsonApi.close
+server.setupTestServer = opts => (jsonApi.setConfig({...config, ...opts}), jsonApi.start())
 server.getExpressServer = jsonApi.getExpressServer

lib/ourJoi.js

@@ -5,6 +5,8 @@ const Joi = require('joi')
 const JoiDateExtensions = require('joi-date-extensions')
 Joi.extend(JoiDateExtensions)
 
+const ALLOWABLE_RELATED_UID_TYPES = ['uuid', 'autoincrement', 'string']
+
 ourJoi._joiBase = resourceName => {
   const relationType = Joi.object().keys({
     id: Joi.string().required(),
@@ -26,8 +28,8 @@ Joi.one = function () {
   }
   obj._settings._uidType = 'string'
   obj.uidType = function (keyType) {
-    if (keyType !== 'uuid' && keyType !== 'autoincrement') {
-      throw new Error('Resources can be related only via UUID or AUTOINCREMENT keys')
+    if (!ALLOWABLE_RELATED_UID_TYPES.includes(keyType)) {
+      throw new Error('Resources can be related only via UUID, STRING or AUTOINCREMENT keys')
     }
     obj._settings._uidType = keyType
     return obj
@@ -45,8 +47,8 @@ Joi.many = function () {
   }
   obj._settings._uidType = 'string'
   obj.uidType = function (keyType) {
-    if (keyType !== 'uuid' && keyType !== 'autoincrement') {
-      throw new Error('Resources can be related only via UUID or AUTOINCREMENT keys')
+    if (!ALLOWABLE_RELATED_UID_TYPES.includes(keyType)) {
+      throw new Error('Resources can be related only via UUID, STRING or AUTOINCREMENT keys')
     }
     obj._settings._uidType = keyType
     return obj

lib/pagination.js

@@ -1,6 +1,7 @@
 'use strict'
 const pagination = module.exports = { }
 
+const jsonApi = require('./jsonApi.js')
 const ourJoi = require('./ourJoi.js')
 const url = require('url')
 
@@ -27,8 +28,9 @@ pagination.validatePaginationParams = request => {
   }
   const page = request.params.page
 
-  page.offset = parseInt(page.offset, 10) || 0
-  page.limit = parseInt(page.limit, 10) || 50
+  // Set your own pagination defaults through setConfig()
+  page.offset = parseInt(page.offset, 10) || (jsonApi._apiConfig.page && jsonApi._apiConfig.page.offset) || 0
+  page.limit = parseInt(page.limit, 10) || (jsonApi._apiConfig.page && jsonApi._apiConfig.page.limit) || 50
 }
 
 pagination.enforcePagination = (request, results) => results.slice(0, request.params.page.size)

lib/postProcess.js

@@ -59,7 +59,7 @@ postProcess._fetchRelatedResources = (request, mainResource, callback) => {
   // Fetch the other objects
   let dataItems = mainResource[request.params.relation]
 
-  if (!dataItems) return callback(null, [ null ], null)
+  if (!dataItems) return callback(null, [], null)
 
   if (!(Array.isArray(dataItems))) dataItems = [ dataItems ]
 

lib/responseHelper.js

@@ -201,7 +201,7 @@ responseHelper._generateResponse = (request, resourceConfig, sanitisedData, hand
     self: responseHelper._baseUrl + request.route.path + (request.route.query ? ('?' + request.route.query) : '')
   }, pagination.generatePageLinks(request, handlerTotal)),
 
-  data: sanitisedData
+  data: (sanitisedData === undefined ? null : sanitisedData)
 })
 
 responseHelper._generateMeta = (request, handlerTotal) => {

lib/routes/addRelation.js

@@ -36,7 +36,8 @@ addRelationRoute.register = () => {
 
         if (resourceConfig.attributes[request.params.relation]._settings.__many) {
           theirResource[request.params.relation] = theirResource[request.params.relation] || [ ]
-          theirResource[request.params.relation].push(theirs)
+          const elements = [].concat(theirs || [])
+          theirResource[request.params.relation].push(...elements)
         } else {
           theirResource[request.params.relation] = theirs
         }

lib/routes/related.js

@@ -59,15 +59,15 @@ relatedRoute.register = () => {
         if (relation._settings.__one) {
           // if this is a hasOne, then disable pagination meta data.
           total = null
-          relatedResources = relatedResources[0]
+          relatedResources = relatedResources[0] ? relatedResources[0] : null
         }
         request.resourceConfig = (relation._settings.__one || relation._settings.__many).map(resourceName => {
           return jsonApi._resources[resourceName]
         })
 
         response = responseHelper._generateResponse(request, resourceConfig, relatedResources, total)
         if (relatedResources !== null) {
-          response.included = [ ]
+          response.included = []
         }
         postProcess.handle(request, response, callback)
       }