:sparkles: starting to consolidate joi schema definitions

backend/lib/models/grouping.js

@@ -1,15 +1,11 @@
 const Schwifty = require('@hapipal/schwifty')
-const Joi = require('joi')
+const groupingSchema = require('../schemas/groupings')
 
 module.exports = class Grouping extends Schwifty.Model {
     static get tableName() {
         return 'groupings'
     }
     static get joiSchema() {
-        return Joi.object({
-            grouping_id: Joi.number(),
-            grouping_name: Joi.string().required(),
-            grouping_type: Joi.string().required(),
-        })
+        return groupingSchema.single
     }
 }

backend/lib/models/matchqueue.js

@@ -1,6 +1,7 @@
 const Schwifty = require('@hapipal/schwifty')
 const Joi = require('joi')
 const User = require('./user')
+const queueSchema = require('../schemas/queues')
 
 module.exports = class MatchQueue extends Schwifty.Model {
     static get tableName() {
@@ -23,11 +24,6 @@ module.exports = class MatchQueue extends Schwifty.Model {
         }
     }
     static get joiSchema() {
-        return Joi.object({
-            match_queue_id: Joi.number(),
-            profile_id: Joi.number().required(),
-            target_id: Joi.number().required(),
-            is_deleted: Joi.boolean().required(),
-        })
+        return queueSchema.single
     }
 }

backend/lib/models/membership.js

@@ -1,18 +1,12 @@
 const Schwifty = require('@hapipal/schwifty')
 const Joi = require('joi')
+const membershipSchema = require('../schemas/memberships')
 
 module.exports = class Membership extends Schwifty.Model {
     static get tableName() {
         return 'memberships'
     }
     static get joiSchema() {
-        return Joi.object({
-            membership_id: Joi.number(),
-            profile_id: Joi.number().required(),
-            grouping_id: Joi.number().allow(null),
-            membership_type: Joi.string().required(),
-            can_edit: Joi.boolean().required(),
-            is_active: Joi.boolean().required(),
-        })
+        return membershipSchema.single
     }
 }

backend/lib/models/response-key.js

@@ -1,13 +1,12 @@
 const Schwifty = require('@hapipal/schwifty')
 const Joi = require('joi')
+const surveyResponseSchema = require('../schemas/responses')
 
 module.exports = class ResponseKey extends Schwifty.Model {
     static get tableName() {
         return 'response_keys'
     }
     static get joiSchema() {
-        return Joi.object({
-            response_key_id: Joi.number().required(),
-        })
+        return surveyResponseSchema.key
     }
 }

backend/lib/models/response.js

@@ -1,16 +1,11 @@
 const Schwifty = require('@hapipal/schwifty')
-const Joi = require('joi')
+const responseSchema = require('../schemas/responses')
 
 module.exports = class Response extends Schwifty.Model {
     static get tableName() {
         return 'responses'
     }
     static get joiSchema() {
-        return Joi.object({
-            response_id: Joi.number(),
-            profile_id: Joi.number(),
-            response_key_id: Joi.number(),
-            val: Joi.string(),
-        })
+        return responseSchema.single
     }
 }

backend/lib/routes/membership/active.js

@@ -1,6 +1,9 @@
 'use strict'
 
 const Joi = require('joi')
