screeps-clockwork 0.10.0 → 0.12.0

package/dist/src/index.d.ts

@@ -11,6 +11,8 @@ export * from './wrappers/monoFlowField';
 export * from './wrappers/multiroomFlowField';
 export * from './wrappers/multiroomMonoFlowField';
 export * from './wrappers/path';
+export type { ClockworkDistanceMap } from './wrappers/distanceMap';
+export type { ClockworkMultiroomDistanceMap } from './wrappers/multiroomDistanceMap';
 /**
  * The `initialize` function should be called in your main loop before
  * using any other screeps-clockwork functions. Depending on available

package/dist/src/utils/fromPacked.d.ts

@@ -1,3 +1,4 @@
 export declare function fromPacked(packedPos: number): RoomPosition;
 export declare function fromPackedRoomName(packedRoomName: number): string;
+export declare function fromPackedRoomNameCached(packedRoomName: number): string;
 export declare function packRoomName(room: string): number;

package/dist/src/utils/packedArrays.d.ts

@@ -0,0 +1,6 @@
+export interface PackedDestination {
+    pos: RoomPosition;
+    range: number;
+}
+export declare function packPositions(positions: RoomPosition[]): Uint32Array;
+export declare function packDestinations(destinations: PackedDestination[] | undefined): Uint32Array | undefined;

package/dist/src/wasm/screeps_clockwork.d.ts

@@ -609,42 +609,6 @@ export class Path {
      */
     to_array_reversed(): Uint32Array;
 }
