Merge branch 'release/2.4.0'

SenseNet · Sep 19, 2017 · 14cf468 · 14cf468
2 parents a94889b + 53f09b5
commit 14cf468
Show file tree

Hide file tree

Showing 4 changed files with 97 additions and 6 deletions.
diff --git a/package.json b/package.json
@@ -1,6 +1,6 @@
 {
   "name": "sn-client-js",
-  "version": "2.3.0",
+  "version": "2.4.0",
   "description": "A JavaScript client for Sense/Net ECM that makes it easy to use the REST API of the Content Repository.",
   "main": "dist/src/SN.js",
   "files": [

diff --git a/src/ODataApi/ODataParams.ts b/src/ODataApi/ODataParams.ts
@@ -5,21 +5,86 @@
 import { Content } from '../Content';
 
 export type ODataFieldParameter<T extends Content> = (keyof T['options'])[] | keyof T['options'];
-export type ODataMetadataType = 'full' | 'minimal' | 'no';
+export type ODataOrderParameter<T extends Content> = keyof T['options'] | (keyof T['options'] | [keyof T['options'], 'asc' | 'desc'])[];
 
+export type ODataMetadataType = 'full' | 'minimal' | 'no';
 export type ODataFormatType = 'json' | 'verbosejson';
+export type ODataInlineCountType = 'none' | 'allpages';
 
+/**
+ * Model class to define specific OData Request parameters. See http://wiki.sensenet.com/OData_REST_API
+ */
 export class IODataParams<T extends Content> {
+    /**
+     * The field(s) to be include in a $select list. Can be a field (e.g. 'DisplayName'), an array of fields (e.g. ['Name', 'Type']) or 'all'
+     */
     select?: ODataFieldParameter<T> | 'all';
+    /**
+     * The field(s) to be include in an $expand list. Can be a reference field (e.g. 'Owner') or an array of fields (e.g. ['CreatedBy', 'ModifiecBy'])
+     */
     expand?: ODataFieldParameter<T>;
-    orderby?: ODataFieldParameter<T>;
+
+    /**
+     * Sets the OData $orderby parameter. Usage example
+     * ```ts
+     * // simple field
+     * {
+     *    ...
+     *    orderby: 'Name'
+     * }
+     * // list with fields or tuples with order direction
+     * {
+     *    ...
+     *    orderby: [
+     *      ['CreationDate', 'desc']
+     *      'Name',
+     *      'DisplayName'
+     *    ]
+     *    
+     * }
+     * 
+     * ```
+     */
+    orderby?: ODataOrderParameter<T>;
+    /**
+     * Sets the OData $top parameter
+     */
     top?: number;
+
+    /**
+     * Sets the OData $skip parameter
+     */
     skip?: number;
+
+    /**
+     * Sets the OData $filter parameter
+     */
     filter?: string;
+
+    /**
+     * Sets the OData $format parameter. Can be 'json' or 'verbosejson'
+     */
     format?: ODataFormatType;
-    inlinecount?: string;
+
+    /**
+     * Sets the OData $format parameter. Can be 'json' or 'verbosejson'
+     */
+    inlinecount?: ODataInlineCountType;
+
+    /**
+     * Sets the OData 'query' parameter. Can be a Content Query
+     */
     query?: string;
+    /**
+     * Sets the OData metadata parameter. Can be 'full', 'minimal' or 'no'
+     */
     metadata?: ODataMetadataType;
+    /**
+     * Sets the OData post data object
+     */
     data?: Object;
+    /**
+     * Sets the OData Scenario parameter
+     */
     scenario?: string;
 }
diff --git a/src/ODataHelper.ts b/src/ODataHelper.ts
@@ -22,7 +22,7 @@ export const combineODataFieldParameters: <T extends Content>(...params: ODataFi
             }
         });
         params = params.filter(param => param && param.length > 0);
-        return [...new Set([...params])] as ODataFieldParameter<T>;
+        return [...new Set([].concat.apply([], params))] as ODataFieldParameter<T>;
     }
 
 /**
@@ -54,7 +54,7 @@ export const buildUrlParamString: <T extends Content>(config: Partial<SnConfigMo
         const plainValue = options[key];
         let parsedValue = plainValue;
         if (plainValue instanceof Array && plainValue.length && plainValue.length > 0){
-            parsedValue = plainValue.join(',');
+            parsedValue = plainValue.map(v => v.join && v.join(' ') || v).join(',');
         }
         if (name && parsedValue && parsedValue.length){
             segments.push({name, value: parsedValue});

diff --git a/test/ODataHelperTests.ts b/test/ODataHelperTests.ts
@@ -75,6 +75,32 @@ describe('#buildUrlParamString()', () => {
         const urlParamString = ODataHelper.buildUrlParamString({DefaultMetadata: 'no'}, { orderby: 'DisplayName' });
         expect(urlParamString).to.be.eq('$orderby=DisplayName&metadata=no');
     });
+
+    it('should parse a single orderby expression', () => {
+        const urlParamString = ODataHelper.buildUrlParamString({DefaultMetadata: 'no'}, { orderby: 'Name' });
+        expect(urlParamString).to.be.eq('$orderby=Name&metadata=no');
+    });
+
+    it('should parse an orderby array with fields expression', () => {
+        const urlParamString = ODataHelper.buildUrlParamString({DefaultMetadata: 'no'}, { orderby: ['Name', 'DisplayName'] });
+        expect(urlParamString).to.be.eq('$orderby=Name,DisplayName&metadata=no');
+    });
+
+    it('should parse an orderby field expression with order', () => {
+        const urlParamString = ODataHelper.buildUrlParamString({DefaultMetadata: 'no'}, { orderby: [['Name', 'asc']] });
+        expect(urlParamString).to.be.eq('$orderby=Name asc&metadata=no');
+    });    
+
+    it('should parse an orderby array with ordered fields list expression', () => {
+        const urlParamString = ODataHelper.buildUrlParamString({DefaultMetadata: 'no'}, { orderby: [['Name', 'asc'], ['DisplayName', 'desc']] });
+        expect(urlParamString).to.be.eq('$orderby=Name asc,DisplayName desc&metadata=no');
+    });
+
+    it('should parse an orderby array with ordered fields list expression and field names', () => {
+        const urlParamString = ODataHelper.buildUrlParamString({DefaultMetadata: 'no'}, { orderby: [['Name', 'asc'], 'DisplayName'] });
+        expect(urlParamString).to.be.eq('$orderby=Name asc,DisplayName&metadata=no');
+    });
+
     it('should return a string without any param', () => {
         const urlParamString = ODataHelper.buildUrlParamString({RequiredSelect: ['Id', 'Type'], DefaultMetadata: 'no'});
         expect(urlParamString).to.be.eq('');