Release 0.5.2

quatico-solutions · Nov 17, 2023 · 6a435fa · 6a435fa
1 parent af50667
commit 6a435fa
Show file tree

Hide file tree

Showing 25 changed files with 2,402 additions and 2,257 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -0,0 +1,105 @@
+<!--
+ ---------------------------------------------------------------------------------------------
+   Copyright (c) Quatico Solutions AG. All rights reserved.
+   Licensed under the MIT License. See LICENSE in the project root for license information.
+ ---------------------------------------------------------------------------------------------
+-->
+<!-- markdownlint-disable MD024 -->
+
+# Releases
+
+Release notes follow the [keep a changelog](https://keepachangelog.com/en/1.1.0/) format.
+
+## [Unreleased]
+
+### Changed
+
+- Upgraded TypeScript dependency to `5.0.x`
+- Upgraded `@quatico/websmith-*` dependencies to `0.4.0`
+
+### Removed
+
+- Removed `packages/java` focusing the project on nodejs.
+- Removed unused code and dependencies.
+
+## [0.3.0]
+
+### Added
+
+- Support for `merge: true` in `@quatico/magellan-client/transport/config.js` to merge the configuration with the
+  existing configuration of a previous magellan-client frontend instead of replacing it.
+
+### Changed 
+
+- Updates @quatico/magellan-client documentation to current transport configuration.
+
+## [0.2.2] - 2023-02-26
+
+### Changed
+
+- Exposing additional server api aspects to enable custom express server usage with Magellan
+- Remove maven-frontend-plugin dependency from Serialization maven package.
+
+## [0.2.1] - 2023-02-07
+
+### Added 
+
+- Serialization and deserialization errors during transport-request handling reject the promise.
+
+### Fixed 
+
+- Removes unnecessary dependency to maven-flatten-plugin in serialization package.
+
+## [0.2.1] - 2023-02-07
+
+### Added
+
+- Support --transpileOnly command line flag for `magellan compile`
+
+### Changed 
+
+- Update to websmith v0.3.5 addressing the undesirable error output.
+- Separate lint and lint:fix: pre-commit hooks now fix linting; CI only validates that the linting rules are followed.
+
+## [0.2.0] - 2022-12-14
+
+### Added 
+
+- service functions throwing errors now yield a rejection of the client promise with the error message.
+- service functions throwing errors now yield a console.error with the error stack on the client if the server is not in
+  production mode.
+
+### Changed
+
+- magellan-server has tslib as production dependency to ease integration in custom servers.
+
+## [0.1.4] - 2022-11-08
+
+SPA Routing
+
+### Added 
+
+- Wildcard paths not pointing to static files now redirect to the static root path.
+
+## [0.1.3] - 2022-08-04
+
+Additional supported serializations
+
+### Added 
+
+- Implements date transport support for LocalDate and LocalDateTime.
+
+### Fixed
+
+- Implements logic to handle incomplete replacement transport configurations.
+
+## [0.1.0] - 2022-07-29
+
+Initial Release
+
+### Added
+
+- (Almost) invisible transport layer between browser and JVM
+- Effortless configuration of service endpoints
+- Automatic serialization of input/output values
+- Transparent error messages and exception handling
diff --git a/docs/Contribution.md b/docs/Contribution.md
@@ -1,3 +1,9 @@
+<!--
+ ---------------------------------------------------------------------------------------------
+   Copyright (c) Quatico Solutions AG. All rights reserved.
+   Licensed under the MIT License. See LICENSE in the project root for license information.
+ ---------------------------------------------------------------------------------------------
+-->
 # Contributing to Magellan
 
 There are three great ways to contribute to the Magellan project: logging bugs, submitting pull requests, and creating suggestions.

diff --git a/docs/technical/server-to-client-communication.md b/docs/technical/server-to-client-communication.md
@@ -1,3 +1,9 @@
+<!--
+ ---------------------------------------------------------------------------------------------
+   Copyright (c) Quatico Solutions AG. All rights reserved.
+   Licensed under the MIT License. See LICENSE in the project root for license information.
+ ---------------------------------------------------------------------------------------------
+-->
 # Response and error propagation of service functions from server to client
 
 magellan supports automatic error propagation from the server executed version of a @service annoted function to the client.

diff --git a/lerna.json b/lerna.json
@@ -1,5 +1,5 @@
 {
-    "npmClient": "yarn",
-    "useWorkspaces": true,
-    "version": "0.3.0"
+  "npmClient": "yarn",
+  "useWorkspaces": true,
+  "version": "0.5.2"
 }
diff --git a/license-config.json b/license-config.json
@@ -45,4 +45,4 @@
         "**/test-data",
         "**/__data__"
     ]
