@straitlink/capacitor 0.2.0 → 0.3.0

package/README.md

@@ -131,6 +131,7 @@ Debug, release and Play App Signing keys each have their own fingerprint."
 | `trackEvent(name, { value, currency, linkId, clickId })` | Conversion or revenue event, placed on the tap of the last attributed open (7 days). Resolves `true` when accepted. |
 | `pendingOpenReports()` / `flushOpenReports()` | Open reports saved while offline (sent again on start and resume). |
 | `deviceClass()` | `phone` or `tablet` (iPad / 600 dp and up), as sent with open reports. |
+| `openStoreSheet(url, options?)` | The app store inside your app for one of your links (another app to install), deep link kept through the install. Options: `androidPackage`, `listing`, `inline`, `appStoreId`, `providerToken`, `customProductPageId`, `style`. Resolves `{ opened, method, clickId, linkId, referrer, reason }`. |
 | `doctor()` | Setup check for debug builds (key, endpoint, this app listed in your link domain's files, Android signing certificate). Resolves `{ ok, findings }`. |
 | `stop()` | Stops delivering events to this object. |
 

package/android/src/main/java/dev/strait/capacitor/StraitPlugin.java

@@ -1,7 +1,9 @@
 package dev.strait.capacitor;
 
 import android.content.Context;
+import android.content.ActivityNotFoundException;
 import android.content.Intent;
+import android.net.Uri;
 import android.content.SharedPreferences;
 import android.content.pm.ApplicationInfo;
 import android.content.pm.PackageInfo;
@@ -39,6 +41,9 @@ import dev.strait.sdk.DoctorReport;
 import dev.strait.sdk.KeyValueStore;
 import dev.strait.sdk.LinkEvent;
 import dev.strait.sdk.LinkStart;
+import dev.strait.sdk.StoreLauncher;
+import dev.strait.sdk.StoreSheetOptions;
+import dev.strait.sdk.StoreSheetResult;
 import dev.strait.sdk.StraitClient;
 import dev.strait.sdk.StraitConfig;
 import dev.strait.sdk.UrlConnectionTransport;
@@ -184,6 +189,47 @@ public class StraitPlugin extends Plugin {
         });
     }
 
+    /** Store sheet: Google Play inside the app for one of the workspace's links, deep link kept. */
+    @PluginMethod
+    public void openStoreSheet(PluginCall call) {
+        StraitClient c = ready(call);
+        if (c == null) return;
+        String url = call.getString("url", "");
+        if (url == null || url.isEmpty()) {
+            call.reject("Strait: openStoreSheet needs a url");
+            return;
+        }
+        Context ctx = getContext();
+        StoreSheetOptions opts = new StoreSheetOptions(
+            call.getString("androidPackage"), ctx.getPackageName(), call.getString("listing"), call.getBoolean("inline", true));
+        StoreLauncher launcher = s -> {
+            Intent intent = new Intent(s.getAction(), Uri.parse(s.getData()));
+            if (s.getPackageName() != null) intent.setPackage(s.getPackageName());
+            for (Map.Entry<String, Object> kv : s.getExtras().entrySet()) {
+                if (kv.getValue() instanceof Boolean) intent.putExtra(kv.getKey(), (Boolean) kv.getValue());
+                else if (kv.getValue() instanceof String) intent.putExtra(kv.getKey(), (String) kv.getValue());
+            }
+            if (getActivity() == null) intent.addFlags(Intent.FLAG_ACTIVITY_NEW_TASK);
+            try {
+                (getActivity() != null ? getActivity() : ctx).startActivity(intent);
+                return true;
+            } catch (ActivityNotFoundException e) {
+                return false;
+            }
+        };
+        executor.execute(() -> {
+            StoreSheetResult r = c.openStoreSheet(url, launcher, opts);
+            JSObject o = new JSObject();
+            o.put("opened", r.getOpened());
+            o.put("method", r.getMethod());
+            putIf(o, "clickId", r.getClickId());
+            putIf(o, "linkId", r.getLinkId());
+            putIf(o, "referrer", r.getReferrer());
+            putIf(o, "reason", r.getReason());
+            call.resolve(o);
+        });
+    }
+
     /** SHA-256 of this build's signing certificate(s), "AB:CD:…" (what assetlinks.json lists). */
     @SuppressWarnings("deprecation")
     private static List<String> signingCerts(Context ctx) {

package/dist/index.d.ts

@@ -6,4 +6,4 @@ export declare const StraitNative: StraitNativePlugin;
  * Android and iOS only; on the web every call resolves a safe default (use @straitlink/web there).
  */
 export declare function createStrait(config: CreateStraitConfig, native?: StraitNativePlugin): Strait;
-export type { CreateStraitConfig, DeviceClass, DoctorFinding, DoctorReport, LinkEvent, LinkStart, Strait, StraitNativePlugin, TrackEventExtra, } from './strait.js';
+export type { CreateStraitConfig, DeviceClass, DoctorFinding, DoctorReport, LinkEvent, LinkStart, Strait, StoreSheetOptions, StoreSheetResult, StraitNativePlugin, TrackEventExtra, } from './strait.js';

package/dist/strait.d.ts

@@ -42,6 +42,32 @@ export interface DoctorFinding {
     /** What to do; empty for `ok`. */
     fix: string;
 }
+/** Store sheet options (same names as @straitlink/react-native). */
+export interface StoreSheetOptions {
+    /** Android: the app to install. Default: the workspace's Android package from Strait. */
+    androidPackage?: string;
+    /** Android: a Play custom store listing name. */
+    listing?: string;
+    /** Android: false skips Play's inline half-sheet. Default true. */
+    inline?: boolean;
+    /** iPhone: the app to install. Default: the workspace's App Store ID from Strait. */
+    appStoreId?: string;
+    providerToken?: string;
+    customProductPageId?: string;
+    /** iPhone: the full product page (default) or a small card at the bottom. */
+    style?: 'product_page' | 'overlay';
+}
+export interface StoreSheetResult {
+    opened: boolean;
+    /** inline_install | market | web | product_page | overlay | none */
+    method: string;
+    clickId?: string;
+    linkId?: string;
+    /** Android: the Play Install Referrer sent. */
+    referrer?: string;
+    /** not_found, expired, offline, no_package, no_app_store_id, not_shown, unavailable… */
+    reason?: string;
+}
 export interface DoctorReport {
     /** No `error` finding. */
     ok: boolean;
@@ -82,6 +108,9 @@ export interface StraitNativePlugin {
         deviceClass?: DeviceClass;
     }>;
     doctor(): Promise<DoctorReport>;
+    openStoreSheet(options: {
+        url: string;
+    } & StoreSheetOptions): Promise<StoreSheetResult>;
     addListener(event: 'link', cb: (e: LinkEvent) => void): Promise<PluginListenerHandle>;
     addListener(event: 'linkStart', cb: (s: LinkStart) => void): Promise<PluginListenerHandle>;
 }
@@ -108,6 +137,11 @@ export interface Strait {
      * signing certificate). Call after start(). Never throws.
      */
     doctor(): Promise<DoctorReport>;
+    /**
+     * Store sheet: open the app store inside your app for one of your short links (an app you
+     * want people to install), keeping the deep link through the install. Never throws.
+     */
+    openStoreSheet(url: string, options?: StoreSheetOptions): Promise<StoreSheetResult>;
     /** Stop delivering events to this object. */
     stop(): void;
 }

