@eveshipfit/dogma-engine 13.0.1 → 13.2.0

package/README.md

@@ -30,6 +30,10 @@ import wasmInit, {
   load_sde,
   load_eft,
   save_eft,
+  load_esi_fitting,
+  save_esi_fitting,
+  load_killmail,
+  load_link,
   calculate,
   beacon,
 } from "@eveshipfit/dogma-engine";
@@ -53,6 +57,13 @@ const withBeacon = calculate({ ...fit, incoming: beacon(beaconTypeId) });
 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);
+/* Or if you have a fitting a character saved in game, as ESI returns it (and the other way around): */
+const fromEsi = load_esi_fitting(fitting);
+const toEsi = save_esi_fitting(fit);
+/* Or if you have a killmail, as ESI returns it, for the fit of the ship that died: */
+const fromKillmail = load_killmail(killmail);
+/* Or if you have an EVEShip.fit link, `<version>:<payload>`, with the payload gunzipped and unbase64'd: */
+const fromLink = load_link(version, payload);
 
 /* What EVE would not let you fly, in `violations` of the calculation: */
 const validated = calculate(fit, { validate: true });

package/esf_dogma_engine.d.ts

@@ -10,6 +10,47 @@ export interface Charge {
     type_id: number;
 }
 
+/**
+ * A fitting as ESI saves it for a character.
+ */
+export interface EsiFitting {
+    /**
+     * Only on fittings ESI returns.
+     */
+    fitting_id?: number;
+    /**
+     * The name of the fitting.
+     */
+    name: string;
+    /**
+     * The description of the fitting.
+     */
+    description?: string;
+    /**
+     * The type id of the ship.
+     */
+    ship_type_id: number;
+    /**
+     * Everything on and in the ship.
+     */
+    items: EsiFittingItem[];
+}
+
+/**
+ * A killmail as ESI returns it; only what a fit is made from. Anything else
+ * in it is ignored.
+ */
+export interface EsiKillmail {
+    /**
+     * The id of the killmail.
+     */
+    killmail_id: number;
+    /**
+     * The ship that died.
+     */
+    victim: EsiKillmailVictim;
+}
+
 /**
  * A module, drone, fighter squadron, implant, booster or item in cargo.
  */
@@ -138,6 +179,46 @@ export interface Fit {
     incoming?: Projection;
 }
 
+/**
+ * An item of a killmail.
+ */
+export interface EsiKillmailItem {
+    /**
+     * An inventory flag, like 27 for the first high slot.
+     */
+    flag: number;
+    /**
+     * The type id of the item.
+     */
+    item_type_id: number;
+    /**
+     * How many of the item were destroyed.
+     */
+    quantity_destroyed?: number;
+    /**
+     * How many of the item dropped.
+     */
+    quantity_dropped?: number;
+}
+
+/**
+ * An item of an ESI fitting.
+ */
+export interface EsiFittingItem {
+    /**
+     * An inventory flag by name, like `HiSlot0`, `DroneBay` or `Cargo`.
+     */
+    flag: string;
+    /**
+     * How many of the item.
+     */
+    quantity: number;
+    /**
+     * The type id of the item.
+     */
+    type_id: number;
+}
+
 /**
  * How a modifier changes an attribute. They are applied in this order.
  */
