Add @astrojs/webapi package (#2729)

* chore: add @astrojs/webapi

* chore: update package.json

* fix: update file case

* fix: remove lowercase file

* chore: update tests to use mocha

* chore: update LICENSE

examples/ssr/package.json

@@ -15,8 +15,5 @@
  "unocss": "^0.15.5",
  "vite-imagetools": "^4.0.1",
  "@astrojs/renderer-svelte": "^0.5.1"
- },
- "dependencies": {
- "@astropub/webapi": "^0.10.13"
  }
 }

examples/ssr/server/server.mjs

@@ -2,7 +2,7 @@ import { createServer } from 'http';
 import fs from 'fs';
 import mime from 'mime';
 import { loadApp } from 'astro/app/node';
-import { polyfill } from '@astropub/webapi';
+import { polyfill } from '@astrojs/webapi';
 import { apiHandler } from './api.mjs';
 
 polyfill(globalThis);

package.json

@@ -11,7 +11,7 @@
  "build": "turbo run build --no-deps --scope=astro --scope=create-astro --scope=\"@astrojs/*\"",
  "build:examples": "turbo run build --scope=\"@example/*\"",
  "dev": "turbo run dev --no-deps --no-cache --parallel --scope=astro --scope=create-astro --scope=\"@astrojs/*\"",
- "test": "turbo run test --scope=astro",
+ "test": "turbo run test --scope=astro --scope=\"@astrojs/*\"",
  "test:match": "cd packages/astro && yarn run test:match",
  "test:templates": "turbo run test --scope=create-astro",
  "test:smoke": "node scripts/smoke/index.js",
