@newkrok/nape-js 3.29.0 → 3.30.1

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@newkrok/nape-js",
-  "version": "3.29.0",
+  "version": "3.30.1",
   "description": "High-performance 2D physics engine for TypeScript & JavaScript — rigid bodies, constraints, fluid simulation, raycasting, and deterministic multiplayer. Tree-shakeable, zero dependencies.",
   "type": "module",
   "sideEffects": [
@@ -85,19 +85,12 @@
     "lint": "eslint src/ tests/",
     "format": "prettier --write src/ tests/",
     "format:check": "prettier --check src/ tests/",
-    "check:circular": "madge --circular --extensions ts src/ --json | node -e \"const d=JSON.parse(require('fs').readFileSync('/dev/stdin','utf8'));if(d.length>27){console.error('New circular dependencies detected: '+d.length+' (max 27)');process.exit(1)}else{console.log('Circular dependencies: '+d.length+'/27 (OK)')}\"",
-    "benchmark": "npm run build && node benchmarks/run.mjs",
-    "benchmark:json": "npm run build && node benchmarks/run.mjs --json",
-    "benchmark:compare": "node benchmarks/compare.mjs",
-    "benchmark:update-baseline": "npm run benchmark:json -- > benchmarks/baseline.json && echo 'baseline.json updated'",
-    "build:docs": "npm run build && cp dist/index.js docs/nape-js.esm.js && rm -f docs/chunk-*.js && cp dist/chunk-*.js docs/ && node scripts/stamp-docs.mjs && npm run build:typedoc",
-    "build:typedoc": "typedoc",
-    "serve:docs": "npx serve docs",
-    "dev:multiplayer": "npm run build && cp dist/index.js docs/nape-js.esm.js && rm -f docs/chunk-*.js && cp dist/chunk-*.js docs/ && npx concurrently -k -n docs,server -c cyan,green \"npx serve docs -l 5500\" \"cd server && PORT=3001 node index.js\""
+    "check:circular": "madge --circular --extensions ts src/ --json | node -e \"const d=JSON.parse(require('fs').readFileSync('/dev/stdin','utf8'));if(d.length>27){console.error('New circular dependencies detected: '+d.length+' (max 27)');process.exit(1)}else{console.log('Circular dependencies: '+d.length+'/27 (OK)')}\""
   },
   "repository": {
     "type": "git",
-    "url": "git+https://github.com/NewKrok/nape-js"
+    "url": "git+https://github.com/NewKrok/nape-js",
+    "directory": "packages/nape-js"
   },
   "keywords": [
     "nape",
@@ -126,18 +119,5 @@
   "bugs": {
     "url": "https://github.com/NewKrok/nape-js/issues"
   },
-  "homepage": "https://newkrok.github.io/nape-js/",
-  "devDependencies": {
-    "@eslint/js": "^10.0.1",
-    "@vitest/coverage-v8": "^4.1.4",
-    "eslint": "^10.2.1",
-    "eslint-config-prettier": "^10.1.8",
-    "madge": "^8.0.0",
-    "prettier": "^3.8.3",
-    "tsup": "^8.4.0",
-    "typedoc": "^0.28.19",
-    "typescript": "^6.0.3",
-    "typescript-eslint": "^8.59.0",
-    "vitest": "^4.1.4"
-  }
+  "homepage": "https://newkrok.github.io/nape-js/"
 }

package/README.md

