TypeScript Declarations

[romw314]

This package does not have TypeScript Declarations, and I would like to use TypeScript instead of JavaScript and APIs without declarations are unusable with TypeScript. These declarations could either be integrated into this repo or into the DefinitelyTyped/DefinitelyTyped repo.

[ZiuChen]

I've simply written a .d.ts file that runs very well on my project.
Add this ncc.d.ts to your project:

/** Type definition for asset object */
interface Asset {
  /** Asset file content */
  source: Buffer | string
  /** File permissions */
  permissions?: number
  /** Symbolic links */
  symlinks?: string[]
}

/** NCC build result */
interface BuildResult {
  /** Compiled code */
  code: string
  /** Source map content */
  map?: string
  /** Asset file objects, key is filename, value is asset object */
  assets?: Record<string, Asset>
}

/** NCC configuration options */
interface NCCOptions {
  /**
   * Whether to output ES module format
   * @default false
   */
  esm?: boolean

  /**
   * Custom cache path or disable cache
   * @default "./ncc-cache"
   */
  cache?: string | false

  /**
   * List of external dependencies that will not be bundled, kept as require calls
   * @default []
   */
  externals?: string[]

  /**
   * Limit the directory scope for asset file output
   * @default process.cwd()
   */
  filterAssetBase?: string

  /**
   * Whether to minify output code
   * @default false
   */
  minify?: boolean

  /**
   * Whether to generate source map
   * @default false
   */
  sourceMap?: boolean

  /**
   * Whether to build asset files
   * @default false
   */
  assetBuilds?: boolean

  /**
   * Base path prefix for source map
   * @default "../"
   */
  sourceMapBasePrefix?: string

  /**
   * Whether to automatically include source-map-support library when outputting source map (adds ~32kB)
   * @default true
   */
  sourceMapRegister?: boolean

  /**
   * Whether to enable watch mode, automatically rebuild on file changes
   * @default false
   */
  watch?: boolean

  /**
   * License file content, leave empty to not generate license file
   * @default ""
   */
  license?: string

  /**
   * Compilation target JavaScript version
   * @default "es2015"
   */
  target?: string

  /**
   * Whether to use V8 code cache
   * @default false
   */
  v8cache?: boolean

  /**
   * Whether to enable quiet mode (no log output)
   * @default false
   */
  quiet?: boolean

  /**
   * Whether to enable debug logging
   * @default false
   */
  debugLog?: boolean
}

/** Handler parameters in watch mode */
interface WatchBuildResult extends BuildResult {
  /** Error occurred during build process */
  err?: Error
}

/** Build object in watch mode */
interface WatchBuild {
  /**
   * Handler called on each build completion
   * @param callback Receives an object containing err, code, map, assets
   */
  handler(callback: (result: WatchBuildResult) => void): void

  /**
   * Handler called when each rebuild starts
   */
  rebuild(callback: () => void): void

  /**
   * Close the watcher
   */
  close(): Promise<void>
}

declare module '@vercel/ncc' {
  /**
   * Vercel NCC - Compile Node.js project into a single file
   * @param input Input file or directory path
   * @param options Build options
   * @returns If watch is false, returns a Promise containing build result; if watch is true, returns an object containing handler, rebuild, close
   */
  function ncc(input: string, options?: NCCOptions & { watch?: false }): Promise<BuildResult>

  function ncc(input: string, options: NCCOptions & { watch: true }): WatchBuild

  function ncc(input: string, options?: NCCOptions): Promise<BuildResult> | WatchBuild

  export = ncc
}