typescript

.github/workflows/ci.yml

@@ -39,6 +39,9 @@ jobs:
       - name: Install dependencies
         run: pnpm install
 
+      - name: TypeScript
+        run: pnpm tsc
+
       - name: Test
         run: pnpm test
 

README.md

@@ -62,6 +62,6 @@ Logo by Pravin Unagar from <a href="https://thenounproject.com/browse/icons/term
 
 ## TODO
 
-- prettier, eslint, typescript
 - publish
+- prettier, eslint
 - add example to [faceted-search demo](https://github.com/stereobooster/faceted-search)

package.json

@@ -3,9 +3,11 @@
     "test": "turbo run test",
     "build": "turbo run build",
     "dev": "turbo run dev",
-    "clean": "turbo run clean"
+    "clean": "turbo run clean",
+    "tsc": "turbo run tsc"
   },
   "devDependencies": {
-    "turbo": "^1.10.16"
+    "turbo": "^1.10.16",
+    "typescript": "^5.2.2"
   }
 }

packages/demo/package.json

@@ -8,7 +8,8 @@
     "dev": "vite",
     "build": "tsc && vite build",
     "preview": "vite preview",
-    "clean": "rm -rf dist"
+    "clean": "rm -rf dist",
+    "tsc": "tsc"
   },
   "dependencies": {
     "@stereobooster/facets": "workspace:*",

packages/demo/tsconfig.json

@@ -1,23 +1,8 @@
 {
+  "extends": "../../tsconfig.json",
   "compilerOptions": {
-    "target": "ES2020",
-    "useDefineForClassFields": true,
     "module": "ESNext",
-    "lib": ["ES2020", "DOM", "DOM.Iterable"],
-    "skipLibCheck": true,
-
-    /* Bundler mode */
     "moduleResolution": "bundler",
-    "allowImportingTsExtensions": true,
-    "resolveJsonModule": true,
-    "isolatedModules": true,
-    "noEmit": true,
-
-    /* Linting */
-    "strict": true,
-    "noUnusedLocals": true,
-    "noUnusedParameters": true,
-    "noFallthroughCasesInSwitch": true
   },
   "include": ["src"]
 }

packages/facets-instantsearch/package.json

@@ -26,7 +26,8 @@
     "prepublishOnly": "npm run build",
     "build": "rm -rf dist && microbundle",
     "dev": "microbundle watch",
-    "clean": "rm -rf dist"
+    "clean": "rm -rf dist",
+    "tsc": "tsc"
   },
   "dependencies": {},
   "peerDependencies": {
@@ -38,6 +39,7 @@
     "@algolia/client-search": "^4.20.0",
     "instantsearch.js": "4.60.0",
     "microbundle": "^0.15.1",
+    "typescript": "^5.2.2",
     "vitest": "^0.34.6"
   }
 }

packages/facets-instantsearch/src/adaptResponse.ts

