@mythryl/app-sdk 0.1.4 → 0.1.5

package/README.md

@@ -78,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/package.json

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