measur-tools-suite 1.2.1-beta.1 → 1.2.1-beta.2

package/BUILD.md

@@ -179,32 +179,38 @@ Artifacts appear under `bin/`
 
 ### 6.5 WebAssembly Usage Example
 
-```js
+```ts
+import type { WallHeatLossModule, DryerOperatingCostModule } from 'measur-tools-suite';
+
 // Initialize module
 const moduleFactory = (await import('/path/to/client.js')).default;
 const toolsSuiteModule = await moduleFactory({
 	locateFile: (filename) => '/path/to/client.wasm'
 });
 
-// Example call
+// Example 1: wallTotalHeatLoss — returns a number directly
 const totalHeatLoss = toolsSuiteModule.wallTotalHeatLoss(
 	500, 80, 225, 10, 0.9, 1.394, 1
 );
-// Alternatively, using the module type for better type safety
-import type * as MeasurToolsSuiteModule  from '/path/to/client';
-const totalHeatLoss = toolsSuiteModule as MeasurToolsSuiteModule.WallHeatLossModule;
-const wthl = totalHeatLoss.wallTotalHeatLoss(500, 80, 225, 10, 0.9, 1.394, 1);
-
-// Example 2 usage of DryerOperatingCost module
-const docRes = new toolsSuiteModule.DryerOperatingCost(1752, 50, 100, 24, 7, 52, 0.08, 0.2, 0.25).calculate(ToolsSuiteModule.DryerType.Heatless);
-console.log("DryerOperatingCost calculation => Water Removed:", docRes.waterRemoved);
+console.log('Wall total heat loss:', totalHeatLoss);
+
+// Alternatively, narrow to a typed sub-module for IDE assistance
+const wallLossModule = toolsSuiteModule as unknown as WallHeatLossModule;
+const wthl = wallLossModule.wallTotalHeatLoss(500, 80, 225, 10, 0.9, 1.394, 1);
+console.log('Wall total heat loss (typed):', wthl);
+
+// Example 2: DryerOperatingCost — plain usage
+// Enum values and constructors come from the live module instance
+const docRes = new toolsSuiteModule.DryerOperatingCost(1752, 50, 100, 24, 7, 52, 0.08, 0.2, 0.25)
+	.calculate(toolsSuiteModule.DryerType.Heatless);
+console.log('DryerOperatingCost => Water Removed:', docRes.waterRemoved);
 docRes.delete();
-// Alternatively, using the module type for better type safety
-const dryerOperatingCostModule = toolsSuiteModule as MeasurToolsSuiteModule.DryerOperatingCostModule;
-let doc = new dryerOperatingCostModule.DryerOperatingCost(1752, 50, 100, 24, 7, 52, 0.08, 0.2, 0.25);
-let res = doc.calculate(dryerOperatingCostModule.DryerType.Heatless);
-let wr = res.waterRemoved;
-console.log("DryerOperatingCost calculation => Water removed:", wr);
+
+// Alternatively, narrow to a typed sub-module for IDE assistance
+const dryerModule = toolsSuiteModule as unknown as DryerOperatingCostModule;
+const doc = new dryerModule.DryerOperatingCost(1752, 50, 100, 24, 7, 52, 0.08, 0.2, 0.25);
+const res = doc.calculate(dryerModule.DryerType.Heatless);
+console.log('DryerOperatingCost => Water removed:', res.waterRemoved);
 res.delete();
 doc.delete();
 ```

package/README.md

@@ -25,6 +25,8 @@ Check out the [Master List of MEASUR Calculators](https://github.com/ORNL-AMO/AM
 npm install measur-tools-suite
 ```
 
+**JavaScript**
+
 ```js
 // Initialize module
 const moduleFactory = (await import('/path/to/client.js')).default;
@@ -32,10 +34,37 @@ const toolsSuiteModule = await moduleFactory({
 	locateFile: (filename) => '/path/to/client.wasm'
 });
 
-// Example call
+// Plain function call — returns a number directly
 const totalHeatLoss = toolsSuiteModule.wallTotalHeatLoss(
 	500, 80, 225, 10, 0.9, 1.394, 1
 );
+console.log('Wall total heat loss:', totalHeatLoss);
+
+// Class-based API — always call delete() to free WASM memory
+const doc = new toolsSuiteModule.DryerOperatingCost(1752, 50, 100, 24, 7, 52, 0.08, 0.2, 0.25);
+const res = doc.calculate(toolsSuiteModule.DryerType.Heatless);
+console.log('Water removed:', res.waterRemoved);
+res.delete();
+doc.delete();
+```
+
+**TypeScript** — named `import type` provides IDE autocompletion with zero runtime cost; enum values and constructors still come from the live module instance.
+
+```ts
+import type { DryerOperatingCostModule } from 'measur-tools-suite';
+
+const moduleFactory = (await import('/path/to/client.js')).default;
+const toolsSuiteModule = await moduleFactory({
+	locateFile: (filename) => '/path/to/client.wasm'
+});
+
+// Narrow to the typed sub-module for full IDE assistance
+const dryerModule = toolsSuiteModule as unknown as DryerOperatingCostModule;
+const doc = new dryerModule.DryerOperatingCost(1752, 50, 100, 24, 7, 52, 0.08, 0.2, 0.25);
+const res = doc.calculate(dryerModule.DryerType.Heatless);
+console.log('Water removed:', res.waterRemoved);
+res.delete();
+doc.delete();
 ```
 
 ### Building from Source

package/bin/package.json

@@ -1,6 +1,6 @@
 {
   "name": "measur-tools-suite",
-  "version": "1.2.1-beta.1",
+  "version": "1.2.1-beta.2",
   "engines": {
     "node": "20.19.4",
     "npm": "10.8.2"
@@ -20,6 +20,7 @@
     "url": "https://github.com/ORNL-AMO/MEASUR-Tools-Suite/issues"
   },
   "homepage": "https://github.com/ORNL-AMO/MEASUR-Tools-Suite#readme",
+  "types": "ts_def/client.d.ts",
   "devDependencies": {
     "chai": "^6.0.1",
     "express": "^4.17.1",

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "measur-tools-suite",
-  "version": "1.2.1-beta.1",
+  "version": "1.2.1-beta.2",
   "engines": {
     "node": "20.19.4",
     "npm": "10.8.2"
@@ -20,6 +20,7 @@
     "url": "https://github.com/ORNL-AMO/MEASUR-Tools-Suite/issues"
   },
   "homepage": "https://github.com/ORNL-AMO/MEASUR-Tools-Suite#readme",
+  "types": "ts_def/client.d.ts",
   "devDependencies": {
     "chai": "^6.0.1",
     "express": "^4.17.1",