feat(core): add serializeSync method

Author: patricksmms

packages/core/CHANGELOG.md

@@ -1,5 +1,11 @@
 # API Elements: Core
 
+## 0.2.1 (2020-08-27)
+
+### Enhancements
+
+Added `serializeSync` method to Fury.
+
 ## 0.2.0 (2020-08-05)
 
 This package updates the version of `api-elements` being used. See

packages/core/lib/fury.js

@@ -80,6 +80,18 @@ const findAdapter = (adapters, mediaType, method) => {
  * @memberof FuryAdapter
  */
 
+/**
+ * @function serializeSync
+ *
+ * @param {Object} options
+ * @param {Category} options.api
+ * @param {Namespace} options.namespace
+ *
+ * @returns {(String|null)}
+ *
+ * @memberof FuryAdapter
+ */
+
 /**
  */
 class Fury {
@@ -244,6 +256,33 @@ class Fury {
     return promise;
   }
 
+  /**
+   * Serialize synchronously an API Description into the given output format.
+   *
+   * @param {Object} options
+   * @param {Category} options.api
+   * @param {string} [options.mediaType]
+   */
+  serializeSync({ api, mediaType = 'text/vnd.apiblueprint' }) {
+    const adapter = findAdapter(this.adapters, mediaType, 'serialize');
+
+    if (!adapter) {
+      // eslint-disable-next-line no-console
+      console.warn('Media type did not match any registered serializer!');
+
+      return null;
+    }
+
+    if (!api) {
+      // eslint-disable-next-line no-param-reassign
+      api = new this.minim.elements.Category();
+    }
+
+    return adapter.serialize({
+      api, namespace: this.minim, mediaType, sync: true,
+    });
+  }
+
   /**
    * @callback SerializeCallback
    *
@@ -252,7 +291,7 @@ class Fury {
    */
 
   /**
-   * Serialize an API Description into the given output format.
+   * Serialize asynchronously an API Description into the given output format.
    *
    * @param {Object} options
    * @param {Category} options.api
@@ -278,7 +317,9 @@ class Fury {
       api = new this.minim.elements.Category();
     }
 
-    const promise = adapter.serialize({ api, namespace: this.minim, mediaType });
+    const promise = adapter.serialize({
+      api, namespace: this.minim, mediaType, sync: false,
+    });
 
     if (done) {
       promise.then(result => done(null, result), done);

packages/core/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@apielements/core",
-  "version": "0.2.0",
+  "version": "0.2.1",
   "description": "API Description SDK",
   "author": "Apiary.io <[email protected]>",
   "license": "MIT",

packages/core/test/serialize-test.js

@@ -108,4 +108,28 @@ describe('Serialize', () => {
       expect(result).to.equal('{"element":"category"}');
     });
   });
+
+  describe('using serializeSync', () => {
+    it('returns null with unknown mediaType', () => {
+      const fury = new Fury();
+      const api = new fury.minim.elements.Category();
+
+      const result = fury.serializeSync({ api, mediaType: 'application/unregistered' });
+      expect(result).to.equal(null);
+    });
+
+    it('can serialize with matching adapter', async () => {
+      const fury = new Fury();
+      fury.use({
+        name: 'json',
+        mediaTypes: ['application/json'],
+        serialize: ({ api, namespace }) => JSON.stringify(namespace.serialiser.serialise(api)),
+      });
+
+      const api = new fury.minim.elements.Category();
+
+      const result = fury.serializeSync({ api, mediaType: 'application/json' });
+      expect(result).to.equal('{"element":"category"}');
+    });
+  });
 });

packages/form-serializer/CHANGELOG.md

@@ -1,5 +1,11 @@
 # Form Serializer Changelog
 
+## 0.1.3 (2020-08-27)
+
+### Enhancements
+
+- Enable synchronous serialization.
+
 ## 0.1.2 (2020-08-19)
 
 ### Enhancements

packages/form-serializer/lib/adapter.js

@@ -3,7 +3,11 @@ const serializeForm = require('./serializeForm');
 const name = 'form';
 const mediaTypes = ['multipart/form-data', 'application/x-www-form-urlencoded'];
 
-function serialize({ api, mediaType }) {
+function serialize({ api, mediaType, sync }) {
+  if (sync) {
+    return serializeForm({ api, mediaType });
+  }
+
   return new Promise(resolve => resolve(serializeForm({ api, mediaType })));
 }
 

packages/form-serializer/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@apielements/form-serializer",
-  "version": "0.1.2",
+  "version": "0.1.3",
   "description": "Multipart/form-data serializer for API Elements",
   "author": "Apiary.io <[email protected]>",
   "license": "MIT",

packages/form-serializer/test/adapter-test.js

@@ -19,7 +19,7 @@ describe('Form Serializer Adapter', () => {
       expect(adapter.mediaTypes).to.include('multipart/form-data');
     });
 
-    it('can serialize an object element', (done) => {
+    it('can serialize an object element asynchronously', (done) => {
       const element = new fury.minim.elements.Object({ message: 'Hello world' });
 
       fury.serialize({ api: element, mediaType: 'multipart/form-data' }, (error, result) => {
@@ -29,7 +29,14 @@ describe('Form Serializer Adapter', () => {
       });
     });
 
-    it('can serialize a string element', (done) => {
+    it('can serialize an object element synchronously', () => {
+      const element = new fury.minim.elements.Object({ message: 'Hello world' });
+      const result = fury.serializeSync({ api: element, mediaType: 'multipart/form-data' });
+
+      expect(result).to.equal('--BOUNDARY\r\nContent-Disposition: form-data; name="message"\r\n\r\nHello world\r\n--BOUNDARY--\r\n');
+    });
+
+    it('can serialize a string element asynchronously', (done) => {
       const element = new fury.minim.elements.String('Hello world');
 
       fury.serialize({ api: element, mediaType: 'multipart/form-data' }, (error, result) => {
@@ -38,6 +45,13 @@ describe('Form Serializer Adapter', () => {
         done();
       });
     });
+
+    it('can serialize a string element synchronously', () => {
+      const element = new fury.minim.elements.String('Hello world');
+      const result = fury.serializeSync({ api: element, mediaType: 'multipart/form-data' });
+
+      expect(result).to.equal('--BOUNDARY\r\nContent-Disposition: form-data; name="undefined"\r\n\r\nHello world\r\n--BOUNDARY--\r\n');
+    });
   });
 
   describe('Application/x-www-form-urlencoded mediaType', () => {
@@ -49,7 +63,7 @@ describe('Form Serializer Adapter', () => {
       expect(adapter.mediaTypes).to.include('application/x-www-form-urlencoded');
     });
 
-    it('can serialize an object element', (done) => {
+    it('can serialize an object element asynchronoulsy', (done) => {
       const element = new fury.minim.elements.Object({ message: 'Hello world' });
 
       fury.serialize({ api: element, mediaType: 'application/x-www-form-urlencoded' }, (error, result) => {
@@ -59,7 +73,14 @@ describe('Form Serializer Adapter', () => {
       });
     });
 
-    it('can serialize a string element', (done) => {
+    it('can serialize an object element synchronoulsy', () => {
+      const element = new fury.minim.elements.Object({ message: 'Hello world' });
+      const result = fury.serializeSync({ api: element, mediaType: 'application/x-www-form-urlencoded' });
+
+      expect(result).to.equal('message=Hello%20world');
+    });
+
+    it('can serialize a string element asynchronously', (done) => {
       const element = new fury.minim.elements.String('Hello world');
 
       fury.serialize({ api: element, mediaType: 'application/x-www-form-urlencoded' }, (error, result) => {
@@ -68,5 +89,12 @@ describe('Form Serializer Adapter', () => {
         done();
       });
     });
+
+    it('can serialize a string element synchronously', () => {
+      const element = new fury.minim.elements.String('Hello world');
+      const result = fury.serializeSync({ api: element, mediaType: 'application/x-www-form-urlencoded' });
+
+      expect(result).to.equal('undefined=Hello%20world');
+    });
   });
 });

packages/json-serializer/CHANGELOG.md

@@ -1,5 +1,11 @@
 # JSON Serializer Changelog
 
+## 0.1.4 (2020-08-27)
+
+### Enhancements
+
+- Enable synchronous serialization.
+
 ## 0.1.3 (2020-08-20)
 
 ### Enhancements

packages/json-serializer/lib/adapter.js

@@ -5,7 +5,11 @@ const mediaTypes = [
   'application/json',
 ];
 
-function serialize({ api }) {
+function serialize({ api, sync }) {
+  if (sync) {
+    return serializeJSON(api);
+  }
+
   return new Promise(resolve => resolve(serializeJSON(api)));
 }