@econ-v1/domain 6.7.0 → 6.10.0

package/src/services/sync/index.js

@@ -0,0 +1,67 @@
+// @ts-check
+
+/**
+ * @typedef {import("./authoritative-mirror.js").AuthoritativeCommandOptions} AuthoritativeCommandOptions
+ */
+/**
+ * @template TValue
+ * @template TCommand
+ * @template TResult
+ * @typedef {import("./authoritative-mirror.js").AuthoritativeMirrorOptions<TValue, TCommand, TResult>} AuthoritativeMirrorOptions
+ */
+/**
+ * @template TPayload
+ * @typedef {import("./log-sync.js").LogSyncOptions<TPayload>} LogSyncOptions
+ */
+/**
+ * @template TValue
+ * @typedef {import("./revision-merge.js").RevisionMergeOptions<TValue>} RevisionMergeOptions
+ */
+/**
+ * @template TValue
+ * @typedef {import("./revision-merge.js").RevisionWriteInput<TValue>} RevisionWriteInput
+ */
+/**
+ * @template TPayload
+ * @typedef {import("./strategy.js").AuthoritativeCommand<TPayload>} AuthoritativeCommand
+ */
+/**
+ * @template TValue
+ * @typedef {import("./strategy.js").AuthoritativeSnapshot<TValue>} AuthoritativeSnapshot
+ */
+/**
+ * @template TValue
+ * @typedef {import("./strategy.js").RevisionCommandResult<TValue>} RevisionCommandResult
+ */
+/**
+ * @template TValue
+ * @typedef {import("./strategy.js").RevisionConflict<TValue>} RevisionConflict
+ */
+/**
+ * @template TValue
+ * @typedef {import("./strategy.js").RevisionEntity<TValue>} RevisionEntity
+ */
+/**
+ * @template TValue
+ * @typedef {import("./strategy.js").RevisionIntent<TValue>} RevisionIntent
+ */
+/**
+ * @typedef {import("./strategy.js").SyncApplyResult} SyncApplyResult
+ */
+/**
+ * @template TPayload
+ * @typedef {import("./strategy.js").SyncDelta<TPayload>} SyncDelta
+ */
+/**
+ * @typedef {import("./strategy.js").SyncDeltaContext} SyncDeltaContext
+ */
+/**
+ * @template TPayload
+ * @typedef {import("./strategy.js").SyncStrategy<TPayload>} SyncStrategy
+ */
+/**
+ * @typedef {import("./strategy.js").SyncStrategyKind} SyncStrategyKind
+ */
+export { AuthoritativeMirror, AuthoritativeRevalidationRequiredError } from "./authoritative-mirror.js";
+export { LogSync } from "./log-sync.js";
+export { RevisionMerge } from "./revision-merge.js";

package/src/services/sync/log-sync.js

