feat (server, web): Share with partner (#2388)

* feat(server, web): implement share with partner * chore: regenerate api * chore: regenerate api * Pass userId to getAssetCountByTimeBucket and getAssetByTimeBucket * chore: regenerate api * Use AssetGrid to view partner's assets * Remove disableNavBarActions flag * Check access to buckets * Apply suggestions from code review Co-authored-by: Jason Rasmussen <jrasm91@gmail.com> * Remove exception rethrowing * Simplify partner access check * Create new PartnerController * chore api:generate * Use partnerApi * Remove id from PartnerResponseDto * Refactor PartnerEntity * Rename args * Remove duplicate code in getAll * Create composite primary keys for partners table * Move asset access check into PartnerCore * Remove redundant getUserAssets call * Remove unused getUserAssets method * chore: regenerate api * Simplify getAll * Replace ?? with || * Simplify PartnerRepository.create * Introduce PartnerIds interface * Replace two database migrations with one * Simplify getAll * Change PartnerResponseDto to include UserResponseDto * Move partner sharing endpoints to PartnerController * Rename ShareController to SharedLinkController * chore: regenerate api after rebase * refactor: shared link remove return type * refactor: return user response dto * chore: regenerate open api * refactor: partner getAll * refactor: partner settings event typing * chore: remove unused code * refactor: add partners modal trigger * refactor: update url for viewing partner photos * feat: update partner sharing title * refactor: rename service method names * refactor: http exception logic to service, PartnerIds interface * chore: regenerate open api * test: coverage for domain code * fix: addPartner => createPartner * fix: missed rename * refactor: more code cleanup * chore: alphabetize settings order * feat: stop sharing confirmation modal * Enhance contrast of the email in dark mode * Replace button with CircleIconButton * Fix linter warning * Fix date types for PartnerEntity * Fix PartnerEntity creation * Reset assetStore state * Change layout of the partner's assets page * Add bulk download action for partner's assets --------- Co-authored-by: Jason Rasmussen <jrasm91@gmail.com>
2025-10-29 17:40:28 +00:00 · 2023-05-15 20:30:53 +03:00
parent 4524aa0d06
commit 7f2fa23179
55 changed files with 1669 additions and 92 deletions
--- a/mobile/openapi/.openapi-generator/FILES
+++ b/mobile/openapi/.openapi-generator/FILES
@@ -60,6 +60,7 @@ doc/OAuthApi.md
 doc/OAuthCallbackDto.md
 doc/OAuthConfigDto.md
 doc/OAuthConfigResponseDto.md
+doc/PartnerApi.md
 doc/QueueStatusDto.md
 doc/RemoveAssetsDto.md
 doc/SearchAlbumResponseDto.md
@@ -111,6 +112,7 @@ lib/api/asset_api.dart
 lib/api/authentication_api.dart
 lib/api/job_api.dart
 lib/api/o_auth_api.dart
+lib/api/partner_api.dart
 lib/api/search_api.dart
 lib/api/server_info_api.dart
 lib/api/share_api.dart
@@ -271,6 +273,7 @@ test/o_auth_api_test.dart
 test/o_auth_callback_dto_test.dart
 test/o_auth_config_dto_test.dart
 test/o_auth_config_response_dto_test.dart
+test/partner_api_test.dart
 test/queue_status_dto_test.dart
 test/remove_assets_dto_test.dart
 test/search_album_response_dto_test.dart
--- a/mobile/openapi/README.md
+++ b/mobile/openapi/README.md
@@ -129,6 +129,9 @@ Class | Method | HTTP request | Description
 *OAuthApi* | [**link**](doc//OAuthApi.md#link) | **POST** /oauth/link | 
 *OAuthApi* | [**mobileRedirect**](doc//OAuthApi.md#mobileredirect) | **GET** /oauth/mobile-redirect | 
 *OAuthApi* | [**unlink**](doc//OAuthApi.md#unlink) | **POST** /oauth/unlink | 
+*PartnerApi* | [**createPartner**](doc//PartnerApi.md#createpartner) | **POST** /partner/{id} | 
+*PartnerApi* | [**getPartners**](doc//PartnerApi.md#getpartners) | **GET** /partner | 
+*PartnerApi* | [**removePartner**](doc//PartnerApi.md#removepartner) | **DELETE** /partner/{id} | 
 *SearchApi* | [**getExploreData**](doc//SearchApi.md#getexploredata) | **GET** /search/explore | 
 *SearchApi* | [**getSearchConfig**](doc//SearchApi.md#getsearchconfig) | **GET** /search/config | 
 *SearchApi* | [**search**](doc//SearchApi.md#search) | **GET** /search | 
--- a/mobile/openapi/doc/GetAssetByTimeBucketDto.md
+++ b/mobile/openapi/doc/GetAssetByTimeBucketDto.md
@@ -9,6 +9,7 @@ import 'package:openapi/api.dart';
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **timeBucket** | **List<String>** |  | [default to const []]
+**userId** | **String** |  | [optional] 

 [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

--- a/mobile/openapi/doc/GetAssetCountByTimeBucketDto.md
+++ b/mobile/openapi/doc/GetAssetCountByTimeBucketDto.md
@@ -9,6 +9,7 @@ import 'package:openapi/api.dart';
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **timeGroup** | [**TimeGroupEnum**](TimeGroupEnum.md) |  | 
+**userId** | **String** |  | [optional] 

 [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

--- a/mobile/openapi/doc/PartnerApi.md
+++ b/mobile/openapi/doc/PartnerApi.md
@@ -0,0 +1,180 @@
+# openapi.api.PartnerApi
+
+## Load the API package
+```dart
+import 'package:openapi/api.dart';
+```
+
+All URIs are relative to */api*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**createPartner**](PartnerApi.md#createpartner) | **POST** /partner/{id} | 
+[**getPartners**](PartnerApi.md#getpartners) | **GET** /partner | 
+[**removePartner**](PartnerApi.md#removepartner) | **DELETE** /partner/{id} | 
+
+
+# **createPartner**
+> UserResponseDto createPartner(id)
+
+
+
+### Example
+```dart
+import 'package:openapi/api.dart';
+// TODO Configure API key authorization: cookie
+//defaultApiClient.getAuthentication<ApiKeyAuth>('cookie').apiKey = 'YOUR_API_KEY';
+// uncomment below to setup prefix (e.g. Bearer) for API key, if needed
+//defaultApiClient.getAuthentication<ApiKeyAuth>('cookie').apiKeyPrefix = 'Bearer';
+// TODO Configure API key authorization: api_key
+//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKey = 'YOUR_API_KEY';
+// uncomment below to setup prefix (e.g. Bearer) for API key, if needed
+//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKeyPrefix = 'Bearer';
+// TODO Configure HTTP Bearer authorization: bearer
+// Case 1. Use String Token
+//defaultApiClient.getAuthentication<HttpBearerAuth>('bearer').setAccessToken('YOUR_ACCESS_TOKEN');
+// Case 2. Use Function which generate token.
+// String yourTokenGeneratorFunction() { ... }
+//defaultApiClient.getAuthentication<HttpBearerAuth>('bearer').setAccessToken(yourTokenGeneratorFunction);
+
+final api_instance = PartnerApi();
+final id = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // String | 
+
+try {
+    final result = api_instance.createPartner(id);
+    print(result);
+} catch (e) {
+    print('Exception when calling PartnerApi->createPartner: $e\n');
+}
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **id** | **String**|  | 
+
+### Return type
+
+[**UserResponseDto**](UserResponseDto.md)
+
+### Authorization
+
+[cookie](../README.md#cookie), [api_key](../README.md#api_key), [bearer](../README.md#bearer)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
+
+# **getPartners**
+> List<UserResponseDto> getPartners(direction)
+
+
+
+### Example
+```dart
+import 'package:openapi/api.dart';
+// TODO Configure API key authorization: cookie
+//defaultApiClient.getAuthentication<ApiKeyAuth>('cookie').apiKey = 'YOUR_API_KEY';
+// uncomment below to setup prefix (e.g. Bearer) for API key, if needed
+//defaultApiClient.getAuthentication<ApiKeyAuth>('cookie').apiKeyPrefix = 'Bearer';
+// TODO Configure API key authorization: api_key
+//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKey = 'YOUR_API_KEY';
+// uncomment below to setup prefix (e.g. Bearer) for API key, if needed
+//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKeyPrefix = 'Bearer';
+// TODO Configure HTTP Bearer authorization: bearer
+// Case 1. Use String Token
+//defaultApiClient.getAuthentication<HttpBearerAuth>('bearer').setAccessToken('YOUR_ACCESS_TOKEN');
+// Case 2. Use Function which generate token.
+// String yourTokenGeneratorFunction() { ... }
+//defaultApiClient.getAuthentication<HttpBearerAuth>('bearer').setAccessToken(yourTokenGeneratorFunction);
+
+final api_instance = PartnerApi();
+final direction = direction_example; // String | 
+
+try {
+    final result = api_instance.getPartners(direction);
+    print(result);
+} catch (e) {
+    print('Exception when calling PartnerApi->getPartners: $e\n');
+}
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **direction** | **String**|  | 
+
+### Return type
+
+[**List<UserResponseDto>**](UserResponseDto.md)
+
+### Authorization
+
+[cookie](../README.md#cookie), [api_key](../README.md#api_key), [bearer](../README.md#bearer)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
+
+# **removePartner**
+> removePartner(id)
+
+
+
+### Example
+```dart
+import 'package:openapi/api.dart';
+// TODO Configure API key authorization: cookie
+//defaultApiClient.getAuthentication<ApiKeyAuth>('cookie').apiKey = 'YOUR_API_KEY';
+// uncomment below to setup prefix (e.g. Bearer) for API key, if needed
+//defaultApiClient.getAuthentication<ApiKeyAuth>('cookie').apiKeyPrefix = 'Bearer';
+// TODO Configure API key authorization: api_key
+//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKey = 'YOUR_API_KEY';
+// uncomment below to setup prefix (e.g. Bearer) for API key, if needed
+//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKeyPrefix = 'Bearer';
+// TODO Configure HTTP Bearer authorization: bearer
+// Case 1. Use String Token
+//defaultApiClient.getAuthentication<HttpBearerAuth>('bearer').setAccessToken('YOUR_ACCESS_TOKEN');
+// Case 2. Use Function which generate token.
+// String yourTokenGeneratorFunction() { ... }
+//defaultApiClient.getAuthentication<HttpBearerAuth>('bearer').setAccessToken(yourTokenGeneratorFunction);
+
+final api_instance = PartnerApi();
+final id = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // String | 
+
+try {
+    api_instance.removePartner(id);
+} catch (e) {
+    print('Exception when calling PartnerApi->removePartner: $e\n');
+}
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **id** | **String**|  | 
+
+### Return type
+
+void (empty response body)
+
+### Authorization
+
+[cookie](../README.md#cookie), [api_key](../README.md#api_key), [bearer](../README.md#bearer)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: Not defined
+
+[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
+
--- a/mobile/openapi/lib/api.dart
+++ b/mobile/openapi/lib/api.dart
@@ -34,6 +34,7 @@ part 'api/asset_api.dart';
 part 'api/authentication_api.dart';
 part 'api/job_api.dart';
 part 'api/o_auth_api.dart';
+part 'api/partner_api.dart';
 part 'api/search_api.dart';
 part 'api/server_info_api.dart';
 part 'api/share_api.dart';
--- a/mobile/openapi/lib/api/partner_api.dart
+++ b/mobile/openapi/lib/api/partner_api.dart
@@ -0,0 +1,158 @@
+//
+// 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 PartnerApi {
+  PartnerApi([ApiClient? apiClient]) : apiClient = apiClient ?? defaultApiClient;
+
+  final ApiClient apiClient;
+
+  /// Performs an HTTP 'POST /partner/{id}' operation and returns the [Response].
+  /// Parameters:
+  ///
+  /// * [String] id (required):
+  Future<Response> createPartnerWithHttpInfo(String id,) async {
+    // ignore: prefer_const_declarations
+    final path = r'/partner/{id}'
+      .replaceAll('{id}', id);
+
+    // ignore: prefer_final_locals
+    Object? postBody;
+
+    final queryParams = <QueryParam>[];
+    final headerParams = <String, String>{};
+    final formParams = <String, String>{};
+
+    const contentTypes = <String>[];
+
+
+    return apiClient.invokeAPI(
+      path,
+      'POST',
+      queryParams,
+      postBody,
+      headerParams,
+      formParams,
+      contentTypes.isEmpty ? null : contentTypes.first,
+    );
+  }
+
+  /// Parameters:
+  ///
+  /// * [String] id (required):
+  Future<UserResponseDto?> createPartner(String id,) async {
+    final response = await createPartnerWithHttpInfo(id,);
+    if (response.statusCode >= HttpStatus.badRequest) {
+      throw ApiException(response.statusCode, await _decodeBodyBytes(response));
+    }
+    // When a remote server returns no body with a status of 204, we shall not decode it.
+    // At the time of writing this, `dart:convert` will throw an "Unexpected end of input"
+    // FormatException when trying to decode an empty string.
+    if (response.body.isNotEmpty && response.statusCode != HttpStatus.noContent) {
+      return await apiClient.deserializeAsync(await _decodeBodyBytes(response), 'UserResponseDto',) as UserResponseDto;
+    
+    }
+    return null;
+  }
+
+  /// Performs an HTTP 'GET /partner' operation and returns the [Response].
+  /// Parameters:
+  ///
+  /// * [String] direction (required):
+  Future<Response> getPartnersWithHttpInfo(String direction,) async {
+    // ignore: prefer_const_declarations
+    final path = r'/partner';
+
+    // ignore: prefer_final_locals
+    Object? postBody;
+
+    final queryParams = <QueryParam>[];
+    final headerParams = <String, String>{};
+    final formParams = <String, String>{};
+
+      queryParams.addAll(_queryParams('', 'direction', direction));
+
+    const contentTypes = <String>[];
+
+
+    return apiClient.invokeAPI(
+      path,
+      'GET',
+      queryParams,
+      postBody,
+      headerParams,
+      formParams,
+      contentTypes.isEmpty ? null : contentTypes.first,
+    );
+  }
+
+  /// Parameters:
+  ///
+  /// * [String] direction (required):
+  Future<List<UserResponseDto>?> getPartners(String direction,) async {
+    final response = await getPartnersWithHttpInfo(direction,);
+    if (response.statusCode >= HttpStatus.badRequest) {
+      throw ApiException(response.statusCode, await _decodeBodyBytes(response));
+    }
+    // When a remote server returns no body with a status of 204, we shall not decode it.
+    // At the time of writing this, `dart:convert` will throw an "Unexpected end of input"
+    // FormatException when trying to decode an empty string.
+    if (response.body.isNotEmpty && response.statusCode != HttpStatus.noContent) {
+      final responseBody = await _decodeBodyBytes(response);
+      return (await apiClient.deserializeAsync(responseBody, 'List<UserResponseDto>') as List)
+        .cast<UserResponseDto>()
+        .toList();
+
+    }
+    return null;
+  }
+
+  /// Performs an HTTP 'DELETE /partner/{id}' operation and returns the [Response].
+  /// Parameters:
+  ///
+  /// * [String] id (required):
+  Future<Response> removePartnerWithHttpInfo(String id,) async {
+    // ignore: prefer_const_declarations
+    final path = r'/partner/{id}'
+      .replaceAll('{id}', id);
+
+    // ignore: prefer_final_locals
+    Object? postBody;
+
+    final queryParams = <QueryParam>[];
+    final headerParams = <String, String>{};
+    final formParams = <String, String>{};
+
+    const contentTypes = <String>[];
+
+
+    return apiClient.invokeAPI(
+      path,
+      'DELETE',
+      queryParams,
+      postBody,
+      headerParams,
+      formParams,
+      contentTypes.isEmpty ? null : contentTypes.first,
+    );
+  }
+
+  /// Parameters:
+  ///
+  /// * [String] id (required):
+  Future<void> removePartner(String id,) async {
+    final response = await removePartnerWithHttpInfo(id,);
+    if (response.statusCode >= HttpStatus.badRequest) {
+      throw ApiException(response.statusCode, await _decodeBodyBytes(response));
+    }
+  }
+}
--- a/mobile/openapi/lib/model/get_asset_by_time_bucket_dto.dart
+++ b/mobile/openapi/lib/model/get_asset_by_time_bucket_dto.dart
@@ -14,25 +14,41 @@ class GetAssetByTimeBucketDto {
  /// Returns a new [GetAssetByTimeBucketDto] instance.
  GetAssetByTimeBucketDto({
    this.timeBucket = const [],
+    this.userId,
  });

  List<String> timeBucket;

+  ///
+  /// Please note: This property should have been non-nullable! Since the specification file
+  /// does not include a default value (using the "default:" property), however, the generated
+  /// source code must fall back to having a nullable type.
+  /// Consider adding a "default:" property in the specification file to hide this note.
+  ///
+  String? userId;
+
  @override
  bool operator ==(Object other) => identical(this, other) || other is GetAssetByTimeBucketDto &&
-     other.timeBucket == timeBucket;
+     other.timeBucket == timeBucket &&
+     other.userId == userId;

  @override
  int get hashCode =>
    // ignore: unnecessary_parenthesis
-    (timeBucket.hashCode);
+    (timeBucket.hashCode) +
+    (userId == null ? 0 : userId!.hashCode);

  @override
-  String toString() => 'GetAssetByTimeBucketDto[timeBucket=$timeBucket]';
+  String toString() => 'GetAssetByTimeBucketDto[timeBucket=$timeBucket, userId=$userId]';

  Map<String, dynamic> toJson() {
    final json = <String, dynamic>{};
      json[r'timeBucket'] = this.timeBucket;
+    if (this.userId != null) {
+      json[r'userId'] = this.userId;
+    } else {
+      // json[r'userId'] = null;
+    }
    return json;
  }

@@ -58,6 +74,7 @@ class GetAssetByTimeBucketDto {
        timeBucket: json[r'timeBucket'] is Iterable
            ? (json[r'timeBucket'] as Iterable).cast<String>().toList(growable: false)
            : const [],
+        userId: mapValueOfType<String>(json, r'userId'),
      );
    }
    return null;
--- a/mobile/openapi/lib/model/get_asset_count_by_time_bucket_dto.dart
+++ b/mobile/openapi/lib/model/get_asset_count_by_time_bucket_dto.dart
@@ -14,25 +14,41 @@ class GetAssetCountByTimeBucketDto {
  /// Returns a new [GetAssetCountByTimeBucketDto] instance.
  GetAssetCountByTimeBucketDto({
    required this.timeGroup,
+    this.userId,
  });

  TimeGroupEnum timeGroup;

+  ///
+  /// Please note: This property should have been non-nullable! Since the specification file
+  /// does not include a default value (using the "default:" property), however, the generated
+  /// source code must fall back to having a nullable type.
+  /// Consider adding a "default:" property in the specification file to hide this note.
+  ///
+  String? userId;
+
  @override
  bool operator ==(Object other) => identical(this, other) || other is GetAssetCountByTimeBucketDto &&
-     other.timeGroup == timeGroup;
+     other.timeGroup == timeGroup &&
+     other.userId == userId;

  @override
  int get hashCode =>
    // ignore: unnecessary_parenthesis
-    (timeGroup.hashCode);
+    (timeGroup.hashCode) +
+    (userId == null ? 0 : userId!.hashCode);

  @override
-  String toString() => 'GetAssetCountByTimeBucketDto[timeGroup=$timeGroup]';
+  String toString() => 'GetAssetCountByTimeBucketDto[timeGroup=$timeGroup, userId=$userId]';

  Map<String, dynamic> toJson() {
    final json = <String, dynamic>{};
      json[r'timeGroup'] = this.timeGroup;
+    if (this.userId != null) {
+      json[r'userId'] = this.userId;
+    } else {
+      // json[r'userId'] = null;
+    }
    return json;
  }

@@ -56,6 +72,7 @@ class GetAssetCountByTimeBucketDto {

      return GetAssetCountByTimeBucketDto(
        timeGroup: TimeGroupEnum.fromJson(json[r'timeGroup'])!,
+        userId: mapValueOfType<String>(json, r'userId'),
      );
    }
    return null;
--- a/mobile/openapi/test/get_asset_by_time_bucket_dto_test.dart
+++ b/mobile/openapi/test/get_asset_by_time_bucket_dto_test.dart
@@ -21,6 +21,11 @@ void main() {
      // TODO
    });

+    // String userId
+    test('to test the property `userId`', () async {
+      // TODO
+    });
+

  });

--- a/mobile/openapi/test/get_asset_count_by_time_bucket_dto_test.dart
+++ b/mobile/openapi/test/get_asset_count_by_time_bucket_dto_test.dart
@@ -21,6 +21,11 @@ void main() {
      // TODO
    });

+    // String userId
+    test('to test the property `userId`', () async {
+      // TODO
+    });
+

  });

--- a/mobile/openapi/test/partner_api_test.dart
+++ b/mobile/openapi/test/partner_api_test.dart
@@ -0,0 +1,36 @@
+//
+// 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
+
+import 'package:openapi/api.dart';
+import 'package:test/test.dart';
+
+
+/// tests for PartnerApi
+void main() {
+  // final instance = PartnerApi();
+
+  group('tests for PartnerApi', () {
+    //Future<UserResponseDto> createPartner(String id) async
+    test('test createPartner', () async {
+      // TODO
+    });
+
+    //Future<List<UserResponseDto>> getPartners(String direction) async
+    test('test getPartners', () async {
+      // TODO
+    });
+
+    //Future removePartner(String id) async
+    test('test removePartner', () async {
+      // TODO
+    });
+
+  });
+}