index.js 7.1 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131
  1. "use strict";
  2. Object.defineProperty(exports, "__esModule", { value: true });
  3. exports.decodeXMLStrict = exports.decodeHTML5Strict = exports.decodeHTML4Strict = exports.decodeHTML5 = exports.decodeHTML4 = exports.decodeHTMLAttribute = exports.decodeHTMLStrict = exports.decodeHTML = exports.decodeXML = exports.DecodingMode = exports.EntityDecoder = exports.encodeHTML5 = exports.encodeHTML4 = exports.encodeNonAsciiHTML = exports.encodeHTML = exports.escapeText = exports.escapeAttribute = exports.escapeUTF8 = exports.encodeXML = exports.EncodingMode = exports.EntityLevel = void 0;
  4. exports.decode = decode;
  5. exports.decodeStrict = decodeStrict;
  6. exports.encode = encode;
  7. const decode_js_1 = require("./decode.js");
  8. const encode_js_1 = require("./encode.js");
  9. const escape_js_1 = require("./escape.js");
  10. /** The level of entities to support. */
  11. var EntityLevel;
  12. (function (EntityLevel) {
  13. /** Support only XML entities. */
  14. EntityLevel[EntityLevel["XML"] = 0] = "XML";
  15. /** Support HTML entities, which are a superset of XML entities. */
  16. EntityLevel[EntityLevel["HTML"] = 1] = "HTML";
  17. })(EntityLevel || (exports.EntityLevel = EntityLevel = {}));
  18. var EncodingMode;
  19. (function (EncodingMode) {
  20. /**
  21. * The output is UTF-8 encoded. Only characters that need escaping within
  22. * XML will be escaped.
  23. */
  24. EncodingMode[EncodingMode["UTF8"] = 0] = "UTF8";
  25. /**
  26. * The output consists only of ASCII characters. Characters that need
  27. * escaping within HTML, and characters that aren't ASCII characters will
  28. * be escaped.
  29. */
  30. EncodingMode[EncodingMode["ASCII"] = 1] = "ASCII";
  31. /**
  32. * Encode all characters that have an equivalent entity, as well as all
  33. * characters that are not ASCII characters.
  34. */
  35. EncodingMode[EncodingMode["Extensive"] = 2] = "Extensive";
  36. /**
  37. * Encode all characters that have to be escaped in HTML attributes,
  38. * following {@link https://html.spec.whatwg.org/multipage/parsing.html#escapingString}.
  39. */
  40. EncodingMode[EncodingMode["Attribute"] = 3] = "Attribute";
  41. /**
  42. * Encode all characters that have to be escaped in HTML text,
  43. * following {@link https://html.spec.whatwg.org/multipage/parsing.html#escapingString}.
  44. */
  45. EncodingMode[EncodingMode["Text"] = 4] = "Text";
  46. })(EncodingMode || (exports.EncodingMode = EncodingMode = {}));
  47. /**
  48. * Decodes a string with entities.
  49. *
  50. * @param input String to decode.
  51. * @param options Decoding options.
  52. */
  53. function decode(input, options = EntityLevel.XML) {
  54. const level = typeof options === "number" ? options : options.level;
  55. if (level === EntityLevel.HTML) {
  56. const mode = typeof options === "object" ? options.mode : undefined;
  57. return (0, decode_js_1.decodeHTML)(input, mode);
  58. }
  59. return (0, decode_js_1.decodeXML)(input);
  60. }
  61. /**
  62. * Decodes a string with entities. Does not allow missing trailing semicolons for entities.
  63. *
  64. * @param input String to decode.
  65. * @param options Decoding options.
  66. * @deprecated Use `decode` with the `mode` set to `Strict`.
  67. */
  68. function decodeStrict(input, options = EntityLevel.XML) {
  69. var _a;
  70. const normalizedOptions = typeof options === "number" ? { level: options } : options;
  71. (_a = normalizedOptions.mode) !== null && _a !== void 0 ? _a : (normalizedOptions.mode = decode_js_1.DecodingMode.Strict);
  72. return decode(input, normalizedOptions);
  73. }
  74. /**
  75. * Encodes a string with entities.
  76. *
  77. * @param input String to encode.
  78. * @param options Encoding options.
  79. */
  80. function encode(input, options = EntityLevel.XML) {
  81. const { mode = EncodingMode.Extensive, level = EntityLevel.XML } = typeof options === "number" ? { level: options } : options;
  82. switch (mode) {
  83. case EncodingMode.UTF8: {
  84. return (0, escape_js_1.escapeUTF8)(input);
  85. }
  86. case EncodingMode.Attribute: {
  87. return (0, escape_js_1.escapeAttribute)(input);
  88. }
  89. case EncodingMode.Text: {
  90. return (0, escape_js_1.escapeText)(input);
  91. }
  92. case EncodingMode.ASCII: {
  93. return level === EntityLevel.HTML
  94. ? (0, encode_js_1.encodeNonAsciiHTML)(input)
  95. : (0, escape_js_1.encodeXML)(input);
  96. }
  97. // eslint-disable-next-line unicorn/no-useless-switch-case
  98. case EncodingMode.Extensive:
  99. default: {
  100. return level === EntityLevel.HTML
  101. ? (0, encode_js_1.encodeHTML)(input)
  102. : (0, escape_js_1.encodeXML)(input);
  103. }
  104. }
  105. }
  106. var escape_js_2 = require("./escape.js");
  107. Object.defineProperty(exports, "encodeXML", { enumerable: true, get: function () { return escape_js_2.encodeXML; } });
  108. Object.defineProperty(exports, "escape", { enumerable: true, get: function () { return escape_js_2.escape; } });
  109. Object.defineProperty(exports, "escapeUTF8", { enumerable: true, get: function () { return escape_js_2.escapeUTF8; } });
  110. Object.defineProperty(exports, "escapeAttribute", { enumerable: true, get: function () { return escape_js_2.escapeAttribute; } });
  111. Object.defineProperty(exports, "escapeText", { enumerable: true, get: function () { return escape_js_2.escapeText; } });
  112. var encode_js_2 = require("./encode.js");
  113. Object.defineProperty(exports, "encodeHTML", { enumerable: true, get: function () { return encode_js_2.encodeHTML; } });
  114. Object.defineProperty(exports, "encodeNonAsciiHTML", { enumerable: true, get: function () { return encode_js_2.encodeNonAsciiHTML; } });
  115. // Legacy aliases (deprecated)
  116. Object.defineProperty(exports, "encodeHTML4", { enumerable: true, get: function () { return encode_js_2.encodeHTML; } });
  117. Object.defineProperty(exports, "encodeHTML5", { enumerable: true, get: function () { return encode_js_2.encodeHTML; } });
  118. var decode_js_2 = require("./decode.js");
  119. Object.defineProperty(exports, "EntityDecoder", { enumerable: true, get: function () { return decode_js_2.EntityDecoder; } });
  120. Object.defineProperty(exports, "DecodingMode", { enumerable: true, get: function () { return decode_js_2.DecodingMode; } });
  121. Object.defineProperty(exports, "decodeXML", { enumerable: true, get: function () { return decode_js_2.decodeXML; } });
  122. Object.defineProperty(exports, "decodeHTML", { enumerable: true, get: function () { return decode_js_2.decodeHTML; } });
  123. Object.defineProperty(exports, "decodeHTMLStrict", { enumerable: true, get: function () { return decode_js_2.decodeHTMLStrict; } });
  124. Object.defineProperty(exports, "decodeHTMLAttribute", { enumerable: true, get: function () { return decode_js_2.decodeHTMLAttribute; } });
  125. // Legacy aliases (deprecated)
  126. Object.defineProperty(exports, "decodeHTML4", { enumerable: true, get: function () { return decode_js_2.decodeHTML; } });
  127. Object.defineProperty(exports, "decodeHTML5", { enumerable: true, get: function () { return decode_js_2.decodeHTML; } });
  128. Object.defineProperty(exports, "decodeHTML4Strict", { enumerable: true, get: function () { return decode_js_2.decodeHTMLStrict; } });
  129. Object.defineProperty(exports, "decodeHTML5Strict", { enumerable: true, get: function () { return decode_js_2.decodeHTMLStrict; } });
  130. Object.defineProperty(exports, "decodeXMLStrict", { enumerable: true, get: function () { return decode_js_2.decodeXML; } });
  131. //# sourceMappingURL=index.js.map