Feat: Highlight cards with important labels

docs/API.md

@@ -212,28 +212,32 @@ Returns an array of board items
             "color": "31CC7C",
             "boardId": 10,
             "cardId": null,
-            "id": 37
+            "id": 37,
+			"customSettings": {}
         },
         {
             "title": "To review",
             "color": "317CCC",
             "boardId": 10,
             "cardId": null,
-            "id": 38
+            "id": 38,
+			"customSettings": {}
         },
         {
             "title": "Action needed",
             "color": "FF7A66",
             "boardId": 10,
             "cardId": null,
-            "id": 39
+            "id": 39,
+			"customSettings": { "isImportant": true }
         },
         {
             "title": "Later",
             "color": "F1DB50",
             "boardId": 10,
             "cardId": null,
-            "id": 40
+            "id": 40,
+			"customSettings": {}
         }
     ],
     "acl": [],
@@ -282,28 +286,32 @@ A 403 response might be returned if the users ability to create new boards has b
             "color": "31CC7C",
             "boardId": "10",
             "cardId": null,
-            "id": 37
+            "id": 37,
+			"customSettings": {}
         },
         {
             "title": "To review",
             "color": "317CCC",
             "boardId": "10",
             "cardId": null,
-            "id": 38
+            "id": 38,
+			"customSettings": {}
         },
         {
             "title": "Action needed",
             "color": "FF7A66",
             "boardId": "10",
             "cardId": null,
-            "id": 39
+            "id": 39,
+			"customSettings": {}
         },
         {
             "title": "Later",
             "color": "F1DB50",
             "boardId": "10",
             "cardId": null,
-            "id": 40
+            "id": 40,
+			"customSettings": {}
         }
     ],
     "acl": [],
@@ -867,24 +875,27 @@ The request can fail with a bad request response for the following reasons:
   "color": "31CC7C",
   "boardId": "2",
   "cardId": null,
