Feature: email document button (#8950)

src-ui/src/app/components/common/email-document-dialog/email-document-dialog.component.html

@@ -0,0 +1,32 @@
+<div class="modal-header">
+    <h4 class="modal-title" id="modal-basic-title">{{title}}</h4>
+    <button type="button" class="btn-close" aria-label="Close" (click)="close()"></button>
+</div>
+<div class="modal-body">
+    <div class="mb-1">
+        <label for="email" class="form-label" i18n>Email address(es)</label>
+        <input type="email" class="form-control" id="email" [(ngModel)]="emailAddress">
+    </div>
+    <div class="mb-1">
+        <label for="email" class="form-label" i18n>Subject</label>
+        <input type="email" class="form-control" id="subject" [(ngModel)]="emailSubject">
+    </div>
+    <div>
+        <label for="message" class="form-label" i18n>Message</label>
+        <textarea class="form-control" id="message" rows="3" [(ngModel)]="emailMessage"></textarea>
+    </div>
+</div>
+<div class="modal-footer">
+    <div class="input-group">
+        <div class="input-group-text flex-grow-1">
+            <input class="form-check-input mt-0 me-2" type="checkbox" role="switch" id="useArchiveVersion" [disabled]="!hasArchiveVersion" [(ngModel)]="useArchiveVersion">
+            <label class="form-check-label w-100 text-start" for="useArchiveVersion" i18n>Use archive version</label>
+        </div>
+        <button type="submit" class="btn btn-outline-primary" (click)="emailDocument()" [disabled]="loading || emailAddress.length === 0 || emailMessage.length === 0 || emailSubject.length === 0">
+            @if (loading) {
+                <div class="spinner-border spinner-border-sm me-2" role="status"></div>
+            }
+            <ng-container i18n>Send email</ng-container>
+        </button>
+    </div>
+</div>

src-ui/src/app/components/common/email-document-dialog/email-document-dialog.component.spec.ts

@@ -0,0 +1,72 @@
+import { ComponentFixture, TestBed } from '@angular/core/testing'
+
+import { provideHttpClient, withInterceptorsFromDi } from '@angular/common/http'
+import { provideHttpClientTesting } from '@angular/common/http/testing'
+import { NgbActiveModal } from '@ng-bootstrap/ng-bootstrap'
+import { NgxBootstrapIconsModule, allIcons } from 'ngx-bootstrap-icons'
+import { of, throwError } from 'rxjs'
+import { IfPermissionsDirective } from 'src/app/directives/if-permissions.directive'
+import { PermissionsService } from 'src/app/services/permissions.service'
+import { DocumentService } from 'src/app/services/rest/document.service'
+import { ToastService } from 'src/app/services/toast.service'
+import { EmailDocumentDialogComponent } from './email-document-dialog.component'
+
+describe('EmailDocumentDialogComponent', () => {
+  let component: EmailDocumentDialogComponent
+  let fixture: ComponentFixture<EmailDocumentDialogComponent>
+  let documentService: DocumentService
+  let permissionsService: PermissionsService
+  let toastService: ToastService
+
+  beforeEach(async () => {
+    await TestBed.configureTestingModule({
+      imports: [
+        EmailDocumentDialogComponent,
+        IfPermissionsDirective,
+        NgxBootstrapIconsModule.pick(allIcons),
+      ],
+      providers: [
+        provideHttpClient(withInterceptorsFromDi()),
+        provideHttpClientTesting(),
+        NgbActiveModal,
+      ],
+    }).compileComponents()
+
+    fixture = TestBed.createComponent(EmailDocumentDialogComponent)
+    documentService = TestBed.inject(DocumentService)
+    toastService = TestBed.inject(ToastService)
+    component = fixture.componentInstance
+    fixture.detectChanges()
+  })
+
+  it('should set hasArchiveVersion and useArchiveVersion', () => {
+    expect(component.hasArchiveVersion).toBeTruthy()
+    component.hasArchiveVersion = false
+    expect(component.hasArchiveVersion).toBeFalsy()
+    expect(component.useArchiveVersion).toBeFalsy()
+  })
+
+  it('should support sending document via email, showing error if needed', () => {
+    const toastErrorSpy = jest.spyOn(toastService, 'showError')
+    const toastSuccessSpy = jest.spyOn(toastService, 'showInfo')
+    component.emailAddress = 'hello@paperless-ngx.com'
+    component.emailSubject = 'Hello'
+    component.emailMessage = 'World'
+    jest
+      .spyOn(documentService, 'emailDocument')
+      .mockReturnValue(throwError(() => new Error('Unable to email document')))
+    component.emailDocument()
+    expect(toastErrorSpy).toHaveBeenCalled()
+
+    jest.spyOn(documentService, 'emailDocument').mockReturnValue(of(true))
+    component.emailDocument()
+    expect(toastSuccessSpy).toHaveBeenCalled()
+  })
+
+  it('should close the dialog', () => {
+    const activeModal = TestBed.inject(NgbActiveModal)
+    const closeSpy = jest.spyOn(activeModal, 'close')
+    component.close()
+    expect(closeSpy).toHaveBeenCalled()
+  })
+})

src-ui/src/app/components/common/email-document-dialog/email-document-dialog.component.ts

@@ -0,0 +1,77 @@
+import { Component, Input } from '@angular/core'
+import { FormsModule } from '@angular/forms'
+import { NgbActiveModal } from '@ng-bootstrap/ng-bootstrap'
+import { NgxBootstrapIconsModule } from 'ngx-bootstrap-icons'
+import { DocumentService } from 'src/app/services/rest/document.service'
+import { ToastService } from 'src/app/services/toast.service'
+import { LoadingComponentWithPermissions } from '../../loading-component/loading.component'
+
+@Component({
+  selector: 'pngx-email-document-dialog',
+  templateUrl: './email-document-dialog.component.html',
+  styleUrl: './email-document-dialog.component.scss',
+  imports: [FormsModule, NgxBootstrapIconsModule],
+})
+export class EmailDocumentDialogComponent extends LoadingComponentWithPermissions {
+  @Input()
+  title = $localize`Email Document`
+
+  @Input()
+  documentId: number
+
+  private _hasArchiveVersion: boolean = true
+
+  @Input()
+  set hasArchiveVersion(value: boolean) {
+    this._hasArchiveVersion = value
+    this.useArchiveVersion = value
+  }
+
+  get hasArchiveVersion(): boolean {
+    return this._hasArchiveVersion
+  }
+
+  public useArchiveVersion: boolean = true
+
+  public emailAddress: string = ''
+  public emailSubject: string = ''
+  public emailMessage: string = ''
+
+  constructor(
+    private activeModal: NgbActiveModal,
+    private documentService: DocumentService,
+    private toastService: ToastService
+  ) {
+    super()
+    this.loading = false
+  }
+
+  public emailDocument() {
+    this.loading = true
+    this.documentService
+      .emailDocument(
+        this.documentId,
+        this.emailAddress,
+        this.emailSubject,
+        this.emailMessage,
+        this.useArchiveVersion
+      )
+      .subscribe({
+        next: () => {
+          this.loading = false
+          this.emailAddress = ''
+          this.emailSubject = ''
+          this.emailMessage = ''
+          this.toastService.showInfo($localize`Email sent`)
+        },
+        error: (e) => {
+          this.loading = false
+          this.toastService.showError($localize`Error emailing document`, e)
+        },
+      })
+  }
+
+  public close() {
+    this.activeModal.close()
+  }
+}

src-ui/src/app/components/common/share-links-dialog/share-links-dialog.component.html

@@ -0,0 +1,68 @@
+<div class="modal-header">
+  <h4 class="modal-title" id="modal-basic-title">{{title}}</h4>
+  <button type="button" class="btn-close" aria-label="Close" (click)="close()"></button>
+</div>
+<div class="modal-body p-0">
+  <ul class="list-group list-group-flush">
+    @if (!shareLinks || shareLinks.length === 0) {
+      <li class="list-group-item fst-italic small text-center text-secondary" i18n>
+        No existing links
+      </li>
+    }
+    @for (link of shareLinks; track link) {
+      <li class="list-group-item">
+        <div class="input-group w-100">
+          <input type="text" class="form-control" aria-label="Share link" [value]="getShareUrl(link)" readonly>
+          @if (link.expiration) {
+            <span class="input-group-text">
+              {{ getDaysRemaining(link) }}
+            </span>
+          }
+          <button type="button" class="btn btn-outline-primary" (click)="copy(link)">
+              @if (copied !== link.id) {
+                <i-bs width="1.2em" height="1.2em" name="clipboard-fill"></i-bs>
+              }
+              @if (copied === link.id) {
+                <i-bs width="1.2em" height="1.2em" name="clipboard-check-fill"></i-bs>
+              }
+              <span class="visually-hidden" i18n>Copy</span>
+          </button>
+          @if (canShare(link)) {
+            <button type="button" class="btn btn-outline-primary" (click)="share(link)">
+              <i-bs width="1.2em" height="1.2em" name="box-arrow-up"></i-bs><span class="visually-hidden" i18n>Share</span>
+            </button>
+          }
+          <button type="button" class="btn btn-outline-danger" (click)="delete(link)">
+            <i-bs width="1.2em" height="1.2em" name="trash"></i-bs><span class="visually-hidden" i18n>Delete</span>
+          </button>
+        </div>
+        <span class="badge copied-badge bg-primary small fade ms-4 position-absolute top-50 translate-middle-y pe-none z-3" [class.show]="copied === link.id" i18n>Copied!</span>
+      </li>
+    }
+  </ul>
+</div>
+<div class="modal-footer">
+  <div class="input-group w-100">
+    <div class="form-check form-switch ms-auto">
+      <input class="form-check-input" type="checkbox" role="switch" id="versionSwitch" [disabled]="!hasArchiveVersion" [(ngModel)]="useArchiveVersion">
+      <label class="form-check-label" for="versionSwitch" i18n>Share archive version</label>
+    </div>
+  </div>
+  <div class="input-group w-100 mt-2">
+    <label class="input-group-text" for="addLink"><ng-container i18n>Expires</ng-container>:</label>
+    <select class="form-select fs-6" [(ngModel)]="expirationDays">
+      @for (option of EXPIRATION_OPTIONS; track option) {
+        <option [ngValue]="option.value">{{ option.label }}</option>
+      }
+    </select>
+    <button class="btn btn-outline-primary ms-auto" type="button" (click)="createLink()" [disabled]="loading">
+      @if (loading) {
+        <div class="spinner-border spinner-border-sm me-2" role="status"></div>
+      }
+      @if (!loading) {
+        <i-bs name="plus"></i-bs>
+      }
+      <ng-container i18n>Create</ng-container>
+    </button>
+  </div>
+</div>

src-ui/src/app/components/common/share-links-dialog/share-links-dialog.component.scss

@@ -0,0 +1,3 @@
+.copied-badge {
+    right: 15em;
+}

src-ui/src/app/components/common/share-links-dialog/share-links-dialog.component.spec.ts

@@ -11,17 +11,18 @@ import {
   tick,
 } from '@angular/core/testing'
 import { By } from '@angular/platform-browser'
+import { NgbActiveModal } from '@ng-bootstrap/ng-bootstrap'
 import { NgxBootstrapIconsModule, allIcons } from 'ngx-bootstrap-icons'
 import { of, throwError } from 'rxjs'
 import { FileVersion, ShareLink } from 'src/app/data/share-link'
 import { ShareLinkService } from 'src/app/services/rest/share-link.service'
 import { ToastService } from 'src/app/services/toast.service'
 import { environment } from 'src/environments/environment'
-import { ShareLinksDropdownComponent } from './share-links-dropdown.component'
+import { ShareLinksDialogComponent } from './share-links-dialog.component'
 
-describe('ShareLinksDropdownComponent', () => {
-  let component: ShareLinksDropdownComponent
-  let fixture: ComponentFixture<ShareLinksDropdownComponent>
+describe('ShareLinksDialogComponent', () => {
+  let component: ShareLinksDialogComponent
+  let fixture: ComponentFixture<ShareLinksDialogComponent>
   let shareLinkService: ShareLinkService
   let toastService: ToastService
   let httpController: HttpTestingController
@@ -30,16 +31,17 @@ describe('ShareLinksDropdownComponent', () => {
   beforeEach(() => {
     TestBed.configureTestingModule({
       imports: [
-        ShareLinksDropdownComponent,
+        ShareLinksDialogComponent,
         NgxBootstrapIconsModule.pick(allIcons),
       ],
       providers: [
         provideHttpClient(withInterceptorsFromDi()),
         provideHttpClientTesting(),
+        NgbActiveModal,
       ],
     })
 
-    fixture = TestBed.createComponent(ShareLinksDropdownComponent)
+    fixture = TestBed.createComponent(ShareLinksDialogComponent)
     shareLinkService = TestBed.inject(ShareLinkService)
     toastService = TestBed.inject(ToastService)
     httpController = TestBed.inject(HttpTestingController)
@@ -232,4 +234,11 @@ describe('ShareLinksDropdownComponent', () => {
       ]
     ).toBeTruthy()
   })
+
+  it('should support close', () => {
+    const activeModal = TestBed.inject(NgbActiveModal)
+    const closeSpy = jest.spyOn(activeModal, 'close')
+    component.close()
+    expect(closeSpy).toHaveBeenCalled()
+  })
 })

src-ui/src/app/components/common/share-links-dialog/share-links-dialog.component.ts

@@ -1,7 +1,7 @@
 import { Clipboard } from '@angular/cdk/clipboard'
 import { Component, Input, OnInit } from '@angular/core'
 import { FormsModule, ReactiveFormsModule } from '@angular/forms'
-import { NgbDropdownModule } from '@ng-bootstrap/ng-bootstrap'
+import { NgbActiveModal } from '@ng-bootstrap/ng-bootstrap'
 import { NgxBootstrapIconsModule } from 'ngx-bootstrap-icons'
 import { first } from 'rxjs'
 import { FileVersion, ShareLink } from 'src/app/data/share-link'
@@ -10,17 +10,12 @@ import { ToastService } from 'src/app/services/toast.service'
 import { environment } from 'src/environments/environment'
 
 @Component({
-  selector: 'pngx-share-links-dropdown',
-  templateUrl: './share-links-dropdown.component.html',
-  styleUrls: ['./share-links-dropdown.component.scss'],
-  imports: [
-    FormsModule,
-    ReactiveFormsModule,
-    NgbDropdownModule,
-    NgxBootstrapIconsModule,
-  ],
+  selector: 'pngx-share-links-dialog',
+  templateUrl: './share-links-dialog.component.html',
+  styleUrls: ['./share-links-dialog.component.scss'],
+  imports: [FormsModule, ReactiveFormsModule, NgxBootstrapIconsModule],
 })
-export class ShareLinksDropdownComponent implements OnInit {
+export class ShareLinksDialogComponent implements OnInit {
   EXPIRATION_OPTIONS = [
     { label: $localize`1 day`, value: 1 },
     { label: $localize`7 days`, value: 7 },
@@ -41,9 +36,6 @@ export class ShareLinksDropdownComponent implements OnInit {
     }
   }
 
-  @Input()
-  disabled: boolean = false
-
   private _hasArchiveVersion: boolean = true
 
   @Input()
@@ -67,6 +59,7 @@ export class ShareLinksDropdownComponent implements OnInit {
   useArchiveVersion: boolean = true
 
   constructor(
+    private activeModal: NgbActiveModal,
     private shareLinkService: ShareLinkService,
     private toastService: ToastService,
     private clipboard: Clipboard
@@ -169,4 +162,8 @@ export class ShareLinksDropdownComponent implements OnInit {
         },
       })
   }
+
+  close() {
+    this.activeModal.close()
+  }
 }

src-ui/src/app/components/common/share-links-dropdown/share-links-dropdown.component.html

@@ -1,70 +0,0 @@
-<div ngbDropdown>
-  <button class="btn btn-sm btn-outline-primary" id="shareLinksDropdown" [disabled]="disabled" ngbDropdownToggle>
-    <i-bs name="link"></i-bs>
-    <div class="d-none d-sm-inline">&nbsp;<ng-container i18n>Share Links</ng-container></div>
-  </button>
-  <div ngbDropdownMenu aria-labelledby="shareLinksDropdown" class="shadow share-links-dropdown">
-    <ul class="list-group list-group-flush">
-      @if (!shareLinks || shareLinks.length === 0) {
-        <li class="list-group-item fst-italic small text-center text-secondary" i18n>
-          No existing links
-        </li>
-      }
-      @for (link of shareLinks; track link) {
-        <li class="list-group-item">
-          <div class="input-group input-group-sm w-100">
-            <input type="text" class="form-control" aria-label="Share link" [value]="getShareUrl(link)" readonly>
-            @if (link.expiration) {
-              <span class="input-group-text">
-                {{ getDaysRemaining(link) }}
-              </span>
-            }
-            <button type="button" class="btn btn-sm btn-outline-primary" (click)="copy(link)">
-                @if (copied !== link.id) {
-                  <i-bs width="1.2em" height="1.2em" name="clipboard-fill"></i-bs>
-                }
-                @if (copied === link.id) {
-                  <i-bs width="1.2em" height="1.2em" name="clipboard-check-fill"></i-bs>
-                }
-                <span class="visually-hidden" i18n>Copy</span>
-              </button>
-              @if (canShare(link)) {
-                <button type="button" class="btn btn-sm btn-outline-primary" (click)="share(link)">
-                  <i-bs width="1.2em" height="1.2em" name="box-arrow-up"></i-bs><span class="visually-hidden" i18n>Share</span>
-                  </button>
-                }
-                <button type="button" class="btn btn-sm btn-outline-danger" (click)="delete(link)">
-                  <i-bs width="1.2em" height="1.2em" name="trash"></i-bs><span class="visually-hidden" i18n>Delete</span>
-                  </button>
-                </div>
-                <span class="badge copied-badge bg-primary small fade ms-4 position-absolute top-50 translate-middle-y pe-none z-3" [class.show]="copied === link.id" i18n>Copied!</span>
-              </li>
-            }
-            <li class="list-group-item pt-3 pb-2">
-              <div class="input-group input-group-sm w-100">
-                <div class="form-check form-switch ms-auto small">
-                  <input class="form-check-input" type="checkbox" role="switch" id="versionSwitch" [disabled]="!hasArchiveVersion" [(ngModel)]="useArchiveVersion">
-                  <label class="form-check-label" for="versionSwitch" i18n>Share archive version</label>
-                </div>
-              </div>
-              <div class="input-group input-group-sm w-100 mt-2">
-                <label class="input-group-text" for="addLink"><ng-container i18n>Expires</ng-container>:</label>
-                <select class="form-select form-select-sm" [(ngModel)]="expirationDays">
-                  @for (option of EXPIRATION_OPTIONS; track option) {
-                    <option [ngValue]="option.value">{{ option.label }}</option>
-                  }
-                </select>
-                <button class="btn btn-sm btn-outline-primary ms-auto" type="button" (click)="createLink()" [disabled]="loading">
-                  @if (loading) {
-                    <div class="spinner-border spinner-border-sm me-2" role="status"></div>
-                  }
-                  @if (!loading) {
-                    <i-bs name="plus"></i-bs>
-                  }
-                  <ng-container i18n>Create</ng-container>
-                </button>
-              </div>
-            </li>
-          </ul>
-        </div>
-      </div>

src-ui/src/app/components/common/share-links-dropdown/share-links-dropdown.component.scss

@@ -1,14 +0,0 @@
-.share-links-dropdown {
-    min-width: 350px;
-
-    // correct position on mobile
-    @media (max-width: 575.98px) {
-        &.show {
-            margin-left: -175px !important;
-        }
-    }
-}
-
-.copied-badge {
-    right: 7.5em;
-}