From 8e58c6dd93bfe3f78cb444211059006f7f315a44 Mon Sep 17 00:00:00 2001
From: Isaac Janzen <50783505+janzenisaac@users.noreply.github.com>
Date: Thu, 28 Dec 2023 08:24:24 -0700
Subject: [PATCH] DEV: Add extension points to `Admin User Fields` (#25021)
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

- Add plugin outlet to `AdminUserFieldItem`
- Add ability to include custom fields when saving `AdminUserFieldItem`
- Update plugin API with `includeUserFieldPropertiesOnSave` per ☝️
- Add `DiscoursePluginRegistry` to `UserFieldsController` to add custom columns
---
 .../components/admin-user-field-item.hbs      |  5 +++++
 .../addon/components/admin-user-field-item.js |  6 +++++-
 .../discourse/app/lib/plugin-api.js           | 20 ++++++++++++++++++-
 .../app/services/admin-custom-user-fields.js  | 10 ++++++++++
 .../admin/user_fields_controller.rb           |  3 ++-
 docs/CHANGELOG-JAVASCRIPT-PLUGIN-API.md       |  7 +++++++
 6 files changed, 48 insertions(+), 3 deletions(-)
 create mode 100644 app/assets/javascripts/discourse/app/services/admin-custom-user-fields.js

diff --git a/app/assets/javascripts/admin/addon/components/admin-user-field-item.hbs b/app/assets/javascripts/admin/addon/components/admin-user-field-item.hbs
index db31305cf4d..2ac7d15eb0f 100644
--- a/app/assets/javascripts/admin/addon/components/admin-user-field-item.hbs
+++ b/app/assets/javascripts/admin/addon/components/admin-user-field-item.hbs
@@ -55,6 +55,11 @@
       <span>{{i18n "admin.user_fields.searchable.title"}}</span>
     </AdminFormRow>
 
+    <PluginOutlet
+      @name="after-admin-user-fields"
+      @outletArgs={{hash buffered=this.buffered}}
+    />
+
     <AdminFormRow>
       <DButton
         @action={{this.save}}
diff --git a/app/assets/javascripts/admin/addon/components/admin-user-field-item.js b/app/assets/javascripts/admin/addon/components/admin-user-field-item.js
index c92191226a5..7a7d8df2e9f 100644
--- a/app/assets/javascripts/admin/addon/components/admin-user-field-item.js
+++ b/app/assets/javascripts/admin/addon/components/admin-user-field-item.js
@@ -1,6 +1,7 @@
 import Component from "@ember/component";
 import { action } from "@ember/object";
 import { schedule } from "@ember/runloop";
+import { inject as service } from "@ember/service";
 import { isEmpty } from "@ember/utils";
 import { popupAjaxError } from "discourse/lib/ajax-error";
 import { i18n, propertyEqual } from "discourse/lib/computed";
@@ -10,6 +11,8 @@ import I18n from "discourse-i18n";
 import UserField from "admin/models/user-field";
 
 export default Component.extend(bufferedProperty("userField"), {
+  adminCustomUserFields: service(),
+
   tagName: "",
   isEditing: false,
 
@@ -75,7 +78,8 @@ export default Component.extend(bufferedProperty("userField"), {
       "show_on_profile",
       "show_on_user_card",
       "searchable",
-      "options"
+      "options",
+      ...this.adminCustomUserFields.additionalProperties
     );
 
     return this.userField
diff --git a/app/assets/javascripts/discourse/app/lib/plugin-api.js b/app/assets/javascripts/discourse/app/lib/plugin-api.js
index 4fafc62a6c2..decae2688a6 100644
--- a/app/assets/javascripts/discourse/app/lib/plugin-api.js
+++ b/app/assets/javascripts/discourse/app/lib/plugin-api.js
@@ -144,7 +144,7 @@ import { modifySelectKit } from "select-kit/mixins/plugin-api";
 // docs/CHANGELOG-JAVASCRIPT-PLUGIN-API.md whenever you change the version
 // using the format described at https://keepachangelog.com/en/1.0.0/.
 
-export const PLUGIN_API_VERSION = "1.20.0";
+export const PLUGIN_API_VERSION = "1.21.0";
 
 // This helper prevents us from applying the same `modifyClass` over and over in test mode.
 function canModify(klass, type, resolverName, changes) {
@@ -2611,6 +2611,24 @@ class PluginApi {
   addBulkActionButton(opts) {
     _addBulkButton(opts);
   }
+
+  /**
+   * Include the passed user field property in the Admin User Field save request.
+   * This is useful for plugins that are adding additional columns to the user field model and want
+   * to save the new property values alongside the default user field properties (all under the same save call)
+   *
+   *
+   * ```
+   * api.includeUserFieldPropertyOnSave("property_one");
+   * api.includeUserFieldPropertyOnSave("property_two");
+   * ```
+   *
+   */
+  includeUserFieldPropertyOnSave(userFieldProperty) {
+    this.container
+      .lookup("service:admin-custom-user-fields")
+      .addProperty(userFieldProperty);
+  }
 }
 
 // from http://stackoverflow.com/questions/6832596/how-to-compare-software-version-number-using-js-only-number
diff --git a/app/assets/javascripts/discourse/app/services/admin-custom-user-fields.js b/app/assets/javascripts/discourse/app/services/admin-custom-user-fields.js
new file mode 100644
index 00000000000..d1051f16b82
--- /dev/null
+++ b/app/assets/javascripts/discourse/app/services/admin-custom-user-fields.js
@@ -0,0 +1,10 @@
+import { tracked } from "@glimmer/tracking";
+import Service from "@ember/service";
+
+export default class AdminCustomUserFields extends Service {
+  @tracked additionalProperties = [];
+
+  addProperty(property) {
+    this.additionalProperties.push(property);
+  }
+}
diff --git a/app/controllers/admin/user_fields_controller.rb b/app/controllers/admin/user_fields_controller.rb
index b244867b7ae..28d927c1023 100644
--- a/app/controllers/admin/user_fields_controller.rb
+++ b/app/controllers/admin/user_fields_controller.rb
@@ -2,7 +2,7 @@
 
 class Admin::UserFieldsController < Admin::AdminController
   def self.columns
-    %i[
+    columns = %i[
       name
       field_type
       editable
@@ -13,6 +13,7 @@ class Admin::UserFieldsController < Admin::AdminController
       position
       searchable
     ]
+    DiscoursePluginRegistry.apply_modifier(:admin_user_fields_columns, columns)
   end
 
   def create
diff --git a/docs/CHANGELOG-JAVASCRIPT-PLUGIN-API.md b/docs/CHANGELOG-JAVASCRIPT-PLUGIN-API.md
index 7d5ef2b216d..9e8f5d0c059 100644
--- a/docs/CHANGELOG-JAVASCRIPT-PLUGIN-API.md
+++ b/docs/CHANGELOG-JAVASCRIPT-PLUGIN-API.md
@@ -7,6 +7,13 @@ in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## [1.21.0] - 2023-12-22
+
+### Added
+
+- Added `includeUserFieldPropertiesOnSave` function, which includes the passed user field properties in the user field save request. This is useful for plugins that are adding additional columns to the user field model and want to save the new property values alongside the default user field properties (all under the same save call).
+
+
 ## [1.20.0] - 2023-12-20
 
 ### Added