add types + gthub workflow

Author: marwie

.github/workflows/publish.yml

@@ -0,0 +1,39 @@
+name: Release Workflow
+on:
+  push:
+    branches:
+      - 'release/next'
+      - 'release/rc'
+      - 'release/stable'
+
+jobs:
+  run-release-script:
+    runs-on: ubuntu-latest
+    timeout-minutes: 5
+    defaults:
+      run:
+        working-directory: .
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v4
+      
+      - name: Setup Node.js
+        uses: actions/setup-node@v4
+        with:
+          node-version: '22'
+          cache: 'npm'
+          cache-dependency-path: './package.json'
+                
+      - name: Publish to npm (stable branch)
+        if: startsWith(github.ref_name, 'release/stable')
+        run: npx --yes needle-publish-helper@next publish "." --webhook "${{ secrets.DISCORD_WEBHOOK }}" --access-token "${{ secrets.NPM_TOKEN }}" --tag "stable" --create-tag "release/" --llm-api-key "${{ secrets.LLM_API_KEY }}"
+                
+      - name: Publish to npm (rc branch)
+        if: startsWith(github.ref_name, 'release/rc')
+        run: npx --yes needle-publish-helper@next publish "." --webhook "${{ secrets.DISCORD_WEBHOOK }}" --access-token "${{ secrets.NPM_TOKEN }}" --tag "rc" --version+tag --create-tag "release/" --llm-api-key "${{ secrets.LLM_API_KEY }}"
+
+      - name: Publish to npm (next and experimental branches)
+        if: startsWith(github.ref_name, 'release/next')
+        run: npx --yes needle-publish-helper@next publish "." --webhook "${{ secrets.DISCORD_WEBHOOK }}" --access-token "${{ secrets.NPM_TOKEN }}" --tag "${{ github.ref_name }}" --version+tag --version+hash --create-tag "release/" --llm-api-key "${{ secrets.LLM_API_KEY }}"
+
+

package.json

@@ -1,9 +1,10 @@
 {
-  "name": "@needle-tools/three-animationpointer",
-  "version": "1.0.0",
+  "name": "@needle-tools/three-animation-pointer",
+  "version": "1.0.0-alpha",
   "description": "KHR_animation_pointer support for three.js",
   "type": "module",
   "main": "src/index.js",
+  "types": "types/index.d.ts",
   "author": {
     "name": "Needle",
     "email": "[email protected]",

src/GLTFLoaderAnimationPointer.js

@@ -10,6 +10,10 @@ import {
 	SkinnedMesh
 } from 'three';
 
+/** 
+ * @typedef {import("three/examples/jsm/loaders/GLTFLoader").GLTFLoaderPlugin} GLTFLoaderPlugin 
+ */
+
 // DUPLICATED from GLTFLoader.js
 const ANIMATION_TARGET_TYPE = {
 	node: 'node',
@@ -29,25 +33,32 @@ const INTERPOLATION = {
 	STEP: InterpolateDiscrete
 };
 
-// HACK monkey patching findNode to ensure we can map to other types required by KHR_animation_pointer.
-const find = PropertyBinding.findNode;
 const _animationPointerDebug = false;
 
+
 /**
  * Animation Pointer Extension
  *
  * Draft Specification: https://github.com/ux3d/glTF/tree/extensions/KHR_animation_pointer/extensions/2.0/Khronos/KHR_animation_pointer
+ * 
+ * @implements {GLTFLoaderPlugin}
  */
 export class GLTFAnimationPointerExtension {
 
+	/** @type {import("three/examples/jsm/loaders/GLTFLoader").GLTFParser} */
 	constructor( parser ) {
 
-		this.parser = parser;
 		this.name = KHR_ANIMATION_POINTER;
+		this.parser = parser;
+
+		/** @type {import("..").AnimationPointerResolver | null} */
 		this.animationPointerResolver = null;
 
 	}
 
+	/** 
+	 * @param {import("..").AnimationPointerResolver | null} animationPointerResolver
+	 */
 	setAnimationPointerResolver( animationPointerResolver ) {
 
 		this.animationPointerResolver = animationPointerResolver;
@@ -318,10 +329,9 @@ export class GLTFAnimationPointerExtension {
 
 			}
 
-			const pointerResolver = this.animationPointerResolver;
-			if ( pointerResolver && pointerResolver.resolvePath ) {
+			if ( this.animationPointerResolver?.resolvePath ) {
 
-				path = pointerResolver.resolvePath( path );
+				path = this.animationPointerResolver.resolvePath( path );
 
 			}
 
@@ -627,11 +637,17 @@ export class GLTFAnimationPointerExtension {
 
 let _havePatchedPropertyBindings = false;
 
+// HACK monkey patching findNode to ensure we can map to other types required by KHR_animation_pointer.
+/** @type {PropertyBinding.findNode | null} */
+let findNodeFn = null;
+
 function _ensurePropertyBindingPatch() {
 
 	if (_havePatchedPropertyBindings) return;
 	_havePatchedPropertyBindings = true;
 
+	const findNode = (findNodeFn ||= PropertyBinding.findNode);
+
 	// "node" is the Animator component in our case
 	// "path" is the animated property path, just with translated material names.
 	PropertyBinding.findNode = function (node, path) {
@@ -707,7 +723,7 @@ function _ensurePropertyBindingPatch() {
 
 			if (!currentTarget) {
 
-				const originalFindResult = find(node, sections[2]);
+				const originalFindResult = findNode(node, sections[2]);
 
 				if (!originalFindResult)
 					console.warn(KHR_ANIMATION_POINTER + ': Property binding not found', path, node, node.name, sections);
@@ -723,7 +739,7 @@ function _ensurePropertyBindingPatch() {
 
 		}
 
-		return find(node, path);
+		return findNode(node, path);
 
 	};
 

types/index.d.ts

@@ -0,0 +1,5 @@
+
+
+export type AnimationPointerResolver = {
+    resolvePath(path: string): string | null;
+}