@progress/sitefinity-webservices-sdk 0.3.0 → 1.0.2

package/src/Sitefinity.spec.ts

@@ -0,0 +1,418 @@
+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", () => {
+            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`);
+            });
+        });
+
+        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 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();
+            });
+        });
+    });
+});

package/src/Sitefinity.ts

@@ -1,183 +1,114 @@
 import { RequestFactory } from './Requests/RequestFactory';
-import { Authentication } from './Authentication';
 import { Data } from './Data';
 import { Query } from './Query';
 import { utils } from './utils';
+import { ResponseHandlers } from "./Requests/ExecutableRequest";
+import { BatchRequest } from "./Requests/BatchRequest";
 
-/**
-* @class Sitefinity
-* @classdesc The constructor of the Sitefinity JavaScript SDK. This is the entry point for the SDK.
-* @property {Object} authentication - The authentication object used for authenticating to Sitefinity. See {@link Authentication}
-* @param {object} options - An object containing configuration options for the Setup object.
-* @param {string} options.serviceUrl - Your service url that points to the configured instance of Sitefinity service.
-* @param {string} options.siteId - The ID of the site, for which the query will be executed.
-* @param {string} options.handlers - The global handlers for request execution
-* @param {string} options.handlers.successCb - The success handler.
-* @param {string} options.handlers.failureCb - The failure handler.
-*/
 export class Sitefinity {
+    public static Query: typeof Query = Query;
+
     private factory: RequestFactory;
-    private authentication: Authentication;
-    private profileUrl: string;
+    private baseUrl: string;
     private siteId: string;
-    public static Query: typeof Query = Query;
 
-    constructor(options: any) {
-        this.profileUrl = utils.addTrailingSlash(options.serviceUrl);
+    /**
+    * The constructor of the Sitefinity JavaScript SDK. This is the entry point for the SDK.
+    */
+    constructor(options: SDKOptions) {
+        this.baseUrl = options.baseUrl;
         this.siteId = options.siteId;
-        this.factory = new RequestFactory({
-            handlers: options.handlers,
-            enableUnlimitedChoices: options.enableUnlimitedChoices,
-            integrationMode: options.integrationMode
-        });
-
-        this.authentication = new Authentication({
-            serviceUrl: this.profileUrl,
-            factory: this.factory
-        });
+        this.factory = new RequestFactory(options);
     }
 
-    /**
-* Creates a new {@link Data} class.
-* @memberOf Sitefinity
-* @instance
-* @param {object} options - An object containing configuration options for the Setup object.
-* @param {string} options.urlName - The URL name of the type..
-* @param {string} [options.providerName] - The name of the provider. If empty the default provider for the site will be used.
-* @param {string} [options.cultureName] - The name of the culture. If empty the default culture for the site will be used.
-* @example
-* var data = sf.data({
-*     urlName: "newsitems",
-*     providerName: "OpenAccessDataProvider",
-*     cultureName: "en"
-* });
-* @returns {Data}
-*/
-    data(options: any) {
-        var optionsServiceUrl = options.serviceUrl ? utils.addTrailingSlash(options.serviceUrl) : options.serviceUrl;
-        var dataOptions = {
-            baseUrl: optionsServiceUrl || this.profileUrl,
-            SFParams: {
-                provider: options.providerName,
-                culture: options.cultureName,
-                siteId: options.siteId || this.siteId
-            },
+    data(options: TypeOptions): Data {
+        const urlOptions: TypeOptions = {
+            baseUrl: utils.addTrailingSlash(options.baseUrl || this.baseUrl),
+            provider: options.provider,
+            culture: options.culture,
+            siteId: options.siteId || this.siteId,
             additionalQueryParams: options.additionalQueryParams,
-            entitySet: options.urlName
+            entitySet: options.entitySet
         }
 
-        this.factory.token = this.authentication.getToken();
-        return new Data(dataOptions, this.factory);
+        return new Data(urlOptions, this.factory);
     }
 
-    /**
-    * Creates a new {@link BatchRequest} class. OData batch requests -> {@link http://docs.oasis-open.org/odata/odata/v4.0/os/part1-protocol/odata-v4.0-os-part1-protocol.html#_Toc372793748}
-    * @memberOf Sitefinity
-    * @instance
-    * @param {Function} success - The success callback of the batch execution.
-    * @param {string} options.urlName - The URL name of the type..
-    * @param {string} [options.providerName] - The name of the provider. If empty the default provider for the site will be used.
-    * @param {string} [options.cultureName] - The name of the culture. If empty the default culture for the site will be used.
-    * @example
-    * var sf = new Sitefinity({
-    *   serviceUrl: 'http://mydomain/route/service/'
-    * });
-    *
-    * var batch = sf.batch(successCbBatch, failureCb);
-    * batch.get({
-    *     entitySet: entitySet,
-    *     query: query8
-    * });
-    *
-    * var transaction = batch.beginTransaction();
-    * var createId = transaction.create({
-    *     entitySet: entitySet,
-    *     data: newsItem
-    * });
-    *
-    * batch.endTransaction(transaction);
-    *
-    * var transaction2 = batch.beginTransaction();
-    * var createId2 = transaction2.create({
-    *     entitySet: entitySet,
-    *     data: newsItem
-    * });
-    *
-    * var updateId2 = transaction2.update({
-    *     entitySet: entitySet,
-    *     key: createId2,
-    *     data: newsItemUpdate
-    * });
-    *
-    * batch.endTransaction(transaction2);
-    *
-    * batch.get({
-    *     entitySet: entitySet
-    * });
-    *
-    * batch.execute();
-    * @returns {BatchRequest}
-    */
-    batch(success: any, failure: any, progress: any, options: any) {
-        if (typeof progress !== 'function') {
-            options = progress;
-            progress = null;
-        }
-
+    batch(success?: Function, failure?: Function, progress?: Function, options?: TypeOptions): BatchRequest {
         if (!options)
             options = {};
 
-        this.factory.token = this.authentication.getToken();
-
-        var optionsServiceUrl = options.serviceUrl ? utils.addTrailingSlash(options.serviceUrl) : options.serviceUrl;
-        var batch = this.factory.batch({
+        const batch = this.factory.batch({
             successCb: success,
             failureCb: failure,
             progressCb: progress,
             urlOptions: {
-                baseUrl: optionsServiceUrl || this.profileUrl,
-                SFParams: {
-                    provider: options.providerName,
-                    culture: options.cultureName,
-                    siteId: options.siteId || this.siteId
-                },
+                baseUrl: utils.addTrailingSlash(options.baseUrl || this.baseUrl),
+                provider: options.provider,
+                culture: options.culture,
+                siteId: options.siteId || this.siteId,
                 additionalQueryParams: options.additionalQueryParams
             }
         });
 
-        var executor: any = this.factory.createExecutor(batch);
-        executor.beginTransaction = () => {
-            return batch.beginTransaction();
-        }
+        return batch;
+    }
 
-        executor.endTransaction = (transaction) => {
-            batch.endTransaction(transaction);
-        }
+    /**
+    * Sets the authentication token.
+    */
+    setToken(token: Token) {
+        this.factory.token = token;
+    }
+}
 
-        executor.get = (options) => {
-            batch.constructor.prototype.get.call(batch, options);
-        }
+interface OptionsBase {
+    /**
+    * Your service url that points to the configured instance of Sitefinity service.
+    */
+    baseUrl?: string;
 
-        executor.getOperations = (options) => {
-            batch.constructor.prototype.getOperations.call(batch, options);
-        }
+    /**
+    * The ID of the site, for which the queries will be executed.
+    */
+    siteId?: string;
+}
 
-        executor.getSingle = (options) => {
-            batch.constructor.prototype.getSingle.call(batch, options);
-        }
+/**
+* Defines an object containing configuration options for the SDK object.
+*/
+export interface SDKOptions extends OptionsBase {
+    /**
+    * The global handlers for request execution
+    */
+    handlers?: ResponseHandlers;
 
-        executor.getProperty = (options) => {
-            batch.constructor.prototype.getProperty.call(batch, options);
-        }
+    enableUnlimitedChoices?: boolean;
+    integrationMode?: boolean;
+}
 
-        executor.getRelated = (options) => {
-            batch.constructor.prototype.getRelated.call(batch, options);
-        }
+/**
+* Defines an object containing configuration options related to a specific type.
+*/
+export interface TypeOptions extends OptionsBase {
+    /**
+    * The URL name of the type.
+    */
+    entitySet?: string;
 
-        executor.getRelatedById = (options) => {
-            batch.constructor.prototype.getRelatedById.call(batch, options);
-        }
+    /**
+    * The name of the provider. If empty the default provider for the site will be used.
+    */
+    provider?: string;
 
-        return executor;
-    }
+    /**
+    * The name of the culture. If empty the default culture for the site will be used.
+    */
+    culture?: string;
+    additionalQueryParams?: { [key: string]: string };
+}
+
+export interface Token {
+    type: string;
+    value: string;
 }