feat(message): add metadata schema path

lykmapipo · Feb 25, 2020 · 407349f · 407349f
1 parent f7c1f8c
commit 407349f
Show file tree

Hide file tree

Showing 2 changed files with 28 additions and 1 deletion.
diff --git a/lib/message.model.js b/lib/message.model.js
@@ -608,8 +608,23 @@ const MessageSchema = new Schema(
       },
     },
 
+    /**
+     * @name metadata
+     * @description Application specific additional information for the message.
+     * @type {Object}
+     * @since 0.18.0
+     * @version 1.0.0
+     * @instance
+     */
+    metadata: {
+      type: Mixed,
+      fake: {
+        generator: 'helpers',
+        type: 'createTransaction',
+      },
+    },
+
     // template: String|Predefine, //template used for sending
-    // metadata: Mixed, //extra message data
   },
   SCHEMA_OPTIONS
 );

diff --git a/test/unit/message.schema.spec.js b/test/unit/message.schema.spec.js
@@ -378,4 +378,16 @@ describe('Message Schema', () => {
     expect(options.options.type.name).to.be.equal('Mixed');
     expect(options.options.fake).to.exist;
   });
+
+  it('should have metadata field', function() {
+    const metadata = Message.path('metadata');
+
+    expect(metadata).to.exist;
+    expect(metadata).to.be.an.instanceof(SchemaTypes.Mixed);
+    expect(metadata.instance).to.be.equal('Mixed');
+    expect(metadata).to.be.an('object');
+    expect(metadata.options.type).to.be.a('function');
+    expect(metadata.options.type.name).to.be.equal('Mixed');
+    expect(metadata.options.fake).to.exist;
+  });
 });