@eveshipfit/dogma-engine 8.0.0 → 9.0.0

package/esf_dogma_engine.d.ts

@@ -1,7 +1,10 @@
 /* tslint:disable */
 /* eslint-disable */
 
-export function calculate(js_esf_fit: any, js_skills: any): any;
+/**
+ * `js_options` may be left out; it then uses the defaults.
+ */
+export function calculate(js_fit: any, js_options: any): any;
 
 export function init(): void;
 

package/esf_dogma_engine_bg.js

@@ -1,10 +1,11 @@
 /**
- * @param {any} js_esf_fit
- * @param {any} js_skills
+ * `js_options` may be left out; it then uses the defaults.
+ * @param {any} js_fit
+ * @param {any} js_options
  * @returns {any}
  */
-export function calculate(js_esf_fit, js_skills) {
-    const ret = wasm.calculate(js_esf_fit, js_skills);
+export function calculate(js_fit, js_options) {
+    const ret = wasm.calculate(js_fit, js_options);
     if (ret[2]) {
         throw takeFromExternrefTable0(ret[1]);
     }
@@ -45,6 +46,12 @@ export function __wbg_String_8564e559799eccda(arg0, arg1) {
     getDataViewMemory0().setInt32(arg0 + 4 * 1, len1, true);
     getDataViewMemory0().setInt32(arg0 + 4 * 0, ptr1, true);
 }
+export function __wbg___wbindgen_bigint_get_as_i64_b482365c149396c8(arg0, arg1) {
+    const v = arg1;
+    const ret = typeof(v) === 'bigint' ? v : undefined;
+    getDataViewMemory0().setBigInt64(arg0 + 8 * 1, isLikeNone(ret) ? BigInt(0) : ret, true);
+    getDataViewMemory0().setInt32(arg0 + 4 * 0, !isLikeNone(ret), true);
+}
 export function __wbg___wbindgen_boolean_get_7a12af2b3f899c5a(arg0) {
     const v = arg0;
     const ret = typeof(v) === 'boolean' ? v : undefined;
@@ -61,10 +68,18 @@ export function __wbg___wbindgen_in_50072d4d6e45c193(arg0, arg1) {
     const ret = arg0 in arg1;
     return ret;
 }
+export function __wbg___wbindgen_is_bigint_60fc0336cb14f5d7(arg0) {
+    const ret = typeof(arg0) === 'bigint';
+    return ret;
+}
 export function __wbg___wbindgen_is_function_fcda5e3902d732fe(arg0) {
     const ret = typeof(arg0) === 'function';
     return ret;
 }
+export function __wbg___wbindgen_is_null_5160b3e381865372(arg0) {
+    const ret = arg0 === null;
+    return ret;
+}
 export function __wbg___wbindgen_is_object_edb6b15aa3afe12e(arg0) {
     const val = arg0;
     const ret = typeof(val) === 'object' && val !== null;
@@ -78,6 +93,10 @@ export function __wbg___wbindgen_is_undefined_8c687d0b90d5b524(arg0) {
     const ret = arg0 === undefined;
     return ret;
 }
+export function __wbg___wbindgen_jsval_eq_9fdcd3c0a860dd3b(arg0, arg1) {
+    const ret = arg0 === arg1;
+    return ret;
+}
 export function __wbg___wbindgen_jsval_loose_eq_3c30021c243b64cd(arg0, arg1) {
     const ret = arg0 == arg1;
     return ret;
@@ -148,6 +167,16 @@ export function __wbg_instanceof_ArrayBuffer_d4ff01f8247925ae(arg0) {
     const ret = result;
     return ret;
 }
+export function __wbg_instanceof_Map_1ff6a2b54c899f0d(arg0) {
+    let result;
+    try {
+        result = arg0 instanceof Map;
+    } catch (_) {
+        result = false;
+    }
+    const ret = result;
+    return ret;
+}
 export function __wbg_instanceof_Uint8Array_598adc0fef426aa8(arg0) {
     let result;
     try {
@@ -235,12 +264,17 @@ export function __wbindgen_generic_0000000000000001(arg0) {
     const ret = arg0;
     return ret;
 }
-export function __wbindgen_generic_0000000000000002(arg0, arg1) {
+export function __wbindgen_generic_0000000000000002(arg0) {
+    // Cast intrinsic for `I64 -> Externref`.
+    const ret = arg0;
+    return ret;
+}
+export function __wbindgen_generic_0000000000000003(arg0, arg1) {
     // Cast intrinsic for `Ref(String) -> Externref`.
     const ret = getStringFromWasm0(arg0, arg1);
     return ret;
 }
-export function __wbindgen_generic_0000000000000003(arg0) {
+export function __wbindgen_generic_0000000000000004(arg0) {
     // Cast intrinsic for `U64 -> Externref`.
     const ret = BigInt.asUintN(64, arg0);
     return ret;

package/package.json

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

package/README.md

@@ -1,96 +0,0 @@
-# EVEShip.fit's Dogma Engine
-
-This library calculates accurately statistics of an EVE Online ship fit.
-
-The input are several data-files provided by EVE Online, together with a ship fit.
-The output are all the Dogma attributes, containing all the details of the ship.
-
-## Implementation
-
-This Dogma engine implements a multi-pass approach.
-
-- [pass 1](./src/calculate/pass_1.rs): collect all the Dogma attributes of the hull and modules.
-- [pass 2](./src/calculate/pass_2.rs): collect all the Dogma effects of the hull and modules.
-- [pass 3](./src/calculate/pass_3.rs): apply all the Dogma effects to the hull/modules, calculating the actual Dogma attribute values.
-- [pass 4](./src/calculate/pass_4.rs): augment the Dogma attributes with EVEShip.fit specific attributes, that are too complex for the Dogma itself to handle.
-
-## EVEShip.fit's specific attributes
-
-`Pass 4` create Dogma attributes that do not exist in-game, but are rather complicated to calculate.
-To make rendering a fit easier, these are calculated by this library, and presented as new Dogma attributes.
-
-Their identifier is always a negative value, to visually separate them.
-What additional attributes exist are defined in [EVEShipFit/sde-patched](https://github.com/EVEShipFit/sde-patched) repository.
-
-## Development
-
-Make sure you have [Rust installed](https://www.rust-lang.org/tools/install).
-
-Next, we need the data-files.
-They are Flatbuffers, built by [sde-patched](https://github.com/EVEShipFit/sde-patched) and published on npm as [`@eveshipfit/sde`](https://www.npmjs.com/package/@eveshipfit/sde):
-
-```bash
-npm ci
-```
-
-- `sde.dat` holds everything needed to calculate a fit.
-- `names.dat` holds the type names in the other seven languages EVE supports.
-  It is optional.
-
-English names live in `sde.dat`, so an EFT-fit written in English imports without it; `names.dat` is only consulted when a name does not match.
-
-After that, we can run the application.
-
-```bash
-flatc --rust --gen-onefile -o src/sde/ node_modules/@eveshipfit/sde/specs/eve.fbs node_modules/@eveshipfit/sde/specs/names.fbs
-cargo run --release --no-default-features --features rust
-```
-
-The regression suite reads the same paths; set `ESF_SDE` and `ESF_NAMES` to point it elsewhere.
-
-## Regression
-
-The engine is locked down by snapshot tests.
-A case calculates one fit with one set of skills, and compares the result against a stored snapshot in [tests/snapshots](./tests/snapshots).
-
-```bash
-cargo test
-```
-
-If failures are expected differences, use `insta` to resolve them:
-
-```bash
-cargo install cargo-insta
-cargo insta review
-```
-
-## Integration
-
-### Javascript (WebAssembly)
-
-The primary goal of this library is to build a WebAssembly variant that can easily be used in the browser.
-This means that there is no need for a server-component, and everything can be calculated in the browser.
-
-This is done with [wasm-pack](https://rustwasm.github.io/wasm-pack/):
-
-```bash
-cargo install wasm-pack
-wasm-pack build --release -- --no-default-features --features wasm
-```
-
-In the `pkg` folder is now a NPM module to use.
-
-Javascript hands over `sde.dat` once, and every lookup after that happens inside WebAssembly.
-The file is a Flatbuffer, so nothing is parsed: the bytes are used where they land.
-
-```js
-import init, { init as initPanicHook, load_sde, calculate } from "@eveshipfit/dogma-engine";
-
-await init();
-initPanicHook();
-
-const sde = await fetch("/sde.dat").then((response) => response.arrayBuffer());
-const buildNumber = load_sde(new Uint8Array(sde));
-
-const statistics = calculate(fit, skills);
-```