@gala-chain/launchpad-sdk 3.11.8 → 3.12.1

package/CHANGELOG.md

@@ -1,5 +1,39 @@
 # Changelog
 
+## 3.12.1
+
+### Patch Changes
+
+- Comprehensive documentation for CommonJS support and module formats
+
+  **SDK Updates:**
+  - Document all three module formats (ESM, CommonJS, UMD)
+  - Add module resolution table showing automatic format selection
+  - Clarify when to use each format with concrete examples
+  - Explain package.json exports configuration
+
+  **MCP Server Updates:**
+  - Document CommonJS module format
+  - Explain integration with SDK's multi-format support
+  - Clarify automatic format selection by Node.js
+
+  **Project Configuration (CLAUDE.md):**
+  - Enhanced Build System section with detailed format breakdown
+  - Added comprehensive "Launchpad SDK Module Formats (v3.12.0+)" section
+  - Include size monitoring metrics for all three bundles
+
+## 3.12.0
+
+### Minor Changes
+
+- Add CommonJS build support with proper exports configuration
+  - Export CommonJS bundle (`index.cjs.js`) via package.json exports field
+  - Maintain ESM as primary format with proper import/require resolution
+  - Add CommonJS bundle to size-limit checks
+  - Keep UMD bundle as "main" fallback for backward compatibility
+
+  Enables legacy CommonJS projects to import the SDK without requiring build tool transformations.
+
 ## 3.11.8
 
 ### Patch Changes

package/README.md

@@ -97,6 +97,75 @@ yarn add ethers@^6.15.0 @gala-chain/api@^2.4.3 @gala-chain/connect@^2.4.3 socket
 
 **All peer dependencies are required** - this includes `socket.io-client` which is needed for transaction verification via WebSocket.
 
+## Module Formats
+
+The SDK is distributed in **three module formats** to support both modern and legacy projects:
+
+### ESM (ES Modules) - Primary Format
+
+**For modern bundlers and Node.js 16+:**
+
+```typescript
+import { createLaunchpadSDK } from '@gala-chain/launchpad-sdk';
+
+const sdk = createLaunchpadSDK({
+  wallet: 'your-private-key-or-mnemonic'
+});
+```
+
+**When to use:**
+- ✅ React, Vue, Svelte, Angular applications
+- ✅ Next.js, Nuxt, SvelteKit
+- ✅ Vite, Webpack, esbuild bundlers
+- ✅ Modern Node.js projects with `"type": "module"`
+
+### CommonJS - Legacy Support
+
+**For CommonJS projects and older Node.js environments:**
+
+```javascript
+const { createLaunchpadSDK } = require('@gala-chain/launchpad-sdk');
+
+const sdk = createLaunchpadSDK({
+  wallet: 'your-private-key-or-mnemonic'
+});
+```
+
+**When to use:**
+- ✅ Legacy Node.js projects with CommonJS modules
+- ✅ Older tooling that doesn't support ESM
+- ✅ Express.js, Nest.js (CommonJS mode)
+- ✅ Projects without build tools
+
+### UMD (Universal Module Definition) - Browser Legacy
+
+**For browser globals and legacy environments:**
+
+```html
+<script src="node_modules/@gala-chain/launchpad-sdk/dist/index.js"></script>
+<script>
+  const sdk = window.GalaLaunchpadSDK.createLaunchpadSDK({
+    wallet: 'your-private-key-or-mnemonic'
+  });
+</script>
+```
+
+**When to use:**
+- ✅ Direct browser `<script>` tags
+- ✅ Older browser environments
+- ✅ CDN delivery
+
+### Module Resolution
+
+Node.js automatically selects the correct module format based on your project:
+
+| Project Type | Method | Format Used | File |
+|---|---|---|---|
+| ESM Module | `import` | ESM | `dist/index.esm.js` |
+| CommonJS | `require()` | CommonJS | `dist/index.cjs.js` |
+| Legacy Tools | Direct Include | UMD | `dist/index.js` |
+
+**No configuration needed** - Node.js and bundlers automatically select the optimal format via the package exports field!
 
 ## AI Agent Integration
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@gala-chain/launchpad-sdk",
-  "version": "3.11.8",
+  "version": "3.12.1",
   "description": "TypeScript SDK for Gala Launchpad Backend API - Production-ready DeFi token launchpad integration with wallet-based authentication, GalaChain trading, and comprehensive user operations. 100% tested (22/22 endpoints working).",
   "main": "dist/index.js",
   "module": "dist/index.esm.js",
@@ -23,7 +23,7 @@
     ".": {
       "types": "./dist/index.d.ts",
       "import": "./dist/index.esm.js",
-      "require": "./dist/index.js"
+      "require": "./dist/index.cjs.js"
     }
   },
   "scripts": {
@@ -157,6 +157,10 @@
     {
       "path": "./dist/index.esm.js",
       "limit": "50 kB"
+    },
+    {
+      "path": "./dist/index.cjs.js",
+      "limit": "50 kB"
     }
   ]
 }