refactor: consume Commonlib as a package

src/apps/cli/services/NodeKeyValueDBService.ts

@@ -1,13 +1,13 @@
-import { LOG_LEVEL_NOTICE, LOG_LEVEL_VERBOSE } from "@lib/common/logger";
-import type { KeyValueDatabase } from "@lib/interfaces/KeyValueDatabase";
-import type { IKeyValueDBService } from "@lib/services/base/IService";
-import { ServiceBase, type ServiceContext } from "@lib/services/base/ServiceBase";
-import type { InjectableAppLifecycleService } from "@lib/services/implements/injectable/InjectableAppLifecycleService";
-import type { InjectableDatabaseEventService } from "@lib/services/implements/injectable/InjectableDatabaseEventService";
-import type { IVaultService } from "@lib/services/base/IService";
+import { LOG_LEVEL_NOTICE, LOG_LEVEL_VERBOSE } from "@vrtmrz/livesync-commonlib/compat/common/logger";
+import type { KeyValueDatabase } from "@vrtmrz/livesync-commonlib/compat/interfaces/KeyValueDatabase";
+import type { IKeyValueDBService } from "@vrtmrz/livesync-commonlib/compat/services/base/IService";
+import { ServiceBase, type ServiceContext } from "@vrtmrz/livesync-commonlib/compat/services/base/ServiceBase";
+import type { InjectableAppLifecycleService } from "@vrtmrz/livesync-commonlib/compat/services/implements/injectable/InjectableAppLifecycleService";
+import type { InjectableDatabaseEventService } from "@vrtmrz/livesync-commonlib/compat/services/implements/injectable/InjectableDatabaseEventService";
+import type { IVaultService } from "@vrtmrz/livesync-commonlib/compat/services/base/IService";
 import type { SimpleStore } from "octagonal-wheels/databases/SimpleStoreBase";
-import { createInstanceLogFunction } from "@lib/services/lib/logUtils";
-import { fs as nodeFs, path as nodePath } from "@/apps/cli/node-compat";
+import { createInstanceLogFunction } from "@vrtmrz/livesync-commonlib/compat/services/lib/logUtils";
+import { fs as nodeFs, path as nodePath } from "@vrtmrz/livesync-commonlib/node";
 
 const NODE_KV_TYPED_KEY = "__nodeKvType";
 const NODE_KV_VALUES_KEY = "values";

src/apps/cli/services/NodeLocalStorage.ts

