High performance self-hosted photo and video management solution.
TypeScript backup-toolfluttergoogle-photosgoogle-photos-alternativejavascriptmobile-appnestjsnodejsphoto-galleryphotosphotos-managementself-hostedsveltesveltekittypescriptvideos
feat(web): Remove from Stack (#19703)
xCJPECKOVERx1a70896113cc
diff --git a/mobile/openapi/README.md b/mobile/openapi/README.mdindex 3e7fa4c2f1..b20a0694c5 100644--- a/mobile/openapi/README.md+++ b/mobile/openapi/README.md@@ -221,6 +221,7 @@ Class | Method | HTTP request | Description*StacksApi* | [**deleteStack**](doc//StacksApi.md#deletestack) | **DELETE** /stacks/{id} |*StacksApi* | [**deleteStacks**](doc//StacksApi.md#deletestacks) | **DELETE** /stacks |*StacksApi* | [**getStack**](doc//StacksApi.md#getstack) | **GET** /stacks/{id} |+*StacksApi* | [**removeAssetFromStack**](doc//StacksApi.md#removeassetfromstack) | **DELETE** /stacks/{id}/assets/{assetId} |*StacksApi* | [**searchStacks**](doc//StacksApi.md#searchstacks) | **GET** /stacks |*StacksApi* | [**updateStack**](doc//StacksApi.md#updatestack) | **PUT** /stacks/{id} |*SyncApi* | [**deleteSyncAck**](doc//SyncApi.md#deletesyncack) | **DELETE** /sync/ack |diff --git a/mobile/openapi/lib/api/stacks_api.dart b/mobile/openapi/lib/api/stacks_api.dartindex 84f23ec55d..6d6c4506be 100644--- a/mobile/openapi/lib/api/stacks_api.dart+++ b/mobile/openapi/lib/api/stacks_api.dart@@ -190,6 +190,51 @@ class StacksApi {return null;}+ /// Performs an HTTP 'DELETE /stacks/{id}/assets/{assetId}' operation and returns the [Response].+ /// Parameters:+ ///+ /// * [String] assetId (required):+ ///+ /// * [String] id (required):+ Future<Response> removeAssetFromStackWithHttpInfo(String assetId, String id,) async {+ // ignore: prefer_const_declarations+ final apiPath = r'/stacks/{id}/assets/{assetId}'+ .replaceAll('{assetId}', assetId)+ .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(+ apiPath,+ 'DELETE',+ queryParams,+ postBody,+ headerParams,+ formParams,+ contentTypes.isEmpty ? null : contentTypes.first,+ );+ }++ /// Parameters:+ ///+ /// * [String] assetId (required):+ ///+ /// * [String] id (required):+ Future<void> removeAssetFromStack(String assetId, String id,) async {+ final response = await removeAssetFromStackWithHttpInfo(assetId, id,);+ if (response.statusCode >= HttpStatus.badRequest) {+ throw ApiException(response.statusCode, await _decodeBodyBytes(response));+ }+ }+/// Performs an HTTP 'GET /stacks' operation and returns the [Response]./// Parameters:///diff --git a/open-api/immich-openapi-specs.json b/open-api/immich-openapi-specs.jsonindex 4acd431203..cd61f3e004 100644--- a/open-api/immich-openapi-specs.json+++ b/open-api/immich-openapi-specs.json@@ -6746,6 +6746,50 @@]}},+ "/stacks/{id}/assets/{assetId}": {+ "delete": {+ "operationId": "removeAssetFromStack",+ "parameters": [+ {+ "name": "assetId",+ "required": true,+ "in": "path",+ "schema": {+ "format": "uuid",+ "type": "string"+ }+ },+ {+ "name": "id",+ "required": true,+ "in": "path",+ "schema": {+ "format": "uuid",+ "type": "string"+ }+ }+ ],+ "responses": {+ "204": {+ "description": ""+ }+ },+ "security": [+ {+ "bearer": []+ },+ {+ "cookie": []+ },+ {+ "api_key": []+ }+ ],+ "tags": [+ "Stacks"+ ]+ }+ },"/sync/ack": {"delete": {"operationId": "deleteSyncAck",diff --git a/open-api/typescript-sdk/src/fetch-client.ts b/open-api/typescript-sdk/src/fetch-client.tsindex d5f7fde52a..81d279407c 100644--- a/open-api/typescript-sdk/src/fetch-client.ts+++ b/open-api/typescript-sdk/src/fetch-client.ts@@ -3373,6 +3373,15 @@ export function updateStack({ id, stackUpdateDto }: {body: stackUpdateDto})));}+export function removeAssetFromStack({ assetId, id }: {+ assetId: string;+ id: string;+}, opts?: Oazapfts.RequestOpts) {+ return oazapfts.ok(oazapfts.fetchText(`/stacks/${encodeURIComponent(id)}/assets/${encodeURIComponent(assetId)}`, {+ ...opts,+ method: "DELETE"+ }));+}export function deleteSyncAck({ syncAckDeleteDto }: {syncAckDeleteDto: SyncAckDeleteDto;}, opts?: Oazapfts.RequestOpts) {diff --git a/server/src/controllers/stack.controller.ts b/server/src/controllers/stack.controller.tsindex 238753734c..5b153a163b 100644--- a/server/src/controllers/stack.controller.ts+++ b/server/src/controllers/stack.controller.ts@@ -6,7 +6,7 @@ import { StackCreateDto, StackResponseDto, StackSearchDto, StackUpdateDto } fromimport { Permission } from 'src/enum';import { Auth, Authenticated } from 'src/middleware/auth.guard';import { StackService } from 'src/services/stack.service';-import { UUIDParamDto } from 'src/validation';+import { UUIDAssetIDParamDto, UUIDParamDto } from 'src/validation';@ApiTags('Stacks')@Controller('stacks')@@ -54,4 +54,11 @@ export class StackController {deleteStack(@Auth() auth: AuthDto, @Param() { id }: UUIDParamDto): Promise<void> {return this.service.delete(auth, id);}++ @Delete(':id/assets/:assetId')+ @Authenticated({ permission: Permission.StackUpdate })+ @HttpCode(HttpStatus.NO_CONTENT)+ removeAssetFromStack(@Auth() auth: AuthDto, @Param() dto: UUIDAssetIDParamDto): Promise<void> {+ return this.service.removeAsset(auth, dto);+ }}diff --git a/server/src/queries/stack.repository.sql b/server/src/queries/stack.repository.sqlindex a256cdfc76..94a24f69e4 100644--- a/server/src/queries/stack.repository.sql+++ b/server/src/queries/stack.repository.sql@@ -143,3 +143,13 @@ from"stack"where"id" = $1::uuid++-- StackRepository.getForAssetRemoval+select+ "stackId" as "id",+ "stack"."primaryAssetId"+from+ "asset"+ left join "stack" on "stack"."id" = "asset"."stackId"+where+ "asset"."id" = $1diff --git a/server/src/repositories/stack.repository.ts b/server/src/repositories/stack.repository.tsindex fe16c8b5eb..ace9468177 100644--- a/server/src/repositories/stack.repository.ts+++ b/server/src/repositories/stack.repository.ts@@ -152,4 +152,14 @@ export class StackRepository {.where('id', '=', asUuid(id)).executeTakeFirst();}++ @GenerateSql({ params: [DummyValue.UUID, DummyValue.UUID] })+ getForAssetRemoval(assetId: string) {+ return this.db+ .selectFrom('asset')+ .leftJoin('stack', 'stack.id', 'asset.stackId')+ .select(['stackId as id', 'stack.primaryAssetId'])+ .where('asset.id', '=', assetId)+ .executeTakeFirst();+ }}diff --git a/server/src/services/stack.service.spec.ts b/server/src/services/stack.service.spec.tsindex 5c7b505cd9..5517cf17f8 100644--- a/server/src/services/stack.service.spec.ts+++ b/server/src/services/stack.service.spec.ts@@ -188,4 +188,53 @@ describe(StackService.name, () => {});});});++ describe('removeAsset', () => {+ it('should require stack.update permissions', async () => {+ await expect(sut.removeAsset(authStub.admin, { id: 'stack-id', assetId: 'asset-id' })).rejects.toBeInstanceOf(+ BadRequestException,+ );++ expect(mocks.stack.getForAssetRemoval).not.toHaveBeenCalled();+ expect(mocks.asset.update).not.toHaveBeenCalled();+ expect(mocks.event.emit).not.toHaveBeenCalled();+ });++ it('should fail if the asset is not in the stack', async () => {+ mocks.access.stack.checkOwnerAccess.mockResolvedValue(new Set(['stack-id']));+ mocks.stack.getForAssetRemoval.mockResolvedValue({ id: null, primaryAssetId: null });++ await expect(+ sut.removeAsset(authStub.admin, { id: 'stack-id', assetId: assetStub.imageFrom2015.id }),+ ).rejects.toBeInstanceOf(BadRequestException);++ expect(mocks.asset.update).not.toHaveBeenCalled();+ expect(mocks.event.emit).not.toHaveBeenCalled();+ });++ it('should fail if the assetId is the primaryAssetId', async () => {+ mocks.access.stack.checkOwnerAccess.mockResolvedValue(new Set(['stack-id']));+ mocks.stack.getForAssetRemoval.mockResolvedValue({ id: 'stack-id', primaryAssetId: assetStub.image.id });++ await expect(+ sut.removeAsset(authStub.admin, { id: 'stack-id', assetId: assetStub.image.id }),+ ).rejects.toBeInstanceOf(BadRequestException);++ expect(mocks.asset.update).not.toHaveBeenCalled();+ expect(mocks.event.emit).not.toHaveBeenCalled();+ });++ it("should update the asset to nullify it's stack-id", async () => {+ mocks.access.stack.checkOwnerAccess.mockResolvedValue(new Set(['stack-id']));+ mocks.stack.getForAssetRemoval.mockResolvedValue({ id: 'stack-id', primaryAssetId: assetStub.image.id });++ await sut.removeAsset(authStub.admin, { id: 'stack-id', assetId: assetStub.image1.id });++ expect(mocks.asset.update).toHaveBeenCalledWith({ id: assetStub.image1.id, stackId: null });+ expect(mocks.event.emit).toHaveBeenCalledWith('StackUpdate', {+ stackId: 'stack-id',+ userId: authStub.admin.user.id,+ });+ });+ });});diff --git a/server/src/services/stack.service.ts b/server/src/services/stack.service.tsindex 18600abd12..c84ec70fbf 100644--- a/server/src/services/stack.service.ts+++ b/server/src/services/stack.service.ts@@ -4,6 +4,7 @@ import { AuthDto } from 'src/dtos/auth.dto';import { StackCreateDto, StackResponseDto, StackSearchDto, StackUpdateDto, mapStack } from 'src/dtos/stack.dto';import { Permission } from 'src/enum';import { BaseService } from 'src/services/base.service';+import { UUIDAssetIDParamDto } from 'src/validation';@Injectable()export class StackService extends BaseService {@@ -58,6 +59,24 @@ export class StackService extends BaseService {await this.eventRepository.emit('StackDeleteAll', { stackIds: dto.ids, userId: auth.user.id });}+ async removeAsset(auth: AuthDto, dto: UUIDAssetIDParamDto): Promise<void> {+ const { id: stackId, assetId } = dto;+ await this.requireAccess({ auth, permission: Permission.StackUpdate, ids: [stackId] });++ const stack = await this.stackRepository.getForAssetRemoval(assetId);++ if (!stack?.id || stack.id !== stackId) {+ throw new BadRequestException('Asset not in stack');+ }++ if (stack.primaryAssetId === assetId) {+ throw new BadRequestException("Cannot remove stack's primary asset");+ }++ await this.assetRepository.update({ id: assetId, stackId: null });+ await this.eventRepository.emit('StackUpdate', { stackId, userId: auth.user.id });+ }+private async findOrFail(id: string) {const stack = await this.stackRepository.getById(id);if (!stack) {diff --git a/server/src/validation.ts b/server/src/validation.tsindex 049b5432d6..3f7e1c6f3b 100644--- a/server/src/validation.ts+++ b/server/src/validation.ts@@ -63,6 +63,22 @@ export class FileNotEmptyValidator extends FileValidator {}}+type UUIDOptions = { optional?: boolean; each?: boolean; nullable?: boolean };+export const ValidateUUID = (options?: UUIDOptions & ApiPropertyOptions) => {+ const { optional, each, nullable, ...apiPropertyOptions } = {+ optional: false,+ each: false,+ nullable: false,+ ...options,+ };+ return applyDecorators(+ IsUUID('4', { each }),+ ApiProperty({ format: 'uuid', ...apiPropertyOptions }),+ optional ? Optional({ nullable }) : IsNotEmpty(),+ each ? IsArray() : IsString(),+ );+};+export class UUIDParamDto {@IsNotEmpty()@IsUUID('4')@@ -70,6 +86,14 @@ export class UUIDParamDto {id!: string;}+export class UUIDAssetIDParamDto {+ @ValidateUUID()+ id!: string;++ @ValidateUUID()+ assetId!: string;+}+type PinCodeOptions = { optional?: boolean } & OptionalOptions;export const PinCode = (options?: PinCodeOptions & ApiPropertyOptions) => {const { optional, nullable, emptyToNull, ...apiPropertyOptions } = {@@ -131,22 +155,6 @@ export const ValidateHexColor = () => {return applyDecorators(...decorators);};-type UUIDOptions = { optional?: boolean; each?: boolean; nullable?: boolean };-export const ValidateUUID = (options?: UUIDOptions & ApiPropertyOptions) => {- const { optional, each, nullable, ...apiPropertyOptions } = {- optional: false,- each: false,- nullable: false,- ...options,- };- return applyDecorators(- IsUUID('4', { each }),- ApiProperty({ format: 'uuid', ...apiPropertyOptions }),- optional ? Optional({ nullable }) : IsNotEmpty(),- each ? IsArray() : IsString(),- );-};-type DateOptions = { optional?: boolean; nullable?: boolean; format?: 'date' | 'date-time' };export const ValidateDate = (options?: DateOptions & ApiPropertyOptions) => {const { optional, nullable, format, ...apiPropertyOptions } = {diff --git a/server/test/fixtures/asset.stub.ts b/server/test/fixtures/asset.stub.tsindex 991c5d2c4f..76cf71d34d 100644--- a/server/test/fixtures/asset.stub.ts+++ b/server/test/fixtures/asset.stub.ts@@ -462,7 +462,7 @@ export const assetStub = {}),imageFrom2015: Object.freeze({- id: 'asset-id-1',+ id: 'asset-id-2015',status: AssetStatus.Active,deviceAssetId: 'device-asset-id',fileModifiedAt: new Date('2015-02-23T05:06:29.716Z'),@@ -484,6 +484,9 @@ export const assetStub = {duration: null,livePhotoVideo: null,livePhotoVideoId: null,+ updateId: 'foo',+ libraryId: null,+ stackId: null,sharedLinks: [],originalFileName: 'asset-id.ext',faces: [],diff --git a/web/src/lib/components/asset-viewer/actions/action.ts b/web/src/lib/components/asset-viewer/actions/action.tsindex d823f17df4..446a004cbb 100644--- a/web/src/lib/components/asset-viewer/actions/action.ts+++ b/web/src/lib/components/asset-viewer/actions/action.ts@@ -1,6 +1,6 @@import type { AssetAction } from '$lib/constants';import type { TimelineAsset } from '$lib/managers/timeline-manager/types';-import type { AlbumResponseDto, StackResponseDto } from '@immich/sdk';+import type { AlbumResponseDto, AssetResponseDto, StackResponseDto } from '@immich/sdk';type ActionMap = {[AssetAction.ARCHIVE]: { asset: TimelineAsset };@@ -15,6 +15,7 @@ type ActionMap = {[AssetAction.UNSTACK]: { assets: TimelineAsset[] };[AssetAction.KEEP_THIS_DELETE_OTHERS]: { asset: TimelineAsset };[AssetAction.SET_STACK_PRIMARY_ASSET]: { stack: StackResponseDto };+ [AssetAction.REMOVE_ASSET_FROM_STACK]: { stack: StackResponseDto | null; asset: AssetResponseDto };[AssetAction.SET_VISIBILITY_LOCKED]: { asset: TimelineAsset };[AssetAction.SET_VISIBILITY_TIMELINE]: { asset: TimelineAsset };};diff --git a/web/src/lib/components/asset-viewer/actions/remove-asset-from-stack.svelte b/web/src/lib/components/asset-viewer/actions/remove-asset-from-stack.sveltenew file mode 100644index 0000000000..0c77f3a1a6--- /dev/null+++ b/web/src/lib/components/asset-viewer/actions/remove-asset-from-stack.svelte@@ -0,0 +1,31 @@+<script lang="ts">+ import MenuOption from '$lib/components/shared-components/context-menu/menu-option.svelte';++ import { AssetAction } from '$lib/constants';+ import { removeAssetFromStack, type AssetResponseDto, type StackResponseDto } from '@immich/sdk';+ import { mdiImageMinusOutline } from '@mdi/js';+ import { t } from 'svelte-i18n';+ import type { OnAction } from './action';++ interface Props {+ asset: AssetResponseDto;+ stack: StackResponseDto;+ onAction: OnAction;+ }++ let { asset, stack, onAction }: Props = $props();++ const handleRemoveFromStack = async () => {+ await removeAssetFromStack({+ id: stack.id,+ assetId: asset.id,+ });+ const updatedStack = {+ ...stack,+ assets: stack.assets.filter((a) => a.id !== asset.id),+ };+ onAction({ type: AssetAction.REMOVE_ASSET_FROM_STACK, stack: updatedStack, asset });+ };+</script>++<MenuOption icon={mdiImageMinusOutline} onClick={handleRemoveFromStack} text={$t('viewer_remove_from_stack')} />diff --git a/web/src/lib/components/asset-viewer/actions/unstack-action.svelte b/web/src/lib/components/asset-viewer/actions/unstack-action.svelteindex 1adeead05f..0c8192a9e3 100644--- a/web/src/lib/components/asset-viewer/actions/unstack-action.svelte+++ b/web/src/lib/components/asset-viewer/actions/unstack-action.svelte@@ -4,7 +4,7 @@import { deleteStack } from '$lib/utils/asset-utils';import { toTimelineAsset } from '$lib/utils/timeline-util';import type { StackResponseDto } from '@immich/sdk';- import { mdiImageMinusOutline } from '@mdi/js';+ import { mdiImageOffOutline } from '@mdi/js';import { t } from 'svelte-i18n';import type { OnAction } from './action';@@ -23,4 +23,4 @@};</script>-<MenuOption icon={mdiImageMinusOutline} onClick={handleUnstack} text={$t('unstack')} />+<MenuOption icon={mdiImageOffOutline} onClick={handleUnstack} text={$t('unstack')} />diff --git a/web/src/lib/components/asset-viewer/asset-viewer-nav-bar.svelte b/web/src/lib/components/asset-viewer/asset-viewer-nav-bar.svelteindex a376c37139..66061ebb01 100644--- a/web/src/lib/components/asset-viewer/asset-viewer-nav-bar.svelte+++ b/web/src/lib/components/asset-viewer/asset-viewer-nav-bar.svelte@@ -9,6 +9,7 @@import DownloadAction from '$lib/components/asset-viewer/actions/download-action.svelte';import FavoriteAction from '$lib/components/asset-viewer/actions/favorite-action.svelte';import KeepThisDeleteOthersAction from '$lib/components/asset-viewer/actions/keep-this-delete-others.svelte';+ import RemoveAssetFromStack from '$lib/components/asset-viewer/actions/remove-asset-from-stack.svelte';import RestoreAction from '$lib/components/asset-viewer/actions/restore-action.svelte';import SetAlbumCoverAction from '$lib/components/asset-viewer/actions/set-album-cover-action.svelte';import SetFeaturedPhotoAction from '$lib/components/asset-viewer/actions/set-person-featured-action.svelte';@@ -195,6 +196,9 @@<KeepThisDeleteOthersAction {stack} {asset} {onAction} />{#if stack?.primaryAssetId !== asset.id}<SetStackPrimaryAsset {stack} {asset} {onAction} />+ {#if stack?.assets?.length > 2}+ <RemoveAssetFromStack {asset} {stack} {onAction} />+ {/if}{/if}{/if}{#if album}diff --git a/web/src/lib/components/asset-viewer/asset-viewer.svelte b/web/src/lib/components/asset-viewer/asset-viewer.svelteindex 4f793e7b52..d82b2e6532 100644--- a/web/src/lib/components/asset-viewer/asset-viewer.svelte+++ b/web/src/lib/components/asset-viewer/asset-viewer.svelte@@ -328,6 +328,13 @@await handleGetAllAlbums();break;}+ case AssetAction.REMOVE_ASSET_FROM_STACK: {+ stack = action.stack;+ if (stack) {+ asset = stack.assets[0];+ }+ break;+ }case AssetAction.SET_STACK_PRIMARY_ASSET: {stack = action.stack;break;diff --git a/web/src/lib/components/photos-page/actions/stack-action.svelte b/web/src/lib/components/photos-page/actions/stack-action.svelteindex 1e817d9e61..8ed3dea22c 100644--- a/web/src/lib/components/photos-page/actions/stack-action.svelte+++ b/web/src/lib/components/photos-page/actions/stack-action.svelte@@ -4,7 +4,7 @@import type { OnStack, OnUnstack } from '$lib/utils/actions';import { deleteStack, stackAssets } from '$lib/utils/asset-utils';import { toTimelineAsset } from '$lib/utils/timeline-util';- import { mdiImageMinusOutline, mdiImageMultipleOutline } from '@mdi/js';+ import { mdiImageMultipleOutline, mdiImageOffOutline } from '@mdi/js';import { t } from 'svelte-i18n';interface Props {@@ -42,7 +42,7 @@</script>{#if unstack}- <MenuOption text={$t('unstack')} icon={mdiImageMinusOutline} onClick={handleUnstack} />+ <MenuOption text={$t('unstack')} icon={mdiImageOffOutline} onClick={handleUnstack} />{:else}<MenuOption text={$t('stack')} icon={mdiImageMultipleOutline} onClick={handleStack} />{/if}diff --git a/web/src/lib/components/photos-page/asset-grid.svelte b/web/src/lib/components/photos-page/asset-grid.svelteindex 2d40857f99..182b24f3eb 100644--- a/web/src/lib/components/photos-page/asset-grid.svelte+++ b/web/src/lib/components/photos-page/asset-grid.svelte@@ -523,6 +523,23 @@updateUnstackedAssetInTimeline(timelineManager, action.assets);break;}+ case AssetAction.REMOVE_ASSET_FROM_STACK: {+ timelineManager.addAssets([toTimelineAsset(action.asset)]);+ if (action.stack) {+ //Have to unstack then restack assets in timeline in order to update the stack count in the timeline.+ updateUnstackedAssetInTimeline(+ timelineManager,+ action.stack.assets.map((asset) => toTimelineAsset(asset)),+ );+ updateStackedAssetInTimeline(timelineManager, {+ stack: action.stack,+ toDeleteIds: action.stack.assets+ .filter((asset) => asset.id !== action.stack?.primaryAssetId)+ .map((asset) => asset.id),+ });+ }+ break;+ }case AssetAction.SET_STACK_PRIMARY_ASSET: {//Have to unstack then restack assets in timeline in order for the currently removed new primary asset to be made visible.updateUnstackedAssetInTimeline(diff --git a/web/src/lib/constants.ts b/web/src/lib/constants.tsindex 1a40f8522e..b354989e17 100644--- a/web/src/lib/constants.ts+++ b/web/src/lib/constants.ts@@ -11,6 +11,7 @@ export enum AssetAction {UNSTACK = 'unstack',KEEP_THIS_DELETE_OTHERS = 'keep-this-delete-others',SET_STACK_PRIMARY_ASSET = 'set-stack-primary-asset',+ REMOVE_ASSET_FROM_STACK = 'remove-asset-from-stack',SET_VISIBILITY_LOCKED = 'set-visibility-locked',SET_VISIBILITY_TIMELINE = 'set-visibility-timeline',}