From 657e5ef7fd825ca1b76e4834077d207e51d4b363 Mon Sep 17 00:00:00 2001 From: Ardit Domi <32884230+arditdomi@users.noreply.github.com> Date: Tue, 18 Apr 2023 14:28:07 +0100 Subject: [PATCH] Generate docs (#8481) * Generate docs * Fix duplicated Optional and restore code block ticks * Fix docbuild command errors, improve documentations --------- Co-authored-by: Amedeo Lepore Co-authored-by: Amedeo Lepore --- docs/README.md | 1 + .../components/content-user-info.component.md | 6 +- .../components/document-list.component.md | 9 +-- .../components/node-comments.component.md | 4 +- .../components/search-chip-list.component.md | 2 +- .../components/tags-creator.component.md | 23 ++++--- .../services/audit.service.md | 22 +++---- .../services/category.service.md | 21 ++----- docs/content-services/services/tag.service.md | 62 +++++++++---------- .../identity-user-info.component.md | 4 +- docs/core/components/viewer.component.md | 3 +- docs/core/services/notification.service.md | 2 +- docs/core/services/people-process.service.md | 2 +- .../edit-process-filter-cloud.component.md | 6 +- .../edit-task-filter-cloud.component.md | 5 +- .../process-list-cloud.component.md | 1 + .../components/task-list-cloud.component.md | 1 + .../services/apps-process-cloud.service.md | 10 +-- .../components/process-user-info.component.md | 6 +- .../components/task-comments.component.md | 2 +- .../src/lib/audit/audit.service.ts | 49 +++++++++++++++ .../content-user-info.component.ts | 4 ++ .../search-chip-list.component.ts | 5 +- .../src/lib/tag/services/tag.service.ts | 6 +- .../tags-creator/tags-creator.component.ts | 2 +- .../base-edit-task-filter-cloud.component.ts | 1 + .../process-user-info.component.ts | 4 ++ .../task-comments/task-comments.component.ts | 2 + tools/doc/package-lock.json | 43 +++---------- 29 files changed, 166 insertions(+), 142 deletions(-) diff --git a/docs/README.md b/docs/README.md index 8be42b9083..83d8e4ca07 100644 --- a/docs/README.md +++ b/docs/README.md @@ -302,6 +302,7 @@ for more information about installing and using the source code. | [Tag Node Actions List component](content-services/components/tag-actions.component.md) | Shows available actions for tags. | [Source](../lib/content-services/src/lib/tag/tag-actions.component.ts) | | [Tag List component](content-services/components/tag-list.component.md) | Shows tags for an item. | [Source](../lib/content-services/src/lib/tag/tag-list.component.ts) | | [Tag Node List component](content-services/components/tag-node-list.component.md) | Shows tags for a node. | [Source](../lib/content-services/src/lib/tag/tag-node-list.component.ts) | +| [Tags Creator component](content-services/components/tags-creator.component.md) | Allows to create multiple tags. That component contains input and two lists. Top list is all created tags, bottom list is searched tags based on input's value. | [Source](../lib/content-services/src/lib/tag/tags-creator/tags-creator.component.ts) | | [Tree View component](content-services/components/tree-view.component.md) | Shows the folder and subfolders of a node as a tree view. | [Source](../lib/content-services/src/lib/tree-view/components/tree-view.component.ts) | | [Tree component](content-services/components/tree.component.md) | Shows the nodes in tree structure, each node containing children is collapsible/expandable. Can be integrated with any datasource extending Tree service. | [Source](../lib/content-services/src/lib/tree/components/tree.component.ts) | | [Upload Button Component](content-services/components/upload-button.component.md) | Activates a file upload. | [Source](../lib/content-services/src/lib/upload/components/upload-button.component.ts) | diff --git a/docs/content-services/components/content-user-info.component.md b/docs/content-services/components/content-user-info.component.md index 1695418bd4..b60bcb6436 100644 --- a/docs/content-services/components/content-user-info.component.md +++ b/docs/content-services/components/content-user-info.component.md @@ -23,9 +23,9 @@ Shows user information for `CONTENT` and `CONTENT_SSO` mode. | ---- | ---- | ------------- | ----------- | | bpmBackgroundImage | `string` | | Custom path for the background banner image for APS users. | | ecmBackgroundImage | `string` | | Custom path for the background banner image for ACS users. | -| ecmUser | [`EcmUserModel`](../../core/models/ecm-user.model.md) | | | -| identityUser | [`IdentityUserModel`](../../../lib/process-services-cloud/src/lib/people/models/identity-user.model.ts) | | | -| isLoggedIn | `boolean` | | | +| ecmUser | [`EcmUserModel`](../../core/models/ecm-user.model.md) | | ECM user info. | +| identityUser | [`IdentityUserModel`](../../../lib/process-services-cloud/src/lib/people/models/identity-user.model.ts) | | Identity user info. | +| isLoggedIn | `boolean` | | Determines if user is logged in. | | menuPositionX | [`MenuPositionX`](https://github.com/angular/components/blob/master/src/material/menu/menu-positions.ts) | "after" | Custom choice for opening the menu at the bottom. Can be `before` or `after`. | | menuPositionY | [`MenuPositionY`](https://github.com/angular/components/blob/master/src/material/menu/menu-positions.ts) | "below" | Custom choice for opening the menu at the bottom. Can be `above` or `below`. | | mode | `UserInfoMode` | | current mode. | diff --git a/docs/content-services/components/document-list.component.md b/docs/content-services/components/document-list.component.md index baabbfb7c7..1b52e1ee02 100644 --- a/docs/content-services/components/document-list.component.md +++ b/docs/content-services/components/document-list.component.md @@ -38,6 +38,7 @@ Displays the documents from a repository. - [Custom 'empty folder' template](#custom-empty-folder-template) - [Custom 'permission denied' template](#custom-permission-denied-template) - [Custom 'loading' template](#custom-loading-template) + - [File Auto downloading](#file-auto-downloading) - [See also](#see-also) ## Basic Usage @@ -792,9 +793,9 @@ This will give the following output: ### File Auto downloading -In case of files exceeding a predefined file size, the document list component can be configured to automatically download those file when trying to preview them. +In case of files exceeding a predefined file size, the [document list component](../../content-services/components/document-list.component.md) can be configured to automatically download those file when trying to preview them. This can help in reducing server load, and ensuring quick access to such files. After turning this feature on, whenever the user tries to preview a file with a large -file size, the Document List component will first preview a dialog, asking for confirmation from the user on whether they want to download the file, or cancel the preview altogether. +file size, the [Document List component](../../content-services/components/document-list.component.md) will first preview a dialog, asking for confirmation from the user on whether they want to download the file, or cancel the preview altogether. In order to configure the Document List to automatically download the files, the following environment variables would need to be set up in app.config.json - @@ -805,10 +806,10 @@ In order to configure the Document List to automatically download the files, the } ``` -Here, `"enableFileAutoDownload": true,` would enable the file auto download feature on the Document List component. Setting this flag to false disables this feature, and always +Here, `"enableFileAutoDownload": true,` would enable the file auto download feature on the [Document List component](../../content-services/components/document-list.component.md). Setting this flag to false disables this feature, and always triggers a file preview when trying to view a file, regardless of its size. -The second configuration here, `"fileAutoDownloadSizeThresholdInMB": 15` specifies the file size threshold (in MB), after which the Document List component will start downloading the file. +The second configuration here, `"fileAutoDownloadSizeThresholdInMB": 15` specifies the file size threshold (in MB), after which the [Document List component](../../content-services/components/document-list.component.md) will start downloading the file. In the example provided above, any file greater than 15MB in size would trigger the auto download functionality. Files lower than 15MB in size would continue to preview normally. ## See also diff --git a/docs/content-services/components/node-comments.component.md b/docs/content-services/components/node-comments.component.md index 46d9be106a..be3d23ac7b 100644 --- a/docs/content-services/components/node-comments.component.md +++ b/docs/content-services/components/node-comments.component.md @@ -25,5 +25,5 @@ Displays comments from users involved in a specified content and allows an invol | Name | Type | Default value | Description | | ---- | ---- | ------------- | ----------- | -| nodeId | `string` | | The numeric ID of the node. | -| readOnly | `boolean` | | Are the comments read only? | +| nodeId | `string` | | nodeId of the document that has comments | +| readOnly | `boolean` | | make the [comments component](../../core/components/comments.component.md) readOnly | diff --git a/docs/content-services/components/search-chip-list.component.md b/docs/content-services/components/search-chip-list.component.md index bf6ed9ad45..08fa251205 100644 --- a/docs/content-services/components/search-chip-list.component.md +++ b/docs/content-services/components/search-chip-list.component.md @@ -25,4 +25,4 @@ Displays search criteria as a set of "chips". | Name | Type | Default value | Description | | ---- | ---- | ------------- | ----------- | | clearAll | `boolean` | false | Flag used to enable the display of a clear-all-filters button. | -| searchFilter | [`SearchFilterComponent`](../../content-services/components/search-filter.component.md) | | Search filter to supply the data for the chips. Not required from 4.5.0 and later versions | +| searchFilter | [`SearchFilterComponent`](../../content-services/components/search-filter.component.md) | | Search filter to supply the data for the chips. Not required from 4.5.0 and later versions @deprecated | diff --git a/docs/content-services/components/tags-creator.component.md b/docs/content-services/components/tags-creator.component.md index 0916341ea6..30d5919833 100644 --- a/docs/content-services/components/tags-creator.component.md +++ b/docs/content-services/components/tags-creator.component.md @@ -23,18 +23,17 @@ Allows to create multiple tags. That component contains input and two lists. Top ### Properties -| Name | Type | Default value | Description | -|-----------------------|-------------------|---------------|-------------------------------------------------------------------------------------------------------------------------------------| -| mode | `TagsCreatorMode` | | Create mode if only new tags can be created or Create And Assign mode if new tags can be created and existing tags can be selected. | -| disabledTagsRemoving | `boolean` | false | False if tags can be removed from top list, true otherwise. | -| tags | `string[]` | | Default top list. | -| tagNameControlVisible | `boolean` | false | True if input should be visible, false otherwise. | | +| Name | Type | Default value | Description | +| ---- | ---- | ------------- | ----------- | +| disabledTagsRemoving | `boolean` | false | False if tags can be removed from top list, true otherwise. | +| mode | `TagsCreatorMode` | | Mode for component. In Create mode we can't select existing tags, we can only create them. In Create and Assign mode we can both - create tags and select existing tags. | +| tagNameControlVisible | `boolean` | | Decides if input for tags creation/searching should be visible. When input is hidden then panel of existing tags is hidden as well. | +| tags | `string[]` | | Default top list. | ### Events -| Name | Type | Description | -|-----------------------------------|------------------------------------------------------------------------|--------------------------------------------------| -| existingTagsPanelVisibilityChange | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when bottom list is showing or hiding. | -| tagsChange | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when tags in top list are changed. | -| tagNameControlVisibleChange | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when input is showing or hiding. | - +| Name | Type | Description | +| ---- | ---- | ----------- | +| existingTagsPanelVisibilityChange | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when bottom list is showing or hiding. | +| tagNameControlVisibleChange | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when input is showing or hiding. | +| tagsChange | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when tags in top list are changed. | diff --git a/docs/content-services/services/audit.service.md b/docs/content-services/services/audit.service.md index e6f3a26683..9d7741ca1d 100644 --- a/docs/content-services/services/audit.service.md +++ b/docs/content-services/services/audit.service.md @@ -26,31 +26,31 @@ Manages Audit apps and entries. - **getAuditApp**(auditApplicationId: `string`, opts?: `any`): [`Observable`](http://reactivex.io/documentation/observable.html)``
Get audit application info. - _auditApplicationId:_ `string` - The identifier of an audit application. - - _opts:_ `any` - (Optional)Options. - - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`` - + - _opts:_ `any` - (Optional) Options. + - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`` - status of an audit application. - **getAuditApps**(opts?: `any`): [`Observable`](http://reactivex.io/documentation/observable.html)``
- List audit applications. - - _opts:_ `any` - (Optional)Options. - - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`` - + Gets a list of audit applications. + - _opts:_ `any` - (Optional) Options. + - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`` - a list of the audit applications. - **getAuditEntries**(auditApplicationId: `string`, opts?: `any`): [`Observable`](http://reactivex.io/documentation/observable.html)``
List audit entries for an audit application. - _auditApplicationId:_ `string` - The identifier of an audit application. - - _opts:_ `any` - (Optional)Options. - - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`` - + - _opts:_ `any` - (Optional) Options. + - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`` - a list of audit entries. - **getAuditEntriesForNode**(nodeId: `string`, opts?: `any`): [`Observable`](http://reactivex.io/documentation/observable.html)``
List audit entries for a node. - _nodeId:_ `string` - The identifier of a node. - - _opts:_ `any` - (Optional)Options. + - _opts:_ `any` - (Optional) Options. - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`` - - **getAuditEntry**(auditApplicationId: `string`, auditEntryId: `string`, opts?: `any`): [`Observable`](http://reactivex.io/documentation/observable.html)``
Get audit entry. - _auditApplicationId:_ `string` - The identifier of an audit application. - _auditEntryId:_ `string` - The identifier of an audit entry. - - _opts:_ `any` - (Optional)Options. - - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`` - + - _opts:_ `any` - (Optional) Options. + - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`` - audit entry. - **updateAuditApp**(auditApplicationId: `string`, auditAppBodyUpdate: `boolean`, opts?: `any`): [`Observable`](http://reactivex.io/documentation/observable.html)``
Update audit application info. - _auditApplicationId:_ `string` - The identifier of an audit application. - _auditAppBodyUpdate:_ `boolean` - The audit application to update. - - _opts:_ `any` - (Optional)Options. + - _opts:_ `any` - (Optional) Options. - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`` - diff --git a/docs/content-services/services/category.service.md b/docs/content-services/services/category.service.md index 1cca9f836b..c2e871853d 100644 --- a/docs/content-services/services/category.service.md +++ b/docs/content-services/services/category.service.md @@ -13,22 +13,11 @@ Manages categories in Content Services. ### Methods -- **getSubcategories**(parentCategoryId: `string`, skipCount?: `number`, maxItems?: `number`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`CategoryPaging`](https://github.com/Alfresco/alfresco-js-api/blob/master/src/api/content-rest-api/docs/CategoryPaging.md)`>`
- Gets subcategories of a given parent category. - - _parentCategoryId:_ `string` - Identifier of a parent category - - _skipCount:_ `number` - Number of top categories to skip - - _maxItems:_ `number` - Maximum number of subcategories returned from Observable - - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`CategoryPaging`](https://github.com/Alfresco/alfresco-js-api/blob/master/src/api/content-rest-api/docs/CategoryPaging.md)`>` - CategoryPaging object (defined in JS-API) with category paging list -- **createSubcategories**(parentCategoryId: `string`, payload: [`CategoryBody[]`](https://github.com/Alfresco/alfresco-js-api/blob/master/src/api/content-rest-api/docs/CategoryBody.md)): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`CategoryPaging`](https://github.com/Alfresco/alfresco-js-api/blob/master/src/api/content-rest-api/docs/CategoryPaging.md) | [`CategoryEntry`](https://github.com/Alfresco/alfresco-js-api/blob/master/src/api/content-rest-api/docs/CategoryEntry.md)`>`
- Creates subcategories under category with provided categoryId. - - _parentCategoryId:_ `string` - Identifier of a parent category - - _payload:_ [`CategoryBody[]`](https://github.com/Alfresco/alfresco-js-api/blob/master/src/api/content-rest-api/docs/CategoryBody.md) - List of categories to be created - - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`CategoryPaging`](https://github.com/Alfresco/alfresco-js-api/blob/master/src/api/content-rest-api/docs/CategoryPaging.md) | [`CategoryEntry`](https://github.com/Alfresco/alfresco-js-api/blob/master/src/api/content-rest-api/docs/CategoryEntry.md)`>` - CategoryEntry object (defined in JS-API) containing the category -- **updateCategory**(categoryId: `string`, payload: [`CategoryBody`](https://github.com/Alfresco/alfresco-js-api/blob/master/src/api/content-rest-api/docs/CategoryBody.md)): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`CategoryEntry`](https://github.com/Alfresco/alfresco-js-api/blob/master/src/api/content-rest-api/docs/CategoryEntry.md)`>`
- Updates category. - - _categoryId:_ `string` - Identifier of a category - - _payload:_ [`CategoryBody`](https://github.com/Alfresco/alfresco-js-api/blob/master/src/api/content-rest-api/docs/CategoryBody.md) - Created category body - - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`CategoryEntry`](https://github.com/Alfresco/alfresco-js-api/blob/master/src/api/content-rest-api/docs/CategoryEntry.md)`>` - CategoryEntry object (defined in JS-API) containing the category +- **createSubcategories**(parentCategoryId: `string`, payload: `CategoryBody[]`): [`Observable`](http://reactivex.io/documentation/observable.html)``
+ Creates subcategories under category with provided categoryId + - _parentCategoryId:_ `string` - The identifier of a parent category. + - _payload:_ `CategoryBody[]` - List of categories to be created. + - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`` - [`Observable`](http://reactivex.io/documentation/observable.html)<CategoryPaging | CategoryEntry> - **deleteCategory**(categoryId: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)``
Deletes category - _categoryId:_ `string` - The identifier of a category. diff --git a/docs/content-services/services/tag.service.md b/docs/content-services/services/tag.service.md index a890c9b416..b6556e060d 100644 --- a/docs/content-services/services/tag.service.md +++ b/docs/content-services/services/tag.service.md @@ -18,6 +18,23 @@ Manages tags in Content Services. - _nodeId:_ `string` - ID of the target node - _tagName:_ `string` - Name of the tag to add - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`TagEntry`](https://github.com/Alfresco/alfresco-js-api/blob/master/src/alfresco-core-rest-api/docs/TagEntry.md)`>` - TagEntry object (defined in JS-API) with details of the new tag +- **assignTagsToNode**(nodeId: `string`, tags: `TagBody[]`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`TagPaging`](https://github.com/Alfresco/alfresco-js-api/blob/master/src/alfresco-core-rest-api/docs/TagPaging.md)`|`[`TagEntry`](https://github.com/Alfresco/alfresco-js-api/blob/master/src/alfresco-core-rest-api/docs/TagEntry.md)`>`
+ Assign tags to node. If tag is new then tag is also created additionally, if tag already exists then it is just assigned. + - _nodeId:_ `string` - Id of node to which tags should be assigned. + - _tags:_ `TagBody[]` - List of tags to create and assign or just assign if they already exist. + - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`TagPaging`](https://github.com/Alfresco/alfresco-js-api/blob/master/src/alfresco-core-rest-api/docs/TagPaging.md)`|`[`TagEntry`](https://github.com/Alfresco/alfresco-js-api/blob/master/src/alfresco-core-rest-api/docs/TagEntry.md)`>` - Just linked tags to node or single tag if linked only one tag. +- **createTags**(tags: `TagBody[]`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`TagEntry`](https://github.com/Alfresco/alfresco-js-api/blob/master/src/alfresco-core-rest-api/docs/TagEntry.md)`[]>`
+ Creates tags. + - _tags:_ `TagBody[]` - list of tags to create. + - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`TagEntry`](https://github.com/Alfresco/alfresco-js-api/blob/master/src/alfresco-core-rest-api/docs/TagEntry.md)`[]>` - Created tags. +- **deleteTag**(tagId: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)``
+ Deletes a tag with tagId. This will cause the tag to be removed from all nodes. You must have admin rights to delete a tag. + - _tagId:_ `string` - of the tag to be deleted + - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`` - Null object when the operation completes +- **findTagByName**(name: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`TagEntry`](https://github.com/Alfresco/alfresco-js-api/blob/master/src/alfresco-core-rest-api/docs/TagEntry.md)`>`
+ Find tag which name matches exactly to passed name. + - _name:_ `string` - Value for name which should be used during finding exact tag. + - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`TagEntry`](https://github.com/Alfresco/alfresco-js-api/blob/master/src/alfresco-core-rest-api/docs/TagEntry.md)`>` - Found tag which name matches exactly to passed name. - **getAllTheTags**(opts?: `any`, includedCounts?: `boolean`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`TagPaging`](https://github.com/Alfresco/alfresco-js-api/blob/master/src/alfresco-core-rest-api/docs/TagPaging.md)`>`
Gets a list of all the tags already defined in the repository. - _opts:_ `any` - (Optional) Options supported by JS-API @@ -27,45 +44,24 @@ Manages tags in Content Services. Gets a list of tags added to a node. - _nodeId:_ `string` - ID of the target node - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`TagPaging`](https://github.com/Alfresco/alfresco-js-api/blob/master/src/alfresco-core-rest-api/docs/TagPaging.md)`>` - TagPaging object (defined in JS-API) containing the tags -- **removeTag**(nodeId: `string`, tag: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)``
+- **removeTag**(nodeId: `string`, tag: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)``
Removes a tag from a node. - _nodeId:_ `string` - ID of the target node - _tag:_ `string` - Name of the tag to remove - - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`` - Null object when the operation completes -- **deleteTag**(tagId: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)``
- Completely deletes a tag, this will cause the tag to be removed from all the nodes. - - _tagId:_ `string` - ID of the tag to remove - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`` - Null object when the operation completes -- **createTags**(tags: `TagBody[]`): [`Observable`](http://reactivex.io/documentation/observable.html)``
- Creates tags. - - _tags:_ `TagBody[]` - List of tags to create. - - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`` - List of created tags. -- **updateTag**(tagId: `string`, tagBody: `TagBody`): [`Observable`](http://reactivex.io/documentation/observable.html)``
- Updates a tag. +- **searchTags**(name: `string`, sorting: `Function` = `{ orderBy: 'tag', direction: 'asc' }`, includedCounts?: `boolean`, skipCount: `number` = `0`, maxItems?: `number`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`TagPaging`](https://github.com/Alfresco/alfresco-js-api/blob/master/src/alfresco-core-rest-api/docs/TagPaging.md)`>`
+ Find tags which name contains searched name. + - _name:_ `string` - Value for name which should be used during searching tags. + - _sorting:_ `Function` - Object which configures sorting. OrderBy field specifies field used for sorting, direction specified ascending or descending direction. Default sorting is ascending by tag field. + - _includedCounts:_ `boolean` - (Optional) True if count field should be included in response object for each tag, false otherwise. + - _skipCount:_ `number` - Specify how many first results should be skipped. Default 0. + - _maxItems:_ `number` - (Optional) Specify max number of returned tags. Default is specified by [UserPreferencesService](../../core/services/user-preferences.service.md). + - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`TagPaging`](https://github.com/Alfresco/alfresco-js-api/blob/master/src/alfresco-core-rest-api/docs/TagPaging.md)`>` - Found tags which name contains searched name. +- **updateTag**(tagId: `string`, tagBody: `TagBody`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`TagEntry`](https://github.com/Alfresco/alfresco-js-api/blob/master/src/alfresco-core-rest-api/docs/TagEntry.md)`>`
+ Update a tag - _tagId:_ `string` - The identifier of a tag. - _tagBody:_ `TagBody` - The updated tag. - - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`` - Updated tag. -- **searchTags**(name: `string`, sorting?: `{ orderBy: string, direction: string }`, includedCounts?: `boolean`, skipCount: `number`): [`Observable`](http://reactivex.io/documentation/observable.html)``
- Find tags which name contains searched name. - - _name:_ `string` - Value for name which should be used during searching tags. - - _sorting:_ `{ orderBy: string, direction: string }` - Object which configures sorting. OrderBy field specifies field used for sorting, direction specified ascending or descending direction. Default sorting is ascending by tag field. - - _includedCounts:_ `boolean` - True if count field should be included in response object for each tag, false otherwise. - - _skipCount:_ `number` - Specify how many first results should be skipped. Default 0. - - _maxItems:_ `number` - Specify max number of returned tags. Default is specified by UserPreferencesService. - - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`` - Found tags which name contains searched name. -- **getCountersForTags**(tags: `string[]`): [`Observable`](http://reactivex.io/documentation/observable.html)``
- Get usage counters for passed tags. - - _tags:_ `string[]` - Array of tags names for which there should be returned counters. - - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`` - Array of usage counters for specified tags. -- **findTagByName**(name: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)``
- Find tag which name matches exactly to passed name. - - _name:_ `string` - Value for name which should be used during finding exact tag. - - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`` - Found tag which name matches exactly to passed name. -- **assignTagsToNode**(nodeId: `string`, tags: `TagBody[]`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`TagPaging`](https://github.com/Alfresco/alfresco-js-api/blob/master/src/alfresco-core-rest-api/docs/TagPaging.md)`|`[`TagEntry`](https://github.com/Alfresco/alfresco-js-api/blob/master/src/alfresco-core-rest-api/docs/TagEntry.md)`>`
- Assign tags to node. If tag is new then tag is also created additionally, if tag already exists then it is just assigned. - - _nodeId:_ `string` - Id of node to which tags should be assigned. - - _tags:_ `TagBody[]` - List of tags to create and assign or just assign if they already exist. - - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`TagPaging`](https://github.com/Alfresco/alfresco-js-api/blob/master/src/alfresco-core-rest-api/docs/TagPaging.md)`|`[`TagEntry`](https://github.com/Alfresco/alfresco-js-api/blob/master/src/alfresco-core-rest-api/docs/TagEntry.md)`>` - Just linked tags to node or single tag if linked only one tag. + - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`TagEntry`](https://github.com/Alfresco/alfresco-js-api/blob/master/src/alfresco-core-rest-api/docs/TagEntry.md)`>` - Updated tag. ## Details diff --git a/docs/core/components/identity-user-info.component.md b/docs/core/components/identity-user-info.component.md index e2e9802ffc..18a8ee0089 100644 --- a/docs/core/components/identity-user-info.component.md +++ b/docs/core/components/identity-user-info.component.md @@ -22,8 +22,8 @@ Shows user information for SSO mode. | Name | Type | Default value | Description | | ---- | ---- | ------------- | ----------- | | bpmBackgroundImage | `string` | | Custom path for the background banner image for APS users. | -| identityUser | [`IdentityUserModel`](../../../lib/process-services-cloud/src/lib/people/models/identity-user.model.ts) | | | -| isLoggedIn | `boolean` | | | +| identityUser | [`IdentityUserModel`](../../../lib/process-services-cloud/src/lib/people/models/identity-user.model.ts) | | User | +| isLoggedIn | `boolean` | | Is the user logged in | | menuPositionX | [`MenuPositionX`](https://github.com/angular/components/blob/master/src/material/menu/menu-positions.ts) | "after" | Custom choice for opening the menu at the bottom. Can be `before` or `after`. | | menuPositionY | [`MenuPositionY`](https://github.com/angular/components/blob/master/src/material/menu/menu-positions.ts) | "below" | Custom choice for opening the menu at the bottom. Can be `above` or `below`. | | namePosition | `string` | "right" | When the username is shown, this defines its position relative to the user info button. Can be `right` or `left`. | diff --git a/docs/core/components/viewer.component.md b/docs/core/components/viewer.component.md index e592f28bbc..6e93d3bbea 100644 --- a/docs/core/components/viewer.component.md +++ b/docs/core/components/viewer.component.md @@ -23,6 +23,7 @@ Displays content from blob file or url file. - [Configuring PDF.js library](#configuring-pdfjs-library) - [Extending the Viewer](#extending-the-viewer) - [Custom layout](#custom-layout) +- [Handling non responsive file preview](#handling-non-responsive-file-preview) - [See also](#see-also) ## Basic usage @@ -382,7 +383,7 @@ By default the viewer's zoom scaling is set to 100%. ## Handling non responsive file preview -It is possible that trying to load a large file, especially over a slow network, can cause the viewer component to get stuck in the loading state. To handle such cases, +It is possible that trying to load a large file, especially over a slow network, can cause the [viewer component](../../core/components/viewer.component.md) to get stuck in the loading state. To handle such cases, the viewer can be configured to display a prompt to ask the user to either download the file locally and then close the viewer, or wait for the viewer to load the file. In case the user decides to wait, the viewer can further be configured to display subsequent reminder prompts asking the same options. diff --git a/docs/core/services/notification.service.md b/docs/core/services/notification.service.md index 50fe8f21cb..232cf26afe 100644 --- a/docs/core/services/notification.service.md +++ b/docs/core/services/notification.service.md @@ -120,7 +120,7 @@ export class MyComponent implements OnInit { } ``` -By providing a `decorativeIcon` property in the `SnackBarData`, it is possible to render a decorative +By providing a `decorativeIcon` property in the [`SnackBarData`](../../../lib/core/src/lib/snackbar-content/snack-bar-data.ts), it is possible to render a decorative [`MaterialIcon`](https://material.angular.io/components/icon/overview#interactive-icons) to the left of the message. ```ts diff --git a/docs/core/services/people-process.service.md b/docs/core/services/people-process.service.md index e8b37c6781..de3971f60c 100644 --- a/docs/core/services/people-process.service.md +++ b/docs/core/services/people-process.service.md @@ -32,7 +32,7 @@ Gets information about Process Services users. Gets information about users across all tasks. - _taskId:_ `string` - (Optional) ID of the task - _searchWord:_ `string` - (Optional) Filter text to search for - - _groupId:_ `string` - (Optional) + - _groupId:_ `string` - (Optional) - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`UserProcessModel`](../../core/models/user-process.model.md)`[]>` - Array of user information objects - **involveUserWithTask**(taskId: `string`, idToInvolve: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`UserProcessModel`](../../core/models/user-process.model.md)`[]>`
Sets a user to be involved with a task. diff --git a/docs/process-services-cloud/components/edit-process-filter-cloud.component.md b/docs/process-services-cloud/components/edit-process-filter-cloud.component.md index 05c89b47dd..766937e06f 100644 --- a/docs/process-services-cloud/components/edit-process-filter-cloud.component.md +++ b/docs/process-services-cloud/components/edit-process-filter-cloud.component.md @@ -45,16 +45,16 @@ Shows/edits process filter details. | ---- | ---- | ------------- | ----------- | | actions | `string[]` | DEFAULT_ACTIONS | List of sort actions. | | appName | `string` | "" | The name of the application. | +| environmentId | `string` | | [Environment](../../../lib/process-services-cloud/src/lib/common/interface/environment.interface.ts) ID of the application. | +| environmentList | [`Environment`](../../../lib/process-services-cloud/src/lib/common/interface/environment.interface.ts)`[]` | \[] | List of environments. | | filterProperties | `string[]` | | List of process filter properties to display | | id | `string` | | Id of the process instance filter. | -| environmentId | `string` | | Environment Id of the process instance filter. | -| environmentList | `string[]` | | List of environments. | | role | `string` | "" | roles to filter the apps | | showFilterActions | `boolean` | true | Toggles editing of process filter actions. | | showProcessFilterName | `boolean` | true | Toggles the appearance of the process filter name . | | showTitle | `boolean` | true | Toggles editing of the process filter title. | | sortProperties | `string[]` | | List of sort properties to display. | -| processFilter | [`ProcessFilterCloudModel`](../../../lib/process-services-cloud/src/lib/process/process-filters/models/process-filter-cloud.model.ts) | | | +| processFilter | [`ProcessFilterCloudModel`](../../../lib/process-services-cloud/src/lib/process/process-filters/models/process-filter-cloud.model.ts) | | Process filter | ### Events diff --git a/docs/process-services-cloud/components/edit-task-filter-cloud.component.md b/docs/process-services-cloud/components/edit-task-filter-cloud.component.md index 3427307ba7..0cc891e16e 100644 --- a/docs/process-services-cloud/components/edit-task-filter-cloud.component.md +++ b/docs/process-services-cloud/components/edit-task-filter-cloud.component.md @@ -45,17 +45,16 @@ Edits task filter details. | ---- | ---- | ------------- | ----------- | | actions | `string[]` | | List of task filter actions. | | appName | `string` | "" | (required) Name of the app. | +| environmentList | [`Environment`](../../../lib/process-services-cloud/src/lib/common/interface/environment.interface.ts)`[]` | \[] | List of environments. | | filterProperties | `string[]` | \[] | List of task filter properties to display. | | id | `string` | | (required) ID of the task filter. | -| environmentId | `string` | | Environment Id of the task filter. | -| environmentList | `string[]` | | List of environments. | | processInstanceId | `string` | | processInstanceId of the task filter. | | role | `string` | "" | user role. | | showFilterActions | `boolean` | true | Toggles the filter actions. | | showTaskFilterName | `boolean` | true | Toggles display of task filter name | | showTitle | `boolean` | true | Toggles the title. | | sortProperties | `string[]` | \[] | List of sort properties to display. | -| taskFilter | [`TaskFilterCloudModel`](../../../lib/process-services-cloud/src/lib/task/task-filters/models/filter-cloud.model.ts) | | Task Filter to use | +| taskFilter | [`TaskFilterCloudModel`](../../../lib/process-services-cloud/src/lib/task/task-filters/models/filter-cloud.model.ts) | | Task Filter to use. | ### Events diff --git a/docs/process-services-cloud/components/process-list-cloud.component.md b/docs/process-services-cloud/components/process-list-cloud.component.md index 37390343be..9f329eb514 100644 --- a/docs/process-services-cloud/components/process-list-cloud.component.md +++ b/docs/process-services-cloud/components/process-list-cloud.component.md @@ -57,6 +57,7 @@ when the process list is empty: | completedDate | `string` | "" | Filter the processes. Display only process with completedDate equal to the supplied date. | | completedFrom | `string` | "" | Filter the processes. Display only process with completedFrom equal to the supplied date. | | completedTo | `string` | "" | Filter the processes. Display only process with completedTo equal to the supplied date. | +| environmentId | `string` | | Filter the processes to display only the ones with this environment ID. | | id | `string` | "" | Filter the processes to display only the ones with this ID. | | initiator | `string` | "" | Name of the initiator of the process. | | isResizingEnabled | `boolean` | false | Toggles main datatable column resizing feature. | diff --git a/docs/process-services-cloud/components/task-list-cloud.component.md b/docs/process-services-cloud/components/task-list-cloud.component.md index 505dfe3968..20a937af84 100644 --- a/docs/process-services-cloud/components/task-list-cloud.component.md +++ b/docs/process-services-cloud/components/task-list-cloud.component.md @@ -65,6 +65,7 @@ when the task list is empty: | dueDate | `Date` | | Filter the tasks. Display only tasks with dueDate equal to the supplied date. | | dueDateFrom | `string` | "" | Filter the tasks. Display only tasks with dueDate greater or equal than the supplied date. | | dueDateTo | `string` | "" | Filter the tasks. Display only tasks with dueDate less or equal to the supplied date. | +| environmentId | `string` | | Filter the tasks to display only the ones with this environment ID. | | id | `string` | "" | Filter the tasks. Display only tasks with id equal to the supplied value. | | isResizingEnabled | `boolean` | false | Toggles main datatable column resizing feature. | | lastModifiedFrom | `string` | "" | Filter the tasks. Display only tasks with lastModifiedFrom equal to the supplied date. | diff --git a/docs/process-services-cloud/services/apps-process-cloud.service.md b/docs/process-services-cloud/services/apps-process-cloud.service.md index e7312b4e13..033d7e2d68 100644 --- a/docs/process-services-cloud/services/apps-process-cloud.service.md +++ b/docs/process-services-cloud/services/apps-process-cloud.service.md @@ -13,6 +13,11 @@ Gets details of deployed apps for the current user. ### Methods +- **getApplicationLabel**(application: [`ApplicationInstanceModel`](../../../lib/process-services-cloud/src/lib/app/models/application-instance.model.ts), environmentList?: [`Environment`](../../../lib/process-services-cloud/src/lib/common/interface/environment.interface.ts)`[]`): `string`
+ Gets application label. + - _application:_ [`ApplicationInstanceModel`](../../../lib/process-services-cloud/src/lib/app/models/application-instance.model.ts) - + - _environmentList:_ [`Environment`](../../../lib/process-services-cloud/src/lib/common/interface/environment.interface.ts)`[]` - (Optional) + - **Returns** `string` - - **getDeployedApplicationsByStatus**(status: `string`, role?: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`ApplicationInstanceModel`](../../../lib/process-services-cloud/src/lib/app/models/application-instance.model.ts)`[]>`
Gets a list of deployed apps for this user by status. - _status:_ `string` - Required status value @@ -24,11 +29,6 @@ Gets details of deployed apps for the current user. - **loadApps**()
-- **getApplicationLabel**(application: `ApplicationInstanceModel`, environmentList?: `Environment[]`): `string`
- Gets application label. - - application:_ `ApplicationInstanceModel` - Required application - - environmentList:_ `Environment[]` - (Optional) to add environment name in front of application name - - **Returns** `string` - The application label. ## Details This service implements some features of the [Apps process service](../../core/services/apps-process.service.md) diff --git a/docs/process-services/components/process-user-info.component.md b/docs/process-services/components/process-user-info.component.md index 05a3df84de..ebef96b1d4 100644 --- a/docs/process-services/components/process-user-info.component.md +++ b/docs/process-services/components/process-user-info.component.md @@ -22,10 +22,10 @@ Shows user information for `PROCESS` and `ALL` mode. | Name | Type | Default value | Description | | ---- | ---- | ------------- | ----------- | | bpmBackgroundImage | `string` | | Custom path for the background banner image for APS users. | -| bpmUser | [`BpmUserModel`](../../core/models/bpm-user.model.md) | | | +| bpmUser | [`BpmUserModel`](../../core/models/bpm-user.model.md) | | BPM user info. | | ecmBackgroundImage | `string` | | Custom path for the background banner image for ACS users. | -| ecmUser | [`EcmUserModel`](../../core/models/ecm-user.model.md) | | | -| isLoggedIn | `boolean` | | | +| ecmUser | [`EcmUserModel`](../../core/models/ecm-user.model.md) | | ECM user info. | +| isLoggedIn | `boolean` | | Determines if user is logged in. | | menuPositionX | [`MenuPositionX`](https://github.com/angular/components/blob/master/src/material/menu/menu-positions.ts) | "after" | Custom choice for opening the menu at the bottom. Can be `before` or `after`. | | menuPositionY | [`MenuPositionY`](https://github.com/angular/components/blob/master/src/material/menu/menu-positions.ts) | "below" | Custom choice for opening the menu at the bottom. Can be `above` or `below`. | | mode | `UserInfoMode` | | current mode. | diff --git a/docs/process-services/components/task-comments.component.md b/docs/process-services/components/task-comments.component.md index c9d651c44d..a5d829c24a 100644 --- a/docs/process-services/components/task-comments.component.md +++ b/docs/process-services/components/task-comments.component.md @@ -25,5 +25,5 @@ Displays comments from users involved in a specified task and allows an involved | Name | Type | Default value | Description | | ---- | ---- | ------------- | ----------- | -| readOnly | `boolean` | | Are the comments read only? | +| readOnly | `boolean` | | Determines if comments are read only. | | taskId | `string` | | The numeric ID of the task. | diff --git a/lib/content-services/src/lib/audit/audit.service.ts b/lib/content-services/src/lib/audit/audit.service.ts index c8ea4e3cc7..018355584d 100644 --- a/lib/content-services/src/lib/audit/audit.service.ts +++ b/lib/content-services/src/lib/audit/audit.service.ts @@ -43,6 +43,11 @@ export class AuditService { constructor(private apiService: AlfrescoApiService, private logService: LogService) { } + /** + * Gets a list of audit applications. + * @param opts Options. + * @returns a list of the audit applications. + */ getAuditApps(opts?: any): Observable { const defaultOptions = { skipCount: 0 @@ -54,6 +59,12 @@ export class AuditService { ); } + /** + * Get audit application info. + * @param auditApplicationId The identifier of an audit application. + * @param opts Options. + * @returns status of an audit application. + */ getAuditApp(auditApplicationId: string, opts?: any): Observable { const defaultOptions = { auditApplicationId @@ -65,6 +76,13 @@ export class AuditService { ); } + /** + * Update audit application info. + * @param auditApplicationId The identifier of an audit application. + * @param auditAppBodyUpdate The audit application to update. + * @param opts Options. + * @returns + */ updateAuditApp(auditApplicationId: string, auditAppBodyUpdate: boolean, opts?: any): Observable { const defaultOptions = {}; const queryOptions = Object.assign({}, defaultOptions, opts); @@ -74,6 +92,12 @@ export class AuditService { ); } + /** + * List audit entries for an audit application. + * @param auditApplicationId The identifier of an audit application. + * @param opts Options. + * @returns a list of audit entries. + */ getAuditEntries(auditApplicationId: string, opts?: any): Observable { const defaultOptions = { skipCount: 0, @@ -86,6 +110,13 @@ export class AuditService { ); } + /** + * Get audit entry. + * @param auditApplicationId The identifier of an audit application. + * @param auditEntryId The identifier of an audit entry. + * @param opts Options. + * @returns audit entry. + */ getAuditEntry(auditApplicationId: string, auditEntryId: string, opts?: any): Observable { const defaultOptions = {}; const queryOptions = Object.assign({}, defaultOptions, opts); @@ -95,6 +126,12 @@ export class AuditService { ); } + /** + * List audit entries for a node. + * @param nodeId The identifier of a node. + * @param opts Options. + * @returns + */ getAuditEntriesForNode(nodeId: string, opts?: any): Observable { const defaultOptions = { nodeId @@ -106,6 +143,12 @@ export class AuditService { ); } + /** + * Permanently delete audit entries for an audit application. + * @param auditApplicationId The identifier of an audit application. + * @param where Audit entries to permanently delete for an audit application, given an inclusive time period or range of ids. + * @returns + */ deleteAuditEntries(auditApplicationId: string, where: string): Observable { return from(this.auditApi.deleteAuditEntriesForAuditApp(auditApplicationId, where)) .pipe( @@ -113,6 +156,12 @@ export class AuditService { ); } + /** + * Permanently delete an audit entry. + * @param auditApplicationId The identifier of an audit application. + * @param auditEntryId The identifier of an audit entry. + * @returns + */ deleteAuditEntry(auditApplicationId: string, auditEntryId: string): Observable { return from(this.auditApi.deleteAuditEntry(auditApplicationId, auditEntryId)) .pipe( diff --git a/lib/content-services/src/lib/content-user-info/content-user-info.component.ts b/lib/content-services/src/lib/content-user-info/content-user-info.component.ts index 1ec5f6825a..5bf1496e87 100644 --- a/lib/content-services/src/lib/content-user-info/content-user-info.component.ts +++ b/lib/content-services/src/lib/content-user-info/content-user-info.component.ts @@ -32,15 +32,19 @@ export class ContentUserInfoComponent implements OnDestroy { @ViewChild(MatMenuTrigger) trigger: MatMenuTrigger; + /** Determines if user is logged in. */ @Input() isLoggedIn: boolean; + /** ECM user info. */ @Input() ecmUser: EcmUserModel; + /** Identity user info. */ @Input() identityUser: IdentityUserModel; + /** current mode. */ @Input() mode: UserInfoMode = UserInfoMode.CONTENT; diff --git a/lib/content-services/src/lib/search/components/search-chip-list/search-chip-list.component.ts b/lib/content-services/src/lib/search/components/search-chip-list/search-chip-list.component.ts index d6ddaa2d1f..f4bffe0ce4 100644 --- a/lib/content-services/src/lib/search/components/search-chip-list/search-chip-list.component.ts +++ b/lib/content-services/src/lib/search/components/search-chip-list/search-chip-list.component.ts @@ -28,8 +28,11 @@ import { SearchFacetFiltersService } from '../../services/search-facet-filters.s }) export class SearchChipListComponent { + /** + * Search filter to supply the data for the chips. + * Not required from 4.5.0 and later versions @deprecated + * */ @Input() - /** This is not required since ADF 4.5.0 @deprecated*/ searchFilter: SearchFilterComponent; /** Flag used to enable the display of a clear-all-filters button. */ diff --git a/lib/content-services/src/lib/tag/services/tag.service.ts b/lib/content-services/src/lib/tag/services/tag.service.ts index 7cfed3d1f6..5ef250a430 100644 --- a/lib/content-services/src/lib/tag/services/tag.service.ts +++ b/lib/content-services/src/lib/tag/services/tag.service.ts @@ -150,10 +150,8 @@ export class TagService { * @param maxItems Specify max number of returned tags. Default is specified by UserPreferencesService. * @returns Found tags which name contains searched name. */ - searchTags(name: string, sorting = { - orderBy: 'tag', - direction: 'asc' - }, includedCounts?: boolean, skipCount = 0, maxItems?: number): Observable { + searchTags(name: string, sorting = { orderBy: 'tag', direction: 'asc' }, + includedCounts?: boolean, skipCount = 0, maxItems?: number): Observable { maxItems = maxItems || this.userPreferencesService.paginationSize; return this.getAllTheTags({ tag: `*${name}*`, diff --git a/lib/content-services/src/lib/tag/tags-creator/tags-creator.component.ts b/lib/content-services/src/lib/tag/tags-creator/tags-creator.component.ts index f4d6a7b475..435145d542 100644 --- a/lib/content-services/src/lib/tag/tags-creator/tags-creator.component.ts +++ b/lib/content-services/src/lib/tag/tags-creator/tags-creator.component.ts @@ -117,10 +117,10 @@ export class TagsCreatorComponent implements OnInit, OnDestroy { */ @Output() existingTagsPanelVisibilityChange = new EventEmitter(); - @Output() /** * Emitted when tags in top list are changed. */ + @Output() tagsChange = new EventEmitter(); /** * Emitted when input is showing or hiding. 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 7516f00e8a..a080d1350f 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 @@ -126,6 +126,7 @@ export abstract class BaseEditTaskFilterCloudComponent implements OnInit, OnC label: 'ADF_CLOUD_TASK_FILTERS.STATUS.ALL' }; + /** Task Filter to use. */ @Input() taskFilter: T; diff --git a/lib/process-services/src/lib/process-user-info/process-user-info.component.ts b/lib/process-services/src/lib/process-user-info/process-user-info.component.ts index 711c70367b..908fb4970f 100644 --- a/lib/process-services/src/lib/process-user-info/process-user-info.component.ts +++ b/lib/process-services/src/lib/process-user-info/process-user-info.component.ts @@ -33,15 +33,19 @@ export class ProcessUserInfoComponent implements OnDestroy { @ViewChild(MatMenuTrigger) trigger: MatMenuTrigger; + /** Determines if user is logged in. */ @Input() isLoggedIn: boolean; + /** BPM user info. */ @Input() bpmUser: BpmUserModel; + /** ECM user info. */ @Input() ecmUser: EcmUserModel; + /** current mode. */ @Input() mode: UserInfoMode = UserInfoMode.PROCESS; diff --git a/lib/process-services/src/lib/task-comments/task-comments.component.ts b/lib/process-services/src/lib/task-comments/task-comments.component.ts index 9f29e6d179..014aa4b2b6 100644 --- a/lib/process-services/src/lib/task-comments/task-comments.component.ts +++ b/lib/process-services/src/lib/task-comments/task-comments.component.ts @@ -29,9 +29,11 @@ import { TaskCommentsService } from './services/task-comments.service'; }] }) export class TaskCommentsComponent { + /** The numeric ID of the task. */ @Input() taskId: string; + /** Determines if comments are read only. */ @Input() readOnly: boolean; } diff --git a/tools/doc/package-lock.json b/tools/doc/package-lock.json index 20516a3243..49d683a414 100644 --- a/tools/doc/package-lock.json +++ b/tools/doc/package-lock.json @@ -25,8 +25,7 @@ "version": "0.1.3", "resolved": "https://registry.npmjs.org/@paperist/types-remark/-/types-remark-0.1.3.tgz", "integrity": "sha512-liJvMxGB0IinhxcoMYiSVOgk2z5CZ5/gvpNCXzVC9xVGVtON0lLJZro1ixo5qZJg1ir6N0BY99Y1u6jp2ZNYEg==", - "dev": true, - "requires": {} + "dev": true }, "@types/minimatch": { "version": "3.0.3", @@ -2435,30 +2434,6 @@ "xtend": "^4.0.1" } }, - "remark-parse": { - "version": "4.0.0", - "resolved": "https://registry.npmjs.org/remark-parse/-/remark-parse-4.0.0.tgz", - "integrity": "sha512-XZgICP2gJ1MHU7+vQaRM+VA9HEL3X253uwUM/BGgx3iv6TH2B3bF3B8q00DKcyP9YrJV+/7WOWEWBFF/u8cIsw==", - "dev": true, - "peer": true, - "requires": { - "collapse-white-space": "^1.0.2", - "is-alphabetical": "^1.0.0", - "is-decimal": "^1.0.0", - "is-whitespace-character": "^1.0.0", - "is-word-character": "^1.0.0", - "markdown-escapes": "^1.0.0", - "parse-entities": "^1.0.2", - "repeat-string": "^1.5.4", - "state-toggle": "^1.0.0", - "trim": "0.0.1", - "trim-trailing-lines": "^1.0.0", - "unherit": "^1.0.4", - "unist-util-remove-position": "^1.0.0", - "vfile-location": "^2.0.0", - "xtend": "^4.0.1" - } - }, "remark-stringify": { "version": "5.0.0", "resolved": "https://registry.npmjs.org/remark-stringify/-/remark-stringify-5.0.0.tgz", @@ -2777,14 +2752,6 @@ } } }, - "string_decoder": { - "version": "1.1.1", - "resolved": "https://registry.npmjs.org/string_decoder/-/string_decoder-1.1.1.tgz", - "integrity": "sha512-n/ShnvDi6FHbbVfviro+WojiFzv+s8MPMHBczVePfUpDJLwoLT0ht1l4YwBCbi8pJAveEEdnkHyPyTP/mzRfwg==", - "requires": { - "safe-buffer": "~5.1.0" - } - }, "string-width": { "version": "1.0.2", "resolved": "https://registry.npmjs.org/string-width/-/string-width-1.0.2.tgz", @@ -2795,6 +2762,14 @@ "strip-ansi": "^3.0.0" } }, + "string_decoder": { + "version": "1.1.1", + "resolved": "https://registry.npmjs.org/string_decoder/-/string_decoder-1.1.1.tgz", + "integrity": "sha512-n/ShnvDi6FHbbVfviro+WojiFzv+s8MPMHBczVePfUpDJLwoLT0ht1l4YwBCbi8pJAveEEdnkHyPyTP/mzRfwg==", + "requires": { + "safe-buffer": "~5.1.0" + } + }, "stringify-entities": { "version": "1.3.2", "resolved": "https://registry.npmjs.org/stringify-entities/-/stringify-entities-1.3.2.tgz",