@legendapp/state 2.2.0-next.7 → 2.2.0-next.71

package/sync.mjs

@@ -0,0 +1,912 @@
+import { isObject, isPromise, observable, when, internal as internal$1, mergeIntoObservable, isEmpty, isString, setAtPath, endBatch, beginBatch, constructObjectWithPath, deconstructObjectWithPath, isFunction, isArray, whenReady } from '@legendapp/state';
+
+const observableSyncConfiguration = {};
+function configureObservableSync(options) {
+    Object.assign(observableSyncConfiguration, options);
+}
+
+function removeNullUndefined(val) {
+    if (val) {
+        Object.keys(val).forEach((key) => {
+            const v = val[key];
+            if (v === null || v === undefined) {
+                delete val[key];
+            }
+            else if (isObject(v)) {
+                removeNullUndefined(v);
+            }
+        });
+    }
+    return val;
+}
+
+function syncObservableAdapter({ get, set }) {
+    const ret = {};
+    if (get) {
+        ret.get = (async (params) => {
+            try {
+                let value = get(params);
+                if (isPromise(value)) {
+                    value = await value;
+                }
+                params.onChange({
+                    value,
+                    lastSync: params.lastSync,
+                    mode: params.mode,
+                });
+                params.onGet();
+                // eslint-disable-next-line no-empty
+            }
+            catch (_a) { }
+        });
+    }
+    if (set) {
+        ret.set = set;
+    }
+    return ret;
+}
+
+const { createPreviousHandler, globalState: globalState$1, symbolLinked: symbolLinked$2, getNode, getNodeValue: getNodeValue$1 } = internal$1;
+const mapSyncPlugins = new WeakMap();
+const metadatas = new WeakMap();
+const promisesLocalSaves = new Set();
+function parseLocalConfig(config) {
+    return config
+        ? isString(config)
+            ? { table: config, config: { name: config } }
+            : { table: config.name, config }
+        : {};
+}
+function doInOrder(arg1, arg2) {
+    return isPromise(arg1) ? arg1.then(arg2) : arg2(arg1);
+}
+function onChangeRemote(cb) {
+    endBatch(true);
+    // Remote changes should only update local state
+    globalState$1.isLoadingRemote = true;
+    beginBatch();
+    cb();
+    // Reset isLoadingRemote before ending the batch so it doesn't
+    // apply to any side effects
+    globalState$1.isLoadingRemote = false;
+    endBatch(true);
+}
+function transformSaveData(value, path, pathTypes, { transform }) {
+    if (transform === null || transform === void 0 ? void 0 : transform.save) {
+        const constructed = constructObjectWithPath(path, pathTypes, value);
+        const saved = transform.save(constructed);
+        value = deconstructObjectWithPath(path, pathTypes, saved);
+    }
+    return value;
+}
+function transformLoadData(value, { transform }, doUserTransform) {
+    if (doUserTransform && (transform === null || transform === void 0 ? void 0 : transform.load)) {
+        value = transform.load(value);
+    }
+    return value;
+}
+async function updateMetadataImmediate(obs, localState, syncState, syncOptions, newMetadata) {
+    const saves = Array.from(promisesLocalSaves);
+    if (saves.length > 0) {
+        await Promise.all(saves);
+    }
+    const { pluginPersist } = localState;
+    const { table, config } = parseLocalConfig(syncOptions === null || syncOptions === void 0 ? void 0 : syncOptions.persist);
+    // Save metadata
+    const oldMetadata = metadatas.get(obs);
+    const { lastSync, pending } = newMetadata;
+    const needsUpdate = pending || (lastSync && (!oldMetadata || lastSync !== oldMetadata.lastSync));
+    if (needsUpdate) {
+        const metadata = Object.assign({}, oldMetadata, newMetadata);
+        metadatas.set(obs, metadata);
+        if (pluginPersist) {
+            await pluginPersist.setMetadata(table, metadata, config);
+        }
+        if (lastSync) {
+            syncState.assign({
+                lastSync: lastSync,
+            });
+        }
+    }
+}
+function updateMetadata(obs, localState, syncState, syncOptions, newMetadata) {
+    if (localState.timeoutSaveMetadata) {
+        clearTimeout(localState.timeoutSaveMetadata);
+    }
+    localState.timeoutSaveMetadata = setTimeout(() => updateMetadataImmediate(obs, localState, syncState, syncOptions, newMetadata), 0);
+}
+let _queuedChanges = [];
+const _queuedRemoteChanges = new Map();
+const _queuedRemoteChangesTimeouts = new Map();
+function mergeChanges(changes) {
+    const changesByPath = new Map();
+    const changesOut = [];
+    // TODO: This could be even more robust by going deeper into paths like the firebase plugin's _updatePendingSave
+    for (let i = 0; i < changes.length; i++) {
+        const change = changes[i];
+        const pathStr = change.path.join('/');
+        const existing = changesByPath.get(pathStr);
+        if (existing) {
+            existing.valueAtPath = change.valueAtPath;
+        }
+        else {
+            changesByPath.set(pathStr, change);
+            changesOut.push(change);
+        }
+    }
+    return changesOut;
+}
+function mergeQueuedChanges(allChanges) {
+    const changesByObsRemote = new Map();
+    const changesByObsLocal = new Map();
+    const previousByObs = new Map();
+    const outRemote = new Map();
+    const outLocal = new Map();
+    for (let i = 0; i < allChanges.length; i++) {
+        const value = allChanges[i];
+        const { obs, changes, inRemoteChange, getPrevious } = value;
+        const changesMap = inRemoteChange ? changesByObsRemote : changesByObsLocal;
+        const existing = changesMap.get(obs);
+        const newChanges = existing ? [...existing, ...changes] : changes;
+        const merged = mergeChanges(newChanges);
+        changesMap.set(obs, merged);
+        value.changes = merged;
+        if (!previousByObs.has(obs)) {
+            previousByObs.set(obs, getPrevious());
+        }
+        value.valuePrevious = previousByObs.get(obs);
+        (inRemoteChange ? outRemote : outLocal).set(obs, value);
+    }
+    return Array.from(outRemote.values()).concat(Array.from(outLocal.values()));
+}
+async function processQueuedChanges() {
+    var _a;
+    // Get a local copy of the queued changes and clear the global queue
+    const queuedChanges = mergeQueuedChanges(_queuedChanges);
+    _queuedChanges = [];
+    const pendingSyncOptions = new Set();
+    for (let i = 0; i < queuedChanges.length; i++) {
+        const change = queuedChanges[i];
+        if (!change.inRemoteChange) {
+            if (!_queuedRemoteChanges.has(change.syncOptions)) {
+                _queuedRemoteChanges.set(change.syncOptions, []);
+            }
+            pendingSyncOptions.add(change.syncOptions);
+            _queuedRemoteChanges.get(change.syncOptions).push(change);
+        }
+    }
+    // Note: Summary of the order of operations these functions:
+    // 1. Prepare all changes for saving. This may involve waiting for promises if the user has asynchronous transform.
+    // We need to prepare all of the changes in the queue before saving so that the saves happen in the correct order,
+    // since some may take longer to transformSaveData than others.
+    // 2. Save pending to the metadata table first. If this is the only operation that succeeds, it would try to save
+    // the current value again on next load, which isn't too bad.
+    // 3. Save local changes to storage. If they never make it to remote, then on the next load they will be pending
+    // and attempted again.
+    // 4. Wait for remote load or error if allowed
+    // 5. Save to remote
+    // 6. On successful save, merge changes (if any) back into observable
+    // 7. Lastly, update metadata to clear pending and update lastSync. Doing this earlier could potentially cause
+    // sync inconsistences so it's very important that this is last.
+    const preppedChangesLocal = await Promise.all(queuedChanges.map(prepChangeLocal));
+    // TODO Clean this up: We only need to prep this now in order to save pending changes, don't need any of the other stuff. Should split that up?
+    await Promise.all(queuedChanges.map(prepChangeRemote));
+    await Promise.all(preppedChangesLocal.map(doChangeLocal));
+    for (const options of pendingSyncOptions) {
+        const timeout = (_a = options.debounceSet) !== null && _a !== void 0 ? _a : observableSyncConfiguration === null || observableSyncConfiguration === void 0 ? void 0 : observableSyncConfiguration.debounceSet;
+        const timeoutSaveRemote = _queuedRemoteChangesTimeouts.get(options);
+        const run = () => processQueuedRemoteChanges(options);
+        if (timeout) {
+            if (timeoutSaveRemote) {
+                clearTimeout(timeoutSaveRemote);
+            }
+            _queuedRemoteChangesTimeouts.set(options, setTimeout(run, timeout));
+        }
+        else {
+            run();
+        }
+    }
+}
+async function processQueuedRemoteChanges(syncOptions) {
+    const arr = _queuedRemoteChanges.get(syncOptions);
+    if (arr === null || arr === void 0 ? void 0 : arr.length) {
+        const queuedRemoteChanges = mergeQueuedChanges(arr);
+        _queuedRemoteChanges.set(syncOptions, []);
+        const preppedChangesRemote = await Promise.all(queuedRemoteChanges.map(prepChangeRemote));
+        preppedChangesRemote.forEach(doChangeRemote);
+    }
+}
+async function prepChangeLocal(queuedChange) {
+    const { syncState, changes, localState, syncOptions, inRemoteChange, isApplyingPending } = queuedChange;
+    const persist = syncOptions.persist;
+    const { pluginSync } = localState;
+    const { config: configLocal } = parseLocalConfig(persist);
+    const configRemote = syncOptions;
+    const saveLocal = (persist === null || persist === void 0 ? void 0 : persist.name) && !configLocal.readonly && !isApplyingPending && syncState.isPersistEnabled.peek();
+    const saveRemote = !!(!inRemoteChange &&
+        (pluginSync === null || pluginSync === void 0 ? void 0 : pluginSync.set) &&
+        (configRemote === null || configRemote === void 0 ? void 0 : configRemote.enableSync) !== false &&
+        syncState.isEnabledRemote.peek());
+    if (saveLocal || saveRemote) {
+        if (saveLocal && !syncState.isPersistLoaded.peek()) {
+            console.error('[legend-state] WARNING: An observable was changed before being loaded from persist', persist);
+            return undefined;
+        }
+        const changesLocal = [];
+        const changesPaths = new Set();
+        let promisesTransform = [];
+        // Reverse order
+        for (let i = changes.length - 1; i >= 0; i--) {
+            const { path } = changes[i];
+            let found = false;
+            // Optimization to only save the latest update at each path. We might have multiple changes at the same path
+            // and we only need the latest value, so it starts from the end of the array, skipping any earlier changes
+            // already processed. If a later change modifies a parent of an earlier change (which happens on delete()
+            // it should be ignored as it's superseded by the parent modification.
+            if (changesPaths.size > 0) {
+                for (let u = 0; u < path.length; u++) {
+                    if (changesPaths.has((u === path.length - 1 ? path : path.slice(0, u + 1)).join('/'))) {
+                        found = true;
+                        break;
+                    }
+                }
+            }
+            if (!found) {
+                const pathStr = path.join('/');
+                changesPaths.add(pathStr);
+                const { prevAtPath, valueAtPath, pathTypes } = changes[i];
+                if (saveLocal) {
+                    const promiseTransformLocal = transformSaveData(valueAtPath, path, pathTypes, configLocal);
+                    promisesTransform.push(doInOrder(promiseTransformLocal, (valueTransformed) => {
+                        // Prepare the local change with the transformed path/value
+                        changesLocal.push({
+                            path,
+                            pathTypes,
+                            prevAtPath,
+                            valueAtPath: valueTransformed,
+                            pathStr,
+                        });
+                    }));
+                }
+            }
+        }
+        // If there's any transform promises, wait for them before saving
+        promisesTransform = promisesTransform.filter(Boolean);
+        if (promisesTransform.length > 0) {
+            await Promise.all(promisesTransform);
+        }
+        return { queuedChange, changesLocal, saveRemote };
+    }
+}
+async function prepChangeRemote(queuedChange) {
+    const { syncState, changes, localState, syncOptions: syncOptions, inRemoteChange, isApplyingPending, valuePrevious, } = queuedChange;
+    const persist = syncOptions.persist;
+    const { pluginSync } = localState;
+    const { config: configLocal } = parseLocalConfig(persist);
+    const configRemote = syncOptions;
+    const saveLocal = persist && !configLocal.readonly && !isApplyingPending && syncState.isPersistEnabled.peek();
+    const saveRemote = !inRemoteChange && (pluginSync === null || pluginSync === void 0 ? void 0 : pluginSync.set) && (configRemote === null || configRemote === void 0 ? void 0 : configRemote.enableSync) !== false && syncState.isEnabledRemote.peek();
+    if (saveLocal || saveRemote) {
+        if (saveLocal && !syncState.isPersistLoaded.peek()) {
+            console.error('[legend-state] WARNING: An observable was changed before being loaded from persist', persist);
+            return undefined;
+        }
+        const changesRemote = [];
+        const changesPaths = new Set();
+        let promisesTransform = [];
+        // Reverse order
+        for (let i = changes.length - 1; i >= 0; i--) {
+            const { path } = changes[i];
+            let found = false;
+            // Optimization to only save the latest update at each path. We might have multiple changes at the same path
+            // and we only need the latest value, so it starts from the end of the array, skipping any earlier changes
+            // already processed. If a later change modifies a parent of an earlier change (which happens on delete()
+            // it should be ignored as it's superseded by the parent modification.
+            if (changesPaths.size > 0) {
+                for (let u = 0; u < path.length; u++) {
+                    if (changesPaths.has((u === path.length - 1 ? path : path.slice(0, u + 1)).join('/'))) {
+                        found = true;
+                        break;
+                    }
+                }
+            }
+            if (!found) {
+                const pathStr = path.join('/');
+                changesPaths.add(pathStr);
+                const { prevAtPath, valueAtPath, pathTypes } = changes[i];
+                if (saveRemote) {
+                    const promiseTransformRemote = transformSaveData(valueAtPath, path, pathTypes, configRemote || {});
+                    promisesTransform.push(doInOrder(promiseTransformRemote, (valueTransformed) => {
+                        var _a;
+                        // Prepare pending changes
+                        if (!localState.pendingChanges) {
+                            localState.pendingChanges = {};
+                        }
+                        // First look for existing pending changes at a higher level than this change
+                        // If they exist then merge this change into it
+                        let found = false;
+                        for (let i = 0; !found && i < path.length - 1; i++) {
+                            const pathParent = path.slice(0, i + 1).join('/');
+                            if ((_a = localState.pendingChanges[pathParent]) === null || _a === void 0 ? void 0 : _a.v) {
+                                found = true;
+                                const pathChild = path.slice(i + 1);
+                                const pathTypesChild = pathTypes.slice(i + 1);
+                                setAtPath(localState.pendingChanges[pathParent].v, pathChild, pathTypesChild, valueAtPath);
+                            }
+                        }
+                        if (!found) {
+                            // If an existing pending change is deeper than this change, just delete it
+                            // in favor of this wider change
+                            for (const key in localState.pendingChanges) {
+                                if (key !== pathStr && key.startsWith(pathStr)) {
+                                    delete localState.pendingChanges[key];
+                                }
+                            }
+                            // The "p" saved in pending should be the previous state before changes,
+                            // so don't overwrite it if it already exists
+                            if (!localState.pendingChanges[pathStr]) {
+                                localState.pendingChanges[pathStr] = { p: prevAtPath !== null && prevAtPath !== void 0 ? prevAtPath : null, t: pathTypes };
+                            }
+                            // Pending value is the untransformed value because it gets loaded without transformment
+                            // and forwarded through to onObsChange where it gets transformed before save
+                            localState.pendingChanges[pathStr].v = valueAtPath;
+                        }
+                        // Prepare the remote change with the transformed path/value
+                        changesRemote.push({
+                            path,
+                            pathTypes,
+                            prevAtPath,
+                            valueAtPath: valueTransformed,
+                            pathStr,
+                            valuePrevious,
+                        });
+                    }));
+                }
+            }
+        }
+        // If there's any transform promises, wait for them before saving
+        promisesTransform = promisesTransform.filter(Boolean);
+        if (promisesTransform.length > 0) {
+            await Promise.all(promisesTransform);
+        }
+        return { queuedChange, changesRemote };
+    }
+}
+async function doChangeLocal(changeInfo) {
+    if (!changeInfo)
+        return;
+    const { queuedChange, changesLocal, saveRemote } = changeInfo;
+    const { obs, syncState, localState, syncOptions: syncOptions } = queuedChange;
+    const { pluginPersist } = localState;
+    const persist = syncOptions.persist;
+    const { table, config: configLocal } = parseLocalConfig(persist);
+    const configRemote = syncOptions;
+    const shouldSaveMetadata = persist && (configRemote === null || configRemote === void 0 ? void 0 : configRemote.offlineBehavior) === 'retry';
+    if (saveRemote && shouldSaveMetadata) {
+        // First save pending changes before saving local or remote
+        await updateMetadataImmediate(obs, localState, syncState, syncOptions, {
+            pending: localState.pendingChanges,
+        });
+    }
+    if (changesLocal.length > 0) {
+        // Save the changes to local cache before saving to remote. They are already marked as pending so
+        // if remote sync fails or the app is closed before remote sync, it will attempt to sync them on the next load.
+        let promiseSet = pluginPersist.set(table, changesLocal, configLocal);
+        if (promiseSet) {
+            promiseSet = promiseSet.then(() => {
+                promisesLocalSaves.delete(promiseSet);
+            });
+            // Keep track of local save promises so that updateMetadata runs only after everything is saved
+            promisesLocalSaves.add(promiseSet);
+            // await the local save before proceeding to save remotely
+            await promiseSet;
+        }
+    }
+}
+async function doChangeRemote(changeInfo) {
+    var _a, _b;
+    if (!changeInfo)
+        return;
+    const { queuedChange, changesRemote } = changeInfo;
+    const { obs, syncState, localState, syncOptions, valuePrevious: previous } = queuedChange;
+    const { pluginPersist, pluginSync } = localState;
+    const persist = syncOptions.persist;
+    const { table, config: configLocal } = parseLocalConfig(persist);
+    const { offlineBehavior, allowSetIfGetError, onBeforeSet, onSetError, waitForSet, onAfterSet } = syncOptions || {};
+    const shouldSaveMetadata = persist && offlineBehavior === 'retry';
+    if (changesRemote.length > 0) {
+        // Wait for remote to be ready before saving
+        await when(() => syncState.isLoaded.get() || (allowSetIfGetError && syncState.error.get()));
+        if (waitForSet) {
+            const waitFor = isFunction(waitForSet)
+                ? waitForSet({ changes: changesRemote, value: obs.peek() })
+                : waitForSet;
+            if (waitFor) {
+                await when(waitFor);
+            }
+        }
+        let value = obs.peek();
+        const transformSave = (_a = syncOptions === null || syncOptions === void 0 ? void 0 : syncOptions.transform) === null || _a === void 0 ? void 0 : _a.save;
+        if (transformSave) {
+            value = transformSave(value);
+        }
+        onBeforeSet === null || onBeforeSet === void 0 ? void 0 : onBeforeSet();
+        localState.numSavesOutstanding = (localState.numSavesOutstanding || 0) + 1;
+        let savedPromise = pluginSync.set({
+            obs,
+            syncState: syncState,
+            options: syncOptions,
+            changes: changesRemote,
+            value,
+            valuePrevious: previous,
+        });
+        if (isPromise(savedPromise)) {
+            savedPromise = savedPromise.catch((err) => onSetError === null || onSetError === void 0 ? void 0 : onSetError(err));
+        }
+        const saved = await savedPromise;
+        localState.numSavesOutstanding--;
+        // If this remote save changed anything then update cache and metadata
+        // Because save happens after a timeout and they're batched together, some calls to save will
+        // return saved data and others won't, so those can be ignored.
+        if (saved) {
+            const pathStrs = Array.from(new Set(changesRemote.map((change) => change.pathStr)));
+            const { changes, lastSync } = saved;
+            if (pathStrs.length > 0) {
+                if (persist) {
+                    const metadata = {};
+                    const pendingMetadata = (_b = pluginPersist.getMetadata(table, configLocal)) === null || _b === void 0 ? void 0 : _b.pending;
+                    const pending = localState.pendingChanges;
+                    let transformedChanges = undefined;
+                    for (let i = 0; i < pathStrs.length; i++) {
+                        const pathStr = pathStrs[i];
+                        // Clear pending for this path
+                        if (pending === null || pending === void 0 ? void 0 : pending[pathStr]) {
+                            // Remove pending from local state
+                            delete pending[pathStr];
+                        }
+                        // Clear pending for this path
+                        if (pendingMetadata === null || pendingMetadata === void 0 ? void 0 : pendingMetadata[pathStr]) {
+                            // Remove pending from persisted medata state
+                            delete pendingMetadata[pathStr];
+                            metadata.pending = pendingMetadata;
+                        }
+                    }
+                    if (lastSync) {
+                        metadata.lastSync = lastSync;
+                    }
+                    // Remote can optionally have data that needs to be merged back into the observable,
+                    // for example Firebase may update dateModified with the server timestamp
+                    if (changes && !isEmpty(changes)) {
+                        transformedChanges = transformLoadData(changes, syncOptions, false);
+                    }
+                    if (localState.numSavesOutstanding > 0) {
+                        if (transformedChanges) {
+                            if (!localState.pendingSaveResults) {
+                                localState.pendingSaveResults = [];
+                            }
+                            localState.pendingSaveResults.push(transformedChanges);
+                        }
+                    }
+                    else {
+                        let allChanges = [...(localState.pendingSaveResults || []), transformedChanges].filter((v) => v !== undefined);
+                        if (allChanges.length > 0) {
+                            if (allChanges.some((change) => isPromise(change))) {
+                                allChanges = await Promise.all(allChanges);
+                            }
+                            onChangeRemote(() => mergeIntoObservable(obs, ...allChanges));
+                        }
+                        if (shouldSaveMetadata && !isEmpty(metadata)) {
+                            updateMetadata(obs, localState, syncState, syncOptions, metadata);
+                        }
+                        localState.pendingSaveResults = [];
+                    }
+                }
+                onAfterSet === null || onAfterSet === void 0 ? void 0 : onAfterSet();
+            }
+        }
+    }
+}
+function onObsChange(obs, syncState, localState, syncOptions, { changes, loading, remote, getPrevious }) {
+    if (!loading) {
+        const inRemoteChange = remote;
+        const isApplyingPending = localState.isApplyingPending;
+        // Queue changes in a microtask so that multiple changes within a frame get run together
+        _queuedChanges.push({
+            obs: obs,
+            syncState,
+            localState,
+            syncOptions,
+            changes,
+            inRemoteChange,
+            isApplyingPending: isApplyingPending,
+            getPrevious,
+        });
+        if (_queuedChanges.length === 1) {
+            queueMicrotask(processQueuedChanges);
+        }
+    }
+}
+async function loadLocal(obs, syncOptions, syncState, localState) {
+    var _a, _b;
+    const { persist } = syncOptions;
+    if (persist) {
+        const PersistPlugin = persist.plugin || ((_a = observableSyncConfiguration.persist) === null || _a === void 0 ? void 0 : _a.plugin);
+        const { table, config } = parseLocalConfig(persist);
+        const node = getNode(obs);
+        if (!PersistPlugin) {
+            throw new Error('Local persist is not configured');
+        }
+        // Ensure there's only one instance of the cache plugin
+        if (!mapSyncPlugins.has(PersistPlugin)) {
+            const persistPlugin = new PersistPlugin();
+            const mapValue = { plugin: persistPlugin, initialized: observable(false) };
+            mapSyncPlugins.set(PersistPlugin, mapValue);
+            if (persistPlugin.initialize) {
+                const initializePromise = (_b = persistPlugin.initialize) === null || _b === void 0 ? void 0 : _b.call(persistPlugin, (observableSyncConfiguration === null || observableSyncConfiguration === void 0 ? void 0 : observableSyncConfiguration.persist) || {});
+                if (isPromise(initializePromise)) {
+                    await initializePromise;
+                }
+            }
+            mapValue.initialized.set(true);
+        }
+        const { plugin, initialized: initialized$ } = mapSyncPlugins.get(PersistPlugin);
+        const persistPlugin = plugin;
+        localState.pluginPersist = persistPlugin;
+        if (!initialized$.peek()) {
+            await when(initialized$);
+        }
+        // If cache has an asynchronous load, wait for it
+        if (persistPlugin.loadTable) {
+            const promise = persistPlugin.loadTable(table, config);
+            if (promise) {
+                await promise;
+            }
+        }
+        // Get current value for init
+        const prevValue = getNodeValue$1(node);
+        // Get the value from state
+        let value = persistPlugin.getTable(table, prevValue, config);
+        const metadata = persistPlugin.getMetadata(table, config);
+        if (metadata) {
+            metadatas.set(obs, metadata);
+            localState.pendingChanges = metadata.pending;
+            syncState.assign({
+                lastSync: metadata.lastSync,
+            });
+        }
+        // Merge the data from local cache into the default state
+        if (value !== undefined) {
+            const { transform } = config;
+            value = transformLoadData(value, { transform }, true);
+            if (isPromise(value)) {
+                value = await value;
+            }
+            // isLoadingLocal prevents saving remotely when two different caches
+            // are set on the same observable
+            internal$1.globalState.isLoadingLocal = true;
+            // We want to merge the local data on top of any initial state the object is created with
+            if (value === null && (!prevValue || prevValue[symbolLinked$2])) {
+                obs.set(value);
+            }
+            else {
+                mergeIntoObservable(obs, value);
+            }
+            internal$1.globalState.isLoadingLocal = false;
+        }
+        node.state.peek().clearPersist = () => Promise.all([
+            persistPlugin.deleteTable(table, config),
+            persistPlugin.deleteMetadata(table, config),
+        ]);
+    }
+    syncState.isPersistLoaded.set(true);
+}
+function syncObservable(obs$, syncOptions) {
+    const node = getNode(obs$);
+    // Merge remote sync options with global options
+    if (syncOptions) {
+        syncOptions = Object.assign({
+            syncMode: 'auto',
+        }, observableSyncConfiguration, removeNullUndefined(syncOptions));
+    }
+    const localState = {};
+    let sync;
+    const syncState = (node.state = observable({
+        isPersistLoaded: false,
+        isLoaded: !syncOptions.get,
+        isPersistEnabled: true,
+        isEnabledRemote: true,
+        clearPersist: undefined,
+        sync: () => Promise.resolve(),
+        getPendingChanges: () => localState.pendingChanges,
+    }));
+    loadLocal(obs$, syncOptions, syncState, localState);
+    localState.pluginSync = syncObservableAdapter(syncOptions);
+    if (syncOptions.get) {
+        let isSynced = false;
+        sync = async () => {
+            var _a, _b;
+            const lastSync = (_a = metadatas.get(obs$)) === null || _a === void 0 ? void 0 : _a.lastSync;
+            const pending = localState.pendingChanges;
+            const get = (_b = localState.pluginSync.get) === null || _b === void 0 ? void 0 : _b.bind(localState.pluginSync);
+            if (get) {
+                const runGet = () => {
+                    get({
+                        state: syncState,
+                        obs: obs$,
+                        options: syncOptions,
+                        lastSync,
+                        dateModified: lastSync,
+                        onError: (error) => {
+                            var _a;
+                            (_a = syncOptions.onGetError) === null || _a === void 0 ? void 0 : _a.call(syncOptions, error);
+                        },
+                        onGet: () => {
+                            node.state.assign({
+                                isLoaded: true,
+                                error: undefined,
+                            });
+                        },
+                        onChange: async ({ value, mode, lastSync }) => {
+                            mode = mode || syncOptions.mode || 'set';
+                            if (value !== undefined) {
+                                value = transformLoadData(value, syncOptions, true);
+                                if (isPromise(value)) {
+                                    value = await value;
+                                }
+                                const pending = localState.pendingChanges;
+                                if (pending) {
+                                    Object.keys(pending).forEach((key) => {
+                                        const p = key.split('/').filter((p) => p !== '');
+                                        const { v, t } = pending[key];
+                                        if (t.length === 0 || !value) {
+                                            if (isObject(value) && isObject(v)) {
+                                                Object.assign(value, v);
+                                            }
+                                            else {
+                                                value = v;
+                                            }
+                                        }
+                                        else if (value[p[0]] !== undefined) {
+                                            value = setAtPath(value, p, t, v, 'merge', obs$.peek(), (path, value) => {
+                                                delete pending[key];
+                                                pending[path.join('/')] = {
+                                                    p: null,
+                                                    v: value,
+                                                    t: t.slice(0, path.length),
+                                                };
+                                            });
+                                        }
+                                    });
+                                }
+                                onChangeRemote(() => {
+                                    if (mode === 'assign' && isObject(value)) {
+                                        obs$.assign(value);
+                                    }
+                                    else if (mode === 'append' && isArray(value)) {
+                                        obs$.push(...value);
+                                    }
+                                    else if (mode === 'prepend' && isArray(value)) {
+                                        obs$.splice(0, 0, ...value);
+                                    }
+                                    else if (mode === 'merge') {
+                                        mergeIntoObservable(obs$, value);
+                                    }
+                                    else {
+                                        obs$.set(value);
+                                    }
+                                });
+                            }
+                            if (lastSync && syncOptions.persist) {
+                                updateMetadata(obs$, localState, syncState, syncOptions, {
+                                    lastSync,
+                                });
+                            }
+                        },
+                    });
+                };
+                runGet();
+            }
+            else {
+                node.state.assign({
+                    isLoaded: true,
+                    error: undefined,
+                });
+            }
+            if (!isSynced) {
+                isSynced = true;
+                // Wait for remote to be ready before saving pending
+                await when(() => syncState.isLoaded.get() || (syncOptions.allowSetIfGetError && syncState.error.get()));
+                if (pending && !isEmpty(pending)) {
+                    localState.isApplyingPending = true;
+                    const keys = Object.keys(pending);
+                    // Bundle up all the changes from pending
+                    const changes = [];
+                    for (let i = 0; i < keys.length; i++) {
+                        const key = keys[i];
+                        const path = key.split('/').filter((p) => p !== '');
+                        const { p, v, t } = pending[key];
+                        changes.push({ path, valueAtPath: v, prevAtPath: p, pathTypes: t });
+                    }
+                    // Send the changes into onObsChange so that they get synced remotely
+                    const value = getNodeValue$1(node);
+                    onObsChange(obs$, syncState, localState, syncOptions, {
+                        value,
+                        loading: false,
+                        remote: false,
+                        getPrevious: createPreviousHandler(value, changes),
+                        changes,
+                    });
+                    localState.isApplyingPending = false;
+                }
+            }
+        };
+        syncState.assign({ sync });
+    }
+    // Wait for this node and all parent nodes up the hierarchy to be loaded
+    const onAllPersistLoaded = () => {
+        var _a, _b;
+        let parentNode = node;
+        while (parentNode) {
+            if (((_b = (_a = parentNode.state) === null || _a === void 0 ? void 0 : _a.isPersistLoaded) === null || _b === void 0 ? void 0 : _b.get()) === false) {
+                return false;
+            }
+            parentNode = parentNode.parent;
+        }
+        return true;
+    };
+    // When all is loaded locally we can start syncing and listening for changes
+    when(onAllPersistLoaded, function () {
+        // If remote is not manual, then sync() is called automatically
+        if (syncOptions.get && syncOptions.syncMode === 'auto') {
+            sync();
+        }
+        obs$.onChange(onObsChange.bind(this, obs$, syncState, localState, syncOptions));
+    });
+    return syncState;
+}
+
+const { getProxy, globalState, runWithRetry, symbolLinked: symbolLinked$1, setNodeValue, getNodeValue } = internal$1;
+function enableActivateSyncedNode() {
+    globalState.activateSyncedNode = function activateSyncedNode(node, newValue) {
+        const obs$ = getProxy(node);
+        if (node.activationState) {
+            // If it is a Synced
+            const { get, initial, set, subscribe } = node.activationState;
+            let onChange = undefined;
+            const pluginRemote = {};
+            let promiseReturn = undefined;
+            // Not sure why this disable is needed, but it's needed to make the linter happy
+            // eslint-disable-next-line prefer-const
+            let syncState;
+            const refresh = () => syncState === null || syncState === void 0 ? void 0 : syncState.sync();
+            if (get) {
+                pluginRemote.get = (params) => {
+                    onChange = params.onChange;
+                    const updateLastSync = (lastSync) => (params.lastSync = lastSync);
+                    const setMode = (mode) => (params.mode = mode);
+                    const existingValue = getNodeValue(node);
+                    const value = runWithRetry(node, { attemptNum: 0 }, () => {
+                        return get({
+                            value: isFunction(existingValue) || (existingValue === null || existingValue === void 0 ? void 0 : existingValue[symbolLinked$1]) ? undefined : existingValue,
+                            lastSync: params.lastSync,
+                            updateLastSync,
+                            setMode,
+                            refresh,
+                        });
+                    });
+                    promiseReturn = value;
+                    return value;
+                };
+            }
+            if (set) {
+                // TODO: Work out these types better
+                pluginRemote.set = async (params) => {
+                    var _a;
+                    if ((_a = node.state) === null || _a === void 0 ? void 0 : _a.isLoaded.get()) {
+                        const retryAttempts = { attemptNum: 0 };
+                        return runWithRetry(node, retryAttempts, async (retryEvent) => {
+                            let changes = {};
+                            let maxModified = 0;
+                            if (!node.state.isLoaded.peek()) {
+                                await whenReady(node.state.isLoaded);
+                            }
+                            const cancelRetry = () => {
+                                retryEvent.cancel = true;
+                            };
+                            await set({
+                                ...params,
+                                node,
+                                update: (params) => {
+                                    const { value, lastSync } = params;
+                                    maxModified = Math.max(lastSync || 0, maxModified);
+                                    changes = mergeIntoObservable(changes, value);
+                                },
+                                retryNum: retryAttempts.attemptNum,
+                                cancelRetry,
+                                refresh,
+                                fromSubscribe: false,
+                            });
+                            return { changes, lastSync: maxModified || undefined };
+                        });
+                    }
+                };
+            }
+            const nodeVal = getNodeValue(node);
+            if (promiseReturn !== undefined) {
+                newValue = promiseReturn;
+            }
+            else if (nodeVal !== undefined && !isFunction(nodeVal)) {
+                newValue = nodeVal;
+            }
+            else {
+                newValue = initial;
+            }
+            setNodeValue(node, promiseReturn ? undefined : newValue);
+            // @ts-expect-error TODO fix these types
+            syncState = syncObservable(obs$, { ...node.activationState, ...pluginRemote });
+            if (subscribe) {
+                when(promiseReturn || true, () => {
+                    subscribe({
+                        node,
+                        update: (params) => {
+                            if (!onChange) {
+                                // TODO: Make this message better
+                                console.log('[legend-state] Cannot update immediately before the first return');
+                            }
+                            else {
+                                onChange(params);
+                            }
+                        },
+                        refresh,
+                    });
+                });
+            }
+            return { update: onChange, value: newValue };
+        }
+        else {
+            // If it is not a Synced
+            let update = undefined;
+            const get = async (params) => {
+                update = params.refresh;
+                if (isPromise(newValue)) {
+                    try {
+                        newValue = await newValue;
+                    }
+                    catch (_a) {
+                        // TODO Once we have global retry settings this should retry
+                    }
+                }
+                return newValue;
+            };
+            syncObservable(obs$, {
+                get,
+            });
+            return { update: update, value: newValue };
+        }
+    };
+}
+
+const { symbolLinked } = internal$1;
+function synced(params) {
+    installPersistActivateNode();
+    return (() => ({
+        [symbolLinked]: { ...params, synced: true },
+    }));
+}
+let didInstall = false;
+function installPersistActivateNode() {
+    if (!didInstall) {
+        enableActivateSyncedNode();
+        didInstall = true;
+    }
+}
+
+function isInRemoteChange() {
+    return internal$1.globalState.isLoadingRemote;
+}
+const internal = {
+    observableSyncConfiguration,
+};
+
+export { configureObservableSync, internal, isInRemoteChange, mapSyncPlugins, syncObservable, synced };
+//# sourceMappingURL=sync.mjs.map