capture ngt version for new animation api

Author: nartc

cli.js

@@ -11,6 +11,24 @@ import gltf from "./src/index.js";
 const __filename = fileURLToPath(import.meta.url);
 const __dirname = dirname(__filename);
 
+const parseVersion = (pkgJson, dep, cbs = {}) => {
+  if (pkgJson.dependencies[dep]) {
+    let raw = cwdPackageJson.dependencies[dep];
+    if (raw.includes("^") || ngRawVersion.includes("~")) {
+      // remove first character
+      raw = raw.slice(1);
+    }
+
+    const parsed = parse(raw);
+    const major = parsed.major;
+
+    cbs.afterParse?.(major, parsed);
+    return parsed;
+  } else {
+    cbs.depNotFound?.();
+  }
+};
+
 const cli = meow(
   `
   Usage
@@ -81,27 +99,28 @@ const { packageJson: cwdPackageJson } = readPackageUpSync({
 });
 const { packageJson } = readPackageUpSync({ cwd: __dirname });
 
-let ngVer;
-
-if (cwdPackageJson.dependencies["@angular/core"]) {
-  let ngRawVersion = cwdPackageJson.dependencies["@angular/core"];
-  if (ngRawVersion.includes("^") || ngRawVersion.includes("~")) {
-    // remove first character
-    ngRawVersion = ngRawVersion.slice(1);
-  }
-
-  const parsed = parse(ngRawVersion);
-  ngVer = parsed.major;
+const ngVer = parseVersion(cwdPackageJson, "@angular/core", {
+  afterParse: (major, parsed) => {
+    if (major < 18) {
+      console.error("Angular version must be >= 18");
+      process.exit(1);
+    }
 
-  if (ngVer < 18) {
-    console.error("Angular version must be >= 18");
-    process.exit(1);
-  }
+    console.log("Detected Angular version: ", parsed.version);
+  },
+  depNotFound: () => {
+    console.warn("Executing outside of Angular workspace");
+  },
+});
 
-  console.log("Detected Angular version: ", parsed.version);
-} else {
-  console.warn("Executing outside of Angular workspace");
-}
+const ngtVer = parseVersion(cwdPackageJson, "angular-three", {
+  afterParse: (_major, parsed) => {
+    console.log("Detected Angular Three version: ", parsed.version);
+  },
+  depNotFound: () => {
+    console.warn("Executing outside of Angular Three enabled workspace");
+  },
+});
 
 if (cli.input.length === 0) {
   console.log(cli.help);
@@ -129,7 +148,8 @@ if (cli.input.length === 0) {
     showLog,
     timeout: 0,
     delay: 1,
-    ngVer,
+    ngVer: ngVer.major,
+    ngtVer,
     header: `Auto-generated by: https://github.com/angular-threejs/gltf
 Command: npx angular-three-gltf&#64;${packageJson.version} ${process.argv.slice(2).join(" ")}`,
   };

package.json

@@ -1,6 +1,6 @@
 {
   "name": "angular-three-gltf",
-  "version": "1.1.12",
+  "version": "1.1.13",
   "description": "GLTF to Angular Three converter",
   "scripts": {
     "cleanup": "rimraf node_modules"

src/utils/parser.js

@@ -15,6 +15,9 @@ function parse(fileName, gltf, options = {}) {
   const gltfAnimationTypeName = componentName + "AnimationClips";
   const gltfAnimationApiTypeName = componentName + "AnimationApi";
   const gltfResultTypeName = componentName + "GLTFResult";
+  const useNewAnimationApi =
+    options.ngtVer?.major >= 4 ||
+    (options.ngtVer?.major === 3 && options.ngtVer?.minor >= 5);
   const ngtTypes = new Set();
 
   // Collect all objects
@@ -118,7 +121,7 @@ function parse(fileName, gltf, options = {}) {
       types.push(
         `type ActionName = ${animations.map((clip, i) => `"${clip.name}"`).join(" | ")};
          type ${gltfAnimationTypeName} = NgtsAnimationClips<ActionName>;
-         export type ${gltfAnimationApiTypeName} = NgtsAnimationApi<${gltfAnimationTypeName}> | null;`,
+         export type ${gltfAnimationApiTypeName} = ${useNewAnimationApi ? `Exclude<NgtsAnimationApi<${gltfAnimationTypeName}>, { get isReady(): false }>` : `NgtsAnimationApi<${gltfAnimationTypeName}>`} | null;`,
       );
     }
 
@@ -725,7 +728,7 @@ export class ${componentName} {
             ? `
         const animations = injectAnimations(this.gltf, this.modelRef);
         effect(() => {
-          if (animations.ready()) {
+          if (animations.${useNewAnimationApi ? "isReady" : "ready()"}) {
             this.animations.set(animations);
           }
         }${options.ngVer < 19 ? ", { allowSignalWrites: true }" : ""})