@data-weave/datamanager 0.6.1 → 0.6.2

package/dist/OptimisticReference.d.ts

@@ -0,0 +1,28 @@
+import type { Reference } from './Reference';
+export type Patch<T> = Partial<T> | ((current: T) => Partial<T>);
+/**
+ * Wraps a `Reference<T>` and overlays an optimistic `_patch` on top of the
+ * source value. The patch is automatically discarded the next time the source
+ * publishes a new value (detected lazily by comparing the source value against
+ * the snapshot the patch was applied against).
+ *
+ * This class is intentionally mobx-free. For reactive consumers, wrap the
+ * instance with `ObservableOptimisticReference` from
+ * `@data-weave/datamanager-mobx`.
+ */
+export declare class OptimisticReference<T extends object> implements Reference<T> {
+    private readonly source;
+    private _patch;
+    private _patchedAgainstSnapshot;
+    constructor(source: Reference<T>);
+    get value(): T | undefined;
+    get resolved(): boolean;
+    get hasError(): boolean;
+    get error(): unknown | undefined;
+    resolve(): Promise<T | undefined>;
+    applyOptimistic(patch: Patch<T>): void;
+    clearOptimistic(): void;
+    get hasPendingOptimistic(): boolean;
+    dispose(): void;
+}
+//# sourceMappingURL=OptimisticReference.d.ts.map

package/dist/OptimisticReference.js

@@ -0,0 +1,61 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.OptimisticReference = void 0;
+/**
+ * Wraps a `Reference<T>` and overlays an optimistic `_patch` on top of the
+ * source value. The patch is automatically discarded the next time the source
+ * publishes a new value (detected lazily by comparing the source value against
+ * the snapshot the patch was applied against).
+ *
+ * This class is intentionally mobx-free. For reactive consumers, wrap the
+ * instance with `ObservableOptimisticReference` from
+ * `@data-weave/datamanager-mobx`.
+ */
+class OptimisticReference {
+    source;
+    _patch;
+    _patchedAgainstSnapshot;
+    constructor(source) {
+        this.source = source;
+    }
+    get value() {
+        const base = this.source.value;
+        if (this._patch !== undefined && base !== this._patchedAgainstSnapshot) {
+            this._patch = undefined;
+            this._patchedAgainstSnapshot = undefined;
+        }
+        if (!this._patch)
+            return base;
+        if (!base)
+            return this._patch;
+        return { ...base, ...this._patch };
+    }
+    get resolved() {
+        return this.source.resolved;
+    }
+    get hasError() {
+        return this.source.hasError;
+    }
+    get error() {
+        return this.source.error;
+    }
+    resolve() {
+        return this.source.resolve();
+    }
+    applyOptimistic(patch) {
+        const current = this.value ?? {};
+        const resolved = typeof patch === 'function' ? patch(current) : patch;
+        this._patch = { ...this._patch, ...resolved };
+        this._patchedAgainstSnapshot = this.source.value;
+    }
+    clearOptimistic() {
+        this._patch = undefined;
+        this._patchedAgainstSnapshot = undefined;
+    }
+    get hasPendingOptimistic() {
+        return this._patch !== undefined;
+    }
+    dispose() { }
+}
+exports.OptimisticReference = OptimisticReference;
+//# sourceMappingURL=OptimisticReference.js.map

package/dist/index.d.ts

@@ -3,5 +3,6 @@ export * from './DataManager';
 export * from './List';
 export * from './LiveList';
 export * from './LiveReference';
+export * from './OptimisticReference';
 export * from './Reference';
 //# sourceMappingURL=index.d.ts.map

package/dist/index.js

@@ -19,5 +19,6 @@ __exportStar(require("./DataManager"), exports);
 __exportStar(require("./List"), exports);
 __exportStar(require("./LiveList"), exports);
 __exportStar(require("./LiveReference"), exports);
+__exportStar(require("./OptimisticReference"), exports);
 __exportStar(require("./Reference"), exports);
 //# sourceMappingURL=index.js.map

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@data-weave/datamanager",
-    "version": "0.6.1",
+    "version": "0.6.2",
     "author": "",
     "main": "dist/index.js",
     "types": "dist/index.d.ts",