@intelligentgraphics/ig.gfx.packager 3.0.16 → 3.0.18

package/lib/lib.mjs

@@ -39,15 +39,15 @@ const getNodeErrorCode = (error)=>{
         return error.code;
     }
 };
-/**
- * Permission denied: An attempt was made to access a file in a way forbidden by its file access permissions.
- *
- * @param {unknown} error
+/**
+ * Permission denied: An attempt was made to access a file in a way forbidden by its file access permissions.
+ *
+ * @param {unknown} error
  */ const isErrorEACCES = (error)=>getNodeErrorCode(error) === "EACCES";
-/**
- * No such file or directory: Commonly raised by fs operations to indicate that a component of the specified pathname does not exist. No entity (file or directory) could be found by the given path.
- *
- * @param {unknown} error
+/**
+ * No such file or directory: Commonly raised by fs operations to indicate that a component of the specified pathname does not exist. No entity (file or directory) could be found by the given path.
+ *
+ * @param {unknown} error
  */ const isErrorENOENT = (error)=>getNodeErrorCode(error) === "ENOENT";
 const isErrorEPERM = (error)=>getNodeErrorCode(error) === "EPERM";
 
@@ -115,14 +115,14 @@ const readPackageAnimationList = (location)=>{
 };
 const getPackageReleasesDirectory = (location)=>path.join(location.path, "Releases");
 
