feat: advanced admin registry extenders (#4209)

* feat: advanced admin registry extenders
* fix: admin extender execution order

Author: SychO9

framework/core/js/src/admin/AdminApplication.tsx

@@ -129,12 +129,14 @@ export default class AdminApplication extends Application {
     this.route = (Object.getPrototypeOf(Object.getPrototypeOf(this)) as Application).route.bind(this);
   }
 
-  protected beforeMount(): void {
+  protected runBeforeMount(): void {
     BasicsPage.register();
     AppearancePage.register();
     MailPage.register();
     AdvancedPage.register();
     PermissionsPage.register();
+
+    super.runBeforeMount();
   }
 
   /**

framework/core/js/src/admin/components/GeneralSearchSource.tsx

@@ -9,7 +9,7 @@ import Icon from '../../common/components/Icon';
 import PermissionGrid from './PermissionGrid';
 import escapeRegExp from '../../common/utils/escapeRegExp';
 import { GeneralIndexData, GeneralIndexItem } from '../states/GeneralSearchIndex';
-import { ExtensionConfig, SettingConfigInternal } from '../utils/AdminRegistry';
+import { ExtensionConfig, SettingConfigInput } from '../utils/AdminRegistry';
 import ItemList from '../../common/utils/ItemList';
 
 export class GeneralSearchResult {
@@ -94,7 +94,7 @@ export default class GeneralSearchSource implements GlobalSearchSource {
     for (const extensionId in data) {
       // settings
       const settings = data[extensionId]!.settings;
-      let normalizedSettings: GeneralIndexItem[] | SettingConfigInternal[] = [];
+      let normalizedSettings: GeneralIndexItem[] | SettingConfigInput[] = [];
 
       if (settings instanceof ItemList) {
         normalizedSettings = settings?.toArray();
@@ -113,7 +113,7 @@ export default class GeneralSearchSource implements GlobalSearchSource {
         const group = app.generalIndex.getGroup(extensionId);
 
         if (this.itemHasQuery(label, query) || this.itemHasQuery(help, query)) {
-          const id = extensionId + '-' + ('setting' in setting ? setting : setting.id);
+          const id = extensionId + '-' + ('setting' in setting ? setting : 'id' in setting ? setting.id : '');
 
           results.push(
             new GeneralSearchResult(

framework/core/js/src/admin/utils/AdminRegistry.ts

@@ -71,7 +71,7 @@ export default class AdminRegistry {
    *   label: app.translator.trans('flarum-flags.admin.settings.guidelines_url_label')
    * }, 15) // priority is optional (ItemList)
    */
-  registerSetting(content: SettingConfigInput, priority = 0): this {
+  registerSetting(content: SettingConfigInput, priority = 0, key: string | null = null): this {
     if (this.state.currentExtension === null) {
       throw new Error(noActiveExtensionErrorMessage);
     }
@@ -83,7 +83,7 @@ export default class AdminRegistry {
     // To support multiple such items for one extension, we assign a random ID.
     // 36 is arbitrary length, but makes collisions very unlikely.
     if (tmpContent instanceof Function) {
-      tmpContent.setting = Math.random().toString(36);
+      tmpContent.setting = key || Math.random().toString(36);
     }
 
     const settings = this.state.data[this.state.currentExtension].settings || new ItemList();
@@ -94,6 +94,62 @@ export default class AdminRegistry {
     return this;
   }
 
+  /**
+   * This function allows you to change the configuration of a setting.
+   */
+  setSetting(key: string, content: SettingConfigInput | ((original: SettingConfigInput) => SettingConfigInput)): this {
+    if (this.state.currentExtension === null) {
+      throw new Error(noActiveExtensionErrorMessage);
+    }
+
+    const settings = this.state.data[this.state.currentExtension].settings || new ItemList();
+
+    if (settings.has(key)) {
+      if (content instanceof Function) {
+        const original = settings.get(key);
+        content = content(original) as SettingConfigInternal;
+      }
+
+      settings.setContent(key, content as SettingConfigInternal);
+    }
+
+    return this;
+  }
+
+  /**
+   * This function allows you to change the priority of a setting.
+   */
+  setSettingPriority(key: string, priority: number): this {
+    if (this.state.currentExtension === null) {
+      throw new Error(noActiveExtensionErrorMessage);
+    }
+
+    const settings = this.state.data[this.state.currentExtension].settings || new ItemList();
+
+    if (settings.has(key)) {
+      settings.setPriority(key, priority);
+    }
+
+    return this;
+  }
+
+  /**
+   * This function allows you to remove a setting.
+   */
+  removeSetting(key: string): this {
+    if (this.state.currentExtension === null) {
+      throw new Error(noActiveExtensionErrorMessage);
+    }
+
+    const settings = this.state.data[this.state.currentExtension].settings || new ItemList();
+
+    if (settings.has(key)) {
+      settings.remove(key);
+    }
+
+    return this;
+  }
+
   /**
    * This function registers your permission with Flarum
    *
@@ -125,6 +181,65 @@ export default class AdminRegistry {
     return this;
   }
 
+  /**
+   * This function allows you to change the configuration of a permission.
+   */
+  setPermission(key: string, content: PermissionConfig | ((original: PermissionConfig) => PermissionConfig), permissionType: PermissionType): this {
+    if (this.state.currentExtension === null) {
+      throw new Error(noActiveExtensionErrorMessage);
+    }
+
+    const permissions = this.state.data[this.state.currentExtension].permissions || {};
+    const permissionsForType = permissions[permissionType] || new ItemList();
+
+    if (permissionsForType.has(key)) {
+      if (content instanceof Function) {
+        const original = permissionsForType.get(key);
+        content = content(original) as PermissionConfig;
+      }
+
+      permissionsForType.setContent(key, content);
+    }
+
+    return this;
+  }
+
+  /**
+   * This function allows you to change the priority of a permission.
+   */
+  setPermissionPriority(key: string, permissionType: PermissionType, priority: number): this {
+    if (this.state.currentExtension === null) {
+      throw new Error(noActiveExtensionErrorMessage);
+    }
+
+    const permissions = this.state.data[this.state.currentExtension].permissions;
+    const permissionsForType = permissions?.[permissionType] || new ItemList();
+
+    if (permissionsForType.has(key)) {
+      permissionsForType.setPriority(key, priority);
+    }
+
+    return this;
+  }
+
+  /**
+   * This function allows you to remove a permission.
+   */
+  removePermission(key: string, permissionType: PermissionType): this {
+    if (this.state.currentExtension === null) {
+      throw new Error(noActiveExtensionErrorMessage);
+    }
+
+    const permissions = this.state.data[this.state.currentExtension].permissions;
+    const permissionsForType = permissions?.[permissionType] || new ItemList();
+
+    if (permissionsForType.has(key)) {
+      permissionsForType.remove(key);
+    }
+
+    return this;
+  }
+
   /**
    * Replace the default extension page with a custom component.
    * This component would typically extend ExtensionPage

framework/core/js/src/common/Application.tsx

@@ -286,6 +286,8 @@ export default class Application {
 
   private handledErrors: { extension: null | string; errorId: string; error: any }[] = [];
 
+  private beforeMounts: (() => void)[] = [];
+
   public load(payload: Application['data']) {
     this.data = payload;
     this.translator.setLocale(payload.locale);
@@ -326,7 +328,7 @@ export default class Application {
 
     this.session = new Session(this.store.getById<User>('users', String(this.data.session.userId)) ?? null, this.data.session.csrfToken);
 
-    this.beforeMount();
+    this.runBeforeMount();
 
     this.mount();
 
@@ -335,8 +337,13 @@ export default class Application {
     caughtInitializationErrors.forEach((handler) => handler());
   }
 
-  protected beforeMount(): void {
-    // ...
+  public beforeMount(callback: () => void) {
+    this.beforeMounts.push(callback);
+  }
+
+  protected runBeforeMount(): void {
+    this.beforeMounts.forEach((callback) => callback());
+    this.beforeMounts = [];
   }
 
   public bootExtensions(extensions: Record<string, { extend?: IExtender[] }>) {