v0.92

* improve typescript support

Author: luizbills

README.md

@@ -28,22 +28,16 @@ Litecanvas is a lightweight HTML5 canvas 2D engine suitable for small web games,
 
 ## Getting Started
 
-You can try our [online playground](https://litecanvas.github.io) or just installing the [basic template](https://github.com/litecanvas/template):
+You can try our [online playground](https://litecanvas.github.io) or install the [basic template](https://github.com/litecanvas/template):
 
 ```sh
-# requires Node.js
+# requires Node.js & NPM
 npx tiged litecanvas/template my-game
 cd my-game
 npm install
 npm run dev
 ```
 
-If you prefer, you can manually install via [NPM](https://www.npmjs.com/package/litecanvas):
-
-```
-npm install litecanvas
-```
-
 ### Show me the code!
 
 ```js

bun.lock

@@ -1,6 +1,6 @@
 {
     "name": "litecanvas",
-    "version": "0.91.0",
+    "version": "0.92.0",
     "description": "Lightweight HTML5 canvas 2D game engine suitable for small projects and creative coding. Inspired by PICO-8 and P5/Processing.",
     "license": "MIT",
     "author": "Luiz Bills <luizbills@pm.me>",
@@ -14,8 +14,25 @@
         "url": "https://github.com/litecanvas/game-engine/issues"
     },
     "type": "module",
-    "main": "src/index.js",
-    "types": "types/index.d.ts",
+    "main": "./src/index.js",
+    "module": "./src/index.js",
+    "types": "./types/index.d.ts",
+    "exports": {
+        ".": {
+            "import": {
+                "types": "./types/index.d.ts",
+                "default": "./src/index.js"
+            }
+        },
+        "./global": "./src/index.js"
+    },
+    "typesVersions": {
+        "*": {
+            "./global": [
+                "./types/global.d.ts"
+            ]
+        }
+    },
     "keywords": [
         "canvas",
         "2d",
@@ -33,7 +50,7 @@
         "@size-limit/preset-small-lib": "^11.2.0",
         "@swc/core": "^1.12.11",
         "@types/jsdom": "^21.1.7",
-        "ava": "^6.4.0",
+        "ava": "^6.4.1",
         "esbuild": "^0.25.6",
         "genversion": "^3.2.0",
         "gzip-size": "^7.0.0",

package.json

@@ -87,7 +87,7 @@ export default function litecanvas(settings = {}) {
          */
         _eventListeners = {}
 
-    /** @type {Omit<LitecanvasInstance,'PI'|'sin'|'cos'|'atan2'|'hypot'|'tan'|'abs'|'ceil'|'floor'|'trunc'|'min'|'max'|'pow'|'sqrt'|'sign'|'exp'|'iskeydown'|'iskeypressed'>} */
+    /** @type {LitecanvasInstance} */
     const instance = {
         /** @type {number} */
         W: 0,
@@ -945,7 +945,6 @@ export default function litecanvas(settings = {}) {
             DEV: assert(isNumber(volumeFactor), '[litecanvas] sfx() 3rd param must be a number')
 
             if (
-                // @ts-ignore
                 root.zzfxV <= 0 ||
                 (navigator.userActivation && !navigator.userActivation.hasBeenActive)
             ) {
@@ -975,7 +974,6 @@ export default function litecanvas(settings = {}) {
         volume(value) {
             DEV: assert(isNumber(value), '[litecanvas] volume() 1st param must be a number')
 
-            // @ts-ignore
             root.zzfxV = value
         },
 
@@ -1082,7 +1080,9 @@ export default function litecanvas(settings = {}) {
         def(key, value) {
             DEV: assert('string' === typeof key, '[litecanvas] def() 1st param must be a string')
             DEV: if (null == value) {
-                console.warn(`def: key "${key}" was defined as ${value} but now is null`)
+                console.warn(
+                    `[litecanvas] def() changed the key "${key}" to null (previous value was ${instance[key]})`
+                )
             }
 
             instance[key] = value
@@ -1148,8 +1148,7 @@ export default function litecanvas(settings = {}) {
                 // 7
                 _timeScale,
                 // 8
-                // @ts-ignore
-                root.zzfxV || 1,
+                root.zzfxV,
                 // 9
                 _rngSeed,
                 // 10
@@ -1189,7 +1188,6 @@ export default function litecanvas(settings = {}) {
                 for (const key in instance) {
                     delete root[key]
                 }
-                // @ts-ignore
                 delete root.ENGINE
             }
 
@@ -1568,7 +1566,7 @@ export default function litecanvas(settings = {}) {
 
         on(_canvas, 'click', () => root.focus())
 
-        // @ts-ignore
+        /** @ts-ignore */
         _canvas.style = ''
 
         resizeCanvas()
@@ -1657,7 +1655,6 @@ export default function litecanvas(settings = {}) {
      * @param {*} config
      */
     function loadPlugin(callback, config) {
-        // @ts-ignore
         const pluginData = callback(instance, config)
 
         DEV: assert(
@@ -1671,12 +1668,10 @@ export default function litecanvas(settings = {}) {
     }
 
     if (settings.global) {
-        // @ts-ignore
         if (root.ENGINE) {
             throw new Error('only one global litecanvas is allowed')
         }
         Object.assign(root, instance)
-        // @ts-ignore
         root.ENGINE = instance
     }
 
@@ -1691,6 +1686,5 @@ export default function litecanvas(settings = {}) {
         raf(init)
     }
 
-    // @ts-ignore
     return instance
 }

src/index.js

@@ -1,6 +1,3 @@
 import litecanvas from './index.js'
 
-/**
- * @global
- */
 globalThis.litecanvas = litecanvas

src/version.js

@@ -1,9 +1,14 @@
 {
     "compilerOptions": {
-        "target": "es2016",
-        "lib": ["es2016", "dom", "dom.iterable"],
+        "target": "es2017",
+        "lib": ["ES2017", "DOM", "DOM.Iterable"],
         "allowJs": true,
-        "noEmit": true
-    },
-    "files": ["types/index.d.ts", "src/index.js"]
+        "noEmit": true,
+        "baseUrl": "src",
+        "paths": {
+            "*": ["types/*"]
+        },
+        "moduleResolution": "nodenext",
+        "module": "nodenext"
+    }
 }