@vrtmrz/livesync-commonlib 0.1.0-rc.0

package/dist/common/models/setting.const.defaults.js

@@ -0,0 +1,185 @@
+import { ChunkAlgorithms, CURRENT_SETTING_VERSION, E2EEAlgorithms, REMOTE_COUCHDB } from "./setting.const.js";
+import { AutoAccepting } from "./setting.type.js";
+const P2P_DEFAULT_SETTINGS = {
+  P2P_Enabled: false,
+  P2P_AutoAccepting: AutoAccepting.NONE,
+  P2P_AppID: "self-hosted-livesync",
+  P2P_roomID: "",
+  P2P_passphrase: "",
+  P2P_relays: "wss://exp-relay.vrtmrz.net/",
+  P2P_AutoBroadcast: false,
+  P2P_AutoStart: false,
+  P2P_AutoSyncPeers: "",
+  P2P_AutoWatchPeers: "",
+  P2P_SyncOnReplication: "",
+  P2P_RebuildFrom: "",
+  P2P_AutoAcceptingPeers: "",
+  P2P_AutoDenyingPeers: "",
+  P2P_IsHeadless: false,
+  P2P_DevicePeerName: "",
+  P2P_turnServers: "",
+  P2P_turnUsername: "",
+  P2P_turnCredential: "",
+  P2P_useDiagRTC: false
+};
+const DEFAULT_SETTINGS = {
+  remoteType: REMOTE_COUCHDB,
+  useCustomRequestHandler: false,
+  couchDB_URI: "",
+  couchDB_USER: "",
+  couchDB_PASSWORD: "",
+  couchDB_DBNAME: "",
+  liveSync: false,
+  syncOnSave: false,
+  syncOnStart: false,
+  savingDelay: 200,
+  lessInformationInLog: false,
+  gcDelay: 300,
+  versionUpFlash: "",
+  minimumChunkSize: 20,
+  longLineThreshold: 250,
+  showVerboseLog: false,
+  suspendFileWatching: false,
+  trashInsteadDelete: true,
+  periodicReplication: false,
+  periodicReplicationInterval: 60,
+  syncOnFileOpen: false,
+  encrypt: false,
+  passphrase: "",
+  usePathObfuscation: false,
+  doNotDeleteFolder: false,
+  resolveConflictsByNewerFile: false,
+  batchSave: false,
+  batchSaveMinimumDelay: 5,
+  batchSaveMaximumDelay: 60,
+  deviceAndVaultName: "",
+  usePluginSettings: false,
+  showOwnPlugins: false,
+  showStatusOnEditor: true,
+  showStatusOnStatusbar: true,
+  showOnlyIconsOnEditor: false,
+  hideFileWarningNotice: false,
+  networkWarningStyle: "",
+  usePluginSync: false,
+  autoSweepPlugins: false,
+  autoSweepPluginsPeriodic: false,
+  notifyPluginOrSettingUpdated: false,
+  checkIntegrityOnSave: false,
+  batch_size: 25,
+  batches_limit: 25,
+  useHistory: false,
+  disableRequestURI: false,
+  skipOlderFilesOnSync: true,
+  checkConflictOnlyOnOpen: false,
+  showMergeDialogOnlyOnActive: false,
+  syncInternalFiles: false,
+  syncInternalFilesBeforeReplication: false,
+  syncInternalFilesIgnorePatterns: "\\/node_modules\\/, \\/\\.git\\/, \\/obsidian-livesync\\/",
+  syncInternalFilesTargetPatterns: "",
+  syncInternalFilesInterval: 60,
+  additionalSuffixOfDatabaseName: "",
+  ignoreVersionCheck: false,
+  lastReadUpdates: 0,
+  deleteMetadataOfDeletedFiles: false,
+  syncIgnoreRegEx: "",
+  syncOnlyRegEx: "",
+  customChunkSize: 0,
+  readChunksOnline: true,
+  watchInternalFileChanges: true,
+  automaticallyDeleteMetadataOfDeletedFiles: 0,
+  disableMarkdownAutoMerge: false,
+  writeDocumentsIfConflicted: false,
+  useDynamicIterationCount: false,
+  syncAfterMerge: false,
+  configPassphraseStore: "",
+  encryptedPassphrase: "",
+  encryptedCouchDBConnection: "",
+  permitEmptyPassphrase: false,
+  remoteConfigurations: {},
+  activeConfigurationId: "",
+  P2P_ActiveRemoteConfigurationId: "",
+  useIndexedDBAdapter: false,
+  useTimeouts: false,
+  writeLogToTheFile: false,
+  doNotPaceReplication: false,
+  hashCacheMaxCount: 300,
+  hashCacheMaxAmount: 50,
+  concurrencyOfReadChunksOnline: 40,
+  minimumIntervalOfReadChunksOnline: 50,
+  hashAlg: "xxhash64",
+  suspendParseReplicationResult: false,
+  doNotSuspendOnFetching: false,
+  useIgnoreFiles: false,
+  ignoreFiles: ".gitignore",
+  syncOnEditorSave: false,
+  keepReplicationActiveInBackground: false,
+  pluginSyncExtendedSetting: {},
+  syncMaxSizeInMB: 50,
+  settingSyncFile: "",
+  writeCredentialsForSettingSync: false,
+  notifyAllSettingSyncFile: false,
+  isConfigured: void 0,
+  settingVersion: CURRENT_SETTING_VERSION,
+  enableCompression: false,
+  accessKey: "",
+  bucket: "",
+  endpoint: "",
+  region: "auto",
+  secretKey: "",
+  useEden: false,
+  maxChunksInEden: 10,
+  maxTotalLengthInEden: 1024,
+  maxAgeInEden: 10,
+  disableCheckingConfigMismatch: false,
+  autoAcceptCompatibleTweak: void 0,
+  displayLanguage: "",
+  /**
+   * @deprecated
+   */
+  enableChunkSplitterV2: false,
+  disableWorkerForGeneratingChunks: false,
+  processSmallFilesInUIThread: false,
+  notifyThresholdOfRemoteStorageSize: -1,
+  usePluginSyncV2: false,
+  usePluginEtc: false,
+  handleFilenameCaseSensitive: void 0,
+  doNotUseFixedRevisionForChunks: true,
+  showLongerLogInsideEditor: false,
+  sendChunksBulk: false,
+  sendChunksBulkMaxSize: 1,
+  /**
+   * @deprecated
+   * This setting is no longer used and will be removed in the future.
+   */
+  useSegmenter: false,
+  useAdvancedMode: false,
+  usePowerUserMode: false,
+  useEdgeCaseMode: false,
+  enableDebugTools: false,
+  suppressNotifyHiddenFilesChange: false,
+  syncMinimumInterval: 2e3,
+  ...P2P_DEFAULT_SETTINGS,
+  doctorProcessedVersion: "",
+  bucketCustomHeaders: "",
+  couchDB_CustomHeaders: "",
+  useJWT: false,
+  jwtAlgorithm: "",
+  jwtKey: "",
+  jwtKid: "",
+  jwtSub: "",
+  jwtExpDuration: 5,
+  useRequestAPI: false,
+  bucketPrefix: "",
+  chunkSplitterVersion: ChunkAlgorithms.RabinKarp,
+  E2EEAlgorithm: E2EEAlgorithms.V2,
+  processSizeMismatchedFiles: false,
+  forcePathStyle: true,
+  syncInternalFileOverwritePatterns: "",
+  useOnlyLocalChunk: false,
+  maxMTimeForReflectEvents: 0,
+  tweakModified: void 0
+};
+export {
+  DEFAULT_SETTINGS,
+  P2P_DEFAULT_SETTINGS
+};

