@ferscloud/fers-calculation-web 0.2.41 → 0.2.42

package/README.md

@@ -165,6 +165,26 @@ import type { FERS, ResultsBundle } from "@ferscloud/fers-calculation-web/fers-m
 
 `FERS` is the input model; `ResultsBundle` is the `result` payload of a successful envelope. Both are generated from the engine's OpenAPI schema, so they track the published version.
 
+## Deflected shape (optional)
+
+Set `include_member_deflected_shape` in the model's analysis options to get a
+ready-to-plot, **load-exact** deflected shape per member — the member's global
+displacement sampled along its length — instead of reconstructing the curve yourself:
+
+```ts
+const model = {
+  /* … model + load cases … */
+  analysis: { /* … */ options: { /* … */ include_member_deflected_shape: true } },
+};
+
+const res = JSON.parse(calculate_from_json(JSON.stringify(model)));
+const mr = res.result.results.loadcases["…"].member_results["1"];
+// mr.member_displacements: [{ x_frac, displacement: [dx, dy, dz] }, …]
+//   x_frac 0→1 along the member; displacement in the global input frame.
+```
+
+Off by default to keep the payload lean; omitted from `member_results` when not requested.
+
 ## Links
 
 - [Full documentation & getting started](https://ferscloud.com/getting-started)

package/fers-models.d.ts

@@ -312,7 +312,16 @@ export interface components {
          * @enum {string}
          */
         DeflectionComponent: "LocalY" | "LocalZ" | "Magnitude";
-        /** @enum {string} */
+        /**
+         * @description Unit of mass density used by every `Material.density` in the model.
+         *
+         *     Chosen **independently** of `lengthUnit` — a mm/N model may still declare
+         *     `kg/m3` and pass raw values like structural steel's `7850`. Accepted JSON
+         *     tokens are the ASCII strings `"kg/m3"` and `"kg/mm3"` (digit `3`, not the
+         *     superscript `³`); both normalise to SI (kg/m³) internally regardless of the
+         *     length unit. Default: `"kg/m3"`.
+         * @enum {string}
+         */
         DensityUnit: "kg/m3" | "kg/mm3";
         /**
          * @description Python:
@@ -2347,6 +2356,10 @@ export interface components {
         };
         /** @description The model's unit system (length, force, density, pressure) for input and results. */
         UnitSettings: {
+            /**
+             * @description Unit of every `Material.density`; independent of `lengthUnit`
+             *     (a mm/N model may still declare `"kg/m3"`). See [`DensityUnit`].
+             */
             densityUnit?: components["schemas"]["DensityUnit"];
             forceUnit?: components["schemas"]["ForceUnit"];
             lengthUnit?: components["schemas"]["LengthUnit"];

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@ferscloud/fers-calculation-web",
   "type": "module",
-  "version": "0.2.41",
+  "version": "0.2.42",
   "repository": {
     "type": "git",
     "url": "git+https://github.com/Jeroen124/FERS_calculations.git"