Merge pull request #470 from devforth/feature/AdminForth/1209/implement-getpluginbyid-map-pl

feat: implement getPluginById method and update plugin registration w…

Author: NoOne7135

adminforth/index.ts

@@ -116,6 +116,7 @@ class AdminForth implements IAdminForth {
   connectorClasses: any;
   runningHotReload: boolean;
   activatedPlugins: Array<AdminForthPlugin>;
+  pluginsById: Record<string, AdminForthPlugin> = {};
   configValidator: IConfigValidator;
   restApi: AdminForthRestAPI;
 
@@ -256,6 +257,13 @@ 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`);
           }
+          const pluginId = pluginInstance.pluginOptions?.id;
+          if (pluginId) {
+            if (this.pluginsById[pluginId]) {
+              throw new Error(`Plugin with id "${pluginId}" already exists!`);
+            }
+            this.pluginsById[pluginId] = pluginInstance;
+          }
           this.activatedPlugins.push(pluginInstance);
           afLogger.trace(`🔌 Plugin ${pluginInstance.constructor.name} activated successfully`);
         }
@@ -282,6 +290,15 @@ class AdminForth implements IAdminForth {
     return plugins[0] as T;
   }
 
+  getPluginById<T = any>(id: string): T {
+    const plugin = this.pluginsById[id];
+    if (!plugin) {
+      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;
+    }
+
   validateFieldGroups(fieldGroups: {
     groupName: string;
     columns: string[];

adminforth/types/Back.ts

@@ -424,6 +424,17 @@ export interface IAdminForth {
    * 
    */
   getPluginByClassName<T>(className: string): T;
+
+  /**
+   *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>('AuditLogPlugin');
+   * ```
+   */
+  getPluginById<T>(id: string): T;
 }
 
 

dev-demo/resources/auditLogs.ts

@@ -39,6 +39,7 @@ export default {
   },
   plugins: [
     new AuditLogPlugin({
+      id: 'AuditLogPlugin',
       // if you want to exclude some resources from logging
       //excludeResourceIds: ['adminuser'],
       resourceColumns: {

dev-demo/resources/carsResourseTemplate.ts

@@ -373,7 +373,8 @@ export default function carsResourseTemplate(resourceId: string, dataSource: str
               return { ok: false, error: result?.error ?? 'Provided 2fa verification data is invalid' };
             }
             await adminforth
-              .getPluginByClassName<AuditLogPlugin>('AuditLogPlugin')
+              // .getPluginByClassName<AuditLogPlugin>('AuditLogPlugin')
+              .getPluginById<AuditLogPlugin>('AuditLogPlugin')
               .logCustomAction({
                 resourceId: resourceId,
                 recordId: null,