ES6

Author: z0mt3c

README.md

@@ -1,7 +1,7 @@
 # hapi-swaggered
 Yet another hapi plugin providing swagger compliant API specifications (swagger specs 2.0) based on routes and joi schemas to be used with swagger-ui.
 
-Supports hapi 8.x, 9.x and 10.x
+Supports hapi 10.x and up
 
 [![Build Status](https://img.shields.io/travis/z0mt3c/hapi-swaggered/master.svg)](https://travis-ci.org/z0mt3c/hapi-swaggered)
 [![Coverage Status](https://img.shields.io/coveralls/z0mt3c/hapi-swaggered/master.svg)](https://coveralls.io/r/z0mt3c/hapi-swaggered?branch=master)

index.js

@@ -1 +1,3 @@
+'use strict'
+
 module.exports = require('./lib')

lib/defaults.js

@@ -1,3 +1,5 @@
+'use strict'
+
 module.exports = {
   requiredTags: ['api'],
   produces: ['application/json'],

lib/generator.js

@@ -1,11 +1,13 @@
-var Hoek = require('hoek')
-var _ = require('lodash')
-var utils = require('./utils')
-var generator = module.exports = {}
+'use strict'
+
+const Hoek = require('hoek')
+const _ = require('lodash')
+const utils = require('./utils')
+const generator = module.exports = {}
 
 generator.createProperties = function (schema, definitions) {
-  return _.reduce(Hoek.reach(schema, '_inner.children'), function (memo, property) {
-    var schema = generator.fromJoiSchema(property.schema, definitions)
+  return _.reduce(Hoek.reach(schema, '_inner.children'), (memo, property) => {
+    const schema = generator.fromJoiSchema(property.schema, definitions)
 
     if (schema) {
       memo[property.key] = schema
@@ -16,31 +18,31 @@ generator.createProperties = function (schema, definitions) {
 }
 
 generator.newModel = function (schema, definitions) {
-  var schemaType = utils.getPrimitiveType(schema)
+  const schemaType = utils.getPrimitiveType(schema)
   Hoek.assert(schemaType !== 'array', 'generator.newModel does not support array schema')
 
   // Don't generate model for primitive types!
   if (utils.isPrimitiveSwaggerType(schemaType)) {
-    var format = utils.getFormat(schema)
+    const format = utils.getFormat(schema)
 
     return {
       type: utils.mapSwaggerType(schema, schemaType),
       format: format
     }
   }
 
-  var model = {
+  const model = {
     required: [],
     properties: {}
   }
 
-  var properties = generator.createProperties(schema, definitions)
-  model.properties = _.reduce(properties, function (memo, value, key) {
+  let properties = generator.createProperties(schema, definitions)
+  model.properties = _.reduce(properties, (memo, value, key) => {
     if (value.required) {
       model.required.push(key)
     }
 
-    var pick = _.has(value, '$ref') ? ['$ref'] : ['type', 'format', 'items', 'default', 'description', '$ref', 'enum', 'minimum', 'maximum', 'minLength', 'maxLength', 'collectionFormat']
+    const pick = _.has(value, '$ref') ? ['$ref'] : ['type', 'format', 'items', 'default', 'description', '$ref', 'enum', 'minimum', 'maximum', 'minLength', 'maxLength', 'collectionFormat']
     memo[key] = _.pick(value, pick)
     return memo
   }, model.properties)
@@ -49,11 +51,11 @@ generator.newModel = function (schema, definitions) {
     delete model.required
   }
 
-  var modelName = utils.generateNameWithFallback(schema, definitions, model)
+  let modelName = utils.generateNameWithFallback(schema, definitions, model)
   definitions[modelName] = model
 
   return {
-    $ref: '#/definitions/' + modelName
+    $ref: `#/definitions/${modelName}`
   }
 }
 
@@ -62,10 +64,10 @@ generator.newArray = function (schema, definitions, arrayModel) {
   arrayModel.type = 'array'
 
   // TODO: Improve array handling, multiple inclusion types are not supported by swagger specs. Only possiblity would be to extract common denominator as interface-schema.
-  var firstInclusionType = utils.getFirstInclusionType(schema)
+  const firstInclusionType = utils.getFirstInclusionType(schema)
 
   if (firstInclusionType) {
-    var firstInclusionTypeModel = generator.fromJoiSchema(firstInclusionType, definitions)
+    const firstInclusionTypeModel = generator.fromJoiSchema(firstInclusionType, definitions)
     if (firstInclusionTypeModel.$ref) {
       arrayModel.items = _.pick(firstInclusionTypeModel, ['$ref'])
     } else {
@@ -78,32 +80,32 @@ generator.newArray = function (schema, definitions, arrayModel) {
 
   return arrayModel
 
-  /*
-   // May extract all arrays and use a reference? Sometimes inline required?
-   var required = arrayModel.required
-   delete arrayModel.required
-   var name = utils.generateNameWithFallback(schema, definitions, arrayModel)
-   definitions[name] = arrayModel
-
-   return {
-   required: required,
-   description: arrayModel.description,
-   $ref: '#/definitions/' + name
-   }
-   */
+/*
+ // May extract all arrays and use a reference? Sometimes inline required?
+ var required = arrayModel.required
+ delete arrayModel.required
+ var name = utils.generateNameWithFallback(schema, definitions, arrayModel)
+ definitions[name] = arrayModel
+
+ return {
+ required: required,
+ description: arrayModel.description,
+ $ref: '#/definitions/' + name
+ }
+ */
 }
 
 generator.extractAsDefinition = function (schema, definitions, definition) {
   if (definition.type === 'array') {
-    var required = definition.required
+    const required = definition.required
     delete definition.required
-    var name = utils.generateNameWithFallback(schema, definitions, definition)
+    let name = utils.generateNameWithFallback(schema, definitions, definition)
     definitions[name] = definition
 
     return {
       required: required,
       description: definition.description,
-      $ref: '#/definitions/' + name
+      $ref: `#/definitions/${name}`
     }
   }
 
@@ -115,8 +117,8 @@ generator.fromJoiSchema = function (schema, definitions) {
   Hoek.assert(schema.isJoi, 'Schema is no joi schema')
 
   if (utils.isSupportedSchema(schema)) {
-    var schemaType = utils.getPrimitiveType(schema)
-    var baseModel = utils.parseBaseModelAttributes(schema)
+    const schemaType = utils.getPrimitiveType(schema)
+    const baseModel = utils.parseBaseModelAttributes(schema)
 
     if (schemaType === 'object') {
       return Hoek.merge(baseModel, generator.newModel(schema, definitions))

lib/index.js

@@ -1,33 +1,35 @@
-var Hoek = require('hoek')
-var Joi = require('joi')
-var Schema = require('./schema')
-var utils = require('./utils')
+'use strict'
 
-var SWAGGER_VERSION = '2.0'
-var defaultOptions = require('./defaults')
+const Hoek = require('hoek')
+const Joi = require('joi')
+const Schema = require('./schema')
+const utils = require('./utils')
+
+const SWAGGER_VERSION = '2.0'
+const defaultOptions = require('./defaults')
 
 module.exports.register = function (plugin, options, next) {
-  var settings = Hoek.applyToDefaults(defaultOptions, options)
+  const settings = Hoek.applyToDefaults(defaultOptions, options)
   Joi.assert(options, Schema.PluginOptions)
-  var routeConfig = utils.getRoutesModifiers(plugin)
+  const routeConfig = utils.getRoutesModifiers(plugin)
   settings.pluginRoutePrefix = routeConfig.route.prefix || ''
 
-  var internals = {
+  const internals = {
     resources: require('./resources'),
-    keyGenerator: function (request) {
-      var requestConnection = utils.getRequestConnection(request)
-      return 'hapi-swaggered:' + requestConnection.info.uri + ':' + request.url.path
+    keyGenerator (request) {
+      const requestConnection = utils.getRequestConnection(request)
+      return `hapi-swaggered:${requestConnection.info.uri}:${request.url.path}`
     }
   }
 
-  var methods = {
-    resources: function (request, reply) {
-      var requestConnection = utils.getRequestConnection(request)
-      var serverSettings = Hoek.reach(requestConnection, 'settings.app.swagger')
-      var currentSettings = utils.getCurrentSettings(settings, serverSettings)
-      var resources = internals.resources(currentSettings, requestConnection.table(), request.query.tags)
+  const methods = {
+    resources (request, reply) {
+      const requestConnection = utils.getRequestConnection(request)
+      const serverSettings = Hoek.reach(requestConnection, 'settings.app.swagger')
+      const currentSettings = utils.getCurrentSettings(settings, serverSettings)
+      const resources = internals.resources(currentSettings, requestConnection.table(), request.query.tags)
 
-      var data = {
+      const data = {
         swagger: SWAGGER_VERSION,
         schemes: currentSettings.schemes,
         externalDocs: currentSettings.externalDocs,
@@ -48,7 +50,7 @@ module.exports.register = function (plugin, options, next) {
     }
   }
 
-  var resourcesGenerator = methods.resources
+  let resourcesGenerator = methods.resources
 
   if (settings.cache !== false) {
     plugin.method('resources', resourcesGenerator, {
@@ -59,14 +61,14 @@ module.exports.register = function (plugin, options, next) {
     resourcesGenerator = plugin.methods.resources
   }
 
-  var handler = {
-    resources: function (request, reply) {
-      return resourcesGenerator(request, function (error, data) {
+  const handler = {
+    resources (request, reply) {
+      return resourcesGenerator(request, (error, data) => {
         Hoek.assert(!error, 'swagger-resource generation failed')
 
-        var requestConnection = utils.getRequestConnection(request)
-        var serverSettings = Hoek.reach(requestConnection, 'settings.app.swagger')
-        var currentSettings = utils.getCurrentSettings(settings, serverSettings)
+        const requestConnection = utils.getRequestConnection(request)
+        const serverSettings = Hoek.reach(requestConnection, 'settings.app.swagger')
+        const currentSettings = utils.getCurrentSettings(settings, serverSettings)
         data.host = currentSettings.host
 
         return reply(data)