1
0
mirror of https://github.com/immich-app/immich.git synced 2025-07-15 07:14:42 +02:00

feat(server)!: search via typesense (#1778)

* build: add typesense to docker

* feat(server): typesense search

* feat(web): search

* fix(web): show api error response message

* chore: search tests

* chore: regenerate open api

* fix: disable typesense on e2e

* fix: number properties for open api (dart)

* fix: e2e test

* fix: change lat/lng from floats to typesense geopoint

* dev: Add smartInfo relation to findAssetById to be able to query against it

---------

Co-authored-by: Alex Tran <alex.tran1502@gmail.com>
This commit is contained in:
Jason Rasmussen
2023-03-02 21:47:08 -05:00
committed by GitHub
parent 1cc184ed10
commit 0aaeab124d
87 changed files with 3638 additions and 77 deletions

View File

@ -0,0 +1,135 @@
//
// AUTO-GENERATED FILE, DO NOT MODIFY!
//
// @dart=2.12
// ignore_for_file: unused_element, unused_import
// ignore_for_file: always_put_required_named_parameters_first
// ignore_for_file: constant_identifier_names
// ignore_for_file: lines_longer_than_80_chars
part of openapi.api;
class SearchAlbumResponseDto {
/// Returns a new [SearchAlbumResponseDto] instance.
SearchAlbumResponseDto({
required this.total,
required this.count,
this.items = const [],
this.facets = const [],
});
int total;
int count;
List<AlbumResponseDto> items;
List<SearchFacetResponseDto> facets;
@override
bool operator ==(Object other) => identical(this, other) || other is SearchAlbumResponseDto &&
other.total == total &&
other.count == count &&
other.items == items &&
other.facets == facets;
@override
int get hashCode =>
// ignore: unnecessary_parenthesis
(total.hashCode) +
(count.hashCode) +
(items.hashCode) +
(facets.hashCode);
@override
String toString() => 'SearchAlbumResponseDto[total=$total, count=$count, items=$items, facets=$facets]';
Map<String, dynamic> toJson() {
final json = <String, dynamic>{};
json[r'total'] = this.total;
json[r'count'] = this.count;
json[r'items'] = this.items;
json[r'facets'] = this.facets;
return json;
}
/// Returns a new [SearchAlbumResponseDto] instance and imports its values from
/// [value] if it's a [Map], null otherwise.
// ignore: prefer_constructors_over_static_methods
static SearchAlbumResponseDto? fromJson(dynamic value) {
if (value is Map) {
final json = value.cast<String, dynamic>();
// Ensure that the map contains the required keys.
// Note 1: the values aren't checked for validity beyond being non-null.
// Note 2: this code is stripped in release mode!
assert(() {
requiredKeys.forEach((key) {
assert(json.containsKey(key), 'Required key "SearchAlbumResponseDto[$key]" is missing from JSON.');
assert(json[key] != null, 'Required key "SearchAlbumResponseDto[$key]" has a null value in JSON.');
});
return true;
}());
return SearchAlbumResponseDto(
total: mapValueOfType<int>(json, r'total')!,
count: mapValueOfType<int>(json, r'count')!,
items: AlbumResponseDto.listFromJson(json[r'items'])!,
facets: SearchFacetResponseDto.listFromJson(json[r'facets'])!,
);
}
return null;
}
static List<SearchAlbumResponseDto>? listFromJson(dynamic json, {bool growable = false,}) {
final result = <SearchAlbumResponseDto>[];
if (json is List && json.isNotEmpty) {
for (final row in json) {
final value = SearchAlbumResponseDto.fromJson(row);
if (value != null) {
result.add(value);
}
}
}
return result.toList(growable: growable);
}
static Map<String, SearchAlbumResponseDto> mapFromJson(dynamic json) {
final map = <String, SearchAlbumResponseDto>{};
if (json is Map && json.isNotEmpty) {
json = json.cast<String, dynamic>(); // ignore: parameter_assignments
for (final entry in json.entries) {
final value = SearchAlbumResponseDto.fromJson(entry.value);
if (value != null) {
map[entry.key] = value;
}
}
}
return map;
}
// maps a json object with a list of SearchAlbumResponseDto-objects as value to a dart map
static Map<String, List<SearchAlbumResponseDto>> mapListFromJson(dynamic json, {bool growable = false,}) {
final map = <String, List<SearchAlbumResponseDto>>{};
if (json is Map && json.isNotEmpty) {
json = json.cast<String, dynamic>(); // ignore: parameter_assignments
for (final entry in json.entries) {
final value = SearchAlbumResponseDto.listFromJson(entry.value, growable: growable,);
if (value != null) {
map[entry.key] = value;
}
}
}
return map;
}
/// The list of required keys that must be present in a JSON.
static const requiredKeys = <String>{
'total',
'count',
'items',
'facets',
};
}

View File

@ -0,0 +1,135 @@
//
// AUTO-GENERATED FILE, DO NOT MODIFY!
//
// @dart=2.12
// ignore_for_file: unused_element, unused_import
// ignore_for_file: always_put_required_named_parameters_first
// ignore_for_file: constant_identifier_names
// ignore_for_file: lines_longer_than_80_chars
part of openapi.api;
class SearchAssetResponseDto {
/// Returns a new [SearchAssetResponseDto] instance.
SearchAssetResponseDto({
required this.total,
required this.count,
this.items = const [],
this.facets = const [],
});
int total;
int count;
List<AssetResponseDto> items;
List<SearchFacetResponseDto> facets;
@override
bool operator ==(Object other) => identical(this, other) || other is SearchAssetResponseDto &&
other.total == total &&
other.count == count &&
other.items == items &&
other.facets == facets;
@override
int get hashCode =>
// ignore: unnecessary_parenthesis
(total.hashCode) +
(count.hashCode) +
(items.hashCode) +
(facets.hashCode);
@override
String toString() => 'SearchAssetResponseDto[total=$total, count=$count, items=$items, facets=$facets]';
Map<String, dynamic> toJson() {
final json = <String, dynamic>{};
json[r'total'] = this.total;
json[r'count'] = this.count;
json[r'items'] = this.items;
json[r'facets'] = this.facets;
return json;
}
/// Returns a new [SearchAssetResponseDto] instance and imports its values from
/// [value] if it's a [Map], null otherwise.
// ignore: prefer_constructors_over_static_methods
static SearchAssetResponseDto? fromJson(dynamic value) {
if (value is Map) {
final json = value.cast<String, dynamic>();
// Ensure that the map contains the required keys.
// Note 1: the values aren't checked for validity beyond being non-null.
// Note 2: this code is stripped in release mode!
assert(() {
requiredKeys.forEach((key) {
assert(json.containsKey(key), 'Required key "SearchAssetResponseDto[$key]" is missing from JSON.');
assert(json[key] != null, 'Required key "SearchAssetResponseDto[$key]" has a null value in JSON.');
});
return true;
}());
return SearchAssetResponseDto(
total: mapValueOfType<int>(json, r'total')!,
count: mapValueOfType<int>(json, r'count')!,
items: AssetResponseDto.listFromJson(json[r'items'])!,
facets: SearchFacetResponseDto.listFromJson(json[r'facets'])!,
);
}
return null;
}
static List<SearchAssetResponseDto>? listFromJson(dynamic json, {bool growable = false,}) {
final result = <SearchAssetResponseDto>[];
if (json is List && json.isNotEmpty) {
for (final row in json) {
final value = SearchAssetResponseDto.fromJson(row);
if (value != null) {
result.add(value);
}
}
}
return result.toList(growable: growable);
}
static Map<String, SearchAssetResponseDto> mapFromJson(dynamic json) {
final map = <String, SearchAssetResponseDto>{};
if (json is Map && json.isNotEmpty) {
json = json.cast<String, dynamic>(); // ignore: parameter_assignments
for (final entry in json.entries) {
final value = SearchAssetResponseDto.fromJson(entry.value);
if (value != null) {
map[entry.key] = value;
}
}
}
return map;
}
// maps a json object with a list of SearchAssetResponseDto-objects as value to a dart map
static Map<String, List<SearchAssetResponseDto>> mapListFromJson(dynamic json, {bool growable = false,}) {
final map = <String, List<SearchAssetResponseDto>>{};
if (json is Map && json.isNotEmpty) {
json = json.cast<String, dynamic>(); // ignore: parameter_assignments
for (final entry in json.entries) {
final value = SearchAssetResponseDto.listFromJson(entry.value, growable: growable,);
if (value != null) {
map[entry.key] = value;
}
}
}
return map;
}
/// The list of required keys that must be present in a JSON.
static const requiredKeys = <String>{
'total',
'count',
'items',
'facets',
};
}

View File

@ -0,0 +1,111 @@
//
// AUTO-GENERATED FILE, DO NOT MODIFY!
//
// @dart=2.12
// ignore_for_file: unused_element, unused_import
// ignore_for_file: always_put_required_named_parameters_first
// ignore_for_file: constant_identifier_names
// ignore_for_file: lines_longer_than_80_chars
part of openapi.api;
class SearchConfigResponseDto {
/// Returns a new [SearchConfigResponseDto] instance.
SearchConfigResponseDto({
required this.enabled,
});
bool enabled;
@override
bool operator ==(Object other) => identical(this, other) || other is SearchConfigResponseDto &&
other.enabled == enabled;
@override
int get hashCode =>
// ignore: unnecessary_parenthesis
(enabled.hashCode);
@override
String toString() => 'SearchConfigResponseDto[enabled=$enabled]';
Map<String, dynamic> toJson() {
final json = <String, dynamic>{};
json[r'enabled'] = this.enabled;
return json;
}
/// Returns a new [SearchConfigResponseDto] instance and imports its values from
/// [value] if it's a [Map], null otherwise.
// ignore: prefer_constructors_over_static_methods
static SearchConfigResponseDto? fromJson(dynamic value) {
if (value is Map) {
final json = value.cast<String, dynamic>();
// Ensure that the map contains the required keys.
// Note 1: the values aren't checked for validity beyond being non-null.
// Note 2: this code is stripped in release mode!
assert(() {
requiredKeys.forEach((key) {
assert(json.containsKey(key), 'Required key "SearchConfigResponseDto[$key]" is missing from JSON.');
assert(json[key] != null, 'Required key "SearchConfigResponseDto[$key]" has a null value in JSON.');
});
return true;
}());
return SearchConfigResponseDto(
enabled: mapValueOfType<bool>(json, r'enabled')!,
);
}
return null;
}
static List<SearchConfigResponseDto>? listFromJson(dynamic json, {bool growable = false,}) {
final result = <SearchConfigResponseDto>[];
if (json is List && json.isNotEmpty) {
for (final row in json) {
final value = SearchConfigResponseDto.fromJson(row);
if (value != null) {
result.add(value);
}
}
}
return result.toList(growable: growable);
}
static Map<String, SearchConfigResponseDto> mapFromJson(dynamic json) {
final map = <String, SearchConfigResponseDto>{};
if (json is Map && json.isNotEmpty) {
json = json.cast<String, dynamic>(); // ignore: parameter_assignments
for (final entry in json.entries) {
final value = SearchConfigResponseDto.fromJson(entry.value);
if (value != null) {
map[entry.key] = value;
}
}
}
return map;
}
// maps a json object with a list of SearchConfigResponseDto-objects as value to a dart map
static Map<String, List<SearchConfigResponseDto>> mapListFromJson(dynamic json, {bool growable = false,}) {
final map = <String, List<SearchConfigResponseDto>>{};
if (json is Map && json.isNotEmpty) {
json = json.cast<String, dynamic>(); // ignore: parameter_assignments
for (final entry in json.entries) {
final value = SearchConfigResponseDto.listFromJson(entry.value, growable: growable,);
if (value != null) {
map[entry.key] = value;
}
}
}
return map;
}
/// The list of required keys that must be present in a JSON.
static const requiredKeys = <String>{
'enabled',
};
}

View File

@ -0,0 +1,119 @@
//
// AUTO-GENERATED FILE, DO NOT MODIFY!
//
// @dart=2.12
// ignore_for_file: unused_element, unused_import
// ignore_for_file: always_put_required_named_parameters_first
// ignore_for_file: constant_identifier_names
// ignore_for_file: lines_longer_than_80_chars
part of openapi.api;
class SearchFacetCountResponseDto {
/// Returns a new [SearchFacetCountResponseDto] instance.
SearchFacetCountResponseDto({
required this.count,
required this.value,
});
int count;
String value;
@override
bool operator ==(Object other) => identical(this, other) || other is SearchFacetCountResponseDto &&
other.count == count &&
other.value == value;
@override
int get hashCode =>
// ignore: unnecessary_parenthesis
(count.hashCode) +
(value.hashCode);
@override
String toString() => 'SearchFacetCountResponseDto[count=$count, value=$value]';
Map<String, dynamic> toJson() {
final json = <String, dynamic>{};
json[r'count'] = this.count;
json[r'value'] = this.value;
return json;
}
/// Returns a new [SearchFacetCountResponseDto] instance and imports its values from
/// [value] if it's a [Map], null otherwise.
// ignore: prefer_constructors_over_static_methods
static SearchFacetCountResponseDto? fromJson(dynamic value) {
if (value is Map) {
final json = value.cast<String, dynamic>();
// Ensure that the map contains the required keys.
// Note 1: the values aren't checked for validity beyond being non-null.
// Note 2: this code is stripped in release mode!
assert(() {
requiredKeys.forEach((key) {
assert(json.containsKey(key), 'Required key "SearchFacetCountResponseDto[$key]" is missing from JSON.');
assert(json[key] != null, 'Required key "SearchFacetCountResponseDto[$key]" has a null value in JSON.');
});
return true;
}());
return SearchFacetCountResponseDto(
count: mapValueOfType<int>(json, r'count')!,
value: mapValueOfType<String>(json, r'value')!,
);
}
return null;
}
static List<SearchFacetCountResponseDto>? listFromJson(dynamic json, {bool growable = false,}) {
final result = <SearchFacetCountResponseDto>[];
if (json is List && json.isNotEmpty) {
for (final row in json) {
final value = SearchFacetCountResponseDto.fromJson(row);
if (value != null) {
result.add(value);
}
}
}
return result.toList(growable: growable);
}
static Map<String, SearchFacetCountResponseDto> mapFromJson(dynamic json) {
final map = <String, SearchFacetCountResponseDto>{};
if (json is Map && json.isNotEmpty) {
json = json.cast<String, dynamic>(); // ignore: parameter_assignments
for (final entry in json.entries) {
final value = SearchFacetCountResponseDto.fromJson(entry.value);
if (value != null) {
map[entry.key] = value;
}
}
}
return map;
}
// maps a json object with a list of SearchFacetCountResponseDto-objects as value to a dart map
static Map<String, List<SearchFacetCountResponseDto>> mapListFromJson(dynamic json, {bool growable = false,}) {
final map = <String, List<SearchFacetCountResponseDto>>{};
if (json is Map && json.isNotEmpty) {
json = json.cast<String, dynamic>(); // ignore: parameter_assignments
for (final entry in json.entries) {
final value = SearchFacetCountResponseDto.listFromJson(entry.value, growable: growable,);
if (value != null) {
map[entry.key] = value;
}
}
}
return map;
}
/// The list of required keys that must be present in a JSON.
static const requiredKeys = <String>{
'count',
'value',
};
}

View File

@ -0,0 +1,119 @@
//
// AUTO-GENERATED FILE, DO NOT MODIFY!
//
// @dart=2.12
// ignore_for_file: unused_element, unused_import
// ignore_for_file: always_put_required_named_parameters_first
// ignore_for_file: constant_identifier_names
// ignore_for_file: lines_longer_than_80_chars
part of openapi.api;
class SearchFacetResponseDto {
/// Returns a new [SearchFacetResponseDto] instance.
SearchFacetResponseDto({
required this.fieldName,
this.counts = const [],
});
String fieldName;
List<SearchFacetCountResponseDto> counts;
@override
bool operator ==(Object other) => identical(this, other) || other is SearchFacetResponseDto &&
other.fieldName == fieldName &&
other.counts == counts;
@override
int get hashCode =>
// ignore: unnecessary_parenthesis
(fieldName.hashCode) +
(counts.hashCode);
@override
String toString() => 'SearchFacetResponseDto[fieldName=$fieldName, counts=$counts]';
Map<String, dynamic> toJson() {
final json = <String, dynamic>{};
json[r'fieldName'] = this.fieldName;
json[r'counts'] = this.counts;
return json;
}
/// Returns a new [SearchFacetResponseDto] instance and imports its values from
/// [value] if it's a [Map], null otherwise.
// ignore: prefer_constructors_over_static_methods
static SearchFacetResponseDto? fromJson(dynamic value) {
if (value is Map) {
final json = value.cast<String, dynamic>();
// Ensure that the map contains the required keys.
// Note 1: the values aren't checked for validity beyond being non-null.
// Note 2: this code is stripped in release mode!
assert(() {
requiredKeys.forEach((key) {
assert(json.containsKey(key), 'Required key "SearchFacetResponseDto[$key]" is missing from JSON.');
assert(json[key] != null, 'Required key "SearchFacetResponseDto[$key]" has a null value in JSON.');
});
return true;
}());
return SearchFacetResponseDto(
fieldName: mapValueOfType<String>(json, r'fieldName')!,
counts: SearchFacetCountResponseDto.listFromJson(json[r'counts'])!,
);
}
return null;
}
static List<SearchFacetResponseDto>? listFromJson(dynamic json, {bool growable = false,}) {
final result = <SearchFacetResponseDto>[];
if (json is List && json.isNotEmpty) {
for (final row in json) {
final value = SearchFacetResponseDto.fromJson(row);
if (value != null) {
result.add(value);
}
}
}
return result.toList(growable: growable);
}
static Map<String, SearchFacetResponseDto> mapFromJson(dynamic json) {
final map = <String, SearchFacetResponseDto>{};
if (json is Map && json.isNotEmpty) {
json = json.cast<String, dynamic>(); // ignore: parameter_assignments
for (final entry in json.entries) {
final value = SearchFacetResponseDto.fromJson(entry.value);
if (value != null) {
map[entry.key] = value;
}
}
}
return map;
}
// maps a json object with a list of SearchFacetResponseDto-objects as value to a dart map
static Map<String, List<SearchFacetResponseDto>> mapListFromJson(dynamic json, {bool growable = false,}) {
final map = <String, List<SearchFacetResponseDto>>{};
if (json is Map && json.isNotEmpty) {
json = json.cast<String, dynamic>(); // ignore: parameter_assignments
for (final entry in json.entries) {
final value = SearchFacetResponseDto.listFromJson(entry.value, growable: growable,);
if (value != null) {
map[entry.key] = value;
}
}
}
return map;
}
/// The list of required keys that must be present in a JSON.
static const requiredKeys = <String>{
'fieldName',
'counts',
};
}

View File

@ -0,0 +1,119 @@
//
// AUTO-GENERATED FILE, DO NOT MODIFY!
//
// @dart=2.12
// ignore_for_file: unused_element, unused_import
// ignore_for_file: always_put_required_named_parameters_first
// ignore_for_file: constant_identifier_names
// ignore_for_file: lines_longer_than_80_chars
part of openapi.api;
class SearchResponseDto {
/// Returns a new [SearchResponseDto] instance.
SearchResponseDto({
required this.albums,
required this.assets,
});
SearchAlbumResponseDto albums;
SearchAssetResponseDto assets;
@override
bool operator ==(Object other) => identical(this, other) || other is SearchResponseDto &&
other.albums == albums &&
other.assets == assets;
@override
int get hashCode =>
// ignore: unnecessary_parenthesis
(albums.hashCode) +
(assets.hashCode);
@override
String toString() => 'SearchResponseDto[albums=$albums, assets=$assets]';
Map<String, dynamic> toJson() {
final json = <String, dynamic>{};
json[r'albums'] = this.albums;
json[r'assets'] = this.assets;
return json;
}
/// Returns a new [SearchResponseDto] instance and imports its values from
/// [value] if it's a [Map], null otherwise.
// ignore: prefer_constructors_over_static_methods
static SearchResponseDto? fromJson(dynamic value) {
if (value is Map) {
final json = value.cast<String, dynamic>();
// Ensure that the map contains the required keys.
// Note 1: the values aren't checked for validity beyond being non-null.
// Note 2: this code is stripped in release mode!
assert(() {
requiredKeys.forEach((key) {
assert(json.containsKey(key), 'Required key "SearchResponseDto[$key]" is missing from JSON.');
assert(json[key] != null, 'Required key "SearchResponseDto[$key]" has a null value in JSON.');
});
return true;
}());
return SearchResponseDto(
albums: SearchAlbumResponseDto.fromJson(json[r'albums'])!,
assets: SearchAssetResponseDto.fromJson(json[r'assets'])!,
);
}
return null;
}
static List<SearchResponseDto>? listFromJson(dynamic json, {bool growable = false,}) {
final result = <SearchResponseDto>[];
if (json is List && json.isNotEmpty) {
for (final row in json) {
final value = SearchResponseDto.fromJson(row);
if (value != null) {
result.add(value);
}
}
}
return result.toList(growable: growable);
}
static Map<String, SearchResponseDto> mapFromJson(dynamic json) {
final map = <String, SearchResponseDto>{};
if (json is Map && json.isNotEmpty) {
json = json.cast<String, dynamic>(); // ignore: parameter_assignments
for (final entry in json.entries) {
final value = SearchResponseDto.fromJson(entry.value);
if (value != null) {
map[entry.key] = value;
}
}
}
return map;
}
// maps a json object with a list of SearchResponseDto-objects as value to a dart map
static Map<String, List<SearchResponseDto>> mapListFromJson(dynamic json, {bool growable = false,}) {
final map = <String, List<SearchResponseDto>>{};
if (json is Map && json.isNotEmpty) {
json = json.cast<String, dynamic>(); // ignore: parameter_assignments
for (final entry in json.entries) {
final value = SearchResponseDto.listFromJson(entry.value, growable: growable,);
if (value != null) {
map[entry.key] = value;
}
}
}
return map;
}
/// The list of required keys that must be present in a JSON.
static const requiredKeys = <String>{
'albums',
'assets',
};
}