@napi-rs/cli 3.0.0-alpha.7 → 3.0.0-alpha.71

package/src/utils/__tests__/__snapshots__/version.spec.ts.md

@@ -9,12 +9,13 @@ Generated by [AVA](https://avajs.dev).
 > Snapshot 1
 
     [
-      '>= 8.6.0',
-      '>= 8.10.0 < 9 || >= 9.3.0',
-      '>= 6.14.2 < 7 || >= 8.11.2 < 9 || >= 9.11.0',
-      '>= 10.16.0 < 11 || >= 11.8.0',
-      '>= 10.17.0 < 11 || >= 12.11.0',
+      '>= 8.6.0 < 9 || >= 9.0.0 < 10 || >= 10.0.0',
+      '>= 8.10.0 < 9 || >= 9.3.0 < 10 || >= 10.0.0',
+      '>= 6.14.2 < 7 || >= 8.11.2 < 9 || >= 9.11.0 < 10 || >= 10.0.0',
+      '>= 10.16.0 < 11 || >= 11.8.0 < 12 || >= 12.0.0',
+      '>= 10.17.0 < 11 || >= 12.11.0 < 13 || >= 13.0.0',
       '>= 10.20.0 < 11 || >= 12.17.0 < 13 || >= 14.0.0',
-      '>= 10.23.0 < 11 || >= 12.19.0 < 13 || >= 14.12.0',
-      '>= 12.22.0 < 13 || >= 14.17.0 < 15 || >= 15.12.0',
+      '>= 10.23.0 < 11 || >= 12.19.0 < 13 || >= 14.12.0 < 15 || >= 15.0.0',
+      '>= 12.22.0 < 13 || >= 14.17.0 < 15 || >= 15.12.0 < 16 || >= 16.0.0',
+      '>= 18.17.0 < 19 || >= 20.3.0 < 21 || >= 21.1.0',
     ]

package/src/utils/__tests__/config.spec.ts

@@ -0,0 +1,81 @@
+import { unlink, writeFile } from 'node:fs/promises'
+import { tmpdir } from 'node:os'
+import { join } from 'node:path'
+
+import ava, { TestFn } from 'ava'
+
+import {
+  CommonPackageJsonFields,
+  UserNapiConfig,
+  readNapiConfig,
+} from '../config.js'
+
+const NON_EXISTENT_FILE = 'non-existent-file'
+
+const test = ava as TestFn<{
+  configPath: string
+  packageJson: string
+  pkgJson: CommonPackageJsonFields
+  config: UserNapiConfig
+}>
+
+test.before(async (t) => {
+  const tmp = tmpdir()
+  const configPath = join(tmp, 'napi.json')
+  const packageJson = join(tmp, 'package.json')
+  const pkgJson = {
+    name: '@napi-rs/testing',
+    version: '0.0.0',
+    napi: {
+      binaryName: 'testing',
+      packageName: '@napi-rs/testing',
+      targets: [
+        'x86_64-unknown-linux-gnu',
+        'x86_64-pc-windows-msvc',
+        'x86_64-apple-darwin',
+      ],
+    },
+  }
+  await writeFile(packageJson, JSON.stringify(pkgJson, null, 2))
+  const config = {
+    binaryName: 'testing',
+    packageName: '@node-rs/testing',
+    targets: [
+      'x86_64-unknown-linux-gnu',
+      'x86_64-apple-darwin',
+      'aarch64-apple-darwin',
+    ],
+  }
+  await writeFile(configPath, JSON.stringify(config, null, 2))
+  t.context = { configPath, config, packageJson, pkgJson }
+})
+
+test.after(async (t) => {
+  await unlink(t.context.configPath)
+  await unlink(t.context.packageJson)
+})
+
+test('should throw if package.json not found', async (t) => {
+  await t.throwsAsync(() => readNapiConfig(NON_EXISTENT_FILE), {
+    message: `package.json not found at ${NON_EXISTENT_FILE}`,
+  })
+})
+
+test('should throw if napi.json not found', async (t) => {
+  const { packageJson } = t.context
+  await t.throwsAsync(() => readNapiConfig(packageJson, NON_EXISTENT_FILE), {
+    message: `NAPI-RS config not found at ${NON_EXISTENT_FILE}`,
+  })
+})
+
+test('should be able to read config from package.json', async (t) => {
+  const { packageJson } = t.context
+  const config = await readNapiConfig(packageJson)
+  t.snapshot(config)
+})
+
+test('should be able to read config from napi.json', async (t) => {
+  const { packageJson, configPath } = t.context
+  const config = await readNapiConfig(packageJson, configPath)
+  t.snapshot(config)
+})

package/src/utils/__tests__/typegen.spec.ts

@@ -18,13 +18,13 @@ test('should ident string correctly', (t) => {
     foo() {
       a = b
     }
-  
+
   bar = () => {
-  
+
   }
       boz = 1
     }
-  
+
   namespace B {
       namespace C {
   type D = A
@@ -43,6 +43,21 @@ test('should process type def correctly', async (t) => {
       '__fixtures__',
       'napi_type_def',
     ),
+    true,
+  )
+
+  t.snapshot(dts)
+})
+
+test('should process type def with noConstEnum correctly', async (t) => {
+  const { dts } = await processTypeDef(
+    join(
+      fileURLToPath(import.meta.url),
+      '../',
+      '__fixtures__',
+      'napi_type_def',
+    ),
+    false,
   )
 
   t.snapshot(dts)

package/src/utils/cargo.ts

@@ -1,4 +1,4 @@
-import { execSync } from 'child_process'
+import { execSync } from 'node:child_process'
 
 import { debug } from './log.js'
 
@@ -28,7 +28,7 @@ function detectCargoBinary(bin: string) {
     })
     debug('Cargo binary detected: %s', bin)
     return true
-  } catch (e) {
+  } catch {
     debug('Cargo binary not detected: %s', bin)
     return false
   }

package/src/utils/config.ts

@@ -1,9 +1,22 @@
+import { underline, yellow } from 'colorette'
 import { merge, omit } from 'lodash-es'
 
 import { fileExists, readFileAsync } from './misc.js'
 import { DEFAULT_TARGETS, parseTriple, Target } from './target.js'
 
-interface UserNapiConfig {
+export type ValueOfConstArray<T> = T[Exclude<keyof T, keyof Array<any>>]
+
+export const SupportedPackageManagers = ['yarn'] as const
+export const SupportedTestFrameworks = ['ava'] as const
+
+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`
    */
@@ -24,6 +37,47 @@ interface UserNapiConfig {
    */
   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
+    }
+  }
+
   /**
    * @deprecated binaryName instead
    */
@@ -71,22 +125,34 @@ export interface CommonPackageJsonFields {
   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'>
-> & {
-  targets: Target[]
-  packageJson: CommonPackageJsonFields
-}
+> &
+  Pick<UserNapiConfig, 'wasm' | 'dtsHeader' | 'dtsHeaderFile' | 'constEnum'> & {
+    targets: Target[]
+    packageJson: CommonPackageJsonFields
+  }
 
-export async function readNapiConfig(path: string): Promise<NapiConfig> {
+export async function readNapiConfig(
+  path: string,
+  configPath?: string,
+): Promise<NapiConfig> {
+  if (configPath && !(await fileExists(configPath))) {
+    throw new Error(`NAPI-RS config not found at ${configPath}`)
+  }
   if (!(await fileExists(path))) {
-    throw new Error(`napi-rs config not found at ${path}`)
+    throw new Error(`package.json not found at ${path}`)
   }
   // May support multiple config sources later on.
   const content = await readFileAsync(path, 'utf8')
@@ -94,12 +160,34 @@ export async function readNapiConfig(path: string): Promise<NapiConfig> {
   try {
     pkgJson = JSON.parse(content) as CommonPackageJsonFields
   } catch (e) {
-    throw new Error('Failed to parse napi-rs config', {
+    throw new Error(`Failed to parse package.json at ${path}`, {
       cause: e,
     })
   }
 
+  let separatedConfig: UserNapiConfig | undefined
+  if (configPath) {
+    const configContent = await readFileAsync(configPath, 'utf8')
+    try {
+      separatedConfig = JSON.parse(configContent) as UserNapiConfig
+    } catch (e) {
+      throw new Error(`Failed to parse NAPI-RS config at ${configPath}`, {
+        cause: e,
+      })
+    }
+  }
+
   const userNapiConfig = pkgJson.napi ?? {}
+  if (pkgJson.napi && separatedConfig) {
+    const pkgJsonPath = underline(path)
+    const configPathUnderline = underline(configPath!)
+    console.warn(
+      yellow(
+        `Both napi field in ${pkgJsonPath} and [NAPI-RS config](${configPathUnderline}) file are found, the NAPI-RS config file will be used.`,
+      ),
+    )
+    Object.assign(userNapiConfig, separatedConfig)
+  }
   const napiConfig: NapiConfig = merge(
     {
       binaryName: 'index',
@@ -114,17 +202,31 @@ export async function readNapiConfig(path: string): Promise<NapiConfig> {
   let targets: string[] = userNapiConfig.targets ?? []
 
   // compatible with old config
-  if (userNapiConfig.package?.name) {
-    napiConfig.packageName = userNapiConfig.package.name
+  if (userNapiConfig?.name) {
+    console.warn(
+      yellow(
+        `[DEPRECATED] napi.name is deprecated, use napi.binaryName instead.`,
+      ),
+    )
+    napiConfig.binaryName = userNapiConfig.name
   }
 
   if (!targets.length) {
+    let deprecatedWarned = false
+    const warning = yellow(
+      `[DEPRECATED] napi.triples is deprecated, use napi.targets instead.`,
+    )
     if (userNapiConfig.triples?.defaults) {
+      deprecatedWarned = true
+      console.warn(warning)
       targets = targets.concat(DEFAULT_TARGETS)
     }
 
     if (userNapiConfig.triples?.additional?.length) {
       targets = targets.concat(userNapiConfig.triples.additional)
+      if (!deprecatedWarned) {
+        console.warn(warning)
+      }
     }
   }
 

package/src/utils/index.ts

@@ -1,4 +1,3 @@
-export * from './ci.js'
 export * from './log.js'
 export * from './misc.js'
 export * from './target.js'

package/src/utils/metadata.ts

@@ -1,5 +1,5 @@
-import { execSync } from 'child_process'
-import fs from 'fs'
+import { execSync } from 'node:child_process'
+import fs from 'node:fs'
 
 export type CrateTargetKind =
   | 'bin'

package/src/utils/misc.ts

@@ -1,6 +1,14 @@
-import { readFile, writeFile, copyFile, mkdir, unlink, stat, readdir } from 'fs'
-import { createRequire } from 'module'
-import { promisify } from 'util'
+import {
+  readFile,
+  writeFile,
+  copyFile,
+  mkdir,
+  unlink,
+  stat,
+  readdir,
+} from 'node:fs'
+import { createRequire } from 'node:module'
+import { promisify } from 'node:util'
 
 import { debug } from './log.js'
 

package/src/utils/target.ts

@@ -1,7 +1,11 @@
-import { execSync } from 'child_process'
+import { execSync } from 'node:child_process'
 
 export type Platform = NodeJS.Platform | 'wasm' | 'wasi'
 
+export const UNIVERSAL_TARGETS = {
+  'universal-apple-darwin': ['aarch64-apple-darwin', 'x86_64-apple-darwin'],
+} as const
+
 export const AVAILABLE_TARGETS = [
   'aarch64-apple-darwin',
   'aarch64-linux-android',
@@ -15,15 +19,20 @@ export const AVAILABLE_TARGETS = [
   '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',
 ] as const
 
 export type TargetTriple = (typeof AVAILABLE_TARGETS)[number]
 
 export const DEFAULT_TARGETS = [
   'x86_64-apple-darwin',
+  'aarch64-apple-darwin',
   'x86_64-pc-windows-msvc',
   'x86_64-unknown-linux-gnu',
 ] as const
@@ -31,6 +40,8 @@ export const DEFAULT_TARGETS = [
 export const TARGET_LINKER: Record<string, string> = {
   'aarch64-unknown-linux-musl': 'aarch64-linux-musl-gcc',
   'riscv64gc-unknown-linux-gnu': 'riscv64-linux-gnu-gcc',
+  'powerpc64le-unknown-linux-gnu': 'powerpc64le-linux-gnu-gcc',
+  's390x-unknown-linux-gnu': 's390x-linux-gnu-gcc',
 }
 
 // https://nodejs.org/api/process.html#process_process_arch
@@ -48,6 +59,7 @@ type NodeJSArch =
   | 'x32'
   | 'x64'
   | 'universal'
+  | 'wasm32'
 
 const CpuToNodeArch: Record<string, NodeJSArch> = {
   x86_64: 'x64',
@@ -55,6 +67,7 @@ const CpuToNodeArch: Record<string, NodeJSArch> = {
   i686: 'ia32',
   armv7: 'arm',
   riscv64gc: 'riscv64',
+  powerpc64le: 'ppc64',
 }
 
 export const NodeArchToCpu: Record<string, string> = {
@@ -63,6 +76,7 @@ export const NodeArchToCpu: Record<string, string> = {
   ia32: 'i686',
   arm: 'armv7',
   riscv64: 'riscv64gc',
+  ppc64: 'powerpc64le',
 }
 
 const SysToNodePlatform: Record<string, Platform> = {
@@ -80,7 +94,7 @@ export interface Target {
   triple: string
   platformArchABI: string
   platform: Platform
-  arch: NodeJSArch | 'wasm32'
+  arch: NodeJSArch
   abi: string | null
 }
 
@@ -95,10 +109,14 @@ export interface Target {
  *   - `abi` = The ABI, for example `gnu`, `android`, `eabi`, etc.
  */
 export function parseTriple(rawTriple: string): Target {
-  if (rawTriple === 'wasm32-wasi-preview1-threads') {
+  if (
+    rawTriple === 'wasm32-wasi' ||
+    rawTriple === 'wasm32-wasi-preview1-threads' ||
+    rawTriple.startsWith('wasm32-wasip')
+  ) {
     return {
       triple: rawTriple,
-      platformArchABI: rawTriple,
+      platformArchABI: 'wasm32-wasi',
       platform: 'wasi',
       arch: 'wasm32',
       abi: 'wasi',

package/src/utils/typegen.ts

@@ -10,7 +10,9 @@ export const DEFAULT_TYPE_DEF_HEADER = `/* auto-generated by NAPI-RS */
 enum TypeDefKind {
   Const = 'const',
   Enum = 'enum',
+  StringEnum = 'string_enum',
   Interface = 'interface',
+  Type = 'type',
   Fn = 'fn',
   Struct = 'struct',
   Impl = 'impl',
@@ -25,24 +27,46 @@ interface TypeDefLine {
   js_mod?: string
 }
 
-function prettyPrint(line: TypeDefLine, ident: number): string {
+function prettyPrint(
+  line: TypeDefLine,
+  constEnum: boolean,
+  ident: number,
+  ambient = false,
+): string {
   let s = line.js_doc ?? ''
   switch (line.kind) {
     case TypeDefKind.Interface:
       s += `export interface ${line.name} {\n${line.def}\n}`
       break
 
+    case TypeDefKind.Type:
+      s += `export type ${line.name} = \n${line.def}`
+      break
+
     case TypeDefKind.Enum:
-      s += `export const enum ${line.name} {\n${line.def}\n}`
+      const enumName = constEnum ? 'const enum' : 'enum'
+      s += `${exportDeclare(ambient)} ${enumName} ${line.name} {\n${line.def}\n}`
+      break
+
+    case TypeDefKind.StringEnum:
+      if (constEnum) {
+        s += `${exportDeclare(ambient)} const enum ${line.name} {\n${line.def}\n}`
+      } else {
+        s += `export type ${line.name} = ${line.def.replaceAll(/.*=/g, '').replaceAll(',', '|')};`
+      }
       break
 
     case TypeDefKind.Struct:
-      s += `export class ${line.name} {\n${line.def}\n}`
+      s += `${exportDeclare(ambient)} class ${line.name} {\n${line.def}\n}`
       if (line.original_name && line.original_name !== line.name) {
         s += `\nexport type ${line.original_name} = ${line.name}`
       }
       break
 
+    case TypeDefKind.Fn:
+      s += `${exportDeclare(ambient)} ${line.def}`
+      break
+
     default:
       s += line.def
   }
@@ -50,51 +74,65 @@ function prettyPrint(line: TypeDefLine, ident: number): string {
   return correctStringIdent(s, ident)
 }
 
+function exportDeclare(ambient: boolean): string {
+  if (ambient) {
+    return 'export'
+  }
+
+  return 'export declare'
+}
+
 export async function processTypeDef(
   intermediateTypeFile: string,
+  constEnum: boolean,
   header?: string,
 ) {
   const exports: string[] = []
   const defs = await readIntermediateTypeFile(intermediateTypeFile)
   const groupedDefs = preprocessTypeDef(defs)
 
-  header = header ? header + '\n' : ''
-  let dts = ''
-
-  sortBy(Array.from(groupedDefs), ([namespace]) => namespace).forEach(
-    ([namespace, defs]) => {
-      if (namespace === TOP_LEVEL_NAMESPACE) {
-        for (const def of defs) {
-          dts += prettyPrint(def, 0) + '\n\n'
-          switch (def.kind) {
-            case TypeDefKind.Const:
-            case TypeDefKind.Enum:
-            case TypeDefKind.Fn:
-            case TypeDefKind.Struct: {
-              exports.push(def.name)
-              if (def.original_name && def.original_name !== def.name) {
-                exports.push(def.original_name)
+  header = header ?? ''
+
+  const dts =
+    sortBy(Array.from(groupedDefs), ([namespace]) => namespace)
+      .map(([namespace, defs]) => {
+        if (namespace === TOP_LEVEL_NAMESPACE) {
+          return defs
+            .map((def) => {
+              switch (def.kind) {
+                case TypeDefKind.Const:
+                case TypeDefKind.Enum:
+                case TypeDefKind.StringEnum:
+                case TypeDefKind.Fn:
+                case TypeDefKind.Struct: {
+                  exports.push(def.name)
+                  if (def.original_name && def.original_name !== def.name) {
+                    exports.push(def.original_name)
+                  }
+                  break
+                }
+                default:
+                  break
               }
-              break
-            }
-            default:
-              break
+              return prettyPrint(def, constEnum, 0)
+            })
+            .join('\n\n')
+        } else {
+          exports.push(namespace)
+          let declaration = ''
+          declaration += `export declare namespace ${namespace} {\n`
+          for (const def of defs) {
+            declaration += prettyPrint(def, constEnum, 2, true) + '\n'
           }
+          declaration += '}'
+          return declaration
         }
-      } else {
-        exports.push(namespace)
-        dts += `export namespace ${namespace} {\n`
-        for (const def of defs) {
-          dts += prettyPrint(def, 2) + '\n'
-        }
-        dts += '}\n\n'
-      }
-    },
-  )
+      })
+      .join('\n\n') + '\n'
 
   if (dts.indexOf('ExternalObject<') > -1) {
     header += `
-export class ExternalObject<T> {
+export declare class ExternalObject<T> {
   readonly '': {
     readonly '': unique symbol
     [K: symbol]: T
@@ -186,13 +224,20 @@ export function correctStringIdent(src: string, ident: number): string {
       const isInMultilineComment = line.startsWith('*')
       const isClosingBracket = line.endsWith('}')
       const isOpeningBracket = line.endsWith('{')
+      const isTypeDeclaration = line.endsWith('=')
+      const isTypeVariant = line.startsWith('|')
 
       let rightIndent = ident
-      if (isOpeningBracket && !isInMultilineComment) {
+      if ((isOpeningBracket || isTypeDeclaration) && !isInMultilineComment) {
         bracketDepth += 1
         rightIndent += (bracketDepth - 1) * 2
       } else {
-        if (isClosingBracket && bracketDepth > 0 && !isInMultilineComment) {
+        if (
+          isClosingBracket &&
+          bracketDepth > 0 &&
+          !isInMultilineComment &&
+          !isTypeVariant
+        ) {
           bracketDepth -= 1
         }
         rightIndent += bracketDepth * 2

package/src/utils/version.ts

@@ -7,20 +7,22 @@ export enum NapiVersion {
   Napi6,
   Napi7,
   Napi8,
+  Napi9,
 }
 
 /// because node support new napi version in some minor version updates, so we might meet such situation:
 /// `node v10.20.0` supports `napi5` and `napi6`, but `node v12.0.0` only support `napi4`,
-/// by which, we can not tell directly napi version supportness from node version directly.
+/// by which, we can not tell directly napi version supportless from node version directly.
 const NAPI_VERSION_MATRIX = new Map<NapiVersion, string>([
-  [NapiVersion.Napi1, '8.6.0'],
-  [NapiVersion.Napi2, '8.10.0 | 9.3.0'],
-  [NapiVersion.Napi3, '6.14.2 | 8.11.2 | 9.11.0'],
-  [NapiVersion.Napi4, '10.16.0 | 11.8.0'],
-  [NapiVersion.Napi5, '10.17.0 | 12.11.0'],
+  [NapiVersion.Napi1, '8.6.0 | 9.0.0 | 10.0.0'],
+  [NapiVersion.Napi2, '8.10.0 | 9.3.0 | 10.0.0'],
+  [NapiVersion.Napi3, '6.14.2 | 8.11.2 | 9.11.0 | 10.0.0'],
+  [NapiVersion.Napi4, '10.16.0 | 11.8.0 | 12.0.0'],
+  [NapiVersion.Napi5, '10.17.0 | 12.11.0 | 13.0.0'],
   [NapiVersion.Napi6, '10.20.0 | 12.17.0 | 14.0.0'],
-  [NapiVersion.Napi7, '10.23.0 | 12.19.0 | 14.12.0'],
-  [NapiVersion.Napi8, '12.22.0 | 14.17.0 | 15.12.0'],
+  [NapiVersion.Napi7, '10.23.0 | 12.19.0 | 14.12.0 | 15.0.0'],
+  [NapiVersion.Napi8, '12.22.0 | 14.17.0 | 15.12.0 | 16.0.0'],
+  [NapiVersion.Napi9, '18.17.0 | 20.3.0 | 21.1.0'],
 ])
 
 interface NodeVersion {

package/dist/api/load-wasi-template.d.ts

@@ -1 +0,0 @@
-export declare const createWasiBinding: (wasmFileName: string, wasiRegisterFunctions: string[]) => string;