@@ -1,193 +0,0 @@
-<p align="center">
-  <img src="docs/logo.svg" alt="nape-js logo" width="80" />
-</p>
-
-# @newkrok/nape-js
-
-[![npm version](https://img.shields.io/npm/v/@newkrok/nape-js.svg)](https://www.npmjs.com/package/@newkrok/nape-js)
-[![npm downloads](https://img.shields.io/npm/dm/@newkrok/nape-js.svg)](https://www.npmjs.com/package/@newkrok/nape-js)
-[![CI](https://github.com/NewKrok/nape-js/actions/workflows/ci.yml/badge.svg)](https://github.com/NewKrok/nape-js/actions/workflows/ci.yml)
-[![bundle size](https://img.shields.io/badge/gzip-16%20KB-blue.svg)](https://github.com/NewKrok/nape-js)
-[![license](https://img.shields.io/npm/l/@newkrok/nape-js.svg)](https://github.com/NewKrok/nape-js/blob/master/LICENSE)
-[![docs](https://img.shields.io/badge/docs-online-blue.svg)](https://newkrok.github.io/nape-js/)
-
-Fully typed, tree-shakeable 2D physics engine — a modern TypeScript rewrite of the
-[Nape](https://github.com/deltaluca/nape) Haxe physics engine.
-
-**[Homepage & Interactive Demos](https://newkrok.github.io/nape-js/)** | **[API Reference](https://newkrok.github.io/nape-js/api/)** | **[Examples](https://newkrok.github.io/nape-js/examples.html)** | **[Multiplayer Demo](https://newkrok.github.io/nape-js/multiplayer.html)**
-
-**[Cookbook](docs/guides/cookbook.md)** | **[Troubleshooting](docs/guides/troubleshooting.md)** | **[Anti-Patterns](docs/guides/anti-patterns.md)**
-
-- Originally created in Haxe by Luca Deltodesco
-- Ported to TypeScript by Istvan Krisztian Somoracz
-
-## Installation
-
-```bash
-npm install @newkrok/nape-js
-```
-
-## Quick Start
-
-```typescript
-import { Space, Body, BodyType, Vec2, Circle, Polygon } from "@newkrok/nape-js";
-
-// Create a physics world with downward gravity
-const space = new Space(new Vec2(0, 600));
-
-// Static floor
-const floor = new Body(BodyType.STATIC, new Vec2(400, 550));
-floor.shapes.add(new Polygon(Polygon.box(800, 20)));
-floor.space = space;
-
-// Dynamic box
-const box = new Body(BodyType.DYNAMIC, new Vec2(400, 100));
-box.shapes.add(new Polygon(Polygon.box(40, 40)));
-box.space = space;
-
-// Dynamic circle
-const ball = new Body(BodyType.DYNAMIC, new Vec2(420, 50));
-ball.shapes.add(new Circle(20));
-ball.space = space;
-
-// Game loop
-function update() {
-  space.step(1 / 60);
-
-  for (const body of space.bodies) {
-    console.log(`x=${body.position.x.toFixed(1)} y=${body.position.y.toFixed(1)}`);
-  }
-}
-```
-
-## API Reference
-
-> Full API documentation: [TypeDoc Reference](https://newkrok.github.io/nape-js/api/)
-
-### Core Classes
-
-| Class | Description |
-|-------|-------------|
-| `Space` | Physics world — add bodies, step simulation, `deterministic` mode for rollback/prediction |
-| `Body` | Rigid body with position, velocity, mass |
-| `Vec2` | 2D vector — pooling, `clone()`, `equals()`, `lerp()`, `fromAngle()` |
-| `Vec3` | 3D vector for constraint impulses — `clone()`, `equals()` |
-| `AABB` | Axis-aligned bounding box — `clone()`, `equals()`, `fromPoints()` |
-| `Mat23` | 2×3 affine matrix — `clone()`, `equals()`, transform, inverse |
-| `Ray` | Raycasting — `clone()`, `fromSegment()`, spatial queries |
-
-### Shapes
-
-| Class | Description |
-|-------|-------------|
-| `Circle` | Circular shape |
-| `Polygon` | Convex polygon (with `Polygon.box()`, `Polygon.rect()`, `Polygon.regular()`) |
-| `Capsule` | Capsule shape (`Capsule.create()`, `Capsule.createVertical()`) |
-| `Shape` | Base class with material, filter, sensor support |
-
-### Physics Properties
-
-| Class | Description |
-|-------|-------------|
-| `Material` | Elasticity, friction, density |
-| `BodyType` | `STATIC`, `DYNAMIC`, `KINEMATIC` |
-| `InteractionFilter` | Bit-mask collision/sensor/fluid filtering |
-| `FluidProperties` | Density, viscosity for fluid shapes |
-
-### Constraints
-
-| Class | Description |
-|-------|-------------|
-| `PivotJoint` | Pin two bodies at a shared point |
-| `DistanceJoint` | Constrain distance between anchors |
-| `WeldJoint` | Fix relative position and angle |
-| `AngleJoint` | Constrain relative angle |
-| `MotorJoint` | Apply angular velocity |
-| `LineJoint` | Slide along a line |
-| `PulleyJoint` | Constrain combined distances |
-
-### Callbacks
-
-| Class | Description |
-|-------|-------------|
-| `InteractionListener` | Collision/sensor/fluid events |
-| `BodyListener` | Body wake/sleep events |
-| `ConstraintListener` | Constraint events |
-| `PreListener` | Pre-collision filtering |
-| `CbType` | Tag interactors for filtering |
-| `CbEvent` | `BEGIN`, `ONGOING`, `END`, `WAKE`, `SLEEP`, `BREAK` |
-
-### Utilities
-
-| Class | Description |
-|-------|-------------|
-| `NapeList<T>` | Iterable list with `for...of` support |
-| `MatMN` | Variable-sized M×N matrix — `clone()`, `equals()`, multiply, transpose |
-
-### Serialization
-
-Full physics state snapshot/restore — suitable for save/load, replay, and multiplayer
-server↔client synchronization.
-
-```typescript
-import "@newkrok/nape-js";
-import { spaceToJSON, spaceFromJSON } from "@newkrok/nape-js/serialization";
-
-// Serialize
-const snapshot = spaceToJSON(space);
-const json = JSON.stringify(snapshot);
-
-// Restore (e.g. on another machine / after network transfer)
-const restored = spaceFromJSON(JSON.parse(json));
-restored.step(1 / 60);
-```
-
-The `/serialization` entry point is tree-shakeable — it does not pull in the engine
-bootstrap when unused. The snapshot captures bodies, shapes, materials, interaction
-filters, fluid properties, all constraint types (except `UserConstraint`), and compounds.
-Arbiters and broadphase tree state are reconstructed automatically on the first step.
-
-### Web Worker
-
-Run physics off the main thread for smooth rendering even with hundreds of bodies.
-
-```typescript
-import "@newkrok/nape-js";
-import { PhysicsWorkerManager } from "@newkrok/nape-js/worker";
-
-const mgr = new PhysicsWorkerManager({ gravityY: 600, maxBodies: 256 });
-await mgr.init();
-
-const id = mgr.addBody("dynamic", 100, 50, [{ type: "circle", radius: 20 }]);
-mgr.start();
-
-// Read transforms on the main thread (zero-copy with SharedArrayBuffer)
-function render() {
-  const t = mgr.getTransform(id);
-  if (t) drawCircle(t.x, t.y, t.rotation);
-  requestAnimationFrame(render);
-}
-render();
-```
-
-Uses SharedArrayBuffer for zero-copy transform sharing when COOP/COEP headers are
-present, with automatic `postMessage` fallback otherwise.
-
-## Known Issues
-
-- **Zero-friction tunneling** — Bodies with zero-friction material and horizontal
-  velocity may tunnel through floors. This affects all shape types (circles,
-  polygons, capsules). **Workaround:** use small friction values (e.g. `0.01`).
-
-## Development
-
-```bash
-npm install
-npm run build      # tsup → dist/ (ESM + CJS + DTS)
-npm test           # vitest — 4773 tests across 208 files
-npm run benchmark  # Performance benchmarks
-```
-
-## License
-
-MIT