fix(matches): report array-path keys as dotted strings

Match results for array-path keys (e.g. keys: [['author', 'firstName']])
leaked the raw string[] into match.key, contradicting the documented
FuseResultMatch.key: string type. Emit the canonical dotted-string id
('author.firstName') instead.

Surfaced while tightening the result formatter: the match projection is now
a pure, typed function (formatMatches, renamed from transformMatches) that
returns FuseResultMatch[] instead of mutating an any, which let TypeScript
catch the leak. Dropped the one-line transformScore and the transformer
array in favor of direct assignment in format().

Author: krisk

dist/fuse.basic.cjs

@@ -1024,45 +1024,33 @@ class MaxHeap {
   }
 }
 
-function transformMatches(result, data) {
-  const matches = result.matches;
-  data.matches = [];
-  if (!isDefined(matches)) {
-    return;
-  }
-  matches.forEach(match => {
+function formatMatches(result) {
+  const matches = [];
+  result.matches.forEach(match => {
     if (!isDefined(match.indices) || !match.indices.length) {
       return;
     }
-    const {
-      indices,
-      value
-    } = match;
     const obj = {
-      indices,
-      value
+      indices: match.indices,
+      value: match.value
     };
     if (match.key) {
-      obj.key = match.key.src;
+      // `key.id` is the canonical dotted-string identity (array paths joined
+      // with '.'); `key.src` is the raw user input and can be a string[].
+      obj.key = match.key.id;
     }
     if (match.idx > -1) {
       obj.refIndex = match.idx;
     }
-    data.matches.push(obj);
+    matches.push(obj);
   });
-}
-
-function transformScore(result, data) {
-  data.score = result.score;
+  return matches;
 }
 
 function format(results, docs, {
   includeMatches = Config.includeMatches,
   includeScore = Config.includeScore
 } = {}) {
-  const transformers = [];
-  if (includeMatches) transformers.push(transformMatches);
-  if (includeScore) transformers.push(transformScore);
   return results.map(result => {
     const {
       idx
@@ -1071,11 +1059,8 @@ function format(results, docs, {
       item: docs[idx],
       refIndex: idx
     };
-    if (transformers.length) {
-      transformers.forEach(transformer => {
-        transformer(result, data);
-      });
-    }
+    if (includeMatches) data.matches = formatMatches(result);
+    if (includeScore) data.score = result.score;
     return data;
   });
 }

dist/fuse.basic.min.cjs

@@ -1022,45 +1022,33 @@ class MaxHeap {
   }
 }
 
-function transformMatches(result, data) {
-  const matches = result.matches;
-  data.matches = [];
-  if (!isDefined(matches)) {
-    return;
-  }
-  matches.forEach(match => {
+function formatMatches(result) {
+  const matches = [];
+  result.matches.forEach(match => {
     if (!isDefined(match.indices) || !match.indices.length) {
       return;
     }
-    const {
-      indices,
-      value
-    } = match;
     const obj = {
-      indices,
-      value
+      indices: match.indices,
+      value: match.value
     };
     if (match.key) {
-      obj.key = match.key.src;
+      // `key.id` is the canonical dotted-string identity (array paths joined
+      // with '.'); `key.src` is the raw user input and can be a string[].
+      obj.key = match.key.id;
     }
     if (match.idx > -1) {
       obj.refIndex = match.idx;
     }
-    data.matches.push(obj);
+    matches.push(obj);
   });
-}
-
-function transformScore(result, data) {
-  data.score = result.score;
+  return matches;
 }
 
 function format(results, docs, {
   includeMatches = Config.includeMatches,
   includeScore = Config.includeScore
 } = {}) {
-  const transformers = [];
-  if (includeMatches) transformers.push(transformMatches);
-  if (includeScore) transformers.push(transformScore);
   return results.map(result => {
     const {
       idx
@@ -1069,11 +1057,8 @@ function format(results, docs, {
       item: docs[idx],
       refIndex: idx
     };
-    if (transformers.length) {
-      transformers.forEach(transformer => {
-        transformer(result, data);
-      });
-    }
+    if (includeMatches) data.matches = formatMatches(result);
+    if (includeScore) data.score = result.score;
     return data;
   });
 }

dist/fuse.basic.min.mjs

@@ -1419,45 +1419,33 @@ class MaxHeap {
   }
 }
 
-function transformMatches(result, data) {
-  const matches = result.matches;
-  data.matches = [];
-  if (!isDefined(matches)) {
-    return;
-  }
-  matches.forEach(match => {
+function formatMatches(result) {
+  const matches = [];
+  result.matches.forEach(match => {
     if (!isDefined(match.indices) || !match.indices.length) {
       return;
     }
-    const {
-      indices,
-      value
-    } = match;
     const obj = {
-      indices,
-      value
+      indices: match.indices,
+      value: match.value
     };
     if (match.key) {
-      obj.key = match.key.src;
+      // `key.id` is the canonical dotted-string identity (array paths joined
+      // with '.'); `key.src` is the raw user input and can be a string[].
+      obj.key = match.key.id;
     }
     if (match.idx > -1) {
       obj.refIndex = match.idx;
     }
-    data.matches.push(obj);
+    matches.push(obj);
   });
-}
-
-function transformScore(result, data) {
-  data.score = result.score;
+  return matches;
 }
 
 function format(results, docs, {
   includeMatches = Config.includeMatches,
   includeScore = Config.includeScore
 } = {}) {
-  const transformers = [];
-  if (includeMatches) transformers.push(transformMatches);
-  if (includeScore) transformers.push(transformScore);
   return results.map(result => {
     const {
       idx
@@ -1466,11 +1454,8 @@ function format(results, docs, {
       item: docs[idx],
       refIndex: idx
     };
-    if (transformers.length) {
-      transformers.forEach(transformer => {
-        transformer(result, data);
-      });
-    }
+    if (includeMatches) data.matches = formatMatches(result);
+    if (includeScore) data.score = result.score;
     return data;
   });
 }

dist/fuse.basic.mjs

@@ -1417,45 +1417,33 @@ class MaxHeap {
   }
 }
 
-function transformMatches(result, data) {
-  const matches = result.matches;
-  data.matches = [];
-  if (!isDefined(matches)) {
-    return;
-  }
-  matches.forEach(match => {
+function formatMatches(result) {
+  const matches = [];
+  result.matches.forEach(match => {
     if (!isDefined(match.indices) || !match.indices.length) {
       return;
     }
-    const {
-      indices,
-      value
-    } = match;
     const obj = {
-      indices,
-      value
+      indices: match.indices,
+      value: match.value
     };
     if (match.key) {
-      obj.key = match.key.src;
+      // `key.id` is the canonical dotted-string identity (array paths joined
+      // with '.'); `key.src` is the raw user input and can be a string[].
+      obj.key = match.key.id;
     }
     if (match.idx > -1) {
       obj.refIndex = match.idx;
     }
-    data.matches.push(obj);
+    matches.push(obj);
   });
-}
-
-function transformScore(result, data) {
-  data.score = result.score;
+  return matches;
 }
 
 function format(results, docs, {
   includeMatches = Config.includeMatches,
   includeScore = Config.includeScore
 } = {}) {
-  const transformers = [];
-  if (includeMatches) transformers.push(transformMatches);
-  if (includeScore) transformers.push(transformScore);
   return results.map(result => {
     const {
       idx
@@ -1464,11 +1452,8 @@ function format(results, docs, {
       item: docs[idx],
       refIndex: idx
     };
-    if (transformers.length) {
-      transformers.forEach(transformer => {
-        transformer(result, data);
-      });
-    }
+    if (includeMatches) data.matches = formatMatches(result);
+    if (includeScore) data.score = result.score;
     return data;
   });
 }

dist/fuse.cjs

@@ -1400,45 +1400,33 @@ class MaxHeap {
   }
 }
 
-function transformMatches(result, data) {
-  const matches = result.matches;
-  data.matches = [];
-  if (!isDefined(matches)) {
-    return;
-  }
-  matches.forEach(match => {
+function formatMatches(result) {
+  const matches = [];
+  result.matches.forEach(match => {
     if (!isDefined(match.indices) || !match.indices.length) {
       return;
     }
-    const {
-      indices,
-      value
-    } = match;
     const obj = {
-      indices,
-      value
+      indices: match.indices,
+      value: match.value
     };
     if (match.key) {
-      obj.key = match.key.src;
+      // `key.id` is the canonical dotted-string identity (array paths joined
+      // with '.'); `key.src` is the raw user input and can be a string[].
+      obj.key = match.key.id;
     }
     if (match.idx > -1) {
       obj.refIndex = match.idx;
     }
-    data.matches.push(obj);
+    matches.push(obj);
   });
-}
-
-function transformScore(result, data) {
-  data.score = result.score;
+  return matches;
 }
 
 function format(results, docs, {
   includeMatches = Config.includeMatches,
   includeScore = Config.includeScore
 } = {}) {
-  const transformers = [];
-  if (includeMatches) transformers.push(transformMatches);
-  if (includeScore) transformers.push(transformScore);
   return results.map(result => {
     const {
       idx
@@ -1447,11 +1435,8 @@ function format(results, docs, {
       item: docs[idx],
       refIndex: idx
     };
-    if (transformers.length) {
-      transformers.forEach(transformer => {
-        transformer(result, data);
-      });
-    }
+    if (includeMatches) data.matches = formatMatches(result);
+    if (includeScore) data.score = result.score;
     return data;
   });
 }