@mythryl/app-sdk 0.1.3 → 0.1.5

package/README.md

@@ -31,16 +31,17 @@ on the server. Call it from effects and event handlers, which run in the browser
 | `sdk.openPost(uri)` | Opens a post, by its `at://` URI, and minimises the app. |
 | `sdk.openTopic(slug)` | Opens a topic, by name without the slash, and minimises the app. |
 | `sdk.openUrl(url)` | Opens an `https` address in the browser once the person confirms. Rejects with `cancelled` if they decline. |
+| `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 person posted, `{}` if they did not. |
+| `sdk.install()` | Asks the person 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 person to follow an account. Rejects with `cancelled` if they decline. |
-| `sdk.share()` | Opens the share sheet with a link to the app. |
 | `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 `share` 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`) is confirmed by the person. A target the host cannot open rejects with `unavailable`.
+`openProfile`, `openPost`, `openTopic`, `openUrl` and `openApp` need the `navigation` capability. `compose`, `follow` and `install`
+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 person. A target the host cannot open rejects with `unavailable`.
 
 ### Events
 
@@ -77,7 +78,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 that gets no answer within 30 seconds rejects with `unavailable`.
+`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 person (`openUrl`, `openApp`, `compose`, `follow`, `install`) has no time limit: it ends when they answer.
 
 ## Outside a host
 

package/dist/channel.d.ts

@@ -7,5 +7,8 @@ export interface Channel {
     /** Removes the transport listener and rejects pending calls with `cancelled`. */
     dispose: () => void;
 }
-/** Correlates responses with requests by id, enforces the call timeout and dispatches events. Independent of which calls exist. */
+/**
+ * Correlates responses with requests by id, enforces the call timeout and dispatches events. A call that waits on a person
+ * has no timeout (`WAITS_ON_PERSON`): it ends when they answer or the SDK is disposed.
+ */
 export declare const createChannel: (transport: Transport, timeoutMs?: number) => Channel;

package/dist/channel.js

@@ -1,5 +1,8 @@
-import { CALL_TIMEOUT_MS, MESSAGE_SOURCE, ProtocolError, isEventMessage, isResponseMessage, } from "@mythryl/protocol";
-/** Correlates responses with requests by id, enforces the call timeout and dispatches events. Independent of which calls exist. */
+import { CALL_TIMEOUT_MS, MESSAGE_SOURCE, ProtocolError, isEventMessage, isResponseMessage, WAITS_ON_PERSON, } from "@mythryl/protocol";
+/**
+ * Correlates responses with requests by id, enforces the call timeout and dispatches events. A call that waits on a person
+ * has no timeout (`WAITS_ON_PERSON`): it ends when they answer or the SDK is disposed.
+ */
 export const createChannel = (transport, timeoutMs = CALL_TIMEOUT_MS) => {
     const pending = new Map();
     const listeners = new Map();
@@ -14,13 +17,16 @@ export const createChannel = (transport, timeoutMs = CALL_TIMEOUT_MS) => {
         request: (method, params, version) => new Promise((resolve, reject) => {
             const id = String((lastId += 1));
             const done = () => {
-                clearTimeout(timer);
+                if (timer)
+                    clearTimeout(timer);
                 pending.delete(id);
             };
-            const timer = setTimeout(() => {
-                done();
-                reject(new ProtocolError("unavailable", `${method} did not answer in ${timeoutMs} ms.`));
-            }, timeoutMs);
+            const timer = WAITS_ON_PERSON[method]
+                ? undefined
+                : setTimeout(() => {
+                    done();
+                    reject(new ProtocolError("unavailable", `${method} did not answer in ${timeoutMs} ms.`));
+                }, timeoutMs);
             pending.set(id, {
                 timer,
                 fail: (error) => {

package/dist/lazy.js

@@ -15,10 +15,11 @@ export const lazySdk = (create) => {
         openPost: (uri) => sdk().openPost(uri),
         openTopic: (slug) => sdk().openTopic(slug),
         openUrl: (url) => sdk().openUrl(url),
+        openStorePage: (domain) => sdk().openStorePage(domain),
         openApp: (options) => sdk().openApp(options),
         compose: (options) => sdk().compose(options),
         follow: (did) => sdk().follow(did),
-        share: () => sdk().share(),
+        install: () => sdk().install(),
         on: (event, listener) => sdk().on(event, listener),
         dispose: () => {
             current?.dispose();

package/dist/sdk.d.ts

@@ -33,6 +33,8 @@ export interface Sdk {
     openTopic: (slug: string) => Promise<void>;
     /** Opens an `https` address in the browser after the person confirms. Rejects with `cancelled` if they decline. */
     openUrl: (url: string) => Promise<void>;
+    /** Opens an app's store page in the host and minimises the calling app. `domain` names the app; left out, it is this app's own page. */
+    openStorePage: (domain?: string) => Promise<void>;
     /** Opens another mini app by its domain and closes this one. `url` is where in that app to start, on its own domain. */
     openApp: (options: {
         domain: string;
@@ -45,10 +47,10 @@ export interface Sdk {
     }) => Promise<{
         uri?: string;
     }>;
+    /** Asks the person 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>;
     /** Asks the person to follow an account, by DID. Rejects with `cancelled` if they decline. Needs the `follow` capability. */
     follow: (did: string) => Promise<void>;
-    /** Opens the share sheet with a link to the app. Needs the `share` capability. */
-    share: () => Promise<void>;
     on: <E extends EventName>(event: E, listener: (data: Events[E]) => void) => () => void;
     /** Removes listeners and rejects pending calls with `cancelled`. */
     dispose: () => void;

package/dist/sdk.js

@@ -29,10 +29,11 @@ export const createSdk = (transport = windowTransport()) => {
         openPost: (uri) => call("openPost", { uri }),
         openTopic: (slug) => call("openTopic", { slug }),
         openUrl: (url) => call("openUrl", { url }),
+        openStorePage: (domain) => call("openStorePage", domain === undefined ? {} : { domain }),
         openApp: (options) => call("openApp", options),
         compose: (options) => call("compose", options ?? {}),
         follow: (did) => call("follow", { did }),
-        share: () => call("share", undefined),
+        install: () => call("install", 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.3",
+  "version": "0.1.5",
   "description": "The browser SDK for Mythryl mini apps.",
   "license": "MIT",
   "repository": {
@@ -26,7 +26,7 @@
     }
   },
   "dependencies": {
-    "@mythryl/protocol": "0.1.3"
+    "@mythryl/protocol": "0.1.5"
   },
   "devDependencies": {
     "typescript": "~6.0.3",