@bsv/wallet-toolbox-client 1.1.34 → 1.1.35

package/out/src/storage/WalletStorageManager.d.ts

@@ -1,5 +1,13 @@
 import { AbortActionArgs, AbortActionResult, InternalizeActionArgs, InternalizeActionResult, ListActionsResult, ListCertificatesResult, ListOutputsResult, RelinquishCertificateArgs, RelinquishOutputArgs } from '@bsv/sdk';
-import { sdk, StorageProvider, StorageSyncReader, TableCertificate, TableCertificateX, TableOutput, TableOutputBasket, TableProvenTxReq, TableSettings, TableUser } from '../index.client';
+import { sdk, StorageProvider, TableCertificate, TableCertificateX, TableOutput, TableOutputBasket, TableProvenTxReq, TableSettings, TableUser } from '../index.client';
+declare class ManagedStorage {
+    storage: sdk.WalletStorageProvider;
+    isAvailable: boolean;
+    isStorageProvider: boolean;
+    settings?: TableSettings;
+    user?: TableUser;
+    constructor(storage: sdk.WalletStorageProvider);
+}
 /**
  * The `WalletStorageManager` class delivers authentication checking storage access to the wallet.
  *
@@ -16,11 +24,41 @@ import { sdk, StorageProvider, StorageSyncReader, TableCertificate, TableCertifi
  * for these services.
  */
 export declare class WalletStorageManager implements sdk.WalletStorage {
-    stores: sdk.WalletStorageProvider[];
+    /**
+     * All configured stores including current active, backups, and conflicting actives.
+     */
+    _stores: ManagedStorage[];
+    /**
+     * True if makeAvailable has been run and access to managed stores (active) is allowed
+     */
+    _isAvailable: boolean;
+    /**
+     * The current active store which is only enabled if the store's user record activeStorage property matches its settings record storageIdentityKey property
+     */
+    _active?: ManagedStorage;
+    /**
+     * Stores to which state is pushed by updateBackups.
+     */
+    _backups?: ManagedStorage[];
+    /**
+     * Stores whose user record activeStorage property disagrees with the active store's user record activeStorage property.
+     */
+    _conflictingActives?: ManagedStorage[];
+    /**
+     * identityKey is always valid, userId and isActive are valid only if _isAvailable
+     */
     _authId: sdk.AuthId;
+    /**
+     * Configured services if any. If valid, shared with stores (which may ignore it).
+     */
     _services?: sdk.WalletServices;
-    _userIdentityKeyToId: Record<string, number>;
+    /**
+     * How many read access operations are pending
+     */
     _readerCount: number;
+    /**
+     * How many write access operations are pending
+     */
     _writerCount: number;
     /**
      * if true, allow only a single writer to proceed at a time.
@@ -39,9 +77,41 @@ export declare class WalletStorageManager implements sdk.WalletStorage {
     _storageProviderLocked: boolean;
     constructor(identityKey: string, active?: sdk.WalletStorageProvider, backups?: sdk.WalletStorageProvider[]);
     isStorageProvider(): boolean;
-    getUserId(): Promise<number>;
+    isAvailable(): boolean;
+    /**
+     * The active storage is "enabled" only if its `storageIdentityKey` matches the user's currently selected `activeStorage`,
+     * and only if there are no stores with conflicting `activeStorage` selections.
+     *
+     * A wallet may be created without including the user's currently selected active storage. This allows readonly access to their wallet data.
+     *
+     * In addition, if there are conflicting `activeStorage` selections among backup storage providers then the active remains disabled.
+     */
+    get isActiveEnabled(): boolean;
+    /**
+     * @returns true if at least one WalletStorageProvider has been added.
+     */
+    canMakeAvailable(): boolean;
+    /**
+     * This async function must be called after construction and before
+     * any other async function can proceed.
+     *
+     * Runs through `_stores` validating all properties and partitioning across `_active`, `_backups`, `_conflictingActives`.
+     *
+     * @throws WERR_INVALID_PARAMETER if canMakeAvailable returns false.
+     *
+     * @returns {TableSettings} from the active storage.
+     */
+    makeAvailable(): Promise<TableSettings>;
+    private verifyActive;
     getAuth(mustBeActive?: boolean): Promise<sdk.AuthId>;
+    getUserId(): Promise<number>;
     getActive(): sdk.WalletStorageProvider;
+    getActiveSettings(): TableSettings;
+    getActiveUser(): TableUser;
+    getActiveStore(): string;
+    getBackupStores(): string[];
+    getConflictingStores(): string[];
+    getAllStores(): string[];
     getActiveForWriter(): Promise<sdk.WalletStorageWriter>;
     getActiveForReader(): Promise<sdk.WalletStorageReader>;
     getActiveForSync(): Promise<sdk.WalletStorageSync>;
@@ -61,12 +131,10 @@ export declare class WalletStorageManager implements sdk.WalletStorage {
      * @returns true if the active `WalletStorageProvider` also implements `StorageProvider`
      */
     isActiveStorageProvider(): boolean;
-    isAvailable(): boolean;
     addWalletStorageProvider(provider: sdk.WalletStorageProvider): Promise<void>;
     setServices(v: sdk.WalletServices): void;
     getServices(): sdk.WalletServices;
     getSettings(): TableSettings;
-    makeAvailable(): Promise<TableSettings>;
     migrate(storageName: string, storageIdentityKey: string): Promise<string>;
     destroy(): Promise<void>;
     findOrInsertUser(identityKey: string): Promise<{
@@ -87,17 +155,25 @@ export declare class WalletStorageManager implements sdk.WalletStorage {
     findOutputBaskets(args: sdk.FindOutputBasketsArgs): Promise<TableOutputBasket[]>;
     findOutputs(args: sdk.FindOutputsArgs): Promise<TableOutput[]>;
     findProvenTxReqs(args: sdk.FindProvenTxReqsArgs): Promise<TableProvenTxReq[]>;
-    syncFromReader(identityKey: string, reader: StorageSyncReader): Promise<void>;
-    updateBackups(activeSync?: sdk.WalletStorageSync): Promise<void>;
-    syncToWriter(auth: sdk.AuthId, writer: sdk.WalletStorageProvider, activeSync?: sdk.WalletStorageSync): Promise<{
+    syncFromReader(identityKey: string, reader: sdk.WalletStorageSyncReader, activeSync?: sdk.WalletStorageSync, log?: string): Promise<{
         inserts: number;
         updates: number;
+        log: string;
     }>;
+    syncToWriter(auth: sdk.AuthId, writer: sdk.WalletStorageProvider, activeSync?: sdk.WalletStorageSync, log?: string): Promise<{
+        inserts: number;
+        updates: number;
+        log: string;
+    }>;
+    updateBackups(activeSync?: sdk.WalletStorageSync): Promise<void>;
     /**
      * Updates backups and switches to new active storage provider from among current backup providers.
      *
+     * Also resolves conflicting actives.
+     *
      * @param storageIdentityKey of current backup storage provider that is to become the new active provider.
      */
-    setActive(storageIdentityKey: string): Promise<void>;
+    setActive(storageIdentityKey: string): Promise<string>;
 }
+export {};
 //# sourceMappingURL=WalletStorageManager.d.ts.map

package/out/src/storage/WalletStorageManager.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"WalletStorageManager.d.ts","sourceRoot":"","sources":["../../../../src/storage/WalletStorageManager.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,eAAe,EACf,iBAAiB,EACjB,qBAAqB,EACrB,uBAAuB,EAEvB,iBAAiB,EACjB,sBAAsB,EAEtB,iBAAiB,EACjB,yBAAyB,EACzB,oBAAoB,EACrB,MAAM,UAAU,CAAA;AACjB,OAAO,EAEL,GAAG,EACH,eAAe,EACf,iBAAiB,EACjB,gBAAgB,EAChB,iBAAiB,EACjB,WAAW,EACX,iBAAiB,EACjB,gBAAgB,EAChB,aAAa,EACb,SAAS,EAEV,MAAM,iBAAiB,CAAA;AAExB;;;;;;;;;;;;;;GAcG;AACH,qBAAa,oBAAqB,YAAW,GAAG,CAAC,aAAa;IAC5D,MAAM,EAAE,GAAG,CAAC,qBAAqB,EAAE,CAAK;IACxC,OAAO,EAAE,GAAG,CAAC,MAAM,CAAA;IACnB,SAAS,CAAC,EAAE,GAAG,CAAC,cAAc,CAAA;IAC9B,oBAAoB,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAK;IACjD,YAAY,EAAE,MAAM,CAAI;IACxB,YAAY,EAAE,MAAM,CAAI;IACxB;;;OAGG;IACH,eAAe,EAAE,OAAO,CAAO;IAC/B;;;OAGG;IACH,WAAW,EAAE,OAAO,CAAQ;IAC5B;;;OAGG;IACH,sBAAsB,EAAE,OAAO,CAAQ;gBAGrC,WAAW,EAAE,MAAM,EACnB,MAAM,CAAC,EAAE,GAAG,CAAC,qBAAqB,EAClC,OAAO,CAAC,EAAE,GAAG,CAAC,qBAAqB,EAAE;IAQvC,iBAAiB,IAAI,OAAO;IAItB,SAAS,IAAI,OAAO,CAAC,MAAM,CAAC;IAK5B,OAAO,CAAC,YAAY,CAAC,EAAE,OAAO,GAAG,OAAO,CAAC,GAAG,CAAC,MAAM,CAAC;IAe1D,SAAS,IAAI,GAAG,CAAC,qBAAqB;IAQhC,kBAAkB,IAAI,OAAO,CAAC,GAAG,CAAC,mBAAmB,CAAC;IAatD,kBAAkB,IAAI,OAAO,CAAC,GAAG,CAAC,mBAAmB,CAAC;IAYtD,gBAAgB,IAAI,OAAO,CAAC,GAAG,CAAC,iBAAiB,CAAC;IAmBlD,2BAA2B,IAAI,OAAO,CAAC,eAAe,CAAC;IAoBvD,WAAW,CAAC,CAAC,EACjB,MAAM,EAAE,CAAC,MAAM,EAAE,GAAG,CAAC,mBAAmB,KAAK,OAAO,CAAC,CAAC,CAAC,GACtD,OAAO,CAAC,CAAC,CAAC;IAUP,WAAW,CAAC,CAAC,EACjB,MAAM,EAAE,CAAC,MAAM,EAAE,GAAG,CAAC,mBAAmB,KAAK,OAAO,CAAC,CAAC,CAAC,GACtD,OAAO,CAAC,CAAC,CAAC;IAUb;;;;;OAKG;IACG,SAAS,CAAC,CAAC,EACf,IAAI,EAAE,CAAC,MAAM,EAAE,GAAG,CAAC,iBAAiB,KAAK,OAAO,CAAC,CAAC,CAAC,EACnD,UAAU,CAAC,EAAE,GAAG,CAAC,iBAAiB,GACjC,OAAO,CAAC,CAAC,CAAC;IAUP,oBAAoB,CAAC,CAAC,EAC1B,IAAI,EAAE,CAAC,MAAM,EAAE,eAAe,KAAK,OAAO,CAAC,CAAC,CAAC,GAC5C,OAAO,CAAC,CAAC,CAAC;IAUb;;;OAGG;IACH,uBAAuB,IAAI,OAAO;IAIlC,WAAW,IAAI,OAAO;IAIhB,wBAAwB,CAC5B,QAAQ,EAAE,GAAG,CAAC,qBAAqB,GAClC,OAAO,CAAC,IAAI,CAAC;IAMhB,WAAW,CAAC,CAAC,EAAE,GAAG,CAAC,cAAc;IAIjC,WAAW,IAAI,GAAG,CAAC,cAAc;IAMjC,WAAW,IAAI,aAAa;IAItB,aAAa,IAAI,OAAO,CAAC,aAAa,CAAC;IAOvC,OAAO,CACX,WAAW,EAAE,MAAM,EACnB,kBAAkB,EAAE,MAAM,GACzB,OAAO,CAAC,MAAM,CAAC;IAMZ,OAAO,IAAI,OAAO,CAAC,IAAI,CAAC;IAOxB,gBAAgB,CACpB,WAAW,EAAE,MAAM,GAClB,OAAO,CAAC;QAAE,IAAI,EAAE,SAAS,CAAC;QAAC,KAAK,EAAE,OAAO,CAAA;KAAE,CAAC;IAgBzC,WAAW,CAAC,IAAI,EAAE,eAAe,GAAG,OAAO,CAAC,iBAAiB,CAAC;IAO9D,YAAY,CAChB,KAAK,EAAE,GAAG,CAAC,qBAAqB,GAC/B,OAAO,CAAC,GAAG,CAAC,yBAAyB,CAAC;IAMnC,iBAAiB,CACrB,IAAI,EAAE,qBAAqB,GAC1B,OAAO,CAAC,uBAAuB,CAAC;IAQ7B,qBAAqB,CACzB,IAAI,EAAE,yBAAyB,GAC9B,OAAO,CAAC,MAAM,CAAC;IAOZ,gBAAgB,CAAC,IAAI,EAAE,oBAAoB,GAAG,OAAO,CAAC,MAAM,CAAC;IAQ7D,aAAa,CACjB,IAAI,EAAE,GAAG,CAAC,wBAAwB,GACjC,OAAO,CAAC,GAAG,CAAC,2BAA2B,CAAC;IAMrC,iBAAiB,CAAC,WAAW,EAAE,gBAAgB,GAAG,OAAO,CAAC,MAAM,CAAC;IAOjE,WAAW,CACf,KAAK,EAAE,GAAG,CAAC,oBAAoB,GAC9B,OAAO,CAAC,iBAAiB,CAAC;IAMvB,gBAAgB,CACpB,IAAI,EAAE,GAAG,CAAC,yBAAyB,GAClC,OAAO,CAAC,sBAAsB,CAAC;IAM5B,WAAW,CACf,KAAK,EAAE,GAAG,CAAC,oBAAoB,GAC9B,OAAO,CAAC,iBAAiB,CAAC;IAMvB,gBAAgB,CACpB,IAAI,EAAE,GAAG,CAAC,oBAAoB,GAC7B,OAAO,CAAC,iBAAiB,EAAE,CAAC;IAMzB,iBAAiB,CACrB,IAAI,EAAE,GAAG,CAAC,qBAAqB,GAC9B,OAAO,CAAC,iBAAiB,EAAE,CAAC;IAMzB,WAAW,CAAC,IAAI,EAAE,GAAG,CAAC,eAAe,GAAG,OAAO,CAAC,WAAW,EAAE,CAAC;IAO9D,gBAAgB,CACpB,IAAI,EAAE,GAAG,CAAC,oBAAoB,GAC7B,OAAO,CAAC,gBAAgB,EAAE,CAAC;IAMxB,cAAc,CAClB,WAAW,EAAE,MAAM,EACnB,MAAM,EAAE,iBAAiB,GACxB,OAAO,CAAC,IAAI,CAAC;IAmCV,aAAa,CAAC,UAAU,CAAC,EAAE,GAAG,CAAC,iBAAiB;IAShD,YAAY,CAChB,IAAI,EAAE,GAAG,CAAC,MAAM,EAChB,MAAM,EAAE,GAAG,CAAC,qBAAqB,EACjC,UAAU,CAAC,EAAE,GAAG,CAAC,iBAAiB,GACjC,OAAO,CAAC;QAAE,OAAO,EAAE,MAAM,CAAC;QAAC,OAAO,EAAE,MAAM,CAAA;KAAE,CAAC;IAmChD;;;;OAIG;IACG,SAAS,CAAC,kBAAkB,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;CAgC3D"}
+{"version":3,"file":"WalletStorageManager.d.ts","sourceRoot":"","sources":["../../../../src/storage/WalletStorageManager.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,eAAe,EACf,iBAAiB,EACjB,qBAAqB,EACrB,uBAAuB,EAEvB,iBAAiB,EACjB,sBAAsB,EAEtB,iBAAiB,EACjB,yBAAyB,EACzB,oBAAoB,EACrB,MAAM,UAAU,CAAA;AACjB,OAAO,EAEL,GAAG,EACH,eAAe,EAEf,gBAAgB,EAChB,iBAAiB,EACjB,WAAW,EACX,iBAAiB,EACjB,gBAAgB,EAChB,aAAa,EACb,SAAS,EAEV,MAAM,iBAAiB,CAAA;AAGxB,cAAM,cAAc;IAMC,OAAO,EAAE,GAAG,CAAC,qBAAqB;IALrD,WAAW,EAAE,OAAO,CAAA;IACpB,iBAAiB,EAAE,OAAO,CAAA;IAC1B,QAAQ,CAAC,EAAE,aAAa,CAAA;IACxB,IAAI,CAAC,EAAE,SAAS,CAAA;gBAEG,OAAO,EAAE,GAAG,CAAC,qBAAqB;CAItD;AAED;;;;;;;;;;;;;;GAcG;AACH,qBAAa,oBAAqB,YAAW,GAAG,CAAC,aAAa;IAC5D;;OAEG;IACH,OAAO,EAAE,cAAc,EAAE,CAAK;IAC9B;;OAEG;IACH,YAAY,EAAE,OAAO,CAAQ;IAC7B;;OAEG;IACH,OAAO,CAAC,EAAE,cAAc,CAAA;IACxB;;OAEG;IACH,QAAQ,CAAC,EAAE,cAAc,EAAE,CAAA;IAC3B;;OAEG;IACH,mBAAmB,CAAC,EAAE,cAAc,EAAE,CAAA;IACtC;;OAEG;IACH,OAAO,EAAE,GAAG,CAAC,MAAM,CAAA;IACnB;;OAEG;IACH,SAAS,CAAC,EAAE,GAAG,CAAC,cAAc,CAAA;IAC9B;;OAEG;IACH,YAAY,EAAE,MAAM,CAAI;IACxB;;OAEG;IACH,YAAY,EAAE,MAAM,CAAI;IACxB;;;OAGG;IACH,eAAe,EAAE,OAAO,CAAO;IAC/B;;;OAGG;IACH,WAAW,EAAE,OAAO,CAAQ;IAC5B;;;OAGG;IACH,sBAAsB,EAAE,OAAO,CAAQ;gBAGrC,WAAW,EAAE,MAAM,EACnB,MAAM,CAAC,EAAE,GAAG,CAAC,qBAAqB,EAClC,OAAO,CAAC,EAAE,GAAG,CAAC,qBAAqB,EAAE;IAQvC,iBAAiB,IAAI,OAAO;IAI5B,WAAW,IAAI,OAAO;IAItB;;;;;;;OAOG;IACH,IAAI,eAAe,IAAI,OAAO,CAQ7B;IAED;;OAEG;IACH,gBAAgB,IAAI,OAAO;IAI3B;;;;;;;;;OASG;IACG,aAAa,IAAI,OAAO,CAAC,aAAa,CAAC;IAyD7C,OAAO,CAAC,YAAY;IAQd,OAAO,CAAC,YAAY,CAAC,EAAE,OAAO,GAAG,OAAO,CAAC,GAAG,CAAC,MAAM,CAAC;IAMpD,SAAS,IAAI,OAAO,CAAC,MAAM,CAAC;IAIlC,SAAS,IAAI,GAAG,CAAC,qBAAqB;IAItC,iBAAiB,IAAI,aAAa;IAIlC,aAAa,IAAI,SAAS;IAI1B,cAAc,IAAI,MAAM;IAIxB,eAAe,IAAI,MAAM,EAAE;IAK3B,oBAAoB,IAAI,MAAM,EAAE;IAKhC,YAAY,IAAI,MAAM,EAAE;IAKlB,kBAAkB,IAAI,OAAO,CAAC,GAAG,CAAC,mBAAmB,CAAC;IActD,kBAAkB,IAAI,OAAO,CAAC,GAAG,CAAC,mBAAmB,CAAC;IAatD,gBAAgB,IAAI,OAAO,CAAC,GAAG,CAAC,iBAAiB,CAAC;IAoBlD,2BAA2B,IAAI,OAAO,CAAC,eAAe,CAAC;IAqBvD,WAAW,CAAC,CAAC,EACjB,MAAM,EAAE,CAAC,MAAM,EAAE,GAAG,CAAC,mBAAmB,KAAK,OAAO,CAAC,CAAC,CAAC,GACtD,OAAO,CAAC,CAAC,CAAC;IAUP,WAAW,CAAC,CAAC,EACjB,MAAM,EAAE,CAAC,MAAM,EAAE,GAAG,CAAC,mBAAmB,KAAK,OAAO,CAAC,CAAC,CAAC,GACtD,OAAO,CAAC,CAAC,CAAC;IAUb;;;;;OAKG;IACG,SAAS,CAAC,CAAC,EACf,IAAI,EAAE,CAAC,MAAM,EAAE,GAAG,CAAC,iBAAiB,KAAK,OAAO,CAAC,CAAC,CAAC,EACnD,UAAU,CAAC,EAAE,GAAG,CAAC,iBAAiB,GACjC,OAAO,CAAC,CAAC,CAAC;IAUP,oBAAoB,CAAC,CAAC,EAC1B,IAAI,EAAE,CAAC,MAAM,EAAE,eAAe,KAAK,OAAO,CAAC,CAAC,CAAC,GAC5C,OAAO,CAAC,CAAC,CAAC;IAUb;;;OAGG;IACH,uBAAuB,IAAI,OAAO;IAI5B,wBAAwB,CAC5B,QAAQ,EAAE,GAAG,CAAC,qBAAqB,GAClC,OAAO,CAAC,IAAI,CAAC;IAQhB,WAAW,CAAC,CAAC,EAAE,GAAG,CAAC,cAAc;IAIjC,WAAW,IAAI,GAAG,CAAC,cAAc;IAMjC,WAAW,IAAI,aAAa;IAItB,OAAO,CACX,WAAW,EAAE,MAAM,EACnB,kBAAkB,EAAE,MAAM,GACzB,OAAO,CAAC,MAAM,CAAC;IAMZ,OAAO,IAAI,OAAO,CAAC,IAAI,CAAC;IAOxB,gBAAgB,CACpB,WAAW,EAAE,MAAM,GAClB,OAAO,CAAC;QAAE,IAAI,EAAE,SAAS,CAAC;QAAC,KAAK,EAAE,OAAO,CAAA;KAAE,CAAC;IAgBzC,WAAW,CAAC,IAAI,EAAE,eAAe,GAAG,OAAO,CAAC,iBAAiB,CAAC;IAO9D,YAAY,CAChB,KAAK,EAAE,GAAG,CAAC,qBAAqB,GAC/B,OAAO,CAAC,GAAG,CAAC,yBAAyB,CAAC;IAMnC,iBAAiB,CACrB,IAAI,EAAE,qBAAqB,GAC1B,OAAO,CAAC,uBAAuB,CAAC;IAQ7B,qBAAqB,CACzB,IAAI,EAAE,yBAAyB,GAC9B,OAAO,CAAC,MAAM,CAAC;IAOZ,gBAAgB,CAAC,IAAI,EAAE,oBAAoB,GAAG,OAAO,CAAC,MAAM,CAAC;IAQ7D,aAAa,CACjB,IAAI,EAAE,GAAG,CAAC,wBAAwB,GACjC,OAAO,CAAC,GAAG,CAAC,2BAA2B,CAAC;IAMrC,iBAAiB,CAAC,WAAW,EAAE,gBAAgB,GAAG,OAAO,CAAC,MAAM,CAAC;IAOjE,WAAW,CACf,KAAK,EAAE,GAAG,CAAC,oBAAoB,GAC9B,OAAO,CAAC,iBAAiB,CAAC;IAMvB,gBAAgB,CACpB,IAAI,EAAE,GAAG,CAAC,yBAAyB,GAClC,OAAO,CAAC,sBAAsB,CAAC;IAM5B,WAAW,CACf,KAAK,EAAE,GAAG,CAAC,oBAAoB,GAC9B,OAAO,CAAC,iBAAiB,CAAC;IAMvB,gBAAgB,CACpB,IAAI,EAAE,GAAG,CAAC,oBAAoB,GAC7B,OAAO,CAAC,iBAAiB,EAAE,CAAC;IAMzB,iBAAiB,CACrB,IAAI,EAAE,GAAG,CAAC,qBAAqB,GAC9B,OAAO,CAAC,iBAAiB,EAAE,CAAC;IAMzB,WAAW,CAAC,IAAI,EAAE,GAAG,CAAC,eAAe,GAAG,OAAO,CAAC,WAAW,EAAE,CAAC;IAO9D,gBAAgB,CACpB,IAAI,EAAE,GAAG,CAAC,oBAAoB,GAC7B,OAAO,CAAC,gBAAgB,EAAE,CAAC;IAMxB,cAAc,CAClB,WAAW,EAAE,MAAM,EACnB,MAAM,EAAE,GAAG,CAAC,uBAAuB,EACnC,UAAU,CAAC,EAAE,GAAG,CAAC,iBAAiB,EAClC,GAAG,GAAE,MAAW,GACf,OAAO,CAAC;QAAE,OAAO,EAAE,MAAM,CAAC;QAAC,OAAO,EAAE,MAAM,CAAC;QAAC,GAAG,EAAE,MAAM,CAAA;KAAE,CAAC;IA6CvD,YAAY,CAChB,IAAI,EAAE,GAAG,CAAC,MAAM,EAChB,MAAM,EAAE,GAAG,CAAC,qBAAqB,EACjC,UAAU,CAAC,EAAE,GAAG,CAAC,iBAAiB,EAClC,GAAG,GAAE,MAAW,GACf,OAAO,CAAC;QAAE,OAAO,EAAE,MAAM,CAAC;QAAC,OAAO,EAAE,MAAM,CAAC;QAAC,GAAG,EAAE,MAAM,CAAA;KAAE,CAAC;IAwCvD,aAAa,CAAC,UAAU,CAAC,EAAE,GAAG,CAAC,iBAAiB;IAStD;;;;;;OAMG;IACG,SAAS,CAAC,kBAAkB,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC;CA8E7D"}

package/out/src/storage/WalletStorageManager.js

@@ -2,6 +2,13 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.WalletStorageManager = void 0;
 const index_client_1 = require("../index.client");
+class ManagedStorage {
+    constructor(storage) {
+        this.storage = storage;
+        this.isStorageProvider = storage.isStorageProvider();
+        this.isAvailable = false;
+    }
+}
 /**
  * The `WalletStorageManager` class delivers authentication checking storage access to the wallet.
  *
@@ -19,9 +26,21 @@ const index_client_1 = require("../index.client");
  */
 class WalletStorageManager {
     constructor(identityKey, active, backups) {
-        this.stores = [];
-        this._userIdentityKeyToId = {};
+        /**
+         * All configured stores including current active, backups, and conflicting actives.
+         */
+        this._stores = [];
+        /**
+         * True if makeAvailable has been run and access to managed stores (active) is allowed
+         */
+        this._isAvailable = false;
+        /**
+         * How many read access operations are pending
+         */
         this._readerCount = 0;
+        /**
+         * How many write access operations are pending
+         */
         this._writerCount = 0;
         /**
          * if true, allow only a single writer to proceed at a time.
@@ -38,41 +57,143 @@ class WalletStorageManager {
          * queue the blocked requests so they get executed in order when released.
          */
         this._storageProviderLocked = false;
-        this.stores = [];
+        const stores = [...(backups || [])];
         if (active)
-            this.stores.push(active);
-        if (backups)
-            this.stores = this.stores.concat(backups);
+            stores.unshift(active);
+        this._stores = stores.map(s => new ManagedStorage(s));
         this._authId = { identityKey };
     }
     isStorageProvider() {
         return false;
     }
-    async getUserId() {
-        if (!this._authId.userId)
-            await this.getAuth();
-        return this._authId.userId;
+    isAvailable() {
+        return this._isAvailable;
+    }
+    /**
+     * The active storage is "enabled" only if its `storageIdentityKey` matches the user's currently selected `activeStorage`,
+     * and only if there are no stores with conflicting `activeStorage` selections.
+     *
+     * A wallet may be created without including the user's currently selected active storage. This allows readonly access to their wallet data.
+     *
+     * In addition, if there are conflicting `activeStorage` selections among backup storage providers then the active remains disabled.
+     */
+    get isActiveEnabled() {
+        return (this._active !== undefined &&
+            this._active.settings.storageIdentityKey ===
+                this._active.user.activeStorage &&
+            this._conflictingActives !== undefined &&
+            this._conflictingActives.length === 0);
+    }
+    /**
+     * @returns true if at least one WalletStorageProvider has been added.
+     */
+    canMakeAvailable() {
+        return this._stores.length > 0;
+    }
+    /**
+     * This async function must be called after construction and before
+     * any other async function can proceed.
+     *
+     * Runs through `_stores` validating all properties and partitioning across `_active`, `_backups`, `_conflictingActives`.
+     *
+     * @throws WERR_INVALID_PARAMETER if canMakeAvailable returns false.
+     *
+     * @returns {TableSettings} from the active storage.
+     */
+    async makeAvailable() {
+        var _a;
+        if (this._isAvailable)
+            return this._active.settings;
+        this._active = undefined;
+        this._backups = [];
+        this._conflictingActives = [];
+        if (this._stores.length < 1)
+            throw new index_client_1.sdk.WERR_INVALID_PARAMETER('active', 'valid. Must add active storage provider to wallet.');
+        // Initial backups. conflictingActives will be removed.
+        const backups = [];
+        let i = -1;
+        for (const store of this._stores) {
+            i++;
+            if (!store.isAvailable || !store.settings) {
+                // Validate all ManagedStorage properties.
+                store.settings = await store.storage.makeAvailable();
+                const r = await store.storage.findOrInsertUser(this._authId.identityKey);
+                store.user = r.user;
+                store.isAvailable = true;
+            }
+            if (!this._active)
+                // _stores[0] becomes the default active store. It may be replaced if it is not the user's "enabled" activeStorage and that store is found among the remainder (backups).
+                this._active = store;
+            else {
+                const ua = store.user.activeStorage;
+                const si = store.settings.storageIdentityKey;
+                if (ua === si && !this.isActiveEnabled) {
+                    // This store's user record selects it as an enabled active storage...
+                    // swap the current not-enabled active for this storeage.
+                    backups.push(this._active);
+                    this._active = store;
+                }
+                else {
+                    // This store is a backup: Its user record selects some other storage as active.
+                    backups.push(store);
+                }
+            }
+        }
+        // Review backups, partition out conflicting actives.
+        const si = (_a = this._active.settings) === null || _a === void 0 ? void 0 : _a.storageIdentityKey;
+        for (const store of backups) {
+            if (store.user.activeStorage !== si)
+                this._conflictingActives.push(store);
+            else
+                this._backups.push(store);
+        }
+        this._isAvailable = true;
+        this._authId.userId = this._active.user.userId;
+        this._authId.isActive = this.isActiveEnabled;
+        return this._active.settings;
+    }
+    verifyActive() {
+        if (!this._active || !this._isAvailable)
+            throw new index_client_1.sdk.WERR_INVALID_OPERATION('An active WalletStorageProvider must be added to this WalletStorageManager and makeAvailable must be called.');
+        return this._active;
     }
     async getAuth(mustBeActive) {
         if (!this.isAvailable())
             await this.makeAvailable();
-        const { user, isNew } = await this.getActive().findOrInsertUser(this._authId.identityKey);
-        if (!user)
-            throw new index_client_1.sdk.WERR_INVALID_PARAMETER('identityKey', 'exist on storage.');
-        this._authId.userId = user.userId;
-        this._authId.isActive =
-            user.activeStorage === undefined ||
-                user.activeStorage === this.getSettings().storageIdentityKey;
         if (mustBeActive && !this._authId.isActive)
             throw new index_client_1.sdk.WERR_NOT_ACTIVE();
         return this._authId;
     }
+    async getUserId() {
+        return (await this.getAuth()).userId;
+    }
     getActive() {
-        if (this.stores.length < 1)
-            throw new index_client_1.sdk.WERR_INVALID_OPERATION('An active WalletStorageProvider must be added to this WalletStorageManager');
-        return this.stores[0];
+        return this.verifyActive().storage;
+    }
+    getActiveSettings() {
+        return this.verifyActive().settings;
+    }
+    getActiveUser() {
+        return this.verifyActive().user;
+    }
+    getActiveStore() {
+        return this.verifyActive().settings.storageIdentityKey;
+    }
+    getBackupStores() {
+        this.verifyActive();
+        return this._backups.map(b => b.settings.storageIdentityKey);
+    }
+    getConflictingStores() {
+        this.verifyActive();
+        return this._conflictingActives.map(b => b.settings.storageIdentityKey);
+    }
+    getAllStores() {
+        this.verifyActive();
+        return this._stores.map(b => b.settings.storageIdentityKey);
     }
     async getActiveForWriter() {
+        if (!this.isAvailable())
+            await this.makeAvailable();
         while (this._storageProviderLocked ||
             this._syncLocked ||
             (this._isSingleWriter && this._writerCount > 0) ||
@@ -83,6 +204,8 @@ class WalletStorageManager {
         return this.getActive();
     }
     async getActiveForReader() {
+        if (!this.isAvailable())
+            await this.makeAvailable();
         while (this._storageProviderLocked ||
             this._syncLocked ||
             (this._isSingleWriter && this._writerCount > 0)) {
@@ -92,6 +215,8 @@ class WalletStorageManager {
         return this.getActive();
     }
     async getActiveForSync() {
+        if (!this.isAvailable())
+            await this.makeAvailable();
         // Wait for a current sync task to complete...
         while (this._syncLocked) {
             await (0, index_client_1.wait)(100);
@@ -108,6 +233,8 @@ class WalletStorageManager {
         return this.getActive();
     }
     async getActiveForStorageProvider() {
+        if (!this.isAvailable())
+            await this.makeAvailable();
         // Wait for a current storageProvider call to complete...
         while (this._storageProviderLocked) {
             await (0, index_client_1.wait)(100);
@@ -178,19 +305,18 @@ class WalletStorageManager {
     isActiveStorageProvider() {
         return this.getActive().isStorageProvider();
     }
-    isAvailable() {
-        return this.getActive().isAvailable();
-    }
     async addWalletStorageProvider(provider) {
         await provider.makeAvailable();
         if (this._services)
             provider.setServices(this._services);
-        this.stores.push(provider);
+        this._stores.push(new ManagedStorage(provider));
+        this._isAvailable = false;
+        await this.makeAvailable();
     }
     setServices(v) {
         this._services = v;
-        for (const store of this.stores)
-            store.setServices(v);
+        for (const store of this._stores)
+            store.storage.setServices(v);
     }
     getServices() {
         if (!this._services)
@@ -200,23 +326,17 @@ class WalletStorageManager {
     getSettings() {
         return this.getActive().getSettings();
     }
-    async makeAvailable() {
-        return await this.runAsWriter(async (writer) => {
-            writer.makeAvailable();
-            return writer.getSettings();
-        });
-    }
     async migrate(storageName, storageIdentityKey) {
         return await this.runAsWriter(async (writer) => {
             return writer.migrate(storageName, storageIdentityKey);
         });
     }
     async destroy() {
-        if (this.stores.length < 1)
+        if (this._stores.length < 1)
             return;
         return await this.runAsWriter(async (writer) => {
-            for (const store of this.stores)
-                await store.destroy();
+            for (const store of this._stores)
+                await store.storage.destroy();
         });
     }
     async findOrInsertUser(identityKey) {
@@ -318,92 +438,129 @@ class WalletStorageManager {
             return await reader.findProvenTxReqs(args);
         });
     }
-    async syncFromReader(identityKey, reader) {
+    async syncFromReader(identityKey, reader, activeSync, log = '') {
         const auth = await this.getAuth();
         if (identityKey !== auth.identityKey)
             throw new index_client_1.sdk.WERR_UNAUTHORIZED();
         const readerSettings = await reader.makeAvailable();
-        return await this.runAsSync(async (sync) => {
+        let inserts = 0, updates = 0;
+        log = await this.runAsSync(async (sync) => {
             const writer = sync;
             const writerSettings = this.getSettings();
-            let log = '';
-            let inserts = 0, updates = 0;
+            log += `syncFromReader from ${readerSettings.storageName} to ${writerSettings.storageName}\n`;
+            let i = -1;
             for (;;) {
+                i++;
                 const ss = await index_client_1.EntitySyncState.fromStorage(writer, identityKey, readerSettings);
                 const args = ss.makeRequestSyncChunkArgs(identityKey, writerSettings.storageIdentityKey);
                 const chunk = await reader.getSyncChunk(args);
+                if (chunk.user) {
+                    // Merging state from a reader cannot update activeStorage
+                    chunk.user.activeStorage = this._active.user.activeStorage;
+                }
                 const r = await writer.processSyncChunk(args, chunk);
                 inserts += r.inserts;
                 updates += r.updates;
-                //log += `${r.maxUpdated_at} inserted ${r.inserts} updated ${r.updates}\n`
+                log += `chunk ${i} inserted ${r.inserts} updated ${r.updates} ${r.maxUpdated_at}\n`;
                 if (r.done)
                     break;
             }
-            //console.log(log)
-            console.log(`sync complete: ${inserts} inserts, ${updates} updates`);
-        });
-    }
-    async updateBackups(activeSync) {
-        const auth = await this.getAuth();
-        return await this.runAsSync(async (sync) => {
-            for (const backup of this.stores.slice(1)) {
-                await this.syncToWriter(auth, backup, sync);
-            }
+            log += `syncFromReader complete: ${inserts} inserts, ${updates} updates\n`;
+            return log;
         }, activeSync);
+        return { inserts, updates, log };
     }
-    async syncToWriter(auth, writer, activeSync) {
+    async syncToWriter(auth, writer, activeSync, log = '') {
         const identityKey = auth.identityKey;
         const writerSettings = await writer.makeAvailable();
-        return await this.runAsSync(async (sync) => {
+        let inserts = 0, updates = 0;
+        log = await this.runAsSync(async (sync) => {
             const reader = sync;
             const readerSettings = this.getSettings();
-            let log = '';
-            let inserts = 0, updates = 0;
+            log += `syncToWriter from ${readerSettings.storageName} to ${writerSettings.storageName}\n`;
+            let i = -1;
             for (;;) {
+                i++;
                 const ss = await index_client_1.EntitySyncState.fromStorage(writer, identityKey, readerSettings);
                 const args = ss.makeRequestSyncChunkArgs(identityKey, writerSettings.storageIdentityKey);
                 const chunk = await reader.getSyncChunk(args);
                 const r = await writer.processSyncChunk(args, chunk);
                 inserts += r.inserts;
                 updates += r.updates;
-                log += `${r.maxUpdated_at} inserted ${r.inserts} updated ${r.updates}\n`;
+                log += `chunk ${i} inserted ${r.inserts} updated ${r.updates} ${r.maxUpdated_at}\n`;
                 if (r.done)
                     break;
             }
-            //console.log(log)
-            //console.log(`sync complete: ${inserts} inserts, ${updates} updates`)
-            return { inserts, updates };
+            log += `syncToWriter complete: ${inserts} inserts, ${updates} updates\n`;
+            return log;
+        }, activeSync);
+        return { inserts, updates, log };
+    }
+    async updateBackups(activeSync) {
+        const auth = await this.getAuth(true);
+        return await this.runAsSync(async (sync) => {
+            for (const backup of this._backups) {
+                await this.syncToWriter(auth, backup.storage, sync);
+            }
         }, activeSync);
     }
     /**
      * Updates backups and switches to new active storage provider from among current backup providers.
      *
+     * Also resolves conflicting actives.
+     *
      * @param storageIdentityKey of current backup storage provider that is to become the new active provider.
      */
     async setActive(storageIdentityKey) {
-        const newActiveIndex = this.stores.findIndex(s => s.getSettings().storageIdentityKey === storageIdentityKey);
+        if (!this.isAvailable())
+            await this.makeAvailable();
+        // Confirm a valid storageIdentityKey: must match one of the _stores.
+        const newActiveIndex = this._stores.findIndex(s => s.settings.storageIdentityKey === storageIdentityKey);
         if (newActiveIndex < 0)
-            throw new index_client_1.sdk.WERR_INVALID_PARAMETER('storageIdentityKey', `registered with this "WalletStorageManager" as a backup data store.`);
-        if (newActiveIndex === 0)
+            throw new index_client_1.sdk.WERR_INVALID_PARAMETER('storageIdentityKey', `registered with this "WalletStorageManager". ${storageIdentityKey} does not match any managed store.`);
+        const identityKey = (await this.getAuth()).identityKey;
+        const newActive = this._stores[newActiveIndex];
+        let log = `setActive to ${newActive.settings.storageName}`;
+        if (newActiveIndex === 0 && this.isActiveEnabled)
             /** Setting the current active as the new active is a permitted no-op. */
-            return;
-        const auth = await this.getAuth();
-        const newActive = this.stores[newActiveIndex];
-        const newActiveStorageIdentityKey = (await newActive.makeAvailable())
-            .storageIdentityKey;
-        return await this.runAsSync(async (sync) => {
-            await sync.setActive(auth, newActiveStorageIdentityKey);
-            await this.updateBackups(sync);
-            // swap stores...
-            const oldActive = this.stores[0];
-            this.stores[0] = this.stores[newActiveIndex];
-            this.stores[newActiveIndex] = oldActive;
-            this._authId = {
-                ...this._authId,
-                userId: undefined,
-                isActive: undefined
-            };
+            return ` unchanged\n`;
+        log += '\n';
+        log += await this.runAsSync(async (sync) => {
+            let log = '';
+            // Handle case where new active is current active to resolve conflicts.
+            // And where new active is one of the current conflict actives.
+            this._conflictingActives.push(this._active);
+            // Remove the new active from conflicting actives and
+            // set new active as the conflicting active that matches the target `storageIdentityKey`
+            this._conflictingActives = this._conflictingActives.filter(ca => {
+                const isNewActive = ca.settings.storageIdentityKey === storageIdentityKey;
+                if (isNewActive)
+                    this._active = ca;
+                return !isNewActive;
+            });
+            if (this._conflictingActives.length > 0) {
+                // Merge state from conflicting actives into `_active`.
+                for (const conflict of this._conflictingActives) {
+                    const sfr = await this.syncFromReader(identityKey, conflict.storage, newActive.storage);
+                    log += sfr.log;
+                }
+            }
+            for (const store of this._stores) {
+                // Update all store's user records to reflect new active store
+                await store.storage.setActive({ identityKey, userId: store.user.userId }, storageIdentityKey);
+                // Update cached user.activeStorage of all stores
+                store.user.activeStorage = storageIdentityKey;
+                // Push state merged from all conflicting actives to all non-active stores.
+                if (store.settings.storageIdentityKey !== storageIdentityKey) {
+                    const stwr = await this.syncToWriter({ identityKey, userId: store.user.userId, isActive: false }, store.storage, newActive.storage);
+                    log += stwr.log;
+                }
+            }
+            this._isAvailable = false;
+            await this.makeAvailable();
+            return log;
         });
+        return log;
     }
 }
 exports.WalletStorageManager = WalletStorageManager;