@cheny56/node-client 1.0.5 → 1.0.6

package/README-COMMONJS.md

@@ -0,0 +1,70 @@
+# CommonJS Usage
+
+This library supports both ES modules (`import`) and CommonJS (`require`). However, due to the ES module nature of the source code, CommonJS usage requires async handling.
+
+## Recommended: Use ES Modules
+
+For the best experience, use ES modules:
+
+```javascript
+// ✅ Recommended
+import { QuorumProvider, ECDSAWallet } from '@cheny56/node-client';
+
+const provider = new QuorumProvider('http://localhost:8545');
+const wallet = new ECDSAWallet('0x...', provider);
+```
+
+## CommonJS Usage (with async/await)
+
+If you must use CommonJS, you need to handle the async loading:
+
+```javascript
+// ⚠️ CommonJS - requires async handling
+const client = await import('@cheny56/node-client');
+const { QuorumProvider, ECDSAWallet } = client;
+
+const provider = new QuorumProvider('http://localhost:8545');
+const wallet = new ECDSAWallet('0x...', provider);
+```
+
+Or wrap in an async function:
+
+```javascript
+async function main() {
+    const { QuorumProvider, ECDSAWallet } = await import('@cheny56/node-client');
+    
+    const provider = new QuorumProvider('http://localhost:8545');
+    const wallet = new ECDSAWallet('0x...', provider);
+    
+    // Use provider and wallet...
+}
+
+main().catch(console.error);
+```
+
+## Why Async is Required
+
+The library source code uses ES modules (`export`/`import`). When using `require()` in CommonJS, Node.js needs to dynamically import the ES module, which is an async operation.
+
+## Migration to ES Modules
+
+To use ES modules in your project:
+
+1. Add `"type": "module"` to your `package.json`, OR
+2. Use `.mjs` extension for your files, OR
+3. Use `import()` syntax in CommonJS files
+
+Example `package.json`:
+```json
+{
+  "type": "module",
+  "scripts": {
+    "start": "node index.js"
+  }
+}
+```
+
+Then you can use:
+```javascript
+import { QuorumProvider } from '@cheny56/node-client';
+```

package/index.cjs

@@ -0,0 +1,37 @@
+/**
+ * CommonJS entry point for @cheny56/node-client
+ * 
+ * NOTE: This library is built as ES modules. For CommonJS compatibility,
+ * you need to use dynamic import() instead of require().
+ * 
+ * Example:
+ *   const { QuorumProvider } = await import('@cheny56/node-client');
+ * 
+ * Or use ES modules in your project:
+ *   import { QuorumProvider } from '@cheny56/node-client';
+ */
+
+// Re-export using dynamic import
+// This allows require() to work, but returns a Promise
+const modPromise = import('./src/index.js');
+
+// For synchronous require(), we need to throw a helpful error
+// and suggest using import() or ES modules
+module.exports = new Proxy({}, {
+    get(target, prop) {
+        if (prop === 'then' || prop === 'catch' || prop === 'finally') {
+            // Make it thenable so it works with await import()
+            return modPromise.then(mod => mod[prop]).bind(modPromise);
+        }
+        
+        throw new Error(
+            `Cannot access '${prop}' synchronously. ` +
+            `This package uses ES modules. Please use:\n` +
+            `  const { ${prop} } = await import('@cheny56/node-client');\n` +
+            `Or switch your project to ES modules by adding "type": "module" to package.json`
+        );
+    }
+});
+
+// Also export as a Promise for await import() usage
+module.exports.default = modPromise;

package/package.json

@@ -1,19 +1,28 @@
 {
   "name": "@cheny56/node-client",
-  "version": "1.0.5",
+  "version": "1.0.6",
   "description": "Client library for Quorum blockchain with Post-Quantum Cryptography (PQC) and Zero-Knowledge Proof (ZK) support",
-  "main": "src/index.js",
+  "main": "./index.cjs",
+  "module": "./src/index.js",
   "types": "src/index.d.ts",
   "type": "module",
   "exports": {
     ".": {
+      "require": "./index.cjs",
       "import": "./src/index.js",
-      "types": "./src/index.d.ts"
-    }
+      "types": "./src/index.d.ts",
+      "default": "./src/index.js"
+    },
+    "./package.json": "./package.json"
   },
   "files": [
     "src/**/*.js",
-    "src/**/*.d.ts"
+    "src/**/*.d.ts",
+    "index.cjs",
+    "package.json",
+    "README.md",
+    "README-COMMONJS.md",
+    "tsconfig.json"
   ],
   "scripts": {
     "test": "echo \"Error: no test specified\" && exit 1"

package/tsconfig.json

@@ -0,0 +1,27 @@
+{
+  "compilerOptions": {
+    "target": "ES2020",
+    "module": "ESNext",
+    "lib": ["ES2020"],
+    "moduleResolution": "node",
+    "declaration": true,
+    "declarationMap": true,
+    "outDir": "./dist",
+    "rootDir": "./src",
+    "strict": false,
+    "esModuleInterop": true,
+    "skipLibCheck": true,
+    "forceConsistentCasingInFileNames": true,
+    "resolveJsonModule": true,
+    "allowSyntheticDefaultImports": true,
+    "noEmit": true
+  },
+  "include": [
+    "src/**/*"
+  ],
+  "exclude": [
+    "node_modules",
+    "dist",
+    "examples"
+  ]
+}