From c97c6923ea2e3fd48c66e97376887b46a07f2671 Mon Sep 17 00:00:00 2001 From: shamoon <4887959+shamoon@users.noreply.github.com> Date: Wed, 16 Sep 2026 08:45:49 -0700 Subject: [PATCH] Enhancement: centralized management of share links + bundles (#14115) --- src-ui/src/app/app-routing.module.ts | 19 ++ .../admin/settings/settings.component.ts | 1 + .../app-frame/app-frame.component.html | 12 ++ .../app-frame/app-frame.component.spec.ts | 7 +- .../app-frame/app-frame.component.ts | 13 ++ .../bulk-editor/bulk-editor.component.spec.ts | 34 ++-- .../bulk-editor/bulk-editor.component.ts | 8 +- .../share-link-bundle-list.component.html} | 130 +++++++------ .../share-link-bundle-list.component.scss} | 0 .../share-link-bundle-list.component.spec.ts} | 122 +++++++++---- .../share-link-bundle-list.component.ts} | 113 +++++++++--- .../share-link-list.component.html | 110 +++++++++++ .../share-link-list.component.spec.ts | 155 ++++++++++++++++ .../share-link-list.component.ts | 172 ++++++++++++++++++ .../share-links/share-links.component.html | 34 ++++ .../share-links/share-links.component.spec.ts | 102 +++++++++++ .../share-links/share-links.component.ts | 78 ++++++++ src-ui/src/app/data/share-link.ts | 2 + src-ui/src/app/data/ui-settings.ts | 3 + .../rest/share-link-bundle.service.spec.ts | 9 - .../rest/share-link-bundle.service.ts | 7 - src-ui/src/styles.scss | 4 + src/documents/serialisers.py | 6 + src/documents/tests/test_api_documents.py | 32 ++++ src/documents/views.py | 13 +- 25 files changed, 1027 insertions(+), 159 deletions(-) rename src-ui/src/app/components/{common/share-link-bundle-manage-dialog/share-link-bundle-manage-dialog.component.html => manage/share-links/share-link-bundle-list/share-link-bundle-list.component.html} (52%) rename src-ui/src/app/components/{common/share-link-bundle-manage-dialog/share-link-bundle-manage-dialog.component.scss => manage/share-links/share-link-bundle-list/share-link-bundle-list.component.scss} (100%) rename src-ui/src/app/components/{common/share-link-bundle-manage-dialog/share-link-bundle-manage-dialog.component.spec.ts => manage/share-links/share-link-bundle-list/share-link-bundle-list.component.spec.ts} (63%) rename src-ui/src/app/components/{common/share-link-bundle-manage-dialog/share-link-bundle-manage-dialog.component.ts => manage/share-links/share-link-bundle-list/share-link-bundle-list.component.ts} (59%) create mode 100644 src-ui/src/app/components/manage/share-links/share-link-list/share-link-list.component.html create mode 100644 src-ui/src/app/components/manage/share-links/share-link-list/share-link-list.component.spec.ts create mode 100644 src-ui/src/app/components/manage/share-links/share-link-list/share-link-list.component.ts create mode 100644 src-ui/src/app/components/manage/share-links/share-links.component.html create mode 100644 src-ui/src/app/components/manage/share-links/share-links.component.spec.ts create mode 100644 src-ui/src/app/components/manage/share-links/share-links.component.ts diff --git a/src-ui/src/app/app-routing.module.ts b/src-ui/src/app/app-routing.module.ts index 66864a0d5..57ca25876 100644 --- a/src-ui/src/app/app-routing.module.ts +++ b/src-ui/src/app/app-routing.module.ts @@ -14,6 +14,7 @@ import { DocumentListComponent } from './components/document-list/document-list. import { DocumentAttributesComponent } from './components/manage/document-attributes/document-attributes.component' import { MailComponent } from './components/manage/mail/mail.component' import { SavedViewsComponent } from './components/manage/saved-views/saved-views.component' +import { ShareLinksComponent } from './components/manage/share-links/share-links.component' import { WorkflowsComponent } from './components/manage/workflows/workflows.component' import { NotFoundComponent } from './components/not-found/not-found.component' import { DirtyDocGuard } from './guards/dirty-doc.guard' @@ -310,6 +311,24 @@ export const routes: Routes = [ componentName: 'SavedViewsComponent', }, }, + { + path: 'share-links', + component: ShareLinksComponent, + canActivate: [PermissionsGuard], + data: { + requiredPermissionAny: [ + { + action: PermissionAction.View, + type: PermissionType.ShareLink, + }, + { + action: PermissionAction.View, + type: PermissionType.ShareLinkBundle, + }, + ], + componentName: 'ShareLinksComponent', + }, + }, ], }, diff --git a/src-ui/src/app/components/admin/settings/settings.component.ts b/src-ui/src/app/components/admin/settings/settings.component.ts index 9076d2a3e..a4ead8373 100644 --- a/src-ui/src/app/components/admin/settings/settings.component.ts +++ b/src-ui/src/app/components/admin/settings/settings.component.ts @@ -110,6 +110,7 @@ const documentDetailFieldOptions = [ const sidebarItemLabels: Record = { [HideableSidebarItemID.Dashboard]: $localize`Dashboard`, [HideableSidebarItemID.SavedViews]: $localize`Saved Views`, + [HideableSidebarItemID.ShareLinks]: $localize`Share Links`, [HideableSidebarItemID.Workflows]: $localize`Workflows`, [HideableSidebarItemID.Mail]: $localize`Mail`, [HideableSidebarItemID.Documentation]: $localize`Documentation`, diff --git a/src-ui/src/app/components/app-frame/app-frame.component.html b/src-ui/src/app/components/app-frame/app-frame.component.html index a8dd12d34..942c6a195 100644 --- a/src-ui/src/app/components/app-frame/app-frame.component.html +++ b/src-ui/src/app/components/app-frame/app-frame.component.html @@ -250,6 +250,18 @@ } + @if (canManageShareLinks) { +
  • + + Share links + + @if (settingsService.organizingSidebarItems()) { + + } +
    • + }
  • diff --git a/src-ui/src/app/components/app-frame/app-frame.component.spec.ts b/src-ui/src/app/components/app-frame/app-frame.component.spec.ts index 4dd88c84d..ad9304ca0 100644 --- a/src-ui/src/app/components/app-frame/app-frame.component.spec.ts +++ b/src-ui/src/app/components/app-frame/app-frame.component.spec.ts @@ -291,6 +291,7 @@ describe('AppFrameComponent', () => { settingsService.set(SETTINGS_KEYS.SIDEBAR_HIDDEN_ITEMS, [ HideableSidebarItemID.Dashboard, HideableSidebarItemID.Workflows, + HideableSidebarItemID.ShareLinks, ]) fixture.detectChanges() @@ -302,6 +303,10 @@ describe('AppFrameComponent', () => { fixture.nativeElement.querySelector('[routerLink="workflows"]') .parentElement.classList ).toContain('d-none') + expect( + fixture.nativeElement.querySelector('[routerLink="share-links"]') + .parentElement.classList + ).toContain('d-none') expect( fixture.nativeElement.querySelector('[routerLink="mail"]').parentElement .classList @@ -319,7 +324,7 @@ describe('AppFrameComponent', () => { expect( fixture.nativeElement.querySelectorAll('pngx-input-switch').length - ).toBe(5) + ).toBe(6) expect( fixture.nativeElement.querySelector('[routerLink="dashboard"]') .parentElement.classList diff --git a/src-ui/src/app/components/app-frame/app-frame.component.ts b/src-ui/src/app/components/app-frame/app-frame.component.ts index 7b4c29d2f..4fa0f6fc3 100644 --- a/src-ui/src/app/components/app-frame/app-frame.component.ts +++ b/src-ui/src/app/components/app-frame/app-frame.component.ts @@ -234,6 +234,19 @@ export class AppFrameComponent return this.appTitleSetting() || environment.appTitle } + get canManageShareLinks(): boolean { + return ( + this.permissionsService.currentUserCan( + PermissionAction.View, + PermissionType.ShareLink + ) || + this.permissionsService.currentUserCan( + PermissionAction.View, + PermissionType.ShareLinkBundle + ) + ) + } + get customAppTitle(): string { return this.appTitleSetting() } diff --git a/src-ui/src/app/components/document-list/bulk-editor/bulk-editor.component.spec.ts b/src-ui/src/app/components/document-list/bulk-editor/bulk-editor.component.spec.ts index b8696a958..29212c955 100644 --- a/src-ui/src/app/components/document-list/bulk-editor/bulk-editor.component.spec.ts +++ b/src-ui/src/app/components/document-list/bulk-editor/bulk-editor.component.spec.ts @@ -7,6 +7,7 @@ import { import { EventEmitter, signal } from '@angular/core' import { ComponentFixture, TestBed } from '@angular/core/testing' import { By } from '@angular/platform-browser' +import { Router } from '@angular/router' import { NgbModal, NgbModalRef } from '@ng-bootstrap/ng-bootstrap' import { NgxBootstrapIconsModule, allIcons } from 'ngx-bootstrap-icons' import { of, throwError } from 'rxjs' @@ -46,7 +47,6 @@ import { StoragePathEditDialogComponent } from '../../common/edit-dialog/storage import { TagEditDialogComponent } from '../../common/edit-dialog/tag-edit-dialog/tag-edit-dialog.component' import { FilterableDropdownComponent } from '../../common/filterable-dropdown/filterable-dropdown.component' import { ShareLinkBundleDialogComponent } from '../../common/share-link-bundle-dialog/share-link-bundle-dialog.component' -import { ShareLinkBundleManageDialogComponent } from '../../common/share-link-bundle-manage-dialog/share-link-bundle-manage-dialog.component' import { BulkEditorComponent } from './bulk-editor.component' const selectionData: SelectionData = { @@ -82,6 +82,7 @@ describe('BulkEditorComponent', () => { let customFieldsService: CustomFieldsService let httpTestingController: HttpTestingController let shareLinkBundleService: ShareLinkBundleService + let router: Router beforeEach(async () => { TestBed.configureTestingModule({ @@ -167,11 +168,14 @@ describe('BulkEditorComponent', () => { provide: ShareLinkBundleService, useValue: { createBundle: jest.fn(), - listAllBundles: jest.fn(), rebuildBundle: jest.fn(), delete: jest.fn(), }, }, + { + provide: Router, + useValue: { navigate: jest.fn().mockResolvedValue(true) }, + }, provideHttpClient(withInterceptorsFromDi()), provideHttpClientTesting(), ], @@ -189,6 +193,7 @@ describe('BulkEditorComponent', () => { customFieldsService = TestBed.inject(CustomFieldsService) httpTestingController = TestBed.inject(HttpTestingController) shareLinkBundleService = TestBed.inject(ShareLinkBundleService) + router = TestBed.inject(Router) fixture = TestBed.createComponent(BulkEditorComponent) component = fixture.componentInstance @@ -1824,9 +1829,9 @@ describe('BulkEditorComponent', () => { }, } - const openSpy = jest.spyOn(modalService, 'open') - openSpy.mockReturnValueOnce(modalRef as NgbModalRef) - openSpy.mockReturnValueOnce({} as NgbModalRef) + const openSpy = jest + .spyOn(modalService, 'open') + .mockReturnValueOnce(modalRef as NgbModalRef) ;(shareLinkBundleService.createBundle as jest.Mock).mockReturnValueOnce( of({ id: 42 }) ) @@ -1860,11 +1865,9 @@ describe('BulkEditorComponent', () => { dialogInstance.onOpenManage() expect(modalRef.close).toHaveBeenCalled() - expect(openSpy).toHaveBeenNthCalledWith( - 2, - ShareLinkBundleManageDialogComponent, - expect.objectContaining({ backdrop: 'static', size: 'lg' }) - ) + expect(router.navigate).toHaveBeenCalledWith(['/share-links'], { + queryParams: { type: 'bundles' }, + }) openSpy.mockRestore() }) @@ -1917,13 +1920,10 @@ describe('BulkEditorComponent', () => { openSpy.mockRestore() }) - it('should open share link bundle management dialog', () => { - const openSpy = jest.spyOn(modalService, 'open') + it('should navigate to share link bundle management', () => { component.manageShareLinkBundles() - expect(openSpy).toHaveBeenCalledWith( - ShareLinkBundleManageDialogComponent, - expect.objectContaining({ backdrop: 'static', size: 'lg' }) - ) - openSpy.mockRestore() + expect(router.navigate).toHaveBeenCalledWith(['/share-links'], { + queryParams: { type: 'bundles' }, + }) }) }) diff --git a/src-ui/src/app/components/document-list/bulk-editor/bulk-editor.component.ts b/src-ui/src/app/components/document-list/bulk-editor/bulk-editor.component.ts index fb7c20776..c8d23c1bb 100644 --- a/src-ui/src/app/components/document-list/bulk-editor/bulk-editor.component.ts +++ b/src-ui/src/app/components/document-list/bulk-editor/bulk-editor.component.ts @@ -12,6 +12,7 @@ import { FormsModule, ReactiveFormsModule, } from '@angular/forms' +import { Router } from '@angular/router' import { NgbDropdownModule, NgbModal, @@ -69,7 +70,6 @@ import { import { ToggleableItemState } from '../../common/filterable-dropdown/toggleable-dropdown-button/toggleable-dropdown-button.component' import { PermissionsDialogComponent } from '../../common/permissions-dialog/permissions-dialog.component' import { ShareLinkBundleDialogComponent } from '../../common/share-link-bundle-dialog/share-link-bundle-dialog.component' -import { ShareLinkBundleManageDialogComponent } from '../../common/share-link-bundle-manage-dialog/share-link-bundle-manage-dialog.component' import { ComponentWithPermissions } from '../../with-permissions/with-permissions.component' import { CustomFieldsBulkEditDialogComponent } from './custom-fields-bulk-edit-dialog/custom-fields-bulk-edit-dialog.component' @@ -104,6 +104,7 @@ export class BulkEditorComponent public readonly permissionService = inject(PermissionsService) private savedViewService = inject(SavedViewService) private readonly shareLinkBundleService = inject(ShareLinkBundleService) + private readonly router = inject(Router) tagSelectionModel = new FilterableDropdownSelectionModel(true) correspondentSelectionModel = new FilterableDropdownSelectionModel() @@ -1135,9 +1136,8 @@ export class BulkEditorComponent } manageShareLinkBundles() { - this.modalService.open(ShareLinkBundleManageDialogComponent, { - backdrop: 'static', - size: 'lg', + void this.router.navigate(['/share-links'], { + queryParams: { type: 'bundles' }, }) } diff --git a/src-ui/src/app/components/common/share-link-bundle-manage-dialog/share-link-bundle-manage-dialog.component.html b/src-ui/src/app/components/manage/share-links/share-link-bundle-list/share-link-bundle-list.component.html similarity index 52% rename from src-ui/src/app/components/common/share-link-bundle-manage-dialog/share-link-bundle-manage-dialog.component.html rename to src-ui/src/app/components/manage/share-links/share-link-bundle-list/share-link-bundle-list.component.html index 15b5bc9de..2ac67b6d9 100644 --- a/src-ui/src/app/components/common/share-link-bundle-manage-dialog/share-link-bundle-manage-dialog.component.html +++ b/src-ui/src/app/components/manage/share-links/share-link-bundle-list/share-link-bundle-list.component.html @@ -1,38 +1,22 @@ -
    -

    {{ title }}

    - -
    - -
    - @if (loading()) { -
    - - Loading share link bundles… -
    - } +
    @if (!loading() && error()) { } @if (!loading() && !error()) { -
    -

    - Status updates every few seconds while bundles are being prepared. -

    -
    @if (bundles().length === 0) {

    No share link bundles currently exist.

    } @if (bundles().length > 0) {
    - +
    - - + + - + @@ -96,6 +80,9 @@ @@ -147,10 +141,32 @@
    CreatedStatusCreatedStatus SizeExpiresExpires Documents File version Actions @if (bundle.expiration) { {{ bundle.expiration | date: 'short' }} + @if (isExpired(bundle.expiration)) { + Expired + } } @if (!bundle.expiration) { Never @@ -104,42 +91,49 @@ {{ bundle.document_count }} {{ fileVersionLabel(bundle.file_version) }} -
    - - @if (bundle.status === statuses.Failed) { +
    + Copied! +
    - } - - - + @if (bundle.status === statuses.Failed) { + + } + + + +
    +
    +
    +
    + + + per page +
    + @if (total() > pageSize) { + + } +
    +
    } }
    - -
    - -
    diff --git a/src-ui/src/app/components/common/share-link-bundle-manage-dialog/share-link-bundle-manage-dialog.component.scss b/src-ui/src/app/components/manage/share-links/share-link-bundle-list/share-link-bundle-list.component.scss similarity index 100% rename from src-ui/src/app/components/common/share-link-bundle-manage-dialog/share-link-bundle-manage-dialog.component.scss rename to src-ui/src/app/components/manage/share-links/share-link-bundle-list/share-link-bundle-list.component.scss diff --git a/src-ui/src/app/components/common/share-link-bundle-manage-dialog/share-link-bundle-manage-dialog.component.spec.ts b/src-ui/src/app/components/manage/share-links/share-link-bundle-list/share-link-bundle-list.component.spec.ts similarity index 63% rename from src-ui/src/app/components/common/share-link-bundle-manage-dialog/share-link-bundle-manage-dialog.component.spec.ts rename to src-ui/src/app/components/manage/share-links/share-link-bundle-list/share-link-bundle-list.component.spec.ts index 5c943b190..085ece5c8 100644 --- a/src-ui/src/app/components/common/share-link-bundle-manage-dialog/share-link-bundle-manage-dialog.component.spec.ts +++ b/src-ui/src/app/components/manage/share-links/share-link-bundle-list/share-link-bundle-list.component.spec.ts @@ -1,6 +1,5 @@ import { Clipboard } from '@angular/cdk/clipboard' import { ComponentFixture, TestBed } from '@angular/core/testing' -import { NgbActiveModal } from '@ng-bootstrap/ng-bootstrap' import { NgxBootstrapIconsModule, allIcons } from 'ngx-bootstrap-icons' import { of, throwError } from 'rxjs' import { FileVersion } from 'src/app/data/share-link' @@ -8,13 +7,15 @@ import { ShareLinkBundleStatus, ShareLinkBundleSummary, } from 'src/app/data/share-link-bundle' +import { SETTINGS_KEYS } from 'src/app/data/ui-settings' import { ShareLinkBundleService } from 'src/app/services/rest/share-link-bundle.service' +import { SettingsService } from 'src/app/services/settings.service' import { ToastService } from 'src/app/services/toast.service' import { environment } from 'src/environments/environment' -import { ShareLinkBundleManageDialogComponent } from './share-link-bundle-manage-dialog.component' +import { ShareLinkBundleListComponent } from './share-link-bundle-list.component' class MockShareLinkBundleService { - listAllBundles = jest.fn() + list = jest.fn() delete = jest.fn() rebuildBundle = jest.fn() } @@ -24,13 +25,12 @@ class MockToastService { showError = jest.fn() } -describe('ShareLinkBundleManageDialogComponent', () => { - let component: ShareLinkBundleManageDialogComponent - let fixture: ComponentFixture +describe('ShareLinkBundleListComponent', () => { + let component: ShareLinkBundleListComponent + let fixture: ComponentFixture let service: MockShareLinkBundleService let toastService: MockToastService let clipboard: Clipboard - let activeModal: NgbActiveModal let originalApiBaseUrl: string beforeEach(() => { @@ -38,26 +38,24 @@ describe('ShareLinkBundleManageDialogComponent', () => { toastService = new MockToastService() originalApiBaseUrl = environment.apiBaseUrl - service.listAllBundles.mockReturnValue(of([])) + service.list.mockReturnValue(of({ count: 0, results: [] })) service.delete.mockReturnValue(of(true)) service.rebuildBundle.mockReturnValue(of(sampleBundle())) TestBed.configureTestingModule({ imports: [ - ShareLinkBundleManageDialogComponent, + ShareLinkBundleListComponent, NgxBootstrapIconsModule.pick(allIcons), ], providers: [ - NgbActiveModal, { provide: ShareLinkBundleService, useValue: service }, { provide: ToastService, useValue: toastService }, ], }) - fixture = TestBed.createComponent(ShareLinkBundleManageDialogComponent) + fixture = TestBed.createComponent(ShareLinkBundleListComponent) component = fixture.componentInstance clipboard = TestBed.inject(Clipboard) - activeModal = TestBed.inject(NgbActiveModal) }) afterEach(() => { @@ -84,28 +82,28 @@ describe('ShareLinkBundleManageDialogComponent', () => { it('loads bundles on init and polls periodically', () => { jest.useFakeTimers() const bundles = [sampleBundle({ status: ShareLinkBundleStatus.Ready })] - service.listAllBundles.mockReset() - service.listAllBundles - .mockReturnValueOnce(of(bundles)) - .mockReturnValue(of(bundles)) + service.list.mockReset() + service.list + .mockReturnValueOnce(of({ count: bundles.length, results: bundles })) + .mockReturnValue(of({ count: bundles.length, results: bundles })) fixture.detectChanges() - expect(service.listAllBundles).toHaveBeenCalledTimes(1) + expect(service.list).toHaveBeenCalledWith(1, 25, 'created', true) expect(component.bundles()).toEqual(bundles) expect(component.loading()).toBe(false) expect(component.error()).toBeNull() jest.advanceTimersByTime(5000) - expect(service.listAllBundles).toHaveBeenCalledTimes(2) + expect(service.list).toHaveBeenCalledTimes(2) }) it('handles errors when loading bundles', () => { jest.useFakeTimers() - service.listAllBundles.mockReset() - service.listAllBundles + service.list.mockReset() + service.list .mockReturnValueOnce(throwError(() => new Error('load fail'))) - .mockReturnValue(of([])) + .mockReturnValue(of({ count: 0, results: [] })) fixture.detectChanges() @@ -114,7 +112,57 @@ describe('ShareLinkBundleManageDialogComponent', () => { expect(component.loading()).toBe(false) jest.advanceTimersByTime(5000) - expect(service.listAllBundles).toHaveBeenCalledTimes(2) + expect(service.list).toHaveBeenCalledTimes(2) + }) + + it('loads another page', () => { + fixture.detectChanges() + + component.setPage(2) + + expect(service.list).toHaveBeenLastCalledWith(2, 25, 'created', true) + }) + + it('sorts bundles and returns to the first page', () => { + fixture.detectChanges() + component.page.set(2) + + component.onSort({ column: 'status', reverse: false }) + + expect(component.page()).toBe(1) + expect(service.list).toHaveBeenLastCalledWith(1, 25, 'status', false) + }) + + it('marks expired share link bundles', () => { + service.list.mockReturnValue( + of({ + count: 1, + results: [sampleBundle({ expiration: '2000-01-01T00:00:00.000Z' })], + }) + ) + + fixture.detectChanges() + + expect(fixture.nativeElement.textContent).toContain('Expired') + }) + + it('stores a changed page size and reloads from the first page', () => { + fixture.detectChanges() + const settingsService = TestBed.inject(SettingsService) + jest + .spyOn(settingsService, 'get') + .mockReturnValueOnce({ share_link_bundles: 25 }) + const setSpy = jest.spyOn(settingsService, 'set') + jest.spyOn(settingsService, 'storeSettings').mockReturnValue(of({})) + component.page.set(2) + + component.pageSize = 100 + + expect(setSpy).toHaveBeenCalledWith(SETTINGS_KEYS.OBJECT_LIST_SIZES, { + share_link_bundles: 100, + }) + expect(component.page()).toBe(1) + expect(service.list).toHaveBeenLastCalledWith(1, 100, 'created', true) }) it('copies bundle links when ready', () => { @@ -126,16 +174,24 @@ describe('ShareLinkBundleManageDialogComponent', () => { slug: 'ready-slug', status: ShareLinkBundleStatus.Ready, }) + component.bundles.set([readyBundle]) + fixture.detectChanges() component.copy(readyBundle) expect(clipboard.copy).toHaveBeenCalledWith( component.getShareUrl(readyBundle) ) expect(component.copiedSlug()).toBe('ready-slug') - expect(toastService.showInfo).toHaveBeenCalled() + expect(toastService.showInfo).not.toHaveBeenCalled() + fixture.detectChanges() + expect( + fixture.nativeElement.querySelector('.badge.show').textContent + ).toContain('Copied!') jest.advanceTimersByTime(3000) expect(component.copiedSlug()).toBeNull() + fixture.detectChanges() + expect(fixture.nativeElement.querySelector('.badge.show')).toBeNull() }) it('ignores copy requests for non-ready bundles', () => { @@ -146,7 +202,7 @@ describe('ShareLinkBundleManageDialogComponent', () => { }) it('deletes bundles and refreshes list', () => { - service.listAllBundles.mockReturnValue(of([])) + service.list.mockReturnValue(of({ count: 0, results: [] })) service.delete.mockReturnValue(of(true)) fixture.detectChanges() @@ -157,12 +213,12 @@ describe('ShareLinkBundleManageDialogComponent', () => { expect(toastService.showInfo).toHaveBeenCalledWith( expect.stringContaining('deleted.') ) - expect(service.listAllBundles).toHaveBeenCalledTimes(2) + expect(service.list).toHaveBeenCalledTimes(2) expect(component.loading()).toBe(false) }) it('handles delete errors gracefully', () => { - service.listAllBundles.mockReturnValue(of([])) + service.list.mockReturnValue(of({ count: 0, results: [] })) service.delete.mockReturnValue(throwError(() => new Error('delete fail'))) fixture.detectChanges() @@ -174,7 +230,7 @@ describe('ShareLinkBundleManageDialogComponent', () => { }) it('retries bundle build and replaces existing entry', () => { - service.listAllBundles.mockReturnValue(of([])) + service.list.mockReturnValue(of({ count: 0, results: [] })) const updated = sampleBundle({ status: ShareLinkBundleStatus.Ready }) service.rebuildBundle.mockReturnValue(of(updated)) @@ -189,7 +245,7 @@ describe('ShareLinkBundleManageDialogComponent', () => { }) it('adds new bundle when retry returns unknown entry', () => { - service.listAllBundles.mockReturnValue(of([])) + service.list.mockReturnValue(of({ count: 0, results: [] })) service.rebuildBundle.mockReturnValue( of(sampleBundle({ id: 99, slug: 'new-slug' })) ) @@ -203,7 +259,7 @@ describe('ShareLinkBundleManageDialogComponent', () => { }) it('handles retry errors', () => { - service.listAllBundles.mockReturnValue(of([])) + service.list.mockReturnValue(of({ count: 0, results: [] })) service.rebuildBundle.mockReturnValue(throwError(() => new Error('fail'))) fixture.detectChanges() @@ -213,8 +269,8 @@ describe('ShareLinkBundleManageDialogComponent', () => { expect(toastService.showError).toHaveBeenCalled() }) - it('maps helpers and closes dialog', () => { - service.listAllBundles.mockReturnValue(of([])) + it('maps status and file version helpers', () => { + service.list.mockReturnValue(of({ count: 0, results: [] })) fixture.detectChanges() expect(component.statusLabel(ShareLinkBundleStatus.Processing)).toContain( @@ -227,9 +283,5 @@ describe('ShareLinkBundleManageDialogComponent', () => { environment.apiBaseUrl = 'https://example.com/api/' const url = component.getShareUrl(sampleBundle({ slug: 'sluggy' })) expect(url).toBe('https://example.com/share/sluggy') - - const closeSpy = jest.spyOn(activeModal, 'close') - component.close() - expect(closeSpy).toHaveBeenCalled() }) }) diff --git a/src-ui/src/app/components/common/share-link-bundle-manage-dialog/share-link-bundle-manage-dialog.component.ts b/src-ui/src/app/components/manage/share-links/share-link-bundle-list/share-link-bundle-list.component.ts similarity index 59% rename from src-ui/src/app/components/common/share-link-bundle-manage-dialog/share-link-bundle-manage-dialog.component.ts rename to src-ui/src/app/components/manage/share-links/share-link-bundle-list/share-link-bundle-list.component.ts index 5da728e5a..00d04a77e 100644 --- a/src-ui/src/app/components/common/share-link-bundle-manage-dialog/share-link-bundle-manage-dialog.component.ts +++ b/src-ui/src/app/components/manage/share-links/share-link-bundle-list/share-link-bundle-list.component.ts @@ -1,7 +1,11 @@ import { Clipboard } from '@angular/cdk/clipboard' import { CommonModule } from '@angular/common' import { Component, OnDestroy, OnInit, inject, signal } from '@angular/core' -import { NgbActiveModal, NgbPopoverModule } from '@ng-bootstrap/ng-bootstrap' +import { FormsModule } from '@angular/forms' +import { + NgbPaginationModule, + NgbPopoverModule, +} from '@ng-bootstrap/ng-bootstrap' import { NgxBootstrapIconsModule } from 'ngx-bootstrap-icons' import { Subject, catchError, of, switchMap, takeUntil, timer } from 'rxjs' import { FileVersion } from 'src/app/data/share-link' @@ -11,42 +15,77 @@ import { ShareLinkBundleStatus, ShareLinkBundleSummary, } from 'src/app/data/share-link-bundle' +import { SETTINGS_KEYS } from 'src/app/data/ui-settings' +import { + SortEvent, + SortableDirective, +} from 'src/app/directives/sortable.directive' import { FileSizePipe } from 'src/app/pipes/file-size.pipe' import { ShareLinkBundleService } from 'src/app/services/rest/share-link-bundle.service' +import { SettingsService } from 'src/app/services/settings.service' import { ToastService } from 'src/app/services/toast.service' import { environment } from 'src/environments/environment' -import { LoadingComponentWithPermissions } from '../../loading-component/loading.component' -import { ConfirmButtonComponent } from '../confirm-button/confirm-button.component' +import { ConfirmButtonComponent } from 'src/app/components/common/confirm-button/confirm-button.component' +import { LoadingComponentWithPermissions } from 'src/app/components/loading-component/loading.component' @Component({ - selector: 'pngx-share-link-bundle-manage-dialog', - templateUrl: './share-link-bundle-manage-dialog.component.html', - styleUrls: ['./share-link-bundle-manage-dialog.component.scss'], + selector: 'pngx-share-link-bundle-list', + templateUrl: './share-link-bundle-list.component.html', + styleUrls: ['./share-link-bundle-list.component.scss'], imports: [ ConfirmButtonComponent, CommonModule, + FormsModule, + NgbPaginationModule, NgbPopoverModule, NgxBootstrapIconsModule, + SortableDirective, FileSizePipe, ], }) -export class ShareLinkBundleManageDialogComponent +export class ShareLinkBundleListComponent extends LoadingComponentWithPermissions implements OnInit, OnDestroy { - private readonly activeModal = inject(NgbActiveModal) private readonly shareLinkBundleService = inject(ShareLinkBundleService) + private readonly settingsService = inject(SettingsService) private readonly toastService = inject(ToastService) private readonly clipboard = inject(Clipboard) - title = $localize`Share link bundles` readonly bundles = signal([]) readonly error = signal(null) readonly copiedSlug = signal(null) + readonly total = signal(0) + readonly page = signal(1) + readonly sortField = signal('created') + readonly sortReverse = signal(true) readonly statuses = ShareLinkBundleStatus readonly fileVersions = FileVersion + get pageSize(): number { + return ( + this.settingsService.get(SETTINGS_KEYS.OBJECT_LIST_SIZES) + ?.share_link_bundles || 25 + ) + } + + set pageSize(pageSize: number) { + this.settingsService.set(SETTINGS_KEYS.OBJECT_LIST_SIZES, { + ...this.settingsService.get(SETTINGS_KEYS.OBJECT_LIST_SIZES), + share_link_bundles: pageSize, + }) + this.settingsService.storeSettings().subscribe({ + next: () => { + this.page.set(1) + this.triggerRefresh(false) + }, + error: (error) => { + this.toastService.showError($localize`Error saving settings`, error) + }, + }) + } + private readonly refresh$ = new Subject() ngOnInit(): void { @@ -57,25 +96,33 @@ export class ShareLinkBundleManageDialogComponent this.loading.set(true) } this.error.set(null) - return this.shareLinkBundleService.listAllBundles().pipe( - catchError((error) => { - if (!silent) { - this.loading.set(false) - } - this.error.set($localize`Failed to load share link bundles.`) - this.toastService.showError( - $localize`Error retrieving share link bundles.`, - error - ) - return of(null) - }) - ) + return this.shareLinkBundleService + .list( + this.page(), + this.pageSize, + this.sortField(), + this.sortReverse() + ) + .pipe( + catchError((error) => { + if (!silent) { + this.loading.set(false) + } + this.error.set($localize`Failed to load share link bundles.`) + this.toastService.showError( + $localize`Error retrieving share link bundles.`, + error + ) + return of(null) + }) + ) }), takeUntil(this.unsubscribeNotifier) ) .subscribe((results) => { if (results) { - this.bundles.set(results) + this.bundles.set(results.results) + this.total.set(results.count) this.copiedSlug.set(null) } this.loading.set(false) @@ -98,6 +145,18 @@ export class ShareLinkBundleManageDialogComponent }` } + setPage(page: number): void { + this.page.set(page) + this.triggerRefresh(false) + } + + onSort(event: SortEvent): void { + this.sortField.set(event.column || 'created') + this.sortReverse.set(event.column ? event.reverse : true) + this.page.set(1) + this.triggerRefresh(false) + } + copy(bundle: ShareLinkBundleSummary): void { if (bundle.status !== ShareLinkBundleStatus.Ready) { return @@ -108,7 +167,6 @@ export class ShareLinkBundleManageDialogComponent setTimeout(() => { this.copiedSlug.set(null) }, 3000) - this.toastService.showInfo($localize`Share link copied to clipboard.`) } } @@ -117,6 +175,9 @@ export class ShareLinkBundleManageDialogComponent this.loading.set(true) this.shareLinkBundleService.delete(bundle).subscribe({ next: () => { + if (this.bundles().length === 1 && this.page() > 1) { + this.page.update((page) => page - 1) + } this.toastService.showInfo($localize`Share link bundle deleted.`) this.triggerRefresh(false) }, @@ -153,8 +214,8 @@ export class ShareLinkBundleManageDialogComponent return SHARE_LINK_BUNDLE_FILE_VERSION_LABELS[version] ?? version } - close(): void { - this.activeModal.close() + isExpired(expiration?: string): boolean { + return !!expiration && Date.parse(expiration) <= Date.now() } private replaceBundle(updated: ShareLinkBundleSummary): void { diff --git a/src-ui/src/app/components/manage/share-links/share-link-list/share-link-list.component.html b/src-ui/src/app/components/manage/share-links/share-link-list/share-link-list.component.html new file mode 100644 index 000000000..710db7dc3 --- /dev/null +++ b/src-ui/src/app/components/manage/share-links/share-link-list/share-link-list.component.html @@ -0,0 +1,110 @@ +
    + @if (!loading() && error()) { + + } + @if (!loading() && !error() && links().length === 0) { +

    + No document share links currently exist. +

    + } + @if (!loading() && !error() && links().length > 0) { +
    + + + + + + + + + + + + @for (link of links(); track link.id) { + + + + + + + + } + +
    DocumentCreatedExpiresFile versionActions
    + {{ link.document_title | documentTitle }} + + @if (copiedDocumentID() === link.document) { + Copied! + } @else { + ID: {{link.document}} + } + + {{ link.created | date: 'short' }} + @if (link.expiration) { + {{ link.expiration | date: 'short' }} + @if (isExpired(link.expiration)) { + Expired + } + } @else { + Never + } + {{ fileVersionLabel(link.file_version) }} +
    + Copied! +
    + + + + +
    +
    +
    +
    +
    +
    + + + per page +
    + @if (total() > pageSize) { + + } +
    + } +
    diff --git a/src-ui/src/app/components/manage/share-links/share-link-list/share-link-list.component.spec.ts b/src-ui/src/app/components/manage/share-links/share-link-list/share-link-list.component.spec.ts new file mode 100644 index 000000000..1946b7e78 --- /dev/null +++ b/src-ui/src/app/components/manage/share-links/share-link-list/share-link-list.component.spec.ts @@ -0,0 +1,155 @@ +import { Clipboard } from '@angular/cdk/clipboard' +import { ComponentFixture, TestBed } from '@angular/core/testing' +import { RouterTestingModule } from '@angular/router/testing' +import { NgxBootstrapIconsModule, allIcons } from 'ngx-bootstrap-icons' +import { of, throwError } from 'rxjs' +import { FileVersion, ShareLink } from 'src/app/data/share-link' +import { SETTINGS_KEYS } from 'src/app/data/ui-settings' +import { ShareLinkService } from 'src/app/services/rest/share-link.service' +import { SettingsService } from 'src/app/services/settings.service' +import { ToastService } from 'src/app/services/toast.service' +import { ShareLinkListComponent } from './share-link-list.component' + +describe('ShareLinkListComponent', () => { + let component: ShareLinkListComponent + let fixture: ComponentFixture + let service: jest.Mocked> + let clipboard: Clipboard + let toastService: jest.Mocked> + + const link = { + id: 1, + document: 42, + document_title: 'Test document', + slug: 'share-slug', + created: new Date().toISOString(), + expiration: null, + file_version: FileVersion.Archive, + } as ShareLink + + beforeEach(() => { + service = { + list: jest.fn().mockReturnValue(of({ count: 1, results: [link] })), + delete: jest.fn().mockReturnValue(of(true)), + } + toastService = { + showInfo: jest.fn(), + showError: jest.fn(), + } + + TestBed.configureTestingModule({ + imports: [ + ShareLinkListComponent, + NgxBootstrapIconsModule.pick(allIcons), + RouterTestingModule, + ], + providers: [ + { provide: ShareLinkService, useValue: service }, + { provide: ToastService, useValue: toastService }, + ], + }) + + fixture = TestBed.createComponent(ShareLinkListComponent) + component = fixture.componentInstance + clipboard = TestBed.inject(Clipboard) + }) + + afterEach(() => { + jest.clearAllTimers() + jest.useRealTimers() + }) + + it('loads and renders document share links', () => { + fixture.detectChanges() + + expect(service.list).toHaveBeenCalledWith(1, 25, 'created', true) + expect(component.links()).toEqual([link]) + expect(fixture.nativeElement.textContent).toContain('Test document') + expect(fixture.nativeElement.textContent).toContain('ID: 42') + }) + + it('loads another page', () => { + fixture.detectChanges() + component.setPage(2) + + expect(service.list).toHaveBeenLastCalledWith(2, 25, 'created', true) + }) + + it('sorts links and returns to the first page', () => { + fixture.detectChanges() + component.page.set(2) + + component.onSort({ column: 'expiration', reverse: false }) + + expect(component.page()).toBe(1) + expect(service.list).toHaveBeenLastCalledWith(1, 25, 'expiration', false) + }) + + it('marks expired share links', () => { + service.list.mockReturnValue( + of({ + count: 1, + results: [ + { + ...link, + expiration: '2000-01-01T00:00:00.000Z', + }, + ], + }) + ) + + fixture.detectChanges() + + expect(fixture.nativeElement.textContent).toContain('Expired') + }) + + it('stores a changed page size and reloads from the first page', () => { + const settingsService = TestBed.inject(SettingsService) + jest.spyOn(settingsService, 'get').mockReturnValueOnce({ share_links: 25 }) + const setSpy = jest.spyOn(settingsService, 'set') + jest.spyOn(settingsService, 'storeSettings').mockReturnValue(of({})) + const reloadSpy = jest.spyOn(component, 'reload') + component.page.set(2) + + component.pageSize = 50 + + expect(setSpy).toHaveBeenCalledWith(SETTINGS_KEYS.OBJECT_LIST_SIZES, { + share_links: 50, + }) + expect(component.page()).toBe(1) + expect(reloadSpy).toHaveBeenCalled() + }) + + it('shows local copy feedback without a toast', () => { + jest.useFakeTimers() + jest.spyOn(clipboard, 'copy').mockReturnValue(true) + fixture.detectChanges() + + component.copy(link) + fixture.detectChanges() + + expect(component.copiedID()).toBe(link.id) + expect(fixture.nativeElement.querySelector('.badge.show')).not.toBeNull() + expect(toastService.showInfo).not.toHaveBeenCalled() + + jest.advanceTimersByTime(3000) + expect(component.copiedID()).toBeNull() + }) + + it('deletes a link and reloads the list', () => { + fixture.detectChanges() + component.delete(link) + + expect(service.delete).toHaveBeenCalledWith(link) + expect(service.list).toHaveBeenCalledTimes(2) + expect(toastService.showInfo).toHaveBeenCalled() + }) + + it('shows an error when loading fails', () => { + service.list.mockReturnValue(throwError(() => new Error('load failed'))) + fixture.detectChanges() + + expect(component.error()).toContain('Failed to load share links.') + expect(toastService.showError).toHaveBeenCalled() + }) +}) diff --git a/src-ui/src/app/components/manage/share-links/share-link-list/share-link-list.component.ts b/src-ui/src/app/components/manage/share-links/share-link-list/share-link-list.component.ts new file mode 100644 index 000000000..6f30366f4 --- /dev/null +++ b/src-ui/src/app/components/manage/share-links/share-link-list/share-link-list.component.ts @@ -0,0 +1,172 @@ +import { Clipboard } from '@angular/cdk/clipboard' +import { CommonModule } from '@angular/common' +import { Component, OnInit, inject, signal } from '@angular/core' +import { FormsModule } from '@angular/forms' +import { RouterModule } from '@angular/router' +import { NgbPaginationModule } from '@ng-bootstrap/ng-bootstrap' +import { NgxBootstrapIconsModule } from 'ngx-bootstrap-icons' +import { takeUntil } from 'rxjs' +import { ConfirmButtonComponent } from 'src/app/components/common/confirm-button/confirm-button.component' +import { LoadingComponentWithPermissions } from 'src/app/components/loading-component/loading.component' +import { FileVersion, ShareLink } from 'src/app/data/share-link' +import { SHARE_LINK_BUNDLE_FILE_VERSION_LABELS } from 'src/app/data/share-link-bundle' +import { SETTINGS_KEYS } from 'src/app/data/ui-settings' +import { IfPermissionsDirective } from 'src/app/directives/if-permissions.directive' +import { + SortEvent, + SortableDirective, +} from 'src/app/directives/sortable.directive' +import { DocumentTitlePipe } from 'src/app/pipes/document-title.pipe' +import { + PermissionAction, + PermissionType, +} from 'src/app/services/permissions.service' +import { ShareLinkService } from 'src/app/services/rest/share-link.service' +import { SettingsService } from 'src/app/services/settings.service' +import { ToastService } from 'src/app/services/toast.service' +import { environment } from 'src/environments/environment' + +@Component({ + selector: 'pngx-share-link-list', + templateUrl: './share-link-list.component.html', + imports: [ + CommonModule, + ConfirmButtonComponent, + DocumentTitlePipe, + FormsModule, + IfPermissionsDirective, + NgbPaginationModule, + NgxBootstrapIconsModule, + RouterModule, + SortableDirective, + ], +}) +export class ShareLinkListComponent + extends LoadingComponentWithPermissions + implements OnInit +{ + private readonly clipboard = inject(Clipboard) + private readonly shareLinkService = inject(ShareLinkService) + private readonly settingsService = inject(SettingsService) + private readonly toastService = inject(ToastService) + + readonly links = signal([]) + readonly total = signal(0) + readonly page = signal(1) + readonly sortField = signal('created') + readonly sortReverse = signal(true) + readonly copiedID = signal(null) + readonly copiedDocumentID = signal(null) + readonly error = signal(null) + readonly PermissionAction = PermissionAction + readonly PermissionType = PermissionType + + get pageSize(): number { + return ( + this.settingsService.get(SETTINGS_KEYS.OBJECT_LIST_SIZES)?.share_links || + 25 + ) + } + + set pageSize(pageSize: number) { + this.settingsService.set(SETTINGS_KEYS.OBJECT_LIST_SIZES, { + ...this.settingsService.get(SETTINGS_KEYS.OBJECT_LIST_SIZES), + share_links: pageSize, + }) + this.settingsService.storeSettings().subscribe({ + next: () => { + this.page.set(1) + this.reload() + }, + error: (error) => { + this.toastService.showError($localize`Error saving settings`, error) + }, + }) + } + + ngOnInit(): void { + this.reload() + } + + reload(): void { + this.loading.set(true) + this.error.set(null) + this.shareLinkService + .list(this.page(), this.pageSize, this.sortField(), this.sortReverse()) + .pipe(takeUntil(this.unsubscribeNotifier)) + .subscribe({ + next: (results) => { + this.links.set(results.results) + this.total.set(results.count) + this.loading.set(false) + }, + error: (error) => { + this.loading.set(false) + this.error.set($localize`Failed to load share links.`) + this.toastService.showError( + $localize`Error retrieving share links.`, + error + ) + }, + }) + } + + setPage(page: number): void { + this.page.set(page) + this.reload() + } + + onSort(event: SortEvent): void { + this.sortField.set(event.column || 'created') + this.sortReverse.set(event.column ? event.reverse : true) + this.page.set(1) + this.reload() + } + + getShareUrl(link: ShareLink): string { + const apiURL = new URL(environment.apiBaseUrl) + return `${apiURL.origin}${apiURL.pathname.replace(/\/api\/$/, '/share/')}${ + link.slug + }` + } + + fileVersionLabel(version: FileVersion): string { + return SHARE_LINK_BUNDLE_FILE_VERSION_LABELS[version] ?? version + } + + isExpired(expiration?: string): boolean { + return !!expiration && Date.parse(expiration) <= Date.now() + } + + copy(link: ShareLink): void { + if (this.clipboard.copy(this.getShareUrl(link))) { + this.copiedID.set(link.id) + setTimeout(() => this.copiedID.set(null), 3000) + } + } + + delete(link: ShareLink): void { + this.shareLinkService.delete(link).subscribe({ + next: () => { + if (this.links().length === 1 && this.page() > 1) { + this.page.update((page) => page - 1) + } + this.toastService.showInfo($localize`Share link deleted.`) + this.reload() + }, + error: (error) => { + this.toastService.showError( + $localize`Error deleting share link.`, + error + ) + }, + }) + } + + copyDocumentID(documentID: number): void { + if (this.clipboard.copy(documentID.toString())) { + this.copiedDocumentID.set(documentID) + setTimeout(() => this.copiedDocumentID.set(null), 3000) + } + } +} diff --git a/src-ui/src/app/components/manage/share-links/share-links.component.html b/src-ui/src/app/components/manage/share-links/share-links.component.html new file mode 100644 index 000000000..0db06c62e --- /dev/null +++ b/src-ui/src/app/components/manage/share-links/share-links.component.html @@ -0,0 +1,34 @@ + + +
      + @if (canViewDocumentLinks) { +
    • + + + + +
      • + } + @if (canViewBundles) { +
    • + + + + +
      • + } +
    + +
    diff --git a/src-ui/src/app/components/manage/share-links/share-links.component.spec.ts b/src-ui/src/app/components/manage/share-links/share-links.component.spec.ts new file mode 100644 index 000000000..36c46dd2c --- /dev/null +++ b/src-ui/src/app/components/manage/share-links/share-links.component.spec.ts @@ -0,0 +1,102 @@ +import { ComponentFixture, TestBed } from '@angular/core/testing' +import { ActivatedRoute, convertToParamMap, Router } from '@angular/router' +import { NgbNavModule } from '@ng-bootstrap/ng-bootstrap' +import { NgxBootstrapIconsModule, allIcons } from 'ngx-bootstrap-icons' +import { of } from 'rxjs' +import { + PermissionAction, + PermissionsService, + PermissionType, +} from 'src/app/services/permissions.service' +import { ShareLinkBundleService } from 'src/app/services/rest/share-link-bundle.service' +import { ShareLinkService } from 'src/app/services/rest/share-link.service' +import { ToastService } from 'src/app/services/toast.service' +import { PageHeaderComponent } from '../../common/page-header/page-header.component' +import { ShareLinksComponent, ShareLinksNavIDs } from './share-links.component' + +describe('ShareLinksComponent', () => { + let fixture: ComponentFixture + let permissionsService: PermissionsService + let router: Router + + const configure = async (type: string = null) => { + await TestBed.configureTestingModule({ + imports: [ + ShareLinksComponent, + NgbNavModule, + NgxBootstrapIconsModule.pick(allIcons), + PageHeaderComponent, + ], + providers: [ + PermissionsService, + { + provide: ActivatedRoute, + useValue: { + snapshot: { queryParamMap: convertToParamMap({ type }) }, + }, + }, + { + provide: Router, + useValue: { navigate: jest.fn().mockResolvedValue(true) }, + }, + { + provide: ShareLinkBundleService, + useValue: { + list: jest.fn().mockReturnValue(of({ count: 0, results: [] })), + rebuildBundle: jest.fn(), + delete: jest.fn(), + }, + }, + { + provide: ShareLinkService, + useValue: { + list: jest.fn().mockReturnValue(of({ count: 0, results: [] })), + delete: jest.fn(), + }, + }, + { + provide: ToastService, + useValue: { showInfo: jest.fn(), showError: jest.fn() }, + }, + ], + }).compileComponents() + + permissionsService = TestBed.inject(PermissionsService) + router = TestBed.inject(Router) + } + + afterEach(() => TestBed.resetTestingModule()) + + it('uses the requested bundles tab when permitted', async () => { + await configure(ShareLinksNavIDs.Bundles) + jest + .spyOn(permissionsService, 'currentUserCan') + .mockImplementation( + (action, type) => + action === PermissionAction.View && + type === PermissionType.ShareLinkBundle + ) + + fixture = TestBed.createComponent(ShareLinksComponent) + fixture.detectChanges() + + expect(fixture.componentInstance.activeNavID()).toBe( + ShareLinksNavIDs.Bundles + ) + expect(fixture.nativeElement.textContent).not.toContain('Document links') + }) + + it('updates the URL when a tab is selected', async () => { + await configure() + jest.spyOn(permissionsService, 'currentUserCan').mockReturnValue(true) + + fixture = TestBed.createComponent(ShareLinksComponent) + fixture.componentInstance.selectTab(ShareLinksNavIDs.Bundles) + + expect(router.navigate).toHaveBeenCalledWith([], { + relativeTo: TestBed.inject(ActivatedRoute), + queryParams: { type: ShareLinksNavIDs.Bundles }, + queryParamsHandling: 'merge', + }) + }) +}) diff --git a/src-ui/src/app/components/manage/share-links/share-links.component.ts b/src-ui/src/app/components/manage/share-links/share-links.component.ts new file mode 100644 index 000000000..bc7aa156f --- /dev/null +++ b/src-ui/src/app/components/manage/share-links/share-links.component.ts @@ -0,0 +1,78 @@ +import { Component, computed, inject, signal, viewChild } from '@angular/core' +import { ActivatedRoute, Router } from '@angular/router' +import { NgbNavModule } from '@ng-bootstrap/ng-bootstrap' +import { + PermissionAction, + PermissionsService, + PermissionType, +} from 'src/app/services/permissions.service' +import { PageHeaderComponent } from '../../common/page-header/page-header.component' +import { ShareLinkBundleListComponent } from './share-link-bundle-list/share-link-bundle-list.component' +import { ShareLinkListComponent } from './share-link-list/share-link-list.component' + +export enum ShareLinksNavIDs { + DocumentLinks = 'documents', + Bundles = 'bundles', +} + +@Component({ + selector: 'pngx-share-links', + templateUrl: './share-links.component.html', + imports: [ + NgbNavModule, + PageHeaderComponent, + ShareLinkBundleListComponent, + ShareLinkListComponent, + ], +}) +export class ShareLinksComponent { + private readonly route = inject(ActivatedRoute) + private readonly router = inject(Router) + private readonly permissionsService = inject(PermissionsService) + + readonly ShareLinksNavIDs = ShareLinksNavIDs + readonly activeNavID = signal(this.getInitialNavID()) + private readonly documentLinks = viewChild(ShareLinkListComponent) + private readonly bundles = viewChild(ShareLinkBundleListComponent) + readonly loading = computed(() => { + const activeList = + this.activeNavID() === ShareLinksNavIDs.DocumentLinks + ? this.documentLinks() + : this.bundles() + return activeList?.loading() ?? true + }) + + get canViewDocumentLinks(): boolean { + return this.permissionsService.currentUserCan( + PermissionAction.View, + PermissionType.ShareLink + ) + } + + get canViewBundles(): boolean { + return this.permissionsService.currentUserCan( + PermissionAction.View, + PermissionType.ShareLinkBundle + ) + } + + selectTab(tab: ShareLinksNavIDs): void { + this.activeNavID.set(tab) + void this.router.navigate([], { + relativeTo: this.route, + queryParams: { type: tab }, + queryParamsHandling: 'merge', + }) + } + + private getInitialNavID(): ShareLinksNavIDs { + const requestedTab = this.route.snapshot.queryParamMap.get('type') + if (requestedTab === ShareLinksNavIDs.Bundles && this.canViewBundles) { + return ShareLinksNavIDs.Bundles + } + if (this.canViewDocumentLinks) { + return ShareLinksNavIDs.DocumentLinks + } + return ShareLinksNavIDs.Bundles + } +} diff --git a/src-ui/src/app/data/share-link.ts b/src-ui/src/app/data/share-link.ts index d9710bd47..f71002995 100644 --- a/src-ui/src/app/data/share-link.ts +++ b/src-ui/src/app/data/share-link.ts @@ -26,5 +26,7 @@ export interface ShareLink extends ObjectWithPermissions { document: number // Document + document_title?: string + file_version: string } diff --git a/src-ui/src/app/data/ui-settings.ts b/src-ui/src/app/data/ui-settings.ts index a36435e37..5bc500872 100644 --- a/src-ui/src/app/data/ui-settings.ts +++ b/src-ui/src/app/data/ui-settings.ts @@ -27,6 +27,7 @@ export enum CollapsibleSection { export enum HideableSidebarItemID { Dashboard = 'dashboard', SavedViews = 'saved_views', + ShareLinks = 'share_links', Workflows = 'workflows', Mail = 'mail', Documentation = 'documentation', @@ -246,6 +247,8 @@ export const SETTINGS: UiSetting[] = [ document_types: 25, tags: 25, storage_paths: 25, + share_links: 25, + share_link_bundles: 25, }, }, { diff --git a/src-ui/src/app/services/rest/share-link-bundle.service.spec.ts b/src-ui/src/app/services/rest/share-link-bundle.service.spec.ts index 6b87ddf04..726dfc4a3 100644 --- a/src-ui/src/app/services/rest/share-link-bundle.service.spec.ts +++ b/src-ui/src/app/services/rest/share-link-bundle.service.spec.ts @@ -48,13 +48,4 @@ describe('ShareLinkBundleService', () => { expect(req.request.body).toEqual({}) req.flush({}) }) - - it('lists bundles with expected parameters', () => { - subscription = service.listAllBundles().subscribe() - const req = httpTestingController.expectOne( - `${environment.apiBaseUrl}${endpoint}/?page=1&page_size=1000&ordering=-created` - ) - expect(req.request.method).toBe('GET') - req.flush({ results: [] }) - }) }) diff --git a/src-ui/src/app/services/rest/share-link-bundle.service.ts b/src-ui/src/app/services/rest/share-link-bundle.service.ts index 2aa719974..4dd7d5791 100644 --- a/src-ui/src/app/services/rest/share-link-bundle.service.ts +++ b/src-ui/src/app/services/rest/share-link-bundle.service.ts @@ -1,6 +1,5 @@ import { Injectable } from '@angular/core' import { Observable } from 'rxjs' -import { map } from 'rxjs/operators' import { ShareLinkBundleCreatePayload, ShareLinkBundleSummary, @@ -32,10 +31,4 @@ export class ShareLinkBundleService extends AbstractNameFilterService { - return this.list(1, 1000, 'created', true).pipe( - map((response) => response.results) - ) - } } diff --git a/src-ui/src/styles.scss b/src-ui/src/styles.scss index 55cbff7f9..8c0fec3e8 100644 --- a/src-ui/src/styles.scss +++ b/src-ui/src/styles.scss @@ -626,6 +626,10 @@ ul.pagination { table.table { --bs-table-color: var(--bs-body-color); --bs-table-bg: var(--bs-light-rgb); + + &.bg-body { + --bs-table-bg: var(--bs-body-bg); + } } .close { diff --git a/src/documents/serialisers.py b/src/documents/serialisers.py index 10296a392..917c68ca4 100644 --- a/src/documents/serialisers.py +++ b/src/documents/serialisers.py @@ -2835,6 +2835,11 @@ class AcknowledgeTasksViewSerializer(serializers.Serializer[dict[str, Any]]): class ShareLinkSerializer(OwnedObjectSerializer): + document_title = serializers.CharField( + source="document.title", + read_only=True, + ) + class Meta: model = ShareLink fields = ( @@ -2843,6 +2848,7 @@ class ShareLinkSerializer(OwnedObjectSerializer): "expiration", "slug", "document", + "document_title", "file_version", ) diff --git a/src/documents/tests/test_api_documents.py b/src/documents/tests/test_api_documents.py index 7e8b1a720..adee77b64 100644 --- a/src/documents/tests/test_api_documents.py +++ b/src/documents/tests/test_api_documents.py @@ -3906,6 +3906,7 @@ class TestDocumentApi(DirectoriesMixin, ConsumeTaskMixin, APITestCase): }, ) self.assertEqual(resp.status_code, status.HTTP_201_CREATED) + self.assertEqual(resp.data["document_title"], doc.title) resp = self.client.post( "/api/share_links/", @@ -3916,6 +3917,17 @@ class TestDocumentApi(DirectoriesMixin, ConsumeTaskMixin, APITestCase): }, ) self.assertEqual(resp.status_code, status.HTTP_201_CREATED) + self.assertEqual(resp.data["document_title"], doc.title) + + response = self.client.get("/api/share_links/", format="json") + + self.assertEqual(response.status_code, status.HTTP_200_OK) + self.assertEqual(response.data["count"], 2) + self.assertTrue( + all( + link["document_title"] == doc.title for link in response.data["results"] + ), + ) response = self.client.get( f"/api/documents/{doc.pk}/share_links/", @@ -3927,6 +3939,9 @@ class TestDocumentApi(DirectoriesMixin, ConsumeTaskMixin, APITestCase): resp_data = response.json() self.assertEqual(len(resp_data), 2) + self.assertTrue( + all(link["document_title"] == doc.title for link in resp_data), + ) self.assertGreater(len(resp_data[1]["slug"]), 0) self.assertIsNone(resp_data[1]["expiration"]) @@ -3952,6 +3967,23 @@ class TestDocumentApi(DirectoriesMixin, ConsumeTaskMixin, APITestCase): self.assertEqual(response.status_code, status.HTTP_404_NOT_FOUND) + def test_order_share_links_by_document_title(self) -> None: + document_zulu = Document.objects.create(title="Zulu") + document_alpha = Document.objects.create(title="Alpha") + ShareLink.objects.create(document=document_zulu, slug="zulu-link") + ShareLink.objects.create(document=document_alpha, slug="alpha-link") + + response = self.client.get( + "/api/share_links/?ordering=document__title", + format="json", + ) + + self.assertEqual(response.status_code, status.HTTP_200_OK) + self.assertEqual( + [link["document_title"] for link in response.data["results"]], + ["Alpha", "Zulu"], + ) + def test_share_links_permissions_aware(self) -> None: """ GIVEN: diff --git a/src/documents/views.py b/src/documents/views.py index 7bee5b51f..6f647bf3f 100644 --- a/src/documents/views.py +++ b/src/documents/views.py @@ -1983,7 +1983,14 @@ class DocumentViewSet( now = timezone.now() links = ( ShareLink.objects.filter(document=doc) - .only("pk", "created", "expiration", "slug") + .select_related("document") + .only( + "pk", + "created", + "expiration", + "slug", + "document__title", + ) .exclude(expiration__lt=now) .order_by("-created") ) @@ -4665,7 +4672,7 @@ class ShareLinkViewSet( ): model = ShareLink - queryset = ShareLink.objects.all() + queryset = ShareLink.objects.select_related("document") serializer_class = ShareLinkSerializer pagination_class = StandardPagination @@ -4676,7 +4683,7 @@ class ShareLinkViewSet( PermittedObjectsFilter, ) filterset_class = ShareLinkFilterSet - ordering_fields = ("created", "expiration", "document") + ordering_fields = ("created", "expiration", "document__title") @extend_schema_view(