@dnv-plant/typescriptpws 1.0.86 → 1.0.88

package/src/constants.ts

@@ -6,10 +6,10 @@
 * Editing it may lead to inconsistent results and limit DNV's ability to provide support.
 * Please contact DNV if you believe changes are required.
 *
-* Version:   1.0.86
-* Date/time: 10 Jul 2025 09:49:05
+* Version:   1.0.89
+* Date/time: 29 Jul 2025 17:59:09
 * Template:  templates/typescriptpws/constants.razor.
- ***********************************************************************/
+***********************************************************************/
 
 export const ABS_TOL_RAD = 0.0000000001;
 // Absolute tolerance for radiation calculations.
@@ -35,6 +35,9 @@ export const BESS_MAX_ANGLE = 90;
 export const BESS_MAX_DURATION = 3600;
 // Maximum duration of a BESS event (s).
 
+export const BESS_MAX_INTERVAL = 1;
+// Maximum value for a user specified confidence interval.
+
 export const BESS_MIN_ANGLE = 0;
 // Minimum release angle for a BESS event (deg.).
 
@@ -50,6 +53,9 @@ export const BESS_MIN_ENERGY = 0;
 export const BESS_MIN_HEIGHT = 0;
 // Minimum release height for a BESS event (m).
 
+export const BESS_MIN_INTERVAL = 0.5;
+// Minimum value for a user specified confidence interval.
+
 export const BESS_MIN_TEMP = 273.15;
 // Minimum gas temperature for a BESS event (K).
 

package/src/entities.ts

@@ -6,10 +6,10 @@
 * Editing it may lead to inconsistent results and limit DNV's ability to provide support.
 * Please contact DNV if you believe changes are required.
 *
-* Version:   1.0.86
-* Date/time: 10 Jul 2025 09:49:06
+* Version:   1.0.89
+* Date/time: 29 Jul 2025 17:59:10
 * Template:  templates/typescriptpws/entities.razor.
- ***********************************************************************/
+***********************************************************************/
 
 import * as Enums from "./enums";
 

package/src/entity-schemas.ts

@@ -6,10 +6,10 @@
 * Editing it may lead to inconsistent results and limit DNV's ability to provide support.
 * Please contact DNV if you believe changes are required.
 *
-* Version:   1.0.86
-* Date/time: 10 Jul 2025 09:49:06
+* Version:   1.0.89
+* Date/time: 29 Jul 2025 17:59:11
 * Template:  templates/typescriptpws/entityschemas.razor.
- ***********************************************************************/
+***********************************************************************/
 
 import * as Enums from "./enums";
 import * as Entities from "./entities";

package/src/enums.ts

@@ -6,10 +6,10 @@
 * Editing it may lead to inconsistent results and limit DNV's ability to provide support.
 * Please contact DNV if you believe changes are required.
 *
-* Version:   1.0.86
-* Date/time: 10 Jul 2025 09:49:06
+* Version:   1.0.89
+* Date/time: 29 Jul 2025 17:59:10
 * Template:  templates/typescriptpws/enums.razor.
- ***********************************************************************/
+***********************************************************************/
 
 /**
  * The Pasquill atmospheric stability classes, a common method for categorizing the amount of atmospheric turbulence present.
@@ -57,29 +57,6 @@ export enum BESSChemistry {
   NMC = 2,
 }
 
-/**
- * Type of case being run.
- */
-export enum CaseType {
-  /** A storage scenario which models a release of material due to rupture of a short length of pipework attached to a vessel or any kind of pressure reservoir. */
-  LINE_RUPTURE = 4,
-
-  /** A storage scenario which models a release of material from the vapour side of a vessel due to the lifting of a relief valve. */
-  RELIEF_VALVE = 3,
-
-  /** A tank roof fire, represented by a pool fire elevated at the height of the tank. */
-  TANK_FIRE = 2,
-
-  /** Case type has not been set. */
-  UNSET = -1,
-
-  /** An instanaeous release of the entire inventory of an associated vessel, intended to model an incident in which the vessel is destroyed by an impact, a crack, or some other failure which propagates very quickly. */
-  VESSEL_CATASTROPHIC_RUPTURE = 1,
-
-  /** A release of material through a hole in a vessel or pipe. */
-  VESSEL_LEAK = 0,
-}
-
 /**
  * Type of contour plot or grid.
  */
@@ -153,7 +130,7 @@ export enum FireType {
   /** A large, intense ball of fire that rises and expands before dissipating. */
   FIREBALL = 1,
 
-  /** A high-velocity burning jet, modelled using the Miller model, which treats the flame as two straight-line segments, with the first segment projected in the direction of the release and the second segment angled according to the effects of buoyancy and wind. */
+  /** A high-velocity burning jet modeled using the Miller model, which represents the flame as two straight segments: the first follows the release direction, and the second bends due to buoyancy and wind effects. */
   MULTI_POINT_SOURCE_JET = 10,
 
   /** No fire occurs or modelled. */

package/src/materials.ts

@@ -6,12 +6,18 @@
 * Editing it may lead to inconsistent results and limit DNV's ability to provide support.
 * Please contact DNV if you believe changes are required.
 *
-* Version:   1.0.86
-* Date/time: 10 Jul 2025 09:49:05
+* Version:   1.0.89
+* Date/time: 29 Jul 2025 17:59:09
 * Template:  templates/typescriptpws/materials.razor.
- ***********************************************************************/
-
-import { getRequest, postRequest, putRequest, getMaterialsApiTarget, getClientAliasId } from "./utilities";
+***********************************************************************/
+
+import {
+  getRequest,
+  postRequest,
+  putRequest,
+  getMaterialsApiTarget,
+  getClientAliasId,
+} from "./utilities";
 import { MaterialSchema, MaterialComponentDataSchema } from "./entity-schemas";
 import { Material, MaterialComponentData } from "./entities";
 
@@ -28,10 +34,7 @@ export class MaterialInfo {
    * @param {string} id - A unique identifier of the material.
    * @param {string} name - The name of the material.
    */
-  constructor(
-    readonly id: string,
-    readonly name: string
-  ) {}
+  constructor(readonly id: string, readonly name: string) {}
 }
 
 export class MaterialCasIdInfo {
@@ -91,7 +94,11 @@ export class MaterialCasIdInfoSchema {
    * @returns A MaterialCasIdInfo instance.
    * @throws Error if validation fails.
    */
-  makeMaterialInfo(data: { id: string; name: string; casId: number }): MaterialCasIdInfo {
+  makeMaterialInfo(data: {
+    id: string;
+    name: string;
+    casId: number;
+  }): MaterialCasIdInfo {
     const { error, value } = this.schema.validate(data);
     if (error) {
       throw new Error(`Validation error: ${error.details[0].message}`);
@@ -150,28 +157,45 @@ export class MaterialEntityDescriptorSchema {
     delete value.extendedProperties;
 
     // Return a new instance of the MaterialEntityDescriptor class.
-    return new MaterialEntityDescriptor(value.id, value.displayName, value.cas_id);
+    return new MaterialEntityDescriptor(
+      value.id,
+      value.displayName,
+      value.cas_id
+    );
   }
 }
 
-async function getDataFromUrl<T>(url: string, schemaClass: SchemaClass, many: boolean = false): Promise<T | T[]> {
-  const { data} = await getRequest(url);
+async function getDataFromUrl<T>(
+  url: string,
+  schemaClass: SchemaClass,
+  many: boolean = false,
+  controller?: AbortController
+): Promise<T | T[]> {
+  const { data } = await getRequest(url, controller);
 
   // Access the Joi schema from the schema class
-  const validationSchema = many ? Joi.array().items(schemaClass.schema) : schemaClass.schema;
+  const validationSchema = many
+    ? Joi.array().items(schemaClass.schema)
+    : schemaClass.schema;
 
   // Validate the data
-  const { error, value } = validationSchema.validate(data, { abortEarly: false });
+  const { error, value } = validationSchema.validate(data, {
+    abortEarly: false,
+  });
 
   if (error) {
-    const errorMessages = error.details.map((e: { message: any }) => e.message).join(", ");
+    const errorMessages = error.details
+      .map((e: { message: any }) => e.message)
+      .join(", ");
     throw new Error(`Error retrieving data: ${errorMessages}`);
   }
 
   return value;
 }
 
-export async function getAllCasIds(): Promise<MaterialCasIdInfo[]> {
+export async function getAllCasIds(
+  controller?: AbortController
+): Promise<MaterialCasIdInfo[]> {
   try {
     // Generate the URL
     const apiTarget = getMaterialsApiTarget();
@@ -179,14 +203,23 @@ export async function getAllCasIds(): Promise<MaterialCasIdInfo[]> {
     const url = `${apiTarget}cas?clientId=${clientAliasId}`;
 
     // Fetch and validate the data
-    return getDataFromUrl(url, new MaterialCasIdInfoSchema(), true) as Promise<MaterialCasIdInfo[]>;
+    return getDataFromUrl(
+      url,
+      new MaterialCasIdInfoSchema(),
+      true,
+      controller
+    ) as Promise<MaterialCasIdInfo[]>;
   } catch (error: unknown) {
-    const errorMessage = error instanceof Error ? error.message : "Unknown error";
+    const errorMessage =
+      error instanceof Error ? error.message : "Unknown error";
     throw new Error(`Error retrieving CAS IDs: ${errorMessage}`);
   }
 }
 
-export async function getMaterialByCasId(casId: number): Promise<Material[]> {
+export async function getMaterialByCasId(
+  casId: number,
+  controller?: AbortController
+): Promise<Material[]> {
   try {
     // Generate the URL
     const apiTarget = getMaterialsApiTarget();
@@ -194,14 +227,25 @@ export async function getMaterialByCasId(casId: number): Promise<Material[]> {
     const url = `${apiTarget}cas/${casId}?clientId=${clientAliasId}`;
 
     // Fetch and validate the data
-    return getDataFromUrl(url, new MaterialSchema(), true) as Promise<Material[]>;
+    return getDataFromUrl(
+      url,
+      new MaterialSchema(),
+      true,
+      controller
+    ) as Promise<Material[]>;
   } catch (error: unknown) {
-    const errorMessage = error instanceof Error ? error.message : "Unknown error";
-    throw new Error(`Error retrieving material with CAS ID ${casId}: ${errorMessage}`);
+    const errorMessage =
+      error instanceof Error ? error.message : "Unknown error";
+    throw new Error(
+      `Error retrieving material with CAS ID ${casId}: ${errorMessage}`
+    );
   }
 }
 
-export async function getComponents(source: number): Promise<MaterialComponentData[]> {
+export async function getComponents(
+  source: number,
+  controller?: AbortController
+): Promise<MaterialComponentData[]> {
   try {
     // Generate the URL
     const apiTarget = getMaterialsApiTarget();
@@ -209,26 +253,41 @@ export async function getComponents(source: number): Promise<MaterialComponentDa
     const url = `${apiTarget}components?clientId=${clientAliasId}&sources=${source}`;
 
     // Fetch and validate the data
-    return getDataFromUrl(url, new MaterialEntityDescriptorSchema(), true) as Promise<MaterialComponentData[]>;
+    return getDataFromUrl(
+      url,
+      new MaterialEntityDescriptorSchema(),
+      true,
+      controller
+    ) as Promise<MaterialComponentData[]>;
   } catch (error: unknown) {
-    const errorMessage = error instanceof Error ? error.message : "Unknown error";
+    const errorMessage =
+      error instanceof Error ? error.message : "Unknown error";
     throw new Error(`Error retrieving components: ${errorMessage}`);
   }
 }
 
-export async function getDnvComponents(): Promise<MaterialComponentData[]> {
-  return getComponents(1);
+export async function getDnvComponents(
+  controller?: AbortController
+): Promise<MaterialComponentData[]> {
+  return getComponents(1, controller);
 }
 
-export async function getDipprComponents(): Promise<MaterialComponentData[]> {
-  return getComponents(2);
+export async function getDipprComponents(
+  controller?: AbortController
+): Promise<MaterialComponentData[]> {
+  return getComponents(2, controller);
 }
 
-export async function getUserComponents(): Promise<MaterialComponentData[]> {
-  return getComponents(3);
+export async function getUserComponents(
+  controller?: AbortController
+): Promise<MaterialComponentData[]> {
+  return getComponents(3, controller);
 }
 
-export async function getComponentById(id: string): Promise<MaterialComponentData> {
+export async function getComponentById(
+  id: string,
+  controller?: AbortController
+): Promise<MaterialComponentData> {
   try {
     // Generate the URL
     const apiTarget = getMaterialsApiTarget();
@@ -236,44 +295,83 @@ export async function getComponentById(id: string): Promise<MaterialComponentDat
     const url = `${apiTarget}components/id=${id}?clientId=${clientAliasId}`;
 
     // Fetch and validate the data
-    return getDataFromUrl(url, new MaterialComponentDataSchema()) as Promise<MaterialComponentData>;
+    return getDataFromUrl(
+      url,
+      new MaterialComponentDataSchema(),
+      false,
+      controller
+    ) as Promise<MaterialComponentData>;
   } catch (error: unknown) {
-    const errorMessage = error instanceof Error ? error.message : "Unknown error";
-    throw new Error(`Error retrieving component with ID ${id}: ${errorMessage}`);
+    const errorMessage =
+      error instanceof Error ? error.message : "Unknown error";
+    throw new Error(
+      `Error retrieving component with ID ${id}: ${errorMessage}`
+    );
   }
 }
 
-export async function getComponentByName(name: string): Promise<MaterialComponentData> {
+export async function getComponentByName(
+  name: string,
+  controller?: AbortController
+): Promise<MaterialComponentData> {
   try {
     // Generate the URL
     const apiTarget = getMaterialsApiTarget();
     const clientAliasId = getClientAliasId();
-    const url = `${apiTarget}components/name=${encodeURIComponent(name)}?clientId=${clientAliasId}`;
+    const url = `${apiTarget}components/name=${encodeURIComponent(
+      name
+    )}?clientId=${clientAliasId}`;
 
     // Fetch and validate the data
-    return getDataFromUrl(url, new MaterialComponentDataSchema()) as Promise<MaterialComponentData>;
+    return getDataFromUrl(
+      url,
+      new MaterialComponentDataSchema(),
+      false,
+      controller
+    ) as Promise<MaterialComponentData>;
   } catch (error: unknown) {
-    const errorMessage = error instanceof Error ? error.message : "Unknown error";
-    throw new Error(`Error retrieving component with name ${name}: ${errorMessage}`);
+    const errorMessage =
+      error instanceof Error ? error.message : "Unknown error";
+    throw new Error(
+      `Error retrieving component with name ${name}: ${errorMessage}`
+    );
   }
 }
 
-export async function getComponentByCasId(casId: number) {
+export async function getComponentByCasId(
+  casId: number,
+  controller?: AbortController
+): Promise<MaterialComponentData> {
   try {
     // Generate the URL
     const apiTarget = getMaterialsApiTarget();
     const clientAliasId = getClientAliasId();
-    const url = `${apiTarget}components/casid=${encodeURIComponent(casId)}?clientId=${clientAliasId}`;
+    const url = `${apiTarget}components/casid=${encodeURIComponent(
+      casId
+    )}?clientId=${clientAliasId}`;
 
     // Fetch and validate the data
-    return getDataFromUrl(url, new MaterialComponentDataSchema()) as Promise<MaterialComponentData>;
+    return getDataFromUrl(
+      url,
+      new MaterialComponentDataSchema(),
+      false,
+      controller
+    ) as Promise<MaterialComponentData>;
   } catch (error: unknown) {
-    const errorMessage = error instanceof Error ? error.message : "Unknown error";
-    throw new Error(`Error retrieving component with CAS ID ${casId}: ${errorMessage}`);
+    const errorMessage =
+      error instanceof Error ? error.message : "Unknown error";
+    throw new Error(
+      `Error retrieving component with CAS ID ${casId}: ${errorMessage}`
+    );
   }
 }
 
-export async function storeDataAndGetResponse<T>(url: string, data: any, schemaClass: SchemaClass): Promise<T> {
+export async function storeDataAndGetResponse<T>(
+  url: string,
+  data: any,
+  schemaClass: SchemaClass,
+  controller?: AbortController
+): Promise<T> {
   // Serialize the data using the schema
   const { error: reqErr, value: payload } = schemaClass.schema.validate(data);
   if (reqErr) {
@@ -282,7 +380,8 @@ export async function storeDataAndGetResponse<T>(url: string, data: any, schemaC
 
   const { status: postStatus, headers } = await postRequest(
     url,
-    JSON.stringify(payload)
+    JSON.stringify(payload),
+    controller
   );
 
   if (postStatus !== 201) {
@@ -294,18 +393,22 @@ export async function storeDataAndGetResponse<T>(url: string, data: any, schemaC
     throw new Error("POST succeeded but no Location header returned");
   }
 
-  const { data: fetched } = await getRequest(location);
+  const { data: fetched } = await getRequest(location, controller);
 
-  const { error: respErr, value: parsed } = schemaClass.schema.validate(fetched);
+  const { error: respErr, value: parsed } =
+    schemaClass.schema.validate(fetched);
   if (respErr) {
-    throw new Error(`Validation error (response): ${respErr.details[0].message}`);
+    throw new Error(
+      `Validation error (response): ${respErr.details[0].message}`
+    );
   }
 
   return parsed as T;
 }
 
 export async function storeMaterialComponentData(
-  materialComponentData: MaterialComponentData
+  materialComponentData: MaterialComponentData,
+  controller?: AbortController
 ): Promise<MaterialComponentData> {
   try {
     // Generate the URL
@@ -314,15 +417,22 @@ export async function storeMaterialComponentData(
     const url = `${apiTarget}components?clientId=${clientAliasId}`;
 
     // Store the data and return the response
-    return storeDataAndGetResponse(url, materialComponentData, new MaterialComponentDataSchema());
+    return storeDataAndGetResponse(
+      url,
+      materialComponentData,
+      new MaterialComponentDataSchema(),
+      controller
+    );
   } catch (error: unknown) {
-    const errorMessage = error instanceof Error ? error.message : "Unknown error";
+    const errorMessage =
+      error instanceof Error ? error.message : "Unknown error";
     throw new Error(`Error storing material component data: ${errorMessage}`);
   }
 }
 
 export async function storeMaterialComponentAndCreateMaterial(
-  materialComponentData: MaterialComponentData
+  materialComponentData: MaterialComponentData,
+  controller?: AbortController
 ): Promise<Material> {
   try {
     // Generate the URL
@@ -331,25 +441,44 @@ export async function storeMaterialComponentAndCreateMaterial(
     const url = `${apiTarget}components/material?clientId=${clientAliasId}`;
 
     // Store the data and return the response
-    return storeDataAndGetResponse(url, materialComponentData, new MaterialSchema());
+    return storeDataAndGetResponse(
+      url,
+      materialComponentData,
+      new MaterialSchema(),
+      controller
+    );
   } catch (error: unknown) {
-    const errorMessage = error instanceof Error ? error.message : "Unknown error";
-    throw new Error(`Error storing material component and creating material: ${errorMessage}`);
+    const errorMessage =
+      error instanceof Error ? error.message : "Unknown error";
+    throw new Error(
+      `Error storing material component and creating material: ${errorMessage}`
+    );
   }
 }
 
-export async function updateMaterialComponent(data: MaterialComponentData): Promise<boolean> {
+export async function updateMaterialComponent(
+  data: MaterialComponentData,
+  controller?: AbortController
+): Promise<boolean> {
   const url = `${getMaterialsApiTarget()}components?clientId=${getClientAliasId()}`;
-  const { status, statusText } = await putRequest(url, JSON.stringify(data));
+  const { status, statusText } = await putRequest(
+    url,
+    JSON.stringify(data),
+    controller
+  );
 
   // Check if the response status is 204 (no content)
   if (status !== 204) {
-    throw new Error(`Failed to update material component: ${status} ${statusText}`);
-  } 
+    throw new Error(
+      `Failed to update material component: ${status} ${statusText}`
+    );
+  }
   return true;
 }
 
-export async function getMaterials(): Promise<Material[]> {
+export async function getMaterials(
+  controller?: AbortController
+): Promise<Material[]> {
   try {
     // Generate the URL
     const apiTarget = getMaterialsApiTarget();
@@ -357,14 +486,23 @@ export async function getMaterials(): Promise<Material[]> {
     const url = `${apiTarget}materials?clientId=${clientAliasId}`;
 
     // Fetch and validate the data
-    return getDataFromUrl(url, new MaterialSchema(), true) as Promise<Material[]>;
+    return getDataFromUrl(
+      url,
+      new MaterialSchema(),
+      true,
+      controller
+    ) as Promise<Material[]>;
   } catch (error: unknown) {
-    const errorMessage = error instanceof Error ? error.message : "Unknown error";
+    const errorMessage =
+      error instanceof Error ? error.message : "Unknown error";
     throw new Error(`Error retrieving materials: ${errorMessage}`);
   }
 }
 
-export async function getMaterialById(id: string): Promise<Material> {
+export async function getMaterialById(
+  id: string,
+  controller?: AbortController
+): Promise<Material> {
   try {
     // Generate the URL
     const apiTarget = getMaterialsApiTarget();
@@ -372,14 +510,23 @@ export async function getMaterialById(id: string): Promise<Material> {
     const url = `${apiTarget}materials/id=${id}?clientId=${clientAliasId}`;
 
     // Fetch and validate the data
-    return getDataFromUrl(url, new MaterialSchema()) as Promise<Material>;
+    return getDataFromUrl(
+      url,
+      new MaterialSchema(),
+      false,
+      controller
+    ) as Promise<Material>;
   } catch (error: unknown) {
-    const errorMessage = error instanceof Error ? error.message : "Unknown error";
+    const errorMessage =
+      error instanceof Error ? error.message : "Unknown error";
     throw new Error(`Error retrieving material with ID ${id}: ${errorMessage}`);
   }
 }
 
-export async function getMaterialByName(name: string): Promise<Material> {
+export async function getMaterialByName(
+  name: string,
+  controller?: AbortController
+): Promise<Material> {
   try {
     // Generate the URL
     const apiTarget = getMaterialsApiTarget();
@@ -387,14 +534,22 @@ export async function getMaterialByName(name: string): Promise<Material> {
     const url = `${apiTarget}materials/name=${name}?clientId=${clientAliasId}`;
 
     // Fetch and validate the data
-    return getDataFromUrl(url, new MaterialSchema()) as Promise<Material>;
+    return getDataFromUrl(
+      url,
+      new MaterialSchema(),
+      false,
+      controller
+    ) as Promise<Material>;
   } catch (error: unknown) {
-    const errorMessage = error instanceof Error ? error.message : "Unknown error";
-    throw new Error(`Error retrieving material with name ${name}: ${errorMessage}`);
+    const errorMessage =
+      error instanceof Error ? error.message : "Unknown error";
+    throw new Error(
+      `Error retrieving material with name ${name}: ${errorMessage}`
+    );
   }
 }
 
-export async function getMaterialNames() {
+export async function getMaterialNames(controller?: AbortController) {
   try {
     // Generate the URL
     const apiTarget = getMaterialsApiTarget();
@@ -402,9 +557,15 @@ export async function getMaterialNames() {
     const url = `${apiTarget}materials/descriptors?clientId=${clientAliasId}`;
 
     // Fetch and validate the data
-    return getDataFromUrl(url, new MaterialInfoSchema(), true) as Promise<MaterialInfo[]>;
+    return getDataFromUrl(
+      url,
+      new MaterialInfoSchema(),
+      true,
+      controller
+    ) as Promise<MaterialInfo[]>;
   } catch (error: unknown) {
-    const errorMessage = error instanceof Error ? error.message : "Unknown error";
+    const errorMessage =
+      error instanceof Error ? error.message : "Unknown error";
     throw new Error(`Error retrieving material names: ${errorMessage}`);
   }
 }