@mythryl/app-sdk 0.1.6 → 0.1.7

package/README.md

@@ -34,14 +34,15 @@ on the server. Call it from effects and event handlers, which run in the browser
 | `sdk.openStorePage(domain?)` | Opens an app's store page in the host and minimises this app. Without a domain, it is this app's own page. |
 | `sdk.openApp({ domain, url? })` | Opens another mini app and closes this one. `url` is where to start, on that app's domain. |
 | `sdk.compose({ text?, embedUrl? })` | Opens the composer with a draft. `{ uri }` if the user posted, `{}` if they did not. |
+| `sdk.notifications.request()` | Asks the user to let the app notify them, adding it to their library too. On yes, Mythryl sends your server a notification token for the user (the `notifications.enabled` webhook). Resolves at once if they are already on; rejects with `cancelled` if they decline. |
 | `sdk.install()` | Asks the user to add this app to their library. Resolves at once if it is already there; rejects with `cancelled` if they decline. |
 | `sdk.follow(did)` | Asks the user to follow an account. Rejects with `cancelled` if they decline. |
 | `sdk.on(event, listener)` | Subscribes to a host event. Returns a function that removes the listener. |
 | `sdk.dispose()` | Removes listeners and rejects pending calls with `cancelled`. |
 
-`openProfile`, `openPost`, `openTopic`, `openUrl` and `openApp` need the `navigation` capability. `compose`, `follow` and `install`
+`openProfile`, `openPost`, `openTopic`, `openUrl` and `openApp` need the `navigation` capability. `compose`, `follow`, `install` and `notifications.request`
 each have a capability of the same name. Older hosts have none of them: check `sdk.getCapabilities()`
-first, or handle the `unsupported` rejection. Anything that writes (`compose`, `follow`, `install`) is confirmed by the user. A target the host cannot open rejects with `unavailable`.
+first, or handle the `unsupported` rejection. Anything that writes (`compose`, `follow`, `install`, `notifications.request`) is confirmed by the user. A target the host cannot open rejects with `unavailable`.
 
 ### Events
 
@@ -78,7 +79,7 @@ const response = await fetch("/api/me", { headers });
 ### Errors
 
 A call that fails rejects with a `ProtocolError`. Its `code` is `cancelled`, `unsupported`, `not_consented`,
-`rate_limited` or `unavailable`. A call the host answers by itself that gets no answer within 30 seconds rejects with `unavailable`. A call that waits on the user (`openUrl`, `openApp`, `compose`, `follow`, `install`) has no time limit: it ends when they answer.
+`rate_limited` or `unavailable`. A call the host answers by itself that gets no answer within 30 seconds rejects with `unavailable`. A call that waits on the user (`openUrl`, `openApp`, `compose`, `follow`, `install`, `notifications.request`) has no time limit: it ends when they answer.
 
 ## Outside a host
 

package/dist/lazy.js

@@ -20,6 +20,7 @@ export const lazySdk = (create) => {
         compose: (options) => sdk().compose(options),
         follow: (did) => sdk().follow(did),
         install: () => sdk().install(),
+        notifications: { request: () => sdk().notifications.request() },
         on: (event, listener) => sdk().on(event, listener),
         dispose: () => {
             current?.dispose();

package/dist/sdk.d.ts

@@ -49,6 +49,14 @@ export interface Sdk {
     }>;
     /** Asks the user to add this app to their library. Resolves at once if it is already there; rejects with `cancelled` if they decline. Needs the `install` capability. */
     install: () => Promise<void>;
+    notifications: {
+        /**
+         * Asks the user to let the app notify them, which also adds it to their library. On yes, Mythryl sends your server a
+         * notification token for the user (the `notifications.enabled` webhook). Resolves at once if they are already on;
+         * rejects with `cancelled` if they decline. Needs the `notifications` capability.
+         */
+        request: () => Promise<void>;
+    };
     /** Asks the user to follow an account, by DID. Rejects with `cancelled` if they decline. Needs the `follow` capability. */
     follow: (did: string) => Promise<void>;
     on: <E extends EventName>(event: E, listener: (data: Events[E]) => void) => () => void;

package/dist/sdk.js

@@ -34,6 +34,7 @@ export const createSdk = (transport = windowTransport()) => {
         compose: (options) => call("compose", options ?? {}),
         follow: (did) => call("follow", { did }),
         install: () => call("install", undefined),
+        notifications: { request: () => call("notifications.request", undefined) },
         // The host sends events only after the handshake, so subscribing starts it.
         on: (event, listener) => {
             connect().catch(() => undefined);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@mythryl/app-sdk",
-  "version": "0.1.6",
+  "version": "0.1.7",
   "description": "The browser SDK for Mythryl mini apps.",
   "license": "MIT",
   "repository": {
@@ -26,7 +26,7 @@
     }
   },
   "dependencies": {
-    "@mythryl/protocol": "0.1.6"
+    "@mythryl/protocol": "0.1.7"
   },
   "devDependencies": {
     "typescript": "~6.0.3",