Add support for iface type

addon/utils/prop-types.js

@@ -209,6 +209,36 @@ PropTypes.shape = function (typeDefs, options) {
   return type
 }
 
+PropTypes.iface = function (typeDefs, options) {
+  const type = generateType('iface')
+
+  if (typeOf(typeDefs) === 'object') {
+    Object.keys(typeDefs)
+      .forEach((key) => {
+        typeDefs[key] = getDef(typeDefs[key])
+      })
+  }
+
+  type.typeDefs = typeDefs
+
+  if (typeOf(options) !== 'object') {
+    type.isRequired.typeDefs = type.typeDefs
+    return type
+  }
+
+  delete type.isRequired
+
+  if ('required' in options) {
+    type.required = options.required
+  }
+
+  if (options.updatable === false) {
+    type.updatable = false
+  }
+
+  return type
+}
+
 export default PropTypes
 export {validators}
 export {logger}

addon/utils/validators/iface.js

@@ -0,0 +1,54 @@
+/**
+ * The PropTypes.iface validator
+ */
+
+import Ember from 'ember'
+const {get, typeOf} = Ember
+
+import logger from '../logger'
+
+/* eslint-disable complexity */
+export default function (validators, ctx, name, value, def, logErrors, throwErrors) {
+  const typeDefs = def.typeDefs
+  let msg = `Expected property ${name} to match given interface`
+  let iface
+  try {
+    iface = JSON.stringify(value, null, ' ')
+    msg = `${msg}, but instead got value ${iface}`
+  } catch (e) {}
+
+  if (typeOf(typeDefs) !== 'object') {
+    logger.warn(ctx, 'PropTypes.iface() requires a plain object to be be passed in as an argument', throwErrors)
+    return false
+  }
+
+  // allow POJOs as well as Ember Object instances for greater flexibility
+  if (typeOf(value) !== 'object' && typeOf(value) !== 'instance') {
+    logger.warn(ctx, msg, throwErrors)
+    return false
+  }
+
+  let valid = Object.keys(typeDefs).every((key) => {
+    const typeDef = typeDefs[key]
+
+    const objectValue = get(value, key)
+    if (objectValue === undefined) {
+      if (!typeDef.required) {
+        return true
+      } else {
+        if (logErrors) {
+          logger.warn(ctx, `Property ${name} is missing required property ${key}`, throwErrors)
+        }
+        return false
+      }
+    }
+
+    return validators[typeDef.type](ctx, `${name}.${key}`, objectValue, typeDef, logErrors, throwErrors)
+  })
+
+  if (!valid && logErrors) {
+    logger.warn(ctx, msg, throwErrors)
+  }
+
+  return valid
+}

addon/utils/validators/index.js

@@ -9,6 +9,7 @@ import element from './element'
 import emberComponent from './ember-component'
 import emberObject from './ember-object'
 import func from './func'
+import iface from './iface'
 import instanceOf from './instance-of'
 import nullFn from './null'
 import number from './number'
@@ -43,6 +44,7 @@ const validators = {
 
 objectAssign(validators, {
   arrayOf: arrayOf.bind(this, validators),
+  iface: iface.bind(this, validators),
   oneOfType: oneOfType.bind(this, validators),
   shape: shape.bind(this, validators)
 })