@digigov/text-search 0.1.0-a131264d

package/src/search/utils.ts

@@ -0,0 +1,72 @@
+import { SimpleDocumentSearchResultSetUnit } from 'flexsearch';
+
+/**
+ * Extracts the unique item IDs from the result set
+ *
+ * @param result - The result set to extract the IDs from
+ */
+export function getResultIds(result: SimpleDocumentSearchResultSetUnit[]) {
+  const set = new Set<number | string>();
+  result.forEach((item) => {
+    item.result.forEach((id) => set.add(id));
+  });
+  return Array.from(set);
+}
+
+/**
+ * Get the items from the list that match the given IDs
+ *
+ * @param items - The list of items to search through
+ * @param ids - The list of IDs to search for
+ * @param idKey - The key to use to find the IDs in the items
+ */
+export function findItemsByIds<T extends Record<string, any>>(
+  items: T[],
+  ids: (string | number)[],
+  idKey: Extract<keyof T, string>
+) {
+  return items.filter(
+    (item) => item && ids.includes(getValueFromNestedKey(item, idKey))
+  );
+}
+
+function getValueFromNestedKey(object: Record<string, any>, nestedKey: string) {
+  const keys = nestedKey.split(':');
+
+  let result = object;
+  for (const keySegment of keys) {
+    if (result.hasOwnProperty(keySegment)) {
+      result = result[keySegment];
+    }
+  }
+  return (result as unknown) as string;
+}
+
+/**
+ * Recursively get all the keys from an object
+ *
+ * The keys are returned in the format `parentKey.childKey` for nested objects
+ * and `key` for top level objects (objects that are not nested inside another object).
+ *
+ * @param object - The item to get the keys from
+ * @param parentKey - The parent key to which the current key should be appended
+ */
+export function getAllItemKeys(
+  object: Record<string, any>,
+  parentKey: string = ''
+): string[] {
+  let keys: string[] = [];
+  for (const key in object) {
+    if (object.hasOwnProperty(key)) {
+      const currentKey = parentKey ? `${parentKey}.${key}` : key;
+
+      if (typeof object[key] === 'object' && object[key] !== null) {
+        keys = keys.concat(getAllItemKeys(object[key], currentKey));
+      } else {
+        keys.push(currentKey);
+      }
+    }
+  }
+
+  return keys;
+}

package/src/test-utils/data.json

