@intelligentgraphics/ig.gfx.packager 2.1.2 → 2.2.0

package/locales/en.json

@@ -9,15 +9,16 @@
   "options.domain.description": "Overwrite the publish domain",
   "options.subdomain.description": "Overwrite the publish subdomain",
   "options.address.description": "Address",
-  "options.service.description": "Bridge server url",
-  "options.service.demands": "The bridge server url has to either be provided using the option --service or through the \"%s\" environment variable",
+  "options.service.description": "Asset server url",
+  "options.service.demands": "The asset server url has to either be provided using the option --service or through the \"%s\" environment variable",
   "options.user.description": "User",
-  "options.user.demands": "The bridge username has to either be provided using the option --user or through the \"%s\" environment variable",
+  "options.user.demands": "The username has to either be provided using the option --user or through the \"%s\" environment variable",
   "options.password.description": "Password",
-  "options.password.demands": "The bridge user password has to either be provided using the option --password or through the \"%s\" environment variable",
+  "options.password.demands": "The user password has to either be provided using the option --password or through the \"%s\" environment variable",
   "options.pushOnly.description": "Try to upload an existing zip file without building and validating the version number",
   "options.noValidate.description": "Skip validation of wether newVersion is higher than the current version for releases",
   "options.docs.description": "Generates typedoc",
+  "options.license.description": "Path to a license file",
   "messages.buildSkipEmpty": "No build targets found. Please check wether a folder with the provided name exists and wether it has _Package.json.",
   "messages.releaseSkipEmpty": "No release targets found. Please check wether a folder with the provided name exists and wether it has _Package.json.",
   "messages.building": "Creating javascript files",

package/package.json

@@ -1,12 +1,16 @@
 {
   "name": "@intelligentgraphics/ig.gfx.packager",
-  "version": "2.1.2",
-  "description": "IG.GFX.Packager 2.1.2 (2.1.2.100)",
+  "version": "2.2.0",
+  "description": "IG.GFX.Packager 2.2.0 (2.2.0.100)",
+  "author": "Michael Beier <mb@intelligentgraphics.biz>",
   "main": "build/index.js",
   "private": false,
   "publishConfig": {
     "access": "public"
   },
+  "engines": {
+    "node": ">=14.0.0"
+  },
   "bin": {
     "packager": "./build/index.js"
   },
@@ -22,7 +26,6 @@
     "test": "jest",
     "_postinstall": "node scripts/postinstall.js"
   },
-  "author": "Michael Beier <mb@intelligentgraphics.biz>",
   "dependencies": {
     "ajv": "^8.6.2",
     "axios": "^0.21.1",
@@ -34,20 +37,19 @@
     "rimraf": "^3.0.2",
     "source-map-support": "^0.5.19",
     "terser": "^4.8.0",
-    "typedoc": "~0.22.15",
-    "typescript": "~4.6.3",
+    "typedoc": "~0.23.2",
+    "typescript": "~4.7.4",
     "update-notifier": "^5.1.0",
     "v8-compile-cache": "^2.1.1",
     "y18n": "^5.0.8",
     "yargs": "^17.0.1"
   },
   "devDependencies": {
-    "@babel/plugin-proposal-class-properties": "^7.14.5",
-    "@babel/plugin-proposal-object-rest-spread": "^7.14.7",
-    "@babel/preset-env": "^7.14.9",
+    "@babel/plugin-proposal-class-properties": "^7.18.6",
+    "@babel/plugin-proposal-object-rest-spread": "^7.18.9",
+    "@babel/preset-env": "^7.18.9",
     "@intelligentgraphics/ig.tools.core": "^1.5.1",
     "@intelligentgraphics/ig.utilities": "^1.6.6",
-    "@types/archiver": "^5.1.1",
     "@types/fs-extra": "^9.0.12",
     "@types/glob": "^7.1.4",
     "@types/node": "^16.4.11",
@@ -55,29 +57,9 @@
     "@types/update-notifier": "^5.1.0",
     "@types/yargs": "^17.0.2",
     "babel-loader": "^8.1.0",
-    "jest": "^28.1.1",
-    "ts-jest": "^28.0.5",
     "ts-loader": "^9.2.5",
     "ts-node": "^10.1.0",
     "webpack": "^5.64.4",
     "webpack-cli": "^4.7.2"
-  },
-  "jest": {
-    "transform": {
-      "\\.tsx?$": "ts-jest"
-    },
-    "testRegex": "(.*\\.(test))\\.(ts|tsx)$",
-    "moduleFileExtensions": [
-      "ts",
-      "tsx",
-      "js",
-      "json"
-    ],
-    "moduleNameMapper": {
-      "^~/(.*)": "<rootDir>/src/$1"
-    },
-    "testEnvironmentOptions": {
-      "url": "http://localhost/"
-    }
   }
 }

