public/obsidian-livesync
1
0
Fork 0
mirror of https://github.com/vrtmrz/obsidian-livesync.git synced 2026-07-18 18:46:02 +00:00
Code Issues Packages Projects Releases Wiki Activity

refactor: align platform APIs with community review

Browse Source
This commit is contained in:
vorotamoroz
2026-07-17 14:47:27 +00:00
parent 298738fc67
commit 326bf77183
39 changed files with 444 additions and 294 deletions
Download Patch File Download Diff File Expand all files Collapse all files
.github/workflows/unit-ci.yml
+7
View File
@@ -17,6 +17,8 @@ on:
- 'vitest.config*.ts'
- 'esbuild.config.mjs'
- 'eslint.config.mjs'
- 'eslint.config.common.mjs'
- 'eslint.community.config.mjs'
- 'update-workspaces.mjs'
- 'version-bump.mjs'
- 'utils/release-*.mjs'
@@ -36,6 +38,8 @@ on:
- 'vitest.config*.ts'
- 'esbuild.config.mjs'
- 'eslint.config.mjs'
- 'eslint.config.common.mjs'
- 'eslint.community.config.mjs'
- 'update-workspaces.mjs'
- 'version-bump.mjs'
- 'utils/release-*.mjs'
@@ -66,6 +70,9 @@ jobs:
- name: Install dependencies
run: npm ci
- name: Run source checks
run: npm run check
- name: Run unit tests suite with coverage
run: npm run test:unit:coverage
CONTRIBUTING.md
+1
View File
@@ -33,6 +33,7 @@ Before submitting a pull request, you must run verification scripts locally to e
```bash
npm run check
```
This also type-checks the maintained CLI and browser applications, and applies the Community directory blocker rules. Run `npm run lint:community` separately to inspect its non-blocking recommendations.
- Run unit tests:
```bash
npm run test:unit
eslint.community.config.mjs
+81
View File
@@ -0,0 +1,81 @@
import obsidianmd from "eslint-plugin-obsidianmd";
import globals from "globals";
import { defineConfig, globalIgnores } from "eslint/config";
export default defineConfig(
globalIgnores([
"node_modules",
"**/dist",
"build",
"coverage",
"main.js",
"main_org.js",
"pouchdb-browser.js",
"package.json",
"package-lock.json",
"versions.json",
// Svelte is covered by the project lint and svelte-check; the directory report currently analyses TypeScript.
"**/*.svelte",
"**/svelte.config.js",
"**/*.unit.spec.ts",
"**/test/**",
"src/apps/_test/**",
"src/apps/cli/testdeno/**",
]),
{
languageOptions: {
globals: {
...globals.browser,
...globals.node,
MANIFEST_VERSION: "readonly",
PACKAGE_VERSION: "readonly",
UPDATE_INFO: "readonly",
hostPlatform: "readonly",
},
parserOptions: {
project: [
"./tsconfig.json",
"./src/apps/browser/tsconfig.json",
"./src/apps/cli/tsconfig.json",
"./src/apps/webapp/tsconfig.json",
"./src/apps/webpeer/tsconfig.app.json",
"./src/apps/webpeer/tsconfig.node.json",
],
tsconfigRootDir: import.meta.dirname,
},
},
},
...obsidianmd.configs.recommended,
{
rules: {
// The directory review reports console usage as guidance rather than a release blocker.
"obsidianmd/rule-custom-message": "off",
"no-console": "warn",
"obsidianmd/no-unsupported-api": "error",
// Keep legacy type-safety debt visible while reserving errors for directory-review blockers.
"@typescript-eslint/no-unsafe-argument": "warn",
"@typescript-eslint/no-unsafe-assignment": "warn",
"@typescript-eslint/no-unsafe-call": "warn",
"@typescript-eslint/no-unsafe-member-access": "warn",
"@typescript-eslint/no-unsafe-return": "warn",
"@typescript-eslint/no-base-to-string": "warn",
"@typescript-eslint/no-redundant-type-constituents": "warn",
"@typescript-eslint/no-unnecessary-type-assertion": "warn",
},
},
{
files: ["src/apps/**/*.{ts,js,mjs}"],
rules: {
// These applications are inspected by the directory review but accept external command and file data.
"@typescript-eslint/restrict-template-expressions": "warn",
},
},
{
files: ["src/apps/browser/**/*.ts", "src/apps/webapp/**/*.ts"],
rules: {
"obsidianmd/no-static-styles-assignment": "off",
"obsidianmd/prefer-create-el": "off",
"obsidianmd/prefer-active-doc": "off",
},
}
);
eslint.config.common.mjs
+2 -2
View File
@@ -91,8 +91,8 @@ export const baseRules = {
*/
export const obsidianRules = {
// -- Obsidian rules
// obsidianmd/no-unsupported-api: usually this project checks for API support at runtime, so this rule is not critical but can be helpful to catch potential issues.
"obsidianmd/no-unsupported-api": warnWhileDev,
// Runtime fallbacks must use requireApiVersion guards recognised by the official rule.
"obsidianmd/no-unsupported-api": "error",
// -- Plugin specific overrides
"obsidianmd/rule-custom-message": "off",
eslint.config.mjs
+36 -4
View File
@@ -7,10 +7,19 @@ import svelteParser from "svelte-eslint-parser";
import importAlias from "@dword-design/eslint-plugin-import-alias";
import { baseRules, ImportAliasRules, obsidianRules } from "./eslint.config.common.mjs";
const warnWhileDev = "off"; // Change to "warn" to enable warnings for rules that are currently disabled.
const lintProjects = [
"./tsconfig.json",
"./src/apps/browser/tsconfig.json",
"./src/apps/cli/tsconfig.json",
"./src/apps/webapp/tsconfig.json",
"./src/apps/webpeer/tsconfig.app.json",
"./src/apps/webpeer/tsconfig.node.json",
];
export default defineConfig([
globalIgnores([
// Build outputs and legacy files
"**/build",
"**/dist/**",
"coverage",
"**/main.js",
"main_org.js",
@@ -22,8 +31,7 @@ export default defineConfig([
// Files from linked dependencies (those files should not exist for most people).
"modules/octagonal-wheels/dist",
// Sub-projects (Exclude from root linting as they have different environments)
"src/apps",
// Sub-project tooling with its own environment
"utils",
// Config files and build scripts
@@ -38,6 +46,9 @@ export default defineConfig([
"vitest.*",
// Testing files (Simplified patterns)
"test/**",
"**/test/**",
"src/apps/_test/**",
"src/apps/cli/testdeno/**",
"**/*.test.ts",
"**/*.unit.spec.ts",
"**/test.ts",
@@ -52,8 +63,8 @@ export default defineConfig([
globals: { ...globals.browser, PouchDB: "readonly" },
parser: tsParser,
parserOptions: {
project: "./tsconfig.json",
rootDir: "./",
project: lintProjects,
tsconfigRootDir: import.meta.dirname,
},
},
linterOptions: {
@@ -73,6 +84,8 @@ export default defineConfig([
parser: svelteParser,
parserOptions: {
parser: tsParser,
project: lintProjects,
tsconfigRootDir: import.meta.dirname,
extraFileExtensions: [".svelte"],
},
},
@@ -86,4 +99,23 @@ export default defineConfig([
...ImportAliasRules("."),
},
},
{
files: ["src/apps/**/*.ts"],
rules: {
// Platform adapters implement asynchronous contracts even when a local operation is synchronous.
"@typescript-eslint/require-await": "off",
// Keep existing application code visible without making gradual type tightening a release blocker.
"@typescript-eslint/no-base-to-string": "warn",
"@typescript-eslint/no-unnecessary-type-assertion": "warn",
"@typescript-eslint/restrict-template-expressions": "warn",
},
},
{
files: ["src/apps/browser/**/*.{ts,svelte}", "src/apps/webapp/**/*.ts"],
rules: {
// Browser applications use the DOM rather than Obsidian's DOM extensions.
"obsidianmd/prefer-create-el": "off",
"obsidianmd/prefer-active-doc": "off",
},
},
]);
package-lock.json
Generated
+37 -6
View File
@@ -65,7 +65,7 @@
"esbuild-plugin-inline-worker": "^0.1.1",
"esbuild-svelte": "^0.9.4",
"eslint": "^9.39.3",
"eslint-plugin-obsidianmd": "^0.3.0",
"eslint-plugin-obsidianmd": "^0.4.1",
"eslint-plugin-svelte": "^3.19.0",
"events": "^3.3.0",
"globals": "^14.0.0",
@@ -1813,6 +1813,36 @@
"node": ">=18"
}
},
"node_modules/@eslint-community/eslint-plugin-eslint-comments": {
"version": "4.7.2",
"resolved": "https://registry.npmjs.org/@eslint-community/eslint-plugin-eslint-comments/-/eslint-plugin-eslint-comments-4.7.2.tgz",
"integrity": "sha512-LF03qURSwEWm2dz5wtdDCzNk+7Opl0X7q6I3undsaIuNsEiNvRV3BCtqu14Q/6Pzg1tBj44LcxpW2EpSLZStZw==",
"dev": true,
"license": "MIT",
"dependencies": {
"escape-string-regexp": "^4.0.0",
"ignore": "^7.0.5"
},
"engines": {
"node": "^12.22.0 || ^14.17.0 || >=16.0.0"
},
"funding": {
"url": "https://opencollective.com/eslint"
},
"peerDependencies": {
"eslint": "^6.0.0 || ^7.0.0 || ^8.0.0 || ^9.0.0 || ^10.0.0"
}
},
"node_modules/@eslint-community/eslint-plugin-eslint-comments/node_modules/ignore": {
"version": "7.0.6",
"resolved": "https://registry.npmjs.org/ignore/-/ignore-7.0.6.tgz",
"integrity": "sha512-BAg6QkE8W+TuQLrrw0Ugr7HegXduRuuj8/ti2kSOc+jz1dmx8/WNcjr6XGnq5YpDWxFwwaavqD0+jIUOKelTsw==",
"dev": true,
"license": "MIT",
"engines": {
"node": ">= 4"
}
},
"node_modules/@eslint-community/eslint-utils": {
"version": "4.9.1",
"resolved": "https://registry.npmjs.org/@eslint-community/eslint-utils/-/eslint-utils-4.9.1.tgz",
@@ -8034,12 +8064,13 @@
}
},
"node_modules/eslint-plugin-obsidianmd": {
"version": "0.3.0",
"resolved": "https://registry.npmjs.org/eslint-plugin-obsidianmd/-/eslint-plugin-obsidianmd-0.3.0.tgz",
"integrity": "sha512-QvGDI6B2nxJBrsZKGTg31da2A/fEJNlnwN+fRZkaoPIu1QL3fYXUdpP7ThyMdr/0iTYQxifb9lt2X9cpydQx1w==",
"version": "0.4.1",
"resolved": "https://registry.npmjs.org/eslint-plugin-obsidianmd/-/eslint-plugin-obsidianmd-0.4.1.tgz",
"integrity": "sha512-Nv3593kVsFOS8kir/HWaJ5CR3xcyiPWEPyXst5Pib8mxRYYuLYPpJS2ALMoZXHulHyiGwoYW8AaxvLRc4rhrRg==",
"dev": true,
"license": "MIT",
"dependencies": {
"@eslint-community/eslint-plugin-eslint-comments": "^4.7.2",
"@eslint/config-helpers": "^0.4.2",
"@eslint/js": "^9.30.1",
"@eslint/json": "0.14.0",
@@ -8048,7 +8079,7 @@
"@types/node": "20.12.12",
"@typescript-eslint/types": "^8.33.1",
"@typescript-eslint/utils": "^8.33.1",
"eslint": ">=9.0.0",
"eslint": ">=9.19.0",
"eslint-plugin-depend": "1.3.1",
"eslint-plugin-import": "^2.31.0",
"eslint-plugin-json-schema-validator": "5.1.0",
@@ -8069,7 +8100,7 @@
"peerDependencies": {
"@eslint/js": "^9.30.1",
"@eslint/json": "0.14.0",
"eslint": ">=9.0.0",
"eslint": ">=9.19.0",
"obsidian": "1.8.7",
"typescript-eslint": "^8.35.1"
}
package.json
+4 -2
View File
@@ -11,15 +11,17 @@
"buildViteOriginal": "npx dotenv-cli -e .env -- vite build --mode original",
"buildDev": "node esbuild.config.mjs dev",
"lint": "eslint --cache --concurrency auto src",
"lint:community": "eslint --config eslint.community.config.mjs --concurrency auto src",
"svelte-check": "svelte-check --tsconfig ./tsconfig.json",
"tsc-check": "tsc --noEmit",
"tsc-check:apps": "tsc --noEmit -p src/apps/browser/tsconfig.json && tsc --noEmit -p src/apps/cli/tsconfig.json && tsc --noEmit -p src/apps/webapp/tsconfig.json && tsc --noEmit -p src/apps/webpeer/tsconfig.app.json && tsc --noEmit -p src/apps/webpeer/tsconfig.node.json",
"pretty:importpath": "cd utilsdeno && deno run -A ./normalise-imports.ts",
"pretty:json": "prettier --config ./.prettierrc.mjs \"**/*.json\" --write --log-level error",
"pretty": "npm run prettyNoWrite -- --write --log-level error",
"prettyCheck": "npm run prettyNoWrite -- --check",
"prettyNoWrite": "prettier --config ./.prettierrc.mjs \"**/*.js\" \"**/*.ts\" \"**/*.json\" ",
"check:compatibility": "node utils/check-compatibility.js --file main.js --ios 15",
"check": "npm run tsc-check && npm run lint && npm run svelte-check && npm run check:compatibility",
"check": "npm run tsc-check && npm run tsc-check:apps && npm run lint && npm run lint:community -- --quiet && npm run svelte-check && npm run check:compatibility",
"unittest": "deno test -A --no-check --coverage=cov_profile --v8-flags=--expose-gc --trace-leaks ./src/",
"test": "vitest run",
"test:unit": "vitest run --config vitest.config.unit.ts",
@@ -108,7 +110,7 @@
"esbuild-plugin-inline-worker": "^0.1.1",
"esbuild-svelte": "^0.9.4",
"eslint": "^9.39.3",
"eslint-plugin-obsidianmd": "^0.3.0",
"eslint-plugin-obsidianmd": "^0.4.1",
"eslint-plugin-svelte": "^3.19.0",
"events": "^3.3.0",
"globals": "^14.0.0",
src/apps/browser/tsconfig.json
+16
View File
@@ -0,0 +1,16 @@
{
"extends": "../../../tsconfig.json",
"compilerOptions": {
"target": "ES2020",
"lib": ["ES2020", "DOM", "DOM.Iterable"],
"moduleResolution": "bundler",
"allowImportingTsExtensions": true,
"isolatedModules": true,
"noEmit": true,
"paths": {
"@/*": ["../../*"]
}
},
"include": ["**/*.ts", "**/*.svelte"],
"exclude": ["**/*.unit.spec.ts"]
}
src/apps/browser/ui/MenuItemView.svelte
+1 -1
View File
@@ -1,5 +1,5 @@
<script lang="ts">
import type { MenuItem } from "../BrowserMenu";
import type { MenuItem } from "@/apps/browser/BrowserMenu";
type Props = {
item: MenuItem;
src/apps/browser/ui/MenuSeparatorView.svelte
+1 -1
View File
@@ -1,5 +1,5 @@
<script lang="ts">
import type { MenuSeparator } from "../BrowserMenu";
import type { MenuSeparator } from "@/apps/browser/BrowserMenu";
type Props = {
item: MenuSeparator;
src/apps/browser/ui/MenuView.svelte
+1 -1
View File
@@ -1,5 +1,5 @@
<script lang="ts">
import type { Menu, MenuItem, MenuSeparator } from "../BrowserMenu";
import type { Menu, MenuItem, MenuSeparator } from "@/apps/browser/BrowserMenu";
import MenuItemView from "./MenuItemView.svelte";
import MenuSeparatorView from "./MenuSeparatorView.svelte";
src/apps/cli/adapters/NodeVaultAdapter.ts
-1
View File
@@ -31,7 +31,6 @@ export class NodeVaultAdapter implements IVaultAdapter<NodeFile> {
const buffer = await fs.readFile(this.resolvePath(file.path));
// Same correction as read() — ensure stat.size matches actual byte length.
file.stat.size = buffer.length;
// eslint-disable-next-line @typescript-eslint/no-unnecessary-type-assertion -- required in environments where Buffer.buffer is ArrayBufferLike
return buffer.buffer.slice(buffer.byteOffset, buffer.byteOffset + buffer.byteLength) as ArrayBuffer;
}
src/apps/cli/commands/types.ts
+4
View File
@@ -91,3 +91,7 @@ export const VALID_COMMANDS = new Set([
"remote-status",
"init-settings",
] as const);
export function isCLICommand(value: string): value is CLICommand {
return (VALID_COMMANDS as ReadonlySet<string>).has(value);
}
src/apps/cli/commands/utils.ts
-1
View File
@@ -1,7 +1,6 @@
import { path, readline } from "@vrtmrz/livesync-commonlib/node";
export function toArrayBuffer(data: Buffer): ArrayBuffer {
// eslint-disable-next-line @typescript-eslint/no-unnecessary-type-assertion -- required in environments where Buffer.buffer is ArrayBufferLike
return data.buffer.slice(data.byteOffset, data.byteOffset + data.byteLength) as ArrayBuffer;
}
src/apps/cli/entrypoint.ts
+3 -6
View File
@@ -1,17 +1,14 @@
#!/usr/bin/env node
// eslint-disable -- This is the entry point for the CLI application.
import * as polyfill from "werift";
import { RTCPeerConnection } from "werift";
import { main } from "./main";
import { compatGlobal } from "@vrtmrz/livesync-commonlib/compat/common/coreEnvFunctions";
// eslint-disable-next-line @typescript-eslint/no-explicit-any -- Polyfill
const rtcPolyfillCtor = (polyfill as any).RTCPeerConnection;
if (
typeof (compatGlobal as unknown as Record<string, unknown>).RTCPeerConnection === "undefined" &&
typeof rtcPolyfillCtor === "function"
typeof RTCPeerConnection === "function"
) {
// Fill only the standard WebRTC global in Node CLI runtime.
(compatGlobal as unknown as Record<string, unknown>).RTCPeerConnection = rtcPolyfillCtor;
(compatGlobal as unknown as Record<string, unknown>).RTCPeerConnection = RTCPeerConnection;
}
main().catch((error) => {
src/apps/cli/lib/pouchdb-node.ts
+40 -38
View File
@@ -24,46 +24,48 @@ type PurgeMultiResult = {
documentWasRemovedCompletely: boolean;
};
type PurgeMultiParam = [docId: string, rev$$1: string];
type PurgeLogDocument = {
purgeSeq: number;
purges: Array<{ docId: string; rev: string; purgeSeq: number }>;
};
function appendPurgeSeqs(db: PouchDB.Database, docs: PurgeMultiParam[]) {
return (
db
.get("_local/purges")
// eslint-disable-next-line @typescript-eslint/no-explicit-any -- Internal method patching.
.then(function (doc: any) {
for (const [docId, rev$$1] of docs) {
const purgeSeq = doc.purgeSeq + 1;
doc.purges.push({
docId,
rev: rev$$1,
purgeSeq,
});
return db
.get<PurgeLogDocument>("_local/purges")
.then(function (doc) {
for (const [docId, rev$$1] of docs) {
const purgeSeq = doc.purgeSeq + 1;
doc.purges.push({
docId,
rev: rev$$1,
purgeSeq,
});
//@ts-ignore : missing type def
if (doc.purges.length > db.purged_infos_limit) {
//@ts-ignore : missing type def
if (doc.purges.length > db.purged_infos_limit) {
//@ts-ignore : missing type def
doc.purges.splice(0, doc.purges.length - db.purged_infos_limit);
}
doc.purgeSeq = purgeSeq;
doc.purges.splice(0, doc.purges.length - db.purged_infos_limit);
}
return doc;
})
.catch(function (err) {
if (err.status !== 404) {
throw err;
}
return {
_id: "_local/purges",
purges: docs.map(([docId, rev$$1], idx) => ({
docId,
rev: rev$$1,
purgeSeq: idx,
})),
purgeSeq: docs.length,
};
})
.then(function (doc) {
return db.put(doc);
})
);
doc.purgeSeq = purgeSeq;
}
return doc;
})
.catch(function (err) {
if (err.status !== 404) {
throw err;
}
return {
_id: "_local/purges",
purges: docs.map(([docId, rev$$1], idx) => ({
docId,
rev: rev$$1,
purgeSeq: idx,
})),
purgeSeq: docs.length,
};
})
.then(function (doc) {
return db.put(doc);
});
}
/**
@@ -88,7 +90,7 @@ PouchDB.prototype.purgeMulti = adapterFun(
);
}
//@ts-ignore
// eslint-disable-next-line @typescript-eslint/no-this-alias
// eslint-disable-next-line @typescript-eslint/no-this-alias -- The adapter task callbacks must retain this PouchDB instance.
const self = this;
const tasks = docs.map(
(param) => () =>
src/apps/cli/main.ts
+11 -8
View File
@@ -2,7 +2,12 @@ import { NodeServiceContext, NodeServiceHub } from "./services/NodeServiceHub";
import { configureNodeLocalStorage, ensureGlobalNodeLocalStorage } from "./services/NodeLocalStorage";
import { LiveSyncBaseCore } from "@/LiveSyncBaseCore";
import { initialiseServiceModulesCLI } from "./serviceModules/CLIServiceModules";
import { DEFAULT_SETTINGS, LOG_LEVEL_VERBOSE, type LOG_LEVEL, type ObsidianLiveSyncSettings } from "@vrtmrz/livesync-commonlib/compat/common/types";
import {
DEFAULT_SETTINGS,
LOG_LEVEL_VERBOSE,
type LOG_LEVEL,
type ObsidianLiveSyncSettings,
} from "@vrtmrz/livesync-commonlib/compat/common/types";
import type { InjectableServiceHub } from "@vrtmrz/livesync-commonlib/compat/services/implements/injectable/InjectableServiceHub";
import type { InjectableSettingService } from "@vrtmrz/livesync-commonlib/compat/services/implements/injectable/InjectableSettingService";
import {
@@ -14,7 +19,7 @@ import {
LOG_LEVEL_NOTICE,
} from "octagonal-wheels/common/logger";
import { runCommand } from "./commands/runCommand";
import { VALID_COMMANDS } from "./commands/types";
import { isCLICommand } from "./commands/types";
import type { CLICommand, CLIOptions } from "./commands/types";
import { getPathFromUXFileInfo } from "@vrtmrz/livesync-commonlib/compat/common/typeUtils";
import { stripAllPrefixes } from "@vrtmrz/livesync-commonlib/compat/string_and_binary/path";
@@ -185,9 +190,8 @@ export function parseArgs(): CLIOptions {
break;
default: {
if (!databasePath) {
// eslint-disable-next-line @typescript-eslint/no-explicit-any -- Set checking
if (command === "daemon" && VALID_COMMANDS.has(token as any)) {
command = token as CLICommand;
if (command === "daemon" && isCLICommand(token)) {
command = token;
break;
}
if (command === "init-settings") {
@@ -197,9 +201,8 @@ export function parseArgs(): CLIOptions {
databasePath = token;
break;
}
// eslint-disable-next-line @typescript-eslint/no-explicit-any -- Set checking
if (command === "daemon" && VALID_COMMANDS.has(token as any)) {
command = token as CLICommand;
if (command === "daemon" && isCLICommand(token)) {
command = token;
break;
}
commandArgs.push(token);
src/apps/cli/services/NodeServiceHub.ts
+2 -4
View File
@@ -20,7 +20,6 @@ import { InjectableTweakValueService } from "@vrtmrz/livesync-commonlib/compat/s
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 "@vrtmrz/livesync-commonlib/compat/services/base/DatabaseService";
@@ -171,7 +170,7 @@ export class NodeServiceHub<T extends NodeServiceContext> extends InjectableServ
APIService: API,
});
const serviceInstancesToInit: Required<ServiceInstances<T>> = {
const serviceInstancesToInit = {
appLifecycle,
conflict,
database,
@@ -191,7 +190,6 @@ export class NodeServiceHub<T extends NodeServiceContext> extends InjectableServ
keyValueDB: keyValueDB as unknown as KeyValueDBService<T>,
control,
};
// eslint-disable-next-line @typescript-eslint/no-explicit-any -- (Forcibly )
super(context, serviceInstancesToInit as any);
super(context, serviceInstancesToInit);
}
}
src/apps/webapp/bootstrap.ts
+10 -2
View File
@@ -5,6 +5,15 @@ import { compatGlobal, _activeDocument } from "@vrtmrz/livesync-commonlib/compat
const historyStore = new VaultHistoryStore();
let app: LiveSyncWebApp | null = null;
type LiveSyncWebAppDebugApi = {
getApp: () => LiveSyncWebApp | null;
historyStore: VaultHistoryStore;
};
type LiveSyncWebAppGlobal = typeof compatGlobal & {
livesyncApp?: LiveSyncWebAppDebugApi;
};
function getRequiredElement<T extends HTMLElement>(id: string): T {
const element = _activeDocument.getElementById(id);
if (!element) {
@@ -131,8 +140,7 @@ compatGlobal.addEventListener("load", () => {
compatGlobal.addEventListener("beforeunload", () => {
void app?.shutdown();
});
// eslint-disable-next-line @typescript-eslint/no-explicit-any -- patching
(compatGlobal as any).livesyncApp = {
(compatGlobal as LiveSyncWebAppGlobal).livesyncApp = {
getApp: () => app,
historyStore,
};
src/apps/webapp/main.ts
+10 -8
View File
@@ -6,7 +6,7 @@
import type { BrowserServiceHub } from "@vrtmrz/livesync-commonlib/compat/services/BrowserServices";
import { LiveSyncBaseCore } from "@/LiveSyncBaseCore";
import { ServiceContext } from "@vrtmrz/livesync-commonlib/compat/services/base/ServiceBase";
import { initialiseServiceModulesFSAPI } from "./serviceModules/FSAPIServiceModules";
import { initialiseServiceModulesFSAPI, type FSAPIServiceModules } from "./serviceModules/FSAPIServiceModules";
import type { ObsidianLiveSyncSettings } from "@vrtmrz/livesync-commonlib/compat/common/types";
import type { BrowserAPIService } from "@vrtmrz/livesync-commonlib/compat/services/implements/browser/BrowserAPIService";
import type { InjectableSettingService } from "@vrtmrz/livesync-commonlib/compat/services/implements/injectable/InjectableSettingService";
@@ -53,6 +53,7 @@ class LiveSyncWebApp {
private rootHandle: FileSystemDirectoryHandle;
private core: LiveSyncBaseCore<ServiceContext, never> | null = null;
private serviceHub: BrowserServiceHub<ServiceContext> | null = null;
private platformServiceModules: FSAPIServiceModules | null = null;
constructor(rootHandle: FileSystemDirectoryHandle) {
this.rootHandle = rootHandle;
@@ -113,7 +114,9 @@ class LiveSyncWebApp {
this.core = new LiveSyncBaseCore<ServiceContext, never>(
this.serviceHub,
(core, serviceHub) => {
return initialiseServiceModulesFSAPI(this.rootHandle, core, serviceHub);
const serviceModules = initialiseServiceModulesFSAPI(this.rootHandle, core, serviceHub);
this.platformServiceModules = serviceModules;
return serviceModules;
},
(core) => [
// new ModuleObsidianEvents(this, core),
@@ -208,9 +211,8 @@ class LiveSyncWebApp {
}
// Scan the directory to populate file cache
// eslint-disable-next-line @typescript-eslint/no-explicit-any -- Accessing private service modules
const fileAccess = (this.core as any)._serviceModules?.storageAccess?.vaultAccess;
if (fileAccess?.fsapiAdapter) {
const fileAccess = this.platformServiceModules?.vaultAccess;
if (fileAccess) {
console.log("[Scanning] Scanning vault directory...");
await fileAccess.fsapiAdapter.scanDirectory();
const files = await fileAccess.fsapiAdapter.getFiles();
@@ -227,13 +229,13 @@ class LiveSyncWebApp {
console.log("[Shutdown] Shutting down...");
// Stop file watching
// eslint-disable-next-line @typescript-eslint/no-explicit-any -- Accessing private service modules
const storageEventManager = (this.core as any)._serviceModules?.storageAccess?.storageEventManager;
if (storageEventManager?.cleanup) {
const storageEventManager = this.platformServiceModules?.storageEventManager;
if (storageEventManager) {
await storageEventManager.cleanup();
}
await this.core.services.control.onUnload();
this.platformServiceModules = null;
console.log("[Shutdown] Complete");
}
}
src/apps/webapp/managers/FSAPIStorageEventManagerAdapter.ts
+25 -10
View File
@@ -13,6 +13,25 @@ import type { FileEventItemSentinel } from "@vrtmrz/livesync-commonlib/compat/ma
import type { FSAPIFile, FSAPIFolder } from "@/apps/webapp/adapters/FSAPITypes";
import { compatGlobal } from "@vrtmrz/livesync-commonlib/compat/common/coreEnvFunctions";
type FileSystemObserverRecord = {
changedHandle?: FileSystemFileHandle | FileSystemDirectoryHandle;
relativePathComponents?: readonly string[];
type: "appeared" | "disappeared" | "modified" | "moved" | "unknown" | "errored";
};
type FileSystemObserverInstance = {
observe(handle: FileSystemDirectoryHandle, options: { recursive: boolean }): Promise<void>;
disconnect(): void;
};
type FileSystemObserverConstructor = new (
callback: (records: readonly FileSystemObserverRecord[]) => void | Promise<void>
) => FileSystemObserverInstance;
type GlobalWithFileSystemObserver = typeof compatGlobal & {
FileSystemObserver?: FileSystemObserverConstructor;
};
/**
* FileSystem API-specific type guard adapter
*/
@@ -89,7 +108,8 @@ class FSAPIPersistenceAdapter implements IStorageEventPersistenceAdapter {
const result = await new Promise<(FileEventItem | FileEventItemSentinel)[] | null>((resolve, reject) => {
const request = store.get(this.snapshotKey);
request.onsuccess = () => resolve(request.result || null);
request.onsuccess = () =>
resolve((request.result as (FileEventItem | FileEventItemSentinel)[] | undefined) ?? null);
request.onerror = () => reject(request.error);
});
@@ -155,26 +175,21 @@ class FSAPIConverterAdapter implements IStorageEventConverterAdapter<FSAPIFile>
* FileSystem API-specific watch adapter using FileSystemObserver (Chrome only)
*/
class FSAPIWatchAdapter implements IStorageEventWatchAdapter {
// eslint-disable-next-line @typescript-eslint/no-explicit-any -- Accessing private service modules
private observer: any = null; // FileSystemObserver type
private observer: FileSystemObserverInstance | null = null;
constructor(private rootHandle: FileSystemDirectoryHandle) {}
async beginWatch(handlers: IStorageEventWatchHandlers): Promise<void> {
// Use FileSystemObserver if available (Chrome 124+)
// eslint-disable-next-line @typescript-eslint/no-explicit-any -- Accessing global FileSystemObserver
if (typeof (compatGlobal as any).FileSystemObserver === "undefined") {
const FileSystemObserver = (compatGlobal as GlobalWithFileSystemObserver).FileSystemObserver;
if (!FileSystemObserver) {
console.log("[FSAPIWatchAdapter] FileSystemObserver not available, file watching disabled");
console.log("[FSAPIWatchAdapter] Consider using Chrome 124+ for real-time file watching");
return Promise.resolve();
}
try {
// eslint-disable-next-line @typescript-eslint/no-explicit-any -- Accessing private service modules
const FileSystemObserver = (compatGlobal as any).FileSystemObserver;
// eslint-disable-next-line @typescript-eslint/no-explicit-any -- Accessing private service modules
this.observer = new FileSystemObserver(async (records: any[]) => {
this.observer = new FileSystemObserver(async (records) => {
for (const record of records) {
const changedHandle = record.changedHandle;
const relativePathComponents = record.relativePathComponents;
src/apps/webapp/serviceModules/FSAPIServiceModules.ts
+8 -1
View File
@@ -11,6 +11,11 @@ import { StorageEventManagerFSAPI } from "@/apps/webapp/managers/StorageEventMan
import type { ServiceModules } from "@vrtmrz/livesync-commonlib/compat/interfaces/ServiceModule";
import { ServiceFileHandler } from "@/serviceModules/FileHandler";
export interface FSAPIServiceModules extends ServiceModules {
vaultAccess: FileAccessFSAPI;
storageEventManager: StorageEventManagerFSAPI;
}
/**
* Initialize service modules for FileSystem API webapp version
* This is the webapp equivalent of ObsidianLiveSyncPlugin.initialiseServiceModules
@@ -24,7 +29,7 @@ export function initialiseServiceModulesFSAPI(
rootHandle: FileSystemDirectoryHandle,
core: LiveSyncBaseCore<ServiceContext, never>,
services: InjectableServiceHub<ServiceContext>
): ServiceModules {
): FSAPIServiceModules {
const storageAccessManager = new StorageAccessManager();
// FileSystem API-specific file access
@@ -104,5 +109,7 @@ export function initialiseServiceModulesFSAPI(
fileHandler,
databaseFileAccess,
storageAccess,
vaultAccess,
storageEventManager,
};
}
src/common/reportTool.ts
-1
View File
@@ -17,7 +17,6 @@ function redactObject(obj: Record<string, unknown>, dotted: string, redactedValu
if (!(key in current)) {
current[key] = {};
}
// eslint-disable-next-line @typescript-eslint/no-unsafe-assignment
current = current[key] as Record<string, unknown>;
}
const lastKey = keys[keys.length - 1];
src/deps.ts
+1
View File
@@ -27,6 +27,7 @@ export {
Menu,
request,
getLanguage,
requireApiVersion,
ButtonComponent,
TextComponent,
ToggleComponent,
src/features/ConfigSync/CmdConfigSync.ts
+1 -1
View File
@@ -1178,7 +1178,7 @@ export class ConfigSync extends LiveSyncCommands {
if (this.isThisModuleEnabled() && this.core.settings.notifyPluginOrSettingUpdated) {
if (!this.pluginDialog || (this.pluginDialog && !this.pluginDialog.isOpened())) {
const fragment = createFragment((doc) => {
doc.createEl("span", undefined, (a) => {
doc.createSpan(undefined, (a) => {
a.appendText(`Some configuration has been arrived, Press `);
a.appendChild(
a.createEl("a", undefined, (anchor) => {
src/modules/coreObsidian/UILib/dialogs.ts
+2 -6
View File
@@ -4,20 +4,16 @@ import { EVENT_PLUGIN_UNLOADED, eventHub } from "@/common/events.ts";
import { compatGlobal, type CompatIntervalHandle } from "@vrtmrz/livesync-commonlib/compat/common/coreEnvFunctions";
class AutoClosableModal extends Modal {
_closeByUnload() {
// eslint-disable-next-line @typescript-eslint/unbound-method
_closeByUnload = () => {
eventHub.off(EVENT_PLUGIN_UNLOADED, this._closeByUnload);
this.close();
}
};
constructor(app: App) {
super(app);
this._closeByUnload = this._closeByUnload.bind(this);
// eslint-disable-next-line @typescript-eslint/unbound-method
eventHub.once(EVENT_PLUGIN_UNLOADED, this._closeByUnload);
}
override onClose() {
// eslint-disable-next-line @typescript-eslint/unbound-method
eventHub.off(EVENT_PLUGIN_UNLOADED, this._closeByUnload);
}
}
src/modules/essentialObsidian/ModuleObsidianEvents.ts
+30 -16
View File
@@ -15,6 +15,23 @@ import {
import type { LiveSyncCore } from "@/main.ts";
import { compatGlobal } from "@vrtmrz/livesync-commonlib/compat/common/coreEnvFunctions";
type MutableCommandDefinition = {
callback?: () => void;
};
type InternalCommandRegistry = {
commands?: Record<string, MutableCommandDefinition | undefined>;
executeCommandById(commandId: string): unknown;
};
type AppWithInternalCommands = {
commands?: InternalCommandRegistry;
};
type CodeMirrorAdapter = {
commands: { save: () => void };
};
export class ModuleObsidianEvents extends AbstractObsidianModule {
_everyOnloadStart(): Promise<boolean> {
// this.registerEvent(this.app.workspace.on("editor-change", ));
@@ -40,10 +57,10 @@ export class ModuleObsidianEvents extends AbstractObsidianModule {
swapSaveCommand() {
this._log("Modifying callback of the save command", LOG_LEVEL_VERBOSE);
// eslint-disable-next-line @typescript-eslint/no-explicit-any -- Editor Tweaking
const saveCommandDefinition = (this.app as any).commands?.commands?.["editor:save-file"];
const commandRegistry = (this.app as unknown as AppWithInternalCommands).commands;
const saveCommandDefinition = commandRegistry?.commands?.["editor:save-file"];
const save = saveCommandDefinition?.callback;
if (typeof save === "function") {
if (saveCommandDefinition && typeof save === "function") {
this.initialCallback = save;
saveCommandDefinition.callback = () => {
scheduleTask("syncOnEditorSave", 250, () => {
@@ -61,17 +78,14 @@ export class ModuleObsidianEvents extends AbstractObsidianModule {
save();
};
}
// eslint-disable-next-line @typescript-eslint/no-this-alias
const _this = this;
//@ts-ignore
if (!compatGlobal.CodeMirrorAdapter) {
const codeMirrorAdapter = (compatGlobal as typeof compatGlobal & { CodeMirrorAdapter?: CodeMirrorAdapter })
.CodeMirrorAdapter;
if (!codeMirrorAdapter) {
this._log("CodeMirrorAdapter is not available");
return;
}
//@ts-ignore
compatGlobal.CodeMirrorAdapter.commands.save = () => {
//@ts-ignore
void _this.app.commands.executeCommandById("editor:save-file");
codeMirrorAdapter.commands.save = () => {
void commandRegistry?.executeCommandById("editor:save-file");
// _this.app.performCommand('editor:save-file');
};
}
@@ -82,18 +96,18 @@ export class ModuleObsidianEvents extends AbstractObsidianModule {
this.watchWorkspaceOpen = this.watchWorkspaceOpen.bind(this);
this.watchOnline = this.watchOnline.bind(this);
// Already bound
// eslint-disable-next-line @typescript-eslint/unbound-method
// eslint-disable-next-line @typescript-eslint/unbound-method -- The handler is bound above before registration.
this.plugin.registerEvent(this.app.workspace.on("file-open", this.watchWorkspaceOpen));
// Already bound
// eslint-disable-next-line @typescript-eslint/unbound-method
// eslint-disable-next-line @typescript-eslint/unbound-method -- The handler is bound above before registration.
this.plugin.registerDomEvent(activeDocument, "visibilitychange", this.watchWindowVisibility);
this.plugin.registerDomEvent(compatGlobal, "focus", () => this.setHasFocus(true));
this.plugin.registerDomEvent(compatGlobal, "blur", () => this.setHasFocus(false));
// Already bound
// eslint-disable-next-line @typescript-eslint/unbound-method
// eslint-disable-next-line @typescript-eslint/unbound-method -- The handler is bound above before registration.
this.plugin.registerDomEvent(compatGlobal, "online", this.watchOnline);
// Already bound
// eslint-disable-next-line @typescript-eslint/unbound-method
// eslint-disable-next-line @typescript-eslint/unbound-method -- The handler is bound above before registration.
this.plugin.registerDomEvent(compatGlobal, "offline", this.watchOnline);
}
@@ -317,7 +331,7 @@ export class ModuleObsidianEvents extends AbstractObsidianModule {
// const proc = this.core.processingFileEventCount.value;
const e = 0;
const proc = 0;
// eslint-disable-next-line @typescript-eslint/no-unused-vars
// eslint-disable-next-line @typescript-eslint/no-unused-vars -- Reading the tick establishes the reactive polling dependency.
const __ = __tick.value;
return (
dbCount +
src/modules/extras/devUtil/tests.ts
+1 -2
View File
@@ -34,8 +34,7 @@ async function measure(
return [name, measures.get(name) as MeasureResult];
}
// eslint-disable-next-line require-await, @typescript-eslint/require-await
async function formatPerfResults(items: NamedMeasureResult[]) {
function formatPerfResults(items: NamedMeasureResult[]) {
return (
`| Name | Runs | Each | Total |\n| --- | --- | --- | --- | \n` +
items
src/modules/features/DocumentHistory/DocumentHistoryModal.ts
+16 -11
View File
@@ -17,6 +17,11 @@ import { isPlainText, stripPrefix } from "@vrtmrz/livesync-commonlib/compat/stri
import { scheduleOnceIfDuplicated } from "octagonal-wheels/concurrency/lock";
import type { LiveSyncBaseCore } from "@/LiveSyncBaseCore.ts";
import { compatGlobal } from "@vrtmrz/livesync-commonlib/compat/common/coreEnvFunctions";
import {
DOCUMENT_HISTORY_PREFERENCE_KEYS,
loadDocumentHistoryPreference,
saveDocumentHistoryPreference,
} from "./documentHistoryPreferences.ts";
function isImage(path: string) {
const ext = path.split(".").splice(-1)[0].toLowerCase();
@@ -99,12 +104,10 @@ export class DocumentHistoryModal extends Modal {
if (!file && id) {
this.file = this.services.path.id2path(id);
}
// eslint-disable-next-line obsidianmd/no-unsupported-api -- loadLocalStorage is supported in Obsidian 1.7.2+
if (this.app.loadLocalStorage("ols-history-highlightdiff") == "1") {
if (loadDocumentHistoryPreference(this.app, DOCUMENT_HISTORY_PREFERENCE_KEYS.highlightDiff)) {
this.showDiff = true;
}
// eslint-disable-next-line obsidianmd/no-unsupported-api -- loadLocalStorage is supported in Obsidian 1.7.2+
if (this.app.loadLocalStorage("ols-history-diffonly") == "1") {
if (loadDocumentHistoryPreference(this.app, DOCUMENT_HISTORY_PREFERENCE_KEYS.diffOnly)) {
this.diffOnly = true;
}
}
@@ -520,10 +523,10 @@ export class DocumentHistoryModal extends Modal {
e.addEventListener("click", () => this.navigateSearch("next"));
});
this.searchResultIndicator = searchRow.createEl("span", { text: "" });
this.searchResultIndicator = searchRow.createSpan({ text: "" });
this.searchResultIndicator.addClass("history-search-result-indicator");
this.searchProgressIndicator = searchRow.createEl("span", { text: "" });
this.searchProgressIndicator = searchRow.createSpan({ text: "" });
this.searchProgressIndicator.addClass("history-search-progress-indicator");
const divView = contentEl.createDiv("");
@@ -554,8 +557,11 @@ export class DocumentHistoryModal extends Modal {
}
checkbox.addEventListener("input", (evt: Event) => {
this.showDiff = checkbox.checked;
// eslint-disable-next-line obsidianmd/no-unsupported-api -- saveLocalStorage is supported in Obsidian 1.7.2+
this.app.saveLocalStorage("ols-history-highlightdiff", this.showDiff == true ? "1" : null);
saveDocumentHistoryPreference(
this.app,
DOCUMENT_HISTORY_PREFERENCE_KEYS.highlightDiff,
this.showDiff
);
this.updateDiffNavVisibility();
void scheduleOnceIfDuplicated("loadRevs", () => this.loadRevs());
});
@@ -570,8 +576,7 @@ export class DocumentHistoryModal extends Modal {
}
checkbox.addEventListener("input", (evt: Event) => {
this.diffOnly = checkbox.checked;
// eslint-disable-next-line obsidianmd/no-unsupported-api -- saveLocalStorage is supported in Obsidian 1.7.2+
this.app.saveLocalStorage("ols-history-diffonly", this.diffOnly == true ? "1" : null);
saveDocumentHistoryPreference(this.app, DOCUMENT_HISTORY_PREFERENCE_KEYS.diffOnly, this.diffOnly);
void scheduleOnceIfDuplicated("loadRevs", () => this.loadRevs());
});
});
@@ -597,7 +602,7 @@ export class DocumentHistoryModal extends Modal {
this.navigateDiff("next");
});
});
this.diffNavIndicator = this.diffNavContainer.createEl("span", { text: "\u2014" });
this.diffNavIndicator = this.diffNavContainer.createSpan({ text: "\u2014" });
this.diffNavIndicator.addClass("diff-nav-indicator");
this.info = contentEl.createDiv("");
src/modules/features/DocumentHistory/documentHistoryPreferences.ts
+22
View File
@@ -0,0 +1,22 @@
import { requireApiVersion, type App } from "@/deps.ts";
export const DOCUMENT_HISTORY_PREFERENCE_KEYS = {
diffOnly: "ols-history-diffonly",
highlightDiff: "ols-history-highlightdiff",
} as const;
export type DocumentHistoryPreferenceKey =
(typeof DOCUMENT_HISTORY_PREFERENCE_KEYS)[keyof typeof DOCUMENT_HISTORY_PREFERENCE_KEYS];
export function loadDocumentHistoryPreference(app: App, key: DocumentHistoryPreferenceKey): boolean {
if (requireApiVersion("1.8.7")) {
return app.loadLocalStorage(key) === "1";
}
return false;
}
export function saveDocumentHistoryPreference(app: App, key: DocumentHistoryPreferenceKey, enabled: boolean): void {
if (requireApiVersion("1.8.7")) {
app.saveLocalStorage(key, enabled ? "1" : null);
}
}
src/modules/features/DocumentHistory/documentHistoryPreferences.unit.spec.ts
+52
View File
@@ -0,0 +1,52 @@
import { beforeEach, describe, expect, it, vi } from "vitest";
const requireApiVersionMock = vi.hoisted(() => vi.fn<(version: string) => boolean>());
vi.mock("@/deps.ts", () => ({
requireApiVersion: requireApiVersionMock,
}));
import {
DOCUMENT_HISTORY_PREFERENCE_KEYS,
loadDocumentHistoryPreference,
saveDocumentHistoryPreference,
} from "./documentHistoryPreferences.ts";
function createAppStorage() {
return {
loadLocalStorage: vi.fn<(key: string) => unknown>(),
saveLocalStorage: vi.fn<(key: string, value: unknown | null) => void>(),
};
}
describe("document history preferences", () => {
beforeEach(() => {
requireApiVersionMock.mockReset();
});
it("falls back without accessing Vault local storage on older Obsidian versions", () => {
requireApiVersionMock.mockReturnValue(false);
const app = createAppStorage();
expect(loadDocumentHistoryPreference(app as never, DOCUMENT_HISTORY_PREFERENCE_KEYS.highlightDiff)).toBe(false);
saveDocumentHistoryPreference(app as never, DOCUMENT_HISTORY_PREFERENCE_KEYS.diffOnly, true);
expect(requireApiVersionMock).toHaveBeenCalledWith("1.8.7");
expect(app.loadLocalStorage).not.toHaveBeenCalled();
expect(app.saveLocalStorage).not.toHaveBeenCalled();
});
it("loads and saves Vault-scoped preferences when the API is available", () => {
requireApiVersionMock.mockReturnValue(true);
const app = createAppStorage();
app.loadLocalStorage.mockReturnValue("1");
expect(loadDocumentHistoryPreference(app as never, DOCUMENT_HISTORY_PREFERENCE_KEYS.diffOnly)).toBe(true);
saveDocumentHistoryPreference(app as never, DOCUMENT_HISTORY_PREFERENCE_KEYS.highlightDiff, true);
saveDocumentHistoryPreference(app as never, DOCUMENT_HISTORY_PREFERENCE_KEYS.highlightDiff, false);
expect(app.loadLocalStorage).toHaveBeenCalledWith("ols-history-diffonly");
expect(app.saveLocalStorage).toHaveBeenNthCalledWith(1, "ols-history-highlightdiff", "1");
expect(app.saveLocalStorage).toHaveBeenNthCalledWith(2, "ols-history-highlightdiff", null);
});
});
src/modules/features/InteractiveConflictResolving/ConflictResolveModal.ts
+2 -2
View File
@@ -110,7 +110,7 @@ export class ConflictResolveModal extends Modal {
contentEl.empty();
const diffOptionsRow = contentEl.createDiv("");
diffOptionsRow.addClass("diff-options-row");
diffOptionsRow.createEl("span", { text: this.filename });
diffOptionsRow.createSpan({ text: this.filename });
const diffNavContainer = diffOptionsRow.createDiv("");
diffNavContainer.addClass("diff-nav");
@@ -122,7 +122,7 @@ export class ConflictResolveModal extends Modal {
e.addClass("diff-nav-btn");
e.addEventListener("click", () => this.navigateDiff("next"));
});
this.diffNavIndicator = diffNavContainer.createEl("span", { text: "\u2014" });
this.diffNavIndicator = diffNavContainer.createSpan({ text: "\u2014" });
this.diffNavIndicator.addClass("diff-nav-indicator");
this.diffView = contentEl.createDiv("");
src/modules/features/SettingDialogue/ObsidianLiveSyncSettingTab.ts
+1 -1
View File
@@ -736,7 +736,7 @@ export class ObsidianLiveSyncSettingTab extends PluginSettingTab {
value: `${order}`,
cls: "sls-setting-tab",
} as DomElementInfo);
el.createEl("div", {
el.createDiv({
cls: "sls-setting-menu-btn",
text: icon,
title: title,
src/modules/features/SettingDialogue/PanePatches.ts
+1 -1
View File
@@ -188,7 +188,7 @@ export function panePatches(this: ObsidianLiveSyncSettingTab, paneEl: HTMLElemen
}
this.requestUpdate();
};
text.inputEl.before((dateEl = activeDocument.createElement("span")));
text.inputEl.before((dateEl = activeDocument.createSpan()));
text.inputEl.type = "datetime-local";
if (this.editingSettings.maxMTimeForReflectEvents > 0) {
const date = new Date(this.editingSettings.maxMTimeForReflectEvents);
src/modules/features/SettingDialogue/PaneRemoteConfig.ts
+1 -133
View File
@@ -16,13 +16,7 @@ import type { PageFunctions } from "./SettingPane.ts";
import InfoPanel from "./InfoPanel.svelte";
import { writable } from "svelte/store";
import { SveltePanel } from "./SveltePanel.ts";
import {
getBucketConfigSummary,
getP2PConfigSummary,
getCouchDBConfigSummary,
getE2EEConfigSummary,
} from "./settingUtils.ts";
import { SETTING_KEY_P2P_DEVICE_NAME } from "@vrtmrz/livesync-commonlib/compat/common/types";
import { getE2EEConfigSummary } from "./settingUtils.ts";
import { SetupManager, UserMode } from "@/modules/features/SetupManager.ts";
import { OnDialogSettingsDefault, type AllSettings } from "./settingConstants.ts";
import { activateRemoteConfiguration } from "@vrtmrz/livesync-commonlib/compat/serviceFeatures/remoteConfig";
@@ -43,15 +37,6 @@ function getSettingsFromEditingSettings(editingSettings: AllSettings): ObsidianL
}
return workObj;
}
const toggleActiveSyncClass = (el: HTMLElement, isActive: () => boolean) => {
if (isActive()) {
el.addClass("active-pane");
} else {
el.removeClass("active-pane");
}
return {};
};
function createRemoteConfigurationId(): string {
return `remote-${Date.now().toString(36)}-${Math.random().toString(36).slice(2, 8)}`;
}
@@ -517,123 +502,6 @@ export function paneRemoteConfig(
refreshList();
});
}
// eslint-disable-next-line no-constant-condition
if (false) {
const initialProps = {
info: getCouchDBConfigSummary(this.editingSettings),
};
const summaryWritable = writable(initialProps);
const updateSummary = () => {
summaryWritable.set({
info: getCouchDBConfigSummary(this.editingSettings),
});
};
void addPanel(paneEl, $msg("obsidianLiveSyncSettingTab.titleCouchDB"), () => {}).then((paneEl) => {
new SveltePanel(InfoPanel, paneEl, summaryWritable);
const setupButton = new Setting(paneEl).setName("Configure Remote");
setupButton
.addButton((button) =>
button
.setButtonText("Configure")
.setCta()
.onClick(async () => {
const setupManager = this.core.getModule(SetupManager);
const originalSettings = getSettingsFromEditingSettings(this.editingSettings);
await setupManager.onCouchDBManualSetup(
UserMode.Update,
originalSettings,
this.editingSettings.remoteType === REMOTE_COUCHDB
);
updateSummary();
})
)
.addOnUpdate(() =>
toggleActiveSyncClass(paneEl, () => this.editingSettings.remoteType === REMOTE_COUCHDB)
);
});
}
// eslint-disable-next-line no-constant-condition
if (false) {
const initialProps = {
info: getBucketConfigSummary(this.editingSettings),
};
const summaryWritable = writable(initialProps);
const updateSummary = () => {
summaryWritable.set({
info: getBucketConfigSummary(this.editingSettings),
});
};
void addPanel(paneEl, $msg("obsidianLiveSyncSettingTab.titleMinioS3R2"), () => {}).then((paneEl) => {
new SveltePanel(InfoPanel, paneEl, summaryWritable);
const setupButton = new Setting(paneEl).setName("Configure Remote");
setupButton
.addButton((button) =>
button
.setButtonText("Configure")
.setCta()
.onClick(async () => {
const setupManager = this.core.getModule(SetupManager);
const originalSettings = getSettingsFromEditingSettings(this.editingSettings);
await setupManager.onBucketManualSetup(
UserMode.Update,
originalSettings,
this.editingSettings.remoteType === REMOTE_MINIO
);
//TODO
updateSummary();
})
)
.addOnUpdate(() =>
toggleActiveSyncClass(paneEl, () => this.editingSettings.remoteType === REMOTE_MINIO)
);
});
}
// eslint-disable-next-line no-constant-condition
if (false) {
const getDevicePeerId = () => this.services.config.getSmallConfig(SETTING_KEY_P2P_DEVICE_NAME) || "";
const initialProps = {
info: getP2PConfigSummary(this.editingSettings, {
"Device Peer ID": getDevicePeerId(),
}),
};
const summaryWritable = writable(initialProps);
const updateSummary = () => {
summaryWritable.set({
info: getP2PConfigSummary(this.editingSettings, {
"Device Peer ID": getDevicePeerId(),
}),
});
};
void addPanel(paneEl, "Peer-to-Peer Synchronisation", () => {}).then((paneEl) => {
new SveltePanel(InfoPanel, paneEl, summaryWritable);
const setupButton = new Setting(paneEl).setName("Configure Remote");
setupButton
.addButton((button) =>
button
.setButtonText("Configure")
.setCta()
.onClick(async () => {
const setupManager = this.core.getModule(SetupManager);
const originalSettings = getSettingsFromEditingSettings(this.editingSettings);
await setupManager.onP2PManualSetup(
UserMode.Update,
originalSettings,
this.editingSettings.remoteType === REMOTE_P2P
);
//TODO
updateSummary();
})
)
.addOnUpdate(() =>
toggleActiveSyncClass(
paneEl,
() => this.editingSettings.remoteType === REMOTE_P2P || this.editingSettings.P2P_Enabled
)
);
});
}
// new Setting(paneEl)
// .setDesc("Generate ES256 Keypair for testing")
// .addButton((button) =>
src/modules/features/SetupManager.ts
+1 -1
View File
@@ -60,7 +60,7 @@ export const enum UserMode {
/**
* Update User Mode - for users who are updating configuration. May be `existing-user` as well, but possibly they want to treat it differently.
*/
// eslint-disable-next-line @typescript-eslint/no-duplicate-enum-values
// eslint-disable-next-line @typescript-eslint/no-duplicate-enum-values -- Update is a semantic alias for the unknown setup mode.
Update = "unknown", // Alias for Unknown for better readability
}
src/modules/services/ObsidianConfirm.ts
+1 -1
View File
@@ -71,7 +71,7 @@ export class ObsidianConfirm<T extends ObsidianServiceContext = ObsidianServiceC
askInPopup(key: string, dialogText: string, anchorCallback: (anchor: HTMLAnchorElement) => void) {
const fragment = createFragment((doc) => {
const [beforeText, afterText] = dialogText.split("{HERE}", 2);
doc.createEl("span", undefined, (a) => {
doc.createSpan(undefined, (a) => {
a.appendText(beforeText);
a.appendChild(
a.createEl("a", undefined, (anchor) => {
src/serviceFeatures/onLayoutReady/enablei18n.ts
+8 -8
View File
@@ -1,17 +1,17 @@
import { getLanguage } from "@/deps";
import { getLanguage, requireApiVersion } from "@/deps";
import { createServiceFeature } from "@vrtmrz/livesync-commonlib/compat/interfaces/ServiceModule";
import { SUPPORTED_I18N_LANGS, type I18N_LANGS } from "@vrtmrz/livesync-commonlib/compat/common/rosetta";
import { $msg, __onMissingTranslation, setLang } from "@vrtmrz/livesync-commonlib/compat/common/i18n";
function tryGetLanguage() {
try {
// Note: 1.8.7+ is required. but it is 18, Feb., 2025. we want to fallback on earlier versions, so we catch the error here.
// eslint-disable-next-line obsidianmd/no-unsupported-api
return getLanguage();
} catch (e) {
console.error("Failed to get Obsidian language, defaulting to 'def'", e);
return "en";
if (requireApiVersion("1.8.7")) {
try {
return getLanguage();
} catch (e) {
console.error("Failed to get Obsidian language, defaulting to 'en'", e);
}
}
return "en";
}
export const enableI18nFeature = createServiceFeature(async ({ services: { setting, API } }) => {
src/serviceModules/FileSystemAdapters/ObsidianVaultAdapter.ts
+4 -14
View File
@@ -41,22 +41,12 @@ export class ObsidianVaultAdapter implements IVaultAdapter<TFile, TFolder> {
return await this.app.vault.rename(file, newPath);
}
async delete(file: TFile | TFolder, force = false): Promise<void> {
if ("trashFile" in this.app.fileManager) {
// eslint-disable-next-line obsidianmd/no-unsupported-api
return await this.app.fileManager.trashFile(file);
}
// eslint-disable-next-line obsidianmd/prefer-file-manager-trash-file -- Fallback for older versions of Obsidian without trashFile support
return await this.app.vault.delete(file, force);
async delete(file: TFile | TFolder): Promise<void> {
return await this.app.fileManager.trashFile(file);
}
async trash(file: TFile | TFolder, force = false): Promise<void> {
if ("trashFile" in this.app.fileManager) {
// eslint-disable-next-line obsidianmd/no-unsupported-api
return await this.app.fileManager.trashFile(file);
}
// eslint-disable-next-line obsidianmd/prefer-file-manager-trash-file -- Fallback for older versions of Obsidian without trashFile support
return await this.app.vault.trash(file, force);
async trash(file: TFile | TFolder): Promise<void> {
return await this.app.fileManager.trashFile(file);
}
trigger(name: string, ...data: unknown[]): void {