models: move Email LDL def into `email.json`

common/models/email.js

@@ -1,57 +1,50 @@
-/*!
- * Module Dependencies.
- */
-
-var Model = require('../../lib/loopback').Model
-  , loopback = require('../../lib/loopback');
-
-var properties = {
-  to: {type: String, required: true},
-  from: {type: String, required: true},
-  subject: {type: String, required: true},
-  text: {type: String},
-  html: {type: String}
-};
-
 /**
  * @property {String} to Email addressee.  Required.
  * @property {String} from Email sender address.  Required.
  * @property {String} subject Email subject string.  Required.
- * @property {String} text Text body of email.  
+ * @property {String} text Text body of email.
  * @property {String} html HTML body of email.
- * 
- * @class
+ *
+ * @class Email
  * @inherits {Model}
  */
 
-var Email = module.exports = Model.extend('Email', properties);
+module.exports = function(Email) {
 
-/**
- * Send an email with the given `options`.
- *
- * Example Options:
- *
- * ```js
- * {
- *   from: "Fred Foo <foo@blurdybloop.com>", // sender address
- *   to: "bar@blurdybloop.com, baz@blurdybloop.com", // list of receivers
- *   subject: "Hello", // Subject line
- *   text: "Hello world", // plaintext body
- *   html: "<b>Hello world</b>" // html body
- * }
- * ```
- *
- * See https://github.com/andris9/Nodemailer for other supported options.
- *
- * @options {Object} options See below
- * @prop {String} from Senders's email address
- * @prop {String} to List of one or more recipient email addresses (comma-delimited)
- * @prop {String} subject Subject line
- * @prop {String} text Body text
- * @prop {String} html Body HTML (optional)
- * @param {Function} callback Called after the e-mail is sent or the sending failed
- */
+  /**
+   * Send an email with the given `options`.
+   *
+   * Example Options:
+   *
+   * ```js
+   * {
+   *   from: "Fred Foo <foo@blurdybloop.com>", // sender address
+   *   to: "bar@blurdybloop.com, baz@blurdybloop.com", // list of receivers
+   *   subject: "Hello", // Subject line
+   *   text: "Hello world", // plaintext body
+   *   html: "<b>Hello world</b>" // html body
+   * }
+   * ```
+   *
+   * See https://github.com/andris9/Nodemailer for other supported options.
+   *
+   * @options {Object} options See below
+   * @prop {String} from Senders's email address
+   * @prop {String} to List of one or more recipient email addresses (comma-delimited)
+   * @prop {String} subject Subject line
+   * @prop {String} text Body text
+   * @prop {String} html Body HTML (optional)
+   * @param {Function} callback Called after the e-mail is sent or the sending failed
+   */
 
-Email.prototype.send = function() {
-  throw new Error('You must connect the Email Model to a Mail connector');
-}
+  Email.send = function() {
+    throw new Error('You must connect the Email Model to a Mail connector');
+  };
+
+  /**
+   * A shortcut for Email.send(this).
+   */
+  Email.prototype.send = function() {
+    throw new Error('You must connect the Email Model to a Mail connector');
+  };
+};

common/models/email.json

@@ -0,0 +1,11 @@
+{
+  "name": "Email",
+  "base": "Model",
+  "properties": {
+    "to": {"type": "String", "required": true},
+    "from": {"type": "String", "required": true},
+    "subject": {"type": "String", "required": true},
+    "text": {"type": "String"},
+    "html": {"type": "String"}
+  }
+}

lib/builtin-models.js

@@ -1,7 +1,9 @@
 module.exports = function(loopback) {
   // NOTE(bajtos) we must use static require() due to browserify limitations
 
-  loopback.Email = require('../common/models/email');
+  loopback.Email = createModel(
+    require('../common/models/email.json'),
+    require('../common/models/email.js'));
 
   loopback.Application = require('../common/models/application');
   loopback.AccessToken = require('../common/models/access-token');