xevion/paperless-mobile
1
0
Fork 0
mirror of https://github.com/Xevion/paperless-mobile.git synced 2025-12-06 11:15:48 -06:00
Code Issues Packages Projects Releases Wiki Activity

feat: Add functionality to delete notes

Browse Source
This commit is contained in:
Anton Stubenbord
2023-12-19 20:08:24 +01:00
parent 26b71e5f37
commit d7f297a4df
11 changed files with 288 additions and 151 deletions
Download Patch File Download Diff File Expand all files Collapse all files

11
lib/core/extensions/flutter_extensions.dart
View File

@@ -11,9 +11,18 @@ extension WidgetPadding on Widget {
Widget paddedSymmetrically({ Widget paddedSymmetrically({
double horizontal = 0.0, double horizontal = 0.0,
double vertical = 0.0, double vertical = 0.0,
bool sliver = false,
}) { }) {
final insets =
EdgeInsets.symmetric(horizontal: horizontal, vertical: vertical);
if (sliver) {
return SliverPadding(
padding: insets,
sliver: this,
);
}
return Padding( return Padding(
padding: EdgeInsets.symmetric(horizontal: horizontal, vertical: vertical), padding: insets,
child: this, child: this,
); );
} }

41
lib/features/document_details/cubit/document_details_cubit.dart
View File

@@ -87,6 +87,47 @@ class DocumentDetailsCubit extends Cubit<DocumentDetailsState> {
} }
} }
Future<void> updateNote(NoteModel note) async {
assert(state.status == LoadingStatus.loaded);
final document = state.document!;
final updatedNotes = document.notes.map((e) => e.id == note.id ? note : e);
try {
final updatedDocument = await _api.update(
state.document!.copyWith(
notes: updatedNotes,
),
);
_notifier.notifyUpdated(updatedDocument);
} on PaperlessApiException catch (e) {
addError(
TransientPaperlessApiError(
code: e.code,
details: e.details,
),
);
}
}
Future<void> deleteNote(NoteModel note) async {
assert(state.status == LoadingStatus.loaded,
"Document data has to be loaded before calling this method.");
assert(note.id != null, "Note id cannot be null.");
try {
final updatedDocument = await _api.deleteNote(
state.document!,
note.id!,
);
_notifier.notifyUpdated(updatedDocument);
} on PaperlessApiException catch (e) {
addError(
TransientPaperlessApiError(
code: e.code,
details: e.details,
),
);
}
}
Future<void> assignAsn( Future<void> assignAsn(
DocumentModel document, { DocumentModel document, {
int? asn, int? asn,

219
lib/features/document_details/view/pages/document_details_page.dart
View File

@@ -240,130 +240,131 @@ class _DocumentDetailsPageState extends State<DocumentDetailsPage> {
context.read(), context.read(),
documentId: widget.id, documentId: widget.id,
), ),
child: Padding( child: TabBarView(
padding: const EdgeInsets.symmetric( children: [
vertical: 16, CustomScrollView(
horizontal: 16, slivers: [
), SliverOverlapInjector(
child: TabBarView( handle: NestedScrollView
children: [ .sliverOverlapAbsorberHandleFor(context),
CustomScrollView( ),
slivers: [ switch (state.status) {
SliverOverlapInjector( LoadingStatus.loaded => DocumentOverviewWidget(
handle: NestedScrollView document: state.document!,
.sliverOverlapAbsorberHandleFor(context), itemSpacing: _itemSpacing,
), queryString:
switch (state.status) { widget.titleAndContentQueryString,
LoadingStatus.loaded => ).paddedSymmetrically(
DocumentOverviewWidget( vertical: 16,
document: state.document!, sliver: true,
itemSpacing: _itemSpacing, ),
queryString: LoadingStatus.error => _buildErrorState(),
widget.titleAndContentQueryString, _ => _buildLoadingState(),
), },
LoadingStatus.error => _buildErrorState(), ],
_ => _buildLoadingState(), ),
}, CustomScrollView(
], slivers: [
), SliverOverlapInjector(
CustomScrollView( handle: NestedScrollView
slivers: [ .sliverOverlapAbsorberHandleFor(context),
SliverOverlapInjector( ),
handle: NestedScrollView switch (state.status) {
.sliverOverlapAbsorberHandleFor(context), LoadingStatus.loaded => DocumentContentWidget(
), document: state.document!,
switch (state.status) { queryString:
LoadingStatus.loaded => DocumentContentWidget( widget.titleAndContentQueryString,
document: state.document!, ).paddedSymmetrically(
queryString: vertical: 16,
widget.titleAndContentQueryString, sliver: true,
), ),
LoadingStatus.error => _buildErrorState(), LoadingStatus.error => _buildErrorState(),
_ => _buildLoadingState(), _ => _buildLoadingState(),
} }
], ],
), ),
CustomScrollView( CustomScrollView(
slivers: [ slivers: [
SliverOverlapInjector( SliverOverlapInjector(
handle: NestedScrollView handle: NestedScrollView
.sliverOverlapAbsorberHandleFor(context), .sliverOverlapAbsorberHandleFor(context),
), ),
switch (state.status) { switch (state.status) {
LoadingStatus.loaded => LoadingStatus.loaded => DocumentMetaDataWidget(
DocumentMetaDataWidget( document: state.document!,
document: state.document!, itemSpacing: _itemSpacing,
itemSpacing: _itemSpacing, metaData: state.metaData!,
metaData: state.metaData!, ).paddedSymmetrically(
), vertical: 16,
LoadingStatus.error => _buildErrorState(), sliver: true,
_ => _buildLoadingState(), ),
}, LoadingStatus.error => _buildErrorState(),
], _ => _buildLoadingState(),
), },
],
),
CustomScrollView(
controller: _pagingScrollController,
slivers: [
SliverOverlapInjector(
handle: NestedScrollView
.sliverOverlapAbsorberHandleFor(context),
),
SimilarDocumentsView(
pagingScrollController: _pagingScrollController,
).paddedSymmetrically(
vertical: 16,
sliver: true,
),
],
),
CustomScrollView(
slivers: [
SliverOverlapInjector(
handle: NestedScrollView
.sliverOverlapAbsorberHandleFor(context),
),
switch (state.status) {
LoadingStatus.loaded => DocumentNotesWidget(
document: state.document!,
).paddedSymmetrically(
vertical: 16,
sliver: true,
),
LoadingStatus.error => _buildErrorState(),
_ => _buildLoadingState(),
},
],
),
if (hasMultiUserSupport)
CustomScrollView( CustomScrollView(
controller: _pagingScrollController, controller: _pagingScrollController,
slivers: [
SliverOverlapInjector(
handle: NestedScrollView
.sliverOverlapAbsorberHandleFor(context),
),
SimilarDocumentsView(
pagingScrollController:
_pagingScrollController,
),
],
),
CustomScrollView(
slivers: [ slivers: [
SliverOverlapInjector( SliverOverlapInjector(
handle: NestedScrollView handle: NestedScrollView
.sliverOverlapAbsorberHandleFor(context), .sliverOverlapAbsorberHandleFor(context),
), ),
switch (state.status) { switch (state.status) {
LoadingStatus.loaded => DocumentNotesWidget( LoadingStatus.loaded =>
DocumentPermissionsWidget(
document: state.document!, document: state.document!,
).paddedSymmetrically(
vertical: 16,
sliver: true,
), ),
LoadingStatus.error => _buildErrorState(), LoadingStatus.error => _buildErrorState(),
_ => _buildLoadingState(), _ => _buildLoadingState(),
}, }
if (state.status == LoadingStatus.loaded)
SliverToBoxAdapter(
child: Align(
alignment: Alignment.centerRight,
child: ElevatedButton.icon(
onPressed: () {
AddNoteRoute($extra: state.document!)
.push(context);
},
icon: Icon(Icons.note_add_outlined),
label: Text('Add note'),
),
),
),
], ],
), ),
if (hasMultiUserSupport) ]
CustomScrollView( .map(
controller: _pagingScrollController, (child) => Padding(
slivers: [ padding: EdgeInsets.symmetric(horizontal: 16),
SliverOverlapInjector( child: child,
handle: NestedScrollView
.sliverOverlapAbsorberHandleFor(
context),
),
switch (state.status) {
LoadingStatus.loaded =>
DocumentPermissionsWidget(
document: state.document!,
),
LoadingStatus.error => _buildErrorState(),
_ => _buildLoadingState(),
}
],
), ),
], )
), .toList(),
), ),
); );
}, },