-}
+}
diff --git a/nx.json b/nx.json
@@ -1,28 +1,48 @@
 {
-    "tasksRunnerOptions": {
-        "default": {
-            "runner": "nx/tasks-runners/default",
-            "options": {
-                "cacheableOperations": ["lint", "test", "build", "test:e2e"],
-                "cacheDirectory": ".nx-cache"
-            }
-        }
-    },
-    "targetDefaults": {
-        "build": {
-            "dependsOn": ["^build"],
-            "outputs": ["{projectRoot}/lib"]
-        },
-        "dist": {
-            "dependsOn": [
-                "^dist"
-            ]
-        },
-        "publish-npm": {
-            "dependsOn": [
-                "^publish-npm"
-            ]
-        }
-    },
-    "defaultBase": "develop"
+	"tasksRunnerOptions": {
+		"default": {
+			"runner": "nx/tasks-runners/default",
+			"options": {
+				"cacheableOperations": [
+					"lint",
+					"test",
+					"build",
+					"test:e2e"
+				],
+				"cacheDirectory": ".nx-cache"
+			}
+		}
+	},
+	"targetDefaults": {
+		"build": {
+			"dependsOn": [
+				"^build"
+			],
+			"outputs": [
+				"{projectRoot}/lib"
+			]
+		},
+		"dist": {
+			"dependsOn": [
+				"^dist"
+			]
+		},
+		"publish-npm": {
+			"dependsOn": [
+				"^publish-npm"
+			]
+		}
+	},
+	"defaultBase": "develop",
+	"$schema": "./node_modules/nx/schemas/nx-schema.json",
+	"namedInputs": {
+		"default": [
+			"{projectRoot}/**/*",
+			"sharedGlobals"
+		],
+		"sharedGlobals": [],
+		"production": [
+			"default"
+		]
+	}
 }
