@nativescript/windows-hermes 0.1.0-alpha.0 → 0.1.0-alpha.140

package/README.md

@@ -1,27 +1,3 @@
-# @nativescript/windows-hermes
-
-NativeScript Windows runtime on **Microsoft's prebuilt Hermes** (`hermes.dll`, which exports both
-`napi_*` and the JSR C API), with no Node/Bun/Deno host. The engine-neutral
-`runtime::napi_engine` WinRT interop runs unchanged over Hermes's `napi_env`.
-
-## As an app runtime (drop-in for `@nativescript/windows`)
-Publishes as `@nativescript/windows-hermes`, the **same** WinUI 3 framework as
-`@nativescript/windows` with the Hermes runtime DLL — swap the dependency and an app runs
-unchanged. Build the framework with the engine flag:
-```sh
-pwsh -File ../../template/build.ps1 -Engine hermes   # or: npm run build
-```
-The engine → runtime-DLL adapter (the C ABI the WinUI 3 host P/Invokes) follows the reference
-implementation in `../windows-quickjs/src/abi.rs`. See `../README.md` for the full contract.
-
-## Standalone host (dev/bench)
-```sh
-cargo build --release --manifest-path packages/windows-hermes/Cargo.toml
-target/release/nativescript-windows.exe   # runs the WinRT demo, exit 0
-```
-build.rs links `vendor/x64/hermes.lib`, forward-exports Hermes's `napi_*` from the exe (so napi-sys
-resolves them), and copies `hermes.dll`/`hermes-icu.dll` next to the binary.
-
-## Notes
-- Prebuilt engine binaries are committed under `vendor/` — see `vendor/README.md` for provenance
-  (Microsoft.JavaScript.Hermes NuGet) and the refresh recipe.
+# @nativescript/windows-hermes
+
+NativeScript Windows runtime on **Microsoft's prebuilt Hermes**

package/framework/__PROJECT_NAME__/App.xaml

@@ -1,13 +1,13 @@
-<Application
-    x:Class="__PROJECT_NAME__.App"
-    xmlns="http://schemas.microsoft.com/winfx/2006/xaml/presentation"
-    xmlns:x="http://schemas.microsoft.com/winfx/2006/xaml"
-    xmlns:local="using:__PROJECT_NAME__">
-    <Application.Resources>
-        <ResourceDictionary>
-            <ResourceDictionary.MergedDictionaries>
-                <XamlControlsResources xmlns="using:Microsoft.UI.Xaml.Controls" />
-            </ResourceDictionary.MergedDictionaries>
-        </ResourceDictionary>
-    </Application.Resources>
-</Application>
+<Application
+    x:Class="__PROJECT_NAME__.App"
+    xmlns="http://schemas.microsoft.com/winfx/2006/xaml/presentation"
+    xmlns:x="http://schemas.microsoft.com/winfx/2006/xaml"
+    xmlns:local="using:__PROJECT_NAME__">
+    <Application.Resources>
+        <ResourceDictionary>
+            <ResourceDictionary.MergedDictionaries>
+                <XamlControlsResources xmlns="using:Microsoft.UI.Xaml.Controls" />
+            </ResourceDictionary.MergedDictionaries>
+        </ResourceDictionary>
+    </Application.Resources>
+</Application>

package/framework/__PROJECT_NAME__/Package.appxmanifest

@@ -1,35 +1,35 @@
-<?xml version="1.0" encoding="utf-8"?>
-<Package
-  xmlns="http://schemas.microsoft.com/appx/manifest/foundation/windows10"
-  xmlns:uap="http://schemas.microsoft.com/appx/manifest/uap/windows10"
-  xmlns:rescap="http://schemas.microsoft.com/appx/manifest/foundation/windows10/restrictedcapabilities"
-  IgnorableNamespaces="uap rescap">
-  <Identity Name="__APP_IDENTIFIER__" Publisher="CN=__PROJECT_NAME__" Version="1.0.0.0" />
-  <Properties>
-    <DisplayName>__PROJECT_NAME__</DisplayName>
-    <PublisherDisplayName>__PROJECT_NAME__</PublisherDisplayName>
-    <Logo>Assets\StoreLogo.png</Logo>
-  </Properties>
-  <Dependencies>
-    <TargetDeviceFamily Name="Windows.Desktop" MinVersion="10.0.17763.0" MaxVersionTested="10.0.26100.0" />
-    <!-- WinUI3 / Windows App SDK 1.6 framework package (framework-dependent). Required so the
-         registered app can activate Microsoft.UI.Xaml.* (else REGDB_E_CLASSNOTREG at startup). -->
-    <PackageDependency Name="Microsoft.WindowsAppRuntime.1.6" MinVersion="6000.0.0.0" Publisher="CN=Microsoft Corporation, O=Microsoft Corporation, L=Redmond, S=Washington, C=US" />
-  </Dependencies>
-  <Resources>
-    <Resource Language="en-US" />
-  </Resources>
-  <Applications>
-    <Application Id="App" Executable="$targetnametoken$.exe" EntryPoint="Windows.FullTrustApplication">
-      <uap:VisualElements DisplayName="__PROJECT_NAME__" Square150x150Logo="Assets\Square150x150Logo.png" Square44x44Logo="Assets\Square44x44Logo.png" Description="A NativeScript Windows application" BackgroundColor="#65ADF1">
-        <uap:DefaultTile Wide310x150Logo="Assets\Wide310x150Logo.png" />
-        <uap:SplashScreen Image="Assets\SplashScreen.png" />
-      </uap:VisualElements>
-    </Application>
-  </Applications>
-  <Capabilities>
-    <rescap:Capability Name="runFullTrust" />
-    <Capability Name="internetClient" />
-    <Capability Name="privateNetworkClientServer" />
-  </Capabilities>
-</Package>
+<?xml version="1.0" encoding="utf-8"?>
+<Package
+  xmlns="http://schemas.microsoft.com/appx/manifest/foundation/windows10"
+  xmlns:uap="http://schemas.microsoft.com/appx/manifest/uap/windows10"
+  xmlns:rescap="http://schemas.microsoft.com/appx/manifest/foundation/windows10/restrictedcapabilities"
+  IgnorableNamespaces="uap rescap">
+  <Identity Name="__APP_IDENTIFIER__" Publisher="CN=__PROJECT_NAME__" Version="1.0.0.0" />
+  <Properties>
+    <DisplayName>__PROJECT_NAME__</DisplayName>
+    <PublisherDisplayName>__PROJECT_NAME__</PublisherDisplayName>
+    <Logo>Assets\StoreLogo.png</Logo>
+  </Properties>
+  <Dependencies>
+    <TargetDeviceFamily Name="Windows.Desktop" MinVersion="10.0.17763.0" MaxVersionTested="10.0.26100.0" />
+    <!-- WinUI3 / Windows App SDK 1.6 framework package (framework-dependent). Required so the
+         registered app can activate Microsoft.UI.Xaml.* (else REGDB_E_CLASSNOTREG at startup). -->
+    <PackageDependency Name="Microsoft.WindowsAppRuntime.1.6" MinVersion="6000.0.0.0" Publisher="CN=Microsoft Corporation, O=Microsoft Corporation, L=Redmond, S=Washington, C=US" />
+  </Dependencies>
+  <Resources>
+    <Resource Language="en-US" />
+  </Resources>
+  <Applications>
+    <Application Id="App" Executable="$targetnametoken$.exe" EntryPoint="Windows.FullTrustApplication">
+      <uap:VisualElements DisplayName="__PROJECT_NAME__" Square150x150Logo="Assets\Square150x150Logo.png" Square44x44Logo="Assets\Square44x44Logo.png" Description="A NativeScript Windows application" BackgroundColor="#65ADF1">
+        <uap:DefaultTile Wide310x150Logo="Assets\Wide310x150Logo.png" />
+        <uap:SplashScreen Image="Assets\SplashScreen.png" />
+      </uap:VisualElements>
+    </Application>
+  </Applications>
+  <Capabilities>
+    <rescap:Capability Name="runFullTrust" />
+    <Capability Name="internetClient" />
+    <Capability Name="privateNetworkClientServer" />
+  </Capabilities>
+</Package>

package/framework/__PROJECT_NAME__/Program.cs