@@ -0,0 +1,60 @@
+// @ts-check
+
+/**
+ * @typedef {import("../../models/sync.js").SyncApplyResult} SyncApplyResult
+ */
+/**
+ * @template TPayload
+ * @typedef {import("../../models/sync.js").SyncDelta<TPayload>} SyncDelta
+ */
+/**
+ * @typedef {import("../../models/sync.js").SyncDeltaContext} SyncDeltaContext
+ */
+/**
+ * @template TPayload
+ * @typedef {import("../../models/sync.js").SyncStrategy<TPayload>} SyncStrategy
+ */
+/**
+ * @template TPayload
+ * @typedef {{ readonly apply: (payload: TPayload, delta: SyncDelta<TPayload>) => Promise<void>; readonly key?: (delta: SyncDelta<TPayload>) => string; }} LogSyncOptions
+ */
+/**
+ * @template TPayload
+ * @implements {SyncStrategy<TPayload>}
+ */
+export class LogSync {
+    /** @readonly @type {"log"} */
+    kind = "log";
+    /**
+   * @readonly
+   * @type {LogSyncOptions<TPayload>["apply"]}
+   */
+    #apply;
+    /**
+   * @readonly
+   * @type {(delta: SyncDelta<TPayload>) => string}
+   */
+    #key;
+    #applied = new Set();
+    /**
+   * @param {LogSyncOptions<TPayload>} options
+   */
+    constructor(options) {
+        this.#apply = options.apply;
+        this.#key = options.key ?? ((delta) => delta.id);
+    }
+    /**
+   * @param {SyncDelta<TPayload>} delta
+   * @param {SyncDeltaContext} context
+   * @returns {Promise<SyncApplyResult>}
+   */
+    async applyDelta(delta, context) {
+        void context;
+        const key = this.#key(delta);
+        if (this.#applied.has(key))
+            return { applied: false };
+        await this.#apply(delta.payload, delta);
+        this.#applied.add(key);
+        return { applied: true };
+    }
+}

package/src/services/sync/revision-merge.js

@@ -0,0 +1,119 @@
+// @ts-check
+
+/**
+ * @template TValue
+ * @typedef {import("../../models/sync.js").RevisionCommandResult<TValue>} RevisionCommandResult
+ */
+/**
+ * @template TValue
+ * @typedef {import("../../models/sync.js").RevisionConflict<TValue>} RevisionConflict
+ */
+/**
+ * @template TValue
+ * @typedef {import("../../models/sync.js").RevisionEntity<TValue>} RevisionEntity
+ */
+/**
+ * @template TValue
+ * @typedef {import("../../models/sync.js").RevisionIntent<TValue>} RevisionIntent
+ */
+/**
+ * @typedef {import("../../models/sync.js").SyncApplyResult} SyncApplyResult
+ */
+/**
+ * @template TPayload
+ * @typedef {import("../../models/sync.js").SyncDelta<TPayload>} SyncDelta
+ */
+/**
+ * @typedef {import("../../models/sync.js").SyncDeltaContext} SyncDeltaContext
+ */
+/**
+ * @template TPayload
+ * @typedef {import("../../models/sync.js").SyncStrategy<TPayload>} SyncStrategy
+ */
+/**
+ * @template TValue
+ * @typedef {{ readonly parkConflict: (conflict: RevisionConflict<TValue>) => Promise<void>; readonly read: (id: string) => Promise<RevisionEntity<TValue> | undefined>; readonly write: (entity: RevisionEntity<TValue>) => Promise<void>; }} RevisionMergeOptions
+ */
+/**
+ * @template TValue
+ * @typedef {{ readonly baseRev?: number; readonly id: string; readonly value: TValue; }} RevisionWriteInput
+ */
+/**
+ * @template TValue
+ * @implements {SyncStrategy<RevisionEntity<TValue>>}
+ */
+export class RevisionMerge {
+    /** @readonly @type {"revision-merge"} */
+    kind = "revision-merge";
+    /**
+   * @readonly
+   * @type {RevisionMergeOptions<TValue>["parkConflict"]}
+   */
+    #parkConflict;
+    /**
+   * @readonly
+   * @type {RevisionMergeOptions<TValue>["read"]}
+   */
+    #read;
+    /**
+   * @readonly
+   * @type {RevisionMergeOptions<TValue>["write"]}
+   */
+    #write;
+    #applied = new Set();
+    /**
+   * @param {RevisionMergeOptions<TValue>} options
+   */
+    constructor(options) {
+        this.#parkConflict = options.parkConflict;
+        this.#read = options.read;
+        this.#write = options.write;
+    }
+    /**
+   * @param {SyncDelta<RevisionEntity<TValue>>} delta
+   * @param {SyncDeltaContext} context
+   * @returns {Promise<SyncApplyResult>}
+   */
+    async applyDelta(delta, context) {
+        void context;
+        if (this.#applied.has(delta.id))
+            return { applied: false };
+        const local = await this.#read(delta.payload.id);
+        if (local !== undefined && local.rev >= delta.payload.rev) {
+            this.#applied.add(delta.id);
+            return { applied: false };
+        }
+        await this.#write(delta.payload);
+        this.#applied.add(delta.id);
+        return { applied: true };
+    }
+    /**
+   * @param {RevisionWriteInput<TValue>} input
+   * @returns {Promise<RevisionIntent<TValue>>}
+   */
+    async createIntent(input) {
+        const local = await this.#read(input.id);
+        return {
+            baseRev: input.baseRev ?? local?.rev ?? 0,
+            id: input.id,
+            value: input.value,
+        };
+    }
+    /**
+   * @param {RevisionIntent<TValue>} intent
+   * @param {RevisionCommandResult<TValue>} result
+   * @returns {Promise<void>}
+   */
+    async handleCommandResult(intent, result) {
+        if (result.status === "accepted") {
+            await this.#write(result.entity);
+            return;
+        }
+        await this.#parkConflict({
+            baseRev: intent.baseRev,
+            id: intent.id,
+            mine: intent.value,
+            theirs: result.theirs,
+        });
+    }
+}

package/src/services/sync/strategy.js

@@ -0,0 +1,44 @@
+// @ts-check
+
+/**
+ * @template TPayload
+ * @typedef {import("../../models/sync.js").AuthoritativeCommand<TPayload>} AuthoritativeCommand
+ */
+/**
+ * @template TValue
+ * @typedef {import("../../models/sync.js").AuthoritativeSnapshot<TValue>} AuthoritativeSnapshot
+ */
+/**
+ * @template TValue
+ * @typedef {import("../../models/sync.js").RevisionCommandResult<TValue>} RevisionCommandResult
+ */
+/**
+ * @template TValue
+ * @typedef {import("../../models/sync.js").RevisionConflict<TValue>} RevisionConflict
+ */
+/**
+ * @template TValue
+ * @typedef {import("../../models/sync.js").RevisionEntity<TValue>} RevisionEntity
+ */
+/**
+ * @template TValue
+ * @typedef {import("../../models/sync.js").RevisionIntent<TValue>} RevisionIntent
+ */
+/**
+ * @typedef {import("../../models/sync.js").SyncApplyResult} SyncApplyResult
+ */
+/**
+ * @template TPayload
+ * @typedef {import("../../models/sync.js").SyncDelta<TPayload>} SyncDelta
+ */
+/**
+ * @typedef {import("../../models/sync.js").SyncDeltaContext} SyncDeltaContext
+ */
+/**
+ * @template TPayload
+ * @typedef {import("../../models/sync.js").SyncStrategy<TPayload>} SyncStrategy
+ */
+/**
+ * @typedef {import("../../models/sync.js").SyncStrategyKind} SyncStrategyKind
+ */
+export {} from "../../models/sync.js";