refactor: field policy enums

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 {

lib/Controller/FieldDefinitionApiController.php

@@ -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,
 			];

lib/Controller/FieldValueApiController.php

@@ -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;
 			}
 

lib/Db/FieldDefinition.php

@@ -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,

lib/Db/FieldDefinitionMapper.php

@@ -27,10 +27,8 @@ public function findByFieldKey(string $fieldKey): ?FieldDefinition {
 			'field_key',
 			'label',
 			'type',
-			'admin_only',
-			'user_editable',
-			'user_visible',
-			'initial_visibility',
+			'edit_policy',
+			'exposure_policy',
 			'sort_order',
 			'active',
 			'options',
@@ -54,10 +52,8 @@ public function findById(int $id): ?FieldDefinition {
 			'field_key',
 			'label',
 			'type',
-			'admin_only',
-			'user_editable',
-			'user_visible',
-			'initial_visibility',
+			'edit_policy',
+			'exposure_policy',
 			'sort_order',
 			'active',
 			'options',
@@ -84,10 +80,8 @@ public function findAllOrdered(): array {
 			'field_key',
 			'label',
 			'type',
-			'admin_only',
-			'user_editable',
-			'user_visible',
-			'initial_visibility',
+			'edit_policy',
+			'exposure_policy',
 			'sort_order',
 			'active',
 			'options',
@@ -111,10 +105,8 @@ public function findActiveOrdered(): array {
 			'field_key',
 			'label',
 			'type',
-			'admin_only',
-			'user_editable',
-			'user_visible',
-			'initial_visibility',
+			'edit_policy',
+			'exposure_policy',
 			'sort_order',
 			'active',
 			'options',

lib/Enum/FieldEditPolicy.php

@@ -0,0 +1,33 @@
+<?php
+
+/**
+ * SPDX-FileCopyrightText: 2026 LibreCode coop and LibreCode contributors
+ * SPDX-License-Identifier: AGPL-3.0-or-later
+ */
+
+declare(strict_types=1);
+
+namespace OCA\ProfileFields\Enum;
+
+enum FieldEditPolicy: string {
+	case ADMINS = 'admins';
+	case USERS = 'users';
+
+	/**
+	 * @return list<string>
+	 */
+	public static function values(): array {
+		return [
+			self::ADMINS->value,
+			self::USERS->value,
+		];
+	}
+
+	public static function isValid(string $value): bool {
+		return self::tryFrom($value) !== null;
+	}
+
+	public function userCanEdit(): bool {
+		return $this === self::USERS;
+	}
+}

lib/Enum/FieldExposurePolicy.php

@@ -0,0 +1,45 @@
+<?php
+
+/**
+ * SPDX-FileCopyrightText: 2026 LibreCode coop and LibreCode contributors
+ * SPDX-License-Identifier: AGPL-3.0-or-later
+ */
+
+declare(strict_types=1);
+
+namespace OCA\ProfileFields\Enum;
+
+enum FieldExposurePolicy: string {
+	case HIDDEN = 'hidden';
+	case PRIVATE = 'private';
+	case USERS = 'users';
+	case PUBLIC = 'public';
+
+	/**
+	 * @return list<string>
+	 */
+	public static function values(): array {
+		return [
+			self::HIDDEN->value,
+			self::PRIVATE->value,
+			self::USERS->value,
+			self::PUBLIC->value,
+		];
+	}
+
+	public static function isValid(string $value): bool {
+		return self::tryFrom($value) !== null;
+	}
+
+	public function isUserVisible(): bool {
+		return $this !== self::HIDDEN;
+	}
+
+	public function initialVisibility(): FieldVisibility {
+		return match ($this) {
+			self::HIDDEN, self::PRIVATE => FieldVisibility::PRIVATE,
+			self::USERS => FieldVisibility::USERS,
+			self::PUBLIC => FieldVisibility::PUBLIC,
+		};
+	}
+}

lib/Migration/Version1000Date20260309120000.php

@@ -41,16 +41,11 @@ public function changeSchema(IOutput $output, Closure $schemaClosure, array $opt
 			$table->addColumn('type', Types::STRING, [
 				'length' => 32,
 			]);
-			$table->addColumn('admin_only', Types::BOOLEAN, [
-				'default' => false,
-			]);
-			$table->addColumn('user_editable', Types::BOOLEAN, [
-				'default' => false,
-			]);
-			$table->addColumn('user_visible', Types::BOOLEAN, [
-				'default' => true,
+			$table->addColumn('edit_policy', Types::STRING, [
+				'length' => 32,
+				'default' => 'users',
 			]);
-			$table->addColumn('initial_visibility', Types::STRING, [
+			$table->addColumn('exposure_policy', Types::STRING, [
 				'length' => 32,
 				'default' => 'private',
 			]);

lib/ResponseDefinitions.php

@@ -12,14 +12,14 @@
 /**
  * @psalm-type ProfileFieldsType = 'text'|'number'|'select'
  * @psalm-type ProfileFieldsVisibility = 'private'|'users'|'public'
+ * @psalm-type ProfileFieldsEditPolicy = 'admins'|'users'
+ * @psalm-type ProfileFieldsExposurePolicy = 'hidden'|'private'|'users'|'public'
  * @psalm-type ProfileFieldsDefinitionInput = array{
  *     field_key?: string,
  *     label?: string,
  *     type?: string,
- *     admin_only?: bool,
- *     user_editable?: bool,
- *     user_visible?: bool,
- *     initial_visibility?: string,
+ *     edit_policy?: ProfileFieldsEditPolicy,
+ *     exposure_policy?: ProfileFieldsExposurePolicy,
  *     sort_order?: int,
  *     active?: bool,
  *     options?: list<string>,
@@ -29,10 +29,8 @@
  *     field_key: non-empty-string,
  *     label: non-empty-string,
  *     type: ProfileFieldsType,
- *     admin_only: bool,
- *     user_editable: bool,
- *     user_visible: bool,
- *     initial_visibility: ProfileFieldsVisibility,
+ *     edit_policy: ProfileFieldsEditPolicy,
+ *     exposure_policy: ProfileFieldsExposurePolicy,
  *     sort_order: int,
  *     active: bool,
  *     options: list<string>|null,

lib/Search/ProfileFieldDirectorySearchService.php

@@ -12,6 +12,7 @@
 use InvalidArgumentException;
 use OCA\ProfileFields\Db\FieldValue;
 use OCA\ProfileFields\Db\FieldValueMapper;
+use OCA\ProfileFields\Enum\FieldExposurePolicy;
 use OCA\ProfileFields\Enum\FieldVisibility;
 use OCA\ProfileFields\Service\FieldDefinitionService;
 use OCP\IGroupManager;
@@ -72,7 +73,7 @@ public function search(?IUser $actor, string $term, int $limit, int $offset): ar
 				continue;
 			}
 
-			if (!$this->isSearchableForActor($definition->getUserVisible(), $value->getCurrentVisibility(), $actorIsAdmin, $actorUid !== null)) {
+			if (!$this->isSearchableForActor(FieldExposurePolicy::from($definition->getExposurePolicy()), $value->getCurrentVisibility(), $actorIsAdmin, $actorUid !== null)) {
 				continue;
 			}
 
@@ -123,12 +124,12 @@ private function extractScalarValue(FieldValue $value): ?string {
 		return trim((string)$scalar);
 	}
 
-	private function isSearchableForActor(bool $fieldIsUserVisible, string $currentVisibility, bool $actorIsAdmin, bool $actorIsAuthenticated): bool {
+	private function isSearchableForActor(FieldExposurePolicy $exposurePolicy, string $currentVisibility, bool $actorIsAdmin, bool $actorIsAuthenticated): bool {
 		if ($actorIsAdmin) {
 			return true;
 		}
 
-		if (!$fieldIsUserVisible) {
+		if (!$exposurePolicy->isUserVisible()) {
 			return false;
 		}