chordsheetjs 6.1.0 → 6.3.0

package/lib/formatter/chord_pro_formatter.js

@@ -1,184 +0,0 @@
-"use strict";
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports["default"] = void 0;
-
-var _tag = _interopRequireDefault(require("../chord_sheet/tag"));
-
-var _chord_lyrics_pair = _interopRequireDefault(require("../chord_sheet/chord_lyrics_pair"));
-
-var _ternary = _interopRequireDefault(require("../chord_sheet/chord_pro/ternary"));
-
-var _literal = _interopRequireDefault(require("../chord_sheet/chord_pro/literal"));
-
-function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { "default": obj }; }
-
-function _classCallCheck(instance, Constructor) { if (!(instance instanceof Constructor)) { throw new TypeError("Cannot call a class as a function"); } }
-
-function _defineProperties(target, props) { for (var i = 0; i < props.length; i++) { var descriptor = props[i]; descriptor.enumerable = descriptor.enumerable || false; descriptor.configurable = true; if ("value" in descriptor) descriptor.writable = true; Object.defineProperty(target, descriptor.key, descriptor); } }
-
-function _createClass(Constructor, protoProps, staticProps) { if (protoProps) _defineProperties(Constructor.prototype, protoProps); if (staticProps) _defineProperties(Constructor, staticProps); Object.defineProperty(Constructor, "prototype", { writable: false }); return Constructor; }
-
-var NEW_LINE = '\n';
-/**
- * Formats a song into a ChordPro chord sheet
- */
-
-var ChordProFormatter = /*#__PURE__*/function () {
-  /**
-   * Instantiate
-   * @param {Object} options options
-   * @param {boolean} options.evaluate Whether or not to evaluate meta expressions. For more info about meta
-   * expression, see: https://bit.ly/2SC9c2u
-   */
-  function ChordProFormatter() {
-    var _ref = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : {},
-        _ref$evaluate = _ref.evaluate,
-        evaluate = _ref$evaluate === void 0 ? false : _ref$evaluate;
-
-    _classCallCheck(this, ChordProFormatter);
-
-    this.evaluate = evaluate === true;
-  }
-  /**
-   * Formats a song into a ChordPro chord sheet.
-   * @param {Song} song The song to be formatted
-   * @returns {string} The ChordPro string
-   */
-
-
-  _createClass(ChordProFormatter, [{
-    key: "format",
-    value: function format(song) {
-      var _this = this;
-
-      var lines = song.lines,
-          metadata = song.metadata;
-      return lines.map(function (line) {
-        return _this.formatLine(line, metadata);
-      }).join(NEW_LINE);
-    }
-  }, {
-    key: "formatLine",
-    value: function formatLine(line, metadata) {
-      var _this2 = this;
-
-      return line.items.map(function (item) {
-        return _this2.formatItem(item, metadata);
-      }).join('');
-    }
-  }, {
-    key: "formatItem",
-    value: function formatItem(item, metadata) {
-      if (item instanceof _tag["default"]) {
-        return this.formatTag(item);
-      }
-
-      if (item instanceof _chord_lyrics_pair["default"]) {
-        return this.formatChordLyricsPair(item);
-      }
-
-      if (typeof item.evaluate === 'function') {
-        return this.formatOrEvaluateItem(item, metadata);
-      }
-
-      throw new Error("Don't know how to format a ".concat(item.constructor.name));
-    }
-  }, {
-    key: "formatOrEvaluateItem",
-    value: function formatOrEvaluateItem(item, metadata) {
-      if (this.evaluate) {
-        return item.evaluate(metadata);
-      }
-
-      if (item instanceof _ternary["default"]) {
-        return this.formatTernary(item);
-      }
-
-      if (item instanceof _literal["default"]) {
-        return item.evaluate();
-      }
-
-      throw new Error("Don't know how to format a ".concat(item.constructor.name));
-    }
-  }, {
-    key: "formatTernary",
-    value: function formatTernary(ternary) {
-      var variable = ternary.variable,
-          valueTest = ternary.valueTest,
-          trueExpression = ternary.trueExpression,
-          falseExpression = ternary.falseExpression;
-      return ['%{', variable || '', this.formatValueTest(valueTest), this.formatExpressionRange(trueExpression), this.formatExpressionRange(falseExpression), '}'].join('');
-    }
-  }, {
-    key: "formatValueTest",
-    value: function formatValueTest(valueTest) {
-      if (!valueTest) {
-        return '';
-      }
-
-      return "=".concat(valueTest);
-    }
-  }, {
-    key: "formatExpressionRange",
-    value: function formatExpressionRange(expressionRange) {
-      var _this3 = this;
-
-      if (!expressionRange) {
-        return '';
-      }
-
-      return "|".concat(expressionRange.map(function (expression) {
-        return _this3.formatExpression(expression);
-      }).join(''));
-    }
-  }, {
-    key: "formatExpression",
-    value: function formatExpression(expression) {
-      if (expression instanceof _ternary["default"]) {
-        return this.formatTernary(expression);
-      }
-
-      if (expression instanceof _literal["default"]) {
-        return expression.string;
-      }
-
-      return '';
-    }
-  }, {
-    key: "formatTag",
-    value: function formatTag(tag) {
-      if (tag.hasValue()) {
-        return "{".concat(tag.originalName, ": ").concat(tag.value, "}");
-      }
-
-      return "{".concat(tag.originalName, "}");
-    }
-  }, {
-    key: "formatChordLyricsPair",
-    value: function formatChordLyricsPair(chordLyricsPair) {
-      return [this.formatChordLyricsPairChords(chordLyricsPair), this.formatChordLyricsPairLyrics(chordLyricsPair)].join('');
-    }
-  }, {
-    key: "formatChordLyricsPairChords",
-    value: function formatChordLyricsPairChords(chordLyricsPair) {
-      if (chordLyricsPair.chords) {
-        return "[".concat(chordLyricsPair.chords, "]");
-      }
-
-      return '';
-    }
-  }, {
-    key: "formatChordLyricsPairLyrics",
-    value: function formatChordLyricsPairLyrics(chordLyricsPair) {
-      return chordLyricsPair.lyrics || '';
-    }
-  }]);
-
-  return ChordProFormatter;
-}();
-
-var _default = ChordProFormatter;
-exports["default"] = _default;

