@progress/sitefinity-webservices-sdk 1.0.3 → 1.1.0

package/package.json

@@ -1,39 +1,41 @@
 {
   "name": "@progress/sitefinity-webservices-sdk",
-  "version": "1.0.3",
+  "version": "1.1.0",
   "scripts": {
-    "start": "webpack-dev-server --config config/webpack.dev.js",
-    "build:dev": "webpack --config config/webpack.dev.js --progress --profile",
-    "build:prod": "webpack --config config/webpack.prod.js --progress --profile",
-    "build:release": "npm run build:prod & npm run build:dev & npm run docs",
+    "start": "webpack-dev-server --config config/webpack.dev.ts",
+    "build:dev": "webpack --config config/webpack.dev.ts --progress --profile",
+    "build:prod": "webpack --config config/webpack.prod.ts --progress --profile",
+    "build:release": "npm run build:dev & npm run build:prod & npm run docs",
     "test": "karma start --single_run",
     "test:debug": "karma start",
     "docs": "typedoc",
-    "lint": "eslint . --ext .ts"
+    "lint": "eslint . --ext .ts",
+    "lint:fix": "eslint . --ext .ts --fix"
   },
   "devDependencies": {
-    "@types/jasmine": "3.10.3",
+    "@types/jasmine": "4.3.0",
     "@types/jasmine-ajax": "3.3.3",
-    "@types/node": "17.0.21",
-    "@typescript-eslint/eslint-plugin": "5.13.0",
-    "@typescript-eslint/parser": "5.13.0",
-    "awesome-typescript-loader": "5.2.1",
-    "eslint": "8.10.0",
+    "@types/node": "18.7.14",
+    "@typescript-eslint/eslint-plugin": "5.36.2",
+    "@typescript-eslint/parser": "5.36.2",
+    "eslint": "8.23.0",
     "html-webpack-plugin": "5.5.0",
-    "jasmine": "4.0.2",
+    "jasmine": "4.3.0",
     "jasmine-ajax": "4.0.0",
     "jasmine-spec-reporter": "7.0.0",
-    "karma": "6.3.17",
-    "karma-chrome-launcher": "3.1.0",
-    "karma-jasmine": "4.0.1",
+    "karma": "6.4.0",
+    "karma-chrome-launcher": "3.1.1",
+    "karma-jasmine": "5.1.0",
     "karma-jasmine-ajax": "0.1.13",
-    "karma-spec-reporter": "0.0.33",
+    "karma-spec-reporter": "0.0.34",
     "karma-typescript": "5.5.3",
-    "typedoc": "0.22.12",
-    "typescript": "4.6.2",
-    "webpack": "5.69.1",
-    "webpack-cli": "4.9.2",
-    "webpack-dev-server": "4.7.4",
+    "ts-loader": "9.3.1",
+    "ts-node": "10.9.1",
+    "typedoc": "0.23.11",
+    "typescript": "4.8.2",
+    "webpack": "5.74.0",
+    "webpack-cli": "4.10.0",
+    "webpack-dev-server": "4.10.1",
     "webpack-merge": "5.8.0"
   }
 }

package/sitefinity-webservices-sdk.ts

@@ -4,7 +4,6 @@ export * from "./src/utils";
 export * from "./src/WhereQuery";
 export * from "./src/Sitefinity";
 export * from "./src/QueryBuilder";
-export * from "./src/QueryBase";
 export * from "./src/Query";
 export * from "./src/OrderProperty";
 export * from "./src/Expression";

package/src/Data.spec.ts

