@straitlink/capacitor 0.1.0 → 0.3.0

package/Package.swift

@@ -10,7 +10,7 @@ let package = Package(
     ],
     dependencies: [
         .package(url: "https://github.com/ionic-team/capacitor-swift-pm.git", from: "8.0.0"),
-        .package(url: "https://github.com/strait-link/strait-sdk-swift.git", from: "0.9.3"),
+        .package(url: "https://github.com/strait-link/strait-sdk-swift.git", from: "0.9.4"),
     ],
     targets: [
         .target(

package/README.md

@@ -92,6 +92,19 @@ The app opens on the link's screen and the console prints
 `Strait link: direct app_link true /p/42` (your path). The open shows up in the dashboard's
 Analytics within a minute. On a fresh install the first launch prints a `deferred` event instead.
 
+### Check your setup
+
+In a debug build, after `start()`:
+
+```ts
+const report = await strait.doctor();
+for (const f of report.findings) console.log(f.severity, f.id, f.title, f.fix);
+```
+
+**You should see** `ok key.ok`, `ok app.listed` and, on Android, `ok cert.listed`. Anything marked
+`error` comes with the fix, for example `cert.missing`: "Add AB:CD:… in Dashboard → Apps & stores.
+Debug, release and Play App Signing keys each have their own fingerprint."
+
 ## Platform features
 
 | Feature | Status | Notes |
@@ -118,6 +131,8 @@ Analytics within a minute. On a fresh install the first launch prints a `deferre
 | `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. |
 
 `LinkEvent`: `id, kind (direct|deferred), route (app_link|custom_scheme|install_referrer|fingerprint|clipboard),
@@ -130,11 +145,11 @@ The plugin is a thin layer. All link logic (resolving short links, the once-per-
 check, open reports and their retry queue, app-state labels) runs in the native SDKs, which share
 golden test vectors with the Strait engine:
 
-- **Android:** `strait-sdk-android` **v0.8.1** from JitPack. The plugin adds JitPack to your Gradle
+- **Android:** `strait-sdk-android` **v0.8.3** from JitPack. The plugin adds JitPack to your Gradle
   repositories, limited to the `com.github.strait-link` group, so nothing else is ever fetched from
   it. It reads the Play Install Referrer (`com.android.installreferrer:installreferrer:2.2`), the launch
   intent and `onNewIntent`, and keeps state in SharedPreferences (`strait`).
-- **iOS:** `StraitSDK` **0.9.3+** through Swift Package Manager. Links come from Capacitor's
+- **iOS:** `StraitSDK` **0.9.4+** through Swift Package Manager. Links come from Capacitor's
   `capacitorOpenURL` / `capacitorOpenUniversalLink` notifications; state lives in `UserDefaults`.
 
 What gets recorded, the privacy details and the match methods are the same as the native SDKs:

package/android/build.gradle

@@ -1,6 +1,6 @@
 // @straitlink/capacitor, Android side: a thin Capacitor plugin over strait-sdk-android (JitPack).
 ext {
-    straitSdkVersion = 'v0.8.1'
+    straitSdkVersion = 'v0.8.3'
 }
 
 buildscript {

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

@@ -1,9 +1,16 @@
 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;
+import android.content.pm.PackageManager;
+import android.content.pm.Signature;
+import android.os.Build;
+import android.util.Log;
 import android.util.DisplayMetrics;
 
 import com.android.installreferrer.api.InstallReferrerClient;
@@ -15,6 +22,7 @@ import com.getcapacitor.PluginCall;
 import com.getcapacitor.PluginMethod;
 import com.getcapacitor.annotation.CapacitorPlugin;
 
+import java.security.MessageDigest;
 import java.util.ArrayList;
 import java.util.List;
 import java.util.Locale;
@@ -28,9 +36,14 @@ import java.util.concurrent.TimeUnit;
 import dev.strait.sdk.AppLifecycleState;
 import dev.strait.sdk.CoreKt;
 import dev.strait.sdk.DeviceFields;
+import dev.strait.sdk.DoctorFinding;
+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;
@@ -149,6 +162,99 @@ public class StraitPlugin extends Plugin {
         call.resolve(r);
     }
 
+    /** B23: setup check (debug builds). Sends this app's package and signing certificate(s). */
+    @PluginMethod
+    public void doctor(PluginCall call) {
+        StraitClient c = ready(call);
+        if (c == null) return;
+        Context ctx = getContext();
+        String pkg = ctx.getPackageName();
+        List<String> certs = signingCerts(ctx);
+        executor.execute(() -> {
+            DoctorReport r = c.doctor(pkg, certs);
+            JSArray list = new JSArray();
+            for (DoctorFinding f : r.getFindings()) {
+                JSObject o = new JSObject();
+                o.put("id", f.getId());
+                o.put("severity", f.getSeverity());
+                o.put("title", f.getTitle());
+                o.put("fix", f.getFix());
+                list.put(o);
+                Log.i("StraitDoctor", f.getSeverity() + " " + f.getId() + ": " + f.getTitle() + (f.getFix().isEmpty() ? "" : " → " + f.getFix()));
+            }
+            JSObject out = new JSObject();
+            out.put("ok", r.getOk());
+            out.put("findings", list);
+            call.resolve(out);
+        });
+    }
+
+    /** 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) {
+        List<String> out = new ArrayList<>();
+        try {
+            PackageManager pm = ctx.getPackageManager();
+            Signature[] sigs;
+            if (Build.VERSION.SDK_INT >= Build.VERSION_CODES.P) {
+                PackageInfo pi = pm.getPackageInfo(ctx.getPackageName(), PackageManager.GET_SIGNING_CERTIFICATES);
+                sigs = pi.signingInfo == null ? new Signature[0]
+                    : pi.signingInfo.hasMultipleSigners() ? pi.signingInfo.getApkContentsSigners() : pi.signingInfo.getSigningCertificateHistory();
+            } else {
+                sigs = pm.getPackageInfo(ctx.getPackageName(), PackageManager.GET_SIGNATURES).signatures;
+            }
+            for (Signature sig : sigs) {
+                byte[] d = MessageDigest.getInstance("SHA-256").digest(sig.toByteArray());
+                StringBuilder b = new StringBuilder();
+                for (int i = 0; i < d.length; i++) b.append(i == 0 ? "" : ":").append(String.format("%02X", d[i]));
+                out.add(b.toString());
+            }
+        } catch (Exception ignored) {
+        }
+        return out;
+    }
+
     @Override
     protected void handleOnNewIntent(Intent intent) {
         super.handleOnNewIntent(intent);

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, 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

@@ -34,6 +34,45 @@ export interface LinkStart {
     at: number;
 }
 export type DeviceClass = 'phone' | 'tablet';
+/** One setup check (contract B23, the same ids and wording in every Strait SDK). */
+export interface DoctorFinding {
+    id: string;
+    severity: 'ok' | 'warn' | 'error';
+    title: string;
+    /** 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;
+    findings: DoctorFinding[];
+}
 export interface CreateStraitConfig {
     /** Your workspace's publishable key (`st_pub_live_…`), Dashboard → Get started. Never the secret key. */
     publishableKey: string;
@@ -68,6 +107,10 @@ export interface StraitNativePlugin {
     deviceClass(): Promise<{
         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>;
 }
@@ -88,6 +131,17 @@ export interface Strait {
     flushOpenReports(): Promise<void>;
     /** What the app runs on, as sent with open reports (B14): iPad / sw600dp = tablet. */
     deviceClass(): Promise<DeviceClass | undefined>;
+    /**
+     * Setup check for debug builds (B23): key, endpoint, and whether your link domain's
+     * assetlinks.json / apple-app-site-association lists this app (Android: also this build's
+     * 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

@@ -59,6 +59,8 @@ export function createStrait(config, native) {
         pendingOpenReports: () => safe(async () => (await native.pendingOpenReports()).count ?? 0, 0),
         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

@@ -17,6 +17,8 @@ public class StraitPlugin: CAPPlugin, CAPBridgedPlugin {
         CAPPluginMethod(name: "pendingOpenReports", returnType: CAPPluginReturnPromise),
         CAPPluginMethod(name: "flushOpenReports", returnType: CAPPluginReturnPromise),
         CAPPluginMethod(name: "deviceClass", returnType: CAPPluginReturnPromise),
+        CAPPluginMethod(name: "doctor", returnType: CAPPluginReturnPromise),
+        CAPPluginMethod(name: "openStoreSheet", returnType: CAPPluginReturnPromise),
     ]
 
     private var links: StraitLinks?
@@ -98,6 +100,48 @@ public class StraitPlugin: CAPPlugin, CAPBridgedPlugin {
         }
     }
 
+    /// B23: setup check (debug builds) for this app's bundle ID.
+    @objc func doctor(_ call: CAPPluginCall) {
+        guard let l = ready(call) else { return }
+        l.doctor(bundleId: Bundle.main.bundleIdentifier) { r in
+            for f in r.findings { print("[Strait doctor] \(f.severity) \(f.id): \(f.title)\(f.fix.isEmpty ? "" : " → \(f.fix)")") }
+            call.resolve([
+                "ok": r.ok,
+                "findings": r.findings.map { ["id": $0.id, "severity": $0.severity, "title": $0.title, "fix": $0.fix] },
+            ])
+        }
+    }
+
+    /// 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.1.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",