craft-native 0.0.124 → 0.0.125

package/dist/android/templates/build.gradle.kts.app.template

@@ -59,6 +59,7 @@ dependencies {
     implementation("androidx.appcompat:appcompat:1.6.1")
     implementation("androidx.fragment:fragment-ktx:1.6.2")
     implementation("androidx.recyclerview:recyclerview:1.3.2")
+{{REFRESH_LAYOUT_DEPENDENCY}}
     implementation("androidx.webkit:webkit:1.12.1")
 {{JAVASCRIPT_ENGINE_DEPENDENCY}}
     implementation("com.google.android.material:material:1.11.0")

package/dist/api/mobile.d.ts

@@ -818,6 +818,47 @@ export declare const tabBar: {
 export declare const splash: {
     hide(): boolean;
 };
+/** Letters, digits, `.`, `_` and `-`, not starting with a dot: the names the shell accepts. */
+export declare function isSnapshotName(name: string): boolean;
+/**
+ * Data the page keeps for its native screens. A native screen reads a
+ * snapshot synchronously before its first frame (`craft.snapshots.get(name)`),
+ * so it opens on the last data the page saw instead of an empty skeleton.
+ * Write one whenever the page has fresh data a native screen shows.
+ *
+ * Each is `Application Support/craft-snapshots/<name>.json` in the app.
+ * Outside a hybrid app every call is a no-op answering false.
+ */
+export declare const snapshots: {
+    isAvailable(): boolean;
+    /** Keep `value` (anything JSON can hold) as `name`. Answers whether it was handed to the shell. */
+    set(name: string, value: unknown): boolean;
+    remove(name: string): boolean;
+    /** Every snapshot, as on signing out. */
+    clear(): boolean;
+};
+/**
+ * Navigation between the page and the app's native screens.
+ *
+ * The shell already hands the stx router's navigations to native paths to
+ * the native screens, and Back at the entry a native screen opened goes back
+ * to it, so most pages need none of this. It is for code that navigates
+ * without the router.
+ */
+export declare const hybrid: {
+    /** Whether this page runs inside a hybrid app. */
+    isActive(): boolean;
+    /** The native screen `path` opens, or null when it is the page's. */
+    nativeScreenFor(path: string): {
+        path: string;
+        screen: string;
+        params: Record<string, string>;
+    } | null;
+    /** Open `path` as the shell would: a tab, a native screen, or the page pushed. */
+    open(path: string): boolean;
+    /** Back to the native screen under this page, when there is one. */
+    back(): boolean;
+};
 /** A rect in the viewport's CSS pixels. */
 export interface NativeRect {
     x: number;
@@ -1153,6 +1194,8 @@ declare const mobile: {
     watchConnectivity: typeof watchConnectivity;
     tabBar: typeof tabBar;
     splash: typeof splash;
+    snapshots: typeof snapshots;
+    hybrid: typeof hybrid;
     dialog: typeof dialog;
     contextMenu: typeof contextMenu;
     browser: typeof browser;

package/dist/cli.js

@@ -3303,7 +3303,7 @@ function pinCraftNativeDependency(packagePath, craftVersion) {
 `);
 }
 // package.json
-var version = "0.0.124";
+var version = "0.0.125";
 
 // bin/cli.ts
 var spawnedFrom = process6.env[CRAFT_CLI_SPAWN_MARKER];
@@ -3611,7 +3611,7 @@ cli.command("ios init <name>", "Initialize a new iOS project").option("--bundle-
     config: options?.renderer ? { renderer: options.renderer } : undefined
   });
 });
-cli.command("ios build", "Build iOS project").option("--html-path <path>", "Path to HTML file").option("--native-bundle <path>", "JavaScript bundle compiled by stx-native").option("-d, --dev-server <url>", "Development server URL").option("-o, --output <dir>", "iOS project directory", { default: "./ios" }).option("-w, --watch", "Watch for file changes and rebuild").example("craft ios build").example("craft ios build --html-path ./dist/index.html").example("craft ios build --native-bundle ./screen.js").example("craft ios build --dev-server http://localhost:3456").example("craft ios build --watch").action(async (options) => {
+cli.command("ios build", "Build iOS project").option("--html-path <path>", "Path to HTML file").option("--native-bundle <path>", "JavaScript bundle from `stx native compile`").option("-d, --dev-server <url>", "Development server URL").option("-o, --output <dir>", "iOS project directory", { default: "./ios" }).option("-w, --watch", "Watch for file changes and rebuild").example("craft ios build").example("craft ios build --html-path ./dist/index.html").example("craft ios build --native-bundle ./screen.js").example("craft ios build --dev-server http://localhost:3456").example("craft ios build --watch").action(async (options) => {
   const iosModule = await import(iosModuleURL);
   const doBuild = async () => {
     await iosModule.build({
@@ -3661,7 +3661,7 @@ cli.command("android init <name>", "Initialize a new Android project").option("-
     config: options?.renderer ? { renderer: options.renderer } : undefined
   });
 });
-cli.command("android build", "Build Android project").option("--html-path <path>", "Path to HTML file").option("--native-bundle <path>", "JavaScript bundle compiled by stx-native").option("-d, --dev-server <url>", "Development server URL").option("-o, --output <dir>", "Android project directory", { default: "./android" }).option("--release", "Build release APK").option("-w, --watch", "Watch for file changes and rebuild").example("craft android build").example("craft android build --release").example("craft android build --native-bundle ./screen.js").example("craft android build --watch").action(async (options) => {
+cli.command("android build", "Build Android project").option("--html-path <path>", "Path to HTML file").option("--native-bundle <path>", "JavaScript bundle from `stx native compile`").option("-d, --dev-server <url>", "Development server URL").option("-o, --output <dir>", "Android project directory", { default: "./android" }).option("--release", "Build release APK").option("-w, --watch", "Watch for file changes and rebuild").example("craft android build").example("craft android build --release").example("craft android build --native-bundle ./screen.js").example("craft android build --watch").action(async (options) => {
   const androidModule = await import(androidModuleURL);
   const doBuild = async () => {
     await androidModule.build({

package/dist/index.cjs

@@ -310,7 +310,7 @@ function craftBinaryNotFoundMessage(triedPath) {
 `);
 }
 // package.json
-var version = "0.0.124";
+var version = "0.0.125";
 
 // src/sdk-version.ts
 var SDK_VERSION = version;

package/dist/index.js

@@ -58,7 +58,7 @@ function craftBinaryNotFoundMessage(triedPath) {
 `);
 }
 // package.json
-var version = "0.0.124";
+var version = "0.0.125";
 
 // src/sdk-version.ts
 var SDK_VERSION = version;

package/dist/ios/src/index.d.ts

@@ -144,7 +144,55 @@ export interface CraftConfig {
     requestTimeoutSeconds?: number;
     orientations?: Array<'portrait' | 'landscape-left' | 'landscape-right' | 'portrait-upside-down'>;
     deviceFamilies?: Array<'iphone' | 'ipad'>;
+    /**
+     * Hybrid: app paths drawn as native stx screens instead of in the
+     * web view, each to the screen in the native bundle that draws it, e.g.
+     * `{ "/m": "Today", "/m/calendar": "Calendar" }`. A segment may be a
+     * parameter (`/m/workout/:id`) and the last one `*`. Needs `renderer: "web"`
+     * and `nativeBundle`; every other path stays in the web view, and a path
+     * whose screen is missing or throws falls back to it.
+     */
+    nativeScreens?: Record<string, string>;
+    /** Hybrid: the bundle `stx native compile --format bundle` wrote, copied to `dist/native-screen.js`. */
+    nativeBundle?: string;
+    /**
+     * The native tab bar, shown from the first frame, before the page loads.
+     * The page's own `tabBar.set` replaces it later. Each `id` is the tab's
+     * root path, as the page's tab links name it.
+     */
+    tabs?: CraftTab[];
+    /**
+     * Hybrid: web-storage keys the page writes (localStorage or
+     * sessionStorage) that native screens need, mirrored into the Keychain
+     * under the name given, e.g. `{ "auth_token": "auth.token" }` for
+     * `craft.secureStorage.getSync('auth.token')`. Turns on secure storage.
+     */
+    shareStorage?: Record<string, string>;
+}
+export interface CraftTab {
+    /** The tab's root path; comes back to the page in `craftTabSelect`. */
+    id: string;
+    title: string;
+    /** An SF Symbol name. */
+    symbol?: string;
+}
+/** `/a//b/?q#h` → `/a/b`, the way the shell and the page compare paths. Null for a relative path. */
+export declare function normalizeNativePath(raw: string): string | null;
+export interface NativePathMatch {
+    path: string;
+    screen: string;
+    params: Record<string, string>;
 }
+/**
+ * The native screen for a path, by the rules the shell (`CraftHybridRoutes`)
+ * and the page script apply: static segments win over `:params`, which win
+ * over a trailing `*`; query items become params under the path's own.
+ */
+export declare function matchNativePath(nativeScreens: Record<string, string> | undefined, raw: string): NativePathMatch | null;
+/** Whether a config mixes native screens into its web page. */
+export declare function isHybrid(config: Pick<CraftConfig, 'renderer' | 'nativeScreens'>): boolean;
+/** What is wrong with a config's hybrid and tab settings, one sentence each. */
+export declare function hybridConfigProblems(config: Pick<CraftConfig, 'renderer' | 'nativeScreens' | 'tabs' | 'shareStorage'>): string[];
 export interface CraftBackgroundRefresh {
     enabled: boolean;
     /** The BGTaskScheduler identifier. Default `<bundleId>.refresh`. */
@@ -191,7 +239,7 @@ export interface InitOptions {
 }
 export interface BuildOptions {
     htmlPath?: string;
-    /** JavaScript bundle emitted by `stx-native compile Screen.stx --format bundle`. */
+    /** JavaScript bundle emitted by `stx native compile Screen.stx --format bundle`. */
     nativeBundlePath?: string;
     devServer?: string;
     output: string;

package/dist/ios/src/index.js

@@ -11,6 +11,122 @@ var CRAFT_VERSION = (() => {
     return "0.0.0";
   }
 })();
+function normalizeNativePath(raw) {
+  if (typeof raw !== "string")
+    return null;
+  let path = raw;
+  const cut = path.search(/[?#]/);
+  if (cut >= 0)
+    path = path.slice(0, cut);
+  if (!path.startsWith("/"))
+    return null;
+  path = path.replace(/\/{2,}/g, "/");
+  if (path.length > 1 && path.endsWith("/"))
+    path = path.slice(0, -1);
+  return path;
+}
+function routeSegments(path) {
+  return path === "/" ? [] : path.slice(1).split("/");
+}
+function matchNativePath(nativeScreens, raw) {
+  const path = normalizeNativePath(raw);
+  if (path === null)
+    return null;
+  const routes = Object.entries(nativeScreens ?? {}).map(([pattern, screen]) => ({ pattern: normalizeNativePath(pattern), screen })).filter((route) => route.pattern !== null && !!route.screen).map((route) => ({ ...route, segments: routeSegments(route.pattern) }));
+  const wild = (segments) => segments.at(-1) === "*" ? 1 : 0;
+  const fixed = (segments) => segments.filter((s) => s !== "*" && !s.startsWith(":")).length;
+  routes.sort((a, b) => wild(a.segments) - wild(b.segments) || fixed(b.segments) - fixed(a.segments) || b.segments.length - a.segments.length || (a.pattern < b.pattern ? -1 : a.pattern > b.pattern ? 1 : 0));
+  const decode = (value) => {
+    try {
+      return decodeURIComponent(value);
+    } catch {
+      return value;
+    }
+  };
+  const parts = routeSegments(path);
+  for (const route of routes) {
+    const params = {};
+    let matched = true;
+    for (let i = 0;i < route.segments.length; i++) {
+      const segment = route.segments[i];
+      if (segment === "*") {
+        params["*"] = parts.slice(i).join("/");
+        break;
+      }
+      if (i >= parts.length) {
+        matched = false;
+        break;
+      }
+      if (segment.startsWith(":")) {
+        if (!parts[i]) {
+          matched = false;
+          break;
+        }
+        params[segment.slice(1)] = decode(parts[i]);
+      } else if (segment !== parts[i]) {
+        matched = false;
+        break;
+      }
+    }
+    if (!matched)
+      continue;
+    if (route.segments.at(-1) !== "*" && route.segments.length !== parts.length)
+      continue;
+    const query = raw.indexOf("?");
+    if (query >= 0) {
+      for (const item of raw.slice(query + 1).split("#")[0].split("&")) {
+        if (!item)
+          continue;
+        const [rawKey = "", ...rest] = item.split("=");
+        const key = decode(rawKey);
+        if (!key || key in params)
+          continue;
+        params[key] = decode(rest.join("=").replace(/\+/g, " "));
+      }
+    }
+    return { path, screen: route.screen, params };
+  }
+  return null;
+}
+function isHybrid(config) {
+  return (config.renderer ?? "web") === "web" && Object.keys(config.nativeScreens ?? {}).length > 0;
+}
+function hybridConfigProblems(config) {
+  const problems = [];
+  const screens = Object.entries(config.nativeScreens ?? {});
+  if (screens.length && config.renderer === "native")
+    problems.push('nativeScreens mixes native screens into a web app; it needs renderer: "web" (renderer: "native" is all native already).');
+  for (const [pattern, screen] of screens) {
+    if (normalizeNativePath(pattern) !== pattern || /[?#]/.test(pattern))
+      problems.push(`nativeScreens path "${pattern}" must be an absolute path with no query, hash or trailing slash.`);
+    if (routeSegments(normalizeNativePath(pattern) ?? "/").slice(0, -1).includes("*"))
+      problems.push(`nativeScreens path "${pattern}" may only end in *.`);
+    if (typeof screen !== "string" || !/^[A-Za-z_$][\w$-]*$/.test(screen))
+      problems.push(`nativeScreens screen "${String(screen)}" for "${pattern}" must be a screen name from the native bundle.`);
+  }
+  const ids = new Set;
+  for (const tab of config.tabs ?? []) {
+    if (!tab || typeof tab.id !== "string" || !tab.id || typeof tab.title !== "string" || !tab.title)
+      problems.push("Each tab needs an id (its root path) and a title.");
+    else if (ids.has(tab.id))
+      problems.push(`Tab "${tab.id}" is listed twice.`);
+    else
+      ids.add(tab.id);
+  }
+  for (const [key, target] of Object.entries(config.shareStorage ?? {})) {
+    if (!key || typeof target !== "string" || !target)
+      problems.push(`shareStorage "${key}" needs the Keychain key native screens read it under.`);
+  }
+  return problems;
+}
+function installNativeBundle(source, output) {
+  if (!existsSync(source))
+    throw new Error(`Native bundle not found: ${source}`);
+  const destination = join(output, "dist", "native-screen.js");
+  mkdirSync(dirname(destination), { recursive: true });
+  if (resolve(source) !== resolve(destination))
+    cpSync(source, destination);
+}
 var DEFAULT_CONFIG = {
   renderer: "web",
   version: "1.0.0",
@@ -643,6 +759,12 @@ async function init(options) {
   }
   if (config.enableBackgroundLocation)
     config.enableGeolocation = true;
+  const problems = hybridConfigProblems(config);
+  if (problems.length)
+    throw new Error(problems.join(`
+`));
+  if (Object.keys(config.shareStorage ?? {}).length)
+    config.enableSecureStorage = true;
   writeFileSync(join(output, "craft.config.json"), JSON.stringify(config, null, 2));
   const swiftTemplate = readFileSync(join(TEMPLATES_DIR, "CraftApp.swift"), "utf-8");
   const swiftSource = swiftTemplate.replace(/CraftApp/g, `${name}App`).replace(/\{\{BUNDLE_ID\}\}/g, finalBundleId).replace(/\{\{CRAFT_VERSION\}\}/g, CRAFT_VERSION);
@@ -652,6 +774,7 @@ async function init(options) {
   cpSync(join(TEMPLATES_DIR, "CraftNativeActions.swift"), join(output, "Sources", "CraftNativeActions.swift"));
   cpSync(join(TEMPLATES_DIR, "CraftNativeMutation.swift"), join(output, "Sources", "CraftNativeMutation.swift"));
   cpSync(join(TEMPLATES_DIR, "CraftNativeUI.swift"), join(output, "Sources", "CraftNativeUI.swift"));
+  cpSync(join(TEMPLATES_DIR, "CraftHybrid.swift"), join(output, "Sources", "CraftHybrid.swift"));
   const infoPlistTemplate = readFileSync(join(TEMPLATES_DIR, "Info.plist.template"), "utf-8");
   const infoPlist = infoPlistTemplate.replace(/\{\{APP_NAME\}\}/g, xmlEscape(displayName)).replace(/\{\{BUNDLE_ID\}\}/g, finalBundleId).replace(/\{\{VERSION\}\}/g, config.version || "1.0.0").replace(/\{\{BUILD_NUMBER\}\}/g, config.buildNumber || "1").replace(/\{\{UI_STYLE\}\}/g, renderAppearance(config).interfaceStyle).replace(/\{\{STATUS_BAR_STYLE\}\}/g, renderAppearance(config).statusBarStyle).replace(/\{\{ORIENTATIONS\}\}/g, renderOrientations(config)).replace(/\{\{USAGE_DESCRIPTIONS\}\}/g, renderUsageDescriptions(config)).replace(/\{\{URL_TYPES\}\}/g, renderUrlTypes(config)).replace(/\{\{APP_BOUND_DOMAINS\}\}/g, renderAppBoundDomains(config)).replace(/\{\{BACKGROUND_MODES\}\}/g, renderBackgroundModes(config)).replace(/\{\{BACKGROUND_TASK_IDENTIFIERS\}\}/g, renderBackgroundTaskIdentifiers(config)).replace(/\{\{LAUNCH_SCREEN\}\}/g, renderLaunchScreen(config)).replace(/\{\{NON_EXEMPT_ENCRYPTION\}\}/g, config.usesNonExemptEncryption ? "true" : "false").replace(/\{\{LIVE_ACTIVITY_SUPPORT\}\}/g, config.enableLiveActivities ? `    <key>NSSupportsLiveActivities</key>
     <true/>
@@ -744,12 +867,18 @@ ${nativeDependencies.join(`
     writeFileSync(join(output, "WatchExtension", "Watch.entitlements"), renderWatchEntitlements(config));
   }
   writeFileSync(join(output, "dist", "index.html"), renderOfflinePage(config));
+  if (isHybrid(config)) {
+    if (config.nativeBundle)
+      installNativeBundle(config.nativeBundle, output);
+    else
+      console.warn("   \u26A0 nativeScreens is set without nativeBundle: every path opens in the web view until `craft ios build --native-bundle` supplies one.");
+  }
   console.log("\u2705 Project initialized");
   console.log("");
   console.log("Next steps:");
   console.log(`  1. cd ${output}`);
   if (config.renderer === "native") {
-    console.log("  2. Compile your screen: stx-native compile Screen.stx --format bundle --output screen.js");
+    console.log("  2. Compile your screen: stx native compile Screen.stx --format bundle --output screen.js");
     console.log("  3. Run: craft ios build --native-bundle screen.js");
   } else {
     console.log("  2. Add your web content to dist/index.html");
@@ -780,11 +909,15 @@ async function build(options) {
         cpSync(nativeBundlePath, destination);
     }
     if (!existsSync(join(output, "dist", "native-screen.js"))) {
-      throw new Error("Native iOS mode needs dist/native-screen.js. Compile a .stx screen with stx-native first.");
+      throw new Error("Native iOS mode needs dist/native-screen.js. Compile a .stx screen with `stx native compile` first.");
     }
-  } else if (nativeBundlePath) {
-    throw new Error('--native-bundle requires renderer: "native" in craft.config.json.');
+  } else if (nativeBundlePath && !isHybrid(config)) {
+    throw new Error('--native-bundle requires renderer: "native", or nativeScreens, in craft.config.json.');
   }
+  const problems = hybridConfigProblems(config);
+  if (problems.length)
+    throw new Error(problems.join(`
+`));
   if (devServer) {
     config.devServerURL = devServer;
     const origin = new URL(devServer).origin;
@@ -796,6 +929,15 @@ async function build(options) {
     syncWebAssets(htmlPath, output);
     console.log(`   Synced: ${htmlPath} \u2192 dist/`);
   }
+  if (isHybrid(config)) {
+    const bundle = nativeBundlePath ?? config.nativeBundle;
+    if (bundle) {
+      installNativeBundle(bundle, output);
+      console.log(`   Native screens: ${bundle} \u2192 dist/native-screen.js`);
+    } else if (!existsSync(join(output, "dist", "native-screen.js"))) {
+      console.warn("   \u26A0 nativeScreens is set but there is no native bundle: every path opens in the web view.");
+    }
+  }
   await refreshRuntime(output, options.runtimeDir);
   if (!generateProject)
     return;
@@ -944,8 +1086,12 @@ export {
   pickSimulator,
   orderSimulators,
   open,
+  normalizeNativePath,
+  matchNativePath,
+  isHybrid,
   installRuntime,
   init,
+  hybridConfigProblems,
   build,
   bootSimulator,
   backgroundRefreshIdentifier,