diff --git a/package.json b/package.json
@@ -1,82 +1,79 @@
 {
-    "name": "@quatico/magellan",
-    "description": "",
-    "version": "0.3.0",
-    "keywords": [
-        "typescript",
-        "java",
-        "compiler",
-        "addons"
-    ],
-    "private": true,
-    "author": "Quatico Solutions AG",
-    "license": "MIT",
-    "files": [
-        "LICENSE",
-        "README.md"
-    ],
-    "repository": {
-        "type": "git",
-        "url": "git+https://github.com/quatico-solutions/magellan.git"
-    },
-    "bugs": {
-        "url": "https://github.com/quatico-solutions/magellan/issues"
-    },
-    "homepage": "https://github.com/quatico-solutions/magellan#readme",
-    "workspaces": {
-        "packages": [
-            "packages/*"
-        ]
-    },
-    "scripts": {
-        "clean": "nx run-many --target=clean",
-        "lint": "nx run-many --target=lint",
-        "lint:fix": "nx run-many --target=lint",
-        "build": "nx run-many --target=build",
-        "watch": "nx run-many --target=watch --parallel=10",
-        "test": "nx run-many --target=test",
-        "test:ci": "yarn jest --verbose && yarn --cwd packages/java test",
-        "test:watch": "nx run-many --target=test:watch --parallel=10",
-        "test:update": "nx run-many --target=test:update",
-        "test:e2e": "nx run-many --target=test:e2e",
-        "dist": "nx run-many --target=dist --skip-nx-cache",
-        "prepare-release": "yarn dist && yarn lerna version --force-publish",
-        "prepare-prerelease": "yarn dist && yarn lerna version prerelease -y --force-publish",
-        "publish-npm": "lerna run --stream publish-npm",
-        "license:check": "license-check-and-add check -f license-config.json",
-        "license:add": "license-check-and-add add -f license-config.json",
-        "license:remove": "license-check-and-add remove -f license-config.json",
-        "prepare": "husky install"
-    },
-    "devDependencies": {
-        "@nrwl/nx-cloud": "latest",
-        "@swc/core": "^1.3.57",
-        "@swc/jest": "^0.2.26",
-        "@types/node": "16",
-        "cross-env": "^7.0.3",
-        "eslint": "^8.40.0",
-        "eslint-config-prettier": "^8.8.0",
-        "eslint-import-resolver-alias": "^1.1.2",
-        "eslint-plugin-import": "^2.27.5",
-        "eslint-plugin-jest": "^27.2.1",
-        "eslint-plugin-prettier": "^4.2.1",
-        "eslint-plugin-testing-library": "^5.11.0",
-        "husky": "^8.0.3",
-        "jest": "^29.5.0",
-        "lerna": "^6.6.2",
-        "license-check-and-add": "^4.0.5",
-        "lint-staged": "^13.2.2",
-        "memfs": "3.5.x",
-        "nx": "16.1.x",
-        "prettier": "^2.8.8",
-        "regenerator-runtime": "0.13.11",
-        "rimraf": "5.0.0",
-        "ts-jest": "^29.1.0",
-        "ts-node": "10.9.x",
-        "typescript": "5.0.x"
-    },
-    "engines": {
-        "node": "16 || 18",
-        "yarn": "1.22.x"
-    }
+  "name": "@quatico/magellan",
+  "description": "",
+  "version": "0.5.2",
+  "keywords": [
+    "typescript",
+    "java",
+    "compiler",
+    "addons"
+  ],
+  "private": true,
+  "author": "Quatico Solutions AG",
+  "license": "MIT",
+  "files": [
+    "LICENSE",
+    "README.md"
+  ],
+  "repository": {
+    "type": "git",
+    "url": "git+https://apps.quatico.com/repo/scm/quamag/qs-magellan.git"
+  },
+  "bugs": {
+    "url": "https://apps.quatico.com/jira/secure/RapidBoard.jspa?rapidView=423&projectKey=QUAMAG"
+  },
+  "workspaces": {
+    "packages": [
+      "packages/*"
+    ]
+  },
+  "scripts": {
+    "clean": "nx run-many --target=clean",
+    "lint": "nx run-many --target=lint",
+    "lint:fix": "nx run-many --target=lint",
+    "build": "nx run-many --target=build",
+    "watch": "nx run-many --target=watch --parallel=10",
+    "test": "nx run-many --target=test",
+    "test:ci": "yarn jest --verbose && yarn --cwd packages/java test",
+    "test:watch": "nx run-many --target=test:watch --parallel=10",
+    "test:update": "nx run-many --target=test:update",
+    "test:e2e": "nx run-many --target=test:e2e",
+    "dist": "nx run-many --target=dist --skip-nx-cache",
+    "prepare-release": "yarn dist && yarn lerna version --force-publish",
+    "prepare-prerelease": "yarn dist && yarn lerna version prerelease -y --force-publish",
+    "publish-npm": "nx run-many --target=publish-npm",
+    "license:check": "license-check-and-add check -f license-config.json",
+    "license:add": "license-check-and-add add -f license-config.json",
+    "license:remove": "license-check-and-add remove -f license-config.json"
+  },
+  "devDependencies": {
+    "@swc/core": "^1.3.57",
+    "@swc/jest": "^0.2.26",
+    "@types/node": "16",
+    "cross-env": "^7.0.3",
+    "eslint": "^8.40.0",
+    "eslint-config-prettier": "^8.8.0",
+    "eslint-import-resolver-alias": "^1.1.2",
+    "eslint-plugin-import": "^2.27.5",
+    "eslint-plugin-jest": "^27.2.1",
+    "eslint-plugin-prettier": "^4.2.1",
+    "eslint-plugin-testing-library": "^5.11.0",
+    "jest": "^29.5.0",
+    "lerna": "6.6.x",
+    "license-check-and-add": "^4.0.5",
+    "lint-staged": "^13.2.2",
+    "memfs": "3.5.x",
+    "nx": "16.5.0",
+    "nx-cloud": "16.0.5",
+    "prettier": "^2.8.8",
+    "regenerator-runtime": "0.13.11",
+    "rimraf": "5.0.0",
+    "ts-jest": "^29.1.0",
+    "ts-node": "10.9.x",
+    "typescript": "5.0.x"
+  },
+  "engines": {
+    "node": "16 || 18",
+    "yarn": "1.22.x"
+  }
 }