[DURACOM-453] refactor, hide *-edit forms, fix cache issue, add type docs

Author: FrancescoMolinaro

config/config.example.yml

@@ -403,6 +403,20 @@ homePage:
 item:
   edit:
     undoTimeout: 10000 # 10 seconds
+    # Defines the security levels available for metadata fields.
+    # Each level maps to a numeric value stored on the metadata field in the backend and controls visibility of that field based on the user's role.
+    # Levels are displayed as toggle buttons in the metadata edit UI.
+    security:
+      levels:
+          - value: 0       # Public — visible to everyone
+            icon: fa fa-globe
+            color: green
+          - value: 1       # Registered users — visible to authenticated users only
+            icon: fa fa-key
+            color: orange
+          - value: 2       # Administrators only — restricted to admin users
+            icon: fa fa-lock
+            color: red
   # Show the item access status label in items lists
   showAccessStatuses: false
   bitstream:

src/app/app.menus.ts

@@ -21,7 +21,7 @@ import { CurationMenuProvider } from './shared/menu/providers/curation.menu';
 import { DSpaceObjectEditMenuProvider } from './shared/menu/providers/dso-edit.menu';
 import { DsoOptionMenuProvider } from './shared/menu/providers/dso-option.menu';
 import { EditMenuProvider } from './shared/menu/providers/edit.menu';
-import { EditItemDetailsMenuProvider } from './shared/menu/providers/edit-item-details.menu';
+import { EditItemMenuProvider } from './shared/menu/providers/edit-item-details.menu';
 import { ExportMenuProvider } from './shared/menu/providers/export.menu';
 import { HealthMenuProvider } from './shared/menu/providers/health.menu';
 import { ImportMenuProvider } from './shared/menu/providers/import.menu';
@@ -79,6 +79,9 @@ export const MENUS = buildMenuStructure({
   ],
   [MenuID.DSO_EDIT]: [
     DsoOptionMenuProvider.withSubs([
+      EditItemMenuProvider.onRoute(
+        MenuRoute.ITEM_PAGE,
+      ),
       SubscribeMenuProvider.onRoute(
         MenuRoute.COMMUNITY_PAGE,
         MenuRoute.COLLECTION_PAGE,
@@ -105,9 +108,6 @@ export const MENUS = buildMenuStructure({
       ClaimMenuProvider.onRoute(
         MenuRoute.ITEM_PAGE,
       ),
-      EditItemDetailsMenuProvider.onRoute(
-        MenuRoute.ITEM_PAGE,
-      ),
     ]),
   ],
 });

src/app/collection-page/collection-form/collection-form.component.ts

@@ -173,7 +173,7 @@ export class CollectionFormComponent extends ComColFormComponent<Collection> imp
           }
         });
 
