refactor: Make ts/eslint happy

eslint.config.js

@@ -101,13 +101,13 @@ const config = [
       '@typescript-eslint': tseslint.plugin
     },
     rules: {
-      '@typescript-eslint/no-unsafe-argument': 'warn',
-      '@typescript-eslint/no-unsafe-assignment': 'warn',
-      '@typescript-eslint/no-unsafe-call': 'warn',
-      '@typescript-eslint/no-unsafe-member-access': 'warn',
-      '@typescript-eslint/no-unsafe-return': 'warn',
+      '@typescript-eslint/no-unsafe-argument': 'error',
+      '@typescript-eslint/no-unsafe-assignment': 'error',
+      '@typescript-eslint/no-unsafe-call': 'error',
+      '@typescript-eslint/no-unsafe-member-access': 'error',
+      '@typescript-eslint/no-unsafe-return': 'error',
       '@typescript-eslint/explicit-function-return-type': 'error',
-      '@typescript-eslint/no-explicit-any': 'warn',
+      '@typescript-eslint/no-explicit-any': 'error',
       '@typescript-eslint/no-unused-vars': [
         'error',
         { ignoreRestSiblings: true }

package.json

@@ -14,7 +14,7 @@
   "dependencies": {
     "comlink": "^4.4.1",
     "cozy-app-publish": "^0.34.0",
-    "cozy-client": "^49.0.0",
+    "cozy-client": "^49.8.0",
     "cozy-device-helper": "^3.1.0",
     "cozy-flags": "^4.0.0",
     "cozy-logger": "^1.10.4",
@@ -37,6 +37,7 @@
     "@testing-library/jest-dom": "^6.4.2",
     "@testing-library/react": "^14.2.1",
     "@types/jest": "^29.5.13",
+    "@types/pouchdb-browser": "^6.1.5",
     "@types/react": "^18.3.5",
     "@types/react-dom": "^18.3.0",
     "@types/sharedworker": "^0.0.126",

src/@types/cozy-client.d.ts

@@ -170,14 +170,14 @@ declare module 'cozy-client' {
   }
 
   export default class CozyClient {
-    plugins: any
+    plugins: unknown
     constructor(rawOptions?: ClientOptions)
     getStackClient(): StackClient
     getInstanceOptions(): InstanceOptions
     instanceOptions: InstanceOptions
     collection(doctype: string): Collection
     isLogged: boolean
-    on: (event: string, callback: () => void) => void
+    on: (event: string, callback: (doctype: string) => void) => void
     removeListener: (event: string, callback: () => void) => void
     logout: () => Promise<void>
     query: (

src/@types/cozy-realtime.d.ts

@@ -0,0 +1,3 @@
+declare module 'cozy-realtime' {
+  export const RealtimePlugin = (): null => null
+}

src/dataproxy/worker/platformWorker.ts

@@ -31,14 +31,15 @@ const openDB = (): Promise<IDBDatabase> => {
 }
 
 const storage = {
-  getItem: async (key: string): Promise<any> => {
+  getItem: async (key: string): Promise<unknown> => {
     const db = await openDB()
     return new Promise((resolve, reject) => {
       const transaction = db.transaction('store', 'readonly')
       const store = transaction.objectStore('store')
       const request = store.get(key)
 
       request.onsuccess = (): void => {
+        // eslint-disable-next-line @typescript-eslint/no-unsafe-member-access
         resolve(request.result ? request.result.value : null)
       }
 
@@ -48,7 +49,7 @@ const storage = {
     })
   },
 
-  setItem: async (key: string, value: any): Promise<void> => {
+  setItem: async (key: string, value: unknown): Promise<void> => {
     const db = await openDB()
     return new Promise((resolve, reject) => {
       const transaction = db.transaction('store', 'readwrite')
@@ -105,6 +106,7 @@ const isOnline = async (): Promise<boolean> => {
 export const platformWorker = {
   storage,
   events,
+  // eslint-disable-next-line @typescript-eslint/no-unsafe-assignment
   pouchAdapter: PouchDB,
   isOnline
 }

src/search/SearchEngine.ts

@@ -13,7 +13,8 @@ import {
   LIMIT_DOCTYPE_SEARCH,
   REPLICATION_DEBOUNCE,
   ROOT_DIR_ID,
-  SHARED_DRIVES_DIR_ID
+  SHARED_DRIVES_DIR_ID,
+  SearchedDoctype
 } from '@/search/consts'
 import { getPouchLink } from '@/search/helpers/client'
 import { getSearchEncoder } from '@/search/helpers/getSearchEncoder'
@@ -30,10 +31,10 @@ import {
   isIOCozyApp,
   isIOCozyContact,
   isIOCozyFile,
-  SearchedDoctype,
   SearchIndex,
   SearchIndexes,
-  SearchResult
+  SearchResult,
+  isSearchedDoctype
 } from '@/search/types'
 
 const log = Minilog('🗂️ [Indexing]')
@@ -50,7 +51,7 @@ class SearchEngine {
 
   constructor(client: CozyClient) {
     this.client = client
-    this.searchIndexes = {}
+    this.searchIndexes = {} as SearchIndexes
 
     this.indexOnChanges()
     this.debouncedReplication = startReplicationWithDebounce(
@@ -64,7 +65,9 @@ class SearchEngine {
       return
     }
     this.client.on('pouchlink:doctypesync:end', async (doctype: string) => {
-      await this.indexDocsForSearch(doctype)
+      if (isSearchedDoctype(doctype)) {
+        await this.indexDocsForSearch(doctype as keyof typeof SEARCH_SCHEMA)
+      }
     })
     this.client.on('login', () => {
       // Ensure login is done before plugin register
@@ -79,15 +82,17 @@ class SearchEngine {
   }
 
   subscribeDoctype(client: CozyClient, doctype: string): void {
+    /* eslint-disable @typescript-eslint/no-unsafe-assignment, @typescript-eslint/no-unsafe-member-access, @typescript-eslint/no-unsafe-call */
     const realtime = this.client.plugins.realtime
     realtime.subscribe('created', doctype, this.handleUpdatedOrCreatedDoc)
     realtime.subscribe('updated', doctype, this.handleUpdatedOrCreatedDoc)
     realtime.subscribe('deleted', doctype, this.handleDeletedDoc)
+    /* eslint-enable @typescript-eslint/no-unsafe-assignment, @typescript-eslint/no-unsafe-member-access, @typescript-eslint/no-unsafe-call */
   }
 
   handleUpdatedOrCreatedDoc(doc: CozyDoc): void {
-    const doctype: string | undefined = doc._type
-    if (!doctype) {
+    const doctype = doc._type
+    if (!isSearchedDoctype(doctype)) {
       return
     }
     const searchIndex = this.searchIndexes?.[doctype]
@@ -102,8 +107,8 @@ class SearchEngine {
   }
 
   handleDeletedDoc(doc: CozyDoc): void {
-    const doctype: string | undefined = doc._type
-    if (!doctype) {
+    const doctype = doc._type
+    if (!isSearchedDoctype(doctype)) {
       return
     }
     const searchIndex = this.searchIndexes?.[doctype]
@@ -112,7 +117,7 @@ class SearchEngine {
       return
     }
     log.debug('[REALTIME] remove doc from index after update : ', doc)
-    this.searchIndexes[doctype].index.remove(doc._id)
+    this.searchIndexes[doctype].index.remove(doc._id!)
 
     this.debouncedReplication()
   }
@@ -126,6 +131,7 @@ class SearchEngine {
     const flexsearchIndex = new FlexSearch.Document<CozyDoc, true>({
       tokenize: 'forward',
       encode: getSearchEncoder(),
+      // @ts-ignore
       minlength: 2,
       document: {
         id: '_id',
@@ -152,7 +158,7 @@ class SearchEngine {
 
   shouldIndexDoc(doc: CozyDoc): boolean {
     if (isIOCozyFile(doc)) {
-      const notInTrash = !doc.trashed && !/^\/\.cozy_trash/.test(doc.path)
+      const notInTrash = !doc.trashed && !/^\/\.cozy_trash/.test(doc.path ?? '')
       const notRootDir = doc._id !== ROOT_DIR_ID
       // Shared drives folder to be hidden in search.
       // The files inside it though must appear. Thus only the file with the folder ID is filtered out.
@@ -163,7 +169,9 @@ class SearchEngine {
     return true
   }
 
-  async indexDocsForSearch(doctype: string): Promise<SearchIndex | null> {
+  async indexDocsForSearch(
+    doctype: keyof typeof SEARCH_SCHEMA
+  ): Promise<SearchIndex | null> {
     const searchIndex = this.searchIndexes[doctype]
     const pouchLink = getPouchLink(this.client)
 
@@ -173,7 +181,9 @@ class SearchEngine {
 
     if (!searchIndex) {
       // First creation of search index
-      const docs = await this.client.queryAll(Q(doctype).limitBy(null))
+      const docs = await this.client.queryAll<CozyDoc[]>(
+        Q(doctype).limitBy(null)
+      )
       const index = this.buildSearchIndex(doctype, docs)
       const info = await pouchLink.getDbInfo(doctype)
 
@@ -199,7 +209,7 @@ class SearchEngine {
       if (change.deleted) {
         searchIndex.index.remove(change.id)
       } else {
-        const normalizedDoc = { ...change.doc, _type: doctype }
+        const normalizedDoc = { ...change.doc, _type: doctype } as CozyDoc
         this.addDocToIndex(searchIndex.index, normalizedDoc)
       }
     }
@@ -222,10 +232,19 @@ class SearchEngine {
     const appsIndex = this.buildSearchIndex('io.cozy.apps', apps)
 
     log.debug('Finished initializing indexes')
+    const currentDate = new Date().toISOString()
     this.searchIndexes = {
-      [FILES_DOCTYPE]: { index: filesIndex, lastSeq: 0 },
-      [CONTACTS_DOCTYPE]: { index: contactsIndex, lastSeq: 0 },
-      [APPS_DOCTYPE]: { index: appsIndex, lastSeq: 0 }
+      [FILES_DOCTYPE]: {
+        index: filesIndex,
+        lastSeq: 0,
+        lastUpdated: currentDate
+      },
+      [CONTACTS_DOCTYPE]: {
+        index: contactsIndex,
+        lastSeq: 0,
+        lastUpdated: currentDate
+      },
+      [APPS_DOCTYPE]: { index: appsIndex, lastSeq: 0, lastUpdated: currentDate }
     }
     return this.searchIndexes
   }
@@ -250,21 +269,25 @@ class SearchEngine {
 
   searchOnIndexes(query: string): FlexSearchResultWithDoctype[] {
     let searchResults: FlexSearchResultWithDoctype[] = []
-    for (const doctype in this.searchIndexes) {
+    for (const key in this.searchIndexes) {
+      const doctype = key as SearchedDoctype // XXX - Should not be necessary
       const index = this.searchIndexes[doctype]
       if (!index) {
         log.warn('[SEARCH] No search index available for ', doctype)
         continue
       }
       // TODO: do not use flexsearch store and rely on pouch storage?
       // It's better for memory, but might slow down search queries
-      const indexResults = index.index.search(query, {
+      // XXX - The limit is specified twice because of a flexsearch inconstency
+      // that does not enforce the limit if only given in second argument, and
+      // does not return the correct type is only given in third options
+      const indexResults = index.index.search(query, LIMIT_DOCTYPE_SEARCH, {
         limit: LIMIT_DOCTYPE_SEARCH,
         enrich: true
       })
       const newResults = indexResults.map(res => ({
         ...res,
-        doctype
+        doctype: doctype
       }))
       searchResults = searchResults.concat(newResults)
     }
@@ -278,11 +301,14 @@ class SearchEngine {
       item.result.map(r => ({ ...r, field: item.field, doctype: item.doctype }))
     )
 
-    const resultMap = new Map<FlexSearch.Id[], any>()
+    type MapItem = Omit<(typeof combinedResults)[number], 'field'> & {
+      fields: string[]
+    }
+    const resultMap = new Map<FlexSearch.Id[], MapItem>()
 
     combinedResults.forEach(({ id, field, ...rest }) => {
       if (resultMap.has(id)) {
-        resultMap.get(id).fields.push(field)
+        resultMap.get(id)?.fields.push(field)
       } else {
         resultMap.set(id, { id, fields: [field], ...rest })
       }

src/search/consts.ts

@@ -1,5 +1,12 @@
+const SEARCHABLE_DOCTYPES = [
+  'io.cozy.files',
+  'io.cozy.contacts',
+  'io.cozy.apps'
+] as const
+export type SearchedDoctype = (typeof SEARCHABLE_DOCTYPES)[number]
+
 // Attribute order matters to apply priority on matching results
-export const SEARCH_SCHEMA = {
+export const SEARCH_SCHEMA: Record<SearchedDoctype, string[]> = {
   'io.cozy.files': ['name', 'path'],
   'io.cozy.contacts': [
     'displayName',

src/search/helpers/replication.spec.ts

@@ -9,9 +9,13 @@ jest.mock('@/search/helpers/client', () => ({
   getPouchLink: jest.fn()
 }))
 
+interface PouchLink {
+  startReplication: Function
+}
+
 describe('startReplicationWithDebounce', () => {
   let client: CozyClient
-  let pouchLink: any
+  let pouchLink: PouchLink
 
   beforeEach(() => {
     client = new CozyClient()

src/search/types.ts

@@ -2,7 +2,13 @@ import FlexSearch from 'flexsearch'
 
 import { IOCozyFile, IOCozyContact, IOCozyApp } from 'cozy-client/types/types'
 
-import { APPS_DOCTYPE, CONTACTS_DOCTYPE, FILES_DOCTYPE } from '@/search/consts'
+import {
+  APPS_DOCTYPE,
+  CONTACTS_DOCTYPE,
+  FILES_DOCTYPE,
+  SEARCH_SCHEMA,
+  SearchedDoctype
+} from '@/search/consts'
 
 export type CozyDoc = IOCozyFile | IOCozyContact | IOCozyApp
 
@@ -18,17 +24,15 @@ export const isIOCozyApp = (doc: CozyDoc): doc is IOCozyApp => {
   return doc._type === APPS_DOCTYPE
 }
 
-const searchedDoctypes = [
-  APPS_DOCTYPE,
-  CONTACTS_DOCTYPE,
-  FILES_DOCTYPE
-] as const
-export type SearchedDoctype = (typeof searchedDoctypes)[number]
+const searchedDoctypes = Object.keys(SEARCH_SCHEMA)
 
 export const isSearchedDoctype = (
-  doctype: string
+  doctype: string | undefined
 ): doctype is SearchedDoctype => {
-  return true
+  if (!doctype) {
+    return false
+  }
+  return searchedDoctypes.includes(doctype)
 }
 
 export interface RawSearchResult
@@ -52,5 +56,5 @@ export interface SearchIndex {
 }
 
 export type SearchIndexes = {
-  [key: string]: SearchIndex
+  [key in SearchedDoctype]: SearchIndex
 }