@@ -1,34 +1,34 @@
-using System;
-using System.Threading;
-using Microsoft.UI.Dispatching;
-using Microsoft.UI.Xaml;
-using WinRT;
-
-// Windows-only WinUI desktop app. The custom entry point (DISABLE_XAML_GENERATED_MAIN)
-// has no platform attribute, so CA1416 treats every Windows API call site as "reachable
-// on all platforms." Declaring the assembly's supported platform once tells the analyzer
-// the whole assembly only runs on Windows >= 17763, silencing those false positives.
-[assembly: System.Runtime.Versioning.SupportedOSPlatform("windows10.0.17763.0")]
-
-namespace __PROJECT_NAME__
-{
-    public static class Program
-    {
-        [System.STAThread]
-        public static void Main(string[] args)
-        {
-            ComWrappersSupport.InitializeComWrappers();
-
-            Application.Start((_callbackParams) =>
-            {
-                var dispatcherQueue = DispatcherQueue.GetForCurrentThread();
-                if (dispatcherQueue != null)
-                {
-                    SynchronizationContext.SetSynchronizationContext(new DispatcherQueueSynchronizationContext(dispatcherQueue));
-                }
-
-				new App();
-            });
-        }
-    }
-}
+using System;
+using System.Threading;
+using Microsoft.UI.Dispatching;
+using Microsoft.UI.Xaml;
+using WinRT;
+
+// Windows-only WinUI desktop app. The custom entry point (DISABLE_XAML_GENERATED_MAIN)
+// has no platform attribute, so CA1416 treats every Windows API call site as "reachable
+// on all platforms." Declaring the assembly's supported platform once tells the analyzer
+// the whole assembly only runs on Windows >= 17763, silencing those false positives.
+[assembly: System.Runtime.Versioning.SupportedOSPlatform("windows10.0.17763.0")]
+
+namespace __PROJECT_NAME__
+{
+    public static class Program
+    {
+        [System.STAThread]
+        public static void Main(string[] args)
+        {
+            ComWrappersSupport.InitializeComWrappers();
+
+            Application.Start((_callbackParams) =>
+            {
+                var dispatcherQueue = DispatcherQueue.GetForCurrentThread();
+                if (dispatcherQueue != null)
+                {
+                    SynchronizationContext.SetSynchronizationContext(new DispatcherQueueSynchronizationContext(dispatcherQueue));
+                }
+
+				new App();
+            });
+        }
+    }
+}

package/framework/__PROJECT_NAME__/Properties/Default.rd.xml

@@ -1,9 +1,9 @@
-<!--
-    Runtime Directives for .NET Native.
-    See https://go.microsoft.com/fwlink/?LinkID=391919
--->
-<Directives xmlns="http://schemas.microsoft.com/netfx/2013/01/metadata">
-  <Application>
-    <Assembly Name="*Application*" Dynamic="Required All" />
-  </Application>
-</Directives>
+<!--
+    Runtime Directives for .NET Native.
+    See https://go.microsoft.com/fwlink/?LinkID=391919
+-->
+<Directives xmlns="http://schemas.microsoft.com/netfx/2013/01/metadata">
+  <Application>
+    <Assembly Name="*Application*" Dynamic="Required All" />
+  </Application>
+</Directives>

package/framework/__PROJECT_NAME__/RuntimeHost.cs

@@ -32,6 +32,20 @@ namespace __PROJECT_NAME__
         [DllImport(NativeScriptLibrary, EntryPoint = nameof(runtime_set_local_folder))]
         private static extern void runtime_set_local_folder([MarshalAs(UnmanagedType.LPUTF8Str)] string localFolder);
 
