Merge branch 'ts-defs'

.gitignore

@@ -26,3 +26,4 @@ www/
 site/
 docs/__pycache__/*
 demos/**/*.blend1
+build/

demos/hello-three/demo.js

@@ -69,7 +69,7 @@ class Utils
             return null;
 
         for(const result of ar.frame.results) {
-            if(result.tracker.type == 'image-tracker') {
+            if(result.of('image-tracker')) {
                 if(result.trackables.length > 0) {
                     const trackable = result.trackables[0];
                     return trackable.referenceImage.name;

demos/hello-world/demo.js

@@ -93,7 +93,7 @@ function animate(time, frame)
 function mix(frame)
 {
     for(const result of frame.results) {
-        if(result.tracker.type == 'image-tracker') {
+        if(result.of('image-tracker')) {
             if(result.trackables.length > 0) {
                 const trackable = result.trackables[0];
                 const projectionMatrix = result.viewer.view.projectionMatrix;

demos/pointer-demo/demo.js

@@ -142,7 +142,7 @@ function animate(time, frame)
 function read(frame)
 {
     for(const result of frame.results) {
-        if(result.tracker.type == 'pointer-tracker') {
+        if(result.of('pointer-tracker')) {
             const pointers = result.trackables;
             return pointers;
         }

docs/api/tracker-result.md

@@ -14,4 +14,38 @@ A reference to the [tracker](tracker.md) that generated this result.
 
 `result.trackables: Trackable[], read-only`
 
-An array of zero or more [trackables](trackable.md).
+An array of zero or more [trackables](trackable.md).
+
+## Methods
+
+### of
+
+`result.of(trackerType: string): boolean`
+
+Checks if `this` result was generated by tracker of a certain `trackerType`. This is a convenient type guard for TypeScript users. See also: [Tracker.is](./tracker.md#is).
+
+*Since:* 0.4.4
+
+**Returns**
+
+The same as `tracker.is(trackerType)`.
+
+**Example**
+
+```ts
+let result: TrackerResult;
+
+// ...
+
+if(result.of('image-tracker')) {
+    // result is inferred to be an ImageTrackerResult
+    // ...
+}
+else if(result.of('pointer-tracker')) {
+    // result is inferred to be a PointerTrackerResult
+    // ...
+}
+else {
+    // ...
+}
+```

docs/api/tracker.md

@@ -2,7 +2,7 @@
 
 An interface that represents a generic tracker. Trackers analyze input data in some way and are meant to be attached to a [session](session.md). Refer to the [concepts](../tutorial/concepts.md) for more information.
 
-An [Image Tracker](image-tracker.md) is an implementation of a tracker.
+An [Image Tracker](image-tracker.md) is an implementation of a tracker, and so is a [PointerTracker](pointer-tracker.md).
 
 ## Properties
 
@@ -10,4 +10,40 @@ An [Image Tracker](image-tracker.md) is an implementation of a tracker.
 
 `tracker.type: string, read-only`
 
-A string representing the type of the tracker.
+A string representing the type of the tracker.
+
+*Deprecated since:* 0.4.4. Use `tracker.is()` instead.
+
+## Methods
+
+### is
+
+`tracker.is(type: string): boolean`
+
+Checks if `this` tracker is of a certain `type`. This is a convenient type guard for TypeScript users. See also: [TrackerResult.of](./tracker-result.md#of).
+
+*Since:* 0.4.4
+
+**Returns**
+
+`true` if and only if `type === tracker.type`
+
+**Example**
+
+```ts
+let tracker: Tracker;
+
+// ...
+
+if(tracker.is('image-tracker')) {
+    // tracker is inferred to be an ImageTracker
+    // ...
+}
+else if(tracker.is('pointer-tracker')) {
+    // tracker is inferred to be a PointerTracker
+    // ...
+}
+else {
+    // ...
+}
+```

docs/hooks.py

@@ -11,7 +11,7 @@ def copy_static_files(config, **kwargs):
 def copy_directory(dir_path, site_dir):
     d = os.path.join(site_dir, dir_path)
     os.makedirs(d, exist_ok=True)
-    s = dir_path if dir_path != "dist" else "www/dist"
+    s = dir_path if dir_path != "dist" else "build/dist"
     copy_tree(s, d)
 
 def copy_tree(src, dst, symlinks=False, ignore=None):

esbuild.mjs

@@ -29,7 +29,7 @@ const options = {
     legalComments: 'inline',
     banner: { js: generateBanner() },
     footer: { js: serve ? generateLiveReloadCode() : '' },
-    outfile: 'www/dist/' + (minify ? 'encantar.min.js' : 'encantar.js'),
+    outfile: 'build/dist/' + (minify ? 'encantar.min.js' : 'encantar.js'),
     sourcemap: !production && 'linked',
     logLevel: 'info',
 };

package-lock.json

@@ -9,7 +9,7 @@
       "version": "0.4.4-dev",
       "license": "LGPL-3.0-or-later",
       "dependencies": {
-        "speedy-vision": "github:alemart/speedy-vision#v0.9.1"
+        "speedy-vision": "github:alemart/speedy-vision#af1a64017ea1476fdac1adbbba4337732e5bfefb"
       },
       "devDependencies": {
         "esbuild": "0.24.2",
@@ -19,270 +19,13 @@
         "url": "https://github.com/sponsors/alemart"
       }
     },
-    "node_modules/@esbuild/aix-ppc64": {
-      "version": "0.24.2",
-      "resolved": "https://registry.npmjs.org/@esbuild/aix-ppc64/-/aix-ppc64-0.24.2.tgz",
-      "integrity": "sha512-thpVCb/rhxE/BnMLQ7GReQLLN8q9qbHmI55F4489/ByVg2aQaQ6kbcLb6FHkocZzQhxc4gx0sCk0tJkKBFzDhA==",
-      "cpu": [
-        "ppc64"
-      ],
-      "dev": true,
-      "optional": true,
-      "os": [
-        "aix"
-      ],
-      "engines": {
-        "node": ">=18"
-      }
-    },
-    "node_modules/@esbuild/android-arm": {
-      "version": "0.24.2",
-      "resolved": "https://registry.npmjs.org/@esbuild/android-arm/-/android-arm-0.24.2.tgz",
-      "integrity": "sha512-tmwl4hJkCfNHwFB3nBa8z1Uy3ypZpxqxfTQOcHX+xRByyYgunVbZ9MzUUfb0RxaHIMnbHagwAxuTL+tnNM+1/Q==",
-      "cpu": [
-        "arm"
-      ],
-      "dev": true,
-      "optional": true,
-      "os": [
-        "android"
-      ],
-      "engines": {
-        "node": ">=18"
-      }
-    },
-    "node_modules/@esbuild/android-arm64": {
-      "version": "0.24.2",
-      "resolved": "https://registry.npmjs.org/@esbuild/android-arm64/-/android-arm64-0.24.2.tgz",
-      "integrity": "sha512-cNLgeqCqV8WxfcTIOeL4OAtSmL8JjcN6m09XIgro1Wi7cF4t/THaWEa7eL5CMoMBdjoHOTh/vwTO/o2TRXIyzg==",
-      "cpu": [
-        "arm64"
-      ],
-      "dev": true,
-      "optional": true,
-      "os": [
-        "android"
-      ],
-      "engines": {
-        "node": ">=18"
-      }
-    },
-    "node_modules/@esbuild/android-x64": {
-      "version": "0.24.2",
-      "resolved": "https://registry.npmjs.org/@esbuild/android-x64/-/android-x64-0.24.2.tgz",
-      "integrity": "sha512-B6Q0YQDqMx9D7rvIcsXfmJfvUYLoP722bgfBlO5cGvNVb5V/+Y7nhBE3mHV9OpxBf4eAS2S68KZztiPaWq4XYw==",
-      "cpu": [
-        "x64"
-      ],
-      "dev": true,
-      "optional": true,
-      "os": [
-        "android"
-      ],
-      "engines": {
-        "node": ">=18"
-      }
-    },
-    "node_modules/@esbuild/darwin-arm64": {
-      "version": "0.24.2",
-      "resolved": "https://registry.npmjs.org/@esbuild/darwin-arm64/-/darwin-arm64-0.24.2.tgz",
-      "integrity": "sha512-kj3AnYWc+CekmZnS5IPu9D+HWtUI49hbnyqk0FLEJDbzCIQt7hg7ucF1SQAilhtYpIujfaHr6O0UHlzzSPdOeA==",
-      "cpu": [
-        "arm64"
-      ],
-      "dev": true,
-      "optional": true,
-      "os": [
-        "darwin"
-      ],
-      "engines": {
-        "node": ">=18"
-      }
-    },
-    "node_modules/@esbuild/darwin-x64": {
-      "version": "0.24.2",
-      "resolved": "https://registry.npmjs.org/@esbuild/darwin-x64/-/darwin-x64-0.24.2.tgz",
-      "integrity": "sha512-WeSrmwwHaPkNR5H3yYfowhZcbriGqooyu3zI/3GGpF8AyUdsrrP0X6KumITGA9WOyiJavnGZUwPGvxvwfWPHIA==",
-      "cpu": [
-        "x64"
-      ],
-      "dev": true,
-      "optional": true,
-      "os": [
-        "darwin"
-      ],
-      "engines": {
-        "node": ">=18"
-      }
-    },
-    "node_modules/@esbuild/freebsd-arm64": {
-      "version": "0.24.2",
-      "resolved": "https://registry.npmjs.org/@esbuild/freebsd-arm64/-/freebsd-arm64-0.24.2.tgz",
-      "integrity": "sha512-UN8HXjtJ0k/Mj6a9+5u6+2eZ2ERD7Edt1Q9IZiB5UZAIdPnVKDoG7mdTVGhHJIeEml60JteamR3qhsr1r8gXvg==",
-      "cpu": [
-        "arm64"
-      ],
-      "dev": true,
-      "optional": true,
-      "os": [
-        "freebsd"
-      ],
-      "engines": {
-        "node": ">=18"
-      }
-    },
-    "node_modules/@esbuild/freebsd-x64": {
-      "version": "0.24.2",
-      "resolved": "https://registry.npmjs.org/@esbuild/freebsd-x64/-/freebsd-x64-0.24.2.tgz",
-      "integrity": "sha512-TvW7wE/89PYW+IevEJXZ5sF6gJRDY/14hyIGFXdIucxCsbRmLUcjseQu1SyTko+2idmCw94TgyaEZi9HUSOe3Q==",
-      "cpu": [
-        "x64"
-      ],
-      "dev": true,
-      "optional": true,
-      "os": [
-        "freebsd"
-      ],
-      "engines": {
-        "node": ">=18"
-      }
-    },
-    "node_modules/@esbuild/linux-arm": {
-      "version": "0.24.2",
-      "resolved": "https://registry.npmjs.org/@esbuild/linux-arm/-/linux-arm-0.24.2.tgz",
-      "integrity": "sha512-n0WRM/gWIdU29J57hJyUdIsk0WarGd6To0s+Y+LwvlC55wt+GT/OgkwoXCXvIue1i1sSNWblHEig00GBWiJgfA==",
-      "cpu": [
-        "arm"
-      ],
-      "dev": true,
-      "optional": true,
-      "os": [
-        "linux"
-      ],
-      "engines": {
-        "node": ">=18"
-      }
-    },
-    "node_modules/@esbuild/linux-arm64": {
-      "version": "0.24.2",
-      "resolved": "https://registry.npmjs.org/@esbuild/linux-arm64/-/linux-arm64-0.24.2.tgz",
-      "integrity": "sha512-7HnAD6074BW43YvvUmE/35Id9/NB7BeX5EoNkK9obndmZBUk8xmJJeU7DwmUeN7tkysslb2eSl6CTrYz6oEMQg==",
-      "cpu": [
-        "arm64"
-      ],
-      "dev": true,
-      "optional": true,
-      "os": [
-        "linux"
-      ],
-      "engines": {
-        "node": ">=18"
-      }
-    },
-    "node_modules/@esbuild/linux-ia32": {
-      "version": "0.24.2",
-      "resolved": "https://registry.npmjs.org/@esbuild/linux-ia32/-/linux-ia32-0.24.2.tgz",
-      "integrity": "sha512-sfv0tGPQhcZOgTKO3oBE9xpHuUqguHvSo4jl+wjnKwFpapx+vUDcawbwPNuBIAYdRAvIDBfZVvXprIj3HA+Ugw==",
-      "cpu": [
-        "ia32"
-      ],
-      "dev": true,
-      "optional": true,
-      "os": [
-        "linux"
-      ],
-      "engines": {
-        "node": ">=18"
-      }
-    },
-    "node_modules/@esbuild/linux-loong64": {
-      "version": "0.24.2",
-      "resolved": "https://registry.npmjs.org/@esbuild/linux-loong64/-/linux-loong64-0.24.2.tgz",
-      "integrity": "sha512-CN9AZr8kEndGooS35ntToZLTQLHEjtVB5n7dl8ZcTZMonJ7CCfStrYhrzF97eAecqVbVJ7APOEe18RPI4KLhwQ==",
-      "cpu": [
-        "loong64"
-      ],
-      "dev": true,
-      "optional": true,
-      "os": [
-        "linux"
-      ],
-      "engines": {
-        "node": ">=18"
-      }
-    },
-    "node_modules/@esbuild/linux-mips64el": {
-      "version": "0.24.2",
-      "resolved": "https://registry.npmjs.org/@esbuild/linux-mips64el/-/linux-mips64el-0.24.2.tgz",
-      "integrity": "sha512-iMkk7qr/wl3exJATwkISxI7kTcmHKE+BlymIAbHO8xanq/TjHaaVThFF6ipWzPHryoFsesNQJPE/3wFJw4+huw==",
-      "cpu": [
-        "mips64el"
-      ],
-      "dev": true,
-      "optional": true,
-      "os": [
-        "linux"
-      ],
-      "engines": {
-        "node": ">=18"
-      }
-    },
-    "node_modules/@esbuild/linux-ppc64": {
-      "version": "0.24.2",
-      "resolved": "https://registry.npmjs.org/@esbuild/linux-ppc64/-/linux-ppc64-0.24.2.tgz",
-      "integrity": "sha512-shsVrgCZ57Vr2L8mm39kO5PPIb+843FStGt7sGGoqiiWYconSxwTiuswC1VJZLCjNiMLAMh34jg4VSEQb+iEbw==",
-      "cpu": [
-        "ppc64"
-      ],
-      "dev": true,
-      "optional": true,
-      "os": [
-        "linux"
-      ],
-      "engines": {
-        "node": ">=18"
-      }
-    },
-    "node_modules/@esbuild/linux-riscv64": {
-      "version": "0.24.2",
-      "resolved": "https://registry.npmjs.org/@esbuild/linux-riscv64/-/linux-riscv64-0.24.2.tgz",
-      "integrity": "sha512-4eSFWnU9Hhd68fW16GD0TINewo1L6dRrB+oLNNbYyMUAeOD2yCK5KXGK1GH4qD/kT+bTEXjsyTCiJGHPZ3eM9Q==",
-      "cpu": [
-        "riscv64"
-      ],
-      "dev": true,
-      "optional": true,
-      "os": [
-        "linux"
-      ],
-      "engines": {
-        "node": ">=18"
-      }
-    },
-    "node_modules/@esbuild/linux-s390x": {
-      "version": "0.24.2",
-      "resolved": "https://registry.npmjs.org/@esbuild/linux-s390x/-/linux-s390x-0.24.2.tgz",
-      "integrity": "sha512-S0Bh0A53b0YHL2XEXC20bHLuGMOhFDO6GN4b3YjRLK//Ep3ql3erpNcPlEFed93hsQAjAQDNsvcK+hV90FubSw==",
-      "cpu": [
-        "s390x"
-      ],
-      "dev": true,
-      "optional": true,
-      "os": [
-        "linux"
-      ],
-      "engines": {
-        "node": ">=18"
-      }
-    },
     "node_modules/@esbuild/linux-x64": {
       "version": "0.24.2",
-      "resolved": "https://registry.npmjs.org/@esbuild/linux-x64/-/linux-x64-0.24.2.tgz",
-      "integrity": "sha512-8Qi4nQcCTbLnK9WoMjdC9NiTG6/E38RNICU6sUNqK0QFxCYgoARqVqxdFmWkdonVsvGqWhmm7MO0jyTqLqwj0Q==",
       "cpu": [
         "x64"
       ],
       "dev": true,
+      "license": "MIT",
       "optional": true,
       "os": [
         "linux"
@@ -291,140 +34,11 @@
         "node": ">=18"
       }
     },
-    "node_modules/@esbuild/netbsd-arm64": {
-      "version": "0.24.2",
-      "resolved": "https://registry.npmjs.org/@esbuild/netbsd-arm64/-/netbsd-arm64-0.24.2.tgz",
-      "integrity": "sha512-wuLK/VztRRpMt9zyHSazyCVdCXlpHkKm34WUyinD2lzK07FAHTq0KQvZZlXikNWkDGoT6x3TD51jKQ7gMVpopw==",
-      "cpu": [
-        "arm64"
-      ],
-      "dev": true,
-      "optional": true,
-      "os": [
-        "netbsd"
-      ],
-      "engines": {
-        "node": ">=18"
-      }
-    },
-    "node_modules/@esbuild/netbsd-x64": {
-      "version": "0.24.2",
-      "resolved": "https://registry.npmjs.org/@esbuild/netbsd-x64/-/netbsd-x64-0.24.2.tgz",
-      "integrity": "sha512-VefFaQUc4FMmJuAxmIHgUmfNiLXY438XrL4GDNV1Y1H/RW3qow68xTwjZKfj/+Plp9NANmzbH5R40Meudu8mmw==",
-      "cpu": [
-        "x64"
-      ],
-      "dev": true,
-      "optional": true,
-      "os": [
-        "netbsd"
-      ],
-      "engines": {
-        "node": ">=18"
-      }
-    },
-    "node_modules/@esbuild/openbsd-arm64": {
-      "version": "0.24.2",
-      "resolved": "https://registry.npmjs.org/@esbuild/openbsd-arm64/-/openbsd-arm64-0.24.2.tgz",
-      "integrity": "sha512-YQbi46SBct6iKnszhSvdluqDmxCJA+Pu280Av9WICNwQmMxV7nLRHZfjQzwbPs3jeWnuAhE9Jy0NrnJ12Oz+0A==",
-      "cpu": [
-        "arm64"
-      ],
-      "dev": true,
-      "optional": true,
-      "os": [
-        "openbsd"
-      ],
-      "engines": {
-        "node": ">=18"
-      }
-    },
-    "node_modules/@esbuild/openbsd-x64": {
-      "version": "0.24.2",
-      "resolved": "https://registry.npmjs.org/@esbuild/openbsd-x64/-/openbsd-x64-0.24.2.tgz",
-      "integrity": "sha512-+iDS6zpNM6EnJyWv0bMGLWSWeXGN/HTaF/LXHXHwejGsVi+ooqDfMCCTerNFxEkM3wYVcExkeGXNqshc9iMaOA==",
-      "cpu": [
-        "x64"
-      ],
-      "dev": true,
-      "optional": true,
-      "os": [
-        "openbsd"
-      ],
-      "engines": {
-        "node": ">=18"
-      }
-    },
-    "node_modules/@esbuild/sunos-x64": {
-      "version": "0.24.2",
-      "resolved": "https://registry.npmjs.org/@esbuild/sunos-x64/-/sunos-x64-0.24.2.tgz",
-      "integrity": "sha512-hTdsW27jcktEvpwNHJU4ZwWFGkz2zRJUz8pvddmXPtXDzVKTTINmlmga3ZzwcuMpUvLw7JkLy9QLKyGpD2Yxig==",
-      "cpu": [
-        "x64"
-      ],
-      "dev": true,
-      "optional": true,
-      "os": [
-        "sunos"
-      ],
-      "engines": {
-        "node": ">=18"
-      }
-    },
-    "node_modules/@esbuild/win32-arm64": {
-      "version": "0.24.2",
-      "resolved": "https://registry.npmjs.org/@esbuild/win32-arm64/-/win32-arm64-0.24.2.tgz",
-      "integrity": "sha512-LihEQ2BBKVFLOC9ZItT9iFprsE9tqjDjnbulhHoFxYQtQfai7qfluVODIYxt1PgdoyQkz23+01rzwNwYfutxUQ==",
-      "cpu": [
-        "arm64"
-      ],
-      "dev": true,
-      "optional": true,
-      "os": [
-        "win32"
-      ],
-      "engines": {
-        "node": ">=18"
-      }
-    },
-    "node_modules/@esbuild/win32-ia32": {
-      "version": "0.24.2",
-      "resolved": "https://registry.npmjs.org/@esbuild/win32-ia32/-/win32-ia32-0.24.2.tgz",
-      "integrity": "sha512-q+iGUwfs8tncmFC9pcnD5IvRHAzmbwQ3GPS5/ceCyHdjXubwQWI12MKWSNSMYLJMq23/IUCvJMS76PDqXe1fxA==",
-      "cpu": [
-        "ia32"
-      ],
-      "dev": true,
-      "optional": true,
-      "os": [
-        "win32"
-      ],
-      "engines": {
-        "node": ">=18"
-      }
-    },
-    "node_modules/@esbuild/win32-x64": {
-      "version": "0.24.2",
-      "resolved": "https://registry.npmjs.org/@esbuild/win32-x64/-/win32-x64-0.24.2.tgz",
-      "integrity": "sha512-7VTgWzgMGvup6aSqDPLiW5zHaxYJGTO4OokMjIlrCtf+VpEL+cXKtCvg723iguPYI5oaUNdS+/V7OU2gvXVWEg==",
-      "cpu": [
-        "x64"
-      ],
-      "dev": true,
-      "optional": true,
-      "os": [
-        "win32"
-      ],
-      "engines": {
-        "node": ">=18"
-      }
-    },
     "node_modules/esbuild": {
       "version": "0.24.2",
-      "resolved": "https://registry.npmjs.org/esbuild/-/esbuild-0.24.2.tgz",
-      "integrity": "sha512-+9egpBW8I3CD5XPe0n6BfT5fxLzxrlDzqydF3aviG+9ni1lDC/OvMHcxqEFV0+LANZG5R1bFMWfUrjVsdwxJvA==",
       "dev": true,
       "hasInstallScript": true,
+      "license": "MIT",
       "bin": {
         "esbuild": "bin/esbuild"
       },
@@ -460,17 +74,17 @@
       }
     },
     "node_modules/speedy-vision": {
-      "version": "0.9.1",
-      "resolved": "git+ssh://git@github.com/alemart/speedy-vision.git#6a48fca4c45b6f4c80bfa8bcacbed5abd0e69ec2",
+      "version": "0.9.1.1",
+      "resolved": "git+ssh://git@github.com/alemart/speedy-vision.git#af1a64017ea1476fdac1adbbba4337732e5bfefb",
+      "integrity": "sha512-d6iK96sKp8fazja1F/pK8Ymt6kN21IMk39xuypuiInIAlirlQVW2//zXkIDxejunIwB61wYwxtddWLk+4s7D1w==",
       "funding": {
         "url": "https://github.com/sponsors/alemart"
       }
     },
     "node_modules/typescript": {
       "version": "4.9.5",
-      "resolved": "https://registry.npmjs.org/typescript/-/typescript-4.9.5.tgz",
-      "integrity": "sha512-1FXk9E2Hm+QzZQ7z+McJiHL4NW1F2EzMu9Nq9i3zAaGqibafqYwCVU6WyWAuyQRRzOlxou8xZSyXLEN8oKj24g==",
       "dev": true,
+      "license": "Apache-2.0",
       "bin": {
         "tsc": "bin/tsc",
         "tsserver": "bin/tsserver"

package.json

@@ -28,19 +28,22 @@
   ],
   "type": "module",
   "main": "src/main.ts",
+  "types": "build/types/main.d.ts",
   "scripts": {
     "start": "node esbuild.mjs --minify --serve",
     "prebuild": "tsc --noEmit && npm run clean",
-    "build": "node esbuild.mjs && node esbuild.mjs --minify",
-    "plugins": "for f in $(find plugins/ -name *.js); do esbuild --minify < $f > ${f%.*}.min.js; done",
+    "build": "mkdir -p build/dist && node esbuild.mjs && node esbuild.mjs --minify",
+    "build-types": "mkdir -p build/types && tsc --emitDeclarationOnly --declaration --declarationDir build/types",
+    "build-bundle-of-types": "mkdir -p build/dist && tsc --emitDeclarationOnly --isolatedModules false --declaration --outFile build/dist/encantar.d.ts",
+    "build-plugins": "mkdir -p build/plugins && for f in $(find plugins/ -name *.js); do esbuild --minify < $f > build/${f%.*}.min.js; done",
     "update": "npm update speedy-vision",
     "deploy": "mkdocs gh-deploy",
     "docs": "mkdocs serve",
-    "clean": "rm -rf www/dist/*.*",
+    "clean": "rm -rf build/",
     "test": "echo \"Error: no test specified\" && exit 1"
   },
   "dependencies": {
-    "speedy-vision": "github:alemart/speedy-vision#v0.9.1"
+    "speedy-vision": "github:alemart/speedy-vision#af1a64017ea1476fdac1adbbba4337732e5bfefb"
   },
   "devDependencies": {
     "esbuild": "0.24.2",

plugins/aframe-with-encantar.js

@@ -107,7 +107,7 @@ const Utils = () => ({
             return null;
 
         for(const result of frame.results) {
-            if(result.tracker.type == 'image-tracker') {
+            if(result.of('image-tracker')) {
                 for(const trackable of result.trackables) {
                     if(name === '' || name === trackable.referenceImage.name) {
                         return {
@@ -129,7 +129,7 @@ const Utils = () => ({
             return null;
 
         for(const result of frame.results) {
-            if(result.tracker.type == 'image-tracker') {
+            if(result.of('image-tracker')) {
                 if(result.trackables.length > 0)
                     return result.viewer;
             }
@@ -144,7 +144,7 @@ const Utils = () => ({
             return [];
 
         for(const result of frame.results) {
-            if(result.tracker.type == 'pointer-tracker')
+            if(result.of('pointer-tracker'))
                 return result.trackables;
         }
 

plugins/babylon-with-encantar.js

@@ -268,7 +268,7 @@ function encantar(demo)
         ar._pointers.length = 0;
 
         for(const result of frame.results) {
-            if(result.tracker.type == 'image-tracker') {
+            if(result.of('image-tracker')) {
                 if(result.trackables.length > 0) {
                     const trackable = result.trackables[0];
                     const projectionMatrix = result.viewer.view.projectionMatrix;
@@ -282,7 +282,7 @@ function encantar(demo)
                     found = true;
                 }
             }
-            else if(result.tracker.type == 'pointer-tracker') {
+            else if(result.of('pointer-tracker')) {
                 if(result.trackables.length > 0)
                     ar._pointers.push.apply(ar._pointers, result.trackables);
             }

plugins/three-with-encantar.js

@@ -262,7 +262,7 @@ export function encantar(demo)
         ar._pointers.length = 0;
 
         for(const result of frame.results) {
-            if(result.tracker.type == 'image-tracker') {
+            if(result.of('image-tracker')) {
                 if(result.trackables.length > 0) {
                     const trackable = result.trackables[0];
                     const projectionMatrix = result.viewer.view.projectionMatrix;
@@ -276,7 +276,7 @@ export function encantar(demo)
                     found = true;
                 }
             }
-            else if(result.tracker.type == 'pointer-tracker') {
+            else if(result.of('pointer-tracker')) {
                 if(result.trackables.length > 0)
                     ar._pointers.push.apply(ar._pointers, result.trackables);
             }

src/core/session.ts

@@ -33,7 +33,7 @@ import { Settings } from './settings';
 import { Stats } from './stats';
 import { Gizmos } from '../ui/gizmos';
 import { Frame } from './frame';
-import { Tracker } from '../trackers/tracker';
+import { Trackable, Tracker, TrackerResult } from '../trackers/tracker';
 import { TimeManager } from './time-manager';
 import { Source } from '../sources/source';
 import { VideoSource } from '../sources/video-source';
@@ -87,13 +87,28 @@ const DEFAULT_OPTIONS: Readonly<Required<SessionOptions>> = {
     gizmos: false,
 };
 
+/** Helper class */
+class EmptyTrackerResult extends TrackerResult
+{
+    readonly tracker: Tracker;
+    readonly trackables: Trackable[];
+
+    constructor(tracker: Tracker)
+    {
+        super();
+        this.tracker = tracker;
+        this.trackables = [];
+    }
+}
+
+
 
 
 /**
  * A Session represents an intent to display AR content
  * and encapsulates the main loop (update-render cycle)
  */
-export class Session extends AREventTarget<SessionEventType>
+export class Session extends AREventTarget<SessionEvent>
 {
     /** Number of active sessions */
     private static _count = 0;
@@ -514,12 +529,14 @@ export class Session extends AREventTarget<SessionEventType>
     {
         // prefer video sources
         for(let i = 0; i < sources.length; i++) {
-            if(sources[i]._type == 'video')
-                return sources[i] as VideoSource;
+            const source = sources[i];
+            if(source._is('video'))
+                return source;
         }
         for(let i = 0; i < sources.length; i++) {
-            if(sources[i]._type == 'canvas')
-                return sources[i] as CanvasSource;
+            const source = sources[i];
+            if(source._is('canvas'))
+                return source;
         }
 
         // emit warning
@@ -705,10 +722,7 @@ export class Session extends AREventTarget<SessionEventType>
 
                 // create a frame
                 const results = this._trackers.map(tracker =>
-                    tracker._output.exports || ({
-                        tracker: tracker,
-                        trackables: [],
-                    })
+                    tracker._output.exports || new EmptyTrackerResult(tracker)
                 );
                 const frame = new Frame(this, results);
 

src/core/viewport.ts

@@ -46,13 +46,10 @@ type ViewportSizeGetter = () => SpeedySize;
 type ViewportEventType = 'resize' | 'fullscreenchange';
 
 /** An event emitted by a Viewport */
-class ViewportEvent extends AREvent<ViewportEventType> { }
-
-/** Viewport event target */
-class ViewportEventTarget extends AREventTarget<ViewportEventType> { }
+export class ViewportEvent extends AREvent<ViewportEventType> { }
 
 /** Viewport style (immersive mode) */
-type ViewportStyle = 'best-fit' | 'stretch' | 'crop' | 'inline';
+export type ViewportStyle = 'best-fit' | 'stretch' | 'crop' | 'inline';
 
 
 
@@ -704,8 +701,9 @@ class ViewportResizer
 
     /**
      * Called when the viewport receives a 'resize' event
+     * @param event
      */
-    private _onViewportResize(): void
+    private _onViewportResize(event: ViewportEvent): void
     {
         const viewport = this._viewport;
 
@@ -948,7 +946,7 @@ class CropResizeStrategy extends ImmersiveResizeStrategy
 /**
  * Viewport
  */
-export class Viewport extends ViewportEventTarget
+export class Viewport extends AREventTarget<ViewportEvent>
 {
     /** Viewport resolution (controls the size of the drawing buffer of the foreground canvas) */
     private readonly _resolution: Resolution;

src/sources/canvas-source.ts

@@ -25,7 +25,7 @@ import { SpeedyMedia } from 'speedy-vision/types/core/speedy-media';
 import { SpeedyPromise } from 'speedy-vision/types/core/speedy-promise';
 import { Utils, Nullable } from '../utils/utils';
 import { IllegalOperationError } from '../utils/errors';
-import { Source } from './source';
+import { Source, SourceType } from './source';
 
 /**
  * HTMLCanvasElement-based source of data
@@ -63,12 +63,21 @@ export class CanvasSource implements Source
      * A type-identifier of the source of data
      * @internal
      */
-    get _type(): string
+    get _type(): keyof SourceType
     {
         return 'canvas';
     }
 
     /**
+     * Check if this source is of a certain type
+     * @internal
+     */
+    _is<T extends keyof SourceType>(type: T): this is SourceType[T]
+    {
+        return type === this._type;
+    }
+
+    /**
      * Get media
      * @internal
      */

src/sources/pointer-source.ts

@@ -22,7 +22,7 @@
 
 import Speedy from 'speedy-vision';
 import { SpeedyPromise } from 'speedy-vision/types/core/speedy-promise';
-import { Source } from './source';
+import { Source, SourceType } from './source';
 import { Viewport } from '../core/viewport'
 import { Utils, Nullable } from '../utils/utils';
 
@@ -55,12 +55,21 @@ export class PointerSource implements Source
      * A type-identifier of the source of data
      * @internal
      */
-    get _type(): string
+    get _type(): keyof SourceType
     {
         return 'pointer-source';
     }
 
     /**
+     * Check if this source is of a certain type
+     * @internal
+     */
+    _is<T extends keyof SourceType>(type: T): this is SourceType[T]
+    {
+        return type === this._type;
+    }
+
+    /**
      * Consume a pointer event
      * @returns the next pointer event to be consumed, or null if there are none
      * @internal

src/sources/source.ts

@@ -21,6 +21,9 @@
  */
 
 import { SpeedyPromise } from 'speedy-vision/types/core/speedy-promise';
+import { CanvasSource } from './canvas-source';
+import { PointerSource } from './pointer-source';
+import { VideoSource } from './video-source';
 
 /**
  * Abstract source of data
@@ -28,7 +31,10 @@ import { SpeedyPromise } from 'speedy-vision/types/core/speedy-promise';
 export interface Source
 {
     /** @internal type-identifier of the source of data */
-    readonly _type: string;
+    readonly _type: keyof SourceType;
+
+    /** @internal check if this source is of a certain type */
+    _is<T extends keyof SourceType>(type: T): this is SourceType[T];
 
     /** @internal method to initialize the source of data (gets the data ready) */
     _init(): SpeedyPromise<void>;
@@ -38,4 +44,14 @@ export interface Source
 
     /** @internal stats related to this source of data */
     readonly _stats: string;
-}
+}
+
+/**
+ * A helper for type-narrowing
+ * @internal
+ */
+export type SourceType = {
+    'video': VideoSource,
+    'canvas': CanvasSource,
+    'pointer-source': PointerSource
+};

src/sources/video-source.ts

@@ -25,7 +25,7 @@ import { SpeedyMedia } from 'speedy-vision/types/core/speedy-media';
 import { SpeedyPromise } from 'speedy-vision/types/core/speedy-promise';
 import { Utils, Nullable } from '../utils/utils';
 import { IllegalOperationError, NotSupportedError, TimeoutError } from '../utils/errors';
-import { Source } from './source';
+import { Source, SourceType } from './source';
 
 /** A message to be displayed if a video can't autoplay and user interaction is required */
 const ALERT_MESSAGE = 'Tap on the screen to start';
@@ -70,12 +70,21 @@ export class VideoSource implements Source
      * A type-identifier of the source of data
      * @internal
      */
-    get _type(): string
+    get _type(): keyof SourceType
     {
         return 'video';
     }
 
     /**
+     * Check if this source is of a certain type
+     * @internal
+     */
+    _is<T extends keyof SourceType>(type: T): this is SourceType[T]
+    {
+        return type === this._type;
+    }
+
+    /**
      * Get media
      * @internal
      */

src/trackers/image-tracker/image-tracker.ts

@@ -33,7 +33,7 @@ import { SpeedyPipelineNodeFASTKeypointDetector } from 'speedy-vision/types/core
 import { SpeedyKeypoint } from 'speedy-vision/types/core/speedy-keypoint';
 import { VideoSource } from '../../sources/video-source';
 import { CanvasSource } from '../../sources/canvas-source';
-import { Tracker, TrackerOutput, TrackerResult, Trackable } from '../tracker';
+import { Tracker, TrackerOutput, TrackerResult, Trackable, TrackerType, TrackerResultType } from '../tracker';
 import { Session } from '../../core/session';
 import { IllegalOperationError, IllegalArgumentError } from '../../utils/errors';
 import { Resolution } from '../../utils/resolution';
@@ -65,7 +65,7 @@ export interface TrackableImage extends Trackable
 }
 
 /** Image Tracker result to be consumed by the user */
-export interface ImageTrackerResult extends TrackerResult
+export class ImageTrackerResult extends TrackerResult
 {
     /** tracker */
     readonly tracker: ImageTracker;
@@ -75,6 +75,20 @@ export interface ImageTrackerResult extends TrackerResult
 
     /** 3D virtual camera */
     readonly viewer: Viewer;
+
+    /**
+     * Constructor
+     * @param tracker
+     * @param trackables
+     * @param viewer
+     */
+    constructor(tracker: ImageTracker, trackables: TrackableImage[], viewer: Viewer)
+    {
+        super();
+        this.tracker = tracker;
+        this.trackables = trackables;
+        this.viewer = viewer;
+    }
 }
 
 /** Image Tracker output */
@@ -119,7 +133,7 @@ const DEFAULT_OPTIONS: Readonly<ImageTrackerOptions> = {
 /**
  * The ImageTracker tracks an image (one at a time)
  */
-export class ImageTracker extends AREventTarget<ImageTrackerEventType> implements Tracker
+export class ImageTracker extends AREventTarget<ImageTrackerEvent> implements Tracker
 {
     /** session */
     private _session: Nullable<Session>;
@@ -176,13 +190,22 @@ export class ImageTracker extends AREventTarget<ImageTrackerEventType> implement
 
     /**
      * The type of the tracker
+     * @deprecated
      */
-    get type(): string
+    get type(): keyof TrackerType
     {
         return 'image-tracker';
     }
 
     /**
+     * Check if this tracker is of a certain type
+     */
+    is<T extends keyof TrackerType>(type: T): this is TrackerType[T]
+    {
+        return type === this.type;
+    }
+
+    /**
      * Current state name
      */
     get state(): ImageTrackerStateName
@@ -261,12 +284,12 @@ export class ImageTracker extends AREventTarget<ImageTrackerEventType> implement
         // XXX also let the user specify a source manually?
         for(const source of session.sources) {
             // prefer video sources
-            if(source._type == 'video') {
-                this._source = source as VideoSource;
+            if(source._is('video')) {
+                this._source = source;
                 break;
             }
-            else if(source._type == 'canvas')
-                this._source = source as CanvasSource;
+            else if(source._is('canvas'))
+                this._source = source;
         }
         if(this._source === null)
             throw new IllegalOperationError('The image tracker requires a suitable source of data');

src/trackers/image-tracker/states/tracking.ts

@@ -433,11 +433,11 @@ export class ImageTrackerTrackingState extends ImageTrackerState
             };
 
             // the result generated by the image tracker
-            const result: ImageTrackerResult = {
-                tracker: this._imageTracker,
-                trackables: [ trackable ],
-                viewer: viewer
-            };
+            const result = new ImageTrackerResult(
+                this._imageTracker,
+                [ trackable ],
+                viewer
+            );
 
             // tracker output
             const trackerOutput: ImageTrackerOutput = {

src/trackers/pointer-tracker/pointer-tracker.ts

@@ -22,7 +22,7 @@
 
 import Speedy from 'speedy-vision';
 import { SpeedyPromise } from 'speedy-vision/types/core/speedy-promise';
-import { TrackerResult, TrackerOutput, Tracker } from '../tracker';
+import { TrackerResult, TrackerOutput, Tracker, TrackerType } from '../tracker';
 import { TrackablePointer, TrackablePointerPhase } from './trackable-pointer';
 import { PointerSource } from '../../sources/pointer-source';
 import { Vector2 } from '../../geometry/vector2';
@@ -34,13 +34,25 @@ import { Viewport } from '../../core/viewport';
 /**
  * A result of a PointerTracker. It's meant to be consumed by the user/application
  */
-export interface PointerTrackerResult extends TrackerResult
+export class PointerTrackerResult extends TrackerResult
 {
     /** the tracker that generated this result */
     readonly tracker: PointerTracker;
 
     /** the trackables */
     readonly trackables: TrackablePointer[];
+
+    /**
+     * Constructor
+     * @param tracker
+     * @param trackables
+     */
+    constructor(tracker: PointerTracker, trackables: TrackablePointer[])
+    {
+        super();
+        this.tracker = tracker;
+        this.trackables = trackables;
+    }
 }
 
 /**
@@ -187,13 +199,22 @@ export class PointerTracker implements Tracker
 
     /**
      * The type of the tracker
+     * @deprecated
      */
-    get type(): string
+    get type(): keyof TrackerType
     {
         return 'pointer-tracker';
     }
 
     /**
+     * Check if this tracker is of a certain type
+     */
+    is<T extends keyof TrackerType>(type: T): this is TrackerType[T]
+    {
+        return type === this.type;
+    }
+
+    /**
      * Initialize the tracker
      * @param session
      * @returns a promise that is resolved as soon as the tracker is initialized
@@ -208,8 +229,8 @@ export class PointerTracker implements Tracker
 
         // find the pointer source
         for(const source of session.sources) {
-            if(source._type == 'pointer-source') {
-                this._source = source as PointerSource;
+            if(source._is('pointer-source')) {
+                this._source = source;
                 break;
             }
         }
@@ -470,12 +491,8 @@ export class PointerTracker implements Tracker
         const trackables: TrackablePointer[] = [];
         this._activePointers.forEach(trackable => trackables.push(trackable));
 
-        return {
-            exports: {
-                tracker: this,
-                trackables: this._sortTrackables(trackables)
-            }
-        };
+        const result = new PointerTrackerResult(this, this._sortTrackables(trackables));
+        return { exports: result };
     }
 
     /**

src/trackers/tracker.ts

@@ -23,6 +23,8 @@
 import { Session } from '../core/session';
 import { SpeedyPromise } from 'speedy-vision/types/core/speedy-promise';
 import { SpeedyMedia } from 'speedy-vision/types/core/speedy-media';
+import { ImageTracker, ImageTrackerResult } from './image-tracker/image-tracker';
+import { PointerTracker, PointerTrackerResult } from './pointer-tracker/pointer-tracker';
 
 /**
  * A Trackable is something that can be tracked
@@ -37,13 +39,19 @@ export interface Trackable
  * The result of a Tracker in a particular frame of a session. Such result is
  * meant to be consumed by the user/application.
  */
-export interface TrackerResult
+export abstract class TrackerResult
 {
     /** the tracker that generated this result */
-    readonly tracker: Tracker;
+    abstract readonly tracker: Tracker;
 
     /** an array of trackables (possibly empty) */
-    readonly trackables: Trackable[];
+    abstract readonly trackables: Trackable[];
+
+    /** check if this result was generated by a tracker of a certain type */
+    of<T extends keyof TrackerResultType>(trackerType: T): this is TrackerResultType[T]
+    {
+        return this.tracker.is(trackerType);
+    }
 }
 
 /**
@@ -63,21 +71,42 @@ export interface TrackerOutput
  */
 export interface Tracker
 {
-    /** a string that identifies the type of the tracker */
-    readonly type: string;
+    /** check if this tracker is of a certain type */
+    is<T extends keyof TrackerType>(type: T): this is TrackerType[T];
+
+    /** a string that identifies the type of the tracker @deprecated */
+    readonly type: keyof TrackerType;
 
     /** initialize tracker @internal */
-    _init: (session: Session) => SpeedyPromise<void>;
+    _init(session: Session): SpeedyPromise<void>;
 
     /** release resources @internal */
-    _release: () => SpeedyPromise<void>;
+    _release(): SpeedyPromise<void>;
 
     /** update cycle @internal */
-    _update: () => SpeedyPromise<void>;
+    _update(): SpeedyPromise<void>;
 
     /** output of the last frame @internal */
     readonly _output: TrackerOutput;
 
     /** stats related to this tracker @internal */
     readonly _stats: string;
-}
+}
+
+/**
+ * A helper for type-narrowing
+ * @internal
+ */
+export type TrackerType = {
+    'image-tracker': ImageTracker,
+    'pointer-tracker': PointerTracker
+};
+
+/**
+ * A helper for type-narrowing
+ * @internal
+ */
+export type TrackerResultType = {
+    'image-tracker': ImageTrackerResult,
+    'pointer-tracker': PointerTrackerResult
+};

src/ui/fullscreen-button.ts

@@ -20,7 +20,7 @@
  * A built-in fullscreen button introduced as a convenience
  */
 
-import { Viewport } from '../core/viewport';
+import { Viewport, ViewportEvent } from '../core/viewport';
 
 /** Button icon to be displayed when the fullscreen mode is disabled */
 const BUTTON_ICON_OFF = 'data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAACAAAAAgCAYAAABzenr0AAAAbUlEQVRYR+2WOQ4AIAgE5f+PVhobDZANBZAsraAwXMoqFil+f9GBj8BW8dIiKt45at/XgShStHgvmfdekwAdIIEyAmh1Z/U5ikmABPoRsLZWtt+5DUlgHgGr6qM1Pf9XnO131L7fJEQjyOqXEzjP1YAhNmUTrgAAAABJRU5ErkJggg==';
@@ -47,8 +47,6 @@ export class FullscreenButton
     /** The HTML element of the button */
     private readonly _button: HTMLButtonElement;
 
-    /** Bound event handler */
-    private readonly _boundEventHandler: EventListener;
 
 
 
@@ -60,7 +58,7 @@ export class FullscreenButton
     {
         this._viewport = viewport;
         this._button = this._createButton();
-        this._boundEventHandler = this._handleFullscreenEvent.bind(this);
+        this._handleFullscreenEvent = this._handleFullscreenEvent.bind(this);
     }
 
     /**
@@ -72,7 +70,7 @@ export class FullscreenButton
     {
         parent.appendChild(this._button);
         this._button.hidden = !isVisible;
-        this._viewport.addEventListener('fullscreenchange', this._boundEventHandler);
+        this._viewport.addEventListener('fullscreenchange', this._handleFullscreenEvent);
     }
 
     /**
@@ -80,7 +78,7 @@ export class FullscreenButton
      */
     release(): void
     {
-        this._viewport.removeEventListener('fullscreenchange', this._boundEventHandler);
+        this._viewport.removeEventListener('fullscreenchange', this._handleFullscreenEvent);
         this._button.remove();
     }
 
@@ -145,7 +143,7 @@ export class FullscreenButton
     /**
      * Handle a fullscreenchange event
      */
-    private _handleFullscreenEvent(event: Event): void
+    private _handleFullscreenEvent(event: ViewportEvent): void
     {
         const img = this._viewport.fullscreen ? BUTTON_ICON_ON : BUTTON_ICON_OFF;
         this._button.style.backgroundImage = 'url(' + img + ')';

src/ui/gizmos.ts

@@ -85,8 +85,9 @@ export class Gizmos
 
         // render the gizmos of each tracker
         for(let i = 0; i < trackers.length; i++) {
-            if(trackers[i].type == 'image-tracker') {
-                const output = trackers[i]._output as ImageTrackerOutput;
+            const tracker = trackers[i];
+            if(tracker.is('image-tracker')) {
+                const output = tracker._output;
                 this._imageTrackerGizmos.render(viewport, output);
             }
         }

src/utils/ar-events.ts

@@ -22,15 +22,11 @@
 
 /**
  * AR Event Type
+ * @internal
  */
 type AREventType = string;
 
 /**
- * AR Event Listener (callback)
- */
-export type AREventListener = EventListener;
-
-/**
  * AR Event
  */
 export class AREvent<T extends AREventType> extends Event
@@ -54,9 +50,24 @@ export class AREvent<T extends AREventType> extends Event
 }
 
 /**
+ * Extract the AREventType from an AREvent
+ * @internal
+ */
+type AREventTypeOf<T> = T extends AREvent<infer U> ? U : never;
+
+/**
+ * AR Event Listener (a callback)
+ * @internal
+ */
+interface AREventListener<T>
+{
+    (evt: T extends AREvent<infer U> ? T : never): void;
+}
+
+/**
  * AR Event Target
  */
-export class AREventTarget<T extends AREventType> implements EventTarget
+export class AREventTarget<T>
 {
     /** event target delegate */
     private readonly _delegate: EventTarget;
@@ -76,9 +87,9 @@ export class AREventTarget<T extends AREventType> implements EventTarget
      * @param type event type
      * @param callback
      */
-    addEventListener(type: T, callback: AREventListener): void
+    addEventListener(type: AREventTypeOf<T>, callback: AREventListener<T>): void
     {
-        this._delegate.addEventListener(type, callback);
+        this._delegate.addEventListener(type, callback as EventListener);
     }
 
     /**
@@ -86,9 +97,9 @@ export class AREventTarget<T extends AREventType> implements EventTarget
      * @param type event type
      * @param callback
      */
-    removeEventListener(type: T, callback: AREventListener): void
+    removeEventListener(type: AREventTypeOf<T>, callback: AREventListener<T>): void
     {
-        this._delegate.removeEventListener(type, callback);
+        this._delegate.removeEventListener(type, callback as EventListener);
     }
 
     /**
@@ -97,7 +108,7 @@ export class AREventTarget<T extends AREventType> implements EventTarget
      * @returns same value as a standard event target
      * @internal
      */
-    dispatchEvent(event: AREvent<T>): boolean
+    dispatchEvent(event: T extends AREvent<infer U> ? T : never): boolean
     {
         return this._delegate.dispatchEvent(event);
     }

tsconfig.json

@@ -3,7 +3,7 @@
         "target": "es2020",
         "module": "es6",
         "lib": ["dom", "es2020"],
-        "outDir": "./dist/",
+        "outDir": "./build",
         "sourceMap": true,
         "allowJs": true,
         "strict": true,