@@ -0,0 +1,552 @@
+[
+  {
+    "id": 0,
+    "firstName": "Jacobson",
+    "lastName": "Hale",
+    "email": "jacobsonhale@uneeq.com",
+    "address": {
+      "street": "Revere Place",
+      "city": "Belva",
+      "state": "Idaho"
+    }
+  },
+  {
+    "id": 1,
+    "firstName": "Anastasia",
+    "lastName": "Rocha",
+    "email": "anastasiarocha@uneeq.com",
+    "address": {
+      "street": "Wilson Street",
+      "city": "Titanic",
+      "state": "Alaska"
+    }
+  },
+  {
+    "id": 2,
+    "firstName": "Μάρκος",
+    "lastName": "Richmond",
+    "email": "stacierichmond@uneeq.com",
+    "address": {
+      "street": "Regent Place",
+      "city": "Knowlton",
+      "state": "West Virginia"
+    }
+  },
+  {
+    "id": 3,
+    "firstName": "Herring",
+    "lastName": "Vazquez",
+    "email": "herringvazquez@uneeq.com",
+    "address": {
+      "street": "Cadman Plaza",
+      "city": "Echo",
+      "state": "Maryland"
+    }
+  },
+  {
+    "id": 4,
+    "firstName": "Strickland",
+    "lastName": "Butler",
+    "email": "stricklandbutler@uneeq.com",
+    "address": {
+      "street": "Farragut Place",
+      "city": "Why",
+      "state": "Virgin Islands"
+    }
+  },
+  {
+    "id": 5,
+    "firstName": "Francine",
+    "lastName": "Ball",
+    "email": "francineball@uneeq.com",
+    "address": {
+      "street": "Hope Street",
+      "city": "Glendale",
+      "state": "Pennsylvania"
+    }
+  },
+  {
+    "id": 6,
+    "firstName": "Noreen",
+    "lastName": "Harris",
+    "email": "noreenharris@uneeq.com",
+    "address": {
+      "street": "Noble Street",
+      "city": "Fontanelle",
+      "state": "Palau"
+    }
+  },
+  {
+    "id": 7,
+    "firstName": "Claire",
+    "lastName": "Hill",
+    "email": "clairehill@uneeq.com",
+    "address": {
+      "street": "Sandford Street",
+      "city": "Fresno",
+      "state": "Federated States Of Micronesia"
+    }
+  },
+  {
+    "id": 8,
+    "firstName": "Rosalie",
+    "lastName": "Matthews",
+    "email": "rosaliematthews@uneeq.com",
+    "address": {
+      "street": "Bergen Place",
+      "city": "Cloverdale",
+      "state": "Minnesota"
+    }
+  },
+  {
+    "id": 9,
+    "firstName": "Cara",
+    "lastName": "Heath",
+    "email": "caraheath@uneeq.com",
+    "address": {
+      "street": "Seigel Street",
+      "city": "Sedley",
+      "state": "North Dakota"
+    }
+  },
+  {
+    "id": 10,
+    "firstName": "Blair",
+    "lastName": "Delgado",
+    "email": "blairdelgado@uneeq.com",
+    "address": {
+      "street": "Turner Place",
+      "city": "Walker",
+      "state": "California"
+    }
+  },
+  {
+    "id": 11,
+    "firstName": "Clark",
+    "lastName": "Evans",
+    "email": "clarkevans@uneeq.com",
+    "address": {
+      "street": "Chase Court",
+      "city": "Wyano",
+      "state": "Mississippi"
+    }
+  },
+  {
+    "id": 12,
+    "firstName": "Johns",
+    "lastName": "Wilkinson",
+    "email": "johnswilkinson@uneeq.com",
+    "address": {
+      "street": "Wyckoff Avenue",
+      "city": "Cavalero",
+      "state": "Vermont"
+    }
+  },
+  {
+    "id": 13,
+    "firstName": "Rosanna",
+    "lastName": "Poole",
+    "email": "rosannapoole@uneeq.com",
+    "address": {
+      "street": "Stuart Street",
+      "city": "Elfrida",
+      "state": "Tennessee"
+    }
+  },
+  {
+    "id": 14,
+    "firstName": "Nicholson",
+    "lastName": "Guthrie",
+    "email": "nicholsonguthrie@uneeq.com",
+    "address": {
+      "street": "Erskine Loop",
+      "city": "Genoa",
+      "state": "Wisconsin"
+    }
+  },
+  {
+    "id": 15,
+    "firstName": "Lessie",
+    "lastName": "Stephenson",
+    "email": "lessiestephenson@uneeq.com",
+    "address": {
+      "street": "Glendale Court",
+      "city": "Brecon",
+      "state": "Nebraska"
+    }
+  },
+  {
+    "id": 16,
+    "firstName": "Schneider",
+    "lastName": "Preston",
+    "email": "schneiderpreston@uneeq.com",
+    "address": {
+      "street": "Clara Street",
+      "city": "Driftwood",
+      "state": "American Samoa"
+    }
+  },
+  {
+    "id": 17,
+    "firstName": "Bobbi",
+    "lastName": "Robinson",
+    "email": "bobbirobinson@uneeq.com",
+    "address": {
+      "street": "Cox Place",
+      "city": "Wauhillau",
+      "state": "Ohio"
+    }
+  },
+  {
+    "id": 18,
+    "firstName": "Clarissa",
+    "lastName": "Schroeder",
+    "email": "clarissaschroeder@uneeq.com",
+    "address": {
+      "street": "Hanover Place",
+      "city": "Robbins",
+      "state": "New Hampshire"
+    }
+  },
+  {
+    "id": 19,
+    "firstName": "Alicia",
+    "lastName": "Mays",
+    "email": "aliciamays@uneeq.com",
+    "address": {
+      "street": "Reed Street",
+      "city": "Clinton",
+      "state": "Massachusetts"
+    }
+  },
+  {
+    "id": 20,
+    "firstName": "Shauna",
+    "lastName": "Reeves",
+    "email": "shaunareeves@uneeq.com",
+    "address": {
+      "street": "Hausman Street",
+      "city": "Indio",
+      "state": "Oregon"
+    }
+  },
+  {
+    "id": 21,
+    "firstName": "Brewer",
+    "lastName": "Holmes",
+    "email": "brewerholmes@uneeq.com",
+    "address": {
+      "street": "Irwin Street",
+      "city": "Iberia",
+      "state": "Hawaii"
+    }
+  },
+  {
+    "id": 22,
+    "firstName": "Meadows",
+    "lastName": "Weber",
+    "email": "meadowsweber@uneeq.com",
+    "address": {
+      "street": "Rogers Avenue",
+      "city": "Fairmount",
+      "state": "Kansas"
+    }
+  },
+  {
+    "id": 23,
+    "firstName": "Valencia",
+    "lastName": "Patterson",
+    "email": "valenciapatterson@uneeq.com",
+    "address": {
+      "street": "Metropolitan Avenue",
+      "city": "Rosewood",
+      "state": "Oklahoma"
+    }
+  },
+  {
+    "id": 24,
+    "firstName": "Trina",
+    "lastName": "Kemp",
+    "email": "trinakemp@uneeq.com",
+    "address": {
+      "street": "Village Road",
+      "city": "Fairhaven",
+      "state": "New York"
+    }
+  },
+  {
+    "id": 25,
+    "firstName": "Lynnette",
+    "lastName": "Glass",
+    "email": "lynnetteglass@uneeq.com",
+    "address": {
+      "street": "Grand Avenue",
+      "city": "Robinette",
+      "state": "Nevada"
+    }
+  },
+  {
+    "id": 26,
+    "firstName": "Pace",
+    "lastName": "Austin",
+    "email": "paceaustin@uneeq.com",
+    "address": {
+      "street": "Kimball Street",
+      "city": "Chumuckla",
+      "state": "Marshall Islands"
+    }
+  },
+  {
+    "id": 27,
+    "firstName": "Vicky",
+    "lastName": "Cardenas",
+    "email": "vickycardenas@uneeq.com",
+    "address": {
+      "street": "Coyle Street",
+      "city": "Hendersonville",
+      "state": "Guam"
+    }
+  },
+  {
+    "id": 28,
+    "firstName": "Robyn",
+    "lastName": "Luna",
+    "email": "robynluna@uneeq.com",
+    "address": {
+      "street": "Billings Place",
+      "city": "Fostoria",
+      "state": "Wyoming"
+    }
+  },
+  {
+    "id": 29,
+    "firstName": "Stafford",
+    "lastName": "Simmons",
+    "email": "staffordsimmons@uneeq.com",
+    "address": {
+      "street": "Raleigh Place",
+      "city": "Whitewater",
+      "state": "New Jersey"
+    }
+  },
+  {
+    "id": 30,
+    "firstName": "Fisher",
+    "lastName": "Cook",
+    "email": "fishercook@uneeq.com",
+    "address": {
+      "street": "Lexington Avenue",
+      "city": "Waiohinu",
+      "state": "Delaware"
+    }
+  },
+  {
+    "id": 31,
+    "firstName": "Nanette",
+    "lastName": "Velazquez",
+    "email": "nanettevelazquez@uneeq.com",
+    "address": {
+      "street": "Gerry Street",
+      "city": "Coleville",
+      "state": "Texas"
+    }
+  },
+  {
+    "id": 32,
+    "firstName": "Crosby",
+    "lastName": "Rhodes",
+    "email": "crosbyrhodes@uneeq.com",
+    "address": {
+      "street": "Gelston Avenue",
+      "city": "Wadsworth",
+      "state": "Louisiana"
+    }
+  },
+  {
+    "id": 33,
+    "firstName": "Becky",
+    "lastName": "James",
+    "email": "beckyjames@uneeq.com",
+    "address": {
+      "street": "Goodwin Place",
+      "city": "Yonah",
+      "state": "Rhode Island"
+    }
+  },
+  {
+    "id": 34,
+    "firstName": "Jolene",
+    "lastName": "Marshall",
+    "email": "jolenemarshall@uneeq.com",
+    "address": {
+      "street": "Berkeley Place",
+      "city": "Bourg",
+      "state": "Florida"
+    }
+  },
+  {
+    "id": 35,
+    "firstName": "Levine",
+    "lastName": "Clay",
+    "email": "levineclay@uneeq.com",
+    "address": {
+      "street": "Gerald Court",
+      "city": "Detroit",
+      "state": "Virginia"
+    }
+  },
+  {
+    "id": 36,
+    "firstName": "Carey",
+    "lastName": "Sherman",
+    "email": "careysherman@uneeq.com",
+    "address": {
+      "street": "Stuyvesant Avenue",
+      "city": "Garnet",
+      "state": "Indiana"
+    }
+  },
+  {
+    "id": 37,
+    "firstName": "Sheppard",
+    "lastName": "Foley",
+    "email": "sheppardfoley@uneeq.com",
+    "address": {
+      "street": "Rodney Street",
+      "city": "Whipholt",
+      "state": "Northern Mariana Islands"
+    }
+  },
+  {
+    "id": 38,
+    "firstName": "Lamb",
+    "lastName": "Flowers",
+    "email": "lambflowers@uneeq.com",
+    "address": {
+      "street": "Woodpoint Road",
+      "city": "Craig",
+      "state": "Iowa"
+    }
+  },
+  {
+    "id": 39,
+    "firstName": "Snow",
+    "lastName": "Whitley",
+    "email": "snowwhitley@uneeq.com",
+    "address": {
+      "street": "Sackman Street",
+      "city": "Whitehaven",
+      "state": "Georgia"
+    }
+  },
+  {
+    "id": 40,
+    "firstName": "Koch",
+    "lastName": "Moreno",
+    "email": "kochmoreno@uneeq.com",
+    "address": {
+      "street": "Colby Court",
+      "city": "Konterra",
+      "state": "Alabama"
+    }
+  },
+  {
+    "id": 41,
+    "firstName": "Berry",
+    "lastName": "Mccoy",
+    "email": "berrymccoy@uneeq.com",
+    "address": {
+      "street": "Provost Street",
+      "city": "Balm",
+      "state": "Colorado"
+    }
+  },
+  {
+    "id": 42,
+    "firstName": "Lara",
+    "lastName": "Mcfarland",
+    "email": "laramcfarland@uneeq.com",
+    "address": {
+      "street": "Brigham Street",
+      "city": "Mammoth",
+      "state": "Missouri"
+    }
+  },
+  {
+    "id": 43,
+    "firstName": "Russell",
+    "lastName": "Mayo",
+    "email": "russellmayo@uneeq.com",
+    "address": {
+      "street": "Kiely Place",
+      "city": "Soudan",
+      "state": "Utah"
+    }
+  },
+  {
+    "id": 44,
+    "firstName": "Lorna",
+    "lastName": "Dejesus",
+    "email": "lornadejesus@uneeq.com",
+    "address": {
+      "street": "Bushwick Place",
+      "city": "Concho",
+      "state": "New Mexico"
+    }
+  },
+  {
+    "id": 45,
+    "firstName": "Tiffany",
+    "lastName": "Goodwin",
+    "email": "tiffanygoodwin@uneeq.com",
+    "address": {
+      "street": "Kane Street",
+      "city": "Dargan",
+      "state": "Arkansas"
+    }
+  },
+  {
+    "id": 46,
+    "firstName": "Todd",
+    "lastName": "Carson",
+    "email": "toddcarson@uneeq.com",
+    "address": {
+      "street": "Fleet Place",
+      "city": "Beechmont",
+      "state": "Puerto Rico"
+    }
+  },
+  {
+    "id": 47,
+    "firstName": "Elsa",
+    "lastName": "Meyer",
+    "email": "elsameyer@uneeq.com",
+    "address": {
+      "street": "Varanda Place",
+      "city": "Dotsero",
+      "state": "Montana"
+    }
+  },
+  {
+    "id": 48,
+    "firstName": "Kari",
+    "lastName": "Dorsey",
+    "email": "karidorsey@uneeq.com",
+    "address": {
+      "street": "Pilling Street",
+      "city": "Geyserville",
+      "state": "Connecticut"
+    }
+  },
+  {
+    "id": 49,
+    "firstName": "Kari",
+    "lastName": "Kari",
+    "email": "karivillarreal@uneeq.com",
+    "address": {
+      "street": "Vermont Street",
+      "city": "Gardners",
+      "state": "Washington"
+    }
+  }
+]

