add set permission endpoint and UI

This commit is contained in:
mgabor
2024-04-12 18:28:50 +02:00
parent 98f1d1517a
commit ac1c4e206e
18 changed files with 419 additions and 6 deletions

View File

@@ -142,6 +142,7 @@ doc/ServerPingResponse.md
doc/ServerStatsResponseDto.md
doc/ServerThemeDto.md
doc/ServerVersionResponseDto.md
doc/SetAlbumPermissionDto.md
doc/SharedLinkApi.md
doc/SharedLinkCreateDto.md
doc/SharedLinkEditDto.md
@@ -355,6 +356,7 @@ lib/model/server_ping_response.dart
lib/model/server_stats_response_dto.dart
lib/model/server_theme_dto.dart
lib/model/server_version_response_dto.dart
lib/model/set_album_permission_dto.dart
lib/model/shared_link_create_dto.dart
lib/model/shared_link_edit_dto.dart
lib/model/shared_link_response_dto.dart
@@ -547,6 +549,7 @@ test/server_ping_response_test.dart
test/server_stats_response_dto_test.dart
test/server_theme_dto_test.dart
test/server_version_response_dto_test.dart
test/set_album_permission_dto_test.dart
test/shared_link_api_test.dart
test/shared_link_create_dto_test.dart
test/shared_link_edit_dto_test.dart

View File

