feat: enhance getPluginById method to support custom identifiers and improve error messaging

Author: Pavlo Kulyk

adminforth/index.ts

@@ -257,11 +257,12 @@ class AdminForth implements IAdminForth {
             throw new Error(`Attempt to activate Plugin ${pluginInstance.constructor.name} second time for same resource, but plugin does not support it. 
               To support multiple plugin instance pre one resource, plugin should return unique string values for each installation from instanceUniqueRepresentation`);
           }
-          if (pluginInstance.id) {
-            if (this.pluginsById[pluginInstance.id]) {
-              throw new Error(`Plugin with id "${pluginInstance.id}" already exists!`);
+          const pluginId = pluginInstance.pluginOptions?.id;
+          if (pluginId) {
+            if (this.pluginsById[pluginId]) {
+              throw new Error(`Plugin with id "${pluginId}" already exists!`);
             }
-            this.pluginsById[pluginInstance.id] = pluginInstance;
+            this.pluginsById[pluginId] = pluginInstance;
           }
           this.activatedPlugins.push(pluginInstance);
           afLogger.trace(`🔌 Plugin ${pluginInstance.constructor.name} activated successfully`);
@@ -289,13 +290,14 @@ class AdminForth implements IAdminForth {
     return plugins[0] as T;
   }
 
-   getPluginById<T = any>(id: string): T {
+  getPluginById<T = any>(id: string): T {
     const plugin = this.pluginsById[id];
     if (!plugin) {
-      throw new Error(`Plugin with id "${id}" not found`);
+      const similar = suggestIfTypo(Object.keys(this.pluginsById), id);
+      throw new Error(`Plugin with id "${id}" not found.${similar ? ` Did you mean "${similar}"?` : ''}`);
+      }
+      return plugin as T;
     }
-    return plugin as T;
-  }
 
   validateFieldGroups(fieldGroups: {
     groupName: string;

adminforth/types/Back.ts

@@ -426,15 +426,15 @@ export interface IAdminForth {
   getPluginByClassName<T>(className: string): T;
 
   /**
-   * This method can be used when you want to get a plugin instance by its unique pluginInstanceId.
-   * @param pluginInstanceId - unique id of the plugin instance
+   *This method can be used when you want to get a plugin instance by its unique identifier.
+   * @param id - unique id of the plugin instance (custom identifier passed when registering/configuring the plugin)
    * 
    * Example:
    * ```ts
-   * const auditLog = adminforth.getPluginById<AuditLogPlugin>('TestPlugin');
+   * const auditLog = adminforth.getPluginById<AuditLogPlugin>('AuditLogPlugin');
    * ```
    */
-  getPluginById<T>(pluginInstanceId: string): T;
+  getPluginById<T>(id: string): T;
 }