@vrtmrz/livesync-commonlib 0.1.0-rc.0

package/dist/common/models/tweak.definition.js

@@ -0,0 +1,77 @@
+import { ChunkAlgorithms, E2EEAlgorithms } from "./setting.const.js";
+import { DEFAULT_SETTINGS } from "./setting.const.defaults.js";
+const TweakValuesShouldMatchedTemplate = {
+  minimumChunkSize: 20,
+  longLineThreshold: 250,
+  encrypt: false,
+  usePathObfuscation: false,
+  enableCompression: false,
+  useEden: false,
+  customChunkSize: 0,
+  useDynamicIterationCount: false,
+  hashAlg: "xxhash64",
+  enableChunkSplitterV2: false,
+  maxChunksInEden: 10,
+  maxTotalLengthInEden: 1024,
+  maxAgeInEden: 10,
+  usePluginSyncV2: false,
+  handleFilenameCaseSensitive: false,
+  doNotUseFixedRevisionForChunks: true,
+  useSegmenter: false,
+  E2EEAlgorithm: E2EEAlgorithms.V2,
+  chunkSplitterVersion: ChunkAlgorithms.RabinKarp
+};
+const IncompatibleChanges = [
+  "encrypt",
+  "usePathObfuscation",
+  "useDynamicIterationCount",
+  "handleFilenameCaseSensitive"
+];
+const CompatibleButLossyChanges = ["hashAlg", "customChunkSize", "chunkSplitterVersion"];
+const IncompatibleChangesInSpecificPattern = [
+  { key: "doNotUseFixedRevisionForChunks", from: true, to: false, isRecommendation: true },
+  { key: "doNotUseFixedRevisionForChunks", to: true, isRecommendation: false }
+];
+const TweakValuesRecommendedTemplate = {
+  useIgnoreFiles: false,
+  useCustomRequestHandler: false,
+  batch_size: 25,
+  batches_limit: 25,
+  // useIndexedDBAdapter: false,
+  useTimeouts: false,
+  readChunksOnline: true,
+  hashCacheMaxCount: 300,
+  hashCacheMaxAmount: 50,
+  concurrencyOfReadChunksOnline: 40,
+  minimumIntervalOfReadChunksOnline: 50,
+  ignoreFiles: ".gitignore",
+  syncMaxSizeInMB: 50,
+  enableChunkSplitterV2: false,
+  usePluginSyncV2: true,
+  handleFilenameCaseSensitive: false,
+  doNotUseFixedRevisionForChunks: false,
+  E2EEAlgorithm: E2EEAlgorithms.V2,
+  chunkSplitterVersion: ChunkAlgorithms.RabinKarp
+};
+const TweakValuesDefault = {
+  usePluginSyncV2: false,
+  E2EEAlgorithm: DEFAULT_SETTINGS.E2EEAlgorithm,
+  chunkSplitterVersion: DEFAULT_SETTINGS.chunkSplitterVersion,
+  tweakModified: DEFAULT_SETTINGS.tweakModified
+};
+const TweakValuesTemplate = {
+  ...TweakValuesRecommendedTemplate,
+  ...TweakValuesShouldMatchedTemplate,
+  tweakModified: 0
+};
+const DEVICE_ID_PREFERRED = "PREFERRED";
+export {
+  CompatibleButLossyChanges,
+  DEVICE_ID_PREFERRED,
+  IncompatibleChanges,
+  IncompatibleChangesInSpecificPattern,
+  TweakValuesDefault,
+  TweakValuesRecommendedTemplate,
+  TweakValuesShouldMatchedTemplate,
+  TweakValuesTemplate
+};

package/dist/common/rosetta.d.ts

