diff --git a/src/app/features/files/components/confirm-move-file-dialog/confirm-move-file-dialog.component.spec.ts b/src/app/features/files/components/confirm-move-file-dialog/confirm-move-file-dialog.component.spec.ts index 6e91d5349..0a6fa8dd5 100644 --- a/src/app/features/files/components/confirm-move-file-dialog/confirm-move-file-dialog.component.spec.ts +++ b/src/app/features/files/components/confirm-move-file-dialog/confirm-move-file-dialog.component.spec.ts @@ -1,12 +1,9 @@ -import { MockComponents, MockProvider } from 'ng-mocks'; +import { MockProvider } from 'ng-mocks'; import { DynamicDialogConfig } from 'primeng/dynamicdialog'; import { ComponentFixture, TestBed } from '@angular/core/testing'; -import { FileSelectDestinationComponent } from '@osf/shared/components/file-select-destination/file-select-destination.component'; -import { IconComponent } from '@osf/shared/components/icon/icon.component'; -import { LoadingSpinnerComponent } from '@osf/shared/components/loading-spinner/loading-spinner.component'; import { CustomConfirmationService } from '@osf/shared/services/custom-confirmation.service'; import { FilesService } from '@osf/shared/services/files.service'; import { ToastService } from '@osf/shared/services/toast.service'; @@ -14,11 +11,8 @@ import { ToastService } from '@osf/shared/services/toast.service'; import { provideOSFCore } from '@testing/osf.testing.provider'; import { CustomConfirmationServiceMock } from '@testing/providers/custom-confirmation-provider.mock'; import { provideDynamicDialogRefMock } from '@testing/providers/dynamic-dialog-ref.mock'; -import { provideMockStore } from '@testing/providers/store-provider.mock'; import { ToastServiceMock } from '@testing/providers/toast-provider.mock'; -import { FilesSelectors } from '../../store'; - import { ConfirmMoveFileDialogComponent } from './confirm-move-file-dialog.component'; describe('ConfirmConfirmMoveFileDialogComponent', () => { @@ -31,10 +25,7 @@ describe('ConfirmConfirmMoveFileDialogComponent', () => { }; TestBed.configureTestingModule({ - imports: [ - ConfirmMoveFileDialogComponent, - ...MockComponents(IconComponent, LoadingSpinnerComponent, FileSelectDestinationComponent), - ], + imports: [ConfirmMoveFileDialogComponent], providers: [ provideOSFCore(), provideDynamicDialogRefMock(), @@ -42,12 +33,6 @@ describe('ConfirmConfirmMoveFileDialogComponent', () => { MockProvider(FilesService), MockProvider(ToastService, ToastServiceMock.simple()), MockProvider(CustomConfirmationService, CustomConfirmationServiceMock.simple()), - provideMockStore({ - signals: [ - { selector: FilesSelectors.getMoveDialogFiles, value: [] }, - { selector: FilesSelectors.getProvider, value: null }, - ], - }), ], }); @@ -63,10 +48,5 @@ describe('ConfirmConfirmMoveFileDialogComponent', () => { it('should initialize with correct properties', () => { expect(component.config).toBeDefined(); expect(component.dialogRef).toBeDefined(); - expect(component.files).toBeDefined(); - }); - - it('should get files from store', () => { - expect(component.files()).toEqual([]); }); }); diff --git a/src/app/features/files/components/confirm-move-file-dialog/confirm-move-file-dialog.component.ts b/src/app/features/files/components/confirm-move-file-dialog/confirm-move-file-dialog.component.ts index 038478525..2bb6771f8 100644 --- a/src/app/features/files/components/confirm-move-file-dialog/confirm-move-file-dialog.component.ts +++ b/src/app/features/files/components/confirm-move-file-dialog/confirm-move-file-dialog.component.ts @@ -1,5 +1,3 @@ -import { select } from '@ngxs/store'; - import { TranslatePipe, TranslateService } from '@ngx-translate/core'; import { Button } from 'primeng/button'; @@ -11,7 +9,6 @@ import { catchError } from 'rxjs/operators'; import { ChangeDetectionStrategy, Component, DestroyRef, inject } from '@angular/core'; import { takeUntilDestroyed } from '@angular/core/rxjs-interop'; -import { FilesSelectors } from '@osf/features/files/store'; import { CustomConfirmationService } from '@osf/shared/services/custom-confirmation.service'; import { FilesService } from '@osf/shared/services/files.service'; import { ToastService } from '@osf/shared/services/toast.service'; @@ -35,8 +32,6 @@ export class ConfirmMoveFileDialogComponent { private readonly toastService = inject(ToastService); private readonly customConfirmationService = inject(CustomConfirmationService); - readonly files = select(FilesSelectors.getMoveDialogFiles); - readonly provider = this.config.data.storageProvider; private fileProjectId = this.config.data.resourceId; @@ -112,9 +107,7 @@ export class ConfirmMoveFileDialogComponent { this.customConfirmationService.confirmDelete({ headerKey: conflictFiles.length > 1 ? 'files.dialogs.replaceFile.multiple' : 'files.dialogs.replaceFile.single', messageKey: 'files.dialogs.replaceFile.message', - messageParams: { - name: conflictFiles.map((c) => c.file.name).join(', '), - }, + messageParams: { name: conflictFiles.map((c) => c.file.name).join(', ') }, acceptLabelKey: 'common.buttons.replace', onConfirm: () => { const replaceRequests$ = conflictFiles.map(({ link }) => diff --git a/src/app/features/files/components/create-folder-dialog/create-folder-dialog.component.html b/src/app/features/files/components/create-folder-dialog/create-folder-dialog.component.html index 0ca1b259b..6724f0c24 100644 --- a/src/app/features/files/components/create-folder-dialog/create-folder-dialog.component.html +++ b/src/app/features/files/components/create-folder-dialog/create-folder-dialog.component.html @@ -1,10 +1,10 @@
diff --git a/src/app/features/files/components/create-folder-dialog/create-folder-dialog.component.spec.ts b/src/app/features/files/components/create-folder-dialog/create-folder-dialog.component.spec.ts index b68e88ebb..33d0b1d89 100644 --- a/src/app/features/files/components/create-folder-dialog/create-folder-dialog.component.spec.ts +++ b/src/app/features/files/components/create-folder-dialog/create-folder-dialog.component.spec.ts @@ -34,7 +34,7 @@ describe('CreateFolderDialogComponent', () => { }); it('should expose name limits from shared input limits', () => { - expect(component.nameLimit).toBe(InputLimits.name.maxLength); + expect(component.nameMaxLength).toBe(InputLimits.name.maxLength); expect(component.nameMinLength).toBe(InputLimits.name.minLength); }); @@ -46,6 +46,14 @@ describe('CreateFolderDialogComponent', () => { expect(dialogRef.close).not.toHaveBeenCalled(); }); + it('should not close dialog when value is only whitespace', () => { + component.folderForm.controls.name.setValue(' '); + + component.onSubmit(); + + expect(dialogRef.close).not.toHaveBeenCalled(); + }); + it('should close dialog with trimmed folder name when form is valid', () => { component.folderForm.controls.name.setValue(' New Folder '); @@ -69,4 +77,20 @@ describe('CreateFolderDialogComponent', () => { expect(dialogRef.close).not.toHaveBeenCalled(); }); + + it('should not close dialog when value is shorter than minimum length', () => { + component.folderForm.controls.name.setValue('A'.repeat(InputLimits.name.minLength - 1)); + + component.onSubmit(); + + expect(dialogRef.close).not.toHaveBeenCalled(); + }); + + it('should not close dialog when value exceeds maximum length', () => { + component.folderForm.controls.name.setValue('A'.repeat(InputLimits.name.maxLength + 1)); + + component.onSubmit(); + + expect(dialogRef.close).not.toHaveBeenCalled(); + }); }); diff --git a/src/app/features/files/components/create-folder-dialog/create-folder-dialog.component.ts b/src/app/features/files/components/create-folder-dialog/create-folder-dialog.component.ts index 187b46b6d..e2745f1d5 100644 --- a/src/app/features/files/components/create-folder-dialog/create-folder-dialog.component.ts +++ b/src/app/features/files/components/create-folder-dialog/create-folder-dialog.component.ts @@ -4,7 +4,7 @@ import { Button } from 'primeng/button'; import { DynamicDialogRef } from 'primeng/dynamicdialog'; import { Component, inject } from '@angular/core'; -import { FormControl, FormGroup, ReactiveFormsModule } from '@angular/forms'; +import { FormControl, FormGroup, ReactiveFormsModule, Validators } from '@angular/forms'; import { TextInputComponent } from '@osf/shared/components/text-input/text-input.component'; import { forbiddenFileNameCharacters, InputLimits } from '@osf/shared/constants/input-limits.const'; @@ -17,7 +17,8 @@ import { CustomValidators } from '@osf/shared/helpers/custom-form-validators.hel }) export class CreateFolderDialogComponent { readonly dialogRef = inject(DynamicDialogRef); - readonly nameLimit = InputLimits.name.maxLength; + + readonly nameMaxLength = InputLimits.name.maxLength; readonly nameMinLength = InputLimits.name.minLength; readonly folderForm = new FormGroup({ @@ -25,6 +26,8 @@ export class CreateFolderDialogComponent { nonNullable: true, validators: [ CustomValidators.requiredTrimmed(), + Validators.minLength(InputLimits.name.minLength), + Validators.maxLength(InputLimits.name.maxLength), CustomValidators.forbiddenCharactersValidator(forbiddenFileNameCharacters), CustomValidators.noPeriodAtEnd(), ], @@ -37,9 +40,6 @@ export class CreateFolderDialogComponent { } const folderName = this.folderForm.getRawValue().name.trim(); - - if (folderName) { - this.dialogRef.close(folderName); - } + this.dialogRef.close(folderName); } } diff --git a/src/app/features/files/components/edit-file-metadata-dialog/edit-file-metadata-dialog.component.html b/src/app/features/files/components/edit-file-metadata-dialog/edit-file-metadata-dialog.component.html index 6ee17bf54..3e22e96ad 100644 --- a/src/app/features/files/components/edit-file-metadata-dialog/edit-file-metadata-dialog.component.html +++ b/src/app/features/files/components/edit-file-metadata-dialog/edit-file-metadata-dialog.component.html @@ -1,38 +1,40 @@ - +
-

{{ 'common.labels.title' | translate }}

- + +
-

{{ 'common.labels.description' | translate }}

- + +
-

{{ 'files.detail.fileMetadata.fields.resourceType' | translate }}

+
-

{{ 'files.detail.fileMetadata.fields.resourceLanguage' | translate }}

+
- +
diff --git a/src/app/features/files/components/edit-file-metadata-dialog/edit-file-metadata-dialog.component.spec.ts b/src/app/features/files/components/edit-file-metadata-dialog/edit-file-metadata-dialog.component.spec.ts index e63d32474..3b35b662b 100644 --- a/src/app/features/files/components/edit-file-metadata-dialog/edit-file-metadata-dialog.component.spec.ts +++ b/src/app/features/files/components/edit-file-metadata-dialog/edit-file-metadata-dialog.component.spec.ts @@ -2,22 +2,19 @@ import { MockProvider } from 'ng-mocks'; import { DynamicDialogConfig, DynamicDialogRef } from 'primeng/dynamicdialog'; -import { Mocked } from 'vitest'; - import { ComponentFixture, TestBed } from '@angular/core/testing'; -import { OsfFileCustomMetadata } from '@osf/features/files/models'; - import { provideOSFCore } from '@testing/osf.testing.provider'; import { provideDynamicDialogRefMock } from '@testing/providers/dynamic-dialog-ref.mock'; +import { OsfFileCustomMetadata } from '../../models/file-custom-metadata.model'; + import { EditFileMetadataDialogComponent } from './edit-file-metadata-dialog.component'; describe('EditFileMetadataDialogComponent', () => { let component: EditFileMetadataDialogComponent; let fixture: ComponentFixture; let dialogRef: DynamicDialogRef; - let dialogConfig: Mocked; const mockFileMetadata: OsfFileCustomMetadata = { id: '1', @@ -27,8 +24,8 @@ describe('EditFileMetadataDialogComponent', () => { language: 'en', }; - beforeEach(() => { - const dialogConfigMock = { data: mockFileMetadata }; + function setup(data?: Partial) { + const dialogConfigMock: Pick = { data }; TestBed.configureTestingModule({ imports: [EditFileMetadataDialogComponent], @@ -38,29 +35,49 @@ describe('EditFileMetadataDialogComponent', () => { fixture = TestBed.createComponent(EditFileMetadataDialogComponent); component = fixture.componentInstance; dialogRef = TestBed.inject(DynamicDialogRef); - dialogConfig = TestBed.inject(DynamicDialogConfig) as Mocked; fixture.detectChanges(); - }); + } it('should create', () => { + setup(mockFileMetadata); + expect(component).toBeTruthy(); }); - it('should have all required form controls', () => { - expect(component.titleControl).toBeDefined(); - expect(component.descriptionControl).toBeDefined(); - expect(component.resourceTypeControl).toBeDefined(); - expect(component.resourceLanguageControl).toBeDefined(); + it('should initialize form from dialog data', () => { + setup(mockFileMetadata); + + expect(component.fileMetadataForm.controls.title.value).toBe('Test File'); + expect(component.fileMetadataForm.controls.description.value).toBe('Test Description'); + expect(component.fileMetadataForm.controls.resourceType.value).toBe('Dataset'); + expect(component.fileMetadataForm.controls.resourceLanguage.value).toBe('en'); + }); + + it('should set null for empty resource type and language', () => { + setup({ + id: '1', + title: 'Title', + description: 'Description', + resourceTypeGeneral: '', + language: '', + }); + + expect(component.fileMetadataForm.controls.resourceType.value).toBeNull(); + expect(component.fileMetadataForm.controls.resourceLanguage.value).toBeNull(); }); - it('should return correct form controls', () => { - expect(component.titleControl).toBe(component.fileMetadataForm.get('title')); - expect(component.descriptionControl).toBe(component.fileMetadataForm.get('description')); - expect(component.resourceTypeControl).toBe(component.fileMetadataForm.get('resourceType')); - expect(component.resourceLanguageControl).toBe(component.fileMetadataForm.get('resourceLanguage')); + it('should initialize safe defaults when dialog data is missing', () => { + setup(); + + expect(component.fileMetadataForm.controls.title.value).toBeNull(); + expect(component.fileMetadataForm.controls.description.value).toBeNull(); + expect(component.fileMetadataForm.controls.resourceType.value).toBeNull(); + expect(component.fileMetadataForm.controls.resourceLanguage.value).toBeNull(); }); - it('should close dialog with form values when setFileMetadata is called with valid form', () => { + it('should close dialog with mapped form values when form is valid', () => { + setup(mockFileMetadata); + component.setFileMetadata(); expect(dialogRef.close).toHaveBeenCalledWith({ @@ -71,46 +88,41 @@ describe('EditFileMetadataDialogComponent', () => { }); }); - it('should always close dialog when setFileMetadata is called (form has no validators)', () => { - component.titleControl.setValue(''); + it('should map nullable select values to empty strings on submit', () => { + setup(mockFileMetadata); + + component.fileMetadataForm.patchValue({ + title: null, + description: null, + resourceType: null, + resourceLanguage: null, + }); component.setFileMetadata(); - expect(dialogRef.close).toHaveBeenCalled(); + expect(dialogRef.close).toHaveBeenCalledWith({ + title: null, + description: null, + resource_type_general: '', + language: '', + }); }); - it('should close dialog without result when cancel is called', () => { - component.cancel(); + it('should not close dialog when form is invalid', () => { + setup(mockFileMetadata); - expect(dialogRef.close).toHaveBeenCalledWith(); - }); + component.fileMetadataForm.setErrors({ invalid: true }); - it('should handle null values in metadata', () => { - dialogConfig.data = { - title: null, - description: null, - resourceTypeGeneral: [], - language: [], - }; - fixture = TestBed.createComponent(EditFileMetadataDialogComponent); - component = fixture.componentInstance; - fixture.detectChanges(); + component.setFileMetadata(); - expect(component.titleControl.value).toBeNull(); - expect(component.descriptionControl.value).toBeNull(); - expect(component.resourceTypeControl.value).toBeNull(); - expect(component.resourceLanguageControl.value).toBeNull(); + expect(dialogRef.close).not.toHaveBeenCalled(); }); - it('should be valid with default values', () => { - expect(component.fileMetadataForm.valid).toBe(true); - }); + it('should close dialog without payload when cancel is called', () => { + setup(mockFileMetadata); - it('should handle form updates', () => { - component.titleControl.setValue('Updated Title'); - component.descriptionControl.setValue('Updated Description'); + component.cancel(); - expect(component.titleControl.value).toBe('Updated Title'); - expect(component.descriptionControl.value).toBe('Updated Description'); + expect(dialogRef.close).toHaveBeenCalledWith(); }); }); diff --git a/src/app/features/files/components/edit-file-metadata-dialog/edit-file-metadata-dialog.component.ts b/src/app/features/files/components/edit-file-metadata-dialog/edit-file-metadata-dialog.component.ts index b1207e692..968d84679 100644 --- a/src/app/features/files/components/edit-file-metadata-dialog/edit-file-metadata-dialog.component.ts +++ b/src/app/features/files/components/edit-file-metadata-dialog/edit-file-metadata-dialog.component.ts @@ -4,6 +4,7 @@ import { Button } from 'primeng/button'; import { DynamicDialogConfig, DynamicDialogRef } from 'primeng/dynamicdialog'; import { InputText } from 'primeng/inputtext'; import { Select } from 'primeng/select'; +import { Textarea } from 'primeng/textarea'; import { ChangeDetectionStrategy, Component, inject } from '@angular/core'; import { FormControl, FormGroup, ReactiveFormsModule } from '@angular/forms'; @@ -11,11 +12,12 @@ import { FormControl, FormGroup, ReactiveFormsModule } from '@angular/forms'; import { LANGUAGE_CODES } from '@osf/shared/constants/language.const'; import { resourceTypes } from '@osf/shared/constants/resource-types.const'; -import { OsfFileCustomMetadata, PatchFileMetadata } from '../../models'; +import { OsfFileCustomMetadata } from '../../models/file-custom-metadata.model'; +import { PatchFileMetadata } from '../../models/patch-file-metadata.model'; @Component({ selector: 'osf-edit-file-metadata-dialog', - imports: [Button, InputText, Select, ReactiveFormsModule, TranslatePipe], + imports: [Button, InputText, Textarea, Select, ReactiveFormsModule, TranslatePipe], templateUrl: './edit-file-metadata-dialog.component.html', styleUrl: './edit-file-metadata-dialog.component.scss', changeDetection: ChangeDetectionStrategy.OnPush, @@ -27,7 +29,7 @@ export class EditFileMetadataDialogComponent { private readonly dialogRef = inject(DynamicDialogRef); readonly config = inject(DynamicDialogConfig); - fileMetadataForm = new FormGroup({ + readonly fileMetadataForm = new FormGroup({ title: new FormControl(null), description: new FormControl(null), resourceType: new FormControl(null), @@ -35,30 +37,20 @@ export class EditFileMetadataDialogComponent { }); constructor() { - const fileMetadata = this.config.data as OsfFileCustomMetadata; - - this.fileMetadataForm.patchValue({ - title: fileMetadata.title, - description: fileMetadata.description, - resourceType: fileMetadata.resourceTypeGeneral.length ? fileMetadata.resourceTypeGeneral : null, - resourceLanguage: fileMetadata.language.length ? fileMetadata.language : null, - }); - } - - get titleControl(): FormControl { - return this.fileMetadataForm.get('title') as FormControl; + this.initializeForm(); } - get descriptionControl(): FormControl { - return this.fileMetadataForm.get('description') as FormControl; - } - - get resourceTypeControl(): FormControl { - return this.fileMetadataForm.get('resourceType') as FormControl; - } + private initializeForm(): void { + const fileMetadata = this.config.data as Partial | undefined; + const resourceTypeGeneral = fileMetadata?.resourceTypeGeneral ?? ''; + const language = fileMetadata?.language ?? ''; - get resourceLanguageControl(): FormControl { - return this.fileMetadataForm.get('resourceLanguage') as FormControl; + this.fileMetadataForm.patchValue({ + title: fileMetadata?.title ?? null, + description: fileMetadata?.description ?? null, + resourceType: resourceTypeGeneral.length ? resourceTypeGeneral : null, + resourceLanguage: language.length ? language : null, + }); } setFileMetadata() { @@ -66,11 +58,12 @@ export class EditFileMetadataDialogComponent { return; } + const { title, description, resourceType, resourceLanguage } = this.fileMetadataForm.getRawValue(); const formValues: PatchFileMetadata = { - title: this.fileMetadataForm.get('title')?.value ?? null, - description: this.fileMetadataForm.get('description')?.value ?? null, - resource_type_general: this.fileMetadataForm.get('resourceType')?.value ?? '', - language: this.fileMetadataForm.get('resourceLanguage')?.value ?? '', + title: title ?? null, + description: description ?? null, + resource_type_general: resourceType ?? '', + language: resourceLanguage ?? '', }; this.dialogRef.close(formValues); diff --git a/src/app/features/files/components/file-browser-info/file-browser-info.component.html b/src/app/features/files/components/file-browser-info/file-browser-info.component.html index c9fd941c7..f7e045c8b 100644 --- a/src/app/features/files/components/file-browser-info/file-browser-info.component.html +++ b/src/app/features/files/components/file-browser-info/file-browser-info.component.html @@ -1,5 +1,5 @@
- @for (item of filteredInfoItems(); track item.titleKey) { + @for (item of filteredInfoItems; track item.titleKey) {

{{ item.titleKey | translate }}

{{ item.descriptionKey | translate }}

@@ -15,5 +15,5 @@

{{ item.titleKey | translate }}

- +
diff --git a/src/app/features/files/components/file-browser-info/file-browser-info.component.spec.ts b/src/app/features/files/components/file-browser-info/file-browser-info.component.spec.ts index be82ae8c4..f00920808 100644 --- a/src/app/features/files/components/file-browser-info/file-browser-info.component.spec.ts +++ b/src/app/features/files/components/file-browser-info/file-browser-info.component.spec.ts @@ -2,8 +2,6 @@ import { MockProvider } from 'ng-mocks'; import { DynamicDialogConfig, DynamicDialogRef } from 'primeng/dynamicdialog'; -import { Mocked } from 'vitest'; - import { ComponentFixture, TestBed } from '@angular/core/testing'; import { ResourceType } from '@osf/shared/enums/resource-type.enum'; @@ -17,10 +15,9 @@ describe('FileBrowserInfoComponent', () => { let component: FileBrowserInfoComponent; let fixture: ComponentFixture; let dialogRef: DynamicDialogRef; - let dialogConfig: Mocked; - beforeEach(() => { - const dialogConfigMock = { data: ResourceType.Project }; + function setup(resourceType?: ResourceType): void { + const dialogConfigMock: Pick = { data: resourceType }; TestBed.configureTestingModule({ imports: [FileBrowserInfoComponent], @@ -30,34 +27,47 @@ describe('FileBrowserInfoComponent', () => { fixture = TestBed.createComponent(FileBrowserInfoComponent); component = fixture.componentInstance; dialogRef = TestBed.inject(DynamicDialogRef); - dialogConfig = TestBed.inject(DynamicDialogConfig) as Mocked; fixture.detectChanges(); - }); + } it('should create', () => { + setup(ResourceType.Project); + expect(component).toBeTruthy(); }); - it('should initialize with correct properties', () => { - expect(component.dialogRef).toBeDefined(); - expect(component.config).toBeDefined(); - expect(component.infoItems).toBeDefined(); - expect(component.resourceType()).toBe(ResourceType.Project); - }); + it('should set resourceType from dialog config', () => { + setup(ResourceType.Registration); - it('should compute resourceType from config data', () => { - expect(component.resourceType()).toBe(ResourceType.Project); + expect(component.resourceType).toBe(ResourceType.Registration); }); it('should default to Project when config data is undefined', () => { - dialogConfig.data = undefined; - fixture.detectChanges(); + setup(); - expect(component.resourceType()).toBe(ResourceType.Project); + expect(component.resourceType).toBe(ResourceType.Project); + }); + + it('should filter items for project resource type', () => { + setup(ResourceType.Project); + + expect(component.filteredInfoItems.length).toBe(component.infoItems.length); + }); + + it('should filter items for registration resource type', () => { + setup(ResourceType.Registration); + + expect(component.filteredInfoItems.length).toBeLessThan(component.infoItems.length); + expect( + component.filteredInfoItems.every((item) => item.showForResourceTypes.includes(ResourceType.Registration)) + ).toBe(true); }); it('should close dialog when close method is called', () => { + setup(ResourceType.Project); + component.dialogRef.close(); + expect(dialogRef.close).toHaveBeenCalled(); }); }); diff --git a/src/app/features/files/components/file-browser-info/file-browser-info.component.ts b/src/app/features/files/components/file-browser-info/file-browser-info.component.ts index 7110c2873..c628fbe70 100644 --- a/src/app/features/files/components/file-browser-info/file-browser-info.component.ts +++ b/src/app/features/files/components/file-browser-info/file-browser-info.component.ts @@ -3,7 +3,7 @@ import { TranslatePipe } from '@ngx-translate/core'; import { Button } from 'primeng/button'; import { DynamicDialogConfig, DynamicDialogRef } from 'primeng/dynamicdialog'; -import { ChangeDetectionStrategy, Component, computed, inject } from '@angular/core'; +import { ChangeDetectionStrategy, Component, inject } from '@angular/core'; import { ResourceType } from '@osf/shared/enums/resource-type.enum'; @@ -20,11 +20,9 @@ export class FileBrowserInfoComponent { readonly dialogRef = inject(DynamicDialogRef); readonly config = inject(DynamicDialogConfig); - readonly resourceType = computed(() => (this.config.data as ResourceType) || ResourceType.Project); + readonly resourceType = (this.config.data as ResourceType) ?? ResourceType.Project; readonly infoItems = FILE_BROWSER_INFO_ITEMS; - readonly filteredInfoItems = computed(() => { - return this.infoItems.filter((item) => item.showForResourceTypes.includes(this.resourceType())); - }); + readonly filteredInfoItems = this.infoItems.filter((item) => item.showForResourceTypes.includes(this.resourceType)); } diff --git a/src/app/features/files/components/file-keywords/file-keywords.component.html b/src/app/features/files/components/file-keywords/file-keywords.component.html index 9cf9943d1..05f9ea0be 100644 --- a/src/app/features/files/components/file-keywords/file-keywords.component.html +++ b/src/app/features/files/components/file-keywords/file-keywords.component.html @@ -1,26 +1,25 @@

{{ 'files.detail.keywords.title' | translate }}

- @if (!hasViewOnly() && hasWriteAccess()) { + @if (canManageTags()) {
- + />
} @if (!isTagsLoading()) {
- @for (tag of tags(); track $index) { + @for (tag of tags(); track tag) { } @empty { diff --git a/src/app/features/files/components/file-keywords/file-keywords.component.spec.ts b/src/app/features/files/components/file-keywords/file-keywords.component.spec.ts index 4daf81e0e..8db5bd9be 100644 --- a/src/app/features/files/components/file-keywords/file-keywords.component.spec.ts +++ b/src/app/features/files/components/file-keywords/file-keywords.component.spec.ts @@ -1,88 +1,129 @@ -import { signal } from '@angular/core'; +import { Store } from '@ngxs/store'; + +import { MockProvider } from 'ng-mocks'; + +import { Mock } from 'vitest'; + import { ComponentFixture, TestBed } from '@angular/core/testing'; +import { ViewOnlyLinkHelperService } from '@osf/shared/services/view-only-link-helper.service'; + +import { FileDetailsMock } from '@testing/mocks/file-details.mock'; import { provideOSFCore } from '@testing/osf.testing.provider'; -import { provideMockStore } from '@testing/providers/store-provider.mock'; +import { BaseSetupOverrides, mergeSignalOverrides, provideMockStore } from '@testing/providers/store-provider.mock'; +import { ViewOnlyLinkHelperMock } from '@testing/providers/view-only-link-helper.mock'; import { FilesSelectors } from '../../store'; +import { UpdateTags } from '../../store/files.actions'; import { FileKeywordsComponent } from './file-keywords.component'; describe('FileKeywordsComponent', () => { let component: FileKeywordsComponent; let fixture: ComponentFixture; + let store: Store; - const mockFile = { + const mockFile = FileDetailsMock.simple({ guid: 'test-guid', name: 'test-file.txt', - }; + }); const mockTags = ['tag1', 'tag2', 'tag3']; - beforeEach(() => { + interface SetupOverrides extends BaseSetupOverrides { + hasViewOnly?: boolean; + } + + function setup(overrides: SetupOverrides = {}) { + const viewOnlyServiceMock = ViewOnlyLinkHelperMock.simple(overrides.hasViewOnly ?? false); + const defaultSignals = [ + { selector: FilesSelectors.getFileTags, value: mockTags }, + { selector: FilesSelectors.isFileTagsLoading, value: false }, + { selector: FilesSelectors.getOpenedFile, value: mockFile }, + { selector: FilesSelectors.hasWriteAccess, value: true }, + ]; + TestBed.configureTestingModule({ imports: [FileKeywordsComponent], providers: [ provideOSFCore(), - provideMockStore({ - signals: [ - { selector: FilesSelectors.getFileTags, value: signal(mockTags) }, - { selector: FilesSelectors.isFileTagsLoading, value: signal(false) }, - { selector: FilesSelectors.getOpenedFile, value: signal(mockFile) }, - { selector: FilesSelectors.hasWriteAccess, value: signal(true) }, - ], - }), + MockProvider(ViewOnlyLinkHelperService, viewOnlyServiceMock), + provideMockStore({ signals: mergeSignalOverrides(defaultSignals, overrides.selectorOverrides) }), ], }); fixture = TestBed.createComponent(FileKeywordsComponent); component = fixture.componentInstance; + store = TestBed.inject(Store); fixture.detectChanges(); - }); + } it('should create', () => { + setup(); + expect(component).toBeTruthy(); }); - it('should initialize with correct properties', () => { - expect(component.tags).toBeDefined(); - expect(component.isTagsLoading).toBeDefined(); - expect(component.file).toBeDefined(); - expect(component.hasWriteAccess).toBeDefined(); - expect(component.keywordControl).toBeDefined(); + it('should expose tag edit permissions for editable state', () => { + setup(); + + expect(component.canManageTags()).toBe(true); + expect(component.canEditTags()).toBe(true); }); - it('should initialize keyword control with empty value', () => { - expect(component.keywordControl.value).toBe(''); + it('should disable editing when loading', () => { + setup({ + selectorOverrides: [{ selector: FilesSelectors.isFileTagsLoading, value: true }], + }); + + expect(component.canEditTags()).toBe(false); + expect(component.keywordControl.disabled).toBe(true); }); - it('should validate keyword control', () => { - component.keywordControl.setValue('valid-keyword'); - expect(component.keywordControl.valid).toBe(true); + it('should disable editing for view only mode', () => { + setup({ hasViewOnly: true }); + + expect(component.canManageTags()).toBe(false); + expect(component.canEditTags()).toBe(false); }); - it('should be invalid when keyword is empty', () => { - component.keywordControl.setValue(''); - expect(component.keywordControl.invalid).toBe(true); + it('should dispatch update with trimmed tag on add', () => { + setup(); + (store.dispatch as Mock).mockClear(); + component.keywordControl.setValue(' new-tag '); + + component.addTag(); + + expect(store.dispatch).toHaveBeenCalledWith(new UpdateTags(['tag1', 'tag2', 'tag3', 'new-tag'], 'test-guid')); + expect(component.keywordControl.value).toBe(''); }); - it('should be invalid when keyword is only whitespace', () => { + it('should not dispatch update when add input is invalid', () => { + setup(); + (store.dispatch as Mock).mockClear(); component.keywordControl.setValue(' '); - expect(component.keywordControl.invalid).toBe(true); - }); - it('should not add tag when keyword is empty', () => { - component.keywordControl.setValue(''); + component.addTag(); - expect(() => component.addTag()).not.toThrow(); + expect(store.dispatch).not.toHaveBeenCalled(); }); - it('should delete tag when deleteTag is called', () => { - expect(() => component.deleteTag('tag1')).not.toThrow(); + it('should dispatch update when removing existing tag', () => { + setup(); + (store.dispatch as Mock).mockClear(); + + component.deleteTag('tag2'); + + expect(store.dispatch).toHaveBeenCalledWith(new UpdateTags(['tag1', 'tag3'], 'test-guid')); + expect(component.keywordControl.value).toBe(''); }); - it('should compute hasViewOnly based on router', () => { - expect(component.hasViewOnly).toBeDefined(); - expect(typeof component.hasViewOnly()).toBe('boolean'); + it('should not dispatch update when tag is missing', () => { + setup(); + (store.dispatch as Mock).mockClear(); + + component.deleteTag('missing-tag'); + + expect(store.dispatch).not.toHaveBeenCalled(); }); }); diff --git a/src/app/features/files/components/file-keywords/file-keywords.component.ts b/src/app/features/files/components/file-keywords/file-keywords.component.ts index 16ee1996d..c537c0c90 100644 --- a/src/app/features/files/components/file-keywords/file-keywords.component.ts +++ b/src/app/features/files/components/file-keywords/file-keywords.component.ts @@ -7,7 +7,7 @@ import { Chip } from 'primeng/chip'; import { InputText } from 'primeng/inputtext'; import { Skeleton } from 'primeng/skeleton'; -import { ChangeDetectionStrategy, Component, computed, DestroyRef, inject } from '@angular/core'; +import { ChangeDetectionStrategy, Component, computed, DestroyRef, effect, inject } from '@angular/core'; import { takeUntilDestroyed } from '@angular/core/rxjs-interop'; import { FormControl, ReactiveFormsModule, Validators } from '@angular/forms'; import { Router } from '@angular/router'; @@ -37,30 +37,51 @@ export class FileKeywordsComponent { readonly file = select(FilesSelectors.getOpenedFile); readonly hasWriteAccess = select(FilesSelectors.hasWriteAccess); - readonly hasViewOnly = computed(() => this.viewOnlyService.hasViewOnlyParam(this.router)); + readonly canManageTags = computed(() => !this.viewOnlyService.hasViewOnlyParam(this.router) && this.hasWriteAccess()); + readonly canEditTags = computed(() => this.canManageTags() && !this.isTagsLoading()); keywordControl = new FormControl('', { nonNullable: true, validators: [CustomValidators.requiredTrimmed(), Validators.maxLength(InputLimits.name.maxLength)], }); + constructor() { + effect(() => { + if (this.isTagsLoading()) { + this.keywordControl.disable({ emitEvent: false }); + } else { + this.keywordControl.enable({ emitEvent: false }); + } + }); + } + addTag(): void { const fileGuid = this.file()?.guid; - if (this.keywordControl.value && fileGuid) { - const updatedTags = [...this.tags(), this.keywordControl.value!]; - this.updateTags(updatedTags, fileGuid); + if (!this.canEditTags() || this.keywordControl.invalid || !fileGuid) { + return; } + + const updatedTags = [...this.tags(), this.keywordControl.value.trim()]; + this.updateTags(updatedTags, fileGuid); } deleteTag(value: string): void { const fileGuid = this.file()?.guid; - if (fileGuid) { - const updatedTags = [...this.tags()]; - updatedTags.splice(updatedTags.indexOf(value), 1); - this.updateTags(updatedTags, fileGuid); + if (!this.canEditTags() || !fileGuid) { + return; } + + const updatedTags = [...this.tags()]; + const tagIndex = updatedTags.indexOf(value); + + if (tagIndex < 0) { + return; + } + + updatedTags.splice(tagIndex, 1); + this.updateTags(updatedTags, fileGuid); } private updateTags(updatedTags: string[], fileGuid: string) { diff --git a/src/app/features/files/components/file-metadata/file-metadata.component.spec.ts b/src/app/features/files/components/file-metadata/file-metadata.component.spec.ts index 3a3452604..589e539f5 100644 --- a/src/app/features/files/components/file-metadata/file-metadata.component.spec.ts +++ b/src/app/features/files/components/file-metadata/file-metadata.component.spec.ts @@ -13,7 +13,7 @@ import { RouterMockBuilder } from '@testing/providers/router-provider.mock'; import { provideMockStore } from '@testing/providers/store-provider.mock'; import { FileMetadataFields } from '../../constants'; -import { PatchFileMetadata } from '../../models'; +import { PatchFileMetadata } from '../../models/patch-file-metadata.model'; import { FilesSelectors } from '../../store'; import { FileMetadataComponent } from './file-metadata.component'; diff --git a/src/app/features/files/components/file-metadata/file-metadata.component.ts b/src/app/features/files/components/file-metadata/file-metadata.component.ts index 3838dc86a..394f43147 100644 --- a/src/app/features/files/components/file-metadata/file-metadata.component.ts +++ b/src/app/features/files/components/file-metadata/file-metadata.component.ts @@ -18,7 +18,7 @@ import { ViewOnlyLinkHelperService } from '@osf/shared/services/view-only-link-h import { LanguageCodeModel } from '@shared/models/language-code.model'; import { FileMetadataFields } from '../../constants'; -import { PatchFileMetadata } from '../../models'; +import { PatchFileMetadata } from '../../models/patch-file-metadata.model'; import { FilesSelectors, SetFileMetadata } from '../../store'; import { EditFileMetadataDialogComponent } from '../edit-file-metadata-dialog/edit-file-metadata-dialog.component'; diff --git a/src/app/features/files/components/file-resource-metadata/file-resource-metadata.component.html b/src/app/features/files/components/file-resource-metadata/file-resource-metadata.component.html index 640ad07d4..541f7af8c 100644 --- a/src/app/features/files/components/file-resource-metadata/file-resource-metadata.component.html +++ b/src/app/features/files/components/file-resource-metadata/file-resource-metadata.component.html @@ -1,3 +1,6 @@ +@let metadata = resourceMetadata(); +@let resourceContributors = contributors(); +

{{ 'files.detail.resourceMetadata.title.' + resourceType() | translate }} @@ -9,7 +12,7 @@

} @else { - @for (funder of resourceMetadata()?.funders; track $index) { + @for (funder of metadata?.funders; track funder.funderIdentifier || $index) {
@if (funder.funderName) {
@@ -23,10 +26,10 @@

{{ 'files.detail.resourceMetadata.fields.awardTitle' | translate }}

{{ funder.awardTitle }}
} - @if (funder.awardTitle) { + @if (funder.awardNumber) {

{{ 'files.detail.resourceMetadata.fields.awardNumber' | translate }}

- {{ funder.awardTitle }} + {{ funder.awardNumber }}
} @if (funder.awardUri) { @@ -41,55 +44,55 @@

{{ 'files.detail.resourceMetadata.fields.awardUri' | translate }}

{{ 'common.labels.title' | translate }}

- {{ resourceMetadata()?.title }} + {{ metadata?.title }}
- @if (resourceMetadata()?.description) { + @if (metadata?.description) {

{{ 'common.labels.description' | translate }}

- {{ resourceMetadata()?.description }} + {{ metadata?.description }}
} - @if (resourceMetadata()?.resourceTypeGeneral) { + @if (metadata?.resourceTypeGeneral) {

{{ 'files.detail.resourceMetadata.fields.resourceType' | translate }}

- {{ resourceMetadata()?.resourceTypeGeneral }} + {{ metadata?.resourceTypeGeneral }}
} - @if (resourceMetadata()?.language) { + @if (metadata?.language) {

{{ 'files.detail.resourceMetadata.fields.resourceLanguage' | translate }}

- {{ resourceMetadata()?.language }} + {{ metadata?.language }}
} - @if (resourceMetadata()?.dateCreated) { + @if (metadata?.dateCreated) {

{{ 'common.labels.dateCreated' | translate }}

- {{ resourceMetadata()?.dateCreated | date: 'MMMM d, y' }} + {{ metadata?.dateCreated | date: 'MMMM d, y' }}
} - @if (resourceMetadata()?.dateModified) { + @if (metadata?.dateModified) {

{{ 'common.labels.dateModified' | translate }}

- {{ resourceMetadata()?.dateModified | date: 'MMMM d, y' }} + {{ metadata?.dateModified | date: 'MMMM d, y' }}
} @@ -98,11 +101,11 @@

{{ 'common.labels.dateModified' | translate }}

@if (isResourceContributorsLoading()) { } @else { - @if (hasViewOnly() || contributors().length) { + @if (resourceContributors.length) {

{{ 'common.labels.contributors' | translate }}

- +
} } diff --git a/src/app/features/files/components/file-resource-metadata/file-resource-metadata.component.spec.ts b/src/app/features/files/components/file-resource-metadata/file-resource-metadata.component.spec.ts index ca1e80388..fffe0f5b0 100644 --- a/src/app/features/files/components/file-resource-metadata/file-resource-metadata.component.spec.ts +++ b/src/app/features/files/components/file-resource-metadata/file-resource-metadata.component.spec.ts @@ -4,112 +4,130 @@ import { ComponentFixture, TestBed } from '@angular/core/testing'; import { Router } from '@angular/router'; import { ContributorsListComponent } from '@osf/shared/components/contributors-list/contributors-list.component'; +import { ResourceMetadata } from '@osf/shared/models/resource-metadata.model'; +import { ViewOnlyLinkHelperService } from '@osf/shared/services/view-only-link-helper.service'; +import { MOCK_CONTRIBUTOR, MOCK_CONTRIBUTOR_WITHOUT_HISTORY } from '@testing/mocks/contributors.mock'; import { provideOSFCore } from '@testing/osf.testing.provider'; -import { RouterMockBuilder } from '@testing/providers/router-provider.mock'; -import { provideMockStore } from '@testing/providers/store-provider.mock'; +import { RouterMockBuilder, RouterMockType } from '@testing/providers/router-provider.mock'; +import { BaseSetupOverrides, mergeSignalOverrides, provideMockStore } from '@testing/providers/store-provider.mock'; +import { ViewOnlyLinkHelperMock, ViewOnlyLinkHelperMockType } from '@testing/providers/view-only-link-helper.mock'; import { FilesSelectors } from '../../store'; import { FileResourceMetadataComponent } from './file-resource-metadata.component'; +interface SetupOverrides extends BaseSetupOverrides { + hasViewOnly?: boolean; +} + describe('FileResourceMetadataComponent', () => { let component: FileResourceMetadataComponent; let fixture: ComponentFixture; - let mockRouter: ReturnType; + let mockRouter: RouterMockType; + let viewOnlyService: ViewOnlyLinkHelperMockType; - const mockResourceMetadata = { - id: 'resource-123', + const mockResourceMetadata: ResourceMetadata = { title: 'Test Resource', description: 'Test Description', - dateCreated: '2023-01-01', - dateModified: '2023-01-02', + dateCreated: new Date('2023-01-01'), + dateModified: new Date('2023-01-02'), + language: 'en', + resourceTypeGeneral: 'Dataset', + identifiers: [], + funders: [], }; - const mockContributors = [ - { id: 'contrib-1', name: 'John Doe', role: 'Author' }, - { id: 'contrib-2', name: 'Jane Smith', role: 'Contributor' }, + const mockContributors = [MOCK_CONTRIBUTOR, MOCK_CONTRIBUTOR_WITHOUT_HISTORY]; + + const defaultSignals = [ + { selector: FilesSelectors.getResourceMetadata, value: mockResourceMetadata }, + { selector: FilesSelectors.getContributors, value: mockContributors }, + { selector: FilesSelectors.isResourceMetadataLoading, value: false }, + { selector: FilesSelectors.isResourceContributorsLoading, value: false }, ]; - beforeEach(() => { + function setup(overrides: SetupOverrides = {}): void { mockRouter = RouterMockBuilder.create().withUrl('/test').build(); + viewOnlyService = ViewOnlyLinkHelperMock.simple(overrides.hasViewOnly ?? false); TestBed.configureTestingModule({ imports: [FileResourceMetadataComponent, MockComponent(ContributorsListComponent)], providers: [ provideOSFCore(), MockProvider(Router, mockRouter), - provideMockStore({ - signals: [ - { selector: FilesSelectors.getResourceMetadata, value: mockResourceMetadata }, - { selector: FilesSelectors.getContributors, value: mockContributors }, - { selector: FilesSelectors.isResourceMetadataLoading, value: false }, - { selector: FilesSelectors.isResourceContributorsLoading, value: false }, - ], - }), + MockProvider(ViewOnlyLinkHelperService, viewOnlyService), + provideMockStore({ signals: mergeSignalOverrides(defaultSignals, overrides.selectorOverrides) }), ], }); fixture = TestBed.createComponent(FileResourceMetadataComponent); component = fixture.componentInstance; fixture.detectChanges(); - }); + } it('should create', () => { - expect(component).toBeTruthy(); - }); + setup(); - it('should initialize with correct properties', () => { - expect(component.resourceType).toBeDefined(); - expect(component.resourceMetadata).toBeDefined(); - expect(component.contributors).toBeDefined(); - expect(component.isResourceMetadataLoading).toBeDefined(); - expect(component.isResourceContributorsLoading).toBeDefined(); - expect(component.hasViewOnly).toBeDefined(); + expect(component).toBeTruthy(); }); it('should have default resource type', () => { + setup(); + expect(component.resourceType()).toBe('nodes'); }); it('should get resource metadata from store', () => { + setup(); + expect(component.resourceMetadata()).toEqual(mockResourceMetadata); }); it('should get contributors from store', () => { + setup(); + expect(component.contributors()).toEqual(mockContributors); }); - it('should get resource metadata loading state from store', () => { - expect(component.isResourceMetadataLoading()).toBe(false); - }); + it('should expose loading states from store selectors', () => { + setup({ + selectorOverrides: [ + { selector: FilesSelectors.isResourceMetadataLoading, value: true }, + { selector: FilesSelectors.isResourceContributorsLoading, value: true }, + ], + }); - it('should get contributors loading state from store', () => { - expect(component.isResourceContributorsLoading()).toBe(false); + expect(component.isResourceMetadataLoading()).toBe(true); + expect(component.isResourceContributorsLoading()).toBe(true); }); - it('should have hasViewOnly computed property', () => { - expect(component.hasViewOnly).toBeDefined(); - expect(typeof component.hasViewOnly()).toBe('boolean'); + it('should set hasViewOnly based on helper service', () => { + setup({ hasViewOnly: true }); + + expect(component.hasViewOnly).toBe(true); + expect(viewOnlyService.hasViewOnlyParam).toHaveBeenCalled(); + expect(viewOnlyService.hasViewOnlyParam).toHaveBeenCalledWith(expect.objectContaining({ url: '/test' })); }); it('should handle input changes', () => { + setup(); + fixture.componentRef.setInput('resourceType', 'preprints'); fixture.detectChanges(); expect(component.resourceType()).toBe('preprints'); }); - it('should handle null resource metadata', () => { - expect(component.resourceMetadata).toBeDefined(); - }); - - it('should handle empty contributors array', () => { - expect(component.contributors).toBeDefined(); - }); + it('should support missing metadata and empty contributors', () => { + setup({ + selectorOverrides: [ + { selector: FilesSelectors.getResourceMetadata, value: null }, + { selector: FilesSelectors.getContributors, value: [] }, + ], + }); - it('should handle loading states', () => { - expect(component.isResourceMetadataLoading).toBeDefined(); - expect(component.isResourceContributorsLoading).toBeDefined(); + expect(component.resourceMetadata()).toBeNull(); + expect(component.contributors()).toEqual([]); }); }); diff --git a/src/app/features/files/components/file-resource-metadata/file-resource-metadata.component.ts b/src/app/features/files/components/file-resource-metadata/file-resource-metadata.component.ts index 8a684a5da..6a56cc300 100644 --- a/src/app/features/files/components/file-resource-metadata/file-resource-metadata.component.ts +++ b/src/app/features/files/components/file-resource-metadata/file-resource-metadata.component.ts @@ -5,7 +5,7 @@ import { TranslatePipe } from '@ngx-translate/core'; import { Skeleton } from 'primeng/skeleton'; import { DatePipe } from '@angular/common'; -import { ChangeDetectionStrategy, Component, computed, inject, input } from '@angular/core'; +import { ChangeDetectionStrategy, Component, inject, input } from '@angular/core'; import { Router } from '@angular/router'; import { ContributorsListComponent } from '@osf/shared/components/contributors-list/contributors-list.component'; @@ -31,5 +31,5 @@ export class FileResourceMetadataComponent { isResourceMetadataLoading = select(FilesSelectors.isResourceMetadataLoading); isResourceContributorsLoading = select(FilesSelectors.isResourceContributorsLoading); - hasViewOnly = computed(() => this.viewOnlyService.hasViewOnlyParam(this.router)); + hasViewOnly = this.viewOnlyService.hasViewOnlyParam(this.router); } diff --git a/src/app/features/files/components/file-revisions/file-revisions.component.html b/src/app/features/files/components/file-revisions/file-revisions.component.html index 36788aba5..f6c04dd6a 100644 --- a/src/app/features/files/components/file-revisions/file-revisions.component.html +++ b/src/app/features/files/components/file-revisions/file-revisions.component.html @@ -1,7 +1,5 @@
-
-

{{ 'files.detail.revisions.title' | translate }}

-
+

{{ 'files.detail.revisions.title' | translate }}

@if (isLoading()) { diff --git a/src/app/features/files/components/file-revisions/file-revisions.component.spec.ts b/src/app/features/files/components/file-revisions/file-revisions.component.spec.ts index 94dbbb6c0..a55dd90b7 100644 --- a/src/app/features/files/components/file-revisions/file-revisions.component.spec.ts +++ b/src/app/features/files/components/file-revisions/file-revisions.component.spec.ts @@ -8,11 +8,27 @@ import { StopPropagationDirective } from '@osf/shared/directives/stop-propagatio import { provideOSFCore } from '@testing/osf.testing.provider'; +import { OsfFileRevision } from '../../models/file-revisions.model'; + import { FileRevisionsComponent } from './file-revisions.component'; describe('FileRevisionsComponent', () => { let component: FileRevisionsComponent; let fixture: ComponentFixture; + const revisions: OsfFileRevision[] = [ + { + version: '1', + dateTime: new Date('2026-01-01T00:00:00Z'), + downloads: 2, + hashes: { md5: 'md5-1', sha256: 'sha256-1' }, + }, + { + version: '2', + dateTime: new Date('2026-01-02T00:00:00Z'), + downloads: 4, + hashes: { md5: 'md5-2', sha256: 'sha256-2' }, + }, + ]; beforeEach(() => { TestBed.configureTestingModule({ @@ -33,82 +49,50 @@ describe('FileRevisionsComponent', () => { expect(component).toBeTruthy(); }); - it('should initialize with default values', () => { + it('should initialize with default inputs', () => { expect(component.fileRevisions()).toBeUndefined(); expect(component.isLoading()).toBe(false); }); - it('should handle loading state input', () => { - fixture.componentRef.setInput('isLoading', true); + it('should update file revisions input', () => { + fixture.componentRef.setInput('fileRevisions', revisions); fixture.detectChanges(); - expect(component.isLoading()).toBe(true); + expect(component.fileRevisions()).toEqual(revisions); }); - it('should emit openRevision event when onOpenRevision is called', () => { - const openRevisionSpy = vi.spyOn(component.openRevision, 'emit'); - - component.onOpenRevision('1'); - - expect(openRevisionSpy).toHaveBeenCalledWith('1'); - }); - - it('should emit downloadRevision event when onDownloadRevision is called', () => { - const downloadRevisionSpy = vi.spyOn(component.downloadRevision, 'emit'); - - component.onDownloadRevision('2'); + it('should support null file revisions input', () => { + fixture.componentRef.setInput('fileRevisions', null); + fixture.detectChanges(); - expect(downloadRevisionSpy).toHaveBeenCalledWith('2'); + expect(component.fileRevisions()).toBeNull(); }); - it('should handle empty file revisions array', () => { - fixture.componentRef.setInput('fileRevisions', []); + it('should handle loading state changes', () => { + fixture.componentRef.setInput('isLoading', true); fixture.detectChanges(); - expect(component.fileRevisions()).toEqual([]); - }); + expect(component.isLoading()).toBe(true); - it('should handle null file revisions', () => { - fixture.componentRef.setInput('fileRevisions', null); + fixture.componentRef.setInput('isLoading', false); fixture.detectChanges(); - expect(component.fileRevisions()).toBeNull(); - }); - - it('should have all required outputs defined', () => { - expect(component.downloadRevision).toBeDefined(); - expect(component.openRevision).toBeDefined(); + expect(component.isLoading()).toBe(false); }); - it('should handle multiple revision events', () => { + it('should emit open revision event', () => { const openRevisionSpy = vi.spyOn(component.openRevision, 'emit'); - const downloadRevisionSpy = vi.spyOn(component.downloadRevision, 'emit'); component.onOpenRevision('1'); - component.onDownloadRevision('1'); - component.onOpenRevision('2'); - component.onDownloadRevision('2'); - expect(openRevisionSpy).toHaveBeenCalledTimes(2); expect(openRevisionSpy).toHaveBeenCalledWith('1'); - expect(openRevisionSpy).toHaveBeenCalledWith('2'); - - expect(downloadRevisionSpy).toHaveBeenCalledTimes(2); - expect(downloadRevisionSpy).toHaveBeenCalledWith('1'); - expect(downloadRevisionSpy).toHaveBeenCalledWith('2'); }); - it('should handle loading state changes', () => { - expect(component.isLoading()).toBe(false); - - fixture.componentRef.setInput('isLoading', true); - fixture.detectChanges(); - - expect(component.isLoading()).toBe(true); + it('should emit download revision event', () => { + const downloadRevisionSpy = vi.spyOn(component.downloadRevision, 'emit'); - fixture.componentRef.setInput('isLoading', false); - fixture.detectChanges(); + component.onDownloadRevision('2'); - expect(component.isLoading()).toBe(false); + expect(downloadRevisionSpy).toHaveBeenCalledWith('2'); }); }); diff --git a/src/app/features/files/components/file-revisions/file-revisions.component.ts b/src/app/features/files/components/file-revisions/file-revisions.component.ts index a360dd71e..fcb0a8d9b 100644 --- a/src/app/features/files/components/file-revisions/file-revisions.component.ts +++ b/src/app/features/files/components/file-revisions/file-revisions.component.ts @@ -11,7 +11,7 @@ import { CopyButtonComponent } from '@osf/shared/components/copy-button/copy-but import { InfoIconComponent } from '@osf/shared/components/info-icon/info-icon.component'; import { StopPropagationDirective } from '@osf/shared/directives/stop-propagation.directive'; -import { OsfFileRevision } from '../../models'; +import { OsfFileRevision } from '../../models/file-revisions.model'; @Component({ selector: 'osf-file-revisions', diff --git a/src/app/features/files/components/files-selection-actions/files-selection-actions.component.html b/src/app/features/files/components/files-selection-actions/files-selection-actions.component.html index a5c2a5ffc..c29b33428 100644 --- a/src/app/features/files/components/files-selection-actions/files-selection-actions.component.html +++ b/src/app/features/files/components/files-selection-actions/files-selection-actions.component.html @@ -1,8 +1,8 @@ -@if (selectedFiles().length > 0) { +@if (selectedFilesCount() > 0) {
- {{ selectedFiles().length }} {{ 'files.selectedFiles' | translate }} + {{ selectedFilesCount() }} {{ 'files.selectedFiles' | translate }} { expect(component).toBeTruthy(); }); - it('should initialize with default values', () => { - expect(component.selectedFiles()).toEqual([]); + it('should initialize with default inputs', () => { + expect(component.selectedFilesCount()).toBe(0); expect(component.canUpdateFiles()).toBe(true); expect(component.hasViewOnly()).toBe(false); }); - it('should handle canUpdateFiles input', () => { + it('should update selected files count input', () => { + fixture.componentRef.setInput('selectedFilesCount', 3); + fixture.detectChanges(); + + expect(component.selectedFilesCount()).toBe(3); + }); + + it('should update canUpdateFiles input', () => { fixture.componentRef.setInput('canUpdateFiles', false); fixture.detectChanges(); expect(component.canUpdateFiles()).toBe(false); }); - it('should handle hasViewOnly input', () => { + it('should update hasViewOnly input', () => { fixture.componentRef.setInput('hasViewOnly', true); fixture.detectChanges(); expect(component.hasViewOnly()).toBe(true); }); - it('should emit copySelected event', () => { + it('should emit copySelected output', () => { const copySelectedSpy = vi.spyOn(component.copySelected, 'emit'); component.copySelected.emit(); @@ -51,7 +58,7 @@ describe('FilesSelectionActionsComponent', () => { expect(copySelectedSpy).toHaveBeenCalled(); }); - it('should emit moveSelected event', () => { + it('should emit moveSelected output', () => { const moveSelectedSpy = vi.spyOn(component.moveSelected, 'emit'); component.moveSelected.emit(); @@ -59,7 +66,7 @@ describe('FilesSelectionActionsComponent', () => { expect(moveSelectedSpy).toHaveBeenCalled(); }); - it('should emit deleteSelected event', () => { + it('should emit deleteSelected output', () => { const deleteSelectedSpy = vi.spyOn(component.deleteSelected, 'emit'); component.deleteSelected.emit(); @@ -67,25 +74,11 @@ describe('FilesSelectionActionsComponent', () => { expect(deleteSelectedSpy).toHaveBeenCalled(); }); - it('should emit clearSelection event', () => { + it('should emit clearSelection output', () => { const clearSelectionSpy = vi.spyOn(component.clearSelection, 'emit'); component.clearSelection.emit(); expect(clearSelectionSpy).toHaveBeenCalled(); }); - - it('should have all required outputs defined', () => { - expect(component.copySelected).toBeDefined(); - expect(component.moveSelected).toBeDefined(); - expect(component.deleteSelected).toBeDefined(); - expect(component.clearSelection).toBeDefined(); - }); - - it('should handle empty selected files array', () => { - fixture.componentRef.setInput('selectedFiles', []); - fixture.detectChanges(); - - expect(component.selectedFiles()).toEqual([]); - }); }); diff --git a/src/app/features/files/components/files-selection-actions/files-selection-actions.component.ts b/src/app/features/files/components/files-selection-actions/files-selection-actions.component.ts index 8077aa3f3..54f281165 100644 --- a/src/app/features/files/components/files-selection-actions/files-selection-actions.component.ts +++ b/src/app/features/files/components/files-selection-actions/files-selection-actions.component.ts @@ -4,8 +4,6 @@ import { Button } from 'primeng/button'; import { ChangeDetectionStrategy, Component, input, output } from '@angular/core'; -import { FileModel } from '@osf/shared/models/files/file.model'; - @Component({ selector: 'osf-files-selection-actions', imports: [Button, TranslatePipe], @@ -14,7 +12,7 @@ import { FileModel } from '@osf/shared/models/files/file.model'; changeDetection: ChangeDetectionStrategy.OnPush, }) export class FilesSelectionActionsComponent { - selectedFiles = input([]); + selectedFilesCount = input(0); canUpdateFiles = input(true); hasViewOnly = input(false); copySelected = output(); diff --git a/src/app/features/files/components/rename-file-dialog/rename-file-dialog.component.html b/src/app/features/files/components/rename-file-dialog/rename-file-dialog.component.html index b052e04d4..ff4dd52e5 100644 --- a/src/app/features/files/components/rename-file-dialog/rename-file-dialog.component.html +++ b/src/app/features/files/components/rename-file-dialog/rename-file-dialog.component.html @@ -1,7 +1,7 @@
{ let component: RenameFileDialogComponent; let fixture: ComponentFixture; let dialogRef: DynamicDialogRef; - let dialogConfig: Mocked; + let dialogConfig: DynamicDialogConfig; beforeEach(() => { const dialogConfigMock = { @@ -33,7 +31,7 @@ describe('RenameFileDialogComponent', () => { fixture = TestBed.createComponent(RenameFileDialogComponent); component = fixture.componentInstance; dialogRef = TestBed.inject(DynamicDialogRef); - dialogConfig = TestBed.inject(DynamicDialogConfig) as Mocked; + dialogConfig = TestBed.inject(DynamicDialogConfig); fixture.detectChanges(); }); @@ -48,38 +46,44 @@ describe('RenameFileDialogComponent', () => { }); it('should initialize form with current name from config', () => { - const nameControl = component.renameForm.get('name'); - expect(nameControl?.value).toBe('test-file.txt'); + expect(component.renameForm.controls.name.value).toBe('test-file.txt'); }); it('should be invalid when name is empty', () => { - const nameControl = component.renameForm.get('name'); - nameControl?.setValue(''); - expect(nameControl?.hasError('required')).toBe(true); + component.renameForm.controls.name.setValue(''); + expect(component.renameForm.controls.name.hasError('required')).toBe(true); expect(component.renameForm.invalid).toBe(true); }); it('should be invalid when name contains forbidden characters', () => { - const nameControl = component.renameForm.get('name'); - nameControl?.setValue('file@name'); - expect(nameControl?.hasError('forbiddenCharacters')).toBe(true); + component.renameForm.controls.name.setValue('file/name'); + expect(component.renameForm.controls.name.hasError('forbiddenCharacters')).toBe(true); }); it('should be invalid when name ends with period', () => { - const nameControl = component.renameForm.get('name'); - nameControl?.setValue('filename.'); - expect(nameControl?.hasError('periodAtEnd')).toBe(true); + component.renameForm.controls.name.setValue('filename.'); + expect(component.renameForm.controls.name.hasError('periodAtEnd')).toBe(true); + }); + + it('should be invalid when name is shorter than min length', () => { + component.renameForm.controls.name.setValue('A'.repeat(InputLimits.title.minLength - 1)); + + expect(component.renameForm.controls.name.hasError('minlength')).toBe(true); + }); + + it('should be invalid when name exceeds max length', () => { + component.renameForm.controls.name.setValue('A'.repeat(InputLimits.title.maxLength + 1)); + + expect(component.renameForm.controls.name.hasError('maxlength')).toBe(true); }); it('should be valid when name passes all validations', () => { - const nameControl = component.renameForm.get('name'); - nameControl?.setValue('valid-filename'); + component.renameForm.controls.name.setValue('valid-filename'); expect(component.renameForm.valid).toBe(true); }); - it('should close dialog with new name when onSubmit is called with valid form', () => { - const nameControl = component.renameForm.get('name'); - nameControl?.setValue('new-filename.txt'); + it('should close dialog with trimmed name when onSubmit is called with valid form', () => { + component.renameForm.controls.name.setValue(' new-filename.txt '); component.onSubmit(); @@ -87,8 +91,7 @@ describe('RenameFileDialogComponent', () => { }); it('should not close dialog when onSubmit is called with invalid form', () => { - const nameControl = component.renameForm.get('name'); - nameControl?.setValue(''); + component.renameForm.controls.name.setValue(''); component.onSubmit(); @@ -101,19 +104,12 @@ describe('RenameFileDialogComponent', () => { expect(dialogRef.close).toHaveBeenCalledWith(); }); - it('should have name control with correct validators', () => { - const nameControl = component.renameForm.get('name'); - expect(nameControl).toBeDefined(); - expect(nameControl?.hasError('required')).toBe(false); - }); - it('should handle empty config data', () => { dialogConfig.data = undefined; fixture = TestBed.createComponent(RenameFileDialogComponent); component = fixture.componentInstance; fixture.detectChanges(); - const nameControl = component.renameForm.get('name'); - expect(nameControl?.value).toBe(''); + expect(component.renameForm.controls.name.value).toBe(''); }); }); diff --git a/src/app/features/files/components/rename-file-dialog/rename-file-dialog.component.ts b/src/app/features/files/components/rename-file-dialog/rename-file-dialog.component.ts index a32b53f3c..423a4022b 100644 --- a/src/app/features/files/components/rename-file-dialog/rename-file-dialog.component.ts +++ b/src/app/features/files/components/rename-file-dialog/rename-file-dialog.component.ts @@ -4,7 +4,7 @@ import { Button } from 'primeng/button'; import { DynamicDialogConfig, DynamicDialogRef } from 'primeng/dynamicdialog'; import { ChangeDetectionStrategy, Component, inject } from '@angular/core'; -import { FormControl, FormGroup, ReactiveFormsModule } from '@angular/forms'; +import { FormControl, FormGroup, ReactiveFormsModule, Validators } from '@angular/forms'; import { TextInputComponent } from '@osf/shared/components/text-input/text-input.component'; import { forbiddenFileNameCharacters, InputLimits } from '@osf/shared/constants/input-limits.const'; @@ -28,6 +28,8 @@ export class RenameFileDialogComponent { nonNullable: true, validators: [ CustomValidators.requiredTrimmed(), + Validators.minLength(InputLimits.title.minLength), + Validators.maxLength(InputLimits.title.maxLength), CustomValidators.forbiddenCharactersValidator(forbiddenFileNameCharacters), CustomValidators.noPeriodAtEnd(), ], @@ -36,7 +38,7 @@ export class RenameFileDialogComponent { onSubmit(): void { if (this.renameForm.valid) { - const newName = this.renameForm.getRawValue().name; + const newName = this.renameForm.getRawValue().name.trim(); this.dialogRef.close(newName); } } diff --git a/src/app/features/files/constants/file-browser-info.constants.ts b/src/app/features/files/constants/file-browser-info.constants.ts index 9e0c95ec0..1de435ecb 100644 --- a/src/app/features/files/constants/file-browser-info.constants.ts +++ b/src/app/features/files/constants/file-browser-info.constants.ts @@ -1,6 +1,6 @@ import { ResourceType } from '@osf/shared/enums/resource-type.enum'; -import { FileInfoItem } from '../models'; +import { FileInfoItem } from '../models/info-item.model'; export const FILE_BROWSER_INFO_ITEMS: FileInfoItem[] = [ { diff --git a/src/app/features/files/constants/file-metadata-fields.constants.ts b/src/app/features/files/constants/file-metadata-fields.constants.ts index d67123b6a..e2c4e5a6f 100644 --- a/src/app/features/files/constants/file-metadata-fields.constants.ts +++ b/src/app/features/files/constants/file-metadata-fields.constants.ts @@ -1,4 +1,4 @@ -import { MetadataField } from '../models'; +import { MetadataField } from '../models/files-metadata-fields.model'; export const FileMetadataFields: MetadataField[] = [ { key: 'title', label: 'common.labels.title' }, diff --git a/src/app/features/files/constants/index.ts b/src/app/features/files/constants/index.ts index af9827638..bed8ae58c 100644 --- a/src/app/features/files/constants/index.ts +++ b/src/app/features/files/constants/index.ts @@ -1,4 +1,3 @@ -export * from './embed-content.constants'; export * from './file-browser-info.constants'; export * from './file-metadata-fields.constants'; export * from './file-provider.constants'; diff --git a/src/app/features/files/files.routes.ts b/src/app/features/files/files.routes.ts index 8b4cb2b77..9f53d2c08 100644 --- a/src/app/features/files/files.routes.ts +++ b/src/app/features/files/files.routes.ts @@ -29,11 +29,8 @@ export const filesRoutes: Routes = [ { path: ':fileGuid', data: { canonicalPathTemplate: 'files/:fileGuid' }, - loadComponent: () => { - return import('@osf/features/files/pages/file-detail/file-detail.component').then( - (c) => c.FileDetailComponent - ); - }, + loadComponent: () => + import('@osf/features/files/pages/file-detail/file-detail.component').then((c) => c.FileDetailComponent), }, ], }, diff --git a/src/app/features/files/mappers/file-custom-metadata.mapper.ts b/src/app/features/files/mappers/file-custom-metadata.mapper.ts index 3af893193..1292bd004 100644 --- a/src/app/features/files/mappers/file-custom-metadata.mapper.ts +++ b/src/app/features/files/mappers/file-custom-metadata.mapper.ts @@ -1,7 +1,8 @@ import { ApiData } from '@osf/shared/models/common/json-api.model'; import { replaceBadEncodedChars } from '@shared/helpers/format-bad-encoding.helper'; -import { FileCustomMetadata, OsfFileCustomMetadata } from '../models'; +import { OsfFileCustomMetadata } from '../models/file-custom-metadata.model'; +import { FileCustomMetadata } from '../models/get-file-metadata-response.model'; export function MapFileCustomMetadata(data: ApiData): OsfFileCustomMetadata { return { diff --git a/src/app/features/files/mappers/file-menu-actions.mapper.ts b/src/app/features/files/mappers/file-menu-actions.mapper.ts new file mode 100644 index 000000000..186a2b39d --- /dev/null +++ b/src/app/features/files/mappers/file-menu-actions.mapper.ts @@ -0,0 +1,17 @@ +import { SupportedFeature } from '@osf/shared/enums/addon-supported-features.enum'; +import { FileMenuType } from '@osf/shared/enums/file-menu-type.enum'; + +export function mapMenuActions(supportedFeatures: SupportedFeature[]): Record { + return { + [FileMenuType.Download]: supportedFeatures.includes(SupportedFeature.DownloadAsZip), + [FileMenuType.Rename]: supportedFeatures.includes(SupportedFeature.AddUpdateFiles), + [FileMenuType.Delete]: supportedFeatures.includes(SupportedFeature.DeleteFiles), + [FileMenuType.Move]: + supportedFeatures.includes(SupportedFeature.CopyInto) && + supportedFeatures.includes(SupportedFeature.DeleteFiles) && + supportedFeatures.includes(SupportedFeature.AddUpdateFiles), + [FileMenuType.Embed]: true, + [FileMenuType.Share]: true, + [FileMenuType.Copy]: true, + }; +} diff --git a/src/app/features/files/mappers/file-revision.mapper.ts b/src/app/features/files/mappers/file-revision.mapper.ts index 19046d20f..34c6b08a4 100644 --- a/src/app/features/files/mappers/file-revision.mapper.ts +++ b/src/app/features/files/mappers/file-revision.mapper.ts @@ -1,10 +1,11 @@ import { ApiData } from '@osf/shared/models/common/json-api.model'; -import { FileRevisionJsonApi, OsfFileRevision } from '../models'; +import { OsfFileRevision } from '../models/file-revisions.model'; +import { FileRevisionJsonApi } from '../models/get-file-revisions-response.model'; export function MapFileRevision(data: ApiData[]): OsfFileRevision[] { const revision = data.map((revision) => ({ - downloads: revision.attributes.extra.downloads, + downloads: revision.attributes.extra.downloads ?? 0, hashes: { md5: revision.attributes.extra.hashes?.md5, sha256: revision.attributes.extra.hashes?.sha256 }, dateTime: new Date(revision.attributes.modified_utc), version: revision.attributes.version, diff --git a/src/app/features/files/models/file-revisions.model.ts b/src/app/features/files/models/file-revisions.model.ts index 84148c1d7..9bb41e509 100644 --- a/src/app/features/files/models/file-revisions.model.ts +++ b/src/app/features/files/models/file-revisions.model.ts @@ -1,5 +1,5 @@ export interface OsfFileRevision { - downloads: 0; + downloads: number; hashes: { md5: string; sha256: string; diff --git a/src/app/features/files/models/files-actions-options.model.ts b/src/app/features/files/models/files-actions-options.model.ts new file mode 100644 index 000000000..cfe735208 --- /dev/null +++ b/src/app/features/files/models/files-actions-options.model.ts @@ -0,0 +1,24 @@ +import { Observable } from 'rxjs'; + +import { FileModel } from '@shared/models/files/file.model'; +import { FileFolderModel } from '@shared/models/files/file-folder.model'; + +export interface DeleteSelectedOptions { + files: FileModel[]; + deleteEntry: (link: string) => Observable; + onSuccess: () => void; +} + +export interface MoveFilesOptions { + files: FileModel[]; + action: 'move' | 'copy'; + resourceId: string; + storageProvider: string; + foldersStack: FileFolderModel[]; + initialFolder: FileFolderModel | null | undefined; +} + +export interface CreateFolderOptions { + newFolderLink: string; + createFolder: (newFolderLink: string, folderName: string) => Observable; +} diff --git a/src/app/features/files/models/files-upload-options.model.ts b/src/app/features/files/models/files-upload-options.model.ts new file mode 100644 index 000000000..94b3eccd8 --- /dev/null +++ b/src/app/features/files/models/files-upload-options.model.ts @@ -0,0 +1,16 @@ +import { FileLinkModel } from '@osf/shared/models/files/file-link.model'; + +export interface UploadFilesOptions { + files: File | File[]; + uploadLink: string; + allowRevisions: boolean; + onStart: (fileName: string) => void; + onProgress: (progress: number) => void; + onComplete: () => void; +} + +export interface UploadState { + completedUploads: number; + totalFiles: number; + conflictFiles: FileLinkModel[]; +} diff --git a/src/app/features/files/models/get-file-revisions-response.model.ts b/src/app/features/files/models/get-file-revisions-response.model.ts index 1491314c3..04de4bc59 100644 --- a/src/app/features/files/models/get-file-revisions-response.model.ts +++ b/src/app/features/files/models/get-file-revisions-response.model.ts @@ -2,7 +2,7 @@ import { ApiData, JsonApiResponse } from '@osf/shared/models/common/json-api.mod export interface FileRevisionJsonApi { extra: { - downloads: 0; + downloads: number; hashes: { md5: string; sha256: string; diff --git a/src/app/features/files/models/index.ts b/src/app/features/files/models/index.ts deleted file mode 100644 index 29d50dfc6..000000000 --- a/src/app/features/files/models/index.ts +++ /dev/null @@ -1,9 +0,0 @@ -export * from './file-custom-metadata.model'; -export * from './file-revisions.model'; -export * from './files-metadata-fields.model'; -export * from './get-custom-metadata-response.model'; -export * from './get-file-metadata-response.model'; -export * from './get-file-revisions-response.model'; -export * from './get-short-info-response.model'; -export * from './info-item.model'; -export * from './patch-file-metadata.model'; diff --git a/src/app/features/files/pages/file-detail/file-detail.component.html b/src/app/features/files/pages/file-detail/file-detail.component.html index fc44a06e3..1e72e92f0 100644 --- a/src/app/features/files/pages/file-detail/file-detail.component.html +++ b/src/app/features/files/pages/file-detail/file-detail.component.html @@ -1,9 +1,6 @@ - +@let currentFile = file(); + + @@ -13,7 +10,7 @@ -
+
@@ -23,7 +20,7 @@
- @if (!isAnonymous() && !hasViewOnly() && hasWriteAccess()) { + @if (canManageFileActions()) { } - @if (file()?.links?.download) { + @if (currentFile?.links?.download) { } - @if (file()?.links?.render) { + @if (currentFile?.links?.render) {
@@ -57,7 +54,7 @@
} - @if (file()?.links?.html) { + @if (currentFile?.links?.html) {
} - @if (showDeleteButton()) { + @if (canManageFileActions()) { }
@@ -121,7 +118,7 @@ } @else {
{ }); it('should call dataciteService.logIdentifiableDownload when downloadFile is triggered', () => { - const link = '123'; - component.downloadFile(link); + component.downloadFile(); expect(dataciteService.logIdentifiableDownload).toHaveBeenCalledWith(component.fileMetadata$); }); diff --git a/src/app/features/files/pages/file-detail/file-detail.component.ts b/src/app/features/files/pages/file-detail/file-detail.component.ts index 84f1108e8..b0d90e8bf 100644 --- a/src/app/features/files/pages/file-detail/file-detail.component.ts +++ b/src/app/features/files/pages/file-detail/file-detail.component.ts @@ -1,15 +1,13 @@ import { createDispatchMap, select, Store } from '@ngxs/store'; -import { TranslatePipe } from '@ngx-translate/core'; +import { TranslatePipe, TranslateService } from '@ngx-translate/core'; import { Button } from 'primeng/button'; import { Menu } from 'primeng/menu'; -import { TableModule } from 'primeng/table'; import { Tab, TabList, Tabs } from 'primeng/tabs'; import { switchMap } from 'rxjs'; -import { Clipboard } from '@angular/cdk/clipboard'; import { ChangeDetectionStrategy, Component, @@ -19,14 +17,12 @@ import { HostBinding, inject, OnDestroy, - OnInit, signal, } from '@angular/core'; import { takeUntilDestroyed, toObservable } from '@angular/core/rxjs-interop'; import { DomSanitizer, SafeResourceUrl } from '@angular/platform-browser'; import { ActivatedRoute, Router, RouterLink } from '@angular/router'; -import { ENVIRONMENT } from '@core/provider/environment.provider'; import { CedarMetadataDataTemplateJsonApi, CedarMetadataRecordData, @@ -44,14 +40,16 @@ import { MetadataTabsComponent } from '@osf/shared/components/metadata-tabs/meta import { SubHeaderComponent } from '@osf/shared/components/sub-header/sub-header.component'; import { MetadataResourceEnum } from '@osf/shared/enums/metadata-resource.enum'; import { ResourceType } from '@osf/shared/enums/resource-type.enum'; +import { getMfrUrlWithVersion } from '@osf/shared/helpers/mfr-url.helper'; import { CustomConfirmationService } from '@osf/shared/services/custom-confirmation.service'; import { DataciteService } from '@osf/shared/services/datacite/datacite.service'; +import { FilesShareEmbedService } from '@osf/shared/services/files-share-embed.service'; import { MetaTagsService } from '@osf/shared/services/meta-tags.service'; import { MetaTagsBuilderService } from '@osf/shared/services/meta-tags-builder.service'; import { SignpostingService } from '@osf/shared/services/signposting.service'; +import { SocialShareService } from '@osf/shared/services/social-share.service'; import { ToastService } from '@osf/shared/services/toast.service'; import { ViewOnlyLinkHelperService } from '@osf/shared/services/view-only-link-helper.service'; -import { FileDetailsModel } from '@shared/models/files/file.model'; import { MetadataTabsModel } from '@shared/models/metadata-tabs.model'; import { @@ -60,7 +58,6 @@ import { FileResourceMetadataComponent, FileRevisionsComponent, } from '../../components'; -import { embedDynamicJs, embedStaticHtml } from '../../constants'; import { FileDetailTab } from '../../enums'; import { DeleteEntry, @@ -89,13 +86,12 @@ import { FileMetadataComponent, FileResourceMetadataComponent, MetadataTabsComponent, - TableModule, ], templateUrl: './file-detail.component.html', styleUrl: './file-detail.component.scss', changeDetection: ChangeDetectionStrategy.OnPush, }) -export class FileDetailComponent implements OnInit, OnDestroy { +export class FileDetailComponent implements OnDestroy { @HostBinding('class') classes = 'flex flex-column flex-1 w-full h-full'; readonly store = inject(Store); @@ -109,11 +105,11 @@ export class FileDetailComponent implements OnInit, OnDestroy { private readonly metaTags = inject(MetaTagsService); private readonly metaTagsBuilder = inject(MetaTagsBuilderService); private readonly viewOnlyService = inject(ViewOnlyLinkHelperService); - private readonly environment = inject(ENVIRONMENT); - private readonly clipboard = inject(Clipboard); + private readonly socialShareService = inject(SocialShareService); + private readonly filesShareEmbedService = inject(FilesShareEmbedService); private readonly signpostingService = inject(SignpostingService); - - readonly dataciteService = inject(DataciteService); + private readonly translateService = inject(TranslateService); + private readonly dataciteService = inject(DataciteService); private readonly actions = createDispatchMap({ getFile: GetFile, @@ -137,7 +133,6 @@ export class FileDetailComponent implements OnInit, OnDestroy { isAnonymous = select(FilesSelectors.isFilesAnonymous); fileCustomMetadata = select(FilesSelectors.getFileCustomMetadata); isFileCustomMetadataLoading = select(FilesSelectors.isFileMetadataLoading); - resourceMetadata = select(FilesSelectors.getResourceMetadata); resourceContributors = select(FilesSelectors.getContributors); isResourceContributorsLoading = select(FilesSelectors.isResourceContributorsLoading); fileRevisions = select(FilesSelectors.getFileRevisions); @@ -154,7 +149,7 @@ export class FileDetailComponent implements OnInit, OnDestroy { readonly FileDetailTab = FileDetailTab; - selectedTab: FileDetailTab = FileDetailTab.Details; + selectedTab = FileDetailTab.Details; fileGuid = ''; fileVersion = ''; @@ -187,15 +182,19 @@ export class FileDetailComponent implements OnInit, OnDestroy { tabs = signal([]); - isLoading = computed(() => this.isFileLoading()); - selectedMetadataTab = signal('osf'); selectedCedarRecord = signal(null); selectedCedarTemplate = signal(null); cedarFormReadonly = signal(true); - showDeleteButton = computed(() => this.hasWriteAccess() && this.file() && !this.isAnonymous() && !this.hasViewOnly()); + canManageFileActions = computed(() => !this.isAnonymous() && !this.hasViewOnly() && this.hasWriteAccess()); + + readonly headerTitle = computed(() => { + const fileName = this.file()?.name ?? ''; + if (!this.fileVersion) return fileName; + return `${fileName} (${this.translateService.instant('project.wiki.version.title')} ${this.fileVersion})`; + }); private readonly metaTagsData = computed(() => { if (this.isFileLoading() || this.isFileCustomMetadataLoading() || this.isResourceContributorsLoading()) { @@ -214,67 +213,10 @@ export class FileDetailComponent implements OnInit, OnDestroy { }); constructor() { - this.route.params - .pipe( - takeUntilDestroyed(this.destroyRef), - switchMap((params) => { - this.fileGuid = params['fileGuid']; - return this.actions.getFile(this.fileGuid); - }) - ) - .subscribe(() => { - this.getIframeLink(''); - const file = this.file(); - if (file) { - this.resourceId = file.target.id || ''; - this.resourceType = file.target.type || ''; - const cedarUrl = file.links.info; - if (this.resourceId && this.resourceType) { - this.actions.getFileResourceMetadata(this.resourceId, this.resourceType); - this.actions.getFileResourceContributors(this.resourceId, this.resourceType); - - const storageLink = file.links.upload || ''; - this.actions.getFileRevisions(storageLink); - this.actions.getCedarTemplates(); - if (cedarUrl) { - this.actions.getCedarRecords(this.resourceId, ResourceType.File, cedarUrl); - } - } - } - }); - - effect(() => { - const records = this.cedarRecords(); - - const baseTabs = [{ id: 'osf', label: 'OSF', type: MetadataResourceEnum.PROJECT }]; - - const cedarTabs = - records?.map((record) => ({ - id: record.id || '', - label: record.embeds?.template?.data?.attributes?.schema_name || `Record ${record.id}`, - type: MetadataResourceEnum.CEDAR, - })) || []; - - this.tabs.set([...baseTabs, ...cedarTabs]); - }); - - this.route.params.pipe(takeUntilDestroyed(this.destroyRef)).subscribe((params) => { - this.actions.getFileMetadata(params['fileGuid']); - }); - - effect(() => { - const metaTagsData = this.metaTagsData(); - - if (metaTagsData) { - this.metaTags.updateMetaTags(metaTagsData, this.destroyRef); - } - }); - - this.dataciteService.logIdentifiableView(this.fileMetadata$).pipe(takeUntilDestroyed(this.destroyRef)).subscribe(); - } - - ngOnInit(): void { - this.signpostingService.addSignposting(this.fileGuid); + this.initRouteSync(); + this.initTabsEffect(); + this.initMetaTagsEffect(); + this.initIdentifiableViewTracking(); } ngOnDestroy(): void { @@ -284,7 +226,9 @@ export class FileDetailComponent implements OnInit, OnDestroy { } getIframeLink(version: string) { - const url = this.getMfrUrlWithVersion(version); + const viewOnlyParam = this.hasViewOnly() ? this.viewOnlyService.getViewOnlyParam() : null; + const url = getMfrUrlWithVersion(this.file()?.links.render, version, viewOnlyParam); + if (url) { this.safeLink = this.sanitizer.bypassSecurityTrustResourceUrl(url); } @@ -313,7 +257,13 @@ export class FileDetailComponent implements OnInit, OnDestroy { } } - downloadFile(link: string): void { + downloadFile(): void { + const link = this.file()?.links.download; + + if (link) { + return; + } + this.dataciteService .logIdentifiableDownload(this.fileMetadata$) .pipe(takeUntilDestroyed(this.destroyRef)) @@ -321,11 +271,6 @@ export class FileDetailComponent implements OnInit, OnDestroy { window.open(link)?.focus(); } - copyToClipboard(embedHtml: string): void { - this.clipboard.copy(embedHtml); - this.toastService.showSuccess('files.detail.toast.copiedToClipboard'); - } - deleteEntry(link: string): void { if (this.resourceId) { const redirectUrl = `/${this.resourceId}/files`; @@ -336,7 +281,13 @@ export class FileDetailComponent implements OnInit, OnDestroy { } } - confirmDelete(file: FileDetailsModel): void { + confirmDelete(): void { + const file = this.file(); + + if (!file) { + return; + } + this.customConfirmationService.confirmDelete({ headerKey: 'files.dialogs.deleteFile.title', messageParams: { name: file.name }, @@ -354,28 +305,26 @@ export class FileDetailComponent implements OnInit, OnDestroy { } handleEmailShare(): void { - const link = `mailto:?subject=${this.file()?.name ?? ''}&body=${this.file()?.links?.html ?? ''}`; + const link = this.socialShareService.getEmailLink(this.file()?.name ?? '', this.file()?.links?.html ?? ''); window.location.href = link; } handleXShare(): void { - const link = `https://x.com/intent/tweet?url=${this.file()?.links?.html ?? ''}&text=${this.file()?.name ?? ''}&via=OSFramework`; + const link = this.socialShareService.getXLink(this.file()?.name ?? '', this.file()?.links?.html ?? ''); window.open(link, '_blank', 'noopener,noreferrer'); } handleFacebookShare(): void { - const link = `https://www.facebook.com/dialog/share?app_id=${this.environment.facebookAppId}&display=popup&href=${this.file()?.links?.html ?? ''}&redirect_uri=${this.file()?.links?.html ?? ''}`; + const link = this.socialShareService.getFacebookCustomLink(this.file()?.links?.html ?? ''); window.open(link, '_blank', 'noopener,noreferrer'); } handleCopyDynamicEmbed(): void { - const data = embedDynamicJs.replace('ENCODED_URL', this.file()?.links?.render ?? ''); - this.copyToClipboard(data); + this.filesShareEmbedService.copyEmbedToClipboard(this.file()?.links?.render ?? '', 'dynamic'); } handleCopyStaticEmbed(): void { - const data = embedStaticHtml.replace('ENCODED_URL', this.file()?.links?.render ?? ''); - this.copyToClipboard(data); + this.filesShareEmbedService.copyEmbedToClipboard(this.file()?.links?.render ?? '', 'static'); } onMetadataTabChange(tabId: string | number): void { @@ -405,26 +354,25 @@ export class FileDetailComponent implements OnInit, OnDestroy { onCedarFormSubmit(data: CedarRecordDataBinding): void { const selectedRecord = this.selectedCedarRecord(); - if (!this.resourceId || !selectedRecord) return; - if (selectedRecord.id) { - this.actions - .updateCedarRecord(data, selectedRecord.id, this.resourceId, ResourceType.File) - .pipe( - takeUntilDestroyed(this.destroyRef), - switchMap(() => { - const cedarUrl = this.file()?.links.info; - if (cedarUrl) { - return this.actions.getCedarRecords(this.resourceId, ResourceType.File, cedarUrl); - } - return []; - }) - ) - .subscribe(() => { - this.cedarFormReadonly.set(true); - this.updateSelectedCedarRecord(selectedRecord.id!); - this.toastService.showSuccess('files.detail.toast.cedarUpdated'); - }); - } + if (!this.resourceId || !selectedRecord?.id) return; + + this.actions + .updateCedarRecord(data, selectedRecord.id, this.resourceId, ResourceType.File) + .pipe( + takeUntilDestroyed(this.destroyRef), + switchMap(() => { + const cedarUrl = this.file()?.links.info; + if (cedarUrl) { + return this.actions.getCedarRecords(this.resourceId, ResourceType.File, cedarUrl); + } + return []; + }) + ) + .subscribe(() => { + this.cedarFormReadonly.set(true); + this.updateSelectedCedarRecord(selectedRecord.id!); + this.toastService.showSuccess('files.detail.toast.cedarUpdated'); + }); } private updateSelectedCedarRecord(recordId: string): void { @@ -443,13 +391,17 @@ export class FileDetailComponent implements OnInit, OnDestroy { if (!records) { return; } + const record = records.find((r) => r.id === recordId); if (!record) { return; } + this.selectedCedarRecord.set(record); this.cedarFormReadonly.set(true); + const templateId = record.relationships?.template?.data?.id; + if (templateId && templates?.data) { const template = templates.data.find((t) => t.id === templateId); if (template) { @@ -464,24 +416,79 @@ export class FileDetailComponent implements OnInit, OnDestroy { } } - private getMfrUrlWithVersion(version?: string): string | null { - const mfrUrl = this.file()?.links.render; - if (!mfrUrl) return null; - const mfrUrlObj = new URL(mfrUrl); - const encodedDownloadUrl = mfrUrlObj.searchParams.get('url'); - if (!encodedDownloadUrl) return mfrUrl; + private initTabsEffect(): void { + effect(() => { + const records = this.cedarRecords(); - const downloadUrlObj = new URL(decodeURIComponent(encodedDownloadUrl)); + const baseTabs = [{ id: 'osf', label: 'OSF', type: MetadataResourceEnum.PROJECT }]; + + const cedarTabs = + records?.map((record) => ({ + id: record.id || '', + label: record.embeds?.template?.data?.attributes?.schema_name || `Record ${record.id}`, + type: MetadataResourceEnum.CEDAR, + })) || []; - if (version) downloadUrlObj.searchParams.set('version', version); + this.tabs.set([...baseTabs, ...cedarTabs]); + }); + } + + private initMetaTagsEffect(): void { + effect(() => { + const metaTagsData = this.metaTagsData(); - if (this.hasViewOnly()) { - const viewOnlyParam = this.viewOnlyService.getViewOnlyParam(); - if (viewOnlyParam) downloadUrlObj.searchParams.set('view_only', viewOnlyParam); + if (metaTagsData) { + this.metaTags.updateMetaTags(metaTagsData, this.destroyRef); + } + }); + } + + private initIdentifiableViewTracking(): void { + this.dataciteService.logIdentifiableView(this.fileMetadata$).pipe(takeUntilDestroyed(this.destroyRef)).subscribe(); + } + + private initRouteSync(): void { + this.route.params + .pipe( + takeUntilDestroyed(this.destroyRef), + switchMap((params) => { + const nextFileGuid = params['fileGuid']; + this.syncFileGuid(nextFileGuid); + this.actions.getFileMetadata(this.fileGuid); + return this.actions.getFile(this.fileGuid); + }) + ) + .subscribe(() => { + this.handleFileLoaded(); + }); + } + + private syncFileGuid(nextFileGuid: string): void { + if (this.fileGuid && this.fileGuid !== nextFileGuid) { + this.signpostingService.removeSignpostingLinkTags(); } - mfrUrlObj.searchParams.set('url', downloadUrlObj.toString()); + this.fileGuid = nextFileGuid; + this.signpostingService.addSignposting(this.fileGuid); + } + + private handleFileLoaded(): void { + this.getIframeLink(''); + const file = this.file(); + if (!file) return; - return mfrUrlObj.toString(); + this.resourceId = file.target?.id || ''; + this.resourceType = file.target?.type || ''; + if (!this.resourceId || !this.resourceType) return; + + this.actions.getFileResourceMetadata(this.resourceId, this.resourceType); + this.actions.getFileResourceContributors(this.resourceId, this.resourceType); + this.actions.getFileRevisions(file.links.upload || ''); + this.actions.getCedarTemplates(); + + const cedarUrl = file.links.info; + if (cedarUrl) { + this.actions.getCedarRecords(this.resourceId, ResourceType.File, cedarUrl); + } } } diff --git a/src/app/features/files/pages/file-preview/file-preview.component.spec.ts b/src/app/features/files/pages/file-preview/file-preview.component.spec.ts index 2ef809426..e1cb7d38d 100644 --- a/src/app/features/files/pages/file-preview/file-preview.component.spec.ts +++ b/src/app/features/files/pages/file-preview/file-preview.component.spec.ts @@ -7,11 +7,10 @@ import { Mock } from 'vitest'; import { ComponentFixture, TestBed } from '@angular/core/testing'; import { ActivatedRoute, Router } from '@angular/router'; -import { FileKind } from '@osf/shared/enums/file-kind.enum'; -import { FileDetailsModel } from '@osf/shared/models/files/file.model'; -import { BaseNodeModel } from '@osf/shared/models/nodes/base-node.model'; +import { getMfrUrlWithVersion } from '@osf/shared/helpers/mfr-url.helper'; import { ViewOnlyLinkHelperService } from '@osf/shared/services/view-only-link-helper.service'; +import { FileDetailsMock } from '@testing/mocks/file-details.mock'; import { provideOSFCore } from '@testing/osf.testing.provider'; import { ActivatedRouteMockBuilder } from '@testing/providers/route-provider.mock'; import { RouterMockBuilder, RouterMockType } from '@testing/providers/router-provider.mock'; @@ -43,39 +42,15 @@ describe('FilePreviewComponent', () => { const encodedDownloadUrl = 'https://files.osf.io/v1/resources/abc/providers/osfstorage/file.txt'; const defaultRenderLink = `https://mfr.osf.io/render?url=${encodeURIComponent(encodedDownloadUrl)}`; - function buildFileDetailsModel(renderLink: string): FileDetailsModel { + function buildFileDetailsModel(renderLink: string) { + const file = FileDetailsMock.simple(); + return { - id: 'file-1', - guid: 'file-guid-1', - name: 'file.txt', - kind: FileKind.File, - path: '/file.txt', - size: 128, - materializedPath: '/file.txt', - dateModified: '2026-01-01T00:00:00.000Z', - dateCreated: '2026-01-01T00:00:00.000Z', - lastTouched: null, - tags: [], - currentVersion: 1, - showAsUnviewed: false, - extra: { - hashes: { - md5: 'md5', - sha256: 'sha256', - }, - downloads: 1, - }, + ...file, links: { - info: '', - move: '', - upload: '', - delete: '', - download: '', + ...file.links, render: renderLink, - html: '', - self: '', }, - target: {} as unknown as BaseNodeModel, }; } @@ -133,7 +108,7 @@ describe('FilePreviewComponent', () => { setup({ renderLink: 'https://mfr.osf.io/render' }); (store.dispatch as Mock).mockClear(); - const result = component.getMfrUrlWithVersion('2'); + const result = getMfrUrlWithVersion(component.file()?.links.render, '2'); expect(result).toBe('https://mfr.osf.io/render'); expect(store.dispatch).not.toHaveBeenCalled(); @@ -142,7 +117,7 @@ describe('FilePreviewComponent', () => { it('should append version param to nested download url', () => { setup(); - const result = component.getMfrUrlWithVersion('3'); + const result = getMfrUrlWithVersion(component.file()?.links.render, '3'); expect(result).toContain('https://mfr.osf.io/render?'); expect(result).toContain(encodeURIComponent('version=3')); @@ -151,7 +126,7 @@ describe('FilePreviewComponent', () => { it('should append view only param when present', () => { setup({ hasViewOnlyParam: true, viewOnlyParam: 'view-token-1' }); - const result = component.getMfrUrlWithVersion(); + const result = getMfrUrlWithVersion(component.file()?.links.render, '', 'view-token-1'); expect(result).toContain(encodeURIComponent('view_only=view-token-1')); }); @@ -159,7 +134,7 @@ describe('FilePreviewComponent', () => { it('should return null for empty render link', () => { setup({ renderLink: '' }); - const result = component.getMfrUrlWithVersion(); + const result = getMfrUrlWithVersion(''); expect(result).toBeNull(); }); diff --git a/src/app/features/files/pages/file-preview/file-preview.component.ts b/src/app/features/files/pages/file-preview/file-preview.component.ts index ab9bbd904..62cc3d351 100644 --- a/src/app/features/files/pages/file-preview/file-preview.component.ts +++ b/src/app/features/files/pages/file-preview/file-preview.component.ts @@ -9,11 +9,13 @@ import { takeUntilDestroyed } from '@angular/core/rxjs-interop'; import { DomSanitizer, SafeResourceUrl } from '@angular/platform-browser'; import { ActivatedRoute, Router } from '@angular/router'; -import { FilesSelectors, GetFile } from '@osf/features/files/store'; import { LoadingSpinnerComponent } from '@osf/shared/components/loading-spinner/loading-spinner.component'; import { SubHeaderComponent } from '@osf/shared/components/sub-header/sub-header.component'; +import { getMfrUrlWithVersion } from '@osf/shared/helpers/mfr-url.helper'; import { ViewOnlyLinkHelperService } from '@osf/shared/services/view-only-link-helper.service'; +import { FilesSelectors, GetFile } from '../../store'; + @Component({ selector: 'osf-draft-file-detail', imports: [SubHeaderComponent, LoadingSpinnerComponent, TranslatePipe], @@ -46,34 +48,15 @@ export class FilePreviewComponent { takeUntilDestroyed(this.destroyRef), switchMap((params) => this.actions.getFile(params['fileGuid'])) ) - .subscribe(() => this.getIframeLink('')); + .subscribe(() => this.getIframeLink()); } - getIframeLink(version: string) { - const url = this.getMfrUrlWithVersion(version); + getIframeLink() { + const viewOnlyParam = this.hasViewOnly() ? this.viewOnlyService.getViewOnlyParam() : null; + const url = getMfrUrlWithVersion(this.file()?.links.render, '', viewOnlyParam); + if (url) { this.safeLink = this.sanitizer.bypassSecurityTrustResourceUrl(url); } } - - getMfrUrlWithVersion(version?: string): string | null { - const mfrUrl = this.file()?.links.render; - if (!mfrUrl) return null; - const mfrUrlObj = new URL(mfrUrl); - const encodedDownloadUrl = mfrUrlObj.searchParams.get('url'); - if (!encodedDownloadUrl) return mfrUrl; - - const downloadUrlObj = new URL(decodeURIComponent(encodedDownloadUrl)); - - if (version) downloadUrlObj.searchParams.set('version', version); - - if (this.hasViewOnly()) { - const viewOnlyParam = this.viewOnlyService.getViewOnlyParam(); - if (viewOnlyParam) downloadUrlObj.searchParams.set('view_only', viewOnlyParam); - } - - mfrUrlObj.searchParams.set('url', downloadUrlObj.toString()); - - return mfrUrlObj.toString(); - } } diff --git a/src/app/features/files/pages/files/files.component.html b/src/app/features/files/pages/files/files.component.html index 10a2f47bb..2f8f1783c 100644 --- a/src/app/features/files/pages/files/files.component.html +++ b/src/app/features/files/pages/files/files.component.html @@ -17,21 +17,14 @@ [(ngModel)]="currentRootFolder" (onChange)="handleRootFolderChange($event.value)" variant="filled" - > - -

{{ selectedOption.label }}

- - -

{{ option.label }}

- - + /> }
@if (filesSelection.length) { @if (!isMoveDialogOpened()) { diff --git a/src/app/features/files/pages/files/files.component.scss b/src/app/features/files/pages/files/files.component.scss index c9be697b1..fd15c2680 100644 --- a/src/app/features/files/pages/files/files.component.scss +++ b/src/app/features/files/pages/files/files.component.scss @@ -5,19 +5,3 @@ flex: 1; overflow: hidden; } - -.blue-text { - color: var(--pr-blue-1); -} - -.filename { - overflow-wrap: anywhere; -} - -.upload-dialog { - width: mix.rem(128px); -} - -.provider-name { - text-transform: capitalize; -} diff --git a/src/app/features/files/pages/files/files.component.spec.ts b/src/app/features/files/pages/files/files.component.spec.ts index 05c5727ac..c0afc4830 100644 --- a/src/app/features/files/pages/files/files.component.spec.ts +++ b/src/app/features/files/pages/files/files.component.spec.ts @@ -25,6 +25,7 @@ import { FileKind } from '@osf/shared/enums/file-kind.enum'; import { FileMenuType } from '@osf/shared/enums/file-menu-type.enum'; import { ResourceType } from '@osf/shared/enums/resource-type.enum'; import { UserPermissions } from '@osf/shared/enums/user-permissions.enum'; +import { getConfiguredStorageAddonDisplayName } from '@osf/shared/helpers/storage-addon-options.helper'; import { ConfiguredAddonModel } from '@osf/shared/models/addons/configured-addon.model'; import { CurrentResource } from '@osf/shared/models/current-resource.model'; import { FileFolderModel } from '@osf/shared/models/files/file-folder.model'; @@ -300,10 +301,10 @@ describe('FilesComponent', () => { expect(options[0].folder.id).toBe('folder-1'); }); - it('should return addon display name for non-osf provider in getAddonName', () => { + it('should resolve non-OSF provider display name via storage addon helper', () => { setup(); - const name = component.getAddonName(configuredAddons, FileProvider.GoogleDrive); + const name = getConfiguredStorageAddonDisplayName(configuredAddons, FileProvider.GoogleDrive, 'OSF Storage'); expect(name).toBe('Google Drive'); }); diff --git a/src/app/features/files/pages/files/files.component.ts b/src/app/features/files/pages/files/files.component.ts index 00ab2a2ef..5167b548f 100644 --- a/src/app/features/files/pages/files/files.component.ts +++ b/src/app/features/files/pages/files/files.component.ts @@ -2,26 +2,13 @@ import { createDispatchMap, select } from '@ngxs/store'; import { TranslatePipe, TranslateService } from '@ngx-translate/core'; -import { TreeDragDropService } from 'primeng/api'; import { Button } from 'primeng/button'; import { Select } from 'primeng/select'; import { TableModule } from 'primeng/table'; -import { - catchError, - debounceTime, - distinctUntilChanged, - filter, - finalize, - forkJoin, - map, - of, - switchMap, - take, -} from 'rxjs'; +import { debounceTime, distinctUntilChanged, finalize, map, of, tap } from 'rxjs'; import { isPlatformBrowser } from '@angular/common'; -import { HttpEventType, HttpResponse } from '@angular/common/http'; import { ChangeDetectionStrategy, Component, @@ -39,22 +26,6 @@ import { takeUntilDestroyed, toSignal } from '@angular/core/rxjs-interop'; import { FormControl, FormsModule, ReactiveFormsModule } from '@angular/forms'; import { ActivatedRoute, Router } from '@angular/router'; -import { ENVIRONMENT } from '@core/provider/environment.provider'; -import { - CreateFolder, - DeleteEntry, - GetConfiguredStorageAddons, - GetFiles, - GetRootFolders, - GetStorageSupportedFeatures, - RenameEntry, - ResetFilesState, - SetCurrentProvider, - SetFilesCurrentFolder, - SetMoveDialogCurrentFolder, - SetSearch, - SetSort, -} from '@osf/features/files/store'; import { FileUploadDialogComponent } from '@osf/shared/components/file-upload-dialog/file-upload-dialog.component'; import { FilesTreeComponent } from '@osf/shared/components/files-tree/files-tree.component'; import { FormSelectComponent } from '@osf/shared/components/form-select/form-select.component'; @@ -67,29 +38,43 @@ import { FILE_SIZE_LIMIT } from '@osf/shared/constants/files-limits.const'; import { ALL_SORT_OPTIONS } from '@osf/shared/constants/sort-options.const'; import { SupportedFeature } from '@osf/shared/enums/addon-supported-features.enum'; import { FileMenuType } from '@osf/shared/enums/file-menu-type.enum'; -import { ResourceType } from '@osf/shared/enums/resource-type.enum'; -import { UserPermissions } from '@osf/shared/enums/user-permissions.enum'; -import { CustomConfirmationService } from '@osf/shared/services/custom-confirmation.service'; +import { CurrentResourceType, ResourceType } from '@osf/shared/enums/resource-type.enum'; +import { mapRootFoldersToStorageLabels } from '@osf/shared/helpers/storage-addon-options.helper'; +import { FilePageLinkModel } from '@osf/shared/models/files/file-page-link.model'; +import { RenamedFileLinkModel } from '@osf/shared/models/files/renamed-file-link.model'; import { CustomDialogService } from '@osf/shared/services/custom-dialog.service'; import { FilesService } from '@osf/shared/services/files.service'; import { ToastService } from '@osf/shared/services/toast.service'; import { ViewOnlyLinkHelperService } from '@osf/shared/services/view-only-link-helper.service'; import { CurrentResourceSelectors, GetResourceDetails } from '@osf/shared/stores/current-resource'; -import { ConfiguredAddonModel } from '@shared/models/addons/configured-addon.model'; import { StorageItem } from '@shared/models/addons/storage-item.model'; import { FileModel } from '@shared/models/files/file.model'; import { FileFolderModel } from '@shared/models/files/file-folder.model'; import { FileLabelModel } from '@shared/models/files/file-label.model'; import { DataciteService } from '@shared/services/datacite/datacite.service'; -import { - CreateFolderDialogComponent, - FileBrowserInfoComponent, - FilesSelectionActionsComponent, - MoveFileDialogComponent, -} from '../../components'; +import { FileBrowserInfoComponent } from '../../components/file-browser-info/file-browser-info.component'; +import { FilesSelectionActionsComponent } from '../../components/files-selection-actions/files-selection-actions.component'; import { FileProvider } from '../../constants'; -import { FilesSelectors } from '../../store'; +import { mapMenuActions } from '../../mappers/file-menu-actions.mapper'; +import { FilesActionsService } from '../../services/files-actions.service'; +import { FilesUploadService } from '../../services/files-upload.service'; +import { + CreateFolder, + DeleteEntry, + FilesSelectors, + GetConfiguredStorageAddons, + GetFiles, + GetRootFolders, + GetStorageSupportedFeatures, + RenameEntry, + ResetFilesState, + SetCurrentProvider, + SetFilesCurrentFolder, + SetMoveDialogCurrentFolder, + SetSearch, + SetSort, +} from '../../store'; @Component({ selector: 'osf-files', @@ -107,14 +92,13 @@ import { FilesSelectors } from '../../store'; SubHeaderComponent, FileUploadDialogComponent, ViewOnlyLinkMessageComponent, - GoogleFilePickerComponent, FilesSelectionActionsComponent, TranslatePipe, ], templateUrl: './files.component.html', styleUrl: './files.component.scss', changeDetection: ChangeDetectionStrategy.OnPush, - providers: [TreeDragDropService], + providers: [FilesActionsService, FilesUploadService], }) export class FilesComponent { googleFilePickerComponent = viewChild(GoogleFilePickerComponent); @@ -128,15 +112,11 @@ export class FilesComponent { private readonly translateService = inject(TranslateService); private readonly router = inject(Router); private readonly dataciteService = inject(DataciteService); - private readonly environment = inject(ENVIRONMENT); - private readonly customConfirmationService = inject(CustomConfirmationService); + private readonly filesActionsService = inject(FilesActionsService); + private readonly filesUploadService = inject(FilesUploadService); private readonly toastService = inject(ToastService); private readonly viewOnlyService = inject(ViewOnlyLinkHelperService); - private readonly platformId = inject(PLATFORM_ID); - private readonly isBrowser = isPlatformBrowser(this.platformId); - - private readonly webUrl = this.environment.webUrl; - private readonly apiDomainUrl = this.environment.apiDomainUrl; + private readonly isBrowser = isPlatformBrowser(inject(PLATFORM_ID)); private readonly actions = createDispatchMap({ createFolder: CreateFolder, @@ -160,13 +140,17 @@ export class FilesComponent { readonly isFilesLoading = select(FilesSelectors.isFilesLoading); readonly currentFolder = select(FilesSelectors.getCurrentFolder); readonly provider = select(FilesSelectors.getProvider); - readonly resourceDetails = select(CurrentResourceSelectors.getResourceDetails); readonly resourceMetadata = select(CurrentResourceSelectors.getCurrentResource); readonly rootFolders = select(FilesSelectors.getRootFolders); readonly isRootFoldersLoading = select(FilesSelectors.isRootFoldersLoading); readonly configuredStorageAddons = select(FilesSelectors.getConfiguredStorageAddons); readonly isConfiguredStorageAddonsLoading = select(FilesSelectors.isConfiguredStorageAddonsLoading); readonly supportedFeatures = select(FilesSelectors.getStorageSupportedFeatures); + readonly hasWriteAccess = select(CurrentResourceSelectors.hasResourceWriteAccess); + readonly hasAdminAccess = select(CurrentResourceSelectors.hasResourceAdminAccess); + readonly currentResourceType = computed( + () => (this.resourceMetadata()?.type as CurrentResourceType) ?? CurrentResourceType.Projects + ); readonly isGoogleDrive = signal(false); readonly accountId = signal(''); @@ -193,17 +177,12 @@ export class FilesComponent { allowRevisions = false; filesSelection: FileModel[] = []; - private readonly urlMap = new Map([ - [ResourceType.Project, 'nodes'], - [ResourceType.Registration, 'registrations'], - ]); - readonly allowedMenuActions = computed(() => { const provider = this.provider(); const supportedFeatures = this.supportedFeatures()[provider] || []; const hasViewOnly = this.hasViewOnly(); const isRegistration = this.resourceType() === ResourceType.Registration; - const menuMap = this.mapMenuActions(supportedFeatures); + const menuMap = mapMenuActions(supportedFeatures); const result: Record = { ...menuMap }; @@ -219,15 +198,8 @@ export class FilesComponent { }); readonly rootFoldersOptions = computed(() => { - const rootFolders = this.rootFolders(); - const addons = this.configuredStorageAddons(); - if (rootFolders && addons) { - return rootFolders.map((folder) => ({ - label: this.getAddonName(addons, folder.provider), - folder: folder, - })); - } - return []; + const osfLabel = this.translateService.instant('files.storageLocation'); + return mapRootFoldersToStorageLabels(this.rootFolders(), this.configuredStorageAddons(), osfLabel); }); resourceType = signal( @@ -235,16 +207,7 @@ export class FilesComponent { ); readonly hasViewOnly = computed(() => this.viewOnlyService.hasViewOnlyParam(this.router)); - - readonly canEdit = computed(() => { - const details = this.resourceDetails(); - const hasAdminOrWrite = details.currentUserPermissions?.some( - (permission) => permission === UserPermissions.Admin || permission === UserPermissions.Write - ); - - return hasAdminOrWrite; - }); - + readonly canEdit = computed(() => this.hasWriteAccess() || this.hasAdminAccess()); readonly isRegistration = computed(() => this.resourceType() === ResourceType.Registration); canUploadFiles = computed( @@ -260,28 +223,33 @@ export class FilesComponent { () => this.isButtonDisabled() || (this.googleFilePickerComponent()?.isGFPDisabled() ?? false) ); - private route = inject(ActivatedRoute); readonly providerName = toSignal( - this.route?.params?.pipe(map((params) => params['fileProvider'])) ?? of('osfstorage') + this.activeRoute?.params?.pipe(map((params) => params['fileProvider'])) ?? of('osfstorage') ); constructor() { + this.initResourceId(); + this.initEffects(); + this.initFilters(); + this.initDestroyHandler(); + } + + private initResourceId(): void { this.activeRoute.parent?.parent?.parent?.params.pipe(takeUntilDestroyed(this.destroyRef)).subscribe((params) => { if (params['id']) { this.resourceId.set(params['id']); } }); + } + private initEffects(): void { effect(() => { const resourceId = this.resourceId(); + if (!resourceId) return; - const resourcePath = this.urlMap.get(this.resourceType()!); - const folderLink = `${this.apiDomainUrl}/v2/${resourcePath}/${resourceId}/files/`; - const iriLink = `${this.webUrl}/${resourceId}`; - - this.actions.getResourceDetails(resourceId, this.resourceType()!); - this.actions.getRootFolders(folderLink); - this.actions.getConfiguredStorageAddons(iriLink); + this.actions.getResourceDetails(resourceId, this.resourceType()); + this.actions.getRootFolders(resourceId, this.resourceType()); + this.actions.getConfiguredStorageAddons(resourceId); }); effect(() => { @@ -336,7 +304,9 @@ export class FilesComponent { this.updateFilesList(); } }); + } + private initFilters(): void { this.searchControl.valueChanges .pipe(takeUntilDestroyed(this.destroyRef), distinctUntilChanged(), debounceTime(500)) .subscribe((searchText) => { @@ -350,7 +320,9 @@ export class FilesComponent { this.updateFilesList(); }); + } + private initDestroyHandler(): void { this.destroyRef.onDestroy(() => { if (this.isBrowser) { this.actions.resetState(); @@ -358,103 +330,40 @@ export class FilesComponent { }); } - onLoadFiles(event: { link: string; page: number }) { + onLoadFiles(event: FilePageLinkModel) { this.actions.getFiles(event.link, event.page); } uploadFiles(files: File | File[]): void { - const currentFolder = this.currentFolder(); - const uploadLink = currentFolder?.links.upload; + const uploadLink = this.currentFolder()?.links.upload; if (!uploadLink) return; - const fileArray = Array.isArray(files) ? files : [files]; - if (fileArray.length === 0) return; - - this.fileName.set(fileArray.length === 1 ? fileArray[0].name : `${fileArray.length} files`); - this.fileIsUploading.set(true); - this.progress.set(0); - - let completedUploads = 0; - const totalFiles = fileArray.length; - const conflictFiles: { file: File; link: string }[] = []; - - fileArray.forEach((file) => { - this.filesService - .uploadFile(file, uploadLink) - .pipe( - takeUntilDestroyed(this.destroyRef), - catchError((err) => { - const conflictLink = err.error?.data?.links?.upload; - if (err.status === 409 && conflictLink) { - if (this.allowRevisions) { - return this.filesService.uploadFile(file, conflictLink, true); - } else { - conflictFiles.push({ file, link: conflictLink }); - } - } - return of(new HttpResponse()); - }) - ) - .subscribe((event) => { - if (event.type === HttpEventType.UploadProgress && event.total) { - const progressPercentage = Math.round((event.loaded / event.total) * 100); - if (totalFiles === 1) { - this.progress.set(progressPercentage); - } - } - - if (event.type === HttpEventType.Response) { - completedUploads++; - - if (totalFiles > 1) { - const progressPercentage = Math.round((completedUploads / totalFiles) * 100); - this.progress.set(progressPercentage); - } - - if (completedUploads === totalFiles) { - if (conflictFiles.length > 0) { - this.openReplaceFileDialog(conflictFiles); - } else { - this.completeUpload(); - } - } - } - }); - }); - } - - private openReplaceFileDialog(conflictFiles: { file: File; link: string }[]) { - this.customConfirmationService.confirmDelete({ - headerKey: conflictFiles.length > 1 ? 'files.dialogs.replaceFile.multiple' : 'files.dialogs.replaceFile.single', - messageKey: 'files.dialogs.replaceFile.message', - messageParams: { - name: conflictFiles.map((c) => c.file.name).join(', '), + this.filesUploadService.uploadFiles({ + files, + uploadLink, + allowRevisions: this.allowRevisions, + onStart: (fileName) => { + this.fileName.set(fileName); + this.fileIsUploading.set(true); + this.progress.set(0); }, - acceptLabelKey: 'common.buttons.replace', - onConfirm: () => { - const replaceRequests$ = conflictFiles.map(({ file, link }) => - this.filesService.uploadFile(file, link, true).pipe( - takeUntilDestroyed(this.destroyRef), - catchError(() => of(null)) - ) - ); - - forkJoin(replaceRequests$).subscribe({ - next: () => this.completeUpload(), - }); + onProgress: (progress) => { + this.progress.set(progress); + }, + onComplete: () => { + this.fileIsUploading.set(false); + this.fileName.set(''); + this.updateFilesList(); }, }); } - private completeUpload(): void { - this.fileIsUploading.set(false); - this.fileName.set(''); - this.updateFilesList(); - } - onFileTreeSelected(file: FileModel): void { - this.filesSelection.push(file); - this.filesSelection = [...new Set(this.filesSelection)]; + if (this.filesSelection.some((selectedFile) => selectedFile.id === file.id)) { + return; + } + + this.filesSelection = [...this.filesSelection, file]; } onFileTreeUnselected(file: FileModel): void { @@ -466,29 +375,12 @@ export class FilesComponent { } onDeleteSelected(): void { - if (!this.filesSelection.length) return; - - this.customConfirmationService.confirmDelete({ - headerKey: 'files.dialogs.deleteMultipleItems.title', - messageKey: 'files.dialogs.deleteMultipleItems.message', - messageParams: { - name: this.filesSelection.map((f) => f.name).join(', '), - }, - acceptLabelKey: 'common.buttons.delete', - onConfirm: () => { - const deleteRequests$ = this.filesSelection.map((file) => - this.actions.deleteEntry(file.links.delete).pipe(catchError(() => of(null))) - ); - - forkJoin(deleteRequests$) - .pipe(takeUntilDestroyed(this.destroyRef)) - .subscribe({ - next: () => { - this.toastService.showSuccess('files.dialogs.deleteFile.success'); - this.filesSelection = []; - this.updateFilesList(); - }, - }); + this.filesActionsService.deleteSelected({ + files: this.filesSelection, + deleteEntry: (link) => this.actions.deleteEntry(link), + onSuccess: () => { + this.filesSelection = []; + this.updateFilesList(); }, }); } @@ -517,30 +409,31 @@ export class FilesComponent { this.uploadFiles(Array.from(files)); } - moveFiles(files: FileModel[], action: string): void { + moveFiles(files: FileModel[], action: 'move' | 'copy'): void { const currentFolder = this.currentFolder(); this.actions.setMoveDialogCurrentFolder(currentFolder); this.isMoveDialogOpened.set(true); - this.customDialogService - .open(MoveFileDialogComponent, { - header: 'files.dialogs.moveFile.title', - width: '552px', - data: { - files: files, - resourceId: this.resourceId(), - action: action, - storageProvider: this.provider(), - foldersStack: this.foldersStack, - initialFolder: structuredClone(this.currentFolder()), - }, + + this.filesActionsService + .openMoveDialog({ + files, + action, + resourceId: this.resourceId(), + storageProvider: this.provider(), + foldersStack: this.foldersStack, + initialFolder: currentFolder, }) - .onClose.subscribe((result) => { - if (result) { - this.filesSelection = []; - } - this.isMoveDialogOpened.set(false); - this.resetProvider(); - }); + .pipe( + tap((result) => { + if (result) { + this.filesSelection = []; + } + this.isMoveDialogOpened.set(false); + this.resetProvider(); + }), + takeUntilDestroyed(this.destroyRef) + ) + .subscribe(); } resetProvider() { @@ -563,20 +456,18 @@ export class FilesComponent { if (!newFolderLink) return; - this.customDialogService - .open(CreateFolderDialogComponent, { - header: 'files.dialogs.createFolder.title', - width: '448px', + this.filesActionsService + .openCreateFolderDialog({ + newFolderLink, + createFolder: (link, folderName) => this.actions.createFolder(link, folderName), }) - .onClose.pipe( - filter((folderName: string) => !!folderName), - switchMap((folderName: string) => this.actions.createFolder(newFolderLink, folderName)), - take(1), + .pipe( + tap(() => this.toastService.showSuccess('files.dialogs.createFolder.success')), finalize(() => { this.updateFilesList(); this.fileIsUploading.set(false); - this.toastService.showSuccess('files.dialogs.createFolder.success'); - }) + }), + takeUntilDestroyed(this.destroyRef) ) .subscribe(); } @@ -626,7 +517,7 @@ export class FilesComponent { }); } - renameEntry(event: { newName: string; link: string }) { + renameEntry(event: RenamedFileLinkModel) { const { newName, link } = event; this.actions.renameEntry(link, newName).subscribe(() => { this.toastService.showSuccess('files.dialogs.renameFile.success'); @@ -635,21 +526,30 @@ export class FilesComponent { } navigateToFile(file: FileModel) { - const extras = this.hasViewOnly() - ? { queryParams: { view_only: this.viewOnlyService.getViewOnlyParamFromUrl(this.router.url) } } - : undefined; + if (file.guid) { + this.openFile(file.guid); + return; + } - const url = this.router.serializeUrl(this.router.createUrlTree(['/', file.guid], extras)); + this.filesService.getFileGuid(file.id).subscribe((file) => { + if (file.guid) { + this.openFile(file.guid); + } + }); + } - window.open(url, '_blank'); + handleRootFolderChange(selectedFolder: FileLabelModel) { + const provider = selectedFolder.folder?.provider; + const resourceId = this.resourceId(); + this.router.navigate([`/${resourceId}/files`, provider], { queryParamsHandling: 'preserve' }); } - getAddonName(addons: ConfiguredAddonModel[], provider: string): string { - if (provider === FileProvider.OsfStorage) { - return this.translateService.instant('files.storageLocation'); - } else { - return addons.find((addon) => addon.externalServiceName === provider)?.displayName ?? ''; - } + private openFile(guid: string): void { + const extras = this.hasViewOnly() + ? { queryParams: { view_only: this.viewOnlyService.getViewOnlyParamFromUrl(this.router.url) } } + : undefined; + + window.open(this.router.serializeUrl(this.router.createUrlTree(['/', guid], extras)), '_blank'); } private setGoogleAccountId(): void { @@ -657,38 +557,7 @@ export class FilesComponent { const googleDrive = addons?.find((addon) => addon.externalServiceName === FileProvider.GoogleDrive); if (googleDrive) { this.accountId.set(googleDrive.baseAccountId); - this.selectedRootFolder.set({ - itemId: googleDrive.selectedStorageItemId, - }); + this.selectedRootFolder.set({ itemId: googleDrive.selectedStorageItemId }); } } - - private mapMenuActions(supportedFeatures: SupportedFeature[]): Record { - return { - [FileMenuType.Download]: supportedFeatures.includes(SupportedFeature.DownloadAsZip), - [FileMenuType.Rename]: supportedFeatures.includes(SupportedFeature.AddUpdateFiles), - [FileMenuType.Delete]: supportedFeatures.includes(SupportedFeature.DeleteFiles), - [FileMenuType.Move]: - supportedFeatures.includes(SupportedFeature.DeleteFiles) && - supportedFeatures.includes(SupportedFeature.AddUpdateFiles), - [FileMenuType.Embed]: true, - [FileMenuType.Share]: true, - [FileMenuType.Copy]: true, - }; - } - - openGoogleFilePicker(): void { - this.googleFilePickerComponent()?.createPicker(); - this.updateFilesList(); - } - - onUpdateFoldersStack(newStack: FileFolderModel[]): void { - this.foldersStack = [...newStack]; - } - - handleRootFolderChange(selectedFolder: FileLabelModel) { - const provider = selectedFolder.folder?.provider; - const resourceId = this.resourceId(); - this.router.navigate([`/${resourceId}/files`, provider], { queryParamsHandling: 'preserve' }); - } } diff --git a/src/app/features/files/services/files-actions.service.ts b/src/app/features/files/services/files-actions.service.ts new file mode 100644 index 000000000..f128afa1c --- /dev/null +++ b/src/app/features/files/services/files-actions.service.ts @@ -0,0 +1,73 @@ +import { catchError, filter, forkJoin, Observable, of, switchMap, take } from 'rxjs'; + +import { inject, Injectable } from '@angular/core'; + +import { CustomConfirmationService } from '@osf/shared/services/custom-confirmation.service'; +import { CustomDialogService } from '@osf/shared/services/custom-dialog.service'; +import { ToastService } from '@osf/shared/services/toast.service'; + +import { CreateFolderDialogComponent } from '../components/create-folder-dialog/create-folder-dialog.component'; +import { MoveFileDialogComponent } from '../components/move-file-dialog/move-file-dialog.component'; +import { CreateFolderOptions, DeleteSelectedOptions, MoveFilesOptions } from '../models/files-actions-options.model'; + +@Injectable() +export class FilesActionsService { + private readonly customConfirmationService = inject(CustomConfirmationService); + private readonly customDialogService = inject(CustomDialogService); + private readonly toastService = inject(ToastService); + + deleteSelected(options: DeleteSelectedOptions): void { + if (!options.files.length) return; + + const fileNames = options.files.map((f) => f.name).join(', '); + + this.customConfirmationService.confirmDelete({ + headerKey: 'files.dialogs.deleteMultipleItems.title', + messageKey: 'files.dialogs.deleteMultipleItems.message', + messageParams: { name: fileNames }, + acceptLabelKey: 'common.buttons.delete', + onConfirm: () => { + const deleteRequests$ = options.files.map((file) => + options.deleteEntry(file.links.delete).pipe(catchError(() => of(null))) + ); + + forkJoin(deleteRequests$).subscribe({ + next: () => { + this.toastService.showSuccess('files.dialogs.deleteFile.success'); + options.onSuccess(); + }, + }); + }, + }); + } + + openMoveDialog(options: MoveFilesOptions): Observable { + return this.customDialogService + .open(MoveFileDialogComponent, { + header: 'files.dialogs.moveFile.title', + width: '552px', + data: { + files: options.files, + resourceId: options.resourceId, + action: options.action, + storageProvider: options.storageProvider, + foldersStack: options.foldersStack, + initialFolder: structuredClone(options.initialFolder), + }, + }) + .onClose.pipe(take(1)); + } + + openCreateFolderDialog(options: CreateFolderOptions): Observable { + return this.customDialogService + .open(CreateFolderDialogComponent, { + header: 'files.dialogs.createFolder.title', + width: '448px', + }) + .onClose.pipe( + filter((folderName: string) => !!folderName), + switchMap((folderName) => options.createFolder(options.newFolderLink, folderName)), + take(1) + ); + } +} diff --git a/src/app/features/files/services/files-upload.service.ts b/src/app/features/files/services/files-upload.service.ts new file mode 100644 index 000000000..5039d485c --- /dev/null +++ b/src/app/features/files/services/files-upload.service.ts @@ -0,0 +1,103 @@ +import { catchError, forkJoin, of } from 'rxjs'; + +import { HttpEvent, HttpEventType, HttpResponse } from '@angular/common/http'; +import { inject, Injectable } from '@angular/core'; + +import { FileLinkModel } from '@osf/shared/models/files/file-link.model'; +import { CustomConfirmationService } from '@osf/shared/services/custom-confirmation.service'; +import { FilesService } from '@osf/shared/services/files.service'; + +import { UploadFilesOptions, UploadState } from '../models/files-upload-options.model'; + +@Injectable() +export class FilesUploadService { + private readonly filesService = inject(FilesService); + private readonly customConfirmationService = inject(CustomConfirmationService); + + uploadFiles(options: UploadFilesOptions): void { + const fileArray = Array.isArray(options.files) ? options.files : [options.files]; + if (!fileArray.length) return; + + const uploadLabel = fileArray.length === 1 ? fileArray[0].name : `${fileArray.length} files`; + + options.onStart(uploadLabel); + options.onProgress(0); + + const state: UploadState = { + completedUploads: 0, + totalFiles: fileArray.length, + conflictFiles: [], + }; + + fileArray.forEach((file) => { + this.createUploadRequest(file, options, state).subscribe((event) => { + this.handleUploadEvent(event, options, state); + }); + }); + } + + private createUploadRequest(file: File, options: UploadFilesOptions, state: UploadState) { + return this.filesService.uploadFile(file, options.uploadLink).pipe( + catchError((err) => { + const conflictLink = err.error?.data?.links?.upload; + if (err.status === 409 && conflictLink) { + if (options.allowRevisions) { + return this.filesService.uploadFile(file, conflictLink, true); + } + + state.conflictFiles.push({ file, link: conflictLink }); + } + + return of(new HttpResponse()); + }) + ); + } + + private handleUploadEvent(event: HttpEvent, options: UploadFilesOptions, state: UploadState): void { + if (event.type === HttpEventType.UploadProgress && event.total && state.totalFiles === 1) { + options.onProgress(Math.round(((event.loaded ?? 0) / event.total) * 100)); + } + + if (event.type !== HttpEventType.Response) { + return; + } + + state.completedUploads++; + + if (state.totalFiles > 1) { + options.onProgress(Math.round((state.completedUploads / state.totalFiles) * 100)); + } + + if (state.completedUploads !== state.totalFiles) { + return; + } + + if (state.conflictFiles.length > 0) { + this.openReplaceFileDialog(state.conflictFiles, options.onComplete); + return; + } + + options.onComplete(); + } + + private openReplaceFileDialog(conflictFiles: FileLinkModel[], onComplete: () => void): void { + const headerKey = + conflictFiles.length > 1 ? 'files.dialogs.replaceFile.multiple' : 'files.dialogs.replaceFile.single'; + + this.customConfirmationService.confirmDelete({ + headerKey, + messageKey: 'files.dialogs.replaceFile.message', + messageParams: { name: conflictFiles.map((c) => c.file.name).join(', ') }, + acceptLabelKey: 'common.buttons.replace', + onConfirm: () => { + const replaceRequests$ = conflictFiles.map(({ file, link }) => + this.filesService.uploadFile(file, link, true).pipe(catchError(() => of(null))) + ); + + forkJoin(replaceRequests$).subscribe({ + next: () => onComplete(), + }); + }, + }); + } +} diff --git a/src/app/features/files/store/files.actions.ts b/src/app/features/files/store/files.actions.ts index 999863b71..0236ee41d 100644 --- a/src/app/features/files/store/files.actions.ts +++ b/src/app/features/files/store/files.actions.ts @@ -1,6 +1,7 @@ import { FileFolderModel } from '@osf/shared/models/files/file-folder.model'; +import { ResourceType } from '@shared/enums/resource-type.enum'; -import { PatchFileMetadata } from '../models'; +import { PatchFileMetadata } from '../models/patch-file-metadata.model'; export class GetFiles { static readonly type = '[Files] Get Files'; @@ -131,25 +132,31 @@ export class DeleteEntry { export class GetRootFolders { static readonly type = '[Files] Get Folders'; - constructor(public folderLink: string) {} + constructor( + public resourceId: string, + public resourceType: ResourceType + ) {} } export class GetConfiguredStorageAddons { static readonly type = '[Files] Get ConfiguredStorageAddons'; - constructor(public resourceUri: string) {} + constructor(public resourceId: string) {} } export class GetMoveDialogRootFolders { static readonly type = '[Files] Get Move Dialog Folders'; - constructor(public folderLink: string) {} + constructor( + public resourceId: string, + public resourceType: ResourceType + ) {} } export class GetMoveDialogConfiguredStorageAddons { static readonly type = '[Files] Get Move Dialog ConfiguredStorageAddons'; - constructor(public resourceUri: string) {} + constructor(public resourceId: string) {} } export class GetStorageSupportedFeatures { diff --git a/src/app/features/files/store/files.model.ts b/src/app/features/files/store/files.model.ts index 518bed572..9c5dcb4b1 100644 --- a/src/app/features/files/store/files.model.ts +++ b/src/app/features/files/store/files.model.ts @@ -8,7 +8,8 @@ import { AsyncStateModel } from '@osf/shared/models/store/async-state.model'; import { AsyncStateWithTotalCount } from '@osf/shared/models/store/async-state-with-total-count.model'; import { FileProvider } from '../constants'; -import { OsfFileCustomMetadata, OsfFileRevision } from '../models'; +import { OsfFileCustomMetadata } from '../models/file-custom-metadata.model'; +import { OsfFileRevision } from '../models/file-revisions.model'; export interface FilesStateModel { files: AsyncStateWithTotalCount; diff --git a/src/app/features/files/store/files.selectors.ts b/src/app/features/files/store/files.selectors.ts index 81e0cca87..d4af2d066 100644 --- a/src/app/features/files/store/files.selectors.ts +++ b/src/app/features/files/store/files.selectors.ts @@ -8,7 +8,8 @@ import { FileDetailsModel, FileModel } from '@osf/shared/models/files/file.model import { FileFolderModel } from '@osf/shared/models/files/file-folder.model'; import { ResourceMetadata } from '@osf/shared/models/resource-metadata.model'; -import { OsfFileCustomMetadata, OsfFileRevision } from '../models'; +import { OsfFileCustomMetadata } from '../models/file-custom-metadata.model'; +import { OsfFileRevision } from '../models/file-revisions.model'; import { FilesStateModel } from './files.model'; import { FilesState } from './files.state'; diff --git a/src/app/features/files/store/files.state.ts b/src/app/features/files/store/files.state.ts index 52e6e31a8..ea2c68229 100644 --- a/src/app/features/files/store/files.state.ts +++ b/src/app/features/files/store/files.state.ts @@ -7,7 +7,6 @@ import { inject, Injectable } from '@angular/core'; import { SupportedFeature } from '@osf/shared/enums/addon-supported-features.enum'; import { handleSectionError } from '@osf/shared/helpers/state-error.handler'; import { FilesService } from '@osf/shared/services/files.service'; -import { ToastService } from '@osf/shared/services/toast.service'; import { MapResourceMetadata } from '../mappers'; @@ -45,7 +44,6 @@ import { FILES_STATE_DEFAULTS, FilesStateModel } from './files.model'; }) export class FilesState { filesService = inject(FilesService); - toastService = inject(ToastService); @Action(GetFiles) getFiles(ctx: StateContext, action: GetFiles) { @@ -262,7 +260,7 @@ export class FilesState { getRootFolders(ctx: StateContext, action: GetRootFolders) { const state = ctx.getState(); ctx.patchState({ rootFolders: { ...state.rootFolders, isLoading: true } }); - return this.filesService.getFolders(action.folderLink).pipe( + return this.filesService.getRootFolders(action.resourceId, action.resourceType).pipe( tap((response) => ctx.patchState({ rootFolders: { @@ -282,7 +280,7 @@ export class FilesState { const state = ctx.getState(); ctx.patchState({ moveDialogRootFolders: { ...state.moveDialogRootFolders, isLoading: true } }); - return this.filesService.getFolders(action.folderLink).pipe( + return this.filesService.getRootFolders(action.resourceId, action.resourceType).pipe( tap((response) => ctx.patchState({ moveDialogRootFolders: { @@ -302,7 +300,7 @@ export class FilesState { const state = ctx.getState(); ctx.patchState({ configuredStorageAddons: { ...state.configuredStorageAddons, isLoading: true } }); - return this.filesService.getConfiguredStorageAddons(action.resourceUri).pipe( + return this.filesService.getConfiguredStorageAddons(action.resourceId).pipe( tap((addons) => ctx.patchState({ configuredStorageAddons: { @@ -326,7 +324,7 @@ export class FilesState { moveDialogConfiguredStorageAddons: { ...state.moveDialogConfiguredStorageAddons, isLoading: true }, }); - return this.filesService.getConfiguredStorageAddons(action.resourceUri).pipe( + return this.filesService.getConfiguredStorageAddons(action.resourceId).pipe( tap((addons) => ctx.patchState({ moveDialogConfiguredStorageAddons: { diff --git a/src/app/features/metadata/components/cedar-template-form/cedar-template-form.component.ts b/src/app/features/metadata/components/cedar-template-form/cedar-template-form.component.ts index 032e378f3..58b859259 100644 --- a/src/app/features/metadata/components/cedar-template-form/cedar-template-form.component.ts +++ b/src/app/features/metadata/components/cedar-template-form/cedar-template-form.component.ts @@ -23,6 +23,7 @@ import { toSignal } from '@angular/core/rxjs-interop'; import { ActivatedRoute } from '@angular/router'; import { ENVIRONMENT } from '@core/provider/environment.provider'; +import { SocialShareService } from '@osf/shared/services/social-share.service'; import { CEDAR_CONFIG, CEDAR_VIEWER_CONFIG } from '../../constants'; import { CedarMetadataHelper } from '../../helpers'; @@ -62,6 +63,7 @@ export class CedarTemplateFormComponent { private route = inject(ActivatedRoute); readonly environment = inject(ENVIRONMENT); + private readonly socialShareService = inject(SocialShareService); readonly recordId = signal(''); readonly downloadUrl = signal(''); @@ -184,18 +186,18 @@ export class CedarTemplateFormComponent { handleEmailShare(): void { const url = window.location.href; - window.location.href = `mailto:?subject=${this.schemaName()}&body=${url}`; + window.location.href = this.socialShareService.getEmailLink(this.schemaName(), url); } handleXShare(): void { const url = window.location.href; - const link = `https://x.com/intent/tweet?url=${url}&text=${this.schemaName()}&via=OSFramework`; + const link = this.socialShareService.getXLink(this.schemaName(), url); window.open(link, '_blank', 'noopener,noreferrer'); } handleFacebookShare(): void { const url = window.location.href; - const link = `https://www.facebook.com/sharer/sharer.php?u=${url}`; + const link = this.socialShareService.getFacebookLink(url); window.open(link, '_blank', 'noopener,noreferrer'); } } diff --git a/src/app/features/preprints/components/stepper/file-step/file-step.component.html b/src/app/features/preprints/components/stepper/file-step/file-step.component.html index 8d9c845ab..425308db6 100644 --- a/src/app/features/preprints/components/stepper/file-step/file-step.component.html +++ b/src/app/features/preprints/components/stepper/file-step/file-step.component.html @@ -95,6 +95,7 @@

{{ 'preprints.preprintStepper.file.title' | translate }}

[files]="projectFiles()" [totalCount]="filesTotalCount()" [storage]="null" + [resourceType]="resourceType" [selectionMode]="null" [isLoading]="areProjectFilesLoading() || isCurrentFolderLoading()" [resourceId]="selectedProjectId()!" diff --git a/src/app/features/preprints/components/stepper/file-step/file-step.component.ts b/src/app/features/preprints/components/stepper/file-step/file-step.component.ts index 48f87991d..dbf74f832 100644 --- a/src/app/features/preprints/components/stepper/file-step/file-step.component.ts +++ b/src/app/features/preprints/components/stepper/file-step/file-step.component.ts @@ -43,9 +43,11 @@ import { import { FilesTreeComponent } from '@osf/shared/components/files-tree/files-tree.component'; import { IconComponent } from '@osf/shared/components/icon/icon.component'; import { ClearFileDirective } from '@osf/shared/directives/clear-file.directive'; +import { CurrentResourceType } from '@osf/shared/enums/resource-type.enum'; import { StringOrNull } from '@osf/shared/helpers/types.helper'; import { FileModel } from '@osf/shared/models/files/file.model'; import { FileFolderModel } from '@osf/shared/models/files/file-folder.model'; +import { FilePageLinkModel } from '@osf/shared/models/files/file-page-link.model'; import { ToastService } from '@osf/shared/services/toast.service'; @Component({ @@ -86,6 +88,7 @@ export class FileStepComponent implements OnInit { }); readonly PreprintFileSource = PreprintFileSource; + readonly resourceType = CurrentResourceType.Preprints; provider = input.required(); showDeleteButton = input(false); @@ -225,7 +228,7 @@ export class FileStepComponent implements OnInit { this.actions.getProjectFilesByLink(folder.links.filesLink, 1); } - onLoadFiles(event: { link: string; page: number }) { + onLoadFiles(event: FilePageLinkModel) { this.actions.getProjectFilesByLink(event.link, event.page); } } diff --git a/src/app/features/project/overview/components/files-widget/files-widget.component.html b/src/app/features/project/overview/components/files-widget/files-widget.component.html index bc85b93cc..443aa125a 100644 --- a/src/app/features/project/overview/components/files-widget/files-widget.component.html +++ b/src/app/features/project/overview/components/files-widget/files-widget.component.html @@ -39,6 +39,7 @@

{{ 'project.overview.files.filesPreview' | translate }}

[storage]="currentRootFolder()!" [isLoading]="isFilesLoading() || isStorageLoading" [resourceId]="selectedRoot!" + [resourceType]="resourceType" [provider]="provider()" [selectionMode]="null" [scrollHeight]="'300px'" diff --git a/src/app/features/project/overview/components/files-widget/files-widget.component.ts b/src/app/features/project/overview/components/files-widget/files-widget.component.ts index 535b01a43..3f90d2cb8 100644 --- a/src/app/features/project/overview/components/files-widget/files-widget.component.ts +++ b/src/app/features/project/overview/components/files-widget/files-widget.component.ts @@ -1,6 +1,6 @@ import { createDispatchMap, select } from '@ngxs/store'; -import { TranslatePipe } from '@ngx-translate/core'; +import { TranslatePipe, TranslateService } from '@ngx-translate/core'; import { Skeleton } from 'primeng/skeleton'; import { TabsModule } from 'primeng/tabs'; @@ -20,7 +20,6 @@ import { } from '@angular/core'; import { ActivatedRoute, Router } from '@angular/router'; -import { ENVIRONMENT } from '@core/provider/environment.provider'; import { FileProvider } from '@osf/features/files/constants'; import { FilesSelectors, @@ -32,14 +31,17 @@ import { } from '@osf/features/files/store'; import { FilesTreeComponent } from '@osf/shared/components/files-tree/files-tree.component'; import { SelectComponent } from '@osf/shared/components/select/select.component'; +import { CurrentResourceType, ResourceType } from '@osf/shared/enums/resource-type.enum'; +import { mapRootFoldersToStorageLabels } from '@osf/shared/helpers/storage-addon-options.helper'; import { Primitive } from '@osf/shared/helpers/types.helper'; -import { ConfiguredAddonModel } from '@osf/shared/models/addons/configured-addon.model'; import { FileModel } from '@osf/shared/models/files/file.model'; import { FileFolderModel } from '@osf/shared/models/files/file-folder.model'; import { FileLabelModel } from '@osf/shared/models/files/file-label.model'; +import { FilePageLinkModel } from '@osf/shared/models/files/file-page-link.model'; import { NodeShortInfoModel } from '@osf/shared/models/nodes/node-with-children.model'; import { ProjectModel } from '@osf/shared/models/projects/projects.model'; import { SelectOption } from '@osf/shared/models/select-option.model'; +import { FilesService } from '@osf/shared/services/files.service'; import { ViewOnlyLinkHelperService } from '@osf/shared/services/view-only-link-helper.service'; @Component({ @@ -56,9 +58,10 @@ export class FilesWidgetComponent { router = inject(Router); activeRoute = inject(ActivatedRoute); - private readonly environment = inject(ENVIRONMENT); private readonly destroyRef = inject(DestroyRef); private readonly viewOnlyService = inject(ViewOnlyLinkHelperService); + private readonly filesService = inject(FilesService); + private readonly translateService = inject(TranslateService); private readonly platformId = inject(PLATFORM_ID); private readonly isBrowser = isPlatformBrowser(this.platformId); @@ -75,7 +78,7 @@ export class FilesWidgetComponent { currentRootFolder = model(null); pageNumber = signal(1); - readonly osfStorageLabel = 'OSF Storage'; + readonly resourceType = CurrentResourceType.Projects; readonly options = computed(() => { const components = this.components().filter((component) => this.rootOption().value !== component.id); @@ -83,15 +86,8 @@ export class FilesWidgetComponent { }); readonly storageAddons = computed(() => { - const rootFolders = this.rootFolders(); - const addons = this.configuredStorageAddons(); - if (rootFolders && addons) { - return rootFolders.map((folder) => ({ - label: this.getAddonName(addons, folder.provider), - folder: folder, - })); - } - return []; + const osfLabel = this.translateService.instant('files.storageLocation'); + return mapRootFoldersToStorageLabels(this.rootFolders(), this.configuredStorageAddons(), osfLabel); }); readonly hasViewOnly = computed(() => this.viewOnlyService.hasViewOnlyParam(this.router)); @@ -129,7 +125,7 @@ export class FilesWidgetComponent { const osfRootFolder = rootFolders.find((folder) => folder.provider === FileProvider.OsfStorage); if (osfRootFolder) { this.currentRootFolder.set({ - label: this.osfStorageLabel, + label: this.translateService.instant('files.storageLocation'), folder: osfRootFolder, }); } @@ -160,11 +156,8 @@ export class FilesWidgetComponent { } private getStorageAddons(projectId: string) { - const resourcePath = 'nodes'; - const folderLink = `${this.environment.apiDomainUrl}/v2/${resourcePath}/${projectId}/files/`; - const iriLink = `${this.environment.webUrl}/${projectId}`; - this.actions.getRootFolders(folderLink); - this.actions.getConfiguredStorageAddons(iriLink); + this.actions.getRootFolders(projectId, ResourceType.Project); + this.actions.getConfiguredStorageAddons(projectId); } private flatComponents( @@ -205,14 +198,6 @@ export class FilesWidgetComponent { }, []); } - private getAddonName(addons: ConfiguredAddonModel[], provider: string): string { - if (provider === FileProvider.OsfStorage) { - return this.osfStorageLabel; - } else { - return addons.find((addon) => addon.externalServiceName === provider)?.displayName ?? ''; - } - } - onChangeProject(value: Primitive) { this.getStorageAddons(value as string); } @@ -225,16 +210,27 @@ export class FilesWidgetComponent { } navigateToFile(file: FileModel) { + if (file.guid) { + this.openFile(file.guid); + return; + } + + this.filesService.getFileGuid(file.id).subscribe((file) => { + if (file.guid) { + this.openFile(file.guid); + } + }); + } + + private openFile(guid: string): void { const extras = this.hasViewOnly() ? { queryParams: { view_only: this.viewOnlyService.getViewOnlyParamFromUrl(this.router.url) } } : undefined; - const url = this.router.serializeUrl(this.router.createUrlTree(['/', file.guid], extras)); - - window.open(url, '_blank'); + window.open(this.router.serializeUrl(this.router.createUrlTree(['/', guid], extras)), '_blank'); } - onLoadFiles(event: { link: string; page: number }) { + onLoadFiles(event: FilePageLinkModel) { this.actions.getFiles(event.link, event.page); } diff --git a/src/app/features/registries/components/files-control/files-control.component.html b/src/app/features/registries/components/files-control/files-control.component.html index 951fcac20..7a308fdd0 100644 --- a/src/app/features/registries/components/files-control/files-control.component.html +++ b/src/app/features/registries/components/files-control/files-control.component.html @@ -49,6 +49,7 @@ [scrollHeight]="'500px'" [viewOnly]="filesViewOnly()" [resourceId]="projectId()" + [resourceType]="resourceType" [provider]="provider()" [selectedFiles]="filesSelection" [isDraftResource]="true" diff --git a/src/app/features/registries/components/files-control/files-control.component.spec.ts b/src/app/features/registries/components/files-control/files-control.component.spec.ts index 1557f575a..415b22bc7 100644 --- a/src/app/features/registries/components/files-control/files-control.component.spec.ts +++ b/src/app/features/registries/components/files-control/files-control.component.spec.ts @@ -2,8 +2,6 @@ import { Store } from '@ngxs/store'; import { MockComponents, MockProvider } from 'ng-mocks'; -import { TreeDragDropService } from 'primeng/api'; - import { of, Subject } from 'rxjs'; import { Mock } from 'vitest'; @@ -70,7 +68,6 @@ describe('FilesControlComponent', () => { MockProvider(CustomConfirmationService), MockProvider(FilesService, mockFilesService), MockProvider(CustomDialogService, mockDialogService), - MockProvider(TreeDragDropService), provideMockStore({ signals: [ { selector: RegistriesSelectors.getFiles, value: [] }, diff --git a/src/app/features/registries/components/files-control/files-control.component.ts b/src/app/features/registries/components/files-control/files-control.component.ts index fd367abbc..1606151b4 100644 --- a/src/app/features/registries/components/files-control/files-control.component.ts +++ b/src/app/features/registries/components/files-control/files-control.component.ts @@ -2,7 +2,6 @@ import { createDispatchMap, select } from '@ngxs/store'; import { TranslatePipe } from '@ngx-translate/core'; -import { TreeDragDropService } from 'primeng/api'; import { Button } from 'primeng/button'; import { filter, finalize, switchMap, take } from 'rxjs'; @@ -17,6 +16,8 @@ import { FilesTreeComponent } from '@osf/shared/components/files-tree/files-tree import { LoadingSpinnerComponent } from '@osf/shared/components/loading-spinner/loading-spinner.component'; import { FILE_SIZE_LIMIT } from '@osf/shared/constants/files-limits.const'; import { ClearFileDirective } from '@osf/shared/directives/clear-file.directive'; +import { CurrentResourceType } from '@osf/shared/enums/resource-type.enum'; +import { FilePageLinkModel } from '@osf/shared/models/files/file-page-link.model'; import { CustomDialogService } from '@osf/shared/services/custom-dialog.service'; import { FilesService } from '@osf/shared/services/files.service'; import { ToastService } from '@osf/shared/services/toast.service'; @@ -46,7 +47,6 @@ import { templateUrl: './files-control.component.html', styleUrl: './files-control.component.scss', changeDetection: ChangeDetectionStrategy.OnPush, - providers: [TreeDragDropService], }) export class FilesControlComponent { attachedFiles = input.required[]>(); @@ -71,6 +71,7 @@ export class FilesControlComponent { readonly progress = signal(0); readonly fileName = signal(''); readonly dataLoaded = signal(false); + readonly resourceType = CurrentResourceType.Registrations; fileIsUploading = signal(false); filesSelection: FileModel[] = []; @@ -180,7 +181,7 @@ export class FilesControlComponent { this.filesSelection = [...new Set(this.filesSelection)]; } - onLoadFiles(event: { link: string; page: number }) { + onLoadFiles(event: FilePageLinkModel) { this.actions.getFiles(event.link, event.page); } diff --git a/src/app/shared/components/file-menu/file-menu.component.html b/src/app/shared/components/file-menu/file-menu.component.html index cb17cb23f..f5b180995 100644 --- a/src/app/shared/components/file-menu/file-menu.component.html +++ b/src/app/shared/components/file-menu/file-menu.component.html @@ -6,7 +6,7 @@ variant="text" [raised]="true" icon="fas fa-ellipsis-v" - (click)="onMenuToggle($event)" + (onClick)="onMenuToggle($event)" > diff --git a/src/app/shared/components/file-select-destination/file-select-destination.component.ts b/src/app/shared/components/file-select-destination/file-select-destination.component.ts index b88134e4c..ab27aaf53 100644 --- a/src/app/shared/components/file-select-destination/file-select-destination.component.ts +++ b/src/app/shared/components/file-select-destination/file-select-destination.component.ts @@ -1,6 +1,6 @@ import { createDispatchMap, select } from '@ngxs/store'; -import { TranslatePipe } from '@ngx-translate/core'; +import { TranslatePipe, TranslateService } from '@ngx-translate/core'; import { Button } from 'primeng/button'; import { Skeleton } from 'primeng/skeleton'; @@ -23,8 +23,6 @@ import { } from '@angular/core'; import { takeUntilDestroyed } from '@angular/core/rxjs-interop'; -import { ENVIRONMENT } from '@core/provider/environment.provider'; -import { FileProvider } from '@osf/features/files/constants'; import { FilesSelectors, GetMoveDialogConfiguredStorageAddons, @@ -34,9 +32,10 @@ import { SetMoveDialogCurrentFolder, } from '@osf/features/files/store'; import { SupportedFeature } from '@osf/shared/enums/addon-supported-features.enum'; +import { ResourceType } from '@osf/shared/enums/resource-type.enum'; import { UserPermissions } from '@osf/shared/enums/user-permissions.enum'; +import { mapRootFoldersToStorageLabels } from '@osf/shared/helpers/storage-addon-options.helper'; import { Primitive } from '@osf/shared/helpers/types.helper'; -import { ConfiguredAddonModel } from '@osf/shared/models/addons/configured-addon.model'; import { FileLabelModel } from '@osf/shared/models/files/file-label.model'; import { NodeShortInfoModel } from '@osf/shared/models/nodes/node-with-children.model'; import { SelectOption } from '@osf/shared/models/select-option.model'; @@ -58,8 +57,8 @@ export class FileSelectDestinationComponent implements OnInit { selectProject = output(); selectStorage = output(); - private readonly environment = inject(ENVIRONMENT); private readonly destroyRef = inject(DestroyRef); + private readonly translateService = inject(TranslateService); readonly rootFolders = select(FilesSelectors.getMoveDialogRootFolders); readonly isRootFoldersLoading = select(FilesSelectors.isMoveDialogRootFoldersLoading); @@ -77,7 +76,6 @@ export class FileSelectDestinationComponent implements OnInit { setCurrentProvider: SetCurrentProvider, }); - readonly osfStorageLabel = 'OSF Storage'; initialSetup = true; currentRootFolder = model(null); selectedProject = computed(() => this.options().find((c) => c.value === this.projectId()) || null); @@ -96,15 +94,8 @@ export class FileSelectDestinationComponent implements OnInit { }); readonly storageAddons = computed(() => { - const rootFolders = this.rootFolders(); - const addons = this.configuredStorageAddons(); - if (rootFolders && addons) { - return rootFolders.map((folder) => ({ - label: this.getAddonName(addons, folder.provider), - folder: folder, - })); - } - return []; + const osfLabel = this.translateService.instant('files.storageLocation'); + return mapRootFoldersToStorageLabels(this.rootFolders(), this.configuredStorageAddons(), osfLabel); }); private getHasWriteAccess = (project: NodeShortInfoModel): boolean => @@ -149,13 +140,9 @@ export class FileSelectDestinationComponent implements OnInit { } private getStorageAddons(projectId: string) { - const resourcePath = 'nodes'; - const folderLink = `${this.environment.apiDomainUrl}/v2/${resourcePath}/${projectId}/files/`; - const iriLink = `${this.environment.webUrl}/${projectId}`; - forkJoin({ - rootFolders: this.actions.getRootFolders(folderLink), - addons: this.actions.getConfiguredStorageAddons(iriLink), + rootFolders: this.actions.getRootFolders(projectId, ResourceType.Project), + addons: this.actions.getConfiguredStorageAddons(projectId), }) .pipe( takeUntilDestroyed(this.destroyRef), @@ -185,14 +172,6 @@ export class FileSelectDestinationComponent implements OnInit { }); } - private getAddonName(addons: ConfiguredAddonModel[], provider: string): string { - if (provider === FileProvider.OsfStorage) { - return this.osfStorageLabel; - } else { - return addons.find((addon) => addon.externalServiceName === provider)?.displayName ?? ''; - } - } - private buildOptions(nodes: NodeShortInfoModel[] = [], parentPath = '..'): SelectOption[] { return nodes.reduce((acc, node) => { const pathParts: string[] = []; diff --git a/src/app/shared/components/files-drop-zone/files-drop-zone.component.html b/src/app/shared/components/files-drop-zone/files-drop-zone.component.html new file mode 100644 index 000000000..16f925a91 --- /dev/null +++ b/src/app/shared/components/files-drop-zone/files-drop-zone.component.html @@ -0,0 +1,20 @@ +
+ @if (enabled()) { +
+ @if (isDragOver()) { +
+ +

{{ 'files.dropText' | translate }}

+
+ } +
+ } + + +
diff --git a/src/app/shared/components/files-drop-zone/files-drop-zone.component.scss b/src/app/shared/components/files-drop-zone/files-drop-zone.component.scss new file mode 100644 index 000000000..8e5f40b7b --- /dev/null +++ b/src/app/shared/components/files-drop-zone/files-drop-zone.component.scss @@ -0,0 +1,27 @@ +.drop-zone-container { + position: relative; +} + +.drop-zone { + position: absolute; + top: 0; + left: 0; + width: 100%; + height: 100%; + z-index: 1000; + display: flex; + align-items: center; + justify-content: center; + color: var(--white); + transition: + background 0.3s ease, + backdrop-filter 0.3s ease; + pointer-events: none; + background: transparent; + + &.active { + backdrop-filter: blur(0.3rem); + background: rgba(132, 174, 210, 0.5); + pointer-events: all; + } +} diff --git a/src/app/shared/components/files-drop-zone/files-drop-zone.component.ts b/src/app/shared/components/files-drop-zone/files-drop-zone.component.ts new file mode 100644 index 000000000..fb8f1e264 --- /dev/null +++ b/src/app/shared/components/files-drop-zone/files-drop-zone.component.ts @@ -0,0 +1,73 @@ +import { TranslatePipe } from '@ngx-translate/core'; + +import { ChangeDetectionStrategy, Component, input, output, signal } from '@angular/core'; + +@Component({ + selector: 'osf-files-drop-zone', + imports: [TranslatePipe], + templateUrl: './files-drop-zone.component.html', + styleUrl: './files-drop-zone.component.scss', + changeDetection: ChangeDetectionStrategy.OnPush, +}) +export class FilesDropZoneComponent { + enabled = input(true); + filesDropped = output(); + isDragOver = signal(false); + + private dragDepth = 0; + + onDragEnter(event: DragEvent): void { + if (!this.enabled()) { + return; + } + + if (event.dataTransfer?.types?.includes('Files')) { + this.dragDepth += 1; + this.isDragOver.set(true); + } + } + + onDragOver(event: DragEvent): void { + if (!this.enabled()) { + return; + } + + event.preventDefault(); + event.stopPropagation(); + if (event.dataTransfer) { + event.dataTransfer.dropEffect = 'copy'; + } + this.isDragOver.set(true); + } + + onDragLeave(event: Event): void { + if (!this.enabled()) { + return; + } + + event.preventDefault(); + event.stopPropagation(); + this.dragDepth = Math.max(0, this.dragDepth - 1); + if (this.dragDepth === 0) { + this.isDragOver.set(false); + } + } + + onDrop(event: DragEvent): void { + event.preventDefault(); + event.stopPropagation(); + this.dragDepth = 0; + this.isDragOver.set(false); + + if (!this.enabled()) { + return; + } + + const files = event.dataTransfer?.files; + if (!files || files.length === 0) { + return; + } + + this.filesDropped.emit(Array.from(files)); + } +} diff --git a/src/app/shared/components/files-tree-row/files-tree-row.component.html b/src/app/shared/components/files-tree-row/files-tree-row.component.html new file mode 100644 index 000000000..f08cab3ac --- /dev/null +++ b/src/app/shared/components/files-tree-row/files-tree-row.component.html @@ -0,0 +1,54 @@ +@if (file().previousFolder) { +
+ + + + {{ file().name }} + +
+} @else { +
+
+ +
+ +
+ @if (downloadsCount()) { + {{ downloadsCount() }} {{ 'common.labels.downloads' | translate }} + } +
+ +
+ {{ file().size | fileSize }} +
+ +
+ {{ file().dateModified | date: 'MMM d, y hh:mm a' }} +
+ + @if (showMenu()) { +
+ + +
+ } +
+} diff --git a/src/app/shared/components/files-tree-row/files-tree-row.component.scss b/src/app/shared/components/files-tree-row/files-tree-row.component.scss new file mode 100644 index 000000000..e24a1d7eb --- /dev/null +++ b/src/app/shared/components/files-tree-row/files-tree-row.component.scss @@ -0,0 +1,30 @@ +@use "styles/mixins" as mix; + +.files-table-row { + display: grid; + align-items: center; + grid-template-columns: + minmax(mix.rem(200px), 32rem) minmax(mix.rem(150px), 0.7fr) minmax(mix.rem(100px), 100px) + minmax(mix.rem(150px), 1fr) minmax(mix.rem(50px), 50px); + grid-template-rows: mix.rem(44px); + border-bottom: 1px solid var(--grey-2); + padding: 0 0.75rem; + cursor: pointer; + + &.previous-folder { + grid-template-columns: auto; + } + + &:hover { + background: var(--bg-blue-3); + } + + &:active { + background: var(--bg-blue-2); + } + + .table-cell { + width: 100%; + height: 100%; + } +} diff --git a/src/app/shared/components/files-tree-row/files-tree-row.component.spec.ts b/src/app/shared/components/files-tree-row/files-tree-row.component.spec.ts new file mode 100644 index 000000000..9d2dc991f --- /dev/null +++ b/src/app/shared/components/files-tree-row/files-tree-row.component.spec.ts @@ -0,0 +1,130 @@ +import { MockComponent } from 'ng-mocks'; + +import { ComponentFixture, TestBed } from '@angular/core/testing'; + +import { FileKind } from '@osf/shared/enums/file-kind.enum'; +import { FileMenuType } from '@osf/shared/enums/file-menu-type.enum'; +import { FileModel } from '@shared/models/files/file.model'; +import { FileMenuFlags } from '@shared/models/files/file-menu-action.model'; + +import { provideOSFCore } from '@testing/osf.testing.provider'; + +import { FileMenuComponent } from '../file-menu/file-menu.component'; + +import { FilesTreeRowComponent } from './files-tree-row.component'; + +describe('FilesTreeRowComponent', () => { + let component: FilesTreeRowComponent; + let fixture: ComponentFixture; + + const ALL_MENU_ACTIONS: FileMenuFlags = { + [FileMenuType.Download]: true, + [FileMenuType.Copy]: true, + [FileMenuType.Move]: true, + [FileMenuType.Delete]: true, + [FileMenuType.Rename]: true, + [FileMenuType.Share]: true, + [FileMenuType.Embed]: true, + }; + + function createTestFile(overrides: Partial = {}): FileModel { + return { + id: 'f1', + guid: 'g1', + name: 'test.pdf', + kind: FileKind.File, + path: '/test.pdf', + size: 2048, + materializedPath: '/test.pdf', + dateModified: '2024-06-01T12:00:00.000Z', + extra: { + hashes: { md5: 'm', sha256: 's' }, + downloads: 5, + }, + links: { + info: 'i', + move: 'm', + upload: 'u', + delete: 'd', + download: 'dl', + render: 'r', + html: 'h', + self: 's', + }, + filesLink: null, + previousFolder: false, + provider: 'osfstorage', + ...overrides, + }; + } + + beforeEach(() => { + TestBed.configureTestingModule({ + imports: [FilesTreeRowComponent, MockComponent(FileMenuComponent)], + providers: [provideOSFCore()], + }); + + fixture = TestBed.createComponent(FilesTreeRowComponent); + component = fixture.componentInstance; + fixture.componentRef.setInput('file', createTestFile()); + fixture.componentRef.setInput('allowedMenuActions', ALL_MENU_ACTIONS); + fixture.detectChanges(); + }); + + it('should create', () => { + expect(component).toBeTruthy(); + }); + + it('should set isFolder when kind is folder', () => { + fixture.componentRef.setInput('file', createTestFile({ kind: FileKind.Folder })); + fixture.detectChanges(); + + expect(component.isFolder()).toBe(true); + }); + + it('should set isFolder false when kind is file', () => { + fixture.componentRef.setInput('file', createTestFile({ kind: FileKind.File })); + fixture.detectChanges(); + + expect(component.isFolder()).toBe(false); + }); + + it('should clear downloadsCount for folder', () => { + fixture.componentRef.setInput( + 'file', + createTestFile({ + kind: FileKind.Folder, + extra: { hashes: { md5: 'm', sha256: 's' }, downloads: 99 }, + }) + ); + fixture.detectChanges(); + + expect(component.downloadsCount()).toBe(''); + }); + + it('should expose downloadsCount for file with downloads', () => { + fixture.componentRef.setInput( + 'file', + createTestFile({ + kind: FileKind.File, + extra: { hashes: { md5: 'm', sha256: 's' }, downloads: 12 }, + }) + ); + fixture.detectChanges(); + + expect(component.downloadsCount()).toBe(12); + }); + + it('should clear downloadsCount when downloads is zero', () => { + fixture.componentRef.setInput( + 'file', + createTestFile({ + kind: FileKind.File, + extra: { hashes: { md5: 'm', sha256: 's' }, downloads: 0 }, + }) + ); + fixture.detectChanges(); + + expect(component.downloadsCount()).toBe(''); + }); +}); diff --git a/src/app/shared/components/files-tree-row/files-tree-row.component.ts b/src/app/shared/components/files-tree-row/files-tree-row.component.ts new file mode 100644 index 000000000..4463ec213 --- /dev/null +++ b/src/app/shared/components/files-tree-row/files-tree-row.component.ts @@ -0,0 +1,45 @@ +import { TranslatePipe } from '@ngx-translate/core'; + +import { Button } from 'primeng/button'; + +import { DatePipe } from '@angular/common'; +import { ChangeDetectionStrategy, Component, computed, input, output } from '@angular/core'; + +import { StopPropagationDirective } from '@osf/shared/directives/stop-propagation.directive'; +import { FileKind } from '@osf/shared/enums/file-kind.enum'; +import { FileModel } from '@shared/models/files/file.model'; +import { FileMenuAction, FileMenuFlags } from '@shared/models/files/file-menu-action.model'; + +import { FileSizePipe } from '../../pipes/file-size.pipe'; +import { FileMenuComponent } from '../file-menu/file-menu.component'; + +@Component({ + selector: 'osf-files-tree-row', + imports: [Button, DatePipe, FileSizePipe, TranslatePipe, FileMenuComponent, StopPropagationDirective], + templateUrl: './files-tree-row.component.html', + styleUrl: './files-tree-row.component.scss', + changeDetection: ChangeDetectionStrategy.OnPush, +}) +export class FilesTreeRowComponent { + file = input.required(); + hasFoldersStack = input(false); + showMenu = input(false); + allowedMenuActions = input.required(); + + openParentFolder = output(); + openEntry = output(); + menuAction = output(); + + readonly isFolder = computed(() => this.file().kind === FileKind.Folder); + + readonly downloadsCount = computed(() => { + if (!this.file().extra.downloads || this.isFolder()) { + return ''; + } + return this.file().extra.downloads; + }); + + onOpenEntry(): void { + this.openEntry.emit(this.file()); + } +} diff --git a/src/app/shared/components/files-tree/files-tree.component.html b/src/app/shared/components/files-tree/files-tree.component.html index ba61a2c22..d038cb3fe 100644 --- a/src/app/shared/components/files-tree/files-tree.component.html +++ b/src/app/shared/components/files-tree/files-tree.component.html @@ -1,130 +1,52 @@ -
- @if (!hasViewOnly() && supportUpload()) { -
- @if (isDragOver()) { -
- -

{{ 'files.dropText' | translate }}

-
- } -
- } - + @if (isLoading() && !isLoadingMore()) {
} @else { -
-
- - - @if (file.previousFolder) { -
-
- - - {{ file.name ?? '' }} -
-
- } @else { -
-
-
- - {{ file?.name ?? '' }} -
-
- -
- @if (file.extra.downloads) { - {{ - file.kind === 'file' ? file.extra.downloads + ' ' + ('common.labels.downloads' | translate) : '' - }} - } -
- -
- {{ file.size | fileSize }} -
- -
- {{ file.dateModified | date: 'MMM d, y hh:mm a' }} -
- - @if (isSomeFileActionAllowed && !selectedFiles().length) { -
- - -
- } - @if (isDraftResource()) { - - } -
- } - - +
+ + + + - @if (!files().length) { -
- @if (hasViewOnly() || !supportUpload()) { + +
+ @if (!canUpload()) {

{{ 'files.emptyState' | translate }}

} @else { -
+

{{ 'files.dropText' | translate }}

}
- } -
+ +
} -
+ diff --git a/src/app/shared/components/files-tree/files-tree.component.scss b/src/app/shared/components/files-tree/files-tree.component.scss index 3984d465f..190e70847 100644 --- a/src/app/shared/components/files-tree/files-tree.component.scss +++ b/src/app/shared/components/files-tree/files-tree.component.scss @@ -1,88 +1,13 @@ -@use "styles/mixins" as mix; - :host { - min-height: 180px; display: flex; flex-direction: column; + min-height: 11.25rem; } .files-table { - display: flex; - flex-direction: column; border: 1px solid var(--grey-2); - border-radius: 8px; - overflow-x: auto; + border-radius: 0.5rem; min-width: 100%; - min-height: 180px; - - &-row { - color: var(--dark-blue-1); - display: grid; - align-items: center; - grid-template-columns: - minmax(mix.rem(200px), 32rem) minmax(mix.rem(150px), 0.7fr) minmax(mix.rem(100px), 100px) - minmax(mix.rem(150px), 1fr) minmax(mix.rem(50px), 50px); - grid-template-rows: mix.rem(44px); - border-bottom: 1px solid var(--grey-2); - padding: 0 mix.rem(12px); - cursor: pointer; - - &:hover { - background: var(--bg-blue-3); - } - - &:active { - background: var(--bg-blue-2); - } - - .table-cell { - width: 100%; - height: 100%; - display: flex; - align-items: center; - } - - > .table-cell:first-child { - max-width: 95%; - } - } -} - -.entry-title { - display: block; - overflow: hidden; - text-overflow: ellipsis; - white-space: nowrap; - min-width: 0; - max-width: 100%; -} - -.tree-table { - .p-tree { - padding: 0; - } -} - -.drop-zone { - position: absolute; - top: 0; - left: 0; - width: 100%; - height: 100%; - z-index: 1000; - display: flex; - align-items: center; - justify-content: center; - color: var(--white); - transition: - background 0.3s ease, - backdrop-filter 0.3s ease; - pointer-events: none; - background: transparent; - - &.active { - backdrop-filter: blur(0.3rem); - background: rgba(132, 174, 210, 0.5); - pointer-events: all; - } + min-height: 11.25rem; + overflow-x: auto; } diff --git a/src/app/shared/components/files-tree/files-tree.component.spec.ts b/src/app/shared/components/files-tree/files-tree.component.spec.ts index 59a8bf61c..64d84dcbc 100644 --- a/src/app/shared/components/files-tree/files-tree.component.spec.ts +++ b/src/app/shared/components/files-tree/files-tree.component.spec.ts @@ -2,7 +2,6 @@ import { MockComponents, MockProvider } from 'ng-mocks'; import { TreeDragDropService } from 'primeng/api'; -import { signal } from '@angular/core'; import { ComponentFixture, TestBed } from '@angular/core/testing'; import { provideRouter } from '@angular/router'; @@ -12,14 +11,12 @@ import { CustomDialogService } from '@osf/shared/services/custom-dialog.service' import { DataciteService } from '@osf/shared/services/datacite/datacite.service'; import { FilesService } from '@osf/shared/services/files.service'; import { ToastService } from '@osf/shared/services/toast.service'; -import { CurrentResourceSelectors } from '@osf/shared/stores/current-resource'; import { FileFolderModel } from '@shared/models/files/file-folder.model'; import { FileLabelModel } from '@shared/models/files/file-label.model'; import { OSF_FILE_MOCK } from '@testing/mocks/osf-file.mock'; import { provideOSFCore } from '@testing/osf.testing.provider'; import { DataciteServiceMock, DataciteServiceMockType } from '@testing/providers/datacite.service.mock'; -import { provideMockStore } from '@testing/providers/store-provider.mock'; import { FileMenuComponent } from '../file-menu/file-menu.component'; import { LoadingSpinnerComponent } from '../loading-spinner/loading-spinner.component'; @@ -50,15 +47,12 @@ describe('FilesTreeComponent', () => { providers: [ provideOSFCore(), provideRouter([]), - provideMockStore({ - signals: [{ selector: CurrentResourceSelectors.getCurrentResource, value: signal(null) }], - }), MockProvider(DataciteService, dataciteMock), MockProvider(FilesService), MockProvider(ToastService), MockProvider(CustomConfirmationService), MockProvider(CustomDialogService), - TreeDragDropService, + MockProvider(TreeDragDropService), ], }); diff --git a/src/app/shared/components/files-tree/files-tree.component.ts b/src/app/shared/components/files-tree/files-tree.component.ts index efe638512..a5e51c8f1 100644 --- a/src/app/shared/components/files-tree/files-tree.component.ts +++ b/src/app/shared/components/files-tree/files-tree.component.ts @@ -1,96 +1,70 @@ -import { select } from '@ngxs/store'; - import { TranslatePipe } from '@ngx-translate/core'; -import { PrimeTemplate, TreeNode } from 'primeng/api'; -import { Button } from 'primeng/button'; -import { Tooltip } from 'primeng/tooltip'; +import { PrimeTemplate, TreeDragDropService } from 'primeng/api'; import { Tree, TreeLazyLoadEvent, TreeNodeDropEvent, TreeNodeSelectEvent } from 'primeng/tree'; -import { Clipboard } from '@angular/cdk/clipboard'; -import { DatePipe, isPlatformBrowser } from '@angular/common'; +import { filter } from 'rxjs'; + +import { isPlatformBrowser } from '@angular/common'; import { - AfterViewInit, ChangeDetectionStrategy, Component, computed, DestroyRef, effect, - ElementRef, - HostBinding, inject, input, - OnDestroy, + model, output, PLATFORM_ID, signal, - viewChild, } from '@angular/core'; import { takeUntilDestroyed } from '@angular/core/rxjs-interop'; -import { ActivatedRoute, Router } from '@angular/router'; +import { Router } from '@angular/router'; -import { ENVIRONMENT } from '@core/provider/environment.provider'; import { ConfirmMoveFileDialogComponent } from '@osf/features/files/components/confirm-move-file-dialog/confirm-move-file-dialog.component'; import { MoveFileDialogComponent } from '@osf/features/files/components/move-file-dialog/move-file-dialog.component'; import { RenameFileDialogComponent } from '@osf/features/files/components/rename-file-dialog/rename-file-dialog.component'; -import { embedDynamicJs, embedStaticHtml } from '@osf/features/files/constants'; -import { StopPropagationDirective } from '@osf/shared/directives/stop-propagation.directive'; import { FileKind } from '@osf/shared/enums/file-kind.enum'; import { FileMenuType } from '@osf/shared/enums/file-menu-type.enum'; +import { CurrentResourceType } from '@osf/shared/enums/resource-type.enum'; +import { FileTreeMapper } from '@osf/shared/mappers/files/file-tree.mapper'; import { FilesMapper } from '@osf/shared/mappers/files/files.mapper'; -import { FileSizePipe } from '@osf/shared/pipes/file-size.pipe'; +import { FilePageLinkModel } from '@osf/shared/models/files/file-page-link.model'; +import { RenamedFileLinkModel } from '@osf/shared/models/files/renamed-file-link.model'; import { CustomConfirmationService } from '@osf/shared/services/custom-confirmation.service'; import { CustomDialogService } from '@osf/shared/services/custom-dialog.service'; import { DataciteService } from '@osf/shared/services/datacite/datacite.service'; import { FilesService } from '@osf/shared/services/files.service'; -import { ToastService } from '@osf/shared/services/toast.service'; +import { FilesShareEmbedService } from '@osf/shared/services/files-share-embed.service'; import { ViewOnlyLinkHelperService } from '@osf/shared/services/view-only-link-helper.service'; import { FileModel } from '@shared/models/files/file.model'; import { FileFolderModel } from '@shared/models/files/file-folder.model'; import { FileLabelModel } from '@shared/models/files/file-label.model'; import { FileMenuAction, FileMenuFlags } from '@shared/models/files/file-menu-action.model'; -import { CurrentResourceSelectors } from '@shared/stores/current-resource'; -import { FileMenuComponent } from '../file-menu/file-menu.component'; +import { FilesDropZoneComponent } from '../files-drop-zone/files-drop-zone.component'; +import { FilesTreeRowComponent } from '../files-tree-row/files-tree-row.component'; import { LoadingSpinnerComponent } from '../loading-spinner/loading-spinner.component'; -// [NS] Temporary fix -type FileTreeNode = FileModel & TreeNode; - @Component({ selector: 'osf-files-tree', - imports: [ - DatePipe, - FileSizePipe, - PrimeTemplate, - TranslatePipe, - Tree, - LoadingSpinnerComponent, - FileMenuComponent, - StopPropagationDirective, - Button, - Tooltip, - ], + imports: [PrimeTemplate, TranslatePipe, Tree, LoadingSpinnerComponent, FilesDropZoneComponent, FilesTreeRowComponent], + providers: [TreeDragDropService], templateUrl: './files-tree.component.html', styleUrl: './files-tree.component.scss', changeDetection: ChangeDetectionStrategy.OnPush, }) -export class FilesTreeComponent implements OnDestroy, AfterViewInit { - @HostBinding('class') classes = 'relative'; - private dropZoneContainerRef = viewChild('dropZoneContainer'); - readonly filesService = inject(FilesService); - readonly router = inject(Router); - readonly toastService = inject(ToastService); - readonly route = inject(ActivatedRoute); - readonly customConfirmationService = inject(CustomConfirmationService); - readonly customDialogService = inject(CustomDialogService); - readonly dataciteService = inject(DataciteService); - private readonly viewOnlyService = inject(ViewOnlyLinkHelperService); - +export class FilesTreeComponent { private readonly destroyRef = inject(DestroyRef); - private readonly environment = inject(ENVIRONMENT); - private readonly platformId = inject(PLATFORM_ID); - readonly clipboard = inject(Clipboard); + private readonly router = inject(Router); + private readonly filesService = inject(FilesService); + private readonly customConfirmationService = inject(CustomConfirmationService); + private readonly customDialogService = inject(CustomDialogService); + private readonly dataciteService = inject(DataciteService); + private readonly filesShareEmbedService = inject(FilesShareEmbedService); + private readonly viewOnlyService = inject(ViewOnlyLinkHelperService); + private readonly isBrowser = isPlatformBrowser(inject(PLATFORM_ID)); files = input.required(); totalCount = input(0); @@ -98,6 +72,7 @@ export class FilesTreeComponent implements OnDestroy, AfterViewInit { currentFolder = input.required(); storage = input.required(); resourceId = input.required(); + resourceType = input(CurrentResourceType.Projects); viewOnly = input(true); provider = input(); allowedMenuActions = input({} as FileMenuFlags); @@ -112,60 +87,44 @@ export class FilesTreeComponent implements OnDestroy, AfterViewInit { setCurrentFolder = output(); setMoveDialogCurrentFolder = output(); deleteEntryAction = output(); - renameEntryAction = output<{ newName: string; link: string }>(); - loadFiles = output<{ link: string; page: number }>(); + renameEntryAction = output(); + loadFiles = output(); selectFile = output(); unselectFile = output(); clearSelection = output(); - updateFoldersStack = output(); resetFilesProvider = output(); - readonly resourceMetadata = select(CurrentResourceSelectors.getCurrentResource); - - foldersStack: FileFolderModel[] = []; + foldersStack = model([]); lastSelectedFile: FileModel | null = null; itemsPerPage = 10; virtualScrollItemSize = 46; - isDragOver = signal(false); isLoadingMore = signal(false); - hasViewOnly = computed(() => this.viewOnlyService.hasViewOnlyParam(this.router) || this.viewOnly()); - visibleFilesCount = computed((): number => { - const height = parseInt(this.scrollHeight(), 10); - return Math.ceil(height / this.virtualScrollItemSize); - }); - - get isSomeFileActionAllowed(): boolean { - return Object.keys(this.allowedMenuActions()).length > 0; - } + readonly hasViewOnly = computed(() => this.viewOnlyService.hasViewOnlyParam(this.router) || this.viewOnly()); + readonly canUpload = computed(() => !this.hasViewOnly() && this.supportUpload()); + readonly canShowMenu = computed( + () => Object.keys(this.allowedMenuActions()).length > 0 && !this.selectedFiles().length + ); readonly nodes = computed(() => { const currentFolder = this.currentFolder(); const files = this.files(); - const hasParent = this.foldersStack.length > 0; - if (hasParent) { - return [ - { - ...currentFolder, - previousFolder: hasParent, - }, - ...files, - ] as FileModel[]; - } else { - return [...files]; - } + + const values = this.foldersStack().length + ? ([{ ...currentFolder, previousFolder: true }, ...files] as FileModel[]) + : files; + + return FileTreeMapper.toTreeNodes(values); }); - // [NS] Temporary fix - readonly selectedNodes = computed(() => this.selectedFiles() as FileTreeNode[]); + readonly selectedNodes = computed(() => FileTreeMapper.toTreeNodes(this.selectedFiles())); constructor() { effect(() => { const storageChanged = this.storage(); if (storageChanged) { - this.foldersStack = []; - this.updateFoldersStack.emit(this.foldersStack); + this.foldersStack.set([]); } }); @@ -176,83 +135,29 @@ export class FilesTreeComponent implements OnDestroy, AfterViewInit { }); } - ngAfterViewInit(): void { - if (!this.viewOnly()) { - this.dropZoneContainerRef()?.nativeElement?.addEventListener('dragenter', this.dragEnterHandler); - } - } - - ngOnDestroy(): void { - if (this.dropZoneContainerRef()?.nativeElement) { - this.dropZoneContainerRef()!.nativeElement.removeEventListener('dragenter', this.dragEnterHandler); - } - } - - private dragEnterHandler = (event: DragEvent) => { - if (event.dataTransfer?.types?.includes('Files') && !this.viewOnly()) { - this.isDragOver.set(true); - } - }; - - onDragOver(event: DragEvent) { - if (this.viewOnly()) { + onDropFiles(fileArray: File[]): void { + if (!fileArray.length) { return; } - event.preventDefault(); - event.stopPropagation(); - event.dataTransfer!.dropEffect = 'copy'; - this.isDragOver.set(true); - } - onDragLeave(event: Event) { - if (this.viewOnly()) { - return; - } - event.preventDefault(); - event.stopPropagation(); - this.isDragOver.set(false); - } - - onDrop(event: DragEvent) { - event.preventDefault(); - event.stopPropagation(); - this.isDragOver.set(false); - - if (this.viewOnly()) { - return; - } + const isMultiple = fileArray.length > 1; - const files = event.dataTransfer?.files; - - if (files && files.length > 0) { - const fileArray = Array.from(files); - const isMultiple = files.length > 1; - - this.customConfirmationService.confirmAccept({ - headerKey: isMultiple ? 'files.dialogs.uploadFiles.title' : 'files.dialogs.uploadFile.title', - messageParams: isMultiple ? { count: files.length } : { name: files[0].name }, - messageKey: isMultiple ? 'files.dialogs.uploadFiles.message' : 'files.dialogs.uploadFile.message', - acceptLabelKey: 'common.buttons.upload', - onConfirm: () => this.uploadFilesConfirmed.emit(fileArray), - }); - } + this.customConfirmationService.confirmAccept({ + headerKey: isMultiple ? 'files.dialogs.uploadFiles.title' : 'files.dialogs.uploadFile.title', + messageParams: isMultiple ? { count: fileArray.length } : { name: fileArray[0].name }, + messageKey: isMultiple ? 'files.dialogs.uploadFiles.message' : 'files.dialogs.uploadFile.message', + acceptLabelKey: 'common.buttons.upload', + onConfirm: () => this.uploadFilesConfirmed.emit(fileArray), + }); } - openEntry(event: Event, file: FileModel | FileFolderModel) { - event.stopPropagation(); + openEntry(file: FileModel | FileFolderModel) { if (file.kind === FileKind.File) { - if (file.guid) { - this.entryFileClicked.emit(file); - } else { - this.filesService.getFileGuid(file.id).subscribe((file) => { - this.entryFileClicked.emit(file); - }); - } + this.entryFileClicked.emit(file); } else { const current = this.currentFolder(); if (current) { - this.foldersStack.push(current); - this.updateFoldersStack.emit(this.foldersStack); + this.foldersStack.update((stack) => [...stack, current]); } const folder = FilesMapper.mapFileToFolder(file as FileModel); this.setCurrentFolder.emit(folder); @@ -261,11 +166,14 @@ export class FilesTreeComponent implements OnDestroy, AfterViewInit { } openParentFolder() { - const previous = this.foldersStack.pop(); - this.updateFoldersStack.emit(this.foldersStack); + const stack = this.foldersStack(); + const previous = stack[stack.length - 1]; + this.foldersStack.set(stack.slice(0, -1)); + if (previous) { this.setCurrentFolder.emit(previous); } + this.clearSelection.emit(); } @@ -298,47 +206,15 @@ export class FilesTreeComponent implements OnDestroy, AfterViewInit { } downloadFileOrFolder(file: FileModel) { - const resourceType = this.resourceMetadata()?.type ?? 'nodes'; this.dataciteService - .logFileDownload(this.resourceId(), resourceType) + .logFileDownload(this.resourceId(), this.resourceType()) .pipe(takeUntilDestroyed(this.destroyRef)) .subscribe(); + if (file.kind === FileKind.File) { this.downloadFile(file.links.download); } else { - const folder = FilesMapper.mapFileToFolder(file as FileModel); - this.downloadFolder(folder.links.download); - } - } - - private handleShareAction(file: FileModel, shareType?: string): void { - const emailLink = `mailto:?subject=${file.name}&body=${file.links.html}`; - const twitterLink = `https://twitter.com/intent/tweet?url=${file.links.html}&text=${file.name}&via=OSFramework`; - const facebookLink = `https://www.facebook.com/dialog/share?app_id=${this.environment.facebookAppId}&display=popup&href=${file.links.html}&redirect_uri=${file.links.html}`; - - switch (shareType) { - case 'email': - this.openLink(emailLink); - break; - case 'twitter': - this.openLinkNewTab(twitterLink); - break; - case 'facebook': - this.openLinkNewTab(facebookLink); - break; - } - } - - private handleEmbedAction(file: FileModel, embedType?: string): void { - let embedHtml = ''; - if (embedType === 'dynamic') { - embedHtml = embedDynamicJs.replace('ENCODED_URL', file.links.render); - } else if (embedType === 'static') { - embedHtml = embedStaticHtml.replace('ENCODED_URL', file.links.render); - } - - if (embedHtml) { - this.copyToClipboard(embedHtml); + this.downloadFolder(file.links.upload); } } @@ -349,57 +225,37 @@ export class FilesTreeComponent implements OnDestroy, AfterViewInit { messageKey: file.kind === FileKind.Folder ? 'files.dialogs.deleteFolder.message' : 'files.dialogs.deleteFile.message', acceptLabelKey: 'common.buttons.remove', - onConfirm: () => this.confirmDeleteEntry(file), + onConfirm: () => this.deleteEntryAction.emit(file), }); } - confirmDeleteEntry(file: FileModel): void { - this.deleteEntryAction.emit(file); - } - confirmRename(file: FileModel): void { this.customDialogService .open(RenameFileDialogComponent, { header: 'files.dialogs.renameFile.title', width: '448px', - data: { - currentName: file.name, - }, + data: { currentName: file.name }, }) - .onClose.subscribe((newName: string) => { - if (newName) { - this.renameEntry(newName, file); + .onClose.pipe( + takeUntilDestroyed(this.destroyRef), + filter((newName: string) => !!newName) + ) + .subscribe((newName) => { + if (newName.trim() && file.links.upload) { + const link = file.links.upload; + this.renameEntryAction.emit({ newName, link }); } }); } - renameEntry(newName: string, file: FileModel): void { - if (newName.trim() && file.links.upload) { - const link = file.links.upload; - this.renameEntryAction.emit({ newName, link }); - } - } - downloadFile(link: string): void { - if (isPlatformBrowser(this.platformId)) { + if (this.isBrowser) { window.open(link)?.focus(); } } - openLink(link: string): void { - if (isPlatformBrowser(this.platformId)) { - window.location.href = link; - } - } - - openLinkNewTab(link: string): void { - if (isPlatformBrowser(this.platformId)) { - window.open(link, '_blank', 'noopener,noreferrer'); - } - } - downloadFolder(downloadLink: string): void { - if (isPlatformBrowser(this.platformId) && downloadLink) { + if (downloadLink) { const link = this.filesService.getFolderDownloadLink(downloadLink); window.open(link, '_blank')?.focus(); } @@ -416,32 +272,11 @@ export class FilesTreeComponent implements OnDestroy, AfterViewInit { resourceId: this.resourceId(), action: action, storageProvider: this.storage()?.folder.provider, - foldersStack: structuredClone(this.foldersStack), + foldersStack: structuredClone(this.foldersStack()), initialFolder: structuredClone(this.currentFolder()), }, }) - .onClose.subscribe(() => { - this.resetFilesProvider.emit(); - }); - } - - copyToClipboard(embedHtml: string): void { - this.clipboard.copy(embedHtml); - this.toastService.showSuccess('files.detail.toast.copiedToClipboard'); - } - - private loadNextPage(): void { - const total = this.totalCount(); - const loaded = this.files().length; - const nextPage = Math.floor(loaded / this.itemsPerPage) + 1; - - if (!this.isLoadingMore() && loaded < total) { - this.isLoadingMore.set(true); - this.loadFiles.emit({ - link: this.currentFolder()?.links.filesLink ?? '', - page: nextPage, - }); - } + .onClose.subscribe(() => this.resetFilesProvider.emit()); } onLazyLoad(event: TreeLazyLoadEvent) { @@ -453,7 +288,12 @@ export class FilesTreeComponent implements OnDestroy, AfterViewInit { onNodeSelect(event: TreeNodeSelectEvent) { const files = this.files(); - const selectedNode = event.node as FileModel; + const selectedNode = event.node.data as FileModel; + + if (!selectedNode) { + return; + } + if ((event.originalEvent as PointerEvent).shiftKey && this.lastSelectedFile) { const lastIndex = files.indexOf(this.lastSelectedFile); const currentIndex = files.indexOf(selectedNode); @@ -468,25 +308,42 @@ export class FilesTreeComponent implements OnDestroy, AfterViewInit { this.selectFile.emit(file); } } + this.selectFile.emit(selectedNode); this.lastSelectedFile = selectedNode; } onNodeDrop(event: TreeNodeDropEvent) { - const dropFile = event.dropNode as FileModel; - if (dropFile.kind !== FileKind.Folder) { + const dropFile = event.dropNode?.data as FileModel; + + if (dropFile?.kind !== FileKind.Folder) { + return; + } + + const selectedFiles = this.selectedFiles(); + const dragFile = event.dragNode?.data as FileModel; + + if (!dragFile) { return; } - const files = this.selectedFiles(); - const dragFile = event.dragNode as FileModel; - if (!files.includes(dragFile)) { + + const filesToMove = selectedFiles.includes(dragFile) ? selectedFiles : [...selectedFiles, dragFile]; + + if (!selectedFiles.includes(dragFile)) { this.selectFile.emit(dragFile); } - this.moveFilesTo(files, dropFile); + + this.moveFilesTo(filesToMove, dropFile); } onNodeUnselect(event: TreeNodeSelectEvent) { - this.unselectFile.emit(event.node as FileModel); + const unselectedNode = event.node.data as FileModel; + + if (!unselectedNode) { + return; + } + + this.unselectFile.emit(unselectedNode); } private moveFilesTo(files: FileModel[], destination: FileModel) { @@ -502,8 +359,35 @@ export class FilesTreeComponent implements OnDestroy, AfterViewInit { storageProvider: this.storage()?.folder.provider, }, }) - .onClose.subscribe(() => { - this.resetFilesProvider.emit(); - }); + .onClose.subscribe(() => this.resetFilesProvider.emit()); + } + + private loadNextPage(): void { + const total = this.totalCount(); + const loaded = this.files().length; + const nextPage = Math.floor(loaded / this.itemsPerPage) + 1; + + if (!this.isLoadingMore() && loaded < total) { + this.isLoadingMore.set(true); + this.loadFiles.emit({ link: this.currentFolder()?.links.filesLink ?? '', page: nextPage }); + } + } + + private handleShareAction(file: FileModel, shareType?: string): void { + const shareAction = this.filesShareEmbedService.getShareLink(file, shareType); + if (!shareAction || !this.isBrowser) { + return; + } + + if (shareAction.target === '_self') { + window.location.href = shareAction.link; + return; + } + + window.open(shareAction.link, shareAction.target, 'noopener,noreferrer'); + } + + private handleEmbedAction(file: FileModel, embedType?: string): void { + this.filesShareEmbedService.copyEmbedToClipboard(file.links.render, embedType); } } diff --git a/src/app/shared/components/socials-share-button/socials-share-button.component.ts b/src/app/shared/components/socials-share-button/socials-share-button.component.ts index 23ed332eb..f51128d45 100644 --- a/src/app/shared/components/socials-share-button/socials-share-button.component.ts +++ b/src/app/shared/components/socials-share-button/socials-share-button.component.ts @@ -33,11 +33,7 @@ export class SocialsShareButtonComponent { ? this.socialShareService.createPreprintUrl(this.resourceId(), this.resourceProvider()) : this.socialShareService.createGuidUrl(this.resourceId()); - const shareableContent: SocialShareContentModel = { - id: this.resourceId(), - title: this.resourceTitle(), - url: resourceUrl, - }; + const shareableContent: SocialShareContentModel = { title: this.resourceTitle(), url: resourceUrl }; return this.socialShareService.generateSocialActionItems(shareableContent); }); diff --git a/src/app/shared/components/status-badge/status-badge.component.html b/src/app/shared/components/status-badge/status-badge.component.html index 0f2b18722..261413749 100644 --- a/src/app/shared/components/status-badge/status-badge.component.html +++ b/src/app/shared/components/status-badge/status-badge.component.html @@ -1,3 +1,3 @@ -@if (label) { - +@if (label()) { + } diff --git a/src/app/shared/components/status-badge/status-badge.component.ts b/src/app/shared/components/status-badge/status-badge.component.ts index 5610e175b..1fa211862 100644 --- a/src/app/shared/components/status-badge/status-badge.component.ts +++ b/src/app/shared/components/status-badge/status-badge.component.ts @@ -2,11 +2,10 @@ import { TranslatePipe } from '@ngx-translate/core'; import { Tag } from 'primeng/tag'; -import { ChangeDetectionStrategy, Component, input } from '@angular/core'; +import { ChangeDetectionStrategy, Component, computed, input } from '@angular/core'; import { RegistryStatusMap } from '@osf/shared/constants/registration-statuses'; import { RegistryStatus } from '@osf/shared/enums/registry-status.enum'; -import { TagSeverityType } from '@osf/shared/models/severity.type'; @Component({ selector: 'osf-status-badge', @@ -18,11 +17,6 @@ import { TagSeverityType } from '@osf/shared/models/severity.type'; export class StatusBadgeComponent { status = input.required(); - get label(): string { - return RegistryStatusMap[this.status()]?.label ?? 'Unknown'; - } - - get severity(): TagSeverityType | null { - return RegistryStatusMap[this.status()]?.severity ?? null; - } + label = computed(() => RegistryStatusMap[this.status()]?.label ?? 'resourceCard.type.null'); + severity = computed(() => RegistryStatusMap[this.status()]?.severity ?? null); } diff --git a/src/app/shared/components/subjects/subjects.component.ts b/src/app/shared/components/subjects/subjects.component.ts index 966742a8b..f201d0fbe 100644 --- a/src/app/shared/components/subjects/subjects.component.ts +++ b/src/app/shared/components/subjects/subjects.component.ts @@ -11,7 +11,8 @@ import { Tree, TreeModule } from 'primeng/tree'; import { debounceTime, distinctUntilChanged } from 'rxjs'; -import { ChangeDetectionStrategy, Component, computed, input, output } from '@angular/core'; +import { ChangeDetectionStrategy, Component, computed, DestroyRef, inject, input, output } from '@angular/core'; +import { takeUntilDestroyed } from '@angular/core/rxjs-interop'; import { FormControl, FormsModule } from '@angular/forms'; import { SubjectModel } from '@osf/shared/models/subject/subject.model'; @@ -27,11 +28,14 @@ import { SearchInputComponent } from '../search-input/search-input.component'; changeDetection: ChangeDetectionStrategy.OnPush, }) export class SubjectsComponent { + readonly destroyRef = inject(DestroyRef); + subjects = select(SubjectsSelectors.getSubjects); subjectsLoading = select(SubjectsSelectors.getSubjectsLoading); searchedSubjects = select(SubjectsSelectors.getSearchedSubjects); - areSubjectsUpdating = input(false); isSearching = select(SubjectsSelectors.getSearchedSubjectsLoading); + + areSubjectsUpdating = input(false); selected = input([]); readonly = input(false); searchChanged = output(); @@ -51,9 +55,11 @@ export class SubjectsComponent { searchControl = new FormControl(''); constructor() { - this.searchControl.valueChanges.pipe(debounceTime(300), distinctUntilChanged()).subscribe((value) => { - this.searchChanged.emit(value ?? ''); - }); + this.searchControl.valueChanges + .pipe(debounceTime(300), distinctUntilChanged(), takeUntilDestroyed(this.destroyRef)) + .subscribe((value) => { + this.searchChanged.emit(value ?? ''); + }); } loadNode(event: TreeNode) { diff --git a/src/app/features/files/constants/embed-content.constants.ts b/src/app/shared/constants/file-embed.constants.ts similarity index 100% rename from src/app/features/files/constants/embed-content.constants.ts rename to src/app/shared/constants/file-embed.constants.ts diff --git a/src/app/shared/constants/social-share.config.ts b/src/app/shared/constants/social-share.config.ts index 88f7d17e2..7a0e2bfaf 100644 --- a/src/app/shared/constants/social-share.config.ts +++ b/src/app/shared/constants/social-share.config.ts @@ -1,7 +1,8 @@ export const SOCIAL_SHARE_URLS = { email: 'mailto:', - twitter: { preview_url: 'https://twitter.com/intent/tweet', viaHandle: 'OsfFramework' }, + x: { preview_url: 'https://x.com/intent/tweet', viaHandle: 'OsfFramework' }, facebook: 'https://www.facebook.com/sharer/sharer.php', + facebookShare: 'https://www.facebook.com/dialog/share', linkedIn: 'https://www.linkedin.com/sharing/share-offsite', mastodon: 'https://mastodonshare.com', bluesky: 'https://bsky.app/intent/compose', diff --git a/src/app/shared/helpers/mfr-url.helper.ts b/src/app/shared/helpers/mfr-url.helper.ts new file mode 100644 index 000000000..a3fa1093b --- /dev/null +++ b/src/app/shared/helpers/mfr-url.helper.ts @@ -0,0 +1,19 @@ +export function getMfrUrlWithVersion( + mfrUrl: string | undefined, + version?: string, + viewOnlyParam?: string | null +): string | null { + if (!mfrUrl) return null; + const mfrUrlObj = new URL(mfrUrl); + const encodedDownloadUrl = mfrUrlObj.searchParams.get('url'); + if (!encodedDownloadUrl) return mfrUrl; + + const downloadUrlObj = new URL(decodeURIComponent(encodedDownloadUrl)); + + if (version) downloadUrlObj.searchParams.set('version', version); + if (viewOnlyParam) downloadUrlObj.searchParams.set('view_only', viewOnlyParam); + + mfrUrlObj.searchParams.set('url', downloadUrlObj.toString()); + + return mfrUrlObj.toString(); +} diff --git a/src/app/shared/helpers/storage-addon-options.helper.ts b/src/app/shared/helpers/storage-addon-options.helper.ts new file mode 100644 index 000000000..18ec482b5 --- /dev/null +++ b/src/app/shared/helpers/storage-addon-options.helper.ts @@ -0,0 +1,31 @@ +import { FileProvider } from '@osf/features/files/constants'; +import { ConfiguredAddonModel } from '@shared/models/addons/configured-addon.model'; +import { FileFolderModel } from '@shared/models/files/file-folder.model'; +import { FileLabelModel } from '@shared/models/files/file-label.model'; + +export function getConfiguredStorageAddonDisplayName( + addons: ConfiguredAddonModel[], + provider: string, + osfStorageLabel: string +): string { + if (provider === FileProvider.OsfStorage) { + return osfStorageLabel; + } + + return addons.find((addon) => addon.externalServiceName === provider)?.displayName ?? ''; +} + +export function mapRootFoldersToStorageLabels( + rootFolders: FileFolderModel[] | null | undefined, + addons: ConfiguredAddonModel[] | null | undefined, + osfStorageLabel: string +): FileLabelModel[] { + if (!rootFolders || !addons) { + return []; + } + + return rootFolders.map((folder) => ({ + label: getConfiguredStorageAddonDisplayName(addons, folder.provider, osfStorageLabel), + folder, + })); +} diff --git a/src/app/shared/mappers/files/file-tree.mapper.ts b/src/app/shared/mappers/files/file-tree.mapper.ts new file mode 100644 index 000000000..7f84211fe --- /dev/null +++ b/src/app/shared/mappers/files/file-tree.mapper.ts @@ -0,0 +1,16 @@ +import { FileModel } from '@shared/models/files/file.model'; +import { FileTreeNode } from '@shared/models/files/file-tree-node.model'; + +export class FileTreeMapper { + static toTreeNode(file: FileModel): FileTreeNode { + return { + key: file.id, + label: file.name, + data: file, + }; + } + + static toTreeNodes(files: FileModel[]): FileTreeNode[] { + return files.map((file) => this.toTreeNode(file)); + } +} diff --git a/src/app/shared/mappers/files/files.mapper.ts b/src/app/shared/mappers/files/files.mapper.ts index f792acf78..6723a3042 100644 --- a/src/app/shared/mappers/files/files.mapper.ts +++ b/src/app/shared/mappers/files/files.mapper.ts @@ -60,6 +60,8 @@ export class FilesMapper { } static getFileDetails(data: FileDetailsDataJsonApi): FileDetailsModel { + const target = data.embeds?.target?.data; + return { id: data.id, guid: data.attributes.guid, @@ -76,7 +78,7 @@ export class FilesMapper { showAsUnviewed: data.attributes.show_as_unviewed, extra: this.getFileExtra(data.attributes.extra), links: this.getFileLinks(data.links), - target: BaseNodeMapper.getNodeData(data.embeds!.target.data), + target: target ? BaseNodeMapper.getNodeData(target) : null, }; } diff --git a/src/app/shared/models/files/file-link.model.ts b/src/app/shared/models/files/file-link.model.ts new file mode 100644 index 000000000..abf1f8d49 --- /dev/null +++ b/src/app/shared/models/files/file-link.model.ts @@ -0,0 +1,4 @@ +export interface FileLinkModel { + file: File; + link: string; +} diff --git a/src/app/shared/models/files/file-page-link.model.ts b/src/app/shared/models/files/file-page-link.model.ts new file mode 100644 index 000000000..a5b6ed0f5 --- /dev/null +++ b/src/app/shared/models/files/file-page-link.model.ts @@ -0,0 +1,4 @@ +export interface FilePageLinkModel { + link: string; + page: number; +} diff --git a/src/app/shared/models/files/file-share-link.model.ts b/src/app/shared/models/files/file-share-link.model.ts new file mode 100644 index 000000000..60a018ea6 --- /dev/null +++ b/src/app/shared/models/files/file-share-link.model.ts @@ -0,0 +1,4 @@ +export interface FileShareLink { + link: string; + target: '_self' | '_blank'; +} diff --git a/src/app/shared/models/files/file-tree-node.model.ts b/src/app/shared/models/files/file-tree-node.model.ts new file mode 100644 index 000000000..7f35896a8 --- /dev/null +++ b/src/app/shared/models/files/file-tree-node.model.ts @@ -0,0 +1,5 @@ +import { TreeNode } from 'primeng/api'; + +import { FileModel } from './file.model'; + +export type FileTreeNode = TreeNode; diff --git a/src/app/shared/models/files/file.model.ts b/src/app/shared/models/files/file.model.ts index c60efe6e8..f49bc8215 100644 --- a/src/app/shared/models/files/file.model.ts +++ b/src/app/shared/models/files/file.model.ts @@ -29,7 +29,7 @@ export interface FileDetailsModel extends BaseFileModel { currentVersion: number; showAsUnviewed: boolean; links: FileLinksModel; - target: BaseNodeModel; + target: BaseNodeModel | null; } export interface FileExtraModel { diff --git a/src/app/shared/models/files/renamed-file-link.model.ts b/src/app/shared/models/files/renamed-file-link.model.ts new file mode 100644 index 000000000..81876ff0e --- /dev/null +++ b/src/app/shared/models/files/renamed-file-link.model.ts @@ -0,0 +1,4 @@ +export interface RenamedFileLinkModel { + newName: string; + link: string; +} diff --git a/src/app/shared/models/socials/social-share-content.model.ts b/src/app/shared/models/socials/social-share-content.model.ts index fc5b94031..ec393ac08 100644 --- a/src/app/shared/models/socials/social-share-content.model.ts +++ b/src/app/shared/models/socials/social-share-content.model.ts @@ -1,5 +1,4 @@ export interface SocialShareContentModel { - id: string; title: string; url: string; } diff --git a/src/app/shared/services/files-share-embed.service.ts b/src/app/shared/services/files-share-embed.service.ts new file mode 100644 index 000000000..399f81658 --- /dev/null +++ b/src/app/shared/services/files-share-embed.service.ts @@ -0,0 +1,77 @@ +import { Clipboard } from '@angular/cdk/clipboard'; +import { inject, Injectable } from '@angular/core'; + +import { embedDynamicJs, embedStaticHtml } from '@shared/constants/file-embed.constants'; + +import { FileModel } from '../models/files/file.model'; +import { FileShareLink } from '../models/files/file-share-link.model'; + +import { SocialShareService } from './social-share.service'; +import { ToastService } from './toast.service'; + +@Injectable({ + providedIn: 'root', +}) +export class FilesShareEmbedService { + private readonly clipboard = inject(Clipboard); + private readonly socialShareService = inject(SocialShareService); + private readonly toastService = inject(ToastService); + + private readonly EMBED_PLACEHOLDER = 'ENCODED_URL'; + + getShareLink(file: FileModel, shareType?: string): FileShareLink | null { + const name = file.name ?? ''; + const url = file.links?.html ?? ''; + + if (!url) { + return null; + } + + switch (shareType) { + case 'email': + return { + link: this.socialShareService.getEmailLink(name, url), + target: '_self', + }; + case 'twitter': + return { + link: this.socialShareService.getXLink(name, url), + target: '_blank', + }; + case 'facebook': + return { + link: this.socialShareService.getFacebookLink(url), + target: '_blank', + }; + default: + return null; + } + } + + getEmbedHtml(url: string, embedType?: string): string { + switch (embedType) { + case 'dynamic': + return embedDynamicJs.replace(this.EMBED_PLACEHOLDER, url); + case 'static': + return embedStaticHtml.replace(this.EMBED_PLACEHOLDER, url); + default: + return ''; + } + } + + copyEmbedToClipboard(url: string, embedType?: string): boolean { + const embedHtml = this.getEmbedHtml(url, embedType); + + if (!embedHtml) { + return false; + } + + const copied = this.clipboard.copy(embedHtml); + + if (copied) { + this.toastService.showSuccess('files.detail.toast.copiedToClipboard'); + } + + return copied; + } +} diff --git a/src/app/shared/services/files.service.ts b/src/app/shared/services/files.service.ts index ad78cb023..ad2b9d199 100644 --- a/src/app/shared/services/files.service.ts +++ b/src/app/shared/services/files.service.ts @@ -6,19 +6,20 @@ import { inject, Injectable } from '@angular/core'; import { ENVIRONMENT } from '@core/provider/environment.provider'; import { MapFileCustomMetadata, MapFileRevision } from '@osf/features/files/mappers'; +import { OsfFileCustomMetadata } from '@osf/features/files/models/file-custom-metadata.model'; +import { OsfFileRevision } from '@osf/features/files/models/file-revisions.model'; +import { GetCustomMetadataResponse } from '@osf/features/files/models/get-custom-metadata-response.model'; import { FileCustomMetadata, - GetCustomMetadataResponse, GetFileMetadataResponse, - GetFileRevisionsResponse, - GetShortInfoResponse, - OsfFileCustomMetadata, - OsfFileRevision, - PatchFileMetadata, -} from '@osf/features/files/models'; +} from '@osf/features/files/models/get-file-metadata-response.model'; +import { GetFileRevisionsResponse } from '@osf/features/files/models/get-file-revisions-response.model'; +import { GetShortInfoResponse } from '@osf/features/files/models/get-short-info-response.model'; +import { PatchFileMetadata } from '@osf/features/files/models/patch-file-metadata.model'; import { PaginatedData } from '@osf/shared/models/paginated-data.model'; import { FileKind } from '../enums/file-kind.enum'; +import { ResourceType } from '../enums/resource-type.enum'; import { AddonMapper } from '../mappers/addon.mapper'; import { ContributorsMapper } from '../mappers/contributors'; import { FilesMapper } from '../mappers/files/files.mapper'; @@ -36,6 +37,7 @@ import { FileFoldersResponseJsonApi, } from '../models/files/file-folder-json-api.model'; import { + FileDetailsDataJsonApi, FileDetailsResponseJsonApi, FileResponseJsonApi, FilesResponseJsonApi, @@ -60,7 +62,13 @@ export class FilesService { return this.environment.addonsApiUrl; } - filesFields = 'name,guid,kind,extra,size,path,materialized_path,date_modified,parent_folder,files'; + private readonly filesFields = 'name,guid,kind,extra,size,path,materialized_path,date_modified,parent_folder,files'; + + private readonly resourcePathMap: Record = { + [ResourceType.Project]: 'nodes', + [ResourceType.Registration]: 'registrations', + [ResourceType.Preprint]: 'preprints', + }; getFiles( filesLink: string, @@ -86,10 +94,17 @@ export class FilesService { .pipe(map((response) => ({ files: FilesMapper.getFileFolders(response.data), meta: response.meta }))); } + getRootFolders( + resourceId: string, + resourceType: ResourceType + ): Observable<{ files: FileFolderModel[]; meta?: MetaJsonApi }> { + const resourcePath = this.resourcePathMap[resourceType]; + return this.getFolders(`${this.apiUrl}/${resourcePath}/${resourceId}/files/`); + } + getFilesWithoutFiltering(filesLink: string, page = 1): Observable> { - const params: Record = { - page: page.toString(), - }; + const params: Record = { page: page.toString() }; + return this.jsonApiService.get(filesLink, params).pipe( map((response) => ({ data: FilesMapper.getFiles(response.data), @@ -169,9 +184,7 @@ export class FilesService { } getFileGuid(id: string): Observable { - const params = { - create_guid: 'true', - }; + const params = { create_guid: 'true' }; return this.jsonApiService .get(`${this.apiUrl}/files/${id}/`, params) @@ -252,15 +265,13 @@ export class FilesService { id: fileGuid, type: 'files', relationships: {}, - attributes: { - tags: tags, - }, + attributes: { tags: tags }, }, }; return this.jsonApiService - .patch(`${this.apiUrl}/files/${fileGuid}/`, payload) - .pipe(map((response) => FilesMapper.getFileDetails(response.data))); + .patch(`${this.apiUrl}/files/${fileGuid}/`, payload) + .pipe(map((response) => FilesMapper.getFileDetails(response))); } copyFileToAnotherLocation(moveLink: string, provider: string, resourceId: string) { @@ -278,9 +289,7 @@ export class FilesService { } getResourceReferences(resourceUri: string): Observable { - const params = { - 'filter[resource_uri]': resourceUri, - }; + const params = { 'filter[resource_uri]': resourceUri }; return this.jsonApiService .get< @@ -289,7 +298,9 @@ export class FilesService { .pipe(map((response) => response.data?.[0]?.links?.self ?? '')); } - getConfiguredStorageAddons(resourceUri: string): Observable { + getConfiguredStorageAddons(resourceId: string): Observable { + const resourceUri = `${this.environment.webUrl}/${resourceId}`; + return this.getResourceReferences(resourceUri).pipe( switchMap((referenceUrl: string) => { if (!referenceUrl) return of([]); diff --git a/src/app/shared/services/meta-tags-builder.service.spec.ts b/src/app/shared/services/meta-tags-builder.service.spec.ts index 14644b63d..59745be75 100644 --- a/src/app/shared/services/meta-tags-builder.service.spec.ts +++ b/src/app/shared/services/meta-tags-builder.service.spec.ts @@ -4,7 +4,7 @@ import { MockProvider } from 'ng-mocks'; import { LOCALE_ID } from '@angular/core'; import { TestBed } from '@angular/core/testing'; -import { OsfFileCustomMetadata } from '@osf/features/files/models'; +import { OsfFileCustomMetadata } from '@osf/features/files/models/file-custom-metadata.model'; import { FileKind } from '@osf/shared/enums/file-kind.enum'; import { FileDetailsModel } from '@osf/shared/models/files/file.model'; diff --git a/src/app/shared/services/meta-tags-builder.service.ts b/src/app/shared/services/meta-tags-builder.service.ts index 28dd524f4..31e8f8db7 100644 --- a/src/app/shared/services/meta-tags-builder.service.ts +++ b/src/app/shared/services/meta-tags-builder.service.ts @@ -4,7 +4,7 @@ import { formatDate } from '@angular/common'; import { inject, Injectable, LOCALE_ID } from '@angular/core'; import { ENVIRONMENT } from '@core/provider/environment.provider'; -import { OsfFileCustomMetadata } from '@osf/features/files/models'; +import { OsfFileCustomMetadata } from '@osf/features/files/models/file-custom-metadata.model'; import { PreprintModel } from '@osf/features/preprints/models'; import { ProjectOverviewModel } from '@osf/features/project/overview/models'; import { RegistrationOverviewModel } from '@osf/features/registry/models'; diff --git a/src/app/shared/services/social-share.service.ts b/src/app/shared/services/social-share.service.ts index 7b821619a..d8c9832f2 100644 --- a/src/app/shared/services/social-share.service.ts +++ b/src/app/shared/services/social-share.service.ts @@ -18,10 +18,29 @@ export class SocialShareService { return this.environment.webUrl; } + getEmailLink(title: string, url: string): string { + return this.generateEmailLink({ title, url }); + } + + getXLink(title: string, url: string): string { + return this.generateXLink({ title, url }); + } + + getFacebookLink(url: string): string { + return this.generateFacebookLink({ title: '', url }); + } + + getFacebookCustomLink(url: string): string { + const encodedUrl = encodeURIComponent(url); + const appId = this.environment.facebookAppId; + + return `${SOCIAL_SHARE_URLS.facebookShare}?app_id=${appId}&display=popup&href=${encodedUrl}&redirect_uri=${encodedUrl}`; + } + generateAllSharingLinks(content: SocialShareContentModel): SocialShareLinksModel { return { email: this.generateEmailLink(content), - twitter: this.generateTwitterLink(content), + twitter: this.generateXLink(content), facebook: this.generateFacebookLink(content), linkedIn: this.generateLinkedInLink(content), mastodon: this.generateMastodonLink(content), @@ -58,11 +77,11 @@ export class SocialShareService { return `${SOCIAL_SHARE_URLS.email}?subject=${subject}&body=${body}`; } - private generateTwitterLink(content: SocialShareContentModel): string { + private generateXLink(content: SocialShareContentModel): string { const url = encodeURIComponent(content.url); const text = encodeURIComponent(content.title); - return `${SOCIAL_SHARE_URLS.twitter.preview_url}?url=${url}&text=${text}&via=${SOCIAL_SHARE_URLS.twitter.viaHandle}`; + return `${SOCIAL_SHARE_URLS.x.preview_url}?url=${url}&text=${text}&via=${SOCIAL_SHARE_URLS.x.viaHandle}`; } private generateFacebookLink(content: SocialShareContentModel): string { diff --git a/src/assets/i18n/en.json b/src/assets/i18n/en.json index d398ed471..452a5228a 100644 --- a/src/assets/i18n/en.json +++ b/src/assets/i18n/en.json @@ -1121,6 +1121,7 @@ "deleteProject": "Delete Project", "descriptions": { "file_updated": { + "instant": "You'll be notified immediately when files are updated.", "daily": "You'll receive a daily summary of file updates.", "instant": "You'll be notified immediately when files are updated.", "none": "You won't receive file update notifications." diff --git a/src/styles/overrides/tree.scss b/src/styles/overrides/tree.scss index e30a4f1e8..86f6f2f96 100644 --- a/src/styles/overrides/tree.scss +++ b/src/styles/overrides/tree.scss @@ -2,6 +2,13 @@ .p-tree { padding: 0; + .files-table-row { + .p-button { + --p-button-label-font-weight: 400; + --p-button-link-color: var(--dark-blue-1); + } + } + .p-tree-node-toggle-button { display: none; } @@ -18,7 +25,7 @@ .p-tree-node-dragover { .files-table-row { - background: var(--bg-blue-3); + background-color: var(--bg-blue-3); } } @@ -47,13 +54,17 @@ } .p-tree-empty-message { - display: none; + height: 100%; } .p-tree-node-selected { .files-table-row { color: var(--white); - background: var(--pr-blue-1); + background-color: var(--pr-blue-1); + + .p-button { + --p-button-link-color: var(--white); + } .blue-icon { color: var(--white); @@ -61,18 +72,4 @@ } } } - - .empty-state-container { - position: absolute; - inset: 0; - top: 2.75rem; - display: flex; - justify-content: center; - align-items: center; - - .drop-text { - text-align: center; - margin-bottom: 2.75rem; - } - } } diff --git a/src/testing/mocks/file-details.mock.ts b/src/testing/mocks/file-details.mock.ts new file mode 100644 index 000000000..7a7b9a8c2 --- /dev/null +++ b/src/testing/mocks/file-details.mock.ts @@ -0,0 +1,43 @@ +import { FileKind } from '@osf/shared/enums/file-kind.enum'; +import { FileDetailsModel } from '@osf/shared/models/files/file.model'; + +import { MOCK_PROJECT_OVERVIEW } from './project-overview.mock'; + +export const FileDetailsMock = { + simple(overrides: Partial = {}): FileDetailsModel { + return { + id: 'file-id', + guid: 'file-guid', + name: 'file-name.pdf', + kind: FileKind.File, + path: '/file-name.pdf', + size: 100, + materializedPath: '/file-name.pdf', + dateModified: '2024-01-05T00:00:00Z', + extra: { + hashes: { + md5: 'md5', + sha256: 'sha256', + }, + downloads: 1, + }, + lastTouched: null, + dateCreated: '2024-01-04T00:00:00Z', + tags: [], + currentVersion: 1, + showAsUnviewed: false, + links: { + info: 'info', + move: 'move', + upload: 'upload', + delete: 'delete', + download: 'download', + render: 'render', + html: 'html', + self: 'self', + }, + target: MOCK_PROJECT_OVERVIEW, + ...overrides, + }; + }, +};