@prairielearn/html 2.1.1 → 3.0.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -1,3 +0,0 @@
1
- @prairielearn/html:build: cache hit, replaying output b42467e94478b467
2
- @prairielearn/html:build: warning package.json: No license field
3
- @prairielearn/html:build: $ tsc
package/CHANGELOG.md CHANGED
@@ -1,5 +1,17 @@
1
1
  # @prairielearn/html
2
2
 
3
+ ## 3.0.0
4
+
5
+ ### Major Changes
6
+
7
+ - 638d27585: Render booleans in templates
8
+
9
+ ## 2.2.0
10
+
11
+ ### Minor Changes
12
+
13
+ - 915320e1f: Support interpolating BigInt values
14
+
3
15
  ## 2.1.1
4
16
 
5
17
  ### Patch Changes
package/dist/index.d.ts CHANGED
@@ -4,7 +4,7 @@ export declare class HtmlSafeString {
4
4
  constructor(strings: ReadonlyArray<string>, values: unknown[]);
5
5
  toString(): string;
6
6
  }
7
- export declare type HtmlValue = string | number | boolean | HtmlSafeString | undefined | null | HtmlValue[];
7
+ export type HtmlValue = string | number | boolean | bigint | HtmlSafeString | undefined | null | HtmlValue[];
8
8
  export declare function html(strings: TemplateStringsArray, ...values: HtmlValue[]): HtmlSafeString;
9
9
  /**
10
10
  * Pre-escpapes the rendered HTML. Useful for when you want to inline the HTML
package/dist/index.js CHANGED
@@ -8,7 +8,7 @@ const ENCODE_HTML_RULES = {
8
8
  '"': '&#34;',
9
9
  "'": '&#39;',
10
10
  };
11
- var MATCH_HTML = /[&<>'"]/g;
11
+ const MATCH_HTML = /[&<>'"]/g;
12
12
  function encodeCharacter(c) {
13
13
  return ENCODE_HTML_RULES[c] || c;
14
14
  }
@@ -16,7 +16,7 @@ function encodeCharacter(c) {
16
16
  * Based on the `escapeXML` function from the `ejs` library.
17
17
  */
18
18
  function escapeHtmlRaw(value) {
19
- return value == undefined ? '' : String(value).replace(MATCH_HTML, encodeCharacter);
19
+ return value == null ? '' : String(value).replace(MATCH_HTML, encodeCharacter);
20
20
  }