-        definitions.forEach((definition: SubmissionDefinitionModel, index: number) => {
+        definitions.filter(def => !def.id.includes('-edit')).forEach((definition: SubmissionDefinitionModel, index: number) => {
           this.submissionDefinitionSelection.add({
             disabled: false,
             label: definition.name,

src/app/core/config/submission-definitions-config-data.service.ts

@@ -1,3 +1,11 @@
+/**
+ * The contents of this file are subject to the license and copyright
+ * detailed in the LICENSE and NOTICE files at the root of the source
+ * tree and available online at
+ *
+ * http://www.dspace.org/license/
+ */
+
 import { Injectable } from '@angular/core';
 import { FollowLinkConfig } from '@dspace/core/shared/follow-link-config.model';
 import { Observable } from 'rxjs';
@@ -16,6 +24,13 @@ import { HALEndpointService } from '../shared/hal-endpoint.service';
 import { ConfigDataService } from './config-data.service';
 import { ConfigObject } from './models/config.model';
 
+/**
+ * Data service responsible for retrieving submission definition configurations from the REST API.
+ * Submission definitions describe the structure of submission forms (steps, sections, and fields)
+ * used when depositing or editing items.
+ *
+ * It extends {@link ConfigDataService} targeting the `submissiondefinitions` endpoint.
+ */
 @Injectable({ providedIn: 'root' })
 export class SubmissionDefinitionsConfigDataService extends ConfigDataService {
   constructor(
@@ -27,6 +42,15 @@ export class SubmissionDefinitionsConfigDataService extends ConfigDataService {
     super('submissiondefinitions', requestService, rdbService, objectCache, halService);
   }
 
+  /**
+   * Retrieves the full list of submission definition configurations from the REST API.
+   *
+   * @param options
+   * @param useCachedVersionIfAvailable
+   * @param reRequestOnStale
+   * @param linksToFollow
+   * @returns An {@link Observable} emitting a {@link RemoteData} wrapper around a {@link PaginatedList} of {@link ConfigObject} entries.
+   */
   findAll(options: FindListOptions = {}, useCachedVersionIfAvailable = true, reRequestOnStale = true, ...linksToFollow: FollowLinkConfig<ConfigObject>[]): Observable<RemoteData<PaginatedList<ConfigObject>>> {
     return this.getBrowseEndpoint(options).pipe(
       take(1),

src/app/core/submission/models/edititem-mode.model.ts

@@ -19,7 +19,16 @@ import { ResourceType } from '../../shared/resource-type';
 import { excludeFromEquals } from '../../utilities/equals.decorators';
 
 /**
- * Describes a EditItem mode
+ * Represents a single edit mode available for an existing {@link Item}.
+ *
+ * Edit modes are returned by the REST API (`/api/submission/edititems/:id/modes`) and define
+ * the different ways in which an item can be edited (e.g. full edit, correction, withdraw).
+ * Each mode references a specific submission definition that determines which sections and
+ * fields are shown in the edit form.
+ *
+ * Consumed by {@link EditItemDataService} to retrieve available modes for a given item, and
+ * used by the edit-item page to build the appropriate submission form via
+ * {@link EditItemMenuProvider}.
  */
 @typedObject
 export class EditItemMode extends CacheableObject {

src/app/core/submission/models/edititem.model.ts

@@ -24,7 +24,10 @@ import { EditItemMode } from './edititem-mode.model';
 import { SubmissionObject } from './submission-object.model';
 
 /**
- * A model class for a EditItem.
+ * Represents the object type of the edit submission object.
+ *
+ * Used to map responses from {@link EditItemDataService} wich is used to retrieve available edit modes for a given item.
+ * {@link EditItemMenuProvider}.
  */
 @typedObject
 @inheritSerialization(SubmissionObject)

src/app/core/submission/models/metadata-security-configuration.ts

@@ -1,3 +1,11 @@
+/**
+ * The contents of this file are subject to the license and copyright
+ * detailed in the LICENSE and NOTICE files at the root of the source
+ * tree and available online at
+ *
+ * http://www.dspace.org/license/
+ */
+
 import {
   autoserialize,
   deserialize,
@@ -16,7 +24,15 @@ interface MetadataCustomSecurityEntries {
   [metadata: string]: number[];
 }
 /**
- * A model class for a security configuration of metadata.
+ * Model class representing the metadata security configuration associated with a given entity type.
+ * This class is used to determine which security levels are applied
+ * to metadata fields — either globally via a default, or on a per-field
+ * basis via custom entries.
+ *
+ * Security levels are represented as integers:
+ * - `0` → Public (visible to everyone)
+ * - `1` → Registered users (visible to authenticated users only)
+ * - `2` → Administrator (visible to administrators only)
  */
 @typedObject
 export class MetadataSecurityConfiguration extends CacheableObject {
@@ -29,17 +45,37 @@ export class MetadataSecurityConfiguration extends CacheableObject {
   @deserializeAs(new IDToUUIDSerializer(MetadataSecurityConfiguration.type.value), 'id')
     uuid: string;
   /**
-   * List of security configurations for all of the metadatas of the entity type
+   * Array of security levels applied by default to all metadata fields
+   * of the entity type, when no custom rule is defined for a specific field.
+   *
+   * Each element is an integer representing a security level
+   * (0 = public, 1 = registered users, 2 = administrators).
+   *
+   * @example [0, 1]
    */
   @autoserialize
     metadataSecurityDefault: number[];
   /**
-   * List of security configurations for all of the metadatas of the entity type
+   * Map of custom security configurations for individual metadata fields
+   * of the entity type.
+   *
+   * Allows overriding the default behavior (`metadataSecurityDefault`)
+   * for specific fields. The key is the qualified metadata field name
+   * (e.g. `dc.title`), and the value is the array of security levels applied.
+   *
+   * @see MetadataCustomSecurityEntries
+   *
+   * @example
+   * {
+   *   "dc.title": [0,1],
+   *   "dc.rights": [1,2]
+   * }
    */
   @autoserialize
     metadataCustomSecurity: MetadataCustomSecurityEntries;
   /**
-   * The object type
+   * The REST resource type, automatically populated during
+   * deserialization from the backend response.
    */
   @excludeFromEquals
   @autoserialize

src/app/core/testing/submission-service.stub.ts

@@ -26,7 +26,7 @@ export class SubmissionServiceStub {
   isSubmissionLoading = jasmine.createSpy('isSubmissionLoading');
   notifyNewSection = jasmine.createSpy('notifyNewSection');
   redirectToMyDSpace = jasmine.createSpy('redirectToMyDSpace');
-  redirectToItemPage = jasmine.createSpy('redirectToItemPage');
+  invalidateCacheAndRedirectToItemPage = jasmine.createSpy('redirectToItemPage');
   resetAllSubmissionObjects = jasmine.createSpy('resetAllSubmissionObjects');
   resetSubmissionObject = jasmine.createSpy('resetSubmissionObject');
   retrieveSubmission = jasmine.createSpy('retrieveSubmission');

src/app/item-page/edit-item-page/edit-metadata-security/edit-metadata-security.component.html

@@ -5,10 +5,11 @@
         <div class="switch-opt"
              [ngStyle]="{'background-color': securityLevel === $any(secLevel).value ? 'white' : 'rgb(204,204,204)' }">
           <button class="btn btn-link text-primary" data-test="switch-btn"
-                  title="Metadata security level {{ $any(secLevel).value }}"
+                  [title]="'metadata.security.level.title' | translate: { level: $any(secLevel).value }"
                   [dsBtnDisabled]="readOnly"
                   (click)="changeSelectedSecurityLevel($any(secLevel).value)">
             <i [class]="$any(secLevel).icon"
+               aria-hidden="true"
                [ngStyle]="{'color': securityLevel === $any(secLevel).value ? $any(secLevel).color : '' }"></i>
           </button>
         </div>

src/app/item-page/edit-item-page/edit-metadata-security/edit-metadata-security.component.spec.ts

@@ -3,6 +3,7 @@ import {
   TestBed,
 } from '@angular/core/testing';
 import { By } from '@angular/platform-browser';
+import { TranslateModule } from '@ngx-translate/core';
 
 import { EditMetadataSecurityComponent } from './edit-metadata-security.component';
 
@@ -12,7 +13,7 @@ describe('EditMetadataSecurityComponent', () => {
 
   beforeEach(async () => {
     await TestBed.configureTestingModule({
-      imports: [EditMetadataSecurityComponent],
+      imports: [TranslateModule.forRoot(), EditMetadataSecurityComponent],
     })
       .compileComponents();
   });