Merge pull request #268 from Alfresco/development

1.8.0
Alfresco · Sep 5, 2017 · 2e85b01 · 2e85b01
2 parents f5ee138 + b61ce4e
commit 2e85b01
Show file tree

Hide file tree

Showing 20 changed files with 1,020 additions and 12 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -3,6 +3,21 @@
 </p>
 
 # Alfresco JS API
+<a name="1.8.0"></a>
+
+# [1.8.0](https://github.com/Alfresco/alfresco-js-api/releases/tag/1.8.0) (05-09-2017)
+
+## Features
+
+- [Process Audit Log end points](https://github.com/Alfresco/alfresco-js-api/issues/263)
+- [Downloads API (requries 5.2.1 platform)](https://issues.alfresco.com/jira/browse/ADF-1225)
+- [getProfilePictures returns null](https://github.com/Alfresco/alfresco-js-api/issues/262)
+- [Adding a new method to retrieve the Profile Picture Url](https://github.com/Alfresco/alfresco-js-api/265)
+
+## Fix
+
+- [Favorites Api not passing the "include" settings to server](https://issues.alfresco.com/jira/browse/ADF-1394)
+
 <a name="1.7.0"></a>
 # [1.7.0](https://github.com/Alfresco/alfresco-js-api/releases/tag/1.7.0) (01-08-2017)
 ## Fix

diff --git a/index.d.ts b/index.d.ts
@@ -587,6 +587,31 @@ declare namespace AlfrescoApi {
         getSharedLinkContent(sharedId?: string, opts?: any): Promise<{}>;
     }
 
+    export interface DownloadsApi {
+        new(client: ApiClient): DownloadsApi;
+
+        createDownload(payload: DownloadBodyCreate, opts?: any): Promise<DownloadEntry>;
+        getDownload(downloadId: string, opts?: any): Promise<DownloadEntry>;
+        cancelDownload(downloadId: string): Promise<void>;
+    }
+
+    export interface DownloadBodyCreate {
+        nodeIds?: string[];
+    }
+
+    export interface DownloadEntry {
+        entry?: Download;
+    }
+
+    export interface Download {
+        filesAdded?: number;
+        bytesAdded?: number;
+        id: string;
+        totalFiles: number;
+        totalBytes: number;
+        status: string;
+    }
+
     export interface TagsApi {
         new(client: ApiClient): TagsApi;
 
@@ -1623,6 +1648,7 @@ declare namespace AlfrescoApi {
         childAssociationsApi: ChildAssociationsApi;
         commentsApi: CommentsApi;
         customModelApi: CustomModelApi;
+        downloadsApi: DownloadsApi;
         favoritesApi: FavoritesApi;
         networksApi: NetworksApi;
         nodesApi: NodesApi;

diff --git a/package.json b/package.json
@@ -1,6 +1,6 @@
 {
   "name": "alfresco-js-api",
-  "version": "1.7.0",
+  "version": "1.8.0",
   "description": "JavaScript client library for the Alfresco REST API",
   "author": "Alfresco Software, Ltd.",
   "main": "main.js",

diff --git a/src/alfresco-activiti-rest-api/docs/ProcessApi.md b/src/alfresco-activiti-rest-api/docs/ProcessApi.md
@@ -9,6 +9,8 @@ Method | HTTP request | Description
 [**getProcessDefinitionStartForm**](ProcessApi.md#getProcessDefinitionStartForm) | **GET** /api/enterprise/process-definitions/{processDefinitionId}/start-form | Retrieve the start form for a process definition
 [**getProcessDefinitions**](ProcessApi.md#getProcessDefinitions) | **GET** /api/enterprise/process-definitions | Retrieve a list of process definitions
 [**getProcessInstanceContent**](ProcessApi.md#getProcessInstanceContent) | **GET** /api/enterprise/process-instances/{processInstanceId}/field-content | Retrieve content attached to process instance fields
+[**getProcessAuditJson**](ProcessApi.md#getProcessAuditJson) | **GET** /api/enterprise/process-instances/{processId}/audit-log | Retrieve process audit infromation in json format
+[**getProcessAuditPdf**](ProcessApi.md#getProcessAuditPdf) | **GET** /app/rest/process-instances/{processId}/audit | Retrieve the process audit infromation in pdf format
 [**getProcessInstanceStartForm**](ProcessApi.md#getProcessInstanceStartForm) | **GET** /api/enterprise/process-instances/{processInstanceId}/start-form | Get process start form
 [**getProcessInstance**](ProcessApi.md#getProcessInstance) | **GET** /api/enterprise/process-instances/{processInstanceId} | Retrieve a process instance information
 [**getProcessInstances**](ProcessApi.md#getProcessInstances) | **POST** /api/enterprise/process-instances/query | Retrieve a list of process instances
@@ -182,6 +184,73 @@ Name | Type | Description  | Notes
 
 No authorization required
 
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+<a name="getProcessAuditJson"></a>
+# **getProcessAuditJson**
+> ProcessInstanceAuditRepresentation getProcessAuditJson(processId)
+
+Retrieve process audit infromation in json format
+
+### Example
+```javascript
+
+var processId = "processId_example"; // String | processId
+
+
+this.alfrescoJsApi.activiti.processApi.getProcessAuditJson(processId);
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **processId** | **String**| processId | 
+
+### Return type
+
+[**ProcessInstanceAuditRepresentation**](ProcessInstanceAuditRepresentation.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+<a name="getProcessAuditPdf"></a>
+# **getProcessAuditPdf**
+> Blob getProcessAuditPdf(processId)
+
+Retrieve process audit infromation in pdf format
+
+### Example
+```javascript
+
+var processId = "processId_example"; // String | processId
+
+this.alfrescoJsApi.activiti.processApi.getProcessAuditPdf(processId);
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **processId** | **String**| processId | 
+
+### Return type
+
+[Blob]
+
+### Authorization
+
+No authorization required
+
 ### HTTP request headers
 
  - **Content-Type**: application/json

diff --git a/src/alfresco-activiti-rest-api/docs/ProcessInstanceAuditRepresentation.md b/src/alfresco-activiti-rest-api/docs/ProcessInstanceAuditRepresentation.md
@@ -0,0 +1,14 @@
+# ActivitiPublicRestApi.ProcessInstanceAuditRepresentation
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**processInstanceId** | **Integer** |  | [optional] 
+**processInstanceName | **String** |  | [optional] 
+**processDefinitionName** | **String** |  | [optional] 
+**processDefinitionVersion** | **Integer** |  | [optional] 
+**processInstanceStartTime** | **Date** |  | [optional] 
+**processInstanceEndTime** | **Date** |  | [optional] 
+**processInstanceInitiator** | **String** |  | [optional] 
+**entries** | **Object** |  | [optional] 
+**decisionInfo** | **Object** |  | [optional] 
diff --git a/src/alfresco-activiti-rest-api/docs/UserApi.md b/src/alfresco-activiti-rest-api/docs/UserApi.md
@@ -83,6 +83,39 @@ No authorization required
  - **Content-Type**: application/json
  - **Accept**: application/json
 
+<a name="getProfilePictureUrl"></a>
+# **getProfilePictureUrl**
+> getProfilePictureUrl(userId)
+
+Retrieve user profile picture
+
+### Example
+```javascript
+
+var userId = 789; // Integer | userId
+
+this.alfrescoJsApi.activiti.userApi.getProfilePictureUrl(userId);
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **userId** | **String**| userId | 
+
+### Return type
+
+string 
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json 
+
 <a name="getUser"></a>
 # **getUser**
 > UserRepresentation getUser(userId)

diff --git a/src/alfresco-activiti-rest-api/src/api/ProcessApi.js b/src/alfresco-activiti-rest-api/src/api/ProcessApi.js
@@ -1,18 +1,18 @@
 (function(root, factory) {
   if (typeof define === 'function' && define.amd) {
     // AMD. Register as an anonymous module.
-    define(['../../../alfrescoApiClient', '../model/ProcessInstanceFilterRequestRepresentation', '../model/ResultListDataRepresentation', '../model/FormDefinitionRepresentation', '../model/ProcessInstanceRepresentation', '../model/ProcessFilterRequestRepresentation', '../model/FormValueRepresentation', '../model/CreateProcessInstanceRepresentation'], factory);
+    define(['../../../alfrescoApiClient', '../model/ProcessInstanceFilterRequestRepresentation', '../model/ResultListDataRepresentation', '../model/FormDefinitionRepresentation', '../model/ProcessInstanceRepresentation', '../model/ProcessInstanceAuditRepresentation', '../model/ProcessFilterRequestRepresentation', '../model/FormValueRepresentation', '../model/CreateProcessInstanceRepresentation'], factory);
   } else if (typeof module === 'object' && module.exports) {
     // CommonJS-like environments that support module.exports, like Node.
-    module.exports = factory(require('../../../alfrescoApiClient'), require('../model/ProcessInstanceFilterRequestRepresentation'), require('../model/ResultListDataRepresentation'), require('../model/FormDefinitionRepresentation'), require('../model/ProcessInstanceRepresentation'), require('../model/ProcessFilterRequestRepresentation'), require('../model/FormValueRepresentation'), require('../model/CreateProcessInstanceRepresentation'));
+    module.exports = factory(require('../../../alfrescoApiClient'), require('../model/ProcessInstanceFilterRequestRepresentation'), require('../model/ResultListDataRepresentation'), require('../model/FormDefinitionRepresentation'), require('../model/ProcessInstanceRepresentation'), require('../model/ProcessInstanceAuditRepresentation'), require('../model/ProcessFilterRequestRepresentation'), require('../model/FormValueRepresentation'), require('../model/CreateProcessInstanceRepresentation'));
   } else {
     // Browser globals (root is window)
     if (!root.ActivitiPublicRestApi) {
       root.ActivitiPublicRestApi = {};
     }
-    root.ActivitiPublicRestApi.ProcessApi = factory(root.ActivitiPublicRestApi.ApiClient, root.ActivitiPublicRestApi.ProcessInstanceFilterRequestRepresentation, root.ActivitiPublicRestApi.ResultListDataRepresentation, root.ActivitiPublicRestApi.FormDefinitionRepresentation, root.ActivitiPublicRestApi.ProcessInstanceRepresentation, root.ActivitiPublicRestApi.ProcessFilterRequestRepresentation, root.ActivitiPublicRestApi.FormValueRepresentation, root.ActivitiPublicRestApi.CreateProcessInstanceRepresentation);
+    root.ActivitiPublicRestApi.ProcessApi = factory(root.ActivitiPublicRestApi.ApiClient, root.ActivitiPublicRestApi.ProcessInstanceFilterRequestRepresentation, root.ActivitiPublicRestApi.ResultListDataRepresentation, root.ActivitiPublicRestApi.FormDefinitionRepresentation, root.ActivitiPublicRestApi.ProcessInstanceRepresentation, root.ActivitiPublicRestApi.ProcessInstanceAuditRepresentation, root.ActivitiPublicRestApi.ProcessFilterRequestRepresentation, root.ActivitiPublicRestApi.FormValueRepresentation, root.ActivitiPublicRestApi.CreateProcessInstanceRepresentation);
   }
-}(this, function(ApiClient, ProcessInstanceFilterRequestRepresentation, ResultListDataRepresentation, FormDefinitionRepresentation, ProcessInstanceRepresentation, ProcessFilterRequestRepresentation, FormValueRepresentation, CreateProcessInstanceRepresentation) {
+}(this, function(ApiClient, ProcessInstanceFilterRequestRepresentation, ResultListDataRepresentation, FormDefinitionRepresentation, ProcessInstanceRepresentation, ProcessInstanceAuditRepresentation, ProcessFilterRequestRepresentation, FormValueRepresentation, CreateProcessInstanceRepresentation) {
   'use strict';
 
   /**
@@ -368,6 +368,76 @@
       );
     }
 
+    /**
+     * Retrieve the process audit in the JSON format
+     * @param {String} processId processId
+     */
+    this.getProcessAuditJson = function(processId) {
+      var postBody = null;
+
+      // verify the required parameter 'processId' is set
+      if (processId == undefined || processId == null) {
+        throw "Missing the required parameter 'processId' when calling getProcessAuditJson";
+      }
+
+      var pathParams = {
+        'processId': processId
+      };
+      var queryParams = {
+      };
+      var headerParams = {
+      };
+      var formParams = {
+      };
+
+      var authNames = [];
+      var contentTypes = ['application/json'];
+      var accepts = ['application/json'];
+      var returnType = ProcessInstanceAuditRepresentation;
+
+      return this.apiClient.callApi(
+        '/api/enterprise/process-instances/{processId}/audit-log', 'GET',
+        pathParams, queryParams, headerParams, formParams, postBody,
+        authNames, contentTypes, accepts, returnType
+      );
+    }
+
+    /**
+     * Retrieve the process audit in the JSON format
+     * @param {String} processId processId
+     */
+    this.getProcessAuditPdf = function(processId) {
+      var postBody = null;
+
+      // verify the required parameter 'processId' is set
+      if (processId == undefined || processId == null) {
+        throw "Missing the required parameter 'processId' when calling getProcessAuditPdf";
+      }
+
+      var pathParams = {
+        'processId': processId
+      };
+      var queryParams = {
+      };
+      var headerParams = {
+      };
+      var formParams = {
+      };
+
+      var authNames = [];
+      var contentTypes = ['application/json'];
+      var accepts = ['application/json'];
+      var returnType = Object;
+      var contextRoot = null;
+      var responseType = 'blob';
+
+      return this.apiClient.callApi(
+        '/app/rest/process-instances/{processId}/audit', 'GET',
+        pathParams, queryParams, headerParams, formParams, postBody,
+        authNames, contentTypes, accepts, returnType, contextRoot, responseType
+      );
+    }
+
     /**
      * Function to receive the result of the getRestFieldValues operation.
      * @param {String} error Error message, if any.

diff --git a/src/alfresco-activiti-rest-api/src/api/UserApi.js b/src/alfresco-activiti-rest-api/src/api/UserApi.js
@@ -114,15 +114,21 @@
       var authNames = [];
       var contentTypes = ['application/json'];
       var accepts = ['application/json'];
-      var returnType = null;
+      var returnType = Object;
+      var contextRoot = null;
+      var responseType = 'blob';
 
       return this.apiClient.callApi(
         '/api/enterprise/users/{userId}/picture', 'GET',
         pathParams, queryParams, headerParams, formParams, postBody,
-        authNames, contentTypes, accepts, returnType
+        authNames, contentTypes, accepts, returnType, contextRoot, responseType
       );
     }
 
+    this.getUserProfilePictureUrl = function(userId) {
+       return this.apiClient.basePath + '/app/rest/users/'+userId+'/picture';
+    }
+
     /**
      * Function to receive the result of the getUser operation.
      * @param {String} error Error message, if any.