AAE-29442 Adjusted to the new eslint rule

Alfresco · Dec 16, 2024 · 4da74d1 · 4da74d1
1 parent 8dc793f
commit 4da74d1
Show file tree

Hide file tree

Showing 140 changed files with 539 additions and 1,134 deletions.
diff --git a/lib/content-services/.eslintrc.json b/lib/content-services/.eslintrc.json
@@ -10,7 +10,7 @@
         "createDefaultProgram": true
       },
       "rules": {
-        "jsdoc/newline-after-description": "warn",
+        "jsdoc/tag-lines": ["error", "any", {"startLines": 1}],
         "@typescript-eslint/naming-convention": "warn",
         "@typescript-eslint/consistent-type-assertions": "warn",
         "@typescript-eslint/prefer-for-of": "warn",

diff --git a/lib/content-services/src/lib/directives/check-allowable-operation.directive.ts b/lib/content-services/src/lib/directives/check-allowable-operation.directive.ts
@@ -95,7 +95,6 @@ export class CheckAllowableOperationDirective implements OnChanges {
     /**
      * Enables decorated element
      *
-     * @memberof CheckAllowableOperationDirective
      */
     enableElement(): void {
         this.renderer.removeAttribute(this.elementRef.nativeElement, 'disabled');
@@ -104,7 +103,6 @@ export class CheckAllowableOperationDirective implements OnChanges {
     /**
      * Disables decorated element
      *
-     * @memberof CheckAllowableOperationDirective
      */
     disableElement(): void {
         this.renderer.setAttribute(this.elementRef.nativeElement, 'disabled', 'true');

diff --git a/lib/core/.eslintrc.json b/lib/core/.eslintrc.json
@@ -10,7 +10,7 @@
         "createDefaultProgram": true
       },
       "rules": {
-        "jsdoc/newline-after-description": "warn",
+        "jsdoc/tag-lines": ["error", "any", {"startLines": 1}],
         "@typescript-eslint/naming-convention": "off",
         "@typescript-eslint/consistent-type-assertions": "warn",
         "@typescript-eslint/prefer-for-of": "off",

diff --git a/lib/core/src/lib/app-config/debug-app-config.service.ts b/lib/core/src/lib/app-config/debug-app-config.service.ts
@@ -25,7 +25,6 @@ export class DebugAppConfigService extends AppConfigService {
         super();
     }
 
-    /** @override */
     get<T>(key: string, defaultValue?: T): T {
         if (key === AppConfigValues.OAUTHCONFIG) {
             return JSON.parse(this.storage.getItem(key)) || super.get<T>(key, defaultValue);

diff --git a/lib/core/src/lib/auth/basic-auth/basic-alfresco-auth.service.ts b/lib/core/src/lib/auth/basic-auth/basic-alfresco-auth.service.ts
@@ -254,6 +254,8 @@ export class BasicAlfrescoAuthService extends BaseAuthenticationService {
 
     /**
      * logout Alfresco API
+     *
+     * @returns A promise that returns {logout} if resolved and {error} if rejected.
      */
     async logout(): Promise<any> {
         if (this.isBPMProvider()) {

diff --git a/lib/core/src/lib/auth/oidc/auth.service.ts b/lib/core/src/lib/auth/oidc/auth.service.ts
@@ -22,57 +22,53 @@ import { Observable } from 'rxjs';
  * Provide authentication/authorization through OAuth2/OIDC protocol.
  */
 export abstract class AuthService {
-  abstract onLogin: Observable<any>;
+    abstract onLogin: Observable<any>;
 
-  /**
-   * An observable that emits a value when a logout event occurs.
-   * Implement this observable to handle any necessary cleanup or state updates
-   * when a user logs out of the application.
-   *
-   * @type {Observable<void>}
-   */
-  abstract onLogout$: Observable<void>;
+    /**
+     * An observable that emits a value when a logout event occurs.
+     * Implement this observable to handle any necessary cleanup or state updates
+     * when a user logs out of the application.
+     */
+    abstract onLogout$: Observable<void>;
 
-  abstract onTokenReceived: Observable<any>;
+    abstract onTokenReceived: Observable<any>;
 
-  /**
-   * An abstract observable that emits a boolean value indicating whether the discovery document
-   * has been successfully loaded.
-   *
-   * @type {Observable<boolean>}
-   */
-  abstract isDiscoveryDocumentLoaded$: Observable<boolean>;
+    /**
+     * An abstract observable that emits a boolean value indicating whether the discovery document
+     * has been successfully loaded.
+     */
+    abstract isDiscoveryDocumentLoaded$: Observable<boolean>;
 
-  /** Subscribe to whether the user has valid Id/Access tokens.  */
-  abstract authenticated$: Observable<boolean>;
+    /** Subscribe to whether the user has valid Id/Access tokens.  */
+    abstract authenticated$: Observable<boolean>;
 
-  /** Get whether the user has valid Id/Access tokens. */
-  abstract authenticated: boolean;
+    /** Get whether the user has valid Id/Access tokens. */
+    abstract authenticated: boolean;
 
-  /** Subscribe to errors reaching the IdP. */
-  abstract idpUnreachable$: Observable<Error>;
+    /** Subscribe to errors reaching the IdP. */
+    abstract idpUnreachable$: Observable<Error>;
 
-  /**
-   * Initiate the IdP login flow.
-   */
-  abstract login(currentUrl?: string): Promise<void> | void;
+    /**
+     * Initiate the IdP login flow.
+     */
+    abstract login(currentUrl?: string): Promise<void> | void;
 
-  abstract baseAuthLogin(username: string, password: string): Observable<TokenResponse> ;
+    abstract baseAuthLogin(username: string, password: string): Observable<TokenResponse>;
 
-  /**
-   * Disconnect from IdP.
-   *
-   * @returns Promise may be returned depending on implementation
-   */
-  abstract logout(): Promise<void> | void;
+    /**
+     * Disconnect from IdP.
+     *
+     * @returns Promise may be returned depending on implementation
+     */
+    abstract logout(): Promise<void> | void;
 
-  /**
-   * Complete the login flow.
-   *
-   * In browsers, checks URL for auth and stored state. Call this once the application returns from IdP.
-   *
-   * @returns Promise, resolve with stored state, reject if unable to reach IdP
-   */
-  abstract loginCallback(loginOptions?: LoginOptions): Promise<string | undefined>;
-  abstract updateIDPConfiguration(...args: any[]): void;
+    /**
+     * Complete the login flow.
+     *
+     * In browsers, checks URL for auth and stored state. Call this once the application returns from IdP.
+     *
+     * @returns Promise, resolve with stored state, reject if unable to reach IdP
+     */
+    abstract loginCallback(loginOptions?: LoginOptions): Promise<string | undefined>;
+    abstract updateIDPConfiguration(...args: any[]): void;
 }
diff --git a/lib/core/src/lib/auth/oidc/oidc-authentication.service.ts b/lib/core/src/lib/auth/oidc/oidc-authentication.service.ts
@@ -51,8 +51,6 @@ export class OidcAuthenticationService extends BaseAuthenticationService {
      * This observable combines the authentication status and the discovery document load status
      * to decide if an SSO login is necessary. It emits `true` if the user is not authenticated
      * and the discovery document is loaded, otherwise it emits `false`.
-     *
-     * @type {Observable<boolean>}
      */
     shouldPerformSsoLogin$: Observable<boolean> = combineLatest([this.auth.authenticated$, this.auth.isDiscoveryDocumentLoaded$]).pipe(
         map(([authenticated, isDiscoveryDocumentLoaded]) => !authenticated && isDiscoveryDocumentLoaded)