chore(providers): Modernize TS setup (#7699)

Author: SokratisVidros

packages/providers/babel.config.js

@@ -2,23 +2,28 @@
   "name": "@novu/providers",
   "version": "2.6.5",
   "description": "Novu Provider Wrappers",
-  "main": "build/main/index.js",
-  "typings": "build/main/index.d.ts",
-  "module": "build/module/index.js",
-  "private": false,
+  "main": "dist/cjs/index.js",
+  "module": "dist/esm/index.js",
+  "types": "dist/cjs/index.d.ts",
+  "files": [
+    "dist/",
+    "!**/*.spec.*",
+    "!**/*.json",
+    "CHANGELOG.md",
+    "LICENSE",
+    "README.md"
+  ],
   "repository": "https://github.com/novuhq/novu",
   "license": "MIT",
   "keywords": [],
   "scripts": {
     "start": "npm run watch:build",
     "prebuild": "rimraf build",
-    "build": "run-p build:*",
-    "build:main": "tsc -p tsconfig.json",
-    "build:module": "tsc -p tsconfig.module.json",
-    "fix": "run-s fix:*",
-    "fix:prettier": "prettier \"src/**/*.ts\" --write",
+    "build": "npm run build:cjs && npm run build:esm",
+    "build:esm": "tsc -p tsconfig.esm.json",
+    "build:cjs": "tsc -p tsconfig.json",
     "lint:fix": "pnpm lint -- --fix",
-    "lint": "eslint src",
+    "lint": "eslint src --fix",
     "test": "vitest",
     "watch:build": "tsc -p tsconfig.json -w",
     "watch:test": "vitest",
@@ -74,7 +79,6 @@
   "devDependencies": {
     "@babel/preset-env": "^7.23.2",
     "@babel/preset-typescript": "^7.13.0",
-    "@istanbuljs/nyc-config-typescript": "~1.0.1",
     "@types/node-mailjet": "^3.3.7",
     "@types/nodemailer": "^6.4.4",
     "@types/sparkpost": "^2.1.5",
@@ -83,34 +87,14 @@
     "cspell": "~6.19.2",
     "nock": "^13.1.3",
     "npm-run-all": "^4.1.5",
-    "nyc": "~15.1.0",
     "open-cli": "^6.0.1",
-    "prettier": "~2.8.0",
     "rimraf": "~3.0.2",
     "ts-node": "~10.9.1",
     "typedoc": "^0.24.0",
     "typescript": "5.6.2",
     "uuid": "^9.0.0",
     "vitest": "^2.0.5"
   },
-  "files": [
-    "build/main",
-    "build/module",
-    "!**/*.spec.*",
-    "!**/*.json",
-    "CHANGELOG.md",
-    "LICENSE",
-    "README.md"
-  ],
-  "prettier": {
-    "singleQuote": true
-  },
-  "nyc": {
-    "extends": "@istanbuljs/nyc-config-typescript",
-    "exclude": [
-      "**/*.spec.js"
-    ]
-  },
   "nx": {
     "tags": [
       "type:package"

packages/providers/package.json

@@ -1,10 +1,4 @@
-import {
-  camelCase,
-  constantCase,
-  kebabCase,
-  pascalCase,
-  snakeCase,
-} from './utils/change-case';
+import { camelCase, constantCase, kebabCase, pascalCase, snakeCase } from './utils/change-case';
 import { deepMerge } from './utils/deepmerge.utils';
 import { Passthrough, WithPassthrough } from './utils/types';
 
@@ -58,10 +52,7 @@ export abstract class BaseProvider {
     T_Output = Record<string, unknown>,
     T_Input = Record<string, unknown>,
     T_Data = Record<string, unknown>,
-  >(
-    bridgeProviderData: WithPassthrough<T_Input>,
-    triggerProviderData: T_Data,
-  ): MergedPassthrough<T_Output> {
+  >(bridgeProviderData: WithPassthrough<T_Input>, triggerProviderData: T_Data): MergedPassthrough<T_Output> {
     const { _passthrough = {}, ...bridgeData } = bridgeProviderData;
 
     // Construct the trigger data passthrough object
@@ -114,9 +105,7 @@ export abstract class BaseProvider {
    * @param data The data to transform.
    * @returns The transformed data, with the keys transformed to the desired casing.
    */
-  private casingTransform(
-    data: Record<string, unknown>,
-  ): Record<string, unknown> {
+  private casingTransform(data: Record<string, unknown>): Record<string, unknown> {
     let casing = camelCase;
 
     switch (this.casing) {

packages/providers/src/base.provider.ts

@@ -44,7 +44,7 @@ test('should trigger Discord provider correctly with _passthrough', async () =>
           content: 'passthrough content',
         },
       },
-    },
+    }
   );
 
   expect(mockPost).toHaveBeenCalledWith('https://www.google.com/?wait=true', {

packages/providers/src/lib/chat/discord/discord.provider.spec.ts

@@ -1,10 +1,5 @@
 import { ChatProviderIdEnum } from '@novu/shared';
-import {
-  ChannelTypeEnum,
-  IChatOptions,
-  IChatProvider,
-  ISendMessageSuccessResponse,
-} from '@novu/stateless';
+import { ChannelTypeEnum, IChatOptions, IChatProvider, ISendMessageSuccessResponse } from '@novu/stateless';
 import axios from 'axios';
 import { BaseProvider, CasingEnum } from '../../../base.provider';
 import { WithPassthrough } from '../../../utils/types';
@@ -21,7 +16,7 @@ export class DiscordProvider extends BaseProvider implements IChatProvider {
 
   async sendMessage(
     data: IChatOptions,
-    bridgeProviderData: WithPassthrough<Record<string, unknown>> = {},
+    bridgeProviderData: WithPassthrough<Record<string, unknown>> = {}
   ): Promise<ISendMessageSuccessResponse> {
     // Setting the wait parameter with the URL API to respect user parameters
     const url = new URL(data.webhookUrl);
@@ -31,7 +26,7 @@ export class DiscordProvider extends BaseProvider implements IChatProvider {
       this.transform(bridgeProviderData, {
         content: data.content,
         ...(data.customData || {}),
-      }).body,
+      }).body
     );
 
     return {

packages/providers/src/lib/chat/discord/discord.provider.ts

@@ -50,7 +50,7 @@ test('should trigger getstream correctly with _passthrough', async () => {
           'X-API-KEY': 'test1',
         },
       },
-    },
+    }
   );
 
   expect(mockPost).toHaveBeenCalledWith('https://www.google.com/', {

packages/providers/src/lib/chat/getstream/getstream.provider.spec.ts

@@ -1,18 +1,10 @@
 import { ChatProviderIdEnum } from '@novu/shared';
-import {
-  ChannelTypeEnum,
-  ISendMessageSuccessResponse,
-  IChatOptions,
-  IChatProvider,
-} from '@novu/stateless';
+import { ChannelTypeEnum, ISendMessageSuccessResponse, IChatOptions, IChatProvider } from '@novu/stateless';
 import axios from 'axios';
 import { BaseProvider, CasingEnum } from '../../../base.provider';
 import { WithPassthrough } from '../../../utils/types';
 
-export class GetstreamChatProvider
-  extends BaseProvider
-  implements IChatProvider
-{
+export class GetstreamChatProvider extends BaseProvider implements IChatProvider {
   id = ChatProviderIdEnum.GetStream;
   channelType = ChannelTypeEnum.CHAT as ChannelTypeEnum.CHAT;
   protected casing = CasingEnum.SNAKE_CASE;
@@ -21,15 +13,15 @@ export class GetstreamChatProvider
   constructor(
     private config: {
       apiKey: string;
-    },
+    }
   ) {
     super();
     this.config = config;
   }
 
   async sendMessage(
     data: IChatOptions,
-    bridgeProviderData: WithPassthrough<Record<string, unknown>> = {},
+    bridgeProviderData: WithPassthrough<Record<string, unknown>> = {}
   ): Promise<ISendMessageSuccessResponse> {
     const transformedData = this.transform(bridgeProviderData, {
       text: data.content,

packages/providers/src/lib/chat/getstream/getstream.provider.ts

@@ -35,7 +35,7 @@ test('should trigger grafana-on-call library correctly', async () => {
       title: 'title',
       message: testContent,
     },
-    undefined,
+    undefined
   );
   expect(res).toEqual({ id: expect.any(String), date: date.toISOString() });
 });
@@ -71,7 +71,7 @@ test('should trigger grafana-on-call library correctly with _passthrough', async
           'Content-Type': 'application/json',
         },
       },
-    },
+    }
   );
 
   expect(mockPost).toHaveBeenCalled();
@@ -89,7 +89,7 @@ test('should trigger grafana-on-call library correctly with _passthrough', async
       headers: {
         'Content-Type': 'application/json',
       },
-    },
+    }
   );
   expect(res).toEqual({ id: expect.any(String), date: date.toISOString() });
 });

packages/providers/src/lib/chat/grafana-on-call/grafana-on-call.provider.spec.ts

@@ -1,19 +1,11 @@
 import { ChatProviderIdEnum } from '@novu/shared';
-import {
-  ChannelTypeEnum,
-  ISendMessageSuccessResponse,
-  IChatOptions,
-  IChatProvider,
-} from '@novu/stateless';
+import { ChannelTypeEnum, ISendMessageSuccessResponse, IChatOptions, IChatProvider } from '@novu/stateless';
 import axios from 'axios';
 import { v4 as uuid } from 'uuid';
 import { BaseProvider, CasingEnum } from '../../../base.provider';
 import { WithPassthrough } from '../../../utils/types';
 
-export class GrafanaOnCallChatProvider
-  extends BaseProvider
-  implements IChatProvider
-{
+export class GrafanaOnCallChatProvider extends BaseProvider implements IChatProvider {
   id = ChatProviderIdEnum.GrafanaOnCall;
   channelType = ChannelTypeEnum.CHAT as ChannelTypeEnum.CHAT;
   protected casing = CasingEnum.SNAKE_CASE;
@@ -25,14 +17,14 @@ export class GrafanaOnCallChatProvider
       imageUrl?: string;
       state?: string;
       externalLink?: string;
-    },
+    }
   ) {
     super();
   }
 
   async sendMessage(
     options: IChatOptions,
-    bridgeProviderData: WithPassthrough<Record<string, unknown>> = {},
+    bridgeProviderData: WithPassthrough<Record<string, unknown>> = {}
   ): Promise<ISendMessageSuccessResponse> {
     const url = new URL(options.webhookUrl);
     const data = this.transform(bridgeProviderData, {
@@ -54,7 +46,7 @@ export class GrafanaOnCallChatProvider
         ? {
             headers: data.headers as Record<string, string>,
           }
-        : undefined,
+        : undefined
     );
 
     return {

packages/providers/src/lib/chat/grafana-on-call/grafana-on-call.provider.ts

@@ -85,7 +85,7 @@ test('should trigger mattermost library correctly, default channel with _passthr
           text: '_passthrough content message',
         },
       },
-    },
+    }
   );
   expect(fakePostDefaultChannel).toHaveBeenCalled();
   expect(fakePostDefaultChannel).toHaveBeenCalledWith(testWebhookUrl, {

packages/providers/src/lib/chat/mattermost/mattermost.provider.spec.ts

@@ -1,10 +1,5 @@
 import axios from 'axios';
-import {
-  ChannelTypeEnum,
-  ISendMessageSuccessResponse,
-  IChatOptions,
-  IChatProvider,
-} from '@novu/stateless';
+import { ChannelTypeEnum, ISendMessageSuccessResponse, IChatOptions, IChatProvider } from '@novu/stateless';
 import { ChatProviderIdEnum } from '@novu/shared';
 import { BaseProvider, CasingEnum } from '../../../base.provider';
 import { WithPassthrough } from '../../../utils/types';
@@ -22,17 +17,14 @@ export class MattermostProvider extends BaseProvider implements IChatProvider {
 
   async sendMessage(
     data: IChatOptions,
-    bridgeProviderData: WithPassthrough<Record<string, unknown>> = {},
+    bridgeProviderData: WithPassthrough<Record<string, unknown>> = {}
   ): Promise<ISendMessageSuccessResponse> {
     const payload: IMattermostPayload = { text: data.content };
 
     if (data.channel) {
       payload.channel = data.channel;
     }
-    const response = await this.axiosInstance.post(
-      data.webhookUrl,
-      this.transform(bridgeProviderData, payload).body,
-    );
+    const response = await this.axiosInstance.post(data.webhookUrl, this.transform(bridgeProviderData, payload).body);
 
     return {
       id: response.headers['x-request-id'],

packages/providers/src/lib/chat/mattermost/mattermost.provider.ts

@@ -43,7 +43,7 @@ test('should trigger msTeams webhook correctly with _passthrough', async () => {
           title: '_passthrough test title',
         },
       },
-    },
+    }
   );
 
   expect(fakePost).toHaveBeenCalled();

packages/providers/src/lib/chat/msTeams/msTeams.provider.spec.ts

@@ -1,10 +1,5 @@
 import { ChatProviderIdEnum } from '@novu/shared';
-import {
-  ChannelTypeEnum,
-  ISendMessageSuccessResponse,
-  IChatOptions,
-  IChatProvider,
-} from '@novu/stateless';
+import { ChannelTypeEnum, ISendMessageSuccessResponse, IChatOptions, IChatProvider } from '@novu/stateless';
 import axios from 'axios';
 import { BaseProvider, CasingEnum } from '../../../base.provider';
 import { WithPassthrough } from '../../../utils/types';
@@ -21,7 +16,7 @@ export class MsTeamsProvider extends BaseProvider implements IChatProvider {
 
   async sendMessage(
     data: IChatOptions,
-    bridgeProviderData: WithPassthrough<Record<string, unknown>> = {},
+    bridgeProviderData: WithPassthrough<Record<string, unknown>> = {}
   ): Promise<ISendMessageSuccessResponse> {
     let payload;
 

packages/providers/src/lib/chat/msTeams/msTeams.provider.ts

@@ -37,7 +37,7 @@ test('should trigger rocket-chat library correctly', async () => {
         'x-auth-token': '<your-auth-token>',
         'x-user-id': '<your-user>',
       },
-    },
+    }
   );
 });
 
@@ -73,7 +73,7 @@ test('should trigger rocket-chat library correctly with _passthrough', async ()
           'x-auth-token': '_passthrough',
         },
       },
-    },
+    }
   );
 
   expect(mockPost).toHaveBeenCalledWith(
@@ -90,6 +90,6 @@ test('should trigger rocket-chat library correctly with _passthrough', async ()
         'x-auth-token': '_passthrough',
         'x-user-id': '<your-user>',
       },
-    },
+    }
   );
 });