chordsheetjs 6.1.0 → 6.2.0

package/lib/chord_sheet/tag.js

@@ -1,359 +0,0 @@
-"use strict";
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports["default"] = exports._KEY = exports.YEAR = exports.TRANSPOSE = exports.TITLE = exports.TIME = exports.TEMPO = exports.SUBTITLE = exports.START_OF_VERSE = exports.START_OF_TAB = exports.START_OF_CHORUS = exports.READ_ONLY_TAGS = exports.NEW_KEY = exports.META_TAGS = exports.LYRICIST = exports.KEY = exports.END_OF_VERSE = exports.END_OF_TAB = exports.END_OF_CHORUS = exports.DURATION = exports.COPYRIGHT = exports.COMPOSER = exports.COMMENT = exports.CAPO = exports.ARTIST = exports.ALBUM = void 0;
-exports.isReadonlyTag = isReadonlyTag;
-
-var _ALIASES;
-
-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 _defineProperty(obj, key, value) { if (key in obj) { Object.defineProperty(obj, key, { value: value, enumerable: true, configurable: true, writable: true }); } else { obj[key] = value; } return obj; }
-
-/**
- * Album meta directive. See https://www.chordpro.org/chordpro/directives-album/
- * @type {string}
- */
-var ALBUM = 'album';
-/**
- * Artist meta directive. See https://www.chordpro.org/chordpro/directives-artist/
- * @type {string}
- */
-
-exports.ALBUM = ALBUM;
-var ARTIST = 'artist';
-/**
- * Capo meta directive. See https://www.chordpro.org/chordpro/directives-capo/
- * @type {string}
- */
-
-exports.ARTIST = ARTIST;
-var CAPO = 'capo';
-/**
- * Comment directive. See https://www.chordpro.org/chordpro/directives-comment/
- * @type {string}
- */
-
-exports.CAPO = CAPO;
-var COMMENT = 'comment';
-/**
- * Composer meta directive. See https://www.chordpro.org/chordpro/directives-composer/
- * @type {string}
- */
-
-exports.COMMENT = COMMENT;
-var COMPOSER = 'composer';
-/**
- * Copyright meta directive. See https://www.chordpro.org/chordpro/directives-copyright/
- * @type {string}
- */
-
-exports.COMPOSER = COMPOSER;
-var COPYRIGHT = 'copyright';
-/**
- * Duration meta directive. See https://www.chordpro.org/chordpro/directives-duration/
- * @type {string}
- */
-
-exports.COPYRIGHT = COPYRIGHT;
-var DURATION = 'duration';
-/**
- * End of chorus directive. See https://www.chordpro.org/chordpro/directives-env_chorus/
- * @type {string}
- */
-
-exports.DURATION = DURATION;
-var END_OF_CHORUS = 'end_of_chorus';
-/**
- * End of tab directive. See https://www.chordpro.org/chordpro/directives-env_tab/
- * @type {string}
- */
-
-exports.END_OF_CHORUS = END_OF_CHORUS;
-var END_OF_TAB = 'end_of_tab';
-/**
- * End of verse directive. See https://www.chordpro.org/chordpro/directives-env_verse/
- * @type {string}
- */
-
-exports.END_OF_TAB = END_OF_TAB;
-var END_OF_VERSE = 'end_of_verse';
-/**
- * Key meta directive. See https://www.chordpro.org/chordpro/directives-key/
- * @type {string}
- */
-
-exports.END_OF_VERSE = END_OF_VERSE;
-var KEY = 'key';
-/**
- * Key meta directive. See https://www.chordpro.org/chordpro/directives-key/
- * @type {string}
- */
-
-exports.KEY = KEY;
-var _KEY = '_key';
-/**
- * Lyricist meta directive. See https://www.chordpro.org/chordpro/directives-lyricist/
- * @type {string}
- */
-
-exports._KEY = _KEY;
-var LYRICIST = 'lyricist';
-/**
- * Start of chorus directive. See https://www.chordpro.org/chordpro/directives-env_chorus/
- * @type {string}
- */
-
-exports.LYRICIST = LYRICIST;
-var START_OF_CHORUS = 'start_of_chorus';
-/**
- * Start of tab directive. See https://www.chordpro.org/chordpro/directives-env_tab/
- * @type {string}
- */
-
-exports.START_OF_CHORUS = START_OF_CHORUS;
-var START_OF_TAB = 'start_of_tab';
-/**
- * Start of verse directive. See https://www.chordpro.org/chordpro/directives-env_verse/
- * @type {string}
- */
-
-exports.START_OF_TAB = START_OF_TAB;
-var START_OF_VERSE = 'start_of_verse';
-/**
- * Subtitle meta directive. See https://www.chordpro.org/chordpro/directives-subtitle/
- * @type {string}
- */
-
-exports.START_OF_VERSE = START_OF_VERSE;
-var SUBTITLE = 'subtitle';
-/**
- * Tempo meta directive. See https://www.chordpro.org/chordpro/directives-tempo/
- * @type {string}
- */
-
-exports.SUBTITLE = SUBTITLE;
-var TEMPO = 'tempo';
-/**
- * Time meta directive. See https://www.chordpro.org/chordpro/directives-time/
- * @type {string}
- */
-
-exports.TEMPO = TEMPO;
-var TIME = 'time';
-/**
- * Title meta directive. See https://www.chordpro.org/chordpro/directives-title/
- * @type {string}
- */
-
-exports.TIME = TIME;
-var TITLE = 'title';
-/**
- * Transpose meta directive. See: https://www.chordpro.org/chordpro/directives-transpose/
- * @type {string}
- */
-
-exports.TITLE = TITLE;
-var TRANSPOSE = 'transpose';
-/**
- * New Key meta directive. See: https://github.com/PraiseCharts/ChordChartJS/issues/53
- * @type {string}
- */
-
-exports.TRANSPOSE = TRANSPOSE;
-var NEW_KEY = 'new_key';
-/**
- * Year meta directive. See https://www.chordpro.org/chordpro/directives-year/
- * @type {string}
- */
-
-exports.NEW_KEY = NEW_KEY;
-var YEAR = 'year';
-exports.YEAR = YEAR;
-var TITLE_SHORT = 't';
-var SUBTITLE_SHORT = 'st';
-var COMMENT_SHORT = 'c';
-var START_OF_CHORUS_SHORT = 'soc';
-var END_OF_CHORUS_SHORT = 'eoc';
-var START_OF_TAB_SHORT = 'sot';
-var END_OF_TAB_SHORT = 'eot';
-var NEW_KEY_SHORT = 'nk';
-var RENDERABLE_TAGS = [COMMENT];
-var META_TAGS = [ALBUM, ARTIST, CAPO, COMPOSER, COPYRIGHT, DURATION, KEY, LYRICIST, TEMPO, TIME, TITLE, SUBTITLE, YEAR];
-exports.META_TAGS = META_TAGS;
-var READ_ONLY_TAGS = [_KEY];
-exports.READ_ONLY_TAGS = READ_ONLY_TAGS;
-var ALIASES = (_ALIASES = {}, _defineProperty(_ALIASES, TITLE_SHORT, TITLE), _defineProperty(_ALIASES, SUBTITLE_SHORT, SUBTITLE), _defineProperty(_ALIASES, COMMENT_SHORT, COMMENT), _defineProperty(_ALIASES, START_OF_CHORUS_SHORT, START_OF_CHORUS), _defineProperty(_ALIASES, END_OF_CHORUS_SHORT, END_OF_CHORUS), _defineProperty(_ALIASES, START_OF_TAB_SHORT, START_OF_TAB), _defineProperty(_ALIASES, END_OF_TAB_SHORT, END_OF_TAB), _defineProperty(_ALIASES, NEW_KEY_SHORT, NEW_KEY), _ALIASES);
-var META_TAG_REGEX = /^meta:\s*([^:\s]+)(\s*(.+))?$/;
-var TAG_REGEX = /^([^:\s]+)(:?\s*(.+))?$/;
-var CUSTOM_META_TAG_NAME_REGEX = /^x_(.+)$/;
-
-function isReadonlyTag(tagName) {
-  return READ_ONLY_TAGS.includes(tagName);
-}
-
-var translateTagNameAlias = function translateTagNameAlias(name) {
-  if (!name) {
-    return name;
-  }
-
-  var sanitizedName = name.trim();
-
-  if (sanitizedName in ALIASES) {
-    return ALIASES[sanitizedName];
-  }
-
-  return sanitizedName;
-};
-/**
- * Represents a tag/directive. See https://www.chordpro.org/chordpro/chordpro-directives/
- */
-
-
-var Tag = /*#__PURE__*/function () {
-  function Tag(name, value) {
-    var _ref = arguments.length > 2 && arguments[2] !== undefined ? arguments[2] : {},
-        _ref$line = _ref.line,
-        line = _ref$line === void 0 ? null : _ref$line,
-        _ref$column = _ref.column,
-        column = _ref$column === void 0 ? null : _ref$column,
-        _ref$offset = _ref.offset,
-        offset = _ref$offset === void 0 ? null : _ref$offset;
-
-    _classCallCheck(this, Tag);
-
-    this.name = name;
-    this.value = value;
-    this.line = line;
-    this.column = column;
-    this.offset = offset;
-  }
-
-  _createClass(Tag, [{
-    key: "name",
-    get:
-    /**
-     * The tag full name. When the original tag used the short name, `name` will return the full name.
-     * @member
-     * @type {string}
-     */
-    function get() {
-      return this._name.trim();
-    }
-    /**
-     * The original tag name that was used to construct the tag.
-     * @member
-     * @type {string}
-     */
-    ,
-    set: function set(name) {
-      this._name = translateTagNameAlias(name);
-      this._originalName = name;
-    }
-  }, {
-    key: "originalName",
-    get: function get() {
-      return this._originalName.trim();
-    }
-  }, {
-    key: "value",
-    get:
-    /**
-     * The tag value
-     * @member
-     * @type {string|null}
-     */
-    function get() {
-      if (this._value) {
-        return "".concat(this._value).trim();
-      }
-
-      return this._value || null;
-    }
-    /**
-     * Checks whether the tag value is a non-empty string.
-     * @returns {boolean}
-     */
-    ,
-    set: function set(value) {
-      this._value = value;
-    }
-  }, {
-    key: "hasValue",
-    value: function hasValue() {
-      return this.value !== null && this.value.trim().length > 0;
-    }
-    /**
-     * Checks whether the tag is usually rendered inline. It currently only applies to comment tags.
-     * @returns {boolean}
-     */
-
-  }, {
-    key: "isRenderable",
-    value: function isRenderable() {
-      return RENDERABLE_TAGS.indexOf(this.name) !== -1;
-    }
-    /**
-     * Checks whether the tag is either a standard meta tag or a custom meta directive (`{x_some_name}`)
-     * @returns {boolean}
-     */
-
-  }, {
-    key: "isMetaTag",
-    value: function isMetaTag() {
-      return CUSTOM_META_TAG_NAME_REGEX.test(this.name) || META_TAGS.indexOf(this.name) !== -1;
-    }
-    /**
-     * Returns a clone of the tag.
-     * @returns {Tag} The cloned tag
-     */
-
-  }, {
-    key: "clone",
-    value: function clone() {
-      return new Tag(this._originalName, this.value);
-    }
-  }, {
-    key: "toString",
-    value: function toString() {
-      return "Tag(name=".concat(this.name, ", value=").concat(this.name, ")");
-    }
-  }, {
-    key: "set",
-    value: function set(_ref2) {
-      var value = _ref2.value;
-      return new Tag(this._originalName, value);
-    }
-  }], [{
-    key: "parse",
-    value: function parse(tag) {
-      if (tag instanceof Tag) {
-        return tag;
-      }
-
-      return this.parseWithRegex(tag, META_TAG_REGEX) || this.parseWithRegex(tag, TAG_REGEX);
-    }
-  }, {
-    key: "parseWithRegex",
-    value: function parseWithRegex(tag, regex) {
-      var matches = tag.match(regex);
-
-      if (matches !== null) {
-        return new Tag(matches[1], matches[3] || null);
-      }
-
-      return null;
-    }
-  }]);
-
-  return Tag;
-}();
-
-var _default = Tag;
-exports["default"] = _default;