package/dist/strait.js

@@ -60,6 +60,7 @@ export function createStrait(config, native) {
         flushOpenReports: () => safe(() => native.flushOpenReports(), undefined),
         deviceClass: () => safe(async () => (await native.deviceClass()).deviceClass, undefined),
         doctor: () => safe(() => native.doctor(), { ok: false, findings: [] }),
+        openStoreSheet: (url, options = {}) => safe(() => native.openStoreSheet({ url, ...options }), { opened: false, method: 'none', reason: 'unavailable' }),
         stop() {
             linkCbs.clear();
             startCbs.clear();

package/ios/Sources/StraitPlugin/StraitPlugin.swift

@@ -18,6 +18,7 @@ public class StraitPlugin: CAPPlugin, CAPBridgedPlugin {
         CAPPluginMethod(name: "flushOpenReports", returnType: CAPPluginReturnPromise),
         CAPPluginMethod(name: "deviceClass", returnType: CAPPluginReturnPromise),
         CAPPluginMethod(name: "doctor", returnType: CAPPluginReturnPromise),
+        CAPPluginMethod(name: "openStoreSheet", returnType: CAPPluginReturnPromise),
     ]
 
     private var links: StraitLinks?
@@ -111,6 +112,36 @@ public class StraitPlugin: CAPPlugin, CAPBridgedPlugin {
         }
     }
 
+    /// Store sheet: the App Store inside the app for one of the workspace's links, deep link kept.
+    @objc func openStoreSheet(_ call: CAPPluginCall) {
+        guard let l = ready(call) else { return }
+        guard let url = call.getString("url"), !url.isEmpty else {
+            call.reject("Strait: openStoreSheet needs a url")
+            return
+        }
+        DispatchQueue.main.async { [weak self] in
+            guard let vc = self?.bridge?.viewController else {
+                call.resolve(["opened": false, "method": "none", "reason": "no_view"])
+                return
+            }
+            let options = StoreSheetOptions(
+                appStoreId: call.getString("appStoreId"),
+                providerToken: call.getString("providerToken"),
+                customProductPageId: call.getString("customProductPageId"),
+                style: StoreSheetStyle(rawValue: call.getString("style") ?? "") ?? .productPage
+            )
+            let presenter = SystemStoreSheetPresenter(from: vc)
+            l.openStoreSheet(url: url, options: options, presenter: presenter) { r in
+                _ = presenter // keep the presenter (the store sheet's delegate) alive until done
+                var o: [String: Any] = ["opened": r.opened, "method": r.method]
+                if let v = r.clickId { o["clickId"] = v }
+                if let v = r.linkId { o["linkId"] = v }
+                if let v = r.reason { o["reason"] = v }
+                call.resolve(o)
+            }
+        }
+    }
+
     private func ready(_ call: CAPPluginCall) -> StraitLinks? {
         guard let l = links else {
             call.reject("Strait: call start() first")

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@straitlink/capacitor",
-  "version": "0.2.0",
+  "version": "0.3.0",
   "description": "Deep linking for Capacitor and Ionic apps: direct links (App Links, Universal Links, custom schemes), deferred links that survive the install and link-open analytics. Wraps the Strait Android and iOS SDKs.",
   "keywords": [
     "capacitor",