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

package/BUILD.md

@@ -179,17 +179,40 @@ 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
 );
+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, 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();
 ```
 
 ### 6.6 WebAssembly Tests (Browser)

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/client.d.ts

@@ -0,0 +1,93 @@
+export * from "./ts_def_modules/binding/registered_vectors";
+
+export * from "./ts_def_modules/compressedAir/compressedAir";
+export * from "./ts_def_modules/compressedAir/compressed_air_utils";
+export * from "./ts_def_modules/compressedAir/compressorsCalc";
+export * from "./ts_def_modules/compressedAir/dryer_operating_cost";
+export * from "./ts_def_modules/compressedAir/operating_cost";
+export * from "./ts_def_modules/compressedAir/pipe_sizing";
+export * from "./ts_def_modules/compressedAir/pneumatic_air_requirement";
+export * from "./ts_def_modules/compressedAir/pneumatic_valve";
+export * from "./ts_def_modules/compressedAir/receiver_tank";
+
+export * from "./ts_def_modules/compressedAir/leak_survey/bag_method";
+export * from "./ts_def_modules/compressedAir/leak_survey/compressed_air_leak_survey";
+export * from "./ts_def_modules/compressedAir/leak_survey/decibels_method";
+export * from "./ts_def_modules/compressedAir/leak_survey/estimate_method";
+export * from "./ts_def_modules/compressedAir/leak_survey/orifice_method";
+
+export * from "./ts_def_modules/databases/default_data";
+
+export * from "./ts_def_modules/motorDriven/fans/fan";
+export * from "./ts_def_modules/motorDriven/fans/fanEnum";
+export * from "./ts_def_modules/motorDriven/fans/fan_affinity_laws";
+
+export * from "./ts_def_modules/motorDriven/motor/motor";
+export * from "./ts_def_modules/motorDriven/motor/motorEnum";
+
+export * from "./ts_def_modules/motorDriven/pump/pump";
+export * from "./ts_def_modules/motorDriven/pump/pump_valve_power_loss";
+
+export * from "./ts_def_modules/motorDriven/pumpFan/pumpFan";
+
+export * from "./ts_def_modules/other/chp";
+export * from "./ts_def_modules/other/lighting_data";
+export * from "./ts_def_modules/other/powerFactor";
+
+export * from "./ts_def_modules/physics/gas_compositions";
+
+export * from "./ts_def_modules/processCooling/chillers";
+export * from "./ts_def_modules/processCooling/process_cooling";
+
+export * from "./ts_def_modules/processHeat/air_heating_using_exhaust";
+export * from "./ts_def_modules/processHeat/cascade_heat_high_to_low";
+export * from "./ts_def_modules/processHeat/energy_equivalency";
+export * from "./ts_def_modules/processHeat/flow_calculations_energy_use";
+export * from "./ts_def_modules/processHeat/o2_enrichment";
+export * from "./ts_def_modules/processHeat/water_heating_using_exhaust";
+
+export * from "./ts_def_modules/processHeat/losses/atmosphere_heat_loss";
+export * from "./ts_def_modules/processHeat/losses/auxiliary_power_used";
+export * from "./ts_def_modules/processHeat/losses/energy_input_electric_arc_furnace";
+export * from "./ts_def_modules/processHeat/losses/energy_input_exhaust_gas_heat_loss";
+export * from "./ts_def_modules/processHeat/losses/exhaust_gas_heat_loss_electric_arc_furnace";
+export * from "./ts_def_modules/processHeat/losses/fixture_heat_loss";
+export * from "./ts_def_modules/processHeat/losses/gas_cooling_heat_loss";
+export * from "./ts_def_modules/processHeat/losses/gas_flue_gas_material";
+export * from "./ts_def_modules/processHeat/losses/gas_load_charge_material_heat_required";
+export * from "./ts_def_modules/processHeat/losses/leakage_heat_loss";
+export * from "./ts_def_modules/processHeat/losses/liquid_cooling_heat_loss";
+export * from "./ts_def_modules/processHeat/losses/liquid_load_charge_material_heat_required";
+export * from "./ts_def_modules/processHeat/losses/load_charge_material";
+export * from "./ts_def_modules/processHeat/losses/opening_heat_loss";
+export * from "./ts_def_modules/processHeat/losses/slag_other_material_heat_loss";
+export * from "./ts_def_modules/processHeat/losses/solid_liquid_flue_gas_material";
+export * from "./ts_def_modules/processHeat/losses/solid_load_charge_material_heat_required";
+export * from "./ts_def_modules/processHeat/losses/wall_heat_loss";
+export * from "./ts_def_modules/processHeat/losses/water_cooling_heat_loss";
+
+export * from "./ts_def_modules/steam/air_water_cooling_using_flue";
+export * from "./ts_def_modules/steam/steam_leak_survey";
+export * from "./ts_def_modules/steam/water_heating_using_flue";
+export * from "./ts_def_modules/steam/water_heating_using_steam";
+
+export * from "./ts_def_modules/steamModeler/ssmt";
+export * from "./ts_def_modules/steamModeler/ssmtEnum";
+export * from "./ts_def_modules/steamModeler/ssmtModeler";
+
+export * from "./ts_def_modules/treasureHunt/compressed_air_pressure_reduction";
+export * from "./ts_def_modules/treasureHunt/compressed_air_reduction";
+export * from "./ts_def_modules/treasureHunt/electricity_reduction";
+export * from "./ts_def_modules/treasureHunt/insulated_pipe_reduction";
+export * from "./ts_def_modules/treasureHunt/insulated_tank_reduction";
+export * from "./ts_def_modules/treasureHunt/natural_gas_reduction";
+export * from "./ts_def_modules/treasureHunt/steam_reduction";
+export * from "./ts_def_modules/treasureHunt/water_reduction";
+
+export * from "./ts_def_modules/wasteWater/svi";
+export * from "./ts_def_modules/wasteWater/wasteWater";
+
+export * from "./ts_def_modules/water/waterAssessment";
+
+declare const _default: (moduleArg?: Record<string, unknown>) => Promise<unknown>;
+export default _default;