@progress/sitefinity-webservices-sdk 0.3.1 → 1.0.0

package/package.json

@@ -1,21 +1,39 @@
 {
   "name": "@progress/sitefinity-webservices-sdk",
-  "version": "0.3.1",
+  "version": "1.0.0",
   "scripts": {
     "start": "webpack-dev-server --config config/webpack.dev.js",
     "build:dev": "webpack --config config/webpack.dev.js --progress --profile",
     "build:prod": "webpack --config config/webpack.prod.js --progress --profile",
-    "build:release": "npm run build:prod & npm run build:dev"
+    "build:release": "npm run build:prod & npm run build:dev & npm run docs",
+    "test": "karma start --single_run",
+    "test:debug": "karma start",
+    "docs": "typedoc",
+    "lint": "eslint . --ext .ts"
   },
   "devDependencies": {
+    "@types/jasmine": "3.10.3",
+    "@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",
-    "html-webpack-plugin": "3.2.0",
-    "typedoc": "0.11.1",
-    "typedoc-webpack-plugin": "1.1.4",
-    "typescript": "2.9.1",
-    "webpack": "4.46.0",
-    "webpack-cli": "3.3.11",
-    "webpack-dev-server": "3.11.0",
-    "webpack-merge": "4.1.2"
+    "eslint": "8.10.0",
+    "html-webpack-plugin": "5.5.0",
+    "jasmine": "4.0.2",
+    "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-jasmine-ajax": "0.1.13",
+    "karma-spec-reporter": "0.0.33",
+    "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",
+    "webpack-merge": "5.8.0"
   }
 }

package/sitefinity-webservices-sdk.ts

@@ -0,0 +1,16 @@
+export * from "./src/BlobBuilder";
+export * from "./src/constants";
+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";
+export * from "./src/Data";
+export * from "./src/Requests/BatchRequest";
+export * from "./src/Requests/ExecutableRequest";
+export * from "./src/Requests/Request";
+export * from "./src/Requests/RequestBase";
+export * from "./src/Requests/RequestFactory";

package/src/BlobBuilder.ts

@@ -1,25 +1,20 @@
 /**
- * @classdesc The BlobBuilder class is used to generate blob objects.
- * @class BlobBuilder
+ * The BlobBuilder class is used to generate blob objects.
  */
 export class BlobBuilder {
-    private _blob = new Blob();
+    private blob = new Blob();
 
     /**
-    * Append new value to blob.
-    * @memberOf BlobBuilder
-    * @instance
-    * @param {object} value - The value to be appended.
+    * Appends new value to blob.
     */
     append(value: any) {
-        this._blob = new Blob([this._blob, value]);
+        this.blob = new Blob([this.blob, value]);
     }
 
     /**
-    * Get generated blob.
-    * @memberOf BlobBuilder
+    * Gets generated blob.
     */
-    build() {
-        return this._blob;
+    build(): Blob {
+        return this.blob;
     }
 }

package/src/Data.spec.ts

@@ -0,0 +1,160 @@
+import { ODATA_PARAMS, SF_PARAMS } from "./constants";
+import { Data } from "./Data";
+import { Sitefinity } from "./Sitefinity";
+
+describe("Data class tests", () => {
+    const baseUrl = "http://www.mysite.com/api/default/";
+    const query = new Sitefinity.Query().where().eq("Title", "test").done();
+    const queryResult = query.build().$filter;
+    const action = "Publish";
+    const fallbackProperties = ["Title", "UrlName"];
+    const key = "1234";
+    const callbacks = {
+        successCb: () => {},
+        failureCb: () => {},
+    };
+
+    let successCbSpy;
+    let failureCbSpy;
+    let data: Data;
+
+    beforeEach(() => {
+        jasmine.Ajax.install();
+        successCbSpy = spyOn(callbacks, "successCb");
+        failureCbSpy = spyOn(callbacks, "failureCb");
+    });
+
+    afterEach(() => {
+        jasmine.Ajax.uninstall();
+    });
+
+    beforeAll(() => {
+        data = new Sitefinity({}).data({ baseUrl });
+    });
+
+    it("Verify get success", () => {
+        data.get({
+            query,
+            action,
+            successCb: callbacks.successCb,
+            failureCb: callbacks.failureCb,
+            fallbackProperties
+        });
+
+        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(',')}`);
+
+        request.respondWith({
+            status: 200,
+            responseText: '{"message":"test"}'
+        });
+
+        expect(successCbSpy).toHaveBeenCalledOnceWith({ message: "test" });
+        expect(failureCbSpy).not.toHaveBeenCalled();
+    });
+
+    it("Verify get failure", () => {
+        data.get({
+            successCb: callbacks.successCb,
+            failureCb: callbacks.failureCb
+        });
+
+        const request = jasmine.Ajax.requests.mostRecent();
+        request.respondWith({
+            status: 400,
+            responseText: '{"message":"test"}'
+        });
+
+        expect(failureCbSpy).toHaveBeenCalledOnceWith({ message: "test", status: 400 })
+        expect(successCbSpy).not.toHaveBeenCalled();
+    });
+
+    it("Verify getOperations success", () => {
+        const parentId = "567";
+        data.getOperations({
+            parentId,
+            successCb: callbacks.successCb,
+            failureCb: callbacks.failureCb
+        });
+
+        let request = jasmine.Ajax.requests.mostRecent();
+        expect(request.url).toContain(`${baseUrl}operations`);
+        expect(request.url).toContain(`${SF_PARAMS.parentId}=${parentId}`);
+
+        request.respondWith({
+            status: 200,
+            responseText: '{"message":"test"}'
+        });
+
+        expect(successCbSpy).toHaveBeenCalledOnceWith({ message: "test" });
+        expect(failureCbSpy).not.toHaveBeenCalled();
+
+        data.getOperations({
+            key,
+            parentId
+        });
+
+        request = jasmine.Ajax.requests.mostRecent();
+        expect(request.url).toContain(`${baseUrl}(${key})/operations`);
+        expect(request.url).not.toContain(`${SF_PARAMS.parentId}=${parentId}`);
+    });
+
+    it("Verify getOperations failure", () => {
+        data.getOperations({
+            successCb: callbacks.successCb,
+            failureCb: callbacks.failureCb
+        });
+
+        const request = jasmine.Ajax.requests.mostRecent();
+        request.respondWith({
+            status: 400,
+            responseText: '{"message":"test"}'
+        });
+
+        expect(failureCbSpy).toHaveBeenCalledOnceWith({ message: "test", status: 400 })
+        expect(successCbSpy).not.toHaveBeenCalled();
+    });
+
+    it("Verify getSingle success", () => {
+        data.getSingle({
+            key,
+            query,
+            action,
+            successCb: callbacks.successCb,
+            failureCb: callbacks.failureCb,
+            fallbackProperties
+        });
+
+        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(',')}`);
+
+        request.respondWith({
+            status: 200,
+            responseText: '{"message":"test"}'
+        });
+
+        expect(successCbSpy).toHaveBeenCalledOnceWith({ message: "test" });
+        expect(failureCbSpy).not.toHaveBeenCalled();
+    });
+
+    it("Verify getSingle failure", () => {
+        data.getSingle({
+            key,
+            successCb: callbacks.successCb,
+            failureCb: callbacks.failureCb
+        });
+
+        const request = jasmine.Ajax.requests.mostRecent();
+        request.respondWith({
+            status: 400,
+            responseText: '{"message":"test"}'
+        });
+
+        expect(failureCbSpy).toHaveBeenCalledOnceWith({ message: "test", status: 400 })
+        expect(successCbSpy).not.toHaveBeenCalled();
+    });
+});