refactor: consume Commonlib as a package

src/common/KeyValueDB.ts

@@ -1,5 +1,5 @@
 import { deleteDB, type IDBPDatabase, openDB } from "idb";
-import type { KeyValueDatabase } from "@lib/interfaces/KeyValueDatabase.ts";
+import type { KeyValueDatabase } from "@vrtmrz/livesync-commonlib/compat/interfaces/KeyValueDatabase";
 import { serialized } from "octagonal-wheels/concurrency/lock";
 import { Logger } from "octagonal-wheels/common/logger";
 const databaseCache: { [key: string]: IDBPDatabase<unknown> } = {};

src/common/KeyValueDBv2.ts

@@ -1,5 +1,5 @@
-import { LOG_LEVEL_VERBOSE, Logger } from "@lib/common/logger";
-import type { KeyValueDatabase } from "@lib/interfaces/KeyValueDatabase";
+import { LOG_LEVEL_VERBOSE, Logger } from "@vrtmrz/livesync-commonlib/compat/common/logger";
+import type { KeyValueDatabase } from "@vrtmrz/livesync-commonlib/compat/interfaces/KeyValueDatabase";
 import { deleteDB, openDB, type IDBPDatabase } from "idb";
 import { serialized } from "octagonal-wheels/concurrency/lock";
 

src/common/PeriodicProcessor.ts

@@ -1,7 +1,7 @@
 import { Logger } from "octagonal-wheels/common/logger";
 import { fireAndForget } from "octagonal-wheels/promises";
 import { eventHub, EVENT_PLUGIN_UNLOADED } from "./events";
-import type { NecessaryServices } from "@lib/interfaces/ServiceModule";
+import type { NecessaryServices } from "@vrtmrz/livesync-commonlib/compat/interfaces/ServiceModule";
 type PeriodicProcessorHost = NecessaryServices<"API" | "control", never>;
 export class PeriodicProcessor {
     _process: () => Promise<unknown>;

src/common/events.ts

@@ -1,4 +1,4 @@
-import { eventHub } from "@lib/hub/hub";
+import { createLiveSyncEventHub } from "@vrtmrz/livesync-commonlib/compat/hub/hub";
 // import type ObsidianLiveSyncPlugin from "../main";
 
 export const EVENT_PLUGIN_LOADED = "plugin-loaded";
@@ -43,5 +43,12 @@ declare global {
     }
 }
 
-export * from "@lib/events/coreEvents.ts";
-export { eventHub };
+export * from "@vrtmrz/livesync-commonlib/compat/events/coreEvents";
+
+/**
+ * Self-hosted LiveSync's host event channel.
+ *
+ * Commonlib does not own a process-global channel. Each LiveSync host context is
+ * composed with this channel while legacy host UI modules migrate to context.events.
+ */
+export const eventHub = createLiveSyncEventHub();

src/common/obsidianEvents.ts

@@ -1,5 +1,5 @@
 import type { TFile } from "@/deps";
-import type { FilePathWithPrefix, LoadedEntry } from "@lib/common/types";
+import type { FilePathWithPrefix, LoadedEntry } from "@vrtmrz/livesync-commonlib/compat/common/types";
 
 export const EVENT_REQUEST_SHOW_HISTORY = "show-history";
 

src/common/reportTool.ts

@@ -1,13 +1,13 @@
-import { REMOTE_COUCHDB, REMOTE_MINIO } from "@lib/common/models/setting.const";
-import type { ObsidianLiveSyncSettings } from "@lib/common/models/setting.type";
-import { generateCredentialObject } from "@lib/replication/httplib";
-import { parseHeaderValues } from "@lib/common/utils";
+import { REMOTE_COUCHDB, REMOTE_MINIO } from "@vrtmrz/livesync-commonlib/compat/common/models/setting.const";
+import type { ObsidianLiveSyncSettings } from "@vrtmrz/livesync-commonlib/compat/common/models/setting.type";
+import { generateCredentialObject } from "@vrtmrz/livesync-commonlib/compat/replication/httplib";
+import { parseHeaderValues } from "@vrtmrz/livesync-commonlib/compat/common/utils";
 import { requestToCouchDBWithCredentials } from "./utils";