package/lib/formatter/html_div_formatter.js

@@ -1,130 +0,0 @@
-"use strict";
-
-function _typeof(obj) { "@babel/helpers - typeof"; return _typeof = "function" == typeof Symbol && "symbol" == typeof Symbol.iterator ? function (obj) { return typeof obj; } : function (obj) { return obj && "function" == typeof Symbol && obj.constructor === Symbol && obj !== Symbol.prototype ? "symbol" : typeof obj; }, _typeof(obj); }
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports["default"] = void 0;
-
-var _handlebars = _interopRequireDefault(require("handlebars"));
-
-require("../template_helpers");
-
-var _html_formatter = _interopRequireDefault(require("./html_formatter"));
-
-require("./templates/html_div_formatter");
-
-var _utilities = require("../utilities");
-
-function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { "default": obj }; }
-
-function _classCallCheck(instance, Constructor) { if (!(instance instanceof Constructor)) { throw new TypeError("Cannot call a class as a function"); } }
-
-function _defineProperties(target, props) { for (var i = 0; i < props.length; i++) { var descriptor = props[i]; descriptor.enumerable = descriptor.enumerable || false; descriptor.configurable = true; if ("value" in descriptor) descriptor.writable = true; Object.defineProperty(target, descriptor.key, descriptor); } }
-
-function _createClass(Constructor, protoProps, staticProps) { if (protoProps) _defineProperties(Constructor.prototype, protoProps); if (staticProps) _defineProperties(Constructor, staticProps); Object.defineProperty(Constructor, "prototype", { writable: false }); return Constructor; }
-
-function _inherits(subClass, superClass) { if (typeof superClass !== "function" && superClass !== null) { throw new TypeError("Super expression must either be null or a function"); } subClass.prototype = Object.create(superClass && superClass.prototype, { constructor: { value: subClass, writable: true, configurable: true } }); Object.defineProperty(subClass, "prototype", { writable: false }); if (superClass) _setPrototypeOf(subClass, superClass); }
-
-function _setPrototypeOf(o, p) { _setPrototypeOf = Object.setPrototypeOf || function _setPrototypeOf(o, p) { o.__proto__ = p; return o; }; return _setPrototypeOf(o, p); }
-
-function _createSuper(Derived) { var hasNativeReflectConstruct = _isNativeReflectConstruct(); return function _createSuperInternal() { var Super = _getPrototypeOf(Derived), result; if (hasNativeReflectConstruct) { var NewTarget = _getPrototypeOf(this).constructor; result = Reflect.construct(Super, arguments, NewTarget); } else { result = Super.apply(this, arguments); } return _possibleConstructorReturn(this, result); }; }
-
-function _possibleConstructorReturn(self, call) { if (call && (_typeof(call) === "object" || typeof call === "function")) { return call; } else if (call !== void 0) { throw new TypeError("Derived constructors may only return object or undefined"); } return _assertThisInitialized(self); }
-
-function _assertThisInitialized(self) { if (self === void 0) { throw new ReferenceError("this hasn't been initialised - super() hasn't been called"); } return self; }
-
-function _isNativeReflectConstruct() { if (typeof Reflect === "undefined" || !Reflect.construct) return false; if (Reflect.construct.sham) return false; if (typeof Proxy === "function") return true; try { Boolean.prototype.valueOf.call(Reflect.construct(Boolean, [], function () {})); return true; } catch (e) { return false; } }
-
-function _getPrototypeOf(o) { _getPrototypeOf = Object.setPrototypeOf ? Object.getPrototypeOf : function _getPrototypeOf(o) { return o.__proto__ || Object.getPrototypeOf(o); }; return _getPrototypeOf(o); }
-
-var template = _handlebars["default"].templates.html_div_formatter;
-var defaultCss = {
-  '.chord:not(:last-child)': {
-    paddingRight: '10px'
-  },
-  '.paragraph': {
-    marginBottom: '1em'
-  },
-  '.row': {
-    display: 'flex'
-  },
-  '.chord:after': {
-    content: '\'\\200b\''
-  },
-  '.lyrics:after': {
-    content: '\'\\200b\''
-  }
-};
-/**
- * Formats a song into HTML. It uses DIVs to align lyrics with chords, which makes it useful for responsive web pages.
- */
-
-var HtmlDivFormatter = /*#__PURE__*/function (_HtmlFormatter) {
-  _inherits(HtmlDivFormatter, _HtmlFormatter);
-
-  var _super = _createSuper(HtmlDivFormatter);
-
-  function HtmlDivFormatter() {
-    _classCallCheck(this, HtmlDivFormatter);
-
-    return _super.apply(this, arguments);
-  }
-
-  _createClass(HtmlDivFormatter, [{
-    key: "format",
-    value:
-    /**
-     * Formats a song into HTML.
-     * @param {Song} song The song to be formatted
-     * @returns {string} The HTML string
-     */
-    function format(song) {
-      return this.formatWithTemplate(song, template);
-    }
-    /**
-     * Generates basic CSS, optionally scoped within the provided selector, to use with output generated by
-     * {@link HtmlDivFormatter}
-     *
-     * For example, execute cssString('.chordSheetViewer') will result in CSS like:
-     *
-     *     .chordSheetViewer .paragraph {
-     *       margin-bottom: 1em;
-     *     }
-     *
-     * @param scope the CSS scope to use, for example `.chordSheetViewer`
-     * @returns {string} the CSS string
-     */
-
-  }], [{
-    key: "cssString",
-    value: function cssString() {
-      var scope = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : '';
-      return (0, _utilities.scopeCss)(defaultCss, scope);
-    }
-    /**
-     * Basic CSS, in object style à la useStyles, to use with output generated by {@link HtmlDivFormatter}
-     *
-     * Example:
-     *
-     *     '.paragraph': {
-     *       marginBottom: '1em'
-     *     }
-     *
-     * For a CSS string see {@link cssString}
-     * @return {Object.<string, Object.<string, string>>} the CSS object
-     */
-
-  }, {
-    key: "cssObject",
-    value: function cssObject() {
-      return defaultCss;
-    }
-  }]);
-
-  return HtmlDivFormatter;
-}(_html_formatter["default"]);
-
-var _default = HtmlDivFormatter;
-exports["default"] = _default;

