Testing type definitions (Typescript)

package.json

@@ -3,18 +3,21 @@
   "version": "3.4.3",
   "description": "Efficient Augmented Reality for the Web",
   "main": "./aframe/build/aframe-ar.js",
+  "types": "./types/aframe/index.d.ts",
   "scripts": {
     "format-check": "prettier --check .",
     "format": "prettier --write .",
     "test": "echo \"Error: no test specified\" && exit 1",
     "build": "./node_modules/.bin/webpack --mode=production",
     "build:dev": "./node_modules/.bin/webpack --mode=development --progress --watch",
+    "build-types": "tsc",
     "server": "npx http-server -c -1",
     "prepare": "husky install"
   },
   "files": [
     "three.js/build",
-    "aframe/build"
+    "aframe/build",
+    "types"
   ],
   "repository": {
     "type": "git",
@@ -51,17 +54,18 @@
   },
   "homepage": "https://github.com/AR-js-org/AR.js/",
   "devDependencies": {
-    "husky": "^8.0.1",
-    "lint-staged": "^13.0.3",
-    "prettier": "^2.7.1",
-    "webpack": "^5.74.0",
-    "webpack-cli": "^4.10.0",
+    "husky": "^8.0.3",
+    "lint-staged": "^13.1.0",
+    "prettier": "^2.8.3",
+    "typescript": "^4.9.4",
+    "webpack": "^5.75.0",
+    "webpack-cli": "^5.0.1",
     "worker-loader": "^3.0.8"
   },
   "dependencies": {
     "@ar-js-org/artoolkit5-js": "^0.2.0",
     "aframe": "^1.0.4",
-    "three": "^0.146.0"
+    "three": "^0.148.0"
   },
   "lint-staged": {
     "*.js": "prettier --write"

three.js/src/location-based/js/device-orientation-controls.js

@@ -16,6 +16,9 @@ const _q1 = new Quaternion(-Math.sqrt(0.5), 0, 0, Math.sqrt(0.5)); // - PI/2 aro
 
 const _changeEvent = { type: "change" };
 
+/**
+ * @type Class
+ */
 class DeviceOrientationControls extends EventDispatcher {
   constructor(object) {
     super();

three.js/src/markers-area/arjs-markersareacontrols.js

@@ -3,6 +3,12 @@ import ArBaseControls from "../threex/threex-arbasecontrols";
 import ArMarkerControls from "../threex/arjs-markercontrols";
 import ArMultiMarkerControls from "./arjs-markersareacontrols";
 
+/**
+ * @type Class
+ * @param {any} arToolkitContext
+ * @param {any} object3d
+ * @param {any} parameters
+ */
 const MarkersAreaControls = function (arToolkitContext, object3d, parameters) {
   var _this = this;
   ArBaseControls.call(this, object3d);
@@ -36,7 +42,7 @@ const MarkersAreaControls = function (arToolkitContext, object3d, parameters) {
 };
 
 MarkersAreaControls.prototype = Object.create(ArBaseControls.prototype);
-MarkersAreaControls.prototype.constructor = MarkersAreaControls;
+//MarkersAreaControls.prototype.constructor = MarkersAreaControls;
 
 //////////////////////////////////////////////////////////////////////////////
 //		Code Separator

three.js/src/markers-area/arjs-markersarealearning.js

@@ -1,5 +1,10 @@
 import ArMultiMarkerControls from "./arjs-markersareacontrols";
 
+/**
+ * @type Class
+ * @param {any} arToolkitContext
+ * @param {any} subMarkersControls
+ */
 const MarkersAreaLearning = function (arToolkitContext, subMarkersControls) {
   var _this = this;
   this._arToolkitContext = arToolkitContext;

three.js/src/new-api/arjs-anchor.js

@@ -10,7 +10,7 @@ import MarkersAreaUtils from "../markers-area/arjs-markersareautils";
 
 /**
  * Create an anchor in the real world
- *
+ * @type Class
  * @param {ARjs.Session} arSession - the session on which we create the anchor
  * @param {Object} markerParameters - parameter of this anchor
  */

three.js/src/new-api/arjs-debugui.js

@@ -3,7 +3,7 @@ import Context from "../threex/arjs-context"; // TODO context build-dependent
 
 /**
  * Create an debug UI for an ARjs.Anchor
- *
+ * @type Class
  * @param {ARjs.Anchor} arAnchor - the anchor to user
  */
 const SessionDebugUI = function (arSession) {
@@ -41,7 +41,7 @@ SessionDebugUI.AugmentedWebsiteURL = "https://webxr.io/augmented-website";
 
 /**
  * Create an debug UI for an ARjs.Anchor
- *
+ * @type Class
  * @param {ARjs.Anchor} arAnchor - the anchor to user
  */
 const AnchorDebugUI = function (arAnchor) {

three.js/src/new-api/arjs-hittesting.js

@@ -2,7 +2,7 @@ import HitTestingPlane from "../threex/threex-hittesting-plane";
 
 /**
  * Create an anchor in the real world
- *
+ * @type Class
  * @param {ARjs.Session} arSession - the session on which we create the anchor
  * @param {Object} markerParameters - parameter of this anchor
  */

three.js/src/new-api/arjs-session-nft.js

@@ -3,8 +3,8 @@ import Source from "../threex/arjs-source";
 import Context from "../threex/arjs-context"; // TODO context build-dependent
 
 /**
- *  * define a Session
- *
+ * define a Session
+ * @type Class
  * @param {Object} parameters - parameters for this session
  */
 const Session = function (parameters) {

three.js/src/new-api/arjs-session.js

@@ -3,8 +3,8 @@ import Source from "../threex/arjs-source";
 import Context from "../threex/arjs-context"; // TODO context build-dependent
 
 /**
- *  * define a Session
- *
+ * define a Session
+ * @type Class
  * @param {Object} parameters - parameters for this session
  */
 const Session = function (parameters) {

three.js/src/threex/arjs-context.js

@@ -2,7 +2,10 @@ import * as THREE from "three";
 import ArMarkerControls from "./arjs-markercontrols";
 import jsartoolkit from "jsartoolkit"; // TODO comment explanation
 const { ARController } = jsartoolkit;
-
+/**
+ * @type Class
+ * @param {object} parameters
+ */
 const Context = function (parameters) {
   var _this = this;
 

three.js/src/threex/arjs-markercontrols.js

@@ -4,6 +4,13 @@ import Worker from "./arjs-markercontrols-nft.worker.js";
 import jsartoolkit from "jsartoolkit"; // TODO comment explanation
 const { ARToolkit } = jsartoolkit;
 
+/**
+ *
+ * @param {any} context
+ * @param {any} object3d
+ * @param {object} parameters
+ * @type Class
+ */
 const MarkerControls = function (context, object3d, parameters) {
   var _this = this;
 
@@ -99,7 +106,7 @@ const MarkerControls = function (context, object3d, parameters) {
 };
 
 MarkerControls.prototype = Object.create(ArBaseControls.prototype);
-MarkerControls.prototype.constructor = MarkerControls;
+//MarkerControls.prototype.constructor = MarkerControls;
 
 //////////////////////////////////////////////////////////////////////////////
 //		dispose instance

three.js/src/threex/arjs-profile.js

@@ -7,6 +7,7 @@ import ArToolkitContext from "./arjs-context"; // TODO context build-dependent
  * - all the other classes are still expecting normal parameters
  * - you can use this class to understand how to tune your specific usecase
  * - it is made to help people to build parameters without understanding all the underlying details.
+ * @type Class
  */
 const Profile = function () {
   this.reset();

three.js/src/threex/arjs-source.js

@@ -1,3 +1,7 @@
+/**
+ * @type Class
+ * @param {object} parameters
+ */
 const Source = function (parameters) {
   var _this = this;
 

three.js/src/threex/threex-arbasecontrols.js

@@ -1,5 +1,9 @@
 import * as THREE from "three";
 
+/**
+ * @type Class
+ * @param {any} object3d
+ */
 const ArBaseControls = function (object3d) {
   this.id = ArBaseControls.id++;
 

three.js/src/threex/threex-arclickability.js

@@ -6,6 +6,8 @@ import * as THREE from "three";
  * - maybe support .onClickFcts in each object3d
  * - seems an easy light layer for clickable object
  * - up to
+ * @type Class
+ * @param {any} sourceElement
  */
 const ARClickability = function (sourceElement) {
   this._sourceElement = sourceElement;

three.js/src/threex/threex-armarkercloak.js

@@ -6,6 +6,8 @@ import * as THREE from "three";
  * - cloakHeight
  * - cloakSegmentsHeight
  * - remove all mentions of cache, for cloak
+ * @type Class
+ * @param {any} videoTexture
  */
 const ArMarkerCloak = function (videoTexture) {
   var updateInShaderEnabled = true;

three.js/src/threex/threex-armarkerhelper.js

@@ -1,5 +1,9 @@
 import * as THREE from "three";
 
+/**
+ * @type Class
+ * @param {any} markerControls
+ */
 const ArMarkerHelper = function (markerControls) {
   this.object3d = new THREE.Group();
 

three.js/src/threex/threex-arsmoothedcontrols.js

@@ -4,8 +4,9 @@ import ArBaseControls from "./threex-arbasecontrols";
  * - lerp position/quaternino/scale
  * - minDelayDetected
  * - minDelayUndetected
- * @param {[type]} object3d   [description]
- * @param {[type]} parameters [description]
+ * @type Class
+ * @param {any} object3d   [description]
+ * @param {any} parameters [description]
  */
 const ArSmoothedControls = function (object3d, parameters) {
   var _this = this;
@@ -69,7 +70,7 @@ const ArSmoothedControls = function (object3d, parameters) {
 };
 
 ArSmoothedControls.prototype = Object.create(ArBaseControls.prototype);
-ArSmoothedControls.prototype.constructor = ArSmoothedControls;
+//ArSmoothedControls.prototype.constructor = ArSmoothedControls;
 
 //////////////////////////////////////////////////////////////////////////////
 //		update function

three.js/src/threex/threex-artoolkitprofile.js

@@ -5,8 +5,8 @@ import Profile from "./arjs-profile";
  * - all the other classes are still expecting normal parameters
  * - you can use this class to understand how to tune your specific usecase
  * - it is made to help people to build parameters without understanding all the underlying details.
+ * @type Class
  */
-
 const ArToolkitProfile = Profile;
 
 export default ArToolkitProfile;

three.js/src/threex/threex-arvideoinwebgl.js

@@ -1,5 +1,9 @@
 import * as THREE from "three";
 
+/**
+ * @type Class
+ * @param {any} videoTexture
+ */
 const ArVideoInWebgl = function (videoTexture) {
   var _this = this;
 

three.js/src/threex/threex-hittesting-plane.js

@@ -6,6 +6,8 @@ import * as THREE from "three";
  * - maybe support .onClickFcts in each object3d
  * - seems an easy light layer for clickable object
  * - up to
+ * @type Class
+ * @param {any} sourceElement
  */
 const HitTestingPlane = function (sourceElement) {
   this._sourceElement = sourceElement;

tsconfig.json

@@ -0,0 +1,22 @@
+{
+  // Change this to match your project
+  "include": ["three.js/src/*", "three.js/src/**/*", "aframe/src/*"],
+  "compilerOptions": {
+    // Tells TypeScript to read JS files, as
+    // normally they are ignored as source files
+    "allowJs": true,
+    "allowSyntheticDefaultImports": true,
+    // Generate d.ts files
+    "declaration": true,
+    // This compiler run should
+    // only output d.ts files
+    "emitDeclarationOnly": true,
+    // Types should go into this directory.
+    // Removing this would place the .d.ts files
+    // next to the .js files
+    "outDir": "types",
+    // go to js file when using IDE functions like
+    // "Go to Definition" in VSCode
+    "declarationMap": true
+  }
+}

types/aframe/src/component-anchor-nft.d.ts

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=component-anchor-nft.d.ts.map

types/aframe/src/component-anchor.d.ts

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=component-anchor.d.ts.map

types/aframe/src/component-hit-testing.d.ts

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=component-hit-testing.d.ts.map

types/aframe/src/index-nft.d.ts

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=index-nft.d.ts.map

types/aframe/src/index.d.ts

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=index.d.ts.map

types/aframe/src/location-based/arjs-look-controls.d.ts

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=arjs-look-controls.d.ts.map

types/aframe/src/location-based/arjs-webcam-texture.d.ts

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=arjs-webcam-texture.d.ts.map

types/aframe/src/location-based/gps-camera.d.ts

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=gps-camera.d.ts.map

types/aframe/src/location-based/gps-entity-place.d.ts

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=gps-entity-place.d.ts.map

types/aframe/src/location-based/gps-projected-camera.d.ts

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=gps-projected-camera.d.ts.map

types/aframe/src/location-based/gps-projected-entity-place.d.ts

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=gps-projected-entity-place.d.ts.map

types/aframe/src/new-location-based/arjs-device-orientation-controls.d.ts

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=arjs-device-orientation-controls.d.ts.map

types/aframe/src/new-location-based/gps-new-camera.d.ts

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=gps-new-camera.d.ts.map

types/aframe/src/new-location-based/gps-new-entity-place.d.ts

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=gps-new-entity-place.d.ts.map

types/aframe/src/system-arjs-nft.d.ts

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=system-arjs-nft.d.ts.map