Build typescript declaration and javascript entrypoint

Author: kraenhansen

package-lock.json

@@ -3,3 +3,7 @@ Cargo.lock
 
 /*.xcframework/
 /*.android.node/
+
+# Generated files
+/libferric_example.d.ts
+/libferric_example.js

packages/ferric-example/.gitignore

@@ -10,7 +10,7 @@
     "start": "tsx src/run.ts"
   },
   "dependencies": {
-    "@napi-rs/cli": "3.0.0-alpha.78",
+    "@napi-rs/cli": "^2.18.4",
     "@commander-js/extra-typings": "^13.1.0",
     "bufout": "^0.3.1",
     "chalk": "^5.4.1",

packages/ferric/package.json

@@ -1,4 +1,5 @@
 import path from "node:path";
+import fs from "node:fs";
 
 import { Command, Option } from "@commander-js/extra-typings";
 import chalk from "chalk";
@@ -13,6 +14,8 @@ import {
   determineXCFrameworkFilename,
   createXCframework,
   createUniversalAppleLibrary,
+  determineLibraryFilename,
+  prettyPath,
 } from "react-native-node-api-modules";
 
 import { UsageError } from "./errors.js";
@@ -26,6 +29,22 @@ import {
   ensureInstalledTargets,
   filterTargetsByPlatform,
 } from "./targets.js";
+import { generateTypeScriptDeclarations } from "./napi-rs.js";
+
+type EntrypointOptions = {
+  outputPath: string;
+  libraryName: string;
+};
+async function generateEntrypoint({
+  outputPath,
+  libraryName,
+}: EntrypointOptions) {
+  await fs.promises.writeFile(
+    outputPath,
+    "module.exports = require('./" + libraryName + ".node');",
+    "utf8"
+  );
+}
 
 const ANDROID_TRIPLET_PER_TARGET: Record<AndroidTargetName, AndroidTriplet> = {
   "aarch64-linux-android": "aarch64-linux-android",
@@ -94,9 +113,9 @@ export const buildCommand = new Command("build")
         const androidTargets = filterTargetsByPlatform(targets, "android");
 
         const targetsDescription =
-          targets.size === 1
-            ? `${targets.size} target`
-            : `${targets.size} targets`;
+          targets.size +
+          (targets.size === 1 ? " target" : " targets") +
+          chalk.dim(" (" + [...targets].join(", ") + ")");
         const [appleLibraries, androidLibraries] = await oraPromise(
           Promise.all([
             Promise.all(
@@ -127,8 +146,44 @@ export const buildCommand = new Command("build")
           }
         );
 
-        // TODO: Call napi.rs to generate the .d.ts
-        // TODO: Generate an entrypoint
+        const libraryName = determineLibraryFilename([
+          ...androidLibraries.map(([, outputPath]) => outputPath),
+        ]);
+
+        const declarationsFilename = `${libraryName}.d.ts`;
+        const declarationsPath = path.join(outputPath, declarationsFilename);
+        await oraPromise(
+          generateTypeScriptDeclarations({
+            outputFilename: declarationsFilename,
+            createPath: process.cwd(),
+            outputPath,
+          }),
+          {
+            text: "Generating TypeScript declarations",
+            successText: `Generated TypeScript declarations ${prettyPath(
+              declarationsPath
+            )}`,
+            failText: (error) =>
+              `Failed to generate TypeScript declarations: ${error.message}`,
+          }
+        );
+
+        const entrypointPath = path.join(outputPath, `${libraryName}.js`);
+
+        await oraPromise(
+          generateEntrypoint({
+            libraryName,
+            outputPath: entrypointPath,
+          }),
+          {
+            text: `Generating entrypoint`,
+            successText: `Generated entrypoint into ${prettyPath(
+              entrypointPath
+            )}`,
+            failText: (error) =>
+              `Failed to generate entrypoint: ${error.message}`,
+          }
+        );
 
         if (androidLibraries.length > 0) {
           const libraryPathByTriplet = Object.fromEntries(
@@ -154,8 +209,8 @@ export const buildCommand = new Command("build")
             }),
             {
               text: "Assembling Android libs directory",
-              successText: `Android libs directory assembled into ${chalk.dim(
-                path.relative(process.cwd(), androidLibsOutputPath)
+              successText: `Android libs directory assembled into ${prettyPath(
+                androidLibsOutputPath
               )}`,
               failText: ({ message }) =>
                 `Failed to assemble Android libs directory: ${message}`,

packages/ferric/src/build.ts

@@ -0,0 +1,67 @@
+import fs from "node:fs";
+import path from "node:path";
+
+import { spawn } from "bufout";
+
+const PACKAGE_ROOT = path.join(import.meta.dirname, "..");
+
+type TypeScriptDeclarationsOptions = {
+  /**
+   * Path to the directory containing the Cargo.toml file.
+   */
+  createPath: string;
+  /**
+   * Path to the output directory where the TypeScript declarations will be copied into.
+   */
+  outputPath: string;
+  /**
+   * File name of the generated TypeScript declarations (including .d.ts).
+   */
+  outputFilename: string;
+};
+
+export async function generateTypeScriptDeclarations({
+  createPath,
+  outputPath,
+  outputFilename,
+}: TypeScriptDeclarationsOptions) {
+  // Using a temporary directory to avoid polluting crate with any other side-effects for generating TypeScript declarations
+  const tempPath = fs.realpathSync(
+    fs.mkdtempSync(path.join(PACKAGE_ROOT, "dts-tmp-"))
+  );
+  try {
+    // Write a dummy package.json file to avoid errors from napi-rs
+    await fs.promises.writeFile(
+      path.join(tempPath, "package.json"),
+      "{}",
+      "utf8"
+    );
+    // Call into napi.rs to generate TypeScript declarations
+    const napiCliPath = new URL(
+      import.meta.resolve("@napi-rs/cli/scripts/index.js")
+    ).pathname;
+    await spawn(
+      // TODO: Resolve the CLI path (not using npx because we don't want to npx to mess up the cwd)
+      napiCliPath,
+      [
+        "build",
+        "--dts",
+        outputFilename,
+        "--cargo-cwd",
+        // This doesn't understand absolute paths
+        path.relative(tempPath, createPath),
+      ],
+      {
+        outputMode: "buffered",
+        cwd: tempPath,
+      }
+    );
+    // Copy out the generated TypeScript declarations
+    await fs.promises.copyFile(
+      path.join(tempPath, outputFilename),
+      path.join(outputPath, outputFilename)
+    );
+  } finally {
+    await fs.promises.rm(tempPath, { recursive: true, force: true });
+  }
+}

