Move core types to extra package (#254)

* feat: introduce new packages

* refactor: update sources

* refactor: update tests

* chore: update content dependencies

* refactor: also move CoreError to @nmshd/core-types

* fix: add references to core-types and utils to transport

* refactor: undo utils extraction

* chore: undo some stuff

* refactor: update references and dependencies

* chore: formatting

* ci: add test for new package

* fix: test issues

* fix: test issues

* refactor: move CoreId generation to CoreIdHelper

* fix: compiler errors

* chore: do not use CoreSerializable anymore

---------

Co-authored-by: mergify[bot] <37929162+mergify[bot]@users.noreply.github.com>

.github/workflows/test.yml

@@ -121,6 +121,25 @@ jobs:
           fail_ci_if_error: true
           CODECOV_TOKEN: ${{ secrets.CODECOV_TOKEN }}
 
+  test-core-types:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-node@v4
+        with:
+          node-version: current
+      - run: npm ci
+        env:
+          BUILD_NUMBER: ${{ github.run_number }}
+          COMMIT_HASH: ${{ github.sha }}
+      - run: npm run build:node
+      - run: npm run test:ci --workspace=@nmshd/core-types
+      - name: Upload coverage reports to Codecov with GitHub Action
+        uses: codecov/codecov-action@v4
+        env:
+          fail_ci_if_error: true
+          CODECOV_TOKEN: ${{ secrets.CODECOV_TOKEN }}
+
   test-runtime-mongodb:
     runs-on: ubuntu-latest
     steps:

package.json

@@ -6,6 +6,7 @@
     "license": "MIT",
     "author": "j&s-soft GmbH",
     "workspaces": [
+        "packages/core-types",
         "packages/transport",
         "packages/content",
         "packages/consumption",

packages/app-runtime/package.json

@@ -25,17 +25,17 @@
         "test:ci": "jest -i --forceExit --coverage"
     },
     "jest": {
-        "maxWorkers": 5,
-        "preset": "ts-jest",
+        "collectCoverageFrom": [
+            "./src/**"
+        ],
         "coverageProvider": "v8",
         "coverageReporters": [
             "text-summary",
             "cobertura",
             "lcov"
         ],
-        "collectCoverageFrom": [
-            "./src/**"
-        ],
+        "maxWorkers": 5,
+        "preset": "ts-jest",
         "setupFilesAfterEnv": [
             "jest-expect-message"
         ],
@@ -52,6 +52,7 @@
     },
     "dependencies": {
         "@js-soft/docdb-access-loki": "^1.1.0",
+        "@nmshd/runtime": "*",
         "lodash": "^4.17.21"
     },
     "devDependencies": {
@@ -60,9 +61,6 @@
         "@types/lokijs": "^1.5.14",
         "@types/luxon": "^3.4.2"
     },
-    "peerDependencies": {
-        "@nmshd/runtime": "*"
-    },
     "publishConfig": {
         "access": "public",
         "provenance": true

packages/app-runtime/src/AppRuntime.ts

@@ -2,8 +2,9 @@ import { IDatabaseConnection } from "@js-soft/docdb-access-abstractions";
 import { LokiJsConnection } from "@js-soft/docdb-access-loki";
 import { Result } from "@js-soft/ts-utils";
 import { ConsumptionController } from "@nmshd/consumption";
+import { CoreId, ICoreAddress } from "@nmshd/core-types";
 import { ModuleConfiguration, Runtime, RuntimeHealth } from "@nmshd/runtime";
-import { AccountController, CoreId, ICoreAddress } from "@nmshd/transport";
+import { AccountController } from "@nmshd/transport";
 import { AppConfig, AppConfigOverwrite, createAppConfig } from "./AppConfig";
 import { AppRuntimeErrors } from "./AppRuntimeErrors";
 import { AppRuntimeServices } from "./AppRuntimeServices";

packages/app-runtime/src/AppStringProcessor.ts

@@ -1,8 +1,9 @@
 import { ILogger, ILoggerFactory } from "@js-soft/logging-abstractions";
 import { Serializable } from "@js-soft/ts-serval";
 import { EventBus, Result } from "@js-soft/ts-utils";
+import { ICoreAddress } from "@nmshd/core-types";
 import { AnonymousServices, Base64ForIdPrefix, DeviceMapper } from "@nmshd/runtime";
-import { ICoreAddress, TokenContentDeviceSharedSecret } from "@nmshd/transport";
+import { TokenContentDeviceSharedSecret } from "@nmshd/transport";
 import { AppRuntimeErrors } from "./AppRuntimeErrors";
 import { AppRuntimeServices } from "./AppRuntimeServices";
 import { IUIBridge } from "./extensibility";

packages/app-runtime/src/multiAccount/AccountServices.ts

@@ -1,5 +1,5 @@
+import { CoreId } from "@nmshd/core-types";
 import { DeviceMapper, DeviceOnboardingInfoDTO } from "@nmshd/runtime";
-import { CoreId } from "@nmshd/transport";
 import { MultiAccountController } from "./MultiAccountController";
 import { LocalAccountDTO } from "./data/LocalAccountDTO";
 import { LocalAccountMapper } from "./data/LocalAccountMapper";

packages/app-runtime/src/multiAccount/MultiAccountController.ts

@@ -1,17 +1,8 @@
 import { IDatabaseCollection, IDatabaseCollectionProvider } from "@js-soft/docdb-access-abstractions";
 import { LokiJsConnection } from "@js-soft/docdb-access-loki";
 import { ILogger } from "@js-soft/logging-abstractions";
-import {
-    AccountController,
-    CoreAddress,
-    CoreDate,
-    CoreError,
-    CoreId,
-    DeviceSharedSecret,
-    Transport,
-    CoreErrors as TransportCoreErrors,
-    TransportLoggerFactory
-} from "@nmshd/transport";
+import { CoreAddress, CoreDate, CoreError, CoreId } from "@nmshd/core-types";
+import { AccountController, CoreIdHelper, DeviceSharedSecret, Transport, TransportCoreErrors, TransportLoggerFactory } from "@nmshd/transport";
 import { AppConfig } from "../AppConfig";
 import { SessionStorage } from "../SessionStorage";
 import { LocalAccount } from "./data/LocalAccount";
@@ -155,7 +146,7 @@ export class MultiAccountController {
 
         this._log.trace(`Onboarding device ${deviceSharedSecret.id} for identity ${deviceSharedSecret.identity.address}...`);
 
-        const id = await CoreId.generate();
+        const id = await CoreIdHelper.notPrefixed.generate();
 
         const localAccount = LocalAccount.from({
             id,
@@ -184,7 +175,7 @@ export class MultiAccountController {
     }
 
     public async createAccount(name: string): Promise<[LocalAccount, AccountController]> {
-        const id = await CoreId.generate();
+        const id = await CoreIdHelper.notPrefixed.generate();
 
         let localAccount = LocalAccount.from({
             id,

packages/app-runtime/src/multiAccount/data/LocalAccount.ts

@@ -1,7 +1,7 @@
-import { serialize, type, validate } from "@js-soft/ts-serval";
-import { CoreAddress, CoreDate, CoreId, CoreSerializable, ICoreDate, ICoreSerializable } from "@nmshd/transport";
+import { ISerializable, Serializable, serialize, type, validate } from "@js-soft/ts-serval";
+import { CoreAddress, CoreDate, CoreId, ICoreDate } from "@nmshd/core-types";
 
-export interface ILocalAccount extends ICoreSerializable {
+export interface ILocalAccount extends ISerializable {
     id: CoreId;
     address?: CoreAddress;
     name: string;
@@ -12,7 +12,7 @@ export interface ILocalAccount extends ICoreSerializable {
 }
 
 @type("LocalAccount")
-export class LocalAccount extends CoreSerializable implements ILocalAccount {
+export class LocalAccount extends Serializable implements ILocalAccount {
     @validate()
     @serialize()
     public id: CoreId;