92
lib/features/document_details/view/widgets/document_notes_widget.dart
View File

@@ -1,7 +1,12 @@
import 'package:flutter/material.dart'; import 'package:flutter/material.dart';
import 'package:flutter/widgets.dart'; import 'package:flutter/widgets.dart';
import 'package:flutter_bloc/flutter_bloc.dart';
import 'package:intl/intl.dart'; import 'package:intl/intl.dart';
import 'package:paperless_api/paperless_api.dart'; import 'package:paperless_api/paperless_api.dart';
import 'package:paperless_mobile/core/extensions/flutter_extensions.dart';
import 'package:paperless_mobile/features/document_details/cubit/document_details_cubit.dart';
import 'package:paperless_mobile/generated/l10n/app_localizations.dart';
import 'package:paperless_mobile/helpers/message_helpers.dart';
class DocumentNotesWidget extends StatelessWidget { class DocumentNotesWidget extends StatelessWidget {
final DocumentModel document; final DocumentModel document;
@@ -9,30 +14,69 @@ class DocumentNotesWidget extends StatelessWidget {
@override @override
Widget build(BuildContext context) { Widget build(BuildContext context) {
return SliverList.builder( return SliverMainAxisGroup(
itemBuilder: (context, index) { slivers: [
final note = document.notes.elementAt(index); SliverList.separated(
return ListTile( separatorBuilder: (context, index) => const SizedBox(height: 16),
title: Text(note.note), itemBuilder: (context, index) {
subtitle: Text( final note = document.notes.elementAt(index);
DateFormat.yMMMd(Localizations.localeOf(context).toString()) return Card(
.format(note.created)), // borderRadius: BorderRadius.circular(8),
trailing: Row( // elevation: 1,
mainAxisSize: MainAxisSize.min, child: Column(
children: [ crossAxisAlignment: CrossAxisAlignment.start,
IconButton( children: [
onPressed: () {}, if (note.created != null)
icon: Icon(Icons.edit), Text(
), DateFormat.yMMMd(
IconButton( Localizations.localeOf(context).toString())
onPressed: () {}, .addPattern('\u2014')
icon: Icon(Icons.delete), .add_jm()
), .format(note.created!),
], style: Theme.of(context).textTheme.labelMedium?.copyWith(
), color: Theme.of(context)
); .colorScheme
}, .onSurface
itemCount: document.notes.length, .withOpacity(.5),
),
),
const SizedBox(height: 8),
Text(
note.note!,
textAlign: TextAlign.justify,
style: Theme.of(context).textTheme.bodyLarge?.copyWith(
color: Theme.of(context).colorScheme.onSurface,
),
),
Row(
mainAxisAlignment: MainAxisAlignment.end,
children: [
Spacer(),
IconButton(
icon: Icon(Icons.edit),
onPressed: () {
// Push edit page
},
),
IconButton(
icon: Icon(Icons.delete),
onPressed: () {
context.read<DocumentDetailsCubit>().deleteNote(note);
showSnackBar(
context,
S.of(context)!.documentSuccessfullyUpdated,
);
},
),
],
),
],
).padded(16),
);
},
itemCount: document.notes.length,
),
],
); );
} }
} }

15
lib/features/document_details/view/widgets/edit_note_page.dart Normal file
View File

@@ -0,0 +1,15 @@
import 'package:flutter/material.dart';
class EditNotePage extends StatefulWidget {
const EditNotePage({super.key});
@override
State<EditNotePage> createState() => _EditNotePageState();
}
class _EditNotePageState extends State<EditNotePage> {
@override
Widget build(BuildContext context) {
return const Placeholder();
}
}

10
packages/paperless_api/lib/src/models/document_model.dart
View File

@@ -1,4 +1,5 @@
import 'package:equatable/equatable.dart'; import 'package:equatable/equatable.dart';
import 'package:freezed_annotation/freezed_annotation.dart';
import 'package:json_annotation/json_annotation.dart'; import 'package:json_annotation/json_annotation.dart';
import 'package:paperless_api/paperless_api.dart'; import 'package:paperless_api/paperless_api.dart';
import 'package:paperless_api/src/converters/local_date_time_json_converter.dart'; import 'package:paperless_api/src/converters/local_date_time_json_converter.dart';
@@ -95,6 +96,9 @@ class DocumentModel extends Equatable {
String? archivedFileName, String? archivedFileName,
int? Function()? owner, int? Function()? owner,
bool? userCanChange, bool? userCanChange,
Iterable<NoteModel>? notes,
Permissions? permissions,
Iterable<CustomFieldModel>? customFields,
}) { }) {
return DocumentModel( return DocumentModel(
id: id, id: id,
@@ -115,6 +119,9 @@ class DocumentModel extends Equatable {
archivedFileName: archivedFileName ?? this.archivedFileName, archivedFileName: archivedFileName ?? this.archivedFileName,
owner: owner != null ? owner() : this.owner, owner: owner != null ? owner() : this.owner,
userCanChange: userCanChange ?? this.userCanChange, userCanChange: userCanChange ?? this.userCanChange,
customFields: customFields ?? this.customFields,
notes: notes ?? this.notes,
permissions: permissions ?? this.permissions,
); );
} }
@@ -135,5 +142,8 @@ class DocumentModel extends Equatable {
archivedFileName, archivedFileName,
owner, owner,
userCanChange, userCanChange,
customFields,
notes,
permissions,
]; ];
} }

