@intelligentgraphics/ig.gfx.packager 3.0.9 → 3.0.11

package/package.json

@@ -1,9 +1,10 @@
 {
   "name": "@intelligentgraphics/ig.gfx.packager",
-  "version": "3.0.9",
-  "description": "IG.GFX.Packager 3.0.9 (3.0.9.100)",
+  "version": "3.0.11",
+  "description": "IG.GFX.Packager 3.0.11 (3.0.11.100)",
   "author": "Michael Beier <mb@intelligentgraphics.biz>",
-  "main": "build/index.mjs",
+  "main": "lib/lib.mjs",
+  "types": "lib/lib.d.ts",
   "private": false,
   "type": "module",
   "publishConfig": {
@@ -13,7 +14,11 @@
     "node": ">=16.19.0"
   },
   "bin": {
-    "packager": "./build/index.mjs"
+    "packager": "./build/bin.mjs"
+  },
+  "exports": {
+    "import": "./lib/lib.mjs",
+    "types": "./lib/lib.d.ts"
   },
   "files": [
     "build"
@@ -45,19 +50,18 @@
     "yargs": "^17.6.2"
   },
   "devDependencies": {
-    "@babel/core": "^7.21.3",
-    "@babel/preset-env": "^7.18.9",
-    "@babel/preset-typescript": "^7.18.6",
     "@intelligentgraphics/ig.gfx.tools.core": "^1.0.0",
-    "@rollup/plugin-babel": "^6.0.3",
     "@rollup/plugin-commonjs": "^24.0.0",
     "@rollup/plugin-json": "^6.0.0",
     "@rollup/plugin-node-resolve": "^15.0.1",
+    "@rollup/plugin-swc": "^0.1.0",
+    "@swc/core": "^1.3.56",
     "@types/glob": "^8.0.1",
     "@types/inquirer": "^9.0.3",
     "@types/node": "^18.15.3",
     "@types/update-notifier": "^6.0.1",
     "@types/yargs": "^17.0.2",
-    "rollup": "^3.10.0"
+    "rollup": "^3.10.0",
+    "rollup-plugin-dts": "^5.3.0"
   }
 }

package/readme.md

@@ -380,12 +380,87 @@ The code snippet above will generate the following \_Index.json output:
 ]
 ```
 
+Additionally when using the `--strictOptional`, this command will also mark non optional parameters as required.
+
+**Example for non optional parameters**
+
+```ts
+namespace IG.Test {
+	interface Params {
+		/**
+		 * Width of the corpus.
+		 *
+		 * Additional informations used to document the property internally
+		 *
+		 * @default 1.0
+		 * @creatorType Float
+		 * @summary Width of the corpus
+		 */
+		Corpus_Width: number | string;
+
+		/**
+		 * Type of the corpus
+		 *
+		 * @default "extra_wide"
+		 * @creatorType String
+		 */
+		Corpus_Type: string;
+	}
+
+	/**
+	 * The description of my evaluator
+	 */
+	export class MyEvaluator extends IGX.IEvaluator {
+		public static Create(
+			productId: string,
+			path: string,
+			parameters: Params,
+		): IGX.EvalResponse {}
+	}
+}
+```
+
+The code snippet above will generate the following \_Index.json output:
+
+```json
+[
+	{
+		"Name": "IG.Test.MyEvaluator",
+		"Description": "The description of my evaluator",
+		"Type": "Evaluator",
+		"Parameters": [
+			{
+				"Name": "Corpus_Width",
+				"Description": "Width of the corpus",
+				"Default": 1.0,
+				"Type": "Float",
+				"DisplayIndex": 1,
+				"Required": true
+			},
+			{
+				"Name": "Corpus_Type",
+				"Description": "Type of the corpus",
+				"Default": "extra_wide",
+				"Type": "String",
+				"DisplayIndex": 2,
+				"Required": true
+			}
+		]
+	}
+]
+```
+
+The `Required` property will be used by the VSCode extension to show an error whenever a required parameter was not declared when configuring parameters for a script class.
+
 **Migrating from a handwritten \_Index.json to an auto generated one:**
 
 1. Make sure all Evaluators implement or extend the IGX.IEvaluator class.
 2. Run the index generation. The output should be nearly identical. If an evaluator does not have an explicit Parameter type, the generator will reuse the informations from an existing \_Index.json file.
 3. Now you can choose to add the parameter types either incrementally or all at once.
 
+To aid with this migration you may also use the command `packager generateParameterType [directory] [name]` to generate a parameters interface for the class identified by the provided name using existing \_Index.json informations.
+In order to generate a parameters interface for a class "AnimationInteractor" of the directory/package "Standard", you would execute the command `packager generateParameterType Standard AnimationInteractor`. This will generate txt file with the type next to the typescript files.
+
 ## Troubleshoot
 
 ### Definitions for ig libraries are not available even though they are registered as dependencies in the package.json
@@ -395,6 +470,15 @@ Afterwards you may need to reload your editor in order for the installed files t
 
 ## History
 
+**IG.GFX.Packager 3.0.11**
+
+-   add library distribution
+-   write version into \_Package.json
+
+**IG.GFX.Packager 3.0.10**
+
+-   add strictOptional option for index generation -> see [\_Index.json generation](#_indexjson-generation)
+
 **IG.GFX.Packager 3.0.9**
 
 -   exit with error code 1 on errors
@@ -442,8 +526,8 @@ Afterwards you may need to reload your editor in order for the installed files t
 
 **IG.GFX.Packager 3.0.0**
 
--   change packager to be installed globally (see [Migrating to ig.gfx.packager 3.0](#Migrating-to-ig.gfx.packager-3.0))
--   offer to upload dependencies, that are defined in the workspace package json, to a creator sub domain if they are not available or outdated (see [Declaring dependencies on ig libraries](#declaring-dependencies-on-ig-libraries))
+-   change packager to be installed globally (see [Migrating to ig.gfx.packager 3.0](#migrating-to-iggfxpackager-30))
+-   offer to upload dependencies, that are defined in the workspace package json, to a creator sub domain if they are not available or outdated (see [Using ig libraries](#using-ig-libraries))
 
 **IG.GFX.Packager 3.0.0-beta.3**