-/**
- * Detects a published package from a path.
- *
- * Can return undefined if the package is not installed.
- *
- * @param {string} resolveBasePath
- * @param {string} name
- * @return {*}  {(PublishedPackageLocation | undefined)}
+/**
+ * Detects a published package from a path.
+ *
+ * Can return undefined if the package is not installed.
+ *
+ * @param {string} resolveBasePath
+ * @param {string} name
+ * @return {*}  {(PublishedPackageLocation | undefined)}
  */ const detectPublishedPackageFromPath = (resolveBasePath, name)=>{
     try {
         const manifestPath = resolve.sync(name + "/package.json", {
@@ -210,11 +210,11 @@ const getWorkspaceOutputPath = (workspace)=>path.join(workspace.path, "bin");
 // 	}
 // 	return results;
 // };
-/**
- * Recursively determines all installed ig libraries for a workspace.
- *
- * @param {WorkspaceLocation} workspace
- * @returns {PublishedPackageLocation[]}
+/**
+ * Recursively determines all installed ig libraries for a workspace.
+ *
+ * @param {WorkspaceLocation} workspace
+ * @returns {PublishedPackageLocation[]}
  */ const determineWorkspaceIGLibraries = (workspace)=>{
     const manifest = readWorkspaceNpmManifest(workspace);
     const libraries = collectIGLibraries(workspace, manifest);
@@ -277,11 +277,11 @@ const getPackageTypescriptFiles = (location)=>glob.sync("**/*.ts", {
     });
 
 const PLUGIN_ID = "0feba3a0-b6d1-11e6-9598-0800200c9a66";
-/**
- * Starts an IG.Asset.Server session and returns the sessionId
- *
- * @param {SessionStartParams} params
- * @returns
+/**
+ * Starts an IG.Asset.Server session and returns the sessionId
+ *
+ * @param {SessionStartParams} params
+ * @returns
  */ const startSession = async ({ url , authentication , ...params })=>{
     const payload = {
         ...params,
@@ -496,16 +496,342 @@ const toposort = (packages)=>{
     return result;
 };
 
+var animationSchema = {
+    $schema: "http://json-schema.org/draft-07/schema",
+    $id: "https://archive.intelligentgraphics.biz/schemas/gfx/animation.json",
+    $comment: "Version 2023-02-17, Source: ig.data.gfx/Specs/animation.json",
+    title: "Animation description format",
+    additionalProperties: false,
+    type: "object",
+    properties: {
+        $schema: {
+            type: "string"
+        },
+        Id: {
+            type: "string",
+            description: "Animation id, to be unique in the project scope. Needs to be a valid JavaScript identifier."
+        },
+        Animations: {
+            type: "array",
+            description: "Declaration of animation states for gfx objects",
+            items: {
+                type: "object",
+                additionalProperties: false,
+                properties: {
+                    _: {
+                        type: "string",
+                        description: "Comment"
+                    },
+                    Path: {
+                        $ref: "#/definitions/igxcPath"
+                    },
+                    States: {
+                        type: "object",
+                        additionalProperties: {
+                            type: "object",
+                            additionalProperties: false,
+                            properties: {
+                                Position: {
+                                    $ref: "#/definitions/vec3"
+                                },
+                                Rotation: {
+                                    $ref: "#/definitions/rotation"
+                                },
+                                Scaling: {
+                                    $ref: "#/definitions/vec3"
+                                },
+                                Visibility: {
+                                    type: "boolean"
+                                },
+                                Deformation: {
+                                    anyOf: [
+                                        {
+                                            type: "number"
+                                        },
+                                        {
+                                            type: "string"
+                                        }
+                                    ]
+                                }
+                            }
+                        }
+                    }
+                }
+            }
+        },
+        Kinematics: {
+            oneOf: [
+                {
+                    $ref: "#/definitions/kinematicChain"
+                },
+                {
+                    type: "array",
+                    items: {
+                        $ref: "#/definitions/kinematicChain"
+                    }
+                }
+            ]
+        },
+        LinkedPoints: {
+            type: "object",
+            additionalProperties: {
+                type: "array",
+                items: {
+                    type: "string"
+                }
+            }
+        },
+        _: {
+            type: "string",
+            description: "Comment"
+        }
+    },
+    definitions: {
+        vec3: {
+            type: "object",
+            additionalProperties: false,
+            properties: {
+                X: {
+                    anyOf: [
+                        {
+                            type: "number"
+                        },
+                        {
+                            type: "string"
+                        }
+                    ]
+                },
+                Y: {
+                    anyOf: [
+                        {
+                            type: "number"
+                        },
+                        {
+                            type: "string"
+                        }
+                    ]
+                },
+                Z: {
+                    anyOf: [
+                        {
+                            type: "number"
+                        },
+                        {
+                            type: "string"
+                        }
+                    ]
+                },
+                _: {
+                    type: "string",
+                    description: "Comment"
+                }
+            }
+        },
+        rotation: {
+            type: "object",
+            additionalProperties: false,
+            properties: {
+                Q: {
+                    description: "If true, the rotation is considered to be a Quaternion. Otherwise, it's interpreted as Euler arcs and W will be ignored.",
+                    type: "boolean"
+                },
+                X: {
+                    anyOf: [
+                        {
+                            type: "number"
+                        },
+                        {
+                            type: "string"
+                        }
+                    ]
+                },
+                Y: {
+                    anyOf: [
+                        {
+                            type: "number"
+                        },
+                        {
+                            type: "string"
+                        }
+                    ]
+                },
+                Z: {
+                    anyOf: [
+                        {
+                            type: "number"
+                        },
+                        {
+                            type: "string"
+                        }
+                    ]
+                },
+                W: {
+                    anyOf: [
+                        {
+                            type: "number"
+                        },
+                        {
+                            type: "string"
+                        }
+                    ]
+                },
+                _: {
+                    type: "string",
+                    description: "Comment"
+                }
+            }
+        },
+        igxcPath: {
+            type: "string",
+            description: "Relative path of the target object",
+            pattern: "^((o|e)\\d+(\\.(o|e)\\d+)*|\\.)$"
+        },
+        param: {
+            type: "string",
+            pattern: "^Param\\d+$"
+        },
+        kinematicChain: {
+            type: "object",
+            additionalProperties: false,
+            properties: {
+                GeometryBase: {
+                    type: "string"
+                },
+                Joints: {
+                    type: "array",
+                    items: {
+                        type: "object",
+                        additionalProperties: false,
+                        properties: {
+                            Name: {
+                                oneOf: [
+                                    {
+                                        $ref: "#/definitions/param"
+                                    },
+                                    {
+                                        type: "string"
+                                    }
+                                ]
+                            },
+                            HeadX: {
+                                oneOf: [
+                                    {
+                                        $ref: "#/definitions/param"
+                                    },
+                                    {
+                                        $ref: "#/definitions/igxcPath"
+                                    }
+                                ]
+                            },
+                            HeadY: {
+                                oneOf: [
+                                    {
+                                        $ref: "#/definitions/param"
+                                    },
+                                    {
+                                        $ref: "#/definitions/igxcPath"
+                                    }
+                                ]
+                            },
+                            HeadZ: {
+                                oneOf: [
+                                    {
+                                        $ref: "#/definitions/param"
+                                    },
+                                    {
+                                        $ref: "#/definitions/igxcPath"
+                                    }
+                                ]
+                            },
+                            Tail: {
+                                oneOf: [
+                                    {
+                                        $ref: "#/definitions/param"
+                                    },
+                                    {
+                                        $ref: "#/definitions/igxcPath"
+                                    }
+                                ]
+                            },
+                            LimitLeft: {
+                                type: "number"
+                            },
+                            LimitRight: {
+                                type: "number"
+                            },
+                            LimitUp: {
+                                type: "number"
+                            },
+                            LimitDown: {
+                                type: "number"
+                            },
+                            FollowJointNode: {
+                                $ref: "#/definitions/igxcPath"
+                            },
+                            _TargetNodeForFollow: {
+                                type: "string"
+                            }
+                        }
+                    }
+                },
+                Target: {
+                    oneOf: [
+                        {
+                            $ref: "#/definitions/igxcPath"
+                        },
+                        {
+                            $ref: "#/definitions/param"
+                        },
+                        {
+                            type: "string",
+                            enum: [
+                                "subbase"
+                            ]
+                        }
+                    ]
+                },
+                Parent: {
+                    oneOf: [
+                        {
+                            $ref: "#/definitions/igxcPath"
+                        },
+                        {
+                            type: "string",
+                            enum: [
+                                "root"
+                            ]
+                        }
+                    ]
+                },
+                Tolerance: {
+                    type: "number"
+                },
+                MaxIterations: {
+                    type: "integer"
+                },
+                _: {
+                    type: "string",
+                    description: "Comment"
+                },
+                __: {
+                    type: "string",
+                    description: "Super Comment"
+                }
+            }
+        }
+    }
+};
+
 let validateAnimationJson;
 const getAnimationJsonValidation = async ()=>{
     if (validateAnimationJson === undefined) {
-        validateAnimationJson = await axios.get("https://archive.intelligentgraphics.biz/schemas/gfx/animation.json").then(({ data  })=>new Ajv({
-                coerceTypes: true,
-                allErrors: true,
-                removeAdditional: true,
-                useDefaults: "empty",
-                validateSchema: "log"
-            }).compile(data));
+        validateAnimationJson = new Ajv({
+            coerceTypes: true,
+            allErrors: true,
+            removeAdditional: true,
+            useDefaults: "empty",
+            validateSchema: "log"
+        }).compile(animationSchema);
     }
     return validateAnimationJson;
 };
@@ -709,10 +1035,10 @@ const createBannerComment = (banner)=>{
     }
     const bannerText = bannerParts.join("\n\n");
     if (bannerText) {
-        return `/*
-${bannerText}
-*
-* @preserve			
+        return `/*
+${bannerText}
+*
+* @preserve			
 */`;
     }
     return undefined;
@@ -926,19 +1252,19 @@ class PackageVersion {
         parts.push(`(${base}.${this.buildNumber})`);
         return parts.join(" ");
     }
-    /**
-	 * Determines wether the version is lesser than the input version
-	 *
-	 * @param {PackageVersion} version
-	 * @returns
+    /**
+	 * Determines wether the version is lesser than the input version
+	 *
+	 * @param {PackageVersion} version
+	 * @returns
 	 */ isLesserThan(version) {
         return PackageVersion.toNumber(this) < PackageVersion.toNumber(version);
     }
-    /**
-	 * Determines wether the version is greater than the input version
-	 *
-	 * @param {PackageVersion} version
-	 * @returns
+    /**
+	 * Determines wether the version is greater than the input version
+	 *
+	 * @param {PackageVersion} version
+	 * @returns
 	 */ isGreaterThan(version) {
         return PackageVersion.toNumber(this) > PackageVersion.toNumber(version);
     }
@@ -1094,10 +1420,10 @@ const notRuntimeScripts = [
     "Context",
     "Evaluator"
 ];
-const buildArchiveFromPackage = async (workspaceLocation, packageLocation, data)=>{
+const buildArchiveFromPackage = async (packageLocation, data, binDir)=>{
     const { domain , subdomain  } = parseCreatorPackageName(data);
     const logStep = (step)=>logPackageMessage(data.Package, step);
-    const libFilePath = path.join(getWorkspaceOutputPath(workspaceLocation), `${data.Package}.min.js`);
+    const libFilePath = path.join(binDir, `${data.Package}.min.js`);
     const scriptDirectories = [
         packageLocation.path,
         packageLocation.scriptsDir
@@ -1139,7 +1465,7 @@ const buildArchiveFromPackage = async (workspaceLocation, packageLocation, data)
     }
     if (!library) {
         const date = new Date(Date.now());
-        library = `/* This file is part of the ${domain} Data Packages.
+        library = `/* This file is part of the ${domain} Data Packages.
 		* Copyright (C) ${date.getFullYear()} intelligentgraphics. All Rights Reserved. */`;
     }
     const minifyResult = await terser.minify(library, {
@@ -1211,7 +1537,7 @@ const releaseFolder = async (options)=>{
             cwd: workspace.path
         });
     }
-    const binDir = getWorkspaceOutputPath(workspace);
+    const binDir = options.outDir ?? getWorkspaceOutputPath(workspace);
     await fs$1.mkdir(binDir, {
         recursive: true
     });
@@ -1287,7 +1613,7 @@ const releaseFolder = async (options)=>{
                     }
                 }
             }
-            const archive = await buildArchiveFromPackage(workspace, location, packageDescription);
+            const archive = await buildArchiveFromPackage(location, packageDescription, binDir);
             try {
                 const zipOutputStream = createWriteStream(zipFilePath);
                 await pipeline(archive.generateNodeStream(), zipOutputStream);
@@ -1455,15 +1781,6 @@ const ensureRequiredVersions = async (workspaceLocation, creatorPackage, session
         const newVersionString = libraryVersion.toVersionString({
             buildNumber: true
         });
-        const packageNameWithVersion = `${libraryCreatorPackage.Package}_${newVersionString}`;
-        const zipFilePath = path.join(getWorkspaceOutputPath(workspaceLocation), `${packageNameWithVersion}.zip`);
-        try {
-            await fs$1.rm(zipFilePath);
-        } catch (err) {
-            if (!isErrorENOENT(err)) {
-                throw err;
-            }
-        }
         const session = uploadTargetScope === "Basics" ? await sessionManager.getBasicsSession() : targetSession;
         logPackageMessage(creatorPackage.Package, `Uploading package ${libraryCreatorPackage.Package} with version ${newVersionString} to ${session.domain}.${session.subDomain}`);
         await uploadPackageFromStream(session, {
@@ -1498,10 +1815,10 @@ const createSessionManager = async (params)=>{
     };
 };
 
-/**
- * Extracts and returns script array for _Index.json from a src folder
- *
- * @param folderPath path to a src folder
+/**
+ * Extracts and returns script array for _Index.json from a src folder
+ *
+ * @param folderPath path to a src folder
  */ function generateIndex({ location , ignore =[] , strictOptional =false  }) {
     const files = getPackageTypescriptFiles(location);
     const filtered = files.filter((path)=>{
@@ -1717,11 +2034,11 @@ const isScriptingClassParameterDeclaration = (scriptingClass, memberNode, parame
     }
     return false;
 };
-/**
- * Finds interactors and evaluators within a script file
- *
- * @param {ts.Node} node
- * @return {*}
+/**
+ * Finds interactors and evaluators within a script file
+ *
+ * @param {ts.Node} node
+ * @return {*}
  */ const findScriptingClasses = (node)=>{
     let body;
     if (ts.isModuleDeclaration(node)) {

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@intelligentgraphics/ig.gfx.packager",
-  "version": "3.0.16",
-  "description": "IG.GFX.Packager 3.0.16 (3.0.16.100)",
+  "version": "3.0.18",
+  "description": "IG.GFX.Packager 3.0.18 (3.0.18.100)",
   "author": "Michael Beier <mb@intelligentgraphics.biz>",
   "main": "lib/lib.mjs",
   "types": "lib/lib.d.ts",
@@ -62,6 +62,7 @@
     "@types/update-notifier": "^6.0.1",
     "@types/yargs": "^17.0.2",
     "rollup": "^3.10.0",
-    "rollup-plugin-dts": "^5.3.0"
+    "rollup-plugin-dts": "^5.3.0",
+    "vitest": "^0.29.5"
   }
 }

package/readme.md

@@ -470,6 +470,14 @@ Afterwards you may need to reload your editor in order for the installed files t
 
 ## History
 
+**IG.GFX.Packager 3.0.18**
+
+-   add animation json schema to own files and no longer load it from archive
+
+**IG.GFX.Packager 3.0.17**
+
+-   use provided bin dir
+
 **IG.GFX.Packager 3.0.16**
 
 -   fix publishNpm for windows