@napi-rs/cli 3.0.0-alpha.1 → 3.0.0-alpha.100

package/dist/utils/__tests__/config.spec.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/utils/config.d.ts

@@ -1,5 +1,10 @@
 import { Target } from './target.js';
-interface UserNapiConfig {
+export type ValueOfConstArray<T> = T[Exclude<keyof T, keyof Array<any>>];
+export declare const SupportedPackageManagers: readonly ["yarn", "pnpm"];
+export declare const SupportedTestFrameworks: readonly ["ava"];
+export type SupportedPackageManager = ValueOfConstArray<typeof SupportedPackageManagers>;
+export type SupportedTestFramework = ValueOfConstArray<typeof SupportedTestFrameworks>;
+export interface UserNapiConfig {
     /**
      * Name of the binary to be generated, default to `index`
      */
@@ -18,6 +23,50 @@ interface UserNapiConfig {
      * The npm client project uses.
      */
     npmClient?: string;
+    /**
+     * Whether generate const enum for typescript bindings
+     */
+    constEnum?: boolean;
+    /**
+     * dts header prepend to the generated dts file
+     */
+    dtsHeader?: string;
+    /**
+     * dts header file path to be prepended to the generated dts file
+     * if both dtsHeader and dtsHeaderFile are provided, dtsHeaderFile will be used
+     */
+    dtsHeaderFile?: string;
+    /**
+     * wasm compilation options
+     */
+    wasm?: {
+        /**
+         * https://developer.mozilla.org/en-US/docs/WebAssembly/JavaScript_interface/Memory
+         * @default 4000 pages (256MiB)
+         */
+        initialMemory?: number;
+        /**
+         * @default 65536 pages (4GiB)
+         */
+        maximumMemory?: number;
+        /**
+         * Browser wasm binding configuration
+         */
+        browser: {
+            /**
+             * Whether to use fs module in browser
+             */
+            fs?: boolean;
+            /**
+             * Whether to initialize wasm asynchronously
+             */
+            asyncInit?: boolean;
+            /**
+             * Whether to inject `buffer` to emnapi context
+             */
+            buffer?: boolean;
+        };
+    };
     /**
      * @deprecated binaryName instead
      */
@@ -35,14 +84,14 @@ interface UserNapiConfig {
         /**
          * Whether enable default targets
          */
-        default: boolean;
+        defaults: boolean;
         /**
          * Additional targets to be compiled for
          */
         additional?: string[];
     };
 }
-interface CommonPackageJsonFields {
+export interface CommonPackageJsonFields {
     name: string;
     version: string;
     description?: string;
@@ -50,16 +99,31 @@ interface CommonPackageJsonFields {
     author?: string;
     authors?: string[];
     license?: string;
+    cpu?: string[];
+    os?: string[];
+    libc?: string[];
+    files?: string[];
     repository?: any;
     homepage?: any;
     engines?: Record<string, string>;
     publishConfig?: any;
     bugs?: any;
     napi?: UserNapiConfig;
+    type?: 'module' | 'commonjs';
+    scripts?: Record<string, string>;
+    main?: string;
+    module?: string;
+    types?: string;
+    browser?: string;
+    exports?: any;
+    dependencies?: Record<string, string>;
+    devDependencies?: Record<string, string>;
+    ava?: {
+        timeout?: string;
+    };
 }
-export type NapiConfig = Required<Pick<UserNapiConfig, 'binaryName' | 'packageName' | 'npmClient'>> & {
+export type NapiConfig = Required<Pick<UserNapiConfig, 'binaryName' | 'packageName' | 'npmClient'>> & Pick<UserNapiConfig, 'wasm' | 'dtsHeader' | 'dtsHeaderFile' | 'constEnum'> & {
     targets: Target[];
     packageJson: CommonPackageJsonFields;
 };
-export declare function readNapiConfig(path: string): Promise<NapiConfig>;
-export {};
+export declare function readNapiConfig(path: string, configPath?: string): Promise<NapiConfig>;

package/dist/utils/index.d.ts

@@ -1,4 +1,3 @@
-export * from './ci.js';
 export * from './log.js';
 export * from './misc.js';
 export * from './target.js';
@@ -7,3 +6,4 @@ export * from './metadata.js';
 export * from './config.js';
 export * from './cargo.js';
 export * from './typegen.js';
+export * from './read-config.js';

package/dist/utils/metadata.d.ts

@@ -13,6 +13,18 @@ export interface Crate {
     targets: CrateTarget[];
     features: Record<string, string[]>;
     manifest_path: string;
+    dependencies: Array<{
+        name: string;
+        source: string;
+        req: string;
+        kind: string | null;
+        rename: string | null;
+        optional: boolean;
+        uses_default_features: boolean;
+        features: string[];
+        target: string | null;
+        registry: string | null;
+    }>;
 }
 export interface CargoWorkspaceMetadata {
     version: number;
@@ -21,4 +33,4 @@ export interface CargoWorkspaceMetadata {
     target_directory: string;
     workspace_root: string;
 }
-export declare function parseMetadata(manifestPath: string): CargoWorkspaceMetadata;
+export declare function parseMetadata(manifestPath: string): Promise<CargoWorkspaceMetadata>;

package/dist/utils/misc.d.ts

@@ -1,5 +1,4 @@
-/// <reference types="node" resolution-mode="require"/>
-import { readFile, writeFile, copyFile, mkdir, unlink, stat, readdir } from 'fs';
+import { readFile, writeFile, copyFile, mkdir, unlink, stat, readdir } from 'node:fs';
 export declare const readFileAsync: typeof readFile.__promisify__;
 export declare const writeFileAsync: typeof writeFile.__promisify__;
 export declare const unlinkAsync: typeof unlink.__promisify__;
@@ -8,6 +7,7 @@ export declare const mkdirAsync: typeof mkdir.__promisify__;
 export declare const statAsync: typeof stat.__promisify__;
 export declare const readdirAsync: typeof readdir.__promisify__;
 export declare function fileExists(path: string): Promise<boolean>;
+export declare function dirExistsAsync(path: string): Promise<boolean>;
 export declare function pick<O, K extends keyof O>(o: O, ...keys: K[]): Pick<O, K>;
 export declare function updatePackageJson(path: string, partial: Record<string, any>): Promise<void>;
-export declare const CLI_VERSION: any;
+export declare const CLI_VERSION: string;

package/dist/utils/read-config.d.ts

@@ -0,0 +1,7 @@
+interface MinimalNapiOptions {
+    cwd: string;
+    configPath?: string;
+    packageJsonPath?: string;
+}
+export declare function readConfig(options: MinimalNapiOptions): Promise<import("./config.js").NapiConfig>;
+export {};

package/dist/utils/target.d.ts

@@ -1,15 +1,18 @@
-/// <reference types="node" resolution-mode="require"/>
-export declare const AVAILABLE_TARGETS: readonly ["aarch64-apple-darwin", "aarch64-linux-android", "aarch64-unknown-linux-gnu", "aarch64-unknown-linux-musl", "aarch64-pc-windows-msvc", "x86_64-apple-darwin", "x86_64-pc-windows-msvc", "x86_64-unknown-linux-gnu", "x86_64-unknown-linux-musl", "x86_64-unknown-freebsd", "i686-pc-windows-msvc", "armv7-unknown-linux-gnueabihf", "armv7-linux-androideabi", "universal-apple-darwin"];
+export type Platform = NodeJS.Platform | 'wasm' | 'wasi' | 'openharmony';
+export declare const UNIVERSAL_TARGETS: {
+    readonly 'universal-apple-darwin': readonly ["aarch64-apple-darwin", "x86_64-apple-darwin"];
+};
+export declare const AVAILABLE_TARGETS: readonly ["aarch64-apple-darwin", "aarch64-linux-android", "aarch64-unknown-linux-gnu", "aarch64-unknown-linux-musl", "aarch64-unknown-linux-ohos", "aarch64-pc-windows-msvc", "x86_64-apple-darwin", "x86_64-pc-windows-msvc", "x86_64-unknown-linux-gnu", "x86_64-unknown-linux-musl", "x86_64-unknown-linux-ohos", "x86_64-unknown-freebsd", "i686-pc-windows-msvc", "armv7-unknown-linux-gnueabihf", "armv7-unknown-linux-musleabihf", "armv7-linux-androideabi", "universal-apple-darwin", "riscv64gc-unknown-linux-gnu", "powerpc64le-unknown-linux-gnu", "s390x-unknown-linux-gnu", "wasm32-wasi-preview1-threads", "wasm32-wasip1-threads"];
 export type TargetTriple = (typeof AVAILABLE_TARGETS)[number];
-export declare const DEFAULT_TARGETS: readonly ["x86_64-apple-darwin", "x86_64-pc-windows-msvc", "x86_64-unknown-linux-gnu"];
+export declare const DEFAULT_TARGETS: readonly ["x86_64-apple-darwin", "aarch64-apple-darwin", "x86_64-pc-windows-msvc", "x86_64-unknown-linux-gnu"];
 export declare const TARGET_LINKER: Record<string, string>;
-type NodeJSArch = 'arm' | 'arm64' | 'ia32' | 'mips' | 'mipsel' | 'ppc' | 'ppc64' | 's390' | 's390x' | 'x32' | 'x64' | 'universal';
+type NodeJSArch = 'arm' | 'arm64' | 'ia32' | 'mips' | 'mipsel' | 'ppc' | 'ppc64' | 'riscv64' | 's390' | 's390x' | 'x32' | 'x64' | 'universal' | 'wasm32';
 export declare const NodeArchToCpu: Record<string, string>;
-export declare const UniArchsByPlatform: Partial<Record<NodeJS.Platform, NodeJSArch[]>>;
+export declare const UniArchsByPlatform: Partial<Record<Platform, NodeJSArch[]>>;
 export interface Target {
     triple: string;
     platformArchABI: string;
-    platform: NodeJS.Platform;
+    platform: Platform;
     arch: NodeJSArch;
     abi: string | null;
 }

package/dist/utils/typegen.d.ts

@@ -1,3 +1,6 @@
 export declare const DEFAULT_TYPE_DEF_HEADER = "/* auto-generated by NAPI-RS */\n/* eslint-disable */\n";
-export declare function processTypeDef(intermediateTypeFile: string, header?: string): Promise<string>;
+export declare function processTypeDef(intermediateTypeFile: string, constEnum: boolean): Promise<{
+    dts: string;
+    exports: string[];
+}>;
 export declare function correctStringIdent(src: string, ident: number): string;

package/dist/utils/version.d.ts

@@ -6,6 +6,7 @@ export declare enum NapiVersion {
     Napi5 = 5,
     Napi6 = 6,
     Napi7 = 7,
-    Napi8 = 8
+    Napi8 = 8,
+    Napi9 = 9
 }
 export declare function napiEngineRequirement(napiVersion: NapiVersion): string;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@napi-rs/cli",
-  "version": "3.0.0-alpha.1",
+  "version": "3.0.0-alpha.100",
   "description": "Cli tools for napi-rs",
   "author": "LongYinan <lynweklm@gmail.com>",
   "homepage": "https://github.com/napi-rs/napi-rs",
@@ -18,12 +18,12 @@
   "exports": {
     ".": {
       "import": {
-        "default": "./dist/index.js",
-        "types": "./dist/index.d.ts"
+        "types": "./dist/index.d.ts",
+        "default": "./dist/index.js"
       },
       "require": {
-        "default": "./dist/index.cjs",
-        "types": "./dist/index.d.ts"
+        "types": "./dist/index.d.ts",
+        "default": "./dist/index.cjs"
       }
     },
     "./package.json": {
@@ -67,34 +67,70 @@
     "url": "https://github.com/napi-rs/napi-rs/issues"
   },
   "dependencies": {
-    "@octokit/rest": "^19.0.7",
-    "clipanion": "^3.2.0",
-    "colorette": "^2.0.19",
-    "debug": "^4.3.4",
-    "inquirer": "^9.1.5",
+    "@inquirer/prompts": "^7.4.0",
+    "@napi-rs/cross-toolchain": "^0.0.19",
+    "@napi-rs/wasm-tools": "^0.0.3",
+    "@octokit/rest": "^22.0.0",
+    "clipanion": "^4.0.0-rc.4",
+    "colorette": "^2.0.20",
+    "debug": "^4.4.0",
+    "emnapi": "^1.4.0",
+    "find-up": "^7.0.0",
     "js-yaml": "^4.1.0",
     "lodash-es": "^4.17.21",
-    "typanion": "^3.12.1"
+    "semver": "^7.7.1",
+    "typanion": "^3.14.0",
+    "wasm-sjlj": "^1.0.6"
   },
   "devDependencies": {
-    "@types/inquirer": "^9.0.3",
-    "@types/js-yaml": "^4.0.5",
-    "@types/lodash-es": "^4.17.6",
-    "ava": "^5.2.0",
-    "esbuild": "^0.17.14",
-    "prettier": "^2.8.7",
-    "ts-node": "^10.9.1",
-    "typescript": "^4.9.4"
+    "@emnapi/core": "^1.4.0",
+    "@emnapi/runtime": "^1.4.0",
+    "@oxc-node/core": "^0.0.29",
+    "@std/toml": "npm:@jsr/std__toml@^1.0.8",
+    "@types/debug": "^4.1.12",
+    "@types/inquirer": "^9.0.7",
+    "@types/js-yaml": "^4.0.9",
+    "@types/lodash-es": "^4.17.12",
+    "@types/node": "^22.13.16",
+    "@types/semver": "^7.7.0",
+    "ava": "^6.2.0",
+    "env-paths": "^3.0.0",
+    "prettier": "^3.5.3",
+    "rolldown": "^1.0.0-beta.23",
+    "tslib": "^2.8.1",
+    "typescript": "^5.8.2"
+  },
+  "peerDependencies": {
+    "@emnapi/runtime": "^1.1.0",
+    "emnapi": "^1.1.0"
+  },
+  "peerDependenciesMeta": {
+    "@emnapi/runtime": {
+      "optional": true
+    },
+    "emnapi": {
+      "optional": true
+    }
   },
   "funding": {
     "type": "github",
     "url": "https://github.com/sponsors/Brooooooklyn"
   },
   "scripts": {
-    "codegen": "node --loader ts-node/esm/transpile-only ./codegen/index.ts",
-    "build": "tsc && yarn build:cjs",
-    "build:cjs": "node ./esbuild.mjs",
-    "test": "ava"
+    "clean": "node --import @oxc-node/core/register ./clean.ts",
+    "codegen": "node --import @oxc-node/core/register ./codegen/index.ts",
+    "build": "tsc && yarn clean && rolldown -c rolldown.config.js",
+    "test": "node --import @oxc-node/core/register ../node_modules/ava/entrypoints/cli.mjs"
+  },
+  "ava": {
+    "extensions": {
+      "ts": "module"
+    },
+    "timeout": "1m",
+    "files": [
+      "**/__tests__/**/*.spec.ts",
+      "e2e/**/*.spec.ts"
+    ]
   },
-  "gitHead": "5daf558ead65b27ffd6b1da318ba91467d7445c3"
+  "gitHead": "40839a3a5e798bcbc59c5466d741f45a4794d1fd"
 }

package/src/api/__tests__/create-npm-dirs.spec.ts

@@ -0,0 +1,210 @@
+import { existsSync } from 'node:fs'
+import { mkdir, readFile, rm, writeFile } from 'node:fs/promises'
+import { tmpdir } from 'node:os'
+import { join } from 'node:path'
+
+import ava, { TestFn } from 'ava'
+
+import { createNpmDirs } from '../create-npm-dirs.js'
+
+const test = ava as TestFn<{
+  tmpDir: string
+  packageJsonPath: string
+}>
+
+test.beforeEach(async (t) => {
+  // Create a unique temp directory for tests
+  const timestamp = Date.now()
+  const random = Math.random().toString(36).substring(7)
+  const tmpDir = join(
+    tmpdir(),
+    'napi-rs-test',
+    `create-npm-dirs-${timestamp}-${random}`,
+  )
+  const packageJsonPath = join(tmpDir, 'package.json')
+
+  // Create the directory
+  await mkdir(tmpDir, { recursive: true })
+
+  t.context = { tmpDir, packageJsonPath }
+})
+
+test.afterEach.always(async (t) => {
+  // Clean up any created directories
+  if (existsSync(t.context.tmpDir)) {
+    await rm(t.context.tmpDir, { recursive: true, force: true })
+  }
+})
+
+test('should omit exports fields from publishConfig in scoped packages', async (t) => {
+  const { tmpDir, packageJsonPath } = t.context
+
+  // Create a package.json with publishConfig that includes exports field
+  const packageJson = {
+    name: 'test-package',
+    version: '1.0.0',
+    publishConfig: {
+      registry: 'https://custom-registry.com',
+      access: 'public',
+      exports: {
+        '.': './dist/index.js',
+        './package.json': './package.json',
+      },
+      tag: 'beta',
+    },
+    napi: {
+      binaryName: 'test-package',
+      targets: ['x86_64-unknown-linux-gnu'],
+    },
+  }
+
+  await writeFile(packageJsonPath, JSON.stringify(packageJson, null, 2))
+
+  await createNpmDirs({
+    cwd: tmpDir,
+    packageJsonPath: 'package.json',
+  })
+
+  // Check that the scoped package directory was created
+  const scopedDir = join(tmpDir, 'npm', 'linux-x64-gnu')
+  t.true(existsSync(scopedDir))
+
+  // Read the generated package.json for the scoped package
+  const scopedPackageJsonPath = join(scopedDir, 'package.json')
+  t.true(existsSync(scopedPackageJsonPath))
+
+  const scopedPackageJson = JSON.parse(
+    await readFile(scopedPackageJsonPath, 'utf-8'),
+  )
+
+  // Verify that publishConfig only contains registry and access, not exports
+  t.truthy(scopedPackageJson.publishConfig)
+  t.is(scopedPackageJson.publishConfig.registry, 'https://custom-registry.com')
+  t.is(scopedPackageJson.publishConfig.access, 'public')
+  t.is(scopedPackageJson.publishConfig.exports, undefined)
+  t.is(scopedPackageJson.publishConfig.tag, undefined)
+})
+
+test('should handle package without publishConfig', async (t) => {
+  const { tmpDir, packageJsonPath } = t.context
+
+  // Create a package.json without publishConfig
+  const packageJson = {
+    name: 'test-package-no-config',
+    version: '1.0.0',
+    napi: {
+      binaryName: 'test-package-no-config',
+      targets: ['x86_64-unknown-linux-gnu'],
+    },
+  }
+
+  await writeFile(packageJsonPath, JSON.stringify(packageJson, null, 2))
+
+  await createNpmDirs({
+    cwd: tmpDir,
+    packageJsonPath: 'package.json',
+  })
+
+  // Check that the scoped package directory was created
+  const scopedDir = join(tmpDir, 'npm', 'linux-x64-gnu')
+  t.true(existsSync(scopedDir))
+
+  // Read the generated package.json for the scoped package
+  const scopedPackageJsonPath = join(scopedDir, 'package.json')
+  const scopedPackageJson = JSON.parse(
+    await readFile(scopedPackageJsonPath, 'utf-8'),
+  )
+
+  // Verify that publishConfig is not present when not in source
+  t.is(scopedPackageJson.publishConfig, undefined)
+})
+
+test('should preserve only registry and access in publishConfig', async (t) => {
+  const { tmpDir, packageJsonPath } = t.context
+
+  // Create a package.json with minimal publishConfig
+  const packageJson = {
+    name: 'test-package-minimal',
+    version: '1.0.0',
+    publishConfig: {
+      registry: 'https://npm.company.com',
+      access: 'restricted',
+    },
+    napi: {
+      binaryName: 'test-package-minimal',
+      targets: ['aarch64-apple-darwin'],
+    },
+  }
+
+  await writeFile(packageJsonPath, JSON.stringify(packageJson, null, 2))
+
+  await createNpmDirs({
+    cwd: tmpDir,
+    packageJsonPath: 'package.json',
+  })
+
+  // Check that the scoped package directory was created
+  const scopedDir = join(tmpDir, 'npm', 'darwin-arm64')
+  t.true(existsSync(scopedDir))
+
+  // Read the generated package.json for the scoped package
+  const scopedPackageJsonPath = join(scopedDir, 'package.json')
+  const scopedPackageJson = JSON.parse(
+    await readFile(scopedPackageJsonPath, 'utf-8'),
+  )
+
+  // Verify that publishConfig contains exactly registry and access
+  t.truthy(scopedPackageJson.publishConfig)
+  t.is(scopedPackageJson.publishConfig.registry, 'https://npm.company.com')
+  t.is(scopedPackageJson.publishConfig.access, 'restricted')
+  t.is(Object.keys(scopedPackageJson.publishConfig).length, 2)
+})
+
+test('should handle WASM targets correctly with publishConfig', async (t) => {
+  const { tmpDir, packageJsonPath } = t.context
+
+  // Create a package.json for WASM target
+  const packageJson = {
+    name: 'test-wasm-package',
+    version: '1.0.0',
+    publishConfig: {
+      registry: 'https://wasm-registry.com',
+      access: 'public',
+      exports: './wasm.js',
+      browser: './browser.js',
+    },
+    napi: {
+      binaryName: 'test-wasm-package',
+      targets: ['wasm32-wasi-preview1-threads'],
+    },
+  }
+
+  await writeFile(packageJsonPath, JSON.stringify(packageJson, null, 2))
+
+  await createNpmDirs({
+    cwd: tmpDir,
+    packageJsonPath: 'package.json',
+  })
+
+  // Check that the scoped package directory was created
+  const scopedDir = join(tmpDir, 'npm', 'wasm32-wasi')
+  t.true(existsSync(scopedDir))
+
+  // Read the generated package.json for the scoped package
+  const scopedPackageJsonPath = join(scopedDir, 'package.json')
+  const scopedPackageJson = JSON.parse(
+    await readFile(scopedPackageJsonPath, 'utf-8'),
+  )
+
+  // Verify that publishConfig is correctly filtered for WASM too
+  t.truthy(scopedPackageJson.publishConfig)
+  t.is(scopedPackageJson.publishConfig.registry, 'https://wasm-registry.com')
+  t.is(scopedPackageJson.publishConfig.access, 'public')
+  t.is(scopedPackageJson.publishConfig.exports, undefined)
+  t.is(scopedPackageJson.publishConfig.browser, undefined)
+
+  // Verify WASM-specific fields are set correctly
+  t.truthy(scopedPackageJson.main)
+  t.truthy(scopedPackageJson.browser)
+  t.truthy(scopedPackageJson.dependencies)
+})