package/lib/formatter/html_formatter.js

@@ -1,44 +0,0 @@
-"use strict";
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports["default"] = void 0;
-
-function _classCallCheck(instance, Constructor) { if (!(instance instanceof Constructor)) { throw new TypeError("Cannot call a class as a function"); } }
-
-function _defineProperties(target, props) { for (var i = 0; i < props.length; i++) { var descriptor = props[i]; descriptor.enumerable = descriptor.enumerable || false; descriptor.configurable = true; if ("value" in descriptor) descriptor.writable = true; Object.defineProperty(target, descriptor.key, descriptor); } }
-
-function _createClass(Constructor, protoProps, staticProps) { if (protoProps) _defineProperties(Constructor.prototype, protoProps); if (staticProps) _defineProperties(Constructor, staticProps); Object.defineProperty(Constructor, "prototype", { writable: false }); return Constructor; }
-
-/**
- * Acts as a base class for HTML formatters, taking care of whitelisting prototype property access.
- */
-var HtmlFormatter = /*#__PURE__*/function () {
-  function HtmlFormatter() {
-    _classCallCheck(this, HtmlFormatter);
-  }
-
-  _createClass(HtmlFormatter, [{
-    key: "formatWithTemplate",
-    value: function formatWithTemplate(song, template) {
-      return template({
-        song: song
-      }, {
-        allowedProtoProperties: {
-          bodyLines: true,
-          bodyParagraphs: true,
-          subtitle: true,
-          title: true,
-          value: true,
-          key: true
-        }
-      });
-    }
-  }]);
-
-  return HtmlFormatter;
-}();
-
-var _default = HtmlFormatter;
-exports["default"] = _default;