package/dist/common/models/setting.const.js

@@ -0,0 +1,68 @@
+const SETTING_VERSION_INITIAL = 0;
+const SETTING_VERSION_SUPPORT_CASE_INSENSITIVE = 10;
+const CURRENT_SETTING_VERSION = SETTING_VERSION_SUPPORT_CASE_INSENSITIVE;
+const RemoteTypes = {
+  REMOTE_COUCHDB: "",
+  REMOTE_MINIO: "MINIO",
+  REMOTE_P2P: "ONLY_P2P"
+};
+const REMOTE_COUCHDB = RemoteTypes.REMOTE_COUCHDB;
+const REMOTE_MINIO = RemoteTypes.REMOTE_MINIO;
+const REMOTE_P2P = RemoteTypes.REMOTE_P2P;
+const E2EEAlgorithmNames = {
+  "": "V1: Legacy",
+  v2: "V2: AES-256-GCM With HKDF",
+  forceV1: "Force-V1: Force Legacy (Not recommended)"
+};
+const E2EEAlgorithms = {
+  V1: "",
+  V2: "v2",
+  ForceV1: "forceV1"
+};
+const HashAlgorithms = {
+  XXHASH32: "xxhash32",
+  XXHASH64: "xxhash64",
+  MIXED_PUREJS: "mixed-purejs",
+  SHA1: "sha1",
+  LEGACY: ""
+};
+const ChunkAlgorithmNames = {
+  v1: "V1: Legacy",
+  v2: "V2: Simple (Default)",
+  "v2-segmenter": "V2.5: Lexical chunks",
+  "v3-rabin-karp": "V3: Fine deduplication"
+};
+const ChunkAlgorithms = {
+  V1: "v1",
+  V2: "v2",
+  V2Segmenter: "v2-segmenter",
+  RabinKarp: "v3-rabin-karp"
+};
+const MODE_SELECTIVE = 0;
+const MODE_AUTOMATIC = 1;
+const MODE_PAUSED = 2;
+const MODE_SHINY = 3;
+const NetworkWarningStyles = {
+  BANNER: "",
+  ICON: "icon",
+  HIDDEN: "hidden"
+};
+export {
+  CURRENT_SETTING_VERSION,
+  ChunkAlgorithmNames,
+  ChunkAlgorithms,
+  E2EEAlgorithmNames,
+  E2EEAlgorithms,
+  HashAlgorithms,
+  MODE_AUTOMATIC,
+  MODE_PAUSED,
+  MODE_SELECTIVE,
+  MODE_SHINY,
+  NetworkWarningStyles,
+  REMOTE_COUCHDB,
+  REMOTE_MINIO,
+  REMOTE_P2P,
+  RemoteTypes,
+  SETTING_VERSION_INITIAL,
+  SETTING_VERSION_SUPPORT_CASE_INSENSITIVE
+};

