@prairielearn/browser-utils 2.0.1 → 2.1.0

package/CHANGELOG.md

@@ -1,5 +1,18 @@
 # @prairielearn/browser-utils
 
+## 2.1.0
+
+### Minor Changes
+
+- d28a15d: Support custom return type for parseHTMLElement
+
+## 2.0.2
+
+### Patch Changes
+
+- Updated dependencies [0f7c90f]
+  - @prairielearn/html@4.0.2
+
 ## 2.0.1
 
 ### Patch Changes

package/README.md

@@ -32,7 +32,7 @@ const elements = parseHTML(
     <div>Goodbye, world</div>
   `,
 );
-const div = parseHTMLElement(document, html`<div>Hello, world</div>`);
+const div = parseHTMLElement<HTMLDivElement>(document, html`<div>Hello, world</div>`);
 ```
 
 ### `EncodedData` and `decodeData`

package/dist/parse-html.d.ts

@@ -5,4 +5,4 @@ export declare function parseHTML(document: Document, html: string | HtmlSafeStr
  * {@link DocumentFragment}. If the HTML being parsed does not contain
  * exactly one element, an error is thrown.
  */
-export declare function parseHTMLElement(document: Document, html: string | HtmlSafeString): Element;
+export declare function parseHTMLElement<T extends Element = Element>(document: Document, html: string | HtmlSafeString): T;

package/dist/parse-html.js.map

@@ -1 +1 @@
-{"version":3,"file":"parse-html.js","sourceRoot":"","sources":["../src/parse-html.ts"],"names":[],"mappings":"AAEA,MAAM,UAAU,SAAS,CAAC,QAAkB,EAAE,IAA6B;IACzE,IAAI,OAAO,IAAI,KAAK,QAAQ;QAAE,IAAI,GAAG,IAAI,CAAC,QAAQ,EAAE,CAAC;IACrD,MAAM,QAAQ,GAAG,QAAQ,CAAC,aAAa,CAAC,UAAU,CAAC,CAAC;IACpD,QAAQ,CAAC,SAAS,GAAG,IAAI,CAAC;IAC1B,OAAO,QAAQ,CAAC,UAAU,CAAC,QAAQ,CAAC,OAAO,EAAE,IAAI,CAAC,CAAC;AACrD,CAAC;AAED;;;;GAIG;AACH,MAAM,UAAU,gBAAgB,CAAC,QAAkB,EAAE,IAA6B;IAChF,MAAM,gBAAgB,GAAG,SAAS,CAAC,QAAQ,EAAE,IAAI,CAAC,CAAC;IACnD,IAAI,gBAAgB,CAAC,iBAAiB,KAAK,CAAC,EAAE,CAAC;QAC7C,MAAM,IAAI,KAAK,CAAC,8CAA8C,CAAC,CAAC;IAClE,CAAC;IACD,OAAO,gBAAgB,CAAC,iBAA4B,CAAC;AACvD,CAAC","sourcesContent":["import type { HtmlSafeString } from '@prairielearn/html';\n\nexport function parseHTML(document: Document, html: string | HtmlSafeString): DocumentFragment {\n  if (typeof html !== 'string') html = html.toString();\n  const template = document.createElement('template');\n  template.innerHTML = html;\n  return document.importNode(template.content, true);\n}\n\n/**\n * Like {@link parseHTML}, but returns an {@link Element} instead of a\n * {@link DocumentFragment}. If the HTML being parsed does not contain\n * exactly one element, an error is thrown.\n */\nexport function parseHTMLElement(document: Document, html: string | HtmlSafeString): Element {\n  const documentFragment = parseHTML(document, html);\n  if (documentFragment.childElementCount !== 1) {\n    throw new Error('Expected HTML to contain exactly one element');\n  }\n  return documentFragment.firstElementChild as Element;\n}\n"]}
+{"version":3,"file":"parse-html.js","sourceRoot":"","sources":["../src/parse-html.ts"],"names":[],"mappings":"AAEA,MAAM,UAAU,SAAS,CAAC,QAAkB,EAAE,IAA6B;IACzE,IAAI,OAAO,IAAI,KAAK,QAAQ;QAAE,IAAI,GAAG,IAAI,CAAC,QAAQ,EAAE,CAAC;IACrD,MAAM,QAAQ,GAAG,QAAQ,CAAC,aAAa,CAAC,UAAU,CAAC,CAAC;IACpD,QAAQ,CAAC,SAAS,GAAG,IAAI,CAAC;IAC1B,OAAO,QAAQ,CAAC,UAAU,CAAC,QAAQ,CAAC,OAAO,EAAE,IAAI,CAAC,CAAC;AACrD,CAAC;AAED;;;;GAIG;AACH,MAAM,UAAU,gBAAgB,CAC9B,QAAkB,EAClB,IAA6B;IAE7B,MAAM,gBAAgB,GAAG,SAAS,CAAC,QAAQ,EAAE,IAAI,CAAC,CAAC;IACnD,IAAI,gBAAgB,CAAC,iBAAiB,KAAK,CAAC,EAAE,CAAC;QAC7C,MAAM,IAAI,KAAK,CAAC,8CAA8C,CAAC,CAAC;IAClE,CAAC;IACD,OAAO,gBAAgB,CAAC,iBAAsB,CAAC;AACjD,CAAC","sourcesContent":["import type { HtmlSafeString } from '@prairielearn/html';\n\nexport function parseHTML(document: Document, html: string | HtmlSafeString): DocumentFragment {\n  if (typeof html !== 'string') html = html.toString();\n  const template = document.createElement('template');\n  template.innerHTML = html;\n  return document.importNode(template.content, true);\n}\n\n/**\n * Like {@link parseHTML}, but returns an {@link Element} instead of a\n * {@link DocumentFragment}. If the HTML being parsed does not contain\n * exactly one element, an error is thrown.\n */\nexport function parseHTMLElement<T extends Element = Element>(\n  document: Document,\n  html: string | HtmlSafeString,\n): T {\n  const documentFragment = parseHTML(document, html);\n  if (documentFragment.childElementCount !== 1) {\n    throw new Error('Expected HTML to contain exactly one element');\n  }\n  return documentFragment.firstElementChild as T;\n}\n"]}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@prairielearn/browser-utils",
-  "version": "2.0.1",
+  "version": "2.1.0",
   "type": "module",
   "main": "dist/index.js",
   "sideEffects": false,
@@ -14,7 +14,7 @@
     "dev": "tsc --watch --preserveWatchOutput"
   },
   "dependencies": {
-    "@prairielearn/html": "^4.0.1",
+    "@prairielearn/html": "^4.0.2",
     "js-base64": "^3.7.7"
   },
   "devDependencies": {

package/src/parse-html.ts

@@ -12,10 +12,13 @@ export function parseHTML(document: Document, html: string | HtmlSafeString): Do
  * {@link DocumentFragment}. If the HTML being parsed does not contain
  * exactly one element, an error is thrown.
  */
-export function parseHTMLElement(document: Document, html: string | HtmlSafeString): Element {
+export function parseHTMLElement<T extends Element = Element>(
+  document: Document,
+  html: string | HtmlSafeString,
+): T {
   const documentFragment = parseHTML(document, html);
   if (documentFragment.childElementCount !== 1) {
     throw new Error('Expected HTML to contain exactly one element');
   }
-  return documentFragment.firstElementChild as Element;
+  return documentFragment.firstElementChild as T;
 }