craft-native 0.0.86 → 0.0.88

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

@@ -80,12 +80,32 @@ export interface InitOptions {
     teamId?: string;
     output: string;
     config?: Partial<CraftConfig>;
+    /**
+     * Where the Zig runtime archives live, overriding `CRAFT_IOS_RUNTIME`.
+     *
+     * `null` means "no runtime, whatever the environment says" — the shape
+     * `AppConfig.craftPath` has for `CRAFT_BIN`, and the reason it exists here
+     * is the same: a caller that does not opt in should not be steered by an
+     * ambient variable. Without it this package's own tests inherited whatever
+     * the developer's shell exported, and went from 12 passing to 8 passing and
+     * 4 failing when `CRAFT_IOS_RUNTIME` happened to be set.
+     *
+     * Omitted (`undefined`) keeps the environment lookup, which is what the
+     * monorepo dev loop uses.
+     */
+    runtimeDir?: string | null;
 }
 export interface BuildOptions {
     htmlPath?: string;
     devServer?: string;
     output: string;
     generateProject?: boolean;
+    /**
+     * Where to re-read the Zig runtime archives from, overriding
+     * `CRAFT_IOS_RUNTIME`. Same meaning as `InitOptions.runtimeDir`; `null`
+     * leaves whatever `init` installed exactly as it is.
+     */
+    runtimeDir?: string | null;
 }
 export interface OpenOptions {
     output: string;
@@ -101,12 +121,66 @@ export declare function renderUrlTypes(config: CraftConfig): string;
 export declare function renderBackgroundModes(config: CraftConfig): string;
 export declare function renderEntitlements(config: CraftConfig): string;
 export declare function renderWatchEntitlements(config: CraftConfig): string;
+/**
+ * The build settings that link the Zig runtime into the app target.
+ *
+ * Two things are load-bearing here:
+ *
+ * `LIBRARY_SEARCH_PATHS` is written twice, once per SDK, so `-lcraft-ios`
+ * resolves to the device archive for a device build and the simulator archive
+ * for a simulator one without the flag itself changing. Xcode applies the
+ * `[sdk=...]` condition; xcodegen passes these keys through verbatim.
+ *
+ * The four `-u` flags are the reason anything works at all. Nothing in the
+ * Swift source *references* these symbols — `CraftZigRuntime` and
+ * `CraftSwiftShim` both find them with `dlsym` at runtime — so a static
+ * archive contributes no objects for them and the linker drops the entire
+ * runtime as unreachable. `-u` names them as undefined so the objects are
+ * pulled in and the symbols end up in the binary for `dlsym` to find.
+ *
+ * `-u` rather than `-force_load`: forcing the whole archive would pull in
+ * every object whether reachable or not, and these four entry points already
+ * reach everything the bridge actually uses.
+ */
+export declare function renderRuntimeSettings(): string;
 export declare function renderPrivacyManifest(config: CraftConfig): string;
 /** Replace the bundled web application atomically so removed assets cannot linger. */
 export declare function syncWebAssets(source: string, output: string): void;
 /**
  * Initialize a new iOS project
  */
+/**
+ * Where the Zig runtime archives live, or null when this build has none.
+ *
+ * `CRAFT_IOS_RUNTIME` points at a directory holding the archives `zig build
+ * build-ios-all` produces. It is opt-in and there is deliberately no fallback
+ * search: a generated project with no runtime is the shipping default today,
+ * and it works — `CraftZigRuntime.offer` is a `dlsym` miss, every action
+ * answers false, and the Swift switch serves the whole surface exactly as it
+ * always has. Guessing at a path would turn "no runtime" into "some runtime,
+ * from somewhere", which is the failure mode the pantry contract exists to
+ * rule out.
+ *
+ * This is the same shape as `CRAFT_BIN`: an explicit override for the monorepo
+ * dev loop, not a lookup path. Shipping the runtime to real apps means putting
+ * these archives in the pantry package beside the `craft` binary, which is a
+ * distribution decision this function does not make.
+ *
+ * `override` is what `InitOptions.runtimeDir` passes: a path to use instead of
+ * the variable, or `null` to declare there is no runtime regardless of what the
+ * environment says. `undefined` falls through to `CRAFT_IOS_RUNTIME`.
+ */
+export declare function resolveRuntimeDir(override?: string | null): string | null;
+/**
+ * Copy the Zig archives into the generated project as `Runtime/<sdk>/libcraft-ios.a`.
+ *
+ * One name for both SDKs, in two directories, because that is what lets a
+ * single `-lcraft-ios` in OTHER_LDFLAGS work for device and simulator builds:
+ * Xcode picks the directory by SDK and the flag never changes.
+ *
+ * Returns true when a runtime was installed.
+ */
+export declare function installRuntime(output: string, runtimeDir: string): Promise<boolean>;
 export declare function init(options: InitOptions): Promise<void>;
 /**
  * Build web assets and generate Xcode project

package/dist/ios/src/index.js

@@ -176,6 +176,14 @@ ${appGroups}</dict>
 </plist>
 `;
 }
+function renderRuntimeSettings() {
+  return [
+    '      LIBRARY_SEARCH_PATHS[sdk=iphoneos*]: "$(PROJECT_DIR)/Runtime/device"',
+    '      LIBRARY_SEARCH_PATHS[sdk=iphonesimulator*]: "$(PROJECT_DIR)/Runtime/simulator"',
+    '      OTHER_LDFLAGS: "-lcraft-ios -Wl,-u,_craft_ios_handle_action -Wl,-u,_craft_ios_set_webview ' + '-Wl,-u,_craft_ios_deliver_result -Wl,-u,_craft_ios_deliver_error"'
+  ].join(`
+`);
+}
 function renderPrivacyManifest(config) {
   const privacy = config.privacy ?? {};
   const collected = privacy.collectedDataTypes ?? [];
@@ -279,6 +287,59 @@ function syncWebAssets(source, output) {
     throw new Error(`Web asset directory must contain index.html: ${source}`);
   }
 }
+function resolveRuntimeDir(override) {
+  if (override === null)
+    return null;
+  const dir = override ?? process.env.CRAFT_IOS_RUNTIME;
+  if (!dir)
+    return null;
+  if (!existsSync(dir)) {
+    const source = override === undefined ? "CRAFT_IOS_RUNTIME points at" : "runtimeDir is";
+    throw new Error(`${source} ${dir}, which does not exist.`);
+  }
+  return dir;
+}
+var RUNTIME_ARCHIVES = {
+  device: ["libcraft-ios.a"],
+  simulator: ["libcraft-ios-simulator-arm64.a", "libcraft-ios-simulator-x64.a"]
+};
+async function installRuntime(output, runtimeDir) {
+  const resolved = Object.entries(RUNTIME_ARCHIVES).map(([sdk, archives]) => {
+    const present = archives.filter((a) => existsSync(join(runtimeDir, a)));
+    if (present.length === 0) {
+      throw new Error(`${runtimeDir} has none of ${archives.join(", ")}. ` + `Run \`zig build build-ios-all\` in packages/zig and point at its zig-out/lib.`);
+    }
+    return { sdk, archives, present };
+  });
+  const dest = join(output, "Runtime");
+  rmSync(dest, { recursive: true, force: true });
+  for (const { sdk, archives, present } of resolved) {
+    const sdkDir = join(dest, sdk);
+    mkdirSync(sdkDir, { recursive: true });
+    const target = join(sdkDir, "libcraft-ios.a");
+    if (present.length === 1) {
+      const missing = archives.filter((a) => !present.includes(a));
+      if (missing.length > 0) {
+        console.warn(`   \u26A0 ${sdk}: only ${present[0]} was found; ${missing.join(", ")} is missing. ` + `The generated project will not link on the other architecture.`);
+      }
+      cpSync(join(runtimeDir, present[0]), target);
+    } else {
+      await $`lipo -create ${present.map((a) => join(runtimeDir, a))} -output ${target}`.quiet();
+    }
+  }
+  return true;
+}
+async function refreshRuntime(output, override) {
+  if (!existsSync(join(output, "Runtime")))
+    return;
+  const dir = resolveRuntimeDir(override);
+  if (!dir) {
+    console.log("   Keeping the Zig runtime installed at init (no runtime directory configured)");
+    return;
+  }
+  await installRuntime(output, dir);
+  console.log("   Refreshed the Zig runtime from", dir);
+}
 async function init(options) {
   const { name, bundleId, teamId, output } = options;
   console.log(`
@@ -351,7 +412,14 @@ async function init(options) {
       SWIFT_VERSION: "5.0"
       SKIP_INSTALL: YES`);
   }
-  const projectYml = projectYmlTemplate.replace(/\{\{APP_NAME\}\}/g, name).replace(/\{\{BUNDLE_ID\}\}/g, finalBundleId).replace(/\{\{BUNDLE_ID_PREFIX\}\}/g, bundleIdPrefix).replace(/\{\{VERSION\}\}/g, config.version || "1.0.0").replace(/\{\{BUILD_NUMBER\}\}/g, config.buildNumber || "1").replace(/\{\{IOS_VERSION\}\}/g, config.iosVersion || "15.0").replace(/\{\{DEVICE_FAMILIES\}\}/g, renderDeviceFamilies(config)).replace(/\{\{TEAM_ID\}\}/g, teamId || "").replace(/\{\{NATIVE_DEPENDENCIES\}\}/g, nativeDependencies.length ? `    dependencies:
+  const runtimeDir = resolveRuntimeDir(options.runtimeDir);
+  const hasRuntime = runtimeDir ? await installRuntime(output, runtimeDir) : false;
+  if (hasRuntime) {
+    console.log("   Linked the Zig runtime from", runtimeDir);
+  } else {
+    rmSync(join(output, "Runtime"), { recursive: true, force: true });
+  }
+  const projectYml = projectYmlTemplate.replace(/\{\{CRAFT_RUNTIME_SETTINGS\}\}/g, hasRuntime ? renderRuntimeSettings() : "").replace(/\{\{APP_NAME\}\}/g, name).replace(/\{\{BUNDLE_ID\}\}/g, finalBundleId).replace(/\{\{BUNDLE_ID_PREFIX\}\}/g, bundleIdPrefix).replace(/\{\{VERSION\}\}/g, config.version || "1.0.0").replace(/\{\{BUILD_NUMBER\}\}/g, config.buildNumber || "1").replace(/\{\{IOS_VERSION\}\}/g, config.iosVersion || "15.0").replace(/\{\{DEVICE_FAMILIES\}\}/g, renderDeviceFamilies(config)).replace(/\{\{TEAM_ID\}\}/g, teamId || "").replace(/\{\{NATIVE_DEPENDENCIES\}\}/g, nativeDependencies.length ? `    dependencies:
 ${nativeDependencies.join(`
 `)}` : "").replace(/\{\{NATIVE_TARGETS\}\}/g, nativeTargets.join(`
 `));
@@ -442,6 +510,7 @@ async function build(options) {
     syncWebAssets(htmlPath, output);
     console.log(`   Synced: ${htmlPath} \u2192 dist/`);
   }
+  await refreshRuntime(output, options.runtimeDir);
   if (!generateProject)
     return;
   try {
@@ -567,9 +636,11 @@ export {
   syncWebAssets,
   showSimulator,
   run,
+  resolveRuntimeDir,
   renderWatchEntitlements,
   renderUsageDescriptions,
   renderUrlTypes,
+  renderRuntimeSettings,
   renderPrivacyManifest,
   renderOrientations,
   renderEntitlements,
@@ -578,6 +649,7 @@ export {
   pickSimulator,
   orderSimulators,
   open,
+  installRuntime,
   init,
   build,
   bootSimulator