@progress/sitefinity-webservices-sdk 1.1.16 → 2.0.0

package/src/Requests/request.spec.ts

@@ -1,154 +0,0 @@
-import { Query } from "../Query";
-import { Sitefinity } from "../Sitefinity";
-import { UploadRequest } from "./Request";
-
-describe("SDK basic tests", () => {
-    const baseUrl = "http://www.mysite.com/api/default/";
-    let sitefinity: Sitefinity;
-    let query: Query;
-
-    beforeEach(function () {
-        jasmine.Ajax.install();
-    });
-
-    afterEach(function () {
-        jasmine.Ajax.uninstall();
-    });
-
-    beforeAll(() => {
-        sitefinity = new Sitefinity({
-            baseUrl
-        });
-
-        query = new Sitefinity.Query();
-    });
-
-    it("query assert", () => {
-        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 resultingQuery = testQuery.build();
-        expect(resultingQuery.$filter).toEqual("(not endswith(Record, 'Title')) and ((not (Content eq 'test')))");
-    });
-
-    it("query count assert", () => {
-        const data = sitefinity.data({
-            entitySet: "newsitems"
-        });
-
-        data.get({ query: query.count(false) });
-
-        let request = jasmine.Ajax.requests.mostRecent();
-        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");
-    });
-
-    it("request assert", () => {
-        sitefinity.data({
-            entitySet: "newsitems",
-            provider: "newsProvider",
-            culture: "en-US"
-        }).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.data()).toEqual({});
-    });
-
-    it("batch assert", async () => {
-        const batch = sitefinity.batch();
-        const getQuery = query.where().eq("Title", "newTitleN11").done();
-
-        batch.get({
-            entitySet: "newsitems",
-            query: getQuery
-        });
-
-        const transaction = batch.beginTransaction();
-
-        transaction.create({
-            entitySet: "newsitems",
-            data: { title: "Test" }
-        });
-
-        batch.endTransaction(transaction);
-        (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");
-
-        await readBlobAsText(request.params).then((result) => {
-            expect(result).toContain("{\"title\":\"Test\"}");
-        });
-    });
-
-    it("query assert string values", () => {
-        const testQuery = (query.where().and()
-            .endsWith("Title", "9f024c1c-9e6f-483e-a8a6-d962b93956ea").done() as any)
-            .or().startsWith("Title", "9f024c1c-9e6f-483e-a8a6-d962b93956ea")
-            .or().contains("Title", "9f024c1c-9e6f-483e-a8a6-d962b93956ea")
-            .done().done().done();
-
-        const resultingQuery = testQuery.build();
-        expect(resultingQuery.$filter).toEqual("(endswith(Title, '9f024c1c-9e6f-483e-a8a6-d962b93956ea')) and (startswith(Title, '9f024c1c-9e6f-483e-a8a6-d962b93956ea') or (contains(Title, '9f024c1c-9e6f-483e-a8a6-d962b93956ea')))");
-    });
-
-    it("query assert filter with in correctly builds the query", () => {
-        const testQuery = query.where().in("Id", ["1", "2", "3"]).done();
-
-        const resultingQuery = testQuery.build();
-        expect(resultingQuery.$filter).toEqual("Id in (1, 2, 3)");
-    });
-
-    it("query assert filter with in throws error when constant is not array", () => {
-        const testQuery = query.where().in("Id", "1, 2, 3").done();
-
-        expect(() => testQuery.build()).toThrow(new Error("Parameter is not an array!"));
-    });
-
-    it("upload request should encode non-ASCII file name header", () => {
-        const fileName = "fakeImage тест.jpeg";
-        const request = new UploadRequest({
-            urlOptions: {
-                baseUrl,
-                entitySet: "images"
-            },
-            data: {},
-            contentType: "image/jpeg",
-            fileName,
-            uploadProperties: {
-                Title: "test"
-            }
-        }, {
-            type: "Bearer",
-            value: "token"
-        }, {});
-
-        expect(request.getHeaders()["X-File-Name"]).toEqual(encodeURIComponent(fileName));
-    });
-
-    function readBlobAsText(blob: Blob): Promise<string> {
-        return new Promise((resolve, reject) => {
-            const reader = new FileReader();
-
-            reader.onload = () => {
-                resolve(<string>reader.result);
-            };
-
-            reader.onerror = () => {
-                reject();
-            };
-            reader.readAsText(blob);
-        });
-    }
-});