@@ -10,7 +10,7 @@ export function adaptResponse<S extends Schema, I extends Item<S>>(
     hits:
       idKey === "objectID"
         ? (response.items as any)
-        : response.items.map(adaptHit(idKey || "id")),
+        : response.items.map(adaptHit<I>(idKey || "id")),
     page: response.pagination.page,
     hitsPerPage: response.pagination.perPage,
     nbHits: response.pagination.total,
@@ -25,17 +25,17 @@ export function adaptResponse<S extends Schema, I extends Item<S>>(
 }
 
 export function adaptHit<I>(key: string) {
-  return (item: I): Hit<I> => ({
+  return (item: any): Hit<I> => ({
     objectID: item[key],
     ...item,
   });
 }
 
-export function adaptFacets(facets): Record<string, Record<string, number>> {
+export function adaptFacets(facets: any): Record<string, Record<string, number>> {
   const instantsearchFacets = Object.create(null);
   Object.keys(facets).forEach((field) => {
     instantsearchFacets[field] = Object.create(null);
-    facets[field].items.forEach(([value, frequency]) => {
+    facets[field].items.forEach(([value, frequency]: [string, number]) => {
       instantsearchFacets[field][value] = frequency;
     });
   });
@@ -44,7 +44,7 @@ export function adaptFacets(facets): Record<string, Record<string, number>> {
 }
 
 export function adaptFacetsStats(
-  facets
+  facets: any
 ): Record<string, { min: number; max: number; avg: number; sum: number }> {
   const instantsearchFacetsStats = Object.create(null);
   Object.keys(facets).forEach((field) => {

packages/facets-instantsearch/tsconfig.json

@@ -0,0 +1,8 @@
+{
+  "extends": "../../tsconfig.json",
+  "compilerOptions": {
+    "module": "ESNext",
+    "moduleResolution": "Node"
+  },
+  "include": ["src"]
+}

packages/facets/package.json

@@ -26,7 +26,8 @@
     "prepublishOnly": "npm run build",
     "build": "rm -rf dist && microbundle",
     "dev": "microbundle watch",
-    "clean": "rm -rf dist"
+    "clean": "rm -rf dist",
+    "tsc": "tsc"
   },
   "dependencies": {
     "mnemonist": "^0.39.5",
@@ -45,6 +46,7 @@
     "minisearch": "^6.2.0",
     "quick-score": "^0.2.0",
     "microbundle": "^0.15.1",
+    "typescript": "^5.2.2",
     "vitest": "^0.34.6"
   }
 }

packages/facets/src/Facets.ts

@@ -150,10 +150,14 @@ export type SearchResults<S extends Schema, I extends Item<S>> = {
 };
 
 export class Facets<S extends Schema, I extends Item<S>> {
+  #config: FacetsConfig<S>;
+  // @ts-expect-error it is assigned later
   #items: I[];
+  // @ts-expect-error it is assigned later
   #indexes: Record<string, InvertedIndex<SupportedFieldTypes>>;
-  #config: FacetsConfig<S>;
+  // @ts-expect-error it is assigned later
   #textIndex: InstanceType<TextIndex>;
+  // @ts-expect-error it is assigned later
   #fullFacets: Record<
     string,
     Array<[SupportedFieldTypes, number, SparseTypedFastBitSet]>
@@ -279,7 +283,7 @@ export class Facets<S extends Schema, I extends Item<S>> {
           const to: number = selected.to || Infinity;
           (this.#indexes[field] as InvertedIndex<number>)
             .values()
-            .forEach(([x, y, z]) => {
+            .forEach(([x, _, z]) => {
               if (x == null || x > to || x < from) return;
               if (!ids) {
                 ids = z.clone();

packages/facets/src/ITrieMapIndex.ts

@@ -10,8 +10,8 @@ export class ITrieMapIndex<K> extends InvertedIndexMaplike<K> {
     this.index = new TrieMap();
   }
 
-  like(prefix) {
-    return this.index.find(prefix).reduce((p, [k, v]) => {
+  like(prefix: K) {
+    return this.index.find(prefix).reduce((p, [_, v]) => {
       p.union(v);
       return p;
     }, new SparseTypedFastBitSet());

packages/facets/src/InvertedIndex.ts

@@ -3,10 +3,10 @@ import { SparseTypedFastBitSet } from "typedfastbitset";
 export type FacetValue<K = unknown> = [K, number, SparseTypedFastBitSet];
 
 export class InvertedIndex<K = unknown> {
-  add(value: K, id: number): void {
+  add(_value: K, _id: number): void {
     throw new Error("Not implemented");
   }
-  get(value: K): SparseTypedFastBitSet {
+  get(_value: K): SparseTypedFastBitSet {
     throw new Error("Not implemented");
   }
   values(): Array<FacetValue<K>> {
@@ -22,6 +22,7 @@ interface Maplike<K, V> {
 }
 
 export class InvertedIndexMaplike<K = unknown> extends InvertedIndex<K> {
+  // @ts-expect-error fix later
   index: Maplike<K, SparseTypedFastBitSet>;
 
   add(value: K, id: number) {

packages/facets/src/TFlexsearchIndex.ts

@@ -25,18 +25,22 @@ export class TFlexsearchIndex extends TextIndexBase {
     this.#index.add(id, item);
   }
 
-  search(query, options?: SearchOptions & TextSearchOptions) {
+  search(query: string, options?: SearchOptions & TextSearchOptions) {
     let { page, perPage, ...rest } = options || {};
     page = page || 0;
     perPage = perPage || 20;
     const results = this.#index.search(query, {
       ...rest,
       offset: 0,
       limit: perPage * (page + 1),
-    });
-    if (results.length === 1) return results[0].result;
-
-    const resultsByRelevance = new Map();
+    }) as Array<{ result: number[] }>;
+    if (results.length === 1)
+      return {
+        ids: results[0].result,
+        matches: new Map<number, any>(),
+      };
+
+    const resultsByRelevance = new Map<number, number>();
     results.forEach(({ result }) => {
       const factor = 1;
       result.forEach((id, i) => {
@@ -52,6 +56,7 @@ export class TFlexsearchIndex extends TextIndexBase {
         .sort((a, b) => a[1] - b[1])
         .slice(page * perPage, (page + 1) * perPage)
         .map((a) => a[0]),
+      matches: new Map<number, any>(),
     };
   }
 }

packages/facets/src/TFuseIndex.ts

@@ -16,6 +16,7 @@ export class TFuseIndex extends TextIndexBase {
   static canHighlight = false;
 
   #options: IFuseOptions<string>;
+  // @ts-expect-error it is assigned later
   #index: Fuse<any>;
 
   constructor({ fields, idKey }: TextIndexBaseOptions) {
@@ -30,7 +31,7 @@ export class TFuseIndex extends TextIndexBase {
     this.#index = new Fuse(items, this.#options);
   }
 
-  search(query, options?: FuseSearchOptions & TextSearchOptions) {
+  search(query: string, options?: FuseSearchOptions & TextSearchOptions) {
     const matches = new Map<number, ReadonlyArray<FuseResultMatch>>();
     return {
       ids: this.#index.search(query, options).map((x) => {

packages/facets/src/TMinisearchIndex.ts

@@ -27,7 +27,7 @@ export class TMinisearchIndex extends TextIndexBase {
     this.#index.addAll(items);
   }
 
-  search(query, options?: SearchOptions & TextSearchOptions) {
+  search(query: string, options?: SearchOptions & TextSearchOptions) {
     const matches = new Map<number, MatchInfo>();
     console.log()
     return {

packages/facets/src/TQuickscoreIndex.ts

@@ -9,6 +9,7 @@ export class TQuickscoreIndex extends TextIndexBase {
   static canHighlight = true;
 
   #fields: Array<string>;
+  // @ts-expect-error it is assigned later
   #index: QuickScore<any>;
   #idKey: string;
 
@@ -22,7 +23,7 @@ export class TQuickscoreIndex extends TextIndexBase {
     this.#index = new QuickScore(items, this.#fields);
   }
 
-  search(query) {
+  search(query: string) {
     const matches = new Map<number, Record<string, RangeTuple[]>>();
     return {
       ids: (this.#index.search(query) as ScoredObject<any>[]).map((x) => {

packages/facets/src/TextIndex.ts

@@ -17,18 +17,18 @@ export class TextIndexBase {
   static requiresId = false;
   static canHighlight = false;
 
-  constructor(opt: TextIndexBaseOptions) {}
+  constructor(_opt: TextIndexBaseOptions) {}
 
-  search(query: string, options?: TextSearchOptions): TextIndexBaseResults {
+  search(_query: string, _options?: TextSearchOptions): TextIndexBaseResults {
     throw new Error("not impelemted");
   }
-  addAll(values: any[]): void {
+  addAll(_values: any[]): void {
     throw new Error("not impelemted");
   }
-  addOne(id: number, value: any): void {
+  addOne(_id: number, _value: any): void {
     throw new Error("not impelemted");
   }
-  highlight(matches: Map<number, any>): (value: any) => Record<string, string> {
+  highlight(_matches: Map<number, any>): (value: any) => Record<string, string> {
     throw new Error("not impelemted");
   }
 }

packages/facets/tsconfig.json

@@ -0,0 +1,8 @@
+{
+  "extends": "../../tsconfig.json",
+  "compilerOptions": {
+    "module": "ESNext",
+    "moduleResolution": "Node"
+  },
+  "include": ["src"]
+}

tsconfig.json

@@ -0,0 +1,22 @@
+{
+  "compilerOptions": {
+    "target": "ES2020",
+    "useDefineForClassFields": true,
+    "module": "ESNext",
+    "lib": ["ES2020", "DOM", "DOM.Iterable"],
+    "skipLibCheck": true,
+
+    /* Bundler mode */
+    "moduleResolution": "bundler",
+    // "allowImportingTsExtensions": true,
+    "resolveJsonModule": true,
+    "isolatedModules": true,
+    "noEmit": true,
+
+    /* Linting */
+    "strict": true,
+    "noUnusedLocals": true,
+    "noUnusedParameters": true,
+    "noFallthroughCasesInSwitch": true
+  }
+}

turbo.json

@@ -3,6 +3,9 @@
   "pipeline": {
     "test": {},
     "clean": {},
+    "tsc": {
+      "dependsOn": ["^build"]
+    },
     "build": {
       "dependsOn": ["^build"],
       "outputs": ["dist/**"]