@cjser/html-escaper 3.0.3-cjser.2

package/LICENSE.txt

@@ -0,0 +1,19 @@
+Copyright (C) 2017-present by Andrea Giammarchi - @WebReflection
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

package/README.md

@@ -0,0 +1,115 @@
+# html-escaper
+
+[![Downloads](https://img.shields.io/npm/dm/html-escaper.svg)](https://www.npmjs.com/package/html-escaper) [![Build Status](https://travis-ci.org/WebReflection/html-escaper.svg?branch=master)](https://travis-ci.org/WebReflection/html-escaper) [![Coverage Status](https://coveralls.io/repos/github/WebReflection/html-escaper/badge.svg?branch=master)](https://coveralls.io/github/WebReflection/html-escaper?branch=master) ![WebReflection status](https://offline.report/status/webreflection.svg)
+
+A simple module to escape/unescape common problematic entities.
+
+#### Go sloppy if you like!
+
+If you'd like to deal with any kind of input, including `null` or `undefined`, and even `symbol` kind, check [html-sloppy-escaper](https://www.npmjs.com/package/html-sloppy-escaper) out: it's this very same module, except it never throws errors 👍
+
+
+## V3 ESM Only Release
+
+The version 3 of this module ditches entirely legacy browsers and _nodejs_ with broken loaders, such as `v13.0.0` and `v13.1.0`.
+
+As the code is basically identical, simply stick with version 2 if you have any issue with this one 👋
+
+
+### How
+This package is available in npm so `npm install html-escaper` is all you need to do, using eventually the global flag too.
+
+Once the module is present
+```js
+import {escape, unescape} from 'html-escaper';
+
+escape('string');
+unescape('escaped string');
+```
+
+
+### Why
+there is basically one rule only: do not **ever** replace one char after another if you are transforming a string into another.
+
+```js
+// WARNING: THIS IS WRONG
+// if you are that kind of dev that does this
+function escape(s) {
+  return s.replace(/&/g, "&")
+          .replace(/</g, "&lt;")
+          .replace(/>/g, "&gt;")
+          .replace(/'/g, "&#39;")
+          .replace(/"/g, "&quot;");
+}
+
+// you might be the same dev that does this too
+function unescape(s) {
+  return s.replace(/&amp;/g, "&")
+          .replace(/&lt;/g, "<")
+          .replace(/&gt;/g, ">")
+          .replace(/&#39;/g, "'")
+          .replace(/&quot;/g, '"');
+}
+
+// guess what we have here ?
+unescape('&amp;lt;');
+
+// now guess this XSS too ...
+unescape('&amp;lt;script&amp;gt;alert("yo")&amp;lt;/script&amp;gt;');
+
+
+```
+
+The last example will produce `<script>alert("yo")</script>` instead of the expected `&lt;script&gt;alert("yo")&lt;/script&gt;`.
+
+Nothing like this could possibly happen if we grab all chars at once and either ways.
+It's just a fortunate case that after swapping `&` with `&amp;` no other replace will be affected, but it's not portable and universally a bad practice.
+
+Grab all chars at once, no excuses!
+
+
+
+**more details**
+As somebody might think it's an `unescape` issue only, it's not. Being an anti-pattern with side effects works both ways.
+
+As example, changing the order of the replacement in escaping would produce the unexpected:
+```js
+function escape(s) {
+  return s.replace(/</g, "&lt;")
+          .replace(/>/g, "&gt;")
+          .replace(/'/g, "&#39;")
+          .replace(/"/g, "&quot;")
+          .replace(/&/g, "&amp;");
+}
+
+escape('<'); // &amp;lt; instead of &lt;
+```
+If we do not want to code with the fear that the order wasn't perfect or that our order in either escaping or unescaping is different from the order another method or function used, if we understand the issue and we agree it's potentially a disaster prone approach, if we add the fact in this case creating 4 RegExp objects each time and invoking 4 times `.replace` trough the `String.prototype` is also potentially slower than creating one function only holding one object, or holding the function too, we should agree there is not absolutely any valid reason to keep proposing a char-by-char implementation.
+
+We have proofs this approach can fail already so ... why should we risk? Just avoid and grab all chars at once or simply use this tiny utility.
+
+### Backtick
+Internt explorer < 9 has [some backtick issue](https://html5sec.org/#102)
+
+For compatibility sake with common server-side HTML entities encoders and decoders, and in order to have the most reliable I/O, this little utility will NOT fix this IE < 9 problem.
+
+It is also important to note that if we create valid HTML and we set attributes at runtime through this utility, backticks in strings cannot possibly affect attribute behaviors.
+
+```js
+var img = new Image();
+img.src = html.escape(
+  'x` `<script>alert(1)</script>"` `'
+);
+// it won't cause problems even in IE < 9
+```
+
+**However**, if you use `innerHTML` and you target IE < 9 then [this **might** be a problem](https://github.com/nette/nette/issues/1496).
+
+Accordingly, if you need more chars and/or backticks to be escaped and unescaped, feel free to use alternatives like [lodash](https://github.com/lodash/lodash) or [he](https://www.npmjs.com/package/he)
+
+Here a bit more of [my POV](https://github.com/WebReflection/html-escaper/commit/52d554fc6e8583b6ffdd357967cf71962fc07cf6#commitcomment-10625122) and why I haven't implemented same thing alternatives did. Good news: those are alternatives ;-)
+
+## cjser
+
+This package is a CommonJS-compatible build generated by cjser for projects that still need `require()` support. The source version matches the original npm package version, with a cjser prerelease suffix for this generated build.
+Original repository: https://github.com/WebReflection/html-escaper

package/cjs/index.js

@@ -0,0 +1,74 @@
+'use strict';
+/**
+ * Copyright (C) 2017-present by Andrea Giammarchi - @WebReflection
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy
+ * of this software and associated documentation files (the "Software"), to deal
+ * in the Software without restriction, including without limitation the rights
+ * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ * copies of the Software, and to permit persons to whom the Software is
+ * furnished to do so, subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in
+ * all copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+ * THE SOFTWARE.
+ */
+
+const {replace} = '';
+
+// escape
+const es = /&(?:amp|#38|lt|#60|gt|#62|apos|#39|quot|#34);/g;
+const ca = /[&<>'"]/g;
+
+const esca = {
+  '&': '&amp;',
+  '<': '&lt;',
+  '>': '&gt;',
+  "'": '&#39;',
+  '"': '&quot;'
+};
+const pe = m => esca[m];
+
+/**
+ * Safely escape HTML entities such as `&`, `<`, `>`, `"`, and `'`.
+ * @param {string} es the input to safely escape
+ * @returns {string} the escaped input, and it **throws** an error if
+ *  the input type is unexpected, except for boolean and numbers,
+ *  converted as string.
+ */
+const escape = es => replace.call(es, ca, pe);
+exports.escape = escape;
+
+
+// unescape
+const unes = {
+  '&amp;': '&',
+  '&#38;': '&',
+  '&lt;': '<',
+  '&#60;': '<',
+  '&gt;': '>',
+  '&#62;': '>',
+  '&apos;': "'",
+  '&#39;': "'",
+  '&quot;': '"',
+  '&#34;': '"'
+};
+const cape = m => unes[m];
+
+/**
+ * Safely unescape previously escaped entities such as `&`, `<`, `>`, `"`,
+ * and `'`.
+ * @param {string} un a previously escaped string
+ * @returns {string} the unescaped input, and it **throws** an error if
+ *  the input type is unexpected, except for boolean and numbers,
+ *  converted as string.
+ */
+const unescape = un => replace.call(un, es, cape);
+exports.unescape = unescape;

package/cjs/package.json

@@ -0,0 +1 @@
+{"type":"commonjs"}

package/dist-cjser/index.cjs

@@ -0,0 +1,56 @@
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __export = (target, all) => {
+  for (var name in all)
+    __defProp(target, name, { get: all[name], enumerable: true });
+};
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+
+// packages/@cjser/html-escaper.tmp-26-1789317420938/esm/index.js
+var index_exports = {};
+__export(index_exports, {
+  escape: () => escape,
+  unescape: () => unescape
+});
+module.exports = __toCommonJS(index_exports);
+var { replace } = "";
+var es = /&(?:amp|#38|lt|#60|gt|#62|apos|#39|quot|#34);/g;
+var ca = /[&<>'"]/g;
+var esca = {
+  "&": "&amp;",
+  "<": "&lt;",
+  ">": "&gt;",
+  "'": "&#39;",
+  '"': "&quot;"
+};
+var pe = (m) => esca[m];
+var escape = (es2) => replace.call(es2, ca, pe);
+var unes = {
+  "&amp;": "&",
+  "&#38;": "&",
+  "&lt;": "<",
+  "&#60;": "<",
+  "&gt;": ">",
+  "&#62;": ">",
+  "&apos;": "'",
+  "&#39;": "'",
+  "&quot;": '"',
+  "&#34;": '"'
+};
+var cape = (m) => unes[m];
+var unescape = (un) => replace.call(un, es, cape);
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  escape,
+  unescape
+});

package/esm/index.js

@@ -0,0 +1,71 @@
+/**
+ * Copyright (C) 2017-present by Andrea Giammarchi - @WebReflection
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy
+ * of this software and associated documentation files (the "Software"), to deal
+ * in the Software without restriction, including without limitation the rights
+ * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ * copies of the Software, and to permit persons to whom the Software is
+ * furnished to do so, subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in
+ * all copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+ * THE SOFTWARE.
+ */
+
+const {replace} = '';
+
+// escape
+const es = /&(?:amp|#38|lt|#60|gt|#62|apos|#39|quot|#34);/g;
+const ca = /[&<>'"]/g;
+
+const esca = {
+  '&': '&amp;',
+  '<': '&lt;',
+  '>': '&gt;',
+  "'": '&#39;',
+  '"': '&quot;'
+};
+const pe = m => esca[m];
+
+/**
+ * Safely escape HTML entities such as `&`, `<`, `>`, `"`, and `'`.
+ * @param {string} es the input to safely escape
+ * @returns {string} the escaped input, and it **throws** an error if
+ *  the input type is unexpected, except for boolean and numbers,
+ *  converted as string.
+ */
+export const escape = es => replace.call(es, ca, pe);
+
+
+// unescape
+const unes = {
+  '&amp;': '&',
+  '&#38;': '&',
+  '&lt;': '<',
+  '&#60;': '<',
+  '&gt;': '>',
+  '&#62;': '>',
+  '&apos;': "'",
+  '&#39;': "'",
+  '&quot;': '"',
+  '&#34;': '"'
+};
+const cape = m => unes[m];
+
+/**
+ * Safely unescape previously escaped entities such as `&`, `<`, `>`, `"`,
+ * and `'`.
+ * @param {string} un a previously escaped string
+ * @returns {string} the unescaped input, and it **throws** an error if
+ *  the input type is unexpected, except for boolean and numbers,
+ *  converted as string.
+ */
+export const unescape = un => replace.call(un, es, cape);

package/index.js

@@ -0,0 +1,81 @@
+var html = (function (exports) {
+  'use strict';
+
+  /**
+   * Copyright (C) 2017-present by Andrea Giammarchi - @WebReflection
+   *
+   * Permission is hereby granted, free of charge, to any person obtaining a copy
+   * of this software and associated documentation files (the "Software"), to deal
+   * in the Software without restriction, including without limitation the rights
+   * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+   * copies of the Software, and to permit persons to whom the Software is
+   * furnished to do so, subject to the following conditions:
+   *
+   * The above copyright notice and this permission notice shall be included in
+   * all copies or substantial portions of the Software.
+   *
+   * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+   * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+   * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+   * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+   * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+   * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+   * THE SOFTWARE.
+   */
+
+  const {replace} = '';
+
+  // escape
+  const es = /&(?:amp|#38|lt|#60|gt|#62|apos|#39|quot|#34);/g;
+  const ca = /[&<>'"]/g;
+
+  const esca = {
+    '&': '&amp;',
+    '<': '&lt;',
+    '>': '&gt;',
+    "'": '&#39;',
+    '"': '&quot;'
+  };
+  const pe = m => esca[m];
+
+  /**
+   * Safely escape HTML entities such as `&`, `<`, `>`, `"`, and `'`.
+   * @param {string} es the input to safely escape
+   * @returns {string} the escaped input, and it **throws** an error if
+   *  the input type is unexpected, except for boolean and numbers,
+   *  converted as string.
+   */
+  const escape = es => replace.call(es, ca, pe);
+
+
+  // unescape
+  const unes = {
+    '&amp;': '&',
+    '&#38;': '&',
+    '&lt;': '<',
+    '&#60;': '<',
+    '&gt;': '>',
+    '&#62;': '>',
+    '&apos;': "'",
+    '&#39;': "'",
+    '&quot;': '"',
+    '&#34;': '"'
+  };
+  const cape = m => unes[m];
+
+  /**
+   * Safely unescape previously escaped entities such as `&`, `<`, `>`, `"`,
+   * and `'`.
+   * @param {string} un a previously escaped string
+   * @returns {string} the unescaped input, and it **throws** an error if
+   *  the input type is unexpected, except for boolean and numbers,
+   *  converted as string.
+   */
+  const unescape = un => replace.call(un, es, cape);
+
+  exports.escape = escape;
+  exports.unescape = unescape;
+
+  return exports;
+
+}({}));

package/min.js

@@ -0,0 +1 @@
+var html=function(t){"use strict";const{replace:a}="",l=/&(?:amp|#38|lt|#60|gt|#62|apos|#39|quot|#34);/g,c=/[&<>'"]/g,e={"&":"&amp;","<":"&lt;",">":"&gt;","'":"&#39;",'"':"&quot;"},p=t=>e[t],o={"&amp;":"&","&#38;":"&","&lt;":"<","&#60;":"<","&gt;":">","&#62;":">","&apos;":"'","&#39;":"'","&quot;":'"',"&#34;":'"'},s=t=>o[t];return t.escape=(t=>a.call(t,c,p)),t.unescape=(t=>a.call(t,l,s)),t}({});

package/package.json

@@ -0,0 +1,74 @@
+{
+  "name": "@cjser/html-escaper",
+  "version": "3.0.3-cjser.2",
+  "description": "fast and safe way to escape and unescape &<>'\" chars",
+  "main": "./dist-cjser/index.cjs",
+  "unpkg": "min.js",
+  "scripts": {
+    "build": "npm run cjs && npm run rollup && npm run minify && npm test && npm run size",
+    "cjs": "ascjs esm cjs",
+    "coveralls": "c8 report --reporter=text-lcov | coveralls",
+    "minify": "uglifyjs index.js --comments=/^!/ --compress --mangle -o min.js",
+    "rollup": "rollup --config rollup.config.js",
+    "size": "cat index.js | wc -c;cat min.js | wc -c;gzip -c min.js | wc -c",
+    "test": "c8 node ./test/index.js"
+  },
+  "module": "./esm/index.js",
+  "type": "module",
+  "exports": {
+    "require": "./dist-cjser/index.cjs",
+    "import": "./esm/index.js",
+    "default": "./cjs/index.js"
+  },
+  "repository": {
+    "type": "git",
+    "url": "https://code.moenext.com/3rdeye/cjser.git"
+  },
+  "keywords": [
+    "html",
+    "escape",
+    "encode",
+    "unescape",
+    "decode",
+    "entities"
+  ],
+  "author": "Andrea Giammarchi",
+  "license": "MIT",
+  "bugs": {
+    "url": "https://github.com/WebReflection/html-escaper/issues"
+  },
+  "homepage": "https://github.com/WebReflection/html-escaper",
+  "devDependencies": {
+    "ascjs": "^5.0.1",
+    "c8": "^7.6.0",
+    "coveralls": "^3.1.0",
+    "rollup": "^2.39.0",
+    "uglify-es": "^3.3.9"
+  },
+  "cjser": {
+    "sourceVersion": "3.0.3",
+    "cjserVersion": 2,
+    "original": {
+      "name": "html-escaper",
+      "version": "3.0.3",
+      "main": "./cjs/index.js",
+      "exports": {
+        "import": "./esm/index.js",
+        "default": "./cjs/index.js"
+      },
+      "repository": {
+        "type": "git",
+        "url": "https://github.com/WebReflection/html-escaper.git"
+      },
+      "scripts": {
+        "build": "npm run cjs && npm run rollup && npm run minify && npm test && npm run size",
+        "cjs": "ascjs esm cjs",
+        "coveralls": "c8 report --reporter=text-lcov | coveralls",
+        "minify": "uglifyjs index.js --comments=/^!/ --compress --mangle -o min.js",
+        "rollup": "rollup --config rollup.config.js",
+        "size": "cat index.js | wc -c;cat min.js | wc -c;gzip -c min.js | wc -c",
+        "test": "c8 node ./test/index.js"
+      }
+    }
+  }
+}

package/test/index.js

@@ -0,0 +1,23 @@
+delete Object.freeze;
+
+var html = require('../cjs');
+
+console.assert(
+  html.escape('&<>\'"') === '&amp;&lt;&gt;&#39;&quot;',
+  'correct escape'
+);
+
+console.assert(
+  html.escape('<>\'"&') === '&lt;&gt;&#39;&quot;&amp;',
+  'correct inverted escape'
+);
+
+console.assert(
+  '&<>\'"' === html.unescape('&amp;&lt;&gt;&#39;&quot;'),
+  'correct unescape'
+);
+
+console.assert(
+  '<>\'"&' === html.unescape('&lt;&gt;&#39;&quot;&amp;'),
+  'correct inverted unescape'
+);

package/test/package.json

@@ -0,0 +1 @@
+{"type":"commonjs"}