package/dist/common/models/setting.const.preferred.d.ts

@@ -0,0 +1,5 @@
+import type { ObsidianLiveSyncSettings } from "./setting.type.js";
+export declare const PREFERRED_BASE: Partial<ObsidianLiveSyncSettings>;
+export declare const PREFERRED_SETTING_CLOUDANT: Partial<ObsidianLiveSyncSettings>;
+export declare const PREFERRED_SETTING_SELF_HOSTED: Partial<ObsidianLiveSyncSettings>;
+export declare const PREFERRED_JOURNAL_SYNC: Partial<ObsidianLiveSyncSettings>;

package/dist/common/models/setting.const.preferred.js

@@ -0,0 +1,35 @@
+import { E2EEAlgorithms } from "./setting.const.js";
+const PREFERRED_BASE = {
+  syncMaxSizeInMB: 50,
+  chunkSplitterVersion: "v3-rabin-karp",
+  doNotUseFixedRevisionForChunks: false,
+  usePluginSyncV2: true,
+  handleFilenameCaseSensitive: false,
+  E2EEAlgorithm: E2EEAlgorithms.V2
+};
+const PREFERRED_SETTING_CLOUDANT = {
+  ...PREFERRED_BASE,
+  customChunkSize: 0,
+  sendChunksBulkMaxSize: 1,
+  concurrencyOfReadChunksOnline: 100,
+  minimumIntervalOfReadChunksOnline: 333
+};
+const PREFERRED_SETTING_SELF_HOSTED = {
+  ...PREFERRED_BASE,
+  customChunkSize: 50,
+  sendChunksBulkMaxSize: 1,
+  concurrencyOfReadChunksOnline: 30,
+  minimumIntervalOfReadChunksOnline: 25
+};
+const PREFERRED_JOURNAL_SYNC = {
+  ...PREFERRED_BASE,
+  customChunkSize: 10,
+  concurrencyOfReadChunksOnline: 30,
+  minimumIntervalOfReadChunksOnline: 25
+};
+export {
+  PREFERRED_BASE,
+  PREFERRED_JOURNAL_SYNC,
+  PREFERRED_SETTING_CLOUDANT,
+  PREFERRED_SETTING_SELF_HOSTED
+};

