@progress/sitefinity-webservices-sdk 1.1.15 → 2.0.0

package/src/Requests/ExecutableRequest.ts

@@ -1,117 +0,0 @@
-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;
-
-    constructor(requestOptions: RequestOptionsBaseExtended, token: Token, sdkOptions: SDKOptions) {
-        super(requestOptions);
-        this.token = token;
-        this.successCb = this.successCb || sdkOptions.handlers?.successCb;
-        this.failureCb = this.failureCb || sdkOptions.handlers?.failureCb;
-        this.enableUnlimitedChoices = sdkOptions.enableUnlimitedChoices;
-        this.integrationMode = sdkOptions.integrationMode;
-    }
-
-    execute() {
-        this.http = new XMLHttpRequest();
-
-        this.http.onreadystatechange = () => {
-            if (this.http.readyState === XMLHttpRequestDone) {
-                if (this.http.status > 0) {
-                    let data = this.parseResponse(this.http);
-
-                    if (this.http.status >= 200 && this.http.status <= 206) {
-                        if (this.successCb && utils.isFunction(this.successCb)) {
-                            this.successCb(data);
-                        }
-                    }
-                    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)) {
-                            data = {
-                                message: data
-                            };
-                        }
-
-                        data.status = this.http.status;
-
-                        // in case of errors we would like there to be one handler for all of the errors
-                        if (this.failureCb && utils.isFunction(this.failureCb)) {
-                            this.failureCb(data);
-                        }
-                    }
-                }
-            }
-        };
-
-
-        this.executeProgressEvent();
-
-        const method = this.getMethod();
-        const url = this.buildUrl();
-        this.http.open(method, url, true);
-        this.setHeaders(this.http, this.getHeaders());
-
-        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 }) {
-        const headerKeys = Object.keys(headers);
-        for (let i = 0; i < headerKeys.length; i++) {
-            const currentHeaderName = headerKeys[i];
-            http.setRequestHeader(currentHeaderName, headers[currentHeaderName]);
-        }
-
-        if (this.token) {
-            if (typeof this.token === "string") {
-                // for backward compatibility
-                http.setRequestHeader(HEADER_NAMES.authorization, this.token);
-            } else {
-                http.setRequestHeader(HEADER_NAMES.authorization, this.token.type + " " + this.token.value);
-            }
-        }
-
-        if (this.enableUnlimitedChoices) {
-            http.setRequestHeader(HEADER_NAMES.choicesBinaryRepresentation, "true");
-        }
-
-        if (this.integrationMode) {
-            http.setRequestHeader(HEADER_NAMES.integrationMode, "true");
-        }
-
-        // for backward compatibility
-        http.setRequestHeader(HEADER_NAMES.serviceRequest, "true");
-    }
-}
-
-export interface ResponseHandlers {
-    /**
-    * The success handler.
-    */
-    successCb?: Function;
-
-    /**
-    * The failure handler.
-    */
-    failureCb?: Function;
-}

package/src/Requests/Request.ts

