Feature: consumption templates (#4196)

* Initial implementation of consumption templates

* Frontend implementation of consumption templates

Testing

* Support consumption template source

* order templates, automatically add permissions

* Support title assignment in consumption templates

* Refactoring, filters to and, show sources on list

Show sources on template list, update some translation strings

Make filters and

minor testing

* Update strings

* Only update django-multiselectfield

* Basic docs, document some methods

* Improve testing coverage, template multi-assignment merges

src-ui/src/app/services/rest/consumption-template.service.spec.ts

@@ -0,0 +1,64 @@
+import { HttpTestingController } from '@angular/common/http/testing'
+import { TestBed } from '@angular/core/testing'
+import { Subscription } from 'rxjs'
+import { environment } from 'src/environments/environment'
+import { commonAbstractPaperlessServiceTests } from './abstract-paperless-service.spec'
+import { ConsumptionTemplateService } from './consumption-template.service'
+import {
+  DocumentSource,
+  PaperlessConsumptionTemplate,
+} from 'src/app/data/paperless-consumption-template'
+
+let httpTestingController: HttpTestingController
+let service: ConsumptionTemplateService
+const endpoint = 'consumption_templates'
+const templates: PaperlessConsumptionTemplate[] = [
+  {
+    name: 'Template 1',
+    id: 1,
+    order: 1,
+    filter_filename: '*test*',
+    filter_path: null,
+    sources: [DocumentSource.ApiUpload],
+    assign_correspondent: 2,
+  },
+  {
+    name: 'Template 2',
+    id: 2,
+    order: 2,
+    filter_filename: null,
+    filter_path: '/test/',
+    sources: [DocumentSource.ConsumeFolder, DocumentSource.ApiUpload],
+    assign_document_type: 1,
+  },
+]
+
+// run common tests
+commonAbstractPaperlessServiceTests(
+  'consumption_templates',
+  ConsumptionTemplateService
+)
+
+describe(`Additional service tests for ConsumptionTemplateService`, () => {
+  it('should reload', () => {
+    service.reload()
+    const req = httpTestingController.expectOne(
+      `${environment.apiBaseUrl}${endpoint}/?page=1&page_size=100000`
+    )
+    req.flush({
+      results: templates,
+    })
+    expect(service.allTemplates).toEqual(templates)
+  })
+
+  beforeEach(() => {
+    // Dont need to setup again
+
+    httpTestingController = TestBed.inject(HttpTestingController)
+    service = TestBed.inject(ConsumptionTemplateService)
+  })
+
+  afterEach(() => {
+    httpTestingController.verify()
+  })
+})

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<PaperlessConsumptionTemplate> {
+  loading: boolean
+
+  constructor(http: HttpClient) {
+    super(http, 'consumption_templates')
+  }
+
+  public 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()))
+  }
+}

src-ui/src/app/services/rest/mail-rule.service.spec.ts

@@ -28,6 +28,7 @@ const mail_rules = [
     attachment_type: MailFilterAttachmentType.Everything,
     action: MailAction.MarkRead,
     assign_title_from: MailMetadataTitleOption.FromSubject,
+    assign_owner_from_rule: true,
   },
   {
     name: 'Mail Rule 2',
@@ -44,6 +45,7 @@ const mail_rules = [
     attachment_type: MailFilterAttachmentType.Everything,
     action: MailAction.Delete,
     assign_title_from: MailMetadataTitleOption.FromSubject,
+    assign_owner_from_rule: true,
   },
   {
     name: 'Mail Rule 3',
@@ -60,6 +62,7 @@ const mail_rules = [
     attachment_type: MailFilterAttachmentType.Everything,
     action: MailAction.Flag,
     assign_title_from: MailMetadataTitleOption.FromSubject,
+    assign_owner_from_rule: false,
   },
 ]