Non generic types Buffer & Uint8Array

[jvanes-awaze]

After upgrading our project to:

    "typescript": "~5.6.3",
    "@smithy/core": "^3.9.0",

The following errors started showing on running tsc

node_modules/@smithy/core/dist-types/submodules/cbor/cbor-types.d.ts:40:46 - error TS2315: Type 'Uint8Array' is not generic.

40 export declare function alloc(size: number): Uint8Array<ArrayBuffer> | Buffer<ArrayBuffer>;
                                                ~~~~~~~~~~~~~~~~~~~~~~~

node_modules/@smithy/core/dist-types/submodules/cbor/cbor-types.d.ts:40:72 - error TS2315: Type 'Buffer' is not generic.

40 export declare function alloc(size: number): Uint8Array<ArrayBuffer> | Buffer<ArrayBuffer>;
                                                                          ~~~~~~~~~~~~~~~~~~~

node_modules/@smithy/core/dist-types/submodules/cbor/cbor.d.ts:13:28 - error TS2315: Type 'Uint8Array' is not generic.

13     serialize(input: any): Uint8Array<ArrayBufferLike>;

Updating the types seems to resolve the issues

[Lemour-sudo]

Experiencing a similar issue too after upgrading to 3.9.0

[kuhe]

TypeScript's built-in declarations mark Uint8Array as generic for es5 and our target level of es2015. However, it's not our intention to use Uint8Array in a generic way.

The source code is:

export function alloc(size: number) {
  return typeof Buffer !== "undefined" ? Buffer.alloc(size) : new Uint8Array(size);
}

this was compiled by TS into:

export declare function alloc(size: number): Uint8Array<ArrayBuffer> | Buffer<ArrayBuffer>;

This was due to an implicit return type. I will change it to the following:

export function alloc(size: number): Uint8Array {
  return typeof Buffer !== "undefined" ? Buffer.alloc(size) : new Uint8Array(size);
}

export declare function alloc(size: number): Uint8Array;

[kuhe]

The fix was published to https://www.npmjs.com/package/@smithy/core/v/3.9.2

[jldlslopez]

The fix was published to https://www.npmjs.com/package/@smithy/core/v/3.9.2

Error still presents even using v3.9.2:

node_modules/@smithy/core/dist-types/submodules/cbor/cbor.d.ts:13:28 - error TS2315: Type 'Uint8Array' is not generic.

13 serialize(input: any): Uint8Array;

[kuhe]

I see, this might be too widespread to enforce consistently.

What is your tsconfig and what gives your global type definition for Uint8Array?

[jldlslopez]

Uint8Array

tsconfig.json:

{
  "compilerOptions": {
    "target": "ES2020",
    "module": "commonjs",
    "lib": ["es2020", "dom"],
    "declaration": true,
    "strict": true,
    "noImplicitAny": true,
    "strictNullChecks": true,
    "noImplicitThis": true,
    "alwaysStrict": true,
    "noUnusedLocals": false,
    "noUnusedParameters": false,
    "noImplicitReturns": true,
    "noFallthroughCasesInSwitch": false,
    "inlineSourceMap": true,
    "inlineSources": true,
    "experimentalDecorators": true,
    "strictPropertyInitialization": false,
	  "esModuleInterop": true,
    "typeRoots": ["./node_modules/@types"]
  },
  "exclude": ["node_modules", "cdk.out"]
}

package.json dependencies:

"dependencies": {
        "@aws-sdk/client-api-gateway": "^3.787.0",
        "@aws-sdk/client-cloudfront": "^3.787.0",
        "@aws-sdk/client-sts": "^3.787.0",
        "aws-sdk-client-mock": "^3.0.0",
        "@aws-sdk/credential-providers": "^3.787.0",
        "aws-cdk-lib": "2.144.0",
        "constructs": "^10.0.0",
        "fs": "^0.0.1-security",
        "source-map-support": "^0.5.21",
        "uuid": "^11.1.0"
    }

Nothing explicitly configured for Uint8Array in the project.

[kuhe]

if you go to the definition of Uint8Array in your IDE, what package does it open?

[jldlslopez]

When I go to the definition of Uint8Array in my IDE, it opens the file lib.es5.d.ts, which is part of the typescript package.

[kuhe]

Could you update TypeScript to a later version that has this feature? microsoft/TypeScript#59417

This looks like it's available in the 5.7 release. https://github.com/microsoft/TypeScript/blame/release-5.7/src/lib/es5.d.ts

[jamitchellcb]

having the same issue. we were using typescript version 5.4.5 and was only able to fix this by upgrading to 5.9.2 (didn't test 5.7). Please add another condition to your typesVersions so that upgrading our typescript is optional; currently all versions I tested of @smithy/core (3.7.1, 3.8.0, 3.9.0) are broken on older versions of typescript for which they used to work.

[jldlslopez]

Could you update TypeScript to a later version that has this feature? microsoft/TypeScript#59417

This looks like it's available in the 5.7 release. https://github.com/microsoft/TypeScript/blame/release-5.7/src/lib/es5.d.ts

package.json devDependencies updated from

"devDependencies": {
"typescript": "~5.2.2",
...
}

to

"devDependencies": {
"typescript": "~5.7.0",
...
}

Issue was solved!

In resume, the @aws-sdk/core in our project now uses @smithy/core@3.9.2 and we updated the package.json to use typescript v5.7.0

Thanks by your support @kuhe

[Lemour-sudo]

Updating to typescript 5.9.2 helped.

[Juuuub]

Would not recommend, but you could set in tsconfig.json

{
    "compilerOptions": {
        "skipLibCheck": true,
        ...
    },
    ....
}