@progress/sitefinity-webservices-sdk 0.3.0 → 1.0.2

package/src/WhereQuery.ts

@@ -1,198 +1,138 @@
 import { ComplexExpression, BinaryExpression } from './Expression';
-const OperatorType = require('./constants').default.ExpressionType;
+import { EXPRESSION_TYPE } from "./constants";
 
 /**
- * @classdesc A fluent API operation for creating a filter for a query by chaining different rules.
- * @class WhereQuery
- * @protected
+ * A fluent API operation for creating a filter for a query by chaining different rules.
  */
-export class WhereQuery {
-
+export class WhereQuery<QueryType> {
     private expression: ComplexExpression;
-    constructor(private parent: any, type: string = OperatorType.and) {
+
+    constructor(private parent: QueryType, type: string = EXPRESSION_TYPE.and) {
         this.expression = new ComplexExpression(type, []);
     }
 
     /**
     * Adds an `and` clause to the current condition and returns it for further chaining.
-    * @method and
-    * @memberOf WhereQuery.prototype
-    * @returns {WhereQuery}
     */
-    and(): WhereQuery {
-        return new WhereQuery(this, OperatorType.and);
+    and(): WhereQuery<WhereQuery<QueryType>> {
+        return new WhereQuery(this, EXPRESSION_TYPE.and);
     }
+
     /**
      * Adds an `or` clause to the current condition and returns it for further chaining.
-     * @method or
-     * @memberOf WhereQuery.prototype
-     * @returns {WhereQuery}
      */
-    or(): WhereQuery {
-        return new WhereQuery(this, OperatorType.or);
+    or(): WhereQuery<WhereQuery<QueryType>> {
+        return new WhereQuery(this, EXPRESSION_TYPE.or);
     }
 
     /**
      * Adds an `any` clause to the current condition and returns it for further chaining.
-     * @method any
-     * @memberOf WhereQuery.prototype
-     * @returns {WhereQuery}
      */
-    any(): WhereQuery {
-        return new WhereQuery(this, OperatorType.any);
+    any(): WhereQuery<WhereQuery<QueryType>> {
+        return new WhereQuery(this, EXPRESSION_TYPE.any);
     }
+
     /**
      * Adds a `not` clause to the current condition and returns it for further chaining.
-     * @method not
-     * @memberOf WhereQuery.prototype
-     * @returns {WhereQuery}
      */
-    not(): WhereQuery {
-        return new WhereQuery(this, OperatorType.not);
-    }
-
-    private _simple(type: string, parameter: string, constant: any, caseSensitive: boolean = true): WhereQuery {
-        var currentExpr = new BinaryExpression(type, parameter, constant, caseSensitive);
-        var subExpressions = this.expression.getExpressions();
-        subExpressions.push(currentExpr);
-
-        if (this.expression.getType() === OperatorType.not && subExpressions.length > 1)
-            throw new Error("Invalid operators count!");
-
-        return this;
+    not(): WhereQuery<WhereQuery<QueryType>> {
+        return new WhereQuery(this, EXPRESSION_TYPE.not);
     }
 
     /**
      * Adds a condition that a field must be equal to a specific value.
-     * @method eq
-     * @memberOf WhereQuery.prototype
-     * @param {string} field Field name.
-     * @param {*} value Comparison value (to which the fields must be equal).
-     * @returns {WhereQuery}
      */
-    eq(parameter: string, constant: any): WhereQuery {
-        return this._simple(OperatorType.eq, parameter, constant);
+    eq(parameter: string, constant: any): WhereQuery<QueryType> {
+        return this.simple(EXPRESSION_TYPE.eq, parameter, constant);
     }
+
     /**
      * Adds a condition that a field must *not* be equal to a specific value.
-     * @method ne
-     * @memberOf WhereQuery.prototype
-     * @param {string} field Field name.
-     * @param {*} value Comparison value (to which the field must not be equal).
-     * @returns {WhereQuery}
      */
-    ne(parameter: string, constant: any): WhereQuery {
-        return this._simple(OperatorType.ne, parameter, constant);
+    ne(parameter: string, constant: any): WhereQuery<QueryType> {
+        return this.simple(EXPRESSION_TYPE.ne, parameter, constant);
     }
+
     /**
      * Adds a condition that a field must be `greater than` a certain value. Applicable to Number, String, and Date fields.
-     * @method gt
-     * @memberOf WhereQuery.prototype
-     * @param {string} field Field name.
-     * @param {*} value Comparison value (that the field should be greater than).
-     * @returns {WhereQuery}
      */
     gt(parameter: string, constant: any) {
-        return this._simple(OperatorType.gt, parameter, constant);
+        return this.simple(EXPRESSION_TYPE.gt, parameter, constant);
     }
+
     /**
      * Adds a condition that a field must be `greater than or equal` to a certain value. Applicable to Number, String, and Date fields.
-     * @method gte
-     * @memberOf WhereQuery.prototype
-     * @param {string} field Field name.
-     * @param {*} value Comparison value (that the field should be greater than or equal to).
-     * @returns {WhereQuery}
      */
     gte(parameter: string, constant: any) {
-        return this._simple(OperatorType.ge, parameter, constant);
+        return this.simple(EXPRESSION_TYPE.ge, parameter, constant);
     }
+
     /**
      * Adds a condition that a field must be `less than` a certain value. Applicable to Number, String, and Date fields.
-     * @method lt
-     * @memberOf WhereQuery.prototype
-     * @param {string} field Field name.
-     * @param {*} value Comparison value (that the field should be less than).
-     * @returns {WhereQuery}
      */
     lt(parameter: string, constant: any) {
-        return this._simple(OperatorType.lt, parameter, constant);
+        return this.simple(EXPRESSION_TYPE.lt, parameter, constant);
     }
+
     /**
      * Adds a condition that a field must be `less than or equal` to a certain value. Applicable to Number, String, and Date fields.
-     * @method lte
-     * @memberOf WhereQuery.prototype
-     * @param {string} field Field name.
-     * @param {*} value Comparison value (that the field should be less than or equal to).
-     * @returns {WhereQuery}
      */
     lte(parameter: string, constant: any) {
-        return this._simple(OperatorType.le, parameter, constant);
+        return this.simple(EXPRESSION_TYPE.le, parameter, constant);
     }
+
     /**
      * Adds a condition that a field value must *start* with a specified string.
-     * @method startsWith
-     * @memberOf WhereQuery.prototype
-     * @param {string} field Field name.
-     * @param {string} value The string that the field should start with.
-     * @param {boolean} caseSensitive A flag indicating if tolower should be applied to the parameter
-     * @param {string} [options] A string of regex options to use. See [specs](http://docs.mongodb.org/manual/reference/operator/query/regex/#op._S_options) for a description of available options.
-     * @returns {WhereQuery}
      */
-    startsWith(parameter: string, constant: any, caseSensitive: boolean = true): WhereQuery {
-        return this._simple(OperatorType.startsWith, parameter, constant, caseSensitive);
+    startsWith(parameter: string, constant: any, caseSensitive = true) {
+        return this.simple(EXPRESSION_TYPE.startsWith, parameter, constant, caseSensitive);
     }
 
     /**
      * Adds a condition that a field value must *contain* a specified string.
-     * @method startsWith
-     * @memberOf WhereQuery.prototype
-     * @param {string} field Field name.
-     * @param {string} value The string that the field should start with.
-     * @param {boolean} caseSensitive A flag indicating if tolower should be applied to the parameter
-     * @param {string} [options] A string of regex options to use. See [specs](http://docs.mongodb.org/manual/reference/operator/query/regex/#op._S_options) for a description of available options.
-     * @returns {WhereQuery}
      */
-    contains(parameter: string, constant: any, caseSensitive: boolean = true) {
-        return this._simple(OperatorType.contains, parameter, constant, caseSensitive);
+    contains(parameter: string, constant: any, caseSensitive = true) {
+        return this.simple(EXPRESSION_TYPE.contains, parameter, constant, caseSensitive);
     }
 
     /**
      * Adds a condition that a field value must *end* with a specified string.
-     * @method endsWith
-     * @memberOf WhereQuery.prototype
-     * @param {string} field Field name.
-     * @param {string} value The string that the field should end with.
-     * @param {boolean} caseSensitive A flag indicating if tolower should be applied to the parameter
-     * @param {string} [options] A string of  regex options to use. See [specs](http://docs.mongodb.org/manual/reference/operator/query/regex/#op._S_options) for a description of available options.
-     * @returns {WhereQuery}
      */
-    endsWith(parameter: string, constant: any, caseSensitive: boolean = true) {
-        return this._simple(OperatorType.endsWith, parameter, constant, caseSensitive);
+    endsWith(parameter: string, constant: any, caseSensitive = true) {
+        return this.simple(EXPRESSION_TYPE.endsWith, parameter, constant, caseSensitive);
     }
 
     /**
      * Ends the definition of the current WhereQuery. You need to call this method in order to continue with the definition of the parent {@link QueryBase}. All other `WhereQuery` methods return the current instance of `WhereQuery` to allow chaining.
-     * @method done
-     * @memberOf WhereQuery.prototype
-     * @returns {Query}
      */
-    done() {
+    done(): QueryType {
         if (this.parent instanceof WhereQuery) {
-            this.parent._addComplexExpression(this);
+            this.parent.addComplexExpression(this);
             // TODO: If has and() || or() must call done() twice
-            if (this.expression.getType() === OperatorType.not)
+            if (this.expression.getType() === EXPRESSION_TYPE.not)
                 return this.parent;
         }
 
         return this.parent;
     }
 
-    _getExpression() {
+    getExpression(): ComplexExpression {
         return this.expression;
     }
 
-    private _addComplexExpression(subQuery): void {
-        var subExpression = subQuery._getExpression();
+    private simple(type: string, parameter: string, constant: any, caseSensitive = true): WhereQuery<QueryType> {
+        const currentExpr = new BinaryExpression(type, parameter, constant, caseSensitive);
+        const subExpressions = this.expression.getExpressions();
+        subExpressions.push(currentExpr);
+
+        if (this.expression.getType() === EXPRESSION_TYPE.not && subExpressions.length > 1)
+            throw new Error("Invalid operators count!");
+
+        return this;
+    }
+
+    private addComplexExpression(subQuery: WhereQuery<QueryType>): void {
+        const subExpression = subQuery.getExpression();
         this.expression.getExpressions().push(subExpression);
     }
 }

package/src/constants.ts

@@ -1,41 +1,60 @@
-const constants = {
-    ExpressionType: {
-        query: 1,
-        where: 100,
-        and: 'and',
-        or: 'or',
-        not: 'not',
-        eq: 'eq',
-        ne: 'ne',
-        lt: 'lt',
-        le: 'le',
-        gt: 'gt',
-        ge: 'ge',
-        any: 'any',
-        /*isin: 126,
-        notin: 127,
-        all: 128,
-        size: 129,
-        regex: 130,*/
-        contains: 'contains',
-        startsWith: 'startsWith',
-        endsWith: 'endsWith'
-    },
-    ODataParams: {
-        $filter: '$filter',
-        $select: '$select',
-        $expand: '$expand',
-        $orderby: '$orderby',
-        $skip: '$skip',
-        $top: '$top',
-        $count: '$count',
-        $search: '$search'
-    },
-    SfParams: {
-        provider: 'sf_provider',
-        culture: 'sf_culture',
-        siteId: 'sf_site'
-    }
+export const EXPRESSION_TYPE = {
+    query: 1,
+    where: 100,
+    and: 'and',
+    or: 'or',
+    not: 'not',
+    eq: 'eq',
+    ne: 'ne',
+    lt: 'lt',
+    le: 'le',
+    gt: 'gt',
+    ge: 'ge',
+    any: 'any',
+    contains: 'contains',
+    startsWith: 'startsWith',
+    endsWith: 'endsWith'
+}
+
+export const ODATA_PARAMS = {
+    $filter: '$filter',
+    $select: '$select',
+    $expand: '$expand',
+    $orderby: '$orderby',
+    $skip: '$skip',
+    $top: '$top',
+    $count: '$count',
+    $search: '$search'
+}
+
+export const SF_PARAMS = {
+    provider: 'sf_provider',
+    culture: 'sf_culture',
+    siteId: 'sf_site',
+    fallbackParams: "sf_fallback_prop_names",
+    parentId: "parentId"
+}
+
+export const HEADER_NAMES = {
+    contentType: "Content-Type",
+    authorization: "Authorization",
+    contentEncoding: "Content-Encoding",
+    operation: "X-Operation",
+    properties: "X-Sf-Properties",
+    fileName: "X-File-Name",
+    serviceRequest: "X-SF-Service-Request",
+    choicesBinaryRepresentation: "X-SF-Binary-Choice-Representation",
+    integrationMode: "X-SF-Integration-Mode"
+}
+
+export const HTTP_METHODS = {
+    get: "GET",
+    put: "PUT",
+    post: "POST",
+    patch: "PATCH",
+    delete: "DELETE"
 };
 
-export default constants;
+export const CONTENT_TYPES = {
+    json: "application/json"
+}

package/src/utils.ts

@@ -9,11 +9,15 @@
 
     static isBlob(obj: any): boolean {
         return obj instanceof Blob;
-    };
+    }
 
     static isNumber(value: any): boolean {
         return typeof value === 'number' && isFinite(value);
-    };
+    }
+
+    static isFunction(func: any): boolean {
+        return typeof func === 'function';
+    }
 
     static serializeToJSON(data): string {
         if (!utils.isString(data) && !this.isBlob(data)) {
@@ -28,12 +32,12 @@
             return null;
         }
 
-        var number = Number(data);
+        const number = Number(data);
         if (!isNaN(number)) {
             return number;
         }
 
-        var result = null;
+        let result = null;
 
         try {
             result = JSON.parse(data);
@@ -45,13 +49,13 @@
         return result;
     }
 
-    static convertDateFieldToISOString = function (data) {
+    static convertDateFieldToISOString(data: object): object {
         /*
         TODOSDK: when write tests for this try to use
         "Object.keys(obj).forEach(function(){})",
         Phantomjs does not recognize "for..in" operator.
         */
-        for (let obj in data) {
+        for (const obj in data) {
             if (data[obj] instanceof Date) {
                 data[obj] = data[obj].toISOString();
             }
@@ -64,19 +68,19 @@
         return Math.floor((1 + Math.random()) * 0x10000).toString(16).substr(1);
     }
 
-    static addTrailingSlash(url) {
+    static addTrailingSlash(url: string): string {
         url = utils.removeSlashes(url);
         url += '/';
         return url;
     }
 
-    static removeSlashes(url) {
-        var ret = url;
-        var fistChar = ret.substr(0, 1);
+    static removeSlashes(url: string) {
+        let ret = url;
+        const fistChar = ret.substr(0, 1);
         if (fistChar == '/')
             ret = ret.substr(1);
 
-        var lastChar = ret.substr(-1);
+        const lastChar = ret.substr(-1);
         if (lastChar == '/')
             ret = ret.substr(0, ret.length - 1);
 
@@ -84,11 +88,10 @@
     }
 
     static clone(from: any, to = {}, action: Function = null): any {
-
         if (!to)
             to = {};
 
-        for (var property in from) {
+        for (const property in from) {
             if (from[property] && from[property].constructor && from[property].constructor === Object && typeof from[property] == 'function') {
                 to[property] = to[property]|| { };
                 arguments.callee(to[property], from[property]);
@@ -104,7 +107,7 @@
     }
 
     private static _parseDateProperties(data) {
-        for (var obj in data) {
+        for (const obj in data) {
             // TODO
             if (data[obj] instanceof Array || (data[obj] instanceof Object && <any>!data[obj] instanceof Function))
                 this._parseDateProperties(data[obj]);

package/template.html

@@ -23,7 +23,7 @@
 
         }
 
-        var query = new Sitefinity.Query();
+        var query = new Sitefinity.Sitefinity.Query();
 
         var query0 = query.where().and().endsWith("Title", "Record").done().or().startsWith('Title', 'asd').done().done();
         var query1 = query.where().or().endsWith("Record", "Title").ne('age', '15').eq('Content', 'test').done().done();
@@ -64,10 +64,10 @@
 
         var entitySet = "newsitems";
 
+        //Replace 'sitefinityUrl' with the location of the server you are using
         var sitefinityUrl = "http://localhost"
-        //Replace my_sandbox_location with the location of the server you are using
         var options = {
-            serviceUrl: sitefinityUrl + "/api/default/",
+            baseUrl: sitefinityUrl + "/api/default/",
             handlers: {
                 failureCb: function() {
                     console.log("Global error occured");
@@ -78,19 +78,9 @@
             }
         }
 
-        // operation data
-        var action = {
-            action: "Publish",
-            actionParameters: {
-                Title: "SomeTitle",
-                PublicationDate: "2016-06-21T06:26:32.7439661Z",
-                ExpirationDate: "2016-06-21T06:26:32.7439661Z"
-            }
-        };
-
         // Sitefinity object
-        var sf = new Sitefinity(options);
-        sf.authentication.setToken("");
+        var sf = new Sitefinity.Sitefinity(options);
+        sf.setToken("");
 
         var inputElement = document.getElementById('getGuid');
         var that = this;
@@ -113,13 +103,23 @@
                 });
             }
             document.getElementById("containerErr").innerHTML = JSON.stringify(data.responseText);
-        }
+        };
 
         var dataOptions = {
-            urlName: entitySet,
-            providerName: "OpenAccessDataProvider",
-            cultureName: "en"
-        }
+            entitySet,
+            provider: "OpenAccessDataProvider",
+            culture: "en"
+        };
+
+        // operation data
+        var action = {
+            action: "Publish",
+            actionParameters: {
+                Title: "SomeTitle",
+                PublicationDate: "2016-06-21T06:26:32.7439661Z",
+                ExpirationDate: "2016-06-21T06:26:32.7439661Z"
+            }
+        };
 
         function requestGet() {
             var data = sf.data(dataOptions);
@@ -129,10 +129,10 @@
             });
         }
 
-        function requestGetCount(inline) {
+        function requestGetCount() {
             var data = sf.data(dataOptions);
             data.get({
-                query: query.count(inline),
+                query: query.count(),
                 successCb: successCb
             });
         }
@@ -151,7 +151,7 @@
             var data = sf.data(dataOptions);
             data.getRelated({
                 key: getGuid(),
-                navigationProperty: "Tags",
+                property: "Tags",
                 successCb: successCb,
                 failureCb: failureCb
             });
@@ -223,7 +223,7 @@
             var createRefLink = "http://localhost:8097/api/odata/flatTaxa(" + getRelatedGuid() + ")";
             data.createRelated({
                 key: getGuid(),
-                navigationProperty: "Tags",
+                property: "Tags",
                 link: createRefLink,
                 successCb: successCb,
                 failureCb: failureCb
@@ -234,7 +234,7 @@
             var data = sf.data(dataOptions);
             data.destroyRelated({
                 key: getGuid(),
-                navigationProperty: "Tags",
+                property: "Tags",
                 successCb: successCb,
                 failureCb: failureCb
             });
@@ -347,7 +347,7 @@
                     result = btoa(result)
 
                     var data = sf.data({
-                        urlName: "images"
+                        entitySet: "images"
                     });
                     data.upload({  /* POST */
                         data: {
@@ -393,13 +393,12 @@
             return inputElement.value;
         }
 
-        function login(username, password) {
-            var url = sitefinityUrl + "/Sitefinity/Authenticate/OpenID/connect/token";
+        function login() {
+            var url = sitefinityUrl + "/Sitefinity/oauth/token";
             var data = {
-                username: username,
-                password: password,
+                username: "",
+                password: "",
                 grant_type: "password",
-                scope: "openid",
                 client_id: "iris",
                 client_secret: "secret"
             };
@@ -425,7 +424,7 @@
                         value: token.access_token
                     };
 
-                    sf.authentication.setToken(tokenObj);
+                    sf.setToken(tokenObj);
                 }
             });
 
@@ -437,14 +436,13 @@
     </script>
     Usage: <br /><code>
         <b>
-            sf = new Sitefinity(options);<br />data = sf.data(entitySet);<br />data.get(); data.destroy ...
+            sf = new Sitefinity(options);<br />data = sf.data(dataOptions);<br />data.get(); data.destroy ...
             <br />data.batch(successCb, failureCb).get().Update...done(); content id's starts from 0 to n ('get' is 0 'update' is 1 etc.).
         </b>
     </code><br /><br />
     <input type="button" value="login" onclick="login()" />
     <input type="button" value="requestGet" onclick="requestGet()" />
-    <input type="button" value="requestGetCountInline" onclick="requestGetCount(true)" />
-    <input type="button" value="requestGetCount" onclick="requestGetCount(false)" />
+    <input type="button" value="requestGetCount" onclick="requestGetCount()" />
     <input type="button" value="requestGetSingle" onclick="requestGetSingle()" />
     <input type="button" value="requestGetRelated" onclick="requestGetRelated()" />
     <input type="button" value="requestUpdate" onclick="requestUpdate()" />

package/tsconfig.json

@@ -3,6 +3,8 @@
     "target": "es5",
     "module": "commonjs",
     "moduleResolution": "node",
+    "declaration": true,
+    "outDir": "dist",
     "sourceMap": true,
     "emitDecoratorMetadata": true,
     "experimentalDecorators": true,
@@ -11,7 +13,7 @@
     "noEmitHelpers": true,
     "importHelpers": true,
     "noUnusedLocals": true,
-    "noEmit": true,
+    "noEmit": false,
     "typeRoots": [
       "node_modules/@types"
     ],
@@ -19,5 +21,10 @@
       "es6",
       "dom"
     ]
+  },
+  "typedocOptions": {
+    "entryPoints": [ "./src" ],
+    "out": "dist/docs",
+    "entryPointStrategy": "expand"
   }
 }

package/type.txt

@@ -1 +1 @@
-minor
+patch

package/config/html.conf.json

@@ -1,5 +0,0 @@
-{
-  "filename": "index.html",
-  "template": "template.html",
-  "inject": "head"
-}