Merge pull request #57 from rescript-lang/notifications

Add bindings for push notifications using service worker

Author: nojaf

package-lock.json

@@ -35,7 +35,7 @@
   },
   "license": "MIT",
   "dependencies": {
-    "rescript": "^12.0.0-alpha.6"
+    "rescript": "^12.0.0-alpha.8"
   },
   "devDependencies": {
     "@astrojs/starlight": "0.32.0",

package.json

@@ -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

src/DOMAPI.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
+}

src/EventAPI.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
+})

src/EventAPI/ExtendableEvent.js

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

src/EventAPI/ExtendableEvent.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,
+}

src/Global.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,23 @@ type pushSubscription = {
 
 type pushSubscriptionOptionsInit = {
   mutable userVisibleOnly?: bool,
-  mutable applicationServerKey?: Null.t<unknown>,
+  mutable applicationServerKey?: applicationServerKey,
 }
 
 type pushSubscriptionJSON = {
   mutable endpoint?: string,
   mutable expirationTime?: Null.t<int>,
   mutable keys?: any,
 }
+
+@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,
+}