@eveshipfit/dogma-engine 12.0.0 → 13.0.0

package/README.md

@@ -74,6 +74,7 @@ All identifiers are those from the SDE.
 
 - `sources` (optional, default false): report per attribute what its value was calculated from.
   Leave it off unless you show it; it makes the calculation several times bigger.
+- `validate` (optional, default false): also report the fitting rules the fit breaks, as `violations`.
 
 ### Calculation
 
@@ -85,6 +86,8 @@ All identifiers are those from the SDE.
   - `id`: which buff, as `dbuffCollections` in the SDE numbers them.
   - `value`: how strong it is, in whatever the buff's operation reads.
 - `outgoing`: what the fit hands to other fits, in the shape `incoming` takes.
+- `violations`: the fitting rules the fit breaks; only with the `validate` option.
+  Absent means they were not looked for, an empty list means none were broken.
 
 Each result has:
 
@@ -114,9 +117,12 @@ What additional attributes exist are defined in [EVEShipFit/sde-patched](https:/
 
 ## Validation
 
-`validate()` checks if the fit violates any rules that would prevent you from flying it in-game.
-It returns the violations, grouped by the kind of rule and, within a kind, in the order of `items`.
-An empty list means the fit breaks no rules.
+The `validate` option checks if the fit violates any rules that would prevent you from flying it in-game.
+The calculation then carries `violations`, grouped by the kind of rule and, within a kind, in the order of `items`.
+An empty list means the fit breaks no rules; absent means the option was off.
+
+Every rule reads the values after skills and modules changed them, so validation is part of `calculate()`
+rather than a call of its own; asking for both costs one calculation, not two.
 
 Each violation has:
 
@@ -162,7 +168,7 @@ cargo add esf-dogma-engine esf-data
 
 ```rust
 use esf_data::{InfoSde, Sde};
-use esf_dogma_engine::{Fit, Options, beacon, calculate, validate};
+use esf_dogma_engine::{Fit, Options, beacon, calculate};
 
 let bytes = std::fs::read("sde.dat")?;
 let sde = Sde::new(&bytes)?;
@@ -189,8 +195,8 @@ let with_sources = calculate(&info, &fit, &Options { sources: true, ..Default::d
 // Or if you have a beacon in space (like wormhole effects):
 let with_beacon = calculate(&info, &Fit { incoming: beacon(&info, beacon_type_id), ..fit }, &Options::default());
 
-// What EVE would not let you fly:
-let violations = validate(&info, &fit, &calculation);
+// What EVE would not let you fly, in `violations` of the calculation:
+let validated = calculate(&info, &fit, &Options { validate: true, ..Default::default() });
 ```
 
 ### Javascript (WebAssembly)
@@ -213,7 +219,6 @@ import wasmInit, {
   load_eft,
   save_eft,
   calculate,
-  validate,
   beacon,
 } from "@eveshipfit/dogma-engine";
 
@@ -237,8 +242,8 @@ const imported = calculate(load_eft("[Rifter, My Rifter]\n200mm AutoCannon I"));
 /* And to write a fit back out as EFT: */
 const eft = save_eft(fit);
 
-/* What EVE would not let you fly; it calculates the fit itself: */
-const violations = validate(fit);
+/* What EVE would not let you fly, in `violations` of the calculation: */
+const validated = calculate(fit, { validate: true });
 ```
 
 ### Python
@@ -280,8 +285,8 @@ imported = dogma.calculate(dogma.load_eft("[Rifter, My Rifter]\n200mm AutoCannon
 # And to write a fit back out as EFT:
 eft = dogma.save_eft(fit)
 
-# What EVE would not let you fly; it calculates the fit itself:
-violations = dogma.validate(fit)
+# What EVE would not let you fly, in `violations` of the calculation:
+validated = dogma.calculate(fit, {"validate": True})
 ```
 
 Fits and calculations are plain dicts, typed with `TypedDict` in `esf_dogma_engine.types`.

package/esf_dogma_engine.d.ts

@@ -340,6 +340,10 @@ export interface Calculation {
      * All outgoing projections (effects and buffs).
      */
     outgoing?: Projection;
+    /**
+     * The fitting rules the fit breaks; only with `Options::validate`.
+     */
+    violations?: Violation[];
 }
 
 /**
@@ -374,6 +378,10 @@ export interface Options {
      * Report per attribute the modifiers its value was calculated from.
      */
     sources?: boolean;
+    /**
+     * Report the fitting rules the fit breaks.
+     */
+    validate?: boolean;
 }
 
 /**
@@ -462,12 +470,6 @@ export function save_eft(fit: Fit): string;
 
 export function set_panic_hook(): void;
 
-/**
- * Report the fitting rules the fit breaks. Calculates the fit itself, as
- * every rule reads the values after skills and modules changed them.
- */
-export function validate(fit: Fit): Violation[];
-
 export type InitInput = RequestInfo | URL | Response | BufferSource | WebAssembly.Module;
 
 export interface InitOutput {
@@ -479,7 +481,6 @@ export interface InitOutput {
     readonly load_sde: (a: number, b: number) => [number, number, number];
     readonly save_eft: (a: any) => [number, number, number, number];
     readonly set_panic_hook: () => void;
-    readonly validate: (a: any) => [number, number, number];
     readonly __wbindgen_malloc: (a: number, b: number) => number;
     readonly __wbindgen_realloc: (a: number, b: number, c: number, d: number) => number;
     readonly __wbindgen_exn_store: (a: number) => void;

package/esf_dogma_engine.js

@@ -103,20 +103,6 @@ export function save_eft(fit) {
 export function set_panic_hook() {
     wasm.set_panic_hook();
 }
-
-/**
- * Report the fitting rules the fit breaks. Calculates the fit itself, as
- * every rule reads the values after skills and modules changed them.
- * @param {Fit} fit
- * @returns {Violation[]}
- */
-export function validate(fit) {
-    const ret = wasm.validate(fit);
-    if (ret[2]) {
-        throw takeFromExternrefTable0(ret[1]);
-    }
-    return takeFromExternrefTable0(ret[0]);
-}
 function __wbg_get_imports() {
     const import0 = {
         __proto__: null,

package/package.json

@@ -5,7 +5,7 @@
     "EVEShipFit Team <info@eveship.fit>"
   ],
   "description": "Library to calculate statistics for EVE Online ship fits",
-  "version": "12.0.0",
+  "version": "13.0.0",
   "license": "MIT",
   "repository": {
     "type": "git",