[ACA-3672] - added server order for document -list (#5899)

* [ACA-3672] - added sorting server side for document-list * [ACA-3672] - added and fixed unit tests for backend order * [ACA-3672] - fixed failing test * [ACA-3672] - regenerated doc and renamed variable Co-authored-by: Vito Albano <vitoalbano@Vitos-MacBook-Pro.local>
2025-07-24 17:32:15 +00:00 · 2020-07-23 14:04:05 +01:00
parent a5972e753a
commit 30c5c58d40
57 changed files with 132 additions and 81 deletions
--- a/docs/core/components/data-column.component.md
+++ b/docs/core/components/data-column.component.md
@@ -51,6 +51,7 @@ Defines column properties for DataTable, Tasklist, Document List and other compo
 | formatTooltip | `Function` |  | Custom tooltip formatter function. |
 | key | `string` |  | Data source key. Can be either a column/property key like `title`  or a property path like `createdBy.name`. |
 | sortable | `boolean` | true | Toggles ability to sort by this column, for example by clicking the column header. |
+| sortingKey | `string` |  | When using server side sorting the column used by the api call where the sorting will be performed |
 | srTitle | `string` |  | Title to be used for screen readers. |
 | title | `string` | "" | Display title of the column, typically used for column headers. You can use the i18n resource key to get it translated automatically. |
 | type | `string` | "text" | Value type for the column. Possible settings are 'text', 'image', 'date', 'fileSize', 'location', and 'json'. |
--- a/docs/core/components/datatable.component.md
+++ b/docs/core/components/datatable.component.md
@@ -346,7 +346,7 @@ Learm more about styling your datatable: [Customizing the component's styles](#c
 | ---- | ---- | ------------- | ----------- |
 | actions | `boolean` | false | Toggles the data actions column. |
 | actionsPosition | `string` | "right" | Position of the actions dropdown menu. Can be "left" or "right". |
-| allowFiltering | `boolean` | false | Flag that indicate if the datatable allow the use facet [widget](../../../lib/testing/src/lib/core/pages/form/widgets/widget.ts) search for filtering. |
+| allowFiltering | `boolean` | false | Flag that indicate if the datatable allow the use facet widget search for filtering. |
 | columns | `any[]` | \[] | The columns that the datatable will show. |
 | contextMenu | `boolean` | false | Toggles custom context menu for the component. |
 | data | [`DataTableAdapter`](../../../lib/core/datatable/data/datatable-adapter.ts) |  | Data source for the table |
--- a/docs/core/components/form-field.component.md
+++ b/docs/core/components/form-field.component.md
@@ -27,7 +27,7 @@ based on the field type or the metadata information.

 | Name | Type | Default value | Description |
 | ---- | ---- | ------------- | ----------- |
-| field | [`FormFieldModel`](../../core/models/form-field.model.md) | null | Contains all the necessary data needed to determine what UI [`Widget`](../../../lib/testing/src/lib/core/pages/form/widgets/widget.ts) to use when rendering the field in the form. You would typically not create this data manually but instead create the form in APS and export it to get to all the `FormFieldModel` definitions. |
+| field | [`FormFieldModel`](../../core/models/form-field.model.md) | null | Contains all the necessary data needed to determine what UI Widget to use when rendering the field in the form. You would typically not create this data manually but instead create the form in APS and export it to get to all the [`FormFieldModel`](../../core/models/form-field.model.md) definitions. |

 ## Details

--- a/docs/core/components/info-drawer-layout.component.md
+++ b/docs/core/components/info-drawer-layout.component.md
@@ -37,6 +37,7 @@ with the following names:
    </div>
 </adf-info-drawer-layout>
 ```
+
 ## Class members

 ### Properties
--- a/docs/core/components/info-drawer.component.md
+++ b/docs/core/components/info-drawer.component.md
@@ -50,8 +50,8 @@ have any content you like:
 | Name | Type | Default value | Description |
 | ---- | ---- | ------------- | ----------- |
 | selectedIndex | `number` | 0 | The selected index tab. |
-| title | `string \| null` | null | The title of the info drawer (string or translation key). |
 | showHeader | `boolean` | true | The visibility of the header. |
+| title | `string \| null` | null | The title of the info drawer (string or translation key). |

 ### Events

--- a/docs/core/components/pagination.component.md
+++ b/docs/core/components/pagination.component.md
@@ -42,9 +42,9 @@ Adds pagination to the component it is used with.

 | Name | Type | Default value | Description |
 | ---- | ---- | ------------- | ----------- |
-| pagination | [`PaginationModel`](../../../lib/core/models/pagination.model.ts) |  | Pagination object. |
 | supportedPageSizes | `number[]` |  | An array of page sizes. |
 | target | [`PaginatedComponent`](../../../lib/core/pagination/paginated-component.interface.ts) |  | Component that provides custom pagination support. |
+| pagination | [`PaginationModel`](../../../lib/core/models/pagination.model.ts) |  | Pagination object. |

 ### Events

--- a/docs/core/components/start-form.component.md
+++ b/docs/core/components/start-form.component.md
@@ -37,8 +37,8 @@ Displays the Start [`Form`](../../../lib/process-services/src/lib/task-list/mode
 | nameNode | `string` |  | Name to assign to the new node where the metadata are stored. |
 | nodeId | `string` |  | Content Services node ID for the form metadata. |
 | path | `string` |  | Path of the folder where the metadata will be stored. |
-| processDefinitionId | `string` |  | Definition ID of the process to start, this parameter can not be use in combination with processId  |
-| processId | `string` |  | Process ID of the process to start, this parameter can not be use in combination with processDefinitionId  |
+| processDefinitionId | `string` |  | [Definition](../../../lib/cli/node_modules/@alfresco/js-api/src/api/content-rest-api/model/definition.ts) ID of the process to start, this parameter can not be use in combination with processId |
+| processId | `string` |  | Process ID of the process to start, this parameter can not be use in combination with processDefinitionId |
 | readOnly | `boolean` | false | Toggle readonly state of the form. Forces all form widgets to render as readonly if enabled. |
 | readOnlyForm | `boolean` | false | Is the form read-only (ie, can't be edited)? |
 | saveMetadata | `boolean` | false | Toggle saving of form metadata. |
--- a/docs/core/components/viewer.component.md
+++ b/docs/core/components/viewer.component.md
@@ -110,7 +110,7 @@ See the [Custom layout](#custom-layout) section for full details of all availabl
 | ---- | ---- | ----------- |
 | extensionChange | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<string>` | Emitted when the filename extension changes. |
 | goBack | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`BaseEvent`](../../../lib/core/events/base.event.ts)`<any>>` | Emitted when user clicks the 'Back' button. |
-| invalidSharedLink | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<>` | Emitted when the shared link used is not valid. |
+| invalidSharedLink | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<any>` | Emitted when the shared link used is not valid. |
 | navigateBefore | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<MouseEvent \| KeyboardEvent>` | Emitted when user clicks 'Navigate Before' ("&lt;") button. |
 | navigateNext | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<MouseEvent \| KeyboardEvent>` | Emitted when user clicks 'Navigate Next' (">") button. |
 | print | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<`[`BaseEvent`](../../../lib/core/events/base.event.ts)`<any>>` | Emitted when user clicks the 'Print' button. |
--- a/docs/core/directives/version-compatibility.directive.md
+++ b/docs/core/directives/version-compatibility.directive.md
@@ -23,7 +23,7 @@ Enables/disables components based on ACS version in use.

 | Name | Type | Default value | Description |
 | ---- | ---- | ------------- | ----------- |
-| adf-acs-version | `string` |  | Minimum version required for component to work correctly . |
+| version | `void` |  | Minimum version required for component to work correctly . |

 ## Details

--- a/docs/core/services/form.service.md
+++ b/docs/core/services/form.service.md
@@ -98,7 +98,7 @@ class MyComponent {
    Get [`Form`](../../../lib/process-services/src/lib/task-list/models/form.model.ts) related to a taskId  
    -   `taskId` - Task Id
 -   `getFormDefinitionById(formId: string):`[`Observable`](http://reactivex.io/documentation/observable.html)`<any>`  
-    Get [`Form`](../../../lib/process-services/src/lib/task-list/models/form.model.ts) Definition  
+    Get [`Form`](../../../lib/process-services/src/lib/task-list/models/form.model.ts) [Definition](../../../lib/cli/node_modules/@alfresco/js-api/src/api/content-rest-api/model/definition.ts)  
    -   `formId` - [`Form`](../../../lib/process-services/src/lib/task-list/models/form.model.ts) Id
 -   `getFormDefinitionByName(name: string):`[`Observable`](http://reactivex.io/documentation/observable.html)`<any>`  
    Returns form definition with a given name.  
--- a/docs/core/services/sites.service.md
+++ b/docs/core/services/sites.service.md
@@ -19,11 +19,11 @@ Accesses and manipulates sites from a Content Services repository.
    -   _inviteeId:_ `string`  - The invitee user name.
    -   _opts:_ `any`  - (Optional) Options supported by JS-API
    -   **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`SiteMembershipRequestWithPersonPaging`](../../../node_modules/@alfresco/js-api/src/api/content-rest-api/model/siteMembershipRequestWithPersonPaging.ts)`>` - Null response notifying when the operation is complete
-   **createSiteGroupMembership**(siteId: `string`, siteMembershipBodyCreate: [`SiteMembershipBodyCreate`](../../../node_modules/@alfresco/js-api/src/api/content-rest-api/model/siteMembershipBodyCreate.ts)): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`SiteGroupEntry`](../../../node_modules/@alfresco/js-api/src/api/content-rest-api/model/siteGroupEntry.ts)`>`<br/>
+-   **createSiteGroupMembership**(siteId: `string`, siteMembershipBodyCreate: [`SiteMembershipBodyCreate`](../../../node_modules/@alfresco/js-api/src/api/content-rest-api/model/siteMembershipBodyCreate.ts)): [`Observable`](http://reactivex.io/documentation/observable.html)`<SiteGroupEntry>`<br/>
    Create a site membership for group
    -   _siteId:_ `string`  - The identifier of a site.
    -   _siteMembershipBodyCreate:_ [`SiteMembershipBodyCreate`](../../../node_modules/@alfresco/js-api/src/api/content-rest-api/model/siteMembershipBodyCreate.ts)  - The Group to add and its role
-    -   **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`SiteGroupEntry`](../../../node_modules/@alfresco/js-api/src/api/content-rest-api/model/siteGroupEntry.ts)`>` - [Observable](http://reactivex.io/documentation/observable.html)&lt;SiteGroupEntry>
+    -   **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<SiteGroupEntry>` - [`Observable`](http://reactivex.io/documentation/observable.html)&lt;SiteGroupEntry>
 -   **createSiteMembership**(siteId: `string`, siteMembershipBodyCreate: [`SiteMembershipBodyCreate`](../../../node_modules/@alfresco/js-api/src/api/content-rest-api/model/siteMembershipBodyCreate.ts), opts?: `any`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`SiteMemberEntry`](../../../node_modules/@alfresco/js-api/src/api/content-rest-api/model/siteMemberEntry.ts)`>`<br/>
    Creates a site membership for person **personId** on site **siteId**.
    -   _siteId:_ `string`  - The identifier of a site
@@ -57,11 +57,11 @@ Accesses and manipulates sites from a Content Services repository.
    Gets a site's content.
    -   _siteId:_ `string`  - ID of the target site
    -   **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`SiteEntry`](https://github.com/Alfresco/alfresco-js-api/blob/master/src/alfresco-core-rest-api/docs/SiteEntry.md)`|__type>` - Site content
-   **getSiteGroupMembership**(siteId: `string`, groupId: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`SiteGroupEntry`](../../../node_modules/@alfresco/js-api/src/api/content-rest-api/model/siteGroupEntry.ts)`>`<br/>
+-   **getSiteGroupMembership**(siteId: `string`, groupId: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)`<SiteGroupEntry>`<br/>
    Get information about site membership of group
    -   _siteId:_ `string`  - The identifier of a site.
    -   _groupId:_ `string`  - The authorityId of a group.
-    -   **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`SiteGroupEntry`](../../../node_modules/@alfresco/js-api/src/api/content-rest-api/model/siteGroupEntry.ts)`>` - [Observable](http://reactivex.io/documentation/observable.html)&lt;SiteGroupEntry>
+    -   **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<SiteGroupEntry>` - [`Observable`](http://reactivex.io/documentation/observable.html)&lt;SiteGroupEntry>
 -   **getSiteMembers**(siteId: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`SiteEntry`](https://github.com/Alfresco/alfresco-js-api/blob/master/src/alfresco-core-rest-api/docs/SiteEntry.md)`|__type>`<br/>
    Gets a list of all a site's members.
    -   _siteId:_ `string`  - ID of the target site
@@ -78,11 +78,11 @@ Accesses and manipulates sites from a Content Services repository.
    Gets a list of all sites in the repository.
    -   _opts:_ `any`  - Options supported by JS-API
    -   **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`SitePaging`](https://github.com/Alfresco/alfresco-js-api/blob/master/src/alfresco-core-rest-api/docs/SitePaging.md)`>` - List of sites
-   **listSiteGroups**(siteId: `string`, opts?: `any`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`SiteGroupPaging`](../../../node_modules/@alfresco/js-api/src/api/content-rest-api/model/siteGroupPaging.ts)`>`<br/>
+-   **listSiteGroups**(siteId: `string`, opts?: `any`): [`Observable`](http://reactivex.io/documentation/observable.html)`<SiteGroupPaging>`<br/>
    List group membership for site
    -   _siteId:_ `string`  - The identifier of a site.
    -   _opts:_ `any`  - (Optional) Options supported by JS-API
-    -   **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`SiteGroupPaging`](../../../node_modules/@alfresco/js-api/src/api/content-rest-api/model/siteGroupPaging.ts)`>` - [Observable](http://reactivex.io/documentation/observable.html)&lt;SiteGroupPaging>
+    -   **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<SiteGroupPaging>` - [`Observable`](http://reactivex.io/documentation/observable.html)&lt;SiteGroupPaging>
 -   **listSiteMemberships**(siteId: `string`, opts: `any`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`SiteMemberPaging`](https://github.com/Alfresco/alfresco-js-api/blob/development/src/api/content-rest-api/docs/SiteMemberPaging.md)`>`<br/>
    Gets a list of all a site's members.
    -   _siteId:_ `string`  - ID of the target site
@@ -94,12 +94,12 @@ Accesses and manipulates sites from a Content Services repository.
    -   _inviteeId:_ `string`  - The invitee user name.
    -   _opts:_ `any`  - (Optional) Options supported by JS-API
    -   **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`SiteMembershipRequestWithPersonPaging`](../../../node_modules/@alfresco/js-api/src/api/content-rest-api/model/siteMembershipRequestWithPersonPaging.ts)`>` - Null response notifying when the operation is complete
-   **updateSiteGroupMembership**(siteId: `string`, groupId: `string`, siteMembershipBodyUpdate: [`SiteMembershipBodyUpdate`](../../../node_modules/@alfresco/js-api/src/api/content-rest-api/model/siteMembershipBodyUpdate.ts)): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`SiteGroupEntry`](../../../node_modules/@alfresco/js-api/src/api/content-rest-api/model/siteGroupEntry.ts)`>`<br/>
+-   **updateSiteGroupMembership**(siteId: `string`, groupId: `string`, siteMembershipBodyUpdate: [`SiteMembershipBodyUpdate`](../../../node_modules/@alfresco/js-api/src/api/content-rest-api/model/siteMembershipBodyUpdate.ts)): [`Observable`](http://reactivex.io/documentation/observable.html)`<SiteGroupEntry>`<br/>
    Update site membership of group
    -   _siteId:_ `string`  - The identifier of a site.
    -   _groupId:_ `string`  - The authorityId of a group.
    -   _siteMembershipBodyUpdate:_ [`SiteMembershipBodyUpdate`](../../../node_modules/@alfresco/js-api/src/api/content-rest-api/model/siteMembershipBodyUpdate.ts)  - The group new role
-    -   **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`SiteGroupEntry`](../../../node_modules/@alfresco/js-api/src/api/content-rest-api/model/siteGroupEntry.ts)`>` - [Observable](http://reactivex.io/documentation/observable.html)&lt;SiteGroupEntry>
+    -   **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<SiteGroupEntry>` - [`Observable`](http://reactivex.io/documentation/observable.html)&lt;SiteGroupEntry>
 -   **updateSiteMembership**(siteId: `string`, personId: `string`, siteMembershipBodyUpdate: [`SiteMembershipBodyUpdate`](../../../node_modules/@alfresco/js-api/src/api/content-rest-api/model/siteMembershipBodyUpdate.ts), opts?: `any`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`SiteMemberEntry`](../../../node_modules/@alfresco/js-api/src/api/content-rest-api/model/siteMemberEntry.ts)`>`<br/>
    Update a site membership
    -   _siteId:_ `string`  - The identifier of a site.
--- a/docs/core/widgets/content.widget.md
+++ b/docs/core/widgets/content.widget.md
@@ -29,7 +29,7 @@ Shows the content preview.

 | Name | Type | Description |
 | ---- | ---- | ----------- |
-| contentClick | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<>` | Emitted when the content is clicked. |
+| contentClick | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<any>` | Emitted when the content is clicked. |
 | contentLoaded | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<any>` | Emitted when the content has loaded. |
 | error | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<any>` | Emitted when an error occurs. |
 | thumbnailLoaded | [`EventEmitter`](https://angular.io/api/core/EventEmitter)`<any>` | Emitted when the thumbnail has loaded. |