From 845ec8213ed0c2170f4e926a804059e99025f28e Mon Sep 17 00:00:00 2001 From: Andre Wachsmuth Date: Wed, 27 Nov 2024 23:42:40 +0100 Subject: [PATCH] Switch from CommonJS to ESM for support for TypeDoc 0.27.x --- data/web-api.json | 216 +++++---------------------------- package.json | 1 + scripts/generateWebApiIndex.js | 11 +- src/index.ts | 12 +- src/test/plugin.test.ts | 2 +- src/typescript.ts | 2 +- src/webApi.ts | 4 +- tsconfig.json | 5 +- 8 files changed, 49 insertions(+), 204 deletions(-) diff --git a/data/web-api.json b/data/web-api.json index cdbaa06..e7aaed1 100644 --- a/data/web-api.json +++ b/data/web-api.json @@ -636,23 +636,7 @@ } }, "CDATASection": "https://developer.mozilla.org/docs/Web/API/CDATASection", - "CSPViolationReportBody": { - "url": "https://developer.mozilla.org/docs/Web/API/CSPViolationReportBody", - "inst": { - "blockedURL": "https://developer.mozilla.org/docs/Web/API/CSPViolationReportBody/blockedURL", - "columnNumber": "https://developer.mozilla.org/docs/Web/API/CSPViolationReportBody/columnNumber", - "disposition": "https://developer.mozilla.org/docs/Web/API/CSPViolationReportBody/disposition", - "documentURL": "https://developer.mozilla.org/docs/Web/API/CSPViolationReportBody/documentURL", - "effectiveDirective": "https://developer.mozilla.org/docs/Web/API/CSPViolationReportBody/effectiveDirective", - "lineNumber": "https://developer.mozilla.org/docs/Web/API/CSPViolationReportBody/lineNumber", - "originalPolicy": "https://developer.mozilla.org/docs/Web/API/CSPViolationReportBody/originalPolicy", - "referrer": "https://developer.mozilla.org/docs/Web/API/CSPViolationReportBody/referrer", - "sample": "https://developer.mozilla.org/docs/Web/API/CSPViolationReportBody/sample", - "sourceFile": "https://developer.mozilla.org/docs/Web/API/CSPViolationReportBody/sourceFile", - "statusCode": "https://developer.mozilla.org/docs/Web/API/CSPViolationReportBody/statusCode", - "toJSON": "https://developer.mozilla.org/docs/Web/API/CSPViolationReportBody/toJSON" - } - }, + "CSPViolationReportBody": "https://developer.mozilla.org/docs/Web/API/CSPViolationReportBody", "CSS": { "url": "https://developer.mozilla.org/docs/Web/API/CSS", "stat": { @@ -898,12 +882,6 @@ "prefix": "https://developer.mozilla.org/docs/Web/API/CSSNamespaceRule/prefix" } }, - "CSSNestedDeclarations": { - "url": "https://developer.mozilla.org/docs/Web/API/CSSNestedDeclarations", - "inst": { - "style": "https://developer.mozilla.org/docs/Web/API/CSSNestedDeclarations/style" - } - }, "CSSNumericArray": { "url": "https://developer.mozilla.org/docs/Web/API/CSSNumericArray", "inst": { @@ -1518,14 +1496,6 @@ "requestClose": "https://developer.mozilla.org/docs/Web/API/CloseWatcher/requestClose" } }, - "CommandEvent": { - "url": "https://developer.mozilla.org/docs/Web/API/CommandEvent", - "inst": { - "CommandEvent": "https://developer.mozilla.org/docs/Web/API/CommandEvent/CommandEvent", - "command": "https://developer.mozilla.org/docs/Web/API/CommandEvent/command", - "source": "https://developer.mozilla.org/docs/Web/API/CommandEvent/source" - } - }, "Comment": { "url": "https://developer.mozilla.org/docs/Web/API/Comment", "inst": { @@ -1820,38 +1790,16 @@ "fromPoint": "https://developer.mozilla.org/docs/Web/API/DOMPointReadOnly/fromPoint_static" } }, - "DOMQuad": { - "url": "https://developer.mozilla.org/docs/Web/API/DOMQuad", - "inst": { - "DOMQuad": "https://developer.mozilla.org/docs/Web/API/DOMQuad/DOMQuad", - "getBounds": "https://developer.mozilla.org/docs/Web/API/DOMQuad/getBounds", - "p1": "https://developer.mozilla.org/docs/Web/API/DOMQuad/p1", - "p2": "https://developer.mozilla.org/docs/Web/API/DOMQuad/p2", - "p3": "https://developer.mozilla.org/docs/Web/API/DOMQuad/p3", - "p4": "https://developer.mozilla.org/docs/Web/API/DOMQuad/p4", - "toJSON": "https://developer.mozilla.org/docs/Web/API/DOMQuad/toJSON" - } - }, + "DOMQuad": "https://developer.mozilla.org/docs/Web/API/DOMQuad", "DOMRect": { "url": "https://developer.mozilla.org/docs/Web/API/DOMRect", "inst": { - "DOMRect": "https://developer.mozilla.org/docs/Web/API/DOMRect/DOMRect", - "height": "https://developer.mozilla.org/docs/Web/API/DOMRect/height", - "width": "https://developer.mozilla.org/docs/Web/API/DOMRect/width", - "x": "https://developer.mozilla.org/docs/Web/API/DOMRect/x", - "y": "https://developer.mozilla.org/docs/Web/API/DOMRect/y" + "DOMRect": "https://developer.mozilla.org/docs/Web/API/DOMRect/DOMRect" }, "stat": { "fromRect": "https://developer.mozilla.org/docs/Web/API/DOMRect/fromRect_static" } }, - "DOMRectList": { - "url": "https://developer.mozilla.org/docs/Web/API/DOMRectList", - "inst": { - "item": "https://developer.mozilla.org/docs/Web/API/DOMRectList/item", - "length": "https://developer.mozilla.org/docs/Web/API/DOMRectList/length" - } - }, "DOMRectReadOnly": { "url": "https://developer.mozilla.org/docs/Web/API/DOMRectReadOnly", "inst": { @@ -1860,7 +1808,6 @@ "height": "https://developer.mozilla.org/docs/Web/API/DOMRectReadOnly/height", "left": "https://developer.mozilla.org/docs/Web/API/DOMRectReadOnly/left", "right": "https://developer.mozilla.org/docs/Web/API/DOMRectReadOnly/right", - "toJSON": "https://developer.mozilla.org/docs/Web/API/DOMRectReadOnly/toJSON", "top": "https://developer.mozilla.org/docs/Web/API/DOMRectReadOnly/top", "width": "https://developer.mozilla.org/docs/Web/API/DOMRectReadOnly/width", "x": "https://developer.mozilla.org/docs/Web/API/DOMRectReadOnly/x", @@ -1960,14 +1907,6 @@ "delayTime": "https://developer.mozilla.org/docs/Web/API/DelayNode/delayTime" } }, - "DelegatedInkTrailPresenter": { - "url": "https://developer.mozilla.org/docs/Web/API/DelegatedInkTrailPresenter", - "inst": { - "expectedImprovement": "https://developer.mozilla.org/docs/Web/API/DelegatedInkTrailPresenter/expectedImprovement", - "presentationArea": "https://developer.mozilla.org/docs/Web/API/DelegatedInkTrailPresenter/presentationArea", - "updateInkTrailStartPoint": "https://developer.mozilla.org/docs/Web/API/DelegatedInkTrailPresenter/updateInkTrailStartPoint" - } - }, "DeprecationReportBody": { "url": "https://developer.mozilla.org/docs/Web/API/DeprecationReportBody", "inst": { @@ -2479,17 +2418,7 @@ "type": "https://developer.mozilla.org/docs/Web/API/EncodedVideoChunk/type" } }, - "ErrorEvent": { - "url": "https://developer.mozilla.org/docs/Web/API/ErrorEvent", - "inst": { - "ErrorEvent": "https://developer.mozilla.org/docs/Web/API/ErrorEvent/ErrorEvent", - "colno": "https://developer.mozilla.org/docs/Web/API/ErrorEvent/colno", - "error": "https://developer.mozilla.org/docs/Web/API/ErrorEvent/error", - "filename": "https://developer.mozilla.org/docs/Web/API/ErrorEvent/filename", - "lineno": "https://developer.mozilla.org/docs/Web/API/ErrorEvent/lineno", - "message": "https://developer.mozilla.org/docs/Web/API/ErrorEvent/message" - } - }, + "ErrorEvent": "https://developer.mozilla.org/docs/Web/API/ErrorEvent", "Event": { "url": "https://developer.mozilla.org/docs/Web/API/Event", "inst": { @@ -2608,6 +2537,7 @@ "handled": "https://developer.mozilla.org/docs/Web/API/FetchEvent/handled", "isReload": "https://developer.mozilla.org/docs/Web/API/FetchEvent/isReload", "preloadResponse": "https://developer.mozilla.org/docs/Web/API/FetchEvent/preloadResponse", + "replacesClientId": "https://developer.mozilla.org/docs/Web/API/FetchEvent/replacesClientId", "request": "https://developer.mozilla.org/docs/Web/API/FetchEvent/request", "respondWith": "https://developer.mozilla.org/docs/Web/API/FetchEvent/respondWith", "resultingClientId": "https://developer.mozilla.org/docs/Web/API/FetchEvent/resultingClientId" @@ -2849,7 +2779,6 @@ "url": "https://developer.mozilla.org/docs/Web/API/GPUAdapter", "inst": { "features": "https://developer.mozilla.org/docs/Web/API/GPUAdapter/features", - "info": "https://developer.mozilla.org/docs/Web/API/GPUAdapter/info", "isFallbackAdapter": "https://developer.mozilla.org/docs/Web/API/GPUAdapter/isFallbackAdapter", "limits": "https://developer.mozilla.org/docs/Web/API/GPUAdapter/limits", "requestAdapterInfo": "https://developer.mozilla.org/docs/Web/API/GPUAdapter/requestAdapterInfo", @@ -2895,7 +2824,6 @@ "inst": { "canvas": "https://developer.mozilla.org/docs/Web/API/GPUCanvasContext/canvas", "configure": "https://developer.mozilla.org/docs/Web/API/GPUCanvasContext/configure", - "getConfiguration": "https://developer.mozilla.org/docs/Web/API/GPUCanvasContext/getConfiguration", "getCurrentTexture": "https://developer.mozilla.org/docs/Web/API/GPUCanvasContext/getCurrentTexture", "unconfigure": "https://developer.mozilla.org/docs/Web/API/GPUCanvasContext/unconfigure" } @@ -3394,8 +3322,6 @@ "HTMLAreaElement": { "url": "https://developer.mozilla.org/docs/Web/API/HTMLAreaElement", "inst": { - "alt": "https://developer.mozilla.org/docs/Web/API/HTMLAreaElement/alt", - "download": "https://developer.mozilla.org/docs/Web/API/HTMLAreaElement/download", "hash": "https://developer.mozilla.org/docs/Web/API/HTMLAreaElement/hash", "host": "https://developer.mozilla.org/docs/Web/API/HTMLAreaElement/host", "hostname": "https://developer.mozilla.org/docs/Web/API/HTMLAreaElement/hostname", @@ -3434,23 +3360,14 @@ "url": "https://developer.mozilla.org/docs/Web/API/HTMLButtonElement", "inst": { "checkValidity": "https://developer.mozilla.org/docs/Web/API/HTMLButtonElement/checkValidity", - "command": "https://developer.mozilla.org/docs/Web/API/HTMLButtonElement/command", - "commandForElement": "https://developer.mozilla.org/docs/Web/API/HTMLButtonElement/commandForElement", "disabled": "https://developer.mozilla.org/docs/Web/API/HTMLButtonElement/disabled", "form": "https://developer.mozilla.org/docs/Web/API/HTMLButtonElement/form", - "formAction": "https://developer.mozilla.org/docs/Web/API/HTMLButtonElement/formAction", - "formEnctype": "https://developer.mozilla.org/docs/Web/API/HTMLButtonElement/formEnctype", - "formMethod": "https://developer.mozilla.org/docs/Web/API/HTMLButtonElement/formMethod", - "formNoValidate": "https://developer.mozilla.org/docs/Web/API/HTMLButtonElement/formNoValidate", - "formTarget": "https://developer.mozilla.org/docs/Web/API/HTMLButtonElement/formTarget", "labels": "https://developer.mozilla.org/docs/Web/API/HTMLButtonElement/labels", "name": "https://developer.mozilla.org/docs/Web/API/HTMLButtonElement/name", "popoverTargetAction": "https://developer.mozilla.org/docs/Web/API/HTMLButtonElement/popoverTargetAction", "popoverTargetElement": "https://developer.mozilla.org/docs/Web/API/HTMLButtonElement/popoverTargetElement", "reportValidity": "https://developer.mozilla.org/docs/Web/API/HTMLButtonElement/reportValidity", - "setCustomValidity": "https://developer.mozilla.org/docs/Web/API/HTMLButtonElement/setCustomValidity", "type": "https://developer.mozilla.org/docs/Web/API/HTMLButtonElement/type", - "validationMessage": "https://developer.mozilla.org/docs/Web/API/HTMLButtonElement/validationMessage", "validity": "https://developer.mozilla.org/docs/Web/API/HTMLButtonElement/validity", "value": "https://developer.mozilla.org/docs/Web/API/HTMLButtonElement/value", "willValidate": "https://developer.mozilla.org/docs/Web/API/HTMLButtonElement/willValidate" @@ -3518,7 +3435,6 @@ "attachInternals": "https://developer.mozilla.org/docs/Web/API/HTMLElement/attachInternals", "attributeStyleMap": "https://developer.mozilla.org/docs/Web/API/HTMLElement/attributeStyleMap", "autocapitalize": "https://developer.mozilla.org/docs/Web/API/HTMLElement/autocapitalize", - "autocorrect": "https://developer.mozilla.org/docs/Web/API/HTMLElement/autocorrect", "autofocus": "https://developer.mozilla.org/docs/Web/API/HTMLElement/autofocus", "blur": "https://developer.mozilla.org/docs/Web/API/HTMLElement/blur", "click": "https://developer.mozilla.org/docs/Web/API/HTMLElement/click", @@ -3531,12 +3447,7 @@ "focus": "https://developer.mozilla.org/docs/Web/API/HTMLElement/focus", "hidden": "https://developer.mozilla.org/docs/Web/API/HTMLElement/hidden", "hidePopover": "https://developer.mozilla.org/docs/Web/API/HTMLElement/hidePopover", - "inert": { - "url": "https://developer.mozilla.org/docs/Web/API/HTMLElement/inert", - "inst": { - "ignores_find_in_page": "https://developer.mozilla.org/docs/Web/API/HTMLElement/inert" - } - }, + "inert": "https://developer.mozilla.org/docs/Web/API/HTMLElement/inert", "innerText": "https://developer.mozilla.org/docs/Web/API/HTMLElement/innerText", "inputMode": "https://developer.mozilla.org/docs/Web/API/HTMLElement/inputMode", "isContentEditable": "https://developer.mozilla.org/docs/Web/API/HTMLElement/isContentEditable", @@ -3580,14 +3491,10 @@ "url": "https://developer.mozilla.org/docs/Web/API/HTMLFieldSetElement", "inst": { "checkValidity": "https://developer.mozilla.org/docs/Web/API/HTMLFieldSetElement/checkValidity", - "disabled": "https://developer.mozilla.org/docs/Web/API/HTMLFieldSetElement/disabled", - "elements": "https://developer.mozilla.org/docs/Web/API/HTMLFieldSetElement/elements", "form": "https://developer.mozilla.org/docs/Web/API/HTMLFieldSetElement/form", "name": "https://developer.mozilla.org/docs/Web/API/HTMLFieldSetElement/name", "reportValidity": "https://developer.mozilla.org/docs/Web/API/HTMLFieldSetElement/reportValidity", - "setCustomValidity": "https://developer.mozilla.org/docs/Web/API/HTMLFieldSetElement/setCustomValidity", "type": "https://developer.mozilla.org/docs/Web/API/HTMLFieldSetElement/type", - "validationMessage": "https://developer.mozilla.org/docs/Web/API/HTMLFieldSetElement/validationMessage", "validity": "https://developer.mozilla.org/docs/Web/API/HTMLFieldSetElement/validity", "willValidate": "https://developer.mozilla.org/docs/Web/API/HTMLFieldSetElement/willValidate" } @@ -3611,7 +3518,6 @@ "inst": { "acceptCharset": "https://developer.mozilla.org/docs/Web/API/HTMLFormElement/acceptCharset", "action": "https://developer.mozilla.org/docs/Web/API/HTMLFormElement/action", - "autocomplete": "https://developer.mozilla.org/docs/Web/API/HTMLFormElement/autocomplete", "checkValidity": "https://developer.mozilla.org/docs/Web/API/HTMLFormElement/checkValidity", "elements": "https://developer.mozilla.org/docs/Web/API/HTMLFormElement/elements", "encoding": "https://developer.mozilla.org/docs/Web/API/HTMLFormElement/encoding", @@ -3619,7 +3525,6 @@ "length": "https://developer.mozilla.org/docs/Web/API/HTMLFormElement/length", "method": "https://developer.mozilla.org/docs/Web/API/HTMLFormElement/method", "name": "https://developer.mozilla.org/docs/Web/API/HTMLFormElement/name", - "noValidate": "https://developer.mozilla.org/docs/Web/API/HTMLFormElement/noValidate", "reportValidity": "https://developer.mozilla.org/docs/Web/API/HTMLFormElement/reportValidity", "requestSubmit": "https://developer.mozilla.org/docs/Web/API/HTMLFormElement/requestSubmit", "reset": "https://developer.mozilla.org/docs/Web/API/HTMLFormElement/reset", @@ -3711,13 +3616,7 @@ "disabled": "https://developer.mozilla.org/docs/Web/API/HTMLInputElement/disabled", "files": "https://developer.mozilla.org/docs/Web/API/HTMLInputElement/files", "form": "https://developer.mozilla.org/docs/Web/API/HTMLInputElement/form", - "formAction": "https://developer.mozilla.org/docs/Web/API/HTMLInputElement/formAction", - "formEnctype": "https://developer.mozilla.org/docs/Web/API/HTMLInputElement/formEnctype", - "formMethod": "https://developer.mozilla.org/docs/Web/API/HTMLInputElement/formMethod", - "formNoValidate": "https://developer.mozilla.org/docs/Web/API/HTMLInputElement/formNoValidate", - "formTarget": "https://developer.mozilla.org/docs/Web/API/HTMLInputElement/formTarget", "height": "https://developer.mozilla.org/docs/Web/API/HTMLInputElement/height", - "indeterminate": "https://developer.mozilla.org/docs/Web/API/HTMLInputElement/indeterminate", "labels": "https://developer.mozilla.org/docs/Web/API/HTMLInputElement/labels", "list": "https://developer.mozilla.org/docs/Web/API/HTMLInputElement/list", "max": "https://developer.mozilla.org/docs/Web/API/HTMLInputElement/max", @@ -3747,7 +3646,6 @@ "stepDown": "https://developer.mozilla.org/docs/Web/API/HTMLInputElement/stepDown", "stepUp": "https://developer.mozilla.org/docs/Web/API/HTMLInputElement/stepUp", "type": "https://developer.mozilla.org/docs/Web/API/HTMLInputElement/type", - "validationMessage": "https://developer.mozilla.org/docs/Web/API/HTMLInputElement/validationMessage", "validity": "https://developer.mozilla.org/docs/Web/API/HTMLInputElement/validity", "value": "https://developer.mozilla.org/docs/Web/API/HTMLInputElement/value", "valueAsDate": "https://developer.mozilla.org/docs/Web/API/HTMLInputElement/valueAsDate", @@ -3758,12 +3656,7 @@ "willValidate": "https://developer.mozilla.org/docs/Web/API/HTMLInputElement/willValidate" } }, - "HTMLLIElement": { - "url": "https://developer.mozilla.org/docs/Web/API/HTMLLIElement", - "inst": { - "value": "https://developer.mozilla.org/docs/Web/API/HTMLLIElement/value" - } - }, + "HTMLLIElement": "https://developer.mozilla.org/docs/Web/API/HTMLLIElement", "HTMLLabelElement": { "url": "https://developer.mozilla.org/docs/Web/API/HTMLLabelElement", "inst": { @@ -3808,7 +3701,6 @@ "HTMLMediaElement": { "url": "https://developer.mozilla.org/docs/Web/API/HTMLMediaElement", "inst": { - "addTextTrack": "https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/addTextTrack", "audioTracks": "https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/audioTracks", "autoplay": "https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/autoplay", "buffered": "https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/buffered", @@ -3905,49 +3797,25 @@ "willValidate": "https://developer.mozilla.org/docs/Web/API/HTMLObjectElement/willValidate" } }, - "HTMLOptGroupElement": { - "url": "https://developer.mozilla.org/docs/Web/API/HTMLOptGroupElement", - "inst": { - "disabled": "https://developer.mozilla.org/docs/Web/API/HTMLOptGroupElement/disabled", - "label": "https://developer.mozilla.org/docs/Web/API/HTMLOptGroupElement/label" - } - }, + "HTMLOptGroupElement": "https://developer.mozilla.org/docs/Web/API/HTMLOptGroupElement", "HTMLOptionElement": { "url": "https://developer.mozilla.org/docs/Web/API/HTMLOptionElement", "inst": { "Option": "https://developer.mozilla.org/docs/Web/API/HTMLOptionElement/Option", - "defaultSelected": "https://developer.mozilla.org/docs/Web/API/HTMLOptionElement/defaultSelected", - "disabled": "https://developer.mozilla.org/docs/Web/API/HTMLOptionElement/disabled", "form": "https://developer.mozilla.org/docs/Web/API/HTMLOptionElement/form", - "index": "https://developer.mozilla.org/docs/Web/API/HTMLOptionElement/index", - "label": "https://developer.mozilla.org/docs/Web/API/HTMLOptionElement/label", - "selected": "https://developer.mozilla.org/docs/Web/API/HTMLOptionElement/selected", - "text": "https://developer.mozilla.org/docs/Web/API/HTMLOptionElement/text", "value": "https://developer.mozilla.org/docs/Web/API/HTMLOptionElement/value" } }, - "HTMLOptionsCollection": { - "url": "https://developer.mozilla.org/docs/Web/API/HTMLOptionsCollection", - "inst": { - "add": "https://developer.mozilla.org/docs/Web/API/HTMLOptionsCollection/add", - "length": "https://developer.mozilla.org/docs/Web/API/HTMLOptionsCollection/length", - "remove": "https://developer.mozilla.org/docs/Web/API/HTMLOptionsCollection/remove", - "selectedIndex": "https://developer.mozilla.org/docs/Web/API/HTMLOptionsCollection/selectedIndex" - } - }, + "HTMLOptionsCollection": "https://developer.mozilla.org/docs/Web/API/HTMLOptionsCollection", "HTMLOutputElement": { "url": "https://developer.mozilla.org/docs/Web/API/HTMLOutputElement", "inst": { "checkValidity": "https://developer.mozilla.org/docs/Web/API/HTMLOutputElement/checkValidity", - "defaultValue": "https://developer.mozilla.org/docs/Web/API/HTMLOutputElement/defaultValue", "form": "https://developer.mozilla.org/docs/Web/API/HTMLOutputElement/form", - "htmlFor": "https://developer.mozilla.org/docs/Web/API/HTMLOutputElement/htmlFor", "labels": "https://developer.mozilla.org/docs/Web/API/HTMLOutputElement/labels", "name": "https://developer.mozilla.org/docs/Web/API/HTMLOutputElement/name", "reportValidity": "https://developer.mozilla.org/docs/Web/API/HTMLOutputElement/reportValidity", - "setCustomValidity": "https://developer.mozilla.org/docs/Web/API/HTMLOutputElement/setCustomValidity", "type": "https://developer.mozilla.org/docs/Web/API/HTMLOutputElement/type", - "validationMessage": "https://developer.mozilla.org/docs/Web/API/HTMLOutputElement/validationMessage", "validity": "https://developer.mozilla.org/docs/Web/API/HTMLOutputElement/validity", "value": "https://developer.mozilla.org/docs/Web/API/HTMLOutputElement/value", "willValidate": "https://developer.mozilla.org/docs/Web/API/HTMLOutputElement/willValidate" @@ -3991,7 +3859,6 @@ "url": "https://developer.mozilla.org/docs/Web/API/HTMLSelectElement", "inst": { "add": "https://developer.mozilla.org/docs/Web/API/HTMLSelectElement/add", - "autocomplete": "https://developer.mozilla.org/docs/Web/API/HTMLSelectElement/autocomplete", "checkValidity": "https://developer.mozilla.org/docs/Web/API/HTMLSelectElement/checkValidity", "disabled": "https://developer.mozilla.org/docs/Web/API/HTMLSelectElement/disabled", "form": "https://developer.mozilla.org/docs/Web/API/HTMLSelectElement/form", @@ -4011,7 +3878,6 @@ "showPicker": "https://developer.mozilla.org/docs/Web/API/HTMLSelectElement/showPicker", "size": "https://developer.mozilla.org/docs/Web/API/HTMLSelectElement/size", "type": "https://developer.mozilla.org/docs/Web/API/HTMLSelectElement/type", - "validationMessage": "https://developer.mozilla.org/docs/Web/API/HTMLSelectElement/validationMessage", "validity": "https://developer.mozilla.org/docs/Web/API/HTMLSelectElement/validity", "value": "https://developer.mozilla.org/docs/Web/API/HTMLSelectElement/value", "willValidate": "https://developer.mozilla.org/docs/Web/API/HTMLSelectElement/willValidate" @@ -4160,16 +4026,8 @@ "reportValidity": "https://developer.mozilla.org/docs/Web/API/HTMLTextAreaElement/reportValidity", "required": "https://developer.mozilla.org/docs/Web/API/HTMLTextAreaElement/required", "rows": "https://developer.mozilla.org/docs/Web/API/HTMLTextAreaElement/rows", - "select": "https://developer.mozilla.org/docs/Web/API/HTMLTextAreaElement/select", - "selectionDirection": "https://developer.mozilla.org/docs/Web/API/HTMLTextAreaElement/selectionDirection", - "selectionEnd": "https://developer.mozilla.org/docs/Web/API/HTMLTextAreaElement/selectionEnd", - "selectionStart": "https://developer.mozilla.org/docs/Web/API/HTMLTextAreaElement/selectionStart", - "setCustomValidity": "https://developer.mozilla.org/docs/Web/API/HTMLTextAreaElement/setCustomValidity", - "setRangeText": "https://developer.mozilla.org/docs/Web/API/HTMLTextAreaElement/setRangeText", - "setSelectionRange": "https://developer.mozilla.org/docs/Web/API/HTMLTextAreaElement/setSelectionRange", "textLength": "https://developer.mozilla.org/docs/Web/API/HTMLTextAreaElement/textLength", "type": "https://developer.mozilla.org/docs/Web/API/HTMLTextAreaElement/type", - "validationMessage": "https://developer.mozilla.org/docs/Web/API/HTMLTextAreaElement/validationMessage", "validity": "https://developer.mozilla.org/docs/Web/API/HTMLTextAreaElement/validity", "value": "https://developer.mozilla.org/docs/Web/API/HTMLTextAreaElement/value", "willValidate": "https://developer.mozilla.org/docs/Web/API/HTMLTextAreaElement/willValidate", @@ -4529,6 +4387,14 @@ "requestPresenter": "https://developer.mozilla.org/docs/Web/API/Ink/requestPresenter" } }, + "InkPresenter": { + "url": "https://developer.mozilla.org/docs/Web/API/InkPresenter", + "inst": { + "expectedImprovement": "https://developer.mozilla.org/docs/Web/API/InkPresenter/expectedImprovement", + "presentationArea": "https://developer.mozilla.org/docs/Web/API/InkPresenter/presentationArea", + "updateInkTrailStartPoint": "https://developer.mozilla.org/docs/Web/API/InkPresenter/updateInkTrailStartPoint" + } + }, "InputDeviceCapabilities": { "url": "https://developer.mozilla.org/docs/Web/API/InputDeviceCapabilities", "inst": { @@ -5281,7 +5147,6 @@ "Navigation": { "url": "https://developer.mozilla.org/docs/Web/API/Navigation", "inst": { - "activation": "https://developer.mozilla.org/docs/Web/API/Navigation/activation", "back": "https://developer.mozilla.org/docs/Web/API/Navigation/back", "canGoBack": "https://developer.mozilla.org/docs/Web/API/Navigation/canGoBack", "canGoForward": "https://developer.mozilla.org/docs/Web/API/Navigation/canGoForward", @@ -6503,7 +6368,6 @@ "close": "https://developer.mozilla.org/docs/Web/API/RTCPeerConnection/close", "connectionState": "https://developer.mozilla.org/docs/Web/API/RTCPeerConnection/connectionState", "createAnswer": "https://developer.mozilla.org/docs/Web/API/RTCPeerConnection/createAnswer", - "createDTMFSender": "https://developer.mozilla.org/docs/Web/API/RTCPeerConnection/createDTMFSender", "createDataChannel": "https://developer.mozilla.org/docs/Web/API/RTCPeerConnection/createDataChannel", "createOffer": "https://developer.mozilla.org/docs/Web/API/RTCPeerConnection/createOffer", "currentLocalDescription": "https://developer.mozilla.org/docs/Web/API/RTCPeerConnection/currentLocalDescription", @@ -6868,12 +6732,7 @@ "Request": { "url": "https://developer.mozilla.org/docs/Web/API/Request", "inst": { - "Request": { - "url": "https://developer.mozilla.org/docs/Web/API/Request/Request", - "inst": { - "init_keepalive_parameter": "https://developer.mozilla.org/docs/Web/API/Request/keepalive" - } - }, + "Request": "https://developer.mozilla.org/docs/Web/API/Request/Request", "arrayBuffer": "https://developer.mozilla.org/docs/Web/API/Request/arrayBuffer", "blob": "https://developer.mozilla.org/docs/Web/API/Request/blob", "body": "https://developer.mozilla.org/docs/Web/API/Request/body", @@ -6886,9 +6745,7 @@ "formData": "https://developer.mozilla.org/docs/Web/API/Request/formData", "headers": "https://developer.mozilla.org/docs/Web/API/Request/headers", "integrity": "https://developer.mozilla.org/docs/Web/API/Request/integrity", - "isHistoryNavigation": "https://developer.mozilla.org/docs/Web/API/Request/isHistoryNavigation", "json": "https://developer.mozilla.org/docs/Web/API/Request/json", - "keepalive": "https://developer.mozilla.org/docs/Web/API/Request/keepalive", "method": "https://developer.mozilla.org/docs/Web/API/Request/method", "mode": "https://developer.mozilla.org/docs/Web/API/Request/mode", "redirect": "https://developer.mozilla.org/docs/Web/API/Request/redirect", @@ -7209,8 +7066,7 @@ "Scheduler": { "url": "https://developer.mozilla.org/docs/Web/API/Scheduler", "inst": { - "postTask": "https://developer.mozilla.org/docs/Web/API/Scheduler/postTask", - "yield": "https://developer.mozilla.org/docs/Web/API/Scheduler/yield" + "postTask": "https://developer.mozilla.org/docs/Web/API/Scheduler/postTask" } }, "Scheduling": { @@ -7484,14 +7340,6 @@ "name": "https://developer.mozilla.org/docs/Web/API/SharedWorkerGlobalScope/name" } }, - "SnapEvent": { - "url": "https://developer.mozilla.org/docs/Web/API/SnapEvent", - "inst": { - "SnapEvent": "https://developer.mozilla.org/docs/Web/API/SnapEvent/SnapEvent", - "snapTargetBlock": "https://developer.mozilla.org/docs/Web/API/SnapEvent/snapTargetBlock", - "snapTargetInline": "https://developer.mozilla.org/docs/Web/API/SnapEvent/snapTargetInline" - } - }, "SourceBuffer": { "url": "https://developer.mozilla.org/docs/Web/API/SourceBuffer", "inst": { @@ -8835,7 +8683,6 @@ "uniformMatrix4fv": "https://developer.mozilla.org/docs/Web/API/WebGLRenderingContext/uniformMatrix", "uniformMatrix4x2fv": "https://developer.mozilla.org/docs/Web/API/WebGL2RenderingContext/uniformMatrix", "uniformMatrix4x3fv": "https://developer.mozilla.org/docs/Web/API/WebGL2RenderingContext/uniformMatrix", - "unpackColorSpace": "https://developer.mozilla.org/docs/Web/API/WebGL2RenderingContext/unpackColorSpace", "useProgram": "https://developer.mozilla.org/docs/Web/API/WebGLRenderingContext/useProgram", "validateProgram": "https://developer.mozilla.org/docs/Web/API/WebGLRenderingContext/validateProgram", "vertexAttrib1f": "https://developer.mozilla.org/docs/Web/API/WebGLRenderingContext/vertexAttrib", @@ -9316,7 +9163,6 @@ "globalPrivacyControl": "https://developer.mozilla.org/docs/Web/API/WorkerNavigator/globalPrivacyControl", "gpu": "https://developer.mozilla.org/docs/Web/API/WorkerNavigator/gpu", "hardwareConcurrency": "https://developer.mozilla.org/docs/Web/API/Navigator/hardwareConcurrency", - "hid": "https://developer.mozilla.org/docs/Web/API/WorkerNavigator/hid", "language": "https://developer.mozilla.org/docs/Web/API/WorkerNavigator/language", "languages": "https://developer.mozilla.org/docs/Web/API/WorkerNavigator/languages", "locks": "https://developer.mozilla.org/docs/Web/API/WorkerNavigator/locks", @@ -9862,8 +9708,8 @@ "atob": "https://developer.mozilla.org/docs/Web/API/Window/atob", "btoa": "https://developer.mozilla.org/docs/Web/API/Window/btoa", "caches": "https://developer.mozilla.org/docs/Web/API/Window/caches", - "clearInterval": "https://developer.mozilla.org/docs/Web/API/Window/clearInterval", - "clearTimeout": "https://developer.mozilla.org/docs/Web/API/Window/clearTimeout", + "clearInterval": "https://developer.mozilla.org/docs/Web/API/clearInterval", + "clearTimeout": "https://developer.mozilla.org/docs/Web/API/clearTimeout", "console": { "url": "https://developer.mozilla.org/docs/Web/API/console", "stat": { @@ -9891,7 +9737,7 @@ "warn": "https://developer.mozilla.org/docs/Web/API/console/warn_static" } }, - "createImageBitmap": "https://developer.mozilla.org/docs/Web/API/Window/createImageBitmap", + "createImageBitmap": "https://developer.mozilla.org/docs/Web/API/createImageBitmap", "crossOriginIsolated": "https://developer.mozilla.org/docs/Web/API/Window/crossOriginIsolated", "crypto": "https://developer.mozilla.org/docs/Web/API/Window/crypto", "fetch": "https://developer.mozilla.org/docs/Web/API/Window/fetch", @@ -9899,12 +9745,12 @@ "isSecureContext": "https://developer.mozilla.org/docs/Web/API/Window/isSecureContext", "origin": "https://developer.mozilla.org/docs/Web/API/Window/origin", "performance": "https://developer.mozilla.org/docs/Web/API/Window/performance", - "queueMicrotask": "https://developer.mozilla.org/docs/Web/API/Window/queueMicrotask", - "reportError": "https://developer.mozilla.org/docs/Web/API/Window/reportError", + "queueMicrotask": "https://developer.mozilla.org/docs/Web/API/queueMicrotask", + "reportError": "https://developer.mozilla.org/docs/Web/API/reportError", "scheduler": "https://developer.mozilla.org/docs/Web/API/Window/scheduler", - "setInterval": "https://developer.mozilla.org/docs/Web/API/Window/setInterval", - "setTimeout": "https://developer.mozilla.org/docs/Web/API/Window/setTimeout", - "structuredClone": "https://developer.mozilla.org/docs/Web/API/Window/structuredClone", + "setInterval": "https://developer.mozilla.org/docs/Web/API/setInterval", + "setTimeout": "https://developer.mozilla.org/docs/Web/API/setTimeout", + "structuredClone": "https://developer.mozilla.org/docs/Web/API/structuredClone", "trustedTypes": "https://developer.mozilla.org/docs/Web/API/Window/trustedTypes", "AggregateError": { "url": "https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/AggregateError", @@ -10866,13 +10712,7 @@ "Uint8Array": { "url": "https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Uint8Array", "inst": { - "Uint8Array": "https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Uint8Array/Uint8Array", - "fromBase64": "https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Uint8Array/fromBase64", - "fromHex": "https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Uint8Array/fromHex", - "setFromBase64": "https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Uint8Array/setFromBase64", - "setFromHex": "https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Uint8Array/setFromHex", - "toBase64": "https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Uint8Array/toBase64", - "toHex": "https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Uint8Array/toHex" + "Uint8Array": "https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Uint8Array/Uint8Array" } }, "Uint8ClampedArray": { diff --git a/package.json b/package.json index 5aeabe6..02b3c11 100644 --- a/package.json +++ b/package.json @@ -2,6 +2,7 @@ "name": "typedoc-plugin-mdn-links", "version": "4.0.1", "main": "dist/index.js", + "type": "module", "license": "MIT", "devDependencies": { "@webgpu/types": "^0.1.43", diff --git a/scripts/generateWebApiIndex.js b/scripts/generateWebApiIndex.js index 460b1b0..874b928 100644 --- a/scripts/generateWebApiIndex.js +++ b/scripts/generateWebApiIndex.js @@ -1,6 +1,9 @@ -const bcd = require("@mdn/browser-compat-data"); -const { writeFileSync } = require("fs"); -const { join } = require("path"); +import bcd from "@mdn/browser-compat-data" assert { type: "json" }; +import { writeFileSync } from "node:fs"; +import { join, resolve } from "node:path"; +import { fileURLToPath } from "node:url"; + +const dirname = resolve(fileURLToPath(import.meta.url), ".."); /** @typedef {import("../src/webApi").WebApiData} WebApiData */ @@ -61,6 +64,6 @@ for (const key in bcd.javascript.builtins) { console.log("There are", Object.keys(results).length, "root entries."); writeFileSync( - join(__dirname, "../data/web-api.json"), + join(dirname, "../data/web-api.json"), JSON.stringify(results, null, "\t"), ); diff --git a/src/index.ts b/src/index.ts index 7d28d7d..bd76525 100644 --- a/src/index.ts +++ b/src/index.ts @@ -1,17 +1,17 @@ import { Application, - CommentDisplayPart, - ComponentPath, + type CommentDisplayPart, + type ComponentPath, Converter, - DeclarationReference, + type DeclarationReference, ParameterType, Reflection, ReflectionSymbolId, splitUnquotedString, - SymbolReference, + type SymbolReference, } from "typedoc"; -import { resolveTsType } from "./typescript"; -import { resolveWebApiPath } from "./webApi"; +import { resolveTsType } from "./typescript.js"; +import { resolveWebApiPath } from "./webApi.js"; declare module "typedoc" { export interface TypeDocOptionMap { diff --git a/src/test/plugin.test.ts b/src/test/plugin.test.ts index 72745bc..b6f8e98 100644 --- a/src/test/plugin.test.ts +++ b/src/test/plugin.test.ts @@ -1,7 +1,7 @@ import { Application, DeclarationReflection, - InlineTagDisplayPart, + type InlineTagDisplayPart, ProjectReflection, QueryType, ReferenceType, diff --git a/src/typescript.ts b/src/typescript.ts index d6b1939..163f5e8 100644 --- a/src/typescript.ts +++ b/src/typescript.ts @@ -1,4 +1,4 @@ -import { ComponentPath } from "typedoc"; +import type { ComponentPath } from "typedoc"; const utilityTypes = new Map([ ["Awaited", "awaitedtype"], diff --git a/src/webApi.ts b/src/webApi.ts index 5a041e1..836f723 100644 --- a/src/webApi.ts +++ b/src/webApi.ts @@ -1,4 +1,4 @@ -import { ComponentPath } from "typedoc"; +import type { ComponentPath } from "typedoc"; export interface WebApiData { url: string; @@ -6,7 +6,7 @@ export interface WebApiData { stat?: Record; } -import _webApi from "#data"; +import _webApi from "#data" assert { type: "json" }; const webApi = _webApi as Record; function resolvePath( diff --git a/tsconfig.json b/tsconfig.json index f3d5991..7c8a648 100644 --- a/tsconfig.json +++ b/tsconfig.json @@ -1,7 +1,7 @@ { "compilerOptions": { "target": "es2020", - "module": "Node16", + "module": "NodeNext", "lib": ["ESNext", "DOM"], "rootDir": "src", "strict": true, @@ -10,7 +10,8 @@ "resolveJsonModule": true, "outDir": "dist", "types": [], - "skipLibCheck": true + "skipLibCheck": true, + "verbatimModuleSyntax": true }, "include": ["."] }