zen-fs-config 0.5.44 → 0.5.45

package/dist/index.d.mts

@@ -347,6 +347,20 @@ interface AppDataGroupDescriptor {
     groupType: 'data-sync';
     backends: AppDataBackendDescriptor[];
 }
+/** Per-backend sync state of a data group. */
+interface BackendSyncState {
+    backendId: string;
+    /** Pair id when the backend instance was created and paired successfully. */
+    pairId?: string;
+    /**
+     * Present when this descriptor could not be connected (e.g. a required
+     * option is missing), so no sync pair exists for it.
+     */
+    error?: {
+        message: string;
+        timestamp: number;
+    };
+}
 /** Handle to a data-sync group, providing direct fs access. */
 interface AppDataGroup {
     readonly groupId: string;
@@ -355,6 +369,11 @@ interface AppDataGroup {
     readonly fs: typeof node_fs;
     /** Get sync status for this data group's sync pairs. */
     getSyncStatuses(): Map<string, SyncPairStatus>;
+    /**
+     * Per-backend sync state, including descriptors that failed to connect and
+     * therefore have no pair (they do not appear in getSyncStatuses()).
+     */
+    getBackendSyncStates(): Map<string, BackendSyncState>;
     /** Manually flush pending sync. */
     flush(): Promise<SyncResult[]>;
     /** Stop sync and release resources. */
@@ -1141,4 +1160,4 @@ declare function incrementVersion(fs: SyncableFS, configFilePath: string, newCon
  */
 declare function verifyOrRepairVersion(fs: SyncableFS, configFilePath: string, author: string): Promise<VersionMeta | null>;
 
-export { type AppDataBackendDescriptor, type AppDataGroup, type AppDataGroupDescriptor, type BackendDescriptor, type BackendFactory, type BackendInstance, type BackendMetadata, type BackendParamDef, type BackendsMeta, type CacheOptions, ConfigRepo, type ConfigRepoOptions, type ConfigSerializer, type ConflictArchive, type ConflictInfo, type ConnectOptions, type ConnectResult, FolderStore, type IConfigRepo, type KeepPurgeResult, LOCAL_IDB_BACKEND_ID, type MigrateLocalFS, type MigrateReplicaFS, type MtimePurgeResult, type PurgeKeepOptions, type PurgeMtimeOptions, type PurgeableFS$1 as PurgeableFS, type SyncGroupType, type TombstoneMeta, type VersionMeta, type VersionMigrationOptions, type VersionMigrationResult, configKeyToFilePath, connect, createBackend, createConfigRepo, createSerializerChain, getAccountFields, getBackendMetadata, getExtension, hasBackend, incrementVersion, isBrowserEnv, isKeepFile, isMtimeSidecar, legacyVersionPathFor, listBackendMetadata, listBackends, localPrimaryType, mergeAccountFields, migrateVersionSidecars, purgeKeepFiles, purgeMtimeSidecars, readVersion, registerBackend, registerFolderBackend, resolveLocalPrimary, sha256, unregisterBackend, verifyOrRepairVersion, versionPathFor, wrapZenFSFileSystem, writeVersion };
+export { type AppDataBackendDescriptor, type AppDataGroup, type AppDataGroupDescriptor, type BackendDescriptor, type BackendFactory, type BackendInstance, type BackendMetadata, type BackendParamDef, type BackendSyncState, type BackendsMeta, type CacheOptions, ConfigRepo, type ConfigRepoOptions, type ConfigSerializer, type ConflictArchive, type ConflictInfo, type ConnectOptions, type ConnectResult, FolderStore, type IConfigRepo, type KeepPurgeResult, LOCAL_IDB_BACKEND_ID, type MigrateLocalFS, type MigrateReplicaFS, type MtimePurgeResult, type PurgeKeepOptions, type PurgeMtimeOptions, type PurgeableFS$1 as PurgeableFS, type SyncGroupType, type TombstoneMeta, type VersionMeta, type VersionMigrationOptions, type VersionMigrationResult, configKeyToFilePath, connect, createBackend, createConfigRepo, createSerializerChain, getAccountFields, getBackendMetadata, getExtension, hasBackend, incrementVersion, isBrowserEnv, isKeepFile, isMtimeSidecar, legacyVersionPathFor, listBackendMetadata, listBackends, localPrimaryType, mergeAccountFields, migrateVersionSidecars, purgeKeepFiles, purgeMtimeSidecars, readVersion, registerBackend, registerFolderBackend, resolveLocalPrimary, sha256, unregisterBackend, verifyOrRepairVersion, versionPathFor, wrapZenFSFileSystem, writeVersion };

package/dist/index.d.ts

@@ -347,6 +347,20 @@ interface AppDataGroupDescriptor {
     groupType: 'data-sync';
     backends: AppDataBackendDescriptor[];
 }
+/** Per-backend sync state of a data group. */
+interface BackendSyncState {
+    backendId: string;
+    /** Pair id when the backend instance was created and paired successfully. */
+    pairId?: string;
+    /**
+     * Present when this descriptor could not be connected (e.g. a required
+     * option is missing), so no sync pair exists for it.
+     */
+    error?: {
+        message: string;
+        timestamp: number;
+    };
+}
 /** Handle to a data-sync group, providing direct fs access. */
 interface AppDataGroup {
     readonly groupId: string;
@@ -355,6 +369,11 @@ interface AppDataGroup {
     readonly fs: typeof node_fs;
     /** Get sync status for this data group's sync pairs. */
     getSyncStatuses(): Map<string, SyncPairStatus>;
+    /**
+     * Per-backend sync state, including descriptors that failed to connect and
+     * therefore have no pair (they do not appear in getSyncStatuses()).
+     */
+    getBackendSyncStates(): Map<string, BackendSyncState>;
     /** Manually flush pending sync. */
     flush(): Promise<SyncResult[]>;
     /** Stop sync and release resources. */
@@ -1141,4 +1160,4 @@ declare function incrementVersion(fs: SyncableFS, configFilePath: string, newCon
  */
 declare function verifyOrRepairVersion(fs: SyncableFS, configFilePath: string, author: string): Promise<VersionMeta | null>;
 
-export { type AppDataBackendDescriptor, type AppDataGroup, type AppDataGroupDescriptor, type BackendDescriptor, type BackendFactory, type BackendInstance, type BackendMetadata, type BackendParamDef, type BackendsMeta, type CacheOptions, ConfigRepo, type ConfigRepoOptions, type ConfigSerializer, type ConflictArchive, type ConflictInfo, type ConnectOptions, type ConnectResult, FolderStore, type IConfigRepo, type KeepPurgeResult, LOCAL_IDB_BACKEND_ID, type MigrateLocalFS, type MigrateReplicaFS, type MtimePurgeResult, type PurgeKeepOptions, type PurgeMtimeOptions, type PurgeableFS$1 as PurgeableFS, type SyncGroupType, type TombstoneMeta, type VersionMeta, type VersionMigrationOptions, type VersionMigrationResult, configKeyToFilePath, connect, createBackend, createConfigRepo, createSerializerChain, getAccountFields, getBackendMetadata, getExtension, hasBackend, incrementVersion, isBrowserEnv, isKeepFile, isMtimeSidecar, legacyVersionPathFor, listBackendMetadata, listBackends, localPrimaryType, mergeAccountFields, migrateVersionSidecars, purgeKeepFiles, purgeMtimeSidecars, readVersion, registerBackend, registerFolderBackend, resolveLocalPrimary, sha256, unregisterBackend, verifyOrRepairVersion, versionPathFor, wrapZenFSFileSystem, writeVersion };
+export { type AppDataBackendDescriptor, type AppDataGroup, type AppDataGroupDescriptor, type BackendDescriptor, type BackendFactory, type BackendInstance, type BackendMetadata, type BackendParamDef, type BackendSyncState, type BackendsMeta, type CacheOptions, ConfigRepo, type ConfigRepoOptions, type ConfigSerializer, type ConflictArchive, type ConflictInfo, type ConnectOptions, type ConnectResult, FolderStore, type IConfigRepo, type KeepPurgeResult, LOCAL_IDB_BACKEND_ID, type MigrateLocalFS, type MigrateReplicaFS, type MtimePurgeResult, type PurgeKeepOptions, type PurgeMtimeOptions, type PurgeableFS$1 as PurgeableFS, type SyncGroupType, type TombstoneMeta, type VersionMeta, type VersionMigrationOptions, type VersionMigrationResult, configKeyToFilePath, connect, createBackend, createConfigRepo, createSerializerChain, getAccountFields, getBackendMetadata, getExtension, hasBackend, incrementVersion, isBrowserEnv, isKeepFile, isMtimeSidecar, legacyVersionPathFor, listBackendMetadata, listBackends, localPrimaryType, mergeAccountFields, migrateVersionSidecars, purgeKeepFiles, purgeMtimeSidecars, readVersion, registerBackend, registerFolderBackend, resolveLocalPrimary, sha256, unregisterBackend, verifyOrRepairVersion, versionPathFor, wrapZenFSFileSystem, writeVersion };

package/dist/index.js

@@ -2885,6 +2885,7 @@ var AppDataGroupImpl = class {
   syncEngine;
   localFS;
   dataBackends = /* @__PURE__ */ new Map();
+  backendStates = /* @__PURE__ */ new Map();
   disposed = false;
   constructor(groupId, appId, backends, pollIntervalMs, parent) {
     this.groupId = groupId;
@@ -2957,8 +2958,14 @@ var AppDataGroupImpl = class {
           "/"
         );
         this.dataBackends.set(desc.id, { instance, syncable, pairId: pair.pairId, desc });
+        this.backendStates.set(desc.id, { backendId: desc.id, pairId: pair.pairId });
         log2.log(`[AppDataGroup:${this.groupId}] backend ${desc.id} (${desc.type}) connected, pair=${pair.pairId}`);
       } catch (err) {
+        const message = err instanceof Error ? err.message : String(err);
+        this.backendStates.set(desc.id, {
+          backendId: desc.id,
+          error: { message, timestamp: Date.now() }
+        });
         log2.error(`[AppDataGroup:${this.groupId}] Failed to create backend ${desc.id} (${desc.type}):`, err);
       }
     }
@@ -2983,6 +2990,9 @@ var AppDataGroupImpl = class {
     const results = await this.syncEngine.syncAll();
     return Array.from(results.values());
   }
+  getBackendSyncStates() {
+    return new Map(this.backendStates);
+  }
   async addBackend(id, type, options, description) {
     if (this.disposed) throw new Error("DataSyncGroup has been disposed");
     if (this.dataBackends.has(id)) {
@@ -3005,6 +3015,8 @@ var AppDataGroupImpl = class {
     );
     const desc = { id, type, options, description, createdAt: Date.now() };
     this.dataBackends.set(id, { instance, syncable, pairId: pair.pairId, desc });
+    this.backendStates.set(id, { backendId: id, pairId: pair.pairId });
+    this._backends = [...this._backends.filter((b) => b.id !== id), desc];
     log2.log(`[AppDataGroup:${this.groupId}] addBackend: ${id} (${type}) connected, pair=${pair.pairId}`);
     try {
       await this.syncEngine.sync(pair.pairId);
@@ -3012,18 +3024,23 @@ var AppDataGroupImpl = class {
       log2.warn(`[AppDataGroup:${this.groupId}] addBackend: initial sync failed for ${id}:`, err);
     }
     this.syncEngine.watch(pair.pairId);
-    await this.parent.updateAppDataGroupDescriptor(this.groupId, this.listBackends());
+    await this.parent.updateAppDataGroupDescriptor(this.groupId, this._backends);
   }
   async removeBackend(id) {
     if (this.disposed) throw new Error("DataSyncGroup has been disposed");
     const backend = this.dataBackends.get(id);
-    if (!backend) {
+    const desc = this._backends.find((b) => b.id === id);
+    if (!backend && !desc) {
       throw new Error(`Backend "${id}" not found in data group "${this.groupId}"`);
     }
-    this.syncEngine.removePair(backend.pairId);
-    this.dataBackends.delete(id);
-    await this.parent.updateAppDataGroupDescriptor(this.groupId, this.listBackends());
-    if (backend.instance?.dispose) {
+    if (backend) {
+      this.syncEngine.removePair(backend.pairId);
+      this.dataBackends.delete(id);
+    }
+    this.backendStates.delete(id);
+    this._backends = this._backends.filter((b) => b.id !== id);
+    await this.parent.updateAppDataGroupDescriptor(this.groupId, this._backends);
+    if (backend?.instance?.dispose) {
       await backend.instance.dispose();
     }
     log2.log(`[AppDataGroup:${this.groupId}] removeBackend: ${id} removed`);

package/dist/index.mjs

@@ -2345,6 +2345,7 @@ var AppDataGroupImpl = class {
   syncEngine;
   localFS;
   dataBackends = /* @__PURE__ */ new Map();
+  backendStates = /* @__PURE__ */ new Map();
   disposed = false;
   constructor(groupId, appId, backends, pollIntervalMs, parent) {
     this.groupId = groupId;
@@ -2417,8 +2418,14 @@ var AppDataGroupImpl = class {
           "/"
         );
         this.dataBackends.set(desc.id, { instance, syncable, pairId: pair.pairId, desc });
+        this.backendStates.set(desc.id, { backendId: desc.id, pairId: pair.pairId });
         log2.log(`[AppDataGroup:${this.groupId}] backend ${desc.id} (${desc.type}) connected, pair=${pair.pairId}`);
       } catch (err) {
+        const message = err instanceof Error ? err.message : String(err);
+        this.backendStates.set(desc.id, {
+          backendId: desc.id,
+          error: { message, timestamp: Date.now() }
+        });
         log2.error(`[AppDataGroup:${this.groupId}] Failed to create backend ${desc.id} (${desc.type}):`, err);
       }
     }
@@ -2443,6 +2450,9 @@ var AppDataGroupImpl = class {
     const results = await this.syncEngine.syncAll();
     return Array.from(results.values());
   }
+  getBackendSyncStates() {
+    return new Map(this.backendStates);
+  }
   async addBackend(id, type, options, description) {
     if (this.disposed) throw new Error("DataSyncGroup has been disposed");
     if (this.dataBackends.has(id)) {
@@ -2465,6 +2475,8 @@ var AppDataGroupImpl = class {
     );
     const desc = { id, type, options, description, createdAt: Date.now() };
     this.dataBackends.set(id, { instance, syncable, pairId: pair.pairId, desc });
+    this.backendStates.set(id, { backendId: id, pairId: pair.pairId });
+    this._backends = [...this._backends.filter((b) => b.id !== id), desc];
     log2.log(`[AppDataGroup:${this.groupId}] addBackend: ${id} (${type}) connected, pair=${pair.pairId}`);
     try {
       await this.syncEngine.sync(pair.pairId);
@@ -2472,18 +2484,23 @@ var AppDataGroupImpl = class {
       log2.warn(`[AppDataGroup:${this.groupId}] addBackend: initial sync failed for ${id}:`, err);
     }
     this.syncEngine.watch(pair.pairId);
-    await this.parent.updateAppDataGroupDescriptor(this.groupId, this.listBackends());
+    await this.parent.updateAppDataGroupDescriptor(this.groupId, this._backends);
   }
   async removeBackend(id) {
     if (this.disposed) throw new Error("DataSyncGroup has been disposed");
     const backend = this.dataBackends.get(id);
-    if (!backend) {
+    const desc = this._backends.find((b) => b.id === id);
+    if (!backend && !desc) {
       throw new Error(`Backend "${id}" not found in data group "${this.groupId}"`);
     }
-    this.syncEngine.removePair(backend.pairId);
-    this.dataBackends.delete(id);
-    await this.parent.updateAppDataGroupDescriptor(this.groupId, this.listBackends());
-    if (backend.instance?.dispose) {
+    if (backend) {
+      this.syncEngine.removePair(backend.pairId);
+      this.dataBackends.delete(id);
+    }
+    this.backendStates.delete(id);
+    this._backends = this._backends.filter((b) => b.id !== id);
+    await this.parent.updateAppDataGroupDescriptor(this.groupId, this._backends);
+    if (backend?.instance?.dispose) {
       await backend.instance.dispose();
     }
     log2.log(`[AppDataGroup:${this.groupId}] removeBackend: ${id} removed`);

package/dist/zen-fs-config.js

@@ -28911,6 +28911,7 @@ var ZenFSConfig = (() => {
       __publicField(this, "syncEngine");
       __publicField(this, "localFS");
       __publicField(this, "dataBackends", /* @__PURE__ */ new Map());
+      __publicField(this, "backendStates", /* @__PURE__ */ new Map());
       __publicField(this, "disposed", false);
       __publicField(this, "parent");
       __publicField(this, "_backends");
@@ -28982,8 +28983,14 @@ var ZenFSConfig = (() => {
             "/"
           );
           this.dataBackends.set(desc.id, { instance, syncable, pairId: pair.pairId, desc });
+          this.backendStates.set(desc.id, { backendId: desc.id, pairId: pair.pairId });
           log6.log(`[AppDataGroup:${this.groupId}] backend ${desc.id} (${desc.type}) connected, pair=${pair.pairId}`);
         } catch (err2) {
+          const message = err2 instanceof Error ? err2.message : String(err2);
+          this.backendStates.set(desc.id, {
+            backendId: desc.id,
+            error: { message, timestamp: Date.now() }
+          });
           log6.error(`[AppDataGroup:${this.groupId}] Failed to create backend ${desc.id} (${desc.type}):`, err2);
         }
       }
@@ -29008,6 +29015,9 @@ var ZenFSConfig = (() => {
       const results = await this.syncEngine.syncAll();
       return Array.from(results.values());
     }
+    getBackendSyncStates() {
+      return new Map(this.backendStates);
+    }
     async addBackend(id, type, options, description) {
       if (this.disposed) throw new Error("DataSyncGroup has been disposed");
       if (this.dataBackends.has(id)) {
@@ -29030,6 +29040,8 @@ var ZenFSConfig = (() => {
       );
       const desc = { id, type, options, description, createdAt: Date.now() };
       this.dataBackends.set(id, { instance, syncable, pairId: pair.pairId, desc });
+      this.backendStates.set(id, { backendId: id, pairId: pair.pairId });
+      this._backends = [...this._backends.filter((b) => b.id !== id), desc];
       log6.log(`[AppDataGroup:${this.groupId}] addBackend: ${id} (${type}) connected, pair=${pair.pairId}`);
       try {
         await this.syncEngine.sync(pair.pairId);
@@ -29037,18 +29049,23 @@ var ZenFSConfig = (() => {
         log6.warn(`[AppDataGroup:${this.groupId}] addBackend: initial sync failed for ${id}:`, err2);
       }
       this.syncEngine.watch(pair.pairId);
-      await this.parent.updateAppDataGroupDescriptor(this.groupId, this.listBackends());
+      await this.parent.updateAppDataGroupDescriptor(this.groupId, this._backends);
     }
     async removeBackend(id) {
       if (this.disposed) throw new Error("DataSyncGroup has been disposed");
       const backend = this.dataBackends.get(id);
-      if (!backend) {
+      const desc = this._backends.find((b) => b.id === id);
+      if (!backend && !desc) {
         throw new Error(`Backend "${id}" not found in data group "${this.groupId}"`);
       }
-      this.syncEngine.removePair(backend.pairId);
-      this.dataBackends.delete(id);
-      await this.parent.updateAppDataGroupDescriptor(this.groupId, this.listBackends());
-      if (backend.instance?.dispose) {
+      if (backend) {
+        this.syncEngine.removePair(backend.pairId);
+        this.dataBackends.delete(id);
+      }
+      this.backendStates.delete(id);
+      this._backends = this._backends.filter((b) => b.id !== id);
+      await this.parent.updateAppDataGroupDescriptor(this.groupId, this._backends);
+      if (backend?.instance?.dispose) {
         await backend.instance.dispose();
       }
       log6.log(`[AppDataGroup:${this.groupId}] removeBackend: ${id} removed`);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "zen-fs-config",
-  "version": "0.5.44",
+  "version": "0.5.45",
   "description": "Distributed config management library built on ZenFS, zen-fs-cache, and zen-fs-sync",
   "main": "dist/index.js",
   "module": "dist/index.mjs",