@dnv-plant/typescriptpws 1.0.27 → 1.0.38

package/src/calculations/fireball.ts

@@ -0,0 +1,458 @@
+/***********************************************************************
+ * This file has been auto-generated by a code generation tool.
+ * Version:   1.0.38
+ * Date/time: 24 Mar 2025 16:46:20
+ * Template:  templates/typescriptpws/calculations.razor.
+ ***********************************************************************/
+
+
+
+import * as Enums from "../enums";
+import * as Entities from "../entities";
+import * as EntitySchemas from "../entity-schemas";
+import { getAnalyticsApiTarget, getClientAliasId, postRequest } from "../utilities";
+
+import Joi from "joi";
+import { AxiosResponse } from "axios";
+
+
+class CalculationRequestBase {
+  /**
+   * Calculation request base class.
+   */
+  constructor() {
+    // Base class initialization code
+  }
+}
+
+class CalculationBase {
+  resultCode?: Enums.ResultCode = Enums.ResultCode.SUCCESS;
+  messages: string[] = [];
+  calculationElapsedTime?: number = 0.0;
+  operationId?: string = "";
+
+  /**
+   * Post JSON to URL and time the call
+   */
+  async postRequest(url: string, data: string): Promise<AxiosResponse> {
+    return postRequest(url, data);
+  }
+
+  /**
+   * Utility method to print the messages returned by the calculation.
+   */
+  printMessages(): void {
+    if (this.messages && this.messages.length > 0) {
+      this.messages.forEach((message) => console.log(message));
+    } else {
+      console.log("No messages");
+    }
+  }
+
+  /**
+   * Utility method to handle a failed response.
+   */
+  handleFailedResponse(response: AxiosResponse): void {
+    try {
+      const validatedFailedResponse = new CalculationFailedResponseSchema().validate(response.data);
+
+      this.resultCode = validatedFailedResponse.resultCode;
+      this.messages.push(...(validatedFailedResponse.messages ?? []));
+      this.calculationElapsedTime = validatedFailedResponse.calculationElapsedTime;
+      this.operationId = validatedFailedResponse.operationId;
+    } catch (error) {
+      if (error instanceof Error) {
+        this.messages.push(`Failed to parse response: ${error.message}`);
+      } else {
+        this.messages.push("An unknown error occurred during response parsing.");
+      }
+      console.error("Failed to parse response:", error);
+    } finally {
+      this.messages.push(`${response.statusText} (Status code: ${response.status})`);
+    }
+  }
+}
+
+class CalculationResponseBase {
+  resultCode?: Enums.ResultCode;
+  messages?: string[];
+  calculationElapsedTime?: number;
+  operationId?: string;
+
+  /**
+   * Calculation response base class.
+   */
+  constructor(
+    resultCode?: Enums.ResultCode,
+    messages?: string[],
+    calculationElapsedTime?: number,
+    operationId?: string
+  ) {
+    this.resultCode = resultCode;
+    this.messages = messages;
+    this.calculationElapsedTime = calculationElapsedTime;
+    this.operationId = operationId;
+  }
+}
+
+class CalculationFailedResponse extends CalculationResponseBase {
+  /**
+   * Calculation failed response class.
+   */
+  constructor(
+    resultCode?: Enums.ResultCode,
+    messages: string[] = [],
+    calculationElapsedTime: number = 0,
+    operationId: string = ""
+  ) {
+    super(resultCode, messages, calculationElapsedTime, operationId);
+  }
+}
+
+class CalculationFailedResponseSchema {
+  schema: Joi.ObjectSchema;
+
+  /**
+   * Calculation failed response schema.
+   */
+  constructor() {
+    this.schema = Joi.object({
+      resultCode: Joi.string()
+        .valid(...Object.values(Enums.ResultCode))
+        .required(),
+      messages: Joi.array().items(Joi.string()).required(),
+      calculationElapsedTime: Joi.number().required(),
+      operationId: Joi.string().required(),
+    }).unknown(true);
+  }
+
+  validate(data: {
+    resultCode: Enums.ResultCode;
+    messages: string[];
+    calculationElapsedTime: number;
+    operationId: string;
+  }) {
+    const { error, value } = this.schema.validate(data);
+    if (error) throw new Error(`Validation error: ${error.details.map((x) => x.message).join(", ")}`);
+    return this.makeCalculationFailedResponse(value);
+  }
+
+  makeCalculationFailedResponse(data: {
+    resultCode: Enums.ResultCode;
+    messages: string[];
+    calculationElapsedTime: number;
+    operationId: string;
+  }) {
+    return new CalculationFailedResponse(data.resultCode, data.messages, data.calculationElapsedTime, data.operationId);
+  }
+  }
+    
+export interface FireballCalculationRequestSchemaData {
+  material: Entities.Material;
+  state: Entities.State;
+  dischargeRecords: Entities.DischargeRecord[];
+  dischargeRecordCount: number;
+  dischargeResult: Entities.DischargeResult;
+  weather: Entities.Weather;
+}
+
+class FireballCalculationRequest extends CalculationRequestBase {
+  material: Entities.Material;
+  state: Entities.State;
+  dischargeRecords: Entities.DischargeRecord[];
+  dischargeRecordCount: number;
+  dischargeResult: Entities.DischargeResult;
+  weather: Entities.Weather;
+
+  /**
+   * Fireball calculation request class.
+   *
+   * @param {Entities.Material} material - A Material entity with post-discharge composition.
+   * @param {Entities.State} state - A State entity.
+   * @param {Entities.DischargeRecord[]} dischargeRecords - An Array of Discharge Records.
+   * @param {number} dischargeRecordCount - Number of Discharge Records.
+   * @param {Entities.DischargeResult} dischargeResult - Discharge / source term definition.
+   * @param {Entities.Weather} weather - A Weather entity.
+   */
+  constructor(
+    material: Entities.Material,
+    state: Entities.State,
+    dischargeRecords: Entities.DischargeRecord[],
+    dischargeRecordCount: number,
+    dischargeResult: Entities.DischargeResult,
+    weather: Entities.Weather
+  ) {
+    super();
+    this.material = material;
+    this.state = state;
+    this.dischargeRecords = dischargeRecords;
+    this.dischargeRecordCount = dischargeRecordCount;
+    this.dischargeResult = dischargeResult;
+    this.weather = weather;
+  }
+}
+
+export class FireballCalculationRequestSchema {
+  schema: Joi.ObjectSchema;
+  propertyTypes: Record<string, string>;
+
+  /**
+   * Schema for the Fireball calculation request.
+   */
+  constructor() {
+    this.schema = Joi.object({
+      material: new EntitySchemas.MaterialSchema().schema,
+      state: new EntitySchemas.StateSchema().schema,
+      dischargeRecords: Joi.array().items(new EntitySchemas.DischargeRecordSchema().schema).allow(null),
+      dischargeRecordCount: Joi.number().integer(),
+      dischargeResult: new EntitySchemas.DischargeResultSchema().schema,
+      weather: new EntitySchemas.WeatherSchema().schema,
+    }).unknown(true);
+
+    this.propertyTypes = {
+      material: "Entities.Material",
+      state: "Entities.State",
+      dischargeRecords: "Entities.DischargeRecord[]",
+      dischargeRecordCount: "number",
+      dischargeResult: "Entities.DischargeResult",
+      weather: "Entities.Weather",
+    };
+  }
+
+  validate(data: FireballCalculationRequestSchemaData): FireballCalculationRequest {
+    const { error, value } = this.schema.validate(data, { abortEarly: false });
+    if (error) {
+      throw new Error(`Validation error: ${error.details.map((x) => x.message).join(", ")}`);
+    }
+    return this.makeCalculationRequest(value);
+  }
+
+  makeCalculationRequest(data: FireballCalculationRequestSchemaData): FireballCalculationRequest {
+    return new FireballCalculationRequest(
+      data.material,
+      data.state,
+      data.dischargeRecords,
+      data.dischargeRecordCount,
+      data.dischargeResult,
+      data.weather
+    );
+  }
+}
+
+export class FireballCalculation extends CalculationBase {
+  material: Entities.Material;
+  state: Entities.State;
+  dischargeRecords: Entities.DischargeRecord[];
+  dischargeRecordCount: number;
+  dischargeResult: Entities.DischargeResult;
+  weather: Entities.Weather;
+  flameResult?: Entities.FlameResult;
+  flameRecords?: Entities.FlameRecord[];
+
+  /**
+   * Calculates a fireball produced from an instantaneous or (short duration) time-varying source term.  The utput can be used can be used to run radiation models for prediction of thermal effects.
+   *
+   * @param {Entities.Material} material - A Material entity with post-discharge composition.
+   * @param {Entities.State} state - A State entity.
+   * @param {Entities.DischargeRecord[]} dischargeRecords - An Array of Discharge Records.
+   * @param {number} dischargeRecordCount - Number of Discharge Records.
+   * @param {Entities.DischargeResult} dischargeResult - Discharge / source term definition.
+   * @param {Entities.Weather} weather - A Weather entity.
+   */
+  constructor(
+    material: Entities.Material,
+    state: Entities.State,
+    dischargeRecords: Entities.DischargeRecord[],
+    dischargeRecordCount: number,
+    dischargeResult: Entities.DischargeResult,
+    weather: Entities.Weather
+  ) {
+    super();
+    this.material = material;
+    this.state = state;
+    this.dischargeRecords = dischargeRecords;
+    this.dischargeRecordCount = dischargeRecordCount;
+    this.dischargeResult = dischargeResult;
+    this.weather = weather;
+  }
+
+  async run() {
+    try {
+      const request = new FireballCalculationRequest(
+        this.material,
+        this.state,
+        this.dischargeRecords,
+        this.dischargeRecordCount,
+        this.dischargeResult,
+        this.weather
+      );
+
+      const schema = new FireballCalculationRequestSchema();
+      const validatedRequest = schema.validate(request);
+
+      const requestJson = JSON.stringify(validatedRequest);
+      const url = `${getAnalyticsApiTarget()}calculatefireball?clientId=${getClientAliasId()}`;
+
+      this.resultCode = Enums.ResultCode.UNEXPECTED_APPLICATION_ERROR;
+
+      const response = await this.postRequest(url, requestJson);
+
+      if (response.status >= 200 && response.status < 300) {
+        const schema = new FireballCalculationResponseSchema();
+        const validatedResponse = schema.validate(response.data);
+
+        this.resultCode = validatedResponse.resultCode;
+        if (this.resultCode === Enums.ResultCode.SUCCESS) {
+          this.flameResult = validatedResponse.flameResult;
+          this.flameRecords = validatedResponse.flameRecords;
+          this.resultCode = validatedResponse.resultCode;
+          this.messages = validatedResponse.messages ?? [];
+          this.calculationElapsedTime = validatedResponse.calculationElapsedTime;
+          this.operationId = validatedResponse.operationId;
+        } else {
+          this.messages.push(...(validatedResponse.messages ?? []));
+        }
+      } else {
+        this.handleFailedResponse(response);
+      }
+    } catch (error) {
+      if (error instanceof Error) {
+        this.messages.push(`Error: ${error.message}`);
+      } else {
+        this.messages.push(`Unexpected error: ${JSON.stringify(error)}`);
+      }
+      console.error(error);
+      this.resultCode = Enums.ResultCode.UNEXPECTED_APPLICATION_ERROR;
+    }
+
+    return this.resultCode;
+  }
+
+  toString() {
+    const parts = ["* Fireball"];
+
+    parts.push(`flameResult: ${String(this.flameResult)}`);
+    parts.push("*** flameRecords:");
+    parts.push(
+      this.flameRecords && this.flameRecords.length > 0
+        ? this.flameRecords.map((point) => `flameRecordsElement: ${point}`).join("\n")
+        : "flameRecords does not contain any elements"
+    );
+    parts.push(`resultCode: ${String(this.resultCode)}`);
+    parts.push("*** messages:");
+    parts.push(`messages: ${this.messages !== undefined ? this.messages : "(None)"}`);
+    parts.push(`calculationElapsedTime: ${this.calculationElapsedTime !== undefined ? this.calculationElapsedTime : "(None)"}`);
+    parts.push(`operationId: ${this.operationId !== undefined ? this.operationId : "(None)"}`);
+
+    return parts.join("\n");
+  }
+}
+
+export class FireballCalculationResponse extends CalculationResponseBase {
+  flameResult: Entities.FlameResult;
+  flameRecords: Entities.FlameRecord[];
+
+  /**
+   * Fireball calculation response class.
+   *
+   * @param {Entities.FlameResult} flameResult - Flame scalar result.
+   * @param {Entities.FlameRecord[]} flameRecords - An array of fireball flame records.
+   */
+  constructor(
+    flameResult: Entities.FlameResult,
+    flameRecords: Entities.FlameRecord[],
+    resultCode: Enums.ResultCode,
+    messages: string[],
+    calculationElapsedTime: number,
+    operationId: string
+  ) {
+    super();
+    this.flameResult = flameResult;
+    this.flameRecords = flameRecords;
+    this.resultCode = resultCode;
+    this.messages = messages;
+    this.calculationElapsedTime = calculationElapsedTime;
+    this.operationId = operationId;
+  }
+
+  initialiseFromDictionary(data: { [key: string]: unknown }) {
+    if (data.flameResult) {
+      this.flameResult = new Entities.FlameResult();
+      this.flameResult.initialiseFromDictionary(data.flameResult as { [key: string]: unknown });
+    }
+    if (data.flameRecords && Array.isArray(data.flameRecords)) {
+      this.flameRecords = data.flameRecords.map(
+        (item) => {
+          const record = new Entities.FlameRecord();
+          record.initialiseFromDictionary(item);
+          return record;
+        }
+      );
+    }
+    if (data.resultCode !== undefined && (typeof data.resultCode === "string" || typeof data.resultCode === "number")) {
+      this.resultCode = data.resultCode as Enums.ResultCode;
+    }
+    this.messages = this.messages ?? [];
+    if (data.messages && Array.isArray(data.messages)) {
+      this.messages.push(...data.messages);
+    }
+    if (data.calculationElapsedTime !== undefined && typeof data.calculationElapsedTime === "number") {
+      this.calculationElapsedTime = data.calculationElapsedTime as number;
+    }
+    if (data.operationId !== undefined && typeof data.operationId === "string") {
+      this.operationId = data.operationId as string;
+    }
+  }
+}
+
+export interface FireballCalculationResponseSchemaData {
+  flameResult: Entities.FlameResult;
+  flameRecords: Entities.FlameRecord[];
+  resultCode: Enums.ResultCode;
+  messages: string[];
+  calculationElapsedTime: number;
+  operationId: string;
+}
+
+export class FireballCalculationResponseSchema {
+  schema: Joi.ObjectSchema;
+  propertyTypes: Record<string, string>;
+
+  /**
+   * Schema for the Fireball calculation response.
+   */
+  constructor() {
+    this.schema = Joi.object({
+      flameResult: new EntitySchemas.FlameResultSchema().schema,
+      flameRecords: Joi.array().items(new EntitySchemas.FlameRecordSchema().schema).allow(null),
+      resultCode: Joi.string().valid(...Object.values(Enums.ResultCode)),
+      messages: Joi.array().items(Joi.string()),
+      calculationElapsedTime: Joi.number().unsafe(),
+      operationId: Joi.string().uuid().allow(null),
+    }).unknown(true);
+
+    this.propertyTypes = {
+      flameResult: "Entities.FlameResult",
+      flameRecords: "Entities.FlameRecord[]",
+    };
+  }
+
+  validate(data: FireballCalculationResponseSchemaData): FireballCalculationResponse {
+    const { error, value } = this.schema.validate(data, { abortEarly: false });
+    if (error) {
+      throw new Error(`Validation error: ${error.details.map((x) => x.message).join(", ")}`);
+    }
+    return this.makeCalculationResponse(value);
+  }
+
+  makeCalculationResponse(data: FireballCalculationResponseSchemaData): FireballCalculationResponse {
+    return new FireballCalculationResponse(
+      data.flameResult,
+      data.flameRecords,
+      data.resultCode,
+      data.messages,
+      data.calculationElapsedTime,
+      data.operationId
+    );
+  }
+}