TS declaration error: Type 'IndexNames<DBTypes, StoreName>' does not satisfy the constraint 'string'

[sumbricht]

When compiling any project that relies on the idb library, I'm getting the following TypeScript error:
Error: node_modules/idb/build/entry.d.ts:359:45 - error TS2344: Type 'IndexNames<DBTypes, StoreName>' does not satisfy the constraint 'string'

Looking at entry.d.ts, this error is actually correct.
The error occurs in the property definition of indexNames:

export interface IDBPObjectStore<DBTypes extends DBSchema | unknown = unknown, StoreName extends StoreNames<DBTypes> = StoreNames<DBTypes>, Mode extends IDBTransactionMode = 'readonly'> extends IDBPObjectStoreExtends {
    readonly indexNames: TypedDOMStringList<IndexNames<DBTypes, StoreName>>;
    [..]
}

TypesDOMStringList<T extends string>expects IndexedNames to be of assignable to string but this turns out to be string | number due to the way IndexedNames is defined. The expression keyof DBTypes[StoreName]['indexes'] is unfortunately string | number even if it should intuitively be string only.

To verify this, let's look at a simplified example:

interface KeyValue {
    [s: string]: any;
}
type Key = keyof KeyValue // you'd expect `string` here, but it's `string | number`

To solve the problem, I propose changing the type IndexNames from
export declare type IndexNames<DBTypes extends DBSchema | unknown, StoreName extends StoreNames<DBTypes>> = DBTypes extends DBSchema ? keyof DBTypes[StoreName]['indexes'] : string;
to
export declare type IndexNames<DBTypes extends DBSchema | unknown, StoreName extends StoreNames<DBTypes>> = DBTypes extends DBSchema ? keyof DBTypes[StoreName]['indexes'] & string : string;

As it's a very quick fix it may be easier for you to just do it; if you'd like a PR, just let me know :-).

Thanks a lot for your help and the great work on this library!

[caboodal]

I'm also getting this issue but only after upgrading typescript to 5.4.5 from 5.2.2: -

X [ERROR] TS2344: Type 'IndexNames<DBTypes, StoreName>' does not satisfy the constraint 'string'.
Type 'string | number' is not assignable to type 'string'.
Type 'number' is not assignable to type 'string'. [plugin angular-compiler]

node_modules/idb/build/entry.d.ts:359:44:
  359 │ ...y indexNames: TypedDOMStringList<IndexNames<DBTypes, StoreName>>;

[philkunz]

+1

[simondingle]

+1

[philkunz]

"@tempfix/idb": "^8.0.3" solves the problem for now by implementing the fix suggested above.

[lee-stevens]

+1

[shruggr]

+1

[ksmit]

+1

[n0daft]

+1

First of all, thanks for maintaining this neat project.

We have an angular app which should be updated to v18. Angular v18 requires ts version to be >=5.4.0 <5.5.0. We are experiencing the same behaviour as described starting with ts 5.4.x, meaning our ng update is blocked.

Is there any update on this? I see there is a fix by switching the to @tempfix/idb but if this is getting solved any time in the near future I rather stick with the original library.

[tambor81]

+1

[tambor81]

As it's a very quick fix it may be easier for you to just do it; if you'd like a PR, just let me know :-).

Would you be so kind to make the PR?
Now we are upgrading to the latest Angular version17 and 18 and also upgrading typescript this compiling error you found is appearing, it'd be awesome if you could get the credit for your solution.

[y-reut]

+1

[AlexandraGae]

+1
It also blocks the migration to Angular 18 of my project.
The fix contained in "@tempfix/idb": "^8.0.3" works for now but we won't go live with this temp version. Is it planned to create a new version soon?
Thanks in advance :)

[elisheva-vol]

+1

[uaKorona]

+1

[5Gears0Chill]

+1

[elisheva-vol]

any update?

[oliviercochet]

Maybe someone may create the PR in tagging the issuer for credit?

[shruggr]

I tried to do that today, but only the dust folder is available from the npm package, so I don’t have the code for the fix.

…

On Thu, Oct 3, 2024 at 9:48 AM, oliviercochet ***@***.***(mailto:On Thu, Oct 3, 2024 at 9:48 AM, oliviercochet <<a href=)> wrote: Maybe someone may create the PR in tagging the issuer for credit? — Reply to this email directly, [view it on GitHub](#311 (comment)), or [unsubscribe](https://github.com/notifications/unsubscribe-auth/ABRT6JVM6AOQX3EKGMGXCM3ZZVDLNAVCNFSM6AAAAABG6KMCC6VHI2DSMVQWIX3LMV43OSLTON2WKQ3PNVWWK3TUHMZDGOJRGQ3TIMRRGM). You are receiving this because you commented.Message ID: ***@***.***>

[uaKorona]

Any updates ? I'm also blocked with angular 18v updating ...

[uaKorona]

I asked Copilot - is it possible to solve this problem locally ?

It proposed to override typing of the idb lib locally

1. Add into tsconfig a reference to local types

"typeRoots": ["./custom-types", "node_modules/@types"]

2. Redefine types in ./custom-types/my-idb.d.ts (for example)

// Declare the module to augment it
declare module 'idb' {

  export type IndexNames<
    DBTypes extends DBSchema | unknown,
    StoreName extends StoreNames<DBTypes>,
  > = DBTypes extends DBSchema ? keyof DBTypes[StoreName]['indexes'] : string | number;
}

3. Restart your typescript server. Joy )

However, this approach didn't work for me )). Maybe I'm doing something wrong, or perhaps locally overriding typings isn't possible at all?

[aaronshaf]

@uaKorona I don't see the PR for this, did you intend that with the branch?

[uaKorona]

@uaKorona I don't see the PR for this, did you intend that with the branch?

No, I’ve made a personal fork with a minimal fix and am waiting for the official resolution.

[sumbricht]

FYI, as the original poster I considered creating a PR, but my confidence that it'll get merged is a bit on the low side as there hasn't been a commit since Dec 1, 2023.

Anyway, suffering with this issue I got to know a very handy package that I'd like to share: patch-package. Just apply any hotfix directly in the node_modules folder and then run patch-package to create a patch file:

npx patch-package idb

This will create a file patches/idb+8.0.0.patch with the following content:

diff --git a/node_modules/idb/build/entry.d.ts b/node_modules/idb/build/entry.d.ts
index febdcf4..7651ec4 100644
--- a/node_modules/idb/build/entry.d.ts
+++ b/node_modules/idb/build/entry.d.ts
@@ -103,7 +103,7 @@ export declare type StoreKey<DBTypes extends DBSchema | unknown, StoreName exten
  * @template DBTypes DB schema type, or unknown if the DB isn't typed.
  * @template StoreName Names of the object stores to get the types of.
  */
-export declare type IndexNames<DBTypes extends DBSchema | unknown, StoreName extends StoreNames<DBTypes>> = DBTypes extends DBSchema ? keyof DBTypes[StoreName]['indexes'] : string;
+export declare type IndexNames<DBTypes extends DBSchema | unknown, StoreName extends StoreNames<DBTypes>> = DBTypes extends DBSchema ? keyof DBTypes[StoreName]['indexes'] & string : string;
 /**
  * Extract the types of indexes in certain object stores from the DB schema type.
  *

To apply the fixes in all your patch files (e.g. after a fresh install of node_modules), either manually run npx patch-package or put it into a postinstall script.

Hope this helps mitigate the pain / include such fixing into your CI pipeline ;-).

[aaronshaf]

@uaKorona if you could create a PR with your commit, that'd be great!