@ferscloud/fers-calculation-web 0.2.69 → 0.2.71

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/LICENSE CHANGED
@@ -1,12 +1,65 @@
1
- BSD 3-Clause License
1
+ Copyright (c) 2024-2026 Jeroen Hermsen
2
2
 
3
- Copyright (c) 2024, Jeroen Hermsen
4
- All rights reserved.
3
+ The FERS solver engine is free for any noncommercial purpose under the
4
+ PolyForm Strict License 1.0.0 below. Commercial use requires a commercial
5
+ licence, which comes with a paid FERS Cloud plan: https://ferscloud.com/pricing
5
6
 
6
- Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:
7
+ # PolyForm Strict License 1.0.0
7
8
 
8
- 1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
9
- 2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.
10
- 3. Neither the name of the Jeroen Hermsen nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.
9
+ <https://polyformproject.org/licenses/strict/1.0.0>
11
10
 
12
- THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
11
+ ## Acceptance
12
+
13
+ In order to get any license under these terms, you must agree to them as both strict obligations and conditions to all your licenses.
14
+
15
+ ## Copyright License
16
+
17
+ The licensor grants you a copyright license for the software to do everything you might do with the software that would otherwise infringe the licensor's copyright in it for any permitted purpose, other than distributing the software or making changes or new works based on the software.
18
+
19
+ ## Patent License
20
+
21
+ The licensor grants you a patent license for the software that covers patent claims the licensor can license, or becomes able to license, that you would infringe by using the software.
22
+
23
+ ## Noncommercial Purposes
24
+
25
+ Any noncommercial purpose is a permitted purpose.
26
+
27
+ ## Personal Uses
28
+
29
+ Personal use for research, experiment, and testing for the benefit of public knowledge, personal study, private entertainment, hobby projects, amateur pursuits, or religious observance, without any anticipated commercial application, is use for a permitted purpose.
30
+
31
+ ## Noncommercial Organizations
32
+
33
+ Use by any charitable organization, educational institution, public research organization, public safety or health organization, environmental protection organization, or government institution is use for a permitted purpose regardless of the source of funding or obligations resulting from the funding.
34
+
35
+ ## Fair Use
36
+
37
+ You may have "fair use" rights for the software under the law. These terms do not limit them.
38
+
39
+ ## No Other Rights
40
+
41
+ These terms do not allow you to sublicense or transfer any of your licenses to anyone else, or prevent the licensor from granting licenses to anyone else. These terms do not imply any other licenses.
42
+
43
+ ## Patent Defense
44
+
45
+ If you make any written claim that the software infringes or contributes to infringement of any patent, your patent license for the software granted under these terms ends immediately. If your company makes such a claim, your patent license ends immediately for work on behalf of your company.
46
+
47
+ ## Violations
48
+
49
+ The first time you are notified in writing that you have violated any of these terms, or done anything with the software not covered by your licenses, your licenses can nonetheless continue if you come into full compliance with these terms, and take practical steps to correct past violations, within 32 days of receiving notice. Otherwise, all your licenses end immediately.
50
+
51
+ ## No Liability
52
+
53
+ ***As far as the law allows, the software comes as is, without any warranty or condition, and the licensor will not be liable to you for any damages arising out of these terms or the use or nature of the software, under any kind of legal claim.***
54
+
55
+ ## Definitions
56
+
57
+ The **licensor** is the individual or entity offering these terms, and the **software** is the software the licensor makes available under these terms.
58
+
59
+ **You** refers to the individual or entity agreeing to these terms.
60
+
61
+ **Your company** is any legal entity, sole proprietorship, or other kind of organization that you work for, plus all organizations that have control over, are under the control of, or are under common control with that organization. **Control** means ownership of substantially all the assets of an entity, or the power to direct its management and policies by vote, contract, or otherwise. Control can be direct or indirect.
62
+
63
+ **Your licenses** are all the licenses granted to you for the software under these terms.
64
+
65
+ **Use** means anything you do with the software requiring one of your licenses.
package/README.md CHANGED
@@ -56,7 +56,7 @@ module.exports = {
56
56
 
57
57
  The solver is synchronous and CPU-bound; for large models run it inside a Web Worker so the UI thread stays responsive. The Node.js package (`@ferscloud/fers-calculation`) needs no bundler config.
58
58
 
59
- ## Quick start — free tier (up to 100 members)
59
+ ## Quick start — free tier (non-commercial, up to 100 members)
60
60
 
61
61
  ```ts
62
62
  import { calculate_from_json } from "@ferscloud/fers-calculation";
@@ -155,6 +155,7 @@ If the token is missing, expired, or invalid, the solver falls back to the free
155
155
 
156
156
  | Feature | Free | Pro |
157
157
  |---|---|---|
158
+ | Use | Non-commercial | Commercial and non-commercial |
158
159
  | Max members | 100 | 10 000 |
159
160
  | WASM function | `calculate_from_json` | `calculate_from_json_with_token` |
160
161
  | Requires token | No | Yes |
@@ -215,8 +216,19 @@ On 0.2.61 this subpath resolved only under a bundler; plain Node ESM needed
215
216
  `/badge.js`. From 0.2.62 the package ships an `exports` map and both forms work
216
217
  everywhere.
217
218
 
218
- Using the free tier in an application? Please display the credit. It is the
219
- only thing the free tier asks of you.
219
+ Using the free tier in a non-commercial application? Please display the
220
+ credit.
221
+
222
+ ## Licence
223
+
224
+ From 0.2.70 the engine is licensed under the PolyForm Strict License 1.0.0
225
+ (see `LICENSE`). It is free for any noncommercial purpose: study, teaching,
226
+ research, hobby projects, and use by schools, charities and public bodies.
227
+ Models of more than 100 members need a Pro solve token.
228
+
229
+ Commercial use, at any model size, needs a paid
230
+ [FERS Cloud plan](https://ferscloud.com/pricing), which includes the commercial
231
+ licence. The licence does not allow modifying or redistributing the package.
220
232
 
221
233
  ## Links
222
234
 
package/fers-models.d.ts CHANGED
@@ -1067,6 +1067,23 @@ export interface components {
1067
1067
  /** Format: int32 */
1068
1068
  load_case_id: number;
1069
1069
  };
1070
+ /**
1071
+ * @description A load case that failed its own second-order solve (`solve_loadcases` with a
1072
+ * nonlinear order). It is absent from `ResultsBundle::loadcases`; the load
1073
+ * combinations are still solved, cold-started where this case would have fed
1074
+ * their warm start. Until 0.2.70 one such failure aborted the whole analysis.
1075
+ */
1076
+ LoadCaseSolveFailure: {
1077
+ /** @description Human-readable solver error (non-convergence, singular system, …). */
1078
+ error: string;
1079
+ /**
1080
+ * Format: int32
1081
+ * @description Id of the load case that failed to solve.
1082
+ */
1083
+ load_case_id: number;
1084
+ /** @description Name of the load case that failed to solve. */
1085
+ name: string;
1086
+ };
1070
1087
  /** @description A factored combination of load cases for a given limit state (SLS/ULS/FLS/ALS). */
1071
1088
  LoadCombination: {
1072
1089
  check: string;
@@ -2592,6 +2609,13 @@ export interface components {
2592
2609
  * broken one without inspecting the wheel.
2593
2610
  */
2594
2611
  engine_version?: string;
2612
+ /**
2613
+ * @description Load cases that failed their second-order solve and are therefore
2614
+ * missing from `loadcases`. The combinations were still solved. Inspect
2615
+ * before trusting per-case results or anything derived from them.
2616
+ * @default []
2617
+ */
2618
+ load_case_failures: components["schemas"]["LoadCaseSolveFailure"][];
2595
2619
  loadcases: {
2596
2620
  [key: string]: components["schemas"]["Results"];
2597
2621
  };
@@ -3060,7 +3084,13 @@ export interface components {
3060
3084
  * `"P_DELTA"`, or `"COROTATIONAL"`.
3061
3085
  */
3062
3086
  analysis_method?: string | null;
3063
- /** @description Whether the solve converged. Linear solves report `true`. */
3087
+ /**
3088
+ * @description Whether the solve converged. Linear solves report `true`. A second-order
3089
+ * solve whose displacement stopped changing is accepted at any residual,
3090
+ * but reports `false` once that residual is more than a hundred times the
3091
+ * tolerance; the warning `second_order_residual_floor` then says how far
3092
+ * from equilibrium it stopped and why.
3093
+ */
3064
3094
  converged?: boolean;
3065
3095
  /**
3066
3096
  * Format: int32
@@ -3071,8 +3101,12 @@ export interface components {
3071
3101
  iterations?: number | null;
3072
3102
  /**
3073
3103
  * Format: double
3074
- * @description Final relative residual norm at convergence (nonlinear solves). `None`
3075
- * for linear solves where no residual is iterated.
3104
+ * @description Final relative residual norm (nonlinear solves): `‖f_int − f_ext‖ / ‖f_ext‖`
3105
+ * at the accepted state, measured in a unit-consistent norm in which
3106
+ * moment rows are divided by the median member length and bimoment rows by
3107
+ * its square, so the number means the same for a model entered in
3108
+ * millimetres as in metres. `None` for linear solves where no residual is
3109
+ * iterated.
3076
3110
  */
3077
3111
  residual_norm?: number | null;
3078
3112
  /**
Binary file
package/package.json CHANGED
@@ -1,8 +1,8 @@
1
1
  {
2
2
  "name": "@ferscloud/fers-calculation-web",
3
3
  "type": "module",
4
- "version": "0.2.69",
5
- "license": "BSD-3-Clause",
4
+ "version": "0.2.71",
5
+ "license": "SEE LICENSE IN LICENSE",
6
6
  "repository": {
7
7
  "type": "git",
8
8
  "url": "git+https://github.com/Jeroen124/FERS_calculations.git"