diff --git a/lib/content-services/src/lib/common/services/saved-searches.service.spec.ts b/lib/content-services/src/lib/common/services/saved-searches.service.spec.ts index fd6b85a46c..762e07ea2d 100644 --- a/lib/content-services/src/lib/common/services/saved-searches.service.spec.ts +++ b/lib/content-services/src/lib/common/services/saved-searches.service.spec.ts @@ -38,7 +38,6 @@ describe('SavedSearchesService', () => { /** * Creates a stub with Promise returning a Blob - * * @returns Promise with Blob */ function createBlob() { diff --git a/lib/content-services/src/lib/common/services/saved-searches.service.ts b/lib/content-services/src/lib/common/services/saved-searches.service.ts index bf3b00ee0a..9bdfa6788c 100644 --- a/lib/content-services/src/lib/common/services/saved-searches.service.ts +++ b/lib/content-services/src/lib/common/services/saved-searches.service.ts @@ -64,7 +64,6 @@ export class SavedSearchesService { /** * Gets a list of saved searches by user. - * * @returns SavedSearch list containing user saved searches */ getSavedSearches(): Observable { @@ -94,7 +93,6 @@ export class SavedSearchesService { /** * Saves a new search into state and updates state. If there are less than 5 searches, * it will be pushed on first place, if more it will be pushed to 6th place. - * * @param newSaveSearch object { name: string, description: string, encodedUrl: string } * @returns NodeEntry */ @@ -132,7 +130,6 @@ export class SavedSearchesService { /** * Replace Save Search with new one and also updates the state. - * * @param updatedSavedSearch - updated Save Search * @returns NodeEntry */ @@ -161,7 +158,6 @@ export class SavedSearchesService { /** * Deletes Save Search and update state. - * * @param deletedSavedSearch - Save Search to delete * @returns NodeEntry */ @@ -194,7 +190,6 @@ export class SavedSearchesService { /** * Reorders saved search place - * * @param previousIndex - previous index of saved search * @param currentIndex - new index of saved search */ diff --git a/lib/content-services/src/lib/search/services/base-query-builder.service.ts b/lib/content-services/src/lib/search/services/base-query-builder.service.ts index 6c9e3b172b..b5ab1304e9 100644 --- a/lib/content-services/src/lib/search/services/base-query-builder.service.ts +++ b/lib/content-services/src/lib/search/services/base-query-builder.service.ts @@ -202,7 +202,6 @@ export abstract class BaseQueryBuilderService { /** * Adds a facet bucket to a field. - * * @param field The target field * @param bucket Bucket to add */ @@ -219,7 +218,6 @@ export abstract class BaseQueryBuilderService { /** * Gets the buckets currently added to a field - * * @param field The target fields * @returns Bucket array */ @@ -229,7 +227,6 @@ export abstract class BaseQueryBuilderService { /** * Removes an existing bucket from a field. - * * @param field The target field * @param bucket Bucket to remove */ @@ -242,7 +239,6 @@ export abstract class BaseQueryBuilderService { /** * Adds a filter query to the current query. - * * @param query Query string to add */ addFilterQuery(query: string): void { @@ -257,7 +253,6 @@ export abstract class BaseQueryBuilderService { /** * Removes an existing filter query. - * * @param query The query to remove */ removeFilterQuery(query: string): void { @@ -269,7 +264,6 @@ export abstract class BaseQueryBuilderService { /** * Gets a facet query by label. - * * @param label Label of the query * @returns Facet query data */ @@ -285,7 +279,6 @@ export abstract class BaseQueryBuilderService { /** * Gets a facet field by label. - * * @param label Label of the facet field * @returns Facet field data */ @@ -311,7 +304,6 @@ export abstract class BaseQueryBuilderService { /** * Builds the current query and triggers the `updated` event. - * * @param queryBody query settings */ update(queryBody?: SearchRequest): void { @@ -321,7 +313,6 @@ export abstract class BaseQueryBuilderService { /** * Builds and executes the current query. - * * @param updateQueryParams whether query params should be updated with encoded query * @param queryBody query settings */ @@ -361,7 +352,6 @@ export abstract class BaseQueryBuilderService { /** * Builds the current query. - * * @returns The finished query */ buildQuery(): SearchRequest { @@ -402,7 +392,6 @@ export abstract class BaseQueryBuilderService { /** * Gets the primary sorting definition. - * * @returns The primary sorting definition */ getPrimarySorting(): SearchSortingDefinition { @@ -414,7 +403,6 @@ export abstract class BaseQueryBuilderService { /** * Gets all pre-configured sorting options that users can choose from. - * * @returns Pre-configured sorting options */ getSortingOptions(): SearchSortingDefinition[] { @@ -423,7 +411,6 @@ export abstract class BaseQueryBuilderService { /** * Gets the query group. - * * @param query Target query * @returns Query group */ @@ -433,7 +420,6 @@ export abstract class BaseQueryBuilderService { /** * Checks if FacetQueries has been defined - * * @returns True if defined, false otherwise */ get hasFacetQueries(): boolean { @@ -442,7 +428,6 @@ export abstract class BaseQueryBuilderService { /** * Checks if FacetIntervals has been defined - * * @returns True if defined, false otherwise */ get hasFacetIntervals(): boolean { @@ -563,7 +548,6 @@ export abstract class BaseQueryBuilderService { /** * Encloses a label name with double quotes if it contains whitespace characters. - * * @param configLabel Original label text * @returns Label, possibly with quotes if it contains spaces */ @@ -596,7 +580,6 @@ export abstract class BaseQueryBuilderService { /** * Builds search query with provided user query, executes query, encodes latest filter config and navigates to search. - * * @param query user query to search for * @param searchUrl search url to navigate to */ diff --git a/lib/core/src/lib/auth/oidc/auth.module.ts b/lib/core/src/lib/auth/oidc/auth.module.ts index c18bfe9abf..9e39a0e81d 100644 --- a/lib/core/src/lib/auth/oidc/auth.module.ts +++ b/lib/core/src/lib/auth/oidc/auth.module.ts @@ -15,10 +15,9 @@ * limitations under the License. */ -import { APP_INITIALIZER, ModuleWithProviders, NgModule } from '@angular/core'; +import { APP_INITIALIZER, inject, ModuleWithProviders, NgModule, InjectionToken } from '@angular/core'; import { AUTH_CONFIG, OAuthModule, OAuthStorage } from 'angular-oauth2-oidc'; import { AuthenticationService } from '../services/authentication.service'; -import { StorageService } from '../../common/services/storage.service'; import { AuthModuleConfig, AUTH_MODULE_CONFIG } from './auth-config'; import { authConfigFactory, AuthConfigService } from './auth-config.service'; import { AuthRoutingModule } from './auth-routing.module'; @@ -27,9 +26,16 @@ import { RedirectAuthService } from './redirect-auth.service'; import { AuthenticationConfirmationComponent } from './view/authentication-confirmation/authentication-confirmation.component'; import { HTTP_INTERCEPTORS } from '@angular/common/http'; import { TokenInterceptor } from './token.interceptor'; +import { StorageService } from '../../common/services/storage.service'; + +export const JWT_STORAGE_SERVICE = new InjectionToken('JWT_STORAGE_SERVICE', { + providedIn: 'root', + factory: () => inject(StorageService) +}); /** * Create a Login Factory function + * * @param redirectService auth redirect service * @returns a factory function */ @@ -37,11 +43,18 @@ export function loginFactory(redirectService: RedirectAuthService): () => Promis return () => redirectService.init(); } +/** + * @returns current instance of OAuthStorage + */ +export function oauthStorageFactory(): OAuthStorage { + return inject(JWT_STORAGE_SERVICE); +} + @NgModule({ declarations: [AuthenticationConfirmationComponent], imports: [AuthRoutingModule, OAuthModule.forRoot()], providers: [ - { provide: OAuthStorage, useExisting: StorageService }, + { provide: OAuthStorage, useFactory: oauthStorageFactory }, { provide: AuthenticationService }, { provide: AUTH_CONFIG, diff --git a/lib/process-services-cloud/src/lib/app/components/app-list-cloud/app-list-cloud.component.ts b/lib/process-services-cloud/src/lib/app/components/app-list-cloud/app-list-cloud.component.ts index 6cfbb81c9f..9e2e73e1c6 100644 --- a/lib/process-services-cloud/src/lib/app/components/app-list-cloud/app-list-cloud.component.ts +++ b/lib/process-services-cloud/src/lib/app/components/app-list-cloud/app-list-cloud.component.ts @@ -96,7 +96,6 @@ export class AppListCloudComponent implements OnInit, AfterContentInit { /** * Check if the value of the layoutType property is an allowed value - * * @returns `true` if layout type is valid, otherwise `false` */ isValidType(): boolean { @@ -115,7 +114,6 @@ export class AppListCloudComponent implements OnInit, AfterContentInit { /** * Check if the layout type is LIST - * * @returns `true` if the layout is list, otherwise `false` */ isList(): boolean { @@ -124,7 +122,6 @@ export class AppListCloudComponent implements OnInit, AfterContentInit { /** * Check if the layout type is GRID - * * @returns `true` if layout is grid, otherwise `false` */ isGrid(): boolean { diff --git a/lib/process-services-cloud/src/lib/app/services/apps-process-cloud.service.ts b/lib/process-services-cloud/src/lib/app/services/apps-process-cloud.service.ts index 552ab95817..17f5c901d5 100644 --- a/lib/process-services-cloud/src/lib/app/services/apps-process-cloud.service.ts +++ b/lib/process-services-cloud/src/lib/app/services/apps-process-cloud.service.ts @@ -34,7 +34,6 @@ export class AppsProcessCloudService { /** * Gets a list of deployed apps for this user by status. - * * @param status Required status value * @param roles to filter the apps * @returns The list of deployed apps diff --git a/lib/process-services-cloud/src/lib/form/components/form-cloud.component.spec.ts b/lib/process-services-cloud/src/lib/form/components/form-cloud.component.spec.ts index df24e70306..5f3e8d1586 100644 --- a/lib/process-services-cloud/src/lib/form/components/form-cloud.component.spec.ts +++ b/lib/process-services-cloud/src/lib/form/components/form-cloud.component.spec.ts @@ -1358,7 +1358,6 @@ describe('FormCloudComponent', () => { /** * Helper function for loading the form in the tests - * * @param form The form model to be loaded */ async function loadForm(form?: any): Promise { diff --git a/lib/process-services-cloud/src/lib/form/components/form-cloud.component.ts b/lib/process-services-cloud/src/lib/form/components/form-cloud.component.ts index be42b21ab2..98845f6b3b 100644 --- a/lib/process-services-cloud/src/lib/form/components/form-cloud.component.ts +++ b/lib/process-services-cloud/src/lib/form/components/form-cloud.component.ts @@ -440,7 +440,6 @@ export class FormCloudComponent extends FormBaseComponent implements OnChanges, /** * Get custom set of outcomes for a Form Definition. - * * @param form Form definition model. * @returns list of form outcomes */ diff --git a/lib/process-services-cloud/src/lib/form/services/form-cloud.service.ts b/lib/process-services-cloud/src/lib/form/services/form-cloud.service.ts index 4ba62c4622..3d0c507da9 100644 --- a/lib/process-services-cloud/src/lib/form/services/form-cloud.service.ts +++ b/lib/process-services-cloud/src/lib/form/services/form-cloud.service.ts @@ -50,7 +50,6 @@ export class FormCloudService extends BaseCloudService implements FormCloudServi /** * Gets the form definition of a task. - * * @param appName Name of the app * @param taskId ID of the target task * @param version Version of the form @@ -79,7 +78,6 @@ export class FormCloudService extends BaseCloudService implements FormCloudServi /** * Saves a task form. - * * @param appName Name of the app * @param taskId ID of the target task * @param processInstanceId ID of processInstance @@ -108,7 +106,6 @@ export class FormCloudService extends BaseCloudService implements FormCloudServi /** * Completes a task form. - * * @param appName Name of the app * @param taskId ID of the target task * @param processInstanceId ID of processInstance @@ -143,7 +140,6 @@ export class FormCloudService extends BaseCloudService implements FormCloudServi /** * Gets details of a task - * * @param appName Name of the app * @param taskId ID of the target task * @returns Details of the task @@ -156,7 +152,6 @@ export class FormCloudService extends BaseCloudService implements FormCloudServi /** * Gets the variables of a task. - * * @param appName Name of the app * @param taskId ID of the target task * @returns Task variables @@ -183,7 +178,6 @@ export class FormCloudService extends BaseCloudService implements FormCloudServi /** * Gets a form definition. - * * @param appName Name of the app * @param formKey key of the target task * @param version Version of the form @@ -207,7 +201,6 @@ export class FormCloudService extends BaseCloudService implements FormCloudServi /** * Parses JSON data to create a corresponding form. - * * @param json JSON data to create the form * @param data Values for the form's fields * @param readOnly Toggles whether or not the form should be read-only diff --git a/lib/process-services-cloud/src/lib/form/services/form-definition-selector-cloud.service.ts b/lib/process-services-cloud/src/lib/form/services/form-definition-selector-cloud.service.ts index 6fb7a32092..d979d8968c 100644 --- a/lib/process-services-cloud/src/lib/form/services/form-definition-selector-cloud.service.ts +++ b/lib/process-services-cloud/src/lib/form/services/form-definition-selector-cloud.service.ts @@ -28,7 +28,6 @@ import { FormDefinitionSelectorCloudServiceInterface } from './form-definition-s export class FormDefinitionSelectorCloudService extends BaseCloudService implements FormDefinitionSelectorCloudServiceInterface { /** * Get all forms of an app. - * * @param appName Name of the application * @returns Details of the forms */ @@ -40,7 +39,6 @@ export class FormDefinitionSelectorCloudService extends BaseCloudService impleme /** * Get all forms of an app. - * * @param appName Name of the application * @returns Details of the forms */ diff --git a/lib/process-services-cloud/src/lib/group/components/group-cloud.component.spec.ts b/lib/process-services-cloud/src/lib/group/components/group-cloud.component.spec.ts index dbe8898b85..8e64a5a3a7 100644 --- a/lib/process-services-cloud/src/lib/group/components/group-cloud.component.spec.ts +++ b/lib/process-services-cloud/src/lib/group/components/group-cloud.component.spec.ts @@ -39,7 +39,6 @@ describe('GroupCloudComponent', () => { /** * search group by value - * * @param value element input value */ async function searchGroup(value: string) { @@ -50,7 +49,6 @@ describe('GroupCloudComponent', () => { /** * search group and invoke the blur event - * * @param value value */ async function searchGroupsAndBlur(value: string) { @@ -62,7 +60,6 @@ describe('GroupCloudComponent', () => { /** * get the group list UI - * * @returns a list of debug elements */ function getGroupListUI(): DebugElement[] { diff --git a/lib/process-services-cloud/src/lib/people/components/people-cloud.component.spec.ts b/lib/process-services-cloud/src/lib/people/components/people-cloud.component.spec.ts index 9094eb323d..bb30f346fc 100644 --- a/lib/process-services-cloud/src/lib/people/components/people-cloud.component.spec.ts +++ b/lib/process-services-cloud/src/lib/people/components/people-cloud.component.spec.ts @@ -40,7 +40,6 @@ describe('PeopleCloudComponent', () => { /** * Search users by value - * * @param value value */ async function searchUsers(value: string) { @@ -51,7 +50,6 @@ describe('PeopleCloudComponent', () => { /** * Search users and blur the input - * * @param value value */ async function searchUsersAndBlur(value: string) { @@ -63,7 +61,6 @@ describe('PeopleCloudComponent', () => { /** * Get users list UI - * * @returns list of debug elements */ function getUsersListUI(): DebugElement[] { @@ -72,7 +69,6 @@ describe('PeopleCloudComponent', () => { /** * Get the first user from the list - * * @returns native element */ function getFirstUserFromListUI(): Element { diff --git a/lib/process-services-cloud/src/lib/people/services/identity-user.service.ts b/lib/process-services-cloud/src/lib/people/services/identity-user.service.ts index f288970292..4914a43418 100644 --- a/lib/process-services-cloud/src/lib/people/services/identity-user.service.ts +++ b/lib/process-services-cloud/src/lib/people/services/identity-user.service.ts @@ -38,7 +38,6 @@ export class IdentityUserService { /** * Gets the name and other basic details of the current user. - * * @returns The user's details */ public getCurrentUserInfo(): IdentityUserModel { @@ -51,7 +50,6 @@ export class IdentityUserService { /** * Search users based on name input and filters. - * * @param name Search query string * @param [filters] Search query filters * @returns List of users diff --git a/lib/process-services-cloud/src/lib/process/process-filters/components/edit-process-filter/edit-process-filter-cloud.component.ts b/lib/process-services-cloud/src/lib/process/process-filters/components/edit-process-filter/edit-process-filter-cloud.component.ts index 5955eb036b..d69707665c 100644 --- a/lib/process-services-cloud/src/lib/process/process-filters/components/edit-process-filter/edit-process-filter-cloud.component.ts +++ b/lib/process-services-cloud/src/lib/process/process-filters/components/edit-process-filter/edit-process-filter-cloud.component.ts @@ -511,7 +511,6 @@ export class EditProcessFilterCloudComponent implements OnInit, OnChanges { /** * Delete a process instance filter - * * @param deleteAction filter action */ delete(deleteAction: ProcessFilterAction) { @@ -530,7 +529,6 @@ export class EditProcessFilterCloudComponent implements OnInit, OnChanges { /** * Save As a process instance filter - * * @param saveAsAction filter action */ saveAs(saveAsAction: ProcessFilterAction) { @@ -576,7 +574,6 @@ export class EditProcessFilterCloudComponent implements OnInit, OnChanges { /** * Get sanitized filter name - * * @param filterName filter name * @returns sanitized filter name */ @@ -587,7 +584,6 @@ export class EditProcessFilterCloudComponent implements OnInit, OnChanges { /** * Return name with hyphen - * * @param name name * @returns updated value */ diff --git a/lib/process-services-cloud/src/lib/process/process-filters/components/process-filters/process-filters-cloud.component.ts b/lib/process-services-cloud/src/lib/process/process-filters/components/process-filters/process-filters-cloud.component.ts index 63cd5db8cd..66f353914d 100644 --- a/lib/process-services-cloud/src/lib/process/process-filters/components/process-filters/process-filters-cloud.component.ts +++ b/lib/process-services-cloud/src/lib/process/process-filters/components/process-filters/process-filters-cloud.component.ts @@ -110,7 +110,6 @@ export class ProcessFiltersCloudComponent implements OnInit, OnChanges { /** * Fetch the filter list based on appName - * * @param appName application name */ getFilters(appName: string): void { @@ -140,7 +139,6 @@ export class ProcessFiltersCloudComponent implements OnInit, OnChanges { /** * Pass the selected filter as next - * * @param paramFilter filter model */ selectFilter(paramFilter: FilterParamsModel) { @@ -162,7 +160,6 @@ export class ProcessFiltersCloudComponent implements OnInit, OnChanges { /** * Check equality of the filter names by translating the given name strings - * * @param name1 source name * @param name2 target name * @returns `true` if filter names are equal, otherwise `false` @@ -176,7 +173,6 @@ export class ProcessFiltersCloudComponent implements OnInit, OnChanges { /** * Selects and emits the given filter - * * @param newParamFilter new parameter filter */ selectFilterAndEmit(newParamFilter: FilterParamsModel) { @@ -190,7 +186,6 @@ export class ProcessFiltersCloudComponent implements OnInit, OnChanges { /** * Select filter with the id - * * @param id filter id */ selectFilterById(id: string) { @@ -199,7 +194,6 @@ export class ProcessFiltersCloudComponent implements OnInit, OnChanges { /** * Selects and emits the clicked filter - * * @param filter filter model */ onFilterClick(filter: ProcessFilterCloudModel) { @@ -224,7 +218,6 @@ export class ProcessFiltersCloudComponent implements OnInit, OnChanges { /** * Get current filter - * * @returns filter model */ getCurrentFilter(): ProcessFilterCloudModel { @@ -233,7 +226,6 @@ export class ProcessFiltersCloudComponent implements OnInit, OnChanges { /** * Check if the filter list is empty - * * @returns `true` if filter list is empty, otherwise `false` */ isFilterListEmpty(): boolean { @@ -274,7 +266,6 @@ export class ProcessFiltersCloudComponent implements OnInit, OnChanges { /** * Get current value for filter and check if value has changed - * * @param filter filter */ updateFilterCounter(filter: ProcessFilterCloudModel): void { diff --git a/lib/process-services-cloud/src/lib/process/process-filters/services/process-filter-cloud.service.ts b/lib/process-services-cloud/src/lib/process/process-filters/services/process-filter-cloud.service.ts index 9ca9d9f8d5..ccaf5328be 100644 --- a/lib/process-services-cloud/src/lib/process/process-filters/services/process-filter-cloud.service.ts +++ b/lib/process-services-cloud/src/lib/process/process-filters/services/process-filter-cloud.service.ts @@ -114,7 +114,6 @@ export class ProcessFilterCloudService { /** * Creates and returns the default process instance filters for a app. - * * @param appName Name of the target app */ private createDefaultFilters(appName: string): void { @@ -141,7 +140,6 @@ export class ProcessFilterCloudService { /** * Gets all process instance filters for a process app. - * * @param appName Name of the target app * @returns Observable of process filters details */ @@ -152,7 +150,6 @@ export class ProcessFilterCloudService { /** * Get process instance filter for given filter id - * * @param appName Name of the target app * @param id Id of the target process instance filter * @returns Observable of process instance filter details @@ -173,7 +170,6 @@ export class ProcessFilterCloudService { /** * Adds a new process instance filter - * * @param newFilter The new filter to add * @returns Observable of process instance filters with newly added filter */ @@ -204,7 +200,6 @@ export class ProcessFilterCloudService { /** * Update process instance filter - * * @param updatedFilter The new filter to update * @returns Observable of process instance filters with updated filter */ @@ -229,7 +224,6 @@ export class ProcessFilterCloudService { /** * Delete process instance filter - * * @param deletedFilter The new filter to delete * @returns Observable of process instance filters without deleted filter */ @@ -254,7 +248,6 @@ export class ProcessFilterCloudService { /** * Checks if given filter is a default filter - * * @param filterName Name of the target process filter * @returns Boolean value for whether the filter is a default filter */ @@ -267,7 +260,6 @@ export class ProcessFilterCloudService { * Reset the process filters to the default configuration if it exists and stores it. * If there is no default configuration for the process cloud filter with the provided filter name, * then it changes nothing but stores the current values of the filter - * * @param appName Name of the target app * @param filter The process filter to be restored to defaults * @returns Observable of process filters details @@ -281,7 +273,6 @@ export class ProcessFilterCloudService { /** * Checks user preference are empty or not - * * @param preferences User preferences of the target app * @returns Boolean value if the preferences are not empty */ @@ -291,7 +282,6 @@ export class ProcessFilterCloudService { /** * Checks for process instance filters in given user preferences - * * @param preferences User preferences of the target app * @param key Key of the process instance filters * @returns Boolean value if the preference has process instance filters @@ -303,7 +293,6 @@ export class ProcessFilterCloudService { /** * Calls create preference api to create process instance filters - * * @param appName Name of the target app * @param key Key of the process instance filters * @param filters Details of new process instance filter @@ -315,7 +304,6 @@ export class ProcessFilterCloudService { /** * Calls get preference api to get process instance filter by preference key - * * @param appName Name of the target app * @param key Key of the process instance filters * @returns Observable of process instance filters @@ -326,7 +314,6 @@ export class ProcessFilterCloudService { /** * Calls update preference api to update process instance filter - * * @param appName Name of the target app * @param key Key of the process instance filters * @param filters Details of update filter @@ -338,7 +325,6 @@ export class ProcessFilterCloudService { /** * Creates a uniq key with appName and username - * * @param appName Name of the target app * @returns String of process instance filters preference key */ @@ -349,7 +335,6 @@ export class ProcessFilterCloudService { /** * Finds and returns the process instance filters from preferences - * * @returns Array of ProcessFilterCloudModel * @param preferences preferences * @param key key @@ -365,7 +350,6 @@ export class ProcessFilterCloudService { /** * Creates and returns the default filters for a process app. - * * @param appName Name of the target app * @returns Array of ProcessFilterCloudModel */ @@ -409,7 +393,6 @@ export class ProcessFilterCloudService { /** * Refresh filter key - * * @param filterKey Key of the filter */ refreshFilter(filterKey: string): void { @@ -422,7 +405,6 @@ export class ProcessFilterCloudService { * If the new property is not found, it is created and assigned the value constructed from the old property. * The filters are then updated in the preferences and returned. * Old properties are left untouched for purposes like feature toggling. - * * @param appName Name of the target app. * @param key Key of the process filters. * @param filters Array of process filters to be checked for backward compatibility. diff --git a/lib/process-services-cloud/src/lib/process/process-list/services/process-task-list-cloud.service.ts b/lib/process-services-cloud/src/lib/process/process-list/services/process-task-list-cloud.service.ts index d1ceec319a..9cf416d3f8 100644 --- a/lib/process-services-cloud/src/lib/process/process-list/services/process-task-list-cloud.service.ts +++ b/lib/process-services-cloud/src/lib/process/process-list/services/process-task-list-cloud.service.ts @@ -27,7 +27,6 @@ import { TaskListCloudSortingModel } from '../../../models/task-list-sorting.mod export class ProcessTaskListCloudService extends BaseCloudService { /** * Finds a task using an object with optional query properties. - * * @param requestNode Query object * @param queryUrl Query url * @returns Task information diff --git a/lib/process-services-cloud/src/lib/process/services/process-cloud.service.ts b/lib/process-services-cloud/src/lib/process/services/process-cloud.service.ts index f22422808c..c503516e59 100644 --- a/lib/process-services-cloud/src/lib/process/services/process-cloud.service.ts +++ b/lib/process-services-cloud/src/lib/process/services/process-cloud.service.ts @@ -31,7 +31,6 @@ export class ProcessCloudService extends BaseCloudService { /** * Gets details of a process instance. - * * @param appName Name of the app * @param processInstanceId ID of the process instance whose details you want * @returns Process instance details @@ -53,7 +52,6 @@ export class ProcessCloudService extends BaseCloudService { /** * Gets the process definitions associated with an app. - * * @param appName Name of the target app * @returns Array of process definitions */ @@ -69,7 +67,6 @@ export class ProcessCloudService extends BaseCloudService { /** * Gets the application versions associated with an app. - * * @param appName Name of the target app * @returns Array of Application Version Models */ @@ -85,7 +82,6 @@ export class ProcessCloudService extends BaseCloudService { /** * Cancels a process. - * * @param appName Name of the app * @param processInstanceId Id of the process to cancel * @returns Operation Information diff --git a/lib/process-services-cloud/src/lib/process/start-process/components/start-process-cloud.component.spec.ts b/lib/process-services-cloud/src/lib/process/start-process/components/start-process-cloud.component.spec.ts index b528343c86..9aeffd74c5 100755 --- a/lib/process-services-cloud/src/lib/process/start-process/components/start-process-cloud.component.spec.ts +++ b/lib/process-services-cloud/src/lib/process/start-process/components/start-process-cloud.component.spec.ts @@ -110,7 +110,6 @@ describe('StartProcessCloudComponent', () => { /** * Setup the component with the given start event information. - * * @param values the values for the form * @param staticValues the static values retrieved from the API for the form * @param constantValues the constant values retrieved from the API for customising the buttons diff --git a/lib/process-services-cloud/src/lib/process/start-process/services/start-process-cloud.service.ts b/lib/process-services-cloud/src/lib/process/start-process/services/start-process-cloud.service.ts index f1f39504c3..38f94529db 100755 --- a/lib/process-services-cloud/src/lib/process/start-process/services/start-process-cloud.service.ts +++ b/lib/process-services-cloud/src/lib/process/start-process/services/start-process-cloud.service.ts @@ -34,7 +34,6 @@ export interface QueryParams { export class StartProcessCloudService extends BaseCloudService { /** * Gets the process definitions associated with an app. - * * @param appName Name of the target app * @param queryParams optional query parameters * @returns Array of process definitions @@ -53,7 +52,6 @@ export class StartProcessCloudService extends BaseCloudService { /** * Starts a process based on a process definition, name, form values or variables. - * * @param appName name of the Application * @param payload Details of the process (definition key, name, variables, etc) * @returns Details of the process instance just started @@ -74,7 +72,6 @@ export class StartProcessCloudService extends BaseCloudService { /** * Update an existing process instance - * * @param appName name of the Application * @param processInstanceId process instance to update * @param payload Details of the process (definition key, name, variables, etc) @@ -89,7 +86,6 @@ export class StartProcessCloudService extends BaseCloudService { /** * Delete an existing process instance - * * @param appName Application name * @param processInstanceId the identifier of the process instance to update * @returns Observable @@ -102,7 +98,6 @@ export class StartProcessCloudService extends BaseCloudService { /** * Gets the static values mapped to the start form of a process definition. - * * @param appName Name of the app * @param processDefinitionId ID of the target process definition * @returns Static mappings for the start event @@ -122,7 +117,6 @@ export class StartProcessCloudService extends BaseCloudService { /** * Gets the constants mapped to the start form of a process definition. - * * @param appName Name of the app * @param processDefinitionId ID of the target process definition * @returns Constants values for the start event diff --git a/lib/process-services-cloud/src/lib/services/local-preference-cloud.service.ts b/lib/process-services-cloud/src/lib/services/local-preference-cloud.service.ts index 81db87c4b5..e5ecb8e1d9 100644 --- a/lib/process-services-cloud/src/lib/services/local-preference-cloud.service.ts +++ b/lib/process-services-cloud/src/lib/services/local-preference-cloud.service.ts @@ -26,7 +26,6 @@ export class LocalPreferenceCloudService implements PreferenceCloudServiceInterf /** * Gets local preferences - * * @param _ Name of the target app * @param key Key of the target preference * @returns List of local preferences @@ -53,7 +52,6 @@ export class LocalPreferenceCloudService implements PreferenceCloudServiceInterf /** * Gets local preference. - * * @param _ Name of the target app * @param key Key of the target preference * @returns Observable of local preference @@ -64,7 +62,6 @@ export class LocalPreferenceCloudService implements PreferenceCloudServiceInterf /** * Creates local preference. - * * @param _ Name of the target app * @param key Key of the target preference * @param newPreference Details of new local preference @@ -79,7 +76,6 @@ export class LocalPreferenceCloudService implements PreferenceCloudServiceInterf /** * Updates local preference. - * * @param _ Name of the target app * @param key Key of the target preference * @param updatedPreference Details of updated preference @@ -94,7 +90,6 @@ export class LocalPreferenceCloudService implements PreferenceCloudServiceInterf /** * Deletes local preference by given preference key. - * * @param key Key of the target preference * @param preferences Details of updated preferences * @returns Observable of preferences without deleted preference diff --git a/lib/process-services-cloud/src/lib/services/task-list-cloud.service.interface.ts b/lib/process-services-cloud/src/lib/services/task-list-cloud.service.interface.ts index a43aa2fca1..963b64eb0b 100644 --- a/lib/process-services-cloud/src/lib/services/task-list-cloud.service.interface.ts +++ b/lib/process-services-cloud/src/lib/services/task-list-cloud.service.interface.ts @@ -21,7 +21,6 @@ import { TaskListRequestModel, TaskQueryCloudRequestModel } from '../models/filt export interface TaskListCloudServiceInterface { /** * Finds a task using an object with optional query properties. - * * @deprecated From Activiti 8.7.0 forward, use TaskListCloudService.fetchTaskList instead. * @param requestNode Query object * @param queryUrl Query url @@ -32,7 +31,6 @@ export interface TaskListCloudServiceInterface { /** * Available from Activiti version 8.7.0 onwards. * Retrieves a list of tasks using an object with optional query properties. - * * @param requestNode Query object * @param queryUrl Query url * @returns List of tasks diff --git a/lib/process-services-cloud/src/lib/services/user-preference-cloud.service.ts b/lib/process-services-cloud/src/lib/services/user-preference-cloud.service.ts index 718c390a16..27a2bdda46 100644 --- a/lib/process-services-cloud/src/lib/services/user-preference-cloud.service.ts +++ b/lib/process-services-cloud/src/lib/services/user-preference-cloud.service.ts @@ -24,7 +24,6 @@ import { BaseCloudService } from './base-cloud.service'; export class UserPreferenceCloudService extends BaseCloudService implements PreferenceCloudServiceInterface { /** * Gets user preferences - * * @param appName Name of the target app * @returns List of user preferences */ @@ -39,7 +38,6 @@ export class UserPreferenceCloudService extends BaseCloudService implements Pref /** * Gets user preference. - * * @param appName Name of the target app * @param key Key of the target preference * @returns Observable of user preference @@ -55,7 +53,6 @@ export class UserPreferenceCloudService extends BaseCloudService implements Pref /** * Creates user preference. - * * @param appName Name of the target app * @param key Key of the target preference * @param newPreference Details of new user preference @@ -74,7 +71,6 @@ export class UserPreferenceCloudService extends BaseCloudService implements Pref /** * Updates user preference. - * * @param appName Name of the target app * @param key Key of the target preference * @param updatedPreference Details of updated preference @@ -86,7 +82,6 @@ export class UserPreferenceCloudService extends BaseCloudService implements Pref /** * Deletes user preference by given preference key. - * * @param appName Name of the target app * @param key Key of the target preference * @returns Observable of delete operation status diff --git a/lib/process-services-cloud/src/lib/task/services/task-cloud.service.ts b/lib/process-services-cloud/src/lib/task/services/task-cloud.service.ts index 767928e372..dba00728d4 100644 --- a/lib/process-services-cloud/src/lib/task/services/task-cloud.service.ts +++ b/lib/process-services-cloud/src/lib/task/services/task-cloud.service.ts @@ -49,7 +49,6 @@ export class TaskCloudService extends BaseCloudService { /** * Complete a task. - * * @param appName Name of the app * @param taskId ID of the task to complete * @returns Details of the task that was completed @@ -67,7 +66,6 @@ export class TaskCloudService extends BaseCloudService { /** * Validate if a task can be completed. - * * @param taskDetails task details object * @returns Boolean value if the task can be completed */ @@ -77,7 +75,6 @@ export class TaskCloudService extends BaseCloudService { /** * Validate if a task is editable. - * * @param taskDetails task details object * @returns Boolean value if the task is editable */ @@ -100,7 +97,6 @@ export class TaskCloudService extends BaseCloudService { /** * Validate if a task can be claimed. - * * @param taskDetails task details object * @returns Boolean value if the task can be completed */ @@ -110,7 +106,6 @@ export class TaskCloudService extends BaseCloudService { /** * Validate if a task can be unclaimed. - * * @param taskDetails task details object * @returns Boolean value if the task can be completed */ @@ -126,7 +121,6 @@ export class TaskCloudService extends BaseCloudService { /** * Claims a task for an assignee. - * * @param appName Name of the app * @param taskId ID of the task to claim * @param assignee User to assign the task to @@ -149,7 +143,6 @@ export class TaskCloudService extends BaseCloudService { /** * Un-claims a task. - * * @param appName Name of the app * @param taskId ID of the task to unclaim * @returns Details of the task that was unclaimed @@ -171,7 +164,6 @@ export class TaskCloudService extends BaseCloudService { /** * Gets details of a task. - * * @param appName Name of the app * @param taskId ID of the task whose details you want * @returns Task details @@ -188,7 +180,6 @@ export class TaskCloudService extends BaseCloudService { /** * Creates a new standalone task. - * * @param startTaskRequest request model * @param appName application name * @returns Details of the newly created task @@ -202,7 +193,6 @@ export class TaskCloudService extends BaseCloudService { /** * Updates the details (name, description, due date) for a task. - * * @param appName Name of the app * @param taskId ID of the task to update * @param payload Data to update the task @@ -221,7 +211,6 @@ export class TaskCloudService extends BaseCloudService { /** * Gets candidate users of the task. - * * @param appName Name of the app * @param taskId ID of the task * @returns Candidate users @@ -237,7 +226,6 @@ export class TaskCloudService extends BaseCloudService { /** * Gets candidate groups of the task. - * * @param appName Name of the app * @param taskId ID of the task * @returns Candidate groups @@ -253,7 +241,6 @@ export class TaskCloudService extends BaseCloudService { /** * Gets the process definitions associated with an app. - * * @param appName Name of the target app * @returns Array of process definitions */ @@ -269,7 +256,6 @@ export class TaskCloudService extends BaseCloudService { /** * Updates the task assignee. - * * @param appName Name of the app * @param taskId ID of the task to update assignee * @param assignee assignee to update current user task assignee diff --git a/lib/process-services-cloud/src/lib/task/task-filters/components/edit-task-filters/base-edit-task-filter-cloud.component.ts b/lib/process-services-cloud/src/lib/task/task-filters/components/edit-task-filters/base-edit-task-filter-cloud.component.ts index 34a6d23d7b..bd59b4f30a 100644 --- a/lib/process-services-cloud/src/lib/task/task-filters/components/edit-task-filters/base-edit-task-filter-cloud.component.ts +++ b/lib/process-services-cloud/src/lib/task/task-filters/components/edit-task-filters/base-edit-task-filter-cloud.component.ts @@ -217,7 +217,6 @@ export abstract class BaseEditTaskFilterCloudComponent implements OnInit, OnC /** * Get the sanitized filter name - * * @param filterName filter name * @returns sanitized filter name */ diff --git a/lib/process-services-cloud/src/lib/task/task-filters/components/edit-task-filters/edit-task-filter/edit-task-filter-cloud.component.spec.ts b/lib/process-services-cloud/src/lib/task/task-filters/components/edit-task-filters/edit-task-filter/edit-task-filter-cloud.component.spec.ts index 060a882b4d..d350a4a668 100644 --- a/lib/process-services-cloud/src/lib/task/task-filters/components/edit-task-filters/edit-task-filter/edit-task-filter-cloud.component.spec.ts +++ b/lib/process-services-cloud/src/lib/task/task-filters/components/edit-task-filters/edit-task-filter/edit-task-filter-cloud.component.spec.ts @@ -139,7 +139,6 @@ describe('EditTaskFilterCloudComponent', () => { /** * resolve filter instance input element - * * @returns native element */ function getProcessInstanceIdInputElement() { diff --git a/lib/process-services-cloud/src/lib/task/task-filters/components/service-task-filters/service-task-filters-cloud.component.ts b/lib/process-services-cloud/src/lib/task/task-filters/components/service-task-filters/service-task-filters-cloud.component.ts index 4216be47b9..f619812454 100644 --- a/lib/process-services-cloud/src/lib/task/task-filters/components/service-task-filters/service-task-filters-cloud.component.ts +++ b/lib/process-services-cloud/src/lib/task/task-filters/components/service-task-filters/service-task-filters-cloud.component.ts @@ -67,7 +67,6 @@ export class ServiceTaskFiltersCloudComponent extends BaseTaskFiltersCloudCompon /** * Load the filter list filtered by appName - * * @param appName application name */ getFilters(appName: string): void { @@ -88,7 +87,6 @@ export class ServiceTaskFiltersCloudComponent extends BaseTaskFiltersCloudCompon /** * Select filter - * * @param paramFilter filter model */ selectFilter(paramFilter: FilterParamsModel) { @@ -123,7 +121,6 @@ export class ServiceTaskFiltersCloudComponent extends BaseTaskFiltersCloudCompon /** * Selects and emits the clicked filter. - * * @param filter filter to select */ onFilterClick(filter: FilterParamsModel) { @@ -146,7 +143,6 @@ export class ServiceTaskFiltersCloudComponent extends BaseTaskFiltersCloudCompon /** * Check if the filter list is empty - * * @returns `true` if filter list is empty, otherwise `false` */ isFilterListEmpty(): boolean { diff --git a/lib/process-services-cloud/src/lib/task/task-filters/components/task-assignment-filter/task-assignment-filter.component.spec.ts b/lib/process-services-cloud/src/lib/task/task-filters/components/task-assignment-filter/task-assignment-filter.component.spec.ts index 34f00510e6..713d1b4588 100644 --- a/lib/process-services-cloud/src/lib/task/task-filters/components/task-assignment-filter/task-assignment-filter.component.spec.ts +++ b/lib/process-services-cloud/src/lib/task/task-filters/components/task-assignment-filter/task-assignment-filter.component.spec.ts @@ -38,7 +38,6 @@ describe('TaskAssignmentFilterComponent', () => { /** * select the assignment type - * * @param type type to select */ function selectAssignmentType(type: AssignmentType) { diff --git a/lib/process-services-cloud/src/lib/task/task-filters/components/task-filters/task-filters-cloud.component.ts b/lib/process-services-cloud/src/lib/task/task-filters/components/task-filters/task-filters-cloud.component.ts index 2c59c68e59..bcca3eca91 100644 --- a/lib/process-services-cloud/src/lib/task/task-filters/components/task-filters/task-filters-cloud.component.ts +++ b/lib/process-services-cloud/src/lib/task/task-filters/components/task-filters/task-filters-cloud.component.ts @@ -91,7 +91,6 @@ export class TaskFiltersCloudComponent extends BaseTaskFiltersCloudComponent imp /** * Loads the filter list filtered by appName - * * @param appName application name */ getFilters(appName: string): void { @@ -128,7 +127,6 @@ export class TaskFiltersCloudComponent extends BaseTaskFiltersCloudComponent imp /** * Get current value for filter and check if value has changed - * * @param filter filter */ updateFilterCounter(filter: TaskFilterCloudModel): void { @@ -224,7 +222,6 @@ export class TaskFiltersCloudComponent extends BaseTaskFiltersCloudComponent imp /** * Selects and emits the clicked filter. - * * @param filter filter model */ onFilterClick(filter: FilterParamsModel) { @@ -250,7 +247,6 @@ export class TaskFiltersCloudComponent extends BaseTaskFiltersCloudComponent imp /** * Check if the filter list is empty - * * @returns `true` if filter list is empty, otherwise `false` */ isFilterListEmpty(): boolean { diff --git a/lib/process-services-cloud/src/lib/task/task-filters/services/service-task-filter-cloud.service.ts b/lib/process-services-cloud/src/lib/task/task-filters/services/service-task-filter-cloud.service.ts index ed4a5f5c0b..dd9872a425 100644 --- a/lib/process-services-cloud/src/lib/task/task-filters/services/service-task-filter-cloud.service.ts +++ b/lib/process-services-cloud/src/lib/task/task-filters/services/service-task-filter-cloud.service.ts @@ -38,7 +38,6 @@ export class ServiceTaskFilterCloudService { /** * Creates and returns the default task filters for an app. - * * @param appName Name of the target app */ private createDefaultFilters(appName: string): void { @@ -62,7 +61,6 @@ export class ServiceTaskFilterCloudService { /** * Checks user preference are empty or not - * * @param preferences User preferences of the target app * @returns Boolean value if the preferences are not empty */ @@ -72,7 +70,6 @@ export class ServiceTaskFilterCloudService { /** * Checks for task filters in given user preferences - * * @param preferences User preferences of the target app * @param key Key of the task filters * @returns Boolean value if the preference has task filters @@ -84,7 +81,6 @@ export class ServiceTaskFilterCloudService { /** * Calls create preference api to create task filters - * * @param appName Name of the target app * @param key Key of the task instance filters * @param filters Details of new task filter @@ -96,7 +92,6 @@ export class ServiceTaskFilterCloudService { /** * Calls get preference api to get task filter by preference key - * * @param appName Name of the target app * @param key Key of the task filters * @returns Observable of task filters @@ -107,7 +102,6 @@ export class ServiceTaskFilterCloudService { /** * Gets all task filters for a task app. - * * @param appName Name of the target app * @returns Observable of task filter details */ @@ -118,7 +112,6 @@ export class ServiceTaskFilterCloudService { /** * Gets a task filter. - * * @param appName Name of the target app * @param id ID of the task * @returns Details of the task filter @@ -139,7 +132,6 @@ export class ServiceTaskFilterCloudService { /** * Adds a new task filter. - * * @param newFilter The new filter to add * @returns Observable of task instance filters with newly added filter */ @@ -167,7 +159,6 @@ export class ServiceTaskFilterCloudService { /** * Updates a task filter. - * * @param updatedFilter The filter to update * @returns Observable of task instance filters with updated filter */ @@ -192,7 +183,6 @@ export class ServiceTaskFilterCloudService { /** * Deletes a task filter - * * @param deletedFilter The filter to delete * @returns Observable of task instance filters without deleted filter */ @@ -215,7 +205,6 @@ export class ServiceTaskFilterCloudService { /** * Checks if given filter is a default filter - * * @param filterName Name of the target task filter * @returns Boolean value for whether the filter is a default filter */ @@ -226,7 +215,6 @@ export class ServiceTaskFilterCloudService { /** * Calls update preference api to update task filter - * * @param appName Name of the target app * @param key Key of the task filters * @param filters Details of update filter @@ -238,7 +226,6 @@ export class ServiceTaskFilterCloudService { /** * Creates a uniq key with appName and username - * * @param appName Name of the target app * @returns String of task filters preference key */ @@ -248,7 +235,6 @@ export class ServiceTaskFilterCloudService { /** * Finds and returns the task filters from preferences - * * @returns Array of TaskFilterCloudModel * @param preferences preferences * @param key key @@ -260,7 +246,6 @@ export class ServiceTaskFilterCloudService { /** * Creates and returns the default filters for a task app. - * * @param appName Name of the target app * @returns Array of TaskFilterCloudModel */ diff --git a/lib/process-services-cloud/src/lib/task/task-filters/services/task-filter-cloud.service.ts b/lib/process-services-cloud/src/lib/task/task-filters/services/task-filter-cloud.service.ts index 1c00ffedbf..a66af2a0a6 100644 --- a/lib/process-services-cloud/src/lib/task/task-filters/services/task-filter-cloud.service.ts +++ b/lib/process-services-cloud/src/lib/task/task-filters/services/task-filter-cloud.service.ts @@ -65,7 +65,6 @@ export class TaskFilterCloudService extends BaseCloudService { /** * Creates and returns the default task filters for an app. - * * @param appName Name of the target app */ private createDefaultFilters(appName: string): void { @@ -90,7 +89,6 @@ export class TaskFilterCloudService extends BaseCloudService { /** * Checks user preference are empty or not - * * @param preferences User preferences of the target app * @returns Boolean value if the preferences are not empty */ @@ -100,7 +98,6 @@ export class TaskFilterCloudService extends BaseCloudService { /** * Checks for task filters in given user preferences - * * @param preferences User preferences of the target app * @param key Key of the task filters * @returns Boolean value if the preference has task filters @@ -112,7 +109,6 @@ export class TaskFilterCloudService extends BaseCloudService { /** * Calls create preference api to create task filters - * * @param appName Name of the target app * @param key Key of the task instance filters * @param filters Details of new task filter @@ -124,7 +120,6 @@ export class TaskFilterCloudService extends BaseCloudService { /** * Calls get preference api to get task filter by preference key - * * @param appName Name of the target app * @param key Key of the task filters * @returns Observable of task filters @@ -135,7 +130,6 @@ export class TaskFilterCloudService extends BaseCloudService { /** * Gets all task filters for a task app. - * * @param appName Name of the target app * @returns Observable of task filter details */ @@ -146,7 +140,6 @@ export class TaskFilterCloudService extends BaseCloudService { /** * Gets a task filter. - * * @param appName Name of the target app * @param id ID of the task * @returns Details of the task filter @@ -167,7 +160,6 @@ export class TaskFilterCloudService extends BaseCloudService { /** * Adds a new task filter. - * * @param newFilter The new filter to add * @returns Observable of task instance filters with newly added filter */ @@ -195,7 +187,6 @@ export class TaskFilterCloudService extends BaseCloudService { /** * Updates a task filter. - * * @param updatedFilter The filter to update * @returns Observable of task instance filters with updated filter */ @@ -220,7 +211,6 @@ export class TaskFilterCloudService extends BaseCloudService { /** * Deletes a task filter - * * @param deletedFilter The filter to delete * @returns Observable of task instance filters without deleted filter */ @@ -243,7 +233,6 @@ export class TaskFilterCloudService extends BaseCloudService { /** * Checks if given filter is a default filter - * * @param filterName Name of the target task filter * @returns Boolean value for whether the filter is a default filter */ @@ -254,7 +243,6 @@ export class TaskFilterCloudService extends BaseCloudService { /** * Finds a task using an object with optional query properties. - * * @returns Task information * @param taskFilter task filter model */ @@ -291,7 +279,6 @@ export class TaskFilterCloudService extends BaseCloudService { /** * Calls update preference api to update task filter - * * @param appName Name of the target app * @param key Key of the task filters * @param filters Details of update filter @@ -303,7 +290,6 @@ export class TaskFilterCloudService extends BaseCloudService { /** * Creates a uniq key with appName and username - * * @param appName Name of the target app * @returns String of task filters preference key */ @@ -313,7 +299,6 @@ export class TaskFilterCloudService extends BaseCloudService { /** * Finds and returns the task filters from preferences - * * @returns Array of TaskFilterCloudModel * @param preferences preferences * @param key key @@ -325,7 +310,6 @@ export class TaskFilterCloudService extends BaseCloudService { /** * Creates and returns the default filters for a task app. - * * @param appName Name of the target app * @returns Array of TaskFilterCloudModel */ @@ -374,7 +358,6 @@ export class TaskFilterCloudService extends BaseCloudService { /** * Refresh filter key - * * @param filterKey Key of the filter */ refreshFilter(filterKey: string): void { @@ -387,7 +370,6 @@ export class TaskFilterCloudService extends BaseCloudService { * If the new property is not found, it is created and assigned the value constructed from the old property. * The filters are then updated in the preferences and returned. * Old properties are left untouched for purposes like feature toggling. - * * @param appName Name of the target app. * @param key Key of the task filters. * @param filters Array of task filters to be checked for backward compatibility. diff --git a/lib/process-services-cloud/src/lib/task/task-header/components/task-header-cloud.component.ts b/lib/process-services-cloud/src/lib/task/task-header/components/task-header-cloud.component.ts index cbeedb1bc2..a49998afb8 100644 --- a/lib/process-services-cloud/src/lib/task/task-header/components/task-header-cloud.component.ts +++ b/lib/process-services-cloud/src/lib/task/task-header/components/task-header-cloud.component.ts @@ -265,7 +265,6 @@ export class TaskHeaderCloudComponent implements OnInit, OnChanges { /** * Save a task detail and update it after a successful response - * * @param updateNotification notification model */ private updateTaskDetails(updateNotification: UpdateNotification) { @@ -314,7 +313,6 @@ export class TaskHeaderCloudComponent implements OnInit, OnChanges { /** * as per [ACA-3960] it required an empty array argument for now * Empty array will be replaced with candidateGroups in feature - * * @returns `true` if assignee property is clickable, otherwise `false` */ isAssigneePropertyClickable(): boolean { diff --git a/lib/process-services-cloud/src/lib/task/task-list/services/service-task-list-cloud.service.ts b/lib/process-services-cloud/src/lib/task/task-list/services/service-task-list-cloud.service.ts index fcb8442eb1..662c984feb 100644 --- a/lib/process-services-cloud/src/lib/task/task-list/services/service-task-list-cloud.service.ts +++ b/lib/process-services-cloud/src/lib/task/task-list/services/service-task-list-cloud.service.ts @@ -26,7 +26,6 @@ import { map } from 'rxjs/operators'; export class ServiceTaskListCloudService extends BaseCloudService { /** * Finds a task using an object with optional query properties. - * * @param requestNode Query object * @returns Task information */ @@ -46,7 +45,6 @@ export class ServiceTaskListCloudService extends BaseCloudService { /** * Finds a service task integration context using an object with optional query properties. - * * @param appName string * @param serviceTaskId string * @returns Service Task Integration Context information @@ -62,7 +60,6 @@ export class ServiceTaskListCloudService extends BaseCloudService { /** * Replay a service task based on the related execution id and flow-node id - * * @param appName string * @param executionId string * @param flowNodeId string diff --git a/lib/process-services-cloud/src/lib/task/task-list/services/task-list-cloud.service.ts b/lib/process-services-cloud/src/lib/task/task-list/services/task-list-cloud.service.ts index 12f74e8547..900eaac888 100644 --- a/lib/process-services-cloud/src/lib/task/task-list/services/task-list-cloud.service.ts +++ b/lib/process-services-cloud/src/lib/task/task-list/services/task-list-cloud.service.ts @@ -28,7 +28,6 @@ import { TaskListCloudServiceInterface } from '../../../services/task-list-cloud export class TaskListCloudService extends BaseCloudService implements TaskListCloudServiceInterface { /** * Finds a task using an object with optional query properties. - * * @deprecated From Activiti 8.7.0 forward, use TaskListCloudService.fetchTaskList instead. * @param requestNode Query object * @param queryUrl Query url @@ -60,7 +59,6 @@ export class TaskListCloudService extends BaseCloudService implements TaskListCl /** * Available from Activiti version 8.7.0 onwards. * Retrieves a list of tasks using an object with optional query properties. - * * @param requestNode Query object * @param queryUrl Query url * @returns List of tasks diff --git a/lib/process-services/src/lib/app-list/apps-list.component.ts b/lib/process-services/src/lib/app-list/apps-list.component.ts index 08904db160..e620d3b0c3 100644 --- a/lib/process-services/src/lib/app-list/apps-list.component.ts +++ b/lib/process-services/src/lib/app-list/apps-list.component.ts @@ -114,7 +114,6 @@ export class AppsListComponent implements OnInit, AfterContentInit { /** * Pass the selected app as next - * * @param app application model */ selectApp(app: AppDefinitionRepresentation) { @@ -124,7 +123,6 @@ export class AppsListComponent implements OnInit, AfterContentInit { /** * Return true if the appId is the current app - * * @param appId application id * @returns `true` if application is selected, otherwise `false` */ @@ -134,7 +132,6 @@ export class AppsListComponent implements OnInit, AfterContentInit { /** * Check if the value of the layoutType property is an allowed value - * * @returns `true` if layout type is valid, otherwise `false` */ isValidType(): boolean { @@ -150,7 +147,6 @@ export class AppsListComponent implements OnInit, AfterContentInit { /** * Check if the layout type is LIST - * * @returns `true` if current layout is in the list mode, otherwise `false` */ isList(): boolean { @@ -159,7 +155,6 @@ export class AppsListComponent implements OnInit, AfterContentInit { /** * Check if the layout type is GRID - * * @returns `true` if current layout is in the grid mode, otherwise `false` */ isGrid(): boolean { diff --git a/lib/process-services/src/lib/form/form.component.ts b/lib/process-services/src/lib/form/form.component.ts index 6642fa4edf..77a490fd86 100644 --- a/lib/process-services/src/lib/form/form.component.ts +++ b/lib/process-services/src/lib/form/form.component.ts @@ -319,7 +319,6 @@ export class FormComponent extends FormBaseComponent implements OnInit, OnChange /** * Get custom set of outcomes for a Form Definition. - * * @param form Form definition model. * @returns list of form outcomes */ @@ -352,7 +351,6 @@ export class FormComponent extends FormBaseComponent implements OnInit, OnChange /** * Creates a Form with a field for each metadata property. - * * @param formName Name of the new form * @returns The new form */ diff --git a/lib/process-services/src/lib/form/services/activiti-alfresco.service.ts b/lib/process-services/src/lib/form/services/activiti-alfresco.service.ts index 97c84f7707..2eb8ab4b9d 100644 --- a/lib/process-services/src/lib/form/services/activiti-alfresco.service.ts +++ b/lib/process-services/src/lib/form/services/activiti-alfresco.service.ts @@ -53,7 +53,6 @@ export class ActivitiContentService { /** * Returns a list of child nodes below the specified folder - * * @param accountId account id * @param folderId folder id * @returns list of external content instances @@ -68,7 +67,6 @@ export class ActivitiContentService { /** * Returns a list of all the repositories configured - * * @param tenantId tenant id * @param includeAccount include accounts * @returns list of endpoints @@ -86,7 +84,6 @@ export class ActivitiContentService { /** * Returns a list of child nodes below the specified folder - * * @param accountId account id * @param node node details * @param siteId site id diff --git a/lib/process-services/src/lib/form/services/editor.service.ts b/lib/process-services/src/lib/form/services/editor.service.ts index 2448d686bc..c9cf755a85 100644 --- a/lib/process-services/src/lib/form/services/editor.service.ts +++ b/lib/process-services/src/lib/form/services/editor.service.ts @@ -39,7 +39,6 @@ export class EditorService { /** * Saves a form. - * * @param formId ID of the form to save * @param formModel Model data for the form * @returns Data for the saved form @@ -50,7 +49,6 @@ export class EditorService { /** * Gets a form definition. - * * @param formId ID of the target form * @returns Form definition */ @@ -63,7 +61,6 @@ export class EditorService { /** * Creates a JSON representation of form data. - * * @param res Object representing form data * @returns JSON data */ @@ -76,7 +73,6 @@ export class EditorService { /** * Reports an error message. - * * @param error Data object with optional `message` and `status` fields for the error * @returns Error message */ diff --git a/lib/process-services/src/lib/form/services/model.service.ts b/lib/process-services/src/lib/form/services/model.service.ts index 689339c111..c47a60ff68 100644 --- a/lib/process-services/src/lib/form/services/model.service.ts +++ b/lib/process-services/src/lib/form/services/model.service.ts @@ -38,7 +38,6 @@ export class ModelService { /** * Create a Form. - * * @param formName Name of the new form * @returns The new form */ @@ -55,7 +54,6 @@ export class ModelService { /** * Gets all the forms. - * * @returns List of form models */ getForms(): Observable { @@ -71,7 +69,6 @@ export class ModelService { /** * Creates a JSON array representation of form data. - * * @param res Object representing form data * @returns JSON data */ @@ -81,7 +78,6 @@ export class ModelService { /** * Searches for a form by name. - * * @param name The form name to search for * @returns Form model(s) matching the search name */ @@ -98,7 +94,6 @@ export class ModelService { /** * Gets the form definition with a given name. - * * @param name The form name * @returns Form definition */ @@ -117,7 +112,6 @@ export class ModelService { /** * Gets the ID of a form. - * * @param form Object representing a form * @returns ID string */ @@ -132,7 +126,6 @@ export class ModelService { } /** * Reports an error message. - * * @param error Data object with optional `message` and `status` fields for the error * @returns Error message */ diff --git a/lib/process-services/src/lib/form/services/process-content.service.ts b/lib/process-services/src/lib/form/services/process-content.service.ts index 36b3233db4..c0bb64eb1a 100644 --- a/lib/process-services/src/lib/form/services/process-content.service.ts +++ b/lib/process-services/src/lib/form/services/process-content.service.ts @@ -43,7 +43,6 @@ export class ProcessContentService { /** * Create temporary related content from an uploaded file. - * * @param file File to use for content * @returns The created content data */ @@ -53,7 +52,6 @@ export class ProcessContentService { /** * Gets the metadata for a related content item. - * * @param contentId ID of the content item * @returns Metadata for the content */ @@ -63,7 +61,6 @@ export class ProcessContentService { /** * Gets raw binary content data for a related content file. - * * @param contentId ID of the related content * @returns Binary data of the related content */ @@ -73,7 +70,6 @@ export class ProcessContentService { /** * Gets the preview for a related content file. - * * @param contentId ID of the related content * @returns Binary data of the content preview */ @@ -102,7 +98,6 @@ export class ProcessContentService { /** * Gets a URL for direct access to a related content file. - * * @param contentId ID of the related content * @returns URL to access the content */ @@ -112,7 +107,6 @@ export class ProcessContentService { /** * Gets the thumbnail for a related content file. - * * @param contentId ID of the related content * @returns Binary data of the thumbnail image */ @@ -132,7 +126,6 @@ export class ProcessContentService { /** * Gets related content items for a task instance. - * * @param taskId ID of the target task * @param opts Options supported by JS-API * @returns Metadata for the content @@ -143,7 +136,6 @@ export class ProcessContentService { /** * Gets related content items for a process instance. - * * @param processId ID of the target process * @param opts Options supported by JS-API * @returns Metadata for the content @@ -154,7 +146,6 @@ export class ProcessContentService { /** * Deletes related content. - * * @param contentId Identifier of the content to delete * @returns Null response that notifies when the deletion is complete */ @@ -164,7 +155,6 @@ export class ProcessContentService { /** * Associates an uploaded file with a process instance. - * * @param processInstanceId ID of the target process instance * @param content File to associate * @param opts Options supported by JS-API @@ -178,7 +168,6 @@ export class ProcessContentService { /** * Associates an uploaded file with a task instance. - * * @param taskId ID of the target task * @param file File to associate * @param opts Options supported by JS-API @@ -190,7 +179,6 @@ export class ProcessContentService { /** * 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 @@ -208,7 +196,6 @@ export class ProcessContentService { /** * Creates a JSON representation of data. - * * @param res Object representing data * @returns JSON object */ @@ -221,7 +208,6 @@ export class ProcessContentService { /** * Creates a JSON array representation of data. - * * @param res Object representing data * @returns JSON array object */ @@ -234,7 +220,6 @@ export class ProcessContentService { /** * Reports an error message. - * * @param error Data object with optional `message` and `status` fields for the error * @returns Callback when an error occurs */ diff --git a/lib/process-services/src/lib/form/services/process-definition.service.ts b/lib/process-services/src/lib/form/services/process-definition.service.ts index 630e6f8ed0..bdbb94b701 100644 --- a/lib/process-services/src/lib/form/services/process-definition.service.ts +++ b/lib/process-services/src/lib/form/services/process-definition.service.ts @@ -40,7 +40,6 @@ export class ProcessDefinitionService { /** * Gets values of fields populated by a REST backend using a process ID. - * * @param processDefinitionId Process identifier * @param field Field identifier * @returns Field values @@ -51,7 +50,6 @@ export class ProcessDefinitionService { /** * Gets column values of fields populated by a REST backend using a process ID. - * * @param processDefinitionId Process identifier * @param field Field identifier * @param column Column identifier @@ -65,7 +63,6 @@ export class ProcessDefinitionService { /** * Creates a JSON representation of form data. - * * @param res Object representing form data * @returns JSON data */ @@ -78,7 +75,6 @@ export class ProcessDefinitionService { /** * Reports an error message. - * * @param error Data object with optional `message` and `status` fields for the error * @returns Error message */ diff --git a/lib/process-services/src/lib/form/services/task-form.service.ts b/lib/process-services/src/lib/form/services/task-form.service.ts index 17aba2b36b..9f1992ea8f 100644 --- a/lib/process-services/src/lib/form/services/task-form.service.ts +++ b/lib/process-services/src/lib/form/services/task-form.service.ts @@ -40,7 +40,6 @@ export class TaskFormService { /** * Saves a task form. - * * @param taskId Task Id * @param formValues Form Values * @returns Null response when the operation is complete @@ -53,7 +52,6 @@ export class TaskFormService { /** * Completes a Task Form. - * * @param taskId Task Id * @param formValues Form Values * @param outcome Form Outcome @@ -70,7 +68,6 @@ export class TaskFormService { /** * Gets a form related to a task. - * * @param taskId ID of the target task * @returns Form definition */ @@ -83,7 +80,6 @@ export class TaskFormService { /** * Gets values of fields populated by a REST backend. - * * @param taskId Task identifier * @param field Field identifier * @returns Field values @@ -94,7 +90,6 @@ export class TaskFormService { /** * Gets column values of fields populated by a REST backend. - * * @param taskId Task identifier * @param field Field identifier * @param column Column identifier @@ -113,7 +108,6 @@ export class TaskFormService { /** * Creates a JSON representation of form data. - * * @param res Object representing form data * @returns JSON data */ @@ -126,7 +120,6 @@ export class TaskFormService { /** * Reports an error message. - * * @param error Data object with optional `message` and `status` fields for the error * @returns Error message */ diff --git a/lib/process-services/src/lib/form/services/task.service.ts b/lib/process-services/src/lib/form/services/task.service.ts index eba012fdd0..e67f473702 100644 --- a/lib/process-services/src/lib/form/services/task.service.ts +++ b/lib/process-services/src/lib/form/services/task.service.ts @@ -38,7 +38,6 @@ export class TaskService { /** * Gets a task. - * * @param taskId Task Id * @returns Task info */ @@ -51,7 +50,6 @@ export class TaskService { /** * Creates a JSON representation of form data. - * * @param res Object representing form data * @returns JSON data */ @@ -64,7 +62,6 @@ export class TaskService { /** * Reports an error message. - * * @param error Data object with optional `message` and `status` fields for the error * @returns Error message */ diff --git a/lib/process-services/src/lib/form/widgets/content-widget/attach-file-widget-dialog.service.ts b/lib/process-services/src/lib/form/widgets/content-widget/attach-file-widget-dialog.service.ts index 882d736bf5..8bd9fe6c0a 100644 --- a/lib/process-services/src/lib/form/widgets/content-widget/attach-file-widget-dialog.service.ts +++ b/lib/process-services/src/lib/form/widgets/content-widget/attach-file-widget-dialog.service.ts @@ -40,7 +40,6 @@ export class AttachFileWidgetDialogService { /** * Opens a dialog to choose a file to upload. - * * @param repository Alfresco endpoint that represents the content service * @param currentFolderId Upload file from specific folder * @param accountIdentifier account identifier diff --git a/lib/process-services/src/lib/form/widgets/document/content.widget.ts b/lib/process-services/src/lib/form/widgets/document/content.widget.ts index 44005282e8..60e08f2fb1 100644 --- a/lib/process-services/src/lib/form/widgets/document/content.widget.ts +++ b/lib/process-services/src/lib/form/widgets/document/content.widget.ts @@ -130,7 +130,6 @@ export class ContentWidgetComponent implements OnChanges { /** * Invoke content download. - * * @param content content link model */ download(content: ContentLinkModel): void { diff --git a/lib/process-services/src/lib/process-comments/services/comment-process.service.ts b/lib/process-services/src/lib/process-comments/services/comment-process.service.ts index 8803fd5afa..a640772a3f 100644 --- a/lib/process-services/src/lib/process-comments/services/comment-process.service.ts +++ b/lib/process-services/src/lib/process-comments/services/comment-process.service.ts @@ -37,7 +37,6 @@ export class CommentProcessService implements CommentsService { /** * Gets all comments that have been added to a process instance. - * * @param id ID of the target process instance * @returns Details for each comment */ @@ -59,7 +58,6 @@ export class CommentProcessService implements CommentsService { /** * Adds a comment to a process instance. - * * @param id ID of the target process instance * @param message Text for the comment * @returns Details of the comment added diff --git a/lib/process-services/src/lib/process-list/components/process-filters/process-filters.component.ts b/lib/process-services/src/lib/process-list/components/process-filters/process-filters.component.ts index a5e20c8d4c..63a043b19c 100644 --- a/lib/process-services/src/lib/process-list/components/process-filters/process-filters.component.ts +++ b/lib/process-services/src/lib/process-list/components/process-filters/process-filters.component.ts @@ -125,7 +125,6 @@ export class ProcessFiltersComponent implements OnInit, OnChanges { /** * Return the filter list filtered by appId - * * @param appId - optional */ getFiltersByAppId(appId?: number) { @@ -158,7 +157,6 @@ export class ProcessFiltersComponent implements OnInit, OnChanges { /** * Return the filter list filtered by appName - * * @param appName application name */ getFiltersByAppName(appName: string): void { @@ -175,7 +173,6 @@ export class ProcessFiltersComponent implements OnInit, OnChanges { /** * Pass the selected filter as next - * * @param filterModel filter model */ selectFilter(filterModel: ProcessInstanceFilterRepresentation) { @@ -186,7 +183,6 @@ export class ProcessFiltersComponent implements OnInit, OnChanges { /** * Select the first filter of a list if present - * * @param filterParam filter parameter */ selectProcessFilter(filterParam: UserProcessInstanceFilterRepresentation): void { @@ -207,7 +203,6 @@ export class ProcessFiltersComponent implements OnInit, OnChanges { /** * Select the Running filter - * * @deprecated in 3.9.0, Use the filterParam Input() with a running filter instance instead */ selectRunningFilter() { @@ -216,7 +211,6 @@ export class ProcessFiltersComponent implements OnInit, OnChanges { /** * Get the current task - * * @returns process instance filter */ getCurrentFilter(): ProcessInstanceFilterRepresentation { @@ -225,7 +219,6 @@ export class ProcessFiltersComponent implements OnInit, OnChanges { /** * Check if the filter list is empty - * * @returns `true` if filter list is empty, otherwise `false` */ isFilterListEmpty(): boolean { @@ -234,7 +227,6 @@ export class ProcessFiltersComponent implements OnInit, OnChanges { /** * Get the material icons equivalent of the glyphicon icon - * * @param icon glyphicon name * @returns material icons equivalent of the icon */ diff --git a/lib/process-services/src/lib/process-list/components/process-list/process-list.component.ts b/lib/process-services/src/lib/process-list/components/process-list/process-list.component.ts index 36e096ee21..25e1f130c0 100644 --- a/lib/process-services/src/lib/process-list/components/process-list/process-list.component.ts +++ b/lib/process-services/src/lib/process-list/components/process-list/process-list.component.ts @@ -252,7 +252,6 @@ export class ProcessInstanceListComponent extends DataTableSchema implements OnC /** * Get the id of the current instance - * * @returns instance id */ getCurrentId(): string { @@ -261,7 +260,6 @@ export class ProcessInstanceListComponent extends DataTableSchema implements OnC /** * Check if the list is empty - * * @returns `true` if list is empty, otherwise `false` */ isListEmpty(): boolean { @@ -270,7 +268,6 @@ export class ProcessInstanceListComponent extends DataTableSchema implements OnC /** * Emit the event rowClick passing the current task id when the row is clicked - * * @param event input event */ onRowClick(event: DataRowEvent) { @@ -286,7 +283,6 @@ export class ProcessInstanceListComponent extends DataTableSchema implements OnC /** * Emit the event rowClick passing the current task id when pressed the Enter key on the selected row - * * @param event keyboard event */ onRowKeyUp(event: CustomEvent) { diff --git a/lib/process-services/src/lib/process-list/components/start-process/start-process.component.spec.ts b/lib/process-services/src/lib/process-list/components/start-process/start-process.component.spec.ts index 8f6a1f52ac..2740cafcc4 100644 --- a/lib/process-services/src/lib/process-list/components/start-process/start-process.component.spec.ts +++ b/lib/process-services/src/lib/process-list/components/start-process/start-process.component.spec.ts @@ -77,7 +77,6 @@ describe('StartProcessComponent', () => { /** * Change application id - * * @param appId application id */ function changeAppId(appId: number) { diff --git a/lib/process-services/src/lib/process-list/services/process-filter.service.ts b/lib/process-services/src/lib/process-list/services/process-filter.service.ts index 4c2d062cc0..7364395799 100644 --- a/lib/process-services/src/lib/process-list/services/process-filter.service.ts +++ b/lib/process-services/src/lib/process-list/services/process-filter.service.ts @@ -39,7 +39,6 @@ export class ProcessFilterService { /** * Gets all filters defined for a Process App. - * * @param appId ID of the target app * @returns Array of filter details */ @@ -59,7 +58,6 @@ export class ProcessFilterService { /** * Retrieves the process filter by ID. - * * @param filterId ID of the filter * @param appId ID of the target app * @returns Details of the filter @@ -70,7 +68,6 @@ export class ProcessFilterService { /** * Retrieves the process filter by name. - * * @param filterName Name of the filter * @param appId ID of the target app * @returns Details of the filter @@ -81,7 +78,6 @@ export class ProcessFilterService { /** * Creates and returns the default filters for an app. - * * @param appId ID of the target app * @returns Default filters just created */ @@ -117,7 +113,6 @@ export class ProcessFilterService { /** * Checks if a filter with the given name already exists in the list of filters. - * * @param filters - An array of objects representing the existing filters. * @param filterName - The name of the filter to check for existence. * @returns - True if a filter with the specified name already exists, false otherwise. @@ -128,7 +123,6 @@ export class ProcessFilterService { /** * Creates and returns a filter that matches "running" process instances. - * * @param appId ID of the target app * @param index of the filter (optional) * @returns Filter just created @@ -146,7 +140,6 @@ export class ProcessFilterService { /** * Adds a filter. - * * @param filter The filter to add * @returns The filter just added */ @@ -156,7 +149,6 @@ export class ProcessFilterService { /** * Calls `getUserProcessInstanceFilters` from the Alfresco JS API. - * * @param appId ID of the target app * @returns List of filter details */ diff --git a/lib/process-services/src/lib/process-list/services/process.service.ts b/lib/process-services/src/lib/process-list/services/process.service.ts index 56a08b580c..6a9bb8d4a6 100644 --- a/lib/process-services/src/lib/process-list/services/process.service.ts +++ b/lib/process-services/src/lib/process-list/services/process.service.ts @@ -64,7 +64,6 @@ export class ProcessService { /** * Gets process instances for a filter and optionally a process definition. - * * @param requestNode Filter for instances * @param processDefinitionKey Limits returned instances to a process definition * @returns List of process instances @@ -85,7 +84,6 @@ export class ProcessService { /** * Gets processes for a filter and optionally a process definition. - * * @param requestNode Filter for instances * @param processDefinitionKey Limits returned instances to a process definition * @returns List of processes @@ -107,7 +105,6 @@ export class ProcessService { /** * Fetches the Process Audit information as a PDF. - * * @param processId ID of the target process * @returns Binary PDF data */ @@ -117,7 +114,6 @@ export class ProcessService { /** * Fetches the Process Audit information in a JSON format. - * * @param processId ID of the target process * @returns JSON data */ @@ -127,7 +123,6 @@ export class ProcessService { /** * Gets Process Instance metadata. - * * @param processInstanceId ID of the target process * @returns Metadata for the instance */ @@ -137,7 +132,6 @@ export class ProcessService { /** * Gets the start form definition for a given process. - * * @param processId Process definition ID * @returns Form definition */ @@ -147,7 +141,6 @@ export class ProcessService { /** * Gets the start form instance for a given process. - * * @param processId Process definition ID * @returns Form definition */ @@ -157,7 +150,6 @@ export class ProcessService { /** * Creates a JSON representation of form data. - * * @param res Object representing form data * @returns JSON data */ @@ -170,7 +162,6 @@ export class ProcessService { /** * Gets task instances for a process instance. - * * @param processInstanceId ID of the process instance * @param state Task state filter (can be "active" or "completed") * @returns Array of task instance details @@ -197,7 +188,6 @@ export class ProcessService { /** * Gets process definitions associated with an app. - * * @param appId ID of a target app * @returns Array of process definitions */ @@ -215,7 +205,6 @@ export class ProcessService { /** * Starts a process based on a process definition, name, form values or variables. - * * @param processDefinitionId Process definition ID * @param name Process name * @param outcome Process outcome @@ -248,7 +237,6 @@ export class ProcessService { /** * Cancels a process instance. - * * @param processInstanceId ID of process to cancel * @returns Null response notifying when the operation is complete */ @@ -258,7 +246,6 @@ export class ProcessService { /** * Gets the variables for a process instance. - * * @param processInstanceId ID of the target process * @returns Array of instance variable info */ @@ -268,7 +255,6 @@ export class ProcessService { /** * Creates or updates variables for a process instance. - * * @param processInstanceId ID of the target process * @param variables Variables to update * @returns Array of instance variable info @@ -279,7 +265,6 @@ export class ProcessService { /** * Deletes a variable for a process instance. - * * @param processInstanceId ID of the target process * @param variableName Name of the variable to delete * @returns Null response notifying when the operation is complete diff --git a/lib/process-services/src/lib/services/apps-process.service.ts b/lib/process-services/src/lib/services/apps-process.service.ts index d5b907c988..3763256ec1 100644 --- a/lib/process-services/src/lib/services/apps-process.service.ts +++ b/lib/process-services/src/lib/services/apps-process.service.ts @@ -35,7 +35,6 @@ export class AppsProcessService { /** * Gets a list of deployed apps for this user. - * * @returns The list of deployed apps */ getDeployedApplications(): Observable { @@ -44,7 +43,6 @@ export class AppsProcessService { /** * Gets a list of deployed apps for this user, where the app name is `name`. - * * @param name Name of the app * @returns The list of deployed apps */ diff --git a/lib/process-services/src/lib/services/people-process.service.ts b/lib/process-services/src/lib/services/people-process.service.ts index 9d34261651..f6a19bd2d9 100644 --- a/lib/process-services/src/lib/services/people-process.service.ts +++ b/lib/process-services/src/lib/services/people-process.service.ts @@ -54,7 +54,6 @@ export class PeopleProcessService { /** * Gets information about the current user. - * * @returns User information object */ getCurrentUserInfo(): Observable { @@ -63,7 +62,6 @@ export class PeopleProcessService { /** * Gets the current user's profile image as a URL. - * * @returns URL string */ getCurrentUserProfileImage(): string { @@ -72,7 +70,6 @@ export class PeopleProcessService { /** * Gets a list of groups in a workflow. - * * @param filter Filter to select specific groups * @param groupId Group ID for the search * @returns Array of groups @@ -87,7 +84,6 @@ export class PeopleProcessService { /** * Gets information about users across all tasks. - * * @param taskId ID of the task * @param searchWord Filter text to search for * @param groupId group id @@ -100,7 +96,6 @@ export class PeopleProcessService { } /** * Gets the profile picture URL for the specified user. - * * @param userId The target user * @returns Profile picture URL */ @@ -110,7 +105,6 @@ export class PeopleProcessService { /** * Sets a user to be involved with a task. - * * @param taskId ID of the target task * @param idToInvolve ID of the user to involve * @returns Empty response when the update completes @@ -121,7 +115,6 @@ export class PeopleProcessService { /** * Removes a user who is currently involved with a task. - * * @param taskId ID of the target task * @param idToRemove ID of the user to remove * @returns Empty response when the update completes diff --git a/lib/process-services/src/lib/services/task-comments.service.ts b/lib/process-services/src/lib/services/task-comments.service.ts index 6e1545a39d..2fb808d46e 100644 --- a/lib/process-services/src/lib/services/task-comments.service.ts +++ b/lib/process-services/src/lib/services/task-comments.service.ts @@ -38,7 +38,6 @@ export class TaskCommentsService implements CommentsService { /** * Gets all comments that have been added to a task. - * * @param id ID of the target task * @returns Details for each comment */ @@ -48,7 +47,6 @@ export class TaskCommentsService implements CommentsService { /** * Adds a comment to a task. - * * @param id ID of the target task * @param message Text for the comment * @returns Details about the comment diff --git a/lib/process-services/src/lib/task-list/components/task-filters/task-filters.component.ts b/lib/process-services/src/lib/task-list/components/task-filters/task-filters.component.ts index fbedaecd11..c75eece7a2 100644 --- a/lib/process-services/src/lib/task-list/components/task-filters/task-filters.component.ts +++ b/lib/process-services/src/lib/task-list/components/task-filters/task-filters.component.ts @@ -128,7 +128,6 @@ export class TaskFiltersComponent implements OnInit, OnChanges { /** * Return the filter list filtered by appId - * * @param appId - optional */ getFiltersByAppId(appId?: number) { @@ -155,7 +154,6 @@ export class TaskFiltersComponent implements OnInit, OnChanges { /** * Return the filter list filtered by appName - * * @param appName application name */ getFiltersByAppName(appName: string): void { @@ -171,7 +169,6 @@ export class TaskFiltersComponent implements OnInit, OnChanges { /** * Create default filters by appId - * * @param appId application id */ private createFiltersByAppId(appId?: number): void { @@ -187,7 +184,6 @@ export class TaskFiltersComponent implements OnInit, OnChanges { /** * Pass the selected filter as next - * * @param newFilter new filter model */ public selectFilter(newFilter: UserTaskFilterRepresentation): void { @@ -208,7 +204,6 @@ export class TaskFiltersComponent implements OnInit, OnChanges { /** * Selects and emits the clicked filter. - * * @param filterParams filter parameters model */ onFilterClick(filterParams: UserTaskFilterRepresentation) { @@ -218,7 +213,6 @@ export class TaskFiltersComponent implements OnInit, OnChanges { /** * Select filter with task - * * @param taskId task id */ selectFilterWithTask(taskId: string): void { @@ -241,7 +235,6 @@ export class TaskFiltersComponent implements OnInit, OnChanges { /** * Get the current filter - * * @returns filter model */ getCurrentFilter(): UserTaskFilterRepresentation { @@ -250,7 +243,6 @@ export class TaskFiltersComponent implements OnInit, OnChanges { /** * Check if the filter list is empty - * * @returns `true` if filter list is empty, otherwise `false` */ isFilterListEmpty(): boolean { @@ -259,7 +251,6 @@ export class TaskFiltersComponent implements OnInit, OnChanges { /** * Get the material icons equivalent of the glyphicon icon - * * @param icon glyphicon name * @returns material icons equivalent of the icon */ diff --git a/lib/process-services/src/lib/task-list/components/task-header/task-header.component.ts b/lib/process-services/src/lib/task-list/components/task-header/task-header.component.ts index b315c6d5d1..9f5cdda134 100644 --- a/lib/process-services/src/lib/task-list/components/task-header/task-header.component.ts +++ b/lib/process-services/src/lib/task-list/components/task-header/task-header.component.ts @@ -176,7 +176,6 @@ export class TaskHeaderComponent implements OnChanges, OnInit { /** * Get the process parent information - * * @returns a map of process instance and definition */ private getParentInfo(): Map { @@ -188,7 +187,6 @@ export class TaskHeaderComponent implements OnChanges, OnInit { /** * Check if the task has an assignee - * * @returns `true` if the task has an assignee, otherwise `false` */ hasAssignee(): boolean { @@ -197,7 +195,6 @@ export class TaskHeaderComponent implements OnChanges, OnInit { /** * Check if the task is assigned to a user - * * @param userId the id of the user to check * @returns `true` if the task assigned to a user, otherwise `false` */ @@ -207,7 +204,6 @@ export class TaskHeaderComponent implements OnChanges, OnInit { /** * Check if the task is assigned to the current user - * * @returns `true` if the task assigned to current user, otherwise `false` */ isAssignedToCurrentUser(): boolean { @@ -216,7 +212,6 @@ export class TaskHeaderComponent implements OnChanges, OnInit { /** * Check if the user is a candidate member - * * @returns `true` if user is a candidate member, otherwise false */ isCandidateMember(): boolean { @@ -225,7 +220,6 @@ export class TaskHeaderComponent implements OnChanges, OnInit { /** * Check if the task is claimable - * * @returns `true` if task can be claimed, otherwise `false` */ isTaskClaimable(): boolean { @@ -234,7 +228,6 @@ export class TaskHeaderComponent implements OnChanges, OnInit { /** * Return true if the task claimed by candidate member. - * * @returns `true` if the task is claimed, otherwise `false` */ isTaskClaimedByCandidateMember(): boolean { @@ -243,7 +236,6 @@ export class TaskHeaderComponent implements OnChanges, OnInit { /** * Get the status of the task - * * @returns `Completed` or `Running` */ getTaskStatus(): 'Completed' | 'Running' { @@ -252,7 +244,6 @@ export class TaskHeaderComponent implements OnChanges, OnInit { /** * Emit the claim event - * * @param taskId the id of the task to claim */ onClaimTask(taskId: string) { @@ -261,7 +252,6 @@ export class TaskHeaderComponent implements OnChanges, OnInit { /** * Emit the unclaim event - * * @param taskId the id of the task to unclaim */ onUnclaimTask(taskId: string) { @@ -270,7 +260,6 @@ export class TaskHeaderComponent implements OnChanges, OnInit { /** * Returns the task completion state - * * @returns `true` if the task is completed, otherwise `false` */ isCompleted(): boolean { @@ -279,7 +268,6 @@ export class TaskHeaderComponent implements OnChanges, OnInit { /** * Check if the form is clickable - * * @returns `true` if the form is clickable, otherwise `false` */ isFormClickable(): boolean { @@ -288,7 +276,6 @@ export class TaskHeaderComponent implements OnChanges, OnInit { /** * Get the task duration - * * @returns the task duration in milliseconds */ getTaskDuration(): string { diff --git a/lib/process-services/src/lib/task-list/components/task-list/task-list.component.ts b/lib/process-services/src/lib/task-list/components/task-list/task-list.component.ts index 06104b34d9..ce66e48237 100644 --- a/lib/process-services/src/lib/task-list/components/task-list/task-list.component.ts +++ b/lib/process-services/src/lib/task-list/components/task-list/task-list.component.ts @@ -287,7 +287,6 @@ export class TaskListComponent extends DataTableSchema implements OnChanges, Aft /** * Select the task given in input if present - * * @param taskIdSelected selected task id */ selectTask(taskIdSelected: string): void { @@ -313,7 +312,6 @@ export class TaskListComponent extends DataTableSchema implements OnChanges, Aft /** * Return the current instance id - * * @returns the current instance id */ getCurrentId(): string { @@ -322,7 +320,6 @@ export class TaskListComponent extends DataTableSchema implements OnChanges, Aft /** * Check if the taskId is the same of the selected task - * * @param taskId task id * @returns `true` if current instance id is the same as task id, otherwise `false` */ @@ -332,7 +329,6 @@ export class TaskListComponent extends DataTableSchema implements OnChanges, Aft /** * Check if the list is empty - * * @returns `true` if list is empty, otherwise `false` */ isListEmpty(): boolean { @@ -430,7 +426,6 @@ export class TaskListComponent extends DataTableSchema implements OnChanges, Aft /** * Optimize name field - * * @param instances task detail models * @returns list of task detail models */ diff --git a/lib/process-services/src/lib/task-list/services/tasklist.service.ts b/lib/process-services/src/lib/task-list/services/tasklist.service.ts index d33e96c47b..f6d57c2a7d 100644 --- a/lib/process-services/src/lib/task-list/services/tasklist.service.ts +++ b/lib/process-services/src/lib/task-list/services/tasklist.service.ts @@ -64,7 +64,6 @@ export class TaskListService { /** * Gets all the filters in the list that belong to a task. - * * @param taskId ID of the target task * @param filterList List of filters to search through * @returns Filters belonging to the task @@ -78,7 +77,6 @@ export class TaskListService { /** * Checks if a taskId is filtered with the given filter. - * * @param taskId ID of the target task * @param filterModel The filter you want to check * @returns The filter if it is related or null otherwise @@ -97,7 +95,6 @@ export class TaskListService { /** * Gets all the tasks matching the supplied query. - * * @param requestNode Query to search for tasks * @returns List of tasks */ @@ -107,7 +104,6 @@ export class TaskListService { /** * Gets tasks matching a query and state value. - * * @param requestNode Query to search for tasks * @returns List of tasks */ @@ -117,7 +113,6 @@ export class TaskListService { /** * Gets details for a task. - * * @param taskId ID of the target task. * @returns Task details */ @@ -127,7 +122,6 @@ export class TaskListService { /** * Gets the checklist for a task. - * * @param id ID of the target task * @returns Array of checklist task details */ @@ -137,7 +131,6 @@ export class TaskListService { /** * Gets all available reusable forms. - * * @returns Array of form details */ getFormList(): Observable { @@ -152,7 +145,6 @@ export class TaskListService { /** * Attaches a form to a task. - * * @param taskId ID of the target task * @param formId ID of the form to add * @returns Null response notifying when the operation is complete @@ -163,7 +155,6 @@ export class TaskListService { /** * Adds a subtask (ie, a checklist task) to a parent task. - * * @param task The task to add * @returns The subtask that was added */ @@ -173,7 +164,6 @@ export class TaskListService { /** * Deletes a subtask (ie, a checklist task) from a parent task. - * * @param taskId The task to delete * @returns Null response notifying when the operation is complete */ @@ -183,7 +173,6 @@ export class TaskListService { /** * Deletes a form from a task. - * * @param taskId Task id related to form * @returns Null response notifying when the operation is complete */ @@ -193,7 +182,6 @@ export class TaskListService { /** * Gives completed status to a task. - * * @param taskId ID of the target task * @returns Null response notifying when the operation is complete */ @@ -203,7 +191,6 @@ export class TaskListService { /** * Creates a new standalone task. - * * @param task Details of the new task * @returns Details of the newly created task */ @@ -213,7 +200,6 @@ export class TaskListService { /** * Assigns a task to a user or group. - * * @param taskId The task to assign * @param requestNode User or group to assign the task to * @returns Details of the assigned task @@ -225,7 +211,6 @@ export class TaskListService { /** * Assigns a task to a user. - * * @param taskId ID of the task to assign * @param userId ID of the user to assign the task to * @returns Details of the assigned task @@ -238,7 +223,6 @@ export class TaskListService { /** * Claims a task for the current user. - * * @param taskId ID of the task to claim * @returns Details of the claimed task */ @@ -248,7 +232,6 @@ export class TaskListService { /** * Un-claims a task for the current user. - * * @param taskId ID of the task to unclaim * @returns Null response notifying when the operation is complete */ @@ -258,7 +241,6 @@ export class TaskListService { /** * Updates the details (name, description, due date) for a task. - * * @param taskId ID of the task to update * @param updated Data to update the task (as a `TaskUpdateRepresentation` instance). * @returns Updated task details @@ -269,7 +251,6 @@ export class TaskListService { /** * Fetches the Task Audit information in PDF format. - * * @param taskId ID of the target task * @returns Binary PDF data */ @@ -279,7 +260,6 @@ export class TaskListService { /** * Fetch the Task Audit information in JSON format - * * @param taskId ID of the target task * @returns JSON data */ diff --git a/package-lock.json b/package-lock.json index dcb6778708..30db444df3 100644 --- a/package-lock.json +++ b/package-lock.json @@ -17994,22 +17994,22 @@ } }, "node_modules/@typescript-eslint/typescript-estree": { - "version": "8.14.0", - "resolved": "https://registry.npmjs.org/@typescript-eslint/typescript-estree/-/typescript-estree-8.14.0.tgz", - "integrity": "sha512-OPXPLYKGZi9XS/49rdaCbR5j/S14HazviBlUQFvSKz3npr3NikF+mrgK7CFVur6XEt95DZp/cmke9d5i3vtVnQ==", + "version": "7.1.1", + "resolved": "https://registry.npmjs.org/@typescript-eslint/typescript-estree/-/typescript-estree-7.1.1.tgz", + "integrity": "sha512-9ZOncVSfr+sMXVxxca2OJOPagRwT0u/UHikM2Rd6L/aB+kL/QAuTnsv6MeXtjzCJYb8PzrXarypSGIPx3Jemxw==", "dev": true, "dependencies": { - "@typescript-eslint/types": "8.14.0", - "@typescript-eslint/visitor-keys": "8.14.0", + "@typescript-eslint/types": "7.1.1", + "@typescript-eslint/visitor-keys": "7.1.1", "debug": "^4.3.4", - "fast-glob": "^3.3.2", + "globby": "^11.1.0", "is-glob": "^4.0.3", - "minimatch": "^9.0.4", - "semver": "^7.6.0", - "ts-api-utils": "^1.3.0" + "minimatch": "9.0.3", + "semver": "^7.5.4", + "ts-api-utils": "^1.0.1" }, "engines": { - "node": "^18.18.0 || ^20.9.0 || >=21.1.0" + "node": "^16.0.0 || >=18.0.0" }, "funding": { "type": "opencollective", @@ -18022,12 +18022,12 @@ } }, "node_modules/@typescript-eslint/typescript-estree/node_modules/@typescript-eslint/types": { - "version": "8.14.0", - "resolved": "https://registry.npmjs.org/@typescript-eslint/types/-/types-8.14.0.tgz", - "integrity": "sha512-yjeB9fnO/opvLJFAsPNYlKPnEM8+z4og09Pk504dkqonT02AyL5Z9SSqlE0XqezS93v6CXn49VHvB2G7XSsl0g==", + "version": "7.1.1", + "resolved": "https://registry.npmjs.org/@typescript-eslint/types/-/types-7.1.1.tgz", + "integrity": "sha512-KhewzrlRMrgeKm1U9bh2z5aoL4s7K3tK5DwHDn8MHv0yQfWFz/0ZR6trrIHHa5CsF83j/GgHqzdbzCXJ3crx0Q==", "dev": true, "engines": { - "node": "^18.18.0 || ^20.9.0 || >=21.1.0" + "node": "^16.0.0 || >=18.0.0" }, "funding": { "type": "opencollective", @@ -18035,16 +18035,16 @@ } }, "node_modules/@typescript-eslint/typescript-estree/node_modules/@typescript-eslint/visitor-keys": { - "version": "8.14.0", - "resolved": "https://registry.npmjs.org/@typescript-eslint/visitor-keys/-/visitor-keys-8.14.0.tgz", - "integrity": "sha512-vG0XZo8AdTH9OE6VFRwAZldNc7qtJ/6NLGWak+BtENuEUXGZgFpihILPiBvKXvJ2nFu27XNGC6rKiwuaoMbYzQ==", + "version": "7.1.1", + "resolved": "https://registry.npmjs.org/@typescript-eslint/visitor-keys/-/visitor-keys-7.1.1.tgz", + "integrity": "sha512-yTdHDQxY7cSoCcAtiBzVzxleJhkGB9NncSIyMYe2+OGON1ZsP9zOPws/Pqgopa65jvknOjlk/w7ulPlZ78PiLQ==", "dev": true, "dependencies": { - "@typescript-eslint/types": "8.14.0", - "eslint-visitor-keys": "^3.4.3" + "@typescript-eslint/types": "7.1.1", + "eslint-visitor-keys": "^3.4.1" }, "engines": { - "node": "^18.18.0 || ^20.9.0 || >=21.1.0" + "node": "^16.0.0 || >=18.0.0" }, "funding": { "type": "opencollective", @@ -18060,26 +18060,10 @@ "balanced-match": "^1.0.0" } }, - "node_modules/@typescript-eslint/typescript-estree/node_modules/fast-glob": { - "version": "3.3.2", - "resolved": "https://registry.npmjs.org/fast-glob/-/fast-glob-3.3.2.tgz", - "integrity": "sha512-oX2ruAFQwf/Orj8m737Y5adxDQO0LAB7/S5MnxCdTNDd4p6BsyIVsv9JQsATbTSq8KHRpLwIHbVlUNatxd+1Ow==", - "dev": true, - "dependencies": { - "@nodelib/fs.stat": "^2.0.2", - "@nodelib/fs.walk": "^1.2.3", - "glob-parent": "^5.1.2", - "merge2": "^1.3.0", - "micromatch": "^4.0.4" - }, - "engines": { - "node": ">=8.6.0" - } - }, "node_modules/@typescript-eslint/typescript-estree/node_modules/minimatch": { - "version": "9.0.5", - "resolved": "https://registry.npmjs.org/minimatch/-/minimatch-9.0.5.tgz", - "integrity": "sha512-G6T0ZX48xgozx7587koeX9Ys2NYy6Gmv//P89sEte9V9whIapMNF4idKxnW2QtCcLiTWlb/wfCabAtAFWhhBow==", + "version": "9.0.3", + "resolved": "https://registry.npmjs.org/minimatch/-/minimatch-9.0.3.tgz", + "integrity": "sha512-RHiac9mvaRw0x3AYRgDC1CxAP7HTcNrrECeA8YYJeWnpo+2Q5CegtZjaotWTWxDG3UeGA1coE05iH1mPjT/2mg==", "dev": true, "dependencies": { "brace-expansion": "^2.0.1" @@ -23171,26 +23155,6 @@ "node": ">=10" } }, - "node_modules/eslint-plugin-storybook/node_modules/eslint-scope": { - "version": "5.1.1", - "dev": true, - "license": "BSD-2-Clause", - "dependencies": { - "esrecurse": "^4.3.0", - "estraverse": "^4.1.1" - }, - "engines": { - "node": ">=8.0.0" - } - }, - "node_modules/eslint-plugin-storybook/node_modules/estraverse": { - "version": "4.3.0", - "dev": true, - "license": "BSD-2-Clause", - "engines": { - "node": ">=4.0" - } - }, "node_modules/eslint-plugin-unicorn": { "version": "49.0.0", "dev": true,