diff --git a/docs/README.md b/docs/README.md index 659c1ee721..cfa6c7f277 100644 --- a/docs/README.md +++ b/docs/README.md @@ -171,7 +171,7 @@ for more information about installing and using the source code. | [Apps Process service](core/services/apps-process.service.md) | Gets details of the Process Services apps that are deployed for the user. | [Source](../lib/core/services/apps-process.service.ts) | | [Auth Guard Bpm service](core/services/auth-guard-bpm.service.md) | Adds authentication with Process Services to a route within the app. | [Source](../lib/core/services/auth-guard-bpm.service.ts) | | [Auth Guard Ecm service](core/services/auth-guard-ecm.service.md) | Adds authentication with Content Services to a route within the app. | [Source](../lib/core/services/auth-guard-ecm.service.ts) | -| [Auth Guard SSO Role service](core/services/auth-guard-sso-role.service.md) | Allow to check the user roles of a user | [Source](../lib/core/services/auth-guard-sso-role.service.ts) | +| [Auth Guard SSO Role service](core/services/auth-guard-sso-role.service.md) | Checks the user roles of a user. | [Source](../lib/core/services/auth-guard-sso-role.service.ts) | | [Auth Guard service](core/services/auth-guard.service.md) | Adds authentication to a route within the app. | [Source](../lib/core/services/auth-guard.service.ts) | | [Authentication Service](core/services/authentication.service.md) | Provides authentication to ACS and APS. | [Source](../lib/core/services/authentication.service.ts) | | [Bpm User service](core/services/bpm-user.service.md) | Gets information about the current Process Services user. | [Source](../lib/core/userinfo/services/bpm-user.service.ts) | @@ -414,6 +414,12 @@ for more information about installing and using the source code. | [Task Header Cloud Component](process-services-cloud/components/task-header-cloud.component.md) ![Experimental](docassets/images/ExperimentalIcon.png) | Shows all the information related to a task. | [Source](../lib/process-services-cloud/src/lib/task/task-header/components/task-header-cloud.component.ts) | | [Task List Cloud component](process-services-cloud/components/task-list-cloud.component.md) ![Experimental](docassets/images/ExperimentalIcon.png) | Renders a list containing all the tasks matched by the parameters specified. | [Source](../lib/process-services-cloud/src/lib/task/task-list/components/task-list-cloud.component.ts) | +### Directives + +| Name | Description | Source link | +| ---- | ----------- | ----------- | +| [Complete Task Directive](process-services-cloud/directives/complete-task.directive.md) ![Experimental](docassets/images/ExperimentalIcon.png) | Completes a task. | [Source](../lib/process-services-cloud/src/lib/task/directives/complete-task.directive.ts) | + ### Pipes | Name | Description | Source link | @@ -431,6 +437,7 @@ for more information about installing and using the source code. | [Process List Cloud Service](process-services-cloud/services/process-list-cloud.service.md) ![Experimental](docassets/images/ExperimentalIcon.png) | Searches processes. | [Source](../lib/process-services-cloud/src/lib/process/process-list/services/process-list-cloud.service.ts) | | [Start Process Cloud Service](process-services-cloud/services/start-process-cloud.service.md) ![Experimental](docassets/images/ExperimentalIcon.png) | Gets process definitions and starts processes. | [Source](../lib/process-services-cloud/src/lib/process/start-process/services/start-process-cloud.service.ts) | | [Start Task Cloud Service](process-services-cloud/services/start-task-cloud.service.md) ![Experimental](docassets/images/ExperimentalIcon.png) | Starts standalone tasks. | [Source](../lib/process-services-cloud/src/lib/task/start-task/services/start-task-cloud.service.ts) | +| [Task Cloud Service](process-services-cloud/services/task-cloud.service.md) ![Experimental](docassets/images/ExperimentalIcon.png) | Manages task cloud. | [Source](../lib/process-services-cloud/src/lib/task/task-header/services/task-cloud.service.ts) | | [Task Filter Cloud Service](process-services-cloud/services/task-filter-cloud.service.md) ![Experimental](docassets/images/ExperimentalIcon.png) | Manages task filters. | [Source](../lib/process-services-cloud/src/lib/task/task-filters/services/task-filter-cloud.service.ts) | | [Task Header Cloud Service](process-services-cloud/services/task-header-cloud.service.md) ![Experimental](docassets/images/ExperimentalIcon.png) | Manages cloud tasks. | [Source](../lib/process-services-cloud/src/lib/task/task-header/services/task-header-cloud.service.ts) | | [Task List Cloud Service](process-services-cloud/services/task-list-cloud.service.md) ![Experimental](docassets/images/ExperimentalIcon.png) | Searches tasks. | [Source](../lib/process-services-cloud/src/lib/task/task-list/services/task-list-cloud.service.ts) | @@ -453,7 +460,7 @@ for more information about installing and using the source code. | Name | Description | Source link | | ---- | ----------- | ----------- | | [Dynamic Component](extensions/components/dynamic.component.md) ![Experimental](docassets/images/ExperimentalIcon.png) | Displays dynamically-loaded extension components. | [Source](../lib/extensions/src/lib/components/dynamic-component/dynamic.component.ts) | -| [Preview Extension Component](extensions/components/preview-extension.component.md) ![Experimental](docassets/images/ExperimentalIcon.png) | Displays dynamically-loaded extension components. | [Source](../lib/extensions/src/lib/components/viewer/preview-extension.component.ts) | +| [Preview Extension Component](extensions/components/preview-extension.component.md) ![Experimental](docassets/images/ExperimentalIcon.png) | Supports dynamically-loaded viewer preview extensions. | [Source](../lib/extensions/src/lib/components/viewer/preview-extension.component.ts) | ### Services diff --git a/docs/content-services/services/search-query-builder.service.md b/docs/content-services/services/search-query-builder.service.md index 859aa35511..ac180cf915 100644 --- a/docs/content-services/services/search-query-builder.service.md +++ b/docs/content-services/services/search-query-builder.service.md @@ -2,7 +2,7 @@ Title: Search Query Builder service Added: v2.3.0 Status: Active -Last reviewed: 2018-06-12 +Last reviewed: 2019-03-19 --- # [Search Query Builder service](../../../lib/content-services/search/search-query-builder.service.ts "Defined in search-query-builder.service.ts") @@ -44,10 +44,9 @@ Stores information from all the custom search and faceted search widgets, compil Gets all pre-configured sorting options that users can choose from. - **Returns** [`SearchSortingDefinition`](../../../lib/content-services/search/search-sorting-definition.interface.ts)`[]` - Pre-configured sorting options - **getSupportedLabel**(configLabel: `string`): `string`
- - - _configLabel:_ `string` - - - **Returns** `string` - - + Encloses a label name with double quotes if it contains whitespace characters. + - _configLabel:_ `string` - Original label text + - **Returns** `string` - Label, possibly with quotes if it contains spaces - **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 @@ -96,7 +95,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. +> **Note:** From ADF 3.0.0, the query contains the `"facetFormat": "V2"` parameter so that all the responses have the same structure whether they come from search queries containing facetFields, facetQueries, grouped facetQueries or facetIntervals. ## See also diff --git a/docs/core/components/about.component.md b/docs/core/components/about.component.md index 93ab208fac..8af231c7a5 100644 --- a/docs/core/components/about.component.md +++ b/docs/core/components/about.component.md @@ -2,7 +2,7 @@ Title: About Component Added: v2.4.0 Status: Experimental -Last reviewed: 2018-11-14 +Last reviewed: 2019-03-19 --- # [About Component](../../../lib/core/about/about.component.ts "Defined in about.component.ts") @@ -10,33 +10,38 @@ Last reviewed: 2018-11-14 Shows a general version and status overview of the installed ADF library. ## Basic Usage + With default input values + ```html ``` + With custom input values: ```html ``` +## Class members + ### Properties | Name | Type | Default value | Description | | ---- | ---- | ------------- | ----------- | -| githubUrlCommitAlpha | `string` | https://githubcom/Alfresco/alfresco-ng2-components/commits/ | Version of ADF to be used | -| showExtensions | `boolean` | true | Parameter for hide or show extensions block | -| regexp | `string` | ^(@alfresco) | Regular expression for filtering dependencies packages | +| githubUrlCommitAlpha | `string` | | Commit corresponding to the version of ADF to be used. | +| regexp | `string` | "^(@alfresco)" | Regular expression for filtering dependencies packages. | +| showExtensions | `boolean` | true | Toggles showing/hiding of extensions block. | ## Details Use this component to get a general overview of the version of ADF installed and the status of the [Content service](../services/content.service.md) and [Process service](../../process-services/services/process.service.md). -Note at the moment this component is mostly for internal use and it requires you to: +Note that at the moment this component is mostly for internal use and it requires you to: - create a version file : `npm list --depth=0 --json=true --prod=true > versions.json` - provide this version file in the `dist` folder diff --git a/docs/core/services/auth-guard-sso-role.service.md b/docs/core/services/auth-guard-sso-role.service.md index 5312b5cab3..f40051e974 100644 --- a/docs/core/services/auth-guard-sso-role.service.md +++ b/docs/core/services/auth-guard-sso-role.service.md @@ -2,11 +2,12 @@ Title: Auth Guard SSO Role service Added: v3.1.0 Status: Active +Last reviewed: 2019-03-19 --- # [Auth Guard SSO role service](../../../lib/core/services/auth-guard-sso-role.service.ts "Defined in auth-guard-sso-role.service.ts") -Allow to check the user roles of a user +Checks the user roles of a user. ## Details @@ -28,11 +29,11 @@ const appRoutes: Routes = [ ] ``` -If the user now clicks on a link or button that follows this route, they will be not able to access to this content if the user does not have the roles. +If the user now clicks on a link or button that follows this route, they will be not able to access this content if they do not have the roles. ## Redirect over forbidden -If the you want to redirect the user to a different page over a forbidden error you can use the **redirectUrl** as the example below: +If the you want to redirect the user to a page after a forbidden access, you can use the **redirectUrl** as in the example below: ```ts const appRoutes: Routes = [ @@ -47,7 +48,7 @@ const appRoutes: Routes = [ ] ``` -Note: you can use this Guard in and with the other ADF auth guard. +**Note**: you can use this Guard in and with the other ADF auth guards. ## See also diff --git a/docs/core/services/authentication.service.md b/docs/core/services/authentication.service.md index 2cc2b34e6a..17e244bdbf 100644 --- a/docs/core/services/authentication.service.md +++ b/docs/core/services/authentication.service.md @@ -2,7 +2,7 @@ Title: Authentication Service Added: v2.0.0 Status: Active -Last reviewed: 2018-11-19 +Last reviewed: 2019-03-19 --- # [Authentication Service](../../../lib/core/services/authentication.service.ts "Defined in authentication.service.ts") @@ -73,8 +73,8 @@ Provides authentication to ACS and APS. Checks whether the "remember me" cookie was set or not. - **Returns** `boolean` - True if set, false otherwise - **isSSODiscoveryConfigured**(): `boolean`
- Check if SSO is configured correctly - - **Returns** `boolean` - + Checks if SSO is configured correctly. + - **Returns** `boolean` - True if configured correctly, false otherwise - **login**(username: `string`, password: `string`, rememberMe: `boolean` = `false`): [`Observable`](http://reactivex.io/documentation/observable.html)``
Logs the user in. - _username:_ `string` - Username for the login diff --git a/docs/core/services/content.service.md b/docs/core/services/content.service.md index 4a8fc93a84..04711086d2 100644 --- a/docs/core/services/content.service.md +++ b/docs/core/services/content.service.md @@ -2,7 +2,7 @@ Title: Content service Added: v2.0.0 Status: Active -Last reviewed: 2019-02-13 +Last reviewed: 2019-03-13 --- # [Content service](../../../lib/core/services/content.service.ts "Defined in content.service.ts") @@ -58,7 +58,7 @@ Accesses app-generated data objects via URLs and file downloads. - **hasPermissions**(node: [`Node`](https://github.com/Alfresco/alfresco-js-api/blob/development/src/api/content-rest-api/docs/Node.md), permission: [`PermissionsEnum`](../../../lib/core/models/permissions.enum.ts)`|string`): `boolean`
Checks if the user has permission on that node - _node:_ [`Node`](https://github.com/Alfresco/alfresco-js-api/blob/development/src/api/content-rest-api/docs/Node.md) - [Node](https://github.com/Alfresco/alfresco-js-api/blob/development/src/api/content-rest-api/docs/Node.md) to check permissions - - _permission:_ [`PermissionsEnum`](../../../lib/core/models/permissions.enum.ts)`|string` - + - _permission:_ [`PermissionsEnum`](../../../lib/core/models/permissions.enum.ts)`|string` - Required permission type - **Returns** `boolean` - True if the user has the required permissions, false otherwise ## Details diff --git a/docs/extensions/services/extension.service.md b/docs/extensions/services/extension.service.md index 3f32f4df62..f3904f526e 100644 --- a/docs/extensions/services/extension.service.md +++ b/docs/extensions/services/extension.service.md @@ -2,7 +2,7 @@ Title: Extension Service Added: v3.0.0 Status: Experimental -Last reviewed: 2018-12-17 +Last reviewed: 2019-03-19 --- # [Extension Service](../../../lib/extensions/src/lib/services/extension.service.ts "Defined in extension.service.ts") @@ -35,10 +35,9 @@ Manages and runs basic extension functionality. - _key:_ `string` - Key name to look for - **Returns** `RuleEvaluator` - RuleEvaluator or null if not found - **getFeature**(key: `string`): `any[]`
- - - _key:_ `string` - - - **Returns** `any[]` - - + Gets features by key. + - _key:_ `string` - Key string, using dot notation + - **Returns** `any[]` - Features array found by key - **getRouteById**(id: `string`): [`RouteRef`](../../../lib/extensions/src/lib/config/routing.extensions.ts)
Retrieves a route using its ID value. - _id:_ `string` - The ID value to look for diff --git a/docs/process-services-cloud/complete-task.directive.md b/docs/process-services-cloud/complete-task.directive.md deleted file mode 100644 index 0ad4ad5856..0000000000 --- a/docs/process-services-cloud/complete-task.directive.md +++ /dev/null @@ -1,26 +0,0 @@ ---- -Title: Complete Cloud Task -Added: v3.1.0 -Status: Experimental -Last reviewed: 2019-02-28 ---- - -# [Complete task directive](../../lib/process-services-cloud/src/lib/task/task-header/directives/complete-task.directive.ts "Defined in complete-task.directive.ts") - -Complete a task - -## Basic Usage - -```html - -``` -## Class members - -### Properties - -| Name | Type | Default value | Description | -| ---- | ---- | ------------- | ----------- | -| taskId | `string` | empty |(Required) The id of the task. | -| appName | `string` | empty | (Required) The name of the application. | -| success | `EventEmitter` | empty | Emitted when the task is completed. | -| error | `EventEmitter` | empty | Emitted when the task cannot be completed. | \ No newline at end of file diff --git a/docs/process-services-cloud/directives/complete-task.directive.md b/docs/process-services-cloud/directives/complete-task.directive.md new file mode 100644 index 0000000000..b88abcb934 --- /dev/null +++ b/docs/process-services-cloud/directives/complete-task.directive.md @@ -0,0 +1,32 @@ +--- +Title: Complete Task Directive +Added: v3.1.0 +Status: Experimental +Last reviewed: 2019-03-19 +--- + +# [Complete task directive](../../../lib/process-services-cloud/src/lib/task/directives/complete-task.directive.ts "Defined in complete-task.directive.ts") + +Completes a task. + +## Basic Usage + +```html + +``` + +## Class members + +### Properties + +| Name | Type | Default value | Description | +| ---- | ---- | ------------- | ----------- | +| appName | `string` | | (Required) The name of the application. | +| taskId | `string` | | (Required) The id of the task. | + +### Events + +| Name | Type | Description | +| ---- | ---- | ----------- | +| error | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when the task cannot be completed. | +| success | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`` | Emitted when the task is completed. | diff --git a/docs/process-services-cloud/task-cloud.service.md b/docs/process-services-cloud/services/task-cloud.service.md similarity index 56% rename from docs/process-services-cloud/task-cloud.service.md rename to docs/process-services-cloud/services/task-cloud.service.md index 3c4a8968ad..4b1675e7e2 100644 --- a/docs/process-services-cloud/task-cloud.service.md +++ b/docs/process-services-cloud/services/task-cloud.service.md @@ -2,37 +2,37 @@ Title: Task Cloud Service Added: v3.1.0 Status: Experimental -Last reviewed: 2019-02-28 +Last reviewed: 2019-03-19 --- -# [Task Cloud Service](../../lib/process-services-cloud/src/lib/task/task-header/services/task-cloud.service.ts "Defined in task-cloud.service.ts") +# [Task Cloud Service](../../../lib/process-services-cloud/src/lib/task/task-header/services/task-cloud.service.ts "Defined in task-cloud.service.ts") -Manage task cloud. +Manages task cloud. ## Class members ### Methods -- **completeTask**(appName: `string`, taskId: `string`)
- Complete a task - - _appName:_ `string` - Name of the app - - _taskId:_ `string` - ID of the task to complete - -- **canCompleteTask**(taskDetails: [`TaskDetailsCloudModel`](../../lib/process-services-cloud/src/lib/task/start-filters/models/task-details-cloud.model.ts))
+- **canCompleteTask**(taskDetails: [`TaskDetailsCloudModel`](../../../lib/process-services-cloud/src/lib/task/start-task/models/task-details-cloud.model.ts)): `boolean`
Validate if a task can be completed. - - _taskDetails:_ [`TaskDetailsCloudModel`](../../lib/process-services-cloud/src/lib/task/start-filters/models/task-details-cloud.model.ts) - Task details object - + - _taskDetails:_ [`TaskDetailsCloudModel`](../../../lib/process-services-cloud/src/lib/task/start-task/models/task-details-cloud.model.ts) - task details object + - **Returns** `boolean` - Boolean value if the task can be completed - **claimTask**(appName: `string`, taskId: `string`, assignee: `string`): `any`
Claims a task for an assignee. - _appName:_ `string` - Name of the app - _taskId:_ `string` - ID of the task to claim - _assignee:_ `string` - User to assign the task to - **Returns** `any` - Details of the claimed task -- **getTaskById**(appName: `string`, taskId: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`TaskDetailsCloudModel`](../../lib/process-services-cloud/src/lib/task/start-task/models/task-details-cloud.model.ts)`>`
+- **completeTask**(appName: `string`, taskId: `string`): `any`
+ Complete a task. + - _appName:_ `string` - Name of the app + - _taskId:_ `string` - ID of the task to complete + - **Returns** `any` - Details of the task that was completed +- **getTaskById**(appName: `string`, taskId: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`TaskDetailsCloudModel`](../../../lib/process-services-cloud/src/lib/task/start-task/models/task-details-cloud.model.ts)`>`
Gets details of a task. - _appName:_ `string` - Name of the app - _taskId:_ `string` - ID of the task whose details you want - - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`TaskDetailsCloudModel`](../../lib/process-services-cloud/src/lib/task/start-task/models/task-details-cloud.model.ts)`>` - Task details + - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`TaskDetailsCloudModel`](../../../lib/process-services-cloud/src/lib/task/start-task/models/task-details-cloud.model.ts)`>` - Task details - **unclaimTask**(appName: `string`, taskId: `string`): `any`
Un-claims a task. - _appName:_ `string` - Name of the app @@ -48,10 +48,10 @@ Manage task cloud. ## Details The methods work in much the same way as the equivalent methods in the -[Tasklist service](../process-services/tasklist.service.md) +[Tasklist service](../../process-services/services/tasklist.service.md) but they use the cloud variants of the classes for return values. See the -[Tasklist service](../process-services/tasklist.service.md) page for usage examples. +[Tasklist service](../../process-services/services/tasklist.service.md) page for usage examples. ## See also -- [Tasklist service](../process-services/tasklist.service.md) \ No newline at end of file +- [Tasklist service](../../process-services/services/tasklist.service.md) diff --git a/docs/versionIndex.md b/docs/versionIndex.md index 71436356df..7e6312f776 100644 --- a/docs/versionIndex.md +++ b/docs/versionIndex.md @@ -12,6 +12,7 @@ backend services have been tested with each released version of ADF. ## Versions +- [v3.1.0](#v310) - [v3.0.0](#v300) - [v2.6.0](#v260) - [v2.5.0](#v250) @@ -21,10 +22,23 @@ backend services have been tested with each released version of ADF. - [v2.1.0](#v210) - [v2.0.0](#v200) -## v3.0.0 +## v3.1.0 **Release:** Forthcoming
+ + +- [Auth guard sso role service](core/services/auth-guard-sso-role.service.md) +- [Complete task directive](process-services-cloud/directives/complete-task.directive.md) +- [Preview extension component](extensions/components/preview-extension.component.md) +- [Task cloud service](process-services-cloud/services/task-cloud.service.md) + + + +## v3.0.0 + +**Release:** 2019-02-13
+ ### Components added diff --git a/lib/content-services/search/search-query-builder.service.ts b/lib/content-services/search/search-query-builder.service.ts index aed794db5d..eb92866766 100644 --- a/lib/content-services/search/search-query-builder.service.ts +++ b/lib/content-services/search/search-query-builder.service.ts @@ -403,6 +403,11 @@ export class SearchQueryBuilderService { return null; } + /** + * Encloses a label name with double quotes if it contains whitespace characters. + * @param configLabel Original label text + * @returns Label, possibly with quotes if it contains spaces + */ getSupportedLabel(configLabel: string): string { const spaceInsideLabelIndex = configLabel.search(/\s/g); if (spaceInsideLabelIndex > -1) { diff --git a/lib/core/about/about.component.ts b/lib/core/about/about.component.ts index a700f352cb..a2f7771e96 100644 --- a/lib/core/about/about.component.ts +++ b/lib/core/about/about.component.ts @@ -39,8 +39,14 @@ export class AboutComponent implements OnInit { modules: ObjectDataTableAdapter; extensionColumns: string[] = ['$id', '$name', '$version', '$vendor', '$license', '$runtime', '$description']; extensions$: Observable; + + /** Commit corresponding to the version of ADF to be used. */ @Input() githubUrlCommitAlpha = 'https://github.com/Alfresco/alfresco-ng2-components/commits/'; + + /** Toggles showing/hiding of extensions block. */ @Input() showExtensions = true; + + /** Regular expression for filtering dependencies packages. */ @Input() regexp = '^(@alfresco)'; ecmHost = ''; diff --git a/lib/core/services/authentication.service.ts b/lib/core/services/authentication.service.ts index 1d6310dd55..ce2d96caa3 100644 --- a/lib/core/services/authentication.service.ts +++ b/lib/core/services/authentication.service.ts @@ -316,7 +316,8 @@ export class AuthenticationService { } /** - * Check if SSO is configured correctly + * Checks if SSO is configured correctly. + * @returns True if configured correctly, false otherwise */ isSSODiscoveryConfigured() { return this.alfrescoApi.getInstance().storage.getItem('discovery') ? true : false; diff --git a/lib/core/services/content.service.ts b/lib/core/services/content.service.ts index f8b89d05f2..342199b00a 100644 --- a/lib/core/services/content.service.ts +++ b/lib/core/services/content.service.ts @@ -175,7 +175,7 @@ export class ContentService { /** * Checks if the user has permission on that node * @param node Node to check permissions - * @param permission + * @param permission Required permission type * @returns True if the user has the required permissions, false otherwise */ hasPermissions(node: Node, permission: PermissionsEnum | string): boolean { @@ -205,7 +205,7 @@ export class ContentService { /** * Checks if the user has permissions on that node * @param node Node to check allowableOperations - * @param permission Create, delete, update, updatePermissions, !create, !delete, !update, !updatePermissions + * @param allowableOperation Create, delete, update, updatePermissions, !create, !delete, !update, !updatePermissions * @returns True if the user has the required permissions, false otherwise */ hasAllowableOperations(node: Node, allowableOperation: AllowableOperationsEnum | string): boolean { diff --git a/lib/extensions/src/lib/services/extension.service.ts b/lib/extensions/src/lib/services/extension.service.ts index f57c8ffe77..0ac4de4263 100644 --- a/lib/extensions/src/lib/services/extension.service.ts +++ b/lib/extensions/src/lib/services/extension.service.ts @@ -80,6 +80,11 @@ export class ExtensionService { this.features = this.loader.getFeatures(config); } + /** + * Gets features by key. + * @param key Key string, using dot notation + * @returns Features array found by key + */ getFeature(key: string): any[] { let properties: string[] = Array.isArray(key) ? [key] : key.split('.'); return properties.reduce((prev, curr) => prev && prev[curr], this.features) || []; diff --git a/tools/doc/yamlTemplates/template.ejs b/tools/doc/yamlTemplates/template.ejs index f3702ff94d..6431ce951b 100644 --- a/tools/doc/yamlTemplates/template.ejs +++ b/tools/doc/yamlTemplates/template.ejs @@ -3,7 +3,7 @@ items: name: <%= name %> fullName: <%= name %> source: - path: <%= sources[0].fileName %> + path: <%= 'lib/' + sources[0].fileName %> startLine: <%= sources[0].line %> children: <%_ if (typeof children !== "undefined") { -%>