Comment out (temporarily) worker export to resolve CORS issues

Author: nikoscham

src/FEAWorkerScript.js

@@ -1,7 +1,21 @@
+//   ______ ______           _____           _       _     //
+//  |  ____|  ____|   /\    / ____|         (_)     | |    //
+//  | |__  | |__     /  \  | (___   ___ ____ _ ____ | |_   //
+//  |  __| |  __|   / /\ \  \___ \ / __|  __| |  _ \| __|  //
+//  | |    | |____ / ____ \ ____) | (__| |  | | |_) | |    //
+//  |_|    |______/_/    \_\_____/ \___|_|  |_|  __/| |    //
+//                                            | |   | |    //
+//                                            |_|   | |_   //
+//       Website: https://feascript.com/             \__|  //
+
 import * as Comlink from "https://unpkg.com/comlink/dist/esm/comlink.mjs";
 import { basicLog } from "./utilities/utilitiesScript.js";
 
 export class FEAWorkerScript {
+  /**
+   * Constructor to initialize the FEAWorkerScript class
+   * Sets up the worker and initializes the FEAWorkerWrapper.
+   */
   constructor() {
     this.worker = null;
     this.feaWorker = null;
@@ -10,6 +24,11 @@ export class FEAWorkerScript {
     this._initWorker();
   }
 
+  /**
+   * Initializes the web worker and wraps it using Comlink.
+   * @private
+   * @throws Will throw an error if the worker fails to initialize.
+   */
   async _initWorker() {
     try {
       this.worker = new Worker(
@@ -33,6 +52,12 @@ export class FEAWorkerScript {
     }
   }
 
+  /**
+   * Ensures that the worker is ready before performing any operations.
+   * @private
+   * @returns {Promise<void>} Resolves when the worker is ready.
+   * @throws Will throw an error if the worker is not ready within the timeout period.
+   */
   async _ensureReady() {
     if (this.isReady) return Promise.resolve();
 
@@ -54,18 +79,34 @@ export class FEAWorkerScript {
     });
   }
 
+  /**
+   * Sets the solver configuration in the worker.
+   * @param {string} solverConfig - The solver configuration to set.
+   * @returns {Promise<boolean>} Resolves when the configuration is set.
+   */
   async setSolverConfig(solverConfig) {
     await this._ensureReady();
     basicLog(`FEAWorkerScript: Setting solver config to: ${solverConfig}`);
     return this.feaWorker.setSolverConfig(solverConfig);
   }
 
+  /**
+   * Sets the mesh configuration in the worker.
+   * @param {object} meshConfig - The mesh configuration to set.
+   * @returns {Promise<boolean>} Resolves when the configuration is set.
+   */
   async setMeshConfig(meshConfig) {
     await this._ensureReady();
     basicLog(`FEAWorkerScript: Setting mesh config`);
     return this.feaWorker.setMeshConfig(meshConfig);
   }
 
+  /**
+   * Adds a boundary condition to the worker.
+   * @param {string} boundaryKey - The key identifying the boundary.
+   * @param {array} condition - The boundary condition to add.
+   * @returns {Promise<boolean>} Resolves when the boundary condition is added.
+   */
   async addBoundaryCondition(boundaryKey, condition) {
     await this._ensureReady();
     basicLog(
@@ -74,12 +115,21 @@ export class FEAWorkerScript {
     return this.feaWorker.addBoundaryCondition(boundaryKey, condition);
   }
 
+  /**
+   * Sets the solver method in the worker.
+   * @param {string} solverMethod - The solver method to set.
+   * @returns {Promise<boolean>} Resolves when the solver method is set.
+   */
   async setSolverMethod(solverMethod) {
     await this._ensureReady();
     basicLog(`FEAWorkerScript: Setting solver method to: ${solverMethod}`);
     return this.feaWorker.setSolverMethod(solverMethod);
   }
 
+  /**
+   * Requests the worker to solve the problem.
+   * @returns {Promise<object>} Resolves with the solution result.
+   */
   async solve() {
     await this._ensureReady();
     basicLog("FEAWorkerScript: Requesting solution from worker...");
@@ -97,16 +147,27 @@ export class FEAWorkerScript {
     return result;
   }
 
+  /**
+   * Retrieves model information from the worker.
+   * @returns {Promise<object>} Resolves with the model information.
+   */
   async getModelInfo() {
     await this._ensureReady();
     return this.feaWorker.getModelInfo();
   }
 
+  /**
+   * Sends a ping request to the worker to check its availability.
+   * @returns {Promise<boolean>} Resolves if the worker responds.
+   */
   async ping() {
     await this._ensureReady();
     return this.feaWorker.ping();
   }
 
+  /**
+   * Terminates the worker and cleans up resources.
+   */
   terminate() {
     if (this.worker) {
       this.worker.terminate();

src/FEAWrapperScript.js

@@ -1,3 +1,13 @@
+//   ______ ______           _____           _       _     //
+//  |  ____|  ____|   /\    / ____|         (_)     | |    //
+//  | |__  | |__     /  \  | (___   ___ ____ _ ____ | |_   //
+//  |  __| |  __|   / /\ \  \___ \ / __|  __| |  _ \| __|  //
+//  | |    | |____ / ____ \ ____) | (__| |  | | |_) | |    //
+//  |_|    |______/_/    \_\_____/ \___|_|  |_|  __/| |    //
+//                                            | |   | |    //
+//                                            |_|   | |_   //
+//       Website: https://feascript.com/             \__|  //
+
 import * as Comlink from "https://unpkg.com/comlink/dist/esm/comlink.mjs";
 import { FEAScriptModel } from "./FEAScript.js";
 import { create, all } from "https://cdn.jsdelivr.net/npm/mathjs@latest/+esm";
@@ -7,6 +17,11 @@ const math = create(all);
 globalThis.math = math;
 
 class FEAWorkerWrapper {
+  /**
+   * Constructor to initialize the FEAWorkerWrapper class.
+   * Creates an instance of the FEAScriptModel.
+   * @throws Will throw an error if the FEAScriptModel fails to initialize.
+   */
   constructor() {
     try {
       this.model = new FEAScriptModel();
@@ -16,6 +31,12 @@ class FEAWorkerWrapper {
     }
   }
 
+  /**
+   * Sets the solver configuration in the FEAScriptModel.
+   * @param {string} solverConfig - The solver configuration to set.
+   * @returns {boolean} Returns true if the configuration is set successfully.
+   * @throws Will throw an error if the configuration fails to set.
+   */
   setSolverConfig(solverConfig) {
     try {
       this.model.setSolverConfig(solverConfig);
@@ -26,6 +47,12 @@ class FEAWorkerWrapper {
     }
   }
 
+  /**
+   * Sets the mesh configuration in the FEAScriptModel.
+   * @param {object} meshConfig - The mesh configuration to set.
+   * @returns {boolean} Returns true if the configuration is set successfully.
+   * @throws Will throw an error if the configuration fails to set.
+   */
   setMeshConfig(meshConfig) {
     try {
       this.model.setMeshConfig(meshConfig);
@@ -36,6 +63,13 @@ class FEAWorkerWrapper {
     }
   }
 
+  /**
+   * Adds a boundary condition to the FEAScriptModel.
+   * @param {string} boundaryKey - The key identifying the boundary.
+   * @param {array} condition - The boundary condition to add.
+   * @returns {boolean} Returns true if the boundary condition is added successfully.
+   * @throws Will throw an error if the boundary condition fails to add.
+   */
   addBoundaryCondition(boundaryKey, condition) {
     try {
       this.model.addBoundaryCondition(boundaryKey, condition);
@@ -46,6 +80,12 @@ class FEAWorkerWrapper {
     }
   }
 
+  /**
+   * Sets the solver method in the FEAScriptModel.
+   * @param {string} solverMethod - The solver method to set.
+   * @returns {boolean} Returns true if the solver method is set successfully.
+   * @throws Will throw an error if the solver method fails to set.
+   */
   setSolverMethod(solverMethod) {
     try {
       this.model.setSolverMethod(solverMethod);
@@ -56,6 +96,11 @@ class FEAWorkerWrapper {
     }
   }
 
+  /**
+   * Solves the problem using the FEAScriptModel.
+   * @returns {object} Returns the solution result, including the solution vector, node coordinates, solver configuration, and mesh dimension.
+   * @throws Will throw an error if the solve operation fails.
+   */
   solve() {
     try {
       const result = this.model.solve();
@@ -71,6 +116,12 @@ class FEAWorkerWrapper {
       throw error;
     }
   }
+
+  /**
+   * Retrieves model information from the FEAScriptModel.
+   * @returns {object} Returns the model information, including solver configuration, mesh configuration, boundary conditions, and solver method.
+   * @throws Will throw an error if the model information fails to retrieve.
+   */
   getModelInfo() {
     try {
       return {

src/index.js

@@ -11,4 +11,10 @@
 export { FEAScriptModel } from "./FEAScript.js";
 export { plotSolution } from "./visualization/plotSolutionScript.js";
 export { printVersion, logSystem } from "./utilities/utilitiesScript.js";
-export { FEAWorkerScript } from "./FEAWorkerScript.js";
+
+// Temporarily commenting out the worker export to avoid CORS issues
+// The Web Worker functionality relies on the Comlink library which is currently causing CORS errors:
+// - Error: "Loading module from 'https://unpkg.com/comlink/dist/esm/comlink.mjs' was blocked because of a disallowed MIME type ('text/html')"
+// - Error: "Cross-Origin Request Blocked: The Same Origin Policy disallows reading the remote resource"
+//
+// export { FEAWorkerScript } from "./FEAWorkerScript.js";