chore: adjusted types for clarity

Author: raideer

src/indexer/AbstractIndexData.ts

@@ -1,7 +1,8 @@
 import { Memoize } from 'typescript-memoize';
+import { IndexedFilePath } from 'types/indexer';
 
 export abstract class AbstractIndexData<T = any> {
-  public constructor(protected data: Map<string, T>) {}
+  public constructor(protected data: Map<IndexedFilePath, T>) {}
 
   @Memoize()
   public getValues(): T[] {

src/indexer/IndexManager.ts

@@ -13,6 +13,7 @@ import { ModuleIndexData } from './module/ModuleIndexData';
 import { AutoloadNamespaceIndexData } from './autoload-namespace/AutoloadNamespaceIndexData';
 import { EventsIndexData } from './events/EventsIndexData';
 import Logger from 'util/Logger';
+import { IndexerKey } from 'types/indexer';
 
 type IndexerInstance = DiIndexer | ModuleIndexer | AutoloadNamespaceIndexer | EventsIndexer;
 
@@ -121,7 +122,7 @@ class IndexManager {
   }
 
   public getIndexStorageData<T = any>(
-    id: string,
+    id: IndexerKey,
     workspaceFolder?: WorkspaceFolder
   ): Map<string, T> | undefined {
     const wf = workspaceFolder || Common.getActiveWorkspaceFolder();

src/indexer/IndexStorage.ts

@@ -1,19 +1,21 @@
 import { WorkspaceFolder } from 'vscode';
-
-export type IndexerStorage<T = any> = Record<string, Record<string, Map<string, T>>>;
+import { IndexerKey, IndexerStorage, IndexedFilePath } from 'types/indexer';
 
 export default class IndexStorage {
   private _indexStorage: IndexerStorage = {};
 
-  public set(workspaceFolder: WorkspaceFolder, key: string, value: any) {
+  public set(workspaceFolder: WorkspaceFolder, key: IndexerKey, value: Map<IndexedFilePath, any>) {
     if (!this._indexStorage[workspaceFolder.uri.fsPath]) {
       this._indexStorage[workspaceFolder.uri.fsPath] = {};
     }
 
     this._indexStorage[workspaceFolder.uri.fsPath][key] = value;
   }
 
-  public get<T = any>(workspaceFolder: WorkspaceFolder, key: string): Map<string, T> | undefined {
+  public get<T = any>(
+    workspaceFolder: WorkspaceFolder,
+    key: IndexerKey
+  ): Map<IndexedFilePath, T> | undefined {
     return this._indexStorage[workspaceFolder.uri.fsPath]?.[key];
   }
 

src/indexer/Indexer.ts

@@ -1,7 +1,8 @@
 import { type GlobPattern, type Uri } from 'vscode';
+import { IndexerKey } from 'types/indexer';
 
 export abstract class Indexer<D = any> {
-  public abstract getId(): string;
+  public abstract getId(): IndexerKey;
   public abstract getName(): string;
   public abstract getPattern(uri: Uri): GlobPattern;
   public abstract indexFile(uri: Uri): Promise<D | undefined>;

src/indexer/autoload-namespace/AutoloadNamespaceIndexer.ts

@@ -2,11 +2,12 @@ import { RelativePattern, Uri } from 'vscode';
 import { Indexer } from 'indexer/Indexer';
 import FileSystem from 'util/FileSystem';
 import { Namespace } from './types';
+import { IndexerKey } from 'types/indexer';
 
 export default class AutoloadNamespaceIndexer extends Indexer<Namespace[]> {
   public static readonly KEY = 'autoloadNamespace';
 
-  public getId(): string {
+  public getId(): IndexerKey {
     return AutoloadNamespaceIndexer.KEY;
   }
 

src/indexer/di/DiIndexer.ts

@@ -4,6 +4,7 @@ import { get } from 'lodash-es';
 import FileSystem from 'util/FileSystem';
 import { DiData, DiPlugin, DiPreference, DiType, DiVirtualType } from './types';
 import { Indexer } from 'indexer/Indexer';
+import { IndexerKey } from 'types/indexer';
 
 export default class DiIndexer extends Indexer<DiData> {
   public static readonly KEY = 'di';
@@ -29,7 +30,7 @@ export default class DiIndexer extends Indexer<DiData> {
     });
   }
 
-  public getId(): string {
+  public getId(): IndexerKey {
     return DiIndexer.KEY;
   }
 

src/indexer/events/EventsIndexer.ts

@@ -3,6 +3,7 @@ import { XMLParser } from 'fast-xml-parser';
 import { get } from 'lodash-es';
 import { Indexer } from 'indexer/Indexer';
 import FileSystem from 'util/FileSystem';
+import { IndexerKey } from 'types/indexer';
 
 export default class EventsIndexer extends Indexer<Event[]> {
   public static readonly KEY = 'events';
@@ -21,7 +22,7 @@ export default class EventsIndexer extends Indexer<Event[]> {
     });
   }
 
-  public getId(): string {
+  public getId(): IndexerKey {
     return EventsIndexer.KEY;
   }
 

src/indexer/module/ModuleIndexer.ts

@@ -4,6 +4,7 @@ import { get } from 'lodash-es';
 import { Module } from './types';
 import { Indexer } from 'indexer/Indexer';
 import FileSystem from 'util/FileSystem';
+import { IndexerKey } from 'types/indexer';
 
 export default class ModuleIndexer extends Indexer<Module> {
   public static readonly KEY = 'module';
@@ -22,7 +23,7 @@ export default class ModuleIndexer extends Indexer<Module> {
     });
   }
 
-  public getId(): string {
+  public getId(): IndexerKey {
     return ModuleIndexer.KEY;
   }
 

src/types/indexer.ts

@@ -0,0 +1,8 @@
+export type IndexerKey = string;
+export type IndexedFilePath = string;
+type WorkspacePath = string;
+
+export type IndexerStorage<T = any> = Record<
+  WorkspacePath,
+  Record<IndexerKey, Map<IndexedFilePath, T>>
+>;