+        // Escape hatch for apps packed with `nsbundle_pack --key-hex <hex>` (custom-key
+        // app.nsbundle containers). Must be called before runtime_init if used at all: apps
+        // packed with the default pepper (no --key-hex) never need to call this. Not wired to a
+        // default call site here; an app author supplies their own key material and calls this
+        // from Initialize() before runtime_init(...).
+        [DllImport(NativeScriptLibrary, EntryPoint = nameof(runtime_set_bundle_key))]
+        private static extern int runtime_set_bundle_key([MarshalAs(UnmanagedType.LPUTF8Str)] string keyHex);
+
+        [DllImport(NativeScriptLibrary, EntryPoint = nameof(runtime_read_protected_file))]
+        private static extern IntPtr runtime_read_protected_file([MarshalAs(UnmanagedType.LPUTF8Str)] string virtualPath);
+
+        [DllImport(NativeScriptLibrary, EntryPoint = nameof(runtime_free_protected_string))]
+        private static extern void runtime_free_protected_string(IntPtr ptr);
+
         [DllImport(NativeScriptLibrary, EntryPoint = nameof(runtime_get_last_js_error))]
         private static extern IntPtr runtime_get_last_js_error();
 
@@ -55,6 +69,18 @@ namespace __PROJECT_NAME__
         }
 
     #if DEBUG
+        // Engine runtimes (@nativescript/windows-<engine>) only: a debug host always allows
+        // dev-server modules (Vite HMR). The classic runtime derives this from its devtools build
+        // and doesn't export it.
+        [DllImport(NativeScriptLibrary, EntryPoint = nameof(runtime_set_debug_build))]
+        private static extern void runtime_set_debug_build(int debug);
+
+        private static void TrySetDebugBuild()
+        {
+            try { runtime_set_debug_build(1); }
+            catch (EntryPointNotFoundException) { }
+        }
+
         [DllImport(NativeScriptLibrary, EntryPoint = nameof(ns_set_log_to_console))]
         private static extern int ns_set_log_to_console(int enabled);
 
@@ -140,6 +166,7 @@ namespace __PROJECT_NAME__
             runtime_set_local_folder(Windows.Storage.ApplicationData.Current.LocalFolder.Path);
             _runtime = runtime_init(AppContext.BaseDirectory);
 #if DEBUG
+            TrySetDebugBuild();
             var trySet = TrySetLogToConsole(true);
             System.Diagnostics.Debug.WriteLine($"[NativeScript] TrySetLogToConsole returned={trySet}");
 
@@ -191,6 +218,27 @@ namespace __PROJECT_NAME__
         }
 #endif
 