1
packages/paperless_api/lib/src/models/models.dart
View File

@@ -28,3 +28,4 @@ export 'task/task.dart';
export 'task/task_status.dart'; export 'task/task_status.dart';
export 'user_model.dart'; export 'user_model.dart';
export 'exception/exceptions.dart'; export 'exception/exceptions.dart';
export 'note_model.dart';

8
packages/paperless_api/lib/src/models/note_model.dart
View File

@@ -5,10 +5,10 @@ part 'note_model.g.dart';
@freezed @freezed
class NoteModel with _$NoteModel { class NoteModel with _$NoteModel {
const factory NoteModel({ const factory NoteModel({
required int id, required int? id,
required String note, required String? note,
required DateTime created, required DateTime? created,
required int document, required int? document,
required int? user, required int? user,
}) = _NoteModel; }) = _NoteModel;

1
packages/paperless_api/lib/src/modules/documents_api/paperless_documents_api.dart
View File

@@ -22,6 +22,7 @@ abstract class PaperlessDocumentsApi {
Future<DocumentModel> find(int id); Future<DocumentModel> find(int id);
Future<int> delete(DocumentModel doc); Future<int> delete(DocumentModel doc);
Future<DocumentMetaData> getMetaData(int id); Future<DocumentMetaData> getMetaData(int id);
Future<DocumentModel> deleteNote(DocumentModel document, int noteId);
Future<Iterable<int>> bulkAction(BulkAction action); Future<Iterable<int>> bulkAction(BulkAction action);
Future<Uint8List> getPreview(int docId); Future<Uint8List> getPreview(int docId);
String getThumbnailUrl(int docId); String getThumbnailUrl(int docId);

18
packages/paperless_api/lib/src/modules/documents_api/paperless_documents_api_impl.dart
View File

@@ -323,4 +323,22 @@ class PaperlessDocumentsApiImpl implements PaperlessDocumentsApi {
); );
} }
} }
@override
Future<DocumentModel> deleteNote(DocumentModel document, int noteId) async {
try {
final response = await client.delete(
"/api/documents/${document.id}/notes/?id=$noteId",
options: Options(validateStatus: (status) => status == 200),
);
final notes =
(response.data as List).map((e) => NoteModel.fromJson(e)).toList();
return document.copyWith(notes: notes);
} on DioException catch (exception) {
throw exception.unravel(
orElse: const PaperlessApiException(ErrorCode.documentDeleteFailed),
);
}
}
} }

23
scripts/install_dependencies.sh
View File

@@ -1,23 +1,20 @@
#!/usr/bin/env bash #!/usr/bin/env bash
set -Eeuo pipefail set -Euo pipefail
__script_dir=$( cd "$( dirname "${BASH_SOURCE[0]}" )" && pwd ) __script_dir=$( cd "$( dirname "${BASH_SOURCE[0]}" )" && pwd )
readonly __script_dir readonly __script_dir
pushd "$__script_dir/../" pushd "$__script_dir/../"
pushd packages/paperless_api for dir in packages/*/ # list directories in the form "/tmp/dirname/"
flutter packages pub get do
dart run build_runner build --delete-conflicting-outputs pushd $dir
popd echo "Installing dependencies for $dir"
flutter packages pub get
pushd packages/mock_server dart run build_runner build --delete-conflicting-outputs
flutter packages pub get popd
popd done
flutter packages pub get flutter packages pub get
flutter gen-l10n flutter gen-l10n
dart run build_runner build --delete-conflicting-outputs dart run build_runner build --delete-conflicting-outputs
popd