From ed37f82c0f0b618bc7d3fd3f63735ddc611223a5 Mon Sep 17 00:00:00 2001 From: shamoon <4887959+shamoon@users.noreply.github.com> Date: Sat, 16 Sep 2023 01:09:04 -0700 Subject: [PATCH] Frontend implementation of consumption templates Testing --- src-ui/src/app/app-routing.module.ts | 13 +- src-ui/src/app/app.module.ts | 4 + .../app-frame/app-frame.component.html | 7 + ...mption-template-edit-dialog.component.html | 73 ++++++++ ...mption-template-edit-dialog.component.scss | 0 ...ion-template-edit-dialog.component.spec.ts | 63 +++++++ ...sumption-template-edit-dialog.component.ts | 88 ++++++++++ .../common/input/tags/tags.component.html | 2 +- .../common/input/tags/tags.component.ts | 3 + .../consmption-templates-list.component.html | 33 ++++ .../consmption-templates-list.component.scss | 0 ...onsmption-templates-list.component.spec.ts | 166 ++++++++++++++++++ .../consmption-templates-list.component.ts | 111 ++++++++++++ .../consmption-templates.component.html | 1 + .../consmption-templates.component.scss | 0 .../consmption-templates.component.spec.ts | 21 +++ .../consmption-templates.component.ts | 8 + .../data/paperless-consumption-template.ts | 29 +++ src-ui/src/app/data/paperless-user.ts | 1 - .../app/services/permissions.service.spec.ts | 4 + .../src/app/services/permissions.service.ts | 1 + .../rest/consumption-template.service.spec.ts | 7 + .../rest/consumption-template.service.ts | 42 +++++ 23 files changed, 674 insertions(+), 3 deletions(-) create mode 100644 src-ui/src/app/components/common/edit-dialog/consumption-template-edit-dialog/consumption-template-edit-dialog.component.html create mode 100644 src-ui/src/app/components/common/edit-dialog/consumption-template-edit-dialog/consumption-template-edit-dialog.component.scss create mode 100644 src-ui/src/app/components/common/edit-dialog/consumption-template-edit-dialog/consumption-template-edit-dialog.component.spec.ts create mode 100644 src-ui/src/app/components/common/edit-dialog/consumption-template-edit-dialog/consumption-template-edit-dialog.component.ts create mode 100644 src-ui/src/app/components/manage/consmption-templates-list/consmption-templates-list.component.html create mode 100644 src-ui/src/app/components/manage/consmption-templates-list/consmption-templates-list.component.scss create mode 100644 src-ui/src/app/components/manage/consmption-templates-list/consmption-templates-list.component.spec.ts create mode 100644 src-ui/src/app/components/manage/consmption-templates-list/consmption-templates-list.component.ts create mode 100644 src-ui/src/app/components/manage/consmption-templates/consmption-templates.component.html create mode 100644 src-ui/src/app/components/manage/consmption-templates/consmption-templates.component.scss create mode 100644 src-ui/src/app/components/manage/consmption-templates/consmption-templates.component.spec.ts create mode 100644 src-ui/src/app/components/manage/consmption-templates/consmption-templates.component.ts create mode 100644 src-ui/src/app/data/paperless-consumption-template.ts create mode 100644 src-ui/src/app/services/rest/consumption-template.service.spec.ts create mode 100644 src-ui/src/app/services/rest/consumption-template.service.ts diff --git a/src-ui/src/app/app-routing.module.ts b/src-ui/src/app/app-routing.module.ts index d839274f8..ddedbc763 100644 --- a/src-ui/src/app/app-routing.module.ts +++ b/src-ui/src/app/app-routing.module.ts @@ -21,6 +21,7 @@ import { PermissionAction, PermissionType, } from './services/permissions.service' +import { ConsmptionTemplatesListComponent } from './components/manage/consmption-templates-list/consmption-templates-list.component' export const routes: Routes = [ { path: '', redirectTo: 'dashboard', pathMatch: 'full' }, @@ -182,7 +183,17 @@ export const routes: Routes = [ }, }, }, - { path: 'tasks', component: TasksComponent }, + { + path: 'templates', + component: ConsmptionTemplatesListComponent, + canActivate: [PermissionsGuard], + data: { + requiredPermission: { + action: PermissionAction.View, + type: PermissionType.ConsumptionTemplate, + }, + }, + }, ], }, diff --git a/src-ui/src/app/app.module.ts b/src-ui/src/app/app.module.ts index f46c06cb9..b5098025d 100644 --- a/src-ui/src/app/app.module.ts +++ b/src-ui/src/app/app.module.ts @@ -95,6 +95,8 @@ import { UsernamePipe } from './pipes/username.pipe' import { LogoComponent } from './components/common/logo/logo.component' import { IsNumberPipe } from './pipes/is-number.pipe' import { ShareLinksDropdownComponent } from './components/common/share-links-dropdown/share-links-dropdown.component' +import { ConsmptionTemplatesListComponent } from './components/manage/consmption-templates-list/consmption-templates-list.component' +import { ConsumptionTemplateEditDialogComponent } from './components/common/edit-dialog/consumption-template-edit-dialog/consumption-template-edit-dialog.component' import localeAf from '@angular/common/locales/af' import localeAr from '@angular/common/locales/ar' @@ -233,6 +235,8 @@ function initializeApp(settings: SettingsService) { LogoComponent, IsNumberPipe, ShareLinksDropdownComponent, + ConsmptionTemplatesListComponent, + ConsumptionTemplateEditDialogComponent, ], imports: [ BrowserModule, 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 3d62c0932..61e716714 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 @@ -155,6 +155,13 @@  Storage paths +
  • + + + +  Templates + +
  • {{tasksService.failedFileTasks.length}} diff --git a/src-ui/src/app/components/common/edit-dialog/consumption-template-edit-dialog/consumption-template-edit-dialog.component.html b/src-ui/src/app/components/common/edit-dialog/consumption-template-edit-dialog/consumption-template-edit-dialog.component.html new file mode 100644 index 000000000..537fb8a9b --- /dev/null +++ b/src-ui/src/app/components/common/edit-dialog/consumption-template-edit-dialog/consumption-template-edit-dialog.component.html @@ -0,0 +1,73 @@ +
    +
    + + +
    +
    +
    +
    + + +

    Paperless-ngx will process mails that match any of the filters specified below.

    + + +
    +
    + + + + +
    +
    + +
    + +
    +
    +
    + +
    +
    + +
    +
    +
    +
    + +
    +
    + +
    +
    +
    + +
    +
    +
    + +
    +
    + +
    +
    +
    +
    + +
    +
    + +
    +
    + Edit permissions also grant viewing permissions +
    +
    +
    +
    +
    +
    + Error: {{error.non_field_errors}} + + +
    +
    diff --git a/src-ui/src/app/components/common/edit-dialog/consumption-template-edit-dialog/consumption-template-edit-dialog.component.scss b/src-ui/src/app/components/common/edit-dialog/consumption-template-edit-dialog/consumption-template-edit-dialog.component.scss new file mode 100644 index 000000000..e69de29bb diff --git a/src-ui/src/app/components/common/edit-dialog/consumption-template-edit-dialog/consumption-template-edit-dialog.component.spec.ts b/src-ui/src/app/components/common/edit-dialog/consumption-template-edit-dialog/consumption-template-edit-dialog.component.spec.ts new file mode 100644 index 000000000..8e30ee8d8 --- /dev/null +++ b/src-ui/src/app/components/common/edit-dialog/consumption-template-edit-dialog/consumption-template-edit-dialog.component.spec.ts @@ -0,0 +1,63 @@ +import { HttpClientTestingModule } from '@angular/common/http/testing' +import { ComponentFixture, TestBed } from '@angular/core/testing' +import { FormsModule, ReactiveFormsModule } from '@angular/forms' +import { NgbActiveModal, NgbModule } from '@ng-bootstrap/ng-bootstrap' +import { NgSelectModule } from '@ng-select/ng-select' +import { IfOwnerDirective } from 'src/app/directives/if-owner.directive' +import { IfPermissionsDirective } from 'src/app/directives/if-permissions.directive' +import { SafeHtmlPipe } from 'src/app/pipes/safehtml.pipe' +import { NumberComponent } from '../../input/number/number.component' +import { PermissionsGroupComponent } from '../../input/permissions/permissions-group/permissions-group.component' +import { PermissionsUserComponent } from '../../input/permissions/permissions-user/permissions-user.component' +import { SelectComponent } from '../../input/select/select.component' +import { TagsComponent } from '../../input/tags/tags.component' +import { TextComponent } from '../../input/text/text.component' +import { ConsumptionTemplateEditDialogComponent } from './consumption-template-edit-dialog.component' +import { EditDialogMode } from '../edit-dialog.component' + +describe('ConsumptionTemplateEditDialogComponent', () => { + let component: ConsumptionTemplateEditDialogComponent + let fixture: ComponentFixture + + beforeEach(() => { + TestBed.configureTestingModule({ + declarations: [ + ConsumptionTemplateEditDialogComponent, + IfPermissionsDirective, + IfOwnerDirective, + SelectComponent, + TextComponent, + NumberComponent, + TagsComponent, + PermissionsUserComponent, + PermissionsGroupComponent, + SafeHtmlPipe, + ], + providers: [NgbActiveModal], + imports: [ + HttpClientTestingModule, + FormsModule, + ReactiveFormsModule, + NgSelectModule, + NgbModule, + ], + }).compileComponents() + + fixture = TestBed.createComponent(ConsumptionTemplateEditDialogComponent) + component = fixture.componentInstance + + fixture.detectChanges() + }) + + it('should support create and edit modes', () => { + component.dialogMode = EditDialogMode.CREATE + const createTitleSpy = jest.spyOn(component, 'getCreateTitle') + const editTitleSpy = jest.spyOn(component, 'getEditTitle') + fixture.detectChanges() + expect(createTitleSpy).toHaveBeenCalled() + expect(editTitleSpy).not.toHaveBeenCalled() + component.dialogMode = EditDialogMode.EDIT + fixture.detectChanges() + expect(editTitleSpy).toHaveBeenCalled() + }) +}) diff --git a/src-ui/src/app/components/common/edit-dialog/consumption-template-edit-dialog/consumption-template-edit-dialog.component.ts b/src-ui/src/app/components/common/edit-dialog/consumption-template-edit-dialog/consumption-template-edit-dialog.component.ts new file mode 100644 index 000000000..66d48aeef --- /dev/null +++ b/src-ui/src/app/components/common/edit-dialog/consumption-template-edit-dialog/consumption-template-edit-dialog.component.ts @@ -0,0 +1,88 @@ +import { Component } from '@angular/core' +import { FormGroup, FormControl } from '@angular/forms' +import { NgbActiveModal } from '@ng-bootstrap/ng-bootstrap' +import { first } from 'rxjs' +import { PaperlessConsumptionTemplate } from 'src/app/data/paperless-consumption-template' +import { PaperlessCorrespondent } from 'src/app/data/paperless-correspondent' +import { PaperlessDocumentType } from 'src/app/data/paperless-document-type' +import { + MailFilterAttachmentType, + MailRuleConsumptionScope, + MailAction, + MailMetadataTitleOption, + MailMetadataCorrespondentOption, +} from 'src/app/data/paperless-mail-rule' +import { PaperlessStoragePath } from 'src/app/data/paperless-storage-path' +import { ConsumptionTemplateService } from 'src/app/services/rest/consumption-template.service' +import { CorrespondentService } from 'src/app/services/rest/correspondent.service' +import { DocumentTypeService } from 'src/app/services/rest/document-type.service' +import { StoragePathService } from 'src/app/services/rest/storage-path.service' +import { UserService } from 'src/app/services/rest/user.service' +import { SettingsService } from 'src/app/services/settings.service' +import { EditDialogComponent } from '../edit-dialog.component' + +@Component({ + selector: 'pngx-consumption-template-edit-dialog', + templateUrl: './consumption-template-edit-dialog.component.html', + styleUrls: ['./consumption-template-edit-dialog.component.scss'], +}) +export class ConsumptionTemplateEditDialogComponent extends EditDialogComponent { + templates: PaperlessConsumptionTemplate[] + correspondents: PaperlessCorrespondent[] + documentTypes: PaperlessDocumentType[] + storagePaths: PaperlessStoragePath[] + + constructor( + service: ConsumptionTemplateService, + activeModal: NgbActiveModal, + correspondentService: CorrespondentService, + documentTypeService: DocumentTypeService, + storagePathService: StoragePathService, + userService: UserService, + settingsService: SettingsService + ) { + super(service, activeModal, userService, settingsService) + + correspondentService + .listAll() + .pipe(first()) + .subscribe((result) => (this.correspondents = result.results)) + + documentTypeService + .listAll() + .pipe(first()) + .subscribe((result) => (this.documentTypes = result.results)) + + storagePathService + .listAll() + .pipe(first()) + .subscribe((result) => (this.storagePaths = result.results)) + } + + getCreateTitle() { + return $localize`Create new consumption template` + } + + getEditTitle() { + return $localize`Edit consumption template` + } + + getForm(): FormGroup { + return new FormGroup({ + name: new FormControl(null), + account: new FormControl(null), + filter_filename: new FormControl(null), + filter_path: new FormControl(null), + order: new FormControl(null), + assign_tags: new FormControl([]), + assign_owner: new FormControl(null), + assign_document_type: new FormControl(null), + assign_correspondent: new FormControl(null), + assign_storage_path: new FormControl(null), + assign_view_users: new FormControl(null), + assign_view_groups: new FormControl(null), + assign_change_users: new FormControl(null), + assign_change_groups: new FormControl(null), + }) + } +} diff --git a/src-ui/src/app/components/common/input/tags/tags.component.html b/src-ui/src/app/components/common/input/tags/tags.component.html index a49a0de2d..053f13419 100644 --- a/src-ui/src/app/components/common/input/tags/tags.component.html +++ b/src-ui/src/app/components/common/input/tags/tags.component.html @@ -1,5 +1,5 @@
    - +
    + + + + + + + + + + + + + + + + + + + + +
    NameFile name filterPath filterActions
    {{template.filter_filename}}{{template.filter_path}} +
    + + +
    +
    +
    No templates defined.
    diff --git a/src-ui/src/app/components/manage/consmption-templates-list/consmption-templates-list.component.scss b/src-ui/src/app/components/manage/consmption-templates-list/consmption-templates-list.component.scss new file mode 100644 index 000000000..e69de29bb diff --git a/src-ui/src/app/components/manage/consmption-templates-list/consmption-templates-list.component.spec.ts b/src-ui/src/app/components/manage/consmption-templates-list/consmption-templates-list.component.spec.ts new file mode 100644 index 000000000..3f1743eb4 --- /dev/null +++ b/src-ui/src/app/components/manage/consmption-templates-list/consmption-templates-list.component.spec.ts @@ -0,0 +1,166 @@ +import { HttpClientTestingModule } from '@angular/common/http/testing' +import { ComponentFixture, TestBed } from '@angular/core/testing' +import { FormsModule, ReactiveFormsModule } from '@angular/forms' +import { By } from '@angular/platform-browser' +import { + NgbModal, + NgbPaginationModule, + NgbModalRef, + NgbModalModule, +} from '@ng-bootstrap/ng-bootstrap' +import { of, throwError } from 'rxjs' +import { PaperlessConsumptionTemplate } from 'src/app/data/paperless-consumption-template' +import { IfPermissionsDirective } from 'src/app/directives/if-permissions.directive' +import { ConsumptionTemplateService } from 'src/app/services/rest/consumption-template.service' +import { ToastService } from 'src/app/services/toast.service' +import { ConfirmDialogComponent } from '../../common/confirm-dialog/confirm-dialog.component' +import { PageHeaderComponent } from '../../common/page-header/page-header.component' +import { ConsmptionTemplatesListComponent } from './consmption-templates-list.component' +import { ConsumptionTemplateEditDialogComponent } from '../../common/edit-dialog/consumption-template-edit-dialog/consumption-template-edit-dialog.component' +import { PermissionsService } from 'src/app/services/permissions.service' + +const templates: PaperlessConsumptionTemplate[] = [ + { + id: 0, + name: 'Template 1', + order: 0, + filter_filename: 'foo', + filter_path: 'bar', + assign_tags: [1, 2, 3], + }, + { + id: 1, + name: 'Template 2', + order: 1, + filter_filename: null, + filter_path: 'foo/bar', + assign_owner: 1, + }, +] + +describe('ConsmptionTemplatesComponent', () => { + let component: ConsmptionTemplatesListComponent + let fixture: ComponentFixture + let consumptionTemplateService: ConsumptionTemplateService + let modalService: NgbModal + let toastService: ToastService + + beforeEach(() => { + TestBed.configureTestingModule({ + declarations: [ + ConsmptionTemplatesListComponent, + IfPermissionsDirective, + PageHeaderComponent, + ConfirmDialogComponent, + ], + providers: [ + { + provide: PermissionsService, + useValue: { + currentUserCan: () => true, + currentUserHasObjectPermissions: () => true, + currentUserOwnsObject: () => true, + }, + }, + ], + imports: [ + HttpClientTestingModule, + NgbPaginationModule, + FormsModule, + ReactiveFormsModule, + NgbModalModule, + ], + }) + + consumptionTemplateService = TestBed.inject(ConsumptionTemplateService) + jest.spyOn(consumptionTemplateService, 'listAll').mockReturnValue( + of({ + count: templates.length, + all: templates.map((o) => o.id), + results: templates, + }) + ) + modalService = TestBed.inject(NgbModal) + toastService = TestBed.inject(ToastService) + + fixture = TestBed.createComponent(ConsmptionTemplatesListComponent) + component = fixture.componentInstance + fixture.detectChanges() + }) + + it('should support create, show notification on error / success', () => { + let modal: NgbModalRef + modalService.activeInstances.subscribe((m) => (modal = m[m.length - 1])) + const toastErrorSpy = jest.spyOn(toastService, 'showError') + const toastInfoSpy = jest.spyOn(toastService, 'showInfo') + const reloadSpy = jest.spyOn(component, 'reload') + + const createButton = fixture.debugElement.queryAll(By.css('button'))[0] + createButton.triggerEventHandler('click') + + expect(modal).not.toBeUndefined() + const editDialog = + modal.componentInstance as ConsumptionTemplateEditDialogComponent + + // fail first + editDialog.failed.emit({ error: 'error creating item' }) + expect(toastErrorSpy).toHaveBeenCalled() + expect(reloadSpy).not.toHaveBeenCalled() + + // succeed + editDialog.succeeded.emit(templates[0]) + expect(toastInfoSpy).toHaveBeenCalled() + expect(reloadSpy).toHaveBeenCalled() + }) + + it('should support edit, show notification on error / success', () => { + let modal: NgbModalRef + modalService.activeInstances.subscribe((m) => (modal = m[m.length - 1])) + const toastErrorSpy = jest.spyOn(toastService, 'showError') + const toastInfoSpy = jest.spyOn(toastService, 'showInfo') + const reloadSpy = jest.spyOn(component, 'reload') + + const editButton = fixture.debugElement.queryAll(By.css('button'))[1] + editButton.triggerEventHandler('click') + + expect(modal).not.toBeUndefined() + const editDialog = + modal.componentInstance as ConsumptionTemplateEditDialogComponent + expect(editDialog.object).toEqual(templates[0]) + + // fail first + editDialog.failed.emit({ error: 'error editing item' }) + expect(toastErrorSpy).toHaveBeenCalled() + expect(reloadSpy).not.toHaveBeenCalled() + + // succeed + editDialog.succeeded.emit(templates[0]) + expect(toastInfoSpy).toHaveBeenCalled() + expect(reloadSpy).toHaveBeenCalled() + }) + + it('should support delete, show notification on error / success', () => { + let modal: NgbModalRef + modalService.activeInstances.subscribe((m) => (modal = m[m.length - 1])) + const toastErrorSpy = jest.spyOn(toastService, 'showError') + const deleteSpy = jest.spyOn(consumptionTemplateService, 'delete') + const reloadSpy = jest.spyOn(component, 'reload') + + const deleteButton = fixture.debugElement.queryAll(By.css('button'))[3] + deleteButton.triggerEventHandler('click') + + expect(modal).not.toBeUndefined() + const editDialog = modal.componentInstance as ConfirmDialogComponent + + // fail first + deleteSpy.mockReturnValueOnce(throwError(() => new Error('error deleting'))) + editDialog.confirmClicked.emit() + expect(toastErrorSpy).toHaveBeenCalled() + expect(reloadSpy).not.toHaveBeenCalled() + + // succeed + deleteSpy.mockReturnValueOnce(of(true)) + editDialog.confirmClicked.emit() + expect(reloadSpy).toHaveBeenCalled() + }) +}) diff --git a/src-ui/src/app/components/manage/consmption-templates-list/consmption-templates-list.component.ts b/src-ui/src/app/components/manage/consmption-templates-list/consmption-templates-list.component.ts new file mode 100644 index 000000000..ce7433453 --- /dev/null +++ b/src-ui/src/app/components/manage/consmption-templates-list/consmption-templates-list.component.ts @@ -0,0 +1,111 @@ +import { Component, OnInit } from '@angular/core' +import { ConsumptionTemplateService } from 'src/app/services/rest/consumption-template.service' +import { ComponentWithPermissions } from '../../with-permissions/with-permissions.component' +import { Subject, takeUntil } from 'rxjs' +import { PaperlessConsumptionTemplate } from 'src/app/data/paperless-consumption-template' +import { NgbModal } from '@ng-bootstrap/ng-bootstrap' +import { ToastService } from 'src/app/services/toast.service' +import { PermissionsService } from 'src/app/services/permissions.service' +import { ConsumptionTemplateEditDialogComponent } from '../../common/edit-dialog/consumption-template-edit-dialog/consumption-template-edit-dialog.component' +import { ConfirmDialogComponent } from '../../common/confirm-dialog/confirm-dialog.component' +import { EditDialogMode } from '../../common/edit-dialog/edit-dialog.component' + +@Component({ + selector: 'pngx-consmption-templates-list', + templateUrl: './consmption-templates-list.component.html', + styleUrls: ['./consmption-templates-list.component.scss'], +}) +export class ConsmptionTemplatesListComponent + extends ComponentWithPermissions + implements OnInit +{ + public templates: PaperlessConsumptionTemplate[] = [] + + private unsubscribeNotifier: Subject = new Subject() + + constructor( + private consumptionTemplateService: ConsumptionTemplateService, + public permissionsService: PermissionsService, + private modalService: NgbModal, + private toastService: ToastService + ) { + super() + } + + ngOnInit() { + this.reload() + } + + reload() { + this.consumptionTemplateService + .listAll() + .pipe(takeUntil(this.unsubscribeNotifier)) + .subscribe((r) => { + this.templates = r.results + }) + } + + editTemplate(rule: PaperlessConsumptionTemplate) { + const modal = this.modalService.open( + ConsumptionTemplateEditDialogComponent, + { + backdrop: 'static', + size: 'xl', + } + ) + modal.componentInstance.dialogMode = rule + ? EditDialogMode.EDIT + : EditDialogMode.CREATE + modal.componentInstance.object = rule + modal.componentInstance.succeeded + .pipe(takeUntil(this.unsubscribeNotifier)) + .subscribe((newTemplate) => { + this.toastService.showInfo( + $localize`Saved template "${newTemplate.name}".` + ) + this.consumptionTemplateService.clearCache() + this.reload() + }) + modal.componentInstance.failed + .pipe(takeUntil(this.unsubscribeNotifier)) + .subscribe((e) => { + this.toastService.showError($localize`Error saving template.`, e) + }) + } + + deleteTemplate(rule: PaperlessConsumptionTemplate) { + const modal = this.modalService.open(ConfirmDialogComponent, { + backdrop: 'static', + }) + modal.componentInstance.title = $localize`Confirm delete template` + modal.componentInstance.messageBold = $localize`This operation will permanently delete this template.` + modal.componentInstance.message = $localize`This operation cannot be undone.` + modal.componentInstance.btnClass = 'btn-danger' + modal.componentInstance.btnCaption = $localize`Proceed` + modal.componentInstance.confirmClicked.subscribe(() => { + modal.componentInstance.buttonsEnabled = false + this.consumptionTemplateService.delete(rule).subscribe({ + next: () => { + modal.close() + this.toastService.showInfo($localize`Deleted template`) + this.consumptionTemplateService.clearCache() + this.reload() + }, + error: (e) => { + this.toastService.showError($localize`Error deleting template.`, e) + }, + }) + }) + } + + userCanEdit(template: PaperlessConsumptionTemplate): boolean { + return this.permissionsService.currentUserHasObjectPermissions( + this.PermissionAction.Change, + template + ) + } + + userIsOwner(template: PaperlessConsumptionTemplate): boolean { + return this.permissionsService.currentUserOwnsObject(template) + } +} diff --git a/src-ui/src/app/components/manage/consmption-templates/consmption-templates.component.html b/src-ui/src/app/components/manage/consmption-templates/consmption-templates.component.html new file mode 100644 index 000000000..06244229d --- /dev/null +++ b/src-ui/src/app/components/manage/consmption-templates/consmption-templates.component.html @@ -0,0 +1 @@ +

    consmption-templates works!

    diff --git a/src-ui/src/app/components/manage/consmption-templates/consmption-templates.component.scss b/src-ui/src/app/components/manage/consmption-templates/consmption-templates.component.scss new file mode 100644 index 000000000..e69de29bb diff --git a/src-ui/src/app/components/manage/consmption-templates/consmption-templates.component.spec.ts b/src-ui/src/app/components/manage/consmption-templates/consmption-templates.component.spec.ts new file mode 100644 index 000000000..9e2aa5fb6 --- /dev/null +++ b/src-ui/src/app/components/manage/consmption-templates/consmption-templates.component.spec.ts @@ -0,0 +1,21 @@ +import { ComponentFixture, TestBed } from '@angular/core/testing' + +import { ConsmptionTemplatesComponent } from './consmption-templates.component' + +describe('ConsmptionTemplatesComponent', () => { + let component: ConsmptionTemplatesComponent + let fixture: ComponentFixture + + beforeEach(() => { + TestBed.configureTestingModule({ + declarations: [ConsmptionTemplatesComponent], + }) + fixture = TestBed.createComponent(ConsmptionTemplatesComponent) + component = fixture.componentInstance + fixture.detectChanges() + }) + + it('should create', () => { + expect(component).toBeTruthy() + }) +}) diff --git a/src-ui/src/app/components/manage/consmption-templates/consmption-templates.component.ts b/src-ui/src/app/components/manage/consmption-templates/consmption-templates.component.ts new file mode 100644 index 000000000..e96ccb350 --- /dev/null +++ b/src-ui/src/app/components/manage/consmption-templates/consmption-templates.component.ts @@ -0,0 +1,8 @@ +import { Component } from '@angular/core' + +@Component({ + selector: 'pngx-consmption-templates', + templateUrl: './consmption-templates.component.html', + styleUrls: ['./consmption-templates.component.scss'], +}) +export class ConsmptionTemplatesComponent {} diff --git a/src-ui/src/app/data/paperless-consumption-template.ts b/src-ui/src/app/data/paperless-consumption-template.ts new file mode 100644 index 000000000..4ce1bac96 --- /dev/null +++ b/src-ui/src/app/data/paperless-consumption-template.ts @@ -0,0 +1,29 @@ +import { ObjectWithPermissions } from './object-with-permissions' + +export interface PaperlessConsumptionTemplate extends ObjectWithPermissions { + name: string + + order: number + + filter_filename: string + + filter_path: string + + assign_tags?: number[] // PaperlessTag.id + + assign_document_type?: number // PaperlessDocumentType.id + + assign_correspondent?: number // PaperlessCorrespondent.id + + assign_storage_path?: number // PaperlessStoragePath.id + + assign_owner?: number // PaperlessUser.id + + assign_view_users?: number[] // [PaperlessUser.id] + + assign_view_groups?: number[] // [PaperlessGroup.id] + + assign_change_users?: number[] // [PaperlessUser.id] + + assign_change_groups?: number[] // [PaperlessGroup.id] +} diff --git a/src-ui/src/app/data/paperless-user.ts b/src-ui/src/app/data/paperless-user.ts index 1cd64ebf9..72c3f7579 100644 --- a/src-ui/src/app/data/paperless-user.ts +++ b/src-ui/src/app/data/paperless-user.ts @@ -1,4 +1,3 @@ -import { PaperlessGroup } from 'src/app/data/paperless-group' import { ObjectWithId } from './object-with-id' export interface PaperlessUser extends ObjectWithId { diff --git a/src-ui/src/app/services/permissions.service.spec.ts b/src-ui/src/app/services/permissions.service.spec.ts index 9e7c43df4..820b9ac1f 100644 --- a/src-ui/src/app/services/permissions.service.spec.ts +++ b/src-ui/src/app/services/permissions.service.spec.ts @@ -252,6 +252,10 @@ describe('PermissionsService', () => { 'view_sharelink', 'change_sharelink', 'delete_sharelink', + 'add_consumptiontemplate', + 'view_consumptiontemplate', + 'change_consumptiontemplate', + 'delete_consumptiontemplate', ], { username: 'testuser', diff --git a/src-ui/src/app/services/permissions.service.ts b/src-ui/src/app/services/permissions.service.ts index 1f4df3748..b22e56177 100644 --- a/src-ui/src/app/services/permissions.service.ts +++ b/src-ui/src/app/services/permissions.service.ts @@ -25,6 +25,7 @@ export enum PermissionType { Group = '%s_group', Admin = '%s_logentry', ShareLink = '%s_sharelink', + ConsumptionTemplate = '%s_consumptiontemplate', } @Injectable({ diff --git a/src-ui/src/app/services/rest/consumption-template.service.spec.ts b/src-ui/src/app/services/rest/consumption-template.service.spec.ts new file mode 100644 index 000000000..c01ee06cc --- /dev/null +++ b/src-ui/src/app/services/rest/consumption-template.service.spec.ts @@ -0,0 +1,7 @@ +import { commonAbstractPaperlessServiceTests } from './abstract-paperless-service.spec' +import { ConsumptionTemplateService } from './consumption-template.service' + +commonAbstractPaperlessServiceTests( + 'consumption_templates', + ConsumptionTemplateService +) diff --git a/src-ui/src/app/services/rest/consumption-template.service.ts b/src-ui/src/app/services/rest/consumption-template.service.ts new file mode 100644 index 000000000..f7756e775 --- /dev/null +++ b/src-ui/src/app/services/rest/consumption-template.service.ts @@ -0,0 +1,42 @@ +import { HttpClient } from '@angular/common/http' +import { Injectable } from '@angular/core' +import { tap } from 'rxjs' +import { PaperlessConsumptionTemplate } from 'src/app/data/paperless-consumption-template' +import { AbstractPaperlessService } from './abstract-paperless-service' + +@Injectable({ + providedIn: 'root', +}) +export class ConsumptionTemplateService extends AbstractPaperlessService { + loading: boolean + + constructor(http: HttpClient) { + super(http, 'consumption_templates') + } + + private reload() { + this.loading = true + this.listAll().subscribe((r) => { + this.templates = r.results + this.loading = false + }) + } + + private templates: PaperlessConsumptionTemplate[] = [] + + public get allTemplates(): PaperlessConsumptionTemplate[] { + return this.templates + } + + create(o: PaperlessConsumptionTemplate) { + return super.create(o).pipe(tap(() => this.reload())) + } + + update(o: PaperlessConsumptionTemplate) { + return super.update(o).pipe(tap(() => this.reload())) + } + + delete(o: PaperlessConsumptionTemplate) { + return super.delete(o).pipe(tap(() => this.reload())) + } +}