-  "id": 5
+  "id": 5,
+  "customSettings": { "isImportant": false }
 }
 ```
 
 ### POST /boards/{boardId}/labels - Create a new label
 
 #### Request parameters
 
-| Parameter | Type    | Description                              |
-| --------- | ------- | ---------------------------------------- |
-| boardId   | Integer | The id of the board the label belongs to |
+| Parameter      | Type    | Description                                                                  |
+|----------------|---------|------------------------------------------------------------------------------|
+| boardId        | Integer | The id of the board the label belongs to                                     |
+| customSettings | Object  | An key-value structure, currently supported only bool property `isImportant` |
 
 #### Request data
 
 ```json
 {
   "title": "Finished",
-  "color": "31CC7C"
+  "color": "31CC7C",
+  "customSettings": { "isImportant": false }
 }
 ```
 
@@ -896,18 +907,20 @@ The request can fail with a bad request response for the following reasons:
 
 #### Request parameters
 
-| Parameter | Type    | Description                              |
-| --------- | ------- | ---------------------------------------- |
-| boardId   | Integer | The id of the board the label belongs to |
-| labelId   | Integer | The id of the label                      |
+| Parameter | Type    | Description                                                                       |
+| --------- | ------- |-----------------------------------------------------------------------------------|
+| boardId   | Integer | The id of the board the label belongs to                                          |
+| labelId   | Integer | The id of the label                                                               |
+| customSettings | Object  | An key-value structure, currently supported only bool property `isImportant` |
 
 
 #### Request data
 
 ```json
 {
   "title": "Finished",
-  "color": "31CC7C"
+  "color": "31CC7C",
+  "customSettings": {  }
 }
 ```
 

lib/Controller/LabelApiController.php

@@ -50,10 +50,12 @@ public function get() {
 	 *
 	 * @params $title
 	 * @params $color
+	 * @param array<string, scalar> $customSettings
+	 *
 	 * Create a new label
 	 */
-	public function create($title, $color) {
-		$label = $this->labelService->create($title, $color, $this->request->getParam('boardId'));
+	public function create($title, $color, array $customSettings = []) {
+		$label = $this->labelService->create($title, $color, $this->request->getParam('boardId'), $customSettings);
 		return new DataResponse($label, HTTP::STATUS_OK);
 	}
 
@@ -64,10 +66,12 @@ public function create($title, $color) {
 	 *
 	 * @params $title
 	 * @params $color
+	 * @param array<string, scalar> $customSettings
+	 *
 	 * Update a specific label
 	 */
-	public function update($title, $color) {
-		$label = $this->labelService->update($this->request->getParam('labelId'), $title, $color);
+	public function update($title, $color, array $customSettings = []) {
+		$label = $this->labelService->update($this->request->getParam('labelId'), $title, $color, $customSettings);
 		return new DataResponse($label, HTTP::STATUS_OK);
 	}
 

lib/Controller/LabelController.php

@@ -25,21 +25,23 @@ public function __construct(
 	 * @param $title
 	 * @param $color
 	 * @param $boardId
+	 * @param array<string, scalar> $customSettings
 	 * @return \OCP\AppFramework\Db\Entity
 	 */
-	public function create($title, $color, $boardId) {
-		return $this->labelService->create($title, $color, $boardId);
+	public function create($title, $color, $boardId, array $customSettings = []) {
+		return $this->labelService->create($title, $color, $boardId, $customSettings);
 	}
 
 	/**
 	 * @NoAdminRequired
 	 * @param $id
 	 * @param $title
 	 * @param $color
+	 * @param array<string, scalar> $customSettings
 	 * @return \OCP\AppFramework\Db\Entity
 	 */
-	public function update($id, $title, $color) {
-		return $this->labelService->update($id, $title, $color);
+	public function update($id, $title, $color, array $customSettings = []) {
+		return $this->labelService->update($id, $title, $color, $customSettings);
 	}
 
 	/**

lib/Db/Label.php

@@ -9,22 +9,41 @@
 
 /**
  * @method getTitle(): string
+ * @method getCustomSettings(): string
+ * @method setCustomSettings(string $customSettings)
  */
 class Label extends RelationalEntity {
 	protected $title;
 	protected $color;
 	protected $boardId;
 	protected $cardId;
 	protected $lastModified;
+	protected $customSettings;
 
 	public function __construct() {
 		$this->addType('id', 'integer');
 		$this->addType('boardId', 'integer');
 		$this->addType('cardId', 'integer');
 		$this->addType('lastModified', 'integer');
+		$this->addType('customSettings', 'string');
 	}
 
 	public function getETag() {
 		return md5((string)$this->getLastModified());
 	}
+
+	public function getCustomSettingsArray(): array {
+		return $this->customSettings ? json_decode($this->customSettings, true) : [];
+	}
+
+	public function setCustomSettingsArray(array $customSettings): void {
+		$this->setCustomSettings(json_encode($customSettings ?: new \stdClass()));
+	}
+
+	public function jsonSerialize(): array {
+		$data = parent::jsonSerialize();
+		$data['customSettings'] = $this->getCustomSettingsArray() ?: new \stdClass();
+
+		return $data;
+	}
 }

lib/Migration/Version20000Date20250907000000.php

@@ -0,0 +1,32 @@
+<?php
+
+/**
+ * SPDX-FileCopyrightText: 2022 Nextcloud GmbH and Nextcloud contributors
+ * SPDX-License-Identifier: AGPL-3.0-or-later
+ */
+
+declare(strict_types=1);
+
+namespace OCA\Deck\Migration;
+
+use Closure;
+use OCP\DB\ISchemaWrapper;
+use OCP\DB\Types;
+use OCP\Migration\IOutput;
+use OCP\Migration\SimpleMigrationStep;
+
+class Version20000Date20250907000000 extends SimpleMigrationStep {
+	public function changeSchema(IOutput $output, Closure $schemaClosure, array $options): ?ISchemaWrapper {
+		/** @var ISchemaWrapper $schema */
+		$schema = $schemaClosure();
+
+		$table = $schema->getTable('deck_labels');
+		if (!$table->hasColumn('custom_settings')) {
+			$table->addColumn('custom_settings', Types::JSON, [
+				'notnull' => false,
+			]);
+		}
+
+		return $schema;
+	}
+}

lib/Service/CardService.php

@@ -340,7 +340,7 @@ public function update($id, $title, $stackId, $type, $owner, $description = '',
 				// clone labels that are assigned to card but don't exist in new board
 				if (empty($filteredLabels)) {
 					if ($this->permissionService->getPermissions($boardId)[Acl::PERMISSION_MANAGE] === true) {
-						$newLabel = $this->labelService->create($label->getTitle(), $label->getColor(), $board->getId());
+						$newLabel = $this->labelService->create($label->getTitle(), $label->getColor(), $board->getId(), $label->getCustomSettingsArray());
 						$boardLabels[] = $label;
 						$this->assignLabel($card->getId(), $newLabel->getId());
 					}

lib/Service/LabelService.php

@@ -62,14 +62,15 @@ public function find($labelId) {
 	 * @param $title
 	 * @param $color
 	 * @param $boardId
+	 * @param array<string, scalar> $customSettings
 	 * @return \OCP\AppFramework\Db\Entity
 	 * @throws StatusException
 	 * @throws \OCA\Deck\NoPermissionException
 	 * @throws \OCP\AppFramework\Db\DoesNotExistException
 	 * @throws \OCP\AppFramework\Db\MultipleObjectsReturnedException
 	 * @throws BadRequestException
 	 */
-	public function create($title, $color, $boardId) {
+	public function create($title, $color, $boardId, array $customSettings = []) {
 		$this->labelServiceValidator->check(compact('title', 'color', 'boardId'));
 
 		$this->permissionService->checkPermission(null, $boardId, Acl::PERMISSION_MANAGE);
@@ -89,6 +90,7 @@ public function create($title, $color, $boardId) {
 		$label->setTitle($title);
 		$label->setColor($color);
 		$label->setBoardId($boardId);
+		$label->setCustomSettingsArray($customSettings);
 		$this->changeHelper->boardChanged($boardId);
 		return $this->labelMapper->insert($label);
 	}
@@ -99,7 +101,7 @@ public function cloneLabelIfNotExists(int $labelId, int $targetBoardId): Label {
 		$originLabel = $this->find($labelId);
 		$filteredValues = array_values(array_filter($boardLabels, fn ($item) => $item->getTitle() === $originLabel->getTitle()));
 		if (empty($filteredValues)) {
-			$label = $this->create($originLabel->getTitle(), $originLabel->getColor(), $targetBoardId);
+			$label = $this->create($originLabel->getTitle(), $originLabel->getColor(), $targetBoardId, $originLabel->getCustomSettingsArray());
 			return $label;
 		}
 		return $originLabel;
@@ -130,14 +132,15 @@ public function delete($id) {
 	 * @param $id
 	 * @param $title
 	 * @param $color
+	 * @param array<string, scalar> $customSettings
 	 * @return \OCP\AppFramework\Db\Entity
 	 * @throws StatusException
 	 * @throws \OCA\Deck\NoPermissionException
 	 * @throws \OCP\AppFramework\Db\DoesNotExistException
 	 * @throws \OCP\AppFramework\Db\MultipleObjectsReturnedException
 	 * @throws BadRequestException
 	 */
-	public function update($id, $title, $color) {
+	public function update($id, $title, $color, array $customSettings = []) {
 		$this->labelServiceValidator->check(compact('title', 'color', 'id'));
 
 		$this->permissionService->checkPermission($this->labelMapper, $id, Acl::PERMISSION_MANAGE);
@@ -161,6 +164,7 @@ public function update($id, $title, $color) {
 
 		$label->setTitle($title);
 		$label->setColor($color);
+		$label->setCustomSettingsArray($customSettings);
 		$this->changeHelper->boardChanged($label->getBoardId());
 		return $this->labelMapper->update($label);
 	}

src/components/board/Board.vue

@@ -281,6 +281,7 @@ export default {
 	}
 
 	.board {
+		padding-left: $board-gap;
 		position: relative;
 		overflow-x: auto;
 		flex-grow: 1;

src/components/board/BoardSidebar.vue

@@ -7,6 +7,7 @@
 	<NcAppSidebar v-if="board != null"
 		:actions="[]"
 		:name="board.title"
+		style="width: 400px"
 		@close="closeSidebar">
 		<NcAppSidebarTab id="sharing"
 			:order="0"