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

package/src/utils/target.ts

@@ -1,34 +1,50 @@
-import { execSync } from 'child_process'
+import { execSync } from 'node:child_process'
+
+export type Platform = NodeJS.Platform | 'wasm' | 'wasi' | 'openharmony'
+
+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',
   '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',
 ] 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
 
 export const TARGET_LINKER: Record<string, string> = {
-  'aarch64-unknown-linux-gnu': 'aarch64-linux-gnu-gcc',
-  'armv7-unknown-linux-gnueabihf': 'arm-linux-gnueabihf-gcc',
   '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
@@ -40,17 +56,21 @@ type NodeJSArch =
   | 'mipsel'
   | 'ppc'
   | 'ppc64'
+  | 'riscv64'
   | 's390'
   | 's390x'
   | 'x32'
   | 'x64'
   | 'universal'
+  | 'wasm32'
 
 const CpuToNodeArch: Record<string, NodeJSArch> = {
   x86_64: 'x64',
   aarch64: 'arm64',
   i686: 'ia32',
   armv7: 'arm',
+  riscv64gc: 'riscv64',
+  powerpc64le: 'ppc64',
 }
 
 export const NodeArchToCpu: Record<string, string> = {
@@ -58,25 +78,26 @@ export const NodeArchToCpu: Record<string, string> = {
   arm64: 'aarch64',
   ia32: 'i686',
   arm: 'armv7',
+  riscv64: 'riscv64gc',
+  ppc64: 'powerpc64le',
 }
 
-const SysToNodePlatform: Record<string, NodeJS.Platform> = {
+const SysToNodePlatform: Record<string, Platform> = {
   linux: 'linux',
   freebsd: 'freebsd',
   darwin: 'darwin',
   windows: 'win32',
+  ohos: 'openharmony',
 }
 
-export const UniArchsByPlatform: Partial<
-  Record<NodeJS.Platform, NodeJSArch[]>
-> = {
+export const UniArchsByPlatform: Partial<Record<Platform, NodeJSArch[]>> = {
   darwin: ['x64', 'arm64'],
 }
 
 export interface Target {
   triple: string
   platformArchABI: string
-  platform: NodeJS.Platform
+  platform: Platform
   arch: NodeJSArch
   abi: string | null
 }
@@ -92,6 +113,19 @@ export interface Target {
  *   - `abi` = The ABI, for example `gnu`, `android`, `eabi`, etc.
  */
 export function parseTriple(rawTriple: string): Target {
+  if (
+    rawTriple === 'wasm32-wasi' ||
+    rawTriple === 'wasm32-wasi-preview1-threads' ||
+    rawTriple.startsWith('wasm32-wasip')
+  ) {
+    return {
+      triple: rawTriple,
+      platformArchABI: 'wasm32-wasi',
+      platform: 'wasi',
+      arch: 'wasm32',
+      abi: 'wasi',
+    }
+  }
   const triple = rawTriple.endsWith('eabi')
     ? `${rawTriple.slice(0, -4)}-eabi`
     : rawTriple
@@ -111,8 +145,18 @@ export function parseTriple(rawTriple: string): Target {
     ;[cpu, , sys, abi = null] = triples
   }
 
-  const platform = SysToNodePlatform[sys] ?? (sys as NodeJS.Platform)
+  const platform = SysToNodePlatform[sys] ?? (sys as Platform)
   const arch = CpuToNodeArch[cpu] ?? (cpu as NodeJSArch)
+
+  if (rawTriple.includes('ohos')) {
+    return {
+      triple: rawTriple,
+      platformArchABI: `linux-${arch}-ohos`,
+      platform: 'openharmony',
+      arch,
+      abi: null,
+    }
+  }
   return {
     triple: rawTriple,
     platformArchABI: abi ? `${platform}-${arch}-${abi}` : `${platform}-${arch}`,

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,59 +74,84 @@ 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,
-  header?: string,
+  constEnum: boolean,
 ) {
+  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'
+  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
+              }
+              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 {
-        dts += `export namespace ${namespace} {\n`
-        for (const def of defs) {
-          dts += prettyPrint(def, 2) + '\n'
-        }
-        dts += '}\n\n'
-      }
-    },
-  )
-
-  if (dts.indexOf('ExternalObject<') > -1) {
-    header += `
-export class ExternalObject<T> {
-  readonly '': {
-    readonly '': unique symbol
-    [K: symbol]: T
-  }
-}
-`
-  }
+      })
+      .join('\n\n') + '\n'
 
-  return header + dts
+  return {
+    dts,
+    exports,
+  }
 }
 
 async function readIntermediateTypeFile(file: string) {
   const content = await readFileAsync(file, 'utf8')
+
   const defs = content
     .split('\n')
     .filter(Boolean)
     .map((line) => {
       line = line.trim()
-      if (!line.startsWith('{')) {
-        // crateName:{ "def": "", ... }
-        const start = line.indexOf(':') + 1
-        line = line.slice(start)
+      const parsed = JSON.parse(line) as TypeDefLine
+      // Convert escaped newlines back to actual newlines in js_doc fields
+      if (parsed.js_doc) {
+        parsed.js_doc = parsed.js_doc.replace(/\\n/g, '\n')
       }
-      return JSON.parse(line) as TypeDefLine
+      // Convert escaped newlines to actual newlines in def fields for struct/class/interface/type types
+      // where \n represents method/field separators that should be actual newlines
+      if (parsed.def) {
+        parsed.def = parsed.def.replace(/\\n/g, '\n')
+      }
+      return parsed
     })
 
   // move all `struct` def to the very top
@@ -145,6 +194,10 @@ function preprocessTypeDef(defs: TypeDefLine[]): Map<string, TypeDefLine[]> {
         }
 
         classDef.def += def.def
+        // Convert any remaining \n sequences in the merged def to actual newlines
+        if (classDef.def) {
+          classDef.def = classDef.def.replace(/\\n/g, '\n')
+        }
       }
     } else {
       group.push(def)
@@ -167,13 +220,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 {
@@ -68,7 +70,7 @@ function toEngineRequirement(versions: NodeVersion[]): string {
     requirements.push(req)
   })
 
-  return requirements.join(' && ')
+  return requirements.join(' ')
 }
 
 export function napiEngineRequirement(napiVersion: NapiVersion): string {

package/dist/api/artifacts.js

@@ -1,50 +0,0 @@
-import { join, parse, resolve } from 'path';
-import * as colors from 'colorette';
-import { applyDefaultArtifactsOptions, } from '../def/artifacts.js';
-import { readNapiConfig, debugFactory, readFileAsync, writeFileAsync, UniArchsByPlatform, readdirAsync, } from '../utils/index.js';
-const debug = debugFactory('artifacts');
-export async function collectArtifacts(userOptions) {
-    const options = applyDefaultArtifactsOptions(userOptions);
-    const packageJsonPath = resolve(options.cwd, options.packageJsonPath);
-    const { targets, binaryName } = await readNapiConfig(packageJsonPath);
-    const distDirs = targets.map((platform) => resolve(options.cwd, options.npmDir, platform.platformArchABI));
-    const universalSourceBins = new Set(targets
-        .filter((platform) => platform.arch === 'universal')
-        .flatMap((p) => UniArchsByPlatform[p.platform]?.map((a) => `${p.platform}-${a}`))
-        .filter(Boolean));
-    await collectNodeBinaries(resolve(options.cwd, options.outputDir)).then((output) => Promise.all(output.map(async (filePath) => {
-        debug.info(`Read [${colors.yellowBright(filePath)}]`);
-        const sourceContent = await readFileAsync(filePath);
-        const parsedName = parse(filePath);
-        const [_binaryName, platformArchABI] = parsedName.name.split('.');
-        if (_binaryName !== binaryName) {
-            debug.warn(`[${_binaryName}] is not matched with [${binaryName}], skip`);
-            return;
-        }
-        const dir = distDirs.find((dir) => dir.includes(platformArchABI));
-        if (!dir && universalSourceBins.has(platformArchABI)) {
-            debug.warn(`[${platformArchABI}] has no dist dir but it is source bin for universal arch, skip`);
-            return;
-        }
-        if (!dir) {
-            throw new Error(`No dist dir found for ${filePath}`);
-        }
-        const distFilePath = join(dir, parsedName.base);
-        debug.info(`Write file content to [${colors.yellowBright(distFilePath)}]`);
-        await writeFileAsync(distFilePath, sourceContent);
-        const distFilePathLocal = join(parse(packageJsonPath).dir, parsedName.base);
-        debug.info(`Write file content to [${colors.yellowBright(distFilePathLocal)}]`);
-        await writeFileAsync(distFilePathLocal, sourceContent);
-    })));
-}
-async function collectNodeBinaries(root) {
-    const files = await readdirAsync(root, { withFileTypes: true });
-    const nodeBinaries = files
-        .filter((file) => file.isFile() && file.name.endsWith('.node'))
-        .map((file) => join(root, file.name));
-    const dirs = files.filter((file) => file.isDirectory());
-    for (const dir of dirs) {
-        nodeBinaries.push(...(await collectNodeBinaries(join(root, dir.name))));
-    }
-    return nodeBinaries;
-}