diff --git a/docs/README.md b/docs/README.md index b9cd39b201..f36f54fdb5 100644 --- a/docs/README.md +++ b/docs/README.md @@ -117,7 +117,7 @@ for more information about installing and using the source code. | [Highlight directive](core/highlight.directive.md) | Adds highlighting to selected sections of an HTML element's content. | [Source](../lib/core/directives/highlight.directive.ts) | | [Logout directive](core/logout.directive.md) | Logs the user out when the decorated element is clicked. | [Source](../lib/core/directives/logout.directive.ts) | | [Node delete directive](core/node-delete.directive.md) | Deletes multiple files and folders. | [Source](../lib/core/directives/node-delete.directive.ts) | -| [Node download directive](content-services/node-download.directive.md) | Allows folders and/or files to be downloaded, with multiple nodes packed as a '.ZIP' archive. | [Source](../lib/core/directives/node-download.directive.ts) | +| [Node download directive](core/node-download.directive.md) | Allows folders and/or files to be downloaded, with multiple nodes packed as a '.ZIP' archive. | [Source](../lib/core/directives/node-download.directive.ts) | | [Node favorite directive](core/node-favorite.directive.md) | Selectively toggles nodes as favorites. | [Source](../lib/core/directives/node-favorite.directive.ts) | | [Node permission directive](core/node-permission.directive.md) | Selectively disables an HTML element or Angular component. | [Source](../lib/core/directives/node-permission.directive.ts) | | [Node restore directive](core/node-restore.directive.md) | Restores deleted nodes to their original location. | [Source](../lib/core/directives/node-restore.directive.ts) | @@ -207,7 +207,7 @@ for more information about installing and using the source code. | Name | Description | Source link | | ---- | ----------- | ----------- | | [Data Table Adapter interface](core/datatable-adapter.interface.md) | Defines how table data is supplied to DataTable and Tasklist components. | [Source](../lib/core/datatable/data/datatable-adapter.ts) | -| [Form Field Validator interface](core/form-field-validator.interface.md) | Defines how the input fields of [`Form`](../../lib/process-services/task-list/models/form.model.ts) and Task Details components are validated. | [Source](../lib/core/form/components/widgets/core/form-field-validator.ts) | +| [Form Field Validator interface](core/form-field-validator.interface.md) | Defines how the input fields of Form and Task Details components are validated. | [Source](../lib/core/form/components/widgets/core/form-field-validator.ts) | | [Search Configuration interface](core/search-configuration.interface.md) | Provides fine control of parameters to a search. | [Source](../lib/core/services/search-configuration.service.ts) | [(Back to Contents)](#contents) @@ -315,7 +315,7 @@ for more information about installing and using the source code. | Name | Description | Source link | | ---- | ----------- | ----------- | -| [Search Widget interface](content-services/search-widget.interface.md) | Specifies required properties for [Search filter component](../content-services/search-filter.component.md) widgets. | [Source](../lib/content-services/search/search-widget.interface.ts) | +| [Search Widget interface](content-services/search-widget.interface.md) | Specifies required properties for Search filter component widgets. | [Source](../lib/content-services/search/search-widget.interface.ts) | [(Back to Contents)](#contents) diff --git a/docs/content-services/confirm.dialog.md b/docs/content-services/confirm.dialog.md index cbdff467f4..603fc7a14f 100644 --- a/docs/content-services/confirm.dialog.md +++ b/docs/content-services/confirm.dialog.md @@ -5,7 +5,7 @@ Status: Active Last reviewed: 2019-01-22 --- -# [Confirm dialog component](../../lib/content-services/dialogs/library/library.dialog.ts "Defined in library.dialog.ts") +# [Confirm dialog component](../../lib/content-services/dialogs/confirm.dialog.ts "Defined in confirm.dialog.ts") Requests a yes/no choice from the user. diff --git a/docs/content-services/content-node-share.directive.md b/docs/content-services/content-node-share.directive.md index cc66b1bfa1..e8869f2671 100644 --- a/docs/content-services/content-node-share.directive.md +++ b/docs/content-services/content-node-share.directive.md @@ -36,7 +36,7 @@ Creates and manages public shared links for files. | Name | Type | Default value | Description | | ---- | ---- | ------------- | ----------- | | baseShareUrl | `string` | | Prefix to add to the generated link. | -| node | [`MinimalNodeEntity`](../content-services/document-library.model.md) | | Node to share. | +| node | [`NodeEntry`](https://github.com/Alfresco/alfresco-js-api/blob/master/src/alfresco-core-rest-api/docs/NodeEntry.md) | | [Node](https://github.com/Alfresco/alfresco-js-api/blob/development/src/api/content-rest-api/docs/Node.md) to share. | ## Details diff --git a/docs/content-services/document-actions.service.md b/docs/content-services/document-actions.service.md index dffcd4d840..78dec2c4d4 100644 --- a/docs/content-services/document-actions.service.md +++ b/docs/content-services/document-actions.service.md @@ -5,7 +5,7 @@ Status: Active Last reviewed: 2018-11-13 --- -# [Document Actions service](../../content-services/document-list/services/document-actions.service.ts "Defined in document-actions.service.ts") +# [Document Actions service](../../lib/content-services/document-list/services/document-actions.service.ts "Defined in document-actions.service.ts") Implements the document menu actions for the [Document List component](../content-services/document-list.component.md). diff --git a/docs/content-services/node-permission.service.md b/docs/content-services/node-permission.service.md index 0ae6ee4888..844e60f09d 100644 --- a/docs/content-services/node-permission.service.md +++ b/docs/content-services/node-permission.service.md @@ -49,7 +49,7 @@ Manages role permissions for content nodes. This service requires the Content Services Groups API, which is available from version 5.2.1. See the -[Groups API docs](https://github.com/Alfresco/alfresco-js-api/blob/master/src/alfresco-core-rest-api/docs/GroupssApi.md) +[Groups API docs](https://github.com/Alfresco/alfresco-js-api/blob/development/src/api/content-rest-api/docs/GroupsApi.md) in the Alfresco JS API for more information about the types returned by the methods and for the implementation of the REST API the service is based on. diff --git a/docs/content-services/search-query-builder.service.md b/docs/content-services/search-query-builder.service.md index 720663eb7a..2f50b9bf90 100644 --- a/docs/content-services/search-query-builder.service.md +++ b/docs/content-services/search-query-builder.service.md @@ -5,7 +5,7 @@ Status: Active Last reviewed: 2018-06-12 --- -# [Search Query Builder service](../../content-services/search/search-query-builder.service.ts "Defined in search-query-builder.service.ts") +# [Search Query Builder service](../../lib/content-services/search/search-query-builder.service.ts "Defined in search-query-builder.service.ts") Stores information from all the custom search and faceted search widgets, compiles and runs the final search query. @@ -16,40 +16,45 @@ Stores information from all the custom search and faceted search widgets, compil - **addFilterQuery**(query: `string`)
Adds a filter query to the current query. - _query:_ `string` - Query string to add -- **addUserFacetBucket**(field: [`FacetField`](../../content-services/search/facet-field.interface.ts), bucket: [`FacetFieldBucket`](../../content-services/search/facet-field-bucket.interface.ts))
+- **addUserFacetBucket**(field: [`FacetField`](../../lib/content-services/search/facet-field.interface.ts), bucket: [`FacetFieldBucket`](../../lib/content-services/search/facet-field-bucket.interface.ts))
Adds a facet bucket to a field. - - _field:_ [`FacetField`](../../content-services/search/facet-field.interface.ts) - The target field - - _bucket:_ [`FacetFieldBucket`](../../content-services/search/facet-field-bucket.interface.ts) - Bucket to add + - _field:_ [`FacetField`](../../lib/content-services/search/facet-field.interface.ts) - The target field + - _bucket:_ [`FacetFieldBucket`](../../lib/content-services/search/facet-field-bucket.interface.ts) - Bucket to add - **buildQuery**(): `QueryBody`
Builds the current query. - **Returns** `QueryBody` - The finished query - **execute**()
Builds and executes the current query. -- **getFacetField**(label: `string`): [`FacetField`](../../content-services/search/facet-field.interface.ts)
+- **getFacetField**(label: `string`): [`FacetField`](../../lib/content-services/search/facet-field.interface.ts)
Gets a facet field by label. - _label:_ `string` - Label of the facet field - - **Returns** [`FacetField`](../../content-services/search/facet-field.interface.ts) - Facet field data -- **getFacetQuery**(label: `string`): [`FacetQuery`](../../content-services/search/facet-query.interface.ts)
+ - **Returns** [`FacetField`](../../lib/content-services/search/facet-field.interface.ts) - Facet field data +- **getFacetQuery**(label: `string`): [`FacetQuery`](../../lib/content-services/search/facet-query.interface.ts)
Gets a facet query by label. - _label:_ `string` - Label of the query - - **Returns** [`FacetQuery`](../../content-services/search/facet-query.interface.ts) - Facet query data -- **getPrimarySorting**(): [`SearchSortingDefinition`](../../content-services/search/search-sorting-definition.interface.ts)
+ - **Returns** [`FacetQuery`](../../lib/content-services/search/facet-query.interface.ts) - Facet query data +- **getPrimarySorting**(): [`SearchSortingDefinition`](../../lib/content-services/search/search-sorting-definition.interface.ts)
Gets the primary sorting definition. - - **Returns** [`SearchSortingDefinition`](../../content-services/search/search-sorting-definition.interface.ts) - The primary sorting definition -- **getSortingOptions**(): [`SearchSortingDefinition`](../../content-services/search/search-sorting-definition.interface.ts)`[]`
+ - **Returns** [`SearchSortingDefinition`](../../lib/content-services/search/search-sorting-definition.interface.ts) - The primary sorting definition +- **getQueryGroup**(query: `any`): `any`
+ + - _query:_ `any` - + - **Returns** `any` - + +- **getSortingOptions**(): [`SearchSortingDefinition`](../../lib/content-services/search/search-sorting-definition.interface.ts)`[]`
Gets all pre-configured sorting options that users can choose from. - - **Returns** [`SearchSortingDefinition`](../../content-services/search/search-sorting-definition.interface.ts)`[]` - Pre-configured sorting options -- **getUserFacetBuckets**(field: `string`): [`FacetFieldBucket`](../../content-services/search/facet-field-bucket.interface.ts)`[]`
+ - **Returns** [`SearchSortingDefinition`](../../lib/content-services/search/search-sorting-definition.interface.ts)`[]` - Pre-configured sorting options +- **getUserFacetBuckets**(field: `string`): [`FacetFieldBucket`](../../lib/content-services/search/facet-field-bucket.interface.ts)`[]`
Gets the buckets currently added to a field - _field:_ `string` - The target fields - - **Returns** [`FacetFieldBucket`](../../content-services/search/facet-field-bucket.interface.ts)`[]` - Bucket array + - **Returns** [`FacetFieldBucket`](../../lib/content-services/search/facet-field-bucket.interface.ts)`[]` - Bucket array - **removeFilterQuery**(query: `string`)
Removes an existing filter query. - _query:_ `string` - The query to remove -- **removeUserFacetBucket**(field: [`FacetField`](../../content-services/search/facet-field.interface.ts), bucket: [`FacetFieldBucket`](../../content-services/search/facet-field-bucket.interface.ts))
+- **removeUserFacetBucket**(field: [`FacetField`](../../lib/content-services/search/facet-field.interface.ts), bucket: [`FacetFieldBucket`](../../lib/content-services/search/facet-field-bucket.interface.ts))
Removes an existing bucket from a field. - - _field:_ [`FacetField`](../../content-services/search/facet-field.interface.ts) - The target field - - _bucket:_ [`FacetFieldBucket`](../../content-services/search/facet-field-bucket.interface.ts) - Bucket to remove + - _field:_ [`FacetField`](../../lib/content-services/search/facet-field.interface.ts) - The target field + - _bucket:_ [`FacetFieldBucket`](../../lib/content-services/search/facet-field-bucket.interface.ts) - Bucket to remove - **resetToDefaults**()
Resets the query to the defaults specified in the app config. - **update**()
@@ -86,6 +91,7 @@ constructor(queryBuilder: SearchQueryBuilderService) { } ``` + > **Note:** Since ADF 3.0.0, the query contains the `"facetFormat": "V2"` parameter so that all the responses have the same structure even if coming from search queries containing facetFields, facetQueries, grouped facetQueries or facetIntervals. ## See also diff --git a/docs/core/authentication.service.md b/docs/core/authentication.service.md index 7043c1e6ce..4cd24a868a 100644 --- a/docs/core/authentication.service.md +++ b/docs/core/authentication.service.md @@ -20,18 +20,17 @@ Provides authentication to ACS and APS. - **getBearerExcludedUrls**(): `string[]`
Gets the set of URLs that the token bearer is excluded from. - **Returns** `string[]` - Array of URL strings -- **getBpmLoggedUser**(): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`UserRepresentation`](https://github.com/Alfresco/alfresco-js-api/blob/development/src/alfresco-activiti-rest-api/docs/UserRepresentation.md)`>`
+- **getBpmLoggedUser**(): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`UserRepresentation`](https://github.com/Alfresco/alfresco-js-api/blob/development/src/api/activiti-rest-api/docs/UserRepresentation.md)`>`
Gets information about the user currently logged into APS. - - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`UserRepresentation`](https://github.com/Alfresco/alfresco-js-api/blob/development/src/alfresco-activiti-rest-api/docs/UserRepresentation.md)`>` - User information + - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`UserRepresentation`](https://github.com/Alfresco/alfresco-js-api/blob/development/src/api/activiti-rest-api/docs/UserRepresentation.md)`>` - User information - **getBpmUsername**(): `string`
Gets the BPM username - **Returns** `string` - The BPM username - **getEcmUsername**(): `string`
Gets the ECM username. - **Returns** `string` - The ECM username -- **getRedirect**(provider: `string`): `string`
+- **getRedirect**(): `string`
Gets the URL to redirect to after login. - - _provider:_ `string` - Service provider. Can be "ECM", "BPM" or "ALL". - **Returns** `string` - The redirect URL - **getTicketBpm**(): `string|null`
Gets the BPM ticket stored in the Storage. diff --git a/docs/core/bpm-user.model.md b/docs/core/bpm-user.model.md index 3b30569e5c..304df944d2 100644 --- a/docs/core/bpm-user.model.md +++ b/docs/core/bpm-user.model.md @@ -12,7 +12,7 @@ Contains information about a Process Services user. Instances of this class are returned by the methods of the [Bpm User service](bpm-user.service.md). It implements the -[`UserRepresentation`](https://github.com/Alfresco/alfresco-js-api/blob/development/src/alfresco-activiti-rest-api/docs/UserRepresentation.md) interface, which is defined in the +[`UserRepresentation`](https://github.com/Alfresco/alfresco-js-api/blob/development/src/api/activiti-rest-api/docs/UserRepresentation.md) interface, which is defined in the [Alfresco JS API](https://github.com/Alfresco/alfresco-js-api/blob/master/src/alfresco-activiti-rest-api/docs/UserRepresentation.md). Note that the Typescript class for this model is in active development; diff --git a/docs/core/content.widget.md b/docs/core/content.widget.md index 23cd08e7b3..65a62a3e0c 100644 --- a/docs/core/content.widget.md +++ b/docs/core/content.widget.md @@ -4,7 +4,7 @@ Added: v2.0.0 Status: Active --- -# [APS Content Component](../../core/form/components/widgets/content/content.widget.ts "Defined in content.widget.ts") +# [APS Content Component](../../lib/core/form/components/widgets/content/content.widget.ts "Defined in content.widget.ts") Shows the content preview. diff --git a/docs/core/download-zip.service.md b/docs/core/download-zip.service.md index 7f9046ac83..3e80108a9c 100644 --- a/docs/core/download-zip.service.md +++ b/docs/core/download-zip.service.md @@ -16,19 +16,19 @@ Creates and manages downloads. - **cancelDownload**(downloadId: `string`)
Cancels a download. - _downloadId:_ `string` - ID of the target download node -- **createDownload**(payload: [`DownloadBodyCreate`](https://github.com/Alfresco/alfresco-js-api/blob/development/src/alfresco-core-rest-api/docs/DownloadBodyCreate.md)): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`DownloadEntry`](https://github.com/Alfresco/alfresco-js-api/blob/development/src/alfresco-core-rest-api/docs/DownloadEntry.md)`>`
+- **createDownload**(payload: [`DownloadBodyCreate`](https://github.com/Alfresco/alfresco-js-api/blob/development/src/api/content-rest-api/docs/DownloadBodyCreate.md)): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`DownloadEntry`](https://github.com/Alfresco/alfresco-js-api/blob/development/src/api/content-rest-api/docs/DownloadEntry.md)`>`
Creates a new download. - - _payload:_ [`DownloadBodyCreate`](https://github.com/Alfresco/alfresco-js-api/blob/development/src/alfresco-core-rest-api/docs/DownloadBodyCreate.md) - Object containing the node IDs of the items to add to the ZIP file - - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`DownloadEntry`](https://github.com/Alfresco/alfresco-js-api/blob/development/src/alfresco-core-rest-api/docs/DownloadEntry.md)`>` - Status object for the download + - _payload:_ [`DownloadBodyCreate`](https://github.com/Alfresco/alfresco-js-api/blob/development/src/api/content-rest-api/docs/DownloadBodyCreate.md) - Object containing the node IDs of the items to add to the ZIP file + - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`DownloadEntry`](https://github.com/Alfresco/alfresco-js-api/blob/development/src/api/content-rest-api/docs/DownloadEntry.md)`>` - Status object for the download - **getContentUrl**(nodeId: `string`, attachment?: `boolean`): `string`
Gets a content URL for the given node. - - _nodeId:_ `string` - Node to get URL for. + - _nodeId:_ `string` - [Node](https://github.com/Alfresco/alfresco-js-api/blob/development/src/api/content-rest-api/docs/Node.md) to get URL for. - _attachment:_ `boolean` - (Optional) Toggles whether to retrieve content as an attachment for download - **Returns** `string` - URL string -- **getDownload**(downloadId: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`DownloadEntry`](https://github.com/Alfresco/alfresco-js-api/blob/development/src/alfresco-core-rest-api/docs/DownloadEntry.md)`>`
+- **getDownload**(downloadId: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`DownloadEntry`](https://github.com/Alfresco/alfresco-js-api/blob/development/src/api/content-rest-api/docs/DownloadEntry.md)`>`
Gets status information for a download node. - _downloadId:_ `string` - ID of the download node - - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`DownloadEntry`](https://github.com/Alfresco/alfresco-js-api/blob/development/src/alfresco-core-rest-api/docs/DownloadEntry.md)`>` - Status object for the download + - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`DownloadEntry`](https://github.com/Alfresco/alfresco-js-api/blob/development/src/api/content-rest-api/docs/DownloadEntry.md)`>` - Status object for the download - **getNode**(nodeId: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`NodeEntry`](https://github.com/Alfresco/alfresco-js-api/blob/master/src/alfresco-core-rest-api/docs/NodeEntry.md)`>`
Gets a Node via its node ID. - _nodeId:_ `string` - ID of the target node @@ -38,9 +38,9 @@ Creates and manages downloads. Use `createDownload` to create a node that will represent the downloadable ZIP data. The ZIP archive includes the content of all node IDs passed in via -the [`DownloadBodyCreate`](https://github.com/Alfresco/alfresco-js-api/blob/development/src/alfresco-core-rest-api/docs/DownloadBodyCreate.md) parameter. +the [`DownloadBodyCreate`](https://github.com/Alfresco/alfresco-js-api/blob/development/src/api/content-rest-api/docs/DownloadBodyCreate.md) parameter. -The [`DownloadEntry`](https://github.com/Alfresco/alfresco-js-api/blob/development/src/alfresco-core-rest-api/docs/DownloadEntry.md) object returned by `createDownload` has an +The [`DownloadEntry`](https://github.com/Alfresco/alfresco-js-api/blob/development/src/api/content-rest-api/docs/DownloadEntry.md) object returned by `createDownload` has an `id` field that you can use to identify the download node (eg, to cancel it later or get the node URL when the download is complete) and other information about the progress of the download. diff --git a/docs/core/icon.component.md b/docs/core/icon.component.md index 5e465d27c9..d5128b100b 100644 --- a/docs/core/icon.component.md +++ b/docs/core/icon.component.md @@ -5,7 +5,7 @@ Status: Active Last reviewed: 2019-01-10 --- -# [Icon Component](../../core/icon/icon.component.ts "Defined in icon.component.ts") +# [Icon Component](../../lib/core/icon/icon.component.ts "Defined in icon.component.ts") Provides a universal way of rendering registered and named icons. @@ -28,8 +28,8 @@ Provides a universal way of rendering registered and named icons. | Name | Type | Default value | Description | | ---- | ---- | ------------- | ----------- | -| value | `string` | | Icon value, which can be either a ligature name or a custom icon in the format `[namespace]:[name]`. | -| color | ThemePalette | |Theme color palette for the component. | +| color | `ThemePalette` | | Theme color palette for the component. | +| value | `string` | | Icon value, which can be either a ligature name or a custom icon in the format `[namespace]:[name]`. | ## Details diff --git a/docs/core/node-delete.directive.md b/docs/core/node-delete.directive.md index 0e73650726..b72a84e9cd 100644 --- a/docs/core/node-delete.directive.md +++ b/docs/core/node-delete.directive.md @@ -31,7 +31,7 @@ Deletes multiple files and folders. | Name | Type | Default value | Description | | ---- | ---- | ------------- | ----------- | | permanent | `boolean` | false | If true then the nodes are deleted immediately rather than being put in the trash | -| selection | [`MinimalNodeEntity`](../content-services/document-library.model.md)`[] \| DeletedNodeEntity[]` | | Array of nodes to delete. | +| selection | [`NodeEntry`](https://github.com/Alfresco/alfresco-js-api/blob/master/src/alfresco-core-rest-api/docs/NodeEntry.md)`[] \| DeletedNodeEntity[]` | | Array of nodes to delete. | ### Events diff --git a/docs/content-services/node-download.directive.md b/docs/core/node-download.directive.md similarity index 100% rename from docs/content-services/node-download.directive.md rename to docs/core/node-download.directive.md diff --git a/docs/core/node-favorite.directive.md b/docs/core/node-favorite.directive.md index 8b8f8ea940..10ad34d74b 100644 --- a/docs/core/node-favorite.directive.md +++ b/docs/core/node-favorite.directive.md @@ -43,7 +43,7 @@ export class MyComponent { | Name | Type | Default value | Description | | ---- | ---- | ------------- | ----------- | -| selection | [`MinimalNodeEntity`](../content-services/document-library.model.md)`[]` | \[] | Array of nodes to toggle as favorites. | +| selection | [`NodeEntry`](https://github.com/Alfresco/alfresco-js-api/blob/master/src/alfresco-core-rest-api/docs/NodeEntry.md)`[]` | \[] | Array of nodes to toggle as favorites. | ### Events diff --git a/docs/core/translation.service.md b/docs/core/translation.service.md index 81dd71709f..ccf7d995fa 100644 --- a/docs/core/translation.service.md +++ b/docs/core/translation.service.md @@ -5,7 +5,7 @@ Status: Active Last reviewed: 2018-06-07 --- -# [Translation service](../../core/services/translation.service.ts "Defined in translation.service.ts") +# [Translation service](../../lib/core/services/translation.service.ts "Defined in translation.service.ts") Supports localisation. diff --git a/docs/core/viewer.component.md b/docs/core/viewer.component.md index f313ac4696..fec04343fa 100644 --- a/docs/core/viewer.component.md +++ b/docs/core/viewer.component.md @@ -91,7 +91,7 @@ See the [Custom layout](#custom-layout) section for full details of all availabl | fileName | `string` | | Content filename. | | maxRetries | `number` | 10 | Number of times the Viewer will retry fetching content Rendition. There is a delay of at least one second between attempts. | | mimeType | `string` | | MIME type of the file content (when not determined by the filename extension). | -| nodeId | `string` | null | Node Id of the file to load. | +| nodeId | `string` | null | [Node](https://github.com/Alfresco/alfresco-js-api/blob/development/src/api/content-rest-api/docs/Node.md) Id of the file to load. | | overlayMode | `boolean` | false | If `true` then show the Viewer as a full page over the current content. Otherwise fit inside the parent div. | | sharedLinkId | `string` | null | Shared link id (to display shared file). | | showLeftSidebar | `boolean` | false | Toggles left sidebar visibility. Requires `allowLeftSidebar` to be set to `true`. | diff --git a/docs/extensions/README.md b/docs/extensions/README.md index a084157e61..e30f6084af 100644 --- a/docs/extensions/README.md +++ b/docs/extensions/README.md @@ -17,7 +17,6 @@ for more information about installing and using the source code. | Name | Description | Source link | | ---- | ----------- | ----------- | | [Dynamic component](dynamic.component.md) ![Experimental](../docassets/images/ExperimentalIcon.png) | Displays dynamically-loaded extension components. | [Source](../../lib/extensions/src/lib/components/dynamic-component/dynamic.component.ts) | -| [Dynamic tab component](dynamic-tab.component.md) ![Experimental](../docassets/images/ExperimentalIcon.png) | Displays dynamically-loaded extensions with tabs. | [Source](../../lib/extensions/src/lib/components/dynamic-tab/dynamic-tab.component.ts) | ## Services diff --git a/docs/process-services/process-filters.component.md b/docs/process-services/process-filters.component.md index b6aab78b11..f68e6fcb0c 100644 --- a/docs/process-services/process-filters.component.md +++ b/docs/process-services/process-filters.component.md @@ -44,9 +44,9 @@ Collection of criteria used to filter process instances, which may be customized | Name | Type | Description | | ---- | ---- | ----------- | | error | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when an error occurs. | -| filterClick | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`UserProcessInstanceFilterRepresentation`](https://github.com/Alfresco/alfresco-js-api/blob/development/src/alfresco-activiti-rest-api/docs/UserProcessInstanceFilterRepresentation.md)`>` | Emitted when the user selects a filter from the list. | -| filterSelected | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`ProcessInstanceFilterRepresentation`](https://github.com/Alfresco/alfresco-js-api/blob/development/src/alfresco-activiti-rest-api/docs/ProcessInstanceFilterRepresentation.md)`>` | Emitted when a process filter is selected. | -| success | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`ProcessInstanceFilterRepresentation`](https://github.com/Alfresco/alfresco-js-api/blob/development/src/alfresco-activiti-rest-api/docs/ProcessInstanceFilterRepresentation.md)`[]>` | Emitted when the list of filters has been successfully loaded from the server. | +| filterClick | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`UserProcessInstanceFilterRepresentation`](https://github.com/Alfresco/alfresco-js-api/blob/development/src/api/activiti-rest-api/docs/UserProcessInstanceFilterRepresentation.md)`>` | Emitted when the user selects a filter from the list. | +| filterSelected | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`ProcessInstanceFilterRepresentation`](https://github.com/Alfresco/alfresco-js-api/blob/development/src/api/activiti-rest-api/docs/ProcessInstanceFilterRepresentation.md)`>` | Emitted when a process filter is selected. | +| success | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`ProcessInstanceFilterRepresentation`](https://github.com/Alfresco/alfresco-js-api/blob/development/src/api/activiti-rest-api/docs/ProcessInstanceFilterRepresentation.md)`[]>` | Emitted when the list of filters has been successfully loaded from the server. | ## Details diff --git a/docs/process-services/process.service.md b/docs/process-services/process.service.md index aa556deb41..0a8b54b7f2 100644 --- a/docs/process-services/process.service.md +++ b/docs/process-services/process.service.md @@ -5,7 +5,7 @@ Status: Active Last reviewed: 2018-03-20 --- -# [Process Service](../../process-services/process-list/services/process.service.ts "Defined in process.service.ts") +# [Process Service](../../lib/process-services/process-list/services/process.service.ts "Defined in process.service.ts") Manages Process Instances, Process Variables, and Process Audit Log. @@ -17,11 +17,11 @@ Manages Process Instances, Process Variables, and Process Audit Log. Cancels a process instance. - _processInstanceId:_ `string` - ID of process to cancel - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`` - Null response notifying when the operation is complete -- **createOrUpdateProcessInstanceVariables**(processInstanceId: `string`, variables: `RestVariable[]`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`ProcessInstanceVariable`](../../process-services/process-list/models/process-instance-variable.model.ts)`[]>`
+- **createOrUpdateProcessInstanceVariables**(processInstanceId: `string`, variables: `RestVariable[]`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`ProcessInstanceVariable`](../../lib/process-services/process-list/models/process-instance-variable.model.ts)`[]>`
Creates or updates variables for a process instance. - _processInstanceId:_ `string` - ID of the target process - _variables:_ `RestVariable[]` - Variables to update - - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`ProcessInstanceVariable`](../../process-services/process-list/models/process-instance-variable.model.ts)`[]>` - Array of instance variable info + - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`ProcessInstanceVariable`](../../lib/process-services/process-list/models/process-instance-variable.model.ts)`[]>` - Array of instance variable info - **deleteProcessInstanceVariable**(processInstanceId: `string`, variableName: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)``
Deletes a variable for a process instance. - _processInstanceId:_ `string` - ID of the target process @@ -35,41 +35,41 @@ Manages Process Instances, Process Variables, and Process Audit Log. Fetches the Process Audit information as a PDF. - _processId:_ `string` - ID of the target process - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`Blob`](https://developer.mozilla.org/en-US/docs/Web/API/Blob)`>` - Binary PDF data -- **getProcess**(processInstanceId: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`ProcessInstance`](../../process-services/process-list/models/process-instance.model.ts)`>`
+- **getProcess**(processInstanceId: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`ProcessInstance`](../../lib/process-services/process-list/models/process-instance.model.ts)`>`
Gets Process Instance metadata. - _processInstanceId:_ `string` - ID of the target process - - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`ProcessInstance`](../../process-services/process-list/models/process-instance.model.ts)`>` - Metadata for the instance -- **getProcessDefinitions**(appId?: `number`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`ProcessDefinitionRepresentation`](../../process-services/process-list/models/process-definition.model.ts)`[]>`
+ - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`ProcessInstance`](../../lib/process-services/process-list/models/process-instance.model.ts)`>` - Metadata for the instance +- **getProcessDefinitions**(appId?: `number`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`ProcessDefinitionRepresentation`](../../lib/process-services/process-list/models/process-definition.model.ts)`[]>`
Gets process definitions associated with an app. - _appId:_ `number` - (Optional) ID of a target app - - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`ProcessDefinitionRepresentation`](../../process-services/process-list/models/process-definition.model.ts)`[]>` - Array of process definitions -- **getProcessInstanceVariables**(processInstanceId: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`ProcessInstanceVariable`](../../process-services/process-list/models/process-instance-variable.model.ts)`[]>`
+ - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`ProcessDefinitionRepresentation`](../../lib/process-services/process-list/models/process-definition.model.ts)`[]>` - Array of process definitions +- **getProcessInstanceVariables**(processInstanceId: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`ProcessInstanceVariable`](../../lib/process-services/process-list/models/process-instance-variable.model.ts)`[]>`
Gets the variables for a process instance. - _processInstanceId:_ `string` - ID of the target process - - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`ProcessInstanceVariable`](../../process-services/process-list/models/process-instance-variable.model.ts)`[]>` - Array of instance variable info -- **getProcessInstances**(requestNode: [`ProcessFilterParamRepresentationModel`](../../process-services/process-list/models/filter-process.model.ts), processDefinitionKey?: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`ProcessListModel`](../../process-services/process-list/models/process-list.model.ts)`>`
+ - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`ProcessInstanceVariable`](../../lib/process-services/process-list/models/process-instance-variable.model.ts)`[]>` - Array of instance variable info +- **getProcessInstances**(requestNode: [`ProcessFilterParamRepresentationModel`](../../lib/process-services/process-list/models/filter-process.model.ts), processDefinitionKey?: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`ProcessListModel`](../../lib/process-services/process-list/models/process-list.model.ts)`>`
Gets process instances for a filter and optionally a process definition. - - _requestNode:_ [`ProcessFilterParamRepresentationModel`](../../process-services/process-list/models/filter-process.model.ts) - Filter for instances + - _requestNode:_ [`ProcessFilterParamRepresentationModel`](../../lib/process-services/process-list/models/filter-process.model.ts) - Filter for instances - _processDefinitionKey:_ `string` - (Optional) Limits returned instances to a process definition - - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`ProcessListModel`](../../process-services/process-list/models/process-list.model.ts)`>` - List of process instances -- **getProcessTasks**(processInstanceId: `string`, state?: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`TaskDetailsModel`](../../process-services/task-list/models/task-details.model.ts)`[]>`
+ - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`ProcessListModel`](../../lib/process-services/process-list/models/process-list.model.ts)`>` - List of process instances +- **getProcessTasks**(processInstanceId: `string`, state?: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`TaskDetailsModel`](../../lib/process-services/task-list/models/task-details.model.ts)`[]>`
Gets task instances for a process instance. - _processInstanceId:_ `string` - ID of the process instance - _state:_ `string` - (Optional) Task state filter (can be "active" or "completed") - - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`TaskDetailsModel`](../../process-services/task-list/models/task-details.model.ts)`[]>` - Array of task instance details -- **getProcesses**(requestNode: [`ProcessFilterParamRepresentationModel`](../../process-services/process-list/models/filter-process.model.ts), processDefinitionKey?: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`ProcessListModel`](../../process-services/process-list/models/process-list.model.ts)`>`
+ - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`TaskDetailsModel`](../../lib/process-services/task-list/models/task-details.model.ts)`[]>` - Array of task instance details +- **getProcesses**(requestNode: [`ProcessFilterParamRepresentationModel`](../../lib/process-services/process-list/models/filter-process.model.ts), processDefinitionKey?: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`ProcessListModel`](../../lib/process-services/process-list/models/process-list.model.ts)`>`
Gets processes for a filter and optionally a process definition. - - _requestNode:_ [`ProcessFilterParamRepresentationModel`](../../process-services/process-list/models/filter-process.model.ts) - Filter for instances + - _requestNode:_ [`ProcessFilterParamRepresentationModel`](../../lib/process-services/process-list/models/filter-process.model.ts) - Filter for instances - _processDefinitionKey:_ `string` - (Optional) Limits returned instances to a process definition - - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`ProcessListModel`](../../process-services/process-list/models/process-list.model.ts)`>` - List of processes -- **startProcess**(processDefinitionId: `string`, name: `string`, outcome?: `string`, startFormValues?: [`FormValues`](../../core/form/components/widgets/core/form-values.ts), variables?: [`ProcessInstanceVariable`](../../process-services/process-list/models/process-instance-variable.model.ts)`[]`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`ProcessInstance`](../../process-services/process-list/models/process-instance.model.ts)`>`
+ - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`ProcessListModel`](../../lib/process-services/process-list/models/process-list.model.ts)`>` - List of processes +- **startProcess**(processDefinitionId: `string`, name: `string`, outcome?: `string`, startFormValues?: [`FormValues`](../../lib/core/form/components/widgets/core/form-values.ts), variables?: [`ProcessInstanceVariable`](../../lib/process-services/process-list/models/process-instance-variable.model.ts)`[]`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`ProcessInstance`](../../lib/process-services/process-list/models/process-instance.model.ts)`>`
Starts a process based on a process definition, name, form values or variables. - _processDefinitionId:_ `string` - Process definition ID - _name:_ `string` - Process name - _outcome:_ `string` - (Optional) Process outcome - - _startFormValues:_ [`FormValues`](../../core/form/components/widgets/core/form-values.ts) - (Optional) Values for the start form - - _variables:_ [`ProcessInstanceVariable`](../../process-services/process-list/models/process-instance-variable.model.ts)`[]` - (Optional) Array of process instance variables - - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`ProcessInstance`](../../process-services/process-list/models/process-instance.model.ts)`>` - Details of the process instance just started + - _startFormValues:_ [`FormValues`](../../lib/core/form/components/widgets/core/form-values.ts) - (Optional) Values for the start form + - _variables:_ [`ProcessInstanceVariable`](../../lib/process-services/process-list/models/process-instance-variable.model.ts)`[]` - (Optional) Array of process instance variables + - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`ProcessInstance`](../../lib/process-services/process-list/models/process-instance.model.ts)`>` - Details of the process instance just started ## Details @@ -113,7 +113,7 @@ this.processService.startProcess(processDefinitionId, name, outcome, startFormVa }); ``` -A [`ProcessInstance`](../../process-services/process-list/models/process-instance.model.ts) object is returned for a successfully started process. This implements the +A [`ProcessInstance`](../../lib/process-services/process-list/models/process-instance.model.ts) object is returned for a successfully started process. This implements the [ProcessInstanceRepresentation interface](https://github.com/Alfresco/alfresco-js-api/blob/master/src/alfresco-activiti-rest-api/docs/ProcessInstanceRepresentation.md). You can start the process with process variables instead of form field values using diff --git a/docs/process-services/start-task.component.md b/docs/process-services/start-task.component.md index 1096455253..f7e0d36af0 100644 --- a/docs/process-services/start-task.component.md +++ b/docs/process-services/start-task.component.md @@ -5,7 +5,7 @@ Status: Active Last reviewed: 2019-01-14 --- -# [Start Task Component](../../process-services/task-list/components/start-task.component.ts "Defined in start-task.component.ts") +# [Start Task Component](../../lib/process-services/task-list/components/start-task.component.ts "Defined in start-task.component.ts") Creates/Starts a new task for the specified app. diff --git a/docs/user-guide/app-extensions.md b/docs/user-guide/app-extensions.md index e22f167f56..1c8f930be4 100644 --- a/docs/user-guide/app-extensions.md +++ b/docs/user-guide/app-extensions.md @@ -45,11 +45,11 @@ a place in the app where the actual content will be supplied dynamically. ADF provides a number of features that offer extension points or help with extensibility in general: -- **Components**: The [Dynamic component](../extensions/dynamic.component.md) and [Dynamic Tab component](../extensions/dynamic-tab.component.md) - have no content of their own but they have an `id` property that +- **Components**: The [Dynamic component](../extensions/dynamic.component.md) + has no content of its own but it has an `id` property that references a registered component extension ID. The referenced component will be added as a child of the Dynamic component at runtime. -- **Routes**: These are registered as key/ID strings that resolve to standard +- **Routes**: These are registered as key/ID strings that resolve to standard Angular routes. This feature can be used, say, that a click on a list item should send the user _somewhere_ but leave the actual destination up to the developer. @@ -79,7 +79,7 @@ with extensibility in general: ## Setting up an app for extensibility You can register component classes for use with the [Dynamic component](../extensions/dynamic.component.md) -or [Dynamic Tab component](../extensions/dynamic-tab.component.md) using the `setComponents` method of the +using the `setComponents` method of the [Extension service](../extensions/extension.service.md) (see the Dynamic component page for further details and code samples). The service also has `setAuthGuards` and `setEvaluators` methods that behave analogously. diff --git a/docs/versionIndex.md b/docs/versionIndex.md index 95a1a2287e..18058a6d39 100644 --- a/docs/versionIndex.md +++ b/docs/versionIndex.md @@ -175,7 +175,7 @@ backend services have been tested with each released version of ADF. -- [Node download directive](content-services/node-download.directive.md) +- [Node download directive](core/node-download.directive.md) - [Node lock directive](content-services/node-lock.directive.md) diff --git a/tools/doc/doctool.config.json b/tools/doc/doctool.config.json index db9ce22ab9..b0a2bb7536 100644 --- a/tools/doc/doctool.config.json +++ b/tools/doc/doctool.config.json @@ -20,6 +20,9 @@ "typeLinker", "toc" ], + "check": [ + "fileChecker" + ], "dev": [ "toc" ] @@ -41,13 +44,13 @@ "Subject": "http://reactivex.io/documentation/subject.html", "AppDefinitionRepresentation": "https://github.com/Alfresco/alfresco-js-api/blob/master/src/alfresco-activiti-rest-api/docs/AppDefinitionRepresentation.md", "DeletedNodesPaging": "https://github.com/Alfresco/alfresco-js-api/blob/master/src/alfresco-core-rest-api/docs/DeletedNodesPaging.md", - "DownloadBodyCreate": "https://github.com/Alfresco/alfresco-js-api/blob/development/src/alfresco-core-rest-api/docs/DownloadBodyCreate.md", - "DownloadEntry": "https://github.com/Alfresco/alfresco-js-api/blob/development/src/alfresco-core-rest-api/docs/DownloadEntry.md", + "DownloadBodyCreate": "https://github.com/Alfresco/alfresco-js-api/blob/development/src/api/content-rest-api/docs/DownloadBodyCreate.md", + "DownloadEntry": "https://github.com/Alfresco/alfresco-js-api/blob/development/src/api/content-rest-api/docs/DownloadEntry.md", "GroupMemberPaging": "https://github.com/Alfresco/alfresco-js-api/blob/development/src/api/content-rest-api/docs/GroupMemberPaging.md", "MinimalNode": "https://github.com/Alfresco/alfresco-js-api/blob/master/src/alfresco-core-rest-api/docs/NodeMinimalEntry.md", "Node": "https://github.com/Alfresco/alfresco-js-api/blob/development/src/api/content-rest-api/docs/Node.md", "NodeEntry": "https://github.com/Alfresco/alfresco-js-api/blob/master/src/alfresco-core-rest-api/docs/NodeEntry.md", - "ProcessInstanceFilterRepresentation": "https://github.com/Alfresco/alfresco-js-api/blob/development/src/alfresco-activiti-rest-api/docs/ProcessInstanceFilterRepresentation.md", + "ProcessInstanceFilterRepresentation": "https://github.com/Alfresco/alfresco-js-api/blob/development/src/api/activiti-rest-api/docs/ProcessInstanceFilterRepresentation.md", "RelatedContentRepresentation": "https://github.com/Alfresco/alfresco-js-api/blob/master/src/alfresco-activiti-rest-api/docs/RelatedContentRepresentation.md", "RenditionEntry": "https://github.com/Alfresco/alfresco-js-api/blob/master/src/alfresco-core-rest-api/docs/RenditionEntry.md", "RenditionPaging": "https://github.com/Alfresco/alfresco-js-api/blob/master/src/alfresco-core-rest-api/docs/RenditionPaging.md", @@ -55,8 +58,8 @@ "SitePaging": "https://github.com/Alfresco/alfresco-js-api/blob/master/src/alfresco-core-rest-api/docs/SitePaging.md", "TagEntry": "https://github.com/Alfresco/alfresco-js-api/blob/master/src/alfresco-core-rest-api/docs/TagEntry.md", "TagPaging": "https://github.com/Alfresco/alfresco-js-api/blob/master/src/alfresco-core-rest-api/docs/TagPaging.md", - "UserProcessInstanceFilterRepresentation": "https://github.com/Alfresco/alfresco-js-api/blob/development/src/alfresco-activiti-rest-api/docs/UserProcessInstanceFilterRepresentation.md", - "UserRepresentation": "https://github.com/Alfresco/alfresco-js-api/blob/development/src/alfresco-activiti-rest-api/docs/UserRepresentation.md" + "UserProcessInstanceFilterRepresentation": "https://github.com/Alfresco/alfresco-js-api/blob/development/src/api/activiti-rest-api/docs/UserProcessInstanceFilterRepresentation.md", + "UserRepresentation": "https://github.com/Alfresco/alfresco-js-api/blob/development/src/api/activiti-rest-api/docs/UserRepresentation.md" }, "typeNameExceptions": { "activiti-alfresco.service": "ActivitiContentService", @@ -65,6 +68,7 @@ "auth-guard.service": "AuthGuard", "card-item-types.service": "CardItemTypeService", "card-view-item.interface": "CardViewItem", + "confirm.dialog": "ConfirmDialogComponent", "content-node-share.directive": "NodeSharedDirective", "content.widget": "ContentWidgetComponent", "create-task-attachment.component": "AttachmentComponent", @@ -160,7 +164,9 @@ ], "fileCheckerFilter": [ "README", + "compatibility", "release-notes", + "roadmap", "tutorials", "user-guide", "versionIndex" diff --git a/tools/doc/tools/sourceLinker.js b/tools/doc/tools/sourceLinker.js index cf28f9f320..005ccc7218 100644 --- a/tools/doc/tools/sourceLinker.js +++ b/tools/doc/tools/sourceLinker.js @@ -3,7 +3,7 @@ Object.defineProperty(exports, "__esModule", { value: true }); var path = require("path"); var unist_util_select_1 = require("unist-util-select"); var ngHelpers = require("../ngHelpers"); -var angFilenameRegex = /([a-zA-Z0-9\-]+)\.((component)|(directive)|(interface)|(model)|(pipe)|(service)|(widget))/; +var angFilenameRegex = /([a-zA-Z0-9\-]+)\.((component)|(dialog)|(directive)|(interface)|(model)|(pipe)|(service)|(widget))/; function processDocs(mdCache, aggData, errorMessages) { var pathnames = Object.keys(mdCache); pathnames.forEach(function (pathname) { diff --git a/tools/doc/tools/sourceLinker.ts b/tools/doc/tools/sourceLinker.ts index aaa873a183..5f3055f976 100644 --- a/tools/doc/tools/sourceLinker.ts +++ b/tools/doc/tools/sourceLinker.ts @@ -5,7 +5,7 @@ import { select } from "unist-util-select"; import * as ngHelpers from "../ngHelpers"; -const angFilenameRegex = /([a-zA-Z0-9\-]+)\.((component)|(directive)|(interface)|(model)|(pipe)|(service)|(widget))/; +const angFilenameRegex = /([a-zA-Z0-9\-]+)\.((component)|(dialog)|(directive)|(interface)|(model)|(pipe)|(service)|(widget))/; export function processDocs(mdCache, aggData, errorMessages) {