Merge pull request #16 from LibreCodeCoop/refactor/field-policy-enums

refactor: field policy enums

Author: vitormattos

env.d.ts

@@ -4,8 +4,8 @@
 /// <reference types="vite/client" />
 
 declare module '@nextcloud/router' {
-	export function generateOcsUrl(path: string): string
-	export function generateUrl(path: string): string
+	export function generateOcsUrl(path: string, params?: object, options?: object): string
+	export function generateUrl(path: string, params?: object, options?: object): string
 }
 
 interface SettingsUserListRow {

img/screenshots/admin-catalog-thumb.png

@@ -55,10 +55,8 @@ public function index(): DataResponse {
 	 * @param string $fieldKey Immutable unique key of the field
 	 * @param string $label Human-readable label shown in the UI
 	 * @param string $type Value type accepted by the field
-	 * @param bool $adminOnly Whether only admins can edit values for this field
-	 * @param bool $userEditable Whether the owner can edit the field value
-	 * @param bool $userVisible Whether the owner can see the field in personal settings
-	 * @param string $initialVisibility Initial visibility applied to new values
+	 * @param string $editPolicy Whether values are managed by admins only or by users too
+	 * @param string $exposurePolicy Whether the field is hidden or which default visibility new values receive
 	 * @param int $sortOrder Display order used in admin and profile forms
 	 * @param bool $active Whether the definition is currently active
 	 * @param list<string> $options Allowed values for select fields (ignored for other types)
@@ -72,10 +70,8 @@ public function create(
 		string $fieldKey,
 		string $label,
 		string $type,
-		bool $adminOnly = false,
-		bool $userEditable = false,
-		bool $userVisible = true,
-		string $initialVisibility = 'private',
+		string $editPolicy = 'users',
+		string $exposurePolicy = 'private',
 		int $sortOrder = 0,
 		bool $active = true,
 		array $options = [],
@@ -85,10 +81,8 @@ public function create(
 				'field_key' => $fieldKey,
 				'label' => $label,
 				'type' => $type,
-				'admin_only' => $adminOnly,
-				'user_editable' => $userEditable,
-				'user_visible' => $userVisible,
-				'initial_visibility' => $initialVisibility,
+				'edit_policy' => $editPolicy,
+				'exposure_policy' => $exposurePolicy,
 				'sort_order' => $sortOrder,
 				'active' => $active,
 			];
@@ -111,10 +105,8 @@ public function create(
 	 * @param int $id Identifier of the field definition
 	 * @param string $label Human-readable label shown in the UI
 	 * @param string $type Value type accepted by the field
-	 * @param bool $adminOnly Whether only admins can edit values for this field
-	 * @param bool $userEditable Whether the owner can edit the field value
-	 * @param bool $userVisible Whether the owner can see the field in personal settings
-	 * @param string $initialVisibility Initial visibility applied to new values
+	 * @param string $editPolicy Whether values are managed by admins only or by users too
+	 * @param string $exposurePolicy Whether the field is hidden or which default visibility new values receive
 	 * @param int $sortOrder Display order used in admin and profile forms
 	 * @param bool $active Whether the definition is currently active
 	 * @param list<string> $options Allowed values for select fields (ignored for other types)
@@ -129,10 +121,8 @@ public function update(
 		int $id,
 		string $label,
 		string $type,
-		bool $adminOnly = false,
-		bool $userEditable = false,
-		bool $userVisible = true,
-		string $initialVisibility = 'private',
+		string $editPolicy = 'users',
+		string $exposurePolicy = 'private',
 		int $sortOrder = 0,
 		bool $active = true,
 		array $options = [],
@@ -146,10 +136,8 @@ public function update(
 			$payload = [
 				'label' => $label,
 				'type' => $type,
-				'admin_only' => $adminOnly,
-				'user_editable' => $userEditable,
-				'user_visible' => $userVisible,
-				'initial_visibility' => $initialVisibility,
+				'edit_policy' => $editPolicy,
+				'exposure_policy' => $exposurePolicy,
 				'sort_order' => $sortOrder,
 				'active' => $active,
 			];

img/screenshots/admin-catalog.png

@@ -11,6 +11,7 @@
 
 use InvalidArgumentException;
 use OCA\ProfileFields\AppInfo\Application;
+use OCA\ProfileFields\Enum\FieldExposurePolicy;
 use OCA\ProfileFields\Service\FieldAccessService;
 use OCA\ProfileFields\Service\FieldDefinitionService;
 use OCA\ProfileFields\Service\FieldValueService;
@@ -58,7 +59,7 @@ public function index(): DataResponse {
 		$editableFields = [];
 
 		foreach ($definitions as $definition) {
-			if (!$definition->getUserVisible()) {
+			if (!FieldExposurePolicy::from($definition->getExposurePolicy())->isUserVisible()) {
 				continue;
 			}
 

img/screenshots/personal-settings-thumb.png

@@ -20,14 +20,10 @@
  * @method void setLabel(string $value)
  * @method string getType()
  * @method void setType(string $value)
- * @method bool getAdminOnly()
- * @method void setAdminOnly(bool $value)
- * @method bool getUserEditable()
- * @method void setUserEditable(bool $value)
- * @method bool getUserVisible()
- * @method void setUserVisible(bool $value)
- * @method string getInitialVisibility()
- * @method void setInitialVisibility(string $value)
+ * @method string getEditPolicy()
+ * @method void setEditPolicy(string $value)
+ * @method string getExposurePolicy()
+ * @method void setExposurePolicy(string $value)
  * @method int getSortOrder()
  * @method void setSortOrder(int $value)
  * @method bool getActive()
@@ -43,10 +39,8 @@ class FieldDefinition extends Entity {
 	protected $fieldKey;
 	protected $label;
 	protected $type;
-	protected $adminOnly;
-	protected $userEditable;
-	protected $userVisible;
-	protected $initialVisibility;
+	protected $editPolicy;
+	protected $exposurePolicy;
 	protected $sortOrder;
 	protected $active;
 	protected $options;
@@ -55,9 +49,6 @@ class FieldDefinition extends Entity {
 
 	public function __construct() {
 		$this->addType('id', 'integer');
-		$this->addType('adminOnly', 'boolean');
-		$this->addType('userEditable', 'boolean');
-		$this->addType('userVisible', 'boolean');
 		$this->addType('sortOrder', 'integer');
 		$this->addType('active', 'boolean');
 		$this->addType('createdAt', 'datetime');
@@ -70,10 +61,8 @@ public function __construct() {
 	 *     field_key: string,
 	 *     label: string,
 	 *     type: string,
-	 *     admin_only: bool,
-	 *     user_editable: bool,
-	 *     user_visible: bool,
-	 *     initial_visibility: string,
+	 *     edit_policy: string,
+	 *     exposure_policy: string,
 	 *     sort_order: int,
 	 *     active: bool,
 	 *     options: list<string>|null,
@@ -89,10 +78,8 @@ public function jsonSerialize(): array {
 			'field_key' => $this->getFieldKey(),
 			'label' => $this->getLabel(),
 			'type' => $this->getType(),
-			'admin_only' => $this->getAdminOnly(),
-			'user_editable' => $this->getUserEditable(),
-			'user_visible' => $this->getUserVisible(),
-			'initial_visibility' => $this->getInitialVisibility(),
+			'edit_policy' => $this->getEditPolicy(),
+			'exposure_policy' => $this->getExposurePolicy(),
 			'sort_order' => $this->getSortOrder(),
 			'active' => $this->getActive(),
 			'options' => $rawOptions !== null ? (json_decode($rawOptions, true) ?? null) : null,