docs: readme; fix: types for wasm exports

Author: user-of-github

.github/workflows/deploy.yml

@@ -1,12 +1,9 @@
-# Simple workflow for deploying static content to GitHub Pages
-name: Deploy static content to Pages
+name: Deploy
 
 on:
-  # Runs on pushes targeting the default branch
   push:
     branches: ['main']
 
-  # Allows you to run this workflow manually from the Actions tab
   workflow_dispatch:
 
 # Sets the GITHUB_TOKEN permissions to allow deployment to GitHub Pages
@@ -21,7 +18,6 @@ concurrency:
   cancel-in-progress: true
 
 jobs:
-  # Single deploy job since we're just deploying
   deploy:
     environment:
       name: github-pages
@@ -33,7 +29,7 @@ jobs:
       - name: Set up Node
         uses: actions/setup-node@v5
         with:
-          node-version: lts/*
+          node-version: 20
           cache: 'npm'
       - name: Install dependencies
         run: npm ci
@@ -44,7 +40,6 @@ jobs:
       - name: Upload artifact
         uses: actions/upload-pages-artifact@v4
         with:
-          # Upload dist folder
           path: './dist'
       - name: Deploy to GitHub Pages
         id: deployment

Readme.md

@@ -0,0 +1,18 @@
+# Canvas Point Simulation comparison  
+___   
+For points simulation we need to perform math/physics feature (calculate coordinates, speeds, acceleration and so on) and render stage.
+This application demonstrates combinations of 2 physics approaches and 2 render approaches:  
+- Pure JS Physics + JS Render (Canvas 2D Api)  
+- Web Assembly Physics + JS Render (Canvas 2D Api)  
+- Pure JS Physics + WebGL Render (WebGL Canvas)
+- Web Assembly Physics + WebGL Render (WebGL Canvas)   
+
+___  
+
+## Technologies for this project:  
+- _TypeScript_  
+- _Pure Web Assembly basics_  
+- _Pure GLSL basics_  
+- _Canvas 2D API_  
+- _Canvas WebGL API_  
+- _HTML, CSS_  

index.html

@@ -31,14 +31,14 @@ <h3>WASM Physics + JS Render</h3>
 
         <div class="option">
           <div class="option-info">
-            <h3>⚡⚡JS Physics + WebGl Render</h3>
+            <h3>⚡⚡  JS Physics + WebGl Render</h3>
           </div>
           <a href="src/pages/js-physics-webgl-render/index.html" class="btn">Test</a>
         </div>
 
         <div class="option">
           <div class="option-info">
-            <h3>⚡⚡⚡ WASM Physics + WebGl Canvas</h3>
+            <h3>⚡⚡⚡  WASM Physics + WebGl Canvas</h3>
           </div>
           <a href="src/pages/wasm-physics-webgl-render/index.html" class="btn">Test</a>
         </div>

package-lock.json

@@ -16,7 +16,6 @@
     "@types/node": "^24.9.1",
     "gh-pages": "^6.3.0",
     "vite": "^7.1.12",
-    "vite-plugin-glsl": "^1.5.4",
-    "vite-plugin-wasm": "^3.5.0"
+    "vite-plugin-glsl": "^1.5.4"
   }
 }

package.json

@@ -1,27 +1,34 @@
 import { Coordinate, Physics } from '../types';
 
+
+type WasmExportsStructure = Omit<Physics, 'run'> & {
+    mem: WebAssembly.Memory;
+    run: (x: number, y: number) => void;
+}
+
 export class WebAssemblyPhysics implements Physics {
     private points: Float32Array = new Float32Array();
+    private readonly wasmExports: WasmExportsStructure;
 
-    public constructor(private readonly wasmInstance: WebAssembly.Instance) {
-
+    public constructor(wasmInstance: WebAssembly.Instance) {
+        this.wasmExports = wasmInstance.exports as unknown as WasmExportsStructure;
     }
 
     public run(coordinate: Coordinate): void {
-        return this.wasmInstance.exports.run(coordinate.x, coordinate.y);
+        return this.wasmExports.run(coordinate.x, coordinate.y);
     }
 
 
     public tick(pointsCount: number): void {
-        return this.wasmInstance.exports.tick(pointsCount);
+        return this.wasmExports.tick(pointsCount);
     };
 
 
     public get data(): Readonly<Float32Array<ArrayBufferLike>> {
-        const wasmExports = this.wasmInstance.exports;
+        const wasmBuffer = this.wasmExports.mem.buffer;
 
-        if (wasmExports.mem.buffer !== this.points.buffer) {
-            this.points = new Float32Array(wasmExports.mem.buffer);
+        if (wasmBuffer !== this.points.buffer) {
+            this.points = new Float32Array(wasmBuffer);
         }
 
         return this.points;

src/core/wasm/physics.ts

@@ -1,26 +1,25 @@
 {
   "compilerOptions": {
-    "target": "ES2020",
+    "target": "ES2021",
     "useDefineForClassFields": true,
     "module": "ESNext",
-    "lib": ["ES2020", "DOM", "DOM.Iterable"],
+    "lib": ["ES2024", "DOM", "DOM.Iterable"],
     "skipLibCheck": true,
 
-    /* Bundler mode */
     "moduleResolution": "bundler",
     "allowImportingTsExtensions": true,
     "resolveJsonModule": true,
     "isolatedModules": true,
     "noEmit": true,
 
-    /* Linting */
     "strict": true,
     "noUnusedLocals": true,
     "noUnusedParameters": true,
     "noFallthroughCasesInSwitch": true,
+    "noImplicitAny": true,
+    "alwaysStrict": true,
 
-    /* Node.js types */
-    "types": ["node", "DOM"]
+    "types": ["node"]
   },
   "include": ["src", "vite.config.ts"]
 }

tsconfig.json

@@ -1,7 +1,6 @@
 import { defineConfig } from 'vite';
 import path from 'node:path';
 import glsl from 'vite-plugin-glsl';
-import wasm from 'vite-plugin-wasm';
 
 
 export default defineConfig({