@dnv-plant/typescriptpws 1.0.0-alpha.0

package/src/materials.ts

@@ -0,0 +1,537 @@
+/***********************************************************************
+ * This file has been auto-generated by a code generation tool.
+ * Version:   1.0.0
+ * Date/time: 30 Jan 2025 10:12:17
+ * Template:  templates/typescriptpws/materials.razor.
+ ***********************************************************************/
+
+import {
+  getRequest,
+  postRequest,
+  putRequest,
+  getMaterialsApiTarget,
+  getClientAliasId,
+} from "./utilities";
+import { MaterialSchema, MaterialComponentDataSchema } from "./entity-schemas";
+import { Material, MaterialComponentData } from "./entities";
+
+import Joi from "joi";
+
+interface SchemaClass {
+  schema: Joi.ObjectSchema; // The class must have a `schema` property of type Joi.ObjectSchema
+}
+
+export class MaterialInfo {
+  /**
+   * MaterialInfo class.
+   *
+   * @param {string} id - A unique identifier of the material.
+   * @param {string} name - The name of the material.
+   */
+  constructor(readonly id: string, readonly name: string) {}
+}
+
+export class MaterialCasIdInfo {
+  /**
+   * MaterialCasIdInfo class.
+   *
+   * @param {string} id - A unique identifier of the material.
+   * @param {string} name - The name of the material.
+   * @param {string} casId - The CAS ID of the material.
+   */
+  constructor(
+    readonly id: string,
+    readonly name: string,
+    readonly casId: string
+  ) {}
+}
+
+export class MaterialInfoSchema {
+  schema: Joi.ObjectSchema;
+
+  constructor() {
+    this.schema = Joi.object({
+      id: Joi.string().guid({ version: "uuidv4" }).required(),
+      displayName: Joi.string().required(),
+    }).unknown(true);
+  }
+
+  /**
+   * Validates and transforms data into a MaterialInfo object.
+   * @param data - The input data to validate and transform.
+   * @returns A MaterialInfo instance.
+   * @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);
+  }
+}
+
+export class MaterialCasIdInfoSchema {
+  schema: Joi.ObjectSchema;
+
+  constructor() {
+    this.schema = Joi.object({
+      id: Joi.string().guid({ version: "uuidv4" }).required(),
+      name: Joi.string().required(),
+      casId: Joi.string().required(),
+    }).unknown(true);
+  }
+
+  /**
+   * Validates and transforms data into a MaterialCasIdInfo object.
+   * @param data - The input data to validate and transform.
+   * @returns A MaterialCasIdInfo instance.
+   * @throws Error if validation fails.
+   */
+  makeMaterialInfo(data: {
+    id: string;
+    name: string;
+    casId: string;
+  }): 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);
+  }
+}
+
+export class MaterialEntityDescriptor {
+  /**
+   * MaterialEntityDescriptor class.
+   *
+   * @param {string} id - A unique identifier of the material.
+   * @param {string} name - The name of the material.
+   * @param {string} casId - The CAS ID of the material.
+   */
+  constructor(
+    readonly id: string,
+    readonly name: string,
+    readonly casId: string
+  ) {}
+}
+
+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.string().required(),
+      }).required(),
+    }).unknown(true);
+  }
+
+  /** Validates and transforms data into a MaterialEntityDescriptor object.
+   * @param data - The input data to validate and transform.
+   * @returns A MaterialEntityDescriptor instance.
+   * @throws Error if validation fails.
+   */
+  makeMaterialInfo(data: {
+    id: string;
+    displayName: string;
+    extendedProperties: { casId: string };
+  }): MaterialEntityDescriptor {
+    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;
+
+    // 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
+    );
+  }
+}
+
+async function getDataFromUrl<T>(
+  url: string,
+  schemaClass: SchemaClass,
+  many: boolean = false
+): Promise<T | T[]> {
+  try {
+    const response = await getRequest(url);
+
+    if (response.status !== 200) {
+      throw new Error(
+        `Failed to get data: ${response.status} ${response.statusText}`
+      );
+    }
+
+    const data = response.data;
+
+    // Access the Joi schema from the schema class
+    const validationSchema = many
+      ? Joi.array().items(schemaClass.schema)
+      : schemaClass.schema;
+
+    // Validate the data
+    const { error, value } = validationSchema.validate(data, {
+      abortEarly: false,
+    });
+
+    if (error) {
+      const errorMessages = error.details
+        .map((e: { message: any }) => e.message)
+        .join(", ");
+      throw new Error(`Error retrieving data: ${errorMessages}`);
+    }
+
+    return value;
+  } catch (err: unknown) {
+    throw new Error(
+      `Error retrieving data: ${
+        err instanceof Error ? err.message : "Unknown error"
+      }`
+    );
+  }
+}
+
+export async function getAllCasIds(): Promise<MaterialCasIdInfo[]> {
+  try {
+    // 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) as Promise<
+      MaterialCasIdInfo[]
+    >;
+  } catch (error: unknown) {
+    const errorMessage =
+      error instanceof Error ? error.message : "Unknown error";
+    throw new Error(`Error retrieving CAS IDs: ${errorMessage}`);
+  }
+}
+
+export async function getMaterialByCasId(casId: string): Promise<Material> {
+  try {
+    // Generate the URL
+    const apiTarget = getMaterialsApiTarget();
+    const clientAliasId = getClientAliasId();
+    const url = `${apiTarget}materials/casid=${casId}?clientId=${clientAliasId}`;
+
+    // Fetch and validate the data
+    return getDataFromUrl(url, new MaterialSchema()) 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}`
+    );
+  }
+}
+
+export async function getComponents(
+  source: number
+): Promise<MaterialComponentData[]> {
+  try {
+    // 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
+    ) as Promise<MaterialComponentData[]>;
+  } catch (error: unknown) {
+    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 getDipprComponents(): Promise<MaterialComponentData[]> {
+  return getComponents(2);
+}
+
+export async function getUserComponents(): Promise<MaterialComponentData[]> {
+  return getComponents(3);
+}
+
+export async function getComponentById(
+  id: string
+): Promise<MaterialComponentData> {
+  try {
+    // 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()
+    ) 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}`
+    );
+  }
+}
+
+export async function getComponentByName(
+  name: string
+): Promise<MaterialComponentData> {
+  try {
+    // 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()
+    ) 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}`
+    );
+  }
+}
+
+export async function getComponentByCasId(casId: string) {
+  try {
+    // 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()
+    ) 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}`
+    );
+  }
+}
+
+export async function storeDataAndGetResponse<T>(
+  url: string,
+  data: any,
+  schemaClass: SchemaClass
+): Promise<T> {
+  // Serialize the data using the schema
+
+  const { error, value } = schemaClass.schema.validate(data);
+  if (error) {
+    throw new Error(`Validation error: ${error.details[0].message}`);
+  }
+
+  const jsonText = JSON.stringify(value);
+
+  // Send a POST request
+  const postResponse = await postRequest(url, jsonText);
+
+  // Check if the response status is 201 (created)
+  if (postResponse.status === 201) {
+    const materialUrl = postResponse.headers["location"];
+    if (!materialUrl) {
+      throw new Error("Failed to store data: no location header in response");
+    }
+
+    // Send a GET request to the material URL
+    const getResponse = await getRequest(materialUrl);
+
+    // Check if the GET request is successful
+    if (getResponse.status === 200) {
+      // Validate and parse the response data using the schema
+      const { error, value } = schemaClass.schema.validate(getResponse.data);
+      if (error) {
+        throw new Error(`Validation error: ${error.details[0].message}`);
+      }
+      return value;
+    } else {
+      throw new Error(
+        `Failed to retrieve data: ${getResponse.status} ${getResponse.statusText}`
+      );
+    }
+  } else {
+    throw new Error(
+      `Failed to store data: ${postResponse.status} ${postResponse.statusText}`
+    );
+  }
+}
+
+export async function storeMaterialComponentData(
+  materialComponentData: MaterialComponentData
+): Promise<MaterialComponentData> {
+  try {
+    // 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()
+    );
+  } catch (error: unknown) {
+    const errorMessage =
+      error instanceof Error ? error.message : "Unknown error";
+    throw new Error(`Error storing material component data: ${errorMessage}`);
+  }
+}
+
+export async function storeMaterialComponentAndCreateMaterial(
+  materialComponentData: MaterialComponentData
+): Promise<Material> {
+  try {
+    // 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()
+    );
+  } catch (error: unknown) {
+    const errorMessage =
+      error instanceof Error ? error.message : "Unknown error";
+    throw new Error(
+      `Error storing material component and creating material: ${errorMessage}`
+    );
+  }
+}
+
+export async function updateMaterialComponent(
+  materialComponentData: MaterialComponentData
+): Promise<boolean> {
+  try {
+    // Generate the URL
+    const apiTarget = getMaterialsApiTarget();
+    const clientAliasId = getClientAliasId();
+    const url = `${apiTarget}components?clientId=${clientAliasId}`;
+
+    // Serialize the data
+    const jsonText = JSON.stringify(materialComponentData);
+
+    // Send a PUT request
+    const response = await putRequest(url, jsonText);
+
+    // Check if the response status is 204 (no content)
+    if (response.status === 204) {
+      return true;
+    } else {
+      throw new Error(
+        `Failed to update material component: ${response.status} ${response.statusText}`
+      );
+    }
+  } catch (error: unknown) {
+    const errorMessage =
+      error instanceof Error ? error.message : "Unknown error";
+    throw new Error(`Error updating material component: ${errorMessage}`);
+  }
+}
+
+export async function getMaterials(): Promise<Material[]> {
+  try {
+    // 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) as Promise<
+      Material[]
+    >;
+  } catch (error: unknown) {
+    const errorMessage =
+      error instanceof Error ? error.message : "Unknown error";
+    throw new Error(`Error retrieving materials: ${errorMessage}`);
+  }
+}
+
+export async function getMaterialById(id: string): Promise<Material> {
+  try {
+    // 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()) 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}`);
+  }
+}
+
+export async function getMaterialByName(name: string): Promise<Material> {
+  try {
+    // 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()) 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}`
+    );
+  }
+}
+
+export async function getMaterialNames() {
+  try {
+    // 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) as Promise<
+      MaterialInfo[]
+    >;
+  } catch (error: unknown) {
+    const errorMessage =
+      error instanceof Error ? error.message : "Unknown error";
+    throw new Error(`Error retrieving material names: ${errorMessage}`);
+  }
+}