ES modules syntax support?

[sekhavati]

Hello 👋 We use TypeScript throughout our projects. Typically we use ES modules syntax (import/export) to load our modules, this then gets boiled down to CommonJS style (require) after the compiler has run.

It seems this module does not support use of the import/export syntax, is it suppose to?

For example we encounter these sorts of errors:

Working example:

const webhooks = require("gocardless-nodejs/webhooks");

webhooks.parse(...); // ok

Broken example:

import webhooks from "gocardless-nodejs/webhooks";

webhooks.parse(...); // => Runtime TypeError: Cannot read properties of undefined (reading 'parse')

[jacktomlinson]

Just stumbled across this issue as we are having the same issue - feels strange that a package like this would not support ES Modules syntax 🤔

[sohilpandya]

Hey Both, I'm sure you've solved your issues but this is how you'd go about using the library and get the types support.

import { GoCardlessClient } from 'gocardless-nodejs/client';
import Constants from 'gocardless-nodejs/constants';

// Initialise the client.
const gocardless = new GoCardlessClient(
  SECRET,
  Constants.Environments.Live OR Constants.Environments.Sandbox,
);

[SPH73]

Hey Both, I'm sure you've solved your issues but this is how you'd go about using the library and get the types support.

import { GoCardlessClient } from 'gocardless-nodejs/client';
import Constants from 'gocardless-nodejs/constants';

// Initialise the client.
const gocardless = new GoCardlessClient(
  SECRET,
  Constants.Environments.Live OR Constants.Environments.Sandbox,
);

Hi, Thanks for adding your reply - I've been able to get my integration working with Nuxt 3 locally as a result.

In a dev env, it all works great and a payment journey is completed successfully but when I deploy to Netlify, I get an error at the billing-request action stage which I think maybe it's as a result of importing the package as an ESM module.

Apr 18, 12:52:32 PM: d1f10929 ERROR  [nuxt] [request error] [unhandled] [500] Cannot find module '/var/task/node_modules/gocardless-nodejs/client' imported from /var/task/chunks/billing-request.post.mjs
Did you mean to import gocardless-nodejs/client.js?
  at new NodeError (node:internal/errors:387:5)  
  at finalizeResolution (node:internal/modules/esm/resolve:330:11)  
  at moduleResolve (node:internal/modules/esm/resolve:907:10)  
  at defaultResolve (node:internal/modules/esm/resolve:1115:11)  
  at nextResolve (node:internal/modules/esm/loader:163:28)  
  at ESMLoader.resolve (node:internal/modules/esm/loader:841:30)  
  at ESMLoader.getModuleJob (node:internal/modules/esm/loader:424:18)  
  at ModuleWrap.<anonymous> (node:internal/modules/esm/module_job:76:40)  
  at link (node:internal/modules/esm/module_job:75:36)

Would you perhaps be able to comment on this and make a suggestion as to what I could try to do to fix it? I contacted their support but I've not had a response.

TIA

[Arthurmtro]

Did you managed to solve this ? maybe we can close this issue then, thanks @sohilpandya

[TheInfamousGrim]

I've had to downgrade to v4 to get the imports to work. It's 2025 can we please get proper support for ESM

[jamiecobbett]

Thank you everyone for reporting this and for your patience.

I have released a beta version with ESM support (and CJS fallback) here: https://www.npmjs.com/package/gocardless-nodejs/v/beta

I'm also working on improving the README code samples.

If you have time to give it a try, please do so and that will help us get this into a mainstream release.