🏷️ Convert to ES Modules and NodeNext

coderabbitai · NatoBoram · May 22, 2024 · May 22, 2024 · May 23, 2024 · May 24, 2024
commit 883b69b4c980d712d1e3ebaa3ea3340755387fd6
diff --git a/.gitignore b/.gitignore
@@ -5,6 +5,7 @@ out/
 docs/
 coverage/
 
+pnpm-lock.yaml
 yarn.lock
 yarn-error.log
 .DS_Store

diff --git a/examples/package.json b/examples/package.json
@@ -18,5 +18,6 @@
   },
   "dependencies": {
     "jira.js": "latest"
-  }
+  },
+  "type": "module"
 }
diff --git a/examples/src/basic.ts b/examples/src/basic.ts
@@ -45,9 +45,8 @@ async function main() {
   }
 }
 
-main()
-  .catch(e => {
-    console.error(e);
+main().catch(e => {
+  console.error(e);
 
-    throw new Error(JSON.stringify(e));
-  });
+  throw new Error(JSON.stringify(e));
+});
diff --git a/examples/src/getAllWorklogs.ts b/examples/src/getAllWorklogs.ts
@@ -1,6 +1,7 @@
 import { Version3Client } from 'jira.js';
-import { addWorklog, createIssue } from './utils';
+import type { Worklog } from 'jira.js/out/version3/models';
 import { apiToken, email, host } from './credentials';