-import { LOG_LEVEL_VERBOSE, Logger } from "@lib/common/logger";
-import { DEFAULT_SETTINGS } from "@lib/common/models/setting.const.defaults";
-import { isCloudantURI } from "@lib/pouchdb/utils_couchdb";
-import { compatGlobal } from "@lib/common/coreEnvFunctions";
-import { manifestVersion, packageVersion } from "@lib/common/coreEnvVars";
+import { LOG_LEVEL_VERBOSE, Logger } from "@vrtmrz/livesync-commonlib/compat/common/logger";
+import { DEFAULT_SETTINGS } from "@vrtmrz/livesync-commonlib/compat/common/models/setting.const.defaults";
+import { isCloudantURI } from "@vrtmrz/livesync-commonlib/compat/pouchdb/utils_couchdb";
+import { compatGlobal } from "@vrtmrz/livesync-commonlib/compat/common/coreEnvFunctions";
+import { manifestVersion, packageVersion } from "@vrtmrz/livesync-commonlib/compat/common/coreEnvVars";
 import type { LiveSyncBaseCore } from "@/LiveSyncBaseCore";
 function redactObject(obj: Record<string, unknown>, dotted: string, redactedValue = "REDACTED") {
     const keys = dotted.split(".");

src/common/translation.ts

@@ -0,0 +1,6 @@
+import { $msg } from "@vrtmrz/livesync-commonlib/compat/common/i18n";
+import type { MessageTranslator } from "@vrtmrz/livesync-commonlib/context";
+
+/** Supplies the LiveSync language catalogue through the Commonlib host boundary. */
+export const translateLiveSyncMessage: MessageTranslator = (key, params) =>
+    $msg(key as Parameters<typeof $msg>[0], params === undefined ? undefined : { ...params });

src/common/types.ts

@@ -1,6 +1,6 @@
 import { type PluginManifest, TFile } from "@/deps.ts";
-import { type DatabaseEntry, type EntryBody, type FilePath } from "@lib/common/types.ts";
-export type { CacheData, FileEventItem } from "@lib/common/types.ts";
+import { type DatabaseEntry, type EntryBody, type FilePath } from "@vrtmrz/livesync-commonlib/compat/common/types";
+export type { CacheData, FileEventItem } from "@vrtmrz/livesync-commonlib/compat/common/types";
 
 export interface PluginDataEntry extends DatabaseEntry {
     deviceVaultName: string;
@@ -51,7 +51,7 @@ export type queueItem = {
 
 export const FileWatchEventQueueMax = 10;
 
-export { configURIBase, configURIBaseQR } from "@lib/common/types.ts";
+export { configURIBase, configURIBaseQR } from "@vrtmrz/livesync-commonlib/compat/common/types";
 
 export {
     CHeader,
@@ -61,4 +61,4 @@ export {
     ICHeaderEnd,
     ICHeaderLength,
     ICXHeader,
-} from "@lib/common/models/fileaccess.const.ts";
+} from "@vrtmrz/livesync-commonlib/compat/common/models/fileaccess.const";

src/common/utils.ts

@@ -7,9 +7,9 @@ import {
     isValidFilenameInWidows,
     isValidFilenameInAndroid,
     stripAllPrefixes,
-} from "@lib/string_and_binary/path.ts";
+} from "@vrtmrz/livesync-commonlib/compat/string_and_binary/path";
 
-import { Logger } from "@lib/common/logger.ts";
+import { Logger } from "@vrtmrz/livesync-commonlib/compat/common/logger";
 import {
     LOG_LEVEL_INFO,
     LOG_LEVEL_NOTICE,
@@ -22,14 +22,14 @@ import {
     type FilePathWithPrefix,
     type UXFileInfo,
     type UXFileInfoStub,
-} from "@lib/common/types.ts";
+} from "@vrtmrz/livesync-commonlib/compat/common/types";
 export { ICHeader, ICXHeader } from "./types.ts";
-import { writeString } from "@lib/string_and_binary/convert.ts";
+import { writeString } from "@vrtmrz/livesync-commonlib/compat/string_and_binary/convert";
 import { sameChangePairs } from "./stores.ts";
 
 import { scheduleTask } from "octagonal-wheels/concurrency/task";
-import { AuthorizationHeaderGenerator } from "@lib/replication/httplib.ts";
-import type { KeyValueDatabase } from "@lib/interfaces/KeyValueDatabase.ts";
+import { AuthorizationHeaderGenerator } from "@vrtmrz/livesync-commonlib/compat/replication/httplib";
+import type { KeyValueDatabase } from "@vrtmrz/livesync-commonlib/compat/interfaces/KeyValueDatabase";
 
 export { scheduleTask, cancelTask, cancelAllTasks } from "octagonal-wheels/concurrency/task";
 
@@ -69,7 +69,7 @@ import {
     getPathFromUXFileInfo,
     getStoragePathFromUXFileInfo,
     getDatabasePathFromUXFileInfo,
-} from "@lib/common/typeUtils.ts";
+} from "@vrtmrz/livesync-commonlib/compat/common/typeUtils";
 export { isInternalFile, getPathFromUXFileInfo, getStoragePathFromUXFileInfo, getDatabasePathFromUXFileInfo };
 
 const memos: { [key: string]: unknown } = {};
@@ -121,7 +121,7 @@ export {
     isCustomisationSyncMetadata,
     isPluginMetadata,
     stripInternalMetadataPrefix,
-} from "@lib/common/typeUtils.ts";
+} from "@vrtmrz/livesync-commonlib/compat/common/typeUtils";
 
 export const _requestToCouchDBFetch = async (
     baseUri: string,
@@ -210,11 +210,11 @@ export function requestToCouchDBWithCredentials(
     return _requestToCouchDB(baseUri, credentials, origin, uri, body, method, customHeaders);
 }
 
-import { BASE_IS_NEW, EVEN, TARGET_IS_NEW } from "@lib/common/models/shared.const.symbols.ts";
+import { BASE_IS_NEW, EVEN, TARGET_IS_NEW } from "@vrtmrz/livesync-commonlib/compat/common/models/shared.const.symbols";
 export { BASE_IS_NEW, EVEN, TARGET_IS_NEW };
 // Why 2000? : ZIP FILE Does not have enough resolution.
-import { compareMTime } from "@lib/common/utils.ts";
-import { _fetch, compatGlobal } from "@lib/common/coreEnvFunctions.ts";
+import { compareMTime } from "@vrtmrz/livesync-commonlib/compat/common/utils";
+import { _fetch, compatGlobal } from "@vrtmrz/livesync-commonlib/compat/common/coreEnvFunctions";
 export { compareMTime };
 function getKey(file: AnyEntry | string | UXFileInfoStub) {
     const key = typeof file == "string" ? file : stripAllPrefixes(file.path);
@@ -236,7 +236,10 @@ export function unmarkChanges(file: AnyEntry | string | UXFileInfoStub) {
     const key = getKey(file);
     sameChangePairs.delete(key);
 }
-export function isMarkedAsSameChanges(file: UXFileInfoStub | AnyEntry | string, mtimes: number[]) {
+export function isMarkedAsSameChanges(
+    file: UXFileInfoStub | AnyEntry | string,
+    mtimes: number[]
+): undefined | typeof EVEN {
     const key = getKey(file);
     const pairs = sameChangePairs.get(key, []) || [];
     if (mtimes.every((e) => pairs.indexOf(e) !== -1)) {
@@ -398,4 +401,4 @@ export function onlyInNTimes(n: number, proc: (progress: number) => unknown) {
     };
 }
 
-export { displayRev } from "@lib/common/utils.ts";
+export { displayRev } from "@vrtmrz/livesync-commonlib/compat/common/utils";