@progress/sitefinity-webservices-sdk 1.0.4 → 1.1.3

package/dist/src/chunk-upload/chunk-upload.sdk.d.ts

@@ -0,0 +1,290 @@
+import { CreateRequestOptions } from "../Data";
+import { RequestFactory } from "../Requests/RequestFactory";
+import { TypeOptions } from "../Sitefinity";
+import { ChunkFileResult } from "./chunked-file-upload.utilities";
+/**
+ * @description Entry point for all chunk upload related tasks
+ * @export
+ * @class ChunkUploadSdk
+ */
+export declare class ChunkUploadSdk {
+    private urlOptions;
+    private factory;
+    constructor(urlOptions: TypeOptions, factory: RequestFactory);
+    /**
+     * @description Gets the needed information to start uploading chunks to the server
+     * @param {GetChunkUploadInfoRequestOptions} parameters
+     * @memberof ChunkUploadSdk
+     */
+    getChunkUploadInfo(parameters: GetChunkUploadInfoRequestOptions): void;
+    /**
+     * @description Sends a single chunk request to the server
+     * @param {UploadChunkRequestOptions} parameters
+     * @memberof ChunkUploadSdk
+     */
+    uploadChunk(parameters: UploadChunkRequestOptions): void;
+    /**
+     * @description Sends the commit chunks request to the server
+     * @param {CommitChunksRequestOptions} parameters
+     * @memberof ChunkUploadSdk
+     */
+    commitChunks(parameters: CommitChunksRequestOptions): void;
+    /**
+     * @description This request is intended to be used when something in the chunk upload process fails to delete the sent chunks
+     * @param {CleanUpChunksRequestOptions} parameters
+     * @memberof ChunkUploadSdk
+     */
+    cleanUpChunks(parameters: CleanUpChunksRequestOptions): void;
+    /**
+     * Chunks the provided file. If the file is a base64 string this method will convert it to a blob and then chunk it.
+     *
+     * @param {(Blob | string)} file
+     * @param {number} chunkSize
+     * @param {string} contentTypeMime
+     * @return {*} {ChunkFileResult}
+     * @memberof ChunkUploadService
+     */
+    chunkFile(file: Blob | string, chunkSize: number, contentTypeMime: string): ChunkFileResult;
+}
+/**
+ * @description This interface shows the minimum data needed to create a single chunk upload request
+ * @export
+ * @interface UploadChunkRequestOptions
+ * @extends {CreateRequestOptions}
+ */
+export interface UploadChunkRequestOptions extends CreateRequestOptions {
+    /**
+     * @description the data needed to construct the request
+     * @type {{
+     *         fileMimeType: string;
+     *         chunkedFileUploadSessionId: string;
+     *         chunkSize: number;
+     *         chunkOrdinal: number;
+     *         numberOfChunks: number;
+     *         positionOfChunkInQueue?: number;
+     *         chunkBlob: Blob;
+     *         blobStorageProviderName: string;
+     *     }}
+     * @memberof UploadChunkRequestOptions
+     */
+    data: {
+        /**
+         * @description the file's mime type
+         * @type {string}
+         */
+        fileMimeType: string;
+        /**
+         * @description the current chunk upload session Id
+         * @type {string}
+         */
+        chunkedFileUploadSessionId: string;
+        /**
+         * @description the chunk size in bytes
+         * @type {number}
+         */
+        chunkSize: number;
+        /**
+         * @description the chunk's ordinal
+         * @type {number}
+         */
+        chunkOrdinal: number;
+        /**
+         * @description the total number of chunks
+         * @type {number}
+         */
+        numberOfChunks: number;
+        /**
+         * @description Optional. The position of the chunk in the request queue, this property is used to calculate the progress of the upload
+         * @type {number}
+         */
+        positionOfChunkInQueue?: number;
+        /**
+         * @description The chunk data
+         * @type {Blob}
+         */
+        chunkBlob: Blob;
+        /**
+         * @description the target blob storage provider's name
+         * @type {string}
+         */
+        blobStorageProviderName: string;
+    };
+}
+/**
+ * @description This interface shows the minimum data needed to create a commit chunks request
+ * @export
+ * @interface CommitChunksRequestOptions
+ * @extends {CreateRequestOptions}
+ */
+export interface CommitChunksRequestOptions extends CreateRequestOptions {
+    /**
+     * @description the data needed to construct the request
+     * @type {{
+     *         chunkedFileUploadSessionId: string;
+     *         contentType: string;
+     *         fileTotalSize: number;
+     *         numberOfChunks: number;
+     *         name: string;
+     *         blobStorageProviderName: string;
+     *         uploadProperties: { [key: string]: string };
+     *         itemId?: string;
+     *     }}
+     * @memberof CommitChunksRequestOptions
+     */
+    data: {
+        /**
+         * @description the current chunk upload session Id
+         * @type {string}
+         */
+        chunkedFileUploadSessionId: string;
+        /**
+         * @description the file's mime type
+         * @type {string}
+         */
+        contentType: string;
+        /**
+         * @description the total size of the file
+         * @type {number}
+         */
+        fileTotalSize: number;
+        /**
+         * @description the total number of chunks
+         * @type {number}
+         */
+        numberOfChunks: number;
+        /**
+         * @description the file's name
+         * @type {string}
+         */
+        name: string;
+        /**
+         * @description the target blob storage provider's name
+         * @type {string}
+         */
+        blobStorageProviderName: string;
+        /**
+         * @description the properties of the uploaded file like the Title, UrlName, etc
+         * @type {{ [key: string]: string }}
+         */
+        uploadProperties: {
+            [key: string]: string;
+        };
+        /**
+         * @description Optional. Used when updating a media item, can be null when used to create a new media file.
+         * @type {string}
+         */
+        itemId?: string;
+    };
+}
+/**
+ * @description This interface shows the minimum data needed to create request to get the chunk upload information for the current library from the server
+ * @export
+ * @interface GetChunkUploadInfoRequestOptions
+ * @extends {CreateRequestOptions}
+ */
+export interface GetChunkUploadInfoRequestOptions extends CreateRequestOptions {
+    /**
+     * @description the data needed to construct the request
+     * @type {{
+     *         libraryId: string;
+     *     }}
+     * @memberof GetChunkUploadInfoRequestOptions
+     */
+    data: {
+        /**
+         * @description the parent library (not folder) in which the file will be uploaded to
+         * @type {string}
+         */
+        libraryId: string;
+    };
+}
+/**
+ * @description This interface show the minimum data needed to create a request to delete all chunk from a chunk upload session
+ * @export
+ * @interface CleanUpChunksRequestOptions
+ * @extends {CreateRequestOptions}
+ */
+export interface CleanUpChunksRequestOptions extends CreateRequestOptions {
+    /**
+     * @description the data needed to construct the request
+     * @type {{
+     *         chunkedFileUploadSessionId: string;
+     *         blobStorageProviderName: string;
+     *     }}
+     * @memberof CleanUpChunksRequestOptions
+     */
+    data: {
+        /**
+         * @description the current chunk upload session Id
+         * @type {string}
+         */
+        chunkedFileUploadSessionId: string;
+        /**
+         * @description the target blob storage provider's name
+         * @type {string}
+         */
+        blobStorageProviderName: string;
+    };
+}
+/**
+ * @description This is a data transfer object that shows the information provided by the getChunkUploadInfo request
+ * @export
+ * @interface ChunkUploadInfoDTO
+ */
+export interface ChunkUploadInfoDTO {
+    /**
+     * @description shows wether the current blob storage provider supports uploading in chunks
+     * @type {boolean}
+     * @memberof ChunkUploadInfoDTO
+     */
+    ProviderSupportsChunkUpload: boolean;
+    /**
+     * @description the target blob storage provider's name
+     * @type {string}
+     * @memberof ChunkUploadInfoDTO
+     */
+    BlobStorageProviderName: string;
+    /**
+     * @description the current chunk upload session Id
+     * @type {string}
+     * @memberof ChunkUploadInfoDTO
+     */
+    ChunkedFileUploadSessionId: string;
+    /**
+     * @description the chunk size in bytes
+     * @type {number}
+     * @memberof ChunkUploadInfoDTO
+     */
+    ChunkSize: number;
+    /**
+     * @description the maximum amount of time a chunk should be retired
+     * @type {number}
+     * @memberof ChunkUploadInfoDTO
+     */
+    MaxRetryCountForChunk: number;
+    /**
+     * @description the maximum simultaneous requests that should be sent to the server
+     * @type {number}
+     * @memberof ChunkUploadInfoDTO
+     */
+    MaxSimultaneousChunkUploadRequestsPerSession: number;
+}
+/**
+ * @description A DTO containing the data that the server responds with when a chunk is uploaded
+ * @export
+ * @interface ChunkUploadResult
+ */
+export interface ChunkUploadResult {
+    /**
+     * @description indicates whether the chunk has been successfully uploaded
+     * @type {boolean}
+     * @memberof ChunkUploadResult
+     */
+    SuccessfullyUploaded: boolean;
+    /**
+     * @description the current chunk upload session Id
+     * @type {string}
+     * @memberof ChunkUploadResult
+     */
+    ChunkedFileUploadSessionId: string;
+}