+import { addWorklog, createIssue } from './utils';
 
 async function getAllWorklogs() {
   const client = new Version3Client({
@@ -19,7 +20,7 @@ async function getAllWorklogs() {
   await addWorklog(client, issue);
 
   // The main part responsible for getting the worklogs
-  const worklogs = [];
+  const worklogs: Worklog[] = [];
 
   let offset = 0;
   let total = 0;

diff --git a/package.json b/package.json
@@ -75,5 +75,6 @@
     "axios": "^1.7.7",
     "form-data": "^4.0.0",
     "tslib": "^2.7.0"
-  }
+  },
+  "type": "module"
 }
diff --git a/src/agile/backlog.ts b/src/agile/backlog.ts
@@ -1,7 +1,7 @@
-import * as Parameters from './parameters';
-import { Client } from '../clients';
-import { Callback } from '../callback';
-import { RequestConfig } from '../requestConfig';
+import * as Parameters from './parameters/index.js';
+import type { Client } from '../clients/index.js';
+import type { Callback } from '../callback.js';
+import type { RequestConfig } from '../requestConfig.js';
 
 export class Backlog {
   constructor(private client: Client) {}

diff --git a/src/agile/board.ts b/src/agile/board.ts
@@ -1,9 +1,9 @@
-import * as Models from './models';
-import * as Parameters from './parameters';
-import { Client } from '../clients';
-import { Callback } from '../callback';
-import { Paginated } from '../paginated';
-import { RequestConfig } from '../requestConfig';
+import * as Models from './models/index.js';
+import * as Parameters from './parameters/index.js';
+import type { Client } from '../clients/index.js';
+import type { Callback } from '../callback.js';
+import type { Paginated } from '../paginated.js';
+import type { RequestConfig } from '../requestConfig.js';
 
 export class Board {
   constructor(private client: Client) {}

diff --git a/src/agile/builds.ts b/src/agile/builds.ts
@@ -1,8 +1,8 @@
-import * as Models from './models';
-import * as Parameters from './parameters';
-import { Client } from '../clients';
-import { Callback } from '../callback';
-import { RequestConfig } from '../requestConfig';
+import * as Models from './models/index.js';
+import * as Parameters from './parameters/index.js';
+import type { Client } from '../clients/index.js';
+import type { Callback } from '../callback.js';
+import type { RequestConfig } from '../requestConfig.js';
 
 export class Builds {
   constructor(private client: Client) {}

diff --git a/src/agile/client/agileClient.ts b/src/agile/client/agileClient.ts
@@ -1,4 +1,4 @@
-import { BaseClient } from '../../clients';
+import { BaseClient } from '../../clients/index.js';
 import {
   Backlog,
   Board,
@@ -13,7 +13,7 @@ import {
   RemoteLinks,
   SecurityInformation,
   Sprint,
-} from '..';
+} from '../index.js';
 
 export class AgileClient extends BaseClient {
   backlog = new Backlog(this);

diff --git a/src/agile/client/index.ts b/src/agile/client/index.ts
@@ -1 +1 @@
-export * from './agileClient';
+export * from './agileClient.js';
diff --git a/src/agile/deployments.ts b/src/agile/deployments.ts
@@ -1,8 +1,8 @@
-import * as Models from './models';
-import * as Parameters from './parameters';
-import { Client } from '../clients';
-import { Callback } from '../callback';
-import { RequestConfig } from '../requestConfig';
+import * as Models from './models/index.js';
+import * as Parameters from './parameters/index.js';
+import type { Client } from '../clients/index.js';
+import type { Callback } from '../callback.js';
+import type { RequestConfig } from '../requestConfig.js';
 
 export class Deployments {
   constructor(private client: Client) {}

diff --git a/src/agile/developmentInformation.ts b/src/agile/developmentInformation.ts
@@ -1,8 +1,8 @@
-import * as Models from './models';
-import * as Parameters from './parameters';
-import { Client } from '../clients';
-import { Callback } from '../callback';
-import { RequestConfig } from '../requestConfig';
+import * as Models from './models/index.js';
+import * as Parameters from './parameters/index.js';
+import type { Client } from '../clients/index.js';
+import type { Callback } from '../callback.js';
+import type { RequestConfig } from '../requestConfig.js';
 
 export class DevelopmentInformation {
   constructor(private client: Client) {}

diff --git a/src/agile/devopsComponents.ts b/src/agile/devopsComponents.ts
@@ -1,8 +1,8 @@
-import * as Models from './models';
-import * as Parameters from './parameters';
-import { Client } from '../clients';
-import { Callback } from '../callback';
-import { RequestConfig } from '../requestConfig';
+import * as Models from './models/index.js';
+import * as Parameters from './parameters/index.js';
+import type { Client } from '../clients/index.js';
+import type { Callback } from '../callback.js';
+import type { RequestConfig } from '../requestConfig.js';
 
 export class DevopsComponents {
   constructor(private client: Client) {}

diff --git a/src/agile/epic.ts b/src/agile/epic.ts
@@ -1,8 +1,8 @@
-import * as Models from './models';
-import * as Parameters from './parameters';
-import { Client } from '../clients';
-import { Callback } from '../callback';
-import { RequestConfig } from '../requestConfig';
+import * as Models from './models/index.js';
+import * as Parameters from './parameters/index.js';
+import type { Client } from '../clients/index.js';
+import type { Callback } from '../callback.js';
+import type { RequestConfig } from '../requestConfig.js';
 
 export class Epic {
   constructor(private client: Client) {}

diff --git a/src/agile/featureFlags.ts b/src/agile/featureFlags.ts
@@ -1,8 +1,8 @@
-import * as Models from './models';
-import * as Parameters from './parameters';
-import { Client } from '../clients';
-import { Callback } from '../callback';
-import { RequestConfig } from '../requestConfig';
+import * as Models from './models/index.js';
+import * as Parameters from './parameters/index.js';
+import type { Client } from '../clients/index.js';
+import type { Callback } from '../callback.js';
+import type { RequestConfig } from '../requestConfig.js';
 
 export class FeatureFlags {
   constructor(private client: Client) {}

diff --git a/src/agile/index.ts b/src/agile/index.ts
@@ -1,17 +1,17 @@
-export * from './backlog';
-export * from './board';
-export * from './builds';
-export * from './deployments';
-export * from './developmentInformation';
-export * from './devopsComponents';
-export * from './epic';
-export * from './featureFlags';
-export * from './issue';
-export * from './operations';
-export * from './remoteLinks';
-export * from './securityInformation';
-export * from './sprint';
+export * from './backlog.js';
+export * from './board.js';
+export * from './builds.js';
+export * from './deployments.js';
+export * from './developmentInformation.js';
+export * from './devopsComponents.js';
+export * from './epic.js';
+export * from './featureFlags.js';
+export * from './issue.js';
+export * from './operations.js';
+export * from './remoteLinks.js';
+export * from './securityInformation.js';
+export * from './sprint.js';
 
-export * as AgileModels from './models';
-export * as AgileParameters from './parameters';
-export * from './client';
+export * as AgileModels from './models/index.js';
+export * as AgileParameters from './parameters/index.js';
+export * from './client/index.js';
diff --git a/src/agile/issue.ts b/src/agile/issue.ts
@@ -1,8 +1,8 @@
-import * as Models from './models';
-import * as Parameters from './parameters';
-import { Client } from '../clients';
-import { Callback } from '../callback';
-import { RequestConfig } from '../requestConfig';
+import * as Models from './models/index.js';
+import * as Parameters from './parameters/index.js';
+import type { Client } from '../clients/index.js';
+import type { Callback } from '../callback.js';
+import type { RequestConfig } from '../requestConfig.js';
 
 export class Issue {
   constructor(private client: Client) {}

diff --git a/src/agile/models/board.ts b/src/agile/models/board.ts
@@ -1,4 +1,4 @@
-import { AvatarUrls } from './avatarUrls';
+import type { AvatarUrls } from './avatarUrls.js';
 
 /** Details about a board. */
 export interface Board {

diff --git a/src/agile/models/createBoard.ts b/src/agile/models/createBoard.ts
@@ -1,4 +1,4 @@
-import { AvatarUrls } from './avatarUrls';
+import type { AvatarUrls } from './avatarUrls.js';
 
 /** Details about a board. */
 export interface CreateBoard {

diff --git a/src/agile/models/fields.ts b/src/agile/models/fields.ts
@@ -1,15 +1,15 @@
-import { Attachment } from '../../version3/models';
-import { Epic } from './epic';
-import { FixVersion } from './fixVersion';
-import { Issue } from './issue';
-import { IssueType } from './issueType';
-import { Progress } from './progress';
-import { Project } from './project';
-import { Sprint } from './sprint';
-import { Status } from './status';
-import { User } from './user';
-import { Version } from './version';
-import {
+import type { Attachment } from '../../version3/models/index.js';
+import type { Epic } from './epic.js';
+import type { FixVersion } from './fixVersion.js';
+import type { Issue } from './issue.js';
+import type { IssueType } from './issueType.js';
+import type { Progress } from './progress.js';
+import type { Project } from './project.js';
+import type { Sprint } from './sprint.js';
+import type { Status } from './status.js';
+import type { User } from './user.js';
+import type { Version } from './version.js';
+import type {
   Comment,
   IssueLink,
   Priority,
@@ -20,7 +20,7 @@ import {
   Votes,
   Watchers,
   Worklog,
-} from '../../version2/models';
+} from '../../version2/models/index.js';
 
 export interface Fields {
   [key: string]: any;

diff --git a/src/agile/models/getAllBoards.ts b/src/agile/models/getAllBoards.ts
@@ -1,4 +1,4 @@
-import { Board } from './board';
+import type { Board } from './board.js';
 
 export interface GetAllBoards {
   isLast?: boolean;

diff --git a/src/agile/models/getBoard.ts b/src/agile/models/getBoard.ts
@@ -1,4 +1,4 @@
-import { AvatarUrls } from './avatarUrls';
+import type { AvatarUrls } from './avatarUrls.js';
 
 /** Details about a board. */
 export interface GetBoard {
Original file line number	Diff line number	Diff line change
		@@ -1 +1 @@
		export * from './agileClient';
		export * from './agileClient.js';