@lunora/server 1.0.0-alpha.55 → 1.0.0-alpha.57

package/dist/data-model.d.mts

@@ -275,6 +275,16 @@ interface SearchFilterBuilder<TDocument> {
  */
 interface SearchReader<TDocument> {
   collect: () => Promise<TDocument[]>;
+  /**
+   * Like `.collect()`, but pairs each matched document with the relevance
+   * score the FTS engine already computed to produce the descending order —
+   * `.collect()` throws it away after sorting by it, this surfaces it
+   * instead. Ordered by `score` descending, same order as `.collect()`.
+   */
+  collectWithScores: () => Promise<{
+    document: TDocument;
+    score: number;
+  }[]>;
   first: () => Promise<TDocument | null>;
   take: (limit: number) => Promise<TDocument[]>;
   unique: () => Promise<TDocument | null>;
@@ -305,6 +315,17 @@ interface GeoFilterBuilder {
  */
 interface GeoReader<TDocument> {
   collect: () => Promise<TDocument[]>;
+  /**
+   * Like `.collect()`, but pairs each matched document with the distance
+   * (in meters) from `.near()`'s point that the read already computed to
+   * produce the nearest-first order. `.within()` box matches have no
+   * point-distance metric, so `distanceMeters` is `null` for those rows
+   * rather than a misleading `0`.
+   */
+  collectWithScores: () => Promise<{
+    distanceMeters: null | number;
+    document: TDocument;
+  }[]>;
   first: () => Promise<TDocument | null>;
   take: (limit: number) => Promise<TDocument[]>;
   unique: () => Promise<TDocument | null>;

package/dist/data-model.d.ts

@@ -275,6 +275,16 @@ interface SearchFilterBuilder<TDocument> {
  */
 interface SearchReader<TDocument> {
   collect: () => Promise<TDocument[]>;
+  /**
+   * Like `.collect()`, but pairs each matched document with the relevance
+   * score the FTS engine already computed to produce the descending order —
+   * `.collect()` throws it away after sorting by it, this surfaces it
+   * instead. Ordered by `score` descending, same order as `.collect()`.
+   */
+  collectWithScores: () => Promise<{
+    document: TDocument;
+    score: number;
+  }[]>;
   first: () => Promise<TDocument | null>;
   take: (limit: number) => Promise<TDocument[]>;
   unique: () => Promise<TDocument | null>;
@@ -305,6 +315,17 @@ interface GeoFilterBuilder {
  */
 interface GeoReader<TDocument> {
   collect: () => Promise<TDocument[]>;
+  /**
+   * Like `.collect()`, but pairs each matched document with the distance
+   * (in meters) from `.near()`'s point that the read already computed to
+   * produce the nearest-first order. `.within()` box matches have no
+   * point-distance metric, so `distanceMeters` is `null` for those rows
+   * rather than a misleading `0`.
+   */
+  collectWithScores: () => Promise<{
+    distanceMeters: null | number;
+    document: TDocument;
+  }[]>;
   first: () => Promise<TDocument | null>;
   take: (limit: number) => Promise<TDocument[]>;
   unique: () => Promise<TDocument | null>;