@napi-rs/cli 3.0.0-alpha.94 → 3.0.0-alpha.95

package/dist/utils/config.d.ts

@@ -95,6 +95,10 @@ export interface CommonPackageJsonFields {
     author?: string;
     authors?: string[];
     license?: string;
+    cpu?: string[];
+    os?: string[];
+    libc?: string[];
+    files?: string[];
     repository?: any;
     homepage?: any;
     engines?: Record<string, string>;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@napi-rs/cli",
-  "version": "3.0.0-alpha.94",
+  "version": "3.0.0-alpha.95",
   "description": "Cli tools for napi-rs",
   "author": "LongYinan <lynweklm@gmail.com>",
   "homepage": "https://github.com/napi-rs/napi-rs",
@@ -132,5 +132,5 @@
       "e2e/**/*.spec.ts"
     ]
   },
-  "gitHead": "08c364f5a76fa5f3b887b3050ffd175d33206a30"
+  "gitHead": "0aa36c39a6cb6b73ce969a33cf4ec04301a1d77a"
 }

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)
+})

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

@@ -13,6 +13,7 @@ import {
   pick,
   writeFileAsync as rawWriteFileAsync,
   Target,
+  type CommonPackageJsonFields,
 } from '../utils/index.js'
 
 const debug = debugFactory('create-npm-dirs')
@@ -65,7 +66,7 @@ export async function createNpmDirs(userOptions: CreateNpmDirsOptions) {
       target.arch === 'wasm32'
         ? `${binaryName}.${target.platformArchABI}.wasm`
         : `${binaryName}.${target.platformArchABI}.node`
-    const scopedPackageJson = {
+    const scopedPackageJson: CommonPackageJsonFields = {
       name: `${packageName}-${target.platformArchABI}`,
       version: packageJson.version,
       cpu: target.arch !== 'universal' ? [target.arch] : undefined,
@@ -80,22 +81,25 @@ export async function createNpmDirs(userOptions: CreateNpmDirsOptions) {
         'homepage',
         'license',
         'engines',
-        'publishConfig',
         'repository',
         'bugs',
       ),
     }
+    if (packageJson.publishConfig) {
+      scopedPackageJson.publishConfig = pick(
+        packageJson.publishConfig,
+        'registry',
+        'access',
+      )
+    }
     if (target.arch !== 'wasm32') {
-      // @ts-expect-error
       scopedPackageJson.os = [target.platform]
     } else {
       const entry = `${binaryName}.wasi.cjs`
       scopedPackageJson.main = entry
-      // @ts-expect-error
       scopedPackageJson.browser = `${binaryName}.wasi-browser.js`
-      scopedPackageJson.files.push(
+      scopedPackageJson.files?.push(
         entry,
-        // @ts-expect-error
         scopedPackageJson.browser,
         `wasi-worker.mjs`,
         `wasi-worker-browser.mjs`,
@@ -121,17 +125,14 @@ export async function createNpmDirs(userOptions: CreateNpmDirsOptions) {
       const wasmRuntime = await fetch(
         `https://registry.npmjs.org/@napi-rs/wasm-runtime`,
       ).then((res) => res.json() as Promise<PackageMeta>)
-      // @ts-expect-error
       scopedPackageJson.dependencies = {
         '@napi-rs/wasm-runtime': `^${wasmRuntime['dist-tags'].latest}`,
       }
     }
 
     if (target.abi === 'gnu') {
-      // @ts-expect-error
       scopedPackageJson.libc = ['glibc']
     } else if (target.abi === 'musl') {
-      // @ts-expect-error
       scopedPackageJson.libc = ['musl']
     }
 

package/src/utils/config.ts

@@ -115,6 +115,10 @@ export interface CommonPackageJsonFields {
   author?: string
   authors?: string[]
   license?: string
+  cpu?: string[]
+  os?: string[]
+  libc?: string[]
+  files?: string[]
   repository?: any
   homepage?: any
   engines?: Record<string, string>