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

Implemented extended query constraints

Browse Source
This commit is contained in:
Anton Stubenbord
2023-01-02 01:30:08 +01:00
parent 457d9f2684
commit 18ec5874a5
13 changed files with 323 additions and 235 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
lib/core/widgets/form_builder_fields/extended_date_range_form_field/form_builder_extended_date_range_picker.dart
View File

@@ -10,12 +10,13 @@ class FormBuilderExtendedDateRangePicker extends StatefulWidget {
final String name;
final String labelText;
final DateRangeQuery initialValue;
final void Function(DateRangeQuery? query)? onChanged;
const FormBuilderExtendedDateRangePicker({
super.key,
required this.name,
required this.labelText,
required this.initialValue,
this.onChanged,
});
@override
@@ -42,6 +43,7 @@ class _FormBuilderExtendedDateRangePickerState
onChanged: (query) {
_textEditingController.text =
_dateRangeQueryToString(query ?? const UnsetDateRangeQuery());
widget.onChanged?.call(query);
},
builder: (field) {
return Column(

96
lib/features/documents/view/widgets/search/document_filter_panel.dart
View File

@@ -1,11 +1,10 @@
import 'package:flutter/material.dart';
import 'package:flutter_bloc/flutter_bloc.dart';
import 'package:flutter_form_builder/flutter_form_builder.dart';
import 'package:intl/intl.dart';
import 'package:paperless_api/paperless_api.dart';
import 'package:paperless_mobile/core/widgets/form_builder_fields/extended_date_range_form_field/form_builder_extended_date_range_picker.dart';
import 'package:paperless_mobile/extensions/flutter_extensions.dart';
import 'package:paperless_mobile/features/documents/view/widgets/search/query_type_form_field.dart';
import 'package:paperless_mobile/features/documents/view/widgets/search/text_query_form_field.dart';
import 'package:paperless_mobile/features/labels/bloc/label_cubit.dart';
import 'package:paperless_mobile/features/labels/bloc/label_state.dart';
import 'package:paperless_mobile/features/labels/tags/view/widgets/tags_form_field.dart';
@@ -37,6 +36,13 @@ class _DocumentFilterPanelState extends State<DocumentFilterPanel> {
static const fkAddedAt = DocumentModel.addedKey;
final _formKey = GlobalKey<FormBuilderState>();
late bool _allowOnlyExtendedQuery;
@override
void initState() {
super.initState();
_allowOnlyExtendedQuery = widget.initialFilter.forceExtendedQuery;
}
@override
Widget build(BuildContext context) {
@@ -108,14 +114,20 @@ class _DocumentFilterPanelState extends State<DocumentFilterPanel> {
),
).padded(),
FormBuilderExtendedDateRangePicker(
name: DocumentModel.createdKey,
name: fkCreatedAt,
initialValue: widget.initialFilter.created,
labelText: S.of(context).documentCreatedPropertyLabel,
onChanged: (_) {
_checkQueryConstraints();
},
).padded(),
FormBuilderExtendedDateRangePicker(
name: DocumentModel.addedKey,
name: fkAddedAt,
initialValue: widget.initialFilter.added,
labelText: S.of(context).documentAddedPropertyLabel,
onChanged: (_) {
_checkQueryConstraints();
},
).padded(),
_buildCorrespondentFormField().padded(),
_buildDocumentTypeFormField().padded(),
@@ -154,11 +166,12 @@ class _DocumentFilterPanelState extends State<DocumentFilterPanel> {
void _resetFilter() async {
FocusScope.of(context).unfocus();
Navigator.pop(
context,
DocumentFilter.initial.copyWith(
sortField: widget.initialFilter.sortField,
sortOrder: widget.initialFilter.sortOrder,
));
context,
DocumentFilter.initial.copyWith(
sortField: widget.initialFilter.sortField,
sortOrder: widget.initialFilter.sortOrder,
),
);
}
Widget _buildDocumentTypeFormField() {
@@ -207,52 +220,24 @@ class _DocumentFilterPanelState extends State<DocumentFilterPanel> {
}
Widget _buildQueryFormField() {
final queryType =
_formKey.currentState?.getRawValue(QueryTypeFormField.fkQueryType) ??
QueryType.titleAndContent;
late String label;
switch (queryType) {
case QueryType.title:
label = S.of(context).documentFilterQueryOptionsTitleLabel;
break;
case QueryType.titleAndContent:
label = S.of(context).documentFilterQueryOptionsTitleAndContentLabel;
break;
case QueryType.extended:
label = S.of(context).documentFilterQueryOptionsExtendedLabel;
break;
}
return FormBuilderTextField(
return TextQueryFormField(
name: fkQuery,
textInputAction: TextInputAction.done,
decoration: InputDecoration(
prefixIcon: const Icon(Icons.search_outlined),
labelText: label,
suffixIcon: QueryTypeFormField(
initialValue: widget.initialFilter.queryType,
afterSelected: (queryType) => setState(() {}),
),
),
initialValue: widget.initialFilter.queryText,
onlyExtendedQueryAllowed: _allowOnlyExtendedQuery,
initialValue: widget.initialFilter.query,
);
}
void _onApplyFilter() async {
_formKey.currentState?.save();
if (_formKey.currentState?.validate() ?? false) {
final v = _formKey.currentState!.value;
DocumentFilter newFilter = _assembleFilter();
try {
FocusScope.of(context).unfocus();
Navigator.pop(context, newFilter);
} on PaperlessServerException catch (error, stackTrace) {
showErrorMessage(context, error, stackTrace);
}
FocusScope.of(context).unfocus();
Navigator.pop(context, newFilter);
}
}
DocumentFilter _assembleFilter() {
_formKey.currentState?.save();
final v = _formKey.currentState!.value;
return DocumentFilter(
correspondent: v[fkCorrespondent] as IdQueryParameter? ??
@@ -263,10 +248,9 @@ class _DocumentFilterPanelState extends State<DocumentFilterPanel> {
DocumentFilter.initial.storagePath,
tags:
v[DocumentModel.tagsKey] as TagsQuery? ?? DocumentFilter.initial.tags,
queryText: v[fkQuery] as String?,
query: v[fkQuery] as TextQuery? ?? DocumentFilter.initial.query,
created: (v[fkCreatedAt] as DateRangeQuery),
added: (v[fkAddedAt] as DateRangeQuery),
queryType: v[QueryTypeFormField.fkQueryType] as QueryType,
asnQuery: widget.initialFilter.asnQuery,
page: 1,
pageSize: widget.initialFilter.pageSize,
@@ -274,16 +258,18 @@ class _DocumentFilterPanelState extends State<DocumentFilterPanel> {
sortOrder: widget.initialFilter.sortOrder,
);
}
}
DateTimeRange? _dateTimeRangeOfNullable(DateTime? start, DateTime? end) {
if (start == null && end == null) {
return null;
void _checkQueryConstraints() {
final filter = _assembleFilter();
if (filter.forceExtendedQuery) {
setState(() => _allowOnlyExtendedQuery = true);
final queryField = _formKey.currentState?.fields[fkQuery];
queryField?.didChange(
(queryField.value as TextQuery?)
?.copyWith(queryType: QueryType.extended),
);
} else {
setState(() => _allowOnlyExtendedQuery = false);
}
}
if (start != null && end != null) {
return DateTimeRange(start: start, end: end);
}
assert(start != null || end != null);
final singleDate = (start ?? end)!;
return DateTimeRange(start: singleDate, end: singleDate);
}

53
lib/features/documents/view/widgets/search/query_type_form_field.dart
View File

@@ -1,53 +0,0 @@
import 'package:flutter/material.dart';
import 'package:flutter_form_builder/flutter_form_builder.dart';
import 'package:paperless_api/paperless_api.dart';
import 'package:paperless_mobile/generated/l10n.dart';
class QueryTypeFormField extends StatelessWidget {
static const fkQueryType = 'queryType';
final QueryType? initialValue;
final void Function(QueryType)? afterSelected;
const QueryTypeFormField({
super.key,
this.initialValue,
this.afterSelected,
});
@override
Widget build(BuildContext context) {
return FormBuilderField<QueryType>(
builder: (field) => PopupMenuButton<QueryType>(
itemBuilder: (context) => [
PopupMenuItem(
child: ListTile(
title: Text(
S.of(context).documentFilterQueryOptionsTitleAndContentLabel),
),
value: QueryType.titleAndContent,
),
PopupMenuItem(
child: ListTile(
title: Text(S.of(context).documentFilterQueryOptionsTitleLabel),
),
value: QueryType.title,
),
PopupMenuItem(
child: ListTile(
title:
Text(S.of(context).documentFilterQueryOptionsExtendedLabel),
),
value: QueryType.extended,
),
//TODO: Add support for ASN queries
],
onSelected: (selection) {
field.didChange(selection);
afterSelected?.call(selection);
},
child: const Icon(Icons.more_vert),
),
initialValue: initialValue,
name: QueryTypeFormField.fkQueryType,
);
}
}

83
lib/features/documents/view/widgets/search/text_query_form_field.dart Normal file
View File

@@ -0,0 +1,83 @@
import 'package:flutter/material.dart';
import 'package:flutter_form_builder/flutter_form_builder.dart';
import 'package:paperless_api/paperless_api.dart';
import 'package:paperless_mobile/generated/l10n.dart';
class TextQueryFormField extends StatelessWidget {
final String name;
final TextQuery? initialValue;
final bool onlyExtendedQueryAllowed;
const TextQueryFormField({
super.key,
required this.name,
this.initialValue,
required this.onlyExtendedQueryAllowed,
});
@override
Widget build(BuildContext context) {
return FormBuilderField<TextQuery>(
name: name,
initialValue: initialValue,
builder: (field) {
return TextFormField(
initialValue: initialValue?.queryText,
textInputAction: TextInputAction.done,
decoration: InputDecoration(
prefixIcon: const Icon(Icons.search_outlined),
labelText: _buildLabelText(context, field.value!.queryType),
suffixIcon: PopupMenuButton<QueryType>(
itemBuilder: (context) => [
if (!onlyExtendedQueryAllowed) ...[
PopupMenuItem(
child: ListTile(
title: Text(S
.of(context)
.documentFilterQueryOptionsTitleAndContentLabel),
),
value: QueryType.titleAndContent,
),
PopupMenuItem(
child: ListTile(
title: Text(
S.of(context).documentFilterQueryOptionsTitleLabel),
),
value: QueryType.title,
),
],
PopupMenuItem(
child: ListTile(
title: Text(
S.of(context).documentFilterQueryOptionsExtendedLabel),
),
value: QueryType.extended,
),
],
onSelected: (selection) {
field.didChange(field.value?.copyWith(queryType: selection));
},
child: const Icon(Icons.more_vert),
),
),
onChanged: (value) {
field.didChange(field.value?.copyWith(queryText: value));
},
);
},
);
}
String _buildLabelText(BuildContext context, QueryType queryType) {
switch (queryType) {
case QueryType.title:
return S.of(context).documentFilterQueryOptionsTitleLabel;
case QueryType.titleAndContent:
return S.of(context).documentFilterQueryOptionsTitleAndContentLabel;
case QueryType.extended:
return S.of(context).documentFilterQueryOptionsExtendedLabel;
default:
return '';
}
}
}

8
lib/features/labels/tags/view/widgets/tags_form_field.dart
View File

@@ -88,12 +88,10 @@ class _TagFormFieldState extends State<TagFormField> {
controller: _textEditingController,
),
suggestionsBoxDecoration: SuggestionsBoxDecoration(
elevation: 4.0,
shadowColor: Theme.of(context).colorScheme.primary,
shape: RoundedRectangleBorder(
borderRadius: BorderRadius.circular(16),
side: BorderSide(
color: Theme.of(context).colorScheme.primary,
width: 2.0,
),
borderRadius: BorderRadius.circular(8),
),
),
suggestionsCallback: (query) {

8
lib/features/labels/view/widgets/label_form_field.dart
View File

@@ -90,9 +90,11 @@ class _LabelFormFieldState<T extends Label> extends State<LabelFormField<T>> {
initialValue: widget.initialValue ?? const IdQueryParameter.unset(),
name: widget.name,
suggestionsBoxDecoration: SuggestionsBoxDecoration(
color: Theme.of(context).colorScheme.surfaceVariant,
elevation: 4.0,
shadowColor: Theme.of(context).colorScheme.primary,
// color: Theme.of(context).colorScheme.surfaceVariant,
shape: RoundedRectangleBorder(
borderRadius: BorderRadius.circular(16),
borderRadius: BorderRadius.circular(8),
// side: BorderSide(
// color: Theme.of(context).colorScheme.primary,
// width: 2.0,
@@ -106,7 +108,7 @@ class _LabelFormFieldState<T extends Label> extends State<LabelFormField<T>> {
maxLines: 1,
overflow: TextOverflow.ellipsis,
),
tileColor: Theme.of(context).colorScheme.surfaceVariant,
// tileColor: Theme.of(context).colorScheme.surfaceVariant,
dense: true,
shape: RoundedRectangleBorder(
borderRadius: BorderRadius.circular(16),

105
packages/paperless_api/lib/src/models/document_filter.dart
View File

@@ -1,10 +1,11 @@
import 'package:equatable/equatable.dart';
import 'package:paperless_api/src/models/query_parameters/text_query.dart';
import 'package:json_annotation/json_annotation.dart';
import 'package:paperless_api/paperless_api.dart';
import 'package:collection/collection.dart';
@JsonSerializable()
class DocumentFilter extends Equatable {
static const _oneDay = Duration(days: 1);
static const DocumentFilter initial = DocumentFilter();
static const DocumentFilter latestDocument = DocumentFilter(
@@ -26,8 +27,7 @@ class DocumentFilter extends Equatable {
final DateRangeQuery created;
final DateRangeQuery added;
final DateRangeQuery modified;
final QueryType queryType;
final String? queryText;
final TextQuery query;
const DocumentFilter({
this.documentType = const IdQueryParameter.unset(),
@@ -39,47 +39,52 @@ class DocumentFilter extends Equatable {
this.sortOrder = SortOrder.descending,
this.page = 1,
this.pageSize = 25,
this.queryType = QueryType.titleAndContent,
this.queryText,
this.query = const TextQuery(),
this.added = const UnsetDateRangeQuery(),
this.created = const UnsetDateRangeQuery(),
this.modified = const UnsetDateRangeQuery(),
});
Map<String, String> toQueryParameters() {
Map<String, String> params = {
'page': page.toString(),
'page_size': pageSize.toString(),
};
bool get forceExtendedQuery {
return added is RelativeDateRangeQuery ||
created is RelativeDateRangeQuery ||
modified is RelativeDateRangeQuery;
}
params.addAll(documentType.toQueryParameter('document_type'));
params.addAll(correspondent.toQueryParameter('correspondent'));
params.addAll(storagePath.toQueryParameter('storage_path'));
params.addAll(asnQuery.toQueryParameter('archive_serial_number'));
params.addAll(tags.toQueryParameter());
params.addAll(added.toQueryParameter(DateRangeQueryField.added));
params.addAll(created.toQueryParameter(DateRangeQueryField.created));
params.addAll(modified.toQueryParameter(DateRangeQueryField.modified));
//TODO: Rework when implementing extended queries.
if (queryText?.isNotEmpty ?? false) {
params.putIfAbsent(queryType.queryParam, () => queryText!);
}
Map<String, dynamic> toQueryParameters() {
List<MapEntry<String, dynamic>> params = [
MapEntry('page', '$page'),
MapEntry('page_size', '$pageSize'),
MapEntry('ordering', '${sortOrder.queryString}${sortField.queryString}'),
...documentType.toQueryParameter('document_type').entries,
...correspondent.toQueryParameter('correspondent').entries,
...storagePath.toQueryParameter('storage_path').entries,
...asnQuery.toQueryParameter('archive_serial_number').entries,
...tags.toQueryParameter().entries,
...added.toQueryParameter(DateRangeQueryField.added).entries,
...created.toQueryParameter(DateRangeQueryField.created).entries,
...modified.toQueryParameter(DateRangeQueryField.modified).entries,
...query.toQueryParameter().entries,
];
// Reverse ordering can also be encoded using &reverse=1
params.putIfAbsent(
'ordering', () => '${sortOrder.queryString}${sortField.queryString}');
return params;
// Merge query params
final queryParams = groupBy(params, (e) => e.key).map(
(key, entries) => MapEntry(
key,
entries.length == 1
? entries.first.value
: entries.map((e) => e.value).toList(),
),
);
return queryParams;
}
@override
String toString() {
return toQueryParameters().toString();
}
String toString() => toQueryParameters().toString();
DocumentFilter copyWith({
int? pageSize,
int? page,
bool? onlyNoDocumentType,
IdQueryParameter? documentType,
IdQueryParameter? correspondent,
IdQueryParameter? storagePath,
@@ -90,10 +95,9 @@ class DocumentFilter extends Equatable {
DateRangeQuery? added,
DateRangeQuery? created,
DateRangeQuery? modified,
QueryType? queryType,
String? queryText,
TextQuery? query,
}) {
return DocumentFilter(
final newFilter = DocumentFilter(
pageSize: pageSize ?? this.pageSize,
page: page ?? this.page,
documentType: documentType ?? this.documentType,
@@ -102,34 +106,20 @@ class DocumentFilter extends Equatable {
tags: tags ?? this.tags,
sortField: sortField ?? this.sortField,
sortOrder: sortOrder ?? this.sortOrder,
queryType: queryType ?? this.queryType,
queryText: queryText ?? this.queryText,
asnQuery: asnQuery ?? this.asnQuery,
query: query ?? this.query,
added: added ?? this.added,
created: created ?? this.created,
modified: modified ?? this.modified,
);
}
String? get titleOnlyMatchString {
if (queryType == QueryType.title) {
return queryText?.isEmpty ?? true ? null : queryText;
if (query?.queryType != QueryType.extended &&
newFilter.forceExtendedQuery) {
//Prevents infinite recursion
return newFilter.copyWith(
query: newFilter.query.copyWith(queryType: QueryType.extended),
);
}
return null;
}
String? get titleAndContentMatchString {
if (queryType == QueryType.titleAndContent) {
return queryText?.isEmpty ?? true ? null : queryText;
}
return null;
}
String? get extendedMatchString {
if (queryType == QueryType.extended) {
return queryText?.isEmpty ?? true ? null : queryText;
}
return null;
return newFilter;
}
int get appliedFiltersCount => [
@@ -141,7 +131,7 @@ class DocumentFilter extends Equatable {
created != initial.created,
modified != initial.modified,
asnQuery != initial.asnQuery,
(queryType != initial.queryType || queryText != initial.queryText),
(query.queryText != initial.query.queryText),
].fold(0, (previousValue, element) => previousValue += element ? 1 : 0);
@override
@@ -158,7 +148,6 @@ class DocumentFilter extends Equatable {
added,
created,
modified,
queryType,
queryText,
query,
];
}

134
packages/paperless_api/lib/src/models/filter_rule_model.dart
View File

@@ -1,6 +1,7 @@
import 'package:equatable/equatable.dart';
import 'package:paperless_api/paperless_api.dart';
import 'package:paperless_api/src/constants.dart';
import 'package:paperless_api/src/models/query_parameters/text_query.dart';
class FilterRule with EquatableMixin {
static const int titleRule = 0;
@@ -32,7 +33,7 @@ class FilterRule with EquatableMixin {
static const int _asnLessThan = 24;
static const String _lastNDateRangeQueryRegex =
r"(?<field>created|added|modified):\[(?<n>-?\d+) (?<unit>day|week|month|year) to now\]";
r"(?<field>created|added|modified):\[-?(?<n>\d+) (?<unit>day|week|month|year) to now\]";
final int ruleType;
final String? value;
@@ -54,7 +55,7 @@ class FilterRule with EquatableMixin {
//TODO: Check in profiling mode if this is inefficient enough to cause stutters...
switch (ruleType) {
case titleRule:
return filter.copyWith(queryText: value, queryType: QueryType.title);
return filter.copyWith(query: TextQuery.title(value));
case documentTypeRule:
return filter.copyWith(
documentType: value == null
@@ -158,60 +159,69 @@ class FilterRule with EquatableMixin {
);
}
case titleAndContentRule:
return filter.copyWith(
queryText: value,
queryType: QueryType.titleAndContent,
);
return filter.copyWith(query: TextQuery.titleAndContent(value));
case extendedRule:
_parseExtendedRule(filter);
return filter.copyWith(queryText: value, queryType: QueryType.extended);
return _parseExtendedRule(filter);
default:
return filter;
}
}
DocumentFilter _parseExtendedRule(final DocumentFilter filter) {
DocumentFilter newFilter = filter;
DocumentFilter _parseExtendedRule(DocumentFilter filter) {
assert(value != null);
final dateRangeRegExp = RegExp(_lastNDateRangeQueryRegex);
if (dateRangeRegExp.hasMatch(value!)) {
final matches = dateRangeRegExp.allMatches(value!);
for (final match in matches) {
final field = match.namedGroup('field')!;
final n = int.parse(match.namedGroup('n')!);
final unit = match.namedGroup('unit')!;
switch (field) {
case 'created':
newFilter = newFilter.copyWith(
created: RelativeDateRangeQuery(
n,
DateRangeUnit.values.byName(unit),
),
);
break;
case 'added':
newFilter = newFilter.copyWith(
added: RelativeDateRangeQuery(
n,
DateRangeUnit.values.byName(unit),
),
);
break;
case 'modified':
newFilter = newFilter.copyWith(
modified: RelativeDateRangeQuery(
n,
DateRangeUnit.values.byName(unit),
),
);
break;
}
final extendedQueryValues = value!.split(",").reversed;
for (final query in extendedQueryValues) {
if (RegExp(_lastNDateRangeQueryRegex).hasMatch(query)) {
filter = _parseRelativeDateRangeQuery(query, filter);
} else {
filter = filter.copyWith(query: TextQuery.extended(query));
}
return newFilter;
} else {
// Match other extended query types... currently not supported!
return filter;
}
return filter;
}
DocumentFilter _parseRelativeDateRangeQuery(
String query,
final DocumentFilter filter,
) {
DocumentFilter newFilter = filter;
final matches = RegExp(_lastNDateRangeQueryRegex).allMatches(query);
for (final match in matches) {
final field = match.namedGroup('field')!;
final n = int.parse(match.namedGroup('n')!);
final unit = match.namedGroup('unit')!;
switch (field) {
case 'created':
newFilter = newFilter.copyWith(
created: RelativeDateRangeQuery(
n,
DateRangeUnit.values.byName(unit),
),
query: newFilter.query.copyWith(queryType: QueryType.extended),
);
break;
case 'added':
newFilter = newFilter.copyWith(
added: RelativeDateRangeQuery(
n,
DateRangeUnit.values.byName(unit),
),
query: newFilter.query.copyWith(queryType: QueryType.extended),
);
break;
case 'modified':
newFilter = newFilter.copyWith(
modified: RelativeDateRangeQuery(
n,
DateRangeUnit.values.byName(unit),
),
query: newFilter.query.copyWith(queryType: QueryType.extended),
);
break;
}
}
return newFilter;
}
///
@@ -254,20 +264,20 @@ class FilterRule with EquatableMixin {
.excludedIds
.map((id) => FilterRule(excludeTagsRule, id.toString())));
}
if (filter.queryText != null) {
switch (filter.queryType) {
if (filter.query.queryText != null) {
switch (filter.query.queryType) {
case QueryType.title:
filterRules.add(FilterRule(titleRule, filter.queryText!));
filterRules.add(FilterRule(titleRule, filter.query.queryText!));
break;
case QueryType.titleAndContent:
filterRules.add(FilterRule(titleAndContentRule, filter.queryText!));
filterRules
.add(FilterRule(titleAndContentRule, filter.query.queryText!));
break;
case QueryType.extended:
filterRules.add(FilterRule(extendedRule, filter.queryText!));
filterRules.add(FilterRule(extendedRule, filter.query.queryText!));
break;
case QueryType.asn:
filterRules.add(FilterRule(asnRule, filter.queryText!));
filterRules.add(FilterRule(asnRule, filter.query.queryText!));
break;
}
}
@@ -337,9 +347,25 @@ class FilterRule with EquatableMixin {
);
}
//Join values of all extended filter rules
final FilterRule extendedFilterRule = filterRules
.where((r) => r.ruleType == extendedRule)
.reduce((previousValue, element) => previousValue.copyWith(
value: previousValue.value! + element.value!,
));
filterRules
..removeWhere((element) => element.ruleType == extendedRule)
..add(extendedFilterRule);
return filterRules;
}
FilterRule copyWith({int? ruleType, String? value}) {
return FilterRule(
ruleType ?? this.ruleType,
value ?? this.value,
);
}
@override
List<Object?> get props => [ruleType, value];
}

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

@@ -10,6 +10,7 @@ export 'query_parameters/sort_field.dart';
export 'query_parameters/sort_order.dart';
export 'query_parameters/tags_query.dart';
export 'query_parameters/date_range_query.dart';
export 'query_parameters/text_query.dart';
export 'bulk_edit_model.dart';
export 'document_filter.dart';
export 'document_meta_data_model.dart';

54
packages/paperless_api/lib/src/models/query_parameters/text_query.dart Normal file
View File

@@ -0,0 +1,54 @@
import 'query_type.dart';
class TextQuery {
final QueryType queryType;
final String? queryText;
const TextQuery({
this.queryType = QueryType.titleAndContent,
this.queryText,
});
const TextQuery.title(this.queryText) : queryType = QueryType.title;
const TextQuery.titleAndContent(this.queryText)
: queryType = QueryType.titleAndContent;
const TextQuery.extended(this.queryText) : queryType = QueryType.extended;
TextQuery copyWith({QueryType? queryType, String? queryText}) {
return TextQuery(
queryType: queryType ?? this.queryType,
queryText: queryText ?? this.queryText,
);
}
Map<String, String> toQueryParameter() {
final params = <String, String>{};
if (queryText != null) {
params.addAll({queryType.queryParam: queryText!});
}
return params;
}
String? get titleOnlyMatchString {
if (queryType == QueryType.title) {
return queryText?.isEmpty ?? true ? null : queryText;
}
return null;
}
String? get titleAndContentMatchString {
if (queryType == QueryType.titleAndContent) {
return queryText?.isEmpty ?? true ? null : queryText;
}
return null;
}
String? get extendedMatchString {
if (queryType == QueryType.extended) {
return queryText?.isEmpty ?? true ? null : queryText;
}
return null;
}
}

9
packages/paperless_api/test/saved_view_test.dart
View File

@@ -1,5 +1,6 @@
import 'package:flutter_test/flutter_test.dart';
import 'package:paperless_api/paperless_api.dart';
import 'package:paperless_api/src/models/query_parameters/text_query.dart';
void main() {
group('Validate parsing logic from [SavedView] to [DocumentFilter]:', () {
@@ -86,8 +87,7 @@ void main() {
),
sortField: SortField.created,
sortOrder: SortOrder.descending,
queryText: "Never gonna give you up",
queryType: QueryType.extended,
query: const TextQuery.extended("Never gonna give you up"),
),
),
);
@@ -173,8 +173,7 @@ void main() {
before: DateTime.parse("2020-03-01"),
after: DateTime.parse("2020-01-01"),
),
queryText: "Never gonna let you down",
queryType: QueryType.title,
query: const TextQuery.title("Never gonna let you down"),
),
name: "test_name",
showInSidebar: false,
@@ -219,7 +218,7 @@ void main() {
sortOrder: SortOrder.descending,
added: UnsetDateRangeQuery(),
created: UnsetDateRangeQuery(),
queryText: null,
query: TextQuery(),
),
name: "test_name",
showInSidebar: false,

2
pubspec.lock
View File

@@ -210,7 +210,7 @@ packages:
source: hosted
version: "4.3.0"
collection:
dependency: transitive
dependency: "direct main"
description:
name: collection
sha256: cfc915e6923fe5ce6e153b0723c753045de46de1b4d63771530504004a45fae0

1
pubspec.yaml
View File

@@ -82,6 +82,7 @@ dependencies:
hydrated_bloc: ^9.0.0
json_annotation: ^4.7.0
pretty_dio_logger: ^1.2.0-beta-1
collection: ^1.17.0
dev_dependencies:
integration_test: