@progress/sitefinity-webservices-sdk 1.1.15 → 2.0.0

package/src/Query.ts

@@ -1,106 +0,0 @@
-import { QueryBase } from "./QueryBase";
-import { WhereQuery } from "./WhereQuery";
-import { OrderProperty } from "./OrderProperty";
-import { QueryBuilder } from "./QueryBuilder";
-
-/**
- * The query class is used for constructing queries.
- * @example
- * const query = new Sitefinity.Query();
- * const query0 = query.where().and().endsWith("Title", "Record").done().or().startsWith('Title', 'asd').done().done();
- * const query1 = query.where().or().endsWith("Record", "Title").ne('age', '15').eq('Content', 'test').done().done();
- * const query2 = query.where().and().endsWith("Title", "Record").done().done();
- * const query3 = query.where().endsWith("Record", "Title").or().ne('age', '15').eq('Content', 'test').done().done();
- * const query4 = query.where().not().endsWith("Record", "Title").done().and().not().eq('Content', 'test').done().done().done();
- * const query5 = query.where().not().and().endsWith("Record", "Title").eq('Content', 'test').done().done().done();
- * const query6 = query.select("Id", "Title", "Content").expand('Tags').order("Title desc").where().ne('Title', 'zzz').eq('Title', 'newTitle').done()//.count();
- * const query7 = query.order("Title desc").where().eq('Title', 'newTitleUPDATE1').done().select("Title", "Content");
- * const query8 = query.where().eq('Title', 'newTitleN11').done();
- */
-export class Query extends QueryBase {
-    orderProperties: OrderProperty[] = null;
-    skipValue: number = null;
-    takeValue: number = null;
-    searchValue: string = null;
-    inlineCount: boolean;
-    filter: WhereQuery<Query> = null;
-
-    constructor() {
-        super();
-    }
-
-    /**
-    * Begins a where clause for filtering the items.
-    */
-    where(): WhereQuery<Query> {
-        const clone: Query = this.clone((newObj: Query) => {
-            newObj.filter = new WhereQuery(newObj);
-        });
-
-        return clone.filter;
-    }
-
-    /**
-    * Specifies the order by clause.
-    * @example
-    * order by single field
-    * order("Title desc")
-    * @example
-    * order by multiple fields
-    * order("Title desc", "Description asc")
-    */
-    order(...properties: string[]): Query {
-        properties = properties ?? [];
-        this.validatePropertyPaths(properties);
-
-        return this.clone((newObj: Query) => {
-            const orderItems: OrderProperty[] = [];
-            for (let i = 0; i < properties.length; i++) {
-                const member = properties[i];
-                const orderProp = new OrderProperty(member);
-                orderItems.push(orderProp);
-            }
-            newObj.orderProperties = orderItems;
-        });
-    }
-
-    /**
-    * Skips a certain number of items from the beginning before returning the rest of the items. Used for paging.
-    */
-    skip(value: number): Query {
-        return this.clone((newObj: Query) => {
-            newObj.skipValue = value;
-        });
-    }
-
-    /**
-    * Takes a specified number of items from the query result. Used for paging.
-    */
-    take(value: number): Query {
-        return this.clone((newObj: Query) => {
-            newObj.takeValue = value;
-        });
-    }
-
-    /**
-    * Searches for the items matching the specified expression.
-    */
-    search(value: string): Query {
-        return this.clone((newObj: Query) => {
-            newObj.searchValue = value;
-        });
-    }
-
-    /**
-    * Returns the total item count with the result. Used for paging.
-    */
-    count(inline = true): Query {
-        return this.clone((newObj: Query) => {
-            newObj.inlineCount = inline;
-        });
-    }
-
-    build() {
-        return new QueryBuilder(this).build();
-    }
-}

package/src/QueryBase.ts

@@ -1,57 +0,0 @@
-import { utils } from "./utils";
-
-/**
- * The base class for dealing with queries.
- */
-export class QueryBase {
-    selectProperties: string[];
-    expandProperties: string[];
-
-    constructor() {
-        this.selectProperties = null;
-        this.expandProperties = null;
-    }
-
-    /**
-    * Selects which fields will be returned when querying the service.
-    */
-    select(...properties: string[]): QueryBase {
-        properties = properties ?? [];
-
-        this.validatePropertyPaths(properties);
-
-        return this.clone((newObj: QueryBase) => {
-            newObj.selectProperties = properties.filter((prop, index, props) => props.indexOf(prop) === index);
-        });
-    }
-
-    /**
-    * Selects which navigation properties will be returned when querying the service.
-    */
-    expand(...properties: string[]): QueryBase {
-        properties = properties ?? [];
-        this.validatePropertyPaths(properties);
-
-        return this.clone((newObj: QueryBase) => {
-            newObj.expandProperties = properties.filter((prop, index, props) => props.indexOf(prop) === index);
-        });
-    }
-
-    protected validatePropertyPaths(propPaths: string[], allowNested = false) {
-        for (let i = 0; i < propPaths.length; i++) {
-            const member = propPaths[i];
-            if (!utils.isString(member)) {
-                throw new Error("Invalid argument in clause");
-            }
-
-            if (!allowNested && member.indexOf(".") > -1) {
-                throw new Error("Invalid argument in clause");
-            }
-        }
-    }
-
-    protected clone(setter: Function = null) {
-        const newObj = utils.clone(this, new QueryBase(), setter);
-        return newObj;
-    }
-}

package/src/QueryBuilder.ts