@@ -36,7 +36,6 @@
  ],
  "volta": {
  "node": "14.17.0",
- "npm": "7.11.2",
  "yarn": "1.22.10"
  },
  "devDependencies": {

packages/astro/package.json

@@ -66,7 +66,7 @@
  "@astrojs/renderer-react": "0.5.0",
  "@astrojs/renderer-svelte": "0.5.1",
  "@astrojs/renderer-vue": "0.4.0",
- "@astropub/webapi": "^0.10.1",
+ "@astrojs/webapi": "^0.11.0",
  "@babel/core": "^7.15.8",
  "@babel/traverse": "^7.15.4",
  "@proload/core": "^0.2.2",

packages/astro/src/core/build/index.ts

@@ -3,7 +3,7 @@ import type { LogOptions } from '../logger';
 
 import fs from 'fs';
 import * as colors from 'kleur/colors';
-import { polyfill } from '@astropub/webapi';
+import { polyfill } from '@astrojs/webapi';
 import { performance } from 'perf_hooks';
 import * as vite from 'vite';
 import { createVite, ViteConfigWithSSR } from '../create-vite.js';

packages/astro/src/core/dev/index.ts

@@ -1,4 +1,4 @@
-import { polyfill } from '@astropub/webapi';
+import { polyfill } from '@astrojs/webapi';
 import type { AddressInfo } from 'net';
 import { performance } from 'perf_hooks';
 import type { AstroConfig } from '../../@types/astro';

packages/astro/test/test-utils.js

@@ -1,5 +1,5 @@
 import { execa } from 'execa';
-import { polyfill } from '@astropub/webapi';
+import { polyfill } from '@astrojs/webapi';
 import fs from 'fs';
 import { fileURLToPath } from 'url';
 import { loadConfig } from '../dist/core/config.js';

packages/webapi/LICENSE

@@ -0,0 +1,37 @@
+MIT License Copyright (c) 2022 The Astro Technology Company
+
+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
+(including the next paragraph) 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.
+
+---
+
+Code from [@astrocommunity/webapi](https://www.npmjs.com/@astrocommunity/webapi) is licensed under the CC0-1.0 License.
+
+Code from [abort-controller](https://www.npmjs.com/package/abort-controller) is licensed under the MIT License (MIT), Copyright Toru Nagashima.
+
+Code from [event-target-shim](https://www.npmjs.com/package/event-target-shim) is licensed under the MIT License (MIT), Copyright Toru Nagashima.
+
+Code from [fetch-blob](https://www.npmjs.com/package/fetch-blob) is licensed under the MIT License (MIT), Copyright Jimmy Wärting.
+
+Code from [formdata-polyfill](https://www.npmjs.com/package/formdata-polyfill) is licensed under the MIT License (MIT), Copyright Jimmy Wärting.
+
+Code from [node-fetch](https://www.npmjs.com/package/node-fetch) is licensed under the MIT License (MIT), Copyright Node Fetch Team.
+
+Code from [web-streams-polyfill](https://www.npmjs.com/package/web-streams-polyfill) is licensed under the MIT License (MIT), Copyright Mattias Buelens and Diwank Singh Tomer.

packages/webapi/README.md

@@ -0,0 +1,179 @@
+# WebAPI
+
+**WebAPI** lets you use Web APIs in Node v12, v14, and v16.
+
+```shell
+npm install @astrojs/webapi
+```
+
+```js
+import { polyfill } from '@astrojs/webapi'
+
+polyfill(globalThis)
+
+const t = new EventTarget()
+const e = new CustomEvent('hello')
+
+t.addEventListener('hello', console.log)
+
+t.dispatchEvent(e) // logs `e` event from `t`
+```
+
+These APIs are combined from popular open source projects and configured to share implementation details. This allows their behavior to match browser expectations as well as reduce their combined memory footprint.
+
+## Features
+
+- [AbortController](https://developer.mozilla.org/en-US/docs/Web/API/AbortController)
+- [AbortSignal](https://developer.mozilla.org/en-US/docs/Web/API/AbortSignal)
+- [Blob](https://developer.mozilla.org/en-US/docs/Web/API/Blob)
+- [ByteLengthQueuingStrategy](https://developer.mozilla.org/en-US/docs/Web/API/ByteLengthQueuingStrategy)
+- [CanvasRenderingContext2D](https://developer.mozilla.org/en-US/docs/Web/API/CanvasRenderingContext2D)
+- [CSSStyleSheet](https://developer.mozilla.org/en-US/docs/Web/API/CSSStyleSheet)
+- [CountQueuingStrategy](https://developer.mozilla.org/en-US/docs/Web/API/CountQueuingStrategy)
+- [CustomElementRegistry](https://developer.mozilla.org/en-US/docs/Web/API/CustomElementRegistry)
+- [CustomEvent](https://developer.mozilla.org/en-US/docs/Web/API/CustomEvent)
+- [DOMException](https://developer.mozilla.org/en-US/docs/Web/API/DOMException)
+- [Document](https://developer.mozilla.org/en-US/docs/Web/API/Document)
+- [DocumentFragment](https://developer.mozilla.org/en-US/docs/Web/API/DocumentFragment)
+- [Element](https://developer.mozilla.org/en-US/docs/Web/API/Element)
+- [Event](https://developer.mozilla.org/en-US/docs/Web/API/Event)
+- [EventTarget](https://developer.mozilla.org/en-US/docs/Web/API/EventTarget)
+- [File](https://developer.mozilla.org/en-US/docs/Web/API/File)
+- [FormData](https://developer.mozilla.org/en-US/docs/Web/API/FormData)
+- [HTMLDocument](https://developer.mozilla.org/en-US/docs/Web/API/HTMLDocument)
+- [HTMLElement](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement)
+- [HTMLBodyElement](https://developer.mozilla.org/en-US/docs/Web/API/HTMLBodyElement)
+- [HTMLCanvasElement](https://developer.mozilla.org/en-US/docs/Web/API/HTMLCanvasElement)
+- [HTMLDivElement](https://developer.mozilla.org/en-US/docs/Web/API/HTMLDivElement)
+- [HTMLHeadElement](https://developer.mozilla.org/en-US/docs/Web/API/HTMLHeadElement)
+- [HTMLHtmlElement](https://developer.mozilla.org/en-US/docs/Web/API/HTMLHtmlElement)
+- [HTMLImageElement](https://developer.mozilla.org/en-US/docs/Web/API/HTMLImageElement)
+- [HTMLSpanElement](https://developer.mozilla.org/en-US/docs/Web/API/HTMLSpanElement)
+- [HTMLStyleElement](https://developer.mozilla.org/en-US/docs/Web/API/HTMLStyleElement)
+- [HTMLTemplateElement](https://developer.mozilla.org/en-US/docs/Web/API/HTMLTemplateElement)
+- [HTMLUnknownElement](https://developer.mozilla.org/en-US/docs/Web/API/HTMLUnknownElement)
+- [Headers](https://developer.mozilla.org/en-US/docs/Web/API/Headers)
+- [IntersectionObserver](https://developer.mozilla.org/en-US/docs/Web/API/IntersectionObserver)
+- [Image](https://developer.mozilla.org/en-US/docs/Web/API/Image)
+- [ImageData](https://developer.mozilla.org/en-US/docs/Web/API/ImageData)
+- [MediaQueryList](https://developer.mozilla.org/en-US/docs/Web/API/MediaQueryList)
+- [MutationObserver](https://developer.mozilla.org/en-US/docs/Web/API/MutationObserver)
+- [Node](https://developer.mozilla.org/en-US/docs/Web/API/Node)
+- [NodeIterator](https://developer.mozilla.org/en-US/docs/Web/API/NodeIterator)
+- [OffscreenCanvas](https://developer.mozilla.org/en-US/docs/Web/API/OffscreenCanvas)
+- [ReadableByteStreamController](https://developer.mozilla.org/en-US/docs/Web/API/ReadableByteStreamController)
+- [ReadableStream](https://developer.mozilla.org/en-US/docs/Web/API/ReadableStream)
+- [ReadableStreamBYOBReader](https://developer.mozilla.org/en-US/docs/Web/API/ReadableStreamBYOBReader)
+- [ReadableStreamBYOBRequest](https://developer.mozilla.org/en-US/docs/Web/API/ReadableStreamBYOBRequest)
+- [ReadableStreamDefaultController](https://developer.mozilla.org/en-US/docs/Web/API/ReadableStreamDefaultController)
+- [ReadableStreamDefaultReader](https://developer.mozilla.org/en-US/docs/Web/API/ReadableStreamDefaultReader)
+- [Request](https://developer.mozilla.org/en-US/docs/Web/API/Request)
+- [Response](https://developer.mozilla.org/en-US/docs/Web/API/Response)
+- [ShadowRoot](https://developer.mozilla.org/en-US/docs/Web/API/ShadowRoot)
+- [Storage](https://developer.mozilla.org/en-US/docs/Web/API/Storage)
+- [StyleSheet](https://developer.mozilla.org/en-US/docs/Web/API/StyleSheet)
+- [TransformStream](https://developer.mozilla.org/en-US/docs/Web/API/TransformStream)
+- [TreeWalker](https://developer.mozilla.org/en-US/docs/Web/API/TreeWalker)
+- [WritableStream](https://developer.mozilla.org/en-US/docs/Web/API/WritableStream)
+- [WritableStreamDefaultController](https://developer.mozilla.org/en-US/docs/Web/API/WritableStreamDefaultController)
+- [WritableStreamDefaultWriter](https://developer.mozilla.org/en-US/docs/Web/API/WritableStreamDefaultWriter)
+- [Window](https://developer.mozilla.org/en-US/docs/Web/API/Window)
+- [atob](https://developer.mozilla.org/en-US/docs/Web/API/atob)
+- [btoa](https://developer.mozilla.org/en-US/docs/Web/API/btoa)
+- [cancelAnimationFrame](https://developer.mozilla.org/en-US/docs/Web/API/cancelAnimationFrame)
+- [cancelIdleCallback](https://developer.mozilla.org/en-US/docs/Web/API/cancelIdleCallback)
+- [clearTimeout](https://developer.mozilla.org/en-US/docs/Web/API/clearTimeout)
+- [fetch](https://developer.mozilla.org/en-US/docs/Web/API/fetch)
+- [localStorage](https://developer.mozilla.org/en-US/docs/Web/API/localStorage)
+- [requestAnimationFrame](https://developer.mozilla.org/en-US/docs/Web/API/requestAnimationFrame)
+- [requestIdleCallback](https://developer.mozilla.org/en-US/docs/Web/API/requestIdleCallback)
+- [setTimeout](https://developer.mozilla.org/en-US/docs/Web/API/setTimeout)
+- [structuredClone](https://developer.mozilla.org/en-US/docs/Web/API/structuredClone)
+- [Object.hasOwn](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object/hasOwn)
+- [Promise.any](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise/any)
+- [Array.prototype.at](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array/at)
+- [String.prototype.at](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String/at)
+- [String.prototype.replaceAll](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String/replaceAll)
+- [TypedArray.prototype.at](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/TypedArray/at)
+- [URLPattern](https://developer.mozilla.org/en-US/docs/Web/API/URLPattern)
+
+## Usage
+
+You can use WebAPIs as individual exports.
+
+```js
+import { AbortController, Blob, Event, EventTarget, File, fetch, Response } from '@astrojs/webapi'
+```
+
+You can apply WebAPIs to an object, like `globalThis`.
+
+```js
+import { polyfill } from '@astrojs/webapi'
+
+polyfill(globalThis)
+```
+
+## Polyfill Options
+
+The `exclude` option receives a list of WebAPIs to exclude from polyfilling.
+
+```js
+polyfill(globalThis, {
+ // disables polyfills for setTimeout clearTimeout
+ exclude: 'setTimeout clearTimeout',
+})
+```
+
+The `exclude` option accepts shorthands to exclude multiple polyfills. These shorthands end with the plus sign (`+`).
+
+```js
+polyfill(globalThis, {
+ // disables polyfills for setTimeout clearTimeout
+ exclude: 'Timeout+',
+})
+```
+
+```js
+polyfill(globalThis, {
+ // disables polyfills for Node, Window, Document, HTMLElement, etc.
+ exclude: 'Node+',
+})
+```
+
+```js
+polyfill(globalThis, {
+ // disables polyfills for Event, EventTarget, Node, Window, Document, HTMLElement, etc.
+ exclude: 'Event+',
+})
+```
+
+| Shorthand | Excludes |
+|:-------------- |:-------- |
+| `Blob+` | `Blob`, `File` |
+| `Document+` | `Document`, `HTMLDocument` |
+| `Element+` | `Element`, and exclusions from `HTMLElement+` |
+| `Event+` | `Event`, `CustomEvent`, `EventTarget`, `AbortSignal`, `MediaQueryList`, `Window`, and exclusions from `Node+` |
+| `EventTarget+` | `Event`, `CustomEvent`, `EventTarget`, `AbortSignal`, `MediaQueryList`, `Window`, and exclusions from `Node+` |
+| `HTMLElement+` | `CustomElementsRegistry`, `HTMLElement`, `HTMLBodyElement`, `HTMLCanvasElement`, `HTMLDivElement`, `HTMLHeadElement`, `HTMLHtmlElement`, `HTMLImageElement`, `HTMLStyleElement`, `HTMLTemplateElement`, `HTMLUnknownElement`, `Image` |
+| `Node+` | `Node`, `DocumentFragment`, `ShadowRoot`, `Document`, `HTMLDocument`, and exclusions from `Element+` |
+| `StyleSheet+` | `StyleSheet`, `CSSStyleSheet` |
+
+---
+
+
+
+## License
+
+Code original to this project is licensed under the CC0-1.0 License.
+
+Code from [abort-controller](https://www.npmjs.com/package/abort-controller) is licensed under the MIT License (MIT), Copyright Toru Nagashima.
+
+Code from [event-target-shim](https://www.npmjs.com/package/event-target-shim) is licensed under the MIT License (MIT), Copyright Toru Nagashima.
+
+Code from [fetch-blob](https://www.npmjs.com/package/fetch-blob) is licensed under the MIT License (MIT), Copyright Jimmy Wärting.
+
+Code from [formdata-polyfill](https://www.npmjs.com/package/formdata-polyfill) is licensed under the MIT License (MIT), Copyright Jimmy Wärting.
+
+Code from [node-fetch](https://www.npmjs.com/package/node-fetch) is licensed under the MIT License (MIT), Copyright Node Fetch Team.
+
+Code from [web-streams-polyfill](https://www.npmjs.com/package/web-streams-polyfill) is licensed under the MIT License (MIT), Copyright Mattias Buelens and Diwank Singh Tomer.

packages/webapi/apply.js

@@ -0,0 +1,5 @@
+import { polyfill } from './mod.js'
+
+export * from './mod.js'
+
+polyfill(globalThis)

packages/webapi/mod.d.ts

@@ -0,0 +1,12 @@
+export { AbortController, AbortSignal, Blob, ByteLengthQueuingStrategy, CanvasRenderingContext2D, CharacterData, Comment, CountQueuingStrategy, CSSStyleSheet, CustomElementRegistry, CustomEvent, DOMException, Document, DocumentFragment, Element, Event, EventTarget, File, FormData, HTMLDocument, HTMLElement, HTMLBodyElement, HTMLCanvasElement, HTMLDivElement, HTMLHeadElement, HTMLHtmlElement, HTMLImageElement, HTMLSpanElement, HTMLStyleElement, HTMLTemplateElement, HTMLUnknownElement, Headers, IntersectionObserver, Image, ImageData, MediaQueryList, MutationObserver, Node, NodeFilter, NodeIterator, OffscreenCanvas, ReadableByteStreamController, ReadableStream, ReadableStreamBYOBReader, ReadableStreamBYOBRequest, ReadableStreamDefaultController, ReadableStreamDefaultReader, Request, ResizeObserver, Response, ShadowRoot, StyleSheet, Text, TransformStream, TreeWalker, URLPattern, WritableStream, WritableStreamDefaultController, WritableStreamDefaultWriter, Window, alert, atob, btoa, cancelAnimationFrame, cancelIdleCallback, clearTimeout, fetch, requestAnimationFrame, requestIdleCallback, setTimeout, structuredClone, } from './mod.js';
+export { pathToPosix } from './lib/utils';
+export declare const polyfill: {
+ (target: any, options?: PolyfillOptions | undefined): any;
+ internals(target: any, name: string): any;
+};
+interface PolyfillOptions {
+ exclude?: string | string[];
+ override?: Record<string, {
+ (...args: any[]): any;
+ }>;
+}