feat: allow adding one-off list items

Author: chenasraf

lib/Controller/ChecklistController.php

@@ -211,6 +211,7 @@ public function indexItems(int $houseId, int $listId, string $sortBy = 'custom',
 	 * @param string|null $quantity Optional quantity string.
 	 * @param string|null $rrule Optional RFC 5545 RRULE for recurrence.
 	 * @param bool $repeatFromCompletion If true, the next occurrence is measured from when the item is marked done; if false, the schedule is anchored at item creation.
+	 * @param bool $deleteOnDone If true, the item is deleted when marked done.
 	 * @param int|null $sortOrder Optional sort order.
 	 *
 	 * @return DataResponse<Http::STATUS_OK, PantryListItem, array{}>
@@ -228,9 +229,10 @@ public function addItem(
 		?string $quantity = null,
 		?string $rrule = null,
 		bool $repeatFromCompletion = false,
+		bool $deleteOnDone = false,
 		?int $sortOrder = null,
 	): DataResponse {
-		return $this->runAction(function () use ($houseId, $listId, $name, $description, $categoryId, $quantity, $rrule, $repeatFromCompletion, $sortOrder): DataResponse {
+		return $this->runAction(function () use ($houseId, $listId, $name, $description, $categoryId, $quantity, $rrule, $repeatFromCompletion, $deleteOnDone, $sortOrder): DataResponse {
 			$this->auth->requireMember($houseId, $this->requireUid());
 			$list = $this->lists->getList($listId);
 			$this->assertListInHouse($list->getHouseId(), $houseId);
@@ -244,6 +246,7 @@ public function addItem(
 				'quantity' => $quantity,
 				'rrule' => $rrule,
 				'repeatFromCompletion' => $repeatFromCompletion,
+				'deleteOnDone' => $deleteOnDone,
 				'sortOrder' => $sortOrder ?? 0,
 			]);
 			$this->notifications->notifyItemAdded($houseId, $this->requireUid(), $item->getName(), $list->getName());
@@ -263,6 +266,7 @@ public function addItem(
 	 * @param string|null $quantity New quantity (empty string clears).
 	 * @param string|null $rrule New RRULE (empty string clears).
 	 * @param bool|null $repeatFromCompletion New recurrence anchor mode.
+	 * @param bool|null $deleteOnDone If true, the item is deleted when marked done.
 	 * @param int|null $imageFileId File id of attached image (0 or negative clears).
 	 * @param int|null $sortOrder New sort order.
 	 * @param int|null $targetListId Move item to a different list (must belong to the same house).
@@ -283,11 +287,12 @@ public function updateItem(
 		?string $quantity = null,
 		?string $rrule = null,
 		?bool $repeatFromCompletion = null,
+		?bool $deleteOnDone = null,
 		?int $imageFileId = null,
 		?int $sortOrder = null,
 		?int $targetListId = null,
 	): DataResponse {
-		return $this->runAction(function () use ($houseId, $listId, $itemId, $name, $description, $categoryId, $quantity, $rrule, $repeatFromCompletion, $imageFileId, $sortOrder, $targetListId): DataResponse {
+		return $this->runAction(function () use ($houseId, $listId, $itemId, $name, $description, $categoryId, $quantity, $rrule, $repeatFromCompletion, $deleteOnDone, $imageFileId, $sortOrder, $targetListId): DataResponse {
 			$this->auth->requireMember($houseId, $this->requireUid());
 			$item = $this->lists->getItem($itemId);
 			$list = $this->lists->getList($item->getListId());
@@ -319,6 +324,9 @@ public function updateItem(
 			if ($repeatFromCompletion !== null) {
 				$patch['repeatFromCompletion'] = $repeatFromCompletion;
 			}
+			if ($deleteOnDone !== null) {
+				$patch['deleteOnDone'] = $deleteOnDone;
+			}
 			if ($imageFileId !== null) {
 				$patch['imageFileId'] = $imageFileId > 0 ? $imageFileId : null;
 			}

lib/Db/ChecklistItem.php

@@ -30,6 +30,8 @@
  * @method void setRrule(?string $rrule)
  * @method bool getRepeatFromCompletion()
  * @method void setRepeatFromCompletion(bool $repeatFromCompletion)
+ * @method bool getDeleteOnDone()
+ * @method void setDeleteOnDone(bool $deleteOnDone)
  * @method int|null getNextDueAt()
  * @method void setNextDueAt(?int $nextDueAt)
  * @method int|null getImageFileId()
@@ -54,6 +56,7 @@ class ChecklistItem extends Entity implements \JsonSerializable {
 	protected ?string $doneBy = null;
 	protected ?string $rrule = null;
 	protected bool $repeatFromCompletion = false;
+	protected bool $deleteOnDone = false;
 	protected ?int $nextDueAt = null;
 	protected ?int $imageFileId = null;
 	protected ?string $imageUploadedBy = null;
@@ -67,6 +70,7 @@ public function __construct() {
 		$this->addType('done', 'boolean');
 		$this->addType('doneAt', 'integer');
 		$this->addType('repeatFromCompletion', 'boolean');
+		$this->addType('deleteOnDone', 'boolean');
 		$this->addType('nextDueAt', 'integer');
 		$this->addType('imageFileId', 'integer');
 		$this->addType('sortOrder', 'integer');
@@ -78,6 +82,7 @@ public function __construct() {
 		// fromRow() resets updated fields after hydration, so reads are unaffected.
 		$this->markFieldUpdated('done');
 		$this->markFieldUpdated('repeatFromCompletion');
+		$this->markFieldUpdated('deleteOnDone');
 	}
 
 	public function jsonSerialize(): array {
@@ -93,6 +98,7 @@ public function jsonSerialize(): array {
 			'doneBy' => $this->doneBy,
 			'rrule' => $this->rrule,
 			'repeatFromCompletion' => $this->repeatFromCompletion,
+			'deleteOnDone' => $this->deleteOnDone,
 			'nextDueAt' => $this->nextDueAt,
 			'imageFileId' => $this->imageFileId,
 			'imageUploadedBy' => $this->imageUploadedBy,

lib/Migration/Version3Date20260416000000.php

@@ -0,0 +1,42 @@
+<?php
+
+declare(strict_types=1);
+
+// SPDX-FileCopyrightText: Chen Asraf <contact@casraf.dev>
+// SPDX-License-Identifier: AGPL-3.0-or-later
+
+namespace OCA\Pantry\Migration;
+
+use Closure;
+use OCA\Pantry\AppInfo\Application;
+use OCP\DB\ISchemaWrapper;
+use OCP\DB\Types;
+use OCP\Migration\IOutput;
+use OCP\Migration\SimpleMigrationStep;
+
+/**
+ * Add delete_on_done flag to checklist items ("Once" items that are removed
+ * from the list when marked done).
+ */
+class Version3Date20260416000000 extends SimpleMigrationStep {
+	/**
+	 * @param Closure():ISchemaWrapper $schemaClosure
+	 */
+	public function changeSchema(IOutput $output, Closure $schemaClosure, array $options): ?ISchemaWrapper {
+		/** @var ISchemaWrapper $schema */
+		$schema = $schemaClosure();
+
+		$itemsTable = Application::tableName('list_items');
+		if ($schema->hasTable($itemsTable)) {
+			$table = $schema->getTable($itemsTable);
+			if (!$table->hasColumn('delete_on_done')) {
+				$table->addColumn('delete_on_done', Types::BOOLEAN, [
+					'notnull' => false,
+					'default' => false,
+				]);
+			}
+		}
+
+		return $schema;
+	}
+}

lib/ResponseDefinitions.php

@@ -50,6 +50,7 @@
  *     doneBy: string|null,
  *     rrule: string|null,
  *     repeatFromCompletion: bool,
+ *     deleteOnDone: bool,
  *     nextDueAt: int|null,
  *     imageFileId: int|null,
  *     imageUploadedBy: string|null,

lib/Service/ChecklistService.php

@@ -143,6 +143,7 @@ public function addItem(int $listId, array $data): ChecklistItem {
 		$item->setRrule($rrule);
 		$repeatFromCompletion = !empty($data['repeatFromCompletion']);
 		$item->setRepeatFromCompletion($repeatFromCompletion);
+		$item->setDeleteOnDone(!empty($data['deleteOnDone']));
 		// For fixed-schedule items, compute the first due time immediately.
 		if ($rrule !== null && !$repeatFromCompletion) {
 			$item->setNextDueAt($this->computeNextDueAt($item, $now)?->getTimestamp());
@@ -194,6 +195,9 @@ public function updateItem(int $itemId, array $patch): ChecklistItem {
 		if (array_key_exists('repeatFromCompletion', $patch)) {
 			$item->setRepeatFromCompletion((bool)$patch['repeatFromCompletion']);
 		}
+		if (array_key_exists('deleteOnDone', $patch)) {
+			$item->setDeleteOnDone((bool)$patch['deleteOnDone']);
+		}
 		if (array_key_exists('imageFileId', $patch)) {
 			$item->setImageFileId($this->intOrNull($patch['imageFileId']));
 		}
@@ -256,6 +260,13 @@ public function toggleItem(int $itemId, string $uid, ?int $now = null): Checklis
 			$item->setDone(true);
 			$item->setDoneAt($now);
 			$item->setDoneBy($uid);
+			// "Once" items are removed from the list when marked done. We still
+			// return the transient done state so callers (notifications, API
+			// response) can reflect the completion before the row is gone.
+			if ($item->getDeleteOnDone()) {
+				$this->itemMapper->delete($item);
+				return $item;
+			}
 			if ($item->getRrule() !== null) {
 				$item->setNextDueAt($this->computeNextDueAt($item, $now)?->getTimestamp());
 			}

openapi.json

@@ -295,6 +295,7 @@
                     "doneBy",
                     "rrule",
                     "repeatFromCompletion",
+                    "deleteOnDone",
                     "nextDueAt",
                     "imageFileId",
                     "imageUploadedBy",
@@ -346,6 +347,9 @@
                     "repeatFromCompletion": {
                         "type": "boolean"
                     },
+                    "deleteOnDone": {
+                        "type": "boolean"
+                    },
                     "nextDueAt": {
                         "type": "integer",
                         "format": "int64",
@@ -1950,6 +1954,11 @@
                                         "default": false,
                                         "description": "If true, the next occurrence is measured from when the item is marked done; if false, the schedule is anchored at item creation."
                                     },
+                                    "deleteOnDone": {
+                                        "type": "boolean",
+                                        "default": false,
+                                        "description": "If true, the item is deleted when marked done."
+                                    },
                                     "sortOrder": {
                                         "type": "integer",
                                         "format": "int64",
@@ -2115,6 +2124,12 @@
                                         "default": null,
                                         "description": "New recurrence anchor mode."
                                     },
+                                    "deleteOnDone": {
+                                        "type": "boolean",
+                                        "nullable": true,
+                                        "default": null,
+                                        "description": "If true, the item is deleted when marked done."
+                                    },
                                     "imageFileId": {
                                         "type": "integer",
                                         "format": "int64",

src/api/lists.ts

@@ -56,6 +56,7 @@ export interface ItemInput {
   quantity?: string | null
   rrule?: string | null
   repeatFromCompletion?: boolean
+  deleteOnDone?: boolean
   sortOrder?: number
   targetListId?: number
 }

src/api/types.ts

@@ -53,6 +53,7 @@ export interface ChecklistItem {
   doneBy: string | null
   rrule: string | null
   repeatFromCompletion: boolean
+  deleteOnDone: boolean
   nextDueAt: number | null
   imageFileId: number | null
   imageUploadedBy: string | null

src/components/ChecklistAddForm/ChecklistAddForm.test.ts

@@ -25,6 +25,15 @@ vi.mock('@nextcloud/vue/components/NcTextField', () => ({
     emits: ['update:modelValue'],
   },
 }))
+vi.mock('@nextcloud/vue/components/NcCheckboxRadioSwitch', () => ({
+  default: {
+    name: 'NcCheckboxRadioSwitch',
+    template:
+      '<label class="nc-checkbox"><input type="checkbox" :checked="modelValue" @change="$emit(\'update:modelValue\', $event.target.checked)" /><slot /></label>',
+    props: ['modelValue'],
+    emits: ['update:modelValue'],
+  },
+}))
 vi.mock('@/components/AutoResizeTextarea', () => ({
   AutoResizeTextarea: {
     name: 'AutoResizeTextarea',
@@ -112,9 +121,35 @@ describe('ChecklistAddForm', () => {
       categoryId: null,
       rrule: null,
       repeatFromCompletion: false,
+      deleteOnDone: false,
     })
   })
 
+  it('emits deleteOnDone=true when the "Once" checkbox is ticked', async () => {
+    const wrapper = mountForm()
+    await wrapper.findAll('.nc-text-field').at(0)!.setValue('Milk')
+
+    const onceCheckbox = wrapper.find('.nc-checkbox input[type="checkbox"]')
+    await onceCheckbox.setValue(true)
+
+    await wrapper.find('form').trigger('submit')
+
+    const payload = wrapper.emitted('add')![0][0]
+    expect(payload.deleteOnDone).toBe(true)
+  })
+
+  it('resets the "Once" checkbox after submit', async () => {
+    const wrapper = mountForm()
+    await wrapper.findAll('.nc-text-field').at(0)!.setValue('Milk')
+    const onceCheckbox = wrapper.find('.nc-checkbox input[type="checkbox"]')
+    await onceCheckbox.setValue(true)
+
+    await wrapper.find('form').trigger('submit')
+
+    const after = wrapper.find('.nc-checkbox input[type="checkbox"]').element as HTMLInputElement
+    expect(after.checked).toBe(false)
+  })
+
   it('resets all fields after submit', async () => {
     const wrapper = mountForm()
     const textFields = wrapper.findAll('.nc-text-field')

src/components/ChecklistAddForm/ChecklistAddForm.vue

@@ -17,7 +17,12 @@
       :house-id="houseId"
       :placeholder="strings.categoryPlaceholder"
     />
-    <NcButton variant="tertiary" @click="showRecurrenceEditor = true">
+    <div class="checklist-add__once" :title="strings.onceHint">
+      <NcCheckboxRadioSwitch v-model="deleteOnDone">
+        {{ strings.once }}
+      </NcCheckboxRadioSwitch>
+    </div>
+    <NcButton v-if="!deleteOnDone" variant="tertiary" @click="showRecurrenceEditor = true">
       <template #icon>
         <RepeatIcon :size="20" />
       </template>
@@ -63,6 +68,7 @@
 import { ref } from 'vue'
 import { t } from '@nextcloud/l10n'
 import NcButton from '@nextcloud/vue/components/NcButton'
+import NcCheckboxRadioSwitch from '@nextcloud/vue/components/NcCheckboxRadioSwitch'
 import NcTextField from '@nextcloud/vue/components/NcTextField'
 import PlusIcon from '@icons/Plus.vue'
 import RepeatIcon from '@icons/Repeat.vue'
@@ -87,26 +93,31 @@ const quantity = ref('')
 const categoryId = ref<number | null>(null)
 const rrule = ref<string | null>(null)
 const repeatFromCompletion = ref(false)
+const deleteOnDone = ref(false)
 const showDescription = ref(false)
 const showRecurrenceEditor = ref(false)
 
 function submitAdd() {
   const trimmedName = name.value.trim()
   if (!trimmedName) return
+  // "Once" items can't recur — ignore any locally-retained recurrence settings.
+  const once = deleteOnDone.value
   emit('add', {
     name: trimmedName,
     description: description.value.trim() || null,
     quantity: quantity.value.trim() || null,
     categoryId: categoryId.value,
-    rrule: rrule.value,
-    repeatFromCompletion: repeatFromCompletion.value,
+    rrule: once ? null : rrule.value,
+    repeatFromCompletion: once ? false : repeatFromCompletion.value,
+    deleteOnDone: once,
   })
   name.value = ''
   description.value = ''
   quantity.value = ''
   categoryId.value = null
   rrule.value = null
   repeatFromCompletion.value = false
+  deleteOnDone.value = false
   showDescription.value = false
 }
 
@@ -119,6 +130,8 @@ const strings = {
   categoryPlaceholder: t('pantry', 'Category'),
   recurrenceButton: t('pantry', 'Repeat …'),
   recurrenceSet: t('pantry', 'Repeat: set'),
+  once: t('pantry', 'Once'),
+  onceHint: t('pantry', 'Delete this item once it is marked as done.'),
   descriptionLabel: t('pantry', 'Description'),
   descriptionPlaceholder: t('pantry', 'Add a description …'),
   descriptionToggle: t('pantry', 'Toggle description'),
@@ -128,7 +141,7 @@ const strings = {
 <style scoped lang="scss">
 .checklist-add {
   display: grid;
-  grid-template-columns: 2fr 1fr 1fr auto auto auto;
+  grid-template-columns: 2fr 1fr 1fr auto auto auto auto;
   gap: 0.75rem;
   align-items: end;
   margin-bottom: 1.5rem;
@@ -145,6 +158,10 @@ const strings = {
     grid-column: 1 / -1;
   }
 
+  &__once {
+    padding-bottom: 0.25rem;
+  }
+
   &__chevron {
     transition: transform 0.2s ease;