@rescript/webapi 0.1.0-experimental-34acf7e → 0.1.0-experimental-3f4e07b

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@rescript/webapi",
-  "version": "0.1.0-experimental-34acf7e",
+  "version": "0.1.0-experimental-3f4e07b",
   "description": "Experimental successor to [rescript-webapi](https://github.com/TheSpyder/rescript-webapi)",
   "homepage": "https://rescript-lang.github.io/experimental-rescript-webapi/",
   "bugs": "https://github.com/rescript-lang/experimental-rescript-webapi/issues",
@@ -35,10 +35,10 @@
   },
   "license": "MIT",
   "dependencies": {
-    "rescript": "^12.0.0-alpha.6"
+    "rescript": "^12.0.0-alpha.8"
   },
   "devDependencies": {
-    "@astrojs/starlight": "0.31.1",
+    "@astrojs/starlight": "0.32.0",
     "astro": "^5.1.1",
     "micromark": "^4.0.1",
     "prettier": "^3.3.3",

package/src/DOMAPI.res

@@ -10,17 +10,14 @@ open MediaCaptureAndStreamsAPI
 open MediaSessionAPI
 open PermissionsAPI
 open ScreenWakeLockAPI
+open WebWorkersAPI
 open ServiceWorkerAPI
 open EncryptedMediaExtensionsAPI
-open GamepadAPI
 open FileAPI
-open WebMIDIAPI
 open HistoryAPI
 open VisualViewportAPI
 open WebSpeechAPI
-open ViewTransitionsAPI
 open FileAndDirectoryEntriesAPI
-open WebVTTAPI
 open RemotePlaybackAPI
 open CanvasAPI
 open StorageAPI

package/src/EventAPI/ExtendableEvent.res

@@ -0,0 +1,20 @@
+open EventAPI
+
+module Impl = (
+  T: {
+    type t
+  },
+) => {
+  external asExtendableEvent: T.t => extendableEvent = "%identity"
+
+  include Event.Impl({
+    type t = T.t
+  })
+
+  @send
+  external waitUntil: (T.t, promise<'a>) => unit = "waitUntil"
+}
+
+include Impl({
+  type t = extendableEvent
+})

package/src/EventAPI.res

@@ -51,6 +51,7 @@ type eventType =
   | @as("mouseout") Mouseout
   | @as("mouseover") Mouseover
   | @as("mouseup") Mouseup
+  | @as("notificationclick") NotificationClick
   | @as("paste") Paste
   | @as("pause") Pause
   | @as("play") Play
@@ -94,6 +95,7 @@ type eventType =
   | @as("pointercancel") Pointercancel
   | @as("pointerout") Pointerout
   | @as("pointerleave") Pointerleave
+  | @as("push") Push
   | @as("gotpointercapture") Gotpointercapture
   | @as("lostpointercapture") Lostpointercapture
   | @as("selectstart") Selectstart
@@ -217,3 +219,12 @@ type eventInit = {
   mutable cancelable?: bool,
   mutable composed?: bool,
 }
+
+/**
+The ExtendableEvent interface extends the lifetime of the install and activate events dispatched on the global scope as part of the service worker lifecycle.
+[See ExtendableEvent on MDN](https://developer.mozilla.org/docs/Web/API/ExtendableEvent)
+ */
+@editor.completeFrom(ExtendableEvent)
+type extendableEvent = {
+  ...event,
+}

package/src/Global.res

@@ -5,7 +5,7 @@ open WebSpeechAPI
 open IndexedDBAPI
 open WebCryptoAPI
 open PerformanceAPI
-open ServiceWorkerAPI
+open WebWorkersAPI
 open WebStorageAPI
 open CanvasAPI
 open FileAPI

package/src/NotificationAPI.res

@@ -63,7 +63,17 @@ type notification = {
   /**
     [Read more on MDN](https://developer.mozilla.org/docs/Web/API/Notification/data)
     */
-  data: JSON.t,
+  data?: JSON.t,
+}
+
+/**
+ An array of actions to display in the notification, for which the default is an empty array. 
+ [Read more on MDN](https://developer.mozilla.org/en-US/docs/Web/API/ServiceWorkerRegistration/showNotification#actions)
+ */
+type notificationAction = {
+  action: string,
+  title: string,
+  icon?: string,
 }
 
 type notificationOptions = {
@@ -76,8 +86,21 @@ type notificationOptions = {
   mutable silent?: Null.t<bool>,
   mutable requireInteraction?: bool,
   mutable data?: JSON.t,
+  mutable actions?: array<notificationAction>,
 }
 
 type getNotificationOptions = {mutable tag?: string}
 
 type notificationPermissionCallback = notificationPermission => unit
+
+type notificationEvent = {
+  ...extendableEvent,
+  /**
+    [Read more on MDN](https://developer.mozilla.org/docs/Web/API/NotificationEvent/action)
+  */
+  action: string,
+  /**
+    [Read more on MDN](https://developer.mozilla.org/docs/Web/API/NotificationEvent/notification)
+  */
+  notification: notification,
+}

package/src/PushAPI/ApplicationServerKey.res

@@ -0,0 +1,4 @@
+open PushAPI
+
+external fromString: string => applicationServerKey = "%identity"
+external fromUint8Array: Uint8Array.t => applicationServerKey = "%identity"

package/src/PushAPI/PushEvent.res

@@ -0,0 +1,5 @@
+open PushAPI
+
+include ExtendableEvent.Impl({
+  type t = pushEvent
+})

package/src/{PushManagerAPI → PushAPI}/PushManager.res

@@ -1,4 +1,4 @@
-open PushManagerAPI
+open PushAPI
 
 /**
 [Read more on MDN](https://developer.mozilla.org/docs/Web/API/PushManager/subscribe)

package/src/PushAPI/PushMessageData.res

@@ -0,0 +1,15 @@
+open PushAPI
+
+/**
+The json() method of the PushMessageData interface extracts push message data by parsing it as a JSON string and returning the result.
+[Read more on MDN](https://developer.mozilla.org/docs/Web/API/PushMessageData/json)
+*/
+@send
+external json: pushMessageData => JSON.t = "json"
+
+/**
+The text() method of the PushMessageData interface extracts push message data as a plain text string.
+[Read more on MDN](https://developer.mozilla.org/docs/Web/API/PushMessageData/text)
+*/
+@send
+external text: pushMessageData => string = "text"

package/src/{PushManagerAPI → PushAPI}/PushSubscription.res

@@ -1,4 +1,4 @@
-open PushManagerAPI
+open PushAPI
 
 /**
 [Read more on MDN](https://developer.mozilla.org/docs/Web/API/PushSubscription/getKey)

package/src/{PushManagerAPI.res → PushAPI.res}

@@ -1,6 +1,7 @@
 @@warning("-30")
 
 open Prelude
+open EventAPI
 
 type permissionState =
   | @as("denied") Denied
@@ -23,6 +24,8 @@ type pushManager = {
   supportedContentEncodings: array<string>,
 }
 
+type applicationServerKey
+
 /**
 [See PushSubscriptionOptions on MDN](https://developer.mozilla.org/docs/Web/API/PushSubscriptionOptions)
 */
@@ -34,7 +37,7 @@ type pushSubscriptionOptions = {
   /**
     [Read more on MDN](https://developer.mozilla.org/docs/Web/API/PushSubscriptionOptions/applicationServerKey)
     */
-  applicationServerKey: Null.t<ArrayBuffer.t>,
+  applicationServerKey: applicationServerKey,
 }
 
 /**
@@ -59,11 +62,30 @@ type pushSubscription = {
 
 type pushSubscriptionOptionsInit = {
   mutable userVisibleOnly?: bool,
-  mutable applicationServerKey?: Null.t<unknown>,
+  mutable applicationServerKey?: applicationServerKey,
+}
+
+type pushSubscriptionJSONKeys = {
+  /** Base64URL-encoded ArrayBuffer value */
+  p256dh: string,
+  /** Base64URL-encoded ArrayBuffer value */
+  auth: string,
 }
 
 type pushSubscriptionJSON = {
   mutable endpoint?: string,
   mutable expirationTime?: Null.t<int>,
-  mutable keys?: any,
+  mutable keys?: pushSubscriptionJSONKeys,
+}
+
+@editor.completeFrom(PushMessageData)
+type pushMessageData
+
+@editor.completeFrom(PushEvent)
+type pushEvent = {
+  ...extendableEvent,
+  /**
+   [Read more on MDN](https://developer.mozilla.org/docs/Web/API/PushEvent/data)
+   */
+  data?: pushMessageData,
 }

package/src/ServiceWorkerAPI/Cache.res

@@ -1,5 +1,5 @@
 open FetchAPI
-open ServiceWorkerAPI
+open WebWorkersAPI
 
 /**
 [Read more on MDN](https://developer.mozilla.org/docs/Web/API/Cache/match)

package/src/ServiceWorkerAPI/Clients.res

@@ -0,0 +1,4 @@
+open ServiceWorkerAPI
+
+@send
+external openWindow: (clients, string) => promise<windowClient> = "open"

package/src/ServiceWorkerAPI/ServiceWorkerContainer.res

@@ -1,4 +1,3 @@
-open EventAPI
 open ServiceWorkerAPI
 
 include EventTarget.Impl({
@@ -11,7 +10,7 @@ include EventTarget.Impl({
 @send
 external register: (
   serviceWorkerContainer,
-  ~scriptURL: string,
+  string,
   ~options: registrationOptions=?,
 ) => promise<serviceWorkerRegistration> = "register"
 

package/src/ServiceWorkerAPI/ServiceWorkerGlobalScope.res

@@ -0,0 +1,5 @@
+open ServiceWorkerAPI
+
+include WorkerGlobalScope.Impl({
+  type t = serviceWorkerGlobalScope
+})

package/src/ServiceWorkerAPI.res

@@ -2,10 +2,8 @@
 
 open Prelude
 open EventAPI
-open PushManagerAPI
-open NotificationAPI
-open FetchAPI
-open ChannelMessagingAPI
+open PushAPI
+open WebWorkersAPI
 
 type serviceWorkerState =
   | @as("activated") Activated
@@ -101,20 +99,6 @@ type serviceWorkerContainer = {
   ready: promise<serviceWorkerRegistration>,
 }
 
-/**
-The storage for Cache objects.
-[See CacheStorage on MDN](https://developer.mozilla.org/docs/Web/API/CacheStorage)
-*/
-@editor.completeFrom(CacheStorage)
-type cacheStorage = {}
-
-/**
-Provides a storage mechanism for Request / Response object pairs that are cached, for example as part of the ServiceWorker life cycle. Note that the Cache interface is exposed to windowed scopes as well as workers. You don't have to use it in conjunction with service workers, even though it is defined in the service worker spec.
-[See Cache on MDN](https://developer.mozilla.org/docs/Web/API/Cache)
-*/
-@editor.completeFrom(Cache)
-type cache = {}
-
 type navigationPreloadState = {
   mutable enabled?: bool,
   mutable headerValue?: string,
@@ -126,15 +110,49 @@ type registrationOptions = {
   mutable updateViaCache?: serviceWorkerUpdateViaCache,
 }
 
-type cacheQueryOptions = {
-  mutable ignoreSearch?: bool,
-  mutable ignoreMethod?: bool,
-  mutable ignoreVary?: bool,
+type requestInfo = any
+
+/**
+The Clients interface provides access to Client objects. Access it via self.clients within a service worker.
+[See Clients on MDN](https://developer.mozilla.org/en-US/docs/Web/API/Clients)
+ */
+@editor.completeFrom(Clients)
+type clients
+
+/**
+The ServiceWorkerGlobalScope interface of the Service Worker API represents the global execution context of a service worker.
+[See ServiceWorkerGlobalScope on MDN](https://developer.mozilla.org/en-US/docs/Web/API/ServiceWorkerGlobalScope)
+ */
+@editor.completeFrom(ServiceWorkerGlobalScope)
+type serviceWorkerGlobalScope = {
+  ...workerGlobalScope,
+  /**
+    [Read more on MDN](https://developer.mozilla.org/en-US/docs/Web/API/ServiceWorkerGlobalScope/clients)
+  */
+  clients: clients,
+  /**
+    [Read more on MDN](https://developer.mozilla.org/en-US/docs/Web/API/ServiceWorkerGlobalScope/registration)
+  */
+  registration: serviceWorkerRegistration,
 }
 
-type multiCacheQueryOptions = {
-  ...cacheQueryOptions,
-  mutable cacheName?: string,
+/**
+The Client interface represents an executable context such as a Worker, or a SharedWorker. Window clients are represented by the more-specific WindowClient.
+[See Client on MDN](https://developer.mozilla.org/en-US/docs/Web/API/Client)
+*/
+type client = {
+  /**
+    [Read more on MDN](https://developer.mozilla.org/en-US/docs/Web/API/Client/id)
+  */
+  id: string,
+  /** [Read more on MDN](https://developer.mozilla.org/en-US/docs/Web/API/Client/url) */
+  url: string,
 }
 
-type requestInfo = any
+/**
+The WindowClient interface of the ServiceWorker API represents the scope of a service worker client that is a document in a browsing context, controlled by an active worker.
+[See WindowClient on MDN](https://developer.mozilla.org/en-US/docs/Web/API/WindowClient)
+*/
+type windowClient = {
+  ...client,
+}

package/src/{ServiceWorkerAPI → WebWorkersAPI}/CacheStorage.res

@@ -1,5 +1,5 @@
 open FetchAPI
-open ServiceWorkerAPI
+open WebWorkersAPI
 
 /**
 [Read more on MDN](https://developer.mozilla.org/docs/Web/API/CacheStorage/match)

package/src/WebWorkersAPI/WorkerGlobalScope.res

@@ -0,0 +1,45 @@
+open WebWorkersAPI
+open FetchAPI
+
+module Impl = (
+  T: {
+    type t
+  },
+) => {
+  include EventTarget.Impl({
+    type t = T.t
+  })
+
+  /**
+`fetch(workerGlobalScope, string, init)`
+
+The fetch() method of the WorkerGlobalScope interface starts the process of fetching a resource from the network, 
+returning a promise that is fulfilled once the response is available.
+
+```res
+let response = await self->WorkerGlobalScope.fetch("https://rescript-lang.org")
+```
+
+[Read more on MDN](https://developer.mozilla.org/en-US/docs/Web/API/WorkerGlobalScope/fetch)
+*/
+  @send
+  external fetch: (T.t, string, ~init: requestInit=?) => promise<response> = "fetch"
+
+  /**
+`fetch_withRequest(workerGlobalScope, request, init)`
+
+The fetch() method of the WorkerGlobalScope interface starts the process of fetching a resource from the network, 
+returning a promise that is fulfilled once the response is available.
+
+```res
+let response = await self->WorkerGlobalScope.fetch(myRequest)
+```
+
+[Read more on MDN](https://developer.mozilla.org/en-US/docs/Web/API/WorkerGlobalScope/fetch)
+*/
+  external fetch_withRequest: (T.t, request, ~init: requestInit=?) => promise<response> = "fetch"
+}
+
+include Impl({
+  type t = workerGlobalScope
+})

package/src/WebWorkersAPI.res

@@ -0,0 +1,46 @@
+open EventAPI
+
+/**
+Provides a storage mechanism for Request / Response object pairs that are cached, for example as part of the ServiceWorker life cycle. Note that the Cache interface is exposed to windowed scopes as well as workers. You don't have to use it in conjunction with service workers, even though it is defined in the service worker spec.
+[See Cache on MDN](https://developer.mozilla.org/docs/Web/API/Cache)
+*/
+@editor.completeFrom(Cache)
+type cache = {}
+
+/**
+The storage for Cache objects.
+[See CacheStorage on MDN](https://developer.mozilla.org/docs/Web/API/CacheStorage)
+*/
+@editor.completeFrom(CacheStorage)
+type cacheStorage = {}
+
+type cacheQueryOptions = {
+  mutable ignoreSearch?: bool,
+  mutable ignoreMethod?: bool,
+  mutable ignoreVary?: bool,
+}
+
+type multiCacheQueryOptions = {
+  ...cacheQueryOptions,
+  mutable cacheName?: string,
+}
+
+/**
+The WorkerGlobalScope interface of the Web Workers API is an interface representing the scope of any worker.
+Workers have no browsing context; this scope contains the information usually conveyed by Window objects —
+in this case event handlers, the console or the associated WorkerNavigator object. 
+Each WorkerGlobalScope has its own event loop.
+[See WorkerGlobalScope on MDN](https://developer.mozilla.org/en-US/docs/Web/API/WorkerGlobalScope)
+*/
+@editor.completeFrom(WorkerGlobalScope)
+type workerGlobalScope = {
+  ...eventTarget,
+  /**
+    [Read more on MDN](https://developer.mozilla.org/en-US/docs/Web/API/WorkerGlobalScope/caches)
+    */
+  caches: cacheStorage,
+  /**
+    [Read more on MDN](https://developer.mozilla.org/en-US/docs/Web/API/WorkerGlobalScope/crossOriginIsolated)
+    */
+  crossOriginIsolated: bool,
+}