+        /// Reads a file that may live inside a sealed app.nsbundle instead of on disk: tries the
+        /// protected-VFS native call first (cheap no-op when no bundle is loaded), falls back to
+        /// the real filesystem. `path` is whatever candidate the caller already built for
+        /// `File.Exists`/`File.ReadAllText`: the native side strips it down to the bundle's
+        /// virtual (app/App-relative) path itself, so no extra bookkeeping is needed here.
+        private static string TryReadVirtual(string path)
+        {
+            IntPtr ptr = IntPtr.Zero;
+            try
+            {
+                ptr = runtime_read_protected_file(path);
+                return ptr == IntPtr.Zero ? null : Marshal.PtrToStringUTF8(ptr);
+            }
+            catch { return null; }
+            finally { if (ptr != IntPtr.Zero) runtime_free_protected_string(ptr); }
+        }
+
+        private static bool VExists(string path) => TryReadVirtual(path) != null || File.Exists(path);
+
+        private static string VReadAllText(string path) => TryReadVirtual(path) ?? File.ReadAllText(path);
+
         public void RunMainScript()
         {
             if (!_initialized)
@@ -205,10 +253,14 @@ namespace __PROJECT_NAME__
 
             var dir = Path.GetDirectoryName(Path.GetFullPath(entryPath));
             var chunks = new List<string>();
-            foreach (var chunkName in new[] { "runtime.js", "vendor.js" })
+            // An ES-module entry (Vite's bundle.mjs) imports its own chunks; webpack's classic
+            // runtime.js/vendor.js prelude must not run in front of it (a stale pair can be left
+            // in app/ after switching bundlers).
+            var isModuleEntry = entryPath.EndsWith(".mjs", StringComparison.OrdinalIgnoreCase);
+            foreach (var chunkName in isModuleEntry ? Array.Empty<string>() : new[] { "runtime.js", "vendor.js" })
             {
                 var chunkPath = Path.Combine(dir, chunkName);
-                if (File.Exists(chunkPath) &&
+                if (VExists(chunkPath) &&
                     !string.Equals(chunkPath, Path.GetFullPath(entryPath), StringComparison.OrdinalIgnoreCase))
                 {
                     chunks.Add(chunkPath);
@@ -218,10 +270,14 @@ namespace __PROJECT_NAME__
 
             foreach (var scriptPath in chunks)
             {
-                var script = File.ReadAllText(Path.GetFullPath(scriptPath));
+                var script = VReadAllText(Path.GetFullPath(scriptPath));
                 try
                 {
-                    runtime_runscript(_runtime, script, Path.GetFileName(scriptPath));
+                    // Modules resolve their imports (chunks, ~/ paths) relative to their own
+                    // location, so they need the full path; classic scripts keep the short name
+                    // their stack traces and code-cache keys have always used.
+                    var name = isModuleEntry ? Path.GetFullPath(scriptPath) : Path.GetFileName(scriptPath);
+                    runtime_runscript(_runtime, script, name);
                 }
                 catch (Exception ex)
                 {
@@ -260,7 +316,7 @@ namespace __PROJECT_NAME__
             foreach (var dir in appDirCandidates)
             {
                 var candidate = Path.Combine(dir, "package.json");
-                if (File.Exists(candidate))
+                if (VExists(candidate))
                 {
                     packageJsonPath = candidate;
                     resolvedBaseDir = dir;
@@ -269,7 +325,7 @@ namespace __PROJECT_NAME__
             }
 
             // Also accept package.json at the project root (parent of bin/).
-            if (packageJsonPath == null && File.Exists(Path.Combine(parentDir, "package.json")))
+            if (packageJsonPath == null && VExists(Path.Combine(parentDir, "package.json")))
             {
                 packageJsonPath = Path.Combine(parentDir, "package.json");
                 resolvedBaseDir = parentDir;
@@ -278,7 +334,7 @@ namespace __PROJECT_NAME__
             string Fallback() =>
                 appDirCandidates
                     .SelectMany(d => new[] { Path.Combine(d, "bundle.js"), Path.Combine(d, "bundle.mjs") })
-                    .FirstOrDefault(File.Exists);
+                    .FirstOrDefault(VExists);
 
             if (packageJsonPath == null)
                 return Fallback();
@@ -304,7 +360,7 @@ namespace __PROJECT_NAME__
 
         private static RuntimePackageConfig ParsePackageConfig(string packageJsonPath)
         {
-            using var doc = JsonDocument.Parse(File.ReadAllText(packageJsonPath));
+            using var doc = JsonDocument.Parse(VReadAllText(packageJsonPath));
             var config = new RuntimePackageConfig();
             if (doc.RootElement.TryGetProperty("main", out var main) && main.ValueKind == JsonValueKind.String)
                 config.Main = main.GetString();
@@ -321,11 +377,11 @@ namespace __PROJECT_NAME__
             foreach (var candidate in new[] { normalized, normalized + ".js", normalized + ".mjs" })
             {
                 var direct = Path.IsPathRooted(candidate) ? candidate : Path.Combine(baseDir, candidate);
-                if (File.Exists(direct)) return direct;
+                if (VExists(direct)) return direct;
                 var appLower = Path.Combine(baseDir, "app", candidate);
-                if (File.Exists(appLower)) return appLower;
+                if (VExists(appLower)) return appLower;
                 var appUpper = Path.Combine(baseDir, "App", candidate);
-                if (File.Exists(appUpper)) return appUpper;
+                if (VExists(appUpper)) return appUpper;
             }
             return null;
         }

package/framework/__PROJECT_NAME__/__PROJECT_NAME__.csproj

@@ -87,7 +87,12 @@
     <Content Include="Properties\Default.rd.xml" />
 
     <!-- App JS/resource files — copied to the output directory on every build -->
-    <Content Include="app\**\*">
+    <!-- Sealed source-protected bundle when present, takes
+         priority over the plaintext app\ tree; produced by the nsbundle_pack packer tool. -->
+    <Content Include="app.nsbundle" Condition="Exists('app.nsbundle')">
+      <CopyToOutputDirectory>PreserveNewest</CopyToOutputDirectory>
+    </Content>
+    <Content Include="app\**\*" Condition="!Exists('app.nsbundle')">
       <CopyToOutputDirectory>PreserveNewest</CopyToOutputDirectory>
     </Content>