Request-a-copy: Review feedback addressed

* ALTCHA updated to 0.9.0 and tested
* Alt text for fas-lock-open images
* Typedoc added
* Comments/TODOs removed
* Better expiry date display on notification panel

Author: kshepherd

package-lock.json

@@ -114,7 +114,7 @@
     "@ngrx/store": "^18.1.1",
     "@ngx-translate/core": "^16.0.3",
     "@nicky-lenaers/ngx-scroll-to": "^14.0.0",
-    "altcha": "^0.2.2",
+    "altcha": "^0.9.0",
     "angulartics2": "^12.2.0",
     "axios": "^1.7.9",
     "bootstrap": "^5.3",

package.json

@@ -129,7 +129,6 @@ export class BitstreamDownloadPageComponent implements OnInit {
         // For now, the access token does not care if we are logged in or not.
         if (hasValue(accessToken)) {
           this.hardRedirectService.redirect(bitstream._links.content.href + '?accessToken=' + accessToken);
-          // this.router.navigateByUrl(getForbiddenRoute(), {skipLocationChange: true});
         } else if (isLoggedIn) {
           this.router.navigateByUrl(getForbiddenRoute(), { skipLocationChange: true });
         } else if (!isLoggedIn) {

src/app/bitstream-page/bitstream-download-page/bitstream-download-page.component.ts

@@ -49,7 +49,6 @@ import { RequestService } from './request.service';
 })
 export class ItemRequestDataService extends IdentifiableDataService<ItemRequest> implements SearchData<ItemRequest> {
 
-  // TODO: This is only public for access by the test class - smell?
   private searchData: SearchDataImpl<ItemRequest>;
 
   constructor(

src/app/core/data/item-request-data.service.ts

@@ -4,6 +4,10 @@ import { map } from 'rxjs/operators';
 
 import { HALEndpointService } from '../shared/hal-endpoint.service';
 
+/**
+ * Service for retrieving captcha challenge data, so proof-of-work calculations can be performed
+ * and returned with protected form data.
+ */
 @Injectable({ providedIn: 'root' })
 export class ProofOfWorkCaptchaDataService {
 
@@ -13,12 +17,20 @@ export class ProofOfWorkCaptchaDataService {
               private halService: HALEndpointService) {
   }
 
+  /**
+   * Get the endpoint for retrieving a new captcha challenge, to be passed
+   * to the Altcha captcha component as an input property
+   */
   public getChallengeHref(): Observable<string> {
     return this.getEndpoint().pipe(
       map((endpoint) => endpoint + '/challenge'),
     );
   }
 
+  /**
+   * Get the base CAPTCHA endpoint URL
+   * @protected
+   */
   protected getEndpoint(): Observable<string> {
     return this.halService.getEndpoint(this.linkPath);
   }

src/app/core/data/proof-of-work-captcha-data.service.ts

@@ -6,9 +6,10 @@
           <ng-container *ngVar="(itemRequest$ | async) as itemRequest">
             @if (hasValue(itemRequest)) {
               <div class="alert alert-warning wb-100 mb-2">
-                <p><span role="img" class="request-a-copy-access-icon"><i class="fa-solid fa-lock-open"></i></span>{{'bitstream-request-a-copy.access-by-token.warning' | translate}}</p>
-                @if (hasValue(itemRequest.accessPeriod) && itemRequest.accessPeriod > 0 && hasValue(itemRequest.decisionDate)) {
-                  <p>{{ 'bitstream-request-a-copy.access-by-token.expiry-label' | translate }} {{ getAccessPeriodEndDate(itemRequest.accessPeriod, itemRequest.decisionDate) }}</p>
+                <p><span role="img" class="request-a-copy-access-icon" [attr.aria-label]="'bitstream-request-a-copy.access-by-token.alt-text' | translate"><i class="fa-solid fa-lock-open"></i></span>{{'bitstream-request-a-copy.access-by-token.warning' | translate}}</p>
+                <!-- Only show the expiry date if it's not null, and doesn't start with the "FOREVER" year -->
+                @if (hasValue(itemRequest.accessExpiry) && !itemRequest.accessExpiry.startsWith('+294276')) {
+                  <p>{{ 'bitstream-request-a-copy.access-by-token.expiry-label' | translate }} {{ itemRequest.accessExpiry }}</p>
                 }
               </div>
             }

src/app/item-page/simple/item-page.component.html

@@ -1002,6 +1002,8 @@
 
   "bitstream-request-a-copy.access-by-token.expiry-label": "Access provided by this link will expire on",
 
+  "bitstream-request-a-copy.access-by-token.alt-text": "Access to this item is provided by a secure token",
+
   "browse.back.all-results": "All browse results",
 
   "browse.comcol.by.author": "By Author",
@@ -1898,6 +1900,8 @@
 
   "file-download-link.restricted": "Restricted bitstream",
 
+  "file-download-link.secure-access": "Restricted bitstream available via secure access token",
+
   "file-section.error.header": "Error obtaining files for this item",
 
   "footer.copyright": "copyright © 2002-{{ year }}",