package/dist/common/models/setting.const.qr.d.ts

@@ -0,0 +1,2 @@
+import type { ObsidianLiveSyncSettings } from "./setting.type.js";
+export declare const KeyIndexOfSettings: Record<keyof ObsidianLiveSyncSettings, number>;

package/dist/common/models/setting.const.qr.js

@@ -0,0 +1,174 @@
+const KeyIndexOfSettings = {
+  remoteType: 0,
+  useCustomRequestHandler: 1,
+  couchDB_URI: 2,
+  couchDB_USER: 3,
+  couchDB_PASSWORD: 4,
+  couchDB_DBNAME: 5,
+  minimumChunkSize: 6,
+  longLineThreshold: 7,
+  encrypt: 8,
+  passphrase: 9,
+  usePathObfuscation: 10,
+  checkIntegrityOnSave: 11,
+  batch_size: 12,
+  batches_limit: 13,
+  useHistory: 14,
+  disableRequestURI: 15,
+  checkConflictOnlyOnOpen: 16,
+  showMergeDialogOnlyOnActive: 17,
+  additionalSuffixOfDatabaseName: 18,
+  ignoreVersionCheck: 19,
+  deleteMetadataOfDeletedFiles: 20,
+  customChunkSize: 21,
+  readChunksOnline: 22,
+  automaticallyDeleteMetadataOfDeletedFiles: 23,
+  useDynamicIterationCount: 24,
+  permitEmptyPassphrase: 25,
+  useTimeouts: 26,
+  doNotPaceReplication: 27,
+  hashCacheMaxCount: 28,
+  hashCacheMaxAmount: 29,
+  concurrencyOfReadChunksOnline: 30,
+  minimumIntervalOfReadChunksOnline: 31,
+  hashAlg: 32,
+  enableCompression: 33,
+  accessKey: 34,
+  bucket: 35,
+  endpoint: 36,
+  region: 37,
+  secretKey: 38,
+  useEden: 39,
+  maxChunksInEden: 40,
+  maxTotalLengthInEden: 41,
+  maxAgeInEden: 42,
+  disableCheckingConfigMismatch: 43,
+  handleFilenameCaseSensitive: 44,
+  doNotUseFixedRevisionForChunks: 45,
+  sendChunksBulk: 46,
+  sendChunksBulkMaxSize: 47,
+  useSegmenter: 48,
+  liveSync: 49,
+  syncOnSave: 50,
+  syncOnStart: 51,
+  syncOnFileOpen: 52,
+  syncOnEditorSave: 53,
+  keepReplicationActiveInBackground: -1,
+  // Desktop-only local preference; do not encode into the QR Code.
+  syncMinimumInterval: 54,
+  showVerboseLog: 55,
+  lessInformationInLog: 56,
+  showLongerLogInsideEditor: 57,
+  showStatusOnEditor: 58,
+  showStatusOnStatusbar: 59,
+  showOnlyIconsOnEditor: 60,
+  displayLanguage: 61,
+  trashInsteadDelete: 62,
+  doNotDeleteFolder: 63,
+  batchSave: 64,
+  batchSaveMinimumDelay: 64,
+  batchSaveMaximumDelay: 65,
+  syncMaxSizeInMB: 66,
+  useIgnoreFiles: 67,
+  ignoreFiles: 68,
+  syncOnlyRegEx: 69,
+  syncIgnoreRegEx: 70,
+  syncAfterMerge: 71,
+  resolveConflictsByNewerFile: 72,
+  writeDocumentsIfConflicted: 73,
+  disableMarkdownAutoMerge: 74,
+  configPassphraseStore: 75,
+  encryptedPassphrase: 76,
+  encryptedCouchDBConnection: 77,
+  periodicReplication: 78,
+  periodicReplicationInterval: 79,
+  syncInternalFiles: 80,
+  syncInternalFilesBeforeReplication: 81,
+  syncInternalFilesInterval: 82,
+  syncInternalFilesIgnorePatterns: 83,
+  watchInternalFileChanges: 84,
+  suppressNotifyHiddenFilesChange: 85,
+  usePluginSync: 86,
+  usePluginSettings: 87,
+  showOwnPlugins: 88,
+  autoSweepPlugins: 89,
+  autoSweepPluginsPeriodic: 90,
+  notifyPluginOrSettingUpdated: 91,
+  deviceAndVaultName: 92,
+  usePluginSyncV2: 93,
+  usePluginEtc: 94,
+  pluginSyncExtendedSetting: 95,
+  useAdvancedMode: 96,
+  usePowerUserMode: 97,
+  useEdgeCaseMode: 98,
+  notifyThresholdOfRemoteStorageSize: 99,
+  disableWorkerForGeneratingChunks: 100,
+  processSmallFilesInUIThread: 101,
+  enableChunkSplitterV2: 102,
+  savingDelay: 103,
+  gcDelay: 104,
+  skipOlderFilesOnSync: 105,
+  useIndexedDBAdapter: 106,
+  enableDebugTools: 107,
+  writeLogToTheFile: 108,
+  settingSyncFile: 109,
+  writeCredentialsForSettingSync: 110,
+  notifyAllSettingSyncFile: 111,
+  suspendFileWatching: 112,
+  suspendParseReplicationResult: 113,
+  doNotSuspendOnFetching: 114,
+  versionUpFlash: 115,
+  settingVersion: 116,
+  isConfigured: 117,
+  lastReadUpdates: 118,
+  doctorProcessedVersion: 119,
+  P2P_Enabled: 120,
+  P2P_relays: 121,
+  P2P_roomID: 122,
+  P2P_passphrase: 123,
+  P2P_AutoAccepting: 124,
+  P2P_AutoStart: 125,
+  P2P_AutoBroadcast: 126,
+  P2P_AutoSyncPeers: 127,
+  P2P_AutoWatchPeers: 128,
+  P2P_SyncOnReplication: 129,
+  P2P_AppID: 130,
+  P2P_RebuildFrom: 131,
+  bucketCustomHeaders: 132,
+  couchDB_CustomHeaders: 133,
+  useJWT: 134,
+  jwtAlgorithm: 135,
+  jwtKey: 136,
+  jwtKid: 137,
+  jwtSub: 138,
+  jwtExpDuration: 139,
+  P2P_AutoAcceptingPeers: 140,
+  P2P_AutoDenyingPeers: 141,
+  P2P_IsHeadless: -1,
+  syncInternalFilesTargetPatterns: 142,
+  useRequestAPI: 143,
+  hideFileWarningNotice: 144,
+  bucketPrefix: 145,
+  chunkSplitterVersion: 146,
+  E2EEAlgorithm: 147,
+  processSizeMismatchedFiles: 148,
+  forcePathStyle: 149,
+  P2P_DevicePeerName: -1,
+  P2P_turnServers: 150,
+  P2P_turnUsername: 151,
+  P2P_turnCredential: 152,
+  syncInternalFileOverwritePatterns: 153,
+  useOnlyLocalChunk: 154,
+  maxMTimeForReflectEvents: 155,
+  networkWarningStyle: 156,
+  remoteConfigurations: 157,
+  activeConfigurationId: 158,
+  P2P_ActiveRemoteConfigurationId: 159,
+  autoAcceptCompatibleTweak: 160,
+  tweakModified: -1,
+  P2P_useDiagRTC: -1
+  // Do not encode into the QR Code.
+};
+export {
+  KeyIndexOfSettings
+};