@peers-app/peers-sdk 0.27.2 → 0.27.3

package/dist/data/persistent-vars.d.ts

@@ -131,11 +131,13 @@ interface IPersistentVarOptionsWithoutDefault<T> extends IPersistentVarOptionsBa
  * A persistent variable that is stored only on this device, in the user's personal db
  */
 export declare function deviceVar<T = string>(name: string, opts: Omit<IPersistentVarOptionsWithDefault<T>, "scope" | "dataContext">): PersistentVar<T>;
+/** Create or reuse a {@link deviceVar} observable for this name and context. */
 export declare function deviceVar<T = string>(name: string, opts?: Omit<IPersistentVarOptionsWithoutDefault<T>, "scope" | "dataContext">): PersistentVar<T | undefined>;
 /**
  * A persistent variable that is stored in the user's personal db and synced across all their devices
  */
 export declare function userVar<T = string>(name: string, opts: Omit<IPersistentVarOptionsWithDefault<T>, "scope" | "dataContext">): PersistentVar<T>;
+/** Create or reuse a {@link userVar} observable for this name and context. */
 export declare function userVar<T = string>(name: string, opts?: Omit<IPersistentVarOptionsWithoutDefault<T>, "scope" | "dataContext">): PersistentVar<T | undefined>;
 /**
  * A persistent variable that is shared by all users in a group. It is stored in the group's db and synced across all users and devices in the group.
@@ -143,6 +145,7 @@ export declare function userVar<T = string>(name: string, opts?: Omit<IPersisten
  * If secret=true, it is encrypted with the group's secret key
  */
 export declare function groupVar<T = string>(name: string, opts: Omit<IPersistentVarOptionsWithDefault<T>, "scope">): PersistentVar<T>;
+/** Create or reuse a {@link groupVar} observable for this name and context. */
 export declare function groupVar<T = string>(name: string, opts?: Omit<IPersistentVarOptionsWithoutDefault<T>, "scope">): PersistentVar<T | undefined>;
 /**
  * A persistent variable that is stored only on this device, in the user's personal db.
@@ -154,6 +157,7 @@ export declare function groupVar<T = string>(name: string, opts?: Omit<IPersiste
  * renderer callers that follow the default group share one row.
  */
 export declare function groupDeviceVar<T = string>(name: string, opts: Omit<IPersistentVarOptionsWithDefault<T>, "scope">): PersistentVar<T>;
+/** Create or reuse a {@link groupDeviceVar} observable for this name and context. */
 export declare function groupDeviceVar<T = string>(name: string, opts?: Omit<IPersistentVarOptionsWithoutDefault<T>, "scope">): PersistentVar<T | undefined>;
 /**
  * A persistent variable that is stored in the user's personal db and synced across all their devices in the group.
@@ -163,4 +167,5 @@ export declare function groupDeviceVar<T = string>(name: string, opts?: Omit<IPe
  * only selects the group whose value is addressed.
  */
 export declare function groupUserVar<T = string>(name: string, opts: Omit<IPersistentVarOptionsWithDefault<T>, "scope">): PersistentVar<T>;
+/** Create or reuse a {@link groupUserVar} observable for this name and context. */
 export declare function groupUserVar<T = string>(name: string, opts?: Omit<IPersistentVarOptionsWithoutDefault<T>, "scope">): PersistentVar<T | undefined>;

package/dist/data/persistent-vars.js

@@ -278,6 +278,7 @@ function userContextCacheId(userContext) {
     }
     return String(id);
 }
+/** Create or reuse a {@link deviceVar} observable for this name and context. */
 function deviceVar(name, opts) {
     const fullOpts = { ...opts, scope: "device" };
     if (opts?.defaultValue !== undefined) {
@@ -287,6 +288,7 @@ function deviceVar(name, opts) {
         return persistentVarFactory(name, fullOpts);
     }
 }
+/** Create or reuse a {@link userVar} observable for this name and context. */
 function userVar(name, opts) {
     const fullOpts = { ...opts, scope: "user" };
     if (opts?.defaultValue !== undefined) {
@@ -296,6 +298,7 @@ function userVar(name, opts) {
         return persistentVarFactory(name, fullOpts);
     }
 }
+/** Create or reuse a {@link groupVar} observable for this name and context. */
 function groupVar(name, opts) {
     const fullOpts = { ...opts, scope: "group" };
     if (opts?.defaultValue !== undefined) {
@@ -305,6 +308,7 @@ function groupVar(name, opts) {
         return persistentVarFactory(name, fullOpts);
     }
 }
+/** Create or reuse a {@link groupDeviceVar} observable for this name and context. */
 function groupDeviceVar(name, opts) {
     const fullOpts = { ...opts, scope: "groupDevice" };
     if (opts?.defaultValue !== undefined) {
@@ -314,6 +318,7 @@ function groupDeviceVar(name, opts) {
         return persistentVarFactory(name, fullOpts);
     }
 }
+/** Create or reuse a {@link groupUserVar} observable for this name and context. */
 function groupUserVar(name, opts) {
     const fullOpts = { ...opts, scope: "groupUser" };
     if (opts?.defaultValue !== undefined) {
@@ -416,12 +421,21 @@ function persistentVarFactory(name, opts) {
                     if (!dbRec) {
                         dbRec = await migrateLegacyRec(table, name);
                     }
-                    if (dbRec) {
-                        if (dbRec.scope !== scope) {
-                            console.warn(`${name}: deleting old persistent var record because scopes don't match.  If this is unexpected there could be two different persistent variables using the same name`);
-                            await table.delete(dbRec);
-                            dbRec = undefined;
-                        }
+                    // Preserve an existing secret unless the caller explicitly changes that setting.
+                    if (dbRec?.isSecret !== undefined && opts.isSecret === undefined) {
+                        isSecret = dbRec.isSecret;
+                    }
+                    if (dbRec && dbRec.scope !== scope) {
+                        console.warn(`${name}: resetting the persistent var to its default under scope ${scope} (it was stored as ${dbRec.scope}).  If this is unexpected there could be two different persistent variables using the same name`);
+                        // Re-save under the new scope rather than deleting: names share one ID across scopes,
+                        // and change tracking turns the move into a tombstone (to a device scope, which isn't
+                        // tracked) or a fresh root snapshot (back to a synced scope) that peers apply.
+                        dbRec = await table.save({
+                            ...dbRec,
+                            scope,
+                            isSecret,
+                            value: { value: defaultValue },
+                        });
                     }
                     if (dbRec && !(0, utils_1.isDeterministicPvarId)(dbRec.persistentVarId)) {
                         dbRec = await table.migrateLegacyId(dbRec);
@@ -503,6 +517,10 @@ function persistentVarFactory(name, opts) {
                         rec = dbRec;
                     }
                     if (dbRec.persistentVarId === rec?.persistentVarId) {
+                        // A later declaration of this scope must reload and perform its own transition.
+                        if (dbRec.scope !== scope && pvarCache.get(cacheKey) === persistentVar) {
+                            pvarCache.delete(cacheKey);
+                        }
                         if (evt.data.op === "delete") {
                             rec = undefined;
                             if (defaultValue !== undefined) {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@peers-app/peers-sdk",
-  "version": "0.27.2",
+  "version": "0.27.3",
   "repository": {
     "type": "git",
     "url": "git+https://github.com/peers-app/peers-sdk.git"