@@ -90,6 +90,7 @@ Class | Method | HTTP request | Description
*AlbumApi* | [**getAllAlbums**](doc//AlbumApi.md#getallalbums) | **GET** /album |
*AlbumApi* | [**removeAssetFromAlbum**](doc//AlbumApi.md#removeassetfromalbum) | **DELETE** /album/{id}/assets |
*AlbumApi* | [**removeUserFromAlbum**](doc//AlbumApi.md#removeuserfromalbum) | **DELETE** /album/{id}/user/{userId} |
*AlbumApi* | [**setAlbumPermission**](doc//AlbumApi.md#setalbumpermission) | **PUT** /album/{id}/permission/{userId} |
*AlbumApi* | [**updateAlbumInfo**](doc//AlbumApi.md#updatealbuminfo) | **PATCH** /album/{id} |
*AssetApi* | [**checkBulkUpload**](doc//AssetApi.md#checkbulkupload) | **POST** /asset/bulk-upload-check |
*AssetApi* | [**checkExistingAssets**](doc//AssetApi.md#checkexistingassets) | **POST** /asset/exist |
@@ -346,6 +347,7 @@ Class | Method | HTTP request | Description
- [ServerStatsResponseDto](doc//ServerStatsResponseDto.md)
- [ServerThemeDto](doc//ServerThemeDto.md)
- [ServerVersionResponseDto](doc//ServerVersionResponseDto.md)
- [SetAlbumPermissionDto](doc//SetAlbumPermissionDto.md)
- [SharedLinkCreateDto](doc//SharedLinkCreateDto.md)
- [SharedLinkEditDto](doc//SharedLinkEditDto.md)
- [SharedLinkResponseDto](doc//SharedLinkResponseDto.md)

View File

@@ -18,6 +18,7 @@ Method | HTTP request | Description
[**getAllAlbums**](AlbumApi.md#getallalbums) | **GET** /album |
[**removeAssetFromAlbum**](AlbumApi.md#removeassetfromalbum) | **DELETE** /album/{id}/assets |
[**removeUserFromAlbum**](AlbumApi.md#removeuserfromalbum) | **DELETE** /album/{id}/user/{userId} |
[**setAlbumPermission**](AlbumApi.md#setalbumpermission) | **PUT** /album/{id}/permission/{userId} |
[**updateAlbumInfo**](AlbumApi.md#updatealbuminfo) | **PATCH** /album/{id} |
@@ -526,6 +527,64 @@ void (empty response body)
[[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)
# **setAlbumPermission**
> setAlbumPermission(id, userId, setAlbumPermissionDto)
### 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 = AlbumApi();
final id = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // String |
final userId = userId_example; // String |
final setAlbumPermissionDto = SetAlbumPermissionDto(); // SetAlbumPermissionDto |
try {
api_instance.setAlbumPermission(id, userId, setAlbumPermissionDto);
} catch (e) {
print('Exception when calling AlbumApi->setAlbumPermission: $e\n');
}
```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**id** | **String**| |
**userId** | **String**| |
**setAlbumPermissionDto** | [**SetAlbumPermissionDto**](SetAlbumPermissionDto.md)| |
### 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**: application/json
- **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)
# **updateAlbumInfo**
> AlbumResponseDto updateAlbumInfo(id, updateAlbumDto)

View File

@@ -0,0 +1,15 @@
# openapi.model.SetAlbumPermissionDto
## Load the model package
```dart
import 'package:openapi/api.dart';
```
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**readonly** | **bool** | |
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

View File

@@ -175,6 +175,7 @@ part 'model/server_ping_response.dart';
part 'model/server_stats_response_dto.dart';
part 'model/server_theme_dto.dart';
part 'model/server_version_response_dto.dart';
part 'model/set_album_permission_dto.dart';
part 'model/shared_link_create_dto.dart';
part 'model/shared_link_edit_dto.dart';
part 'model/shared_link_response_dto.dart';

View File

@@ -485,6 +485,55 @@ class AlbumApi {
}
}
/// Performs an HTTP 'PUT /album/{id}/permission/{userId}' operation and returns the [Response].
/// Parameters:
///
/// * [String] id (required):
///
/// * [String] userId (required):
///
/// * [SetAlbumPermissionDto] setAlbumPermissionDto (required):
Future<Response> setAlbumPermissionWithHttpInfo(String id, String userId, SetAlbumPermissionDto setAlbumPermissionDto,) async {
// ignore: prefer_const_declarations
final path = r'/album/{id}/permission/{userId}'
.replaceAll('{id}', id)
.replaceAll('{userId}', userId);
// ignore: prefer_final_locals
Object? postBody = setAlbumPermissionDto;
final queryParams = <QueryParam>[];
final headerParams = <String, String>{};
final formParams = <String, String>{};
const contentTypes = <String>['application/json'];
return apiClient.invokeAPI(
path,
'PUT',
queryParams,
postBody,
headerParams,
formParams,
contentTypes.isEmpty ? null : contentTypes.first,
);
}
/// Parameters:
///
/// * [String] id (required):
///
/// * [String] userId (required):
///
/// * [SetAlbumPermissionDto] setAlbumPermissionDto (required):
Future<void> setAlbumPermission(String id, String userId, SetAlbumPermissionDto setAlbumPermissionDto,) async {
final response = await setAlbumPermissionWithHttpInfo(id, userId, setAlbumPermissionDto,);
if (response.statusCode >= HttpStatus.badRequest) {
throw ApiException(response.statusCode, await _decodeBodyBytes(response));
}
}
/// Performs an HTTP 'PATCH /album/{id}' operation and returns the [Response].
/// Parameters:
///

View File

@@ -428,6 +428,8 @@ class ApiClient {
return ServerThemeDto.fromJson(value);
case 'ServerVersionResponseDto':
return ServerVersionResponseDto.fromJson(value);
case 'SetAlbumPermissionDto':
return SetAlbumPermissionDto.fromJson(value);
case 'SharedLinkCreateDto':
return SharedLinkCreateDto.fromJson(value);
case 'SharedLinkEditDto':

View File

@@ -0,0 +1,98 @@
//
// 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 SetAlbumPermissionDto {
/// Returns a new [SetAlbumPermissionDto] instance.
SetAlbumPermissionDto({
required this.readonly,
});
bool readonly;
@override
bool operator ==(Object other) => identical(this, other) || other is SetAlbumPermissionDto &&
other.readonly == readonly;
@override
int get hashCode =>
// ignore: unnecessary_parenthesis
(readonly.hashCode);
@override
String toString() => 'SetAlbumPermissionDto[readonly=$readonly]';
Map<String, dynamic> toJson() {
final json = <String, dynamic>{};
json[r'readonly'] = this.readonly;
return json;
}
/// Returns a new [SetAlbumPermissionDto] instance and imports its values from
/// [value] if it's a [Map], null otherwise.
// ignore: prefer_constructors_over_static_methods
static SetAlbumPermissionDto? fromJson(dynamic value) {
if (value is Map) {
final json = value.cast<String, dynamic>();
return SetAlbumPermissionDto(
readonly: mapValueOfType<bool>(json, r'readonly')!,
);
}
return null;
}
static List<SetAlbumPermissionDto> listFromJson(dynamic json, {bool growable = false,}) {
final result = <SetAlbumPermissionDto>[];
if (json is List && json.isNotEmpty) {
for (final row in json) {
final value = SetAlbumPermissionDto.fromJson(row);
if (value != null) {
result.add(value);
}
}
}
return result.toList(growable: growable);
}
static Map<String, SetAlbumPermissionDto> mapFromJson(dynamic json) {
final map = <String, SetAlbumPermissionDto>{};
if (json is Map && json.isNotEmpty) {
json = json.cast<String, dynamic>(); // ignore: parameter_assignments
for (final entry in json.entries) {
final value = SetAlbumPermissionDto.fromJson(entry.value);
if (value != null) {
map[entry.key] = value;
}
}
}
return map;
}
// maps a json object with a list of SetAlbumPermissionDto-objects as value to a dart map
static Map<String, List<SetAlbumPermissionDto>> mapListFromJson(dynamic json, {bool growable = false,}) {
final map = <String, List<SetAlbumPermissionDto>>{};
if (json is Map && json.isNotEmpty) {
// ignore: parameter_assignments
json = json.cast<String, dynamic>();
for (final entry in json.entries) {
map[entry.key] = SetAlbumPermissionDto.listFromJson(entry.value, growable: growable,);
}
}
return map;
}
/// The list of required keys that must be present in a JSON.
static const requiredKeys = <String>{
'readonly',
};
}

View File

@@ -62,6 +62,11 @@ void main() {
// TODO
});
//Future setAlbumPermission(String id, String userId, SetAlbumPermissionDto setAlbumPermissionDto) async
test('test setAlbumPermission', () async {
// TODO
});
//Future<AlbumResponseDto> updateAlbumInfo(String id, UpdateAlbumDto updateAlbumDto) async
test('test updateAlbumInfo', () async {
// TODO

View File

@@ -0,0 +1,27 @@
//
// 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 SetAlbumPermissionDto
void main() {
// final instance = SetAlbumPermissionDto();
group('test SetAlbumPermissionDto', () {
// bool readonly
test('to test the property `readonly`', () async {
// TODO
});
});
}

View File

@@ -589,6 +589,59 @@
]
}
},
"/album/{id}/permission/{userId}": {
"put": {
"operationId": "setAlbumPermission",
"parameters": [
{
"name": "id",
"required": true,
"in": "path",
"schema": {
"format": "uuid",
"type": "string"
}
},
{
"name": "userId",
"required": true,
"in": "path",
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SetAlbumPermissionDto"
}
}
},
"required": true
},
"responses": {
"200": {
"description": ""
}
},
"security": [
{
"bearer": []
},
{
"cookie": []
},
{
"api_key": []
}
],
"tags": [
"Album"
]
}
},
"/album/{id}/user/{userId}": {
"delete": {
"operationId": "removeUserFromAlbum",
@@ -9914,6 +9967,17 @@
],
"type": "object"
},
"SetAlbumPermissionDto": {
"properties": {
"readonly": {
"type": "boolean"
}
},
"required": [
"readonly"
],
"type": "object"
},
"SharedLinkCreateDto": {
"properties": {
"albumId": {

View File

@@ -193,6 +193,9 @@ export type BulkIdResponseDto = {
id: string;
success: boolean;
};
export type SetAlbumPermissionDto = {
"readonly": boolean;
};
export type AddUsersDto = {
sharedUserIds: string[];
};
@@ -1193,6 +1196,17 @@ export function addAssetsToAlbum({ id, key, bulkIdsDto }: {
body: bulkIdsDto
})));
}
export function setAlbumPermission({ id, userId, setAlbumPermissionDto }: {
id: string;
userId: string;
setAlbumPermissionDto: SetAlbumPermissionDto;
}, opts?: Oazapfts.RequestOpts) {
return oazapfts.ok(oazapfts.fetchText(`/album/${encodeURIComponent(id)}/permission/${encodeURIComponent(userId)}`, oazapfts.json({
...opts,
method: "PUT",
body: setAlbumPermissionDto
})));
}
export function removeUserFromAlbum({ id, userId }: {
id: string;
userId: string;

View File

@@ -7,6 +7,7 @@ import {
AlbumResponseDto,
CreateAlbumDto,
GetAlbumsDto,
SetAlbumPermissionDto,
UpdateAlbumDto,
} from 'src/dtos/album.dto';
import { BulkIdResponseDto, BulkIdsDto } from 'src/dtos/asset-ids.response.dto';
@@ -96,4 +97,14 @@ export class AlbumController {
) {
return this.service.removeUser(auth, id, userId);
}
@Put(':id/permission/:userId')
setAlbumPermission(
@Auth() auth: AuthDto,
@Param() { id }: UUIDParamDto,
@Param('userId', new ParseMeUUIDPipe({ version: '4' })) userId: string,
@Body() dto: SetAlbumPermissionDto,
): Promise<void> {
return this.service.setAlbumPermission(auth, id, userId, dto);
}
}

View File

@@ -83,6 +83,11 @@ export class AlbumCountResponseDto {
notShared!: number;
}
export class SetAlbumPermissionDto {
@ValidateBoolean()
readonly!: boolean;
}
export class AlbumPermissionResponseDto {
user!: UserResponseDto;
readonly!: boolean;

View File

@@ -1,9 +1,10 @@
import { Injectable } from '@nestjs/common';
import { InjectRepository } from '@nestjs/typeorm';
import { Equals } from 'class-validator';
import { AlbumPermissionEntity } from 'src/entities/album-permission.entity';
import { IAlbumPermissionRepository } from 'src/interfaces/album-permission.interface';
import { Instrumentation } from 'src/utils/instrumentation';
import { Repository } from 'typeorm';
import { Equal, Repository } from 'typeorm';
@Instrumentation()
@Injectable()
@@ -16,9 +17,11 @@ export class AlbumPermissionRepository implements IAlbumPermissionRepository {
}
async update(userId: string, albumId: string, dto: Partial<AlbumPermissionEntity>): Promise<AlbumPermissionEntity> {
await this.repository.update({ users: { id: userId }, albums: { id: albumId } }, dto);
// @ts-expect-error I'm pretty sure I messed something up with the entity because
// if I follow what typescript says I get postgres errors
await this.repository.update({ users: userId, albums: albumId }, dto);
return this.repository.findOneOrFail({
where: { users: { id: userId }, albums: { id: albumId } },
where: { users: Equal(userId), albums: Equal(albumId) },
relations: { users: true },
});
}

View File

@@ -264,6 +264,26 @@ export class AlbumService {
await this.albumPermissionRepository.delete(userId, id);
}
async setAlbumPermission(
auth: AuthDto,
id: string,
userId: string,
dto: Partial<AlbumPermissionEntity>,
): Promise<void> {
await this.access.requirePermission(auth, Permission.ALBUM_SHARE, id);
const album = await this.findOrFail(id, { withAssets: false });
const permission = album.albumPermissions.find(({ users: { id } }) => id === userId);
if (!permission) {
throw new BadRequestException('Album not shared with user');
}
console.log(userId, id, dto.readonly);
await this.albumPermissionRepository.update(userId, id, { readonly: dto.readonly });
}
private async findOrFail(id: string, options: AlbumInfoOptions) {
const album = await this.albumRepository.getById(id, options);
if (!album) {

View File

@@ -1,5 +1,5 @@
<script lang="ts">
import { getMyUserInfo, removeUserFromAlbum, type AlbumResponseDto, type UserResponseDto } from '@immich/sdk';
import { getMyUserInfo, removeUserFromAlbum, type AlbumResponseDto, type UserResponseDto, setAlbumPermission } from '@immich/sdk';
import { mdiDotsVertical } from '@mdi/js';
import { createEventDispatcher, onMount } from 'svelte';
import { getContextMenuPosition } from '../../utils/context-menu';
@@ -17,6 +17,7 @@
const dispatch = createEventDispatcher<{
remove: string;
updatePermissions: void
}>();
let currentUser: UserResponseDto;
@@ -63,6 +64,19 @@
selectedRemoveUser = null;
}
};
const handleSetReadonly = async (user: UserResponseDto, readonly: boolean) => {
try {
await setAlbumPermission({ id: album.id, userId: user.id , setAlbumPermissionDto: { readonly } });
const message = readonly ? `Set ${user.name} as viewer` : `Set ${user.name} as editor`;
dispatch('updatePermissions');
notificationController.show({ type: NotificationType.Info, message });
} catch (error) {
handleError(error, 'Unable to set permission');
} finally {
selectedRemoveUser = null;
}
}
</script>
{#if !selectedRemoveUser}
@@ -78,7 +92,7 @@
<p class="text-sm">Owner</p>
</div>
</div>
{#each album.sharedUsers as user}
{#each album.albumPermissions as {user, readonly}}
<div
class="flex w-full place-items-center justify-between gap-4 p-5 transition-colors hover:bg-gray-50 dark:hover:bg-gray-700"
>
@@ -87,7 +101,14 @@
<p class="text-sm font-medium">{user.name}</p>
</div>
<div id="icon-{user.id}" class="flex place-items-center">
<div id="icon-{user.id}" class="flex place-items-center gap-2">
<div>
{#if readonly}
Viewer
{:else}
Editor
{/if}
</div>
{#if isOwned}
<div>
<CircleIconButton
@@ -101,6 +122,11 @@
{#if selectedMenuUser === user}
<ContextMenu {...position} on:outclick={() => (selectedMenuUser = null)}>
{#if readonly}
<MenuOption on:click={() => handleSetReadonly(user, false)} text="Allow edits" />
{:else}
<MenuOption on:click={() => handleSetReadonly(user, true)} text="Disallow edits" />
{/if}
<MenuOption on:click={handleMenuRemove} text="Remove" />
</ContextMenu>
{/if}

View File

@@ -344,6 +344,14 @@
}
};
const handleUpdatePermissions = async () => {
try {
await refreshAlbum();
} catch (error) {
handleError(error, 'Error updating permissions');
}
};
const handleDownloadAlbum = async () => {
await downloadAlbum(album);
};
@@ -695,6 +703,7 @@
onClose={() => (viewMode = ViewMode.VIEW)}
{album}
on:remove={({ detail: userId }) => handleRemoveUser(userId)}
on:updatePermissions={handleUpdatePermissions}
/>
{/if}