@straitlink/cli 0.1.1 → 0.1.2

package/README.md

@@ -28,7 +28,7 @@ npx @straitlink/cli init
    | Flutter | `lib/links.dart` |
    | Android | `app/src/main/java/<package>/StraitLinks.kt` |
 
-4. Prints the remaining steps for your app: the install command, the AndroidManifest intent filters (or the `app.json` block for Expo), the iPhone (beta) Associated Domains entry, what to fill in under Dashboard → Settings, and the `curl` checks for `assetlinks.json` and `apple-app-site-association`. Steps the project already has, such as the intent filters, are marked `[already done]`.
+4. Prints the remaining steps for your app: the install command, the AndroidManifest intent filters (or the `app.json` block for Expo), the iPhone Associated Domains entry, what to fill in under Dashboard → Apps & stores, and the `curl` checks for `assetlinks.json` and `apple-app-site-association`. Steps the project already has, such as the intent filters, are marked `[already done]`.
 
 It never edits your existing files and never overwrites an earlier integration file unless you pass `--force`.
 
@@ -48,7 +48,7 @@ From a checkout of this repo: `node bin/strait.mjs init ../my-app`, or `npm link
 |---|---|
 | `--key` | Publishable key (Dashboard → Get started). Env: `STRAIT_PUBLISHABLE_KEY` |
 | `--host` | Link domain, e.g. `acme.strait.link`. A pasted link works too. Env: `STRAIT_LINK_HOST` |
-| `--scheme` | Custom scheme. Taken from `app.json`, or guessed from the package name (`com.acme.shop` → `acmeshop`) |
+| `--scheme` | Custom scheme: the one you typed in Dashboard → Apps & stores. Taken from `app.json`, or guessed from the package name (`com.acme.shop` → `acmeshop`); a guess is marked "(guessed from …)" in the output |
 | `--framework` | `react-native`, `expo`, `flutter` or `android`, to skip detection |
 | `--dry-run` | Print the files and steps; write nothing |
 | `--force` | Replace an existing integration file |

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@straitlink/cli",
-  "version": "0.1.1",
+  "version": "0.1.2",
   "description": "npx @straitlink/cli init: set up Strait deep links in a React Native, Expo, Flutter or Android app.",
   "keywords": [
     "strait",

package/src/cli.mjs

@@ -15,7 +15,8 @@ Usage
 Options
   --key <st_pub_live_…>   Publishable key (Dashboard → Get started)
   --host <host>           Your link domain, e.g. acme.strait.link
-  --scheme <scheme>       Your app's custom scheme, e.g. acmeshop (guessed from the package name)
+  --scheme <scheme>       Your app's custom scheme, the one in Dashboard → Apps & stores,
+                          e.g. acmeshop (guessed from the package name if left out)
   --framework <name>      react-native | expo | flutter | android (detected by default)
   --dry-run               Print what would be written; write nothing
   --force                 Replace an existing integration file
@@ -84,7 +85,8 @@ export async function main(argv, io = {}) {
         host = host ?? (await askValid(ask, 'Link host (e.g. acme.strait.link): ', normalizeHost, err));
         if (!scheme) {
           const guess = suggestScheme(detectProject(dir) ?? {});
-          scheme = await askValid(ask, `Custom scheme${guess ? ` [${guess}]` : ''}: `, (a) => normalizeScheme(a || guess || ''), err);
+          const hint = guess ? ` [${guess}, guessed from the package name]` : '';
+          scheme = await askValid(ask, `Custom scheme (the one in Dashboard → Apps & stores)${hint}: `, (a) => normalizeScheme(a || guess || ''), err);
         }
       } finally {
         ask.close?.();

package/src/init.mjs

@@ -31,12 +31,15 @@ export function planInit({ dir, key, host, scheme, framework, force = false, ins
   const chosen = scheme ?? suggestScheme(project);
   if (!chosen) throw new UsageError("Couldn't guess your app's custom scheme. Pass --scheme, for example --scheme acmeshop.");
   const opts = { key: k, host: h, scheme: normalizeScheme(chosen) };
+  // Said out loud in the output: the developer may have made up a different scheme in Apps & stores.
+  const schemeGuessedFrom =
+    scheme || project.scheme ? null : suggestScheme({ androidPackage: project.androidPackage }) ? `the package name ${project.androidPackage}` : `the app name ${project.appName}`;
   const files = integrationFiles(project, opts).map((f) => {
     const abs = join(root, f.path);
     return { ...f, abs, exists: existsSync(abs) };
   });
   const conflicts = force ? [] : files.filter((f) => f.exists).map((f) => f.path);
-  return { project, opts, files, steps: nextSteps(project, opts, installSource), conflicts };
+  return { project, opts, schemeGuessedFrom, files, steps: nextSteps(project, opts, installSource), conflicts };
 }
 
 function emptyProject(dir) {
@@ -62,10 +65,27 @@ export function formatPlan(plan, { dryRun = false } = {}) {
   const out = [];
   const facts = [project.label, project.androidPackage && `package ${project.androidPackage}`, project.expoRouter && 'Expo Router', project.typescript && 'TypeScript'].filter(Boolean);
   out.push(`Found: ${facts.join(' · ')}`);
-  out.push(`Link host: ${opts.host} · scheme: ${opts.scheme}://`);
+  out.push(`Link host: ${opts.host} · scheme: ${opts.scheme}://${plan.schemeGuessedFrom ? ` (guessed from ${plan.schemeGuessedFrom})` : ''}`);
+  if (plan.schemeGuessedFrom) {
+    out.push(
+      'If you made up your own scheme (Custom scheme in Dashboard → Apps & stores), ' +
+        (dryRun
+          ? 'run this again with --scheme yourscheme, so every line below uses it.'
+          : `use it in place of ${opts.scheme} in the steps below: the files written don't contain the scheme, so you don't need --force. ` +
+            'To reprint the steps with it, run this again with --scheme yourscheme --dry-run.'),
+    );
+  }
   out.push('');