packages/ferric/src/napi-rs.ts

@@ -20,3 +20,5 @@ export {
   createUniversalAppleLibrary,
   determineXCFrameworkFilename,
 } from "./prebuilds/apple.js";
+
+export { determineLibraryFilename, prettyPath } from "./path-utils.js";

packages/react-native-node-api-modules/src/node/index.ts

@@ -301,6 +301,20 @@ export function findNodeApiModulePathsByDependency({
   );
 }
 
+/**
+ * Determine the library filename based on the library paths.
+ * Ensuring that all framework paths have the same base name.
+ */
+export function determineLibraryFilename(libraryPaths: string[]) {
+  const libraryNames = libraryPaths.map((p) =>
+    path.basename(p, path.extname(p))
+  );
+  const candidates = new Set<string>(libraryNames);
+  assert(candidates.size === 1, "Expected all libraries to have the same name");
+  const [name] = candidates;
+  return name;
+}
+
 export function getAutolinkPath(platform: PlatformName) {
   const result = path.resolve(__dirname, "../../auto-linked", platform);
   fs.mkdirSync(result, { recursive: true });

packages/react-native-node-api-modules/src/node/path-utils.ts

@@ -3,6 +3,7 @@ import fs from "node:fs";
 import path from "node:path";
 
 import { AndroidTriplet } from "./triplets.js";
+import { determineLibraryFilename } from "../path-utils.js";
 
 export const DEFAULT_ANDROID_TRIPLETS = [
   "aarch64-linux-android",
@@ -24,17 +25,9 @@ export const ANDROID_ARCHITECTURES = {
  * Determine the filename of the Android libs directory based on the framework paths.
  * Ensuring that all framework paths have the same base name.
  */
-export function determineAndroidLibsFilename(frameworkPaths: string[]) {
-  const frameworkNames = frameworkPaths.map((p) =>
-    path.basename(p, path.extname(p))
-  );
-  const candidates = new Set<string>(frameworkNames);
-  assert(
-    candidates.size === 1,
-    "Expected all frameworks to have the same name"
-  );
-  const [name] = candidates;
-  return `${name}.android.node`;
+export function determineAndroidLibsFilename(libraryPaths: string[]) {
+  const libraryName = determineLibraryFilename(libraryPaths);
+  return `${libraryName}.android.node`;
 }
 
 type AndroidLibsDirectoryOptions = {