3.5.2 typescript build errors

[jozefchutka]

System Info

• transformers.js: 3.5.2

Environment/Platform

• Website/web-app
• Browser extension
• Server-side (e.g., Node.js, Deno, Bun)
• Desktop app (e.g., Electron)
• Other (e.g., VSCode extension)

Description

Running a very basic typescript build using transformers.js 3.5.2 fails.

Reproduction

package.json:

{
	"devDependencies": {
		"@huggingface/transformers": "^3.5.2"
	}
}

tsconfig.json:

{
	"compilerOptions": {
	  "target": "ESNEXT",
	  "lib": ["ESNext", "WebWorker"],
	  "module": "ESNext",
	  "moduleResolution": "bundler",
	  "baseUrl": "./",
	  "paths": {}
	}
  }

Main.mts

import { AutomaticSpeechRecognitionConfig, env, pipeline, ProgressCallback } from "@huggingface/transformers";

runnig tsc command fails with the following errors:

node_modules/@huggingface/transformers/types/models/auto/processing_auto.d.ts:32:76 - error TS2304: Cannot find name 'PretrainedProcessorOptions'.

32     static from_pretrained(pretrained_model_name_or_path: string, options: PretrainedProcessorOptions): Promise<Processor>;
                                                                              ~~~~~~~~~~~~~~~~~~~~~~~~~~

node_modules/@huggingface/transformers/types/models/mgp_str/processing_mgp_str.d.ts:52:5 - error TS2416: Property 'batch_decode' in type 'MgpstrProcessor' is not assignable to the same property in base type 'Processor'.
  Type '([char_logits, bpe_logits, wp_logits]: Tensor[]) => { generated_text: string[]; scores: number[]; char_preds: string[]; bpe_preds: string[]; wp_preds: string[]; }' is not assignable to type '(batch: number[][] | Tensor, decode_args?: any) => string[]'.
    Types of parameters '__0' and 'batch' are incompatible.
      Type 'number[][] | Tensor' is not assignable to type 'Tensor[]'.
        Type 'number[][]' is not assignable to type 'Tensor[]'.
          Type 'number[]' is missing the following properties from type 'Tensor': dims, type, data, size, and 47 more.

52     batch_decode([char_logits, bpe_logits, wp_logits]: import("../../utils/tensor.js").Tensor[]): {
       ~~~~~~~~~~~~

node_modules/@huggingface/transformers/types/pipelines.d.ts:1393:59 - error TS2304: Cannot find name 'HTMLCanvasElement'.

1393 export type ImageInput = string | RawImage | URL | Blob | HTMLCanvasElement | OffscreenCanvas;
                                                               ~~~~~~~~~~~~~~~~~

node_modules/@huggingface/transformers/types/utils/image.d.ts:18:57 - error TS2304: Cannot find name 'HTMLCanvasElement'.

18     static read(input: RawImage | string | URL | Blob | HTMLCanvasElement | OffscreenCanvas): Promise<RawImage>;
                                                           ~~~~~~~~~~~~~~~~~

node_modules/@huggingface/transformers/types/utils/image.d.ts:24:31 - error TS2304: Cannot find name 'HTMLCanvasElement'.

24     static fromCanvas(canvas: HTMLCanvasElement | OffscreenCanvas): RawImage;
                                 ~~~~~~~~~~~~~~~~~

node_modules/@huggingface/transformers/types/utils/video.d.ts:11:49 - error TS2304: Cannot find name 'HTMLVideoElement'.

11 export function load_video(src: string | Blob | HTMLVideoElement, { num_frames, fps }?: {
                                                   ~~~~~~~~~~~~~~~~

node_modules/onnxruntime-common/dist/esm/tensor-factory.d.ts:203:29 - error TS2304: Cannot find name 'HTMLImageElement'.

203     fromImage(imageElement: HTMLImageElement, options?: TensorFromImageElementOptions): Promise<TypedTensor<'float32'> | TypedTensor<'uint8'>>;
                                ~~~~~~~~~~~~~~~~


Found 7 errors in 6 files.

Errors  Files
     1  node_modules/@huggingface/transformers/types/models/auto/processing_auto.d.ts:32
     1  node_modules/@huggingface/transformers/types/models/mgp_str/processing_mgp_str.d.ts:52
     1  node_modules/@huggingface/transformers/types/pipelines.d.ts:1393
     2  node_modules/@huggingface/transformers/types/utils/image.d.ts:18
     1  node_modules/@huggingface/transformers/types/utils/video.d.ts:11
     1  node_modules/onnxruntime-common/dist/esm/tensor-factory.d.ts:203

This is an extension of #1270 which reported very similiar issues on tjs 3.4.2

[jozefchutka]

A workaround is to (re)declare the problematic instances:

declare global {
	interface HTMLCanvasElement extends EventTarget {readonly _:never;}
	interface HTMLImageElement extends EventTarget {readonly _:never;}
	interface HTMLVideoElement extends EventTarget {readonly _:never;}
	interface Navigator {readonly _:never;}
	type PretrainedProcessorOptions = any;
}

declare module '@huggingface/transformers' {
	export interface MgpstrProcessor {
		batch_decode(...args:any[]):any
	}
}

export {}

[obenjiro]

🎯 Quick Solutions (Choose One)

Option 1: Add Type Declarations (Recommended)

Create a types/global.d.ts file in your project with the declarations provided by @jozefchutka. This gives you full type safety and fixes all errors.

Option 2: Simple TypeScript Config

Update your tsconfig.json to include:

{
  "compilerOptions": {
    "lib": ["ESNext", "DOM"],
    "skipLibCheck": true
  }
}