@mythryl/app-sdk 0.1.2 → 0.1.4

package/README.md

@@ -27,9 +27,22 @@ on the server. Call it from effects and event handlers, which run in the browser
 | `sdk.getCapabilities()` | The capabilities the host supports. Check before calling optional features. |
 | `sdk.getContext()` | The signed-in person, how the app was launched, and the client environment. |
 | `sdk.auth.signin({ force? })` | `{ token }`: a JWT that authenticates the person to the app's own server. |
+| `sdk.openProfile(actor)` | Opens a profile (handle or DID) in the host and minimises the app. |
+| `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.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`
+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
 
 `minimised` and `maximised` are sent when the person hides the app and brings it back. `colorSchemeChanged` is sent with

package/dist/lazy.js

@@ -11,6 +11,15 @@ export const lazySdk = (create) => {
         getCapabilities: () => sdk().getCapabilities(),
         getContext: () => sdk().getContext(),
         auth: { signin: (options) => sdk().auth.signin(options) },
+        openProfile: (actor) => sdk().openProfile(actor),
+        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),
+        install: () => sdk().install(),
         on: (event, listener) => sdk().on(event, listener),
         dispose: () => {
             current?.dispose();

package/dist/sdk.d.ts

@@ -25,6 +25,32 @@ export interface Sdk {
         }>;
     };
     /** Subscribes to a host event. Returns a function that removes the listener. */
+    /** Opens a person's profile in the host and minimises the app. `actor` is a handle or a DID. Check the `navigation` capability first. */
+    openProfile: (actor: string) => Promise<void>;
+    /** Opens a post in the host and minimises the app. `uri` is the post's `at://` URI. */
+    openPost: (uri: string) => Promise<void>;
+    /** Opens a topic in the host and minimises the app. `slug` is the topic's name without the leading slash. */
+    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;
+        url?: string;
+    }) => Promise<void>;
+    /** Opens the composer with a draft. Resolves with the post's URI if the person posted, and without one if they did not. Needs the `compose` capability. */
+    compose: (options?: {
+        text?: string;
+        embedUrl?: string;
+    }) => 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>;
     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

@@ -25,6 +25,15 @@ export const createSdk = (transport = windowTransport()) => {
         getCapabilities: async () => (await connect()).capabilities,
         getContext: () => call("getContext", undefined),
         auth: { signin: (options) => tokens.get(options?.force) },
+        openProfile: (actor) => call("openProfile", { actor }),
+        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 }),
+        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.2",
+  "version": "0.1.4",
   "description": "The browser SDK for Mythryl mini apps.",
   "license": "MIT",
   "repository": {
@@ -26,7 +26,7 @@
     }
   },
   "dependencies": {
-    "@mythryl/protocol": "0.1.2"
+    "@mythryl/protocol": "0.1.4"
   },
   "devDependencies": {
     "typescript": "~6.0.3",