@@ -370,6 +451,20 @@ export interface Ship {
  */
 export type State = "offline" | "online" | "active" | "overload";
 
+/**
+ * The victim of a killmail.
+ */
+export interface EsiKillmailVictim {
+    /**
+     * The type id of the ship.
+     */
+    ship_type_id: number;
+    /**
+     * Everything on and in the ship.
+     */
+    items?: EsiKillmailItem[];
+}
+
 /**
  * What [`calculate()`] reports on top of the values.
  */
@@ -450,6 +545,32 @@ export function calculate(fit: Fit, options?: Options | null): Calculation;
  */
 export function load_eft(eft: string): Fit;
 
+/**
+ * Load a fit from an esf/1 document, as text.
+ */
+export function load_esf(text: string): Fit;
+
+/**
+ * Load a fit from an esf/1 link: the binary form, in base64url.
+ */
+export function load_esf_link(link: string): Fit;
+
+/**
+ * Load a fit from an ESI fitting, the fits a character saves in game.
+ */
+export function load_esi_fitting(fitting: EsiFitting): Fit;
+
+/**
+ * Load the fit of the ship that died from a killmail, as ESI returns it.
+ */
+export function load_killmail(killmail: EsiKillmail): Fit;
+
+/**
+ * Load a fit from an EVEShip.fit link, given its version and its payload
+ * once unbase64'd and gunzipped.
+ */
+export function load_link(version: string, payload: string): Fit;
+
 /**
  * Load `names.dat`, so an EFT written in another language than English also
  * imports. Optional; without it only English names match. Has to be called
@@ -468,6 +589,21 @@ export function load_sde(bytes: Uint8Array): number;
  */
 export function save_eft(fit: Fit): string;
 
+/**
+ * Write a fit as an esf/1 document, as text.
+ */
+export function save_esf(fit: Fit): string;
+
+/**
+ * Write a fit as an esf/1 link: the binary form, in base64url.
+ */
+export function save_esf_link(fit: Fit): string;
+
+/**
+ * Write a fit as an ESI fitting, the fits a character saves in game.
+ */
+export function save_esi_fitting(fit: Fit): EsiFitting;
+
 export function set_panic_hook(): void;
 
 export type InitInput = RequestInfo | URL | Response | BufferSource | WebAssembly.Module;
@@ -477,9 +613,17 @@ export interface InitOutput {
     readonly beacon: (a: number) => [number, number, number];
     readonly calculate: (a: any, b: number) => [number, number, number];
     readonly load_eft: (a: number, b: number) => [number, number, number];
+    readonly load_esf: (a: number, b: number) => [number, number, number];
+    readonly load_esf_link: (a: number, b: number) => [number, number, number];
+    readonly load_esi_fitting: (a: any) => [number, number, number];
+    readonly load_killmail: (a: any) => [number, number, number];
+    readonly load_link: (a: number, b: number, c: number, d: number) => [number, number, number];
     readonly load_names: (a: number, b: number) => [number, number, number];
     readonly load_sde: (a: number, b: number) => [number, number, number];
     readonly save_eft: (a: any) => [number, number, number, number];
+    readonly save_esf: (a: any) => [number, number, number, number];
+    readonly save_esf_link: (a: any) => [number, number, number, number];
+    readonly save_esi_fitting: (a: any) => [number, number, number];
     readonly set_panic_hook: () => void;
     readonly __wbindgen_malloc: (a: number, b: number) => number;
     readonly __wbindgen_realloc: (a: number, b: number, c: number, d: number) => number;

package/esf_dogma_engine.js

@@ -43,6 +43,81 @@ export function load_eft(eft) {
     return takeFromExternrefTable0(ret[0]);
 }
 
+/**
+ * Load a fit from an esf/1 document, as text.
+ * @param {string} text
+ * @returns {Fit}
+ */
+export function load_esf(text) {
+    const ptr0 = passStringToWasm0(text, wasm.__wbindgen_malloc, wasm.__wbindgen_realloc);
+    const len0 = WASM_VECTOR_LEN;
+    const ret = wasm.load_esf(ptr0, len0);
+    if (ret[2]) {
+        throw takeFromExternrefTable0(ret[1]);
+    }
+    return takeFromExternrefTable0(ret[0]);
+}
+
+/**
+ * Load a fit from an esf/1 link: the binary form, in base64url.
+ * @param {string} link
+ * @returns {Fit}
+ */
+export function load_esf_link(link) {
+    const ptr0 = passStringToWasm0(link, wasm.__wbindgen_malloc, wasm.__wbindgen_realloc);
+    const len0 = WASM_VECTOR_LEN;
+    const ret = wasm.load_esf_link(ptr0, len0);
+    if (ret[2]) {
+        throw takeFromExternrefTable0(ret[1]);
+    }
+    return takeFromExternrefTable0(ret[0]);
+}
+
+/**
+ * Load a fit from an ESI fitting, the fits a character saves in game.
+ * @param {EsiFitting} fitting
+ * @returns {Fit}
+ */
+export function load_esi_fitting(fitting) {
+    const ret = wasm.load_esi_fitting(fitting);
+    if (ret[2]) {
+        throw takeFromExternrefTable0(ret[1]);
+    }
+    return takeFromExternrefTable0(ret[0]);
+}
+
+/**
+ * Load the fit of the ship that died from a killmail, as ESI returns it.
+ * @param {EsiKillmail} killmail
+ * @returns {Fit}
+ */
+export function load_killmail(killmail) {
+    const ret = wasm.load_killmail(killmail);
+    if (ret[2]) {
+        throw takeFromExternrefTable0(ret[1]);
+    }
+    return takeFromExternrefTable0(ret[0]);
+}
+
+/**
+ * Load a fit from an EVEShip.fit link, given its version and its payload
+ * once unbase64'd and gunzipped.
+ * @param {string} version
+ * @param {string} payload
+ * @returns {Fit}
+ */
+export function load_link(version, payload) {
+    const ptr0 = passStringToWasm0(version, wasm.__wbindgen_malloc, wasm.__wbindgen_realloc);
+    const len0 = WASM_VECTOR_LEN;
+    const ptr1 = passStringToWasm0(payload, wasm.__wbindgen_malloc, wasm.__wbindgen_realloc);
+    const len1 = WASM_VECTOR_LEN;
+    const ret = wasm.load_link(ptr0, len0, ptr1, len1);
+    if (ret[2]) {
+        throw takeFromExternrefTable0(ret[1]);
+    }
+    return takeFromExternrefTable0(ret[0]);
+}
+
 /**
  * Load `names.dat`, so an EFT written in another language than English also
  * imports. Optional; without it only English names match. Has to be called
@@ -100,6 +175,67 @@ export function save_eft(fit) {
     }
 }
 
+/**
+ * Write a fit as an esf/1 document, as text.
+ * @param {Fit} fit
+ * @returns {string}
+ */
+export function save_esf(fit) {
+    let deferred2_0;
+    let deferred2_1;
+    try {
+        const ret = wasm.save_esf(fit);
+        var ptr1 = ret[0];
+        var len1 = ret[1];
+        if (ret[3]) {
+            ptr1 = 0; len1 = 0;
+            throw takeFromExternrefTable0(ret[2]);
+        }
+        deferred2_0 = ptr1;
+        deferred2_1 = len1;
+        return getStringFromWasm0(ptr1, len1);
+    } finally {
+        wasm.__wbindgen_free(deferred2_0, deferred2_1, 1);
+    }
+}
+
+/**
+ * Write a fit as an esf/1 link: the binary form, in base64url.
+ * @param {Fit} fit
+ * @returns {string}
+ */
+export function save_esf_link(fit) {
+    let deferred2_0;
+    let deferred2_1;
+    try {
+        const ret = wasm.save_esf_link(fit);
+        var ptr1 = ret[0];
+        var len1 = ret[1];
+        if (ret[3]) {
+            ptr1 = 0; len1 = 0;
+            throw takeFromExternrefTable0(ret[2]);
+        }
+        deferred2_0 = ptr1;
+        deferred2_1 = len1;
+        return getStringFromWasm0(ptr1, len1);
+    } finally {
+        wasm.__wbindgen_free(deferred2_0, deferred2_1, 1);
+    }
+}
+
+/**
+ * Write a fit as an ESI fitting, the fits a character saves in game.
+ * @param {Fit} fit
+ * @returns {EsiFitting}
+ */
+export function save_esi_fitting(fit) {
+    const ret = wasm.save_esi_fitting(fit);
+    if (ret[2]) {
+        throw takeFromExternrefTable0(ret[1]);
+    }
+    return takeFromExternrefTable0(ret[0]);
+}
+
 export function set_panic_hook() {
     wasm.set_panic_hook();
 }

package/package.json

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