@dnv-plant/typescriptpws 1.0.0-alpha.1785278 → 1.0.13-alpha.1789228

package/LICENSE

@@ -0,0 +1,19 @@
+Copyright (c) 2025 DNV AS
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -1,20 +1,90 @@
-# Introduction 
-TODO: Give a short introduction of your project. Let this section explain the objectives or the motivation behind this project. 
-
-# Getting Started
-TODO: Guide users through getting your code up and running on their own system. In this section you can talk about:
-1.	Installation process
-2.	Software dependencies
-3.	Latest releases
-4.	API references
-
-# Build and Test
-TODO: Describe and show how to build your code and run the tests. 
-
-# Contribute
-TODO: Explain how other users and developers can contribute to make your code better. 
-
-If you want to learn more about creating good readme files then refer the following [guidelines](https://docs.microsoft.com/en-us/azure/devops/repos/git/create-a-readme?view=azure-devops). You can also seek inspiration from the below readme files:
-- [ASP.NET Core](https://github.com/aspnet/Home)
-- [Visual Studio Code](https://github.com/Microsoft/vscode)
-- [Chakra Core](https://github.com/Microsoft/ChakraCore)
+# PHAST WEB SERVICES
+
+## Introduction
+
+Phast is the world's most comprehensive process hazard analysis software which models the progress of a potential incident from the initial release to far-field dispersion including modelling of pool spreading and evaporation and resulting flammable and toxic effects. In Phast Web Services we have taken the same state of the art consequence modelling calculations and made them available as web services so you can use them in your own applications.
+
+## Consequence analysis
+
+Phast Web services and TypeScript PWS have been developed to enable you to call Phast consequence calculations from within your own TypeScript files.
+
+We have services available for a wide range of consequence calculations:
+
+- Discharge
+- Toxic/flammable gas dispersion
+- Fire and explosion modelling
+- Various supporting, utility calculations
+
+## Reference documentation
+A detailed reference document for Phast Web Services can be found [here](https://phastwebservices.dnv.com/).
+
+## Getting started
+In order to call the Phast Web Services calculations you will need to obtain an access token from DNV.  
+
+## Sample code to perform a vessel leak calculation
+In the following example the **VesselLeakCalculation** is used to predict the release of Methane from a 50mm hole in a horizontal vessel.  In order to get the correct conditions within the vessel the **VesselStateCalculation** is called first and the results from this are passed to the **VesselLeakCalculation** to correctly set it up.
+
+```typescript
+import { VesselLeakCalculation, VesselStateCalculation } from "@dnv-plant/typescriptpws";
+import { DischargeParameters, Leak, Material, MaterialComponent, State, Vessel } from "@dnv-plant/typescriptpws";
+import { ResultCode, TimeVaryingOption, VesselShape } from "@dnv-plant/typescriptpws";
+
+// Define the material contained by the vessel.
+const material = new Material("METHANE", [new MaterialComponent("METHANE", 1.0)]);
+
+// Define the initial state of the vessel.
+const pressure = 2000000; // Pa
+const temperature = 300; // K
+const liquidFraction = 0.0;
+
+const myState = new State(pressure, temperature, liquidFraction);
+
+// Create a vessel state calculation using the material and state.
+const vesselStateCalculation = new VesselStateCalculation();
+vesselStateCalculation.material = material;
+vesselStateCalculation.materialState = myState;
+
+// Run the vessel state calculation.
+vesselStateCalculation.run();
+
+// Create a vessel entity and pass in the results from the VesselStateCalculation.
+const vessel = new Vessel();
+vessel.material = material;
+vessel.state = myState;
+vessel.vesselConditions = vesselStateCalculation.vesselConditions;
+
+// Create a leak to use in the vessel leak calculation.
+// The leak has a hole diameter of 50mm (0.05m). The hole height fraction is set to 0.0, which corresponds to the
+// bottom of the vessel. The time-varying option is set to initial rate.
+const leak = new Leak();
+leak.holeDiameter = 0.05;
+leak.holeHeightFraction = 0.0;
+leak.timeVaryingOption = TimeVaryingOption.INITIAL_RATE;
+
+// Create discharge parameters to use in the vessel leak calculation taking all the default values.
+const dischargeParameters = new DischargeParameters();
+
+// Create a vessel leak calculation using the vessel, leak, and discharge parameters.
+const vesselLeakCalculation = new VesselLeakCalculation();
+vesselLeakCalculation.vessel = vessel;
+vesselLeakCalculation.leak = leak;
+vesselLeakCalculation.dischargeParameters = dischargeParameters;
+
+// Run the vessel leak calculation.
+const resultCode = vesselLeakCalculation.run();
+
+if (resultCode === ResultCode.SUCCESS) {
+    console.log('SUCCESS: vesselLeakCalculation');
+} else {
+    console.log(`FAILED vesselLeakCalculation with result code ${resultCode}`);
+    throw new Error(`Vessel leak calculation failed with result code ${resultCode}`);
+}
+
+// Print any messages.
+if (vesselLeakCalculation.messages.length > 0) {
+    console.log('Messages:');
+    vesselLeakCalculation.messages.forEach((message: string) => console.log(message));
+}
+```
+
+Note that each calculation returns a "Result Code" which can be used to check whether the calculation was successful.  In the event of a failed calculation another property (messages) of the calculation instance can be inspected to display possible reasons for the failed calculation.  These two features are only shown for the vesselLeakCalculation for reasons of brevity.

package/index.ts

@@ -0,0 +1,14 @@
+/***********************************************************************
+ * This file has been auto-generated by a code generation tool.
+ * Version:   1.0.13
+ * Date/time: 03 Feb 2025 21:02:35
+ * Template:  templates/typescriptpws/index.razor.
+ ***********************************************************************/
+
+export * from './src/calculations';
+export * from './src/constants';
+export * from './src/entities';
+export * from './src/entity-schemas';
+export * from './src/enums';
+export * from './src/materials';
+export * from './src/utilities';

package/package.json

@@ -1,14 +1,14 @@
 {
   "name": "@dnv-plant/typescriptpws",
-  "version": "1.0.0-alpha.1785278",
+  "version": "1.0.13-alpha.1789228",
   "description": "Integrate Phast models with our versatile APIs for enhanced customization and efficiency.",
-  "main": "index.js",
+  "main": "index.ts",
   "scripts": {
     "test": "echo \"Error: no test specified\" && exit 1"
   },
   "keywords": [],
-  "author": "",
-  "license": "ISC",
+  "author": "DNV <software.support@dnv.com> (www.dnv.com)",
+  "license": "MIT",
   "dependencies": {
     "axios": "^1.7.9",
     "joi": "^17.13.3",