@recordtimelabel/core 0.1.7 → 0.1.9

package/README.md

@@ -17,11 +17,13 @@ During local development an app can consume a sibling checkout with:
 "@recordtimelabel/core": "file:../recordtimelabel-core"
 ```
 
-For release builds, consume a fixed npm package, git tag, or private registry version so builds do not depend on a sibling folder path. The current release candidate is:
+For release builds, consume a fixed npm package, git tag, or private registry version so builds do not depend on a sibling folder path. The current published release is:
 
 ```json
-"@recordtimelabel/core": "0.1.2"
+"@recordtimelabel/core": "0.1.9"
 ```
+
+If this checkout's `package.json` is ahead of the published version, publish the new package before updating consumers to that version.
 
 ## Public API
 
@@ -32,8 +34,8 @@ For release builds, consume a fixed npm package, git tag, or private registry ve
 - `applyRecordTimeLabelOperation(state, operation)`
 - `createSyncEngine({ storageAdapter, cloudAdapter, clientId, clock, logger })`
 - `createRecordTimeLabelController({ storageAdapter, cloudAdapter, clientId, settingKeys, clock, logger })`
-- `buildRecordTimeLabelSyncPayload({ data, previousCloudData, pendingOps, syncMode, clientId, now })`
-- `buildSyncPayloadWithOperations({ data, previousCloudData, pendingOps, syncMode, clientId, now })`
+- `buildRecordTimeLabelSyncPayload({ data, previousCloudData, pendingOps, syncMode, clientId, now, groupOrderNormalizer })`
+- `buildSyncPayloadWithOperations({ data, previousCloudData, pendingOps, syncMode, clientId, now, groupOrderNormalizer })`
 - `flushPendingOperations({ operations, storageAdapter, cloudAdapter, clientId, now })`
 - `mergeRemoteStateIntoLocal({ localData, remoteData, pendingOps, settingKeys, clientId, now })`
 - `buildLocalStateFromStorage(data, options)`
@@ -41,6 +43,7 @@ For release builds, consume a fixed npm package, git tag, or private registry ve
 - `buildFirestoreV1UserPatch(state, options)`
 - `buildFirestoreV2LogicalPaths(userId)`
 - `buildFirestoreV2DocumentsFromState(state, options)`
+- `buildFirestoreV2DocumentChangeSet(previousDocuments, nextDocuments, options)`
 - `buildStateFromFirestoreV2Documents(documents, options)`
 - `hasMeaningfulRecordTimeLabelCloudState(data, options)`
 - `buildRecordTimeLabelContentFingerprint(data)`

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@recordtimelabel/core",
-  "version": "0.1.7",
+  "version": "0.1.9",
   "type": "module",
   "description": "Shared RecordTimeLabel data model, merge logic, operations, and sync engine.",
   "main": "./src/index.js",

package/src/index.js

@@ -5,7 +5,7 @@ const REQUIRED_FOLDERS = [
   { id: DEFAULT_FOLDER_ID, name: 'Uncategorized' }
 ];
 
-export const RECORD_TIMELABEL_CORE_VERSION = '0.1.6';
+export const RECORD_TIMELABEL_CORE_VERSION = '0.1.9';
 
 export const OPERATION_TYPES = Object.freeze({
   RECORD_CREATE: 'record.create',
@@ -1274,6 +1274,94 @@ export const buildFirestoreV2DocumentsFromState = (state = {}, options = {}) =>
   };
 };
 
+const canonicalizeFirestoreV2DocumentValue = (value) => {
+  if (Array.isArray(value)) {
+    return value.map((entry) => canonicalizeFirestoreV2DocumentValue(entry));
+  }
+  if (value instanceof Date) {
+    return value.toISOString();
+  }
+  if (!value || typeof value !== 'object') {
+    return value;
+  }
+
+  return Object.keys(value)
+    .sort()
+    .reduce((result, key) => {
+      result[key] = canonicalizeFirestoreV2DocumentValue(value[key]);
+      return result;
+    }, {});
+};
+
+const areFirestoreV2DocumentValuesEqual = (left, right) => (
+  JSON.stringify(canonicalizeFirestoreV2DocumentValue(left)) ===
+  JSON.stringify(canonicalizeFirestoreV2DocumentValue(right))
+);
+
+const buildFirestoreV2CollectionChangeSet = (previousCollection, nextCollection, allowDeletes) => {
+  const previous = previousCollection && typeof previousCollection === 'object'
+    ? previousCollection
+    : {};
+  const next = nextCollection && typeof nextCollection === 'object'
+    ? nextCollection
+    : {};
+  const upserts = {};
+
+  Object.keys(next).sort().forEach((documentId) => {
+    if (!Object.prototype.hasOwnProperty.call(previous, documentId) ||
+      !areFirestoreV2DocumentValuesEqual(previous[documentId], next[documentId])) {
+      upserts[documentId] = next[documentId];
+    }
+  });
+
+  const deleteIds = allowDeletes
+    ? Object.keys(previous).filter((documentId) => (
+      !Object.prototype.hasOwnProperty.call(next, documentId)
+    )).sort()
+    : [];
+
+  return { upserts, deleteIds };
+};
+
+export const buildFirestoreV2DocumentChangeSet = (
+  previousDocuments = {},
+  nextDocuments = {},
+  options = {}
+) => {
+  const allowDeletes = options.allowDeletes === true;
+  const previousRoot = previousDocuments?.root;
+  const nextRoot = nextDocuments?.root;
+  const rootUpsert = nextRoot && !areFirestoreV2DocumentValuesEqual(previousRoot, nextRoot)
+    ? nextRoot
+    : null;
+  const records = buildFirestoreV2CollectionChangeSet(
+    previousDocuments?.records,
+    nextDocuments?.records,
+    allowDeletes
+  );
+  const folders = buildFirestoreV2CollectionChangeSet(
+    previousDocuments?.folders,
+    nextDocuments?.folders,
+    allowDeletes
+  );
+  const ops = buildFirestoreV2CollectionChangeSet(
+    previousDocuments?.ops,
+    nextDocuments?.ops,
+    allowDeletes
+  );
+  const hasCollectionChanges = [records, folders, ops].some((changeSet) => (
+    Object.keys(changeSet.upserts).length > 0 || changeSet.deleteIds.length > 0
+  ));
+
+  return {
+    hasChanges: Boolean(rootUpsert) || hasCollectionChanges,
+    root: { upsert: rootUpsert },
+    records,
+    folders,
+    ops
+  };
+};
+
 const removeV2Metadata = (data = {}) => {
   const { schemaVersion, folderId, ...rest } = data || {};
   return rest;
@@ -1502,14 +1590,14 @@ const resolveMergedOrder = ({
   return mergeOrderArrays(normalizer, remoteData?.[stateKey], localData?.[stateKey]);
 };
 
-const buildSyncStateInput = (data = {}, operationTime) => ({
-  folders: data?.folders || [],
-  records: data?.records || {},
-  settings: data?.settings || {},
-  groupOrder: data?.groupOrder || [],
-  folderOrder: data?.folderOrder || [],
-  expandedGroups: data?.expandedGroups || [],
-  rtlSyncMeta: data?.rtlSyncMeta || {},
+const buildSyncStateInput = (data = {}, operationTime, options = {}) => ({
+  folders: data?.folders || [],
+  records: data?.records || {},
+  settings: data?.settings || {},
+  groupOrder: normalizeGroupOrderForOption(data?.groupOrder || [], options.groupOrderNormalizer),
+  folderOrder: data?.folderOrder || [],
+  expandedGroups: data?.expandedGroups || [],
+  rtlSyncMeta: data?.rtlSyncMeta || {},
   deletedRecordTombstones: data?.deletedRecordTombstones || {},
   deletedFolderTombstones: data?.deletedFolderTombstones || {},
   lastModified: operationTime
@@ -1518,23 +1606,24 @@ const buildSyncStateInput = (data = {}, operationTime) => ({
 export const buildRecordTimeLabelSyncPayload = ({
   data,
   previousCloudData,
-  pendingOps = [],
-  syncMode = RECORD_TIMELABEL_SYNC_MODES.FULL,
-  clientId = 'recordtimelabel-client',
-  now = Date.now()
-} = {}) => {
-  const operationTime = toFiniteTimestamp(data?.lastModified) || now;
-  const payloadSource = syncMode === RECORD_TIMELABEL_SYNC_MODES.MERGE
-    ? mergeLocalRemote({
-      localState: buildSyncStateInput(data || {}, operationTime),
-      remoteState: previousCloudData || {},
-      pendingOps,
-      clientId,
-      now
-    }).state
-    : buildSyncStateInput(data || {}, operationTime);
-  const sanitizedRecords = removeRecordSyncFlags(payloadSource.records || {});
-  const deletionTombstones = buildDeletionTombstones({
+  pendingOps = [],
+  syncMode = RECORD_TIMELABEL_SYNC_MODES.FULL,
+  clientId = 'recordtimelabel-client',
+  now = Date.now(),
+  groupOrderNormalizer
+} = {}) => {
+  const operationTime = toFiniteTimestamp(data?.lastModified) || now;
+  const payloadSource = syncMode === RECORD_TIMELABEL_SYNC_MODES.MERGE
+    ? mergeLocalRemote({
+      localState: buildSyncStateInput(data || {}, operationTime, { groupOrderNormalizer }),
+      remoteState: previousCloudData || {},
+      pendingOps,
+      clientId,
+      now
+    }).state
+    : buildSyncStateInput(data || {}, operationTime, { groupOrderNormalizer });
+  const sanitizedRecords = removeRecordSyncFlags(payloadSource.records || {});
+  const deletionTombstones = buildDeletionTombstones({
     previousState: previousCloudData,
     nextRecords: sanitizedRecords,
     nextFolders: payloadSource.folders || [],
@@ -1544,11 +1633,12 @@ export const buildRecordTimeLabelSyncPayload = ({
     clientId
   });
 
-  return normalizeState({
-    ...payloadSource,
-    records: sanitizedRecords,
-    deletedRecordTombstones: deletionTombstones.deletedRecordTombstones,
-    deletedFolderTombstones: deletionTombstones.deletedFolderTombstones,
+  return normalizeState({
+    ...payloadSource,
+    groupOrder: normalizeGroupOrderForOption(payloadSource.groupOrder, groupOrderNormalizer),
+    records: sanitizedRecords,
+    deletedRecordTombstones: deletionTombstones.deletedRecordTombstones,
+    deletedFolderTombstones: deletionTombstones.deletedFolderTombstones,
     lastModified: operationTime
   });
 };
@@ -1569,7 +1659,8 @@ export const buildSyncPayloadWithOperations = ({
     pendingOps: [],
     syncMode,
     clientId,
-    now
+    now,
+    groupOrderNormalizer
   });
 
   operations.forEach((operation) => {
@@ -2122,6 +2213,7 @@ export default {
   buildFirestoreV1UserPatch,
   buildFirestoreV2LogicalPaths,
   buildFirestoreV2DocumentsFromState,
+  buildFirestoreV2DocumentChangeSet,
   buildStateFromFirestoreV2Documents,
   flushPendingOperations,
   mergeRemoteStateIntoLocal,