@@ -1,180 +0,0 @@
-import { WhereQuery } from "./WhereQuery";
-import { ComplexExpression, BinaryExpression } from "./Expression";
-import { OrderProperty } from "./OrderProperty";
-import { utils } from "./utils";
-import { ODATA_PARAMS, EXPRESSION_TYPE } from "./constants";
-import { Query } from "./Query";
-
-export class QueryBuilder {
-    constructor(private query: Query) {
-    }
-
-    build(): { [key: string]: string } {
-        const queryParameters = {};
-        const whereClause = this.query.filter;
-        if (whereClause instanceof WhereQuery) {
-            const expression = whereClause.getExpression();
-            if (expression instanceof ComplexExpression) {
-                const result = this.buildComplexExpression(expression, null);
-                if (result) {
-                    queryParameters[ODATA_PARAMS.$filter] = result;
-                }
-            }
-        }
-
-        const selectClause = this.query.selectProperties;
-        if (selectClause instanceof Array) {
-            queryParameters[ODATA_PARAMS.$select] = selectClause.join(", ");
-        }
-
-        const expandClause = this.query.expandProperties;
-        if (expandClause instanceof Array)
-            queryParameters[ODATA_PARAMS.$expand] = expandClause.join(", ");
-
-        const orderByClause = this.query.orderProperties;
-        if (orderByClause instanceof Array) {
-            const order = [];
-            for (const i in orderByClause) {
-                if (orderByClause[i] instanceof OrderProperty)
-                    order.push(orderByClause[i].getValue());
-            }
-            queryParameters[ODATA_PARAMS.$orderby] = order.join(", ");
-        }
-
-        const take = this.query.takeValue;
-        if (utils.isNumber(take))
-            queryParameters[ODATA_PARAMS.$top] = take;
-
-        const skip = this.query.skipValue;
-        if (utils.isNumber(skip))
-            queryParameters[ODATA_PARAMS.$skip] = skip;
-
-        const search = this.query.searchValue;
-        if (search)
-            queryParameters[ODATA_PARAMS.$search] = search;
-
-        if (this.query.inlineCount !== null) {
-            queryParameters[ODATA_PARAMS.$count] = this.query.inlineCount;
-        }
-
-        return queryParameters;
-    }
-
-    private buildComplexExpression(expression: ComplexExpression, parent: string): string {
-        if (!(expression instanceof ComplexExpression))
-            throw new Error("Invalid complex expression");
-
-        let counter = 0;
-        let result = "";
-        const subExpressions = expression.getExpressions();
-        if (!subExpressions.length) {
-            return result;
-        }
-
-        while (true) {
-            const currentExp = subExpressions[counter];
-            if (currentExp instanceof BinaryExpression) {
-                result += this.buildBinaryExpression(currentExp);
-            }
-            else if (currentExp instanceof ComplexExpression) {
-                const complexResult = this.buildComplexExpression(currentExp, expression.type);
-                if (complexResult) {
-                    result += "(" + complexResult + ")";
-                }
-            }
-
-            if (expression.getType() === EXPRESSION_TYPE.not)
-                result = expression.getType() + " " + result;
-            // TODOSDK: Rethink this!
-            if (expression.getType() === EXPRESSION_TYPE.any) {
-                const exprVal = [];
-                for (let index = 0; index < subExpressions.length; index++) {
-                    if (subExpressions[index].type == EXPRESSION_TYPE.contains || subExpressions[index].type == EXPRESSION_TYPE.startsWith || subExpressions[index].type == EXPRESSION_TYPE.endsWith)
-                        exprVal.push(subExpressions[index].type.toLowerCase() + "(x, '" + (subExpressions[index] as BinaryExpression).constant + "')");
-                    else
-                        exprVal.push("x " + subExpressions[index].type.toLowerCase() + " " + this.checkType((subExpressions[index] as BinaryExpression).constant));
-                }
-                result = (currentExp as BinaryExpression).parameter + "/" + expression.getType() + "(x:" + exprVal.join(" " + parent + " ") + ")";
-            }
-
-            counter++;
-            if (counter == subExpressions.length)
-                break;
-
-            result += " " + expression.getType() + " ";
-        }
-
-        return result;
-    }
-
-    private buildBinaryExpression(expression: BinaryExpression): string {
-        let result: string = null;
-        const type = expression.getType();
-        switch (type) {
-        case EXPRESSION_TYPE.eq:
-        case EXPRESSION_TYPE.ne:
-        case EXPRESSION_TYPE.lt:
-        case EXPRESSION_TYPE.le:
-        case EXPRESSION_TYPE.gt:
-        case EXPRESSION_TYPE.ge: {
-            const constant = expression.getConstant();
-            result = `(${expression.getParameter()} ${type} ${this.checkType(constant)})`;
-            break;
-        }
-        case EXPRESSION_TYPE.contains:
-        case EXPRESSION_TYPE.startsWith:
-        case EXPRESSION_TYPE.endsWith: {
-            const expressionParameter = this.applyCaseSensitiveSettings(expression, expression.getParameter());
-            const expressionConstant =  this.checkType(expression.getConstant(), true);
-            const expressionValue = this.applyCaseSensitiveSettings(expression, expressionConstant);
-
-            result = `${type.toLowerCase()}(${expressionParameter}, ${expressionValue})`;
-            break;
-        }
-        case EXPRESSION_TYPE.in: {
-            const valueArray = expression.getConstant();
-            if (!Array.isArray(valueArray)) {
-                throw new Error("Parameter is not an array!");
-            }
-
-            result = `${expression.getParameter()} in (${valueArray.join(", ")})`;
-            break;
-        }
-        default: {
-            const msg = `Unsupported operator ${type}`;
-            throw new Error(msg);
-        }
-        }
-
-        return result;
-    }
-
-    private applyCaseSensitiveSettings(expression: BinaryExpression, value: string): string {
-        if (expression.isCaseSensitive()) {
-            return value;
-        }
-
-        return `tolower(${value})`;
-    }
-
-    private checkType(constant: any, treatAsString = false): string {
-        if (this.isGuid(constant) && !treatAsString)
-            return constant;
-
-        if (constant == null)
-            return null;
-
-        constant = constant.replace(/[+/?%#&]/g, function ($0) {
-            return encodeURIComponent($0);
-        });
-
-        // escapes the apostrophes
-        constant = constant.replace(/'/g, "''");
-
-        return "'" + constant + "'";
-    }
-
-    private isGuid(constant: string): boolean {
-        return /^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$/.test(constant);
-    }
-}