@napi-rs/cli 3.0.0-alpha.4 → 3.0.0-alpha.40

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

@@ -616,3 +616,558 @@ Generated by [AVA](https://avajs.dev).
     }␊
     ␊
     `
+
+## should process type def with noConstEnum correctly
+
+> Snapshot 1
+
+    `␊
+    export class ExternalObject<T> {␊
+      readonly '': {␊
+        readonly '': unique symbol␊
+        [K: symbol]: T␊
+      }␊
+    }␊
+    /**␊
+     * \`constructor\` option for \`struct\` requires all fields to be public,␊
+     * otherwise tag impl fn as constructor␊
+     * #[napi(constructor)]␊
+     */␊
+    export class Animal {␊
+      /** Kind of animal */␊
+      readonly kind: Kind␊
+      /** This is the constructor */␊
+      constructor(kind: Kind, name: string)␊
+      /** This is a factory method */␊
+      static withKind(kind: Kind): Animal␊
+      get name(): string␊
+      set name(name: string)␊
+      get type(): Kind␊
+      set type(kind: Kind)␊
+      /**␊
+       * This is a␊
+       * multi-line comment␊
+       * with an emoji 🚀␊
+       */␊
+      whoami(): string␊
+      /** This is static... */␊
+      static getDogKind(): Kind␊
+      /**␊
+       * Here are some characters and character sequences␊
+       * that should be escaped correctly:␊
+       * \\[]{}/\\:""{␊
+       * }␊
+       */␊
+      returnOtherClass(): Dog␊
+      returnOtherClassWithCustomConstructor(): Bird␊
+      overrideIndividualArgOnMethod(normalTy: string, overriddenTy: {n: string}): Bird␊
+    }␊
+    ␊
+    export class AnimalWithDefaultConstructor {␊
+      name: string␊
+      kind: number␊
+      constructor(name: string, kind: number)␊
+    }␊
+    ␊
+    export class AnotherClassForEither {␊
+      constructor()␊
+    }␊
+    ␊
+    export class AnotherCssStyleSheet {␊
+      get rules(): CssRuleList␊
+    }␊
+    export type AnotherCSSStyleSheet = AnotherCssStyleSheet␊
+    ␊
+    export class Asset {␊
+      constructor()␊
+      get filePath(): number␊
+    }␊
+    export type JsAsset = Asset␊
+    ␊
+    export class Assets {␊
+      constructor()␊
+      get(id: number): JsAsset | null␊
+    }␊
+    export type JsAssets = Assets␊
+    ␊
+    export class Bird {␊
+      name: string␊
+      constructor(name: string)␊
+      getCount(): number␊
+      getNameAsync(): Promise<string>␊
+    }␊
+    ␊
+    /** Smoking test for type generation */␊
+    export class Blake2BHasher {␊
+      static withKey(key: Blake2bKey): Blake2BHasher␊
+      update(data: Buffer): void␊
+    }␊
+    export type Blake2bHasher = Blake2BHasher␊
+    ␊
+    export class Blake2BKey {␊
+    ␊
+    }␊
+    export type Blake2bKey = Blake2BKey␊
+    ␊
+    export class ClassWithFactory {␊
+      name: string␊
+      static withName(name: string): ClassWithFactory␊
+      setName(name: string): this␊
+    }␊
+    ␊
+    export class Context {␊
+      maybeNeed?: boolean␊
+      buffer: Uint8Array␊
+      constructor()␊
+      static withData(data: string): Context␊
+      static withBuffer(buf: Uint8Array): Context␊
+      method(): string␊
+    }␊
+    ␊
+    export class CssRuleList {␊
+      getRules(): Array<string>␊
+      get parentStyleSheet(): CSSStyleSheet␊
+      get name(): string | null␊
+    }␊
+    export type CSSRuleList = CssRuleList␊
+    ␊
+    export class CssStyleSheet {␊
+      constructor(name: string, rules: Array<string>)␊
+      get rules(): CssRuleList␊
+      anotherCssStyleSheet(): AnotherCssStyleSheet␊
+    }␊
+    export type CSSStyleSheet = CssStyleSheet␊
+    ␊
+    export class CustomFinalize {␊
+      constructor(width: number, height: number)␊
+    }␊
+    ␊
+    export class Dog {␊
+      name: string␊
+      constructor(name: string)␊
+    }␊
+    ␊
+    export class Fib {␊
+      [Symbol.iterator](): Iterator<number, void, number>␊
+      constructor()␊
+    }␊
+    ␊
+    export class Fib2 {␊
+      [Symbol.iterator](): Iterator<number, void, number>␊
+      static create(seed: number): Fib2␊
+    }␊
+    ␊
+    export class Fib3 {␊
+      current: number␊
+      next: number␊
+      constructor(current: number, next: number)␊
+      [Symbol.iterator](): Iterator<number, void, number>␊
+    }␊
+    ␊
+    export class JsClassForEither {␊
+      constructor()␊
+    }␊
+    ␊
+    export class JsRemote {␊
+      name(): string␊
+    }␊
+    ␊
+    export class JsRepo {␊
+      constructor(dir: string)␊
+      remote(): JsRemote␊
+    }␊
+    ␊
+    export class NinjaTurtle {␊
+      name: string␊
+      static isInstanceOf(value: unknown): boolean␊
+      /** Create your ninja turtle! 🐢 */␊
+      static newRaph(): NinjaTurtle␊
+      getMaskColor(): string␊
+      getName(): string␊
+      returnThis(this: this): this␊
+    }␊
+    ␊
+    export class NotWritableClass {␊
+      name: string␊
+      constructor(name: string)␊
+      setName(name: string): void␊
+    }␊
+    ␊
+    export class Optional {␊
+      static optionEnd(required: string, optional?: string | undefined | null): string␊
+      static optionStart(optional: string | undefined | null, required: string): string␊
+      static optionStartEnd(optional1: string | undefined | null, required: string, optional2?: string | undefined | null): string␊
+      static optionOnly(optional?: string | undefined | null): string␊
+    }␊
+    ␊
+    export class Width {␊
+      value: number␊
+      constructor(value: number)␊
+    }␊
+    ␊
+    export interface A {␊
+      foo: number␊
+    }␊
+    ␊
+    export function acceptThreadsafeFunction(func: (err: Error | null, value: number) => any): void␊
+    ␊
+    export function acceptThreadsafeFunctionFatal(func: (value: number) => any): void␊
+    ␊
+    export function acceptThreadsafeFunctionTupleArgs(func: (err: Error | null, arg0: number, arg1: boolean, arg2: string) => any): void␊
+    ␊
+    export function add(a: number, b: number): number␊
+    ␊
+    export enum ALIAS {␊
+      A = 0,␊
+      B = 1␊
+    }␊
+    ␊
+    export interface AliasedStruct {␊
+      a: ALIAS␊
+      b: number␊
+    }␊
+    ␊
+    export interface AllOptionalObject {␊
+      name?: string␊
+      age?: number␊
+    }␊
+    ␊
+    export function appendBuffer(buf: Buffer): Buffer␊
+    ␊
+    export function arrayBufferPassThrough(buf: Uint8Array): Promise<Uint8Array>␊
+    ␊
+    export function asyncMultiTwo(arg: number): Promise<number>␊
+    ␊
+    export function asyncPlus100(p: Promise<number>): Promise<number>␊
+    ␊
+    export function asyncReduceBuffer(buf: Buffer): Promise<number>␊
+    ␊
+    export interface B {␊
+      bar: number␊
+    }␊
+    ␊
+    export function bigintAdd(a: bigint, b: bigint): bigint␊
+    ␊
+    export function bigintFromI128(): bigint␊
+    ␊
+    export function bigintFromI64(): bigint␊
+    ␊
+    export function bigintGetU64AsString(bi: bigint): string␊
+    ␊
+    export function bufferPassThrough(buf: Buffer): Promise<Buffer>␊
+    ␊
+    export interface C {␊
+      baz: number␊
+    }␊
+    ␊
+    export function callbackReturnPromise<T>(functionInput: () => T | Promise<T>, callback: (err: Error | null, result: T) => void): T | Promise<T>␊
+    ␊
+    export function callThreadsafeFunction(callback: (...args: any[]) => any): void␊
+    ␊
+    export function captureErrorInCallback(cb1: () => void, cb2: (arg0: Error) => void): void␊
+    ␊
+    export function chronoDateAdd1Minute(input: Date): Date␊
+    ␊
+    export function chronoDateToMillis(input: Date): number␊
+    ␊
+    export function concatLatin1(s: string): string␊
+    ␊
+    export function concatStr(s: string): string␊
+    ␊
+    export function concatUtf16(s: string): string␊
+    ␊
+    export function contains(source: string, target: string): boolean␊
+    ␊
+    export function convertU32Array(input: Uint32Array): Array<number>␊
+    ␊
+    export function createBigInt(): bigint␊
+    ␊
+    export function createBigIntI64(): bigint␊
+    ␊
+    export function createExternal(size: number): ExternalObject<number>␊
+    ␊
+    export function createExternalString(content: string): ExternalObject<string>␊
+    ␊
+    export function createExternalTypedArray(): Uint32Array␊
+    ␊
+    export function createObj(): object␊
+    ␊
+    export function createObjectWithClassField(): ObjectFieldClassInstance␊
+    ␊
+    export function createObjWithProperty(): { value: ArrayBuffer, get getter(): number }␊
+    ␊
+    export function createSymbol(): symbol␊
+    ␊
+    /** You could break the step and for an new continuous value. */␊
+    export enum CustomNumEnum {␊
+      One = 1,␊
+      Two = 2,␊
+      Three = 3,␊
+      Four = 4,␊
+      Six = 6,␊
+      Eight = 8,␊
+      Nine = 9,␊
+      Ten = 10␊
+    }␊
+    ␊
+    export function customStatusCode(): void␊
+    ␊
+    export interface Dates {␊
+      start: Date␊
+      end?: Date␊
+    }␊
+    ␊
+    export function dateToNumber(input: Date): number␊
+    ␊
+    /** This is a const */␊
+    export const DEFAULT_COST: number␊
+    ␊
+    export function derefUint8Array(a: Uint8Array, b: Uint8ClampedArray): number␊
+    ␊
+    export function either3(input: string | number | boolean): number␊
+    ␊
+    export function either4(input: string | number | boolean | Obj): number␊
+    ␊
+    export function eitherBoolOrFunction(input: boolean | ((...args: any[]) => any)): void␊
+    ␊
+    export function eitherFromObjects(input: A | B | C): string␊
+    ␊
+    export function eitherFromOption(): JsClassForEither | undefined␊
+    ␊
+    export function eitherStringOrNumber(input: string | number): number␊
+    ␊
+    export enum Empty {␊
+    ␊
+    }␊
+    ␊
+    export function enumToI32(e: CustomNumEnum): number␊
+    ␊
+    export function fibonacci(n: number): number␊
+    ␊
+    export function fnReceivedAliased(s: AliasedStruct, e: ALIAS): void␊
+    ␊
+    export function getBuffer(): Buffer␊
+    ␊
+    export function getCwd(callback: (arg0: string) => void): void␊
+    ␊
+    export function getEmptyBuffer(): Buffer␊
+    ␊
+    export function getExternal(external: ExternalObject<number>): number␊
+    ␊
+    export function getGlobal(): typeof global␊
+    ␊
+    export function getMapping(): Record<string, number>␊
+    ␊
+    export function getNestedNumArr(): number[][][]␊
+    ␊
+    export function getNull(): null␊
+    ␊
+    export function getNumArr(): number[]␊
+    ␊
+    /** Gets some numbers */␊
+    export function getNums(): Array<number>␊
+    ␊
+    export function getPackageJsonName(packageJson: PackageJson): string␊
+    ␊
+    export function getStrFromObject(): void␊
+    ␊
+    export function getterFromObj(): number␊
+    ␊
+    export function getUndefined(): void␊
+    ␊
+    export function getWords(): Array<string>␊
+    ␊
+    /** default enum values are continuos i32s start from 0 */␊
+    export enum Kind {␊
+      /** Barks */␊
+      Dog = 0,␊
+      /** Kills birds */␊
+      Cat = 1,␊
+      /** Tasty */␊
+      Duck = 2␊
+    }␊
+    ␊
+    export function listObjKeys(obj: object): Array<string>␊
+    ␊
+    export function mapOption(val?: number | undefined | null): number | null␊
+    ␊
+    export function mutateExternal(external: ExternalObject<number>, newVal: number): void␊
+    ␊
+    export function mutateTypedArray(input: Float32Array): void␊
+    ␊
+    export interface Obj {␊
+      v: string | number␊
+    }␊
+    ␊
+    export interface ObjectFieldClassInstance {␊
+      bird: Bird␊
+    }␊
+    ␊
+    export interface ObjectOnlyFromJs {␊
+      count: number␊
+      callback: (err: Error | null, value: number) => any␊
+    }␊
+    ␊
+    export function optionEnd(callback: (arg0: string, arg1?: string | undefined | null) => void): void␊
+    ␊
+    export function optionOnly(callback: (arg0?: string | undefined | null) => void): void␊
+    ␊
+    export function optionStart(callback: (arg0: string | undefined | null, arg1: string) => void): void␊
+    ␊
+    export function optionStartEnd(callback: (arg0: string | undefined | null, arg1: string, arg2?: string | undefined | null) => void): void␊
+    ␊
+    export function overrideIndividualArgOnFunction(notOverridden: string, f: () => string, notOverridden2: number): string␊
+    ␊
+    export function overrideIndividualArgOnFunctionWithCbArg(callback: (town: string, name?: string | undefined | null) => string, notOverridden: number): object␊
+    ␊
+    /** This is an interface for package.json */␊
+    export interface PackageJson {␊
+      name: string␊
+      /** The version of the package */␊
+      version: string␊
+      dependencies?: Record<string, any>␊
+      devDependencies?: Record<string, any>␊
+    }␊
+    ␊
+    export function panic(): void␊
+    ␊
+    export function plusOne(this: Width): number␊
+    ␊
+    export function promiseInEither(input: number | Promise<number>): Promise<boolean>␊
+    ␊
+    /** napi = { version = 2, features = ["serde-json"] } */␊
+    export function readFile(callback: (arg0: Error | undefined, arg1?: string | undefined | null) => void): void␊
+    ␊
+    export function readFileAsync(path: string): Promise<Buffer>␊
+    ␊
+    export function readPackageJson(): PackageJson␊
+    ␊
+    export function receiveAllOptionalObject(obj?: AllOptionalObject | undefined | null): void␊
+    ␊
+    export function receiveClassOrNumber(either: number | JsClassForEither): number␊
+    ␊
+    export function receiveDifferentClass(either: JsClassForEither | AnotherClassForEither): number␊
+    ␊
+    export function receiveMutClassOrNumber(either: number | JsClassForEither): number␊
+    ␊
+    export function receiveObjectOnlyFromJs(obj: { count: number, callback: (err: Error | null, count: number) => void }): void␊
+    ␊
+    export function receiveObjectWithClassField(object: ObjectFieldClassInstance): Bird␊
+    ␊
+    export function receiveStrictObject(strictObject: StrictObject): void␊
+    ␊
+    export function receiveString(s: string): string␊
+    ␊
+    export function returnEither(input: number): string | number␊
+    ␊
+    export function returnEitherClass(input: number): number | JsClassForEither␊
+    ␊
+    export function returnJsFunction(): (...args: any[]) => any␊
+    ␊
+    export function returnNull(): null␊
+    ␊
+    export function returnUndefined(): void␊
+    ␊
+    export function returnUndefinedIfInvalid(input: boolean): boolean␊
+    ␊
+    export function returnUndefinedIfInvalidPromise(input: Promise<boolean>): Promise<boolean>␊
+    ␊
+    export function roundtripStr(s: string): string␊
+    ␊
+    export function runScript(script: string): unknown␊
+    ␊
+    export function setSymbolInObj(symbol: symbol): object␊
+    ␊
+    export interface StrictObject {␊
+      name: string␊
+    }␊
+    ␊
+    export function sumMapping(nums: Record<string, number>): number␊
+    ␊
+    export function sumNums(nums: Array<number>): number␊
+    ␊
+    export function testSerdeRoundtrip(data: any): any␊
+    ␊
+    export function threadsafeFunctionClosureCapture(func: (...args: any[]) => any): void␊
+    ␊
+    export function threadsafeFunctionFatalMode(cb: (...args: any[]) => any): void␊
+    ␊
+    export function threadsafeFunctionFatalModeError(cb: (...args: any[]) => any): void␊
+    ␊
+    export function threadsafeFunctionThrowError(cb: (...args: any[]) => any): void␊
+    ␊
+    export function throwError(): void␊
+    ␊
+    export function toJsObj(): object␊
+    ␊
+    export function tsfnAsyncCall(func: (...args: any[]) => any): Promise<void>␊
+    ␊
+    export function tsfnCallWithCallback(func: (...args: any[]) => any): void␊
+    ␊
+    export function tsRename(a: { foo: number }): string[]␊
+    ␊
+    export interface TsTypeChanged {␊
+      typeOverride: object␊
+      typeOverrideOptional?: object␊
+    }␊
+    ␊
+    export function validateArray(arr: Array<number>): number␊
+    ␊
+    export function validateBigint(input: bigint): bigint␊
+    ␊
+    export function validateBoolean(i: boolean): boolean␊
+    ␊
+    export function validateBuffer(b: Buffer): number␊
+    ␊
+    export function validateDate(d: Date): number␊
+    ␊
+    export function validateDateTime(d: Date): number␊
+    ␊
+    export function validateExternal(e: ExternalObject<number>): number␊
+    ␊
+    export function validateFunction(cb: () => number): number␊
+    ␊
+    export function validateHashMap(input: Record<string, number>): number␊
+    ␊
+    export function validateNull(i: null): boolean␊
+    ␊
+    export function validateNumber(i: number): number␊
+    ␊
+    export function validateOptional(input1?: string | undefined | null, input2?: boolean | undefined | null): boolean␊
+    ␊
+    export function validatePromise(p: Promise<number>): Promise<number>␊
+    ␊
+    export function validateString(s: string): string␊
+    ␊
+    export function validateSymbol(s: symbol): boolean␊
+    ␊
+    export function validateTypedArray(input: Uint8Array): number␊
+    ␊
+    export function validateUndefined(i: undefined): boolean␊
+    ␊
+    export function withAbortController(a: number, b: number, signal: AbortSignal): Promise<number>␊
+    ␊
+    export function withoutAbortController(a: number, b: number): Promise<number>␊
+    ␊
+    export function xxh64Alias(input: Buffer): bigint␊
+    ␊
+    export namespace xxh2 {␊
+      export function xxh2Plus(a: number, b: number): number␊
+      export function xxh3Xxh64Alias(input: Buffer): bigint␊
+    }␊
+    ␊
+    export namespace xxh3 {␊
+      /** Xxh3 class */␊
+      export class Xxh3 {␊
+        constructor()␊
+        /** update */␊
+        update(input: Buffer): void␊
+        digest(): bigint␊
+      }␊
+      export const ALIGNMENT: number␊
+      /** xxh128 function */␊
+      export function xxh128(input: Buffer): bigint␊
+      export function xxh3_64(input: Buffer): bigint␊
+    }␊
+    ␊
+    `

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',
-      '>= 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',
+      '>= 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 < 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)
+})