@@ -1,5 +1,5 @@
-import { fs as nodeFs, path as nodePath } from "@/apps/cli/node-compat";
-import { compatGlobal } from "@lib/common/coreEnvFunctions";
+import { fs as nodeFs, path as nodePath } from "@vrtmrz/livesync-commonlib/node";
+import { compatGlobal } from "@vrtmrz/livesync-commonlib/compat/common/coreEnvFunctions";
 
 type LocalStorageShape = {
     getItem(key: string): string | null;

src/apps/cli/services/NodeLocalStorage.unit.spec.ts

@@ -1,6 +1,4 @@
-import * as fs from "node:fs";
-import * as os from "node:os";
-import * as path from "node:path";
+import { fs, os, path } from "@vrtmrz/livesync-commonlib/node";
 import { afterEach, describe, expect, it } from "vitest";
 import {
     clearNodeLocalStorage,

src/apps/cli/services/NodeServiceContext.ts

@@ -0,0 +1,10 @@
+import { eventHub } from "@/common/events";
+import { translateLiveSyncMessage } from "@/common/translation";
+import { ServiceContext } from "@vrtmrz/livesync-commonlib/context";
+
+/** Host capabilities owned by one Self-hosted LiveSync CLI composition. */
+export class NodeServiceContext extends ServiceContext {
+    constructor(readonly databasePath: string) {
+        super({ events: eventHub, translate: translateLiveSyncMessage });
+    }
+}

src/apps/cli/services/NodeServiceContext.unit.spec.ts

@@ -0,0 +1,33 @@
+import { describe, expect, it } from "vitest";
+
+import { eventHub } from "@/common/events";
+import { translateLiveSyncMessage } from "@/common/translation";
+import {
+    observeServiceComposition,
+    observeServiceContext,
+    SERVICE_CONTEXT_MEMBERS,
+} from "../../../../test/contracts/serviceContext";
+import { NodeServiceContext } from "./NodeServiceContext";
+import { NodeServiceHub } from "./NodeServiceHub";
+
+const TRANSLATION_KEY = "Replicator.Message.InitialiseFatalError";
+
+describe("NodeServiceContext contract", () => {
+    it("preserves the CLI capabilities and host-neutral API results", () => {
+        const context = new NodeServiceContext("/tmp/livesync-context-contract");
+
+        expect(observeServiceContext(context, TRANSLATION_KEY)).toEqual({
+            translation: translateLiveSyncMessage(TRANSLATION_KEY),
+            receivedEvents: ["context-contract-event"],
+        });
+        expect(context.events).toBe(eventHub);
+        expect(context.databasePath).toBe("/tmp/livesync-context-contract");
+
+        const hub = new NodeServiceHub(context.databasePath, context);
+        const composition = observeServiceComposition(hub, context);
+        expect(composition.hubUsesExpectedContext).toBe(true);
+        expect(SERVICE_CONTEXT_MEMBERS.filter((member) => !composition.servicesUsingExpectedContext[member])).toEqual(
+            []
+        );
+    });
+});

src/apps/cli/services/NodeServiceHub.ts

@@ -1,39 +1,36 @@
-import type { AppLifecycleService, AppLifecycleServiceDependencies } from "@lib/services/base/AppLifecycleService";
-import { ServiceContext } from "@lib/services/base/ServiceBase";
-import { ConfigServiceBrowserCompat } from "@lib/services/implements/browser/ConfigServiceBrowserCompat";
-import { SvelteDialogManagerBase, type ComponentHasResult } from "@lib/services/implements/base/SvelteDialog";
-import { UIService } from "@lib/services/implements/base/UIService";
-import { InjectableServiceHub } from "@lib/services/implements/injectable/InjectableServiceHub";
-import { InjectableAppLifecycleService } from "@lib/services/implements/injectable/InjectableAppLifecycleService";
-import { InjectableConflictService } from "@lib/services/implements/injectable/InjectableConflictService";
-import { InjectableDatabaseEventService } from "@lib/services/implements/injectable/InjectableDatabaseEventService";
-import { InjectableFileProcessingService } from "@lib/services/implements/injectable/InjectableFileProcessingService";
-import { PathServiceCompat } from "@lib/services/implements/injectable/InjectablePathService";
-import { InjectableRemoteService } from "@lib/services/implements/injectable/InjectableRemoteService";
-import { InjectableReplicationService } from "@lib/services/implements/injectable/InjectableReplicationService";
-import { InjectableReplicatorService } from "@lib/services/implements/injectable/InjectableReplicatorService";
-import { InjectableTestService } from "@lib/services/implements/injectable/InjectableTestService";
-import { InjectableTweakValueService } from "@lib/services/implements/injectable/InjectableTweakValueService";
-import { InjectableVaultServiceCompat } from "@lib/services/implements/injectable/InjectableVaultService";
-import { ControlService } from "@lib/services/base/ControlService";
-import type { IControlService } from "@lib/services/base/IService";
-import { HeadlessAPIService } from "@lib/services/implements/headless/HeadlessAPIService";
-// import { HeadlessDatabaseService } from "@lib/services/implements/headless/HeadlessDatabaseService";
-import type { ServiceInstances } from "@lib/services/ServiceHub";
+import type { AppLifecycleServiceDependencies } from "@vrtmrz/livesync-commonlib/compat/services/base/AppLifecycleService";
+import type { ServiceContext } from "@vrtmrz/livesync-commonlib/compat/services/base/ServiceBase";
+import { ConfigServiceBrowserCompat } from "@vrtmrz/livesync-commonlib/compat/services/implements/browser/ConfigServiceBrowserCompat";
+import type {
+    ComponentHasResult,
+    SvelteDialogManager,
+} from "@vrtmrz/livesync-commonlib/compat/services/implements/base/SvelteDialog";
+import { UIService } from "@vrtmrz/livesync-commonlib/compat/services/implements/base/UIService";
+import { InjectableServiceHub } from "@vrtmrz/livesync-commonlib/compat/services/implements/injectable/InjectableServiceHub";
+import { InjectableAppLifecycleService } from "@vrtmrz/livesync-commonlib/compat/services/implements/injectable/InjectableAppLifecycleService";
+import { InjectableConflictService } from "@vrtmrz/livesync-commonlib/compat/services/implements/injectable/InjectableConflictService";
+import { InjectableDatabaseEventService } from "@vrtmrz/livesync-commonlib/compat/services/implements/injectable/InjectableDatabaseEventService";
+import { InjectableFileProcessingService } from "@vrtmrz/livesync-commonlib/compat/services/implements/injectable/InjectableFileProcessingService";
+import { PathServiceCompat } from "@vrtmrz/livesync-commonlib/compat/services/implements/injectable/InjectablePathService";
+import { InjectableRemoteService } from "@vrtmrz/livesync-commonlib/compat/services/implements/injectable/InjectableRemoteService";
+import { InjectableReplicationService } from "@vrtmrz/livesync-commonlib/compat/services/implements/injectable/InjectableReplicationService";
+import { InjectableReplicatorService } from "@vrtmrz/livesync-commonlib/compat/services/implements/injectable/InjectableReplicatorService";
+import { InjectableTestService } from "@vrtmrz/livesync-commonlib/compat/services/implements/injectable/InjectableTestService";
+import { InjectableTweakValueService } from "@vrtmrz/livesync-commonlib/compat/services/implements/injectable/InjectableTweakValueService";
+import { InjectableVaultServiceCompat } from "@vrtmrz/livesync-commonlib/compat/services/implements/injectable/InjectableVaultService";
+import { ControlService } from "@vrtmrz/livesync-commonlib/compat/services/base/ControlService";
+import { HeadlessAPIService } from "@vrtmrz/livesync-commonlib/compat/services/implements/headless/HeadlessAPIService";
+import type { ServiceInstances } from "@vrtmrz/livesync-commonlib/compat/services/ServiceHub";
 import { NodeKeyValueDBService } from "./NodeKeyValueDBService";
 import { NodeSettingService } from "./NodeSettingService";
-import { DatabaseService } from "@lib/services/base/DatabaseService";
-import type { ObsidianLiveSyncSettings } from "@lib/common/types";
-import { path as nodePath } from "@/apps/cli/node-compat";
-import type { KeyValueDBService } from "@lib/services/base/KeyValueDBService";
+import { DatabaseService } from "@vrtmrz/livesync-commonlib/compat/services/base/DatabaseService";
+import type { ObsidianLiveSyncSettings } from "@vrtmrz/livesync-commonlib/compat/common/types";
+import { path as nodePath } from "@vrtmrz/livesync-commonlib/node";
+import type { KeyValueDBService } from "@vrtmrz/livesync-commonlib/compat/services/base/KeyValueDBService";
+import { PouchDB } from "@/apps/cli/lib/pouchdb-node";
+import { NodeServiceContext } from "./NodeServiceContext";
 
-export class NodeServiceContext extends ServiceContext {
-    databasePath: string;
-    constructor(databasePath: string) {
-        super();
-        this.databasePath = databasePath;
-    }
-}
+export { NodeServiceContext } from "./NodeServiceContext";
 
 class NodeAppLifecycleService<T extends ServiceContext> extends InjectableAppLifecycleService<T> {
     constructor(context: T, dependencies: AppLifecycleServiceDependencies) {
@@ -41,21 +38,24 @@ class NodeAppLifecycleService<T extends ServiceContext> extends InjectableAppLif
     }
 }
 
-class NodeSvelteDialogManager<T extends ServiceContext> extends SvelteDialogManagerBase<T> {
-    openSvelteDialog<TValue, UInitial>(
-        component: ComponentHasResult<TValue, UInitial>,
-        initialData?: UInitial
+class NodeDialogManager<T extends ServiceContext> implements SvelteDialogManager<T> {
+    open<TValue, UInitial>(
+        _component: ComponentHasResult<TValue, UInitial>,
+        _initialData?: UInitial
     ): Promise<TValue | undefined> {
-        throw new Error("Method not implemented.");
+        return Promise.reject(new Error("Interactive dialogues are not available in the CLI."));
+    }
+
+    openWithExplicitCancel<TValue, UInitial>(
+        _component: ComponentHasResult<TValue, UInitial>,
+        _initialData?: UInitial
+    ): Promise<TValue> {
+        return Promise.reject(new Error("Interactive dialogues are not available in the CLI."));
     }
 }
 
 type NodeUIServiceDependencies<T extends ServiceContext = ServiceContext> = {
-    appLifecycle: AppLifecycleService<T>;
-    config: ConfigServiceBrowserCompat<T>;
-    replicator: InjectableReplicatorService<T>;
     APIService: HeadlessAPIService<T>;
-    control: IControlService;
 };
 class NodeDatabaseService<T extends NodeServiceContext> extends DatabaseService<T> {
     protected override modifyDatabaseOptions(
@@ -77,17 +77,9 @@ class NodeUIService<T extends ServiceContext> extends UIService<T> {
     }
 
     constructor(context: T, dependencies: NodeUIServiceDependencies<T>) {
-        const headlessConfirm = dependencies.APIService.confirm;
-        const dialogManager = new NodeSvelteDialogManager<T>(context, {
-            confirm: headlessConfirm,
-            appLifecycle: dependencies.appLifecycle,
-            config: dependencies.config,
-            replicator: dependencies.replicator,
-            control: dependencies.control,
-        });
+        const dialogManager = new NodeDialogManager<T>();
 
         super(context, {
-            appLifecycle: dependencies.appLifecycle,
             dialogManager,
             APIService: dependencies.APIService,
         });
@@ -111,6 +103,7 @@ export class NodeServiceHub<T extends NodeServiceContext> extends InjectableServ
         });
 
         const remote = new InjectableRemoteService(context, {
+            pouchDB: PouchDB,
             APIService: API,
             appLifecycle,
             setting,
@@ -128,6 +121,7 @@ export class NodeServiceHub<T extends NodeServiceContext> extends InjectableServ
         });
 
         const database = new NodeDatabaseService<T>(context, {
+            pouchDB: PouchDB,
             API: API,
             path,
             vault,
@@ -174,11 +168,7 @@ export class NodeServiceHub<T extends NodeServiceContext> extends InjectableServ
         });
 
         const ui = new NodeUIService<T>(context, {
-            appLifecycle,
-            config,
-            replicator,
             APIService: API,
-            control,
         });
 
         const serviceInstancesToInit: Required<ServiceInstances<T>> = {

src/apps/cli/services/NodeSettingService.ts

@@ -1,10 +1,9 @@
-import { EVENT_SETTING_SAVED } from "@lib/events/coreEvents";
+import { EVENT_SETTING_SAVED } from "@vrtmrz/livesync-commonlib/compat/events/coreEvents";
 import { EVENT_REQUEST_RELOAD_SETTING_TAB } from "@/common/events";
-import { eventHub } from "@lib/hub/hub";
-import { handlers } from "@lib/services/lib/HandlerUtils";
-import type { ObsidianLiveSyncSettings } from "@lib/common/types";
-import type { ServiceContext } from "@lib/services/base/ServiceBase";
-import { SettingService, type SettingServiceDependencies } from "@lib/services/base/SettingService";
+import { handlers } from "@vrtmrz/livesync-commonlib/compat/services/lib/HandlerUtils";
+import type { ObsidianLiveSyncSettings } from "@vrtmrz/livesync-commonlib/compat/common/types";
+import type { ServiceContext } from "@vrtmrz/livesync-commonlib/compat/services/base/ServiceBase";
+import { SettingService, type SettingServiceDependencies } from "@vrtmrz/livesync-commonlib/compat/services/base/SettingService";
 import {
     configureNodeLocalStorage,
     deleteNodeLocalStorageItem,
@@ -17,11 +16,11 @@ export class NodeSettingService<T extends ServiceContext> extends SettingService
         super(context, dependencies);
         configureNodeLocalStorage(storagePath);
         this.onSettingSaved.addHandler((settings) => {
-            eventHub.emitEvent(EVENT_SETTING_SAVED, settings);
+            this.context.events.emitEvent(EVENT_SETTING_SAVED, settings);
             return Promise.resolve(true);
         });
         this.onSettingLoaded.addHandler((settings) => {
-            eventHub.emitEvent(EVENT_REQUEST_RELOAD_SETTING_TAB);
+            this.context.events.emitEvent(EVENT_REQUEST_RELOAD_SETTING_TAB);
             return Promise.resolve(true);
         });
     }