package/lib/chord_sheet_serializer.js

@@ -1,278 +0,0 @@
-"use strict";
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports["default"] = void 0;
-
-var _literal = _interopRequireDefault(require("./chord_sheet/chord_pro/literal"));
-
-var _song = _interopRequireDefault(require("./chord_sheet/song"));
-
-var _chord_lyrics_pair = _interopRequireDefault(require("./chord_sheet/chord_lyrics_pair"));
-
-var _tag = _interopRequireDefault(require("./chord_sheet/tag"));
-
-var _comment = _interopRequireDefault(require("./chord_sheet/comment"));
-
-var _ternary = _interopRequireDefault(require("./chord_sheet/chord_pro/ternary"));
-
-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; }
-
-var CHORD_SHEET = 'chordSheet';
-var CHORD_LYRICS_PAIR = 'chordLyricsPair';
-var TAG = 'tag';
-var COMMENT = 'comment';
-var TERNARY = 'ternary';
-var LINE = 'line';
-/**
- * Serializes a song into een plain object, and deserializes the serialized object back into a {@link Song}
- */
-
-var ChordSheetSerializer = /*#__PURE__*/function () {
-  function ChordSheetSerializer() {
-    _classCallCheck(this, ChordSheetSerializer);
-  }
-
-  _createClass(ChordSheetSerializer, [{
-    key: "serialize",
-    value:
-    /**
-     * Serializes the chord sheet to a plain object, which can be converted to any format like JSON, XML etc
-     * Can be deserialized using {@link deserialize}
-     * @returns object A plain JS object containing all chord sheet data
-     */
-    function serialize(song) {
-      var _this = this;
-
-      return {
-        type: CHORD_SHEET,
-        lines: song.lines.map(function (line) {
-          return _this.serializeLine(line);
-        })
-      };
-    }
-  }, {
-    key: "serializeLine",
-    value: function serializeLine(line) {
-      var _this2 = this;
-
-      return {
-        type: LINE,
-        items: line.items.map(function (item) {
-          return _this2.serializeItem(item);
-        })
-      };
-    }
-  }, {
-    key: "serializeItem",
-    value: function serializeItem(item) {
-      if (item instanceof _tag["default"]) {
-        return this.serializeTag(item);
-      }
-
-      if (item instanceof _chord_lyrics_pair["default"]) {
-        return this.serializeChordLyricsPair(item);
-      }
-
-      if (item instanceof _ternary["default"]) {
-        return this.serializeTernary(item);
-      }
-
-      if (item instanceof _literal["default"]) {
-        return this.serializeLiteral(item);
-      }
-
-      throw new Error("Don't know how to serialize ".concat(item.constructor.name));
-    }
-  }, {
-    key: "serializeTag",
-    value: function serializeTag(tag) {
-      return {
-        type: TAG,
-        name: tag.originalName,
-        value: tag.value
-      };
-    }
-  }, {
-    key: "serializeChordLyricsPair",
-    value: function serializeChordLyricsPair(chordLyricsPair) {
-      return {
-        type: CHORD_LYRICS_PAIR,
-        chords: chordLyricsPair.chords,
-        lyrics: chordLyricsPair.lyrics
-      };
-    }
-  }, {
-    key: "serializeTernary",
-    value: function serializeTernary(ternary) {
-      return {
-        type: TERNARY,
-        variable: ternary.variable,
-        valueTest: ternary.valueTest,
-        trueExpression: this.serializeExpression(ternary.trueExpression),
-        falseExpression: this.serializeExpression(ternary.falseExpression)
-      };
-    }
-  }, {
-    key: "serializeLiteral",
-    value: function serializeLiteral(literal) {
-      return literal.string;
-    }
-  }, {
-    key: "serializeExpression",
-    value: function serializeExpression(expression) {
-      var _this3 = this;
-
-      return expression === null || expression === void 0 ? void 0 : expression.map(function (part) {
-        return _this3.serializeItem(part);
-      });
-    }
-    /**
-     * Deserializes a song that has been serialized using {@link serialize}
-     * @param {object} serializedSong The serialized song
-     * @returns {Song} The deserialized song
-     */
-
-  }, {
-    key: "deserialize",
-    value: function deserialize(serializedSong) {
-      this.parseAstComponent(serializedSong);
-      this.song.finish();
-      return this.song;
-    }
-  }, {
-    key: "parseAstComponent",
-    value: function parseAstComponent(astComponent) {
-      if (!astComponent) {
-        return null;
-      }
-
-      if (typeof astComponent === 'string') {
-        return new _literal["default"](astComponent);
-      }
-
-      var type = astComponent.type;
-
-      switch (type) {
-        case CHORD_SHEET:
-          return this.parseChordSheet(astComponent);
-
-        case CHORD_LYRICS_PAIR:
-          return this.parseChordLyricsPair(astComponent);
-
-        case TAG:
-          return this.parseTag(astComponent);
-
-        case COMMENT:
-          return this.parseComment(astComponent);
-
-        case TERNARY:
-          return this.parseTernary(astComponent);
-
-        default:
-          console.warn("Unhandled AST component \"".concat(type, "\""), astComponent);
-      }
-
-      return null;
-    }
-  }, {
-    key: "parseChordSheet",
-    value: function parseChordSheet(astComponent) {
-      var _this4 = this;
-
-      var lines = astComponent.lines;
-      this.song = new _song["default"]();
-      lines.forEach(function (line, index) {
-        return _this4.parseLine(line, index);
-      });
-    }
-  }, {
-    key: "parseLine",
-    value: function parseLine(astComponent) {
-      var _this5 = this;
-
-      var items = astComponent.items;
-      this.song.addLine();
-      items.forEach(function (item) {
-        var parsedItem = _this5.parseAstComponent(item);
-
-        _this5.song.addItem(parsedItem);
-      });
-    }
-  }, {
-    key: "parseChordLyricsPair",
-    value: function parseChordLyricsPair(astComponent) {
-      var chords = astComponent.chords,
-          lyrics = astComponent.lyrics;
-      return new _chord_lyrics_pair["default"](chords, lyrics);
-    }
-  }, {
-    key: "parseTag",
-    value: function parseTag(astComponent) {
-      var name = astComponent.name,
-          value = astComponent.value,
-          _astComponent$locatio = astComponent.location;
-      _astComponent$locatio = _astComponent$locatio === void 0 ? {} : _astComponent$locatio;
-      var offset = _astComponent$locatio.offset,
-          line = _astComponent$locatio.line,
-          column = _astComponent$locatio.column;
-      return new _tag["default"](name, value, {
-        line: line,
-        column: column,
-        offset: offset
-      });
-    }
-  }, {
-    key: "parseComment",
-    value: function parseComment(astComponent) {
-      var comment = astComponent.comment;
-      return new _comment["default"](comment);
-    }
-  }, {
-    key: "parseTernary",
-    value: function parseTernary(astComponent) {
-      var variable = astComponent.variable,
-          valueTest = astComponent.valueTest,
-          trueExpression = astComponent.trueExpression,
-          falseExpression = astComponent.falseExpression,
-          _astComponent$locatio2 = astComponent.location;
-      _astComponent$locatio2 = _astComponent$locatio2 === void 0 ? {} : _astComponent$locatio2;
-      var offset = _astComponent$locatio2.offset,
-          line = _astComponent$locatio2.line,
-          column = _astComponent$locatio2.column;
-      return new _ternary["default"]({
-        variable: variable,
-        valueTest: valueTest,
-        trueExpression: this.parseExpression(trueExpression),
-        falseExpression: this.parseExpression(falseExpression),
-        offset: offset,
-        line: line,
-        column: column
-      });
-    }
-  }, {
-    key: "parseExpression",
-    value: function parseExpression(expression) {
-      var _this6 = this;
-
-      var parsedParts = (expression || []).map(function (part) {
-        return _this6.parseAstComponent(part);
-      });
-      return (0, _utilities.presence)(parsedParts);
-    }
-  }]);
-
-  return ChordSheetSerializer;
-}();
-
-var _default = ChordSheetSerializer;
-exports["default"] = _default;