-/**
- * Tracks fatigue cost for each position in a path. Used to calculate move time
- * for a given creep build.
- */
-export class PathFatigue {
-    /**
-     * @param {Path} path
-     */
-    constructor(path: Path);
-    __destroy_into_raw(): any;
-    __wbg_ptr: any;
-    free(): void;
-    /**
-     * @returns {number}
-     */
-    len(): number;
-    /**
-     * Calculates the total move time for the path, given a fatigue ratio.
-     *
-     * For unboosted creeps, the ratio is `Math.floor(moveParts * 2 / fatigueParts)`
-     * where `fatigue_parts` are any part except MOVE and empty CARRY parts.
-     * @param {number} fatigue_ratio
-     * @returns {number}
-     */
-    moveTime(fatigue_ratio: number): number;
-    /**
-     * Refreshes fatigue cost for each position in the path. If the PathFatigue
-     * has not been initialized yet, every position's fatigue cost will be set,
-     * even if there is no vision in the room, based on terrain costs. If the
-     * list *has* been initialized, only positions with vision will be updated.
-     *
-     * When there is vision, this also accounts for roads at the position.
-     * @param {Path} path
-     */
-    refresh(path: Path): void;
-}
 /**
  * Translates the `PWR_*` constants, which are types of powers used by power
  * creeps

package/dist/src/wrappers/distanceMap.d.ts

@@ -4,7 +4,11 @@ import { DistanceMap } from '../wasm/screeps_clockwork';
  */
 export declare class ClockworkDistanceMap {
     private _map;
-    constructor(_map: DistanceMap);
+    constructor(map: DistanceMap);
+    /**
+     * Frees the underlying WASM distance map allocation.
+     */
+    free(): void;
     /**
      * Gets the distance value at a given position.
      */

package/dist/src/wrappers/flowField.d.ts

@@ -4,7 +4,11 @@ import { FlowField } from '../wasm/screeps_clockwork';
  */
 export declare class ClockworkFlowField {
     private _flowField;
-    constructor(_flowField: FlowField);
+    constructor(flowField: FlowField);
+    /**
+     * Frees the underlying WASM flow field allocation.
+     */
+    free(): void;
     /**
      * Get the internal value for a given coordinate.
      */

package/dist/src/wrappers/freeable.d.ts

@@ -0,0 +1,5 @@
+export interface FreeableWasmHandle {
+    free(): void;
+}
+export declare function assertNotFreed<T>(handle: T | undefined, label: string): T;
+export declare function freeHandle<T extends FreeableWasmHandle>(handle: T | undefined): undefined;

package/dist/src/wrappers/monoFlowField.d.ts

@@ -4,7 +4,11 @@ import { MonoFlowField } from '../wasm/screeps_clockwork';
  */
 export declare class ClockworkMonoFlowField {
     private _flowField;
-    constructor(_flowField: MonoFlowField);
+    constructor(flowField: MonoFlowField);
+    /**
+     * Frees the underlying WASM flow field allocation.
+     */
+    free(): void;
     /**
      * Get the direction for a given coordinate.
      */

package/dist/src/wrappers/multiroomDistanceMap.d.ts

@@ -12,7 +12,11 @@ export interface DirectionOrderOptions {
  */
 export declare class ClockworkMultiroomDistanceMap {
     private _map;
-    constructor(_map: MultiroomDistanceMap);
+    constructor(map: MultiroomDistanceMap);
+    /**
+     * Frees the underlying WASM multiroom distance map allocation.
+     */
+    free(): void;
     /**
      * Get the stored value for a given position.
      */

package/dist/src/wrappers/multiroomFlowField.d.ts

@@ -6,7 +6,11 @@ import { ClockworkPath } from './path';
  */
 export declare class ClockworkMultiroomFlowField {
     private _flowField;
-    constructor(_flowField: MultiroomFlowField);
+    constructor(flowField: MultiroomFlowField);
+    /**
+     * Frees the underlying WASM multiroom flow field allocation.
+     */
+    free(): void;
     /**
      * Get the flow field value at a given position.
      */

package/dist/src/wrappers/multiroomMonoFlowField.d.ts

@@ -6,7 +6,11 @@ import { ClockworkPath } from './path';
  */
 export declare class ClockworkMultiroomMonoFlowField {
     private _flowField;
-    constructor(_flowField: MultiroomMonoFlowField);
+    constructor(flowField: MultiroomMonoFlowField);
+    /**
+     * Frees the underlying WASM multiroom flow field allocation.
+     */
+    free(): void;
     /**
      * Get the direction at a given position.
      */

package/dist/src/wrappers/path.d.ts

@@ -4,8 +4,12 @@ import { Path } from '../wasm/screeps_clockwork';
  * function like `ClockworkMultiroomFlowField.pathToOrigin` rather than created directly.
  */
 export declare class ClockworkPath {
-    private readonly path;
+    private path;
     constructor(path: Path);
+    /**
+     * Frees the underlying WASM path allocation.
+     */
+    free(): void;
     /**
      * Iterate over the path.
      *

package/package.json

@@ -1,14 +1,41 @@
 {
   "name": "screeps-clockwork",
-  "version": "0.10.0",
+  "version": "0.12.0",
   "description": "A WASM movement library for Screeps",
   "main": "dist/index.js",
   "types": "dist/src/index.d.ts",
   "scripts": {
+    "check": "run-s lint format:check typecheck",
+    "lint": "run-s lint:ts lint:rust",
+    "lint:ts": "eslint src test \"benches/**/*.ts\" types.d.ts",
+    "lint:rust": "cargo clippy --target wasm32-unknown-unknown --all-features -- -D warnings",
+    "format": "run-s format:ts format:rust",
+    "format:ts": "prettier --write . --ignore-unknown",
+    "format:rust": "cargo fmt",
+    "format:check": "run-s format:check:ts format:check:rust",
+    "format:check:ts": "prettier --check . --ignore-unknown",
+    "format:check:rust": "cargo fmt --check",
+    "typecheck": "run-s typecheck:ts typecheck:rust",
+    "typecheck:ts": "run-s typecheck:ts:src typecheck:ts:test",
+    "typecheck:ts:src": "tsc -p tsconfig.src.json --noEmit",
+    "typecheck:ts:test": "tsc -p tsconfig.test.json --noEmit",
+    "typecheck:rust": "cargo check --target wasm32-unknown-unknown --all-features",
+    "check:wasm-types": "run-s check:wasm-types:present check:wasm-types:src check:wasm-types:bench",
+    "check:wasm-types:present": "test -f src/wasm/screeps_clockwork.d.ts && test -f src/wasm/screeps_clockwork_bg.wasm.d.ts && test -f benches/wasm/pkg/screeps_clockwork.d.ts && test -f benches/wasm/pkg/screeps_clockwork_bg.wasm.d.ts",
+    "check:wasm-types:src": "npm run build:lib && git diff --exit-code -- src/wasm/screeps_clockwork.d.ts src/wasm/screeps_clockwork_bg.wasm.d.ts",
+    "check:wasm-types:bench": "npm run bench:wasm:build && git diff --exit-code -- benches/wasm/pkg/screeps_clockwork.d.ts benches/wasm/pkg/screeps_clockwork_bg.wasm.d.ts",
     "build": "run-s build:lib build:src",
-    "build:lib": "wasm-pack build --target web --out-dir src/wasm --config build.rustflags=[\\'-Ctarget-feature=-reference-types\\',\\'-Ctarget-feature=-multivalue\\',\\'-Ctarget-feature=-sign-ext\\'] -Z build-std=std,panic_abort",
+    "build:lib": "wasm-pack build --target web --out-dir src/wasm --config build.rustflags=[\\'-Ctarget-feature=-reference-types\\',\\'-Ctarget-feature=-multivalue\\',\\'-Ctarget-feature=-sign-ext\\'] -Z build-std=std,panic_abort && printf '*\\n!*.d.ts\\n' > src/wasm/.gitignore",
     "build:src": "rollup -c",
     "build:docs": "typedoc",
+    "bench:rust": "cargo bench --features bench --bench distance_map",
+    "bench:wasm:build": "wasm-pack build --target nodejs --out-dir benches/wasm/pkg --config \"build.rustflags=['-Ctarget-feature=-reference-types','-Ctarget-feature=-multivalue','-Ctarget-feature=-sign-ext']\" -Z build-std=std,panic_abort && printf '*\\n!*.d.ts\\n' > benches/wasm/pkg/.gitignore && cp benches/wasm/pkg/screeps_clockwork.js benches/wasm/pkg/screeps_clockwork.cjs",
+    "bench:wasm:run": "node --no-liftoff --no-wasm-lazy-compilation --wasm-wrapper-tiering-budget=0 ./node_modules/vitest/vitest.mjs bench benches/wasm",
+    "bench:wasm": "run-s bench:wasm:build bench:wasm:run",
+    "bench:wasm:save": "run-s bench:wasm:build bench:wasm:save:run",
+    "bench:wasm:save:run": "mkdir -p target/wasm-bench && node --no-liftoff --no-wasm-lazy-compilation --wasm-wrapper-tiering-budget=0 ./node_modules/vitest/vitest.mjs bench benches/wasm --outputJson target/wasm-bench/main.json",
+    "bench:wasm:compare": "run-s bench:wasm:build bench:wasm:compare:run",
+    "bench:wasm:compare:run": "node --no-liftoff --no-wasm-lazy-compilation --wasm-wrapper-tiering-budget=0 ./node_modules/vitest/vitest.mjs bench benches/wasm --compare target/wasm-bench/main.json",
     "build:pserver": "run-s build:lib build:src && rollup -c --environment DEST:pserver",
     "watch": "run-s build watch:both",
     "watch:lib": "bacon --headless -j build-lib",
@@ -51,7 +78,8 @@
     "source-map": "0.6.1",
     "tslib": "^2.8.1",
     "typedoc": "^0.28.5",
-    "typescript": "^6.0.3"
+    "typescript": "^6.0.3",
+    "vitest": "4.1.6"
   },
   "dependencies": {
     "fastestsmallesttextencoderdecoder-encodeinto": "^1.0.22"