@progress/sitefinity-webservices-sdk 0.3.1 → 1.0.3

package/src/Data.ts

@@ -1,68 +1,49 @@
-/**
-* @class Data
-* @classdesc The constructor of the Data object. This object is used for requesting data from Sitefinity.
-* @param {object} urlOptions - An object containing configuration options for the {@link Data} object.
-* @param {string} urlOptions.baseUrl - Your service url that points to the configured instance of Sitefinity service.
-* @param {string} urlOptions.entitySet - The url name of the type.
-* @param {object} urlOptions.SFParams - An object containing configuration options for requests.
-* @param {string} urlOptions.SFParams.provider - The provider name to use in each request.
-* @param {string} urlOptions.SFParams.culture - The culture name to use in each request.
+import { SF_PARAMS } from "./constants";
+import { Query } from "./Query";
+import { ExecutableRequest } from "./Requests/ExecutableRequest";
+import { RequestFactory } from "./Requests/RequestFactory";
+import { TypeOptions } from "./Sitefinity";
+
+/**
+* The constructor of the Data object. This object is used for requesting data from Sitefinity.
 */
 export class Data {
-    private urlOptions: any;
-    private factory: any;
+    private urlOptions: TypeOptions;
+    private factory: RequestFactory;
 
-    constructor(urlOptions, factory) {
+    constructor(urlOptions: TypeOptions, factory: RequestFactory) {
         this.urlOptions = urlOptions;
         this.factory = factory;
     }
 
-    // TODO: rethink this
     /**
     * Executes a GET request to retrieve a collection of items.
-    * @memberOf Data
-    * @instance
-    * @param {object} parameters - The parameters for the request.
-    * @param {string} parameters.action - The OData action along with its parameters.
-    * @param {object} parameters.query - The {@link WhereQuery} with which to filter the items.
-    * @param {Function} parameters.successCb - The success callback function.
-    * @param {Function} parameters.failureCb - The error callback function.
     */
-    get(parameters: any) {
-        parameters = parameters || {};
-
-        // TODO: move to Request
-        if (parameters.query)
-            this.urlOptions.ODataParams = parameters.query;
-
-        var request = this.factory.get({
+    get(parameters: RequestOptionsBase) {
+        const request = this.factory.get({
             urlOptions: this.urlOptions,
+            query: parameters.query,
             action: parameters.action,
             successCb: parameters.successCb,
             failureCb: parameters.failureCb,
             fallbackProperties: parameters.fallbackProperties
         });
 
-        request._execute();
+        request.execute();
     }
 
     /**
     * Executes a GET request to retrieve an/all item(s) operations.
-    * @memberOf Data
-    * @instance
-    * @param {object} parameters - The parameters for the request.
-    * @param {Function} parameters.successCb - The success callback function.
-    * @param {Function} parameters.failureCb - The error callback function.
     */
-    getOperations(parameters: any) {
-        var request;
-        var action = "operations";
+    getOperations(parameters: OperationsRequestOptions) {
+        let request: ExecutableRequest;
+        let action = "operations";
 
         // Set parentId if no item key is passed
         if (!parameters.key)
-            action += "?parentId=" + parameters.parentId;
+            action += `?${SF_PARAMS.parentId}=` + parameters.parentId;
 
-        var params: any = {
+        const params: any = {
             urlOptions: this.urlOptions,
             action: action,
             successCb: parameters.successCb,
@@ -76,88 +57,59 @@ export class Data {
             request = this.factory.get(params);
         }
 
-        request._execute();
+        request.execute();
     }
 
     /**
     * Executes a GET request for a single item.
-    * @memberOf Data
-    * @instance
-    * @param {object} parameters - The parameters for the request.
-    * @param {object} parameters.query - The {@link QueryBase} object containing the OData query options that should be sent to the server.
-    * @param {string} parameters.key - The identifier of the item to be retrieved.
-    * @param {string} parameters.action - The OData action along with its parameters.
-    * @param {Function} parameters.successCb - The success callback function.
-    * @param {Function} parameters.failureCb - The error callback function.
     */
-    getSingle(parameters: any) {
+    getSingle(parameters: RequestOptionsBase) {
         if (!(parameters.key))
             throw "Parameter 'key' is required!";
 
-        if (parameters.query)
-            this.urlOptions.ODataParams = parameters.query;
-
-        var request = this.factory.getSingle({
+        const request = this.factory.getSingle({
             urlOptions: this.urlOptions,
             key: parameters.key,
+            query: parameters.query,
             action: parameters.action,
             successCb: parameters.successCb,
             failureCb: parameters.failureCb,
             fallbackProperties: parameters.fallbackProperties
         });
 
-        request._execute();
+        request.execute();
     }
 
     /**
     * Executes a POST request for a single item.
-    * @memberOf Data
-    * @instance
-    * @param {object} parameters - The parameters for the request.
-    * @param {string} parameters.key - The identifier of the item.
-    * @param {object} parameters.data - The payload of the request.
-    * @param {string} parameters.action - The OData action along with its parameters.
-    * @param {Function} parameters.successCb - The success callback function.
-    * @param {Function} parameters.failureCb - The error callback function.
     */
-    create(parameters: any) {
+    create(parameters: CreateRequestOptions) {
         if (!(parameters.data))
             throw "Parameter 'data' is required!";
 
-        if (parameters.query)
-            this.urlOptions.ODataParams = parameters.query;
-
-        var request = this.factory.create({
+        const request = this.factory.create({
             urlOptions: this.urlOptions,
             key: parameters.key,
+            query: parameters.query,
             data: parameters.data,
             action: parameters.action,
             successCb: parameters.successCb,
             failureCb: parameters.failureCb
         });
 
-        request._execute();
+        request.execute();
     }
 
     /**
     * Executes a PATCH request to update a single item.
-    * @memberOf Data
-    * @instance
-    * @param {object} parameters - The parameters for the request.
-    * @param {bool} parameters.saveTemp - A flag indicating whether to save in temp.
-    * @param {string} parameters.key - The identifier of the item to be updated.
-    * @param {object} parameters.data - The payload of the request.
-    * @param {string} parameters.action - The OData action along with its parameters.
-    * @param {Function} parameters.successCb - The success callback function.
-    * @param {Function} parameters.failureCb - The error callback function.
     * @example
-    * var data = sf.data({
-    *     urlName: "newsitems",
-    *     providerName: "OpenAccessDataProvider",
-    *     cultureName: "en"
+    * const data = sf.data({
+    *     entitySet: "newsitems",
+    *     provider: "OpenAccessDataProvider",
+    *     culture: "en"
     * });
     *
-    * var newsItemUpdate =  {
+    * const newsItemUpdate =  {
     *    "Title": 'updated news title'
     * };
     *
@@ -169,11 +121,11 @@ export class Data {
     *   failureCb: failureCb
     * });
     */
-    update(parameters: any) {
+    update(parameters: UpdateRequestOptions) {
         if (!(parameters.key || parameters.data))
             throw "Parameters: 'data' and 'key' are required!";
 
-        var request = this.factory.update({
+        const request = this.factory.update({
             urlOptions: this.urlOptions,
             key: parameters.key,
             data: parameters.data,
@@ -183,47 +135,34 @@ export class Data {
             failureCb: parameters.failureCb
         });
 
-        request._execute();
+        request.execute();
     }
 
     /**
     * Executes a DELETE request to delete a single item.
-    * @memberOf Data
-    * @instance
-    * @param {object} parameters - The parameters for the request.
-    * @param {string} parameters.key - The identifier of the item to be deleted.
-    * @param {Function} parameters.successCb - The success callback function.
-    * @param {Function} parameters.failureCb - The error callback function.
     */
-    destroy(parameters: any) {
+    destroy(parameters: RequestOptionsBase) {
         if (!(parameters.key))
             throw "Parameter 'key' is required!";
 
-        var request = this.factory.destroy({
+        const request = this.factory.destroy({
             urlOptions: this.urlOptions,
             key: parameters.key,
             successCb: parameters.successCb,
             failureCb: parameters.failureCb
         });
 
-        request._execute();
+        request.execute();
     }
 
     /**
     * Executes a POST request to execute a workflow operation for single item.
-    * @memberOf Data
-    * @instance
-    * @param {object} parameters - The parameters for the request.
-    * @param {string} parameters.key - The identifier of the item.
-    * @param {object} parameters.data - The payload of the request.
-    * @param {Function} parameters.successCb - The success callback function.
-    * @param {Function} parameters.failureCb - The error callback function.
     */
-    operation(parameters: any) {
+    operation(parameters: CreateRequestOptions) {
         if (!(parameters.key || parameters.data))
             throw "Parameters: 'data' and 'key' are required!";
 
-        var request = this.factory.create({
+        const request = this.factory.create({
             urlOptions: this.urlOptions,
             key: parameters.key,
             action: "operation",
@@ -232,186 +171,130 @@ export class Data {
             failureCb: parameters.failureCb
         });
 
-        request._execute();
+        request.execute();
     }
 
     /**
     * Executes a GET request to get the property of a single item.
-    * @memberOf Data
-    * @instance
-    * @param {object} parameters - The parameters for the request.
-    * @param {string} parameters.key - The identifier of the item.
-    * @param {string} parameters.property - The name of the property to be retrieved.
-    * @param {Function} parameters.successCb - The success callback function.
-    * @param {Function} parameters.failureCb - The error callback function.
     */
-    getProperty(parameters: any) {
+    getProperty(parameters: PropertyRequestOptions) {
         if (!(parameters.key || parameters.property))
             throw "Parameters: 'data' and 'property' are required!";
 
-        var request = this.factory.getProperty({
+        const request = this.factory.getProperty({
             urlOptions: this.urlOptions,
             key: parameters.key,
-            navigationProperty: parameters.property,
+            property: parameters.property,
             successCb: parameters.successCb,
             failureCb: parameters.failureCb
         });
 
-        request._execute();
+        request.execute();
     }
 
     /**
     * Executes a GET request to get the related property value of a single item.
-    * @memberOf Data
-    * @instance
-    * @param {object} parameters - The parameters for the request.
-    * @param {string} parameters.key - The identifier of the item.
-    * @param {string} parameters.navigationProperty - The name of the navigation property to be retrieved.
-    * @param {Function} parameters.successCb - The success callback function.
-    * @param {Function} parameters.failureCb - The error callback function.
     */
-    getRelated(parameters: any) {
-        if (!(parameters.key || parameters.navigationProperty))
-            throw "Parameters: 'data' and 'navigationProperty' are required!";
+    getRelated(parameters: PropertyRequestOptions) {
+        if (!(parameters.key || parameters.property))
+            throw "Parameters: 'data' and 'property' are required!";
 
-        var request = this.factory.getRelated({
+        const request = this.factory.getRelated({
             urlOptions: this.urlOptions,
             key: parameters.key,
-            navigationProperty: parameters.navigationProperty,
+            property: parameters.property,
             successCb: parameters.successCb,
             failureCb: parameters.failureCb
         });
 
-        request._execute();
+        request.execute();
     }
 
     /**
     * Executes a GET request to retrieve the related property value of a single item by the id of the related item.
-    * @memberOf Data
-    * @instance
-    * @param {object} parameters - The parameters for the request.
-    * @param {string} parameters.key - The identifier of the item.
-    * @param {string} parameters.navigationProperty - The name of the navigation property to be retrieved.
-    * @param {string} parameters.relatedKey - The identifier of the related item.
-    * @param {Function} parameters.successCb - The success callback function.
-    * @param {Function} parameters.failureCb - The error callback function.
     */
-    getRelatedById(parameters: any) {
-        if (!(parameters.key || parameters.navigationProperty || parameters.relatedKey))
-            throw "Parameters: 'data', 'relatedKey' and 'navigationProperty' are required!";
+    getRelatedById(parameters: SingleRelatedItemRequestOptions) {
+        if (!(parameters.key || parameters.property || parameters.relatedId))
+            throw "Parameters: 'data', 'relatedId' and 'property' are required!";
 
-        var request = this.factory.getRelatedById({
+        const request = this.factory.getRelatedById({
             urlOptions: this.urlOptions,
             key: parameters.key,
-            relatedKey: parameters.relatedKey,
-            navigationProperty: parameters.navigationProperty,
+            relatedId: parameters.relatedId,
+            property: parameters.property,
             successCb: parameters.successCb,
             failureCb: parameters.failureCb
         });
 
-        request._execute();
+        request.execute();
     }
 
     /**
     * Executes a DELETE request to retrieve the delete all of the associated members in the relation property.
-    * @memberOf Data
-    * @instance
-    * @param {object} parameters - The parameters for the request.
-    * @param {string} parameters.key - The identifier of the item.
-    * @param {string} parameters.navigationProperty - The name of the navigation property.
-    * @param {Function} parameters.successCb - The success callback function.
-    * @param {Function} parameters.failureCb - The error callback function.
     */
-    destroyRelated(parameters: any) {
-        if (!(parameters.key || parameters.navigationProperty))
-            throw "Parameters: 'data' and 'navigationProperty' are required!";
+    destroyRelated(parameters: PropertyRequestOptions) {
+        if (!(parameters.key || parameters.property))
+            throw "Parameters: 'data' and 'property' are required!";
 
-        var request = this.factory.destroyRelated({
+        const request = this.factory.destroyRelated({
             urlOptions: this.urlOptions,
             key: parameters.key,
-            navigationProperty: parameters.navigationProperty,
+            property: parameters.property,
             successCb: parameters.successCb,
             failureCb: parameters.failureCb
         });
 
-        request._execute();
+        request.execute();
     }
 
     /**
     * Executes a DELETE request to retrieve the a single entry of the associated members in the relation property.
-    * @memberOf Data
-    * @instance
-    * @param {object} parameters - The parameters for the request.
-    * @param {string} parameters.key - The identifier of the item.
-    * @param {string} parameters.navigationProperty - The name of the navigation property.
-    * @param {string} parameters.relatedKey - The identifier of the related item.
-    * @param {Function} parameters.successCb - The success callback function.
-    * @param {Function} parameters.failureCb - The error callback function.
     */
-    destroyRelatedById(parameters: any) {
-        if (!(parameters.key || parameters.navigationProperty || parameters.relatedKey))
-            throw "Parameters: 'data', 'relatedKey' and 'navigationProperty' are required!";
+    destroyRelatedById(parameters: SingleRelatedItemRequestOptions) {
+        if (!(parameters.key || parameters.property || parameters.relatedId))
+            throw "Parameters: 'data', 'relatedId' and 'property' are required!";
 
-        var request = this.factory.destroyRelatedById({
+        const request = this.factory.destroyRelatedById({
             urlOptions: this.urlOptions,
             key: parameters.key,
-            relatedKey: parameters.relatedKey,
-            navigationProperty: parameters.navigationProperty,
+            relatedId: parameters.relatedId,
+            property: parameters.property,
             successCb: parameters.successCb,
             failureCb: parameters.failureCb
         });
 
-        request._execute();
+        request.execute();
     }
 
     /**
     * Executes a POST request to add a related item to the property collection.
-    * @memberOf Data
-    * @instance
-    * @param {object} parameters - The parameters for the request.
-    * @param {string} parameters.key - The identifier of the item.
-    * @param {string} parameters.navigationProperty - The name of the navigation property.
-    * @param {string} parameters.link - The URL of the related item.
-    * @param {Function} parameters.successCb - The success callback function.
-    * @param {Function} parameters.failureCb - The error callback function.
     */
-    createRelated(parameters: any) {
-        if (!(parameters.key || parameters.navigationProperty || parameters.link))
-            throw "Parameters: 'data', 'link' and 'navigationProperty' are required!";
+    createRelated(parameters: CreateRelatedRequestOptions) {
+        if (!(parameters.key || parameters.property || parameters.link))
+            throw "Parameters: 'data', 'link' and 'property' are required!";
 
-        var data = {
+        const data = {
             "@odata.id": parameters.link
         }
 
-        var request = this.factory.createRelated({
+        const request = this.factory.createRelated({
             urlOptions: this.urlOptions,
             key: parameters.key,
-            navigationProperty: parameters.navigationProperty,
+            property: parameters.property,
             data: data,
             successCb: parameters.successCb,
             failureCb: parameters.failureCb
         });
 
-        request._execute();
+        request.execute();
     }
 
     /**
     * Executes a POST request to upload a media item.
-    * @memberOf Data
-    * @instance
-    * @param {object} parameters - The parameters for the request.
-    * @param {string} parameters.data - The data to be uploaded.
-    * @param {string} parameters.data.content - The base64 representation of the media item.
-    * @param {string} parameters.data.contentType - The content type of the item. E.g. image/jpeg.
-    * @param {string} parameters.data.name - The name of the media item.
-    * @param {string} parameters.data.payload - Holds the JSON metadata about the image. E.g. Title, Urlname etc.
-    * @param {string} parameters.data.uploadProperties - The properties passed on upload. Must contain ParentId and can contain FolderId, Title, UrlName, etc.
-    * @param {Function} parameters.successCb - The success callback function.
-    * @param {Function} parameters.failureCb - The error callback function.
     * @example
     *
-    * var data = sf.data({
-    *     urlName: "images"
+    * const data = sf.data({
+    *     entitySet: "images"
     * });
     * data.upload({
     *     data: {
@@ -420,7 +303,7 @@ export class Data {
     *         name: "test.jpg",
     *         payload: {
     *             Title: "Test",
-    *             UrlName: "test"
+    *             entitySet: "test"
     *         },
     *         uploadProperties: {
     *             ParentId: "4BA7AD46-F29B-4E65-BE17-9BF7CE5BA1FB"
@@ -430,21 +313,21 @@ export class Data {
     *     failureCb: failureCb
     * });
     */
-    upload(parameters: any) {
+    upload(parameters: UploadRequestOptions) {
         if (!(parameters || parameters.data || parameters.data.content || parameters.data.contentType || parameters.data || parameters.data.name || parameters.data.uploadProperties))
             throw "parameters: content, contentType, name and uploadProperties are required!";
 
-        var options = {
+        const options = {
             urlOptions: this.urlOptions,
             _factory: this.factory,
             successCb: parameters.successCb,
             failureCb: parameters.failureCb
         }
 
-        var batch = this.factory.batch(options);
-        var transaction = batch.beginTransaction();
+        const batch = this.factory.batch(options);
+        const transaction = batch.beginTransaction();
 
-        var uploadedFile = transaction.upload({
+        const uploadedFile = transaction.upload({
             entitySet: this.urlOptions.entitySet,
             data: parameters.data.content,
             contentType: parameters.data.contentType,
@@ -470,8 +353,50 @@ export class Data {
         }
 
         batch.endTransaction(transaction);
-        var executor = this.factory.createExecutor(batch);
-        executor._execute();
+        batch.execute();
     }
 }
 
+export interface RequestOptionsBase {
+    query?: Query;
+    action?: string;
+    successCb?: Function;
+    failureCb?: Function;
+    fallbackProperties?: string[];
+    key?: string | number;
+}
+
+export interface OperationsRequestOptions extends RequestOptionsBase {
+    parentId?: string;
+}
+
+export interface CreateRequestOptions extends RequestOptionsBase {
+    data?: object;
+}
+
+export interface UpdateRequestOptions extends CreateRequestOptions {
+    saveTemp?: boolean;
+}
+
+export interface PropertyRequestOptions extends RequestOptionsBase {
+    property: string;
+}
+
+export interface SingleRelatedItemRequestOptions extends PropertyRequestOptions {
+    relatedId: string;
+}
+
+export interface CreateRelatedRequestOptions extends PropertyRequestOptions {
+    link: string | number;
+}
+
+export interface UploadRequestOptions extends CreateRequestOptions {
+    data: {
+        content: string;
+        contentType: string;
+        uploadProperties: { [key: string]: string };
+        name: string;
+        payload: object;
+    },
+    publish: boolean;
+}

package/src/Expression.ts

@@ -1,6 +1,5 @@
 export class ExpressionBase {
     constructor(public type: string) {
-
     }
 
     getType(): string {

package/src/OrderProperty.ts

@@ -1,6 +1,5 @@
 import { utils } from './utils';
 
-
 export class OrderProperty {
     constructor(private propertyPath: string, private isDesc: boolean = null) {
         if (!utils.isString(propertyPath))
@@ -8,13 +7,13 @@ export class OrderProperty {
 
         propertyPath = propertyPath.trim();
 
-        var parts = propertyPath.split(' ');
+        const parts = propertyPath.split(' ');
         // parts[0] is the propertyPath; [1] would be whether descending or not.
         if (parts.length > 1 && isDesc !== true && isDesc !== false) {
             isDesc = parts[1].toLowerCase() == 'desc';
             if (!isDesc) {
                 // isDesc is false but check to make sure its intended.
-                var isAsc = parts[1].toLowerCase() == 'asc';
+                const isAsc = parts[1].toLowerCase() == 'asc';
                 if (!isAsc) {
                     throw new Error("the second word in the propertyPath must begin with 'desc' or 'asc'");
                 }
@@ -33,8 +32,8 @@ export class OrderProperty {
         return this.isDesc;
     }
 
-    getValue() {
-        var direction = (this.isDesc) ? 'desc' : 'asc';
+    getValue(): string {
+        const direction = (this.isDesc) ? 'desc' : 'asc';
         return this.propertyPath + ' ' + direction;
     }
 }