tsx fails to load @credo-ts/drizzle-storage: import.meta.dirname is undefined

[Patrik-Stas]

After upgrading from alpha version to recent release, I started to have problem with running the code using tsx.

Reproduction is as simple as running this

import { DrizzleStorageModule } from '@credo-ts/drizzle-storage';

const drizzleModule = new DrizzleStorageModule({
  // @ts-ignore
  database: undefined,
  bundles: [],
});

with tsx ( I've created repo https://github.com/Patrik-Stas/tsx-credo-06-reproduction/tree/main so you can just checkout and run pnpm run test )
This produces output

pnpm run test

> tsx-credo-06-reproduction@1.0.0 test /Users/patrik/dev/foobar/project/tsx-credo-06-reproduction
> tsx src/index.ts

/Users/patrik/dev/foobar/project/tsx-credo-06-reproduction/node_modules/.pnpm/@credo-ts+drizzle-storage@0.6.0-alpha-20251128133214_@hyperledger+anoncreds-shared@0.3._de4f30d7974941e97c44732dbbbc5bba/node_modules/@credo-ts/drizzle-storage/build/util.mjs:4
const addSchemaExtension = (path) => dirname.endsWith("/src") ? `${path}.ts` : `${path}.mjs`;
                                             ^

TypeError: Cannot read properties of undefined (reading 'endsWith')
    at addSchemaExtension (/Users/patrik/dev/foobar/project/tsx-credo-06-reproduction/node_modules/.pnpm/@credo-ts+drizzle-storage@0.6.0-alpha-20251128133214_@hyperledger+anoncreds-shared@0.3._de4f30d7974941e97c44732dbbbc5bba/node_modules/@credo-ts/drizzle-storage/build/util.mjs:4:46)
    at bundleMigrationDefinition (/Users/patrik/dev/foobar/project/tsx-credo-06-reproduction/node_modules/.pnpm/@credo-ts+drizzle-storage@0.6.0-alpha-20251128133214_@hyperledger+anoncreds-shared@0.3._de4f30d7974941e97c44732dbbbc5bba/node_modules/@credo-ts/drizzle-storage/build/util.mjs:7:15)
    at <anonymous> (/Users/patrik/dev/foobar/project/tsx-credo-06-reproduction/node_modules/.pnpm/@credo-ts+drizzle-storage@0.6.0-alpha-20251128133214_@hyperledger+anoncreds-shared@0.3._de4f30d7974941e97c44732dbbbc5bba/node_modules/@credo-ts/drizzle-storage/build/core/bundle.mjs:26:14)
    at Object.<anonymous> (/Users/patrik/dev/foobar/project/tsx-credo-06-reproduction/node_modules/.pnpm/@credo-ts+drizzle-storage@0.6.0-alpha-20251128133214_@hyperledger+anoncreds-shared@0.3._de4f30d7974941e97c44732dbbbc5bba/node_modules/@credo-ts/drizzle-storage/build/core/bundle.mjs:27:1)
    at Module._compile (node:internal/modules/cjs/loader:1546:14)
    at Object.transformer (/Users/patrik/dev/foobar/project/tsx-credo-06-reproduction/node_modules/.pnpm/tsx@4.21.0/node_modules/tsx/dist/register-D46fvsV_.cjs:3:1104)
    at Module.load (node:internal/modules/cjs/loader:1318:32)
    at Function._load (node:internal/modules/cjs/loader:1128:12)
    at TracingChannel.traceSync (node:diagnostics_channel:315:14)
    at wrapModuleLoad (node:internal/modules/cjs/loader:218:24)

Node.js v22.11.0

The problem refers to file packages/drizzle-storage/src/util.ts specifically line
export const dirname = import.meta.dirname that was added on 11th of October.

The issue is probably related to following PR on 27th November
#2539

based on which alpha versions work with/without issue

0.6.0-alpha-20251117150036 OK
0.6.0-alpha-20251118085559 OK
0.6.0-alpha-20251121023030 OK
0.6.0-alpha-20251127043254 OK

0.6.0-alpha-20251128133214 XX

I am not sure if this is actually concern of credo-ts. Maybe just wrong configuration on my end, or expected behavior related exclusive ESM support? Anyway any thoughts appreicated~

Thank you.

[TimoGlastra]

Adding "type": "module" to your package.json or changing src/index.ts to src/index.mts should work.

However we might want to address this in Credo. Not exactly sure how to do it though. If you're not using ESM, the import.meta object will be undefined. But I've also had issues with parsers rejecting __dirname (Even if uses as a fallbak).

But maybe we can try doing something like:

const dirname = import.meta.dirname ?? __dirname

And see if that works?

Otherwise we'd need to add a specific export (in packge.json exports) for require (which uses __dirname) vs import (which uses import.meta.dirname)

[Patrik-Stas]

Hey @TimoGlastra thank you, yes that works, but interestingly switching "type": "module" started to trigger runtime errors when creating DIDs

did creation result {"didDocumentMetadata":{},"didRegistrationMetadata":{},"didState":{"state":"failed","reason":"unknownError: Error creating key"}}
Error details: Error: DID not created, didCreateResult: {"didDocumentMetadata":{},"didRegistrationMetadata":{},"didState":{"state":"failed","reason":"unknownError: Error creating key"}}

This seems to be regardless of credo version, happens on older 0.6 alpha versions as well, as long as "type": "module" is set in my package.

[TimoGlastra]

And does it also happen if you do not set the type, but add .mts extensions?

Can you provide an updated reproduction? And maybe figure out the underlying error? "Error creating key" -> which KMS backend are you using?

[Patrik-Stas]

Updated the main branch (commit 13df6845bc4dc8c1671bf00698deed1658d10473 ) on reproduction repo https://github.com/Patrik-Stas/tsx-credo-06-reproduction/tree/main

If you run pnpm run test you should see in output

[ERROR] DID not created, didCreateResult: {
  "didDocumentMetadata": {},
  "didRegistrationMetadata": {},
  "didState": {
    "state": "failed",
    "reason": "unknownError: Error creating key"
  }
}
[ERROR] ❌ Script failed with error

but if you remove type: module it should succeed

[INFO] ✅ DID key created successfully
[INFO]   DID: did:key:z6MkfnXzhM8iivsgd9774ZHCqKcXDkBEVnY9jwb2BQUFWqfH
[INFO]   KID: did:key:z6MkfnXzhM8iivsgd9774ZHCqKcXDkBEVnY9jwb2BQUFWqfH#z6MkfnXzhM8iivsgd9774ZHCqKcXDkBEVnY9jwb2BQUFWqfH
[INFO] ✅ Script completed successfully

The repo is using simplest possible agent

    const agent = new Agent({
      config: {
        logger: new SimpleLogger(logLevel),
      },
      dependencies: agentDependencies,
      modules: {
        askar: new AskarModule({
          askar: askar,
          store: {
            id: walletId,
            key: walletKey,
          },
          enableKms: true,
          enableStorage: true, // Use Askar's default SQLite storage
        }),
      },
    });

[Patrik-Stas]

I am also getting same issue if I use .mts without type: module