package/readme.md

@@ -2,14 +2,14 @@
 
 ## Requirements
 
-node.js (https://nodejs.org/en/download/) >= 10
+node.js (https://nodejs.org/en/download/) >= 14
 
 ## Installation
 
 1\. Install this package as a dev dependency
 
 ```sh
-npm i --save-dev @intelligentgraphics/ig.gfx.packager@latest
+npm install --save-dev @intelligentgraphics/ig.gfx.packager@latest
 ```
 
 2\. Add a build and a release command to the package.json
@@ -59,6 +59,10 @@ npm i --save-dev @intelligentgraphics/ig.gfx.packager@latest
 }
 ```
 
+## Update
+
+You can update the installed package by running `npm install --save-dev @intelligentgraphics/ig.gfx.packager@latest` again.
+
 ## Environment configuration
 
 This program requires the following environment variables to be set:
@@ -67,11 +71,17 @@ This program requires the following environment variables to be set:
 
 The service to which packages should be uploaded to.
 
-### IG_GFX_USER
+### Authentication
+
+To use the new license file based authentication, the path to the license file needs to be provided in the `IG_GFX_LICENSE` environment variable. You can download your license file from the creator login page.
+
+Alternatively the legacy username and password based authentication can be configured through the following environment variables:
+
+**IG_GFX_USER**
 
 The identifier of the user that will login at the IG_GFX_ASSET_SERVICE.
 
-### IG_GFX_PWD
+**IG_GFX_PWD**
 
 The password for the user.
 
@@ -206,8 +216,50 @@ Sets the javascript version the typescript files should be compiled to.
 
 Specifies the standard libraries that are available.
 
+### Typedoc
+
+The IG.GFX.Packager can automatically generate typedoc documentation for your typescript files.
+
+This behaviour can be enabled by passing a `--docs` option when executing `build` or `upload`.
+
+```sh
+npm run upload Basics -- --newVersion=1.0.0.1 --domain=IG --subdomain=Test --docs
+```
+
+The typedoc files will be generated in a docs/<PackageName> folder within the current directory.
+
+**Assets**
+
+The packager supports referencing assets from jsdoc comments which will be copied to the generated documentation.
+
+An asset can be referenced using the following syntax:
+
+```ts
+class Test {
+	/**
+	 * <img src="media://image.png" alt="a png image"/>
+	 */
+}
+```
+
+The path specified after the media:// schema will be resolved within a directory called `Media` next to the \_Package.json file.
+
 ## History
 
+**IG.GFX.Packager 2.2.0**
+
+-   add support for license files
+-   improve error message when encountering invalid syntax in an animation json file
+
+**IG.GFX.Packager 2.1.4**
+
+-   support referencing assets from jsdoc for typedoc generation
+-   update typescript and typedoc
+
+**IG.GFX.Packager 2.1.3**
+
+-   use package scope, if available, when adding animations
+
 **IG.GFX.Packager 2.1.2**
 
 -   improve handling of interactors with many dots in name