src: convert project from CJS to ESM

[cjihrig]

This is a substantial change that moves the release-1.x branch from CommonJS to ESM as discussed in
#2014. Please review/test carefully.

This commit does the following things:

• Updates the tsconfig to generate ESM code. The formatter also automatically formatted this file.
• Add "type": "module" to the package.json so that consumers treat this as ESM instead of CJS.
• Updates all of the imports to be valid ESM imports. ESM requires that file extensions are provided. TypeScript is smart enough to handle the .js extensions, but TypeScript does not support adding the extensions at build time. See Provide a way to add the '.js' file extension to the end of module specifiers microsoft/TypeScript#16577 for more details about this. The tsc-esm-fix utility on npm was used to automatically add the extensions. The code generator probably needs to add support for this too if it doesn't already.
• Fixup the jsonpath imports, as this module does not have a default ESM export. This just means adding * as to the existing imports.
• Remove the AbortError export originating from node-fetch. Apparently this is not actually there.

I was able to successfully import the transpiled code using import * as k8s from './dist/index.js';. This should hopefully unblock running tests against the transpiled code as well (it currently does not work because the openid-client and chai dependencies have both moved to ESM only).

[brendandburns]

Thanks for doing this. We do need to make the changes for upstream code in the upstream generator here:

https://github.com/OpenAPITools/openapi-generator/tree/master/modules/openapi-generator/src/main/resources/typescript-fetch

Because otherwise we'll overwrite these changes next time we regenerate.

[cjihrig]

Oh, it looks like this might already be supported upstream: OpenAPITools/openapi-generator#15440

[brendandburns]

Ah, cool, then we just need to update here:

https://github.com/kubernetes-client/gen/blob/master/openapi/typescript-fetch.xml#L26

To add that configuration.

[cjihrig]

I ran the generator locally with the importFileExtension setting and then cherry-picked the resulting update on top of this branch. I encountered the following conflict:

diff --cc src/gen/http/http.ts
index 748aa4a2,cc9bdfbb..00000000
--- a/src/gen/http/http.ts
+++ b/src/gen/http/http.ts
@@@ -1,8 -1,8 +1,15 @@@
  // TODO: evaluate if we can easily get rid of this library
++<<<<<<< HEAD
 +import  FormData from "form-data";
 +import { URL, URLSearchParams } from 'url';
 +import * as http from 'http';
 +import * as https from 'https';
++=======
+ import  FormData from "form-data.js";
+ import { URL, URLSearchParams } from 'url.js';
+ import * as http from 'http.js';
+ import * as https from 'https.js';
++>>>>>>> 9f3cdd59... gen: generate with importFileExtension option
  import { Observable, from } from '../rxjsStub.js';
  
  export * from './isomorphic-fetch.js';

Looking at the generator source code, these lines appear to be incorrect and should not have the extension. So we will need an upstream patch after all - just a much smaller one.

[cjihrig]

FWIW, I opened OpenAPITools/openapi-generator#20194. I have no idea what the PR process there is like, or how long it might be until it's available in this repo.

We could enable the importFileExtension now, and because the diff is so small, update the script in this repo to patch those four lines on update.

[brendandburns]

They're usually pretty good about merging PRs fast. Let's give it a couple of days (maybe more because of the holiday) and then go the patch route if it isn't merged by sometime next week.

We're going to wait for Kubernetes 1.32 to release (12/11/24) before we cut the 1.0.0 anyway.

[cjihrig]

The PR to the generator landed.

cjihrig@8973e71 is what updating OPENAPI_GENERATOR_COMMIT to OpenAPITools/openapi-generator@06f0b68 looks like for the v1.x branch, independent of anything related to this PR.

Is that something that should be PR'ed to this repo?

[mstruebing]

Yes we would need this an then regenerate the code with the applied changes.

[cjihrig]

OK. Here it is: #2085

[cjihrig]

PR to update the XML config in the gen repo: kubernetes-client/gen#275

[brendandburns]

/lgtm
/approve

[brendandburns]

Looks like there are CI failures related to the script/test we use to make sure that package.json and package-lock.json are in-sync.

[cjihrig]

Pushed up a fix for the script. The formatter did some extra work, but this is what I actually added:

import { createRequire } from 'node:module';
const require = createRequire(import.meta.url);

[brendandburns]

/lgtm
/approve

[mstruebing]

/lgtm
/approve

[k8s-ci-robot]

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: brendandburns, cjihrig, mstruebing

The full list of commands accepted by this bot can be found here.

The pull request process is described here

Needs approval from an approver in each of these files:

• OWNERS [brendandburns,mstruebing]

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment