@dnv-plant/typescriptpws 1.0.97 → 1.0.98-alpha.2397542

package/src/materials.ts

@@ -6,9 +6,9 @@
  * 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.97
- * Date/time: 13 Apr 2026 17:02:52
- * Template:  templates/typescriptpws/materials.razor.
+ * Version:   1.0.0
+ * Date/time: 23 Jun 2026 12:11:11
+ * Template:  TYPE_SCRIPT_PWS/materials.sbn.
  ***********************************************************************/
 
 import { getRequest, postRequest, putRequest, getMaterialsApiTarget, getClientAliasId } from './utilities';
@@ -29,8 +29,8 @@ export class MaterialInfo {
    * @param {string} name - The name of the material.
    */
   constructor(
-    readonly id: string,
-    readonly name: string,
+	readonly id: string,
+	readonly name: string,
   ) {}
 }
 
@@ -43,9 +43,9 @@ export class MaterialCasIdInfo {
    * @param {number} casId - The CAS ID of the material.
    */
   constructor(
-    readonly id: string,
-    readonly name: string,
-    readonly casId: number,
+	readonly id: string,
+	readonly name: string,
+	readonly casId: number,
   ) {}
 }
 
@@ -53,10 +53,10 @@ export class MaterialInfoSchema {
   schema: Joi.ObjectSchema;
 
   constructor() {
-    this.schema = Joi.object({
-      id: Joi.string().guid({ version: 'uuidv4' }).required(),
-      displayName: Joi.string().required(),
-    }).unknown(true);
+	this.schema = Joi.object({
+	  id: Joi.string().guid({ version: 'uuidv4' }).required(),
+	  displayName: Joi.string().required(),
+	}).unknown(true);
   }
 
   /**
@@ -66,11 +66,11 @@ export class MaterialInfoSchema {
    * @throws Error if validation fails.
    */
   makeMaterialInfo(data: { id: string; displayName: string }): MaterialInfo {
-    const { error, value } = this.schema.validate(data);
-    if (error) {
-      throw new Error(`Validation error: ${error.details[0].message}`);
-    }
-    return new MaterialInfo(value.id, value.displayName);
+	const { error, value } = this.schema.validate(data);
+	if (error) {
+	  throw new Error(`Validation error: ${error.details[0].message}`);
+	}
+	return new MaterialInfo(value.id, value.displayName);
   }
 }
 
@@ -78,11 +78,11 @@ export class MaterialCasIdInfoSchema {
   schema: Joi.ObjectSchema;
 
   constructor() {
-    this.schema = Joi.object({
-      id: Joi.string().guid({ version: 'uuidv4' }).required(),
-      name: Joi.string().required(),
-      casId: Joi.number().required(),
-    }).unknown(true);
+	this.schema = Joi.object({
+	  id: Joi.string().guid({ version: 'uuidv4' }).required(),
+	  name: Joi.string().required(),
+	  casId: Joi.number().required(),
+	}).unknown(true);
   }
 
   /**
@@ -92,11 +92,11 @@ export class MaterialCasIdInfoSchema {
    * @throws Error if validation fails.
    */
   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}`);
-    }
-    return new MaterialCasIdInfo(value.id, value.name, value.casId);
+	const { error, value } = this.schema.validate(data);
+	if (error) {
+	  throw new Error(`Validation error: ${error.details[0].message}`);
+	}
+	return new MaterialCasIdInfo(value.id, value.name, value.casId);
   }
 }
 
@@ -109,9 +109,9 @@ export class MaterialEntityDescriptor {
    * @param {number} casId - The CAS ID of the material.
    */
   constructor(
-    readonly id: string,
-    readonly name: string,
-    readonly casId: number,
+	readonly id: string,
+	readonly name: string,
+	readonly casId: number,
   ) {}
 }
 
@@ -119,13 +119,13 @@ export class MaterialEntityDescriptorSchema {
   schema: Joi.ObjectSchema;
 
   constructor() {
-    this.schema = Joi.object({
-      id: Joi.string().guid({ version: 'uuidv4' }).required(),
-      displayName: Joi.string().required(),
-      extendedProperties: Joi.object({
-        casId: Joi.number().required(),
-      }).required(),
-    }).unknown(true);
+	this.schema = Joi.object({
+	  id: Joi.string().guid({ version: 'uuidv4' }).required(),
+	  displayName: Joi.string().required(),
+	  extendedProperties: Joi.object({
+		casId: Joi.number().required(),
+	  }).required(),
+	}).unknown(true);
   }
 
   /** Validates and transforms data into a MaterialEntityDescriptor object.
@@ -134,19 +134,19 @@ export class MaterialEntityDescriptorSchema {
    * @throws Error if validation fails.
    */
   makeMaterialInfo(data: { id: string; displayName: string; extendedProperties: { casId: number } }): MaterialEntityDescriptor {
-    const { error, value } = this.schema.validate(data);
-    if (error) {
-      throw new Error(`Validation error: ${error.details[0].message}`);
-    }
+	const { error, value } = this.schema.validate(data);
+	if (error) {
+	  throw new Error(`Validation error: ${error.details[0].message}`);
+	}
 
-    // Add the cas_id to the data dictionary.
-    value.cas_id = value.extendedProperties.casId;
+	// Add the cas_id to the data dictionary.
+	value.cas_id = value.extendedProperties.casId;
 
-    // Remove the extended_properties from the data dictionary.
-    delete value.extendedProperties;
+	// Remove the extended_properties from the data dictionary.
+	delete value.extendedProperties;
 
-    // Return a new instance of the MaterialEntityDescriptor class.
-    return new MaterialEntityDescriptor(value.id, value.displayName, value.cas_id);
+	// Return a new instance of the MaterialEntityDescriptor class.
+	return new MaterialEntityDescriptor(value.id, value.displayName, value.cas_id);
   }
 }
 
@@ -158,12 +158,12 @@ async function getDataFromUrl<T>(url: string, schemaClass: SchemaClass, many: bo
 
   // Validate the data
   const { error, value } = validationSchema.validate(data, {
-    abortEarly: false,
+	abortEarly: false,
   });
 
   if (error) {
-    const errorMessages = error.details.map((e: { message: any }) => e.message).join(', ');
-    throw new Error(`Error retrieving data: ${errorMessages}`);
+	const errorMessages = error.details.map((e: { message: any }) => e.message).join(', ');
+	throw new Error(`Error retrieving data: ${errorMessages}`);
   }
 
   return value;
@@ -171,46 +171,46 @@ async function getDataFromUrl<T>(url: string, schemaClass: SchemaClass, many: bo
 
 export async function getAllCasIds(controller?: AbortController): Promise<MaterialCasIdInfo[]> {
   try {
-    // Generate the URL
-    const apiTarget = getMaterialsApiTarget();
-    const clientAliasId = getClientAliasId();
-    const url = `${apiTarget}cas?clientId=${clientAliasId}`;
+	// Generate the URL
+	const apiTarget = getMaterialsApiTarget();
+	const clientAliasId = getClientAliasId();
+	const url = `${apiTarget}cas?clientId=${clientAliasId}`;
 
-    // Fetch and validate the data
-    return getDataFromUrl(url, new MaterialCasIdInfoSchema(), true, controller) as Promise<MaterialCasIdInfo[]>;
+	// Fetch and validate the data
+	return getDataFromUrl(url, new MaterialCasIdInfoSchema(), true, controller) as Promise<MaterialCasIdInfo[]>;
   } catch (error: unknown) {
-    const errorMessage = error instanceof Error ? error.message : 'Unknown error';
-    throw new Error(`Error retrieving CAS IDs: ${errorMessage}`);
+	const errorMessage = error instanceof Error ? error.message : 'Unknown error';
+	throw new Error(`Error retrieving CAS IDs: ${errorMessage}`);
   }
 }
 
 export async function getMaterialByCasId(casId: number, controller?: AbortController): Promise<Material[]> {
   try {
-    // Generate the URL
-    const apiTarget = getMaterialsApiTarget();
-    const clientAliasId = getClientAliasId();
-    const url = `${apiTarget}cas/${casId}?clientId=${clientAliasId}`;
+	// Generate the URL
+	const apiTarget = getMaterialsApiTarget();
+	const clientAliasId = getClientAliasId();
+	const url = `${apiTarget}cas/${casId}?clientId=${clientAliasId}`;
 
-    // Fetch and validate the data
-    return getDataFromUrl(url, new MaterialSchema(), true, controller) as Promise<Material[]>;
+	// Fetch and validate the data
+	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, controller?: AbortController): Promise<MaterialComponentData[]> {
   try {
-    // Generate the URL
-    const apiTarget = getMaterialsApiTarget();
-    const clientAliasId = getClientAliasId();
-    const url = `${apiTarget}components?clientId=${clientAliasId}&sources=${source}`;
+	// Generate the URL
+	const apiTarget = getMaterialsApiTarget();
+	const clientAliasId = getClientAliasId();
+	const url = `${apiTarget}components?clientId=${clientAliasId}&sources=${source}`;
 
-    // Fetch and validate the data
-    return getDataFromUrl(url, new MaterialEntityDescriptorSchema(), true, controller) as Promise<MaterialComponentData[]>;
+	// Fetch and validate the data
+	return getDataFromUrl(url, new MaterialEntityDescriptorSchema(), true, controller) as Promise<MaterialComponentData[]>;
   } catch (error: unknown) {
-    const errorMessage = error instanceof Error ? error.message : 'Unknown error';
-    throw new Error(`Error retrieving components: ${errorMessage}`);
+	const errorMessage = error instanceof Error ? error.message : 'Unknown error';
+	throw new Error(`Error retrieving components: ${errorMessage}`);
   }
 }
 
@@ -228,46 +228,46 @@ export async function getUserComponents(controller?: AbortController): Promise<M
 
 export async function getComponentById(id: string, controller?: AbortController): Promise<MaterialComponentData> {
   try {
-    // Generate the URL
-    const apiTarget = getMaterialsApiTarget();
-    const clientAliasId = getClientAliasId();
-    const url = `${apiTarget}components/id=${id}?clientId=${clientAliasId}`;
+	// Generate the URL
+	const apiTarget = getMaterialsApiTarget();
+	const clientAliasId = getClientAliasId();
+	const url = `${apiTarget}components/id=${id}?clientId=${clientAliasId}`;
 
-    // Fetch and validate the data
-    return getDataFromUrl(url, new MaterialComponentDataSchema(), false, controller) as Promise<MaterialComponentData>;
+	// Fetch and validate the data
+	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, controller?: AbortController): Promise<MaterialComponentData> {
   try {
-    // Generate the URL
-    const apiTarget = getMaterialsApiTarget();
-    const clientAliasId = getClientAliasId();
-    const url = `${apiTarget}components/name=${encodeURIComponent(name)}?clientId=${clientAliasId}`;
+	// Generate the URL
+	const apiTarget = getMaterialsApiTarget();
+	const clientAliasId = getClientAliasId();
+	const url = `${apiTarget}components/name=${encodeURIComponent(name)}?clientId=${clientAliasId}`;
 
-    // Fetch and validate the data
-    return getDataFromUrl(url, new MaterialComponentDataSchema(), false, controller) as Promise<MaterialComponentData>;
+	// Fetch and validate the data
+	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, controller?: AbortController): Promise<MaterialComponentData> {
   try {
-    // Generate the URL
-    const apiTarget = getMaterialsApiTarget();
-    const clientAliasId = getClientAliasId();
-    const url = `${apiTarget}components/casid=${encodeURIComponent(casId)}?clientId=${clientAliasId}`;
+	// Generate the URL
+	const apiTarget = getMaterialsApiTarget();
+	const clientAliasId = getClientAliasId();
+	const url = `${apiTarget}components/casid=${encodeURIComponent(casId)}?clientId=${clientAliasId}`;
 
-    // Fetch and validate the data
-    return getDataFromUrl(url, new MaterialComponentDataSchema(), false, controller) as Promise<MaterialComponentData>;
+	// Fetch and validate the data
+	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}`);
   }
 }
 
@@ -275,25 +275,25 @@ export async function storeDataAndGetResponse<T>(url: string, data: any, schemaC
   // Serialize the data using the schema
   const { error: reqErr, value: payload } = schemaClass.schema.validate(data);
   if (reqErr) {
-    throw new Error(`Validation error (request): ${reqErr.details[0].message}`);
+	throw new Error(`Validation error (request): ${reqErr.details[0].message}`);
   }
 
   const { status: postStatus, headers } = await postRequest(url, JSON.stringify(payload), controller);
 
   if (postStatus !== 201) {
-    throw new Error(`Expected 201 from POST, got ${postStatus}`);
+	throw new Error(`Expected 201 from POST, got ${postStatus}`);
   }
 
   const location = headers.location ?? headers.Location; // header name can vary
   if (!location) {
-    throw new Error('POST succeeded but no Location header returned');
+	throw new Error('POST succeeded but no Location header returned');
   }
 
   const { data: fetched } = await getRequest(location, controller);
 
   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;
@@ -301,31 +301,31 @@ export async function storeDataAndGetResponse<T>(url: string, data: any, schemaC
 
 export async function storeMaterialComponentData(materialComponentData: MaterialComponentData, controller?: AbortController): Promise<MaterialComponentData> {
   try {
-    // Generate the URL
-    const apiTarget = getMaterialsApiTarget();
-    const clientAliasId = getClientAliasId();
-    const url = `${apiTarget}components?clientId=${clientAliasId}`;
+	// Generate the URL
+	const apiTarget = getMaterialsApiTarget();
+	const clientAliasId = getClientAliasId();
+	const url = `${apiTarget}components?clientId=${clientAliasId}`;
 
-    // Store the data and return the response
-    return storeDataAndGetResponse(url, materialComponentData, new MaterialComponentDataSchema(), controller);
+	// Store the data and return the response
+	return storeDataAndGetResponse(url, materialComponentData, new MaterialComponentDataSchema(), controller);
   } catch (error: unknown) {
-    const errorMessage = error instanceof Error ? error.message : 'Unknown error';
-    throw new Error(`Error storing material component data: ${errorMessage}`);
+	const errorMessage = error instanceof Error ? error.message : 'Unknown error';
+	throw new Error(`Error storing material component data: ${errorMessage}`);
   }
 }
 
 export async function storeMaterialComponentAndCreateMaterial(materialComponentData: MaterialComponentData, controller?: AbortController): Promise<Material> {
   try {
-    // Generate the URL
-    const apiTarget = getMaterialsApiTarget();
-    const clientAliasId = getClientAliasId();
-    const url = `${apiTarget}components/material?clientId=${clientAliasId}`;
+	// Generate the URL
+	const apiTarget = getMaterialsApiTarget();
+	const clientAliasId = getClientAliasId();
+	const url = `${apiTarget}components/material?clientId=${clientAliasId}`;
 
-    // Store the data and return the response
-    return storeDataAndGetResponse(url, materialComponentData, new MaterialSchema(), controller);
+	// Store the data and return the response
+	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}`);
   }
 }
 
@@ -335,67 +335,67 @@ export async function updateMaterialComponent(data: MaterialComponentData, contr
 
   // 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(controller?: AbortController): Promise<Material[]> {
   try {
-    // Generate the URL
-    const apiTarget = getMaterialsApiTarget();
-    const clientAliasId = getClientAliasId();
-    const url = `${apiTarget}materials?clientId=${clientAliasId}`;
+	// Generate the URL
+	const apiTarget = getMaterialsApiTarget();
+	const clientAliasId = getClientAliasId();
+	const url = `${apiTarget}materials?clientId=${clientAliasId}`;
 
-    // Fetch and validate the data
-    return getDataFromUrl(url, new MaterialSchema(), true, controller) as Promise<Material[]>;
+	// Fetch and validate the data
+	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 materials: ${errorMessage}`);
+	const errorMessage = error instanceof Error ? error.message : 'Unknown error';
+	throw new Error(`Error retrieving materials: ${errorMessage}`);
   }
 }
 
 export async function getMaterialById(id: string, controller?: AbortController): Promise<Material> {
   try {
-    // Generate the URL
-    const apiTarget = getMaterialsApiTarget();
-    const clientAliasId = getClientAliasId();
-    const url = `${apiTarget}materials/id=${id}?clientId=${clientAliasId}`;
+	// Generate the URL
+	const apiTarget = getMaterialsApiTarget();
+	const clientAliasId = getClientAliasId();
+	const url = `${apiTarget}materials/id=${id}?clientId=${clientAliasId}`;
 
-    // Fetch and validate the data
-    return getDataFromUrl(url, new MaterialSchema(), false, controller) as Promise<Material>;
+	// Fetch and validate the data
+	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 ID ${id}: ${errorMessage}`);
+	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, controller?: AbortController): Promise<Material> {
   try {
-    // Generate the URL
-    const apiTarget = getMaterialsApiTarget();
-    const clientAliasId = getClientAliasId();
-    const url = `${apiTarget}materials/name=${name}?clientId=${clientAliasId}`;
+	// Generate the URL
+	const apiTarget = getMaterialsApiTarget();
+	const clientAliasId = getClientAliasId();
+	const url = `${apiTarget}materials/name=${name}?clientId=${clientAliasId}`;
 
-    // Fetch and validate the data
-    return getDataFromUrl(url, new MaterialSchema(), false, controller) as Promise<Material>;
+	// Fetch and validate the data
+	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(controller?: AbortController) {
   try {
-    // Generate the URL
-    const apiTarget = getMaterialsApiTarget();
-    const clientAliasId = getClientAliasId();
-    const url = `${apiTarget}materials/descriptors?clientId=${clientAliasId}`;
+	// Generate the URL
+	const apiTarget = getMaterialsApiTarget();
+	const clientAliasId = getClientAliasId();
+	const url = `${apiTarget}materials/descriptors?clientId=${clientAliasId}`;
 
-    // Fetch and validate the data
-    return getDataFromUrl(url, new MaterialInfoSchema(), true, controller) as Promise<MaterialInfo[]>;
+	// Fetch and validate the data
+	return getDataFromUrl(url, new MaterialInfoSchema(), true, controller) as Promise<MaterialInfo[]>;
   } catch (error: unknown) {
-    const errorMessage = error instanceof Error ? error.message : 'Unknown error';
-    throw new Error(`Error retrieving material names: ${errorMessage}`);
+	const errorMessage = error instanceof Error ? error.message : 'Unknown error';
+	throw new Error(`Error retrieving material names: ${errorMessage}`);
   }
-}
+}