Add TypeScript definitions and configuration for ThreeJSRendererPlugin

Author: kalwalt

README.md

@@ -235,6 +235,15 @@ GitHub Actions workflow (`.github/workflows/ci.yml`) runs:
 - Tests (Node version defined in `.nvmrc` file)
   Badge above shows current status.
 
+## Type Definitions 🔤🧾
+
+TypeScript declaration files are included in the `types` folder. Prefer importing types from the provided declarations:
+
+- `types/index.d.ts`
+- `types/threejs-renderer-plugin.d.ts`
+
+Source maps (`.d.ts.map`) are included for better editor/IDE support.
+
 ## Compatibility 🔄
 - Built & tested with Three.js 0.161.x
 - Requires AR.js-core engine abstraction with an event bus (`on/off/emit`)

package-lock.json

@@ -14,6 +14,7 @@
   },
   "sideEffects": false,
   "scripts": {
+    "build:types": "tsc",
     "build:vite": "vite build",
     "dev:vite": "vite",
     "serve:vite": "vite preview",
@@ -33,6 +34,7 @@
     "@vitest/coverage-v8": "^4.0.8",
     "three": "^0.161.0",
     "jsdom": "^19.0.0",
+    "typescript": "^3.9.10",
     "vite": "^7.1.12",
     "vitest": "^4.0.8"
   },

package.json

@@ -0,0 +1,25 @@
+{
+  // Change this to match your project
+  "include": ["src/**/*"],
+  "compilerOptions": {
+    "target": "ESnext" /* Specify ECMAScript target version: 'ES3' (default), 'ES5', 'ES2015', 'ES2016', 'ES2017', 'ES2018', 'ES2019', 'ES2020', or 'ESNEXT'. */,
+    "module": "ESnext",
+    // Tells TypeScript to read JS files, as
+    // normally they are ignored as source files
+    "allowJs": true,
+    // Generate d.ts files
+    "declaration": true,
+    // This compiler run should
+    // only output d.ts files
+    "emitDeclarationOnly": true,
+    /* Module Resolution Options */
+    "moduleResolution": "node",
+    // 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
+  }
+}

tsconfig.json

@@ -0,0 +1,2 @@
+export { ThreeJSRendererPlugin } from "./threejs-renderer-plugin.js";
+//# sourceMappingURL=index.d.ts.map

types/index.d.ts

@@ -0,0 +1,66 @@
+/**
+ * Plugin to render THREE.js scenes driven by AR markers.
+ * Provides management of renderer, scene, camera and marker anchors.
+ * Supported options: antialias, alpha, preferRAF, container, invertModelView, applyAxisFix
+ */
+export class ThreeJSRendererPlugin {
+    constructor(options?: {});
+    name: string;
+    version: any;
+    engine: any;
+    emitter: any;
+    renderer: any;
+    scene: any;
+    camera: any;
+    anchors: Map<any, any>;
+    options: {
+        antialias: any;
+        alpha: any;
+        preferRAF: any;
+        container: any;
+        minConfidence: any;
+        useLegacyAxisChain: any;
+        changeMatrixMode: any;
+        invertModelView: any;
+        applyAxisFix: any;
+        debugSceneAxes: any;
+        sceneAxesSize: any;
+        debugAnchorAxes: any;
+        anchorAxesSize: any;
+        rendererFactory: any;
+    };
+    _rafId: number;
+    _axisFix: any;
+    init(engine: any): void;
+    enable(): void;
+    _onUpdate: () => void;
+    _onMarker: (e: any) => void;
+    _onGetMarker: (e: any) => void;
+    _onCamera: (e: any) => void;
+    _onLegacyFound: (d: any) => void;
+    _onLegacyUpdated: (d: any) => void;
+    _onLegacyLost: (d: any) => void;
+    _onResize: () => void;
+    disable(): void;
+    dispose(): void;
+    _sub(ev: any, fn: any): void;
+    _off(ev: any, fn: any): void;
+    _adaptLegacy(d: any, visible: any): {
+        id: string;
+        matrix: any;
+        visible: any;
+        _legacy: boolean;
+    };
+    handleRawGetMarker(e: any): void;
+    handleUnifiedMarker(evt: any): void;
+    handleCamera(e: any): void;
+    handleUpdate(): void;
+    handleResize(): void;
+    _resizeToContainer(container: any): void;
+    getAnchor(id: any): any;
+    getScene(): any;
+    getCamera(): any;
+    getRenderer(): any;
+}
+export const THREEJS_RENDERER_PLUGIN_VERSION: any;
+//# sourceMappingURL=threejs-renderer-plugin.d.ts.map