@progress/sitefinity-webservices-sdk 1.0.3 → 1.1.0

package/src/Requests/ExecutableRequest.ts

@@ -1,11 +1,13 @@
-import { RequestBase, RequestOptionsBaseExtended } from './RequestBase';
-import { utils } from '../utils';
+import { RequestBase, RequestOptionsBaseExtended } from "./RequestBase";
+import { utils } from "../utils";
 import { HEADER_NAMES } from "../constants";
 import { SDKOptions, Token } from "../Sitefinity";
 
 const XMLHttpRequestDone = 4;
 
 export class ExecutableRequest extends RequestBase {
+    protected http: XMLHttpRequest;
+
     private token: Token;
     private enableUnlimitedChoices: boolean;
     private integrationMode: boolean;
@@ -20,20 +22,19 @@ export class ExecutableRequest extends RequestBase {
     }
 
     execute() {
-        const http = new XMLHttpRequest();
-
-        http.onreadystatechange = () => {
-            if (http.readyState === XMLHttpRequestDone) {
-                if (http.status > 0) {
-                    let data = this.parseResponse(http);
+        this.http = new XMLHttpRequest();
 
-                    if (http.status >= 200 && http.status <= 206) {
+        this.http.onreadystatechange = () => {
+            if (this.http.readyState === XMLHttpRequestDone) {
+                if (this.http.status > 0) {
+                    let data = this.parseResponse(this.http);
 
-                        if (utils.isFunction(this.successCb)) {
+                    if (this.http.status >= 200 && this.http.status <= 206) {
+                        if (this.successCb && utils.isFunction(this.successCb)) {
                             this.successCb(data);
                         }
                     }
-                    else if (http.status >= 400) {
+                    else if (this.http.status >= 400) {
                         // When the data is string, we save the string as message
                         // and convert the data to normal object with message property
                         if (utils.isString(data)) {
@@ -42,10 +43,10 @@ export class ExecutableRequest extends RequestBase {
                             };
                         }
 
-                        data.status = http.status;
+                        data.status = this.http.status;
 
                         // in case of errors we would like there to be one handler for all of the errors
-                        if (utils.isFunction(this.failureCb)) {
+                        if (this.failureCb && utils.isFunction(this.failureCb)) {
                             this.failureCb(data);
                         }
                     }
@@ -53,20 +54,25 @@ export class ExecutableRequest extends RequestBase {
             }
         };
 
-        if (utils.isFunction(this.progressCb)) {
-            if (http.upload) {
-                http.upload.onprogress = (event) => {
-                    this.progressCb(event);
-                };
-            }
-        }
+
+        this.executeProgressEvent();
 
         const method = this.getMethod();
         const url = this.buildUrl();
-        http.open(method, url, true);
-        this.setHeaders(http, this.getHeaders());
+        this.http.open(method, url, true);
+        this.setHeaders(this.http, this.getHeaders());
 
-        http.send(utils.serializeToJSON(this.getBody()));
+        this.http.send(utils.serializeToJSON(this.getBody()));
+    }
+
+    protected executeProgressEvent() {
+        if (this.http.upload) {
+            this.http.upload.onprogress = (event) => {
+                if (this.progressCb && utils.isFunction(this.progressCb)) {
+                    this.progressCb(event);
+                }
+            };
+        }
     }
 
     private setHeaders(http: XMLHttpRequest, headers: { [key: string]: string }) {
@@ -77,7 +83,7 @@ export class ExecutableRequest extends RequestBase {
         }
 
         if (this.token) {
-            if (typeof this.token === 'string') {
+            if (typeof this.token === "string") {
                 // for backward compatibility
                 http.setRequestHeader(HEADER_NAMES.authorization, this.token);
             } else {

package/src/Requests/Request.ts

@@ -1,6 +1,6 @@
 import { HEADER_NAMES, HTTP_METHODS } from "../constants";
 import { SDKOptions, Token } from "../Sitefinity";
-import { utils } from '../utils';
+import { utils } from "../utils";
 import { ExecutableRequest } from "./ExecutableRequest";
 import { RequestOptionsBaseExtended } from "./RequestBase";
 
@@ -120,7 +120,7 @@ export class DeleteRelatedRequest extends DeleteRequest {
     }
 
     buildUrl(): string {
-        const url = this.urlOptions.baseUrl + this.urlOptions.entitySet + "(" + this.key + ")/" + this.property + "/$ref"
+        const url = this.urlOptions.baseUrl + this.urlOptions.entitySet + "(" + this.key + ")/" + this.property + "/$ref";
         return this.addQueryParameters(url);
     }
 }
@@ -190,6 +190,91 @@ export class UploadRequest extends CreateRequest {
     }
 }
 
+export class UploadChunkRequest extends CreateRequest {
+    contentType: string;
+    chunkOrdinal: number;
+    chunkSize: number;
+    chunkedFileUploadSessionId: string;
+    numberOfChunks: number;
+    positionInQueue: number;
+    blobStorageProviderName: string;
+
+    constructor(requestOptions: UploadChunkRequestOptionsExtended, token: Token, sdkOptions: SDKOptions) {
+        super(requestOptions, token, sdkOptions);
+        this.contentType = requestOptions.fileMimeType;
+        this.chunkOrdinal = requestOptions.chunkOrdinal;
+        this.chunkedFileUploadSessionId = requestOptions.chunkedFileUploadSessionId;
+        this.chunkSize = requestOptions.chunkSize;
+        this.numberOfChunks = requestOptions.numberOfChunks;
+        this.positionInQueue = requestOptions.positionOfChunkInQueue;
+        this.blobStorageProviderName = requestOptions.blobStorageProviderName;
+        this.data = requestOptions.chunkBlob;
+    }
+
+    getHeaders(): { [key: string]: string } {
+        const headers = super.getHeaders();
+        headers[HEADER_NAMES.contentEncoding] = "identity";
+        headers[HEADER_NAMES.contentType] = this.contentType || "application/octet-stream";
+        headers[HEADER_NAMES.chunkOrdinal] = this.chunkOrdinal.toString();
+        headers[HEADER_NAMES.chunkedFileUploadSessionId] = this.chunkedFileUploadSessionId;
+        headers[HEADER_NAMES.chunkSize] = this.chunkSize.toString();
+        headers[HEADER_NAMES.blobStorageProviderName] = this.blobStorageProviderName.toString();
+
+        return headers;
+    }
+
+    getBody(): object {
+        return this.data;
+    }
+
+    getMethod(): string {
+        return HTTP_METHODS.post;
+    }
+
+    protected override executeProgressEvent(): void {
+        if (this.http.upload) {
+            this.http.upload.onprogress = () => {
+                const payload = {
+                    lengthComputable: true,
+                    loaded: this.positionInQueue,
+                    total: this.numberOfChunks
+                };
+
+                if (this.progressCb && utils.isFunction(this.progressCb)) {
+                    this.progressCb(payload);
+                }
+            };
+        }
+    }
+}
+
+export class CommitChunksRequest extends CreateRequest {
+    constructor(requestOptions: CommitChunksRequestOptionsExtended, token: Token, sdkOptions: SDKOptions) {
+        super(requestOptions, token, sdkOptions);
+
+        this.action = "Default.CommitChunks";
+
+        this.data = {
+            // ! this must be the param name that the operation provider on the server accepts
+            commitChunksDto: {
+                chunkedFileUploadSessionId: requestOptions.chunkedFileUploadSessionId,
+                contentType: requestOptions.contentType,
+                fileTotalSize: requestOptions.fileTotalSize,
+                numberOfChunks: requestOptions.numberOfChunks,
+                fileName: requestOptions.fileName,
+                blobStorageProviderName: requestOptions.blobStorageProviderName,
+                itemId: requestOptions.itemId || null,
+                // ! must be named properties
+                properties: requestOptions.uploadProperties
+            }
+        };
+    }
+
+    getMethod(): string {
+        return HTTP_METHODS.post;
+    }
+}
+
 export interface PostRequestOptionsExtended extends RequestOptionsBaseExtended {
     data?: object;
 }
@@ -211,3 +296,25 @@ export interface UploadRequestOptionsExtended extends PostRequestOptionsExtended
     contentType: string;
     uploadProperties: { [key: string]: string };
 }
+
+export interface UploadChunkRequestOptionsExtended extends PostRequestOptionsExtended {
+    fileMimeType: string;
+    chunkedFileUploadSessionId: string;
+    chunkSize: number;
+    chunkOrdinal: number;
+    numberOfChunks: number;
+    chunkBlob: Blob;
+    blobStorageProviderName: string;
+    positionOfChunkInQueue?: number;
+}
+
+export interface CommitChunksRequestOptionsExtended extends PostRequestOptionsExtended {
+    chunkedFileUploadSessionId: string
+    blobStorageProviderName: string;
+    contentType: string;
+    fileTotalSize: number;
+    numberOfChunks: number;
+    fileName: string;
+    uploadProperties: { [key: string]: string };
+    itemId?: string;
+}

package/src/Requests/RequestBase.ts

@@ -2,7 +2,7 @@ import { CONTENT_TYPES, HEADER_NAMES, ODATA_PARAMS, SF_PARAMS } from "../constan
 import { RequestOptionsBase } from "../Data";
 import { Query } from "../Query";
 import { TypeOptions } from "../Sitefinity";
-import { utils } from '../utils';
+import { utils } from "../utils";
 
 export class RequestBase {
     public successCb: Function;
@@ -11,14 +11,14 @@ export class RequestBase {
     public key: string | number;
     public urlOptions: TypeOptions;
     protected query: Query;
-    private action: string;
+    protected action: string;
     private fallbackProperties: string[];
 
     constructor(options: RequestOptionsBaseExtended) {
         this.successCb = options.successCb;
         this.failureCb = options.failureCb;
-        this.urlOptions = options.urlOptions;
         this.progressCb = options.progressCb;
+        this.urlOptions = options.urlOptions;
         this.key = options.key;
         this.action = options.action;
         this.fallbackProperties = options.fallbackProperties;
@@ -156,6 +156,5 @@ export class RequestBase {
 }
 
 export interface RequestOptionsBaseExtended extends RequestOptionsBase {
-    progressCb?: Function;
     urlOptions: TypeOptions;
 }

package/src/Requests/RequestFactory.ts

@@ -1,4 +1,4 @@
-import { GetRequest, GetByIdRequest, CreateRequest, UpdateRequest, DeleteRequest, GetRelatedRequest, GetRelatedByIdRequest, DeleteRelatedRequest, DeleteRelatedByIdRequest, CreateRelatedRequest, UploadRequest, PostRequestOptionsExtended, PutRequestOptionsExtended, RelatedRequestOptionsExtended, RelatedByIdRequestOptionsExtended, UploadRequestOptionsExtended } from "./Request";
+import { GetRequest, GetByIdRequest, CreateRequest, UpdateRequest, DeleteRequest, GetRelatedRequest, GetRelatedByIdRequest, DeleteRelatedRequest, DeleteRelatedByIdRequest, CreateRelatedRequest, UploadRequest, PostRequestOptionsExtended, PutRequestOptionsExtended, RelatedRequestOptionsExtended, RelatedByIdRequestOptionsExtended, UploadRequestOptionsExtended, UploadChunkRequest, CommitChunksRequest, CommitChunksRequestOptionsExtended, UploadChunkRequestOptionsExtended } from "./Request";
 import { SDKOptions, Token } from "../Sitefinity";
 import { BatchRequest, BatchRequestOptionsExtended } from "./BatchRequest";
 import { RequestOptionsBaseExtended } from "./RequestBase";
@@ -59,6 +59,14 @@ export class RequestFactory {
         return new UploadRequest(parameters, this.token, this.options);
     }
 
+    uploadChunk(parameters: UploadChunkRequestOptionsExtended) {
+        return new UploadChunkRequest(parameters, this.token, this.options);
+    }
+
+    commitChunks(parameters: CommitChunksRequestOptionsExtended) {
+        return new CommitChunksRequest(parameters, this.token, this.options);
+    }
+
     batch(parameters: RequestOptionsBaseExtended) {
         const batchParams = parameters as BatchRequestOptionsExtended;
         batchParams.factory = this;

package/src/Requests/request.spec.ts

@@ -2,7 +2,7 @@ import { Query } from "../Query";
 import { Sitefinity } from "../Sitefinity";
 
 describe("SDK basic tests", () => {
-    const baseUrl = "http://www.mysite.com/api/default/"
+    const baseUrl = "http://www.mysite.com/api/default/";
     let sitefinity: Sitefinity;
     let query: Query;
 
@@ -23,13 +23,13 @@ describe("SDK basic tests", () => {
     });
 
     it("query assert", () => {
-        const testQuery = (query.where().and().endsWith("Title", "Record").done() as any).or().startsWith('Title', 'asd').done().done();
+        const testQuery = (query.where().and().endsWith("Title", "Record").done() as any).or().startsWith("Title", "asd").done().done();
         const resultingQuery = testQuery.build();
         expect(resultingQuery.$filter).toEqual("(endswith(Title, 'Record')) and (startswith(Title, 'asd'))");
     });
 
     it("complex query assert", () => {
-        const testQuery = query.where().not().endsWith("Record", "Title").done().and().not().eq('Content', 'test').done().done().done();
+        const testQuery = query.where().not().endsWith("Record", "Title").done().and().not().eq("Content", "test").done().done().done();
         const resultingQuery = testQuery.build();
         expect(resultingQuery.$filter).toEqual("(not endswith(Record, 'Title')) and ((not (Content eq 'test')))");
     });
@@ -42,12 +42,12 @@ describe("SDK basic tests", () => {
         data.get({query: query.count(false)});
 
         let request = jasmine.Ajax.requests.mostRecent();
-        expect(request.url).toBe('http://www.mysite.com/api/default/newsitems/$count');
+        expect(request.url).toBe("http://www.mysite.com/api/default/newsitems/$count");
 
         data.get({query: query.count(true)});
 
         request = jasmine.Ajax.requests.mostRecent();
-        expect(request.url).toBe('http://www.mysite.com/api/default/newsitems?$count=true');
+        expect(request.url).toBe("http://www.mysite.com/api/default/newsitems?$count=true");
     });
 
     it("request assert", () => {
@@ -58,14 +58,14 @@ describe("SDK basic tests", () => {
         }).get({query: null});
 
         const request = jasmine.Ajax.requests.mostRecent();
-        expect(request.url).toBe('http://www.mysite.com/api/default/newsitems?sf_provider=newsProvider&sf_culture=en-US');
-        expect(request.method).toBe('GET');
+        expect(request.url).toBe("http://www.mysite.com/api/default/newsitems?sf_provider=newsProvider&sf_culture=en-US");
+        expect(request.method).toBe("GET");
         expect(request.data()).toEqual({});
     });
 
     it("batch assert", async () => {
         const batch = sitefinity.batch();
-        const getQuery = query.where().eq('Title', 'newTitleN11').done();
+        const getQuery = query.where().eq("Title", "newTitleN11").done();
 
         batch.get({
             entitySet: "newsitems",
@@ -83,8 +83,8 @@ describe("SDK basic tests", () => {
         (batch as any).execute();
 
         const request = jasmine.Ajax.requests.mostRecent();
-        expect(request.url).toBe('http://www.mysite.com/api/default/$batch');
-        expect(request.method).toBe('POST');
+        expect(request.url).toBe("http://www.mysite.com/api/default/$batch");
+        expect(request.method).toBe("POST");
 
         await readBlobAsText(request.params).then((result) => {
             expect(result).toContain("{\"title\":\"Test\"}");

package/src/Sitefinity.spec.ts

@@ -103,7 +103,7 @@ OData-Version: 4.0\r
             sdk = new Sitefinity({
                 baseUrl: "http://www.mysite.com/api/default/v2/",
                 enableUnlimitedChoices: false
-            })
+            });
             sdk.data({}).get({});
 
             request = jasmine.Ajax.requests.mostRecent();
@@ -123,7 +123,7 @@ OData-Version: 4.0\r
             sdk = new Sitefinity({
                 baseUrl: "http://www.mysite.com/api/default/v2/",
                 integrationMode: false
-            })
+            });
             sdk.data({}).get({});
 
             request = jasmine.Ajax.requests.mostRecent();
@@ -147,7 +147,7 @@ OData-Version: 4.0\r
             const request = jasmine.Ajax.requests.mostRecent();
             request.respondWith({
                 status: 200,
-                responseText: '{"message":"test"}'
+                responseText: "{\"message\":\"test\"}"
             });
 
             expect(successSpy).toHaveBeenCalledOnceWith({ message: "test" });
@@ -171,7 +171,7 @@ OData-Version: 4.0\r
             const request = jasmine.Ajax.requests.mostRecent();
             request.respondWith({
                 status: 400,
-                responseText: '{"message":"test"}'
+                responseText: "{\"message\":\"test\"}"
             });
 
             expect(failureSpy).toHaveBeenCalledOnceWith({ message: "test", status: 400 });
@@ -286,7 +286,7 @@ OData-Version: 4.0\r
                 }).get({});
 
                 const request = jasmine.Ajax.requests.mostRecent();
-                expect(request.url).toContain(`p1=test1&p2=123`);
+                expect(request.url).toContain("p1=test1&p2=123");
             });
         });
 
@@ -366,7 +366,7 @@ OData-Version: 4.0\r
                 }).execute();
 
                 const request = jasmine.Ajax.requests.mostRecent();
-                expect(request.url).toContain(`p1=test1&p2=123`);
+                expect(request.url).toContain("p1=test1&p2=123");
             });
 
             it("Verify successCb overrides global success handler from SDK options", () => {

package/src/Sitefinity.ts

@@ -1,7 +1,7 @@
-import { RequestFactory } from './Requests/RequestFactory';
-import { Data } from './Data';
-import { Query } from './Query';
-import { utils } from './utils';
+import { RequestFactory } from "./Requests/RequestFactory";
+import { Data } from "./Data";
+import { Query } from "./Query";
+import { utils } from "./utils";
 import { ResponseHandlers } from "./Requests/ExecutableRequest";
 import { BatchRequest } from "./Requests/BatchRequest";
 
@@ -29,7 +29,7 @@ export class Sitefinity {
             siteId: options.siteId || this.siteId,
             additionalQueryParams: options.additionalQueryParams,
             entitySet: options.entitySet
-        }
+        };
 
         return new Data(urlOptions, this.factory);
     }

package/src/WhereQuery.ts

@@ -1,4 +1,4 @@
-import { ComplexExpression, BinaryExpression } from './Expression';
+import { ComplexExpression, BinaryExpression } from "./Expression";
 import { EXPRESSION_TYPE } from "./constants";
 
 /**
@@ -103,7 +103,7 @@ export class WhereQuery<QueryType> {
     }
 
     /**
-     * Ends the definition of the current WhereQuery. You need to call this method in order to continue with the definition of the parent {@link QueryBase}. All other `WhereQuery` methods return the current instance of `WhereQuery` to allow chaining.
+     * Ends the definition of the current WhereQuery. You need to call this method in order to continue with the definition of the parent {@link Query}. All other `WhereQuery` methods return the current instance of `WhereQuery` to allow chaining.
      */
     done(): QueryType {
         if (this.parent instanceof WhereQuery) {