[TASKSCLOUD-682] - Deployed new 22.12 version.

Author: IvanAndreychikov

README.md

@@ -34,6 +34,10 @@ Feel free to explore the [Developer's Guide](https://docs.aspose.cloud/display/t
 XER, XLSX, HTML, XML, TXT, TIF, SVG, PNG, JPEG
 
 
+## Enhancements in Version 22.12
+- Added new ability to read Primavera-specific task's properties.
+- Provided the ability to read more document properties.
+
 ## Enhancements in Version 20.11
 - Support for the batch creation of tasks (i.e. the ability to create multiple tasks in a single *API* call).
 

package-lock.json

@@ -1,6 +1,6 @@
 {
   "name": "@asposecloud/aspose-tasks-cloud",
-  "version": "22.8.0",
+  "version": "22.12.0",
   "description": "Aspose.Tasks Cloud SDK for Node.js",
   "homepage": "https://products.aspose.cloud/tasks",
   "readmeFilename": "README.md",

package.json

@@ -2779,6 +2779,46 @@ export class TasksApi {
         return Promise.resolve(result);
     }
 
+    /**
+     * Get primavera properties for a task with the specified Uid.
+     * @param requestObj contains request parameters
+     */
+    public async getPrimaveraTaskProperties(requestObj: model.GetPrimaveraTaskPropertiesRequest): Promise<model.TasksIncomingMessage<model.PrimaveraTaskPropertiesResponse>> {
+        if (requestObj === null || requestObj === undefined) {
+            throw new Error('Required parameter "requestObj" was null or undefined when calling getPrimaveraTaskProperties.');
+        }
+
+        let localVarPath = this.configuration.getApiBaseUrl() + "/tasks/{name}/tasks/{taskUid}/primaveraProperties"
+            .replace("{" + "name" + "}", String(requestObj.name))
+            .replace("{" + "taskUid" + "}", String(requestObj.taskUid));
+        const queryParameters: any = {};
+
+        // verify required parameter 'requestObj.name' is not null or undefined
+        if (requestObj.name === null || requestObj.name === undefined) {
+            throw new Error('Required parameter "requestObj.name" was null or undefined when calling getPrimaveraTaskProperties.');
+        }
+
+        // verify required parameter 'requestObj.taskUid' is not null or undefined
+        if (requestObj.taskUid === null || requestObj.taskUid === undefined) {
+            throw new Error('Required parameter "requestObj.taskUid" was null or undefined when calling getPrimaveraTaskProperties.');
+        }
+        
+        localVarPath = addQueryParameterToUrl(localVarPath, queryParameters, "folder", requestObj.folder);
+        localVarPath = addQueryParameterToUrl(localVarPath, queryParameters, "storage", requestObj.storage);
+
+        const requestOptions: request.Options = {
+            method: "GET",
+            qs: queryParameters,
+            uri: localVarPath,
+            json: true,
+        };
+
+        const response = await invokeApiMethod(requestOptions, this.configuration);
+        const body =  ObjectSerializer.deserialize(response.body, "PrimaveraTaskPropertiesResponse");
+		const result: model.TasksIncomingMessage<model.PrimaveraTaskPropertiesResponse> = {body, response};
+        return Promise.resolve(result);
+    }
+
     /**
      * Read project task.
      * @param requestObj contains request parameters

src/api.ts

@@ -106,7 +106,7 @@ async function invokeApiMethodInternal(requestOptions: request.Options, confgura
     //headers
     sa.set("User-Agent", "tasks nodejs sdk");
     sa.set("x-aspose-client", "nodejs sdk");  
-    sa.set("x-aspose-client-version", "22.8"); 
+    sa.set("x-aspose-client-version", "22.12"); 
 
     if (!requestOptions.headers) {
         requestOptions.headers = {};

src/internal/requestHelper.ts

@@ -2053,6 +2053,129 @@ export enum PresentationFormat {
     ResourceSheet = 'ResourceSheet' as any,
     TaskSheet = 'TaskSheet' as any,
 }
+/**
+ * Represents Primavera-specific properties for a task read from Primavera format (XER of P6XML).
+ */
+export class PrimaveraTaskProperties {
+
+    /**
+     * Attribute type map
+     */
+    public static attributeTypeMap: Array<{name: string, baseName: string, type: string}> = [
+        {
+            name: "sequenceNumber",
+            baseName: "sequenceNumber",
+            type: "number",
+        },        
+        {
+            name: "activityId",
+            baseName: "activityId",
+            type: "string",
+        },        
+        {
+            name: "remainingEarlyFinish",
+            baseName: "remainingEarlyFinish",
+            type: "Date",
+        },        
+        {
+            name: "remainingEarlyStart",
+            baseName: "remainingEarlyStart",
+            type: "Date",
+        },        
+        {
+            name: "remainingLateStart",
+            baseName: "remainingLateStart",
+            type: "Date",
+        },        
+        {
+            name: "remainingLateFinish",
+            baseName: "remainingLateFinish",
+            type: "Date",
+        },        
+        {
+            name: "rawDurationType",
+            baseName: "rawDurationType",
+            type: "string",
+        },        
+        {
+            name: "rawActivityType",
+            baseName: "rawActivityType",
+            type: "string",
+        },        
+        {
+            name: "rawCompletePercentType",
+            baseName: "rawCompletePercentType",
+            type: "string",
+        },        
+        {
+            name: "rawStatus",
+            baseName: "rawStatus",
+            type: "string",
+        }    ];
+
+    /**
+     * Returns attribute type map
+     */
+    public static getAttributeTypeMap() {
+        return PrimaveraTaskProperties.attributeTypeMap;
+    }
+
+    /**
+     * The sequence number of the WBS item (summary tasks). It is used to sort summary tasks in Primavera.
+     */
+    public sequenceNumber: number;
+    
+    /**
+     * Activity id field - a task's unique identifier used by Primavera.
+     */
+    public activityId: string;
+    
+    /**
+     * Remaining early finish date - the date when the remaining work for the activity is scheduled to be finished.
+     */
+    public remainingEarlyFinish: Date;
+    
+    /**
+     * Remaining early start date - the date when the remaining work for the activity is scheduled to begin.
+     */
+    public remainingEarlyStart: Date;
+    
+    /**
+     * Remaining late start date.
+     */
+    public remainingLateStart: Date;
+    
+    /**
+     * Remaining late finish date.
+     */
+    public remainingLateFinish: Date;
+    
+    /**
+     * Raw text representation (as in source file) of 'Duration Type' field of the activity.
+     */
+    public rawDurationType: string;
+    
+    /**
+     * Raw text representation (as in source file) of 'Activity Type' field of the activity.
+     */
+    public rawActivityType: string;
+    
+    /**
+     * Raw text representation (as in source file) of '% Complete Type' field of the activity.
+     */
+    public rawCompletePercentType: string;
+    
+    /**
+     * Raw text representation (as in source file) of 'Status' field of the activity.
+     */
+    public rawStatus: string;
+    
+    public constructor(init?: Partial<PrimaveraTaskProperties>) {
+        
+        Object.assign(this, init);
+    }        
+}
+
 /**
  * Specifies types of supported probability distributions.
  */
@@ -7240,6 +7363,39 @@ export class PageCountResponse extends AsposeResponse {
     }        
 }
 
+/**
+ * PrimaveraProperties response.
+ */
+export class PrimaveraTaskPropertiesResponse extends AsposeResponse {
+
+    /**
+     * Attribute type map
+     */
+    public static attributeTypeMap: Array<{name: string, baseName: string, type: string}> = [
+        {
+            name: "primaveraProperties",
+            baseName: "primaveraProperties",
+            type: "PrimaveraTaskProperties",
+        }    ];
+
+    /**
+     * Returns attribute type map
+     */
+    public static getAttributeTypeMap() {
+        return super.getAttributeTypeMap().concat(PrimaveraTaskPropertiesResponse.attributeTypeMap);
+    }
+
+    /**
+     * PrimaveraTaskProperties DTO
+     */
+    public primaveraProperties: PrimaveraTaskProperties;
+    
+    public constructor(init?: Partial<PrimaveraTaskPropertiesResponse>) {
+        super(init);
+        Object.assign(this, init);
+    }        
+}
+
 /**
  * ProjectIds response
  */
@@ -7964,6 +8120,7 @@ const typeMap = {
             OutlineCodeItem,
             OutlineMask,
             OutlineValue,
+            PrimaveraTaskProperties,
             ProjectInfo,
             ProjectRecalculationResult,
             ProjectServerSaveOptionsDTO,
@@ -8013,6 +8170,7 @@ const typeMap = {
             OutlineCodeItemsResponse,
             OutlineCodeResponse,
             PageCountResponse,
+            PrimaveraTaskPropertiesResponse,
             ProjectIdsResponse,
             ProjectList,
             ProjectListResponse,
@@ -10206,6 +10364,35 @@ public fileName: string;
     } 
 }
 
+/**
+ * Request model for getPrimaveraTaskProperties operation.
+ */
+export class GetPrimaveraTaskPropertiesRequest {
+    /**
+     * The name of the file.
+     */
+public name: string;
+
+    /**
+     * Uid of task to get primavera properties for.
+     */
+public taskUid: number;
+
+    /**
+     * The document folder.
+     */
+public folder: string;
+
+    /**
+     * The document storage.
+     */
+public storage: string;
+    
+    public constructor(init?: Partial<GetPrimaveraTaskPropertiesRequest>) {        
+        Object.assign(this, init);
+    } 
+}
+
 /**
  * Request model for getTask operation.
  */

src/model/model.ts

@@ -45,7 +45,7 @@ describe("getDocumentProperties function", () => {
 
         const result = await tasksApi.getDocumentProperties(request);
         expect(result.response.statusCode).to.equal(200);
-        expect(result.body.properties.list.length).to.equal(52);
+        expect(result.body.properties.list.length).to.equal(63);
         expect(result.body.properties.list[0].name).to.equal("Title");
         expect(result.body.properties.list[0].value).to.equal("Home Move");
     });
@@ -195,4 +195,4 @@ describe("postDocumentProperty function", () => {
         const result = await tasksApi.getDocumentProperty(request2);
         expect(result.body.property).is.null;
     });
-});
+});

