Merge pull request #5 from Devotel/feat/tests

Make the tests coverage both esm and commonjs modules.

Author: devotel-fb

.github/workflows/test.yml

@@ -0,0 +1,28 @@
+name: Test Module Compatibility
+
+on:
+  push:
+    branches: [ main, develop ]
+  pull_request:
+    branches: [ main ]
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        node-version: [18, 20, 22]
+    
+    steps:
+    - uses: actions/checkout@v4
+    
+    - name: Use Node.js ${{ matrix.node-version }}
+      uses: actions/setup-node@v4
+      with:
+        node-version: ${{ matrix.node-version }}
+        cache: 'npm'
+    
+    - run: npm ci
+    - run: npm run build
+    - run: npm run test:modules
+    - run: npm test

README.md

@@ -1,14 +1,53 @@
-# DevHub Node.js SDK
+# DevHub Node.js SDK 📡
+
+[![npm version](https://badge.fury.io/js/@devotel%2Fdevhub.svg)](https://badge.fury.io/js/@devotel%2Fdevhub)
+[![TypeScript](https://img.shields.io/badge/TypeScript-Ready-blue.svg)](https://www.typescriptlang.org/)
+[![Node.js](https://img.shields.io/badge/Node.js-18%2B-green.svg)](https://nodejs.org/)
+[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
+[![ESM](https://img.shields.io/badge/ESM-Ready-brightgreen.svg)](https://nodejs.org/api/esm.html)
+[![CommonJS](https://img.shields.io/badge/CommonJS-Ready-brightgreen.svg)](https://nodejs.org/api/modules.html)
 
 Official Node.js SDK for the DevHub Communication API.
 
-## Installation
+## 📦 Installation
 
 ```bash
-npm install @devotel/devhub
+npm i @devotel/devhub
+```
+
+## 🔧 Module Compatibility
+
+This SDK supports both **ESM** (ES Modules) and **CommonJS** module systems:
+
+### ESM (ES Modules)
+
+```javascript
+// Default import (recommended)
+import DevHubSDK from "@devotel/devhub";
+
+// Named import
+import { DevHubSDK } from "@devotel/devhub";
+
+const devhub = new DevHubSDK({
+  apiKey: "<your-api-key>",
+});
+```
+
+### CommonJS
+
+```javascript
+// Default import (recommended)
+const DevHubSDK = require("@devotel/devhub").default;
+
+// Named import
+const { DevHubSDK } = require("@devotel/devhub");
+
+const devhub = new DevHubSDK({
+  apiKey: "<your-api-key>",
+});
 ```
 
-## Quick Start
+## 🚀 Quick Start
 
 ```javascript
 import DevHubSDK from "@devotel/devhub";
@@ -19,35 +58,38 @@ const devhub = new DevHubSDK({
 
 // Send SMS
 await devhub.sms.send({
-  to: "+1234567890",
+  recipient: "+1234567890",
   message: "Hello from DevHub!",
+  sender: "<sender>",
 });
 
 // Send Email
 await devhub.email.send({
-  to: "user@example.com",
+  recipient: "user@example.com",
   subject: "Hello",
-  html: "<h1>Hello from DevHub!</h1>",
+  body: "<h1>Hello from DevHub!</h1>",
+  sender: "sender@example.com",
 });
 
 // Send WhatsApp message
 await devhub.whatsapp.sendNormalMessage({
+  account_id: "your-account-id",
   to: "+1234567890",
   type: "text",
   text: { body: "Hello from DevHub!" },
 });
 ```
 
-## API Reference
+## 📚 API Reference
 
 ### SMS Service
 
 ```javascript
 // Send SMS
 await devhub.sms.send({
-  to: "+1234567890",
+  recipient: "+1234567890",
   message: "Your message",
-  from: "optional-sender-id",
+  sender: "optional-sender-id",
 });
 
 // Get available senders
@@ -68,10 +110,10 @@ await devhub.sms.getNumbers();
 ```javascript
 // Send email
 await devhub.email.send({
-  to: "recipient@example.com",
+  recipient: "recipient@example.com",
   subject: "Subject",
-  html: "<p>HTML content</p>",
-  text: "Plain text content",
+  body: "<p>HTML content</p>",
+  sender: "sender@example.com",
 });
 ```
 
@@ -92,6 +134,7 @@ await devhub.whatsapp.sendTemplateMessage("account-id", {
 
 // Send normal message
 await devhub.whatsapp.sendNormalMessage({
+  account_id: "your-account-id",
   to: "+1234567890",
   type: "text",
   text: { body: "Hello!" },
@@ -122,8 +165,8 @@ await devhub.contacts.updateContact("contact-id", {
 
 // Create custom field
 await devhub.contacts.createCustomField({
-  name: "Company",
-  type: "text",
+  label: "Company",
+  component: "Input",
   required: false,
 });
 ```
@@ -136,8 +179,11 @@ await devhub.rcs.getAccounts();
 
 // Send RCS message
 await devhub.rcs.send({
-  to: "+1234567890",
-  content: { text: "Hello from RCS!" },
+  account_id: "your-account-id",
+  number: "+1234567890",
+  contentMessage: {
+    text: "Hello from RCS!",
+  },
 });
 
 // Create RCS template
@@ -172,13 +218,14 @@ await devhub.contactGroups.updateContactGroup("group-id", {
 await devhub.messages.send({
   channel: "SMS",
   sms: {
-    to: "+1234567890",
+    sender: "DevHub",
+    recipient: "+1234567890",
     message: "Hello!",
   },
 });
 ```
 
-## Error Handling
+## ⚠️ Error Handling
 
 All methods return a response object with the following structure:
 
@@ -194,7 +241,7 @@ Example:
 
 ```javascript
 const result = await devhub.sms.send({
-  to: "+1234567890",
+  recipient: "+1234567890",
   message: "Hello!",
 });
 
@@ -205,6 +252,118 @@ if (result.success) {
 }
 ```
 
-## License
+## 🔷 TypeScript Support
+
+The SDK is written in TypeScript and provides full type definitions. Available types:
+
+### Core Types
+
+```typescript
+import { DevHubConfig, ApiResponse, ChannelType } from "@devotel/devhub";
+```
+
+### SMS Types
+
+```typescript
+import { SmsMessage, BuyNumberRequest } from "@devotel/devhub";
+
+// Usage
+const smsData: SmsMessage = {
+  recipient: "+1234567890",
+  message: "Hello!",
+  sender: "DevHub",
+};
+```
+
+### Email Types
+
+```typescript
+import { EmailMessage } from "@devotel/devhub";
+
+// Usage
+const emailData: EmailMessage = {
+  recipient: "user@example.com",
+  subject: "Hello",
+  body: "<h1>Hello!</h1>",
+  sender: "sender@example.com",
+};
+```
+
+### WhatsApp Types
+
+```typescript
+import { WhatsAppTemplate, WhatsAppNormalMessage } from "@devotel/devhub";
+
+// Template message
+const templateData: WhatsAppTemplate = {
+  to: "+1234567890",
+  template: {
+    name: "hello_world",
+    language: { code: "en" },
+  },
+};
+
+// Normal message
+const normalData: WhatsAppNormalMessage = {
+  account_id: "your-account-id",
+  to: "+1234567890",
+  type: "text",
+  text: { body: "Hello!" },
+};
+```
+
+### Contact Types
+
+```typescript
+import { Contact, CustomField } from "@devotel/devhub";
+
+// Contact
+const contactData: Contact = {
+  firstName: "John",
+  lastName: "Doe",
+  email: "john@example.com",
+  phoneNumber: "+1234567890",
+};
+
+// Custom field
+const fieldData: CustomField = {
+  label: "Company",
+  component: "Input",
+  required: false,
+};
+```
+
+### RCS Types
+
+```typescript
+import { RcsMessage } from "@devotel/devhub";
+
+// Usage
+const rcsData: RcsMessage = {
+  account_id: "your-account-id",
+  number: "+1234567890",
+  contentMessage: {
+    text: "Hello from RCS!",
+  },
+};
+```
+
+### Unified Messages
+
+```typescript
+import { UnifiedMessage } from "@devotel/devhub";
+
+// Usage
+const unifiedData: UnifiedMessage = {
+  channel: "SMS",
+  sms: {
+    sender: "DevHub",
+    recipient: "+1234567890",
+    message: "Hello!",
+  },
+};
+```
+
+## 📄 License
 
 MIT

jest.config.cjs

@@ -0,0 +1,17 @@
+module.exports = {
+  preset: 'ts-jest',
+  testEnvironment: 'node',
+  roots: ['<rootDir>/src', '<rootDir>/tests'],
+  testMatch: ['**/__tests__/**/*.ts', '**/?(*.)+(spec|test).ts'],
+  setupFilesAfterEnv: ['<rootDir>/tests/setup.ts'],
+  collectCoverageFrom: [
+    'src/**/*.ts',
+    '!src/**/*.d.ts',
+    '!src/index.ts'
+  ],
+  coverageDirectory: 'coverage',
+  coverageReporters: ['text', 'lcov', 'html'],
+  moduleNameMapper: {
+    '^(\\.{1,2}/.*)\\.js$': '$1'
+  }
+};

package.json

@@ -25,6 +25,12 @@
     "build:package": "echo '{\"type\": \"commonjs\"}' > dist/cjs/package.json",
     "clean": "rm -rf dist",
     "test": "jest",
+    "test:watch": "jest --watch",
+    "test:coverage": "jest --coverage",
+    "test:modules": "npm run test:esm && npm run test:cjs",
+    "test:esm": "node tests/module-compatibility.test.js",
+    "test:cjs": "node tests/module-compatibility.cjs",
+    "validate:build": "node scripts/validate-build.cjs",
     "prepublishOnly": "npm run clean && npm run build && npm run validate:build && npm run test:modules"
   },
   "keywords": [

scripts/validate-build.cjs

@@ -0,0 +1,39 @@
+#!/usr/bin/env node
+
+const fs = require('fs');
+const path = require('path');
+
+// Check required files exist
+const requiredFiles = [
+  'dist/esm/index.js',
+  'dist/esm/index.d.ts',
+  'dist/cjs/index.js',
+  'dist/cjs/index.d.ts',
+  'dist/cjs/package.json'
+];
+
+let allFilesExist = true;
+
+requiredFiles.forEach(file => {
+  if (!fs.existsSync(file)) {
+    console.error(`❌ Missing: ${file}`);
+    allFilesExist = false;
+  } else {
+    console.log(`✅ Found: ${file}`);
+  }
+});
+
+// Check CJS package.json has correct type
+const cjsPackage = JSON.parse(fs.readFileSync('dist/cjs/package.json', 'utf8'));
+if (cjsPackage.type !== 'commonjs') {
+  console.error('❌ CJS package.json missing type: commonjs');
+  allFilesExist = false;
+} else {
+  console.log('✅ CJS package.json has correct type');
+}
+
+if (!allFilesExist) {
+  process.exit(1);
+}
+
+console.log('✅ Build validation passed');