-  out.push(dryRun ? 'Dry run: nothing written. These files would be created:' : 'Created:');
-  for (const f of files) out.push(`  ${f.path}${f.exists ? ' (replaced)' : ''}  ${f.why}`);
+  out.push(
+    !dryRun
+      ? 'Created:'
+      : plan.conflicts.length
+        ? `Dry run: nothing written. A real run would stop: ${plan.conflicts.join(', ')} already exists (add --force to replace it). With --force it would write:`
+        : 'Dry run: nothing written. These files would be created:',
+  );
+  // A conflict is a file the real run refuses to overwrite (no --force): never call it replaced.
+  const label = (f) => (plan.conflicts.includes(f.path) ? ' (already exists: kept unless --force)' : f.exists ? ' (replaced)' : '');
+  for (const f of files) out.push(`  ${f.path}${label(f)}  ${f.why}`);
   if (dryRun) {
     for (const f of files) {
       out.push('');

package/src/install.mjs

@@ -16,12 +16,15 @@ export const INSTALL = {
 /** The source for one registry: `source` as one word applies to all three. */
 export const sourceFor = (src, registry) => (typeof src.source === 'string' ? src.source : src.source[registry]);
 
-/** SDK versions the generated code is written for (site.config.json packages). */
+/**
+ * SDK versions the generated code is written for. Must equal site/site.config.json `packages`
+ * (the one source of truth; test/install.test.mjs fails if they differ). Bump both together.
+ */
 export const VERSIONS = {
-  version: '0.9.2', // Swift (Unity 0.8.5 is not written by this CLI)
-  rnVersion: '0.9.1',
-  flutterVersion: '0.9.2',
-  androidVersion: '0.8.0',
+  version: '0.9.3', // Swift (Unity is not written by this CLI)
+  rnVersion: '0.9.2',
+  flutterVersion: '0.9.3',
+  androidVersion: '0.8.1',
 };
 
 export const PACKAGES = {

package/src/templates.mjs

@@ -84,7 +84,7 @@ class LifecycleFeed with WidgetsBindingObserver {
   Stream<AppLifecycle> get stream => _ctl.stream;
   LifecycleFeed() { WidgetsBinding.instance.addObserver(this); }
   @override
-  void didChangeAppLifecycleState(AppLifecycleState s) => _ctl.add(switch (s) {
+  void didChangeAppLifecycleState(AppLifecycleState state) => _ctl.add(switch (state) {
         AppLifecycleState.resumed => AppLifecycle.active,
         AppLifecycleState.inactive => AppLifecycle.inactive,
         _ => AppLifecycle.background,
@@ -293,6 +293,10 @@ export default function RootLayout() {
   return <Stack />;
 }`;
 
+// ops/IOS-STATUS-1022.md: iPhone links are live; install matching is opt-in (dashboard "iPhone installs", off until chosen).
+const IPHONE_INSTALLS =
+  'iPhone install matching is opt-in: choose a method in Dashboard → Settings → iPhone installs (device matching, paste or both; off until you choose) to land people on the link\'s screen after an App Store install.';
+
 const keytool = (fw) =>
   fw === 'expo'
     ? 'keytool -list -v -keystore android/app/debug.keystore -storepass android | grep SHA256   # local builds; EAS builds: eas credentials'
@@ -328,7 +332,7 @@ export function nextSteps(project, opts, installSrc) {
   // 2. Start it
   if (fw === 'react-native') steps.push({ title: 'Load links at startup', body: `Add \`import './links';\` to the top of index.js, then rebuild (npx react-native run-android). The SDK adds a native module, so a Metro reload is not enough.` });
   if (fw === 'expo') {
-    steps.push({ title: 'Add link settings to app.json (merge with what you have)', code: expoAppJson(opts, project), lang: 'json', body: project.dynamicConfig ? 'Your config is app.config.js/ts, so copy these keys into it by hand.' : undefined });
+    steps.push({ title: 'Add link settings to app.json (merge with what you have)', code: expoAppJson(opts, project), lang: 'json', body: `${project.dynamicConfig ? 'Your config is app.config.js/ts, so copy these keys into it by hand. ' : ''}associatedDomains opens links in your iPhone app. ${IPHONE_INSTALLS}` });
     if (project.expoRouter) steps.push({ title: 'Route links in app/_layout.tsx', code: EXPO_LAYOUT, lang: 'tsx' });
     else steps.push({ title: 'Load links at startup', body: "Add `import './links';` to your entry file." });
     steps.push({ title: 'Make a development build (Expo Go cannot load the native module)', code: 'npx expo run:android     # or: eas build --profile development --platform android', lang: 'bash' });
@@ -357,19 +361,24 @@ export function nextSteps(project, opts, installSrc) {
       code: done ? undefined : [filtersDone ? null : manifestXml(opts), needsFlutterMeta ? flutterMeta : null].filter(Boolean).join('\n'),
       lang: 'xml',
     });
-    steps.push({ title: 'iPhone (beta)', body: `In Xcode add Associated Domains → applinks:${host}, and ${scheme} under Info → URL Types.${fw === 'flutter' ? ' Set FlutterDeepLinkingEnabled = NO in Info.plist.' : ''}` });
+    if (fw !== 'android') {
+      steps.push({
+        title: 'iPhone',
+        body: `In Xcode add Associated Domains → applinks:${host}, and ${scheme} under Info → URL Types.${fw === 'flutter' ? ' Set FlutterDeepLinkingEnabled = NO in Info.plist.' : ''} Links then open your app on the right screen. ${IPHONE_INSTALLS}`,
+      });
+    }
   }
 
   // 4. Dashboard + verification files
   steps.push({
-    title: 'Fill in Dashboard → Settings',
-    body: `Package name ${pkg}, custom scheme ${scheme}, and the SHA-256 fingerprint of every certificate your app is signed with (debug, upload, and Play App Signing from Play Console → App integrity). For iPhone (beta), your Apple Team ID and bundle ID.`,
+    title: 'Fill in Dashboard → Apps & stores',
+    body: `Package name ${pkg}, custom scheme ${scheme}, and the SHA-256 fingerprint of every certificate your app is signed with (debug, upload, and Play App Signing from Play Console → App integrity). For iPhone, your Apple Team ID and bundle ID.`,
     code: keytool(fw),
     lang: 'bash',
   });
   steps.push({
     title: 'Check the verification files your link domain serves',
-    body: 'Each returns 404 until the matching Settings fields are filled in. assetlinks.json lets Android open https links in the app directly; apple-app-site-association does the same on iPhone (beta).',
+    body: 'Each returns 404 until the matching Apps & stores fields are filled in. assetlinks.json lets Android open https links in the app directly; apple-app-site-association does the same on iPhone.',
     code: `curl https://${host}/.well-known/assetlinks.json\ncurl https://${host}/.well-known/apple-app-site-association`,
     lang: 'bash',
   });

package/src/validate.mjs

@@ -4,12 +4,17 @@
 export class UsageError extends Error {}
 
 const PUB_KEY = /^st_pub_(live|test)_[A-Za-z0-9]{8,}$/;
-const SECRET_KEY = /^st_(live|test)_/;
+const SECRET_KEY = /st_(live|test)_/; // anywhere: quotes, KEY=…, "Bearer …" (a publishable key never contains it)
 const LABEL = /^[a-z0-9]([a-z0-9-]{0,61}[a-z0-9])?$/;
+// Stand-ins seen in our docs and screenshots (site/scripts/dashboard-shots/mock-supabase.ts). Real keys are 32 hex.
+const EXAMPLE_BODIES = new Set(['8fK2mQx7Lp4RtZ']);
 
-/** A publishable key (st_pub_live_…). A secret key is refused: it must never ship in an app. */
+/**
+ * A publishable key (st_pub_live_…). A secret key is refused: it must never ship in an app.
+ * Nothing the person typed is echoed back except an st_pub_ key, which is safe to show.
+ */
 export function normalizeKey(value) {
-  const k = String(value ?? '').trim();
+  let k = String(value ?? '').trim().replace(/^['"]+|['"]+$/g, '');
   if (!k) throw new UsageError('A publishable key is required (--key st_pub_live_…). Find it in Dashboard → Get started.');
   if (SECRET_KEY.test(k)) {
     throw new UsageError(
@@ -17,8 +22,21 @@ export function normalizeKey(value) {
         'If the secret key was pasted somewhere public, rotate it in Dashboard → Settings → Secret keys.',
     );
   }
-  if (!PUB_KEY.test(k)) throw new UsageError(`"${k}" is not a publishable key. It starts with st_pub_live_ (Dashboard → Get started).`);
-  return k;
+  const m = /^st_pub_(live|test)_(.*)$/.exec(k);
+  const where = (mode = 'live') => `Copy your real one from Dashboard → Get started (the Publishable key box): st_pub_${mode}_ followed by 32 letters and numbers.`;
+  if (!m) throw new UsageError(`That is not a publishable key. ${where()}`);
+  const [, mode] = m;
+  let rest = m[2].replace(/\.$/, ''); // a full stop copied from a sentence
+  const shortened = /(?:…|\.\.)$/.test(rest);
+  rest = rest.replace(/(?:…|\.)+$/, '');
+  const bracketed = /^<(.*)>$/.exec(rest)?.[1];
+  if (bracketed != null && /^[A-Za-z0-9]{8,}$/.test(bracketed)) throw new UsageError(`Remove the < > around your key: st_pub_${mode}_${bracketed}.`);
+  if (rest === '' || bracketed != null || /your/i.test(rest) || /^x{3,}$/i.test(rest) || EXAMPLE_BODIES.has(rest)) {
+    throw new UsageError(`"${k}" is the example key from the docs, not your key. ${where(mode)}`);
+  }
+  const key = `st_pub_${mode}_${rest}`;
+  if (shortened || !PUB_KEY.test(key)) throw new UsageError(`"${k}" looks cut off. ${where(mode)}`);
+  return key;
 }
 
 /** "https://Acme.strait.link/summer" → "acme.strait.link". */