package/lib/formatter/html_table_formatter.js

@@ -1,154 +0,0 @@
-"use strict";
-
-function _typeof(obj) { "@babel/helpers - typeof"; return _typeof = "function" == typeof Symbol && "symbol" == typeof Symbol.iterator ? function (obj) { return typeof obj; } : function (obj) { return obj && "function" == typeof Symbol && obj.constructor === Symbol && obj !== Symbol.prototype ? "symbol" : typeof obj; }, _typeof(obj); }
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.defaultCss = exports["default"] = void 0;
-exports.scopedCss = scopedCss;
-
-var _handlebars = _interopRequireDefault(require("handlebars"));
-
-require("../template_helpers");
-
-var _html_formatter = _interopRequireDefault(require("./html_formatter"));
-
-require("./templates/html_table_formatter");
-
-var _utilities = require("../utilities");
-
-function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { "default": obj }; }
-
-function _classCallCheck(instance, Constructor) { if (!(instance instanceof Constructor)) { throw new TypeError("Cannot call a class as a function"); } }
-
-function _defineProperties(target, props) { for (var i = 0; i < props.length; i++) { var descriptor = props[i]; descriptor.enumerable = descriptor.enumerable || false; descriptor.configurable = true; if ("value" in descriptor) descriptor.writable = true; Object.defineProperty(target, descriptor.key, descriptor); } }
-
-function _createClass(Constructor, protoProps, staticProps) { if (protoProps) _defineProperties(Constructor.prototype, protoProps); if (staticProps) _defineProperties(Constructor, staticProps); Object.defineProperty(Constructor, "prototype", { writable: false }); return Constructor; }
-
-function _inherits(subClass, superClass) { if (typeof superClass !== "function" && superClass !== null) { throw new TypeError("Super expression must either be null or a function"); } subClass.prototype = Object.create(superClass && superClass.prototype, { constructor: { value: subClass, writable: true, configurable: true } }); Object.defineProperty(subClass, "prototype", { writable: false }); if (superClass) _setPrototypeOf(subClass, superClass); }
-
-function _setPrototypeOf(o, p) { _setPrototypeOf = Object.setPrototypeOf || function _setPrototypeOf(o, p) { o.__proto__ = p; return o; }; return _setPrototypeOf(o, p); }
-
-function _createSuper(Derived) { var hasNativeReflectConstruct = _isNativeReflectConstruct(); return function _createSuperInternal() { var Super = _getPrototypeOf(Derived), result; if (hasNativeReflectConstruct) { var NewTarget = _getPrototypeOf(this).constructor; result = Reflect.construct(Super, arguments, NewTarget); } else { result = Super.apply(this, arguments); } return _possibleConstructorReturn(this, result); }; }
-
-function _possibleConstructorReturn(self, call) { if (call && (_typeof(call) === "object" || typeof call === "function")) { return call; } else if (call !== void 0) { throw new TypeError("Derived constructors may only return object or undefined"); } return _assertThisInitialized(self); }
-
-function _assertThisInitialized(self) { if (self === void 0) { throw new ReferenceError("this hasn't been initialised - super() hasn't been called"); } return self; }
-
-function _isNativeReflectConstruct() { if (typeof Reflect === "undefined" || !Reflect.construct) return false; if (Reflect.construct.sham) return false; if (typeof Proxy === "function") return true; try { Boolean.prototype.valueOf.call(Reflect.construct(Boolean, [], function () {})); return true; } catch (e) { return false; } }
-
-function _getPrototypeOf(o) { _getPrototypeOf = Object.setPrototypeOf ? Object.getPrototypeOf : function _getPrototypeOf(o) { return o.__proto__ || Object.getPrototypeOf(o); }; return _getPrototypeOf(o); }
-
-var template = _handlebars["default"].templates.html_table_formatter;
-/**
- * Basic CSS, in object style à la useStyles, to use with output generated by {@link }HtmlTableFormatter}
- * For a CSS string see {@link scopedCss}
- * @type {Object.<string, Object.<string, string>>}
- */
-
-var defaultCss = {
-  h1: {
-    fontSize: '1.5em'
-  },
-  h2: {
-    fontSize: '1.1em'
-  },
-  table: {
-    borderSpacing: '0',
-    color: 'inherit'
-  },
-  td: {
-    padding: '3px 0'
-  },
-  '.chord:not(:last-child)': {
-    paddingRight: '10px'
-  },
-  '.paragraph': {
-    marginBottom: '1em'
-  }
-};
-/**
- * Generates basic CSS, scoped within the provided selector, to use with output generated by {@link HtmlTableFormatter}
- * @param scope the CSS scope to use, for example `.chordSheetViewer`
- * @returns {string} the CSS string
- */
-
-exports.defaultCss = defaultCss;
-
-function scopedCss(scope) {
-  return (0, _utilities.scopeCss)(defaultCss, scope);
-}
-/**
- * Formats a song into HTML. It uses TABLEs to align lyrics with chords, which makes the HTML for things like
- * PDF conversion.
- */
-
-
-var HtmlTableFormatter = /*#__PURE__*/function (_HtmlFormatter) {
-  _inherits(HtmlTableFormatter, _HtmlFormatter);
-
-  var _super = _createSuper(HtmlTableFormatter);
-
-  function HtmlTableFormatter() {
-    _classCallCheck(this, HtmlTableFormatter);
-
-    return _super.apply(this, arguments);
-  }
-
-  _createClass(HtmlTableFormatter, [{
-    key: "format",
-    value:
-    /**
-     * Formats a song into HTML.
-     * @param {Song} song The song to be formatted
-     * @returns {string} The HTML string
-     */
-    function format(song) {
-      return this.formatWithTemplate(song, template);
-    }
-    /**
-     * Generates basic CSS, optionally scoped within the provided selector, to use with output generated by
-     * {@link HtmlTableFormatter}
-     *
-     * For example, execute cssString('.chordSheetViewer') will result in CSS like:
-     *
-     *     .chordSheetViewer .paragraph {
-     *       margin-bottom: 1em;
-     *     }
-     *
-     * @param scope the CSS scope to use, for example `.chordSheetViewer`
-     * @returns {string} the CSS string
-     */
-
-  }], [{
-    key: "cssString",
-    value: function cssString() {
-      var scope = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : '';
-      return (0, _utilities.scopeCss)(defaultCss, scope);
-    }
-    /**
-     * Basic CSS, in object style à la useStyles, to use with output generated by {@link HtmlTableFormatter}
-     * For a CSS string see {@link cssString}
-     *
-     * Example:
-     *
-     *     '.paragraph': {
-     *       marginBottom: '1em'
-     *     }
-     *
-     * @return {Object.<string, Object.<string, string>>} the CSS object
-     */
-
-  }, {
-    key: "cssObject",
-    value: function cssObject() {
-      return defaultCss;
-    }
-  }]);
-
-  return HtmlTableFormatter;
-}(_html_formatter["default"]);
-
-var _default = HtmlTableFormatter;
-exports["default"] = _default;