@@ -0,0 +1,42 @@
+/**
+# Rosetta stone
+- To localise messages to your language, please write a translation to this file and submit a PR.
+- Please order languages in alphabetic order, if you write multiple items.
+
+## Notice to ensure that your favours are not wasted.
+
+If you plan to utilise machine translation engines to contribute translated resources,
+please ensure the engine's terms of service are compatible with our project's license.
+Your diligence in this matter helps maintain compliance and avoid potential licensing issues.
+Thank you for your consideration.
+
+Usually, our projects (Self-hosted LiveSync and its families) are licensed under MIT License.
+To see details, please refer to the LICENSES file on each repository.
+
+## How to internationalise untranslated items?
+1. Change the message literal to use `$msg`
+   "Could not parse YAML" -> $msg('anyKey')
+2. Create `ls-debug` folder under the `.obsidian` folder of your vault.
+3. Run Self-hosted LiveSync in dev mode (npm run dev).
+4. You will get the `missing-translation-YYYY-MM-DD.jsonl` under `ls-debug`. Please copy and paste inside `allMessages` and write the translations.
+5. Send me the PR!
+*/
+declare const LANG_DE = "de";
+declare const LANG_ES = "es";
+declare const LANG_FR = "fr";
+declare const LANG_HE = "he";
+declare const LANG_JA = "ja";
+declare const LANG_RU = "ru";
+declare const LANG_ZH = "zh";
+declare const LANG_KO = "ko";
+declare const LANG_ZH_TW = "zh-tw";
+declare const LANG_DEF = "def";
+export declare const SUPPORTED_I18N_LANGS: string[];
+export type I18N_LANGS = typeof LANG_DEF | typeof LANG_DE | typeof LANG_ES | typeof LANG_FR | typeof LANG_HE | typeof LANG_JA | typeof LANG_KO | typeof LANG_RU | typeof LANG_ZH | typeof LANG_ZH_TW | "";
+export type MESSAGE = {
+    [key in I18N_LANGS]?: string;
+};
+import type { MessageKeys } from "./messages/combinedMessages.dev.js";
+export declare function expandKeywords<T extends Record<string, U>, U extends Record<string, string>>(message: T, lang: I18N_LANGS, recurseLimit?: number): T;
+export type AllMessageKeys = MessageKeys;
+export {};

package/dist/common/rosetta.js

@@ -0,0 +1,57 @@
+const LANG_DE = "de";
+const LANG_ES = "es";
+const LANG_FR = "fr";
+const LANG_HE = "he";
+const LANG_JA = "ja";
+const LANG_RU = "ru";
+const LANG_ZH = "zh";
+const LANG_KO = "ko";
+const LANG_ZH_TW = "zh-tw";
+const LANG_DEF = "def";
+const SUPPORTED_I18N_LANGS = [
+  LANG_DEF,
+  LANG_DE,
+  LANG_ES,
+  LANG_FR,
+  LANG_HE,
+  LANG_JA,
+  LANG_KO,
+  LANG_RU,
+  LANG_ZH,
+  LANG_ZH_TW
+];
+import { Logger } from "./logger.js";
+function expandKeywords(message, lang, recurseLimit = 10) {
+  if (recurseLimit <= 0) {
+    Logger(
+      `ExpandKeywords hit the recursion limit, returning the current state. but this is not expected. May recursive referenced.`
+    );
+    return message;
+  }
+  const keywordMap = /* @__PURE__ */ new Map();
+  for (const [key, value] of Object.entries(message)) {
+    const messageValue = value[lang];
+    if (typeof messageValue !== "string") continue;
+    const normalizedKey = key.startsWith("K.") ? key.substring("K.".length) : key;
+    keywordMap.set(`%{${normalizedKey}}`, messageValue);
+  }
+  const ret = {
+    ...message
+  };
+  let isChanged = false;
+  for (const key of Object.keys(message)) {
+    if (!(lang in ret[key])) continue;
+    if (!ret[key][lang].includes("%{")) continue;
+    const replaced = ret[key][lang].replace(/%\{[^}]+\}/g, (token) => keywordMap.get(token) ?? token);
+    if (replaced !== ret[key][lang]) {
+      ret[key][lang] = replaced;
+      isChanged = true;
+    }
+  }
+  if (isChanged) return expandKeywords(ret, lang, recurseLimit--);
+  return ret;
+}
+export {
+  SUPPORTED_I18N_LANGS,
+  expandKeywords
+};

package/dist/common/settingConstants.d.ts

