@napi-rs/cli 3.0.0-alpha.9 → 3.0.0-alpha.91

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',
@@ -29,6 +31,7 @@ function prettyPrint(
   line: TypeDefLine,
   constEnum: boolean,
   ident: number,
+  ambient = false,
 ): string {
   let s = line.js_doc ?? ''
   switch (line.kind) {
@@ -36,18 +39,34 @@ function prettyPrint(
       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:
       const enumName = constEnum ? 'const enum' : 'enum'
-      s += `export ${enumName} ${line.name} {\n${line.def}\n}`
+      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
   }
@@ -55,79 +74,84 @@ function prettyPrint(
   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, constEnum, 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)
+  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, constEnum, 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 {
-    dts: header + dts,
+    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')
+      }
+      // 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 JSON.parse(line) as TypeDefLine
+      return parsed
     })
 
   // move all `struct` def to the very top
@@ -170,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)
@@ -192,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 {

package/dist/api/artifacts.js

@@ -1,53 +0,0 @@
-import { join, parse, resolve } from 'node: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 terms = parsedName.name.split('.');
-        const platformArchABI = terms.pop();
-        const _binaryName = terms.join('.');
-        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;
-}
-//# sourceMappingURL=artifacts.js.map

package/dist/api/artifacts.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"artifacts.js","sourceRoot":"","sources":["../../src/api/artifacts.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,IAAI,EAAE,KAAK,EAAE,OAAO,EAAE,MAAM,WAAW,CAAA;AAEhD,OAAO,KAAK,MAAM,MAAM,WAAW,CAAA;AAEnC,OAAO,EACL,4BAA4B,GAE7B,MAAM,qBAAqB,CAAA;AAC5B,OAAO,EACL,cAAc,EACd,YAAY,EACZ,aAAa,EACb,cAAc,EACd,kBAAkB,EAClB,YAAY,GACb,MAAM,mBAAmB,CAAA;AAE1B,MAAM,KAAK,GAAG,YAAY,CAAC,WAAW,CAAC,CAAA;AAEvC,MAAM,CAAC,KAAK,UAAU,gBAAgB,CAAC,WAA6B;IAClE,MAAM,OAAO,GAAG,4BAA4B,CAAC,WAAW,CAAC,CAAA;IAEzD,MAAM,eAAe,GAAG,OAAO,CAAC,OAAO,CAAC,GAAG,EAAE,OAAO,CAAC,eAAe,CAAC,CAAA;IACrE,MAAM,EAAE,OAAO,EAAE,UAAU,EAAE,GAAG,MAAM,cAAc,CAAC,eAAe,CAAC,CAAA;IAErE,MAAM,QAAQ,GAAG,OAAO,CAAC,GAAG,CAAC,CAAC,QAAQ,EAAE,EAAE,CACxC,OAAO,CAAC,OAAO,CAAC,GAAG,EAAE,OAAO,CAAC,MAAM,EAAE,QAAQ,CAAC,eAAe,CAAC,CAC/D,CAAA;IAED,MAAM,mBAAmB,GAAG,IAAI,GAAG,CACjC,OAAO;SACJ,MAAM,CAAC,CAAC,QAAQ,EAAE,EAAE,CAAC,QAAQ,CAAC,IAAI,KAAK,WAAW,CAAC;SACnD,OAAO,CACN,CAAC,CAAC,EAAE,EAAE,CAAC,kBAAkB,CAAC,CAAC,CAAC,QAAQ,CAAC,EAAE,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,GAAG,CAAC,CAAC,QAAQ,IAAI,CAAC,EAAE,CAAC,CACxE;SACA,MAAM,CAAC,OAAO,CAAa,CAC/B,CAAA;IAED,MAAM,mBAAmB,CAAC,OAAO,CAAC,OAAO,CAAC,GAAG,EAAE,OAAO,CAAC,SAAS,CAAC,CAAC,CAAC,IAAI,CACrE,CAAC,MAAM,EAAE,EAAE,CACT,OAAO,CAAC,GAAG,CACT,MAAM,CAAC,GAAG,CAAC,KAAK,EAAE,QAAQ,EAAE,EAAE;QAC5B,KAAK,CAAC,IAAI,CAAC,SAAS,MAAM,CAAC,YAAY,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAA;QACrD,MAAM,aAAa,GAAG,MAAM,aAAa,CAAC,QAAQ,CAAC,CAAA;QACnD,MAAM,UAAU,GAAG,KAAK,CAAC,QAAQ,CAAC,CAAA;QAClC,MAAM,KAAK,GAAG,UAAU,CAAC,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,CAAA;QACxC,MAAM,eAAe,GAAG,KAAK,CAAC,GAAG,EAAG,CAAA;QACpC,MAAM,WAAW,GAAG,KAAK,CAAC,IAAI,CAAC,GAAG,CAAC,CAAA;QAEnC,IAAI,WAAW,KAAK,UAAU,EAAE;YAC9B,KAAK,CAAC,IAAI,CACR,IAAI,WAAW,0BAA0B,UAAU,SAAS,CAC7D,CAAA;YACD,OAAM;SACP;QACD,MAAM,GAAG,GAAG,QAAQ,CAAC,IAAI,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,GAAG,CAAC,QAAQ,CAAC,eAAe,CAAC,CAAC,CAAA;QACjE,IAAI,CAAC,GAAG,IAAI,mBAAmB,CAAC,GAAG,CAAC,eAAe,CAAC,EAAE;YACpD,KAAK,CAAC,IAAI,CACR,IAAI,eAAe,iEAAiE,CACrF,CAAA;YACD,OAAM;SACP;QACD,IAAI,CAAC,GAAG,EAAE;YACR,MAAM,IAAI,KAAK,CAAC,yBAAyB,QAAQ,EAAE,CAAC,CAAA;SACrD;QAED,MAAM,YAAY,GAAG,IAAI,CAAC,GAAG,EAAE,UAAU,CAAC,IAAI,CAAC,CAAA;QAC/C,KAAK,CAAC,IAAI,CACR,0BAA0B,MAAM,CAAC,YAAY,CAAC,YAAY,CAAC,GAAG,CAC/D,CAAA;QACD,MAAM,cAAc,CAAC,YAAY,EAAE,aAAa,CAAC,CAAA;QACjD,MAAM,iBAAiB,GAAG,IAAI,CAC5B,KAAK,CAAC,eAAe,CAAC,CAAC,GAAG,EAC1B,UAAU,CAAC,IAAI,CAChB,CAAA;QACD,KAAK,CAAC,IAAI,CACR,0BAA0B,MAAM,CAAC,YAAY,CAAC,iBAAiB,CAAC,GAAG,CACpE,CAAA;QACD,MAAM,cAAc,CAAC,iBAAiB,EAAE,aAAa,CAAC,CAAA;IACxD,CAAC,CAAC,CACH,CACJ,CAAA;AACH,CAAC;AAED,KAAK,UAAU,mBAAmB,CAAC,IAAY;IAC7C,MAAM,KAAK,GAAG,MAAM,YAAY,CAAC,IAAI,EAAE,EAAE,aAAa,EAAE,IAAI,EAAE,CAAC,CAAA;IAC/D,MAAM,YAAY,GAAG,KAAK;SACvB,MAAM,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,MAAM,EAAE,IAAI,IAAI,CAAC,IAAI,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAC;SAC9D,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,IAAI,EAAE,IAAI,CAAC,IAAI,CAAC,CAAC,CAAA;IAEvC,MAAM,IAAI,GAAG,KAAK,CAAC,MAAM,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,WAAW,EAAE,CAAC,CAAA;IACvD,KAAK,MAAM,GAAG,IAAI,IAAI,EAAE;QACtB,YAAY,CAAC,IAAI,CAAC,GAAG,CAAC,MAAM,mBAAmB,CAAC,IAAI,CAAC,IAAI,EAAE,GAAG,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,CAAA;KACxE;IACD,OAAO,YAAY,CAAA;AACrB,CAAC"}