package/src/Sitefinity.spec.ts

@@ -1,483 +0,0 @@
-import { SF_PARAMS, HEADER_NAMES } from "./constants";
-import { ResponseHandlers } from "./Requests/ExecutableRequest";
-import { Sitefinity } from "./Sitefinity";
-
-describe("Base SDK tests", () => {
-    const baseUrl = "http://www.mysite.com/api/default/";
-    const batchResponse = `--batchresponse_ab4d3fab-5bee-4ea0-ba40-723ea40d1c32\r
-Content-Type: application/http\r
-Content-Transfer-Encoding: binary\r
-\r
-HTTP/1.1 200 OK\r
-Cache-Control: no-store, must-revalidate, no-cache\r
-Access-Control-Allow-Origin: *\r
-Content-Type: text/plain\r
-OData-Version: 4.0\r
-\r
-1\r
---batchresponse_ab4d3fab-5bee-4ea0-ba40-723ea40d1c32--\r
-`;
-    let sitefinity: Sitefinity;
-
-    beforeEach(() => {
-        jasmine.Ajax.install();
-    });
-
-    afterEach(() => {
-        jasmine.Ajax.uninstall();
-    });
-
-    beforeAll(() => {
-        sitefinity = new Sitefinity({
-            baseUrl
-        });
-    });
-
-    describe("SDK options tests", () => {
-        it("Verify baseUrl from SDK options wiht slash", () => {
-            const url = "/";
-            const sdk = new Sitefinity({
-                baseUrl: url
-            });
-            sdk.data({}).get({});
-
-            const request = jasmine.Ajax.requests.mostRecent();
-            expect(request.url).toBe(url);
-        });
-
-        it("Verify baseUrl from SDK options with relative path", () => {
-            const url = "/sub";
-            const sdk = new Sitefinity({
-                baseUrl: url
-            });
-            sdk.data({}).get({});
-
-            const request = jasmine.Ajax.requests.mostRecent();
-            expect(request.url).toBe(url + "/");
-        });
-
-        it("Verify baseUrl from SDK options with relative path and slash", () => {
-            const url = "/sub/";
-            const sdk = new Sitefinity({
-                baseUrl: url
-            });
-            sdk.data({}).get({});
-
-            const request = jasmine.Ajax.requests.mostRecent();
-            expect(request.url).toBe(url);
-        });
-
-        it("Verify baseUrl from SDK options", () => {
-            const url = "http://www.mysite.com/api/default/v2/";
-            const sdk = new Sitefinity({
-                baseUrl: url
-            });
-            sdk.data({}).get({});
-
-            const request = jasmine.Ajax.requests.mostRecent();
-            expect(request.url).toBe(url);
-        });
-
-        it("Verify siteId from SDK options", () => {
-            const siteId = "mySiteId";
-            const sdk = new Sitefinity({
-                baseUrl: "http://www.mysite.com/api/default/v2/",
-                siteId: siteId
-            });
-            sdk.data({}).get({});
-
-            const request = jasmine.Ajax.requests.mostRecent();
-            expect(request.url).toContain(`${SF_PARAMS.siteId}=${siteId}`);
-        });
-
-        it("Verify enableUnlimitedChoices from SDK options", () => {
-            let sdk = new Sitefinity({
-                baseUrl: "http://www.mysite.com/api/default/v2/",
-                enableUnlimitedChoices: true
-            });
-            sdk.data({}).get({});
-
-            let request = jasmine.Ajax.requests.mostRecent();
-            expect(request.requestHeaders[HEADER_NAMES.choicesBinaryRepresentation]).toBe("true");
-
-            sdk = new Sitefinity({
-                baseUrl: "http://www.mysite.com/api/default/v2/",
-                enableUnlimitedChoices: false
-            });
-            sdk.data({}).get({});
-
-            request = jasmine.Ajax.requests.mostRecent();
-            expect(request.requestHeaders[HEADER_NAMES.choicesBinaryRepresentation]).toBeUndefined();
-        });
-
-        it("Verify integrationMode from SDK options", () => {
-            let sdk = new Sitefinity({
-                baseUrl: "http://www.mysite.com/api/default/v2/",
-                integrationMode: true
-            });
-            sdk.data({}).get({});
-
-            let request = jasmine.Ajax.requests.mostRecent();
-            expect(request.requestHeaders[HEADER_NAMES.integrationMode]).toBe("true");
-
-            sdk = new Sitefinity({
-                baseUrl: "http://www.mysite.com/api/default/v2/",
-                integrationMode: false
-            });
-            sdk.data({}).get({});
-
-            request = jasmine.Ajax.requests.mostRecent();
-            expect(request.requestHeaders[HEADER_NAMES.integrationMode]).toBeUndefined();
-        });
-
-        it("Verify global success handler from SDK options", () => {
-            const handlers: ResponseHandlers = {
-                successCb: () => {},
-                failureCb: () => {}
-            };
-            const successSpy = spyOn<ResponseHandlers, any>(handlers, "successCb");
-            const failureSpy = spyOn<ResponseHandlers, any>(handlers, "failureCb");
-
-            const sdk = new Sitefinity({
-                baseUrl: "http://www.mysite.com/api/default/v2/",
-                handlers
-            });
-            sdk.data({}).get({});
-
-            const request = jasmine.Ajax.requests.mostRecent();
-            request.respondWith({
-                status: 200,
-                responseText: "{\"message\":\"test\"}"
-            });
-
-            expect(successSpy).toHaveBeenCalledOnceWith({ message: "test" });
-            expect(failureSpy).not.toHaveBeenCalled();
-        });
-
-        it("Verify global failure handler from SDK options", () => {
-            const handlers: ResponseHandlers = {
-                successCb: () => {},
-                failureCb: () => {}
-            };
-            const successSpy = spyOn<ResponseHandlers, any>(handlers, "successCb");
-            const failureSpy = spyOn<ResponseHandlers, any>(handlers, "failureCb");
-
-            const sdk = new Sitefinity({
-                baseUrl: "http://www.mysite.com/api/default/v2/",
-                handlers
-            });
-            sdk.data({}).get({});
-
-            const request = jasmine.Ajax.requests.mostRecent();
-            request.respondWith({
-                status: 400,
-                responseText: "{\"message\":\"test\"}"
-            });
-
-            expect(failureSpy).toHaveBeenCalledOnceWith({ message: "test", status: 400 });
-            expect(successSpy).not.toHaveBeenCalled();
-        });
-
-        it("Verify token", () => {
-            const sdk = new Sitefinity({
-                baseUrl: "http://www.mysite.com/api/default/v2/"
-            });
-            sdk.data({}).get({});
-
-            let request = jasmine.Ajax.requests.mostRecent();
-            expect(request.requestHeaders[HEADER_NAMES.authorization]).toBeUndefined();
-
-            sdk.setToken({
-                type: "Bearer",
-                value: "123"
-            });
-            sdk.data({}).get({});
-
-            request = jasmine.Ajax.requests.mostRecent();
-            expect(request.requestHeaders[HEADER_NAMES.authorization]).toBe("Bearer 123");
-        });
-    });
-
-    describe("Type options tests", () => {
-        describe("for data()", () => {
-            it("Verify baseUrl is appended trailing slash", () => {
-                const url = "http://www.mysite.com/api/default/v2";
-                sitefinity.data({
-                    baseUrl: url
-                }).get({});
-
-                let request = jasmine.Ajax.requests.mostRecent();
-                expect(request.url).toBe(`${url}/`);
-
-                const sdk = new Sitefinity({
-                    baseUrl: url
-                });
-                sdk.data({}).get({});
-
-                request = jasmine.Ajax.requests.mostRecent();
-                expect(request.url).toBe(`${url}/`);
-            });
-
-            it("Verify baseUrl from type options overrides baseUrl from SDK options", () => {
-                const url = "http://www.mysite.com/api/default/v2/";
-                sitefinity.data({
-                    baseUrl: url
-                }).get({});
-
-                const request = jasmine.Ajax.requests.mostRecent();
-                expect(request.url).toBe(url);
-            });
-
-            it("Verify siteId from type options overrides siteId from SDK options", () => {
-                const siteId = "mySiteId";
-                const sdk = new Sitefinity({
-                    baseUrl: "http://www.mysite.com/api/default/v2/",
-                    siteId: "test"
-                });
-                sdk.data({
-                    siteId
-                }).get({});
-
-                const request = jasmine.Ajax.requests.mostRecent();
-                expect(request.url).toContain(`${SF_PARAMS.siteId}=${siteId}`);
-            });
-
-            it("Verify entitySet from type options", () => {
-                const entitySet = "newsitems";
-
-                sitefinity.data({
-                    entitySet
-                }).get({});
-
-                const request = jasmine.Ajax.requests.mostRecent();
-                expect(request.url).toBe(`${baseUrl}${entitySet}`);
-            });
-
-            it("Verify provider from type options", () => {
-                const provider = "myProvider";
-
-                sitefinity.data({
-                    provider
-                }).get({});
-
-                const request = jasmine.Ajax.requests.mostRecent();
-                expect(request.url).toContain(`${SF_PARAMS.provider}=${provider}`);
-            });
-
-            it("Verify culture from type options", () => {
-                const culture = "en";
-
-                sitefinity.data({
-                    culture
-                }).get({});
-
-                const request = jasmine.Ajax.requests.mostRecent();
-                expect(request.url).toContain(`${SF_PARAMS.culture}=${culture}`);
-            });
-
-            it("Verify additional query params from type options", () => {
-                const additionalQueryParams = {
-                    "p1": "test1",
-                    "p2": "123",
-                };
-
-                sitefinity.data({
-                    additionalQueryParams
-                }).get({});
-
-                const request = jasmine.Ajax.requests.mostRecent();
-                expect(request.url).toContain("p1=test1&p2=123");
-            });
-
-            it("Verify additional headers from type options", () => {
-                const additionalHeaders = {
-                    "p1": "test1",
-                    "p2": "123",
-                };
-
-                sitefinity.data({
-                    additionalHeaders
-                }).get({});
-
-                additionalHeaders[HEADER_NAMES.serviceRequest] = "true";
-
-                const request = jasmine.Ajax.requests.mostRecent();
-                expect(request.requestHeaders).toEqual(additionalHeaders);
-            });
-        });
-
-        describe("for batch", () => {
-            it("Verify baseUrl is appended trailing slash", () => {
-                const url = "http://www.mysite.com/api/default/v2";
-                sitefinity.batch(undefined, undefined, undefined, {
-                    baseUrl: url
-                }).execute();
-
-                let request = jasmine.Ajax.requests.mostRecent();
-                expect(request.url).toBe(`${url}/$batch`);
-
-                const sdk = new Sitefinity({
-                    baseUrl: url
-                });
-                sdk.batch().execute();
-
-                request = jasmine.Ajax.requests.mostRecent();
-                expect(request.url).toBe(`${url}/$batch`);
-            });
-
-            it("Verify baseUrl from type options overrides baseUrl from SDK options", () => {
-                const url = "http://www.mysite.com/api/default/v2/";
-                sitefinity.batch(undefined, undefined, undefined, {
-                    baseUrl: url
-                }).execute();
-
-                const request = jasmine.Ajax.requests.mostRecent();
-                expect(request.url).toBe(`${url}$batch`);
-            });
-
-            it("Verify siteId from type options overrides siteId from SDK options", () => {
-                const siteId = "mySiteId";
-                const sdk = new Sitefinity({
-                    baseUrl: "http://www.mysite.com/api/default/v2/",
-                    siteId: "test"
-                });
-                sdk.batch(undefined, undefined, undefined, {
-                    siteId
-                }).execute();
-
-                const request = jasmine.Ajax.requests.mostRecent();
-                expect(request.url).toContain(`${SF_PARAMS.siteId}=${siteId}`);
-            });
-
-            it("Verify provider from type options", () => {
-                const provider = "myProvider";
-
-                sitefinity.batch(undefined, undefined, undefined, {
-                    provider
-                }).execute();
-
-                const request = jasmine.Ajax.requests.mostRecent();
-                expect(request.url).toContain(`${SF_PARAMS.provider}=${provider}`);
-            });
-
-            it("Verify culture from type options", () => {
-                const culture = "en";
-
-                sitefinity.batch(undefined, undefined, undefined, {
-                    culture
-                }).execute();
-
-                const request = jasmine.Ajax.requests.mostRecent();
-                expect(request.url).toContain(`${SF_PARAMS.culture}=${culture}`);
-            });
-
-            it("Verify additional query params from type options", () => {
-                const additionalQueryParams = {
-                    "p1": "test1",
-                    "p2": "123",
-                };
-
-                sitefinity.batch(undefined, undefined, undefined, {
-                    additionalQueryParams
-                }).execute();
-
-                const request = jasmine.Ajax.requests.mostRecent();
-                expect(request.url).toContain("p1=test1&p2=123");
-            });
-
-            it("Verify additional headers from type options", () => {
-                const additionalHeaders = {
-                    "p1": "test1",
-                    "p2": "123",
-                };
-
-                sitefinity.batch(undefined, undefined, undefined, {
-                    additionalHeaders
-                }).execute();
-
-                additionalHeaders[HEADER_NAMES.serviceRequest] = "true";
-
-                const request = jasmine.Ajax.requests.mostRecent();
-                expect(request.requestHeaders).toEqual(additionalHeaders);
-            });
-
-            it("Verify successCb overrides global success handler from SDK options", () => {
-                const globalHandlers: ResponseHandlers = {
-                    successCb: () => {},
-                    failureCb: () => {}
-                };
-                const successSpyGlobal = spyOn<ResponseHandlers, any>(globalHandlers, "successCb");
-                const failureSpyGlobal = spyOn<ResponseHandlers, any>(globalHandlers, "failureCb");
-
-                const localHandlers = {
-                    successCb: () => {},
-                    failureCb: () => {}
-                };
-                const successSpyLocal = spyOn<ResponseHandlers, any>(localHandlers, "successCb");
-                const failureSpyLocal = spyOn<ResponseHandlers, any>(localHandlers, "failureCb");
-
-                const sdk = new Sitefinity({
-                    baseUrl: "http://www.mysite.com/api/default/v2/",
-                    handlers: globalHandlers
-                });
-                sdk.batch(localHandlers.successCb, localHandlers.failureCb).execute();
-
-                const request = jasmine.Ajax.requests.mostRecent();
-                request.respondWith({
-                    status: 200,
-                    responseText: batchResponse,
-                    responseHeaders: {
-                        "Access-Control-Allow-Origin": "*",
-                        "Cache-Control:": "no-cache",
-                        "Content-Length": "334",
-                        "Content-type": "multipart/mixed; boundary=batchresponse_ab4d3fab-5bee-4ea0-ba40-723ea40d1c32"
-                    }
-                });
-
-                expect(successSpyLocal).toHaveBeenCalledTimes(1);
-                expect(failureSpyLocal).not.toHaveBeenCalled();
-                expect(successSpyGlobal).not.toHaveBeenCalled();
-                expect(failureSpyGlobal).not.toHaveBeenCalled();
-            });
-
-            it("Verify failureCb overrides global failure handler from SDK options", () => {
-                const globalHandlers: ResponseHandlers = {
-                    successCb: () => {},
-                    failureCb: () => {}
-                };
-                const successSpyGlobal = spyOn<ResponseHandlers, any>(globalHandlers, "successCb");
-                const failureSpyGlobal = spyOn<ResponseHandlers, any>(globalHandlers, "failureCb");
-
-                const localHandlers = {
-                    successCb: () => {},
-                    failureCb: () => {}
-                };
-                const successSpyLocal = spyOn<ResponseHandlers, any>(localHandlers, "successCb");
-                const failureSpyLocal = spyOn<ResponseHandlers, any>(localHandlers, "failureCb");
-
-                const sdk = new Sitefinity({
-                    baseUrl: "http://www.mysite.com/api/default/v2/",
-                    handlers: globalHandlers
-                });
-                sdk.batch(localHandlers.successCb, localHandlers.failureCb).execute();
-
-                const request = jasmine.Ajax.requests.mostRecent();
-                request.respondWith({
-                    status: 400,
-                    responseText: batchResponse,
-                    responseHeaders: {
-                        "Access-Control-Allow-Origin": "*",
-                        "Cache-Control:": "no-cache",
-                        "Content-Length": "334",
-                        "Content-type": "multipart/mixed; boundary=batchresponse_ab4d3fab-5bee-4ea0-ba40-723ea40d1c32"
-                    }
-                });
-
-                expect(failureSpyLocal).toHaveBeenCalledTimes(1);
-                expect(successSpyLocal).not.toHaveBeenCalled();
-                expect(successSpyGlobal).not.toHaveBeenCalled();
-                expect(failureSpyGlobal).not.toHaveBeenCalled();
-            });
-        });
-    });
-});