+const apiSchema = require('../../schemas/api')
+const errorSchema = require('../../schemas/errors')
+const groupingSchema = require('../../schemas/groupings')
 
 const pluginConfig = {
     handlerType: 'grouping',
@@ -25,11 +28,9 @@ const validators = {
 }
 
 const responseSchemas = {
-    groupingsList: Joi.object({
-        grouping_id: Joi.number(),
-        grouping_name: Joi.string(),
-        grouping_type: Joi.string(),
-    }),
+    single: groupingSchema.single,
+    list: groupingSchema.list,
+    error: errorSchema.single
 }
 
 module.exports = {
@@ -73,11 +74,9 @@ module.exports = {
 
         /** Validate the server response */
         response: {
-            schema: Joi.object({
-                ok: Joi.bool(),
-                handler: Joi.string(),
-                data: Joi.array().items(responseSchemas.groupingsList),
-            }),
+            schema: apiSchema.single.append({
+                data: responseSchemas.list
+            })
         },
     },
 }

backend/lib/routes/membership/join.js

@@ -1,5 +1,9 @@
 const Joi = require('joi')
 
+const apiSchema = require('../../schemas/api')
+const errorSchema = require('../../schemas/errors')
+const groupingSchema = require('../../schemas/groupings')
+
 const pluginConfig = {
     handlerType: 'grouping',
     docs: {
@@ -10,13 +14,10 @@ const pluginConfig = {
 
 const validators = {
     params: Joi.object({ profile_id: Joi.number() }),
-    payload: Joi.object({
+    payload: groupingSchema.single.append({
         target_id: Joi.number().required(),
-        grouping_id: Joi.number().allow(null),
-        grouping_name: Joi.string().allow(null),
-        grouping_type: Joi.string().allow(null),
         role: Joi.string(),
-    }),
+    })
 }
 
 const responseSchemas = {
@@ -24,9 +25,7 @@ const responseSchemas = {
         memberships: Joi.array().items(),
         hasMatch: Joi.boolean()
     }),
-    error: Joi.object({
-        error: Joi.string(),
-    }),
+    error: errorSchema.single
 }
 
 module.exports = {
@@ -104,14 +103,10 @@ module.exports = {
         /** Validate the server response */
         response: {
             status: {
-                200: Joi.object({
-                    ok: Joi.bool(),
-                    handler: Joi.string(),
+                200: apiSchema.single.append({
                     data: responseSchemas.response,
                 }),
-                409: Joi.object({
-                    ok: Joi.bool(),
-                    handler: Joi.string(),
+                409: apiSchema.single.append({
                     data: responseSchemas.error,
                 }),
             },

backend/lib/routes/membership/leave.js

@@ -1,7 +1,7 @@
 'use strict'
 
 const Joi = require('joi')
-
+const apiSchema = require('../../schemas/api')
 const pluginConfig = {
     handlerType: 'grouping',
     docs: {
@@ -40,9 +40,7 @@ module.exports = {
         },
         validate: validators.leave,
         response: {
-            schema: Joi.object({
-                ok: Joi.bool(),
-                handler: Joi.string(),
+            schema: apiSchema.single.append({
                 data: validators.leave,
             }),
             failAction: 'log',

backend/lib/routes/profile/match.js

@@ -1,6 +1,8 @@
 'use strict'
 
 const Joi = require('joi')
+const apiSchema = require('../../schemas/api')
+const errorSchema = require('../../schemas/errors')
 
 const pluginConfig = {
     handlerType: 'match',
@@ -14,9 +16,7 @@ const validators = {}
 
 const responseSchemas = {
     response: Joi.array().items(Joi.object()),
-    error: Joi.object({
-        error: Joi.string(),
-    }),
+    error: errorSchema.single
 }
 
 module.exports = {
@@ -65,16 +65,12 @@ module.exports = {
         /** Validate the server response */
         response: {
             status: {
-                200: Joi.object({
-                    ok: Joi.bool(),
-                    handler: Joi.string(),
+                200: apiSchema.single.append({
                     data: responseSchemas.response,
                 }),
-                409: Joi.object({
-                    ok: Joi.bool(),
-                    handler: Joi.string(),
+                409: apiSchema.single.append({
                     data: responseSchemas.error,
-                }),
+                })
             },
         },
     },

backend/lib/routes/profile/patch-queue.js

@@ -2,6 +2,9 @@
 
 const Joi = require('joi')
 
+const apiSchema = require('../../schemas/api')
+const errorSchema = require('../../schemas/errors')
+
 const pluginConfig = {
     handlerType: 'profile',
     docs: {
@@ -11,7 +14,7 @@ const pluginConfig = {
 }
 
 const responseSchemas = {
-    responses: Joi.array().items(
+    response: Joi.array().items(
         Joi.alternatives().try(
             Joi.number(),
             Joi.object({
@@ -26,9 +29,7 @@ const responseSchemas = {
             }),
         ),
     ),
-    error: Joi.object({
-        error: Joi.string(),
-    }),
+    error: errorSchema.single
 }
 
 const validators = {
@@ -86,16 +87,12 @@ module.exports = {
         /** Validate the server response */
         response: {
             status: {
-                200: Joi.object({
-                    ok: Joi.bool(),
-                    handler: Joi.string(),
-                    data: responseSchemas.responses,
+                200: apiSchema.single.append({
+                    data: responseSchemas.response,
                 }),
-                409: Joi.object({
-                    ok: Joi.bool(),
-                    handler: Joi.string(),
+                409: apiSchema.single.append({
                     data: responseSchemas.error,
-                }),
+                })
             },
         },
     },

backend/lib/routes/profile/queue.js

@@ -1,6 +1,8 @@
 'use strict'
 
 const Joi = require('joi')
+const apiSchema = require('../../schemas/api')
+const errorSchema = require('../../schemas/errors')
 
 const pluginConfig = {
     handlerType: 'profile',
@@ -11,7 +13,7 @@ const pluginConfig = {
 }
 
 const responseSchemas = {
-    responses: Joi.array().items(
+    response: Joi.array().items(
         Joi.alternatives().try(
             Joi.number(),
             Joi.object({
@@ -25,9 +27,7 @@ const responseSchemas = {
             }),
         )
     ),
-    error: Joi.object({
-        error: Joi.string(),
-    }),
+    error: errorSchema.single
 }
 
 const validators = {
@@ -82,16 +82,12 @@ module.exports = {
         /** Validate the server response */
         response: {
             status: {
-                200: Joi.object({
-                    ok: Joi.bool(),
-                    handler: Joi.string(),
-                    data: responseSchemas.responses,
+                200: apiSchema.single.append({
+                    data: responseSchemas.response,
                 }),
-                409: Joi.object({
-                    ok: Joi.bool(),
-                    handler: Joi.string(),
+                409: apiSchema.single.append({
                     data: responseSchemas.error,
-                }),
+                })
             },
         },
     },

backend/lib/routes/profile/respond.js

@@ -1,6 +1,9 @@
 'use strict'
 
 const Joi = require('joi')
+const apiSchema = require('../../schemas/api')
+const errorSchema = require('../../schemas/errors')
+const surveyResponseSchema = require('../../schemas/responses')
 
 const pluginConfig = {
     handlerType: 'profile',
@@ -11,17 +14,8 @@ const pluginConfig = {
 }
 
 const responseSchemas = {
-    responses: Joi.array().items(
-        Joi.object({
-            response_id: Joi.number().required(),
-            profile_id: Joi.number().required(),
-            response_key_id: Joi.number().required(),
-            val: Joi.string().required(),
-        }),
-    ),
-    error: Joi.object({
-        error: Joi.string(),
-    }),
+    response: surveyResponseSchema.list,
+    error: errorSchema.single
 }
 
 const validators = {
@@ -98,16 +92,12 @@ module.exports = {
         /** Validate the server response */
         response: {
             status: {
-                201: Joi.object({
-                    ok: Joi.bool(),
-                    handler: Joi.string(),
-                    data: responseSchemas.responses,
+                201: apiSchema.single.append({
+                    data: responseSchemas.response,
                 }),
-                409: Joi.object({
-                    ok: Joi.bool(),
-                    handler: Joi.string(),
+                409: apiSchema.single.append({
                     data: responseSchemas.error,
-                }),
+                })
             },
         },
     },

backend/lib/routes/profile/score.js

@@ -1,6 +1,8 @@
 'use strict'
 
 const Joi = require('joi')
+const apiSchema = require('../../schemas/api')
+const errorSchema = require('../../schemas/errors')
 
 const pluginConfig = {
     handlerType: 'score',
@@ -30,9 +32,7 @@ const validators = {
 
 const responseSchemas = {
     response: Joi.array().items(),
-    error: Joi.object({
-        error: Joi.string(),
-    }),
+    error: errorSchema.single
 }
 
 module.exports = {
@@ -95,16 +95,12 @@ module.exports = {
         /** Validate the server response */
         response: {
             status: {
-                200: Joi.object({
-                    ok: Joi.bool(),
-                    handler: Joi.string(),
+                200: apiSchema.single.append({
                     data: responseSchemas.response,
                 }),
-                409: Joi.object({
-                    ok: Joi.bool(),
-                    handler: Joi.string(),
+                409: apiSchema.single.append({
                     data: responseSchemas.error,
-                }),
+                })
             },
         },
     },

backend/lib/routes/profile/update.js

@@ -1,6 +1,9 @@
 'use strict'
 
 const Joi = require('joi')
+const apiSchema = require('../../schemas/api')
+const errorSchema = require('../../schemas/errors')
+const surveyResponseSchema = require('../../schemas/responses')
 
 const pluginConfig = {
     handlerType: 'profile',
@@ -11,17 +14,8 @@ const pluginConfig = {
 }
 
 const responseSchemas = {
-    responses: Joi.array().items(
-        Joi.object({
-            response_id: Joi.number().required(),
-            profile_id: Joi.number().required(),
-            response_key_id: Joi.number().required(),
-            val: Joi.string().required(),
-        }),
-    ),
-    error: Joi.object({
-        error: Joi.string(),
-    }),
+    response: surveyResponseSchema.list,
+    error: errorSchema.single
 }
 
 const validators = {
@@ -89,16 +83,12 @@ module.exports = {
         /** Validate the server response */
         response: {
             status: {
-                200: Joi.object({
-                    ok: Joi.bool(),
-                    handler: Joi.string(),
-                    data: responseSchemas.responses,
+                200: apiSchema.single.append({
+                    data: responseSchemas.response,
                 }),
-                409: Joi.object({
-                    ok: Joi.bool(),
-                    handler: Joi.string(),
+                409: apiSchema.single.append({
                     data: responseSchemas.error,
-                }),
+                })
             },
         },
     },

backend/lib/routes/survey/questions.js

@@ -1,6 +1,8 @@
 'use strict'
 
 const Joi = require('joi')
+const apiSchema = require('../../schemas/api')
+const surveyResponseSchema = require('../../schemas/responses')
 
 const pluginConfig = {
     handlerType: 'survey',
@@ -22,12 +24,7 @@ const validators = {
     // payload: true,
 }
 const responseSchemas = {
-    responseKeysList: Joi.object({
-        response_key_id: Joi.number().required(),
-        response_key_category: Joi.string().required(),
-        response_key_prompt: Joi.string().required(),
-        response_key_description: Joi.any(),
-    }),
+    response: surveyResponseSchema.keys,
 }
 
 module.exports = {
@@ -62,10 +59,8 @@ module.exports = {
 
         /** Validate the server response */
         response: {
-            schema: Joi.object({
-                ok: Joi.bool(),
-                handler: Joi.string(),
-                data: Joi.array().items(responseSchemas.responseKeysList),
+            schema: apiSchema.single.append({
+                data: responseSchemas.response
             }),
             failAction: 'log',
         },

backend/lib/routes/survey/responses.js

@@ -1,6 +1,8 @@
 'use strict'
 
 const Joi = require('joi')
+const apiSchema = require('../../schemas/api')
+const surveyResponseSchema = require('../../schemas/responses')
 
 const pluginConfig = {
     handlerType: 'survey',
@@ -22,9 +24,7 @@ const validators = {
     // payload: true,
 }
 const responseSchemas = {
-    responseKeysList: Joi.object({
-        response_key_id: Joi.number().required(),
-    }),
+    response: surveyResponseSchema.keys
 }
 
 module.exports = {
@@ -59,10 +59,8 @@ module.exports = {
 
         /** Validate the server response */
         response: {
-            schema: Joi.object({
-                ok: Joi.bool(),
-                handler: Joi.string(),
-                data: Joi.array().items(responseSchemas.responseKeysList),
+            schema: apiSchema.single.append({
+                data: responseSchemas.response
             }),
             failAction: 'log',
         },

backend/lib/routes/user/create-profile.js

@@ -1,6 +1,7 @@
 'use strict'
 
 const Joi = require('joi')
+const errorSchema = require('../../schemas/errors')
 
 const pluginConfig = {
     handlerType: 'user',
@@ -39,9 +40,7 @@ const responseSchemas = {
         // and this route utilizes getCompleteProfiles
         user_name: Joi.string(),
     }),
-    error: Joi.object({
-        error: Joi.string(),
-    }),
+    error: errorSchema.single
 }
 
 module.exports = {

backend/lib/routes/user/list-profiles.js

@@ -1,6 +1,7 @@
 'use strict'
 
 const Joi = require('joi')
+const errorSchema = require('../../schemas/errors')
 
 const pluginConfig = {
     handlerType: 'user',
@@ -46,9 +47,7 @@ const responseSchemas = {
         ),
         user_type: Joi.string().required(),
     }),
-    error: Joi.object({
-        error: Joi.string(),
-    }),
+    error: errorSchema.single
 }
 
 module.exports = {

backend/lib/schemas/api.js

@@ -0,0 +1,12 @@
+'use strict'
+
+const Joi = require('joi')
+
+const singleApiResponse = Joi.object({
+    ok: Joi.bool(),
+    handler: Joi.string(),
+}).label('api_single')
+
+module.exports = {
+    single: singleApiResponse
+}

backend/lib/schemas/errors.js

@@ -0,0 +1,11 @@
+'use strict'
+
+const Joi = require('joi')
+
+const singleError = Joi.object({
+    error: Joi.string(),
+}).label('error_single')
+
+module.exports = {
+    single: singleError
+}

backend/lib/schemas/groupings.js

@@ -0,0 +1,14 @@
+'use strict'
+
+const Joi = require('joi')
+
+const singleGrouping = Joi.object({
+    grouping_id: Joi.number(),
+    grouping_name: Joi.string(),
+    grouping_type: Joi.string(),
+}).label('grouping_single')
+
+module.exports = {
+    single: singleGrouping,
+    list: Joi.array().items(singleGrouping).label('grouping_list')
+}

backend/lib/schemas/memberships.js

@@ -0,0 +1,17 @@
+'use strict'
+
+const Joi = require('joi')
+
+const singleMembership = Joi.object({
+    membership_id: Joi.number(),
+    profile_id: Joi.number().required(),
+    grouping_id: Joi.number().allow(null),
+    membership_type: Joi.string().required(),
+    can_edit: Joi.boolean().required(),
+    is_active: Joi.boolean().required(),
+}).label('membership_single')
+
+module.exports = {
+    single: singleMembership,
+    list: Joi.array().items(singleMembership).label('membership_list')
+}

backend/lib/schemas/queues.js

@@ -0,0 +1,15 @@
+'use strict'
+
+const Joi = require('joi')
+
+const singleQueueEntry = Joi.object({
+    match_queue_id: Joi.number(),
+    profile_id: Joi.number().required(),
+    target_id: Joi.number().required(),
+    is_deleted: Joi.boolean().required(),
+}).label('queue_single')
+
+module.exports = {
+    single: singleQueueEntry,
+    list: Joi.array().items(singleQueueEntry).label('queue_list')
+}

backend/lib/schemas/responses.js

@@ -0,0 +1,24 @@
+'use strict'
+
+const Joi = require('joi')
+
+const singleResponse = Joi.object({
+    response_key_id: Joi.number(),
+    response_id: Joi.number(),
+    profile_id: Joi.number(),
+    val: Joi.string(),
+}).label('response_single')
+
+const singleResponseKey = Joi.object({
+    response_key_id: Joi.number().required(),
+    response_key_category: Joi.string().required(),
+    response_key_prompt: Joi.string().required(),
+    response_key_description: Joi.any(),
+}).label('question_single')
+
+module.exports = {
+    single: singleResponse,
+    list: Joi.array().items(singleResponse).label('response_list'),
+    key: singleResponseKey,
+    keys: Joi.array().items(singleResponseKey).label('question_list')
+}

backend/tests/score.spec.js

@@ -9,6 +9,10 @@ const plugin = require('../lib/plugins/profile')
 const Profile = require('../lib/models/profile')
 const ZipCode = require('../lib/models/zip-code')
 const MatchQueue = require('../lib/models/matchqueue')
+
+// !: Must match the key set in servives/profile.js
+const zipcodeKey = 7 
+
 /**
  * Route parameters
  */
@@ -24,7 +28,7 @@ const mockReturn = {
             responses: [
                 { val: '120' },
                 { val: '200' },
-                { response_key_id: 16, val: '90065' },
+                { response_key_id: zipcodeKey, val: '90065' },
             ],
         },
         {
@@ -33,7 +37,7 @@ const mockReturn = {
             responses: [
                 { val: '120' },
                 { val: '200' },
-                { response_key_id: 16, val: '96741' },
+                { response_key_id: zipcodeKey, val: '96741' },
             ],
         },
         {
@@ -42,7 +46,7 @@ const mockReturn = {
             responses: [
                 { val: '180' },
                 { val: '140' },
-                { response_key_id: 16, val: '97002' },
+                { response_key_id: zipcodeKey, val: '97002' },
             ],
         },
     ],