package/lib/constants.js

@@ -1,54 +0,0 @@
-"use strict";
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.VERSE = exports.TAB = exports.SYMBOL = exports.ROMAN_NUMERALS = exports.NUMERIC = exports.NUMERAL = exports.NONE = exports.INDETERMINATE = exports.CHORUS = void 0;
-
-/**
- * Used to mark a paragraph as verse
- * @constant
- * @type {string}
- */
-var VERSE = 'verse';
-/**
- * Used to mark a paragraph as chorus
- * @constant
- * @type {string}
- */
-
-exports.VERSE = VERSE;
-var CHORUS = 'chorus';
-/**
- * Used to mark a paragraph as not containing a line marked with a type
- * @constant
- * @type {string}
- */
-
-exports.CHORUS = CHORUS;
-var NONE = 'none';
-/**
- * Used to mark a paragraph as containing lines with both verse and chorus type
- * @constant
- * @type {string}
- */
-
-exports.NONE = NONE;
-var INDETERMINATE = 'indeterminate';
-/**
- * Used to mark a paragraph as tab
- * @constant
- * @type {string}
- */
-
-exports.INDETERMINATE = INDETERMINATE;
-var TAB = 'tab';
-exports.TAB = TAB;
-var SYMBOL = 'symbol';
-exports.SYMBOL = SYMBOL;
-var NUMERIC = 'numeric';
-exports.NUMERIC = NUMERIC;
-var NUMERAL = 'numeral';
-exports.NUMERAL = NUMERAL;
-var ROMAN_NUMERALS = ['I', 'II', 'III', 'IV', 'V', 'VI', 'VII'];
-exports.ROMAN_NUMERALS = ROMAN_NUMERALS;