diff --git a/lib/content-services/.eslintrc.json b/lib/content-services/.eslintrc.json index a4408fe1e67..388a13fdb21 100644 --- 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 index 807e988704f..b729f5fa8f2 100644 --- 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 index f5be19c8c42..5fb6b3f0b8f 100644 --- 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 index 56ace1ab364..c6d5b50d2c5 100644 --- 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(key: string, defaultValue?: T): T { if (key === AppConfigValues.OAUTHCONFIG) { return JSON.parse(this.storage.getItem(key)) || super.get(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 index adbfd3417f0..f2a5657d6e1 100644 --- 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 { 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 index 15c095cc5ff..54713d04130 100644 --- 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; + abstract onLogin: Observable; - /** - * 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} - */ - abstract onLogout$: Observable; + /** + * 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; - abstract onTokenReceived: Observable; + abstract onTokenReceived: Observable; - /** - * An abstract observable that emits a boolean value indicating whether the discovery document - * has been successfully loaded. - * - * @type {Observable} - */ - abstract isDiscoveryDocumentLoaded$: Observable; + /** + * An abstract observable that emits a boolean value indicating whether the discovery document + * has been successfully loaded. + */ + abstract isDiscoveryDocumentLoaded$: Observable; - /** Subscribe to whether the user has valid Id/Access tokens. */ - abstract authenticated$: Observable; + /** Subscribe to whether the user has valid Id/Access tokens. */ + abstract authenticated$: Observable; - /** 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; + /** Subscribe to errors reaching the IdP. */ + abstract idpUnreachable$: Observable; - /** - * Initiate the IdP login flow. - */ - abstract login(currentUrl?: string): Promise | void; + /** + * Initiate the IdP login flow. + */ + abstract login(currentUrl?: string): Promise | void; - abstract baseAuthLogin(username: string, password: string): Observable ; + abstract baseAuthLogin(username: string, password: string): Observable; - /** - * Disconnect from IdP. - * - * @returns Promise may be returned depending on implementation - */ - abstract logout(): Promise | void; + /** + * Disconnect from IdP. + * + * @returns Promise may be returned depending on implementation + */ + abstract logout(): Promise | 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; - 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; + 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 index 684f5c1844d..e6ba81b21f3 100644 --- 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} */ shouldPerformSsoLogin$: Observable = combineLatest([this.auth.authenticated$, this.auth.isDiscoveryDocumentLoaded$]).pipe( map(([authenticated, isDiscoveryDocumentLoaded]) => !authenticated && isDiscoveryDocumentLoaded) diff --git a/lib/core/src/lib/auth/oidc/redirect-auth.service.ts b/lib/core/src/lib/auth/oidc/redirect-auth.service.ts index 3a026765dfd..c456d9164cf 100644 --- a/lib/core/src/lib/auth/oidc/redirect-auth.service.ts +++ b/lib/core/src/lib/auth/oidc/redirect-auth.service.ts @@ -16,7 +16,18 @@ */ import { Inject, Injectable, inject } from '@angular/core'; -import { AuthConfig, AUTH_CONFIG, OAuthErrorEvent, OAuthEvent, OAuthService, OAuthStorage, TokenResponse, LoginOptions, OAuthSuccessEvent, OAuthLogger } from 'angular-oauth2-oidc'; +import { + AuthConfig, + AUTH_CONFIG, + OAuthErrorEvent, + OAuthEvent, + OAuthService, + OAuthStorage, + TokenResponse, + LoginOptions, + OAuthSuccessEvent, + OAuthLogger +} from 'angular-oauth2-oidc'; import { JwksValidationHandler } from 'angular-oauth2-oidc-jwks'; import { from, Observable, race, ReplaySubject } from 'rxjs'; import { distinctUntilChanged, filter, map, shareReplay, switchMap, take } from 'rxjs/operators'; @@ -29,394 +40,400 @@ const isPromise = (value: T | Promise): value is Promise => value && ty @Injectable() export class RedirectAuthService extends AuthService { + readonly authModuleConfig: AuthModuleConfig = inject(AUTH_MODULE_CONFIG); + private readonly _retryLoginService: RetryLoginService = inject(RetryLoginService); + private readonly _oauthLogger: OAuthLogger = inject(OAuthLogger); + private readonly _timeSyncService: TimeSyncService = inject(TimeSyncService); + + private _isDiscoveryDocumentLoadedSubject$ = new ReplaySubject(); + public isDiscoveryDocumentLoaded$ = this._isDiscoveryDocumentLoadedSubject$.asObservable(); + + onLogin: Observable; + + onTokenReceived: Observable; + + private _loadDiscoveryDocumentPromise = Promise.resolve(false); + + /** + * Observable stream that emits when the user logs out. + * + * This observable listens to the events emitted by the OAuth service and filters + * them to only include instances of OAuthSuccessEvent with the type `logout`. + */ + onLogout$: Observable; + + /** + * Observable stream that emits OAuthErrorEvent instances. + * + * This observable listens to the events emitted by the OAuth service and filters + * them to only include instances of OAuthErrorEvent. It then maps these events + * to the correct type. + */ + oauthErrorEvent$: Observable; + + /** + * Observable stream that emits the first OAuth error event that occurs. + */ + firstOauthErrorEventOccur$: Observable; + + /** + * Observable stream that emits the first OAuth error event that occurs, excluding token refresh errors. + */ + firstOauthErrorEventExcludingTokenRefreshError$: Observable; + + /** + * Observable stream that emits the second OAuth token refresh error event that occurs. + */ + secondTokenRefreshErrorEventOccur$: Observable; + + /** + * Observable that emits an error when the token has expired due to + * the local machine clock being out of sync with the server time. + */ + tokenHasExpiredDueToClockOutOfSync$: Observable; + + /** + * Observable that emits an error when the OAuth error event occurs due to + * the local machine clock being out of sync with the server time. + */ + oauthErrorEventOccurDueToClockOutOfSync$: Observable; + + /** + * Observable stream that emits either OAuthErrorEvent or Error. + * This stream combines multiple OAuth error sources into a single observable. + */ + combinedOAuthErrorsStream$: Observable; + + /** Subscribe to whether the user has valid Id/Access tokens. */ + authenticated$!: Observable; + + /** Subscribe to errors reaching the IdP. */ + idpUnreachable$!: Observable; + + /** + * Get whether the user has valid Id/Access tokens. + * + * @returns `true` if the user is authenticated, otherwise `false` + */ + get authenticated(): boolean { + return this.oauthService.hasValidIdToken() && this.oauthService.hasValidAccessToken(); + } - readonly authModuleConfig: AuthModuleConfig = inject(AUTH_MODULE_CONFIG); - private readonly _retryLoginService: RetryLoginService = inject(RetryLoginService); - private readonly _oauthLogger: OAuthLogger = inject(OAuthLogger); - private readonly _timeSyncService: TimeSyncService = inject(TimeSyncService); - - private _isDiscoveryDocumentLoadedSubject$ = new ReplaySubject(); - public isDiscoveryDocumentLoaded$ = this._isDiscoveryDocumentLoadedSubject$.asObservable(); - - onLogin: Observable; - - onTokenReceived: Observable; - - private _loadDiscoveryDocumentPromise = Promise.resolve(false); - - /** - * Observable stream that emits when the user logs out. - * - * This observable listens to the events emitted by the OAuth service and filters - * them to only include instances of OAuthSuccessEvent with the type `logout`. - * - * @type {Observable} - */ - onLogout$: Observable; - - /** - * Observable stream that emits OAuthErrorEvent instances. - * - * This observable listens to the events emitted by the OAuth service and filters - * them to only include instances of OAuthErrorEvent. It then maps these events - * to the correct type. - * - * @type {Observable} - */ - oauthErrorEvent$: Observable; - - /** - * Observable stream that emits the first OAuth error event that occurs. - */ - firstOauthErrorEventOccur$: Observable; - - /** - * Observable stream that emits the first OAuth error event that occurs, excluding token refresh errors. - */ - firstOauthErrorEventExcludingTokenRefreshError$: Observable; - - /** - * Observable stream that emits the second OAuth token refresh error event that occurs. - */ - secondTokenRefreshErrorEventOccur$: Observable; - - /** - * Observable that emits an error when the token has expired due to - * the local machine clock being out of sync with the server time. - * - * @type {Observable} - */ - tokenHasExpiredDueToClockOutOfSync$: Observable; - - /** - * Observable that emits an error when the OAuth error event occurs due to - * the local machine clock being out of sync with the server time. - * - * @type {Observable} - */ - oauthErrorEventOccurDueToClockOutOfSync$: Observable; - - /** - * Observable stream that emits either OAuthErrorEvent or Error. - * This stream combines multiple OAuth error sources into a single observable. - */ - combinedOAuthErrorsStream$: Observable; - - /** Subscribe to whether the user has valid Id/Access tokens. */ - authenticated$!: Observable; - - /** Subscribe to errors reaching the IdP. */ - idpUnreachable$!: Observable; - - /** - * Get whether the user has valid Id/Access tokens. - * - * @returns `true` if the user is authenticated, otherwise `false` - */ - get authenticated(): boolean { - return this.oauthService.hasValidIdToken() && this.oauthService.hasValidAccessToken(); - } - - private authConfig!: AuthConfig | Promise; - - private readonly AUTH_STORAGE_ITEMS: string[] = [ - 'access_token', - 'access_token_stored_at', - 'expires_at', - 'granted_scopes', - 'id_token', - 'id_token_claims_obj', - 'id_token_expires_at', - 'id_token_stored_at', - 'nonce', - 'PKCE_verifier', - 'refresh_token', - 'session_state' - ]; - - constructor( - private oauthService: OAuthService, - private _oauthStorage: OAuthStorage, - @Inject(AUTH_CONFIG) authConfig: AuthConfig - ) { - super(); - - this.authConfig = authConfig; - - this.oauthService.clearHashAfterLogin = true; - - this.oauthService.events.pipe( - filter(() => oauthService.showDebugInformation)) - .subscribe(event => { - if (event instanceof OAuthErrorEvent) { - this._oauthLogger.error('OAuthErrorEvent Object:', event); - } else { - this._oauthLogger.info('OAuthEvent Object:', event); - } - }); - - this.oauthErrorEvent$ = this.oauthService.events.pipe( - filter(event => event instanceof OAuthErrorEvent), - map((event) => event as OAuthErrorEvent) - ); - - this.firstOauthErrorEventOccur$ = this.oauthErrorEvent$.pipe(take(1)); - - this.firstOauthErrorEventExcludingTokenRefreshError$ = this.oauthErrorEvent$.pipe( - filter(event => event instanceof OAuthErrorEvent && event.type !== 'token_refresh_error'), - take(1) - ); - - this.secondTokenRefreshErrorEventOccur$ = this.oauthErrorEvent$.pipe( - filter(event => event.type === 'token_refresh_error'), - take(2), - filter((_, index) => index === 1) - ); - - this.oauthErrorEventOccurDueToClockOutOfSync$ = this.oauthErrorEvent$.pipe( - switchMap(() => this._timeSyncService.checkTimeSync(this.oauthService.clockSkewInSec)), - filter((timeSync) => timeSync?.outOfSync), - map((timeSync) => new Error(`OAuth error occurred due to local machine clock ${timeSync.localDateTimeISO} being out of sync with server time ${timeSync.serverDateTimeISO}`)), - take(1) - ); - - this.authenticated$ = this.oauthService.events.pipe( - map(() => this.authenticated), - distinctUntilChanged(), - shareReplay(1) - ); - - this.tokenHasExpiredDueToClockOutOfSync$ = this.oauthService.events.pipe( - map(() => !!this.oauthService.getIdentityClaims() && this.tokenHasExpired()), - filter((hasExpired) => hasExpired), - switchMap(() => this._timeSyncService.checkTimeSync(this.oauthService.clockSkewInSec)), - filter((timeSync) => timeSync?.outOfSync), - map((timeSync) => new Error(`Token has expired due to local machine clock ${timeSync.localDateTimeISO} being out of sync with server time ${timeSync.serverDateTimeISO}`)), - take(1) - ); - - this.onLogout$ = this.oauthService.events.pipe( - filter((event) => event.type === 'logout'), - map(() => undefined) - ); - - this.combinedOAuthErrorsStream$ = race([ - this.oauthErrorEventOccurDueToClockOutOfSync$, - this.firstOauthErrorEventExcludingTokenRefreshError$, - this.tokenHasExpiredDueToClockOutOfSync$, - this.secondTokenRefreshErrorEventOccur$ - ]); - - this.combinedOAuthErrorsStream$.subscribe({ - next: (res) => { - this._oauthLogger.error(res); - this.logout(); - }, - error: () => {} - }); - - this.oauthService.events.pipe(take(1)).subscribe(() => { - if(this.oauthService.getAccessToken() && !this.oauthService.hasValidAccessToken()) { - if(this.oauthService.showDebugInformation) { - this._oauthLogger.warn('Access token not valid. Removing all auth items from storage'); + private authConfig!: AuthConfig | Promise; + + private readonly AUTH_STORAGE_ITEMS: string[] = [ + 'access_token', + 'access_token_stored_at', + 'expires_at', + 'granted_scopes', + 'id_token', + 'id_token_claims_obj', + 'id_token_expires_at', + 'id_token_stored_at', + 'nonce', + 'PKCE_verifier', + 'refresh_token', + 'session_state' + ]; + + constructor(private oauthService: OAuthService, private _oauthStorage: OAuthStorage, @Inject(AUTH_CONFIG) authConfig: AuthConfig) { + super(); + + this.authConfig = authConfig; + + this.oauthService.clearHashAfterLogin = true; + + this.oauthService.events.pipe(filter(() => oauthService.showDebugInformation)).subscribe((event) => { + if (event instanceof OAuthErrorEvent) { + this._oauthLogger.error('OAuthErrorEvent Object:', event); + } else { + this._oauthLogger.info('OAuthEvent Object:', event); } - this.AUTH_STORAGE_ITEMS.map((item: string) => this._oauthStorage.removeItem(item)); - } - }); + }); + + this.oauthErrorEvent$ = this.oauthService.events.pipe( + filter((event) => event instanceof OAuthErrorEvent), + map((event) => event as OAuthErrorEvent) + ); + + this.firstOauthErrorEventOccur$ = this.oauthErrorEvent$.pipe(take(1)); + + this.firstOauthErrorEventExcludingTokenRefreshError$ = this.oauthErrorEvent$.pipe( + filter((event) => event instanceof OAuthErrorEvent && event.type !== 'token_refresh_error'), + take(1) + ); + + this.secondTokenRefreshErrorEventOccur$ = this.oauthErrorEvent$.pipe( + filter((event) => event.type === 'token_refresh_error'), + take(2), + filter((_, index) => index === 1) + ); + + this.oauthErrorEventOccurDueToClockOutOfSync$ = this.oauthErrorEvent$.pipe( + switchMap(() => this._timeSyncService.checkTimeSync(this.oauthService.clockSkewInSec)), + filter((timeSync) => timeSync?.outOfSync), + map( + (timeSync) => + new Error( + `OAuth error occurred due to local machine clock ${timeSync.localDateTimeISO} being out of sync with server time ${timeSync.serverDateTimeISO}` + ) + ), + take(1) + ); + + this.authenticated$ = this.oauthService.events.pipe( + map(() => this.authenticated), + distinctUntilChanged(), + shareReplay(1) + ); + + this.tokenHasExpiredDueToClockOutOfSync$ = this.oauthService.events.pipe( + map(() => !!this.oauthService.getIdentityClaims() && this.tokenHasExpired()), + filter((hasExpired) => hasExpired), + switchMap(() => this._timeSyncService.checkTimeSync(this.oauthService.clockSkewInSec)), + filter((timeSync) => timeSync?.outOfSync), + map( + (timeSync) => + new Error( + `Token has expired due to local machine clock ${timeSync.localDateTimeISO} being out of sync with server time ${timeSync.serverDateTimeISO}` + ) + ), + take(1) + ); + + this.onLogout$ = this.oauthService.events.pipe( + filter((event) => event.type === 'logout'), + map(() => undefined) + ); + + this.combinedOAuthErrorsStream$ = race([ + this.oauthErrorEventOccurDueToClockOutOfSync$, + this.firstOauthErrorEventExcludingTokenRefreshError$, + this.tokenHasExpiredDueToClockOutOfSync$, + this.secondTokenRefreshErrorEventOccur$ + ]); + + this.combinedOAuthErrorsStream$.subscribe({ + next: (res) => { + this._oauthLogger.error(res); + this.logout(); + }, + error: () => {} + }); + + this.oauthService.events.pipe(take(1)).subscribe(() => { + if (this.oauthService.getAccessToken() && !this.oauthService.hasValidAccessToken()) { + if (this.oauthService.showDebugInformation) { + this._oauthLogger.warn('Access token not valid. Removing all auth items from storage'); + } + this.AUTH_STORAGE_ITEMS.map((item: string) => this._oauthStorage.removeItem(item)); + } + }); - this.onLogin = this.authenticated$.pipe( - filter((authenticated) => authenticated), - map(() => undefined) - ); + this.onLogin = this.authenticated$.pipe( + filter((authenticated) => authenticated), + map(() => undefined) + ); - this.onTokenReceived = this.oauthService.events.pipe( - filter((event: OAuthEvent) => event.type === 'token_received'), - map(() => undefined) - ); + this.onTokenReceived = this.oauthService.events.pipe( + filter((event: OAuthEvent) => event.type === 'token_received'), + map(() => undefined) + ); - this.idpUnreachable$ = this.oauthService.events.pipe( - filter((event): event is OAuthErrorEvent => event.type === 'discovery_document_load_error'), - map((event) => event.reason as Error) - ); + this.idpUnreachable$ = this.oauthService.events.pipe( + filter((event): event is OAuthErrorEvent => event.type === 'discovery_document_load_error'), + map((event) => event.reason as Error) + ); + } + init(): Promise { + if (isPromise(this.authConfig)) { + return this.authConfig.then((config) => this.configureAuth(config)); + } + + return this.configureAuth(this.authConfig); } - init(): Promise { - if (isPromise(this.authConfig)) { - return this.authConfig.then((config) => this.configureAuth(config)); + logout() { + this.oauthService.logOut(); } - return this.configureAuth(this.authConfig); - } + ensureDiscoveryDocument(): Promise { + this._loadDiscoveryDocumentPromise = this._loadDiscoveryDocumentPromise + .catch(() => false) + .then((loaded) => { + if (!loaded) { + return this.oauthService.loadDiscoveryDocument().then(() => true); + } + return true; + }); + return this._loadDiscoveryDocumentPromise; + } - logout() { - this.oauthService.logOut(); - } + login(currentUrl?: string): void { + let stateKey: string | undefined; - ensureDiscoveryDocument(): Promise { - this._loadDiscoveryDocumentPromise = this._loadDiscoveryDocumentPromise - .catch(() => false) - .then((loaded) => { - if (!loaded) { - return this.oauthService.loadDiscoveryDocument().then(() => true); + if (currentUrl) { + const randomValue = window.crypto.getRandomValues(new Uint32Array(1))[0]; + stateKey = `auth_state_${randomValue}${Date.now()}`; + this._oauthStorage.setItem(stateKey, JSON.stringify(currentUrl || {})); } - return true; - }); - return this._loadDiscoveryDocumentPromise; - } - - login(currentUrl?: string): void { - let stateKey: string | undefined; + // initLoginFlow will initialize the login flow in either code or implicit depending on the configuration + this.ensureDiscoveryDocument().then(() => void this.oauthService.initLoginFlow(stateKey)); + } - if (currentUrl) { - const randomValue = window.crypto.getRandomValues(new Uint32Array(1))[0]; - stateKey = `auth_state_${randomValue}${Date.now()}`; - this._oauthStorage.setItem(stateKey, JSON.stringify(currentUrl || {})); + baseAuthLogin(username: string, password: string): Observable { + this.oauthService.useHttpBasicAuth = true; + + return from(this.oauthService.fetchTokenUsingPasswordFlow(username, password)).pipe( + map((response) => { + const props = new Map(); + props.set('id_token', response.id_token); + // for backward compatibility we need to set the response in our storage + this.oauthService['storeAccessTokenResponse']( + response.access_token, + response.refresh_token, + response.expires_in, + response.scope, + props + ); + return response; + }) + ); } - // initLoginFlow will initialize the login flow in either code or implicit depending on the configuration - this.ensureDiscoveryDocument().then(() => void this.oauthService.initLoginFlow(stateKey)); - } - - baseAuthLogin(username: string, password: string): Observable { - this.oauthService.useHttpBasicAuth = true; - - return from(this.oauthService.fetchTokenUsingPasswordFlow(username, password)).pipe( - map((response) => { - const props = new Map(); - props.set('id_token', response.id_token); - // for backward compatibility we need to set the response in our storage - this.oauthService['storeAccessTokenResponse'](response.access_token, response.refresh_token, response.expires_in, response.scope, props); - return response; - }) - ); - } - - async loginCallback(loginOptions?: LoginOptions): Promise { - return this.ensureDiscoveryDocument() - .then(() => this._retryLoginService.tryToLoginTimes({ ...loginOptions, preventClearHashAfterLogin: this.authModuleConfig.preventClearHashAfterLogin })) - .then(() => this._getRedirectUrl()); - } - - private _getRedirectUrl() { - const DEFAULT_REDIRECT = '/'; - const stateKey = this.oauthService.state; - - if (stateKey) { - const stateStringified = this._oauthStorage.getItem(stateKey); - if (stateStringified) { - // cleanup state from storage - this._oauthStorage.removeItem(stateKey); - return JSON.parse(stateStringified); - } + async loginCallback(loginOptions?: LoginOptions): Promise { + return this.ensureDiscoveryDocument() + .then(() => + this._retryLoginService.tryToLoginTimes({ + ...loginOptions, + preventClearHashAfterLogin: this.authModuleConfig.preventClearHashAfterLogin + }) + ) + .then(() => this._getRedirectUrl()); } - return DEFAULT_REDIRECT; - } + private _getRedirectUrl() { + const DEFAULT_REDIRECT = '/'; + const stateKey = this.oauthService.state; - private configureAuth(config: AuthConfig): Promise { - this.oauthService.configure(config); - this.oauthService.tokenValidationHandler = new JwksValidationHandler(); + if (stateKey) { + const stateStringified = this._oauthStorage.getItem(stateKey); + if (stateStringified) { + // cleanup state from storage + this._oauthStorage.removeItem(stateKey); + return JSON.parse(stateStringified); + } + } - if (config.sessionChecksEnabled) { - this.oauthService.events.pipe(filter((event) => event.type === 'session_terminated')).subscribe(() => { - this.oauthService.logOut(); - }); + return DEFAULT_REDIRECT; } - return this.ensureDiscoveryDocument().then(() => { - this._isDiscoveryDocumentLoadedSubject$.next(true); - this.oauthService.setupAutomaticSilentRefresh(); - return void this.allowRefreshTokenAndSilentRefreshOnMultipleTabs(); - }).catch(() => { - // catch error to prevent the app from crashing when trying to access unprotected routes - }); - } - - /** - * Fix a known issue (https://github.com/manfredsteyer/angular-oauth2-oidc/issues/850) - * where multiple tabs can cause the token refresh and the silent refresh to fail. - * This patch is based on the solutions provided in the following comments: - * https://github.com/manfredsteyer/angular-oauth2-oidc/issues/850#issuecomment-889921776 fix silent refresh for the implicit flow - * https://github.com/manfredsteyer/angular-oauth2-oidc/issues/850#issuecomment-1557286966 fix refresh token for the code flow - */ - private allowRefreshTokenAndSilentRefreshOnMultipleTabs() { - let lastUpdatedAccessToken: string | undefined; - - if (this.oauthService.hasValidAccessToken()) { - lastUpdatedAccessToken = this.oauthService.getAccessToken(); + private configureAuth(config: AuthConfig): Promise { + this.oauthService.configure(config); + this.oauthService.tokenValidationHandler = new JwksValidationHandler(); + + if (config.sessionChecksEnabled) { + this.oauthService.events.pipe(filter((event) => event.type === 'session_terminated')).subscribe(() => { + this.oauthService.logOut(); + }); + } + + return this.ensureDiscoveryDocument() + .then(() => { + this._isDiscoveryDocumentLoadedSubject$.next(true); + this.oauthService.setupAutomaticSilentRefresh(); + return void this.allowRefreshTokenAndSilentRefreshOnMultipleTabs(); + }) + .catch(() => { + // catch error to prevent the app from crashing when trying to access unprotected routes + }); } - const originalRefreshToken = this.oauthService.refreshToken.bind(this.oauthService); - this.oauthService.refreshToken = (): Promise => - navigator.locks.request(`refresh_tokens_${location.origin}`, () => { - if (!!lastUpdatedAccessToken && lastUpdatedAccessToken !== this.oauthService.getAccessToken()) { - (this.oauthService as any).eventsSubject.next(new OAuthSuccessEvent('token_received')); - (this.oauthService as any).eventsSubject.next(new OAuthSuccessEvent('token_refreshed')); - lastUpdatedAccessToken = this.oauthService.getAccessToken(); - return; - } + /** + * Fix a known issue (https://github.com/manfredsteyer/angular-oauth2-oidc/issues/850) + * where multiple tabs can cause the token refresh and the silent refresh to fail. + * This patch is based on the solutions provided in the following comments: + * https://github.com/manfredsteyer/angular-oauth2-oidc/issues/850#issuecomment-889921776 fix silent refresh for the implicit flow + * https://github.com/manfredsteyer/angular-oauth2-oidc/issues/850#issuecomment-1557286966 fix refresh token for the code flow + */ + private allowRefreshTokenAndSilentRefreshOnMultipleTabs() { + let lastUpdatedAccessToken: string | undefined; + + if (this.oauthService.hasValidAccessToken()) { + lastUpdatedAccessToken = this.oauthService.getAccessToken(); + } - return originalRefreshToken().then((resp) => (lastUpdatedAccessToken = resp.access_token)); - }); + const originalRefreshToken = this.oauthService.refreshToken.bind(this.oauthService); + this.oauthService.refreshToken = (): Promise => + navigator.locks.request(`refresh_tokens_${location.origin}`, () => { + if (!!lastUpdatedAccessToken && lastUpdatedAccessToken !== this.oauthService.getAccessToken()) { + (this.oauthService as any).eventsSubject.next(new OAuthSuccessEvent('token_received')); + (this.oauthService as any).eventsSubject.next(new OAuthSuccessEvent('token_refreshed')); + lastUpdatedAccessToken = this.oauthService.getAccessToken(); + return; + } + + return originalRefreshToken().then((resp) => (lastUpdatedAccessToken = resp.access_token)); + }); + + const originalSilentRefresh = this.oauthService.silentRefresh.bind(this.oauthService); + this.oauthService.silentRefresh = async (params: any = {}, noPrompt = true): Promise => + navigator.locks.request(`silent_refresh_${location.origin}`, async (): Promise => { + if (lastUpdatedAccessToken !== this.oauthService.getAccessToken()) { + (this.oauthService as any).eventsSubject.next(new OAuthSuccessEvent('token_received')); + (this.oauthService as any).eventsSubject.next(new OAuthSuccessEvent('token_refreshed')); + const event = new OAuthSuccessEvent('silently_refreshed'); + (this.oauthService as any).eventsSubject.next(event); + lastUpdatedAccessToken = this.oauthService.getAccessToken(); + return event; + } else { + return originalSilentRefresh(params, noPrompt); + } + }); + } - const originalSilentRefresh = this.oauthService.silentRefresh.bind(this.oauthService); - this.oauthService.silentRefresh = async (params: any = {}, noPrompt = true): Promise => - navigator.locks.request(`silent_refresh_${location.origin}`, async (): Promise => { - if (lastUpdatedAccessToken !== this.oauthService.getAccessToken()) { - (this.oauthService as any).eventsSubject.next(new OAuthSuccessEvent('token_received')); - (this.oauthService as any).eventsSubject.next(new OAuthSuccessEvent('token_refreshed')); - const event = new OAuthSuccessEvent('silently_refreshed'); - (this.oauthService as any).eventsSubject.next(event); - lastUpdatedAccessToken = this.oauthService.getAccessToken(); - return event; - } else { - return originalSilentRefresh(params, noPrompt); - } - }); - } - - updateIDPConfiguration(config: AuthConfig) { - this.oauthService.configure(config); - } - - - /** - * Checks if the token has expired. - * - * This method retrieves the identity claims from the OAuth service and calculates - * the token's issued and expiration times. It then compares the current time with - * these values, considering a clock skew and a configurable expiration decrease. - * - * @returns - Returns `true` if the token has expired, otherwise `false`. - */ - tokenHasExpired(){ - const claims = this.oauthService.getIdentityClaims(); - if(!claims){ - this._oauthLogger.warn('No claims found in the token'); - return false; + updateIDPConfiguration(config: AuthConfig) { + this.oauthService.configure(config); } - const now = Date.now(); - const issuedAtMSec = claims.iat * 1000; - const expiresAtMSec = claims.exp * 1000; - const clockSkewInMSec = this.oauthService.clockSkewInSec * 1000; - - this.showTokenExpiredDebugInformations(now, issuedAtMSec, expiresAtMSec, clockSkewInMSec); - return issuedAtMSec - clockSkewInMSec >= now || - expiresAtMSec + clockSkewInMSec - this.oauthService.decreaseExpirationBySec <= now; - } - - private showTokenExpiredDebugInformations(now: number, issuedAtMSec: number, expiresAtMSec: number, clockSkewInMSec: number) { - if(this.oauthService.showDebugInformation) { - this._oauthLogger.warn('now: ', new Date(now)); - this._oauthLogger.warn('issuedAt: ', new Date(issuedAtMSec)); - this._oauthLogger.warn('expiresAt: ', new Date(expiresAtMSec)); - this._oauthLogger.warn('clockSkewInMSec: ', clockSkewInMSec); - this._oauthLogger.warn('this.oauthService.decreaseExpirationBySec: ', this.oauthService.decreaseExpirationBySec); - this._oauthLogger.warn('issuedAtMSec - clockSkewInMSec >= now: ', issuedAtMSec - clockSkewInMSec >= now); - this._oauthLogger.warn('expiresAtMSec + clockSkewInMSec - this.oauthService.decreaseExpirationBySec <= now: ', expiresAtMSec + clockSkewInMSec - this.oauthService.decreaseExpirationBySec <= now); + + /** + * Checks if the token has expired. + * + * This method retrieves the identity claims from the OAuth service and calculates + * the token's issued and expiration times. It then compares the current time with + * these values, considering a clock skew and a configurable expiration decrease. + * + * @returns - Returns `true` if the token has expired, otherwise `false`. + */ + tokenHasExpired() { + const claims = this.oauthService.getIdentityClaims(); + if (!claims) { + this._oauthLogger.warn('No claims found in the token'); + return false; + } + const now = Date.now(); + const issuedAtMSec = claims.iat * 1000; + const expiresAtMSec = claims.exp * 1000; + const clockSkewInMSec = this.oauthService.clockSkewInSec * 1000; + + this.showTokenExpiredDebugInformations(now, issuedAtMSec, expiresAtMSec, clockSkewInMSec); + return issuedAtMSec - clockSkewInMSec >= now || expiresAtMSec + clockSkewInMSec - this.oauthService.decreaseExpirationBySec <= now; } - } + private showTokenExpiredDebugInformations(now: number, issuedAtMSec: number, expiresAtMSec: number, clockSkewInMSec: number) { + if (this.oauthService.showDebugInformation) { + this._oauthLogger.warn('now: ', new Date(now)); + this._oauthLogger.warn('issuedAt: ', new Date(issuedAtMSec)); + this._oauthLogger.warn('expiresAt: ', new Date(expiresAtMSec)); + this._oauthLogger.warn('clockSkewInMSec: ', clockSkewInMSec); + this._oauthLogger.warn('this.oauthService.decreaseExpirationBySec: ', this.oauthService.decreaseExpirationBySec); + this._oauthLogger.warn('issuedAtMSec - clockSkewInMSec >= now: ', issuedAtMSec - clockSkewInMSec >= now); + this._oauthLogger.warn( + 'expiresAtMSec + clockSkewInMSec - this.oauthService.decreaseExpirationBySec <= now: ', + expiresAtMSec + clockSkewInMSec - this.oauthService.decreaseExpirationBySec <= now + ); + } + } } diff --git a/lib/core/src/lib/auth/oidc/token.interceptor.ts b/lib/core/src/lib/auth/oidc/token.interceptor.ts index d5fa131c6d1..18bcc44c0a1 100644 --- a/lib/core/src/lib/auth/oidc/token.interceptor.ts +++ b/lib/core/src/lib/auth/oidc/token.interceptor.ts @@ -33,8 +33,6 @@ import { OAuthService, OAuthStorage } from 'angular-oauth2-oidc'; * * See the related issue: https://github.com/manfredsteyer/angular-oauth2-oidc/issues/1443 * - * @implements {HttpInterceptor} - * @class * @function intercept * @param {HttpRequest} request - The outgoing HTTP request. * @param {HttpHandler} next - The next handler in the HTTP request chain. diff --git a/lib/core/src/lib/datatable/components/location-cell/location-cell.component.ts b/lib/core/src/lib/datatable/components/location-cell/location-cell.component.ts index 4bc1cf4ca75..8cca2947305 100644 --- a/lib/core/src/lib/datatable/components/location-cell/location-cell.component.ts +++ b/lib/core/src/lib/datatable/components/location-cell/location-cell.component.ts @@ -44,7 +44,6 @@ export class LocationCellComponent extends DataTableCellComponent implements OnI super.ngOnInit(); } - /** @override */ protected updateValue(): void { if (this.column?.key && this.column?.format && this.row && this.data) { const path: PathInfo = this.data.getValue(this.row, this.column, this.resolverFn); diff --git a/lib/core/src/lib/form/components/widgets/core/form.model.ts b/lib/core/src/lib/form/components/widgets/core/form.model.ts index 2278f1eb33d..09bf385a5bd 100644 --- a/lib/core/src/lib/form/components/widgets/core/form.model.ts +++ b/lib/core/src/lib/form/components/widgets/core/form.model.ts @@ -146,8 +146,6 @@ export class FormModel implements ProcessFormModel { /** * Validates entire form and all form fields. - * - * @memberof FormModel */ validateForm(): void { const validateFormEvent: any = new ValidateFormEvent(this); @@ -173,7 +171,6 @@ export class FormModel implements ProcessFormModel { * Validates a specific form field, triggers form validation. * * @param field Form field to validate. - * @memberof FormModel */ validateField(field: FormFieldModel): void { if (!field) { diff --git a/lib/core/src/lib/mock/cookie.service.mock.ts b/lib/core/src/lib/mock/cookie.service.mock.ts index 886387b3ce7..3186999021f 100644 --- a/lib/core/src/lib/mock/cookie.service.mock.ts +++ b/lib/core/src/lib/mock/cookie.service.mock.ts @@ -20,22 +20,18 @@ import { CookieService } from '../common/services/cookie.service'; @Injectable() export class CookieServiceMock extends CookieService { - /** @override */ isEnabled(): boolean { return true; } - /** @override */ getItem(key: string): string | null { return this[key]?.data || null; } - /** @override */ setItem(key: string, data: string, expiration: Date | null, path: string | null): void { this[key] = { data, expiration, path }; } - /** @override */ clear() { Object.keys(this).forEach((key) => { if (Object.prototype.hasOwnProperty.call(this, key) && typeof this[key] !== 'function') { diff --git a/lib/extensions/src/lib/services/app-extension.service.ts b/lib/extensions/src/lib/services/app-extension.service.ts index 5b7a41f9b41..28d4c588da2 100644 --- a/lib/extensions/src/lib/services/app-extension.service.ts +++ b/lib/extensions/src/lib/services/app-extension.service.ts @@ -43,31 +43,23 @@ export class AppExtensionService { return; } - const references = (config.$references || []) - .filter((entry) => typeof entry === 'object') - .map((entry) => entry as ExtensionRef); + const references = (config.$references || []).filter((entry) => typeof entry === 'object').map((entry) => entry as ExtensionRef); this._references.next(references); } /** * Provides a collection of document list columns for the particular preset. * The result is filtered by the **disabled** state. - * * @param key Preset key. * @returns list of document list presets */ getDocumentListPreset(key: string): DocumentListPresetRef[] { - return this.extensionService - .getElements( - `features.documentList.${key}` - ) - .filter((entry) => !entry.disabled); + return this.extensionService.getElements(`features.documentList.${key}`).filter((entry) => !entry.disabled); } /** * Provides a list of the Viewer content extensions, * filtered by **disabled** state and **rules**. - * * @returns list of viewer extension references */ getViewerExtensions(): ViewerExtensionRef[] { @@ -78,13 +70,13 @@ export class AppExtensionService { protected isViewerExtensionDisabled(extension: ViewerExtensionRef): boolean { if (extension) { - if (extension.disabled) { - return true; - } + if (extension.disabled) { + return true; + } - if (extension.rules?.disabled) { - return this.extensionService.evaluateRule(extension.rules.disabled); - } + if (extension.rules?.disabled) { + return this.extensionService.evaluateRule(extension.rules.disabled); + } } return false; diff --git a/lib/extensions/src/lib/services/extension-loader.service.ts b/lib/extensions/src/lib/services/extension-loader.service.ts index b97caf4f92c..90c45016bec 100644 --- a/lib/extensions/src/lib/services/extension-loader.service.ts +++ b/lib/extensions/src/lib/services/extension-loader.service.ts @@ -28,15 +28,9 @@ import { RuleRef } from '../config/rule.extensions'; providedIn: 'root' }) export class ExtensionLoaderService { - constructor(private http: HttpClient) { - } + constructor(private http: HttpClient) {} - load( - configPath: string, - pluginsPath: string, - extensions?: string[], - extensionValues?: ExtensionConfig[] - ): Promise { + load(configPath: string, pluginsPath: string, extensions?: string[], extensionValues?: ExtensionConfig[]): Promise { return new Promise((resolve) => { this.loadConfig(configPath, 0).then((result) => { if (result) { @@ -54,9 +48,7 @@ export class ExtensionLoaderService { } if (config.$references?.length > 0 || extensionValues) { - const plugins = (config.$references ?? []).map((name, idx) => - this.loadConfig(`${pluginsPath}/${name}`, idx) - ); + const plugins = (config.$references ?? []).map((name, idx) => this.loadConfig(`${pluginsPath}/${name}`, idx)); Promise.all(plugins).then((results) => { let configs = results @@ -65,13 +57,9 @@ export class ExtensionLoaderService { .map((entry) => entry.config); if (extensionValues) { - configs = [ - ...configs, - ...extensionValues - ]; + configs = [...configs, ...extensionValues]; } - if (configs.length > 0) { config = mergeObjects(config, ...configs); } @@ -96,26 +84,18 @@ export class ExtensionLoaderService { * Retrieves configuration elements. * Filters element by **enabled** and **order** attributes. * Example: - * `getElements(config, 'features.viewer.extensions')` - * + * `getElements(config, 'features.viewer.extensions')` * @param config configuration settings * @param key element key * @param fallback fallback array of values * @returns list of elements */ - getElements( - config: ExtensionConfig, - key: string, - fallback: Array = [] - ): Array { + getElements(config: ExtensionConfig, key: string, fallback: Array = []): Array { const values = getValue(config, key) || fallback || []; return values.filter(filterEnabled).sort(sortByOrder); } - getContentActions( - config: ExtensionConfig, - key: string - ): Array { + getContentActions(config: ExtensionConfig, key: string): Array { return this.getElements(config, key).map(this.setActionDefaults); } @@ -150,8 +130,7 @@ export class ExtensionLoaderService { protected getMetadata(config: ExtensionConfig): ExtensionRef { const result: any = {}; - Object - .keys(config) + Object.keys(config) .filter((key) => key.startsWith('$')) .forEach((key) => { result[key] = config[key]; @@ -160,10 +139,7 @@ export class ExtensionLoaderService { return result; } - protected loadConfig( - url: string, - order: number - ): Promise<{ order: number; config: ExtensionConfig }> { + protected loadConfig(url: string, order: number): Promise<{ order: number; config: ExtensionConfig }> { return new Promise((resolve) => { this.http.get(url).subscribe( (config) => { diff --git a/lib/extensions/src/lib/services/extension.service.ts b/lib/extensions/src/lib/services/extension.service.ts index 068d50e397a..8ccac36e2ae 100644 --- a/lib/extensions/src/lib/services/extension.service.ts +++ b/lib/extensions/src/lib/services/extension.service.ts @@ -29,7 +29,6 @@ import { BehaviorSubject, Observable } from 'rxjs'; /** * The default extensions factory - * * @returns the list of extension json files */ export function extensionJsonsFactory() { @@ -48,7 +47,6 @@ export const EXTENSION_JSON_VALUES = new InjectionToken('extension-j /** * Provides the extension json values for the angular modules - * * @param jsons files to provide * @returns a provider section */ @@ -62,7 +60,6 @@ export function provideExtensionConfig(jsons: string[]) { /** * Provides the extension json raw values for the angular modules - * * @param extensionConfigValue config value * @returns a provider section */ @@ -103,7 +100,6 @@ export class ExtensionService { /** * Loads and registers an extension config file and plugins (specified by path properties). - * * @returns The loaded config data */ async load(): Promise { @@ -115,7 +111,6 @@ export class ExtensionService { /** * Registers extensions from a config object. - * * @param config Object with config data */ setup(config: ExtensionConfig) { @@ -142,7 +137,6 @@ export class ExtensionService { /** * Gets features by key. - * * @param key Key string using dot notation or array of strings * @param defaultValue Default value returned if feature is not found, default is empty array * @returns Feature found by key @@ -158,7 +152,6 @@ export class ExtensionService { /** * Adds one or more new rule evaluators to the existing set. - * * @param values The new evaluators to add */ setEvaluators(values: { [key: string]: RuleEvaluator }) { @@ -167,7 +160,6 @@ export class ExtensionService { /** * Adds one or more new auth guards to the existing set. - * * @param values The new auth guards to add */ setAuthGuards(values: Record) { @@ -178,7 +170,6 @@ export class ExtensionService { /** * Adds one or more new components to the existing set. - * * @param values The new components to add */ setComponents(values: { [key: string]: Type }) { @@ -187,7 +178,6 @@ export class ExtensionService { /** * Retrieves a route using its ID value. - * * @param id The ID value to look for * @returns The route or null if not found */ @@ -197,7 +187,6 @@ export class ExtensionService { /** * Retrieves one or more auth guards using an array of ID values. - * * @param ids Array of ID value to look for * @returns Array of auth guards or empty array if none were found */ @@ -207,7 +196,6 @@ export class ExtensionService { /** * Retrieves an action using its ID value. - * * @param id The ID value to look for * @returns Action or null if not found */ @@ -217,7 +205,6 @@ export class ExtensionService { /** * Retrieves a RuleEvaluator function using its key name. - * * @param key Key name to look for * @returns RuleEvaluator or null if not found */ @@ -227,7 +214,6 @@ export class ExtensionService { /** * Evaluates a rule. - * * @param ruleId ID of the rule to evaluate * @param context Custom rule execution context. * @returns True if the rule passed, false otherwise @@ -238,7 +224,6 @@ export class ExtensionService { /** * Retrieves a registered extension component using its ID value. - * * @param id The ID value to look for * @returns The component or null if not found */ @@ -248,7 +233,6 @@ export class ExtensionService { /** * Retrieves a rule using its ID value. - * * @param id The ID value to look for * @returns The rule or null if not found */ @@ -258,7 +242,6 @@ export class ExtensionService { /** * Runs a lightweight expression stored in a string. - * * @param value String containing the expression or literal value * @param context Parameter object for the expression with details of app state * @returns Result of evaluated expression, if found, or the literal value otherwise diff --git a/lib/extensions/src/lib/services/rule.service.ts b/lib/extensions/src/lib/services/rule.service.ts index 0cbb4976d89..9bc688144cc 100644 --- a/lib/extensions/src/lib/services/rule.service.ts +++ b/lib/extensions/src/lib/services/rule.service.ts @@ -36,7 +36,6 @@ export class RuleService { /** * Adds one or more new rule evaluators to the existing set. - * * @param values The new evaluators to add */ setEvaluators(values: { [key: string]: RuleEvaluator }) { @@ -47,7 +46,6 @@ export class RuleService { /** * Retrieves a rule using its ID value. - * * @param id The ID value to look for * @returns The rule or null if not found */ @@ -57,7 +55,6 @@ export class RuleService { /** * Retrieves a RuleEvaluator function using its key name. - * * @param key Key name to look for * @returns RuleEvaluator or null if not found */ @@ -71,7 +68,6 @@ export class RuleService { /** * Evaluates a rule. - * * @param ruleId ID of the rule to evaluate * @param context Custom rule execution context. * @returns True if the rule passed, false otherwise diff --git a/lib/insights/src/lib/analytics-process/components/analytics-report-list.component.ts b/lib/insights/src/lib/analytics-process/components/analytics-report-list.component.ts index 4c34d281f22..8e194a865a5 100644 --- a/lib/insights/src/lib/analytics-process/components/analytics-report-list.component.ts +++ b/lib/insights/src/lib/analytics-process/components/analytics-report-list.component.ts @@ -85,7 +85,6 @@ export class AnalyticsReportListComponent implements OnInit { /** * Reload the component - * * @param reportId report id */ reload(reportId?: number) { @@ -95,7 +94,6 @@ export class AnalyticsReportListComponent implements OnInit { /** * Get the report list - * * @param appId application id * @param reportId report id */ @@ -139,7 +137,6 @@ export class AnalyticsReportListComponent implements OnInit { /** * Check if the report list is empty - * * @returns `true` if report list is empty, otherwise `false` */ isReportsEmpty(): boolean { @@ -148,7 +145,6 @@ export class AnalyticsReportListComponent implements OnInit { /** * Select the current report - * * @param report report model */ selectReport(report: ReportParametersModel) { diff --git a/lib/insights/src/lib/analytics-process/services/analytics.service.ts b/lib/insights/src/lib/analytics-process/services/analytics.service.ts index 864de29df7e..ae3151a55a9 100644 --- a/lib/insights/src/lib/analytics-process/services/analytics.service.ts +++ b/lib/insights/src/lib/analytics-process/services/analytics.service.ts @@ -50,7 +50,6 @@ export class AnalyticsService { /** * Retrieve all the Deployed app - * * @param appId application id * @returns list or report parameter models */ @@ -71,7 +70,6 @@ export class AnalyticsService { /** * Retrieve Report by name - * * @param reportName - The name of report * @returns report model */ diff --git a/lib/insights/src/lib/diagram/components/tooltip/diagram-tooltip.component.ts b/lib/insights/src/lib/diagram/components/tooltip/diagram-tooltip.component.ts index 0d3f2c78162..10b387c1154 100644 --- a/lib/insights/src/lib/diagram/components/tooltip/diagram-tooltip.component.ts +++ b/lib/insights/src/lib/diagram/components/tooltip/diagram-tooltip.component.ts @@ -98,7 +98,6 @@ export class DiagramTooltipComponent implements AfterViewInit, OnDestroy { /** * Calculates the tooltip position and displays it - * * @param event mouseenter/touchend event */ private handleMouseEnter(event): void { diff --git a/lib/js-api/src/alfrescoApi.ts b/lib/js-api/src/alfrescoApi.ts index f7cf9c4f32b..649ef8c9c3d 100644 --- a/lib/js-api/src/alfrescoApi.ts +++ b/lib/js-api/src/alfrescoApi.ts @@ -304,7 +304,6 @@ export class AlfrescoApi implements Emitter, AlfrescoApiType { /** * login Alfresco API - * * @param username Username to login * @param password Password to login * @returns A promise that returns {new authentication ticket} if resolved and {error} if rejected. @@ -383,7 +382,6 @@ export class AlfrescoApi implements Emitter, AlfrescoApiType { /** * login Tickets - * * @param ticketEcm alfresco ticket * @param ticketBpm alfresco ticket */ @@ -558,7 +556,6 @@ export class AlfrescoApi implements Emitter, AlfrescoApiType { /** * Set the current Ticket - * * @param ticketEcm ecm ticket * @param ticketBpm bpm ticket */ diff --git a/lib/js-api/src/alfrescoApiClient.ts b/lib/js-api/src/alfrescoApiClient.ts index e3b4edc19f3..e977e18a907 100644 --- a/lib/js-api/src/alfrescoApiClient.ts +++ b/lib/js-api/src/alfrescoApiClient.ts @@ -35,7 +35,6 @@ export type AlfrescoApiClientPromise = Promise & { /** * Builds a string representation of an array-type actual parameter, according to the given collection format. - * * @param param An array parameter. * @param collectionFormat The array element separator strategy. * @returns A string representation of the supplied collection, using the specified delimiter. Returns @@ -343,7 +342,6 @@ export class AlfrescoApiClient implements ee.Emitter, LegacyHttpClient { /** * Chooses a content type from the given array, with JSON preferred; i.e. return JSON if included, otherwise return the first. - * * @param contentTypes content types * @returns The chosen content type, preferring JSON. */ @@ -369,7 +367,6 @@ export class AlfrescoApiClient implements ee.Emitter, LegacyHttpClient { *
  • application/json; charset=UTF8
    • *
  • APPLICATION/JSON
    • * - * * @param contentType The MIME content type to check. * @returns true if contentType represents JSON, otherwise false. */ diff --git a/lib/js-api/src/api/activiti-rest-api/api/about.api.ts b/lib/js-api/src/api/activiti-rest-api/api/about.api.ts index ce0ddba0c1e..f537b4d0bce 100644 --- a/lib/js-api/src/api/activiti-rest-api/api/about.api.ts +++ b/lib/js-api/src/api/activiti-rest-api/api/about.api.ts @@ -24,7 +24,6 @@ export class AboutApi extends BaseApi { /** * Get server type and version * Provides information about the running Alfresco Process Services Suite. The response payload object has the properties type, majorVersion, minorVersion, revisionVersion and edition. - * * @return Promise<{ [key: string]: string; }> */ getAppVersion(): Promise<{ [key: string]: string }> { diff --git a/lib/js-api/src/api/activiti-rest-api/api/accountIntegration.api.ts b/lib/js-api/src/api/activiti-rest-api/api/accountIntegration.api.ts index 969c078dc8d..69813c6aa71 100644 --- a/lib/js-api/src/api/activiti-rest-api/api/accountIntegration.api.ts +++ b/lib/js-api/src/api/activiti-rest-api/api/accountIntegration.api.ts @@ -25,7 +25,6 @@ export class AccountIntegrationApi extends BaseApi { /** * Retrieve external account information * Accounts are used to integrate with third party apps and clients - * * @return Promise */ getAccounts(): Promise { diff --git a/lib/js-api/src/api/activiti-rest-api/api/adminEndpoints.api.ts b/lib/js-api/src/api/activiti-rest-api/api/adminEndpoints.api.ts index f8098a6956e..d1f94ab91c9 100644 --- a/lib/js-api/src/api/activiti-rest-api/api/adminEndpoints.api.ts +++ b/lib/js-api/src/api/activiti-rest-api/api/adminEndpoints.api.ts @@ -25,7 +25,6 @@ import { throwIfNotDefined } from '../../../assert'; export class AdminEndpointsApi extends BaseApi { /** * Add an endpoint authorization - * * @param createRepresentation createRepresentation * @return Promise */ @@ -41,7 +40,6 @@ export class AdminEndpointsApi extends BaseApi { /** * Create an endpoint - * * @param representation representation * @return Promise */ @@ -56,7 +54,6 @@ export class AdminEndpointsApi extends BaseApi { /** * Get an endpoint authorization - * * @param basicAuthId basicAuthId * @param tenantId tenantId * @return Promise @@ -83,7 +80,6 @@ export class AdminEndpointsApi extends BaseApi { /** * List endpoint authorizations - * * @param tenantId tenantId * @return Promise */ @@ -103,7 +99,6 @@ export class AdminEndpointsApi extends BaseApi { /** * Get an endpoint - * * @param endpointConfigurationId endpointConfigurationId * @param tenantId tenantId * @return Promise @@ -129,7 +124,6 @@ export class AdminEndpointsApi extends BaseApi { /** * List endpoints - * * @param tenantId tenantId * @return Promise */ @@ -148,7 +142,6 @@ export class AdminEndpointsApi extends BaseApi { /** * Delete an endpoint authorization - * * @param basicAuthId basicAuthId * @param tenantId tenantId * @return Promise<{}> @@ -174,7 +167,6 @@ export class AdminEndpointsApi extends BaseApi { /** * Delete an endpoint - * * @param endpointConfigurationId endpointConfigurationId * @param tenantId tenantId * @return Promise<{}> @@ -200,7 +192,6 @@ export class AdminEndpointsApi extends BaseApi { /** * Update an endpoint authorization - * * @param basicAuthId basicAuthId * @param createRepresentation createRepresentation * @return Promise @@ -226,7 +217,6 @@ export class AdminEndpointsApi extends BaseApi { /** * Update an endpoint - * * @param endpointConfigurationId endpointConfigurationId * @param representation representation * @return Promise diff --git a/lib/js-api/src/api/activiti-rest-api/api/adminGroups.api.ts b/lib/js-api/src/api/activiti-rest-api/api/adminGroups.api.ts index fc83884cdf8..d86c710b37b 100644 --- a/lib/js-api/src/api/activiti-rest-api/api/adminGroups.api.ts +++ b/lib/js-api/src/api/activiti-rest-api/api/adminGroups.api.ts @@ -31,7 +31,6 @@ import { throwIfNotDefined } from '../../../assert'; export class AdminGroupsApi extends BaseApi { /** * Activate a group - * * @param groupId groupId * @return Promise<{}> */ @@ -50,7 +49,6 @@ export class AdminGroupsApi extends BaseApi { /** * Add users to a group - * * @param groupId groupId * @return Promise<{}> */ @@ -69,7 +67,6 @@ export class AdminGroupsApi extends BaseApi { /** * Add capabilities to a group - * * @param groupId groupId * @param addGroupCapabilitiesRepresentation addGroupCapabilitiesRepresentation * @return Promise<{}> @@ -91,7 +88,6 @@ export class AdminGroupsApi extends BaseApi { /** * Add a user to a group - * * @param groupId groupId * @param userId userId * @return Promise<{}> @@ -113,7 +109,6 @@ export class AdminGroupsApi extends BaseApi { /** * Get a related group - * * @param groupId groupId * @param relatedGroupId relatedGroupId * @param type type @@ -142,7 +137,6 @@ export class AdminGroupsApi extends BaseApi { /** * Create a group - * * @param groupRepresentation groupRepresentation * @return Promise */ @@ -158,7 +152,6 @@ export class AdminGroupsApi extends BaseApi { /** * Remove a capability from a group - * * @param groupId groupId * @param groupCapabilityId groupCapabilityId * @return Promise<{}> @@ -180,7 +173,6 @@ export class AdminGroupsApi extends BaseApi { /** * Delete a member from a group - * * @param groupId groupId * @param userId userId * @return Promise<{}> @@ -202,7 +194,6 @@ export class AdminGroupsApi extends BaseApi { /** * Delete a group - * * @param groupId groupId * @return Promise<{}> */ @@ -221,7 +212,6 @@ export class AdminGroupsApi extends BaseApi { /** * Delete a related group - * * @param groupId groupId * @param relatedGroupId relatedGroupId * @return Promise<{}> @@ -243,7 +233,6 @@ export class AdminGroupsApi extends BaseApi { /** * List group capabilities - * * @param groupId groupId * @return Promise */ @@ -262,7 +251,6 @@ export class AdminGroupsApi extends BaseApi { /** * Get group members - * * @param groupId groupId * @param opts Optional parameters * @return Promise @@ -286,7 +274,6 @@ export class AdminGroupsApi extends BaseApi { /** * Get a group - * * @param groupId groupId * @param opts Optional parameters * @return Promise @@ -307,7 +294,6 @@ export class AdminGroupsApi extends BaseApi { /** * Query groups - * * @param opts Optional parameters * @return Promise */ @@ -320,7 +306,6 @@ export class AdminGroupsApi extends BaseApi { /** * Get related groups - * * @param groupId groupId * @return Promise */ @@ -339,7 +324,6 @@ export class AdminGroupsApi extends BaseApi { /** * Update a group - * * @param groupId groupId * @param groupRepresentation groupRepresentation * @return Promise diff --git a/lib/js-api/src/api/activiti-rest-api/api/adminTenants.api.ts b/lib/js-api/src/api/activiti-rest-api/api/adminTenants.api.ts index e12a9c6b446..3a0d11bb57c 100644 --- a/lib/js-api/src/api/activiti-rest-api/api/adminTenants.api.ts +++ b/lib/js-api/src/api/activiti-rest-api/api/adminTenants.api.ts @@ -26,7 +26,6 @@ export class AdminTenantsApi extends BaseApi { /** * Create a tenant * Only a tenant manager may access this endpoint - * * @param createTenantRepresentation createTenantRepresentation * @return Promise */ @@ -41,7 +40,6 @@ export class AdminTenantsApi extends BaseApi { /** * Delete a tenant - * * @param tenantId tenantId * @return Promise<{}> */ @@ -60,7 +58,6 @@ export class AdminTenantsApi extends BaseApi { /** * Get tenant events - * * @param tenantId tenantId * @return Promise */ @@ -80,7 +77,6 @@ export class AdminTenantsApi extends BaseApi { /** * Get a tenant's logo - * * @param tenantId tenantId * @return Promise<{}> */ @@ -99,7 +95,6 @@ export class AdminTenantsApi extends BaseApi { /** * Get a tenant - * * @param tenantId tenantId * @return Promise */ @@ -120,7 +115,6 @@ export class AdminTenantsApi extends BaseApi { /** * List tenants * Only a tenant manager may access this endpoint - * * @return Promise */ getTenants(): Promise { @@ -131,7 +125,6 @@ export class AdminTenantsApi extends BaseApi { /** * Update a tenant - * * @param tenantId tenantId * @param createTenantRepresentation createTenantRepresentation * @return Promise @@ -154,7 +147,6 @@ export class AdminTenantsApi extends BaseApi { /** * Update a tenant's logo - * * @param tenantId tenantId * @param file file * @return Promise diff --git a/lib/js-api/src/api/activiti-rest-api/api/adminUsers.api.ts b/lib/js-api/src/api/activiti-rest-api/api/adminUsers.api.ts index 61c29423abb..fd54863494a 100644 --- a/lib/js-api/src/api/activiti-rest-api/api/adminUsers.api.ts +++ b/lib/js-api/src/api/activiti-rest-api/api/adminUsers.api.ts @@ -44,7 +44,6 @@ export interface GetUsersOpts { export class AdminUsersApi extends BaseApi { /** * Bulk update a list of users - * * @param update update * @return Promise<{}> */ @@ -59,7 +58,6 @@ export class AdminUsersApi extends BaseApi { /** * Create a user - * * @param userRepresentation userRepresentation * @return Promise */ @@ -75,7 +73,6 @@ export class AdminUsersApi extends BaseApi { /** * Get a user - * * @param userId userId * @param opts Optional parameters * @return Promise @@ -96,7 +93,6 @@ export class AdminUsersApi extends BaseApi { /** * Query users - * * @param opts Optional parameters * @return Promise */ @@ -109,7 +105,6 @@ export class AdminUsersApi extends BaseApi { /** * Update a user - * * @param userId userId * @param userRepresentation userRepresentation * @return Promise<{}> diff --git a/lib/js-api/src/api/activiti-rest-api/api/appDefinitions.api.ts b/lib/js-api/src/api/activiti-rest-api/api/appDefinitions.api.ts index ee9dae08f30..259de87295b 100644 --- a/lib/js-api/src/api/activiti-rest-api/api/appDefinitions.api.ts +++ b/lib/js-api/src/api/activiti-rest-api/api/appDefinitions.api.ts @@ -30,7 +30,6 @@ import { throwIfNotDefined } from '../../../assert'; export class AppDefinitionsApi extends BaseApi { /** * deleteAppDefinition - * * @param appDefinitionId appDefinitionId * @return Promise<{}> */ @@ -51,7 +50,6 @@ export class AppDefinitionsApi extends BaseApi { * Export an app definition * * This will return a zip file containing the app definition model and all related models (process definitions and forms). - * * @param modelId modelId from a runtime app or the id of an app definition model * @return Promise<{}> */ @@ -75,7 +73,6 @@ export class AppDefinitionsApi extends BaseApi { /** * Get an app definition - * * @param modelId Application definition ID * @return Promise */ @@ -94,7 +91,6 @@ export class AppDefinitionsApi extends BaseApi { /** * importAndPublishApp - * * @param file file * @param opts options * @return Promise @@ -124,7 +120,6 @@ export class AppDefinitionsApi extends BaseApi { * Allows a zip file to be uploaded containing an app definition and any number of included models. *

    This is useful to bootstrap an environment (for users or continuous integration).

    * Before using any processes included in the import the app must be published and deployed. - * * @param file file * @param opts Optional parameters * @param opts.renewIdmEntries Whether to renew user and group identifiers (default to false) @@ -149,7 +144,6 @@ export class AppDefinitionsApi extends BaseApi { * Publish an app definition * * Publishing an app definition makes it available for use. The application must not have any validation errors or an error will be returned.

    Before an app definition can be used by other users, it must also be deployed for their use - * * @param modelId modelId * @param publishModel publishModel * @return Promise @@ -171,7 +165,6 @@ export class AppDefinitionsApi extends BaseApi { /** * Update an app definition - * * @param modelId Application definition ID * @param updatedModel updatedModel | * @return Promise diff --git a/lib/js-api/src/api/activiti-rest-api/api/checklists.api.ts b/lib/js-api/src/api/activiti-rest-api/api/checklists.api.ts index 876e602c225..d822fc8ed29 100644 --- a/lib/js-api/src/api/activiti-rest-api/api/checklists.api.ts +++ b/lib/js-api/src/api/activiti-rest-api/api/checklists.api.ts @@ -27,7 +27,6 @@ import { throwIfNotDefined } from '../../../assert'; export class ChecklistsApi extends BaseApi { /** * Create a task checklist - * * @param taskId taskId * @param taskRepresentation taskRepresentation * @return Promise @@ -50,7 +49,6 @@ export class ChecklistsApi extends BaseApi { /** * Get checklist for a task - * * @param taskId taskId * @return Promise */ @@ -70,7 +68,6 @@ export class ChecklistsApi extends BaseApi { /** * Change the order of items on a checklist - * * @param taskId taskId * @param orderRepresentation orderRepresentation * @return Promise<{}> diff --git a/lib/js-api/src/api/activiti-rest-api/api/comments.api.ts b/lib/js-api/src/api/activiti-rest-api/api/comments.api.ts index 8fca0baf91f..63aec2f33cd 100644 --- a/lib/js-api/src/api/activiti-rest-api/api/comments.api.ts +++ b/lib/js-api/src/api/activiti-rest-api/api/comments.api.ts @@ -26,7 +26,6 @@ import { throwIfNotDefined } from '../../../assert'; export class ActivitiCommentsApi extends BaseApi { /** * Add a comment to a process instance - * * @param commentRequest commentRequest * @param processInstanceId processInstanceId * @return Promise @@ -49,7 +48,6 @@ export class ActivitiCommentsApi extends BaseApi { /** * Add a comment to a task - * * @param commentRequest commentRequest * @param taskId taskId * @return Promise @@ -72,7 +70,6 @@ export class ActivitiCommentsApi extends BaseApi { /** * Get comments for a process - * * @param processInstanceId processInstanceId * @param opts Optional parameters * @return Promise @@ -97,7 +94,6 @@ export class ActivitiCommentsApi extends BaseApi { /** * Get comments for a task - * * @param taskId taskId * @param opts Optional parameters * @return Promise diff --git a/lib/js-api/src/api/activiti-rest-api/api/content.api.ts b/lib/js-api/src/api/activiti-rest-api/api/content.api.ts index 33afe650e2c..d4761365961 100644 --- a/lib/js-api/src/api/activiti-rest-api/api/content.api.ts +++ b/lib/js-api/src/api/activiti-rest-api/api/content.api.ts @@ -29,7 +29,6 @@ import { throwIfNotDefined } from '../../../assert'; export class ContentApi extends BaseApi { /** * Attach existing content to a process instance - * * @param processInstanceId processInstanceId * @param relatedContent relatedContent * @param opts Optional parameters @@ -75,7 +74,6 @@ export class ContentApi extends BaseApi { /** * Attach existing content to a task - * * @param taskId taskId * @param relatedContent relatedContent * @param opts Optional parameters @@ -119,7 +117,6 @@ export class ContentApi extends BaseApi { /** * Upload content and create a local representation - * * @param file file * @return Promise */ @@ -140,7 +137,6 @@ export class ContentApi extends BaseApi { /** * Create a local representation of content from a remote repository - * * @param relatedContent relatedContent * @return Promise */ @@ -156,7 +152,6 @@ export class ContentApi extends BaseApi { /** * Remove a local content representation - * * @param contentId contentId * @return Promise<{}> */ @@ -175,7 +170,6 @@ export class ContentApi extends BaseApi { /** * Get a local content representation - * * @param contentId contentId * @return Promise */ @@ -195,7 +189,6 @@ export class ContentApi extends BaseApi { /** * Get content Raw URL for the given contentId - * * @param contentId contentId */ getRawContentUrl(contentId: number): string { @@ -204,7 +197,6 @@ export class ContentApi extends BaseApi { /** * Stream content rendition - * * @param contentId contentId * @param renditionType renditionType * @return Promise<{}> @@ -240,7 +232,6 @@ export class ContentApi extends BaseApi { /** * List content attached to a process instance - * * @param processInstanceId processInstanceId * @param opts Optional parameters * @return Promise @@ -267,7 +258,6 @@ export class ContentApi extends BaseApi { /** * List content attached to a task - * * @param taskId taskId * @param opts Optional parameters * @return Promise @@ -292,7 +282,6 @@ export class ContentApi extends BaseApi { /** * Lists processes and tasks on workflow started with provided document - * * @param sourceId - id of the document that workflow or task has been started with * @param source - source of the document that workflow or task has been started with * @param size - size of the entries to get diff --git a/lib/js-api/src/api/activiti-rest-api/api/dataSources.api.ts b/lib/js-api/src/api/activiti-rest-api/api/dataSources.api.ts index 268569ea6bc..df18a390b9d 100644 --- a/lib/js-api/src/api/activiti-rest-api/api/dataSources.api.ts +++ b/lib/js-api/src/api/activiti-rest-api/api/dataSources.api.ts @@ -24,7 +24,6 @@ import { BaseApi } from './base.api'; export class DataSourcesApi extends BaseApi { /** * Get data sources - * * @param opts Optional parameters * @return Promise */ diff --git a/lib/js-api/src/api/activiti-rest-api/api/decisionAudits.api.ts b/lib/js-api/src/api/activiti-rest-api/api/decisionAudits.api.ts index db0d30dd12d..0111a0e25c0 100644 --- a/lib/js-api/src/api/activiti-rest-api/api/decisionAudits.api.ts +++ b/lib/js-api/src/api/activiti-rest-api/api/decisionAudits.api.ts @@ -26,7 +26,6 @@ import { throwIfNotDefined } from '../../../assert'; export class DecisionAuditsApi extends BaseApi { /** * Get an audit trail - * * @param auditTrailId auditTrailId * @return Promise */ @@ -46,7 +45,6 @@ export class DecisionAuditsApi extends BaseApi { /** * Query decision table audit trails - * * @param decisionKey decisionKey * @param dmnDeploymentId dmnDeploymentId * @return Promise diff --git a/lib/js-api/src/api/activiti-rest-api/api/decisionTables.api.ts b/lib/js-api/src/api/activiti-rest-api/api/decisionTables.api.ts index 7059e66510c..691292965fb 100644 --- a/lib/js-api/src/api/activiti-rest-api/api/decisionTables.api.ts +++ b/lib/js-api/src/api/activiti-rest-api/api/decisionTables.api.ts @@ -36,7 +36,6 @@ export interface GetDecisionTablesOpts { export class DecisionTablesApi extends BaseApi { /** * Get definition for a decision table - * * @param decisionTableId decisionTableId * @return Promise */ @@ -55,7 +54,6 @@ export class DecisionTablesApi extends BaseApi { /** * Get a decision table - * * @param decisionTableId decisionTableId * @return Promise */ @@ -74,7 +72,6 @@ export class DecisionTablesApi extends BaseApi { /** * Query decision tables - * * @param opts Optional parameters * @return Promise */ diff --git a/lib/js-api/src/api/activiti-rest-api/api/endpoints.api.ts b/lib/js-api/src/api/activiti-rest-api/api/endpoints.api.ts index 1b65617436b..58611622325 100644 --- a/lib/js-api/src/api/activiti-rest-api/api/endpoints.api.ts +++ b/lib/js-api/src/api/activiti-rest-api/api/endpoints.api.ts @@ -25,7 +25,6 @@ import { throwIfNotDefined } from '../../../assert'; export class EndpointsApi extends BaseApi { /** * Get an endpoint configuration - * * @param endpointConfigurationId endpointConfigurationId * @return Promise */ @@ -44,7 +43,6 @@ export class EndpointsApi extends BaseApi { /** * List endpoint configurations - * * @return Promise */ getEndpointConfigurations(): Promise { diff --git a/lib/js-api/src/api/activiti-rest-api/api/formModels.api.ts b/lib/js-api/src/api/activiti-rest-api/api/formModels.api.ts index 589cde633e7..6609d645781 100644 --- a/lib/js-api/src/api/activiti-rest-api/api/formModels.api.ts +++ b/lib/js-api/src/api/activiti-rest-api/api/formModels.api.ts @@ -43,7 +43,6 @@ export interface GetFormsOpts { export class FormModelsApi extends BaseApi { /** * Get form content - * * @param formId formId * @return Promise */ @@ -62,7 +61,6 @@ export class FormModelsApi extends BaseApi { /** * Get form history - * * @param formId formId * @param formHistoryId formHistoryId * @return Promise @@ -85,7 +83,6 @@ export class FormModelsApi extends BaseApi { /** * Get a form model - * * @param formId {number} formId * @return Promise */ @@ -105,7 +102,6 @@ export class FormModelsApi extends BaseApi { /** * Get forms - * * @param input input * @return Promise */ @@ -137,7 +133,6 @@ export class FormModelsApi extends BaseApi { /** * Update form model content - * * @param formId ID of the form to update * @param saveRepresentation saveRepresentation * @return Promise @@ -162,7 +157,6 @@ export class FormModelsApi extends BaseApi { * Validate form model content * * The model content to be validated must be specified in the POST body - * * @param formId formId * @param saveRepresentation saveRepresentation * @return Promise diff --git a/lib/js-api/src/api/activiti-rest-api/api/groups.api.ts b/lib/js-api/src/api/activiti-rest-api/api/groups.api.ts index 138d50cb34e..66675aedab0 100644 --- a/lib/js-api/src/api/activiti-rest-api/api/groups.api.ts +++ b/lib/js-api/src/api/activiti-rest-api/api/groups.api.ts @@ -33,7 +33,6 @@ export interface GetGroupsOpts { export class ActivitiGroupsApi extends BaseApi { /** * Query groups - * * @param opts Optional parameters * @return Promise */ @@ -46,7 +45,6 @@ export class ActivitiGroupsApi extends BaseApi { /** * List members of a group - * * @param groupId groupId * @return Promise */ diff --git a/lib/js-api/src/api/activiti-rest-api/api/iDMSync.api.ts b/lib/js-api/src/api/activiti-rest-api/api/iDMSync.api.ts index 5e5beda20f0..c8ca739778d 100644 --- a/lib/js-api/src/api/activiti-rest-api/api/iDMSync.api.ts +++ b/lib/js-api/src/api/activiti-rest-api/api/iDMSync.api.ts @@ -25,7 +25,6 @@ import { throwIfNotDefined } from '../../../assert'; export class IDMSyncApi extends BaseApi { /** * Get log file for a sync log entry - * * @param syncLogEntryId syncLogEntryId * @return Promise<{}> */ @@ -44,7 +43,6 @@ export class IDMSyncApi extends BaseApi { /** * List sync log entries - * * @param opts Optional parameters * @param opts.tenantId {number} tenantId * @param opts.page {number} page diff --git a/lib/js-api/src/api/activiti-rest-api/api/integrationAlfrescoCloud.api.ts b/lib/js-api/src/api/activiti-rest-api/api/integrationAlfrescoCloud.api.ts index 3938ef776c7..c103d12785b 100644 --- a/lib/js-api/src/api/activiti-rest-api/api/integrationAlfrescoCloud.api.ts +++ b/lib/js-api/src/api/activiti-rest-api/api/integrationAlfrescoCloud.api.ts @@ -30,7 +30,6 @@ export class IntegrationAlfrescoCloudApi extends BaseApi { /** * Alfresco Cloud Authorization * Returns Alfresco OAuth HTML Page - * * @param code code * @return Promise<{}> */ @@ -50,7 +49,6 @@ export class IntegrationAlfrescoCloudApi extends BaseApi { /** * List Alfresco networks - * * @return Promise */ getAllNetworks(): Promise { @@ -62,7 +60,6 @@ export class IntegrationAlfrescoCloudApi extends BaseApi { /** * List Alfresco sites * Returns ALL Sites - * * @param networkId networkId * @return Promise */ @@ -81,7 +78,6 @@ export class IntegrationAlfrescoCloudApi extends BaseApi { /** * List files and folders inside a specific folder identified by path - * * @param networkId networkId * @param opts Optional parameters * @param opts.siteId {string} siteId @@ -107,7 +103,6 @@ export class IntegrationAlfrescoCloudApi extends BaseApi { /** * List files and folders inside a specific folder - * * @param networkId networkId * @param folderId folderId * @return Promise @@ -129,7 +124,6 @@ export class IntegrationAlfrescoCloudApi extends BaseApi { /** * List files and folders inside a specific site - * * @param networkId networkId * @param siteId siteId * @return Promise diff --git a/lib/js-api/src/api/activiti-rest-api/api/integrationAlfrescoOnPremise.api.ts b/lib/js-api/src/api/activiti-rest-api/api/integrationAlfrescoOnPremise.api.ts index 4e7c7fe5ab2..5e5ad3906d9 100644 --- a/lib/js-api/src/api/activiti-rest-api/api/integrationAlfrescoOnPremise.api.ts +++ b/lib/js-api/src/api/activiti-rest-api/api/integrationAlfrescoOnPremise.api.ts @@ -30,7 +30,6 @@ export class IntegrationAlfrescoOnPremiseApi extends BaseApi { /** * List Alfresco sites * Returns ALL Sites - * * @param repositoryId repositoryId * @return Promise */ @@ -49,7 +48,6 @@ export class IntegrationAlfrescoOnPremiseApi extends BaseApi { /** * List files and folders inside a specific folder identified by folder path - * * @param repositoryId repositoryId * @param siteId siteId * @param folderPath folderPath @@ -78,7 +76,6 @@ export class IntegrationAlfrescoOnPremiseApi extends BaseApi { /** * List files and folders inside a specific folder - * * @param repositoryId repositoryId * @param folderId folderId * @return Promise @@ -100,7 +97,6 @@ export class IntegrationAlfrescoOnPremiseApi extends BaseApi { /** * List files and folders inside a specific site - * * @param repositoryId repositoryId * @param siteId siteId * @return Promise @@ -124,7 +120,6 @@ export class IntegrationAlfrescoOnPremiseApi extends BaseApi { * List Alfresco repositories * * A tenant administrator can configure one or more Alfresco repositories to use when working with content. - * * @param opts Optional parameters * @param opts.tenantId {string} tenantId * @param opts.includeAccounts {boolean} includeAccounts (default to true) diff --git a/lib/js-api/src/api/activiti-rest-api/api/integrationBox.api.ts b/lib/js-api/src/api/activiti-rest-api/api/integrationBox.api.ts index 589a85feab4..a45bdf7b032 100644 --- a/lib/js-api/src/api/activiti-rest-api/api/integrationBox.api.ts +++ b/lib/js-api/src/api/activiti-rest-api/api/integrationBox.api.ts @@ -26,7 +26,6 @@ export class IntegrationBoxApi extends BaseApi { /** * Box Authorization * Returns Box OAuth HTML Page - * * @return Promise<{}> */ confirmAuthorisation(): Promise { @@ -38,7 +37,6 @@ export class IntegrationBoxApi extends BaseApi { /** * Add Box account - * * @param userId userId * @param credentials credentials * @return Promise<{}> @@ -60,7 +58,6 @@ export class IntegrationBoxApi extends BaseApi { /** * Delete account information - * * @param userId userId * @return Promise<{}> */ @@ -82,7 +79,6 @@ export class IntegrationBoxApi extends BaseApi { /** * Get status information - * * @return Promise */ getBoxPluginStatus(): Promise { @@ -94,7 +90,6 @@ export class IntegrationBoxApi extends BaseApi { /** * List file and folders - * * @param opts Optional parameters * @param opts.filter filter * @param opts.parent parent @@ -112,7 +107,6 @@ export class IntegrationBoxApi extends BaseApi { /** * Get account information - * * @param userId userId * @return Promise<{}> */ @@ -132,7 +126,6 @@ export class IntegrationBoxApi extends BaseApi { /** * Update account information - * * @param userId userId * @param credentials credentials * @return Promise<{}> diff --git a/lib/js-api/src/api/activiti-rest-api/api/integrationDrive.api.ts b/lib/js-api/src/api/activiti-rest-api/api/integrationDrive.api.ts index c9de9a39f70..dbfe36ba774 100644 --- a/lib/js-api/src/api/activiti-rest-api/api/integrationDrive.api.ts +++ b/lib/js-api/src/api/activiti-rest-api/api/integrationDrive.api.ts @@ -25,7 +25,6 @@ export class IntegrationDriveApi extends BaseApi { /** * Drive Authorization * Returns Drive OAuth HTML Page - * * @return Promise<{}> */ confirmAuthorisation(): Promise { @@ -37,7 +36,6 @@ export class IntegrationDriveApi extends BaseApi { /** * List files and folders - * * @param opts Optional parameters * @param opts.filter {string} filter * @param opts.parent {string} parent diff --git a/lib/js-api/src/api/activiti-rest-api/api/modelJsonBpmn.api.ts b/lib/js-api/src/api/activiti-rest-api/api/modelJsonBpmn.api.ts index 46003559ee9..823c0d48782 100644 --- a/lib/js-api/src/api/activiti-rest-api/api/modelJsonBpmn.api.ts +++ b/lib/js-api/src/api/activiti-rest-api/api/modelJsonBpmn.api.ts @@ -21,7 +21,6 @@ import { throwIfNotDefined } from '../../../assert'; export class ModelJsonBpmnApi extends BaseApi { /** * Export a previous process definition model to a JSON - * * @param processModelId processModelId * @param processModelHistoryId processModelHistoryId */ @@ -42,7 +41,6 @@ export class ModelJsonBpmnApi extends BaseApi { /** * Export a process definition model to a JSON - * * @param processModelId processModelId */ getEditorDisplayJsonClient(processModelId: number) { @@ -60,7 +58,6 @@ export class ModelJsonBpmnApi extends BaseApi { /** * Function to receive the result of the getModelJSONForProcessDefinition operation. - * * @param processDefinitionId processDefinitionId */ getModelJSON(processDefinitionId: string) { @@ -78,7 +75,6 @@ export class ModelJsonBpmnApi extends BaseApi { /** * Function to receive the result of the getModelHistoryJSON operation. - * * @param processInstanceId processInstanceId */ getModelJSONForProcessDefinition(processInstanceId: string) { diff --git a/lib/js-api/src/api/activiti-rest-api/api/models.api.ts b/lib/js-api/src/api/activiti-rest-api/api/models.api.ts index dff4b9ea2ca..83e0fe86e64 100644 --- a/lib/js-api/src/api/activiti-rest-api/api/models.api.ts +++ b/lib/js-api/src/api/activiti-rest-api/api/models.api.ts @@ -32,7 +32,6 @@ export interface GetModelsQuery { export class ModelsApi extends BaseApi { /** * Create a new model - * * @param modelRepresentation modelRepresentation * @return Promise */ @@ -48,7 +47,6 @@ export class ModelsApi extends BaseApi { /** * Delete a model - * * @param modelId modelId * @param opts Optional parameters * @param opts.cascade cascade @@ -76,7 +74,6 @@ export class ModelsApi extends BaseApi { /** * Duplicate an existing model - * * @param modelId modelId * @param modelRepresentation modelRepresentation * @return Promise @@ -99,7 +96,6 @@ export class ModelsApi extends BaseApi { /** * Get model content - * * @param modelId modelId * @return Promise */ @@ -118,7 +114,6 @@ export class ModelsApi extends BaseApi { /** * Get a model's thumbnail image - * * @param modelId modelId * @return Promise */ @@ -140,7 +135,6 @@ export class ModelsApi extends BaseApi { * Get a model * * Models act as containers for process, form, decision table and app definitions - * * @param modelId modelId * @param opts Optional parameters * @return Promise @@ -166,7 +160,6 @@ export class ModelsApi extends BaseApi { /** * List process definition models shared with the current user - * * @return Promise */ getModelsToIncludeInAppDefinition(): Promise { @@ -178,7 +171,6 @@ export class ModelsApi extends BaseApi { /** * List models (process, form, decision rule or app) - * * @param opts Optional parameters * @return Promise */ @@ -192,7 +184,6 @@ export class ModelsApi extends BaseApi { /** * Create a new version of a model - * * @param modelId modelId * @param file file * @return Promise @@ -220,7 +211,6 @@ export class ModelsApi extends BaseApi { /** * Import a BPMN 2.0 XML file - * * @param file file * @return Promise */ @@ -241,7 +231,6 @@ export class ModelsApi extends BaseApi { /** * Update model content - * * @param modelId modelId * @param values values * @return Promise @@ -266,7 +255,6 @@ export class ModelsApi extends BaseApi { * Update a model * * This method allows you to update the metadata of a model. In order to update the content of the model you will need to call the specific endpoint for that model type. - * * @param modelId modelId * @param updatedModel updatedModel * @return Promise @@ -289,7 +277,6 @@ export class ModelsApi extends BaseApi { /** * Validate model content - * * @param modelId modelId * @param opts Optional parameters * @param opts.values values diff --git a/lib/js-api/src/api/activiti-rest-api/api/modelsBpmn.api.ts b/lib/js-api/src/api/activiti-rest-api/api/modelsBpmn.api.ts index 45b95d23f13..c1225e92510 100644 --- a/lib/js-api/src/api/activiti-rest-api/api/modelsBpmn.api.ts +++ b/lib/js-api/src/api/activiti-rest-api/api/modelsBpmn.api.ts @@ -24,7 +24,6 @@ import { throwIfNotDefined } from '../../../assert'; export class ModelsBpmnApi extends BaseApi { /** * Export a historic version of a process definition as BPMN 2.0 XML - * * @param processModelId processModelId * @param processModelHistoryId processModelHistoryId * @return Promise<{}> @@ -49,7 +48,6 @@ export class ModelsBpmnApi extends BaseApi { /** * Export a process definition as BPMN 2.0 XML - * * @param processModelId processModelId * @return Promise<{}> */ diff --git a/lib/js-api/src/api/activiti-rest-api/api/modelsHistory.api.ts b/lib/js-api/src/api/activiti-rest-api/api/modelsHistory.api.ts index 564ecc19cef..db2fec8d519 100644 --- a/lib/js-api/src/api/activiti-rest-api/api/modelsHistory.api.ts +++ b/lib/js-api/src/api/activiti-rest-api/api/modelsHistory.api.ts @@ -26,7 +26,6 @@ import { throwIfNotDefined } from '../../../assert'; export class ModelsHistoryApi extends BaseApi { /** * List a model's historic versions - * * @param modelId modelId * @param opts Optional parameters * @param opts.includeLatestVersion includeLatestVersion @@ -53,7 +52,6 @@ export class ModelsHistoryApi extends BaseApi { /** * Get a historic version of a model - * * @param modelId modelId * @param modelHistoryId modelHistoryId * @return Promise diff --git a/lib/js-api/src/api/activiti-rest-api/api/processDefinitions.api.ts b/lib/js-api/src/api/activiti-rest-api/api/processDefinitions.api.ts index f1adfc81816..c958a1952cb 100644 --- a/lib/js-api/src/api/activiti-rest-api/api/processDefinitions.api.ts +++ b/lib/js-api/src/api/activiti-rest-api/api/processDefinitions.api.ts @@ -32,7 +32,6 @@ import { throwIfNotDefined } from '../../../assert'; export class ProcessDefinitionsApi extends BaseApi { /** * Add a user or group involvement to a process definition - * * @param processDefinitionId processDefinitionId * @param identityLinkRepresentation identityLinkRepresentation * @return Promise @@ -54,7 +53,6 @@ export class ProcessDefinitionsApi extends BaseApi { /** * Remove a user or group involvement from a process definition - * * @param processDefinitionId Process definition ID * @param family Identity type * @param identityId User or group ID @@ -79,7 +77,6 @@ export class ProcessDefinitionsApi extends BaseApi { /** * Get a user or group involvement with a process definition - * * @param processDefinitionId Process definition ID * @param family Identity type * @param identityId User or group ID @@ -104,7 +101,6 @@ export class ProcessDefinitionsApi extends BaseApi { /** * List either the users or groups involved with a process definition - * * @param processDefinitionId processDefinitionId * @param family Identity type * @return Promise @@ -126,7 +122,6 @@ export class ProcessDefinitionsApi extends BaseApi { /** * List the users and groups involved with a process definition - * * @param processDefinitionId processDefinitionId * @return Promise */ @@ -145,7 +140,6 @@ export class ProcessDefinitionsApi extends BaseApi { /** * List the decision tables associated with a process definition - * * @param processDefinitionId processDefinitionId * @return Promise */ @@ -164,7 +158,6 @@ export class ProcessDefinitionsApi extends BaseApi { /** * List the forms associated with a process definition - * * @param processDefinitionId processDefinitionId * @return Promise */ @@ -183,7 +176,6 @@ export class ProcessDefinitionsApi extends BaseApi { /** * Retrieve the start form for a process definition - * * @param processDefinitionId processDefinitionId * @return Promise */ @@ -202,7 +194,6 @@ export class ProcessDefinitionsApi extends BaseApi { * Retrieve a list of process definitions * * Get a list of process definitions (visible within the tenant of the user) - * * @param opts Optional parameters * @return Promise */ @@ -219,7 +210,6 @@ export class ProcessDefinitionsApi extends BaseApi { /** * Retrieve field values (e.g. the typeahead field) - * * @param processDefinitionId processDefinitionId * @param field field * @return Promise @@ -238,7 +228,6 @@ export class ProcessDefinitionsApi extends BaseApi { /** * Retrieve field values (eg. the table field) - * * @param processDefinitionId processDefinitionId * @param field field * @param column column diff --git a/lib/js-api/src/api/activiti-rest-api/api/processInstanceVariables.api.ts b/lib/js-api/src/api/activiti-rest-api/api/processInstanceVariables.api.ts index c26bdd066af..f67982acbea 100644 --- a/lib/js-api/src/api/activiti-rest-api/api/processInstanceVariables.api.ts +++ b/lib/js-api/src/api/activiti-rest-api/api/processInstanceVariables.api.ts @@ -25,7 +25,6 @@ import { throwIfNotDefined } from '../../../assert'; export class ProcessInstanceVariablesApi extends BaseApi { /** * Create or update variables - * * @param processInstanceId Process instance ID * @param restVariables restVariables * @return Promise @@ -47,7 +46,6 @@ export class ProcessInstanceVariablesApi extends BaseApi { /** * Delete a variable - * * @param processInstanceId processInstanceId * @param variableName variableName * @return Promise<{}> @@ -69,7 +67,6 @@ export class ProcessInstanceVariablesApi extends BaseApi { /** * Get a variable - * * @param processInstanceId processInstanceId * @param variableName variableName * @return Promise @@ -91,7 +88,6 @@ export class ProcessInstanceVariablesApi extends BaseApi { /** * List variables - * * @param processInstanceId Process instance ID * @return Promise */ @@ -110,7 +106,6 @@ export class ProcessInstanceVariablesApi extends BaseApi { /** * Update a variable - * * @param processInstanceId processInstanceId * @param variableName variableName * @param restVariable restVariable diff --git a/lib/js-api/src/api/activiti-rest-api/api/processInstances.api.ts b/lib/js-api/src/api/activiti-rest-api/api/processInstances.api.ts index ed6a0a61462..aba429f08ac 100644 --- a/lib/js-api/src/api/activiti-rest-api/api/processInstances.api.ts +++ b/lib/js-api/src/api/activiti-rest-api/api/processInstances.api.ts @@ -38,7 +38,6 @@ import { throwIfNotDefined } from '../../../assert'; export class ProcessInstancesApi extends BaseApi { /** * Activate a process instance - * * @param processInstanceId processInstanceId * @return Promise */ @@ -58,7 +57,6 @@ export class ProcessInstancesApi extends BaseApi { /** * Add a user or group involvement to a process instance - * * @param processInstanceId processInstanceId * @param identityLinkRepresentation identityLinkRepresentation * @return Promise @@ -80,7 +78,6 @@ export class ProcessInstancesApi extends BaseApi { /** * Remove a user or group involvement from a process instance - * * @param processInstanceId processInstanceId * @param family family * @param identityId identityId @@ -110,7 +107,6 @@ export class ProcessInstancesApi extends BaseApi { * Cancel or remove a process instance * * If the process instance has not yet been completed, it will be cancelled. If it has already finished or been cancelled then the process instance will be removed and will no longer appear in queries. - * * @param processInstanceId processInstanceId * @return Promise<{}> */ @@ -131,7 +127,6 @@ export class ProcessInstancesApi extends BaseApi { * List process instances using a filter * * The request body provided must define either a valid filterId value or filter object - * * @param filterRequest filterRequest * @return Promise */ @@ -149,7 +144,6 @@ export class ProcessInstancesApi extends BaseApi { /** * Get decision tasks in a process instance - * * @param processInstanceId processInstanceId * @return Promise */ @@ -169,7 +163,6 @@ export class ProcessInstancesApi extends BaseApi { /** * Get historic variables for a process instance - * * @param processInstanceId processInstanceId * @return Promise */ @@ -188,7 +181,6 @@ export class ProcessInstancesApi extends BaseApi { /** * Query historic process instances - * * @param queryRequest queryRequest * @return Promise */ @@ -206,7 +198,6 @@ export class ProcessInstancesApi extends BaseApi { /** * Get a user or group involvement with a process instance - * * @param processInstanceId processInstanceId * @param family family * @param identityId identityId @@ -234,7 +225,6 @@ export class ProcessInstancesApi extends BaseApi { /** * List either the users or groups involved with a process instance - * * @param processInstanceId processInstanceId * @param family family * @return Promise @@ -256,7 +246,6 @@ export class ProcessInstancesApi extends BaseApi { /** * List the users and groups involved with a process instance - * * @param processInstanceId processInstanceId * @return Promise */ @@ -275,7 +264,6 @@ export class ProcessInstancesApi extends BaseApi { /** * List content attached to process instance fields - * * @param processInstanceId processInstanceId * @return Promise */ @@ -295,7 +283,6 @@ export class ProcessInstancesApi extends BaseApi { /** * Get the process diagram for the process instance - * * @param processInstanceId processInstanceId * @return Promise */ @@ -319,7 +306,6 @@ export class ProcessInstancesApi extends BaseApi { * Get a process instance start form * * The start form for a process instance can be retrieved when the process definition has a start form defined (hasStartForm = true on the process instance) - * * @param processInstanceId processInstanceId * @return Promise */ @@ -338,7 +324,6 @@ export class ProcessInstancesApi extends BaseApi { /** * Get a process instance - * * @param processInstanceId processInstanceId * @return Promise */ @@ -358,7 +343,6 @@ export class ProcessInstancesApi extends BaseApi { /** * Query process instances - * * @param processInstancesQuery processInstancesQuery * @return Promise */ @@ -376,7 +360,6 @@ export class ProcessInstancesApi extends BaseApi { /** * Get the audit log for a process instance - * * @param processInstanceId processInstanceId * @return Promise */ @@ -395,7 +378,6 @@ export class ProcessInstancesApi extends BaseApi { /** * Retrieve the process audit in the PDF format - * * @param processInstanceId processId * @returns process audit */ @@ -417,7 +399,6 @@ export class ProcessInstancesApi extends BaseApi { /** * Start a process instance - * * @param startRequest startRequest * @return Promise */ @@ -433,7 +414,6 @@ export class ProcessInstancesApi extends BaseApi { /** * Suspend a process instance - * * @param processInstanceId processInstanceId * @return Promise */ diff --git a/lib/js-api/src/api/activiti-rest-api/api/processScopes.api.ts b/lib/js-api/src/api/activiti-rest-api/api/processScopes.api.ts index e6c8915b228..84d9638550b 100644 --- a/lib/js-api/src/api/activiti-rest-api/api/processScopes.api.ts +++ b/lib/js-api/src/api/activiti-rest-api/api/processScopes.api.ts @@ -25,7 +25,6 @@ import { throwIfNotDefined } from '../../../assert'; export class ProcessScopesApi extends BaseApi { /** * List runtime process scopes - * * @param processScopesRequest processScopesRequest * @return Promise */ diff --git a/lib/js-api/src/api/activiti-rest-api/api/report.api.ts b/lib/js-api/src/api/activiti-rest-api/api/report.api.ts index dd858678f36..a2d99dd6416 100755 --- a/lib/js-api/src/api/activiti-rest-api/api/report.api.ts +++ b/lib/js-api/src/api/activiti-rest-api/api/report.api.ts @@ -105,7 +105,6 @@ export class ReportApi extends BaseApi { /** * Export a report - * * @param reportId report id * @param bodyParam body parameters */ @@ -127,7 +126,6 @@ export class ReportApi extends BaseApi { /** * Save a report - * * @param reportId report id * @param opts Optional parameters */ @@ -154,7 +152,6 @@ export class ReportApi extends BaseApi { /** * Delete a report - * * @param reportId report id */ deleteReport(reportId: string) { diff --git a/lib/js-api/src/api/activiti-rest-api/api/runtimeAppDefinitions.api.ts b/lib/js-api/src/api/activiti-rest-api/api/runtimeAppDefinitions.api.ts index 59b49312ed1..37dbbafedca 100644 --- a/lib/js-api/src/api/activiti-rest-api/api/runtimeAppDefinitions.api.ts +++ b/lib/js-api/src/api/activiti-rest-api/api/runtimeAppDefinitions.api.ts @@ -31,7 +31,6 @@ export class RuntimeAppDefinitionsApi extends BaseApi { * Deploy a published app * * Deploying an app allows the user to see it on his/her landing page. Apps must be published before they can be deployed. - * * @param saveObject saveObject * @return Promise<{}> */ @@ -46,7 +45,6 @@ export class RuntimeAppDefinitionsApi extends BaseApi { /** * Get a runtime app - * * @param appDefinitionId appDefinitionId * @return Promise */ @@ -67,7 +65,6 @@ export class RuntimeAppDefinitionsApi extends BaseApi { * List runtime apps * * When a user logs in into Alfresco Process Services Suite, a landing page is displayed containing all the apps that the user is allowed to see and use. These are referred to as runtime apps. - * * @return Promise */ getAppDefinitions(): Promise { diff --git a/lib/js-api/src/api/activiti-rest-api/api/runtimeAppDeployments.api.ts b/lib/js-api/src/api/activiti-rest-api/api/runtimeAppDeployments.api.ts index 2a95ae09144..a4322ba2d7c 100644 --- a/lib/js-api/src/api/activiti-rest-api/api/runtimeAppDeployments.api.ts +++ b/lib/js-api/src/api/activiti-rest-api/api/runtimeAppDeployments.api.ts @@ -26,7 +26,6 @@ import { throwIfNotDefined } from '../../../assert'; export class RuntimeAppDeploymentsApi extends BaseApi { /** * Remove an app deployment - * * @param appDeploymentId appDeploymentId * @return Promise<{}> */ @@ -45,7 +44,6 @@ export class RuntimeAppDeploymentsApi extends BaseApi { /** * Export the app archive for a deployment - * * @param deploymentId deploymentId * @return Promise<{}> */ @@ -67,7 +65,6 @@ export class RuntimeAppDeploymentsApi extends BaseApi { /** * Query app deployments - * * @param opts Optional parameters * @return Promise */ @@ -89,7 +86,6 @@ export class RuntimeAppDeploymentsApi extends BaseApi { /** * Get an app deployment - * * @param appDeploymentId appDeploymentId * @return Promise */ @@ -110,7 +106,6 @@ export class RuntimeAppDeploymentsApi extends BaseApi { /** * Get an app by deployment ID or DMN deployment ID * Either a deploymentId or a dmnDeploymentId must be provided - * * @param opts Optional parameters * @return Promise */ diff --git a/lib/js-api/src/api/activiti-rest-api/api/scriptFiles.api.ts b/lib/js-api/src/api/activiti-rest-api/api/scriptFiles.api.ts index 3e0a00f7512..0b9d330c4c3 100644 --- a/lib/js-api/src/api/activiti-rest-api/api/scriptFiles.api.ts +++ b/lib/js-api/src/api/activiti-rest-api/api/scriptFiles.api.ts @@ -23,7 +23,6 @@ import { BaseApi } from './base.api'; export class ScriptFilesApi extends BaseApi { /** * getControllers - * * @returns Promise */ getControllers(): Promise { @@ -37,7 +36,6 @@ export class ScriptFilesApi extends BaseApi { /** * getLibraries - * * @returns Promise */ getLibraries(): Promise { diff --git a/lib/js-api/src/api/activiti-rest-api/api/submittedForms.api.ts b/lib/js-api/src/api/activiti-rest-api/api/submittedForms.api.ts index 025d790f8d4..6a3b33b764c 100644 --- a/lib/js-api/src/api/activiti-rest-api/api/submittedForms.api.ts +++ b/lib/js-api/src/api/activiti-rest-api/api/submittedForms.api.ts @@ -26,7 +26,6 @@ import { throwIfNotDefined } from '../../../assert'; export class SubmittedFormsApi extends BaseApi { /** * List submissions for a form - * * @param formId formId * @param opts Optional parameters * @return Promise @@ -51,7 +50,6 @@ export class SubmittedFormsApi extends BaseApi { /** * List submissions for a process instance - * * @param processId processId * @return Promise */ @@ -71,7 +69,6 @@ export class SubmittedFormsApi extends BaseApi { /** * Get a form submission - * * @param submittedFormId submittedFormId * @return Promise */ @@ -91,7 +88,6 @@ export class SubmittedFormsApi extends BaseApi { /** * Get the submitted form for a task - * * @param taskId taskId * @return Promise */ diff --git a/lib/js-api/src/api/activiti-rest-api/api/systemProperties.api.ts b/lib/js-api/src/api/activiti-rest-api/api/systemProperties.api.ts index 3d741a79c92..4baea4b8ddf 100644 --- a/lib/js-api/src/api/activiti-rest-api/api/systemProperties.api.ts +++ b/lib/js-api/src/api/activiti-rest-api/api/systemProperties.api.ts @@ -25,7 +25,6 @@ import { throwIfNotDefined } from '../../../assert'; export class SystemPropertiesApi extends BaseApi { /** * Get global date format - * * @param tenantId tenantId * @return Promise */ @@ -44,7 +43,6 @@ export class SystemPropertiesApi extends BaseApi { /** * Get password validation constraints - * * @param tenantId tenantId * @return Promise */ @@ -65,7 +63,6 @@ export class SystemPropertiesApi extends BaseApi { * Retrieve system properties * * Typical value is AllowInvolveByEmail - * * @return Promise */ getProperties(): Promise { @@ -76,7 +73,6 @@ export class SystemPropertiesApi extends BaseApi { /** * Get involved users who can edit forms - * * @param tenantId tenantId * @return Promise */ diff --git a/lib/js-api/src/api/activiti-rest-api/api/taskActions.api.ts b/lib/js-api/src/api/activiti-rest-api/api/taskActions.api.ts index 18d2cc1998b..e03512c865c 100644 --- a/lib/js-api/src/api/activiti-rest-api/api/taskActions.api.ts +++ b/lib/js-api/src/api/activiti-rest-api/api/taskActions.api.ts @@ -25,7 +25,6 @@ import { throwIfNotDefined } from '../../../assert'; export class TaskActionsApi extends BaseApi { /** * Assign a task to a user - * * @param taskId taskId * @param userIdentifier userIdentifier * @return Promise @@ -48,7 +47,6 @@ export class TaskActionsApi extends BaseApi { /** * Attach a form to a task - * * @param taskId taskId * @param formIdentifier formIdentifier * @return Promise<{}> @@ -72,7 +70,6 @@ export class TaskActionsApi extends BaseApi { * Claim a task * * To claim a task (in case the task is assigned to a group) - * * @param taskId taskId * @return Promise<{}> */ @@ -93,7 +90,6 @@ export class TaskActionsApi extends BaseApi { * Complete a task * * Use this endpoint to complete a standalone task or task without a form - * * @param taskId taskId * @return Promise<{}> */ @@ -112,7 +108,6 @@ export class TaskActionsApi extends BaseApi { /** * Delegate a task - * * @param taskId taskId * @param userIdentifier userIdentifier * @return Promise<{}> @@ -134,7 +129,6 @@ export class TaskActionsApi extends BaseApi { /** * Involve a group with a task - * * @param taskId taskId * @param groupId groupId * @return Promise<{}> @@ -156,7 +150,6 @@ export class TaskActionsApi extends BaseApi { /** * Involve a user with a task - * * @param taskId taskId * @param userIdentifier userIdentifier * @return Promise<{}> @@ -178,7 +171,6 @@ export class TaskActionsApi extends BaseApi { /** * Remove a form from a task - * * @param taskId taskId * @return Promise<{}> */ @@ -197,7 +189,6 @@ export class TaskActionsApi extends BaseApi { /** * Remove an involved group from a task - * * @param taskId taskId * @param identifier identifier * @return Promise<{}> @@ -227,9 +218,6 @@ export class TaskActionsApi extends BaseApi { /** * Resolve a task - * - * - * * @param taskId taskId * @return Promise<{}> */ @@ -250,7 +238,6 @@ export class TaskActionsApi extends BaseApi { * Unclaim a task * * To unclaim a task (in case the task was assigned to a group) - * * @param taskId taskId * @return Promise<{}> */ diff --git a/lib/js-api/src/api/activiti-rest-api/api/taskForms.api.ts b/lib/js-api/src/api/activiti-rest-api/api/taskForms.api.ts index 40e11f56f54..f224466b1e7 100644 --- a/lib/js-api/src/api/activiti-rest-api/api/taskForms.api.ts +++ b/lib/js-api/src/api/activiti-rest-api/api/taskForms.api.ts @@ -31,7 +31,6 @@ import { throwIfNotDefined } from '../../../assert'; export class TaskFormsApi extends BaseApi { /** * Complete a task form - * * @param taskId taskId * @param completeTaskFormRepresentation completeTaskFormRepresentation * @return Promise<{}> @@ -53,7 +52,6 @@ export class TaskFormsApi extends BaseApi { /** * Get task variables - * * @param taskId taskId * @return Promise */ @@ -73,7 +71,6 @@ export class TaskFormsApi extends BaseApi { /** * Retrieve Column Field Values * Specific case to retrieve information on a specific column - * * @param taskId taskId * @param field field * @param column column @@ -110,7 +107,6 @@ export class TaskFormsApi extends BaseApi { * Retrieve populated field values * * Form field values that are populated through a REST backend, can be retrieved via this service - * * @param taskId taskId * @param field field * @return Promise @@ -132,7 +128,6 @@ export class TaskFormsApi extends BaseApi { /** * Get a task form - * * @param taskId taskId * @returns Promise */ @@ -151,7 +146,6 @@ export class TaskFormsApi extends BaseApi { /** * Save a task form - * * @param taskId taskId * @param saveTaskFormRepresentation saveTaskFormRepresentation * @return Promise<{}> @@ -173,7 +167,6 @@ export class TaskFormsApi extends BaseApi { /** * Retrieve Task Form Variables - * * @param taskId taskId */ getTaskFormVariables(taskId: string) { diff --git a/lib/js-api/src/api/activiti-rest-api/api/taskVariables.api.ts b/lib/js-api/src/api/activiti-rest-api/api/taskVariables.api.ts index ee3fdd9c635..7eb749fce6e 100644 --- a/lib/js-api/src/api/activiti-rest-api/api/taskVariables.api.ts +++ b/lib/js-api/src/api/activiti-rest-api/api/taskVariables.api.ts @@ -26,7 +26,6 @@ import { ScopeQuery } from './types'; export class TaskVariablesApi extends BaseApi { /** * Create variables - * * @param taskId taskId * @param restVariables restVariables * @return Promise @@ -48,7 +47,6 @@ export class TaskVariablesApi extends BaseApi { /** * Create or update variables - * * @param taskId taskId * @return Promise<{}> */ @@ -67,7 +65,6 @@ export class TaskVariablesApi extends BaseApi { /** * Delete a variable - * * @param taskId taskId * @param variableName variableName * @param opts Optional parameters @@ -90,7 +87,6 @@ export class TaskVariablesApi extends BaseApi { } /** * Get a variable - * * @param taskId taskId * @param variableName variableName * @param opts Optional parameters @@ -114,7 +110,6 @@ export class TaskVariablesApi extends BaseApi { /** * List variables - * * @param taskId taskId * @param opts Optional parameters * @return Promise @@ -135,7 +130,6 @@ export class TaskVariablesApi extends BaseApi { /** * Update a variable - * * @param taskId taskId * @param variableName variableName * @param restVariable restVariable diff --git a/lib/js-api/src/api/activiti-rest-api/api/tasks.api.ts b/lib/js-api/src/api/activiti-rest-api/api/tasks.api.ts index d4ae737e530..086b091e82f 100644 --- a/lib/js-api/src/api/activiti-rest-api/api/tasks.api.ts +++ b/lib/js-api/src/api/activiti-rest-api/api/tasks.api.ts @@ -34,7 +34,6 @@ import { throwIfNotDefined } from '../../../assert'; export class TasksApi extends BaseApi { /** * List the users and groups involved with a task - * * @param taskId taskId * @param identityLinkRepresentation identityLinkRepresentation * @returns Promise @@ -58,7 +57,6 @@ export class TasksApi extends BaseApi { * Create a standalone task * * A standalone task is one which is not associated with any process instance. - * * @param taskRepresentation taskRepresentation * @returns Promise */ @@ -74,7 +72,6 @@ export class TasksApi extends BaseApi { /** * Remove a user or group involvement from a task - * * @param taskId taskId * @param family family * @param identityId identityId @@ -102,7 +99,6 @@ export class TasksApi extends BaseApi { /** * Delete a task - * * @param taskId taskId * @returns Promise<{}> */ @@ -121,7 +117,6 @@ export class TasksApi extends BaseApi { /** * Filter a list of tasks - * * @param tasksFilter tasksFilter * @returns Promise */ @@ -137,7 +132,6 @@ export class TasksApi extends BaseApi { /** * Get a user or group involvement with a task - * * @param taskId taskId * @param family family * @param identityId identityId @@ -165,7 +159,6 @@ export class TasksApi extends BaseApi { /** * List either the users or groups involved with a process instance - * * @param taskId taskId * @param family family * @returns Promise @@ -187,7 +180,6 @@ export class TasksApi extends BaseApi { /** * getIdentityLinks - * * @param taskId taskId * @returns Promise */ @@ -206,7 +198,6 @@ export class TasksApi extends BaseApi { /** * Get the audit log for a task - * * @param taskId taskId * @returns Promise */ @@ -225,7 +216,6 @@ export class TasksApi extends BaseApi { /** * Get the audit log for a task - * * @param taskId taskId * @returns Promise task audit in blob */ @@ -246,7 +236,6 @@ export class TasksApi extends BaseApi { /** * Get a task - * * @param taskId taskId * @returns Promise */ @@ -266,7 +255,6 @@ export class TasksApi extends BaseApi { /** * Query historic tasks - * * @param queryRequest queryRequest * @returns Promise */ @@ -282,7 +270,6 @@ export class TasksApi extends BaseApi { /** * List tasks - * * @param tasksQuery tasksQuery * @returns Promise */ @@ -300,7 +287,6 @@ export class TasksApi extends BaseApi { * Update a task * * You can edit only name, description and dueDate (ISO 8601 string). - * * @param taskId taskId * @param updated updated * @returns Promise diff --git a/lib/js-api/src/api/activiti-rest-api/api/temporary.api.ts b/lib/js-api/src/api/activiti-rest-api/api/temporary.api.ts index 1d322cb750f..a36bece71b6 100755 --- a/lib/js-api/src/api/activiti-rest-api/api/temporary.api.ts +++ b/lib/js-api/src/api/activiti-rest-api/api/temporary.api.ts @@ -23,7 +23,6 @@ import { BaseApi } from './base.api'; export class TemporaryApi extends BaseApi { /** * completeTasks - * * @param userId userId * @param processDefinitionKey processDefinitionKey */ @@ -51,7 +50,6 @@ export class TemporaryApi extends BaseApi { /** * generateData - * * @param userId userId * @param processDefinitionKey processDefinitionKey */ diff --git a/lib/js-api/src/api/activiti-rest-api/api/userFilters.api.ts b/lib/js-api/src/api/activiti-rest-api/api/userFilters.api.ts index 2c960f6c60f..35587c69f46 100644 --- a/lib/js-api/src/api/activiti-rest-api/api/userFilters.api.ts +++ b/lib/js-api/src/api/activiti-rest-api/api/userFilters.api.ts @@ -32,7 +32,6 @@ import { AppIdQuery } from './types'; export class UserFiltersApi extends BaseApi { /** * Create a process instance filter - * * @param userProcessInstanceFilterRepresentation userProcessInstanceFilterRepresentation * @returns Promise */ @@ -49,7 +48,6 @@ export class UserFiltersApi extends BaseApi { /** * Create a task filter - * * @param userTaskFilterRepresentation userTaskFilterRepresentation * @returns Promise */ @@ -65,7 +63,6 @@ export class UserFiltersApi extends BaseApi { /** * Delete a process instance filter - * * @param userFilterId userFilterId * @returns Promise<{}> */ @@ -84,7 +81,6 @@ export class UserFiltersApi extends BaseApi { /** * Delete a task filter - * * @param userFilterId userFilterId * @returns Promise<{}> */ @@ -103,7 +99,6 @@ export class UserFiltersApi extends BaseApi { /** * Get a process instance filter - * * @param userFilterId userFilterId * @returns Promise */ @@ -124,7 +119,6 @@ export class UserFiltersApi extends BaseApi { * List process instance filters * * Returns filters for the current user, optionally filtered by *appId*. - * * @param opts Optional parameters * @returns Promise */ @@ -137,7 +131,6 @@ export class UserFiltersApi extends BaseApi { /** * Get a task filter - * * @param userFilterId userFilterId * @returns Promise */ @@ -159,7 +152,6 @@ export class UserFiltersApi extends BaseApi { * List task filters * * Returns filters for the current user, optionally filtered by *appId*. - * * @param opts Optional parameters * @returns Promise */ @@ -173,7 +165,6 @@ export class UserFiltersApi extends BaseApi { /** * Re-order the list of user process instance filters - * * @param filterOrderRepresentation filterOrderRepresentation * @returns Promise<{}> */ @@ -188,7 +179,6 @@ export class UserFiltersApi extends BaseApi { /** * Re-order the list of user task filters - * * @param filterOrderRepresentation filterOrderRepresentation * @returns Promise<{}> */ @@ -203,7 +193,6 @@ export class UserFiltersApi extends BaseApi { /** * Update a process instance filter - * * @param userFilterId userFilterId * @param userProcessInstanceFilterRepresentation userProcessInstanceFilterRepresentation * @returns Promise @@ -228,7 +217,6 @@ export class UserFiltersApi extends BaseApi { /** * Update a task filter - * * @param userFilterId userFilterId * @param userTaskFilterRepresentation userTaskFilterRepresentation * @returns Promise diff --git a/lib/js-api/src/api/activiti-rest-api/api/userProfile.api.ts b/lib/js-api/src/api/activiti-rest-api/api/userProfile.api.ts index 24c8b1ff4a1..000c44e0338 100644 --- a/lib/js-api/src/api/activiti-rest-api/api/userProfile.api.ts +++ b/lib/js-api/src/api/activiti-rest-api/api/userProfile.api.ts @@ -27,7 +27,6 @@ import { throwIfNotDefined } from '../../../assert'; export class UserProfileApi extends BaseApi { /** * Change user password - * * @param changePasswordRepresentation changePasswordRepresentation * @return Promise<{}> */ @@ -43,7 +42,6 @@ export class UserProfileApi extends BaseApi { /** * Retrieve user profile picture * Generally returns an image file - * * @return Promise */ getProfilePicture(): Promise { @@ -65,7 +63,6 @@ export class UserProfileApi extends BaseApi { * Get user profile * This operation returns account information for the current user. * This is useful to get the name, email, the groups that the user is part of, the user picture, etc. - * * @return Promise */ getProfile(): Promise { @@ -78,7 +75,6 @@ export class UserProfileApi extends BaseApi { /** * Update user profile. * Only a first name, last name, email and company can be updated - * * @param userRepresentation userRepresentation * @return Promise */ @@ -94,7 +90,6 @@ export class UserProfileApi extends BaseApi { /** * Change user profile picture - * * @param file file * @return Promise */ diff --git a/lib/js-api/src/api/activiti-rest-api/api/users.api.ts b/lib/js-api/src/api/activiti-rest-api/api/users.api.ts index 350e8a140d4..0fbb823102d 100644 --- a/lib/js-api/src/api/activiti-rest-api/api/users.api.ts +++ b/lib/js-api/src/api/activiti-rest-api/api/users.api.ts @@ -41,7 +41,6 @@ export class UsersApi extends BaseApi { * Execute an action for a specific user * * Typical action is updating/reset password - * * @param userId userId * @param actionRequest actionRequest * @returns Promise<{}> @@ -63,7 +62,6 @@ export class UsersApi extends BaseApi { /** * Stream user profile picture - * * @param userId userId * @returns Promise<{}> */ @@ -73,7 +71,6 @@ export class UsersApi extends BaseApi { /** * Get a user - * * @param userId userId * @returns Promise */ @@ -95,7 +92,6 @@ export class UsersApi extends BaseApi { * Query users * * A common use case is that a user wants to select another user (eg. when assigning a task) or group. - * * @param opts Optional parameters * @returns Promise */ @@ -121,7 +117,6 @@ export class UsersApi extends BaseApi { /** * Request a password reset - * * @param resetPassword resetPassword * @returns Promise<{}> */ @@ -136,7 +131,6 @@ export class UsersApi extends BaseApi { /** * Update a user - * * @param userId userId * @param userRequest userRequest * @returns Promise diff --git a/lib/js-api/src/api/auth-rest-api/api/authentication.api.ts b/lib/js-api/src/api/auth-rest-api/api/authentication.api.ts index cb4692124a6..4de237f8678 100644 --- a/lib/js-api/src/api/auth-rest-api/api/authentication.api.ts +++ b/lib/js-api/src/api/auth-rest-api/api/authentication.api.ts @@ -29,7 +29,6 @@ export class AuthenticationApi extends BaseApi { * Create ticket (login) * * **Note:** this endpoint is available in Alfresco 5.2 and newer versions. - * * @param ticketBodyCreate The user credential. * @returns Promise */ @@ -45,7 +44,6 @@ export class AuthenticationApi extends BaseApi { /** * Get ticket (login) - * * @returns Promise */ getTicket(): Promise { @@ -59,7 +57,6 @@ export class AuthenticationApi extends BaseApi { * Delete ticket (logout) * * **Note:** this endpoint is available in Alfresco 5.2 and newer versions. - * * @returns Promise<{}> */ deleteTicket(): Promise { @@ -77,7 +74,6 @@ export class AuthenticationApi extends BaseApi { * For example, you can pass the Authorization request header using Javascript: * Javascript * request.setRequestHeader (\"Authorization\", \"Basic \" + btoa(ticket)); - * * @returns Promise */ validateTicket(): Promise { diff --git a/lib/js-api/src/api/content-custom-api/api/classes.api.ts b/lib/js-api/src/api/content-custom-api/api/classes.api.ts index 0d878060db6..f919ba267a8 100755 --- a/lib/js-api/src/api/content-custom-api/api/classes.api.ts +++ b/lib/js-api/src/api/content-custom-api/api/classes.api.ts @@ -24,7 +24,6 @@ import { BaseApi } from './base.api'; export class ClassesApi extends BaseApi { /** * Gets the class information for the specified className. - * * @param className The identifier of the class. * @returns a Promise, with data of type ClassDescription */ diff --git a/lib/js-api/src/api/content-custom-api/api/content.api.ts b/lib/js-api/src/api/content-custom-api/api/content.api.ts index 4da2a85ad95..604b21ce537 100644 --- a/lib/js-api/src/api/content-custom-api/api/content.api.ts +++ b/lib/js-api/src/api/content-custom-api/api/content.api.ts @@ -18,125 +18,159 @@ import { BaseApi } from './base.api'; export class ContentApi extends BaseApi { - /** * Get thumbnail URL for the given nodeId - * * @param nodeId The ID of the document node - * @param [attachment=false] Retrieve content as an attachment for download + * @param [attachment] Retrieve content as an attachment for download * @param [ticket] Custom ticket to use for authentication * @returns The URL address pointing to the content. */ getDocumentThumbnailUrl(nodeId: string, attachment?: boolean, ticket?: string): string { - return this.apiClient.basePath + '/nodes/' + nodeId + + return ( + this.apiClient.basePath + + '/nodes/' + + nodeId + '/renditions/doclib/content' + - '?attachment=' + (attachment ? 'true' : 'false') + - this.apiClient.getAlfTicket(ticket); + '?attachment=' + + (attachment ? 'true' : 'false') + + this.apiClient.getAlfTicket(ticket) + ); } /** * Get preview URL for the given nodeId - * * @param nodeId The ID of the document node - * @param [attachment=false] Retrieve content as an attachment for download + * @param [attachment] Retrieve content as an attachment for download * @param [ticket] Custom ticket to use for authentication * @returns The URL address pointing to the content. */ getDocumentPreviewUrl(nodeId: string, attachment?: boolean, ticket?: string): string { - return this.apiClient.basePath + '/nodes/' + nodeId + + return ( + this.apiClient.basePath + + '/nodes/' + + nodeId + '/renditions/imgpreview/content' + - '?attachment=' + (attachment ? 'true' : 'false') + - this.apiClient.getAlfTicket(ticket); + '?attachment=' + + (attachment ? 'true' : 'false') + + this.apiClient.getAlfTicket(ticket) + ); } /** * Get content URL for the given nodeId - * * @param nodeId The ID of the document node - * @param [attachment=false] Retrieve content as an attachment for download + * @param [attachment] Retrieve content as an attachment for download * @param [ticket] Custom ticket to use for authentication * @returns The URL address pointing to the content. */ getContentUrl(nodeId: string, attachment?: boolean, ticket?: string): string { - return this.apiClient.basePath + '/nodes/' + nodeId + + return ( + this.apiClient.basePath + + '/nodes/' + + nodeId + '/content' + - '?attachment=' + (attachment ? 'true' : 'false') + - this.apiClient.getAlfTicket(ticket); + '?attachment=' + + (attachment ? 'true' : 'false') + + this.apiClient.getAlfTicket(ticket) + ); } /** * Get rendition URL for the given nodeId - * * @param nodeId The ID of the document node * @param encoding of the document - * @param [attachment=false] retrieve content as an attachment for download + * @param [attachment] retrieve content as an attachment for download * @param [ticket] Custom ticket to use for authentication * @returns The URL address pointing to the content. */ getRenditionUrl(nodeId: string, encoding: string, attachment?: boolean, ticket?: string): string { - return this.apiClient.basePath + '/nodes/' + nodeId + - '/renditions/' + encoding + '/content' + - '?attachment=' + (attachment ? 'true' : 'false') + - this.apiClient.getAlfTicket(ticket); + return ( + this.apiClient.basePath + + '/nodes/' + + nodeId + + '/renditions/' + + encoding + + '/content' + + '?attachment=' + + (attachment ? 'true' : 'false') + + this.apiClient.getAlfTicket(ticket) + ); } /** * Get version's rendition URL for the given nodeId - * * @param nodeId The ID of the document node * @param versionId The ID of the version * @param encoding of the document - * @param [attachment=false] retrieve content as an attachment for download + * @param [attachment] retrieve content as an attachment for download * @param [ticket] Custom ticket to use for authentication * @returns The URL address pointing to the content. */ getVersionRenditionUrl(nodeId: string, versionId: string, encoding: string, attachment?: boolean, ticket?: string): string { - return this.apiClient.basePath + '/nodes/' + nodeId + '/versions/' + versionId + - '/renditions/' + encoding + '/content' + - '?attachment=' + (attachment ? 'true' : 'false') + - this.apiClient.getAlfTicket(ticket); + return ( + this.apiClient.basePath + + '/nodes/' + + nodeId + + '/versions/' + + versionId + + '/renditions/' + + encoding + + '/content' + + '?attachment=' + + (attachment ? 'true' : 'false') + + this.apiClient.getAlfTicket(ticket) + ); } /** * Get content URL for the given nodeId and versionId - * * @param nodeId The ID of the document node * @param versionId The ID of the version - * @param [attachment=false] Retrieve content as an attachment for download + * @param [attachment] Retrieve content as an attachment for download * @param [ticket] Custom ticket to use for authentication * @returns The URL address pointing to the content. */ getVersionContentUrl(nodeId: string, versionId: string, attachment?: boolean, ticket?: string): string { - return this.apiClient.basePath + '/nodes/' + nodeId + - '/versions/' + versionId + '/content' + - '?attachment=' + (attachment ? 'true' : 'false') + - this.apiClient.getAlfTicket(ticket); + return ( + this.apiClient.basePath + + '/nodes/' + + nodeId + + '/versions/' + + versionId + + '/content' + + '?attachment=' + + (attachment ? 'true' : 'false') + + this.apiClient.getAlfTicket(ticket) + ); } /** * Get content url for the given shared link id - * * @param linkId - The ID of the shared link - * @param [attachment=false] Retrieve content as an attachment for download + * @param [attachment] Retrieve content as an attachment for download * @returns The URL address pointing to the content. */ getSharedLinkContentUrl(linkId: string, attachment?: boolean): string { - return this.apiClient.basePath + '/shared-links/' + linkId + - '/content' + - '?attachment=' + (attachment ? 'true' : 'false'); + return this.apiClient.basePath + '/shared-links/' + linkId + '/content' + '?attachment=' + (attachment ? 'true' : 'false'); } /** * Gets the rendition content for file with shared link identifier sharedId. - * * @param sharedId - The identifier of a shared link to a file. * @param renditionId - The name of a thumbnail rendition, for example doclib, or pdf. - * @param [attachment=false] Retrieve content as an attachment for download + * @param [attachment] Retrieve content as an attachment for download * @returns The URL address pointing to the content. */ getSharedLinkRenditionUrl(sharedId: string, renditionId: string, attachment?: boolean): string { - return this.apiClient.basePath + '/shared-links/' + sharedId + - '/renditions/' + renditionId + '/content' + - '?attachment=' + (attachment ? 'true' : 'false'); + return ( + this.apiClient.basePath + + '/shared-links/' + + sharedId + + '/renditions/' + + renditionId + + '/content' + + '?attachment=' + + (attachment ? 'true' : 'false') + ); } } diff --git a/lib/js-api/src/api/content-custom-api/api/webscript.api.ts b/lib/js-api/src/api/content-custom-api/api/webscript.api.ts index c7bcd3d4dbf..89e2d4003a7 100644 --- a/lib/js-api/src/api/content-custom-api/api/webscript.api.ts +++ b/lib/js-api/src/api/content-custom-api/api/webscript.api.ts @@ -27,7 +27,6 @@ export class WebscriptApi extends BaseApi { * Call a get on a Web Scripts see https://wiki.alfresco.com/wiki/Web_Scripts for more details about Web Scripts * Url syntax definition : http[s]://:/[/]/[/][?] * example: http://localhost:8081/share/service/mytasks?priority=1 - * * @param httpMethod GET, POST, PUT and DELETE * @param scriptPath script path * @param scriptArgs script arguments diff --git a/lib/js-api/src/api/content-custom-api/model/dateAlfresco.ts b/lib/js-api/src/api/content-custom-api/model/dateAlfresco.ts index b38a7ab7001..0890f18f4b6 100644 --- a/lib/js-api/src/api/content-custom-api/model/dateAlfresco.ts +++ b/lib/js-api/src/api/content-custom-api/model/dateAlfresco.ts @@ -18,7 +18,6 @@ export class DateAlfresco extends Date { /** * Parses an ISO-8601 string representation of a date value. - * * @param dateToConvert The date value as a string. * @returns The parsed date object. */ @@ -41,7 +40,6 @@ export class DateAlfresco extends Date { /** * Parses the date component of a ISO-8601 string representation of a date value. - * * @param dateToConvert The date value as a string. * @returns The parsed date object. */ @@ -50,7 +48,7 @@ export class DateAlfresco extends Date { // return new Date(str.replace(/T/i, ' ')); // Compatible with Safari 9.1.2 - const dateParts = dateToConvert.split(/[^0-9]/).map(function(s) { + const dateParts = dateToConvert.split(/[^0-9]/).map(function (s) { return parseInt(s, 10); }); return new Date( @@ -68,7 +66,6 @@ export class DateAlfresco extends Date { /** * Parses the timezone component of a ISO-8601 string representation of a date value. - * * @param dateToConvert The timezone offset as a string, e.g. '+0000', '+2000' or '-0500'. * @returns The number of minutes offset from UTC. */ diff --git a/lib/js-api/src/api/content-rest-api/api/actions.api.ts b/lib/js-api/src/api/content-rest-api/api/actions.api.ts index 3fd446eaf27..db43d640b52 100644 --- a/lib/js-api/src/api/content-rest-api/api/actions.api.ts +++ b/lib/js-api/src/api/content-rest-api/api/actions.api.ts @@ -29,7 +29,6 @@ export class ActionsApi extends BaseApi { * Retrieve the details of an action definition * * **Note:** this endpoint is available in Alfresco 5.2 and newer versions. - * * @param actionDefinitionId The identifier of an action definition. * @returns Promise */ @@ -50,7 +49,6 @@ export class ActionsApi extends BaseApi { * Execute an action * * **Note:** this endpoint is available in Alfresco 5.2 and newer versions. - * * @param actionBodyExec Action execution details * @returns Promise */ @@ -76,8 +74,6 @@ export class ActionsApi extends BaseApi { * You can use any of the following fields to order the results: * - name * - title - * - * * @param opts Optional parameters * @param opts.orderBy A string to control the order of the entities returned in a list. You can use the **orderBy** parameter to * sort the list by one or more fields. @@ -114,7 +110,6 @@ export class ActionsApi extends BaseApi { * You can use any of the following fields to order the results: * - name * - title - * * @param nodeId The identifier of a node. * @param opts Optional parameters * @param opts.orderBy A string to control the order of the entities returned in a list. You can use the **orderBy** parameter to diff --git a/lib/js-api/src/api/content-rest-api/api/activities.api.ts b/lib/js-api/src/api/content-rest-api/api/activities.api.ts index d36d7523511..fc4b2b50b83 100644 --- a/lib/js-api/src/api/content-rest-api/api/activities.api.ts +++ b/lib/js-api/src/api/content-rest-api/api/activities.api.ts @@ -30,7 +30,6 @@ export class ActivitiesApi extends BaseApi { * * Gets a list of activities for person **personId**. * You can use the -me- string in place of to specify the currently authenticated user. - * * @param personId The identifier of a person. * @param opts Optional parameters * @param opts.who A filter to include the user's activities only me, other user's activities only others' diff --git a/lib/js-api/src/api/content-rest-api/api/agents.api.ts b/lib/js-api/src/api/content-rest-api/api/agents.api.ts index b00ef0a5589..ebc0bc27e55 100644 --- a/lib/js-api/src/api/content-rest-api/api/agents.api.ts +++ b/lib/js-api/src/api/content-rest-api/api/agents.api.ts @@ -25,7 +25,6 @@ import { BaseApi } from '../../hxi-connector-api/api/base.api'; export class AgentsApi extends BaseApi { /** * Gets all agents. - * * @returns AgentPaging object containing the agents. */ getAgents(): Promise { diff --git a/lib/js-api/src/api/content-rest-api/api/audit.api.ts b/lib/js-api/src/api/content-rest-api/api/audit.api.ts index 3c696b93313..bd39792cec4 100644 --- a/lib/js-api/src/api/content-rest-api/api/audit.api.ts +++ b/lib/js-api/src/api/content-rest-api/api/audit.api.ts @@ -37,7 +37,6 @@ export class AuditApi extends BaseApi { * - where=(createdAt BETWEEN ('2017-06-02T12:13:51.593+01:00' , '2017-06-04T10:05:16.536+01:00') * - where=(id BETWEEN ('1234', '4321') * You must have admin rights to delete audit information. - * * @param auditApplicationId The identifier of an audit application. * @param where Audit entries to permanently delete for an audit application, given an inclusive time period or range of ids. For example: * - where=(createdAt BETWEEN ('2017-06-02T12:13:51.593+01:00' , '2017-06-04T10:05:16.536+01:00') @@ -68,7 +67,6 @@ export class AuditApi extends BaseApi { * * **Note:** this endpoint is available in Alfresco 5.2.2 and newer versions. * You must have admin rights to delete audit information. - * * @param auditApplicationId The identifier of an audit application. * @param auditEntryId The identifier of an audit entry. * @return Promise<{}> @@ -95,7 +93,6 @@ export class AuditApi extends BaseApi { * You must have admin rights to retrieve audit information. * * You can use the **include** parameter to return the minimum and/or maximum audit record id for the application. - * * @param auditApplicationId The identifier of an audit application. * @param opts Optional parameters * @return Promise @@ -124,7 +121,6 @@ export class AuditApi extends BaseApi { * * **Note:** this endpoint is available in Alfresco 5.2.2 and newer versions. * You must have admin rights to access audit information. - * * @param auditApplicationId The identifier of an audit application. * @param auditEntryId The identifier of an audit entry. * @param opts Optional parameters @@ -164,7 +160,6 @@ export class AuditApi extends BaseApi { * - Alfresco Sync Service (used by Enterprise Cloud Sync) * * You must have admin rights to retrieve audit information. - * * @param opts Optional parameters * @return Promise */ @@ -201,7 +196,6 @@ export class AuditApi extends BaseApi { * * For example, specifying orderBy=createdAt DESC returns audit entries in descending **createdAt** order. * You must have admin rights to retrieve audit information. - * * @param auditApplicationId The identifier of an audit application. * @param opts Optional parameters * @param opts.orderBy A string to control the order of the entities returned in a list. You can use the **orderBy** parameter to @@ -262,7 +256,6 @@ export class AuditApi extends BaseApi { * * For example, specifying orderBy=createdAt DESC returns audit entries in descending **createdAt** order. * This relies on the pre-configured 'alfresco-access' audit application. - * * @param nodeId The identifier of a node. * @param opts Optional parameters * @param opts.orderBy A string to control the order of the entities returned in a list. You can use the **orderBy** parameter to @@ -319,7 +312,6 @@ export class AuditApi extends BaseApi { * Note, it is still possible to query &/or delete any existing audit entries even * if auditing is disabled for the audit application. * You must have admin rights to update audit application. - * * @param auditApplicationId The identifier of an audit application. * @param auditAppBodyUpdate The audit application to update. * @param opts Optional parameters diff --git a/lib/js-api/src/api/content-rest-api/api/categories.api.ts b/lib/js-api/src/api/content-rest-api/api/categories.api.ts index 9afa7ac0189..adfbe88dc48 100644 --- a/lib/js-api/src/api/content-rest-api/api/categories.api.ts +++ b/lib/js-api/src/api/content-rest-api/api/categories.api.ts @@ -34,7 +34,6 @@ export class CategoriesApi extends BaseApi { * The parameter categoryId can be set to the alias -root- to obtain a list of top level categories. * * You can use the **include** parameter to return additional **values** information. - * * @param categoryId The identifier of a category. * @param opts Optional parameters * @returns Promise @@ -66,7 +65,6 @@ export class CategoriesApi extends BaseApi { * * Get a specific category with categoryId. * You can use the **include** parameter to return additional **values** information. - * * @param categoryId The identifier of a category. * @param opts Optional parameters * @returns Promise @@ -93,7 +91,6 @@ export class CategoriesApi extends BaseApi { /** * List of categories that node is assigned to - * * @param nodeId The identifier of a node. * @param opts Optional parameters * @returns Promise @@ -125,7 +122,6 @@ export class CategoriesApi extends BaseApi { * * This will cause everything to be removed from the category. * You must have admin rights to delete a category. - * * @param categoryId The identifier of a category. * @returns Promise<{}> */ @@ -144,7 +140,6 @@ export class CategoriesApi extends BaseApi { /** * Unassign a node from category - * * @param nodeId The identifier of a node. * @param categoryId The identifier of a category. * @returns Promise<{}> @@ -169,7 +164,6 @@ export class CategoriesApi extends BaseApi { * * Updates the category **categoryId**. * You must have admin rights to update a category. - * * @param categoryId The identifier of a category. * @param categoryBodyUpdate The updated category * @param opts Optional parameters @@ -203,7 +197,6 @@ export class CategoriesApi extends BaseApi { * Creates new categories within the category **categoryId**. * The parameter categoryId can be set to the alias -root- to create a new top level category. * You must have admin rights to create a category. - * * @param categoryId The identifier of a category. * @param categoryBodyCreate List of categories to create. * @param opts Optional parameters. @@ -233,7 +226,6 @@ export class CategoriesApi extends BaseApi { /** * Assign a node to a category - * * @param nodeId The identifier of a node. * @param categoryLinkBodyCreate The new category link * @param opts Optional parameters diff --git a/lib/js-api/src/api/content-rest-api/api/comments.api.ts b/lib/js-api/src/api/content-rest-api/api/comments.api.ts index d8e5de76dc0..ad3b7490771 100644 --- a/lib/js-api/src/api/content-rest-api/api/comments.api.ts +++ b/lib/js-api/src/api/content-rest-api/api/comments.api.ts @@ -29,7 +29,6 @@ import { ContentFieldsQuery, ContentPagingQuery } from './types'; export class CommentsApi extends BaseApi { /** * Create a comment - * * @param nodeId The identifier of a node. * @param commentBodyCreate The comment text. Note that you can also provide a list of comments. * @param opts Optional parameters @@ -58,7 +57,6 @@ export class CommentsApi extends BaseApi { /** * Delete a comment - * * @param nodeId The identifier of a node. * @param commentId The identifier of a comment. * @returns Promise<{}> @@ -82,7 +80,6 @@ export class CommentsApi extends BaseApi { * List comments * * Gets a list of comments for the node **nodeId**, sorted chronologically with the newest comment first. - * * @param nodeId The identifier of a node. * @param opts Optional parameters * @returns Promise @@ -110,7 +107,6 @@ export class CommentsApi extends BaseApi { /** * Update a comment - * * @param nodeId The identifier of a node. * @param commentId The identifier of a comment. * @param commentBodyUpdate The JSON representing the comment to be updated. diff --git a/lib/js-api/src/api/content-rest-api/api/downloads.api.ts b/lib/js-api/src/api/content-rest-api/api/downloads.api.ts index 353f08ec903..c32f7d2618d 100644 --- a/lib/js-api/src/api/content-rest-api/api/downloads.api.ts +++ b/lib/js-api/src/api/content-rest-api/api/downloads.api.ts @@ -36,7 +36,6 @@ export class DownloadsApi extends BaseApi { * By default, if the download node is not deleted it will be picked up by a cleaner job which removes download nodes older than a configurable amount of time (default is 1 hour) * Information about the existing progress at the time of cancelling can be retrieved by calling the **GET /downloads/{downloadId}** endpoint * The cancel operation is done asynchronously. - * * @param downloadId The identifier of a download node. * @returns Promise<{}> */ @@ -58,7 +57,6 @@ export class DownloadsApi extends BaseApi { * * **Note:** this endpoint is available in Alfresco 5.2.1 and newer versions. * **Note:** The content of the download node can be obtained using the **GET /nodes/{downloadId}/content** endpoint - * * @param downloadBodyCreate The nodeIds the content of which will be zipped, which zip will be set as the content of our download node. * @param opts Optional parameters * @param opts.fields A list of field names. You can use this parameter to restrict the fields @@ -86,7 +84,6 @@ export class DownloadsApi extends BaseApi { * Get a download * * **Note:** this endpoint is available in Alfresco 5.2.1 and newer versions. - * * @param downloadId The identifier of a download node. * @param opts Optional parameters * @param opts.fields A list of field names. You can use this parameter to restrict the fields diff --git a/lib/js-api/src/api/content-rest-api/api/favorites.api.ts b/lib/js-api/src/api/content-rest-api/api/favorites.api.ts index 6d317601033..ff1a7a9d8e1 100644 --- a/lib/js-api/src/api/content-rest-api/api/favorites.api.ts +++ b/lib/js-api/src/api/content-rest-api/api/favorites.api.ts @@ -30,7 +30,6 @@ export class FavoritesApi extends BaseApi { * * Favorite a **site**, **file**, or **folder** in the repository. * You can use the -me- string in place of to specify the currently authenticated user. - * * @param personId The identifier of a person. * @param favoriteBodyCreate An object identifying the entity to be favorited. * The object consists of a single property which is an object with the name site, file, or folder. @@ -76,7 +75,6 @@ export class FavoritesApi extends BaseApi { * Create a site favorite * * **Note:** this endpoint is deprecated as of Alfresco 4.2, and will be removed in the future. Use /people/{personId}/favorites instead. - * * @param personId The identifier of a person. * @param favoriteSiteBodyCreate The id of the site to favorite. * @param opts Optional parameters @@ -106,7 +104,6 @@ export class FavoritesApi extends BaseApi { * Delete a favorite * * You can use the -me- string in place of to specify the currently authenticated user. - * * @param personId The identifier of a person. * @param favoriteId The identifier of a favorite. * @returns Promise<{}> @@ -133,7 +130,6 @@ export class FavoritesApi extends BaseApi { * Use /people/{personId}/favorites/{favoriteId} instead. * * You can use the -me- string in place of to specify the currently authenticated user. - * * @param personId The identifier of a person. * @param siteId The identifier of a site. * @returns Promise<{}> @@ -158,7 +154,6 @@ export class FavoritesApi extends BaseApi { * * Gets favorite **favoriteId** for person **personId**. * You can use the -me- string in place of to specify the currently authenticated user. - * * @param personId The identifier of a person. * @param favoriteId The identifier of a favorite. * @param opts Optional parameters @@ -201,7 +196,6 @@ export class FavoritesApi extends BaseApi { * Use /people/{personId}/favorites/{favoriteId} instead. * * You can use the -me- string in place of to specify the currently authenticated user. - * * @param personId The identifier of a person. * @param siteId The identifier of a site. * @param opts Optional parameters @@ -240,7 +234,6 @@ export class FavoritesApi extends BaseApi { * Use /people/{personId}/favorites instead. * * You can use the -me- string in place of to specify the currently authenticated user. - * * @param personId The identifier of a person. * @param opts Optional parameters * @returns Promise @@ -271,7 +264,6 @@ export class FavoritesApi extends BaseApi { * * Gets a list of favorites for person **personId**. * You can use the -me- string in place of to specify the currently authenticated user. - * * @param personId The identifier of a person. * @param opts optional parameters * @returns Promise diff --git a/lib/js-api/src/api/content-rest-api/api/groups.api.ts b/lib/js-api/src/api/content-rest-api/api/groups.api.ts index 9d00994a7c0..2b0c9c996f7 100644 --- a/lib/js-api/src/api/content-rest-api/api/groups.api.ts +++ b/lib/js-api/src/api/content-rest-api/api/groups.api.ts @@ -75,7 +75,6 @@ export class GroupsApi extends BaseApi { * The group will be created in the **APP.DEFAULT** and **AUTH.ALF** zones. * * You must have admin rights to create a group. - * * @param groupBodyCreate The group to create. * @param opts Optional parameters * @returns Promise @@ -104,7 +103,6 @@ export class GroupsApi extends BaseApi { * If the added group was previously a root group then it becomes a non-root group since it now has a parent. * It is an error to specify an **id** that does not exist. * You must have admin rights to create a group membership. - * * @param groupId The identifier of a group. * @param groupMembershipBodyCreate The group membership to add (person or sub-group). * @param opts Optional parameters @@ -140,7 +138,6 @@ export class GroupsApi extends BaseApi { * In this case, removing a group member does not delete the person or sub-group itself. * If a removed sub-group no longer has any parent groups then it becomes a root group. * You must have admin rights to delete a group. - * * @param groupId The identifier of a group. * @param opts Optional parameters * @returns Promise @@ -174,7 +171,6 @@ export class GroupsApi extends BaseApi { * Delete group member **groupMemberId** (person or sub-group) from group **groupId**. * Removing a group member does not delete the person or sub-group itself.\ * If a removed sub-group no longer has any parent groups then it becomes a root group. - * * @param groupId The identifier of a group. * @param groupMemberId The identifier of a person or group. * @returns Promise<{}> @@ -201,7 +197,6 @@ export class GroupsApi extends BaseApi { * * Get details for group **groupId**. * You can use the **include** parameter to return additional information. - * * @param groupId The identifier of a group. * @param opts Optional parameters * @returns Promise @@ -241,7 +236,6 @@ export class GroupsApi extends BaseApi { * You can override the default by using the **orderBy** parameter. You can specify one of the following fields in the **orderBy** parameter: * - id * - displayName - * * @param groupId The identifier of a group. * @param opts Optional parameters * @returns Promise @@ -273,7 +267,6 @@ export class GroupsApi extends BaseApi { * List group memberships * * **Note:** this endpoint is available in Alfresco 5.2.1 and newer versions. - * * @param personId The identifier of a person. * @param opts Optional parameters * @param opts.skipCount The number of entities that exist in the collection before those included in this list. @@ -327,7 +320,6 @@ export class GroupsApi extends BaseApi { * List groups * * **Note:** this endpoint is available in Alfresco 5.2.1 and newer versions. - * * @param opts Optional parameters * @returns Promise */ @@ -353,7 +345,6 @@ export class GroupsApi extends BaseApi { * * **Note:** this endpoint is available in Alfresco 5.2.1 and newer versions. * You must have admin rights to update a group. - * * @param groupId The identifier of a group. * @param groupBodyUpdate The group information to update. * @param opts Optional parameters diff --git a/lib/js-api/src/api/content-rest-api/api/networks.api.ts b/lib/js-api/src/api/content-rest-api/api/networks.api.ts index 2f663fd2f36..c955ca2dbe1 100644 --- a/lib/js-api/src/api/content-rest-api/api/networks.api.ts +++ b/lib/js-api/src/api/content-rest-api/api/networks.api.ts @@ -28,7 +28,6 @@ import { ContentFieldsQuery, ContentPagingQuery } from './types'; export class NetworksApi extends BaseApi { /** * Get a network - * * @param networkId The identifier of a network. * @param opts Optional parameters * @returns Promise @@ -56,7 +55,6 @@ export class NetworksApi extends BaseApi { * Get network information * * You can use the -me- string in place of to specify the currently authenticated user. - * * @param personId The identifier of a person. * @param networkId The identifier of a network. * @param opts Optional parameters @@ -88,7 +86,6 @@ export class NetworksApi extends BaseApi { * * Gets a list of network memberships for person **personId**. * You can use the -me- string in place of to specify the currently authenticated user. - * * @param personId The identifier of a person. * @param opts Optional parameters * @returns Promise diff --git a/lib/js-api/src/api/content-rest-api/api/nodes.api.ts b/lib/js-api/src/api/content-rest-api/api/nodes.api.ts index 3a551af21af..4f2129d30ec 100644 --- a/lib/js-api/src/api/content-rest-api/api/nodes.api.ts +++ b/lib/js-api/src/api/content-rest-api/api/nodes.api.ts @@ -91,7 +91,6 @@ export class NodesApi extends BaseApi { * If the source **nodeId** is a folder, then all of its children are also copied. * * If the source **nodeId** is a file, it's properties, aspects and tags are copied, it's ratings, comments and locks are not. - * * @param nodeId The identifier of a node. * @param nodeBodyCopy The targetParentId and, optionally, a new name which should include the file extension. * @param opts Optional parameters @@ -123,7 +122,6 @@ export class NodesApi extends BaseApi { * Create node association * * **Note:** this endpoint is available in Alfresco 5.2 and newer versions. - * * @param nodeId The identifier of a source node. * @param associationBodyCreate The target node id and assoc type. * @param opts Optional parameters @@ -159,7 +157,6 @@ export class NodesApi extends BaseApi { * Create a node * * **Note:** this endpoint is available in Alfresco 5.2 and newer versions. - * * @param nodeId The identifier of a node. You can also use one of these well-known aliases: * -my- * -shared- @@ -223,7 +220,6 @@ export class NodesApi extends BaseApi { /** * Create a folder - * * @param name - folder name * @param relativePath - The relativePath specifies the folder structure to create relative to the node identified by nodeId. * @param nodeId default value root.The identifier of a node where add the folder. You can also use one of these well-known aliases: -my- | -shared- | -root- @@ -246,7 +242,6 @@ export class NodesApi extends BaseApi { * Create secondary child * * **Note:** this endpoint is available in Alfresco 5.2 and newer versions. - * * @param nodeId The identifier of a parent node. * @param secondaryChildAssociationBodyCreate The child node id and assoc type. * @param opts Optional parameters @@ -292,7 +287,6 @@ export class NodesApi extends BaseApi { * If the association type is **not** specified, then all peer associations, of any type, in the direction * from source to target, are deleted. * **Note:** After removal of the peer association, or associations, from source to target, the two nodes may still have peer associations in the other direction. - * * @param nodeId The identifier of a source node. * @param targetId The identifier of a target node. * @param opts Optional parameters @@ -333,7 +327,6 @@ export class NodesApi extends BaseApi { * child association is restored. This applies recursively for any primary children. No other secondary child associations or * peer associations are restored for any of the nodes in the primary parent-child hierarchy of restored nodes, regardless of whether the original * associations were to nodes inside or outside the restored hierarchy. - * * @param nodeId The identifier of a node. * @param opts Optional parameters * @param opts.permanent If **true** then the node is deleted permanently, without moving to the trashcan. @@ -359,7 +352,6 @@ export class NodesApi extends BaseApi { } /** * Delete multiple nodes - * * @param nodeIds The list of node IDs to delete. * @param opts Optional parameters * @param opts.permanent If **true** then nodes are deleted permanently, without moving to the trashcan. @@ -388,7 +380,6 @@ export class NodesApi extends BaseApi { * If the association type is **not** specified, then all secondary child associations, of any type in the direction * from parent to secondary child, will be deleted. The child will still have a primary parent and may still be * associated as a secondary child with other secondary parents. - * * @param nodeId The identifier of a parent node. * @param childId The identifier of a child node. * @param opts Optional parameters @@ -417,7 +408,6 @@ export class NodesApi extends BaseApi { * **Note:** this endpoint is available in Alfresco 5.2 and newer versions. * * You can use the **include** parameter to return additional information. - * * @param nodeId The identifier of a node. You can also use one of these well-known aliases: * - -my- * - -shared- @@ -451,7 +441,6 @@ export class NodesApi extends BaseApi { * Get node content * * **Note:** this endpoint is available in Alfresco 5.2 and newer versions. - * * @param nodeId The identifier of a node. * @param opts Optional parameters * @param opts.attachment **true** enables a web browser to download the file as an attachment. @@ -536,7 +525,6 @@ export class NodesApi extends BaseApi { * - createdAt * - modifiedByUser * - createdByUser - * * @param nodeId The identifier of a node. You can also use one of these well-known aliases: * - -my- * - -shared- @@ -600,7 +588,6 @@ export class NodesApi extends BaseApi { * * Gets a list of parent nodes that are associated with the current child **nodeId**. * The list includes both the primary parent and any secondary parents. - * * @param nodeId The identifier of a child node. You can also use one of these well-known aliases: * - -my- * - -shared- @@ -651,7 +638,6 @@ export class NodesApi extends BaseApi { * **Note:** this endpoint is available in Alfresco 5.2 and newer versions. * * Gets a list of secondary child nodes that are associated with the current parent **nodeId**, via a secondary child association. - * * @param nodeId The identifier of a parent node. You can also use one of these well-known aliases: * -my- * -shared- @@ -698,7 +684,6 @@ export class NodesApi extends BaseApi { * List source associations * * **Note:** this endpoint is available in Alfresco 5.2 and newer versions. - * * @param nodeId The identifier of a target node. * @param opts Optional parameters * @param opts.where Optionally filter the list by **assocType**. Here's an example: @@ -738,7 +723,6 @@ export class NodesApi extends BaseApi { * **Note:** this endpoint is available in Alfresco 5.2 and newer versions. * * Gets a list of target nodes that are associated with the current source **nodeId**. - * * @param nodeId The identifier of a source node. * @param opts Optional parameters * @param opts.where Optionally filter the list by **assocType**. Here's an example: @@ -781,7 +765,6 @@ export class NodesApi extends BaseApi { * **Note:** this endpoint is available in Alfresco 5.2 and newer versions. * * If a lock on the node cannot be taken, then an error is returned. - * * @param nodeId The identifier of a node. * @param nodeBodyLock Lock details. * @param opts Optional parameters @@ -818,7 +801,6 @@ export class NodesApi extends BaseApi { * The moved node retains its name unless you specify a new **name** in the request body. * If the source **nodeId** is a folder, then its children are also moved. * The move will effectively change the primary parent. - * * @param nodeId The identifier of a node. * @param nodeBodyMove The targetParentId and, optionally, a new name which should include the file extension. * @param opts Optional parameters @@ -853,7 +835,6 @@ export class NodesApi extends BaseApi { * * The current user must be the owner of the locks or have admin rights, otherwise an error is returned. * If a lock on the node cannot be released, then an error is returned. - * * @param nodeId The identifier of a node. * @param opts Optional parameters * @returns Promise @@ -882,7 +863,6 @@ export class NodesApi extends BaseApi { * Update a node * * **Note:** this endpoint is available in Alfresco 5.2 and newer versions. - * * @param nodeId The identifier of a node. * @param nodeBodyUpdate The node information to update. * @param opts Optional parameters @@ -913,7 +893,6 @@ export class NodesApi extends BaseApi { * Update node content * * **Note:** this endpoint is available in Alfresco 5.2 and newer versions. - * * @param nodeId The identifier of a node. * @param contentBodyUpdate The binary content * @param opts Optional parameters @@ -965,7 +944,6 @@ export class NodesApi extends BaseApi { * Generate a direct access content url for a given node * * **Note:** this endpoint is available in Alfresco 7.1 and newer versions. - * * @param nodeId The identifier of a node. * @returns Promise */ diff --git a/lib/js-api/src/api/content-rest-api/api/people.api.ts b/lib/js-api/src/api/content-rest-api/api/people.api.ts index 8f5d194eb94..12f331fe04a 100644 --- a/lib/js-api/src/api/content-rest-api/api/people.api.ts +++ b/lib/js-api/src/api/content-rest-api/api/people.api.ts @@ -30,7 +30,6 @@ export class PeopleApi extends BaseApi { * * **Note:** this endpoint is available in Alfresco 5.2 and newer versions. * **Note:** setting properties of type d:content and d:category are not supported. - * * @param personBodyCreate The person details. * @param opts Optional parameters * @returns Promise @@ -58,7 +57,6 @@ export class PeopleApi extends BaseApi { * Deletes the avatar image related to person **personId**. * You must be the person or have admin rights to update a person's avatar. * You can use the -me- string in place of to specify the currently authenticated user. - * * @param personId The identifier of a person. * @returns Promise<{}> */ @@ -84,7 +82,6 @@ export class PeopleApi extends BaseApi { * the **placeholder** query parameter can be optionally used to request a placeholder image to be returned. * * You can use the -me- string in place of to specify the currently authenticated user. - * * @param personId The identifier of a person. * @param opts Optional parameters * @param opts.attachment **true** enables a web browser to download the file as an attachment. @@ -131,7 +128,6 @@ export class PeopleApi extends BaseApi { * Get a person * * You can use the `-me-` string in place of to specify the currently authenticated user. - * * @param personId The identifier of a person. * @param opts Optional parameters * @returns Promise @@ -171,7 +167,6 @@ export class PeopleApi extends BaseApi { * - id * - firstName * - lastName - * * @param opts Optional parameters * @param opts.orderBy A string to control the order of the entities returned in a list. You can use the **orderBy** parameter to * sort the list by one or more fields. @@ -209,7 +204,6 @@ export class PeopleApi extends BaseApi { * * **Note:** this endpoint is available in Alfresco 5.2.1 and newer versions. * **Note:** No authentication is required to call this endpoint. - * * @param personId The identifier of a person. * @param clientBody The client name to send email with app-specific url. * @returns Promise<{}> @@ -234,7 +228,6 @@ export class PeopleApi extends BaseApi { * * **Note:** this endpoint is available in Alfresco 5.2.1 and newer versions. * **Note:** No authentication is required to call this endpoint. - * * @param personId The identifier of a person. * @param passwordResetBody The reset password details * @returns Promise<{}> @@ -267,7 +260,6 @@ export class PeopleApi extends BaseApi { * You must be the person or have admin rights to update a person's avatar. * * You can use the -me- string in place of to specify the currently authenticated user. - * * @param personId The identifier of a person. * @param contentBodyUpdate The binary content * @returns Promise<{}> @@ -304,7 +296,6 @@ export class PeopleApi extends BaseApi { * Admin users cannot be disabled by setting enabled to false. * Non-admin users may not disable themselves. * **Note:** setting properties of type d:content and d:category are not supported. - * * @param personId The identifier of a person. * @param personBodyUpdate The person details. * @param opts Optional parameters diff --git a/lib/js-api/src/api/content-rest-api/api/preferences.api.ts b/lib/js-api/src/api/content-rest-api/api/preferences.api.ts index 81874113a2c..7f9f0be5bb7 100644 --- a/lib/js-api/src/api/content-rest-api/api/preferences.api.ts +++ b/lib/js-api/src/api/content-rest-api/api/preferences.api.ts @@ -30,7 +30,6 @@ export class PreferencesApi extends BaseApi { * * Gets a specific preference for person **personId**. * You can use the -me- string in place of to specify the currently authenticated user. - * * @param personId The identifier of a person. * @param preferenceName The name of the preference. * @param opts Optional parameters @@ -63,7 +62,6 @@ export class PreferencesApi extends BaseApi { * Note that each preference consists of an **id** and a **value**. * * The **value** can be of any JSON type. - * * @param personId The identifier of a person. * @param opts Optional parameters * @returns Promise diff --git a/lib/js-api/src/api/content-rest-api/api/probes.api.ts b/lib/js-api/src/api/content-rest-api/api/probes.api.ts index 474d875ac0b..3bf51542b33 100644 --- a/lib/js-api/src/api/content-rest-api/api/probes.api.ts +++ b/lib/js-api/src/api/content-rest-api/api/probes.api.ts @@ -32,7 +32,6 @@ export class ProbesApi extends BaseApi { * The readiness probe is normally only used to check repository startup. * The liveness probe should then be used to check the repository is still responding to requests. * **Note:** No authentication is required to call this endpoint. - * * @param probeId The name of the probe: * - -ready- * - -live- diff --git a/lib/js-api/src/api/content-rest-api/api/queries.api.ts b/lib/js-api/src/api/content-rest-api/api/queries.api.ts index facc9235eb2..129a235c6c2 100644 --- a/lib/js-api/src/api/content-rest-api/api/queries.api.ts +++ b/lib/js-api/src/api/content-rest-api/api/queries.api.ts @@ -79,7 +79,6 @@ export class QueriesApi extends BaseApi { * - name * - modifiedAt * - createdAt - * * @param term The term to search for. * @param opts Optional parameters * @returns Promise @@ -122,7 +121,6 @@ export class QueriesApi extends BaseApi { * - id * - firstName * - lastName - * * @param term The term to search for. * @param opts Optional parameters * @returns Promise @@ -164,7 +162,6 @@ export class QueriesApi extends BaseApi { * - id * - title * - description - * * @param term The term to search for. * @param opts Optional parameters * @returns Promise diff --git a/lib/js-api/src/api/content-rest-api/api/ratings.api.ts b/lib/js-api/src/api/content-rest-api/api/ratings.api.ts index 73ea5d01091..3a634857d14 100644 --- a/lib/js-api/src/api/content-rest-api/api/ratings.api.ts +++ b/lib/js-api/src/api/content-rest-api/api/ratings.api.ts @@ -29,7 +29,6 @@ import { ContentFieldsQuery, ContentPagingQuery } from './types'; export class RatingsApi extends BaseApi { /** * Create a rating - * * @param nodeId The identifier of a node. * @param ratingBodyCreate For \"myRating\" the type is specific to the rating scheme, boolean for the likes and an integer for the fiveStar. * For example, to \"like\" a file the following body would be used: @@ -67,7 +66,6 @@ export class RatingsApi extends BaseApi { * Delete a rating * * Deletes rating **ratingId** from node **nodeId**. - * * @param nodeId The identifier of a node. * @param ratingId The identifier of a rating. * @returns Promise<{}> @@ -91,7 +89,6 @@ export class RatingsApi extends BaseApi { * Get a rating * * Get the specific rating **ratingId** on node **nodeId**. - * * @param nodeId The identifier of a node. * @param ratingId The identifier of a rating. * @param opts Optional parameters @@ -122,7 +119,6 @@ export class RatingsApi extends BaseApi { * List ratings * * Gets a list of ratings for node **nodeId**. - * * @param nodeId The identifier of a node. * @param opts Optional parameters * @returns Promise diff --git a/lib/js-api/src/api/content-rest-api/api/renditions.api.ts b/lib/js-api/src/api/content-rest-api/api/renditions.api.ts index b4f0f0e8cbd..54e03b08b00 100644 --- a/lib/js-api/src/api/content-rest-api/api/renditions.api.ts +++ b/lib/js-api/src/api/content-rest-api/api/renditions.api.ts @@ -27,7 +27,6 @@ export class RenditionsApi extends BaseApi { * Create rendition * * **Note:** this endpoint is available in Alfresco 5.2 and newer versions. - * * @param nodeId The identifier of a node. * @param renditionBodyCreate The rendition \"id\". * @returns Promise<{}> @@ -51,7 +50,6 @@ export class RenditionsApi extends BaseApi { * Get rendition information * * **Note:** this endpoint is available in Alfresco 5.2 and newer versions. - * * @param nodeId The identifier of a node. * @param renditionId The name of a thumbnail rendition, for example *doclib*, or *pdf*. * @returns Promise @@ -76,7 +74,6 @@ export class RenditionsApi extends BaseApi { * Get rendition content * * **Note:** this endpoint is available in Alfresco 5.2 and newer versions. - * * @param nodeId The identifier of a node. * @param renditionId The name of a thumbnail rendition, for example *doclib*, or *pdf*. * @param opts Optional parameters @@ -143,7 +140,6 @@ export class RenditionsApi extends BaseApi { * You can use the **where** parameter to filter the returned renditions by **status**. For example, the following **where** * clause will return just the CREATED renditions: * - (status='CREATED') - * * @param nodeId The identifier of a node. * @param opts Optional parameters * @param opts.where A string to restrict the returned objects by using a predicate. @@ -168,7 +164,6 @@ export class RenditionsApi extends BaseApi { * Generate a direct access content url for a given rendition of a node * * **Note:** this endpoint is available in Alfresco 7.1 and newer versions. - * * @param nodeId The identifier of a node. * @param renditionId The identifier of a version * @returns Promise diff --git a/lib/js-api/src/api/content-rest-api/api/search-ai.api.ts b/lib/js-api/src/api/content-rest-api/api/search-ai.api.ts index 1ee3c6c3890..23187789ece 100644 --- a/lib/js-api/src/api/content-rest-api/api/search-ai.api.ts +++ b/lib/js-api/src/api/content-rest-api/api/search-ai.api.ts @@ -24,7 +24,6 @@ import { BaseApi } from '../../hxi-connector-api/api/base.api'; export class SearchAiApi extends BaseApi { /** * Ask a question to the AI. - * * @param questions QuestionRequest array containing questions to ask. * @returns QuestionModel object containing information about questions. */ @@ -41,7 +40,6 @@ export class SearchAiApi extends BaseApi { /** * Get an answer to specific question. - * * @param questionId The ID of the question to get an answer for. * @returns AiAnswerEntry object containing the answer. */ @@ -53,7 +51,6 @@ export class SearchAiApi extends BaseApi { /** * Get the knowledge retrieval configuration. - * * @returns KnowledgeRetrievalConfigEntry object containing the configuration. */ getConfig(): Promise { diff --git a/lib/js-api/src/api/content-rest-api/api/sharedlinks.api.ts b/lib/js-api/src/api/content-rest-api/api/sharedlinks.api.ts index bf16e9faff7..792fe29afb4 100644 --- a/lib/js-api/src/api/content-rest-api/api/sharedlinks.api.ts +++ b/lib/js-api/src/api/content-rest-api/api/sharedlinks.api.ts @@ -34,7 +34,6 @@ export class SharedlinksApi extends BaseApi { * Create a shared link to a file * * **Note:** this endpoint is available in Alfresco 5.2 and newer versions. - * * @param sharedLinkBodyCreate The nodeId to create a shared link for. * @param opts Optional parameters * @returns Promise @@ -59,7 +58,6 @@ export class SharedlinksApi extends BaseApi { * Deletes a shared link * * **Note:** this endpoint is available in Alfresco 5.2 and newer versions. - * * @param sharedId The identifier of a shared link to a file. * @returns Promise<{}> */ @@ -80,7 +78,6 @@ export class SharedlinksApi extends BaseApi { * Email shared link * * **Note:** this endpoint is available in Alfresco 5.2 and newer versions. - * * @param sharedId The identifier of a shared link to a file. * @param sharedLinkBodyEmail The shared link email to send. * @returns Promise<{}> @@ -105,7 +102,6 @@ export class SharedlinksApi extends BaseApi { * * **Note:** this endpoint is available in Alfresco 5.2 and newer versions. * **Note:** No authentication is required to call this endpoint. - * * @param sharedId The identifier of a shared link to a file. * @param opts Optional parameters * @returns Promise @@ -134,7 +130,6 @@ export class SharedlinksApi extends BaseApi { * * **Note:** this endpoint is available in Alfresco 5.2 and newer versions. * **Note:** No authentication is required to call this endpoint. - * * @param sharedId The identifier of a shared link to a file. * @param opts Optional parameters * @param opts.attachment **true** enables a web browser to download the file as an attachment. @@ -190,7 +185,6 @@ export class SharedlinksApi extends BaseApi { * which means the rendition is available to view/download. * * **Note:** No authentication is required to call this endpoint. - * * @param sharedId The identifier of a shared link to a file. * @param renditionId The name of a thumbnail rendition, for example *doclib*, or *pdf*. * @returns Promise @@ -216,7 +210,6 @@ export class SharedlinksApi extends BaseApi { * * **Note:** this endpoint is available in Alfresco 5.2 and newer versions. * **Note:** No authentication is required to call this endpoint. - * * @param sharedId The identifier of a shared link to a file. * @param renditionId The name of a thumbnail rendition, for example *doclib*, or *pdf*. * @param opts Optional parameters @@ -278,7 +271,6 @@ export class SharedlinksApi extends BaseApi { * where the rendition status is CREATED, which means the rendition is available to view/download. * * **Note:** No authentication is required to call this endpoint. - * * @param sharedId The identifier of a shared link to a file. * @returns Promise */ @@ -305,7 +297,6 @@ export class SharedlinksApi extends BaseApi { * The list is ordered in descending modified order. * * **Note:** The list of links is eventually consistent so newly created shared links may not appear immediately. - * * @param opts Optional parameters * @param opts.where Optionally filter the list by \"sharedByUser\" `userId` of person who shared the link (can also use -me-) * where=(sharedByUser='jbloggs') diff --git a/lib/js-api/src/api/content-rest-api/api/sites.api.ts b/lib/js-api/src/api/content-rest-api/api/sites.api.ts index 89c2e663e0e..6c72275b459 100644 --- a/lib/js-api/src/api/content-rest-api/api/sites.api.ts +++ b/lib/js-api/src/api/content-rest-api/api/sites.api.ts @@ -47,7 +47,6 @@ import { ContentFieldsQuery, ContentPagingQuery } from './types'; export class SitesApi extends BaseApi { /** * Approve a site membership request - * * @param siteId The identifier of a site. * @param inviteeId The invitee username. * @param opts Optional parameters @@ -76,7 +75,6 @@ export class SitesApi extends BaseApi { * Create a site * * **Note:** this endpoint is available in Alfresco 5.2 and newer versions. - * * @param siteBodyCreate The site details * @param opts Optional parameters * @param opts.skipConfiguration Flag to indicate whether the Share-specific (surf) configuration files for the site should not be created. (default to false) @@ -111,7 +109,6 @@ export class SitesApi extends BaseApi { /** * Create a site membership - * * @param siteId The identifier of a site. * @param siteMembershipBodyCreate The person to add and their role * @param opts Optional parameters @@ -144,7 +141,6 @@ export class SitesApi extends BaseApi { /** * Create a site membership request - * * @param personId The identifier of a person. * @param siteMembershipRequestBodyCreate Site membership request details * @param opts Optional parameters @@ -178,7 +174,6 @@ export class SitesApi extends BaseApi { /** * Delete a site * **Note:** this endpoint is available in Alfresco 5.2 and newer versions. - * * @param siteId The identifier of a site. * @param opts Optional parameters * @param opts.permanent Flag to indicate whether the site should be permanently deleted i.e. bypass the trashcan. (default to false) @@ -205,7 +200,6 @@ export class SitesApi extends BaseApi { /** * Delete a site membership * You can use the -me- string in place of to specify the currently authenticated user. - * * @param siteId The identifier of a site. * @param personId The identifier of a person. * @returns Promise<{}> @@ -230,7 +224,6 @@ export class SitesApi extends BaseApi { * * Deletes person **personId** as a member of site **siteId**. * You can use the -me- string in place of to specify the currently authenticated user. - * * @param personId The identifier of a person. * @param siteId The identifier of a site. * @returns Promise<{}> @@ -255,7 +248,6 @@ export class SitesApi extends BaseApi { * * Deletes the site membership request to site **siteId** for person **personId**. * You can use the -me- string in place of to specify the currently authenticated user. - * * @param personId The identifier of a person. * @param siteId The identifier of a site. * @returns Promise<{}> @@ -289,7 +281,6 @@ export class SitesApi extends BaseApi { * objects related to the site **siteId**: * * containers,members - * * @param siteId The identifier of a site. * @param opts Optional parameters * @param opts.relations Use the relations parameter to include one or more related entities in a single response. @@ -319,7 +310,6 @@ export class SitesApi extends BaseApi { * Get a site container * * Gets information on the container **containerId** in site **siteId**. - * * @param siteId The identifier of a site. * @param containerId The unique identifier of a site container. * @param opts Optional parameters @@ -350,7 +340,6 @@ export class SitesApi extends BaseApi { * * Gets site membership information for person **personId** on site **siteId**. * You can use the -me- string in place of to specify the currently authenticated user. - * * @param siteId The identifier of a site. * @param personId The identifier of a person. * @param opts Optional parameters @@ -382,7 +371,6 @@ export class SitesApi extends BaseApi { * * Gets site membership information for person **personId** on site **siteId**. * You can use the -me- string in place of to specify the currently authenticated user. - * * @param personId The identifier of a person. * @param siteId The identifier of a site. * @returns Promise @@ -408,7 +396,6 @@ export class SitesApi extends BaseApi { * * Gets the site membership request for site **siteId** for person **personId**, if one exists. * You can use the -me- string in place of to specify the currently authenticated user. - * * @param personId The identifier of a person. * @param siteId The identifier of a site. * @param opts Optional parameters @@ -449,7 +436,6 @@ export class SitesApi extends BaseApi { * This may be combined with the siteId filter, as shown below: * * where=(siteId=mySite AND personId=person)) - * * @param opts Optional parameters * @param opts.where A string to restrict the returned objects by using a predicate. * @returns Promise @@ -473,7 +459,6 @@ export class SitesApi extends BaseApi { * List site containers * * Gets a list of containers for the site **siteId**. - * * @param siteId The identifier of a site. * @param opts Optional parameters * @returns Promise @@ -504,7 +489,6 @@ export class SitesApi extends BaseApi { * * Gets a list of the current site membership requests for person **personId**. * You can use the -me- string in place of to specify the currently authenticated user. - * * @param personId The identifier of a person. * @param opts Optional parameters * @returns Promise @@ -534,7 +518,6 @@ export class SitesApi extends BaseApi { * List site memberships * * Gets a list of site memberships for site **siteId**. - * * @param siteId The identifier of a site. * @param opts Optional parameters * @returns Promise @@ -585,7 +568,6 @@ export class SitesApi extends BaseApi { * - id * - title * - role - * * @param personId The identifier of a person. * @param opts Optional parameters * @param opts.orderBy A string to control the order of the entities returned in a list. You can use the **orderBy** parameter to @@ -657,8 +639,6 @@ export class SitesApi extends BaseApi { * objects related to each site: * * containers,members - * - * * @param opts Optional parameters * @param opts.orderBy A string to control the order of the entities returned in a list. You can use the **orderBy** parameter to * sort the list by one or more fields. @@ -695,7 +675,6 @@ export class SitesApi extends BaseApi { /** * Reject a site membership request - * * @param siteId The identifier of a site. * @param inviteeId The invitee username. * @param opts Optional parameters @@ -729,7 +708,6 @@ export class SitesApi extends BaseApi { * (site) admin can update title, description or visibility. * * Note: the id of a site cannot be updated once the site has been created. - * * @param siteId The identifier of a site. * @param siteBodyUpdate The site information to update. * @param opts Optional parameters @@ -768,7 +746,6 @@ export class SitesApi extends BaseApi { * - SiteCollaborator * - SiteContributor * - SiteManager - * * @param siteId The identifier of a site. * @param personId The identifier of a person. * @param siteMembershipBodyUpdate The persons new role @@ -808,7 +785,6 @@ export class SitesApi extends BaseApi { * * Updates the message for the site membership request to site **siteId** for person **personId**. * You can use the -me- string in place of to specify the currently authenticated user. - * * @param personId The identifier of a person. * @param siteId The identifier of a site. * @param siteMembershipRequestBodyUpdate The new message to display @@ -852,7 +828,6 @@ export class SitesApi extends BaseApi { * - SiteCollaborator * - SiteContributor * - SiteManager - * * @param siteId The identifier of a site. * @param siteMembershipBodyCreate The group to add and it role * @param opts Optional parameters @@ -887,7 +862,6 @@ export class SitesApi extends BaseApi { * List group membership for site * * **Note:** this endpoint is available in Alfresco 7.0.0 and newer versions. - * * @param siteId The identifier of a site. * @param opts Optional parameters * @returns Promise @@ -917,7 +891,6 @@ export class SitesApi extends BaseApi { * Get information about site membership of group * **Note:** this endpoint is available in Alfresco 7.0.0 and newer versions. * Gets site membership information for group **groupId** on site **siteId**. - * * @param siteId The identifier of a site. * @param groupId The authorityId of a group. * @param opts Optional parameters @@ -954,7 +927,6 @@ export class SitesApi extends BaseApi { * - SiteCollaborator * - SiteContributor * - SiteManager - * * @param siteId The identifier of a site. * @param groupId The authorityId of a group. * @param siteMembershipBodyUpdate The group new role @@ -991,7 +963,6 @@ export class SitesApi extends BaseApi { /** * Delete a group membership for site - * * @param siteId The identifier of a site. * @param groupId The authorityId of a group. * @returns Promise<{}> diff --git a/lib/js-api/src/api/content-rest-api/api/tags.api.ts b/lib/js-api/src/api/content-rest-api/api/tags.api.ts index e434db44ad7..4087a55e0e7 100644 --- a/lib/js-api/src/api/content-rest-api/api/tags.api.ts +++ b/lib/js-api/src/api/content-rest-api/api/tags.api.ts @@ -29,7 +29,6 @@ import { ContentFieldsQuery, ContentIncludeQuery, ContentPagingQuery } from './t export class TagsApi extends BaseApi { /** * Create a tag for a node - * * @param nodeId The identifier of a node. * @param tagBodyCreate The new tag * @param opts Optional parameters @@ -58,7 +57,6 @@ export class TagsApi extends BaseApi { /** * Delete a tag from a node - * * @param nodeId The identifier of a node. * @param tagId The identifier of a tag. * @returns Promise<{}> @@ -80,7 +78,6 @@ export class TagsApi extends BaseApi { /** * Get a tag - * * @param tagId The identifier of a tag. * @param opts Optional parameters * @returns Promise @@ -106,7 +103,6 @@ export class TagsApi extends BaseApi { /** * List tags - * * @param opts Optional parameters * @param opts.tag Name or pattern for which tag is returned. Example of pattern: *test* which returns tags like 'my test 1' * @param opts.matching Switches filtering to pattern mode instead of exact mode. @@ -139,7 +135,6 @@ export class TagsApi extends BaseApi { /** * List tags for a node - * * @param nodeId The identifier of a node. * @param opts Optional parameters * @returns Promise @@ -167,7 +162,6 @@ export class TagsApi extends BaseApi { /** * Update a tag - * * @param tagId The identifier of a tag. * @param tagBodyUpdate The updated tag * @param opts Optional parameters @@ -196,7 +190,6 @@ export class TagsApi extends BaseApi { /** * Deletes a tag by **tagId**. This will cause the tag to be removed from all nodes. - * * @param tagId The identifier of a tag. * @returns Promise<{}> */ @@ -215,7 +208,6 @@ export class TagsApi extends BaseApi { /** * Create specified by **tags** list of tags. - * * @param tags List of tags to create. * @returns Promise */ @@ -230,7 +222,6 @@ export class TagsApi extends BaseApi { /** * Assign tags to node. If tag is new then tag is also created additionally, if tag already exists then it is just assigned. - * * @param nodeId Id of node to which tags should be assigned. * @param tags List of tags to create and assign or just assign if they already exist. * @returns Promise @@ -246,7 +237,6 @@ export class TagsApi extends BaseApi { /** * Assign tags to node. If tag is new then tag is also created additionally, if tag already exists then it is just assigned. - * * @param nodeId Id of node to which tags should be assigned. * @param tag List of tags to create and assign or just assign if they already exist. * @returns Promise diff --git a/lib/js-api/src/api/content-rest-api/api/trashcan.api.ts b/lib/js-api/src/api/content-rest-api/api/trashcan.api.ts index ee59149e99d..1e44a64a564 100644 --- a/lib/js-api/src/api/content-rest-api/api/trashcan.api.ts +++ b/lib/js-api/src/api/content-rest-api/api/trashcan.api.ts @@ -28,7 +28,6 @@ import { ContentFieldsQuery, ContentIncludeQuery, ContentPagingQuery } from './t /** * Trashcan service. - * * @module TrashcanApi */ export class TrashcanApi extends BaseApi { @@ -36,7 +35,6 @@ export class TrashcanApi extends BaseApi { * Permanently delete a deleted node * * **Note:** this endpoint is available in Alfresco 5.2 and newer versions. - * * @param nodeId The identifier of a node. * @returns Promise<{}> */ @@ -57,7 +55,6 @@ export class TrashcanApi extends BaseApi { * Get rendition information for a deleted node * * **Note:** this endpoint is available in Alfresco 5.2 and newer versions. - * * @param nodeId The identifier of a node. * @param renditionId The name of a thumbnail rendition, for example *doclib*, or *pdf*. * @returns Promise @@ -82,7 +79,6 @@ export class TrashcanApi extends BaseApi { * Get rendition content of a deleted node * * **Note:** this endpoint is available in Alfresco 5.2 and newer versions. - * * @param nodeId The identifier of a node. * @param renditionId The name of a thumbnail rendition, for example *doclib*, or *pdf*. * @param opts Optional parameters @@ -142,7 +138,6 @@ export class TrashcanApi extends BaseApi { * Get a deleted node * * **Note:** this endpoint is available in Alfresco 5.2 and newer versions. - * * @param nodeId The identifier of a node. * @param opts Optional parameters * @returns Promise @@ -170,7 +165,6 @@ export class TrashcanApi extends BaseApi { * Get deleted node content * * **Note:** this endpoint is available in Alfresco 5.2 and newer versions. - * * @param nodeId The identifier of a node. * @param opts Optional parameters * @param opts.attachment **true** enables a web browser to download the file as an attachment. @@ -232,7 +226,6 @@ export class TrashcanApi extends BaseApi { * clause will return just the CREATED renditions: * * - (status='CREATED') - * * @param nodeId The identifier of a node. * @param opts Optional parameters * @param opts.where A string to restrict the returned objects by using a predicate. @@ -265,7 +258,6 @@ export class TrashcanApi extends BaseApi { * Gets a list of deleted nodes for the current user. * If the current user is an administrator deleted nodes for all users will be returned. * The list of deleted nodes will be ordered with the most recently deleted node at the top of the list. - * * @param opts Optional parameters * @returns Promise */ @@ -298,7 +290,6 @@ export class TrashcanApi extends BaseApi { * * Also, any previously shared link will not be restored since it is deleted at the time * of delete of each node. - * * @param nodeId The identifier of a node. * @param opts Optional parameters * @param opts.deletedNodeBodyRestore The targetParentId if the node is restored to a new location. @@ -336,7 +327,6 @@ export class TrashcanApi extends BaseApi { * Generate a direct access content url for a given deleted node * * **Note:** this endpoint is available in Alfresco 7.1 and newer versions. - * * @param nodeId The identifier of a node. * @returns Promise */ @@ -358,7 +348,6 @@ export class TrashcanApi extends BaseApi { * Generate a direct access content url for a given rendition of a deleted node * * **Note:** this endpoint is available in Alfresco 7.1 and newer versions. - * * @param nodeId The identifier of a node. * @param renditionId The identifier of a version * @returns Promise diff --git a/lib/js-api/src/api/content-rest-api/api/versions.api.ts b/lib/js-api/src/api/content-rest-api/api/versions.api.ts index 8235cbbe647..938b75c6761 100644 --- a/lib/js-api/src/api/content-rest-api/api/versions.api.ts +++ b/lib/js-api/src/api/content-rest-api/api/versions.api.ts @@ -23,7 +23,6 @@ import { ContentFieldsQuery, ContentIncludeQuery, ContentPagingQuery } from './t /** * Versions service. - * * @module VersionsApi */ export class VersionsApi extends BaseApi { @@ -31,7 +30,6 @@ export class VersionsApi extends BaseApi { * Create rendition for a file version * * **Note:** this endpoint is available in Alfresco 7.0.0 and newer versions. - * * @param nodeId The identifier of a node. * @param versionId The identifier of a version, ie. version label, within the version history of a node. * @param renditionBodyCreate The rendition \"id\". @@ -70,7 +68,6 @@ export class VersionsApi extends BaseApi { * can remove the \"cm:versionable\" aspect (via update node) which will also disable versioning. In this * case, you can re-enable versioning by adding back the \"cm:versionable\" aspect or using the version * params (majorVersion and comment) on a subsequent file content update. - * * @param nodeId The identifier of a node. * @param versionId The identifier of a version, ie. version label, within the version history of a node. * @returns Promise<{}> @@ -94,7 +91,6 @@ export class VersionsApi extends BaseApi { * Get version information * * **Note:** this endpoint is available in Alfresco 5.2 and newer versions. - * * @param nodeId The identifier of a node. * @param versionId The identifier of a version, ie. version label, within the version history of a node. * @returns Promise @@ -119,7 +115,6 @@ export class VersionsApi extends BaseApi { * Get version content * * **Note:** this endpoint is available in Alfresco 5.2 and newer versions. - * * @param nodeId The identifier of a node. * @param versionId The identifier of a version, ie. version label, within the version history of a node. * @param opts Optional parameters @@ -177,7 +172,6 @@ export class VersionsApi extends BaseApi { * Get rendition information for a file version * * **Note:** this endpoint is available in Alfresco 7.0.0 and newer versions. - * * @param nodeId The identifier of a node. * @param versionId The identifier of a version, ie. version label, within the version history of a node. * @param renditionId The name of a thumbnail rendition, for example *doclib*, or *pdf*. @@ -205,7 +199,6 @@ export class VersionsApi extends BaseApi { * Get rendition content for a file version * * **Note:** this endpoint is available in Alfresco 7.0.0 and newer versions. - * * @param nodeId The identifier of a node. * @param versionId The identifier of a version, ie. version label, within the version history of a node. * @param renditionId The name of a thumbnail rendition, for example *doclib*, or *pdf*. @@ -281,7 +274,6 @@ export class VersionsApi extends BaseApi { * * The list is ordered in descending modified order. So the most recent version is first and * the original version is last in the list. - * * @param nodeId The identifier of a node. * @param opts Optional parameters * @returns Promise @@ -317,7 +309,6 @@ export class VersionsApi extends BaseApi { * Each rendition returned has a **status**: CREATED means it is available to view or download, NOT_CREATED means the rendition can be requested. * You can use the **where** parameter to filter the returned renditions by **status**. For example, the following **where** * clause will return just the CREATED renditions: (status='CREATED') - * * @param nodeId The identifier of a node. * @param versionId The identifier of a version, ie. version label, within the version history of a node. * @param opts Optional parameters @@ -349,7 +340,6 @@ export class VersionsApi extends BaseApi { * Attempts to revert the version identified by **versionId** and **nodeId** to the live node. * If the node is successfully reverted then the content and metadata for that versioned node * will be promoted to the live node and a new version will appear in the version history. - * * @param nodeId The identifier of a node. * @param versionId The identifier of a version, ie. version label, within the version history of a node. * @param revertBody Optionally, specify a version comment and whether this should be a major version, or not. @@ -383,7 +373,6 @@ export class VersionsApi extends BaseApi { * Generate a direct access content url for a given version of a node * * **Note:** this endpoint is available in Alfresco 7.1 and newer versions. - * * @param nodeId The identifier of a node. * @param versionId The identifier of a version * @returns Promise diff --git a/lib/js-api/src/api/discovery-rest-api/api/discovery.api.ts b/lib/js-api/src/api/discovery-rest-api/api/discovery.api.ts index 261e4379841..2f6ceb02edc 100644 --- a/lib/js-api/src/api/discovery-rest-api/api/discovery.api.ts +++ b/lib/js-api/src/api/discovery-rest-api/api/discovery.api.ts @@ -26,7 +26,6 @@ export class DiscoveryApi extends BaseApi { * Get repository information * * **Note:** this endpoint is available in Alfresco 5.2 and newer versions. - * * @returns Promise */ getRepositoryInformation(): Promise { diff --git a/lib/js-api/src/api/gs-classification-rest-api/api/authorityClearance.api.ts b/lib/js-api/src/api/gs-classification-rest-api/api/authorityClearance.api.ts index af75ad27069..665b75b9c5e 100644 --- a/lib/js-api/src/api/gs-classification-rest-api/api/authorityClearance.api.ts +++ b/lib/js-api/src/api/gs-classification-rest-api/api/authorityClearance.api.ts @@ -25,7 +25,6 @@ import { GsPagingQuery } from './types'; export class AuthorityClearanceApi extends BaseApi { /** * Get the authority clearances for a single user/group - * * @param authorityId The name for the authority for which the clearance is to be fetched. Can be left blank in which case it will fetch it for all users with pagination * @param opts Optional parameters * @returns Promise @@ -44,7 +43,6 @@ export class AuthorityClearanceApi extends BaseApi { /** * Updates the authority clearance. - * * @param authorityId The name for the authority for which the clearance is to be updated * @param authorityClearance AuthorityClearanceBody * @returns Promise diff --git a/lib/js-api/src/api/gs-classification-rest-api/api/classificationGuides.api.ts b/lib/js-api/src/api/gs-classification-rest-api/api/classificationGuides.api.ts index 66a194f4d41..457619f97e5 100644 --- a/lib/js-api/src/api/gs-classification-rest-api/api/classificationGuides.api.ts +++ b/lib/js-api/src/api/gs-classification-rest-api/api/classificationGuides.api.ts @@ -40,7 +40,6 @@ export interface CombinedInstructionsOpts { export class ClassificationGuidesApi extends BaseApi { /** * Combines instructions from the given topics and the user defined instruction, if any. - * * @param opts Optional parameters * @param opts.instructions Instructions * @returns Promise @@ -54,7 +53,6 @@ export class ClassificationGuidesApi extends BaseApi { /** * Create a classification guide - * * @param classificationGuide Classification guide * @returns Promise */ @@ -69,7 +67,6 @@ export class ClassificationGuidesApi extends BaseApi { /** * Create a subtopic - * * @param topicId The identifier for the topic * @param topic Subtopic * @param opts Optional parameters @@ -98,7 +95,6 @@ export class ClassificationGuidesApi extends BaseApi { /** * Create a topic - * * @param classificationGuideId The identifier for the classification guide * @param topic Topic * @param opts Optional parameters @@ -127,7 +123,6 @@ export class ClassificationGuidesApi extends BaseApi { /** * Delete a classification guide - * * @param classificationGuideId The identifier for the classification guide * @returns Promise<{}> */ @@ -146,7 +141,6 @@ export class ClassificationGuidesApi extends BaseApi { /** * Delete a topic - * * @param topicId The identifier for the topic * @returns Promise<{}> */ @@ -165,7 +159,6 @@ export class ClassificationGuidesApi extends BaseApi { /** * List all classification guides - * * @param opts Optional parameters * @param opts.orderBy A string to control the order of the entities returned in a list. You can use the **orderBy** parameter to sort the list by one or more fields. * Each field has a default sort order, which is normally ascending order. Read the API method implementation notes @@ -194,7 +187,6 @@ export class ClassificationGuidesApi extends BaseApi { /** * List all subtopics - * * @param topicId The identifier for the topic * @param opts Optional parameters * @param opts.orderBy A string to control the order of the entities returned in a list. You can use the **orderBy** parameter to @@ -243,7 +235,6 @@ export class ClassificationGuidesApi extends BaseApi { /** * List all topics - * * @param classificationGuideId The identifier for the classification guide * @param opts Optional parameters * @param opts.orderBy A string to control the order of the entities returned in a list. You can use the **orderBy** parameter to @@ -292,7 +283,6 @@ export class ClassificationGuidesApi extends BaseApi { /** * Get classification guide information - * * @param classificationGuideId The identifier for the classification guide * @returns Promise */ @@ -311,7 +301,6 @@ export class ClassificationGuidesApi extends BaseApi { /** * Get topic information - * * @param topicId The identifier for the topic * @param opts Optional parameters * @returns Promise @@ -339,7 +328,6 @@ export class ClassificationGuidesApi extends BaseApi { * Update a classification guide * * Updates the classification guide with id **classificationGuideId**. For example, you can rename a classification guide. - * * @param classificationGuideId The identifier for the classification guide * @param classificationGuide Classification guide * @returns Promise @@ -364,7 +352,6 @@ export class ClassificationGuidesApi extends BaseApi { * * Updates the topic with id **topicId**. * Use this to rename a topic or to add, edit, or remove the instruction associated with it. - * * @param topicId The identifier for the topic * @param topic Topic * @param opts Optional parameters diff --git a/lib/js-api/src/api/gs-classification-rest-api/api/classificationReasons.api.ts b/lib/js-api/src/api/gs-classification-rest-api/api/classificationReasons.api.ts index 85fd1493bb2..09ccad4441f 100644 --- a/lib/js-api/src/api/gs-classification-rest-api/api/classificationReasons.api.ts +++ b/lib/js-api/src/api/gs-classification-rest-api/api/classificationReasons.api.ts @@ -29,7 +29,6 @@ export class ClassificationReasonsApi extends BaseApi { * Creates a new classification reason. * * **Note:** You can create more than one reason by specifying a list of reasons in the JSON body. - * * @param classificationReason Classification reason * @returns Promise */ @@ -47,7 +46,6 @@ export class ClassificationReasonsApi extends BaseApi { * * You can't delete a classification reason that is being used to classify content. * There must be at least one classification reason. - * * @param classificationReasonId The identifier for the classification reason * @returns Promise<{}> */ @@ -66,7 +64,6 @@ export class ClassificationReasonsApi extends BaseApi { /** * List all classification reasons - * * @param opts Optional parameters * @returns Promise */ @@ -85,7 +82,6 @@ export class ClassificationReasonsApi extends BaseApi { /** * Get classification reason information - * * @param classificationReasonId The identifier for the classification reason * @returns Promise */ @@ -104,7 +100,6 @@ export class ClassificationReasonsApi extends BaseApi { /** * Updates the classification reason with id **classificationReasonId**. For example, you can change a classification reason code or description. - * * @param classificationReasonId The identifier for the classification reason * @param classificationReason Classification reason * @returns Promise diff --git a/lib/js-api/src/api/gs-classification-rest-api/api/declassificationExemptions.api.ts b/lib/js-api/src/api/gs-classification-rest-api/api/declassificationExemptions.api.ts index 411e449f9d8..10e2d09949d 100644 --- a/lib/js-api/src/api/gs-classification-rest-api/api/declassificationExemptions.api.ts +++ b/lib/js-api/src/api/gs-classification-rest-api/api/declassificationExemptions.api.ts @@ -26,7 +26,6 @@ import { GsPagingQuery } from './types'; export class DeclassificationExemptionsApi extends BaseApi { /** * Create a declassification exemption - * * @param declassificationExemption Declassification exemption * @returns Promise */ @@ -42,7 +41,6 @@ export class DeclassificationExemptionsApi extends BaseApi { /** * Deletes the declassification exemption with id **declassificationExemptionId**. * You can't delete a classification exemption that is being used to classify content. - * * @param declassificationExemptionId The identifier for the declassification exemption * @returns Promise<{}> */ @@ -61,7 +59,6 @@ export class DeclassificationExemptionsApi extends BaseApi { /** * List all declassification exemptions - * * @param opts Optional parameters * @returns Promise */ @@ -74,7 +71,6 @@ export class DeclassificationExemptionsApi extends BaseApi { /** * Get declassification exemption information - * * @param declassificationExemptionId The identifier for the declassification exemption * @returns Promise */ @@ -93,7 +89,6 @@ export class DeclassificationExemptionsApi extends BaseApi { /** * Update a declassification exemption - * * @param declassificationExemptionId The identifier for the declassification exemption * @param declassificationExemption Declassification exemption * @returns Promise diff --git a/lib/js-api/src/api/gs-classification-rest-api/api/defaultClassificationValues.api.ts b/lib/js-api/src/api/gs-classification-rest-api/api/defaultClassificationValues.api.ts index a63fa5a2030..847b39a00bc 100644 --- a/lib/js-api/src/api/gs-classification-rest-api/api/defaultClassificationValues.api.ts +++ b/lib/js-api/src/api/gs-classification-rest-api/api/defaultClassificationValues.api.ts @@ -26,7 +26,6 @@ import { throwIfNotDefined } from '../../../assert'; export class DefaultClassificationValuesApi extends BaseApi { /** * Calculates the default declassification date for **nodeId** based on the properties of the node and the current declassification time frame. - * * @param nodeId The identifier of a node. * @returns Promise */ diff --git a/lib/js-api/src/api/gs-classification-rest-api/api/nodeSecurityMarks.api.ts b/lib/js-api/src/api/gs-classification-rest-api/api/nodeSecurityMarks.api.ts index 40b41988e2a..873083af94b 100644 --- a/lib/js-api/src/api/gs-classification-rest-api/api/nodeSecurityMarks.api.ts +++ b/lib/js-api/src/api/gs-classification-rest-api/api/nodeSecurityMarks.api.ts @@ -27,7 +27,6 @@ import { GsPagingQuery } from './types'; export class NodeSecurityMarksApi extends BaseApi { /** * Add/Remove security mark on a node - * * @param nodeId The key for the node id. * @param dataBody Array of NodeSecurityMarkBody. * @returns Promise @@ -49,7 +48,6 @@ export class NodeSecurityMarksApi extends BaseApi { /** * Get security marks on a node - * * @param nodeId The key for the node id. * @param opts Optional parameters * @returns Promise diff --git a/lib/js-api/src/api/gs-classification-rest-api/api/securityControlSettings.api.ts b/lib/js-api/src/api/gs-classification-rest-api/api/securityControlSettings.api.ts index fb2d70daf24..056315a25fb 100644 --- a/lib/js-api/src/api/gs-classification-rest-api/api/securityControlSettings.api.ts +++ b/lib/js-api/src/api/gs-classification-rest-api/api/securityControlSettings.api.ts @@ -21,13 +21,11 @@ import { throwIfNotDefined } from '../../../assert'; /** * SecurityControlSettingsApi service. - * * @module SecurityControlSettingsApi */ export class SecurityControlSettingsApi extends BaseApi { /** * Get security control setting value - * * @param securityControlSettingKey The key for the security control setting. You can use one of the following settings: * -declassificationTimeFrame- for the declassification time frame value set in alfresco-global.properties file * @returns Promise @@ -47,7 +45,6 @@ export class SecurityControlSettingsApi extends BaseApi { /** * Update security control setting value - * * @param securityControlSettingKey The key for the security control setting. You can use one of the following settings: * -declassificationTimeFrame- for the declassification time frame value set in alfresco-global.properties file * @param securityControlSettingValue The new value for the security control setting. This can be a string or number, depending on the setting key. diff --git a/lib/js-api/src/api/gs-classification-rest-api/api/securityGroups.api.ts b/lib/js-api/src/api/gs-classification-rest-api/api/securityGroups.api.ts index 33e5db3896f..beed27fc7ae 100644 --- a/lib/js-api/src/api/gs-classification-rest-api/api/securityGroups.api.ts +++ b/lib/js-api/src/api/gs-classification-rest-api/api/securityGroups.api.ts @@ -21,13 +21,11 @@ import { GsGroupInclude, GsPagingQuery } from './types'; /** * SecurityGroupsApi service. - * * @module SecurityGroupsApi */ export class SecurityGroupsApi extends BaseApi { /** * Get All security groups - * * @param opts Optional parameters * @returns Promise */ @@ -40,7 +38,6 @@ export class SecurityGroupsApi extends BaseApi { /** * Create security group - * * @param securityGroupBody securityGroupBody. * @param opts Optional parameters * @returns Promise @@ -55,7 +52,6 @@ export class SecurityGroupsApi extends BaseApi { /** * Get a security groups information - * * @param securityGroupId The Key of Security Group id for which info is required * @param opts Optional parameters * @returns Promise @@ -74,7 +70,6 @@ export class SecurityGroupsApi extends BaseApi { /** * Update a security groups information - * * @param securityGroupId The Key of Security Group id for which info is required * @param securityGroupBody SecurityGroupBody * @param opts Optional parameters @@ -95,7 +90,6 @@ export class SecurityGroupsApi extends BaseApi { /** * Delete security group - * * @param securityGroupId The key for the security group id. * @returns Promise */ diff --git a/lib/js-api/src/api/gs-classification-rest-api/api/securityMarks.api.ts b/lib/js-api/src/api/gs-classification-rest-api/api/securityMarks.api.ts index 1d9e1f189dd..959445476f3 100644 --- a/lib/js-api/src/api/gs-classification-rest-api/api/securityMarks.api.ts +++ b/lib/js-api/src/api/gs-classification-rest-api/api/securityMarks.api.ts @@ -22,13 +22,11 @@ import { GsPagingQuery } from './types'; /** * Security Marks API. - * * @module SecurityMarksApi */ export class SecurityMarksApi extends BaseApi { /** * Get security mark value - * * @param securityGroupId The key for the security group id. * @param opts Options * @returns Promise @@ -49,7 +47,6 @@ export class SecurityMarksApi extends BaseApi { /** * Create security marks - * * @param securityGroupId The key for the security group id. * @param securityMarkBody securityMarkBody[]. * @returns Promise @@ -69,7 +66,6 @@ export class SecurityMarksApi extends BaseApi { /** * Get security mark value information - * * @param securityGroupId The key for the security group id. * @param securityMarkId The key for the security mark id * @returns Promise @@ -91,7 +87,6 @@ export class SecurityMarksApi extends BaseApi { /** * Updates Security Mark value - * * @param securityGroupId The key for the security group id. * @param securityMarkId The key for the security mark is in use or not. * @param securityMarkBody securityMarkBody. @@ -116,7 +111,6 @@ export class SecurityMarksApi extends BaseApi { /** * Delete security mark - * * @param securityGroupId The key for the security group id. * @param securityMarkId The key for the security mark id. * @returns Promise diff --git a/lib/js-api/src/api/gs-classification-rest-api/model/path.ts b/lib/js-api/src/api/gs-classification-rest-api/model/path.ts index e91c3fd49e5..cf384e96953 100644 --- a/lib/js-api/src/api/gs-classification-rest-api/model/path.ts +++ b/lib/js-api/src/api/gs-classification-rest-api/model/path.ts @@ -21,4 +21,4 @@ import { PathElement } from '../../content-rest-api'; * An ordered list of ancestors starting with the classification guide and ending with the parent of this topic. * This field is only returned when requested. */ -export interface Path extends Array {} +export type Path = Array; diff --git a/lib/js-api/src/api/gs-classification-rest-api/model/securityMarks.ts b/lib/js-api/src/api/gs-classification-rest-api/model/securityMarks.ts index 9af6ce70de3..014d5254398 100644 --- a/lib/js-api/src/api/gs-classification-rest-api/model/securityMarks.ts +++ b/lib/js-api/src/api/gs-classification-rest-api/model/securityMarks.ts @@ -17,4 +17,4 @@ import { SecurityMark } from './securityMark'; -export interface SecurityMarks extends Array {} +export type SecurityMarks = Array; diff --git a/lib/js-api/src/api/gs-classification-rest-api/model/securityMarksBody.ts b/lib/js-api/src/api/gs-classification-rest-api/model/securityMarksBody.ts index 2f74a24451f..9de2653239f 100644 --- a/lib/js-api/src/api/gs-classification-rest-api/model/securityMarksBody.ts +++ b/lib/js-api/src/api/gs-classification-rest-api/model/securityMarksBody.ts @@ -17,4 +17,4 @@ import { SecurityMarkBody } from './securityMarkBody'; -export interface SecurityMarksBody extends Array {} +export type SecurityMarksBody = Array; diff --git a/lib/js-api/src/api/gs-core-rest-api/api/filePlans.api.ts b/lib/js-api/src/api/gs-core-rest-api/api/filePlans.api.ts index dbdefe2e353..1d846c69070 100644 --- a/lib/js-api/src/api/gs-core-rest-api/api/filePlans.api.ts +++ b/lib/js-api/src/api/gs-core-rest-api/api/filePlans.api.ts @@ -31,7 +31,6 @@ import { RecordsIncludeQuery, RecordsPagingQuery, RecordsSourceQuery } from './t export class FilePlansApi extends BaseApi { /** * Create record categories for a file plan - * * @param filePlanId The identifier of a file plan. You can also use the -filePlan- alias. * @param nodeBodyCreate The node information to create. * @param opts Optional parameters @@ -73,7 +72,6 @@ export class FilePlansApi extends BaseApi { * * Mandatory fields and the file plan's aspects and properties are returned by default. * You can use the **include** parameter (include=allowableOperations) to return additional information. - * * @param filePlanId The identifier of a file plan. You can also use the -filePlan- alias. * @param opts Optional parameters * @returns Promise @@ -103,7 +101,6 @@ export class FilePlansApi extends BaseApi { * * Minimal information for each child is returned by default. * You can use the **include** parameter (include=allowableOperations) to return additional information. - * * @param filePlanId The identifier of a file plan. You can also use the -filePlan- alias. * @param opts Optional parameters * @returns Promise @@ -135,7 +132,6 @@ export class FilePlansApi extends BaseApi { * Update a file plan * * **Note:** Currently there is no optimistic locking for updates, so they are applied in \"last one wins\" order. - * * @param filePlanId The identifier of a file plan. You can also use the -filePlan- alias. * @param filePlanBodyUpdate The file plan information to update. * @param opts Optional parameters diff --git a/lib/js-api/src/api/gs-core-rest-api/api/files.api.ts b/lib/js-api/src/api/gs-core-rest-api/api/files.api.ts index 61f95e0193d..5e453ce5f4e 100644 --- a/lib/js-api/src/api/gs-core-rest-api/api/files.api.ts +++ b/lib/js-api/src/api/gs-core-rest-api/api/files.api.ts @@ -23,7 +23,6 @@ import { RecordsIncludeQuery } from './types'; /** * Files service. - * * @module FilesApi */ export class FilesApi extends BaseApi { @@ -31,7 +30,6 @@ export class FilesApi extends BaseApi { * Declare as record * * Declares the file **fileId** in the unfiled records container. The original file is moved to the Records Management site and a secondary parent association is created in the file's original site. - * * @param fileId The identifier of a non-record file. * @param opts Optional parameters * @param opts.hideRecord Flag to indicate whether the record should be hidden from the current parent folder. (default to false) diff --git a/lib/js-api/src/api/gs-core-rest-api/api/gsSites.api.ts b/lib/js-api/src/api/gs-core-rest-api/api/gsSites.api.ts index 0f7e8010862..d696fabf737 100644 --- a/lib/js-api/src/api/gs-core-rest-api/api/gsSites.api.ts +++ b/lib/js-api/src/api/gs-core-rest-api/api/gsSites.api.ts @@ -30,7 +30,6 @@ export class GsSitesApi extends BaseApi { * * The creator will be added as a member with Site Manager role. * When you create the RM site, the **filePlan** structure is also created including special containers, such as containers for transfers, holds and, unfiled records. - * * @param siteBodyCreate The site details * @param opts Optional parameters * @param opts.skipAddToFavorites Flag to indicate whether the RM site should not be added to the user's site favorites. (default to false) @@ -48,7 +47,6 @@ export class GsSitesApi extends BaseApi { /** * Delete the Records Management (RM) site - * * @returns Promise<{}> */ deleteRMSite(): Promise { @@ -59,7 +57,6 @@ export class GsSitesApi extends BaseApi { /** * Get the Records Management (RM) site - * * @param opts Optional parameters * @returns Promise */ @@ -79,7 +76,6 @@ export class GsSitesApi extends BaseApi { * * Update the details for the RM site. Site Manager or other (site) admin can update title or description. * **Note**: the id, site visibility, or compliance of the RM site cannot be updated once the site has been created. - * * @param siteBodyUpdate The RM site information to update. * @param opts Optional parameters * @returns Promise diff --git a/lib/js-api/src/api/gs-core-rest-api/api/legal-hold.api.ts b/lib/js-api/src/api/gs-core-rest-api/api/legal-hold.api.ts index f3109fb5d7b..71ba1860e74 100644 --- a/lib/js-api/src/api/gs-core-rest-api/api/legal-hold.api.ts +++ b/lib/js-api/src/api/gs-core-rest-api/api/legal-hold.api.ts @@ -24,13 +24,11 @@ import { HoldBulkStatusEntry } from '../model/holdBulkStatusEntry'; /** * Legal Holds service. - * * @module LegalHoldApi */ export class LegalHoldApi extends BaseApi { /** * List of legal holds - * * @param filePlanId The identifier of a file plan. You can also use the -filePlan- alias. * @param options Optional parameters * @returns Promise @@ -57,7 +55,6 @@ export class LegalHoldApi extends BaseApi { /** * Assign node to legal hold - * * @param holdId The identifier of a hold * @param nodeId The id of the node to be assigned to existing hold * @returns Promise @@ -76,7 +73,6 @@ export class LegalHoldApi extends BaseApi { /** * Assign nodes to legal hold - * * @param holdId The identifier of a hold * @param nodeIds The list with id of nodes to assign to existing hold * @returns Promise @@ -95,7 +91,6 @@ export class LegalHoldApi extends BaseApi { /** * Deletes the relationship between a child with id nodeId and a parent hold with id holdId - * * @param holdId The identifier of a hold * @param nodeId The Id of the node which is unassigned * @returns Empty response @@ -112,7 +107,6 @@ export class LegalHoldApi extends BaseApi { /** * Create new hold - * * @param filePlanId The identifier of a file plan. You can also use the -filePlan- alias. * @param hold Hold to create * @returns Promise @@ -135,7 +129,6 @@ export class LegalHoldApi extends BaseApi { /** * Create list of new holds - * * @param filePlanId The identifier of a file plan. You can also use the -filePlan- alias. * @param holds Array of holds * @returns Promise @@ -158,7 +151,6 @@ export class LegalHoldApi extends BaseApi { /** * Start the asynchronous bulk process for a hold with id holdId based on search query results. - * * @param holdId The identifier of a hold * @param query Search query * @returns Promise @@ -179,7 +171,6 @@ export class LegalHoldApi extends BaseApi { /** * Get status of bulk operation with **bulkStatusId** for **holdId**. - * * @param bulkStatusId The identifier of a bulk status * @param holdId The identifier of a hold * @returns Promise diff --git a/lib/js-api/src/api/gs-core-rest-api/api/recordCategories.api.ts b/lib/js-api/src/api/gs-core-rest-api/api/recordCategories.api.ts index 0cc6eb03b98..f4e28c49461 100644 --- a/lib/js-api/src/api/gs-core-rest-api/api/recordCategories.api.ts +++ b/lib/js-api/src/api/gs-core-rest-api/api/recordCategories.api.ts @@ -33,7 +33,6 @@ import { RecordsIncludeQuery, RecordsPagingQuery, RecordsSourceQuery } from './t export class RecordCategoriesApi extends BaseApi { /** * Create a record category or a record folder - * * @param recordCategoryId The identifier of a record category. * @param nodeBodyCreate The node information to create. * @param opts Optional parameters @@ -71,7 +70,6 @@ export class RecordCategoriesApi extends BaseApi { /** * Delete a record category - * * @param recordCategoryId The identifier of a record category. * @returns Promise<{}> */ @@ -93,7 +91,6 @@ export class RecordCategoriesApi extends BaseApi { * * Mandatory fields and the record category's aspects and properties are returned by default. * You can use the **include** parameter (include=allowableOperations) to return additional information. - * * @param recordCategoryId The identifier of a record category. * @param opts Optional parameters * @param opts.relativePath Return information on children in the record category resolved by this path. The path is relative to **recordCategoryId**. @@ -132,7 +129,6 @@ export class RecordCategoriesApi extends BaseApi { * You can use the **include** parameter (include=allowableOperations) to return additional information. * * The list of child nodes includes primary children and secondary children, if there are any. - * * @param recordCategoryId The identifier of a record category. * @param opts Optional parameters * @param opts.where Optionally filter the list. Here are some examples: @@ -180,7 +176,6 @@ export class RecordCategoriesApi extends BaseApi { * * **Note:** If you want to add or remove aspects, then you must use **GET /record-categories/{recordCategoryId}** first to get the complete set of *aspectNames*. * **Note:** Currently there is no optimistic locking for updates, so they are applied in \"last one wins\" order. - * * @param recordCategoryId The identifier of a record category. * @param recordCategoryBodyUpdate The record category information to update. * @param opts Optional parameters diff --git a/lib/js-api/src/api/gs-core-rest-api/api/recordFolders.api.ts b/lib/js-api/src/api/gs-core-rest-api/api/recordFolders.api.ts index 0d5963c02f8..4a70ccd0d97 100644 --- a/lib/js-api/src/api/gs-core-rest-api/api/recordFolders.api.ts +++ b/lib/js-api/src/api/gs-core-rest-api/api/recordFolders.api.ts @@ -30,7 +30,6 @@ export class RecordFoldersApi extends BaseApi { * * Create a record as a primary child of **recordFolderId**. * This endpoint supports both JSON and multipart/form-data (file upload). - * * @param recordFolderId The identifier of a record folder. * @param recordBodyCreate The record information to create. This field is ignored for multipart/form-data content uploads. * @param opts Optional parameters @@ -61,7 +60,6 @@ export class RecordFoldersApi extends BaseApi { /** * Deletes record folder **recordFolderId**. * Deleted file plan components cannot be recovered, they are deleted permanently. - * * @param recordFolderId The identifier of a record folder. * @returns Promise<{}> */ @@ -83,7 +81,6 @@ export class RecordFoldersApi extends BaseApi { * * Mandatory fields and the record folder's aspects and properties are returned by default. * You can use the **include** parameter (include=allowableOperations) to return additional information. - * * @param recordFolderId The identifier of a record folder. * @param opts Optional parameters * @returns Promise @@ -114,7 +111,6 @@ export class RecordFoldersApi extends BaseApi { * Minimal information for each record is returned by default. * The list of records includes primary children and secondary children, if there are any. * You can use the **include** parameter (include=allowableOperations) to return additional information. - * * @param recordFolderId The identifier of a record folder. * @param opts Optional parameters * @param opts.where Optionally filter the list. Here are some examples: @@ -159,7 +155,6 @@ export class RecordFoldersApi extends BaseApi { * * **Note:** if you want to add or remove aspects, then you must use **GET /record-folders/{recordFolderId}** first to get the complete set of *aspectNames*. * **Note:** Currently there is no optimistic locking for updates, so they are applied in \"last one wins\" order. - * * @param recordFolderId The identifier of a record folder. * @param recordFolderBodyUpdate The record folder information to update. * @param opts Optional parameters diff --git a/lib/js-api/src/api/gs-core-rest-api/api/records.api.ts b/lib/js-api/src/api/gs-core-rest-api/api/records.api.ts index 1ed06c2aeef..724adcf9607 100644 --- a/lib/js-api/src/api/gs-core-rest-api/api/records.api.ts +++ b/lib/js-api/src/api/gs-core-rest-api/api/records.api.ts @@ -25,13 +25,11 @@ import { RecordsIncludeQuery } from './types'; /** * Records service. - * * @module RecordsApi */ export class RecordsApi extends BaseApi { /** * Complete a record - * * @param recordId The identifier of a record. * @param opts Optional parameters * @returns Promise @@ -58,7 +56,6 @@ export class RecordsApi extends BaseApi { /** * Delete a record. Deleted file plan components cannot be recovered, they are deleted permanently. - * * @param recordId The identifier of a record. * @returns Promise<{}> */ @@ -81,7 +78,6 @@ export class RecordsApi extends BaseApi { * You need to specify the target record folder by providing its id **targetParentId** * If the record is already filed, a link to the target record folder is created. * You can use the **include** parameter (include=allowableOperations) to return additional information. - * * @param recordId The identifier of a record. * @param nodeBodyFile The target record folder id * @param opts Optional parameters @@ -114,7 +110,6 @@ export class RecordsApi extends BaseApi { * * Mandatory fields and the record's aspects and properties are returned by default. * You can use the **include** parameter (include=allowableOperations) to return additional information. - * * @param recordId The identifier of a record. * @param opts Optional parameters * @returns Promise @@ -141,7 +136,6 @@ export class RecordsApi extends BaseApi { /** * Get record content - * * @param recordId The identifier of a record. * @param opts Optional parameters * @param opts.attachment **true** enables a web browser to download the file as an attachment. @@ -191,22 +185,21 @@ export class RecordsApi extends BaseApi { * Updates the record **recordId**. For example, you can rename a record: * JSON * { - * \"name\":\"My new name\" + * \"name\":\"My new name\" * } * * You can also set or update one or more properties: * JSON * { - * \"properties\": - * { - * \"cm:title\":\"New title\", - * \"cm:description\":\"New description\" - * } + * \"properties\": + * { + * \"cm:title\":\"New title\", + * \"cm:description\":\"New description\" + * } * } * * **Note:** if you want to add or remove aspects, then you must use **GET /records/{recordId}** first to get the complete set of *aspectNames*. * **Note:** Currently there is no optimistic locking for updates, so they are applied in \"last one wins\" order. - * * @param recordId The identifier of a record. * @param recordBodyUpdate The record information to update. * @param opts Optional parameters diff --git a/lib/js-api/src/api/gs-core-rest-api/api/transferContainers.api.ts b/lib/js-api/src/api/gs-core-rest-api/api/transferContainers.api.ts index 2d2c989e445..1aa5ca8c0c8 100644 --- a/lib/js-api/src/api/gs-core-rest-api/api/transferContainers.api.ts +++ b/lib/js-api/src/api/gs-core-rest-api/api/transferContainers.api.ts @@ -32,7 +32,6 @@ export class TransferContainersApi extends BaseApi { * * Mandatory fields and the transfer container's aspects and properties are returned by default. * You can use the **include** parameter (include=allowableOperations) to return additional information. - * * @param transferContainerId The identifier of a transfer container. You can also use the -transfers- alias. * @param opts Optional parameters * @returns Promise @@ -62,7 +61,6 @@ export class TransferContainersApi extends BaseApi { * * Minimal information for each child is returned by default. * You can use the **include** parameter (include=allowableOperations) to return additional information. - * * @param transferContainerId The identifier of a transfer container. You can also use the -transfers- alias. * @param opts Optional parameters * @returns Promise @@ -96,7 +94,6 @@ export class TransferContainersApi extends BaseApi { /** * Update transfer container - * * @param transferContainerId The identifier of a transfer container. You can also use the -transfers- alias. * @param nodeBodyUpdate The node information to update. * @param opts Optional parameters diff --git a/lib/js-api/src/api/gs-core-rest-api/api/transfers.api.ts b/lib/js-api/src/api/gs-core-rest-api/api/transfers.api.ts index 7bd5311ae98..3c1657d7ea3 100644 --- a/lib/js-api/src/api/gs-core-rest-api/api/transfers.api.ts +++ b/lib/js-api/src/api/gs-core-rest-api/api/transfers.api.ts @@ -24,7 +24,6 @@ import { RecordsIncludeQuery, RecordsPagingQuery, RecordsSourceQuery } from './t /** * Transfers service. - * * @module TransfersApi */ export class TransfersApi extends BaseApi { @@ -33,7 +32,6 @@ export class TransfersApi extends BaseApi { * * Mandatory fields and the transfer's aspects and properties are returned by default. * You can use the **include** parameter (include=allowableOperations) to return additional information. - * * @param transferId The identifier of a transfer. * @param opts Optional parameters * @returns Promise @@ -63,7 +61,6 @@ export class TransfersApi extends BaseApi { * * Minimal information for each child is returned by default. * You can use the **include** parameter (include=allowableOperations) to return additional information. - * * @param transferId The identifier of a transfer. * @param opts Optional parameters * @returns Promise diff --git a/lib/js-api/src/api/gs-core-rest-api/api/unfiledContainers.api.ts b/lib/js-api/src/api/gs-core-rest-api/api/unfiledContainers.api.ts index 594ea15781c..6884ecd4adf 100644 --- a/lib/js-api/src/api/gs-core-rest-api/api/unfiledContainers.api.ts +++ b/lib/js-api/src/api/gs-core-rest-api/api/unfiledContainers.api.ts @@ -23,13 +23,11 @@ import { RecordsIncludeQuery, RecordsPagingQuery, RecordsSourceQuery } from './t /** * Unfiled containers service. - * * @module UnfiledContainersApi */ export class UnfiledContainersApi extends BaseApi { /** * Creates a record or an unfiled record folder as a primary child of **unfiledContainerId**. - * * @param unfiledContainerId The identifier of an unfiled records container. You can use the **-unfiled-** alias. * @param nodeBodyCreate The node information to create. * @param opts Optional parameters @@ -75,7 +73,6 @@ export class UnfiledContainersApi extends BaseApi { * Mandatory fields and the unfiled records container's aspects and properties are returned by default. * * You can use the **include** parameter (include=allowableOperations) to return additional information. - * * @param unfiledContainerId The identifier of an unfiled records container. You can use the **-unfiled-** alias. * @param opts Optional parameters * @returns Promise @@ -107,7 +104,6 @@ export class UnfiledContainersApi extends BaseApi { * * Minimal information for each child is returned by default. * You can use the **include** parameter (include=allowableOperations) to return additional information. - * * @param unfiledContainerId The identifier of an unfiled records container. You can use the **-unfiled-** alias. * @param opts Optional parameters * @param opts.where Optionally filter the list. Here are some examples: @@ -152,7 +148,6 @@ export class UnfiledContainersApi extends BaseApi { * Update an unfiled record container * * **Note:** Currently there is no optimistic locking for updates, so they are applied in \"last one wins\" order. - * * @param unfiledContainerId The identifier of an unfiled records container. You can use the **-unfiled-** alias. * @param unfiledContainerBodyUpdate The unfiled record container information to update. * @param opts Optional parameters diff --git a/lib/js-api/src/api/gs-core-rest-api/api/unfiledRecordFolders.api.ts b/lib/js-api/src/api/gs-core-rest-api/api/unfiledRecordFolders.api.ts index 9c0d27cd70b..70f2b83c992 100644 --- a/lib/js-api/src/api/gs-core-rest-api/api/unfiledRecordFolders.api.ts +++ b/lib/js-api/src/api/gs-core-rest-api/api/unfiledRecordFolders.api.ts @@ -26,13 +26,11 @@ import { RecordsIncludeQuery, RecordsPagingQuery, RecordsSourceQuery } from './t /** * UnfiledRecordFoldersApi service. - * * @module UnfiledRecordFoldersApi */ export class UnfiledRecordFoldersApi extends BaseApi { /** * Create a record or an unfiled record folder - * * @param unfiledRecordFolderId The identifier of an unfiled record folder. * @param nodeBodyCreate The node information to create. * @param opts Optional parameters @@ -71,7 +69,6 @@ export class UnfiledRecordFoldersApi extends BaseApi { /** * Delete an unfiled record folder. Deleted file plan components cannot be recovered, they are deleted permanently. - * * @param unfiledRecordFolderId The identifier of an unfiled record folder. * @returns Promise<{}> */ @@ -93,7 +90,6 @@ export class UnfiledRecordFoldersApi extends BaseApi { * * Mandatory fields and the unfiled record folder's aspects and properties are returned by default. * You can use the **include** parameter (include=allowableOperations) to return additional information. - * * @param unfiledRecordFolderId The identifier of an unfiled record folder. * @param opts Optional parameters * @param opts.relativePath Return information on children in the unfiled records container resolved by this path. The path is relative to **unfiledRecordFolderId**. @@ -130,7 +126,6 @@ export class UnfiledRecordFoldersApi extends BaseApi { * * Minimal information for each child is returned by default. * You can use the **include** parameter (include=allowableOperations) to return additional information. - * * @param unfiledRecordFolderId The identifier of an unfiled record folder. * @param opts Optional parameters * @param opts.where Optionally filter the list. Here are some examples: @@ -177,7 +172,6 @@ export class UnfiledRecordFoldersApi extends BaseApi { /** * Updates unfiled record folder **unfiledRecordFolderId**. * For example, you can rename a record folder: - * * @param unfiledRecordFolderId The identifier of an unfiled record folder. * @param unfiledRecordFolderBodyUpdate The record folder information to update. * @param opts Optional parameters diff --git a/lib/js-api/src/api/hxi-connector-api/api/predictions.api.ts b/lib/js-api/src/api/hxi-connector-api/api/predictions.api.ts index eb97b1a25f9..b9661780d06 100644 --- a/lib/js-api/src/api/hxi-connector-api/api/predictions.api.ts +++ b/lib/js-api/src/api/hxi-connector-api/api/predictions.api.ts @@ -22,7 +22,6 @@ import { PredictionPaging, ReviewStatus } from '../model'; export class PredictionsApi extends BaseApi { /** * List of predictions for a node - * * @param nodeId The identifier of a node. * @returns Promise */ @@ -42,7 +41,6 @@ export class PredictionsApi extends BaseApi { /** * Confirm or reject a prediction - * * @param predictionId The identifier of a prediction. * @param reviewStatus New status to apply for prediction. Can be either 'confirmed' or 'rejected'. * @returns Promise diff --git a/lib/js-api/src/api/model-rest-api/api/aspects.api.ts b/lib/js-api/src/api/model-rest-api/api/aspects.api.ts index 95ad879a2b1..1ab4818b660 100644 --- a/lib/js-api/src/api/model-rest-api/api/aspects.api.ts +++ b/lib/js-api/src/api/model-rest-api/api/aspects.api.ts @@ -68,7 +68,6 @@ export class AspectsApi extends BaseApi { * Get an aspect * * **Note:** This is available in Alfresco 7.0.0 and newer versions. - * * @param aspectId The `Qname` of an aspect(prefix:name) e.g 'cm:title' * @returns Promise */ @@ -90,7 +89,6 @@ export class AspectsApi extends BaseApi { * List aspects * * **Note:** This is available in Alfresco 7.0.0 and newer versions. - * * @param opts Optional parameters * @returns Promise */ diff --git a/lib/js-api/src/api/model-rest-api/api/types.api.ts b/lib/js-api/src/api/model-rest-api/api/types.api.ts index 3f64271c02c..b2d7e1e1948 100644 --- a/lib/js-api/src/api/model-rest-api/api/types.api.ts +++ b/lib/js-api/src/api/model-rest-api/api/types.api.ts @@ -65,7 +65,6 @@ export class TypesApi extends BaseApi { * Get a type * * **Note:** This is available in Alfresco 7.0.0 and newer versions. - * * @param typeId The `Qname` of a type(prefix:name) e.g 'cm:content' * @returns Promise */ @@ -87,7 +86,6 @@ export class TypesApi extends BaseApi { * List types * * **Note:** This is available in Alfresco 7.0.0 and newer versions. - * * @param opts Optional parameters * @returns Promise */ diff --git a/lib/js-api/src/api/search-rest-api/api/search.api.ts b/lib/js-api/src/api/search-rest-api/api/search.api.ts index f832d8a020c..bd9fd33ed9e 100644 --- a/lib/js-api/src/api/search-rest-api/api/search.api.ts +++ b/lib/js-api/src/api/search-rest-api/api/search.api.ts @@ -23,7 +23,6 @@ import { LegacyHttpClient } from '../../../api-clients/http-client.interface'; /** * Search service. - * * @module SearchApi */ export class SearchApi extends ApiClient { @@ -35,7 +34,6 @@ export class SearchApi extends ApiClient { * Searches Alfresco * * **Note**: this endpoint is available in Alfresco 5.2 and newer versions. - * * @param queryBody Generic query API * @returns Promise */ diff --git a/lib/js-api/src/api/search-rest-api/model/requestFacetQueries.ts b/lib/js-api/src/api/search-rest-api/model/requestFacetQueries.ts index dae8a4c8a10..56820fba4db 100644 --- a/lib/js-api/src/api/search-rest-api/model/requestFacetQueries.ts +++ b/lib/js-api/src/api/search-rest-api/model/requestFacetQueries.ts @@ -20,4 +20,4 @@ import { RequestFacetQueriesInner } from './requestFacetQueriesInner'; /** * Facet queries to include */ -export interface RequestFacetQueries extends Array {} +export type RequestFacetQueries = Array; diff --git a/lib/js-api/src/api/search-rest-api/model/requestFields.ts b/lib/js-api/src/api/search-rest-api/model/requestFields.ts index 84a54590fa2..640836e4143 100644 --- a/lib/js-api/src/api/search-rest-api/model/requestFields.ts +++ b/lib/js-api/src/api/search-rest-api/model/requestFields.ts @@ -21,4 +21,4 @@ You can use this parameter to restrict the fields returned within a response if, The list applies to a returned individual entity or entries within a collection. If the **include** parameter is used as well then the fields specified in the **include** parameter are returned in addition to those specified in the **fields** parameter. */ -export interface RequestFields extends Array {} +export type RequestFields = Array; diff --git a/lib/js-api/src/api/search-rest-api/model/requestFilterQueries.ts b/lib/js-api/src/api/search-rest-api/model/requestFilterQueries.ts index fe1624fcff7..e18c88ea5f7 100644 --- a/lib/js-api/src/api/search-rest-api/model/requestFilterQueries.ts +++ b/lib/js-api/src/api/search-rest-api/model/requestFilterQueries.ts @@ -20,4 +20,4 @@ import { RequestFilterQueriesInner } from './requestFilterQueriesInner'; /** * Filter Queries. Constraints that apply to the results set but do not affect the score of each entry. */ -export interface RequestFilterQueries extends Array {} +export type RequestFilterQueries = Array; diff --git a/lib/js-api/src/api/search-rest-api/model/requestInclude.ts b/lib/js-api/src/api/search-rest-api/model/requestInclude.ts index 54b922006eb..1018f8d9c79 100644 --- a/lib/js-api/src/api/search-rest-api/model/requestInclude.ts +++ b/lib/js-api/src/api/search-rest-api/model/requestInclude.ts @@ -24,4 +24,4 @@ * allowableOperations * association */ -export interface RequestInclude extends Array {} +export type RequestInclude = Array; diff --git a/lib/js-api/src/api/search-rest-api/model/requestSortDefinition.ts b/lib/js-api/src/api/search-rest-api/model/requestSortDefinition.ts index b4ce67a30d5..ec04861d964 100644 --- a/lib/js-api/src/api/search-rest-api/model/requestSortDefinition.ts +++ b/lib/js-api/src/api/search-rest-api/model/requestSortDefinition.ts @@ -20,4 +20,4 @@ import { RequestSortDefinitionInner } from './requestSortDefinitionInner'; /** * How to sort the rows? An array of sort specifications. The array order defines the ordering precedence. */ -export interface RequestSortDefinition extends Array {} +export type RequestSortDefinition = Array; diff --git a/lib/js-api/src/api/search-rest-api/model/requestTemplates.ts b/lib/js-api/src/api/search-rest-api/model/requestTemplates.ts index 3705380fca5..4e86baad3da 100644 --- a/lib/js-api/src/api/search-rest-api/model/requestTemplates.ts +++ b/lib/js-api/src/api/search-rest-api/model/requestTemplates.ts @@ -24,4 +24,4 @@ import { RequestTemplatesInner } from './requestTemplatesInner'; * to generate * cm:name:example cm:name:example */ -export interface RequestTemplates extends Array {} +export type RequestTemplates = Array; diff --git a/lib/js-api/src/assert.ts b/lib/js-api/src/assert.ts index 781d668ecf1..4871478ebfe 100644 --- a/lib/js-api/src/assert.ts +++ b/lib/js-api/src/assert.ts @@ -17,7 +17,6 @@ /** * Throw exception if param is not defined - * * @param param param * @param name param name */ diff --git a/lib/js-api/src/authentication/contentAuth.ts b/lib/js-api/src/authentication/contentAuth.ts index a3a54a2e55c..b671945ddef 100644 --- a/lib/js-api/src/authentication/contentAuth.ts +++ b/lib/js-api/src/authentication/contentAuth.ts @@ -68,7 +68,6 @@ export class ContentAuth extends AlfrescoApiClient { /** * login Alfresco API - * * @param username Username to login * @param password Password to login * @returns A promise that returns {new authentication ticket} if resolved and {error} if rejected. @@ -111,7 +110,6 @@ export class ContentAuth extends AlfrescoApiClient { /** * validate the ticket present in this.config.ticket against the server - * * @returns A promise that returns if resolved and {error} if rejected. */ validateTicket(): Promise { @@ -141,7 +139,6 @@ export class ContentAuth extends AlfrescoApiClient { /** * logout Alfresco API - * * @returns A promise that returns { authentication ticket} if resolved and {error} if rejected. */ logout(): Promise { @@ -180,7 +177,6 @@ export class ContentAuth extends AlfrescoApiClient { /** * Get the current Ticket - * * @returns ticket value */ getTicket(): string { @@ -197,7 +193,6 @@ export class ContentAuth extends AlfrescoApiClient { /** * If the client is logged in return true - * * @returns `true` if client is logged in, otherwise `false` */ isLoggedIn(): boolean { @@ -206,7 +201,6 @@ export class ContentAuth extends AlfrescoApiClient { /** * return the Authentication - * * @returns authentication object */ getAuthentication(): Authentication { diff --git a/lib/js-api/src/authentication/oauth2Auth.ts b/lib/js-api/src/authentication/oauth2Auth.ts index 3a49fa5074e..c67d19b8aec 100644 --- a/lib/js-api/src/authentication/oauth2Auth.ts +++ b/lib/js-api/src/authentication/oauth2Auth.ts @@ -561,7 +561,6 @@ export class Oauth2Auth extends AlfrescoApiClient { /** * login Alfresco API - * * @returns A promise that returns {new authentication token} if resolved and {error} if rejected. */ login(username: string, password: string): Promise { @@ -622,7 +621,6 @@ export class Oauth2Auth extends AlfrescoApiClient { /** * Refresh the Token - * * @returns promise of void */ refreshToken(): Promise { @@ -686,7 +684,6 @@ export class Oauth2Auth extends AlfrescoApiClient { /** * Get the current Token - * * @returns token value */ getToken(): string { @@ -695,7 +692,6 @@ export class Oauth2Auth extends AlfrescoApiClient { /** * return the Authentication - * * @returns authentications */ getAuthentication(): Authentication { @@ -711,7 +707,6 @@ export class Oauth2Auth extends AlfrescoApiClient { /** * If the client is logged in return true - * * @returns is logged in */ isLoggedIn(): boolean { diff --git a/lib/js-api/src/authentication/processAuth.ts b/lib/js-api/src/authentication/processAuth.ts index 109bb714581..131ecc82d4c 100644 --- a/lib/js-api/src/authentication/processAuth.ts +++ b/lib/js-api/src/authentication/processAuth.ts @@ -77,7 +77,6 @@ export class ProcessAuth extends AlfrescoApiClient { /** * login Activiti API - * * @param username Username to login * @param password Password to login * @returns A promise that returns {new authentication ticket} if resolved and {error} if rejected. @@ -130,7 +129,6 @@ export class ProcessAuth extends AlfrescoApiClient { /** * logout Alfresco API - * * @returns A promise that returns {new authentication ticket} if resolved and {error} if rejected. */ logout(): AlfrescoApiClientPromise { @@ -162,7 +160,6 @@ export class ProcessAuth extends AlfrescoApiClient { /** * Set the current Ticket - * * @param ticket Ticket value */ setTicket(ticket: string) { @@ -184,7 +181,6 @@ export class ProcessAuth extends AlfrescoApiClient { /** * Get the current Ticket - * * @returns ticket */ getTicket(): string { @@ -193,7 +189,6 @@ export class ProcessAuth extends AlfrescoApiClient { /** * If the client is logged in return true - * * @returns `true` if logged in, otherwise `false` */ isLoggedIn(): boolean { @@ -202,7 +197,6 @@ export class ProcessAuth extends AlfrescoApiClient { /** * return the Authentication - * * @returns authentication object */ getAuthentication(): Authentication { diff --git a/lib/js-api/src/contentClient.ts b/lib/js-api/src/contentClient.ts index 9f4fc8c7921..8893c3d69ea 100644 --- a/lib/js-api/src/contentClient.ts +++ b/lib/js-api/src/contentClient.ts @@ -44,7 +44,6 @@ export class ContentClient extends AlfrescoApiClient { /** * set the Authentications - * * @param authentications authentications */ setAuthentications(authentications: Authentication): void { diff --git a/lib/js-api/src/processClient.ts b/lib/js-api/src/processClient.ts index d532207a882..189e323d4a9 100644 --- a/lib/js-api/src/processClient.ts +++ b/lib/js-api/src/processClient.ts @@ -42,7 +42,6 @@ export class ProcessClient extends AlfrescoApiClient { /** * set the authentications - * * @param authentications Authentications value */ setAuthentications(authentications: Authentication) { diff --git a/lib/js-api/src/superagentHttpClient.ts b/lib/js-api/src/superagentHttpClient.ts index 5a5a636b978..efe17156c6d 100644 --- a/lib/js-api/src/superagentHttpClient.ts +++ b/lib/js-api/src/superagentHttpClient.ts @@ -115,7 +115,7 @@ export class SuperagentHttpClient implements HttpClient { }); }); - promise.abort = function() { + promise.abort = function () { request.abort(); return this; }; @@ -236,7 +236,6 @@ export class SuperagentHttpClient implements HttpClient { /** * Applies authentication headers to the request. - * * @param request The request object created by a superagent() call. * @param authentications authentications */ @@ -291,7 +290,6 @@ export class SuperagentHttpClient implements HttpClient { /** * Deserializes an HTTP response body into a value of the specified type. - * * @param response A SuperAgent response object. * @param returnType The type to return. Pass a string for simple types * or the constructor function for a complex type. Pass an array containing the type name to return an array of that type. To @@ -332,7 +330,6 @@ export class SuperagentHttpClient implements HttpClient { *

  • keep files and arrays
    • *
  • format to string with `paramToString` for other cases
    • * - * * @param params The parameters as object properties. * @returns normalized parameters. */ @@ -354,7 +351,6 @@ export class SuperagentHttpClient implements HttpClient { /** * Checks whether the given parameter value represents file-like content. - * * @param param The parameter to check. * @returns true if param represents a file. */ diff --git a/lib/js-api/src/utils/param-to-string.ts b/lib/js-api/src/utils/param-to-string.ts index 1267bebab4b..1e2b2588f70 100644 --- a/lib/js-api/src/utils/param-to-string.ts +++ b/lib/js-api/src/utils/param-to-string.ts @@ -17,7 +17,6 @@ /** * Returns a string representation for an actual parameter. - * * @param param The actual parameter. * @returns The string representation of param. */ diff --git a/lib/process-services-cloud/.eslintrc.json b/lib/process-services-cloud/.eslintrc.json index a49f042f37b..9726a858abd 100644 --- a/lib/process-services-cloud/.eslintrc.json +++ b/lib/process-services-cloud/.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/process-services-cloud/src/lib/form/services/form-utils.service.spec.ts b/lib/process-services-cloud/src/lib/form/services/form-utils.service.spec.ts index 4b0d89d3fde..27bdf77e7f3 100644 --- a/lib/process-services-cloud/src/lib/form/services/form-utils.service.spec.ts +++ b/lib/process-services-cloud/src/lib/form/services/form-utils.service.spec.ts @@ -35,9 +35,7 @@ describe('FormUtilsService', () => { */ function testRestUrlVariablesMap(restUrl: string, inputBody: { [key: string]: any }, expected: { [key: string]: any }) { const formModel = new FormModel({ variables }); - spyOn(formModel, 'getProcessVariableValue').and.callFake((name) => { - return variables.find((variable) => variable.name === name)?.value; - }); + spyOn(formModel, 'getProcessVariableValue').and.callFake((name) => variables.find((variable) => variable.name === name)?.value); const result = service.getRestUrlVariablesMap(formModel, restUrl, inputBody); expect(result).toEqual(expected); } diff --git a/lib/process-services/.eslintrc.json b/lib/process-services/.eslintrc.json index c90bbe7f8c7..5a230a57574 100644 --- a/lib/process-services/.eslintrc.json +++ b/lib/process-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/process-services/src/lib/form/start-form/start-form.component.ts b/lib/process-services/src/lib/form/start-form/start-form.component.ts index 79b0ec3e584..549f672f247 100644 --- a/lib/process-services/src/lib/form/start-form/start-form.component.ts +++ b/lib/process-services/src/lib/form/start-form/start-form.component.ts @@ -140,7 +140,6 @@ export class StartFormComponent extends FormComponent implements OnChanges, OnIn this.onFormLoaded(this.form); } - /** @override */ isOutcomeButtonVisible(outcome: FormOutcomeModel, isFormReadOnly: boolean): boolean { if (outcome?.isSystem && (outcome.name === FormOutcomeModel.SAVE_ACTION || outcome.name === FormOutcomeModel.COMPLETE_ACTION)) { return false; @@ -150,12 +149,10 @@ export class StartFormComponent extends FormComponent implements OnChanges, OnIn return super.isOutcomeButtonVisible(outcome, isFormReadOnly); } - /** @override */ saveTaskForm() { // do nothing } - /** @override */ onRefreshClicked() { if (this.processDefinitionId) { this.visibilityService.cleanProcessVariable(); diff --git a/lib/process-services/src/lib/form/widgets/people/people.widget.ts b/lib/process-services/src/lib/form/widgets/people/people.widget.ts index 1d6e89720a8..33c1b9ffa79 100644 --- a/lib/process-services/src/lib/form/widgets/people/people.widget.ts +++ b/lib/process-services/src/lib/form/widgets/people/people.widget.ts @@ -128,9 +128,7 @@ export class PeopleWidgetComponent extends WidgetComponent implements OnInit { isValidUser(users: LightUserRepresentation[], name: string): boolean { if (users) { - return !!users.find((user) => { - return this.getDisplayName(user).toLocaleLowerCase() === name.toLocaleLowerCase(); - }); + return !!users.find((user) => this.getDisplayName(user).toLocaleLowerCase() === name.toLocaleLowerCase()); } return false; } diff --git a/lib/process-services/src/lib/people/components/people-search-field/people-search-field.component.spec.ts b/lib/process-services/src/lib/people/components/people-search-field/people-search-field.component.spec.ts index 5edfa4524be..f5311c86ffb 100644 --- a/lib/process-services/src/lib/people/components/people-search-field/people-search-field.component.spec.ts +++ b/lib/process-services/src/lib/people/components/people-search-field/people-search-field.component.spec.ts @@ -39,7 +39,7 @@ describe('PeopleSearchFieldComponent', () => { }); it('should have the proper placeholder by default', () => { - const input = element.querySelector('[data-automation-id="adf-people-search-input"]'); + const input = element.querySelector('[data-automation-id="adf-people-search-input"]') as HTMLInputElement; expect(input.placeholder).toBe('ADF_TASK_LIST.PEOPLE.SEARCH_USER'); }); @@ -49,7 +49,7 @@ describe('PeopleSearchFieldComponent', () => { fixture.detectChanges(); await fixture.whenStable(); - const input = element.querySelector('[data-automation-id="adf-people-search-input"]'); + const input = element.querySelector('[data-automation-id="adf-people-search-input"]') as HTMLInputElement; expect(input.placeholder).toBe('Arcadia Bay'); });