@@ -0,0 +1,216 @@
+import { type ConfigurationItem, type ObsidianLiveSyncSettings } from "./types.js";
+type ExtractPropertiesByType<T, U> = {
+    [K in keyof T as T[K] extends U ? K : never]: T[K] extends U ? K : never;
+};
+export type FilterStringKeys<T> = keyof ExtractPropertiesByType<T, string | undefined>;
+export type FilterBooleanKeys<T> = keyof ExtractPropertiesByType<T, boolean | undefined>;
+export type FilterNumberKeys<T> = keyof ExtractPropertiesByType<T, number | undefined>;
+import type { FilePath, FilePathWithPrefixLC, FilePathWithPrefix, DocumentID } from "./models/db.type.js";
+export type { FilePath, FilePathWithPrefixLC, FilePathWithPrefix, DocumentID };
+/**
+ * Self-hosted LiveSync settings pane items.
+ */
+export type OnDialogSettings = {
+    configPassphrase: string;
+    preset: "" | "PERIODIC" | "LIVESYNC" | "DISABLE";
+    syncMode: "ONEVENTS" | "PERIODIC" | "LIVESYNC";
+    dummy: number;
+    deviceAndVaultName: string;
+};
+/**
+ * Default settings for the OnDialogSettings.
+ * Not used for the common library, but used for the Obsidian plugin.
+ */
+export declare const OnDialogSettingsDefault: OnDialogSettings;
+export declare const AllSettingDefault: {
+    configPassphrase: string;
+    preset: "" | "PERIODIC" | "LIVESYNC" | "DISABLE";
+    syncMode: "ONEVENTS" | "PERIODIC" | "LIVESYNC";
+    dummy: number;
+    deviceAndVaultName: string;
+    liveSync: boolean;
+    syncOnSave: boolean;
+    syncOnStart: boolean;
+    syncOnFileOpen: boolean;
+    syncOnEditorSave: boolean;
+    keepReplicationActiveInBackground: boolean;
+    syncMinimumInterval: number;
+    showVerboseLog: boolean;
+    lessInformationInLog: boolean;
+    showLongerLogInsideEditor: boolean;
+    showStatusOnEditor: boolean;
+    showStatusOnStatusbar: boolean;
+    showOnlyIconsOnEditor: boolean;
+    hideFileWarningNotice: boolean;
+    networkWarningStyle: "" | "icon" | "hidden";
+    displayLanguage: import("./rosetta.js").I18N_LANGS;
+    trashInsteadDelete: boolean;
+    doNotDeleteFolder: boolean;
+    batchSave: boolean;
+    batchSaveMinimumDelay: number;
+    batchSaveMaximumDelay: number;
+    syncMaxSizeInMB: number;
+    useIgnoreFiles: boolean;
+    ignoreFiles: string;
+    processSizeMismatchedFiles: boolean;
+    syncOnlyRegEx: import("./types.js").CustomRegExpSourceList<"|[]|">;
+    syncIgnoreRegEx: import("./types.js").CustomRegExpSourceList<"|[]|">;
+    syncAfterMerge: boolean;
+    resolveConflictsByNewerFile: boolean;
+    writeDocumentsIfConflicted: boolean;
+    disableMarkdownAutoMerge: boolean;
+    configPassphraseStore: import("./types.js").ConfigPassphraseStore;
+    encryptedPassphrase: string;
+    encryptedCouchDBConnection: string;
+    periodicReplication: boolean;
+    periodicReplicationInterval: number;
+    syncInternalFiles: boolean;
+    syncInternalFilesBeforeReplication: boolean;
+    syncInternalFilesInterval: number;
+    syncInternalFilesIgnorePatterns: import("./types.js").CustomRegExpSourceList<",">;
+    syncInternalFilesTargetPatterns: import("./types.js").CustomRegExpSourceList<",">;
+    watchInternalFileChanges: boolean;
+    suppressNotifyHiddenFilesChange: boolean;
+    syncInternalFileOverwritePatterns: import("./types.js").CustomRegExpSourceList<",">;
+    usePluginSync: boolean;
+    usePluginSettings: boolean;
+    showOwnPlugins: boolean;
+    autoSweepPlugins: boolean;
+    autoSweepPluginsPeriodic: boolean;
+    notifyPluginOrSettingUpdated: boolean;
+    usePluginSyncV2: boolean;
+    usePluginEtc: boolean;
+    pluginSyncExtendedSetting: Record<import("./types.js").PluginSyncSettingEntry["key"], import("./types.js").PluginSyncSettingEntry>;
+    useAdvancedMode: boolean;
+    usePowerUserMode: boolean;
+    useEdgeCaseMode: boolean;
+    notifyThresholdOfRemoteStorageSize: number;
+    disableWorkerForGeneratingChunks: boolean;
+    processSmallFilesInUIThread: boolean;
+    savingDelay: number;
+    gcDelay: number;
+    skipOlderFilesOnSync: boolean;
+    useIndexedDBAdapter: boolean;
+    enableDebugTools: boolean;
+    writeLogToTheFile: boolean;
+    settingSyncFile: string;
+    writeCredentialsForSettingSync: boolean;
+    notifyAllSettingSyncFile: boolean;
+    suspendFileWatching: boolean;
+    suspendParseReplicationResult: boolean;
+    doNotSuspendOnFetching: boolean;
+    maxMTimeForReflectEvents: number;
+    versionUpFlash: string;
+    settingVersion: number;
+    isConfigured?: boolean;
+    lastReadUpdates: number;
+    doctorProcessedVersion: string;
+    remoteConfigurations: Record<string, import("./models/setting.type.js").RemoteConfiguration>;
+    activeConfigurationId: string;
+    P2P_ActiveRemoteConfigurationId: string;
+    couchDB_URI: string;
+    couchDB_USER: string;
+    couchDB_PASSWORD: string;
+    couchDB_DBNAME: string;
+    couchDB_CustomHeaders: string;
+    useJWT: boolean;
+    jwtAlgorithm: import("./models/auth.type.js").JWTAlgorithm;
+    jwtKey: string;
+    jwtKid: string;
+    jwtSub: string;
+    jwtExpDuration: number;
+    useRequestAPI: boolean;
+    accessKey: string;
+    secretKey: string;
+    bucket: string;
+    region: string;
+    endpoint: string;
+    useCustomRequestHandler: boolean;
+    bucketCustomHeaders: string;
+    bucketPrefix: string;
+    forcePathStyle: boolean;
+    remoteType: import("./types.js").RemoteType;
+    encrypt: boolean;
+    passphrase: string;
+    usePathObfuscation: boolean;
+    E2EEAlgorithm: import("./types.js").E2EEAlgorithm;
+    hashAlg: import("./types.js").HashAlgorithm;
+    minimumChunkSize: number;
+    customChunkSize: number;
+    longLineThreshold: number;
+    useSegmenter: boolean;
+    enableChunkSplitterV2: boolean;
+    doNotUseFixedRevisionForChunks: boolean;
+    chunkSplitterVersion: import("./types.js").ChunkSplitterVersion;
+    useEden: boolean;
+    maxChunksInEden: number;
+    maxTotalLengthInEden: number;
+    maxAgeInEden: number;
+    tweakModified: number | undefined;
+    checkIntegrityOnSave: boolean;
+    useHistory: boolean;
+    disableRequestURI: boolean;
+    sendChunksBulk: boolean;
+    sendChunksBulkMaxSize: number;
+    useDynamicIterationCount: boolean;
+    doNotPaceReplication: boolean;
+    readChunksOnline: boolean;
+    useOnlyLocalChunk: boolean;
+    concurrencyOfReadChunksOnline: number;
+    minimumIntervalOfReadChunksOnline: number;
+    enableCompression: boolean;
+    batch_size: number;
+    batches_limit: number;
+    ignoreVersionCheck: boolean;
+    disableCheckingConfigMismatch: boolean;
+    autoAcceptCompatibleTweak: boolean | undefined;
+    hashCacheMaxCount: number;
+    hashCacheMaxAmount: number;
+    permitEmptyPassphrase: boolean;
+    handleFilenameCaseSensitive: boolean;
+    checkConflictOnlyOnOpen: boolean;
+    showMergeDialogOnlyOnActive: boolean;
+    additionalSuffixOfDatabaseName: string | undefined;
+    useTimeouts: boolean;
+    deleteMetadataOfDeletedFiles: boolean;
+    automaticallyDeleteMetadataOfDeletedFiles: number;
+    P2P_AutoAccepting: import("./types.js").AutoAccepting;
+    P2P_AutoSyncPeers: string;
+    P2P_AutoWatchPeers: string;
+    P2P_SyncOnReplication: string;
+    P2P_RebuildFrom: string;
+    P2P_AutoAcceptingPeers: string;
+    P2P_AutoDenyingPeers: string;
+    P2P_IsHeadless?: boolean;
+    P2P_Enabled: boolean;
+    P2P_relays: string;
+    P2P_roomID: string;
+    P2P_passphrase: string;
+    P2P_AppID: string;
+    P2P_AutoStart: boolean;
+    P2P_AutoBroadcast: boolean;
+    P2P_DevicePeerName?: string;
+    P2P_turnServers: string;
+    P2P_turnUsername: string;
+    P2P_turnCredential: string;
+    P2P_useDiagRTC?: boolean;
+};
+export type AllSettings = ObsidianLiveSyncSettings & OnDialogSettings;
+export type AllStringItemKey = FilterStringKeys<AllSettings>;
+export type AllNumericItemKey = FilterNumberKeys<AllSettings>;
+export type AllBooleanItemKey = FilterBooleanKeys<AllSettings>;
+export type AllSettingItemKey = AllStringItemKey | AllNumericItemKey | AllBooleanItemKey;
+export type ValueOf<T extends AllSettingItemKey> = T extends AllStringItemKey ? string : T extends AllNumericItemKey ? number : T extends AllBooleanItemKey ? boolean : AllSettings[T];
+export declare const SettingInformation: Partial<Record<keyof AllSettings, ConfigurationItem>>;
+type SettingLabelTranslator = (message: string) => string;
+export declare function getConfig(key: AllSettingItemKey, translate?: SettingLabelTranslator): false | {
+    name: string;
+    desc?: string;
+    placeHolder?: string;
+    status?: "BETA" | "ALPHA" | "EXPERIMENTAL";
+    obsolete?: boolean;
+    level?: import("./types.js").ConfigLevel;
+    isHidden?: boolean;
+    isAdvanced?: boolean;
+};
+export declare function getConfName(key: AllSettingItemKey, translate?: SettingLabelTranslator): string;