Updated onboarding, reformatted files, improved referenced documents view, updated error handling

2025-12-15 08:12:28 -06:00 · 2022-11-03 22:15:36 +01:00
parent 2f2312d5f3
commit 40133b6e0e
117 changed files with 1788 additions and 1021 deletions
--- a/lib/features/labels/view/pages/add_label_page.dart
+++ b/lib/features/labels/view/pages/add_label_page.dart
@@ -5,6 +5,7 @@ import 'package:flutter_form_builder/flutter_form_builder.dart';
 import 'package:paperless_mobile/core/bloc/label_cubit.dart';
 import 'package:paperless_mobile/core/logic/error_code_localization_mapper.dart';
 import 'package:paperless_mobile/core/model/error_message.dart';
+import 'package:paperless_mobile/core/type/types.dart';
 import 'package:paperless_mobile/extensions/flutter_extensions.dart';
 import 'package:paperless_mobile/features/labels/document_type/model/matching_algorithm.dart';
 import 'package:paperless_mobile/features/labels/model/label.model.dart';
@@ -34,7 +35,7 @@ class AddLabelPage<T extends Label> extends StatefulWidget {

 class _AddLabelPageState<T extends Label> extends State<AddLabelPage<T>> {
  final _formKey = GlobalKey<FormBuilderState>();
-  Map<String, String> _errors = {};
+  PaperlessValidationErrors _errors = {};

  @override
  Widget build(BuildContext context) {
@@ -103,11 +104,12 @@ class _AddLabelPageState<T extends Label> extends State<AddLabelPage<T>> {
  void _onSubmit() async {
    if (_formKey.currentState?.saveAndValidate() ?? false) {
      try {
-        final label = await widget.cubit.add(widget.fromJson(_formKey.currentState!.value));
+        final label = await widget.cubit
+            .add(widget.fromJson(_formKey.currentState!.value));
        Navigator.pop(context, label);
      } on ErrorMessage catch (e) {
        showSnackBar(context, translateError(context, e.code));
-      } on Map<String, String> catch (json) {
+      } on PaperlessValidationErrors catch (json) {
        setState(() => _errors = json);
      }
    }
--- a/lib/features/labels/view/pages/edit_label_page.dart
+++ b/lib/features/labels/view/pages/edit_label_page.dart
@@ -4,7 +4,7 @@ import 'package:flutter/material.dart';
 import 'package:flutter_form_builder/flutter_form_builder.dart';
 import 'package:paperless_mobile/core/logic/error_code_localization_mapper.dart';
 import 'package:paperless_mobile/core/model/error_message.dart';
-import 'package:paperless_mobile/core/type/json.dart';
+import 'package:paperless_mobile/core/type/types.dart';
 import 'package:paperless_mobile/extensions/flutter_extensions.dart';
 import 'package:paperless_mobile/features/labels/document_type/model/matching_algorithm.dart';
 import 'package:paperless_mobile/features/labels/model/label.model.dart';
@@ -35,7 +35,7 @@ class EditLabelPage<T extends Label> extends StatefulWidget {
 class _EditLabelPageState<T extends Label> extends State<EditLabelPage<T>> {
  final _formKey = GlobalKey<FormBuilderState>();

-  Map<String, String> _errors = {};
+  PaperlessValidationErrors _errors = {};

  @override
  Widget build(BuildContext context) {
@@ -80,8 +80,8 @@ class _EditLabelPageState<T extends Label> extends State<EditLabelPage<T>> {
            ),
            FormBuilderDropdown<int?>(
              name: Label.matchingAlgorithmKey,
-              initialValue:
-                  widget.label.matchingAlgorithm?.value ?? MatchingAlgorithm.allWords.value,
+              initialValue: widget.label.matchingAlgorithm?.value ??
+                  MatchingAlgorithm.allWords.value,
              decoration: InputDecoration(
                labelText: S.of(context).labelMatchingAlgorithmPropertyLabel,
                errorText: _errors[Label.matchingAlgorithmKey],
@@ -111,12 +111,13 @@ class _EditLabelPageState<T extends Label> extends State<EditLabelPage<T>> {
  void _onSubmit() async {
    if (_formKey.currentState?.saveAndValidate() ?? false) {
      try {
-        final mergedJson = {...widget.label.toJson(), ..._formKey.currentState!.value};
+        final mergedJson = {
+          ...widget.label.toJson(),
+          ..._formKey.currentState!.value
+        };
        await widget.onSubmit(widget.fromJson(mergedJson));
        Navigator.pop(context);
-      } on ErrorMessage catch (e) {
-        showSnackBar(context, translateError(context, e.code));
-      } on Map<String, String> catch (errorMessages) {
+      } on PaperlessValidationErrors catch (errorMessages) {
        setState(() => _errors = errorMessages);
      }
    }
--- a/lib/features/labels/view/pages/labels_page.dart
+++ b/lib/features/labels/view/pages/labels_page.dart
@@ -37,7 +37,8 @@ class LabelsPage extends StatefulWidget {
  State<LabelsPage> createState() => _LabelsPageState();
 }

-class _LabelsPageState extends State<LabelsPage> with SingleTickerProviderStateMixin {
+class _LabelsPageState extends State<LabelsPage>
+    with SingleTickerProviderStateMixin {
  late final TabController _tabController;
  int _currentIndex = 0;

@@ -54,100 +55,126 @@ class _LabelsPageState extends State<LabelsPage> with SingleTickerProviderStateM

  @override
  Widget build(BuildContext context) {
-    return DefaultTabController(
-      length: 3,
-      child: Scaffold(
-        drawer: const InfoDrawer(),
-        appBar: AppBar(
-          title: Text(
-            [
-              S.of(context).labelsPageCorrespondentsTitleText,
-              S.of(context).labelsPageDocumentTypesTitleText,
-              S.of(context).labelsPageTagsTitleText,
-              S.of(context).labelsPageStoragePathTitleText
-            ][_currentIndex],
-          ),
-          actions: [
-            IconButton(
-              onPressed: _onAddPressed,
-              icon: const Icon(Icons.add),
-            )
-          ],
-          bottom: PreferredSize(
-            preferredSize: const Size.fromHeight(kToolbarHeight),
-            child: ColoredBox(
-              color: Theme.of(context).bottomAppBarColor,
-              child: TabBar(
-                indicatorColor: Theme.of(context).colorScheme.primary,
-                controller: _tabController,
-                tabs: [
-                  Tab(
-                    icon: Icon(
-                      Icons.person_outline,
-                      color: Theme.of(context).colorScheme.onPrimaryContainer,
+    return BlocProvider.value(
+      value: getIt<DocumentsCubit>(),
+      child: DefaultTabController(
+        length: 3,
+        child: Scaffold(
+          drawer: const InfoDrawer(),
+          appBar: AppBar(
+            title: Text(
+              [
+                S.of(context).labelsPageCorrespondentsTitleText,
+                S.of(context).labelsPageDocumentTypesTitleText,
+                S.of(context).labelsPageTagsTitleText,
+                S.of(context).labelsPageStoragePathTitleText
+              ][_currentIndex],
+            ),
+            actions: [
+              IconButton(
+                onPressed: _onAddPressed,
+                icon: const Icon(Icons.add),
+              )
+            ],
+            bottom: PreferredSize(
+              preferredSize: const Size.fromHeight(kToolbarHeight),
+              child: ColoredBox(
+                color: Theme.of(context).bottomAppBarColor,
+                child: TabBar(
+                  indicatorColor: Theme.of(context).colorScheme.primary,
+                  controller: _tabController,
+                  tabs: [
+                    Tab(
+                      icon: Icon(
+                        Icons.person_outline,
+                        color: Theme.of(context).colorScheme.onPrimaryContainer,
+                      ),
                    ),
-                  ),
-                  Tab(
-                    icon: Icon(
-                      Icons.description_outlined,
-                      color: Theme.of(context).colorScheme.onPrimaryContainer,
+                    Tab(
+                      icon: Icon(
+                        Icons.description_outlined,
+                        color: Theme.of(context).colorScheme.onPrimaryContainer,
+                      ),
                    ),
-                  ),
-                  Tab(
-                    icon: Icon(
-                      Icons.label_outline,
-                      color: Theme.of(context).colorScheme.onPrimaryContainer,
+                    Tab(
+                      icon: Icon(
+                        Icons.label_outline,
+                        color: Theme.of(context).colorScheme.onPrimaryContainer,
+                      ),
                    ),
-                  ),
-                  Tab(
-                    icon: Icon(
-                      Icons.folder_open,
-                      color: Theme.of(context).colorScheme.onPrimaryContainer,
-                    ),
-                  )
-                ],
+                    Tab(
+                      icon: Icon(
+                        Icons.folder_open,
+                        color: Theme.of(context).colorScheme.onPrimaryContainer,
+                      ),
+                    )
+                  ],
+                ),
              ),
            ),
          ),
-        ),
-        body: TabBarView(
-          controller: _tabController,
-          children: [
-            LabelTabView<Correspondent>(
-              cubit: BlocProvider.of<CorrespondentCubit>(context),
-              filterBuilder: (label) => DocumentFilter(
-                correspondent: CorrespondentQuery.fromId(label.id),
-                pageSize: label.documentCount ?? 0,
+          body: TabBarView(
+            controller: _tabController,
+            children: [
+              LabelTabView<Correspondent>(
+                cubit: BlocProvider.of<CorrespondentCubit>(context),
+                filterBuilder: (label) => DocumentFilter(
+                  correspondent: CorrespondentQuery.fromId(label.id),
+                  pageSize: label.documentCount ?? 0,
+                ),
+                onOpenEditPage: _openEditCorrespondentPage,
+                emptyStateActionButtonLabel:
+                    S.of(context).labelsPageCorrespondentEmptyStateAddNewLabel,
+                emptyStateDescription: S
+                    .of(context)
+                    .labelsPageCorrespondentEmptyStateDescriptionText,
+                onOpenAddNewPage: _onAddPressed,
              ),
-              onOpenEditPage: _openEditCorrespondentPage,
-            ),
-            LabelTabView<DocumentType>(
-              cubit: BlocProvider.of<DocumentTypeCubit>(context),
-              filterBuilder: (label) => DocumentFilter(
-                documentType: DocumentTypeQuery.fromId(label.id),
-                pageSize: label.documentCount ?? 0,
+              LabelTabView<DocumentType>(
+                cubit: BlocProvider.of<DocumentTypeCubit>(context),
+                filterBuilder: (label) => DocumentFilter(
+                  documentType: DocumentTypeQuery.fromId(label.id),
+                  pageSize: label.documentCount ?? 0,
+                ),
+                onOpenEditPage: _openEditDocumentTypePage,
+                emptyStateActionButtonLabel:
+                    S.of(context).labelsPageDocumentTypeEmptyStateAddNewLabel,
+                emptyStateDescription: S
+                    .of(context)
+                    .labelsPageDocumentTypeEmptyStateDescriptionText,
+                onOpenAddNewPage: _onAddPressed,
              ),
-              onOpenEditPage: _openEditDocumentTypePage,
-            ),
-            LabelTabView<Tag>(
-              cubit: BlocProvider.of<TagCubit>(context),
-              filterBuilder: (label) => DocumentFilter(
-                tags: TagsQuery.fromIds([label.id!]),
-                pageSize: label.documentCount ?? 0,
+              LabelTabView<Tag>(
+                cubit: BlocProvider.of<TagCubit>(context),
+                filterBuilder: (label) => DocumentFilter(
+                  tags: TagsQuery.fromIds([label.id!]),
+                  pageSize: label.documentCount ?? 0,
+                ),
+                onOpenEditPage: _openEditTagPage,
+                leadingBuilder: (t) => CircleAvatar(backgroundColor: t.color),
+                emptyStateActionButtonLabel:
+                    S.of(context).labelsPageTagsEmptyStateAddNewLabel,
+                emptyStateDescription:
+                    S.of(context).labelsPageTagsEmptyStateDescriptionText,
+                onOpenAddNewPage: _onAddPressed,
              ),
-              onOpenEditPage: _openEditTagPage,
-              leadingBuilder: (t) => CircleAvatar(backgroundColor: t.color),
-            ),
-            LabelTabView<StoragePath>(
-              cubit: BlocProvider.of<StoragePathCubit>(context),
-              onOpenEditPage: _openEditStoragePathPage,
-              filterBuilder: (label) => DocumentFilter(
-                storagePath: StoragePathQuery.fromId(label.id),
-                pageSize: label.documentCount ?? 0,
+              LabelTabView<StoragePath>(
+                cubit: BlocProvider.of<StoragePathCubit>(context),
+                onOpenEditPage: _openEditStoragePathPage,
+                filterBuilder: (label) => DocumentFilter(
+                  storagePath: StoragePathQuery.fromId(label.id),
+                  pageSize: label.documentCount ?? 0,
+                ),
+                contentBuilder: (path) => Text(path.path ?? ""),
+                emptyStateActionButtonLabel:
+                    S.of(context).labelsPageStoragePathEmptyStateAddNewLabel,
+                emptyStateDescription: S
+                    .of(context)
+                    .labelsPageStoragePathEmptyStateDescriptionText,
+                onOpenAddNewPage: _onAddPressed,
              ),
-              contentBuilder: (path) => Text(path.path ?? ""),
-            ),
-          ],
+            ],
+          ),
        ),
      ),
    );
@@ -160,7 +187,8 @@ class _LabelsPageState extends State<LabelsPage> with SingleTickerProviderStateM
        builder: (_) => MultiBlocProvider(
          providers: [
            BlocProvider.value(value: getIt<DocumentsCubit>()),
-            BlocProvider.value(value: BlocProvider.of<CorrespondentCubit>(context)),
+            BlocProvider.value(
+                value: BlocProvider.of<CorrespondentCubit>(context)),
          ],
          child: EditCorrespondentPage(correspondent: correspondent),
        ),
@@ -175,7 +203,8 @@ class _LabelsPageState extends State<LabelsPage> with SingleTickerProviderStateM
        builder: (_) => MultiBlocProvider(
          providers: [
            BlocProvider.value(value: getIt<DocumentsCubit>()),
-            BlocProvider.value(value: BlocProvider.of<DocumentTypeCubit>(context)),
+            BlocProvider.value(
+                value: BlocProvider.of<DocumentTypeCubit>(context)),
          ],
          child: EditDocumentTypePage(documentType: docType),
        ),
@@ -205,7 +234,8 @@ class _LabelsPageState extends State<LabelsPage> with SingleTickerProviderStateM
        builder: (_) => MultiBlocProvider(
          providers: [
            BlocProvider.value(value: getIt<DocumentsCubit>()),
-            BlocProvider.value(value: BlocProvider.of<StoragePathCubit>(context)),
+            BlocProvider.value(
+                value: BlocProvider.of<StoragePathCubit>(context)),
          ],
          child: EditStoragePathPage(storagePath: path),
        ),