@@ -1,327 +0,0 @@
-import { HEADER_NAMES, HTTP_METHODS } from "../constants";
-import { SDKOptions, Token } from "../Sitefinity";
-import { utils } from "../utils";
-import { ExecutableRequest } from "./ExecutableRequest";
-import { RequestOptionsBaseExtended } from "./RequestBase";
-
-export class GetRequest extends ExecutableRequest {
-    constructor(requestOptions: RequestOptionsBaseExtended, token: Token, sdkOptions: SDKOptions) {
-        super(requestOptions, token, sdkOptions);
-    }
-
-    getMethod(): string {
-        return HTTP_METHODS.get;
-    }
-}
-
-export class GetByIdRequest extends ExecutableRequest {
-    constructor(requestOptions: RequestOptionsBaseExtended, token: Token, sdkOptions: SDKOptions) {
-        super(requestOptions, token, sdkOptions);
-    }
-
-    getMethod(): string {
-        return HTTP_METHODS.get;
-    }
-}
-
-export class DeleteRequest extends ExecutableRequest {
-    constructor(requestOptions: RequestOptionsBaseExtended, token: Token, sdkOptions: SDKOptions) {
-        super(requestOptions, token, sdkOptions);
-    }
-
-    getMethod(): string {
-        return HTTP_METHODS.delete;
-    }
-}
-
-export class UpdateRequest extends ExecutableRequest {
-    private data: object;
-    private saveTemp: boolean;
-
-    constructor(requestOptions: PutRequestOptionsExtended, token: Token, sdkOptions: SDKOptions) {
-        super(requestOptions, token, sdkOptions);
-        this.data = requestOptions.data;
-        this.saveTemp = requestOptions.saveTemp;
-    }
-
-    getMethod(): string {
-        return HTTP_METHODS.patch;
-    }
-
-    getBody(): object {
-        const body = utils.convertDateFieldToISOString(this.data);
-        return body;
-    }
-
-    getHeaders(): { [key: string]: string } {
-        const headers = super.getHeaders();
-        if (this.saveTemp) {
-            headers[HEADER_NAMES.operation] = "SaveTemp";
-        }
-
-        return headers;
-    }
-}
-
-export class CreateRequest extends ExecutableRequest {
-    protected data: object;
-
-    constructor(requestOptions: PostRequestOptionsExtended, token: Token, sdkOptions: SDKOptions) {
-        super(requestOptions, token, sdkOptions);
-        this.data = requestOptions.data;
-    }
-
-    getMethod(): string {
-        return HTTP_METHODS.post;
-    }
-
-    getBody(): object {
-        if (!(this.data instanceof File)) {
-            return utils.convertDateFieldToISOString(this.data);
-        }
-
-        return this.data;
-    }
-}
-
-export class GetRelatedRequest extends GetByIdRequest {
-    private property: string;
-
-    constructor(requestOptions: RelatedRequestOptionsExtended, token: Token, sdkOptions: SDKOptions) {
-        super(requestOptions, token, sdkOptions);
-        this.property = requestOptions.property;
-    }
-
-    buildUrl(): string {
-        const url = this.urlOptions.baseUrl + this.urlOptions.entitySet + "(" + this.key + ")/" + this.property;
-        return this.addQueryParameters(url);
-    }
-}
-
-export class GetRelatedByIdRequest extends GetByIdRequest {
-    private property: string;
-    private relatedId: string;
-
-    constructor(requestOptions: RelatedByIdRequestOptionsExtended, token: Token, sdkOptions: SDKOptions) {
-        super(requestOptions, token, sdkOptions);
-        this.property = requestOptions.property;
-        this.relatedId = requestOptions.relatedId;
-    }
-
-    buildUrl(): string {
-        const url = this.urlOptions.baseUrl + this.urlOptions.entitySet + "(" + this.key + ")/" + this.property + "(" + this.relatedId + ")";
-        return this.addQueryParameters(url);
-    }
-}
-
-export class DeleteRelatedRequest extends DeleteRequest {
-    private property: string;
-
-    constructor(requestOptions: RelatedRequestOptionsExtended, token: Token, sdkOptions: SDKOptions) {
-        super(requestOptions, token, sdkOptions);
-        this.property = requestOptions.property;
-    }
-
-    buildUrl(): string {
-        const url = this.urlOptions.baseUrl + this.urlOptions.entitySet + "(" + this.key + ")/" + this.property + "/$ref";
-        return this.addQueryParameters(url);
-    }
-}
-
-export class DeleteRelatedByIdRequest extends DeleteRequest {
-    private property: string;
-    private relatedId: string;
-
-    constructor(requestOptions: RelatedByIdRequestOptionsExtended, token: Token, sdkOptions: SDKOptions) {
-        super(requestOptions, token, sdkOptions);
-        this.property = requestOptions.property;
-        this.relatedId = requestOptions.relatedId;
-    }
-
-    buildUrl(): string {
-        const url = this.urlOptions.baseUrl + this.urlOptions.entitySet + "(" + this.key + ")/" + this.property + "(" + this.relatedId + ")/$ref";
-        return this.addQueryParameters(url);
-    }
-}
-
-export class CreateRelatedRequest extends CreateRequest {
-    private property: string;
-
-    constructor(requestOptions: RelatedRequestOptionsExtended, token: Token, sdkOptions: SDKOptions) {
-        super(requestOptions, token, sdkOptions);
-        this.property = requestOptions.property;
-        this.key = requestOptions.key;
-    }
-
-    buildUrl(): string {
-        const url = this.urlOptions.baseUrl + this.urlOptions.entitySet + "(" + this.key + ")/" + this.property + "/$ref";
-        return this.addQueryParameters(url);
-    }
-}
-
-export class UploadRequest extends CreateRequest {
-    private fileName: string;
-    private uploadProperties: { [key: string]: string };
-    private contentType: string;
-
-    constructor(requestOptions: UploadRequestOptionsExtended, token: Token, sdkOptions: SDKOptions) {
-        super(requestOptions, token, sdkOptions);
-        this.fileName = requestOptions.fileName;
-        this.uploadProperties = requestOptions.uploadProperties;
-        this.contentType = requestOptions.contentType;
-    }
-
-    getHeaders(): { [key: string]: string } {
-        const headers = super.getHeaders();
-        headers[HEADER_NAMES.contentType] = this.contentType || "application/octet-stream";
-        headers[HEADER_NAMES.fileName] = this.fileName;
-        headers[HEADER_NAMES.properties] = JSON.stringify(this.uploadProperties);
-        headers[HEADER_NAMES.contentEncoding] = "identity";
-        return headers;
-    }
-
-    getBody(): object {
-        return this.data;
-    }
-
-    getMethod(): string {
-        if (this.key) {
-            return HTTP_METHODS.patch;
-        }
-
-        return HTTP_METHODS.post;
-    }
-}
-
-export class UploadChunkRequest extends CreateRequest {
-    contentType: string;
-    chunkOrdinal: number;
-    chunkSize: number;
-    chunkedFileUploadSessionId: string;
-    numberOfChunks: number;
-    positionInQueue: number;
-    blobStorageProviderName: string;
-    fileName: 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;
-        this.fileName = requestOptions.fileName;
-    }
-
-    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();
-        headers[HEADER_NAMES.fileName] = this.fileName;
-
-        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;
-}
-
-export interface PutRequestOptionsExtended extends PostRequestOptionsExtended {
-    saveTemp: boolean;
-}
-
-export interface RelatedRequestOptionsExtended extends PostRequestOptionsExtended {
-    property: string;
-}
-
-export interface RelatedByIdRequestOptionsExtended extends RelatedRequestOptionsExtended {
-    relatedId: string;
-}
-
-export interface UploadRequestOptionsExtended extends PostRequestOptionsExtended {
-    fileName: string;
-    contentType: string;
-    uploadProperties: { [key: string]: string };
-}
-
-export interface UploadChunkRequestOptionsExtended extends PostRequestOptionsExtended {
-    fileMimeType: string;
-    fileName: 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

@@ -1,163 +0,0 @@
-import { CONTENT_TYPES, HEADER_NAMES, ODATA_PARAMS, SF_PARAMS } from "../constants";
-import { RequestOptionsBase } from "../Data";
-import { Query } from "../Query";
-import { TypeOptions } from "../Sitefinity";
-import { utils } from "../utils";
-
-export class RequestBase {
-    public successCb: Function;
-    public failureCb: Function;
-    public progressCb: Function;
-    public key: string | number;
-    public urlOptions: TypeOptions;
-    protected query: Query;
-    protected action: string;
-    private fallbackProperties: string[];
-
-    constructor(options: RequestOptionsBaseExtended) {
-        this.successCb = options.successCb;
-        this.failureCb = options.failureCb;
-        this.progressCb = options.progressCb;
-        this.urlOptions = options.urlOptions;
-        this.key = options.key;
-        this.action = options.action;
-        this.fallbackProperties = options.fallbackProperties;
-        this.query = options.query;
-    }
-
-    getQueryString(urlOptions: TypeOptions, query: Query): string {
-        const paramDictionary: { [key: string]: string } = {};
-
-        this.getQueryParameters(paramDictionary, urlOptions, query);
-        const keys = Object.keys(paramDictionary);
-        if (keys.length == 0)
-            return null;
-
-        let queryString = "?";
-        for (const prop in paramDictionary) {
-            queryString += prop + "=" + paramDictionary[prop] + "&";
-        }
-
-        queryString = queryString.substring(0, queryString.length - 1);
-
-        return queryString;
-    }
-
-    getBody(): object {
-        return undefined;
-    }
-
-    getMethod(): string {
-        return null;
-    }
-
-    getHeaders(): { [key: string]: string } {
-        const headers = this.urlOptions.additionalHeaders ?? {};
-        if (headers[HEADER_NAMES.contentType] == undefined) {
-            headers[HEADER_NAMES.contentType] = CONTENT_TYPES.json;
-        }
-
-        return headers;
-    }
-
-    buildUrl(): string {
-        let url = this.urlOptions.baseUrl + (this.urlOptions.entitySet || "");
-        url += this.key ? ("(" + this.key + ")") : "";
-        if (this.action) {
-            url += url.endsWith("/") ? "" : "/";
-            url += this.action;
-        }
-
-        // including count here
-        // not the best solution as build() is called once more in getQueryString
-        // but not that big of an issue right now
-        if (this.query) {
-            const getCount = this.query.build().$count;
-
-            if (utils.isBoolean(getCount) && !getCount) {
-                url += "/$count";
-            }
-        }
-
-        return this.addQueryParameters(url);
-    }
-
-    protected parseResponse(http: XMLHttpRequest): string | any {
-        const data = utils.parseStringToJson(http.responseText);
-        if (data) {
-            if (http.status >= 400 && data.error) {
-                return data.error;
-            }
-
-            return data;
-        }
-
-        return http.responseText;
-    }
-
-    protected addQueryParameters(url: string): string {
-        let queryString = this.getQueryString(this.urlOptions, this.query);
-
-        if (queryString) {
-            if (url.indexOf("?") > -1 && queryString[0] == "?") {
-                queryString = "&" + queryString.substring(1);
-            }
-
-            url += queryString;
-        }
-
-        return url;
-    }
-
-    private getQueryParameters(paramDictionary: { [key: string]: string }, urlOptions: TypeOptions, query: Query) {
-        if (query) {
-            const builtQuery = query.build();
-            if (utils.isString(builtQuery.$filter))
-                paramDictionary[ODATA_PARAMS.$filter] = builtQuery.$filter;
-            if (utils.isString(builtQuery.$select))
-                paramDictionary[ODATA_PARAMS.$select] = builtQuery.$select;
-            if (utils.isString(builtQuery.$expand))
-                paramDictionary[ODATA_PARAMS.$expand] = builtQuery.$expand;
-            if (utils.isString(builtQuery.$orderby))
-                paramDictionary[ODATA_PARAMS.$orderby] = builtQuery.$orderby;
-            if (utils.isNumber(builtQuery.$skip))
-                paramDictionary[ODATA_PARAMS.$skip] = builtQuery.$skip;
-            if (utils.isNumber(builtQuery.$top))
-                paramDictionary[ODATA_PARAMS.$top] = builtQuery.$top;
-            if (utils.isString(builtQuery.$search))
-                paramDictionary[ODATA_PARAMS.$search] = builtQuery.$search;
-
-            // inline count
-            if (utils.isBoolean(builtQuery.$count) && builtQuery.$count)
-                paramDictionary[ODATA_PARAMS.$count] = builtQuery.$count;
-        }
-
-        if (urlOptions.provider) {
-            paramDictionary[SF_PARAMS.provider] = urlOptions.provider;
-        }
-
-        if (urlOptions.culture) {
-            paramDictionary[SF_PARAMS.culture] = urlOptions.culture;
-        }
-
-        if (urlOptions.siteId) {
-            paramDictionary[SF_PARAMS.siteId] = urlOptions.siteId;
-        }
-
-        if (this.fallbackProperties) {
-            paramDictionary[SF_PARAMS.fallbackParams] = this.fallbackProperties.join();
-        }
-
-        if (urlOptions.additionalQueryParams) {
-            for (const key in urlOptions.additionalQueryParams) {
-                if (urlOptions.additionalQueryParams.hasOwnProperty(key)) {
-                    paramDictionary[key] = urlOptions.additionalQueryParams[key];
-                }
-            }
-        }
-    }
-}
-
-export interface RequestOptionsBaseExtended extends RequestOptionsBase {
-    urlOptions: TypeOptions;
-}

package/src/Requests/RequestFactory.ts

@@ -1,75 +0,0 @@
-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";
-
-export class RequestFactory {
-    public token: Token;
-    private options: SDKOptions;
-
-    constructor(options: SDKOptions) {
-        this.options = options;
-    }
-
-    get(parameters: RequestOptionsBaseExtended) {
-        return new GetRequest(parameters, this.token, this.options);
-    }
-
-    getSingle(parameters: RequestOptionsBaseExtended) {
-        return new GetByIdRequest(parameters, this.token, this.options);
-    }
-
-    create(parameters: PostRequestOptionsExtended) {
-        return new CreateRequest(parameters, this.token, this.options);
-    }
-
-    update(parameters: PutRequestOptionsExtended) {
-        return new UpdateRequest(parameters, this.token, this.options);
-    }
-
-    destroy(parameters: RequestOptionsBaseExtended) {
-        return new DeleteRequest(parameters, this.token, this.options);
-    }
-
-    getProperty(parameters: RelatedRequestOptionsExtended) {
-        return new GetRelatedRequest(parameters, this.token, this.options);
-    }
-
-    getRelated(parameters: RelatedRequestOptionsExtended) {
-        return new GetRelatedRequest(parameters, this.token, this.options);
-    }
-
-    getRelatedById(parameters: RelatedByIdRequestOptionsExtended) {
-        return new GetRelatedByIdRequest(parameters, this.token, this.options);
-    }
-
-    destroyRelated(parameters: RelatedRequestOptionsExtended) {
-        return new DeleteRelatedRequest(parameters, this.token, this.options);
-    }
-
-    destroyRelatedById(parameters: RelatedByIdRequestOptionsExtended) {
-        return new DeleteRelatedByIdRequest(parameters, this.token, this.options);
-    }
-
-    createRelated(parameters: RelatedRequestOptionsExtended) {
-        return new CreateRelatedRequest(parameters, this.token, this.options);
-    }
-
-    upload(parameters: UploadRequestOptionsExtended) {
-        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;
-        return new BatchRequest(batchParams, this.token, this.options);
-    }
-}