@intelligentgraphics/ig.gfx.packager 2.1.1 → 2.1.4

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/package.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "name": "@intelligentgraphics/ig.gfx.packager",
3
- "version": "2.1.1",
4
- "description": "IG.GFX.Packager 2.1.1 (2.1.1.100)",
3
+ "version": "2.1.4",
4
+ "description": "IG.GFX.Packager 2.1.4 (2.1.4.100)",
5
5
  "main": "build/index.js",
6
6
  "private": false,
7
7
  "publishConfig": {
@@ -19,22 +19,23 @@
19
19
  "dist": "webpack",
20
20
  "clean": "rimraf build *.tsbuildinfo",
21
21
  "prepublishOnly": "yarn clean && yarn dist",
22
+ "test": "jest",
22
23
  "_postinstall": "node scripts/postinstall.js"
23
24
  },
24
25
  "author": "Michael Beier <mb@intelligentgraphics.biz>",
25
26
  "dependencies": {
26
27
  "ajv": "^8.6.2",
27
- "archiver": "^5.0.0",
28
28
  "axios": "^0.21.1",
29
29
  "core-js": "^3.16.0",
30
30
  "execa": "^5.1.1",
31
31
  "fs-extra": "^10.0.0",
32
32
  "glob": "^7.1.4",
33
+ "jszip": "^3.10.0",
33
34
  "rimraf": "^3.0.2",
34
35
  "source-map-support": "^0.5.19",
35
36
  "terser": "^4.8.0",
36
- "typedoc": "~0.22.15",
37
- "typescript": "~4.6.3",
37
+ "typedoc": "~0.23.2",
38
+ "typescript": "~4.7.4",
38
39
  "update-notifier": "^5.1.0",
39
40
  "v8-compile-cache": "^2.1.1",
40
41
  "y18n": "^5.0.8",
@@ -54,9 +55,29 @@
54
55
  "@types/update-notifier": "^5.1.0",
55
56
  "@types/yargs": "^17.0.2",
56
57
  "babel-loader": "^8.1.0",
58
+ "jest": "^28.1.1",
59
+ "ts-jest": "^28.0.5",
57
60
  "ts-loader": "^9.2.5",
58
61
  "ts-node": "^10.1.0",
59
62
  "webpack": "^5.64.4",
60
63
  "webpack-cli": "^4.7.2"
64
+ },
65
+ "jest": {
66
+ "transform": {
67
+ "\\.tsx?$": "ts-jest"
68
+ },
69
+ "testRegex": "(.*\\.(test))\\.(ts|tsx)$",
70
+ "moduleFileExtensions": [
71
+ "ts",
72
+ "tsx",
73
+ "js",
74
+ "json"
75
+ ],
76
+ "moduleNameMapper": {
77
+ "^~/(.*)": "<rootDir>/src/$1"
78
+ },
79
+ "testEnvironmentOptions": {
80
+ "url": "http://localhost/"
81
+ }
61
82
  }
62
83
  }
package/readme.md CHANGED
@@ -206,8 +206,51 @@ Sets the javascript version the typescript files should be compiled to.
206
206
 
207
207
  Specifies the standard libraries that are available.
208
208
 
209
+ ### Typedoc
210
+
211
+ The IG.GFX.Packager can automatically generate typedoc documentation for your typescript files.
212
+
213
+ This behaviour can be enabled by passing a `--docs` option when executing `build` or `upload`.
214
+
215
+ ```sh
216
+ npm run upload Basics -- --newVersion=1.0.0.1 --domain=IG --subdomain=Test --docs
217
+ ```
218
+
219
+ The typedoc files will be generated in a docs/<PackageName> folder within the current directory.
220
+
221
+ **Assets**
222
+
223
+ The packager supports referencing assets from jsdoc comments which will be copied to the generated documentation.
224
+
225
+ An asset can be referenced using the following syntax:
226
+
227
+ ```ts
228
+ class Test {
229
+ /**
230
+ * <img src="media://image.png" alt="a png image"/>
231
+ */
232
+ }
233
+ ```
234
+
235
+ The path specified after the media:// schema will be resolved within a directory called `Media` next to the \_Package.json file.
236
+
209
237
  ## History
210
238
 
239
+ **IG.GFX.Packager 2.1.4**
240
+
241
+ - support referencing assets from jsdoc for typedoc generation
242
+ - update typescript and typedoc
243
+
244
+ **IG.GFX.Packager 2.1.3**
245
+
246
+ - use package scope, if available, when adding animations
247
+
248
+ **IG.GFX.Packager 2.1.2**
249
+
250
+ - improve handling of interactors with many dots in name
251
+ - throw an error when executing build for a package without typescript files
252
+ - migrate to jszip to resolve zip issues
253
+
211
254
  **IG.GFX.Packager 2.1.1**
212
255
 
213
256
  - fix update notifier