feat: enhance menu contribution provider to support icon registration

AdminForth/1686/we-need-here-same-looking-gif-

Author: yaroslav8765

adminforth/documentation/docs/tutorial/03-Customization/10-menuConfiguration.md

@@ -154,10 +154,14 @@ async modifyResourceConfig(adminforth, resourceConfig) {
         placement: { position: 'first' },
       },
     ];
+  }, {
+    icons: ['flowbite:chart-pie-solid'],
   });
 }
 ```
 
+AdminForth bundles menu icons when it builds the SPA. Providers are called during the build too, but without `adminUser`, so items they return only at runtime are not visible there. List every icon the provider can return in the `icons` option, otherwise it renders empty.
+
 After the plugin changes the state used by the provider, call `refreshMenu` on the backend:
 
 ```ts
@@ -528,10 +532,14 @@ async modifyResourceConfig(adminforth, resourceConfig) {
         placement: { position: 'first' },
       },
     ];
+  }, {
+    icons: ['flowbite:chart-pie-solid'],
   });
 }
 ```
 
+AdminForth bundles menu icons when it builds the SPA. Providers are called during the build too, but without `adminUser`, so items they return only at runtime are not visible there. List every icon the provider can return in the `icons` option, otherwise it renders empty.
+
 After the plugin changes the state used by the provider, call `refreshMenu` on the backend:
 
 ```ts

adminforth/index.ts

@@ -117,6 +117,7 @@ class AdminForth implements IAdminForth {
   pluginsById: Record<string, AdminForthPlugin> = {};
   private menuContributions: AdminForthMenuContribution[] = [];
   private menuContributionProviders: AdminForthMenuContributionProvider[] = [];
+  menuContributionProviderIcons: string[] = [];
   configValidator: IConfigValidator;
   restApi: AdminForthRestAPI;
 
@@ -126,8 +127,9 @@ class AdminForth implements IAdminForth {
     this.menuContributions.push(contribution);
   }
 
-  registerMenuContributionProvider(provider: AdminForthMenuContributionProvider): void {
+  registerMenuContributionProvider(provider: AdminForthMenuContributionProvider, { icons = [] }: { icons?: string[] } = {}): void {
     this.menuContributionProviders.push(provider);
+    this.menuContributionProviderIcons.push(...icons);
   }
 
   getMenuContributions(): AdminForthMenuContribution[] {

adminforth/modules/codeInjector.ts

@@ -766,6 +766,8 @@ class CodeInjector implements ICodeInjector {
     registerCustomPages(this.adminforth.config);
     const menuWithContributions = await this.adminforth.getMenuWithContributions();
     collectAssetsFromMenu(menuWithContributions);
+    // providers get no adminUser here, so icons they return only at runtime are declared on registration
+    icons.push(...this.adminforth.menuContributionProviderIcons);
     registerSettingPages(this.adminforth.config.auth.userMenuSettingsPages);
     const spaDir = this.getSpaDir();
 

adminforth/types/Back.ts

@@ -701,7 +701,13 @@ export interface IAdminForth {
   getPluginById<T>(id: string): T;
 
   registerMenuContribution(contribution: AdminForthMenuContribution): void;
-  registerMenuContributionProvider(provider: AdminForthMenuContributionProvider): void;
+  /**
+   * Registers a provider which is called every time the menu is fetched.
+   *
+   * AdminForth bundles menu icons when it builds the SPA, and providers are called there without `adminUser`,
+   * so list in `options.icons` every icon the provider can return, otherwise it renders empty.
+   */
+  registerMenuContributionProvider(provider: AdminForthMenuContributionProvider, options?: { icons?: string[] }): void;
   getMenuContributions(): AdminForthMenuContribution[];
   getMenuWithContributions(adminUser?: AdminUser, menu?: AdminForthConfigMenuItem[]): Promise<AdminForthConfigMenuItem[]>;