@@ -44,11 +44,11 @@ describe("Data class tests", () => {
         const request = jasmine.Ajax.requests.mostRecent();
         expect(request.url).toContain(`${ODATA_PARAMS.$filter}=${queryResult}`);
         expect(request.url).toContain(`${baseUrl}${action}`);
-        expect(request.url).toContain(`${SF_PARAMS.fallbackParams}=${fallbackProperties.join(',')}`);
+        expect(request.url).toContain(`${SF_PARAMS.fallbackParams}=${fallbackProperties.join(",")}`);
 
         request.respondWith({
             status: 200,
-            responseText: '{"message":"test"}'
+            responseText: "{\"message\":\"test\"}"
         });
 
         expect(successCbSpy).toHaveBeenCalledOnceWith({ message: "test" });
@@ -64,10 +64,10 @@ describe("Data class tests", () => {
         const request = jasmine.Ajax.requests.mostRecent();
         request.respondWith({
             status: 400,
-            responseText: '{"message":"test"}'
+            responseText: "{\"message\":\"test\"}"
         });
 
-        expect(failureCbSpy).toHaveBeenCalledOnceWith({ message: "test", status: 400 })
+        expect(failureCbSpy).toHaveBeenCalledOnceWith({ message: "test", status: 400 });
         expect(successCbSpy).not.toHaveBeenCalled();
     });
 
@@ -85,7 +85,7 @@ describe("Data class tests", () => {
 
         request.respondWith({
             status: 200,
-            responseText: '{"message":"test"}'
+            responseText: "{\"message\":\"test\"}"
         });
 
         expect(successCbSpy).toHaveBeenCalledOnceWith({ message: "test" });
@@ -110,10 +110,10 @@ describe("Data class tests", () => {
         const request = jasmine.Ajax.requests.mostRecent();
         request.respondWith({
             status: 400,
-            responseText: '{"message":"test"}'
+            responseText: "{\"message\":\"test\"}"
         });
 
-        expect(failureCbSpy).toHaveBeenCalledOnceWith({ message: "test", status: 400 })
+        expect(failureCbSpy).toHaveBeenCalledOnceWith({ message: "test", status: 400 });
         expect(successCbSpy).not.toHaveBeenCalled();
     });
 
@@ -130,11 +130,11 @@ describe("Data class tests", () => {
         const request = jasmine.Ajax.requests.mostRecent();
         expect(request.url).toContain(`${ODATA_PARAMS.$filter}=${queryResult}`);
         expect(request.url).toContain(`${baseUrl}(${key})/${action}`);
-        expect(request.url).toContain(`${SF_PARAMS.fallbackParams}=${fallbackProperties.join(',')}`);
+        expect(request.url).toContain(`${SF_PARAMS.fallbackParams}=${fallbackProperties.join(",")}`);
 
         request.respondWith({
             status: 200,
-            responseText: '{"message":"test"}'
+            responseText: "{\"message\":\"test\"}"
         });
 
         expect(successCbSpy).toHaveBeenCalledOnceWith({ message: "test" });
@@ -151,10 +151,10 @@ describe("Data class tests", () => {
         const request = jasmine.Ajax.requests.mostRecent();
         request.respondWith({
             status: 400,
-            responseText: '{"message":"test"}'
+            responseText: "{\"message\":\"test\"}"
         });
 
-        expect(failureCbSpy).toHaveBeenCalledOnceWith({ message: "test", status: 400 })
+        expect(failureCbSpy).toHaveBeenCalledOnceWith({ message: "test", status: 400 });
         expect(successCbSpy).not.toHaveBeenCalled();
     });
-});
+});

package/src/Data.ts

@@ -1,4 +1,5 @@
-import { SF_PARAMS } from "./constants";
+import { ChunkUploadSdk } from "./chunk-upload/chunk-upload.sdk";
+import { SF_PARAMS } from "./constants";
 import { Query } from "./Query";
 import { ExecutableRequest } from "./Requests/ExecutableRequest";
 import { RequestFactory } from "./Requests/RequestFactory";
@@ -16,6 +17,19 @@ export class Data {
         this.factory = factory;
     }
 
+
+    /**
+     * Returns an instance of the @type {ChunkUploadService}
+     *
+     * @readonly
+     * @type {ChunkUploadSdk}
+     * @memberof Data
+     */
+    public get chunkUpload(): ChunkUploadSdk {
+        const service = new ChunkUploadSdk(this.urlOptions, this.factory);
+        return service;
+    }
+
     /**
     * Executes a GET request to retrieve a collection of items.
     */
@@ -275,7 +289,7 @@ export class Data {
 
         const data = {
             "@odata.id": parameters.link
-        }
+        };
 
         const request = this.factory.createRelated({
             urlOptions: this.urlOptions,
@@ -322,7 +336,7 @@ export class Data {
             _factory: this.factory,
             successCb: parameters.successCb,
             failureCb: parameters.failureCb
-        }
+        };
 
         const batch = this.factory.batch(options);
         const transaction = batch.beginTransaction();
@@ -353,7 +367,7 @@ export class Data {
         }
 
         batch.endTransaction(transaction);
-        batch.execute();
+        return batch.execute();
     }
 }
 
@@ -362,6 +376,7 @@ export interface RequestOptionsBase {
     action?: string;
     successCb?: Function;
     failureCb?: Function;
+    progressCb?: Function;
     fallbackProperties?: string[];
     key?: string | number;
 }

package/src/OrderProperty.ts

@@ -1,19 +1,19 @@
-import { utils } from './utils';
+import { utils } from "./utils";
 
 export class OrderProperty {
     constructor(private propertyPath: string, private isDesc: boolean = null) {
         if (!utils.isString(propertyPath))
-            throw new Error('Property name is not a valid string');
+            throw new Error("Property name is not a valid string");
 
         propertyPath = propertyPath.trim();
 
-        const parts = propertyPath.split(' ');
+        const parts = propertyPath.split(" ");
         // parts[0] is the propertyPath; [1] would be whether descending or not.
         if (parts.length > 1 && isDesc !== true && isDesc !== false) {
-            isDesc = parts[1].toLowerCase() == 'desc';
+            isDesc = parts[1].toLowerCase() == "desc";
             if (!isDesc) {
                 // isDesc is false but check to make sure its intended.
-                const isAsc = parts[1].toLowerCase() == 'asc';
+                const isAsc = parts[1].toLowerCase() == "asc";
                 if (!isAsc) {
                     throw new Error("the second word in the propertyPath must begin with 'desc' or 'asc'");
                 }
@@ -33,7 +33,7 @@ export class OrderProperty {
     }
 
     getValue(): string {
-        const direction = (this.isDesc) ? 'desc' : 'asc';
-        return this.propertyPath + ' ' + direction;
+        const direction = (this.isDesc) ? "desc" : "asc";
+        return this.propertyPath + " " + direction;
     }
 }

package/src/Query.ts

@@ -1,7 +1,7 @@
-import { QueryBase } from './QueryBase';
-import { WhereQuery } from './WhereQuery';
-import { OrderProperty } from './OrderProperty';
-import { QueryBuilder } from './QueryBuilder';
+import { QueryBase } from "./QueryBase";
+import { WhereQuery } from "./WhereQuery";
+import { OrderProperty } from "./OrderProperty";
+import { QueryBuilder } from "./QueryBuilder";
 
 /**
  * The query class is used for constructing queries.

package/src/QueryBase.ts

@@ -1,4 +1,4 @@
-import { utils } from './utils';
+import { utils } from "./utils";
 
 /**
  * The base class for dealing with queries.
@@ -41,11 +41,11 @@ export class QueryBase {
         for (let i = 0; i < propPaths.length; i++) {
             const member = propPaths[i];
             if (!utils.isString(member)) {
-                throw new Error('Invalid argument in clause');
+                throw new Error("Invalid argument in clause");
             }
 
-            if (!allowNested && member.indexOf('.') > -1) {
-                throw new Error('Invalid argument in clause');
+            if (!allowNested && member.indexOf(".") > -1) {
+                throw new Error("Invalid argument in clause");
             }
         }
     }

package/src/QueryBuilder.ts

@@ -1,7 +1,7 @@
-import { WhereQuery } from './WhereQuery';
-import { ComplexExpression, BinaryExpression } from './Expression';
-import { OrderProperty } from './OrderProperty';
-import { utils } from './utils';
+import { WhereQuery } from "./WhereQuery";
+import { ComplexExpression, BinaryExpression } from "./Expression";
+import { OrderProperty } from "./OrderProperty";
+import { utils } from "./utils";
 import { ODATA_PARAMS, EXPRESSION_TYPE } from "./constants";
 import { Query } from "./Query";
 
@@ -24,12 +24,12 @@ export class QueryBuilder {
 
         const selectClause = this.query.selectProperties;
         if (selectClause instanceof Array) {
-            queryParameters[ODATA_PARAMS.$select] = selectClause.join(', ');
+            queryParameters[ODATA_PARAMS.$select] = selectClause.join(", ");
         }
 
         const expandClause = this.query.expandProperties;
         if (expandClause instanceof Array)
-            queryParameters[ODATA_PARAMS.$expand] = expandClause.join(', ');
+            queryParameters[ODATA_PARAMS.$expand] = expandClause.join(", ");
 
         const orderByClause = this.query.orderProperties;
         if (orderByClause instanceof Array) {
@@ -38,7 +38,7 @@ export class QueryBuilder {
                 if (orderByClause[i] instanceof OrderProperty)
                     order.push(orderByClause[i].getValue());
             }
-            queryParameters[ODATA_PARAMS.$orderby] = order.join(', ');
+            queryParameters[ODATA_PARAMS.$orderby] = order.join(", ");
         }
 
         const take = this.query.takeValue;
@@ -62,10 +62,10 @@ export class QueryBuilder {
 
     private buildComplexExpression(expression: ComplexExpression, parent: string): string {
         if (!(expression instanceof ComplexExpression))
-            throw new Error('Invalid complex expression');
+            throw new Error("Invalid complex expression");
 
         let counter = 0;
-        let result = '';
+        let result = "";
         const subExpressions = expression.getExpressions();
         if (!subExpressions.length) {
             return result;
@@ -79,12 +79,12 @@ export class QueryBuilder {
             else if (currentExp instanceof ComplexExpression) {
                 const complexResult = this.buildComplexExpression(currentExp, expression.type);
                 if (complexResult) {
-                    result += '(' + complexResult + ')';
+                    result += "(" + complexResult + ")";
                 }
             }
 
             if (expression.getType() === EXPRESSION_TYPE.not)
-                result = expression.getType() + ' ' + result;
+                result = expression.getType() + " " + result;
             // TODOSDK: Rethink this!
             if (expression.getType() === EXPRESSION_TYPE.any) {
                 const exprVal = [];
@@ -92,16 +92,16 @@ export class QueryBuilder {
                     if (subExpressions[index].type == EXPRESSION_TYPE.contains || subExpressions[index].type == EXPRESSION_TYPE.startsWith || subExpressions[index].type == EXPRESSION_TYPE.endsWith)
                         exprVal.push(subExpressions[index].type.toLowerCase() + "(x, '" + (subExpressions[index] as BinaryExpression).constant + "')");
                     else
-                        exprVal.push('x ' + subExpressions[index].type.toLowerCase() + ' ' + this.checkType((subExpressions[index] as BinaryExpression).constant));
+                        exprVal.push("x " + subExpressions[index].type.toLowerCase() + " " + this.checkType((subExpressions[index] as BinaryExpression).constant));
                 }
-                result = (currentExp as BinaryExpression).parameter + '/' + expression.getType() + '(x:' + exprVal.join(' ' + parent + ' ') + ')';
+                result = (currentExp as BinaryExpression).parameter + "/" + expression.getType() + "(x:" + exprVal.join(" " + parent + " ") + ")";
             }
 
             counter++;
             if (counter == subExpressions.length)
                 break;
 
-            result += ' ' + expression.getType() + ' ';
+            result += " " + expression.getType() + " ";
         }
 
         return result;
@@ -111,30 +111,30 @@ export class QueryBuilder {
         let result: string = null;
         const type = expression.getType();
         switch (type) {
-            case EXPRESSION_TYPE.eq:
-            case EXPRESSION_TYPE.ne:
-            case EXPRESSION_TYPE.lt:
-            case EXPRESSION_TYPE.le:
-            case EXPRESSION_TYPE.gt:
-            case EXPRESSION_TYPE.ge: {
-                const constant = expression.getConstant();
-                result = `(${expression.getParameter()} ${type} ${this.checkType(constant)})`;
-                break;
-            }
-            case EXPRESSION_TYPE.contains:
-            case EXPRESSION_TYPE.startsWith:
-            case EXPRESSION_TYPE.endsWith: {
-                const expressionParameter = this.applyCaseSensitiveSettings(expression, expression.getParameter());
-                const expressionConstant =  this.checkType(expression.getConstant());
-                const expressionValue = this.applyCaseSensitiveSettings(expression, expressionConstant);
-
-                result = `${type.toLowerCase()}(${expressionParameter}, ${expressionValue})`;
-                break;
-            }
-            default: {
-                const msg = `Unsupported operator ${type}`;
-                throw new Error(msg);
-            }
+        case EXPRESSION_TYPE.eq:
+        case EXPRESSION_TYPE.ne:
+        case EXPRESSION_TYPE.lt:
+        case EXPRESSION_TYPE.le:
+        case EXPRESSION_TYPE.gt:
+        case EXPRESSION_TYPE.ge: {
+            const constant = expression.getConstant();
+            result = `(${expression.getParameter()} ${type} ${this.checkType(constant)})`;
+            break;
+        }
+        case EXPRESSION_TYPE.contains:
+        case EXPRESSION_TYPE.startsWith:
+        case EXPRESSION_TYPE.endsWith: {
+            const expressionParameter = this.applyCaseSensitiveSettings(expression, expression.getParameter());
+            const expressionConstant =  this.checkType(expression.getConstant());
+            const expressionValue = this.applyCaseSensitiveSettings(expression, expressionConstant);
+
+            result = `${type.toLowerCase()}(${expressionParameter}, ${expressionValue})`;
+            break;
+        }
+        default: {
+            const msg = `Unsupported operator ${type}`;
+            throw new Error(msg);
+        }
         }
 
         return result;

package/src/Requests/BatchRequest.ts

@@ -1,6 +1,6 @@
 import { RequestFactory } from "./RequestFactory";
-import { BlobBuilder } from '../BlobBuilder';
-import { utils } from '../utils';
+import { BlobBuilder } from "../BlobBuilder";
+import { utils } from "../utils";
 import { HEADER_NAMES, HTTP_METHODS } from "../constants";
 import { ExecutableRequest } from "./ExecutableRequest";
 import { SDKOptions, Token, TypeOptions } from "../Sitefinity";
@@ -77,13 +77,13 @@ export class Transaction {
         const options: PostRequestOptionsExtended = {
             urlOptions: urlOptions,
             key: parameters.key,
-            action: 'operation',
+            action: "operation",
             data: parameters.data
         };
 
         const request = this.factory.create(options);
 
-        this.overrideUrlGeneration(request, parameters.key, 'operation', options.urlOptions, options.query);
+        this.overrideUrlGeneration(request, parameters.key, "operation", options.urlOptions, options.query);
         this.addRequest(request);
     }
 
@@ -147,7 +147,7 @@ export class Transaction {
 
         const request = this.factory.destroyRelated(options);
 
-        const propertyURL = (request as any).property + '/$ref';
+        const propertyURL = (request as any).property + "/$ref";
         this.overrideUrlGeneration(request, parameters.key, propertyURL, options.urlOptions, options.query);
 
         this.addRequest(request);
@@ -191,8 +191,8 @@ export class Transaction {
         }
 
         const data = {
-            '@odata.id': parameters.link
-        }
+            "@odata.id": parameters.link
+        };
 
         const options: RelatedRequestOptionsExtended = {
             urlOptions: urlOptions,
@@ -202,7 +202,7 @@ export class Transaction {
         };
 
         const request = this.factory.createRelated(options);
-        const propertyURL = (request as any).property + '/$ref';
+        const propertyURL = (request as any).property + "/$ref";
         this.overrideUrlGeneration(request, parameters.key, propertyURL, options.urlOptions, options.query);
 
         return this.addRequest(request);
@@ -216,7 +216,7 @@ export class Transaction {
                 request.buildUrl = function () {
                     let uri = "$" + key;
                     if (additionalPropertyURL !== undefined) {
-                        uri = uri + '/' + additionalPropertyURL;
+                        uri = uri + "/" + additionalPropertyURL;
                     }
 
                     if (urlOptions) {
@@ -227,7 +227,7 @@ export class Transaction {
                     }
 
                     return uri;
-                }
+                };
             }
         }
     }
@@ -258,7 +258,7 @@ export class BatchRequest extends ExecutableRequest {
 
 
     public static constants = {
-        newLine: '\r\n'
+        newLine: "\r\n"
     };
 
     constructor(requestOptions: BatchRequestOptionsExtended, token: Token, sdkOptions: SDKOptions) {
@@ -415,7 +415,7 @@ export class BatchRequest extends ExecutableRequest {
         const queryString = this.getQueryString(this.urlOptions, this.query);
 
         if (queryString) {
-            url += queryString
+            url += queryString;
         }
 
         return url;
@@ -470,7 +470,7 @@ export class BatchRequest extends ExecutableRequest {
                 const responseCheck = function (r) {
                     let success = true;
                     if (r.data && r.data.hasOwnProperty("Success")) {
-                        success = r.data.Success
+                        success = r.data.Success;
                     }
 
                     return success;
@@ -582,10 +582,10 @@ export class BatchRequest extends ExecutableRequest {
         let i, len;
         for (i = 1, len = contentTypeParts.length; i < len; i++) {
             const contentTypeParams = contentTypeParts[i].split("=");
-            properties[contentTypeParams[0].replace(/^\s+|\s+$/g, '')] = contentTypeParams[1];
+            properties[contentTypeParams[0].replace(/^\s+|\s+$/g, "")] = contentTypeParams[1];
         }
 
-        return { mediaType: contentTypeParts[0].replace(/^\s+|\s+$/g, ''), properties: properties };
+        return { mediaType: contentTypeParts[0].replace(/^\s+|\s+$/g, ""), properties: properties };
     }
 
     private readTo(text, str, context) {
@@ -657,7 +657,7 @@ export class BatchRequest extends ExecutableRequest {
 
     private buildRequestBody() {
         const builder = new BlobBuilder();
-        builder.append('');
+        builder.append("");
 
         for (let index = 0; index < this.requests.length; index += 1) {
 
@@ -681,12 +681,12 @@ export class BatchRequest extends ExecutableRequest {
 
     private buildRequest(request: RequestBase): Blob {
         const builder = new BlobBuilder();
-        builder.append(BatchRequest.constants.newLine + 'Content-Type: application/http' +
-                    BatchRequest.constants.newLine + 'Content-Transfer-Encoding: binary' +
+        builder.append(BatchRequest.constants.newLine + "Content-Type: application/http" +
+                    BatchRequest.constants.newLine + "Content-Transfer-Encoding: binary" +
                     BatchRequest.constants.newLine +
                     BatchRequest.constants.newLine +
                     request.getMethod() +
-                    ' ' + request.buildUrl() + ' HTTP/1.1');
+                    " " + request.buildUrl() + " HTTP/1.1");
 
         return builder.build();
     }
@@ -699,7 +699,7 @@ export class BatchRequest extends ExecutableRequest {
         builder.append(BatchRequest.constants.newLine);
 
         const changeset = this.createBoundary("sf_changeset_");
-        builder.append('Content-Type: multipart/mixed; boundary=' + changeset);
+        builder.append("Content-Type: multipart/mixed; boundary=" + changeset);
 
         const changesetRequests = transaction.requests;
         for (let index = 0; index < changesetRequests.length; index += 1) {
@@ -708,12 +708,12 @@ export class BatchRequest extends ExecutableRequest {
             // we shouldn't add new lines after blob content. Otherwise they are added to the blob and corrupt it
             const shouldAddNewLine = index === 0 || !utils.isBlob(changesetRequests[index - 1].request.getBody());
             builder.append(this.createDelimeter(changeset, false, shouldAddNewLine) +
-                        BatchRequest.constants.newLine + 'Content-Type: application/http' +
-                        BatchRequest.constants.newLine + 'Content-Transfer-Encoding: binary' +
-                        BatchRequest.constants.newLine + 'Content-ID: ' + changesetRequests[index].id);
+                        BatchRequest.constants.newLine + "Content-Type: application/http" +
+                        BatchRequest.constants.newLine + "Content-Transfer-Encoding: binary" +
+                        BatchRequest.constants.newLine + "Content-ID: " + changesetRequests[index].id);
 
             const requestUrl = currentRequest.buildUrl();
-            builder.append(BatchRequest.constants.newLine + BatchRequest.constants.newLine + currentRequest.getMethod() + ' ' + requestUrl + ' HTTP/1.1');
+            builder.append(BatchRequest.constants.newLine + BatchRequest.constants.newLine + currentRequest.getMethod() + " " + requestUrl + " HTTP/1.1");
 
             const headers = currentRequest.getHeaders();
             const headerNames = Object.keys(headers);
@@ -749,7 +749,7 @@ export class BatchRequest extends ExecutableRequest {
     }
 
     private createBoundary(prefix) {
-        return prefix + utils.hex16() + '-' + utils.hex16() + '-' + utils.hex16();
+        return prefix + utils.hex16() + "-" + utils.hex16() + "-" + utils.hex16();
     }
 
     private addRequest(request: RequestBase) {