package/dist/src/chunk-upload/chunk-upload.sdk.spec.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/src/chunk-upload/chunked-file-upload.utilities.d.ts

@@ -0,0 +1,13 @@
+export declare class ChunkedFileUploadUtilities {
+    chunkFile(file: Blob | string, chunkSize: number, contentTypeMime: string): ChunkFileResult;
+    private base64ToBlob;
+}
+export interface FileUploadChunk {
+    ordinal: number;
+    content: Blob;
+}
+export interface ChunkFileResult {
+    chunks: Array<FileUploadChunk>;
+    totalChunksCount: number;
+    fileTotalSize: number;
+}

package/dist/src/constants.d.ts

@@ -42,6 +42,11 @@ export declare const HEADER_NAMES: {
     serviceRequest: string;
     choicesBinaryRepresentation: string;
     integrationMode: string;
+    chunkOrdinal: string;
+    chunkSize: string;
+    fileSize: string;
+    chunkedFileUploadSessionId: string;
+    blobStorageProviderName: string;
 };
 export declare const HTTP_METHODS: {
     get: string;

package/package.json

@@ -1,39 +1,41 @@
 {
   "name": "@progress/sitefinity-webservices-sdk",
-  "version": "1.0.4",
+  "version": "1.1.3",
   "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.1",
     "@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.13.0",
+    "@typescript-eslint/eslint-plugin": "5.51.0",
+    "@typescript-eslint/parser": "5.51.0",
+    "eslint": "8.33.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.1",
+    "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.4.2",
+    "ts-node": "10.9.1",
+    "typedoc": "0.23.24",
+    "typescript": "4.8.2",
+    "webpack": "5.75.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");
             }
         }
     }