21
21
  function escapeValue(value) {
22
22
  if (value instanceof HtmlSafeString) {
@@ -26,7 +26,10 @@ function escapeValue(value) {
26
26
  else if (Array.isArray(value)) {
27
27
  return value.map((val) => escapeValue(val)).join('');
28
28
  }
29
- else if (typeof value === 'string' || typeof value === 'number') {
29
+ else if (typeof value === 'string' ||
30
+ typeof value === 'number' ||
31
+ typeof value === 'bigint' ||
32
+ typeof value === 'boolean') {
30
33
  return escapeHtmlRaw(String(value));
31
34
  }
32
35
  else if (value == null) {
@@ -37,8 +40,8 @@ function escapeValue(value) {
37
40
  throw new Error(`Cannot interpolate object in template: ${JSON.stringify(value)}`);
38
41
  }
39
42
  else {
40
- // This is boolean - don't render anything here.
41
- return '';
43
+ // There shouldn't be any other types
44
+ throw new Error(`Unexpected type in template: ${typeof value} for value ${JSON.stringify(value)}`);
42
45
  }
43
46
  }
44
47
  // Based on https://github.com/Janpot/escape-html-template-tag
package/dist/index.js.map CHANGED
@@ -1 +1 @@
1
- {"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;AAAA,MAAM,iBAAiB,GAAG;IACxB,GAAG,EAAE,OAAO;IACZ,GAAG,EAAE,MAAM;IACX,GAAG,EAAE,MAAM;IACX,GAAG,EAAE,OAAO;IACZ,GAAG,EAAE,OAAO;CACb,CAAC;AACF,IAAI,UAAU,GAAG,UAAU,CAAC;AAE5B,SAAS,eAAe,CAAC,CAAS;IAChC,OAAO,iBAAiB,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC;AACnC,CAAC;AAED;;GAEG;AACH,SAAS,aAAa,CAAC,KAAa;IAClC,OAAO,KAAK,IAAI,SAAS,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,OAAO,CAAC,UAAU,EAAE,eAAe,CAAC,CAAC;AACtF,CAAC;AAED,SAAS,WAAW,CAAC,KAAc;IACjC,IAAI,KAAK,YAAY,cAAc,EAAE;QACnC,mBAAmB;QACnB,OAAO,KAAK,CAAC,QAAQ,EAAE,CAAC;KACzB;SAAM,IAAI,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,EAAE;QAC/B,OAAO,KAAK,CAAC,GAAG,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,WAAW,CAAC,GAAG,CAAC,CAAC,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;KACtD;SAAM,IAAI,OAAO,KAAK,KAAK,QAAQ,IAAI,OAAO,KAAK,KAAK,QAAQ,EAAE;QACjE,OAAO,aAAa,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC;KACrC;SAAM,IAAI,KAAK,IAAI,IAAI,EAAE;QACxB,sCAAsC;QACtC,OAAO,EAAE,CAAC;KACX;SAAM,IAAI,OAAO,KAAK,KAAK,QAAQ,EAAE;QACpC,MAAM,IAAI,KAAK,CAAC,0CAA0C,IAAI,CAAC,SAAS,CAAC,KAAK,CAAC,EAAE,CAAC,CAAC;KACpF;SAAM;QACL,gDAAgD;QAChD,OAAO,EAAE,CAAC;KACX;AACH,CAAC;AAED,8DAA8D;AAC9D,MAAa,cAAc;IAIzB,YAAY,OAA8B,EAAE,MAAiB;QAC3D,IAAI,CAAC,OAAO,GAAG,OAAO,CAAC;QACvB,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC;IACvB,CAAC;IAED,QAAQ;QACN,OAAO,IAAI,CAAC,MAAM,CAAC,MAAM,CAAS,CAAC,GAAG,EAAE,GAAG,EAAE,CAAC,EAAE,EAAE;YAChD,OAAO,GAAG,GAAG,WAAW,CAAC,GAAG,CAAC,GAAG,IAAI,CAAC,OAAO,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC;QACtD,CAAC,EAAE,IAAI,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,CAAC;IACtB,CAAC;CACF;AAdD,wCAcC;AAID,SAAgB,IAAI,CAAC,OAA6B,EAAE,GAAG,MAAmB;IACxE,OAAO,IAAI,cAAc,CAAC,OAAO,EAAE,MAAM,CAAC,CAAC;AAC7C,CAAC;AAFD,oBAEC;AAED;;;;GAIG;AACH,SAAgB,UAAU,CAAC,IAAoB;IAC7C,OAAO,UAAU,CAAC,aAAa,CAAC,IAAI,CAAC,QAAQ,EAAE,CAAC,CAAC,CAAC;AACpD,CAAC;AAFD,gCAEC;AAED;;;;;;GAMG;AACH,SAAgB,UAAU,CAAC,KAAa;IACtC,OAAO,IAAI,cAAc,CAAC,CAAC,KAAK,CAAC,EAAE,EAAE,CAAC,CAAC;AACzC,CAAC;AAFD,gCAEC"}
1
+ {"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;AAAA,MAAM,iBAAiB,GAA2B;IAChD,GAAG,EAAE,OAAO;IACZ,GAAG,EAAE,MAAM;IACX,GAAG,EAAE,MAAM;IACX,GAAG,EAAE,OAAO;IACZ,GAAG,EAAE,OAAO;CACb,CAAC;AACF,MAAM,UAAU,GAAG,UAAU,CAAC;AAE9B,SAAS,eAAe,CAAC,CAAS;IAChC,OAAO,iBAAiB,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC;AACnC,CAAC;AAED;;GAEG;AACH,SAAS,aAAa,CAAC,KAAa;IAClC,OAAO,KAAK,IAAI,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,OAAO,CAAC,UAAU,EAAE,eAAe,CAAC,CAAC;AACjF,CAAC;AAED,SAAS,WAAW,CAAC,KAAc;IACjC,IAAI,KAAK,YAAY,cAAc,EAAE;QACnC,mBAAmB;QACnB,OAAO,KAAK,CAAC,QAAQ,EAAE,CAAC;KACzB;SAAM,IAAI,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,EAAE;QAC/B,OAAO,KAAK,CAAC,GAAG,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,WAAW,CAAC,GAAG,CAAC,CAAC,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;KACtD;SAAM,IACL,OAAO,KAAK,KAAK,QAAQ;QACzB,OAAO,KAAK,KAAK,QAAQ;QACzB,OAAO,KAAK,KAAK,QAAQ;QACzB,OAAO,KAAK,KAAK,SAAS,EAC1B;QACA,OAAO,aAAa,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC;KACrC;SAAM,IAAI,KAAK,IAAI,IAAI,EAAE;QACxB,sCAAsC;QACtC,OAAO,EAAE,CAAC;KACX;SAAM,IAAI,OAAO,KAAK,KAAK,QAAQ,EAAE;QACpC,MAAM,IAAI,KAAK,CAAC,0CAA0C,IAAI,CAAC,SAAS,CAAC,KAAK,CAAC,EAAE,CAAC,CAAC;KACpF;SAAM;QACL,qCAAqC;QACrC,MAAM,IAAI,KAAK,CACb,gCAAgC,OAAO,KAAK,cAAc,IAAI,CAAC,SAAS,CAAC,KAAK,CAAC,EAAE,CAClF,CAAC;KACH;AACH,CAAC;AAED,8DAA8D;AAC9D,MAAa,cAAc;IAIzB,YAAY,OAA8B,EAAE,MAAiB;QAC3D,IAAI,CAAC,OAAO,GAAG,OAAO,CAAC;QACvB,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC;IACvB,CAAC;IAED,QAAQ;QACN,OAAO,IAAI,CAAC,MAAM,CAAC,MAAM,CAAS,CAAC,GAAG,EAAE,GAAG,EAAE,CAAC,EAAE,EAAE;YAChD,OAAO,GAAG,GAAG,WAAW,CAAC,GAAG,CAAC,GAAG,IAAI,CAAC,OAAO,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC;QACtD,CAAC,EAAE,IAAI,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,CAAC;IACtB,CAAC;CACF;AAdD,wCAcC;AAYD,SAAgB,IAAI,CAAC,OAA6B,EAAE,GAAG,MAAmB;IACxE,OAAO,IAAI,cAAc,CAAC,OAAO,EAAE,MAAM,CAAC,CAAC;AAC7C,CAAC;AAFD,oBAEC;AAED;;;;GAIG;AACH,SAAgB,UAAU,CAAC,IAAoB;IAC7C,OAAO,UAAU,CAAC,aAAa,CAAC,IAAI,CAAC,QAAQ,EAAE,CAAC,CAAC,CAAC;AACpD,CAAC;AAFD,gCAEC;AAED;;;;;;GAMG;AACH,SAAgB,UAAU,CAAC,KAAa;IACtC,OAAO,IAAI,cAAc,CAAC,CAAC,KAAK,CAAC,EAAE,EAAE,CAAC,CAAC;AACzC,CAAC;AAFD,gCAEC"}
@@ -9,6 +9,16 @@ describe('html', () => {
9
9
  it('interpolates multiple values', () => {
10
10
  chai_1.assert.equal((0, index_1.html) `<p>${'cats'} and ${'dogs'}</p>`.toString(), '<p>cats and dogs</p>');
11
11
  });
12
+ it('interpolates a number', () => {
13
+ chai_1.assert.equal((0, index_1.html) `<p>${123}</p>`.toString(), '<p>123</p>');
14
+ });
15
+ it('interpolates a bigint', () => {
16
+ chai_1.assert.equal((0, index_1.html) `<p>${123n}</p>`.toString(), '<p>123</p>');
17
+ });
18
+ it('interpolates a boolean', () => {
19
+ chai_1.assert.equal((0, index_1.html) `<p>${true}</p>`.toString(), '<p>true</p>');
20
+ chai_1.assert.equal((0, index_1.html) `<p>${false}</p>`.toString(), '<p>false</p>');
21
+ });
12
22
  it('escapes values when rendering array', () => {
13
23
  const arr = ['cats>', '<dogs'];
14
24
  chai_1.assert.equal(
@@ -23,12 +33,9 @@ describe('html', () => {
23
33
  });
24
34
  it('errors when interpolating object', () => {
25
35
  chai_1.assert.throws(
26
- // @ts-expect-error
36
+ // @ts-expect-error -- Testing runtime behavior of bad input.
27
37
  () => (0, index_1.html) `<p>${{ foo: 'bar' }}</p>`.toString(), 'Cannot interpolate object in template');
28
38
  });
29
- it('omits boolean values from template', () => {
30
- chai_1.assert.equal((0, index_1.html) `<p>${true}${false}</p>`.toString(), '<p></p>');
31
- });
32
39
  it('omits nullish values from template', () => {
33
40
  chai_1.assert.equal((0, index_1.html) `<p>${null}${undefined}</p>`.toString(), '<p></p>');
34
41
  });
@@ -1 +1 @@
1
- {"version":3,"file":"index.test.js","sourceRoot":"","sources":["../src/index.test.ts"],"names":[],"mappings":";;AAAA,+BAA8B;AAE9B,mCAA2C;AAE3C,QAAQ,CAAC,MAAM,EAAE,GAAG,EAAE;IACpB,EAAE,CAAC,sBAAsB,EAAE,GAAG,EAAE;QAC9B,aAAM,CAAC,KAAK,CAAC,IAAA,YAAI,EAAA,MAAM,UAAU,MAAM,CAAC,QAAQ,EAAE,EAAE,uBAAuB,CAAC,CAAC;IAC/E,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,8BAA8B,EAAE,GAAG,EAAE;QACtC,aAAM,CAAC,KAAK,CAAC,IAAA,YAAI,EAAA,MAAM,MAAM,QAAQ,MAAM,MAAM,CAAC,QAAQ,EAAE,EAAE,sBAAsB,CAAC,CAAC;IACxF,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,qCAAqC,EAAE,GAAG,EAAE;QAC7C,MAAM,GAAG,GAAG,CAAC,OAAO,EAAE,OAAO,CAAC,CAAC;QAC/B,aAAM,CAAC,KAAK;QACV,kBAAkB;QAClB,IAAA,YAAI,EAAA,OAAO,GAAG,OAAO,CAAC,QAAQ,EAAE,EAChC,2BAA2B,CAC5B,CAAC;IACJ,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,oDAAoD,EAAE,GAAG,EAAE;QAC5D,MAAM,GAAG,GAAG,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;QAC7B,aAAM,CAAC,KAAK;QACV,kBAAkB;QAClB,IAAA,YAAI,EAAA,OAAO,GAAG,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,IAAA,YAAI,EAAA,OAAO,CAAC,OAAO,CAAC,OAAO,CAAC,QAAQ,EAAE,EAChE,qCAAqC,CACtC,CAAC;IACJ,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,kCAAkC,EAAE,GAAG,EAAE;QAC1C,aAAM,CAAC,MAAM;QACX,mBAAmB;QACnB,GAAG,EAAE,CAAC,IAAA,YAAI,EAAA,MAAM,EAAE,GAAG,EAAE,KAAK,EAAE,MAAM,CAAC,QAAQ,EAAE,EAC/C,uCAAuC,CACxC,CAAC;IACJ,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,oCAAoC,EAAE,GAAG,EAAE;QAC5C,aAAM,CAAC,KAAK,CAAC,IAAA,YAAI,EAAA,MAAM,IAAI,GAAG,KAAK,MAAM,CAAC,QAAQ,EAAE,EAAE,SAAS,CAAC,CAAC;IACnE,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,oCAAoC,EAAE,GAAG,EAAE;QAC5C,aAAM,CAAC,KAAK,CAAC,IAAA,YAAI,EAAA,MAAM,IAAI,GAAG,SAAS,MAAM,CAAC,QAAQ,EAAE,EAAE,SAAS,CAAC,CAAC;IACvE,CAAC,CAAC,CAAC;AACL,CAAC,CAAC,CAAC;AAEH,QAAQ,CAAC,YAAY,EAAE,GAAG,EAAE;IAC1B,EAAE,CAAC,uBAAuB,EAAE,GAAG,EAAE;QAC/B,aAAM,CAAC,KAAK,CAAC,IAAA,kBAAU,EAAC,IAAA,YAAI,EAAA,cAAc,CAAC,CAAC,QAAQ,EAAE,EAAE,0BAA0B,CAAC,CAAC;IACtF,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,mCAAmC,EAAE,GAAG,EAAE;QAC3C,aAAM,CAAC,KAAK,CAAC,IAAA,YAAI,EAAA,IAAI,IAAA,kBAAU,EAAC,IAAA,YAAI,EAAA,SAAS,CAAC,GAAG,CAAC,QAAQ,EAAE,EAAE,uBAAuB,CAAC,CAAC;IACzF,CAAC,CAAC,CAAC;AACL,CAAC,CAAC,CAAC"}
1
+ {"version":3,"file":"index.test.js","sourceRoot":"","sources":["../src/index.test.ts"],"names":[],"mappings":";;AAAA,+BAA8B;AAE9B,mCAA2C;AAE3C,QAAQ,CAAC,MAAM,EAAE,GAAG,EAAE;IACpB,EAAE,CAAC,sBAAsB,EAAE,GAAG,EAAE;QAC9B,aAAM,CAAC,KAAK,CAAC,IAAA,YAAI,EAAA,MAAM,UAAU,MAAM,CAAC,QAAQ,EAAE,EAAE,uBAAuB,CAAC,CAAC;IAC/E,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,8BAA8B,EAAE,GAAG,EAAE;QACtC,aAAM,CAAC,KAAK,CAAC,IAAA,YAAI,EAAA,MAAM,MAAM,QAAQ,MAAM,MAAM,CAAC,QAAQ,EAAE,EAAE,sBAAsB,CAAC,CAAC;IACxF,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,uBAAuB,EAAE,GAAG,EAAE;QAC/B,aAAM,CAAC,KAAK,CAAC,IAAA,YAAI,EAAA,MAAM,GAAG,MAAM,CAAC,QAAQ,EAAE,EAAE,YAAY,CAAC,CAAC;IAC7D,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,uBAAuB,EAAE,GAAG,EAAE;QAC/B,aAAM,CAAC,KAAK,CAAC,IAAA,YAAI,EAAA,MAAM,IAAI,MAAM,CAAC,QAAQ,EAAE,EAAE,YAAY,CAAC,CAAC;IAC9D,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,wBAAwB,EAAE,GAAG,EAAE;QAChC,aAAM,CAAC,KAAK,CAAC,IAAA,YAAI,EAAA,MAAM,IAAI,MAAM,CAAC,QAAQ,EAAE,EAAE,aAAa,CAAC,CAAC;QAC7D,aAAM,CAAC,KAAK,CAAC,IAAA,YAAI,EAAA,MAAM,KAAK,MAAM,CAAC,QAAQ,EAAE,EAAE,cAAc,CAAC,CAAC;IACjE,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,qCAAqC,EAAE,GAAG,EAAE;QAC7C,MAAM,GAAG,GAAG,CAAC,OAAO,EAAE,OAAO,CAAC,CAAC;QAC/B,aAAM,CAAC,KAAK;QACV,kBAAkB;QAClB,IAAA,YAAI,EAAA,OAAO,GAAG,OAAO,CAAC,QAAQ,EAAE,EAChC,2BAA2B,CAC5B,CAAC;IACJ,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,oDAAoD,EAAE,GAAG,EAAE;QAC5D,MAAM,GAAG,GAAG,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;QAC7B,aAAM,CAAC,KAAK;QACV,kBAAkB;QAClB,IAAA,YAAI,EAAA,OAAO,GAAG,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,IAAA,YAAI,EAAA,OAAO,CAAC,OAAO,CAAC,OAAO,CAAC,QAAQ,EAAE,EAChE,qCAAqC,CACtC,CAAC;IACJ,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,kCAAkC,EAAE,GAAG,EAAE;QAC1C,aAAM,CAAC,MAAM;QACX,6DAA6D;QAC7D,GAAG,EAAE,CAAC,IAAA,YAAI,EAAA,MAAM,EAAE,GAAG,EAAE,KAAK,EAAE,MAAM,CAAC,QAAQ,EAAE,EAC/C,uCAAuC,CACxC,CAAC;IACJ,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,oCAAoC,EAAE,GAAG,EAAE;QAC5C,aAAM,CAAC,KAAK,CAAC,IAAA,YAAI,EAAA,MAAM,IAAI,GAAG,SAAS,MAAM,CAAC,QAAQ,EAAE,EAAE,SAAS,CAAC,CAAC;IACvE,CAAC,CAAC,CAAC;AACL,CAAC,CAAC,CAAC;AAEH,QAAQ,CAAC,YAAY,EAAE,GAAG,EAAE;IAC1B,EAAE,CAAC,uBAAuB,EAAE,GAAG,EAAE;QAC/B,aAAM,CAAC,KAAK,CAAC,IAAA,kBAAU,EAAC,IAAA,YAAI,EAAA,cAAc,CAAC,CAAC,QAAQ,EAAE,EAAE,0BAA0B,CAAC,CAAC;IACtF,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,mCAAmC,EAAE,GAAG,EAAE;QAC3C,aAAM,CAAC,KAAK,CAAC,IAAA,YAAI,EAAA,IAAI,IAAA,kBAAU,EAAC,IAAA,YAAI,EAAA,SAAS,CAAC,GAAG,CAAC,QAAQ,EAAE,EAAE,uBAAuB,CAAC,CAAC;IACzF,CAAC,CAAC,CAAC;AACL,CAAC,CAAC,CAAC"}
package/package.json CHANGED
@@ -1,7 +1,12 @@
1
1
  {
2
2
  "name": "@prairielearn/html",
3
- "version": "2.1.1",
3
+ "version": "3.0.0",
4
4
  "main": "dist/index.js",
5
+ "repository": {
6
+ "type": "git",
7
+ "url": "https://github.com/PrairieLearn/PrairieLearn.git",
8
+ "directory": "packages/html"
9
+ },
5
10
  "scripts": {
6
11
  "build": "tsc",
7
12
  "dev": "tsc --watch --preserveWatchOutput",
@@ -9,8 +14,9 @@
9
14
  },
10
15
  "devDependencies": {
11
16
  "@prairielearn/tsconfig": "*",
12
- "mocha": "^10.0.0",
17
+ "@types/node": "^18.15.11",
18
+ "mocha": "^10.2.0",
13
19
  "ts-node": "^10.9.1",
14
- "typescript": "^4.8.2"
20
+ "typescript": "^4.9.5"
15
21
  }
16
22
  }
package/src/index.test.ts CHANGED
@@ -11,6 +11,19 @@ describe('html', () => {
11
11
  assert.equal(html`<p>${'cats'} and ${'dogs'}</p>`.toString(), '<p>cats and dogs</p>');
12
12
  });
13
13
 
14
+ it('interpolates a number', () => {
15
+ assert.equal(html`<p>${123}</p>`.toString(), '<p>123</p>');
16
+ });
17
+
18
+ it('interpolates a bigint', () => {
19
+ assert.equal(html`<p>${123n}</p>`.toString(), '<p>123</p>');
20
+ });
21
+
22
+ it('interpolates a boolean', () => {
23
+ assert.equal(html`<p>${true}</p>`.toString(), '<p>true</p>');
24
+ assert.equal(html`<p>${false}</p>`.toString(), '<p>false</p>');
25
+ });
26
+
14
27
  it('escapes values when rendering array', () => {
15
28
  const arr = ['cats>', '<dogs'];
16
29
  assert.equal(
@@ -31,16 +44,12 @@ describe('html', () => {
31
44
 
32
45
  it('errors when interpolating object', () => {
33
46
  assert.throws(
34
- // @ts-expect-error
47
+ // @ts-expect-error -- Testing runtime behavior of bad input.
35
48
  () => html`<p>${{ foo: 'bar' }}</p>`.toString(),
36
49
  'Cannot interpolate object in template'
37
50
  );
38
51
  });
39
52
 
40
- it('omits boolean values from template', () => {
41
- assert.equal(html`<p>${true}${false}</p>`.toString(), '<p></p>');
42
- });
43
-
44
53
  it('omits nullish values from template', () => {
45
54
  assert.equal(html`<p>${null}${undefined}</p>`.toString(), '<p></p>');
46
55
  });
package/src/index.ts CHANGED
@@ -1,11 +1,11 @@
1
- const ENCODE_HTML_RULES = {
1
+ const ENCODE_HTML_RULES: Record<string, string> = {
2
2
  '&': '&amp;',
3
3
  '<': '&lt;',
4
4
  '>': '&gt;',
5
5
  '"': '&#34;',
6
6
  "'": '&#39;',
7
7
  };
8
- var MATCH_HTML = /[&<>'"]/g;
8
+ const MATCH_HTML = /[&<>'"]/g;
9
9
 
10
10
  function encodeCharacter(c: string) {
11
11
  return ENCODE_HTML_RULES[c] || c;
@@ -15,7 +15,7 @@ function encodeCharacter(c: string) {
15
15
  * Based on the `escapeXML` function from the `ejs` library.
16
16
  */
17
17
  function escapeHtmlRaw(value: string): string {
18
- return value == undefined ? '' : String(value).replace(MATCH_HTML, encodeCharacter);
18
+ return value == null ? '' : String(value).replace(MATCH_HTML, encodeCharacter);
19
19
  }
20
20
 
21
21
  function escapeValue(value: unknown): string {
@@ -24,7 +24,12 @@ function escapeValue(value: unknown): string {
24
24
  return value.toString();
25
25
  } else if (Array.isArray(value)) {
26
26
  return value.map((val) => escapeValue(val)).join('');
27
- } else if (typeof value === 'string' || typeof value === 'number') {
27
+ } else if (
28
+ typeof value === 'string' ||
29
+ typeof value === 'number' ||
30
+ typeof value === 'bigint' ||
31
+ typeof value === 'boolean'
32
+ ) {
28
33
  return escapeHtmlRaw(String(value));
29
34
  } else if (value == null) {
30
35
  // undefined or null -- render nothing
@@ -32,8 +37,10 @@ function escapeValue(value: unknown): string {
32
37
  } else if (typeof value === 'object') {
33
38
  throw new Error(`Cannot interpolate object in template: ${JSON.stringify(value)}`);
34
39
  } else {
35
- // This is boolean - don't render anything here.
36
- return '';
40
+ // There shouldn't be any other types
41
+ throw new Error(
42
+ `Unexpected type in template: ${typeof value} for value ${JSON.stringify(value)}`
43
+ );
37
44
  }
38
45
  }
39
46
 
@@ -54,7 +61,15 @@ export class HtmlSafeString {
54
61
  }
55
62
  }
56
63
 
57
- export type HtmlValue = string | number | boolean | HtmlSafeString | undefined | null | HtmlValue[];
64
+ export type HtmlValue =
65
+ | string
66
+ | number
67
+ | boolean
68
+ | bigint
69
+ | HtmlSafeString
70
+ | undefined
71
+ | null
72
+ | HtmlValue[];
58
73
 
59
74
  export function html(strings: TemplateStringsArray, ...values: HtmlValue[]): HtmlSafeString {
60
75
  return new HtmlSafeString(strings, values);