Merge pull request #27 from voxmedia/mc-remove-internal-exports

Remove private exports

.gitignore

@@ -1,4 +1,5 @@
 .grunt
+.vscode
 build
 lib-cov
 coverage

README.md

@@ -104,6 +104,7 @@ convert(delta, formats, { blockTag: 'FIGURE', inlineTag: 'INS' });
 
 ## Changelog
 
+- `6.0.0` Remove the `toInternalHtml` method. Also remove the private formats and internal-specific outputs that used to support `toInternalHtml`.
 - `5.5.0` Add support for data params in doc component
 - `5.4.1` Update dev dependencies to address security vulnerabilities
 - `5.4.0` Update jsdom and lodash dependencies

browser.js

@@ -1,6 +1,5 @@
 var toHtml = require('./lib/export/to_html');
 var toInlineHtml = require('./lib/export/to_inline_html');
-var toInternalHtml = require('./lib/export/to_internal_html');
 var toPublicHtml = require('./lib/export/to_public_html');
 var toPlaintext = require('./lib/export/to_plaintext');
 
@@ -13,10 +12,6 @@ module.exports = {
     options = Object.assign({}, options, { document: document });
     return toInlineHtml(delta, formats, options);
   },
-  toInternalHtml: function(delta, formats, options) {
-    options = Object.assign({}, options, { document: document });
-    return toInternalHtml(delta, formats, options);
-  },
   toPublicHtml: function(delta, formats, options) {
     options = Object.assign({}, options, { document: document });
     return toPublicHtml(delta, formats, options);

index.js

@@ -1,7 +1,6 @@
 var JSDOM = require('jsdom').JSDOM;
 var toHtml = require('./lib/export/to_html');
 var toInlineHtml = require('./lib/export/to_inline_html');
-var toInternalHtml = require('./lib/export/to_internal_html');
 var toPublicHtml = require('./lib/export/to_public_html');
 var toPlaintext = require('./lib/export/to_plaintext');
 
@@ -14,10 +13,6 @@ module.exports = {
     options = Object.assign({}, options, { document: new JSDOM().window.document });
     return toInlineHtml(delta, formats, options);
   },
-  toInternalHtml: function(delta, formats, options) {
-    options = Object.assign({}, options, { document: new JSDOM().window.document });
-    return toInternalHtml(delta, formats, options);
-  },
   toPublicHtml: function(delta, formats, options) {
     options = Object.assign({}, options, { document: new JSDOM().window.document });
     return toPublicHtml(delta, formats, options);

lib/export/to_public_html.js

@@ -1,7 +1,7 @@
 var pick = require('lodash').pick;
 var toHtml = require('./to_html');
-var publicFormats = require('../formats').public;
-var formatOptions = require('../formats').options;
+var publicFormats = require('../formats');
+var formatOptions = require('../formats/format_options');
 
 module.exports = function toPublicHtml(delta, formats, options) {
   formats = formats ? pick(publicFormats, formats) : publicFormats;

lib/formats/actionbox.js

@@ -1,4 +1,4 @@
-exports.public = {
+module.exports = {
   add: function(node, value, dom) {
     dom(node.parentNode).switchTag('ASIDE');
 
@@ -17,5 +17,3 @@ exports.public = {
     return div;
   }
 };
-
-exports.private = require('./object')('actionbox');

lib/formats/ad_placement.js

@@ -1,9 +1,4 @@
-exports.private = {
-  type: 'line',
-  attribute: 'data-ad-placement-anchor'
-};
-
-exports.public = {
+module.exports = {
   type: 'line',
   add: function(node, value) {
     // add the attribute to the top-most wrapper div

lib/formats/autolink.js

@@ -1,40 +1,6 @@
-var addLink = require('./link').public.add;
+var addLink = require('./link').add;
 
-exports.private = {
-  add: function(node, value, dom) {
-    if (node.nodeType !== Node.ELEMENT_NODE) {
-      var span = node.ownerDocument.createElement('span');
-      dom(node).wrap(span);
-      node = span;
-    }
-    node.setAttribute('data-autolink-id', value.id);
-    node.setAttribute('data-autolink-href', value.href);
-    if (value.disabled) {
-      node.setAttribute('data-autolink-disabled', '');
-    } else {
-      node.removeAttribute('data-autolink-disabled');
-    }
-    return node;
-  },
-  remove: function(node) {
-    node.removeAttribute('data-autolink-id');
-    node.removeAttribute('data-autolink-href');
-    node.removeAttribute('data-autolink-disabled');
-    return node;
-  },
-  value: function(node) {
-    return {
-      id: node.getAttribute('data-autolink-id'),
-      href: node.getAttribute('data-autolink-href'),
-      disabled: node.hasAttribute('data-autolink-disabled')
-    };
-  },
-  match: function(node) {
-    return node.hasAttribute('data-autolink-id');
-  }
-};
-
-exports.public = {
+module.exports = {
   add: function(node, value, dom) {
     if (!value.disabled) {
       node = addLink(node, value.href, dom);

lib/formats/blockquote.js

@@ -1,4 +1 @@
-var blockquote = { type: 'line', parentTag: 'BLOCKQUOTE' };
-
-exports.public = blockquote;
-exports.private = Object.assign({}, blockquote, { exclusive: true, inherit: true });
+module.exports = { type: 'line', parentTag: 'BLOCKQUOTE' };

lib/formats/bold.js

@@ -1,4 +1 @@
-var bold = { tag: 'STRONG' };
-
-exports.public = bold;
-exports.private = Object.assign({}, bold, { prepare: 'bold' });
+module.exports = { tag: 'STRONG' };

lib/formats/br.js

@@ -1,27 +1,8 @@
-exports.private = {
-  type: 'line',
-  reverseMerge: true,
-  add: function(node) {
-    node.classList.add('soft-break');
-    return node;
-  },
-  remove: function(node) {
-    node.classList.remove('soft-break');
-    return node;
-  },
-  value: function(node) {
-    return node.classList.contains('soft-break');
-  },
-  match: function(node) {
-    return node.classList.contains('soft-break');
-  }
-};
-
 // All lines that end with a line-break will end with a <br> tag. `to_unison_html`
 // post-processing will strip out extra <p> tags b/t lines after the fact.
 //
 // Ex. <p>Hello<br></p><p>world!</p> => <p>Hello<br>world!</p>
-exports.public = {
+module.exports = {
   type: 'line',
   add: function(node) {
     var br = node.ownerDocument.createElement('br');

lib/formats/bullet.js

@@ -1,4 +1 @@
-var bullet = { type: 'line', parentTag: 'UL', tag: 'LI' };
-
-exports.public = bullet;
-exports.private = Object.assign({}, bullet, { exclusive: true, inherit: true });
+module.exports = { type: 'line', parentTag: 'UL', tag: 'LI' };

lib/formats/credits.js

@@ -1,4 +1,4 @@
-exports.public = {
+module.exports = {
   add: function(node, value, dom) {
     dom(node.parentNode).switchTag('ASIDE');
     var div = node.ownerDocument.createElement('div');
@@ -9,5 +9,3 @@ exports.public = {
     return div;
   }
 };
-
-exports.private = require('./object')('credits');

lib/formats/del.js

@@ -1,3 +1 @@
-exports.private = exports.public = {
-  tag: 'DEL'
-};
+module.exports = { tag: 'DEL' };

lib/formats/doc.js

@@ -1,4 +1,4 @@
-exports.public = {
+module.exports = {
   add: function(node, value, dom) {
     dom(node.parentNode).switchTag('div');
 
@@ -15,5 +15,3 @@ exports.public = {
     return div;
   }
 };
-
-exports.private = require('./object')('doc');

lib/formats/dropcap.js

@@ -1,23 +1,4 @@
-exports.private = {
-  type: 'line',
-  splitAffinity: 'left',
-  add: function(node, value) {
-    node.setAttribute('data-dropcap', value.toString());
-    return node;
-  },
-  remove: function(node) {
-    node.removeAttribute('data-dropcap');
-    return node;
-  },
-  value: function(node) {
-    return node.dataset.dropcap === 'true';
-  },
-  match: function(node) {
-    return node.tagName === 'P' && node.hasAttribute('data-dropcap');
-  }
-};
-
-exports.public = {
+module.exports = {
   type: 'line',
   add: function(node, value) {
     if (value) {

lib/formats/endmark.js

@@ -1,23 +1,4 @@
-exports.private = {
-  type: 'line',
-  splitAffinity: 'right',
-  add: function(node, value) {
-    node.setAttribute('data-endmark', value.toString());
-    return node;
-  },
-  remove: function(node) {
-    node.removeAttribute('data-endmark');
-    return node;
-  },
-  value: function(node) {
-    return node.dataset.endmark === 'true';
-  },
-  match: function(node) {
-    return node.tagName === 'P' && node.hasAttribute('data-endmark');
-  }
-};
-
-exports.public = {
+module.exports = {
   type: 'line',
   add: function(node, value) {
     if (value) {

lib/formats/fifthheader.js

@@ -1,4 +1 @@
-var fifthheader = { type: 'line', tag: 'H5' };
-
-exports.public = fifthheader;
-exports.private = Object.assign({}, fifthheader, { exclusive: true });
+module.exports = { type: 'line', tag: 'H5' };

lib/formats/firstheader.js

@@ -1,4 +1 @@
-var firstheader = { type: 'line', tag: 'H1' };
-
-exports.public = firstheader;
-exports.private = Object.assign({}, firstheader, { exclusive: true });
+module.exports = { type: 'line', tag: 'H1' };

lib/formats/format_options.js

@@ -0,0 +1,56 @@
+module.exports = {
+  blockTag: 'P',
+  formatOrder: [
+    // inline: wrapper tag
+    'bold',
+    'italic',
+    'mark',
+    'small',
+    'strike',
+    'superscript',
+    'subscript',
+    'autolink',
+    'link', // links come last so that they can merge sibling nodes
+
+    // objects
+    'actionbox',
+    'credits',
+    'doc',
+    'hr',
+    'html',
+    'image',
+    'oembed',
+    'pullquote',
+    'ratingcard',
+    'newsletter',
+    'readmore',
+    'video',
+    'toh_project_details',
+    'toh_tools',
+    'pym',
+
+    // line: wrapper tag
+    'position',
+    'grouping',
+    'blockquote',
+
+    // line: wrapper tag + switch tag
+    'bullet',
+    'list',
+
+    // line: switch tag
+    'firstheader',
+    'secondheader',
+    'thirdheader',
+    'fourthheader',
+    'fifthheader',
+
+    // line: add classes / attributes
+    'dropcap',
+    'leadgraf',
+    'endmark',
+    'ad_placement',
+    'br',
+    'id'
+  ]
+};

lib/formats/fourthheader.js

@@ -1,4 +1 @@
-var fourthheader = { type: 'line', tag: 'H4' };
-
-exports.public = fourthheader;
-exports.private = Object.assign({}, fourthheader, { exclusive: true });
+module.exports = { type: 'line', tag: 'H4' };

lib/formats/grouping.js

@@ -1,9 +1,4 @@
-exports.private = {
-  type: 'line',
-  attribute: 'data-grouping'
-};
-
-exports.public = {
+module.exports = {
   type: 'line',
   add: function(node, value, dom) {
     // Create the image grid container with appropriate classes

lib/formats/hr.js

@@ -1,9 +1,7 @@
-exports.public = {
+module.exports = {
   add: function(node, value, dom) {
     var hr = dom(node.parentNode).switchTag('hr').get();
     hr.classList.add('p-entry-hr');
     return hr;
   }
 };
-
-exports.private = require('./object')('hr');

lib/formats/html.js

@@ -1,4 +1,4 @@
-exports.public = {
+module.exports = {
   add: function(node, value, dom) {
     var temp = node.ownerDocument.createElement('div');
     temp.innerHTML = value.value;
@@ -19,5 +19,3 @@ exports.public = {
     return frag;
   }
 };
-
-exports.private = require('./object')('html');

lib/formats/id.js

@@ -1,9 +1,4 @@
-exports.private = {
-  type: 'line',
-  attribute: 'id'
-};
-
-exports.public = {
+module.exports = {
   type: 'line',
   add: function(node, value) {
     if (!node.id) {

lib/formats/image.js

@@ -1,4 +1,4 @@
-exports.public = {
+module.exports = {
   add: function(node, value, dom) {
     var doc = node.ownerDocument;
     dom(node.parentNode).switchTag('figure');
@@ -29,5 +29,3 @@ exports.public = {
     return frag;
   }
 };
-
-exports.private = require('./object')('image');