package/src/types.ts

@@ -0,0 +1,65 @@
+/**
+ * Options for configuring the useSearch hook
+ */
+export interface UseSearchOptions<T extends Record<string, any>> {
+  indexing: SearchIndexOptions<T>;
+}
+
+/**
+ * Options for configuring the search index
+ *
+ * @typeParam T - The type of the data that will be indexed
+ */
+export interface SearchIndexOptions<T> {
+  /**
+   * Describes where to find the unique ID for each item in the data
+   *
+   * This can also be a nested key, e.g. `address.street`. If not specified, the search index will
+   * create an 'id' field on each item, with the value being the index of the item in the array.
+   */
+  idKey?: NestedKeyOf<T>;
+  /**
+   * List of fields to index
+   *
+   * Contains a list of fields from the document, that should be indexed. The fields can be nested.
+   *
+   * @example Using nested keys
+   * ```
+   * {
+   *   id: 1,
+   *   name: 'John',
+   *   address: {
+   *     street: '123 Main St',
+   *     city: 'New York'
+   *   }
+   * }
+   * ```
+   * To search against the `street` key, add `address.street` to the fields array.
+   */
+  fields?: NestedKeyOf<T>[];
+  /**
+   * Whether to use a web worker for indexing
+   */
+  enableWorker?: boolean;
+}
+
+/**
+ * Any key of an object that has nested objects.
+ *
+ * This utility type is used to get all the primitive keys of an object, including the keys of any nested objects.
+ *
+ * @typeParam ObjectType - The type of the object to get the keys of
+ */
+export type NestedKeyOf<T> = T extends Primitive
+  ? never
+  :
+      | (keyof T & string)
+      | { [P in keyof T & string]: DeepSubKeys<T, P> }[keyof T & string];
+
+type DeepSubKeys<T, P extends keyof T & string> = T[P] extends (infer Inner)[]
+  ? `${P}.${NestedKeyOf<Inner>}`
+  : T[P] extends object
+  ? `${P}.${NestedKeyOf<T[P]>}`
+  : never;
+
+type Primitive = null | undefined | string | number | boolean | symbol | bigint;