test/documentPropertiesTests.ts

@@ -0,0 +1,63 @@
+/*
+* MIT License
+
+* Copyright (c) 2022 Aspose Pty Ltd
+
+* Permission is hereby granted, free of charge, to any person obtaining a copy
+* of this software and associated documentation files (the "Software"), to deal
+* in the Software without restriction, including without limitation the rights
+* to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+* copies of the Software, and to permit persons to whom the Software is
+* furnished to do so, subject to the following conditions:
+
+* The above copyright notice and this permission notice shall be included in all
+* copies or substantial portions of the Software.
+
+* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+* SOFTWARE.
+*/
+
+import { expect } from "chai";
+import "mocha";
+import { GetPrimaveraTaskPropertiesRequest } from "../src";
+
+import * as BaseTest from "./baseTest";
+
+describe("getPrimaveraTaskProperties function", () => {
+    it("should return response with code 200 and correct data", async () => {
+        
+        const tasksApi = BaseTest.initializeTasksApi();
+        const fileName = "p6_multiproject.xml";
+        const localPath = BaseTest.localBaseTestDataFolder + fileName;
+        const remotePath = BaseTest.remoteBaseTestDataFolder;
+        const remoteFullPath = remotePath + "/" + fileName;
+
+        await tasksApi.uploadFileToStorage(remoteFullPath, localPath);
+
+        const request : GetPrimaveraTaskPropertiesRequest = {
+            name: fileName,
+            taskUid: 1,
+            folder: remotePath,
+            storage: undefined
+        }
+
+        const result = await tasksApi.getPrimaveraTaskProperties(request);
+
+        expect(result.response.statusCode).to.equal(200);
+        expect(result.body.primaveraProperties.sequenceNumber).to.equal(0);
+        expect(result.body.primaveraProperties.activityId).to.equal("A1040");
+        expect(result.body.primaveraProperties.remainingEarlyStart).to.eql(new Date(2000, 9, 12, 8));
+        expect(result.body.primaveraProperties.remainingEarlyFinish).to.eql(new Date(2000, 9, 12, 17));
+        expect(result.body.primaveraProperties.remainingLateStart).to.eql(new Date(2000, 9, 12, 8));
+        expect(result.body.primaveraProperties.remainingLateFinish).to.eql(new Date(2000, 9, 12, 17));
+        expect(result.body.primaveraProperties.rawDurationType).to.equal("Fixed Units");
+        expect(result.body.primaveraProperties.rawActivityType).to.equal("Task Dependent");
+        expect(result.body.primaveraProperties.rawCompletePercentType).to.equal("Units");
+        expect(result.body.primaveraProperties.rawStatus).to.equal("Not Started");
+    });
+});