Typed Lyra.insert method according to the schema used (#20)

* Implemented nested schema

* Restored old code format

* Typed insert function according to the schema inserted

* Restored code format

* Assed @ts-expect-error in test files

Co-authored-by: Daniele Fedeli <[email protected]>

Author: DanieleFedeli

packages/lyra/src/lyra.ts

@@ -6,15 +6,18 @@ import * as ERRORS from "./errors";
 import { tokenize } from "./tokenizer";
 import { formatNanoseconds, getNanosecondsTime } from "./utils";
 import { Language, SUPPORTED_LANGUAGES } from "./stemmer";
+import type { ResolveSchema } from "./types";
 
 export type PropertyType = "string" | "number" | "boolean";
 
 export type PropertiesSchema = {
   [key: string]: PropertyType | PropertiesSchema;
 };
 
-export type LyraProperties = {
-  schema: PropertiesSchema;
+export type LyraProperties<
+  TSchema extends PropertiesSchema = PropertiesSchema
+> = {
+  schema: TSchema;
   defaultLanguage?: Language;
 };
 
@@ -43,18 +46,19 @@ type SearchResult = Promise<{
   elapsed: string;
 }>;
 
-export class Lyra {
+export class Lyra<TSchema extends PropertiesSchema = PropertiesSchema> {
   private defaultLanguage: Language = "english";
-  private schema: PropertiesSchema;
+  private schema: TSchema;
   private docs: LyraDocs = new Map();
   private index: LyraIndex = new Map();
+
   private queue: queueAsPromised<QueueDocParams> = fastq.promise(
     this,
     this._insert,
     1
   );
 
-  constructor(properties: LyraProperties) {
+  constructor(properties: LyraProperties<TSchema>) {
     const defaultLanguage =
       (properties?.defaultLanguage?.toLowerCase() as Language) ?? "english";
 
@@ -67,8 +71,8 @@ export class Lyra {
     this.buildIndex(properties.schema);
   }
 
-  private buildIndex(schema: PropertiesSchema, prefix = "") {
-    for (const prop in schema) {
+  private buildIndex(schema: TSchema, prefix = "") {
+    for (const prop of Object.keys(schema)) {
       const propType = typeof prop;
       const isNested = typeof schema[prop] === "object";
 
@@ -77,7 +81,7 @@ export class Lyra {
       const propName = `${prefix}${prop}`;
 
       if (isNested) {
-        this.buildIndex(schema[prop] as PropertiesSchema, `${propName}.`);
+        this.buildIndex(schema[prop] as TSchema, `${propName}.`);
       } else {
         this.index.set(propName, new Trie());
       }
@@ -207,7 +211,7 @@ export class Lyra {
   }
 
   public async insert(
-    doc: object,
+    doc: ResolveSchema<TSchema>,
     language: Language = this.defaultLanguage
   ): Promise<{ id: string }> {
     const id = nanoid();

packages/lyra/src/types.d.ts

@@ -1 +1,16 @@
+import type { PropertiesSchema } from "./lyra";
 export type Nullable<T> = T | null;
+
+type ResolveTypes<TType> = TType extends "string"
+  ? string
+  : TType extends "boolean"
+  ? boolean
+  : TType extends "number"
+  ? number
+  : TType extends PropertiesSchema
+  ? { [P in keyof TType]: ResolveTypes<TType[P]> }
+  : never;
+
+export type ResolveSchema<T extends PropertiesSchema> = {
+  [P in keyof T]: ResolveTypes<T[P]>;
+};

packages/lyra/tests/lyra.test.ts

@@ -61,6 +61,7 @@ describe("checkInsertDocSchema", () => {
     ).toBeDefined();
 
     try {
+      // @ts-expect-error
       await db.insert({ quote: "hello, world!", author: true });
     } catch (err) {
       expect(err).toMatchSnapshot();
@@ -69,13 +70,15 @@ describe("checkInsertDocSchema", () => {
     try {
       await db.insert({
         quote: "hello, world!",
+        // @ts-expect-error
         authors: "author should be singular",
       });
     } catch (err) {
       expect(err).toMatchSnapshot();
     }
 
     try {
+      // @ts-expect-error
       await db.insert({ quote: "hello, world!", foo: { bar: 10 } });
     } catch (err) {
       expect(err).toMatchSnapshot();